About Features Downloads Getting Started Documentation Events Support GitHub

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

VuFind Documentation

Site Tools

You are here: start » development » architecture » directory_layout
Trace:
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:27] – [Top-Level Layout] demiankatzdevelopment:architecture:directory_layout [2023/11/09 21:01] – demiankatz
Line 1: Line 1:
 ====== VuFind Directory Layout ====== ====== VuFind Directory Layout ======
- 
-// This page refers to VuFind 2.x and later; use of earlier versions is no longer recommended. // 
  
 ===== Top-Level Layout ===== ===== Top-Level Layout =====
Line 8: Line 6:
     * **vufind** \\ Default VuFind .ini files; normally these are copied into a [[configuration:local_settings_directory|local settings directory]] rather than modified directly.     * **vufind** \\ Default VuFind .ini files; normally these are copied into a [[configuration:local_settings_directory|local settings directory]] rather than modified directly.
   * **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
Line 22: Line 21:
     * **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. Starting with VuFind 3.0, this is separated into separate 'vufind' and 'vendor' subdirectories to differentiate Solr-distributed code from VuFind configuration and data.+  * **solr** \\ Solr index and all Solr related items including Solr itself and the data directories for the indexes. This is separated into separate 'vufind' and 'vendor' subdirectories to differentiate Solr-distributed code from VuFind configuration and data.
   * **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.
Line 55: 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