Developer Manual

This page contains the latest information for VuFind developers.

Coding Standards

For help with standards compliance, try the PHP_CodeSniffer tool. Install it with PEAR, then run:

phpcs --standard=PEAR [file]

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.
Unit Tests - Notes on building and running tests for VuFind components.
User Interface Customization - Basics on customizing the presentation layer of VuFind.

Working with MARC - This Code4Lib page offers useful resources for dealing with MARC records.
VuFind Orientation - A quick blog post about VuFind's architecture.

Deprecated Developer Manual - EXTREMELY out of date, but retained for reference.