Warning: This page has not been updated in over over a year and may be outdated or deprecated.
legacy:vufind_1.x_developer_manual:directory_layout
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
directory_layout [2010/12/14 14:46] – demiankatz | legacy:vufind_1.x_developer_manual:directory_layout [2015/12/11 19:15] – ↷ Links adapted because of a move operation demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== VuFind Directory Layout ====== | ====== VuFind Directory Layout ====== | ||
- | | + | // This page refers to VuFind 1.x; for later versions, see [[development: |
- | * **solr** \\ The solr directory contains all Solr related items including Jetty and the data directories for the indexes. \\ * Note: Soon VuFind will have multiple indexes to allow for non bibliographic data. | + | |
- | * **tests** \\ Contains the test suite (see [[Unit Tests]] for more details). | + | |
+ | * **solr** \\ The solr directory contains all Solr related items including Jetty and the data directories for the indexes. | ||
+ | * **tests** \\ Contains the test suite (see [[legacy: | ||
* **util** \\ Contains PHP utility scripts designed to be run from the command line. | * **util** \\ Contains PHP utility scripts designed to be run from the command line. | ||
* dedupe.php \\ Remove duplicate lines from a text file. | * dedupe.php \\ Remove duplicate lines from a text file. | ||
Line 15: | Line 17: | ||
* **conf** \\ This directory contains VuFind' | * **conf** \\ This directory contains VuFind' | ||
* **Crypt** \\ This directory contains encryption-related support classes. | * **Crypt** \\ This directory contains encryption-related support classes. | ||
- | * **Drivers** \\ This directory holds driver classes that allow VuFind to interface with a variety of third-party library systems. | + | * **Drivers** \\ This directory holds driver classes that allow VuFind to interface with a variety of third-party library systems. |
* **File** \\ This directory contains utility classes for dealing with specific file formats (i.e. MARC). | * **File** \\ This directory contains utility classes for dealing with specific file formats (i.e. MARC). | ||
* **images** \\ Images used by VuFind (additional images may be found in the themes folders below). | * **images** \\ Images used by VuFind (additional images may be found in the themes folders below). | ||
* **interface** | * **interface** | ||
- | * **plugins** \\ This directory holds custom Smarty plugins (see [[Building a Plugin]]). | + | * **plugins** \\ This directory holds custom Smarty plugins (see [[legacy: |
- | * **themes** \\ This directory holds a number of themes which are collections of template files in directories that are named for the service or " | + | * **themes** \\ This directory holds a number of themes which are collections of template files in directories that are named for the service or " |
* **js** \\ Javascript support code. | * **js** \\ Javascript support code. | ||
* **lang** \\ This directory holds translation mappings for various languages. | * **lang** \\ This directory holds translation mappings for various languages. | ||
- | * **services** \\ This directory contains the modules of VuFind. | + | * **services** \\ This directory contains the modules of VuFind. |
- | * **sys** \\ This directory contains system-level support classes shared by various modules in the services directory. | + | * **sys** \\ This directory contains system-level support classes shared by various modules in the services directory. |
* **xsl** \\ XSL support code. | * **xsl** \\ XSL support code. | ||
* .htaccess | * .htaccess | ||
Line 31: | Line 33: | ||
* CatalogConnection.php \\ Interface class that wraps around the ILS drivers in the Drivers directory. | * CatalogConnection.php \\ Interface class that wraps around the ILS drivers in the Drivers directory. | ||
* index.php \\ Top-level logic that every VuFind page runs through. | * index.php \\ Top-level logic that every VuFind page runs through. | ||
- | * install \\ This is the initial install bash script that sets up the mysql database as well as the PEAR and Smarty libraries. We hope to expand this to include more setup functionality. | + | * install \\ This is the initial install bash script that sets up the MySQL database as well as the PEAR and Smarty libraries. |
- | * mysql.sql \\ The mysql create file | + | * mysql.sql \\ The MySQL create file |
* vufind.sh \\ The bash script to start and stop Jetty | * vufind.sh \\ The bash script to start and stop Jetty | ||
---- struct data ---- | ---- struct data ---- | ||
---- | ---- | ||
legacy/vufind_1.x_developer_manual/directory_layout.txt · Last modified: 2018/12/19 14:21 by demiankatz