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:customizing_vufind

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
development:architecture:customizing_vufind [2015/12/21 16:47] – ↷ Links adapted because of a move operation demiankatzdevelopment:architecture:customizing_vufind [2024/04/24 18:41] (current) – [Themes] emaijala
Line 18: Line 18:
  
 Details on creating a new theme can be found on the [[development:architecture:user_interface|Customizing the User Interface]] page. Details on creating a new theme can be found on the [[development:architecture:user_interface|Customizing the User Interface]] page.
 +
 +Details on the Bootstrap 5 based themes (starting with VuFind 10) can be found on the [[development:architecture:user_interface:bootstrap5|Themes Based on Bootstrap 5]] page.
  
 You can configure VuFind to use a custom theme through settings in [[configuration:files:config.ini]]. You can configure VuFind to use a custom theme through settings in [[configuration:files:config.ini]].
Line 23: Line 25:
 ===== Modules ===== ===== Modules =====
  
-VuFind is built as a [[development:architecture:zend_framework|Zend Framework 2]] module.  All of its routes and services are configured in /module/VuFind/config/module.config.php.+VuFind is built as a [[development:architecture:laminas|Laminas]] module.  All of its routes and services are configured in /module/VuFind/config/module.config.php.
  
-You can override these settings by building your own custom module.  VuFind's install script provides the option of initializing a custom module.  This establishes a directory and namespace where you can store your local configurations and code.  It also sets up the VUFIND_LOCAL_MODULES environment variable that your Apache configuration uses to tell VuFind to load the custom code.+You can override these settings by building your own custom module.  VuFind's install script (php $VUFIND_HOME/install.php) provides the option of initializing a custom module.  This establishes a directory and namespace where you can store your local configurations and code.  It also sets up the VUFIND_LOCAL_MODULES environment variable that your Apache configuration uses to tell VuFind to load the custom code. Even if you already have VuFind set up, you can run the install script a second time to make adjustments; just be aware that it will create a new Apache configuration in $VUFIND_LOCAL_DIR (while also making a backup of your existing configuration, in case you need to roll back).
  
 Your configuration overrides belong in /module/[your module name]/config/module.config.php.  Your custom code belongs in /module/[your module name]/src/[your module name], and it should live in a PHP namespace that corresponds with the module's name. Your configuration overrides belong in /module/[your module name]/config/module.config.php.  Your custom code belongs in /module/[your module name]/src/[your module name], and it should live in a PHP namespace that corresponds with the module's name.
Line 35: Line 37:
  
 See some useful applications of the VuFind customization on the [[installation:installing_multiple_instances|installing multiple instances]] page. See some useful applications of the VuFind customization on the [[installation:installing_multiple_instances|installing multiple instances]] page.
 +
 +===== Related Video =====
 +
 +See the [[videos:code_generators_1|Code Generators Part 1]] video for a hands-on example of setting up a local code module.
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
development/architecture/customizing_vufind.1450716455.txt.gz · Last modified: 2015/12/21 16:47 by demiankatz