====== Documentation ======


===== Introduction =====

Welcome to the VuFind documentation.  These pages are designed to help you install and customize VuFind.  Please see the [[http://vufind.org/about.php|about]] and [[http://vufind.org/features.php|features]] pages if you first want to learn more about what VuFind is and what it can do for you.

  * [[Requirements]] - Notes on the software needed to run VuFind.
  * [[Installation Status]] - A detailed list of institutions currently using VuFind.  Please add yours!
  * [[Changelog]] - A history of VuFind's releases and their features.











===== Installation & Setup =====

These pages should guide you through the steps of installing VuFind, configuring it to meet your needs and maintaining it over time.

  * [[Installation]] - Start here to get VuFind running on your server.
  * [[Starting and Stopping VuFind]] - How to turn your new discovery server on and off.
  * [[marc_export_notes|Getting Records out of your ILS]] - How to export records from your ILS system.
  * [[Importing Records|Importing and Managing Records]] - Advice on getting your data into VuFind.
  * [[Configuration and Customization]] - How to change the look, feel and behavior of VuFind.
  * [[Performance]] - Making the most of VuFind once it is running.
  * [[Security]] - Preventing attacks on VuFind.
  * [[Automation]] - Keeping VuFind updated and running smoothly over time.
  * [[Migration Notes]] - Considerations for upgrading to new versions of VuFind
  * [[To-do list after install - for the project manager|Notes for the Project Manager]] - How to manage VuFind after you have it running.
  * [[Third-Party Add-ons]] - Notes on using external tools to enhance VuFind.





===== Developers & Systems Administrators =====

  * [[Developer Manual]] - Standards and basic information useful for VuFind programmers.
  * [[New Feature Specifications]] - Pages for discussing and specifying new features.
  * [[Testing Checklist]] - Feature list helpful for validating functionality of VuFind code.



===== VuFind Project Administration =====

Notes on the people behind VuFind and how the project is run.

  * [[Administration Policies and Procedures]]
  * [[Administrator List]]
  * [[ILS Support List]] - VuFind users with experience using particular library systems.
  * [[Language Support List]] - Volunteers to help with the internationalization of VuFind.
  * [[VuFind 2.0 Conference]] - Planning for the VuFind conference in September, 2010.




===== Presentation Slides =====
  * Standard VuFind Presentation: {{http://vufind.org/docs/VuFind Presentation.ppt|PowerPoint}} | {{http://docs.google.com/Presentation?id=dgvn7rhj_2hd538x|Google Docs}}
  * Access 2008 {{http://vufind.org/docs/Access - VuFind Presentation.ppt|PowerPoint}}
  * NERCOMP New Discovery Tools Symposium (February 1, 2010) {{http://vufind.org/docs/NERCOMP.ppt|PowerPoint}}
  * Bibliothekskongress 2010, Leipzig (Germany), March 16, 2010, in Session [[http://www.conwerk.net/contxt_bidkon10/programme/view_symp_detail_short_abstract.asp?referer=16_overview.asp&symposiumID=70|"Stirbt der OPAC ?"]]: [[http://www.slideshare.net/tillk/vufind-ein-open-source-projekt|Slideshare]]
  * Catholic Research Resources Alliance All-Members Meeting 2010 VuFind Discussion {{http://vufind.org/docs/crra2010.ppt|PowerPoint}}

===== Marketing Materials =====
{{http://vufind.org/docs/VufindBrochure.pdf|VuFind Brochure}}






===== User Supplied Documentation =====

Feel free to add your own thoughts and external links to this section.

  * [[http://timesync.gmu.edu/wordpress/?p=364|VuFind on OS X]]
  George Mason University discusses the issues of VuFind on OS X
  * [[Index Fields]]
  Stanford University's documents on VuFind index field population algorithms and field uses. Not guaranteed to be 100% accurate or up to date.
  * [[daia_pica_driver|DAIA/PICA driver]]
  Documentation about the PICA/DAIA driver
  * [[Hacking VuFind into German Libraries]]: Findings of a 2 days hack session