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.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
development:architecture:directory_layout [2023/11/09 21:01] – demiankatz | development:architecture:directory_layout [2024/01/04 19:11] (current) – [Top-Level Layout] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
===== Top-Level Layout ===== | ===== Top-Level Layout ===== | ||
* **config** \\ Application-level configurations | * **config** \\ Application-level configurations | ||
- | * **vufind** \\ Default | + | * **vufind** \\ Default |
* **data** \\ Storage for application-level data (rarely used) | * **data** \\ Storage for application-level data (rarely used) | ||
* **downloads** \\ Cache for downloaded dependencies (e.g. Solr) | * **downloads** \\ Cache for downloaded dependencies (e.g. Solr) | ||
Line 12: | Line 12: | ||
* **local** \\ Default [[configuration: | * **local** \\ Default [[configuration: | ||
* **module** \\ Core code, divided into modules; for details, see [[# | * **module** \\ Core code, divided into modules; for details, see [[# | ||
- | * **VuFind** \\ Core VuFind | + | * **VuFind** \\ Core VuFind® |
* **VuFindAdmin** \\ Code for accessing the web-based Admin panel | * **VuFindAdmin** \\ Code for accessing the web-based Admin panel | ||
- | * **VuFindApi** \\ Code for VuFind's public API | + | * **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 | + | * **VuFindDevTools** \\ Code that is only available when VuFind® |
- | * **VuFindLocalTemplate** \\ Template for building a local module to override | + | * **VuFindLocalTemplate** \\ Template for building a local module to override |
- | * **VuFindSearch** \\ VuFind's low-level search system | + | * **VuFindSearch** \\ VuFind®'s low-level search system |
- | * **VuFindTheme** \\ VuFind's theming system | + | * **VuFindTheme** \\ VuFind®'s theming system |
* **public** \\ Web root -- should only contain index.php; other files are made accessible via Apache configuration | * **public** \\ Web root -- should only contain index.php; other files are made accessible via Apache configuration | ||
- | * **solr** \\ Solr index and all Solr related items including Solr itself and the data directories for the indexes. This is separated into separate ' | + | * **solr** \\ Solr index and all Solr related items including Solr itself and the data directories for the indexes. This is separated into separate ' |
* **tests** \\ Test suite | * **tests** \\ Test suite | ||
* **themes** \\ Templates, CSS, Javascript, images and other theme-specific resources; for details, see [[# | * **themes** \\ Templates, CSS, Javascript, images and other theme-specific resources; for details, see [[# | ||
Line 27: | Line 27: | ||
* **local_theme_example** \\ Example of a local custom theme (used by the [[development: | * **local_theme_example** \\ Example of a local custom theme (used by the [[development: | ||
* **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// | + | * //assorted other directories// |
* **util** \\ [[administration: | * **util** \\ [[administration: | ||
+ | * **i18n** \\ Specialized Javascript/ | ||
* **vendor** \\ Third-party code | * **vendor** \\ Third-party code | ||
* build.xml \\ Phing build script (used for development/ | * build.xml \\ Phing build script (used for development/ | ||
* import-*.* \\ Import automation scripts | * import-*.* \\ Import automation scripts | ||
* index-alphabetic-browse.* \\ AlphaBrowse index generation script | * index-alphabetic-browse.* \\ AlphaBrowse index generation script | ||
- | * install.php \\ VuFind | + | * install.php \\ VuFind® |
* solr.sh \\ Solr startup/ | * solr.sh \\ Solr startup/ | ||
development/architecture/directory_layout.txt · Last modified: 2024/01/04 19:11 by demiankatz