Differences

This shows you the differences between two versions of the page.

--- configuration:course_reserves [2023/06/05 20:33] – [Multiple reserve Solr cores] Fix module name. dltj
+++ configuration:course_reserves [2023/11/09 18:47] (current) – demiankatz
@@ Line 1: / Line 1: @@
 ====== Course Reserves ======
-Academic libraries often need to list resources held on reserve for particular courses, departments and instructors.  VuFind supports this need in multiple ways.
+Academic libraries often need to list resources held on reserve for particular courses, departments and instructors.  VuFind® supports this need in multiple ways.
-Regardless of how reserves are configured, they can be accessed through the "/Search/Reserves" action beneath your base VuFind URL.
+Regardless of how reserves are configured, they can be accessed through the "/Search/Reserves" action beneath your base VuFind® URL.
 ===== Driver-Based Reserves (Default) =====
-If your [[development:plugins:ils_drivers|ILS driver]] implements the findReserves() method, VuFind can load course reserves information in real-time from the ILS.
+If your [[development:plugins:ils_drivers|ILS driver]] implements the findReserves() method, VuFind® can load course reserves information in real-time from the ILS.
 ===== Solr-Based Reserves =====
-Starting with VuFind 1.3, you can configure the software to use a Solr index for course reserves searching instead of the ILS driver.  This offers greater flexibility and a more attractive user interface.  To configure:
+You can configure the software to use a Solr index for course reserves searching instead of the ILS driver.  This offers greater flexibility and a more attractive user interface, but it requires you to periodically reindex your data to keep the system up to date.  To configure:
 .) Edit the [Reserves] section of [[configuration:files:config.ini]] and set search_enabled to true.
-.) Turn on the reserves Solr core by editing solr/solr.xml to uncomment the appropriate line and then [[administration:starting_and_stopping_solr|restarting Solr]]. :!: This step is not necessary in VuFind 3.0 or newer.
+.) Load data into the index by running the util/index_reserves.php tool to extract it from your ILS.  ILS extraction requires support in the [[development:plugins:ils_drivers|ILS driver]].  You can also load data from a CSV file.  See index_reserves.php parameters below for details.
-.) Load data into the index by running the util/index_reserves.php tool to extract it from your ILS.  ILS extraction requires support in the [[development:plugins:ils_drivers|ILS driver]].  Starting with VuFind 1.4, you can also load data from a CSV file.  See index_reserves.php parameters below for details.
+==== index_reserves.php command-line parameters ====
-==== index_reserves.php command-line parameters (VuFind 1.4 or newer) ====
+You can load data into your Solr reserves index by running the ''util/index_reserves.php'' command. Usage details:
 <code>
@@ Line 44: / Line 44: @@
 ==== Multiple reserve Solr cores ====
-If your Solr installation has more than one core for reserves (for instance, your Solr service is used by more than one VuFind installation), you can change the name of the reserves core.
+Starting with VuFind® 9.0, if your Solr installation has more than one core for reserves (for instance, your Solr service is used by more than one VuFind® installation), you can change the name of the reserves core by customizing the [Index] section of reserves.ini. For earlier versions of VuFind®, customizing the core name required you to override the factory of the SolrReserves search backend.
-.) Create module/<your_module>/src/<your_module>/Search/Factory/SolrReservesBackendFactory.php and extend the parent class. Change $this->solrCore to the name of your reserves Solr core:
-<code>
-<?php
-namespace <your_module>\Search\Factory;
-class SolrReservesBackendFactory extends \VuFind\Search\Factory\SolrReservesBackendFactory
-{
-    public function __construct()
-    {
-        parent::__construct();
-        $this->solrCore = '<your-library>_reserves';
-    }
-}
-</code>
-.) Add a factory plugin to the new factory in your module's "module.config.php"
-<code>
-'vufind' =>
-  array(
-    'search_backend' =>
-      array(
-        'factories' =>
-          array(
-            'SolrReserves' => '<your_module>\Search\Factory\SolrReservesBackendFactory',
-          )
-      )
-  )
-</code>
 ---- struct data ----
 properties.Page Owner :
 ----