All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
The browse indexes for DSpace can be extensively configured. These configurations are used by both the Legacy Seach / Browse (Lucene and DB-browse) and Discovery. This section of the configuration allows you to take control of the indexes you wish to browse, and how you wish to present the results. The configuration is broken into several parts: defining the indexes, defining the fields upon which users can sort results, defining truncation for potentially long fields (e.g. authors), setting cross-links between different browse contexts (e.g. from an author's name to a complete list of their items), how many recent submissions to display, and configuration for item mapping browse.
Property: |
|
Example Value: | {{ |
Informational Note: | This is an example of how one "Defines the Indexes". See "Defining the Indexes" in the next sub-section. |
Property: |
|
Example Value: |
|
Informational Note: | This is an example of how one "Defines the Sort Options". See "Defining Sort Options" in the following sub-section. |
...
If you want to re-enable the legacy DBMS Browse Engine please refer to Legacy methods for re-indexing content
...
Info |
---|
If you make changes in this section be sure to update your SOLR indexes running the Discovery Maintenance Script, see Discovery |
...
Code Block |
---|
webui.browse.index.1 = dateissued:metadata:dc.date.issued:date:fullitem:dateissued webui.browse.index.2 = author:metadata:dc.contributor.*,dc.creator:text webui.browse.index.3 = title:metadata:dc.titleitem:title:full webui.browse.index.4 = subject:metadata:dc.subject.*:text #webui.browse.index.5 = dateaccessioned:item:dateaccessioned |
...
There are two types of indexes which are provided in this default integration:
item
" indexes which have a format of webui.browse.index.<n> = <index-name> : item : <sort-type> : (asc | desc)
metadata
" indexes which have a format of webui.browse.index.<n> = <index-name> : metadata : <comma-separated-list-of-metadata-fields> : (date | text) : (asc | dec)
Please <metadata>:<schema prefix>.<element>.<qualifier>:<data-type field>:<sort option>. Please notice that the punctuation is paramount in typing this property key in the dspace.cfg
file. The following table explains each element:
Element | Definition and Options (if available) | ||
---|---|---|---|
| n is the index number. The index numbers must start from 1 and increment continuously by 1 thereafter. Deviation from this will cause an error during install or a configuration update. So anytime you add a new browse index, remember to increase the number. (Commented out index numbers may be used over again). | ||
| The name by which the index will be identified. You will need to update In order for the DSpace UI to display human-friendly description for this index, you'll need to update either your Messages.properties file to match this field. (The form used in the Messages.properties file is: | ||
| Only two options are available: " | ||
(JSPUI) or messages.xml (XMLUI) with new message keys referencing this <index-name>. JSPUI Example (Messages.properties):
XMLUI Example (messages.xml):
| |||
| Only two options are available: "
| ||
| (Only for "metadata" indexes) |
| The schema used for the field to be index. The default is dc (for Dublin Core). |
| (Only for "metadata" indexes) The schema element. In Dublin Core, for example, the author element is referred to as "Contributor". The user should consult the default Dublin Core Metadata Registry table in Appendix A. | ||
| (Only for "metadata" indexes) This is the qualifier to the <element> component. The user has two choices: an asterisk "" or a proper qualifier of the element. The asterisk is a wildcard and causes DSpace to index all types of the schema element. For example, if you have the element "contributor" and the qualifier "" then you would index all contributor data regardless of the qualifier. Another example, you have the element "subject" and the qualifier "lcsh" would cause the indexing of only those fields that have the qualifier "lcsh". (This means you would only index Library of Congress Subject Headings and not all data elements that are subjects. | ||
| This refers to the datatype sort type / data type of the field:
title the index type will be treated like a title, which will include a link to the item page
| ||
| Choose |
...
| |
| (Optional) The default sort order. Choose |
Info |
---|
If you make changes in this section be sure to update your SOLR indexes running the Discovery Maintenance Script, see Discovery |
Sort options/types will be available when browsing a list of items (i.e. only in "full" mode, not "single" modesee also the "item
" index type above). You can define an arbitrary number of fields to sort on, irrespective of which fields you display using web.itemlist.columns. For example, the default entries that appear in the dspace.cfg as default installation:
...
The format of each entry is web.browse.sort-option.<n> = <option <sort-type-name>:<schema-prefix>.<element>.<qualifier>:<datatype>
. Please notice the punctuation used between the different elements. The following table explains the each element:
Element | Definition and Options (if available) |
---|---|
| n is an arbitrary number you choose. |
| The name by which the sort option will be identified. This may be used in later configuration or to locate the message key (found in Messages.properties file) for this index.is the name by which it is referred in the "webui.browse.index" settings (see Defining the Indexes). |
| The schema used for the field to be sorted on in the index. The default is dc (for Dublin Core). |
| The schema element. In Dublin Core, for example, the author element is referred to as "Contributor". The user should consult the default Dublin Core Metadata Registry table in Appendix A. |
| This is the qualifier to the <element> component. The user has two choices: an asterisk "*" or a proper qualifier of the element. |
| This refers to the datatype of the field: |
...