Warning: This page has not been updated in over over a year and may be outdated or deprecated.
legacy:vufind_1.x_developer_manual
This is an old revision of the document!
Table of Contents
VuFind 1.x Developer Manual
This page contains information for developers working with the VuFind 1.x codebase.
VuFind 1.x is no longer under development; for information on the latest version, see the 2.x Developer Manual.
Coding Standards
- PHP Code - PEAR Coding Standards
For help with standards compliance, try the PHP_CodeSniffer tool. Install it with PEAR, then run:
phpcs --standard=PEAR [file]
Development Tools
- Subversion - Notes on aiding development with version tracking.
Architecture Notes
How-Tos
- Adding Facets - How to add a new facet to searches.
- Building an Authentication Handler - How to add custom authentication methods.
- Building an ILS Driver - How to connect to your Integrated Library System.
- Building a Link Resolver Driver - How to connect to your OpenURL resolver.
- Building a Module - How to add new pages and functionality to the interface.
- Building a Plugin - How to add custom behavior to Smarty Templates.
- Building a Recommendations Module - How to add custom recommendations to searches.
- Building a Search Object - How to add a new type of searching to VuFind.
- Creating a Session Handler - How to store user sessions in a custom location.
- Building Custom Autosuggestions - How to customize VuFind's autocomplete functionality.
- Supporting a New Metadata Format - How to add a record driver and build an importer for non-MARC records.
- User Interface Customization - Basics on customizing the presentation layer of VuFind.
Planning
- JIRA - VuFind's issue tracker.
Testing
- Continuous Integration - Notes on project-level VuFind testing.
- Testing Checklist - Feature list helpful for validating functionality of VuFind code.
- Unit Tests - Notes on building and running tests for VuFind components.
External Resources
- Working with MARC - This Code4Lib page offers useful resources for dealing with MARC records.
- VuFind Orientation - A quick blog post about VuFind's architecture.
Older Resources
- Deprecated Developer Manual - EXTREMELY out of date, but retained for reference.
legacy/vufind_1.x_developer_manual.1449771530.txt.gz · Last modified: 2015/12/10 18:18 by demiankatz