About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


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.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
directory_layout [2015/12/09 20:48] demiankatzlegacy: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 [[vufind2:directory_layout|VuFind 2.x Directory Layout]]. //+// This page refers to VuFind 1.x; for later versions, see [[development:architecture:directory_layout|VuFind 2.x Directory Layout]]. //
  
   * **import** \\ The import directory contains the import tool for importing records.   * **import** \\ The import directory contains the import tool for importing records.
   * **solr** \\ The solr directory contains all Solr related items including Jetty and the data directories for the indexes.   * **solr** \\ The solr directory contains all Solr related items including Jetty and the data directories for the indexes.
-  * **tests** \\ Contains the test suite (see [[Unit Tests]] for more details).+  * **tests** \\ Contains the test suite (see [[legacy:vufind_1.x_developer_manual:unit_tests|Unit Tests]] for more details).
   * **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 21: Line 21:
     * **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:vufind_1.x_developer_manual:building_a_smarty_plugin|Building a Plugin]]).
       * **themes** \\ This directory holds a number of themes which are collections of template files in directories that are named for the service or "module" they display.  Each theme also contains a css directory.  Themes include: classic (the old look), default (a newer look based on classic), blueprint (a jQuery-based theme), mobile (an iWebKit-based mobile theme) and jquerymobile (a jQueryMobile-based mobile theme).  Depending on your VuFind version, some of these themes may not be available.       * **themes** \\ This directory holds a number of themes which are collections of template files in directories that are named for the service or "module" they display.  Each theme also contains a css directory.  Themes include: classic (the old look), default (a newer look based on classic), blueprint (a jQuery-based theme), mobile (an iWebKit-based mobile theme) and jquerymobile (a jQueryMobile-based mobile theme).  Depending on your VuFind version, some of these themes may not be available.
     * **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.  Each "module" is a directory containing a series of Classes.  Each class has its own PHP file of the same name.  The "action" classes get called by the index.php page in the web directory based on the URL.  The URL rewriting is processed by the mod_rewrite rules located in the .htaccess file in the web directory.  Classes process data and pass details into the Smarty templates in the interface directory for presentation (in early versions of VuFind, the templates were in the services directory).  See [[Building a Module]] for more details. +    * **services** \\ This directory contains the modules of VuFind.  Each "module" is a directory containing a series of Classes.  Each class has its own PHP file of the same name.  The "action" classes get called by the index.php page in the web directory based on the URL.  The URL rewriting is processed by the mod_rewrite rules located in the .htaccess file in the web directory.  Classes process data and pass details into the Smarty templates in the interface directory for presentation (in early versions of VuFind, the templates were in the services directory).  See [[legacy:vufind_1.x_developer_manual:building_a_module|Building a Module]] for more details. 
-    * **sys** \\ This directory contains system-level support classes shared by various modules in the services directory.  See the [[System Classes]] page for more details.+    * **sys** \\ This directory contains system-level support classes shared by various modules in the services directory.  See the [[legacy:vufind_1.x_developer_manual:system_classes|System Classes]] page for more details.
     * **xsl** \\ XSL support code.     * **xsl** \\ XSL support code.
     * .htaccess     * .htaccess
legacy/vufind_1.x_developer_manual/directory_layout.txt · Last modified: 2018/12/19 14:21 by demiankatz