Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
vufind2:developer_manual [2015/06/30 12:43] – [Development Tools] demiankatz | development [2020/07/30 15:09] – [VuFind Planning] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== VuFind | + | ====== VuFind Developer Manual ====== |
- | This page covers development of VuFind 2.x; for earlier versions, see the [[..: | + | :!: This page covers development of VuFind 2.x and later; use of earlier versions |
- | ===== Coding Standards | + | ===== Prerequisites |
- | * PHP Code - [[http:// | + | * [[development:coding_standards|Coding Standards]] - How to conform to VuFind' |
+ | * [[development: | ||
+ | * [[development: | ||
- | For help with standards compliance, try the [[http://pear.php.net/ | + | ===== About VuFind ===== |
- | <code> | + | * [[development:architecture|Architecture Notes]] - Information on VuFind' |
- | phpcs --standard=PEAR | + | * [[development: |
- | </ | + | * [[development:plugins|Plugins]] - Information on the types of plug-ins used to extend VuFind functionality. |
+ | * [[development: | ||
+ | * [[development: | ||
+ | * [[development: | ||
+ | * [[development: | ||
- | ===== Development Tools ===== | ||
- | * [[Git]] - Notes on aiding development with version tracking. | + | ===== External Links ===== |
- | * [[Recommended Tools]] - Suggestions for successful VuFind development. | + | |
- | ===== Architecture Notes ===== | + | ==== VuFind |
- | * [[Data Model / Key Concepts]] - Key ideas in the VuFind | + | |
- | * [[Record Driver Method Master List]] - A reference to get methods used by record drivers. | + | |
- | * [[Directory Layout]] | + | |
- | * [[..:Index Schema]] | + | |
- | * [[..: | + | |
- | * [[Language / Localization Support]] | + | |
- | * [[Search Service]] | + | |
- | ===== General Information ===== | + | |
- | * [[Why VuFind 2.0?]] - Some of the reasons for a new major release. | + | * [[community_call|Community Call]] - A regular meeting (free, online |
- | * [[Customizing VuFind 2.0]] - How to change VuFind' | + | * [[https://github.com/vufind-org/ |
- | * [[Zend Framework 2.0|Zend Framework 2]] - Information about VuFind 2.0's underlying framework. | + | |
- | + | ||
- | ===== Plugins ===== | + | |
- | + | ||
- | VuFind features integration points for a variety of plugins. | + | |
- | + | ||
- | * [[Authentication Handlers]] - Custom login functionality | + | |
- | * [[Autosuggesters]] - Sources for autocomplete suggestions | + | |
- | * [[Database Gateways]] - Interfacing with database tables | + | |
- | * [[Hierarchy Components]] - Support tools for [[..: | + | |
- | * [[Building an ILS Driver|ILS Drivers]] - Interfacing with integrated library systems | + | |
- | * [[Link Resolver Drivers]] - Interfacing with OpenURL resolvers for embedded results | + | |
- | * [[Permission Provider Plugins]] - Permission providers are part of VuFind' | + | |
- | * [[Recommendation Modules]] - Providing context-sensitive suggestions in search results | + | |
- | * [[Record Drivers]] - Representing metadata in an object format recognized by VuFind | + | |
- | * [[Record Tabs]] - Objects representing tabs on the record view page | + | |
- | * [[building_a_related_record_module|Related Records Modules]] - Providing context-sensitive suggestions in record views | + | |
- | * [[Session Handlers]] - Custom PHP session storage mechanisms | + | |
- | * [[Statistics Drivers]] - Modules for gathering search/record view statistics | + | |
- | + | ||
- | ===== How-Tos ===== | + | |
- | * [[..:Adding Facets]] | + | |
- | * [[Authorization]] - Information on how VuFind handles user authorization. | + | |
- | * [[Building an ILS Driver]] - How to connect to your Integrated Library System. | + | |
- | * [[Building a Controller]] - How to add new pages and functionality to the interface. | + | |
- | * [[Building a View Helper]] - How to add custom behavior to templates. | + | |
- | * [[..: | + | |
- | * [[Connecting a New External Data Source]] - Building a VuFind module for a new data source | + | |
- | * [[Customizing the User Interface]] - Basics | + | |
- | * [[Displaying a Custom Field]] - How to make a new field visible in the VuFind environment. | + | |
- | * [[..: | + | |
- | * [[Supporting a New Citation Style]] - How to add a citation style to VuFind. | + | |
- | * [[Supporting a New Export Format]] - How to add support to export metadata from VuFind to files/ | + | |
- | * [[Supporting a New Metadata Format]] - How to add a record driver and build an importer for non-MARC records. | + | |
- | + | ||
- | ===== Planning ===== | + | |
- | + | ||
- | * [[..:New Feature Specifications]] - Pages for discussing and specifying | + | |
* [[http:// | * [[http:// | ||
- | + | | |
- | ===== Testing ===== | + | ==== Other Notes ==== |
- | + | ||
- | | + | |
- | * [[..:Testing Checklist]] - Feature list helpful for validating functionality of VuFind code. | + | |
- | * [[Unit Tests]] - Notes on building and running tests for VuFind components. | + | |
- | + | ||
- | ===== External Resources ===== | + | |
* [[http:// | * [[http:// | ||
development.txt · Last modified: 2020/10/05 14:10 by demiankatz