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 revisionNext revisionBoth sides next revision | ||
development:architecture:directory_layout [2018/12/19 14:21] – [VuFind Directory Layout] demiankatz | development:architecture:directory_layout [2018/12/19 14:28] – [Anatomy of a Theme] demiankatz | ||
---|---|---|---|
Line 14: | Line 14: | ||
* **module** \\ Core code, divided into modules; for details, see [[# | * **module** \\ Core code, divided into modules; for details, see [[# | ||
* **VuFind** \\ Core VuFind code | * **VuFind** \\ Core VuFind code | ||
+ | * **VuFindAdmin** \\ Code for accessing the web-based Admin panel | ||
+ | * **VuFindApi** \\ Code for VuFind' | ||
* **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' | ||
* **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' | * **VuFindSearch** \\ VuFind' | ||
Line 24: | Line 25: | ||
* **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 [[# | ||
- | * **blueprint** \\ Default desktop | + | * **local_mixin_example** \\ Example of a [[development: |
- | * **jquerymobile** \\ Default mobile | + | * **local_theme_example** \\ Example of a local custom |
* **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// | ||
* **util** \\ [[administration: | * **util** \\ [[administration: | ||
* **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 | + | * solr.sh \\ Solr startup/ |
===== Anatomy of a Module ===== | ===== Anatomy of a Module ===== | ||
Line 53: | Line 55: | ||
* **images** \\ Image resources (exposed to public access) | * **images** \\ Image resources (exposed to public access) | ||
* **js** \\ Javascript resources (exposed to public access) | * **js** \\ Javascript resources (exposed to public access) | ||
+ | * **less** \\ LESS resources (used to build CSS) | ||
+ | * **scss** \\ SCSS resources (auto-translated from LESS; provided for reference but unused by default) | ||
* **templates** \\ PHP templates for rendering HTML | * **templates** \\ PHP templates for rendering HTML | ||
* theme.config.php \\ Theme configuration file | * theme.config.php \\ Theme configuration file |
development/architecture/directory_layout.txt · Last modified: 2024/01/04 19:11 by demiankatz