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.
development:architecture: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
Next revisionBoth sides next revision
development:architecture:directory_layout [2018/12/19 14:21] – [VuFind Directory Layout] demiankatzdevelopment:architecture:directory_layout [2018/12/19 14:27] – [Top-Level Layout] demiankatz
Line 14: Line 14:
   * **module** \\ Core code, divided into modules; for details, see [[#anatomy_of_a_module|anatomy of a module]] below.   * **module** \\ Core code, divided into modules; for details, see [[#anatomy_of_a_module|anatomy of a module]] below.
     * **VuFind** \\ Core VuFind code     * **VuFind** \\ Core VuFind code
 +    * **VuFindAdmin** \\ Code for accessing the web-based Admin panel
 +    * **VuFindApi** \\ Code for VuFind's public API
     * **VuFindConsole** \\ Console-specific code used for command-line tools     * **VuFindConsole** \\ Console-specific code used for command-line tools
     * **VuFindDevTools** \\ Code that is only available when VuFind is set to development mode (via Apache configuration)     * **VuFindDevTools** \\ Code that is only available when VuFind is set to development mode (via Apache configuration)
-    * **VuFindHttp** \\ VuFind's HTTP service 
     * **VuFindLocalTemplate** \\ Template for building a local module to override VuFind defaults; this is copied by install.php and should not be modified directly     * **VuFindLocalTemplate** \\ Template for building a local module to override VuFind defaults; this is copied by install.php and should not be modified directly
     * **VuFindSearch** \\ VuFind's low-level search system     * **VuFindSearch** \\ VuFind's low-level search system
Line 24: Line 25:
   * **tests** \\ Test suite   * **tests** \\ Test suite
   * **themes** \\ Templates, CSS, Javascript, images and other theme-specific resources; for details, see [[#anatomy_of_a_theme|anatomy of a theme]] below.   * **themes** \\ Templates, CSS, Javascript, images and other theme-specific resources; for details, see [[#anatomy_of_a_theme|anatomy of a theme]] below.
-    * **blueprint** \\ Default desktop theme +    * **local_mixin_example** \\ Example of a [[development:architecture:user_interface#mix-ins|theme mix-in]] (used by the [[development:code_generators#creating_theme_mix-ins|mix-in generator]]). 
-    * **jquerymobile** \\ Default mobile theme+    * **local_theme_example** \\ Example of a local custom theme (used by the [[development:code_generators#creating_themes|theme generator]]).
     * **root** \\ Base theme containing shared resources needed by all other themes     * **root** \\ Base theme containing shared resources needed by all other themes
 +    * //assorted other directories// \\ VuFind's built-in themes (details vary depending on version)
   * **util** \\ [[administration:command_line_utilities|Command line utilities]]   * **util** \\ [[administration:command_line_utilities|Command line utilities]]
   * **vendor** \\ Third-party code   * **vendor** \\ Third-party code
Line 33: Line 35:
   * index-alphabetic-browse.* \\ AlphaBrowse index generation script   * index-alphabetic-browse.* \\ AlphaBrowse index generation script
   * install.php \\ VuFind installer   * install.php \\ VuFind installer
-  * vufind.sh \\ VuFind startup/shutdown script+  * solr.sh \\ Solr startup/shutdown script
  
 ===== Anatomy of a Module ===== ===== Anatomy of a Module =====
development/architecture/directory_layout.txt · Last modified: 2024/01/04 19:11 by demiankatz