Both sides previous revisionPrevious revisionNext revision | Previous revision |
legacy:vufind_1.x_developer_manual [2015/12/10 18:07] – ↷ Links adapted because of a move operation demiankatz | legacy:vufind_1.x_developer_manual [2018/12/19 15:02] (current) – demiankatz |
---|
====== VuFind 1.x Developer Manual ====== | ====== VuFind 1.x Developer Manual ====== |
| |
This page contains information for developers working with the VuFind 1.x codebase. | // This outdated page has been deleted to prevent confusion; for current documentation, see [[:development|this page]]. To view old content for historical interest, see the "Old Revisions" list below. // |
| |
// VuFind 1.x is no longer under development; for information on the latest version, see the [[:development|2.x Developer Manual]]. // | |
===== Coding Standards ===== | |
* PHP Code - [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]] | |
| |
For help with standards compliance, try the [[http://pear.php.net/package/PHP_CodeSniffer|PHP_CodeSniffer]] tool. Install it with PEAR, then run: | |
<code> | |
phpcs --standard=PEAR [file] | |
</code> | |
| |
===== Development Tools ===== | |
| |
* [[:subversion|Subversion]] - Notes on aiding development with version tracking. | |
| |
| |
| |
| |
===== Architecture Notes ===== | |
* [[http://vufind.org/docs/VufindDiagram.jpg|Architecture Diagram]] | |
* [[:directory_layout|Directory Layout]] | |
* [[:global_variables|Global Variables]] | |
* [[:index_schema|Index Schema]] | |
* [[:authority_control#authority_index|Authority Index Schema]] | |
* [[:language_localization_support|Language Localization Support]] | |
* [[:system_classes|System Classes]] | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
===== How-Tos ===== | |
* [[:adding_facets|Adding Facets]] - How to add a new facet to searches. | |
* [[legacy:vufind_1.x_developer_manual:building_an_authentication_handler|Building an Authentication Handler]] - How to add custom authentication methods. | |
* [[legacy:vufind_1.x_developer_manual:building_an_ils_driver|Building an ILS Driver]] - How to connect to your Integrated Library System. | |
* [[legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver|Building a Link Resolver Driver]] - How to connect to your OpenURL resolver. | |
* [[:building_a_module|Building a Module]] - How to add new pages and functionality to the interface. | |
* [[:building_a_plugin|Building a Plugin]] - How to add custom behavior to Smarty Templates. | |
* [[:building_a_recommendations_module|Building a Recommendations Module]] - How to add custom recommendations to searches. | |
* [[:building_a_search_object|Building a Search Object]] - How to add a new type of searching to VuFind. | |
* [[legacy:vufind_1.x_developer_manual:creating_a_session_handler|Creating a Session Handler]] - How to store user sessions in a custom location. | |
* [[:autocomplete#building_custom_suggestions|Building Custom Autosuggestions]] - How to customize VuFind's autocomplete functionality. | |
* [[:other_than_marc|Supporting a New Metadata Format]] - How to add a record driver and build an importer for non-MARC records. | |
* [[:customization|User Interface Customization]] - Basics on customizing the presentation layer of VuFind. | |
| |
===== Planning ===== | |
| |
* [[http://vufind.org/jira|JIRA]] - VuFind's issue tracker. | |
| |
===== Testing ===== | |
| |
* [[:continuous_integration|Continuous Integration]] - Notes on project-level VuFind testing. | |
* [[:testing_checklist|Testing Checklist]] - Feature list helpful for validating functionality of VuFind code. | |
* [[:unit_tests|Unit Tests]] - Notes on building and running tests for VuFind components. | |
| |
===== External Resources ===== | |
* [[http://wiki.code4lib.org/index.php/Working_with_MaRC|Working with MARC]] - This Code4Lib page offers useful resources for dealing with MARC records. | |
* [[http://credaul.wordpress.com/2011/06/05/vufind-orientation/|VuFind Orientation]] - A quick blog post about VuFind's architecture. | |
| |
===== Older Resources ===== | |
* {{http://vufind.org/docs/VUFind%20Documentation.pdf|Deprecated Developer Manual}} - EXTREMELY out of date, but retained for reference. | |
---- struct data ---- | ---- struct data ---- |
| properties.Page Owner : |
---- | ---- |
| |