Differences

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

--- indexing:hierarchies_and_collections [2015/12/21 16:47] – ↷ Links adapted because of a move operation demiankatz
+++ indexing:hierarchies_and_collections [2023/11/28 20:13] (current) – [Hierarchies and Collections] demiankatz
@@ Line 1: / Line 1: @@
 ====== Hierarchies and Collections ======
-// The features described on this page are available starting with VuFind 1.4. //
 ===== Hierarchies =====
-Some document collections are structured hierarchically.  VuFind offers a mechanism for displaying these hierarchies as a pop-up within search results and as a tab of the record page.
+Some document collections are structured hierarchically.  VuFind® offers a mechanism for displaying these hierarchies as a pop-up within search results and as a tab of the record page.
 ==== Solr Setup ====
-To display hierarchies, VuFind needs to be able to find information about document relationships in your Solr index.  At index time, you need to populate the following fields in order to use hierarchy functionality:
+To display hierarchies, VuFind® needs to be able to find information about document relationships in your Solr index.  At index time, you need to populate the following fields in order to use hierarchy functionality:
-  * **hierarchytype** - The type of hierarchy being used (this triggers loading of a hierarchy driver; it is usually easiest to leave it blank, causing VuFind to default to the driver specified in the [Hierarchy] section of [[configuration:files:config.ini]]).
+  * **hierarchytype** - The type of hierarchy being used (this triggers loading of a hierarchy driver; it is usually easiest to leave it blank, causing VuFind® to default to the driver specified in the [Hierarchy] section of [[configuration:files:config.ini]]).
   * **hierarchy_browse** - Optional, see [[#Setting Up Browsing]] below.
   * **hierarchy_top_id** - The Solr ID of the record representing the top of the hierarchy containing the current record.
@@ Line 26: / Line 24: @@
   * **is_hierarchy_id** - If the current record represents a node within a hierarchy, this field should contain the same value as the regular id field.
   * **is_hierarchy_title** - If the current record represents a node within a hierarchy, this field should contain the same value as the regular title field.
-  * **title_in_hierarchy** - Optional, introduced in VuFind 2.3. If a record needs to have a different display title in different collection contexts, this field should contain a number of titles equal to the number of parent collections and in the same order as the hierarchy_parent_id field.
+  * **title_in_hierarchy** - Optional, introduced in VuFind® 2.3. If a record needs to have a different display title in different collection contexts, this field should contain a number of titles equal to the number of parent collections and in the same order as the hierarchy_parent_id field.
+This optional field is not required, but can be used to enhance some functionality:
+  * **hierarchy_all_parents_str_mv** - This should contain every parent collection ID -- hierarchy_top_id, hierarchy_parent_id, and any "breadcrumb trail" in between. If populated, starting with VuFind® 10.0, this can be used to improve "deep searching" behavior in the collection view by turning on the search_container_id_field setting in HierarchyDefault.ini. Note that any field name can be used in the configuration, so this name is just a suggestion.
-==== VuFind Configuration ====
+==== VuFind® Configuration ====
-Once the Solr index is populated appropriately, you need to adjust several VuFind configuration files to make hierarchies visible.
+Once the Solr index is populated appropriately, you need to adjust several VuFind® configuration files to make hierarchies visible.
   * In [[configuration:files:config.ini]], make sure that the [Hierarchy] section contains a driver setting (Default is usually the best option if you want to show trees) and the showTree setting is true.
@@ Line 55: / Line 57: @@
 ===== Collections =====
-Once you have hierarchies set up, you have the option of enabling VuFind's Collection module.  This can be used to provide an alternative to the standard record view for records that are considered "collections".  This allows you to, for example, view and search a list of items below the collection record's position in the hierarchy.
+Once you have hierarchies set up, you have the option of enabling VuFind®'s Collection module.  This can be used to provide an alternative to the standard record view for records that are considered "collections".  This allows you to, for example, view and search a list of items below the collection record's position in the hierarchy.
-VuFind's collection browse mode also gives you a high-level view of all the records configured to be treated as collections.
+VuFind®'s collection browse mode also gives you a high-level view of all the records configured to be treated as collections.
 ==== Configuration ====
@@ Line 81: / Line 83: @@
 === Browsing Collections ===
-In addition to the custom collection view, VuFind also offers a module for browsing through lists of your collections.  This can be found at Collections/Home under your VuFind base URL.
+In addition to the custom collection view, VuFind® also offers a module for browsing through lists of your collections.  This can be found at Collections/Home under your VuFind® base URL.
 == Setting Up Browsing ==
@@ Line 104: / Line 106: @@
 By default, the collection browse uses Solr faceting to find a list of collections.  However, if you have a large number of collections in your index, this may become slow or take up too much memory.  In that case, you can switch to using the [[indexing:alphabetical_heading_browse|alphabetical heading browse]] mechanism instead by changing the browseType setting in the [Collections] section of [[configuration:files:config.ini]] to "Alphabetical."  When using this option, be sure to maintain your browse index databases as described on the [[indexing:alphabetical_heading_browse|alphabetical heading browse]] page.
 ---- struct data ----
+properties.Page Owner :
 ----