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 revisionLast revisionBoth sides next revision | ||
vufind2:directory_layout [2014/06/13 13:14] – external edit 127.0.0.1 | development:architecture:directory_layout [2023/11/09 21:02] – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | + | ||
- | // This page refers to VuFind 2.x; for earlier versions, see [[..: | + | |
===== 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) | ||
* **harvest** \\ Tools for harvesting metadata | * **harvest** \\ Tools for harvesting metadata | ||
* **import** \\ Tools for importing metadata | * **import** \\ Tools for importing metadata | ||
* **languages** \\ Default language files | * **languages** \\ Default language files | ||
- | * **local** \\ Default [[local settings directory]] (other paths may be configured) | + | * **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 | ||
+ | * **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 | + | * **VuFindDevTools** \\ Code that is only available when VuFind® |
- | * **VuFindHttp** \\ 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** \\ Solr index and all Solr related items including |
* **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// |
- | * createHierarchyTrees.php \\ Populate the hierarchy cache when using [[..: | + | |
- | * dedupe.php \\ Remove duplicate lines from a text file. | + | |
- | * delete.php \\ Remove all of the records in a specified MARC file from the Solr index. | + | |
- | * expire_searches.php \\ Remove unwanted saved searches from the database. | + | |
- | * index_reserves.php \\ Build a Solr index for course reserves. | + | |
- | * optimize.php \\ Optimize the Solr index. | + | |
- | * sitemap.php \\ Generate a sitemap for use with search engines. | + | |
- | * suppressed.php \\ Delete all currently suppressed catalog records from the Solr index. | + | |
* **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® |
- | * vufind.sh \\ VuFind | + | * solr.sh \\ Solr startup/ |
===== Anatomy of a Module ===== | ===== Anatomy of a Module ===== | ||
Line 61: | Line 54: | ||
* **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 | ||
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
development/architecture/directory_layout.txt · Last modified: 2024/01/04 19:11 by demiankatz