Page History
...
- A developer or user downloads a copy of DSpace to build & install
- He/She can edit the
[dspace-source]/build.properties
to specify the very basic settings for building & installing DSpace- OR, alternatively he/she can copy/rename the "build.properties" to a different "*.properties" file & edit it. For example, you could choose to create a separate properties file for each environment (dev.properties, test.properties, prod.properties)
- He/She can then build the DSpace Installation Package using the *.properties file they choose
- Running simply "mvn package" will always use the default "build.properties" settings.
- Passing in the "-Denv" (environment) flag, will cause the build process to use a custom properties file. Some examples:
- "mvn package -Denv=test" would build DSpace using a custom file named
[dspace-source]/test.properties
- "mvn package -Denv=local" would build DSpace using a custom file named
[dspace-source]/local.properties
- "mvn package -Denv=john" would build DSpace using a custom file named
[dspace-source]/john.properties
- "mvn package -Denv=test" would build DSpace using a custom file named
- No matter which build options are used, the values in the enabled properties file will be automatically copied over to your
[dspace-source]/dspace/target/dspace-[version]-build/
dspace.cfg
Note | ||
---|---|---|
| ||
It is worth noting that the Once DSpace is installed, it the system only uses the settings in your |
Warning | ||
---|---|---|
| ||
When you edit the "build.properties" file (or a custom *.properties file), take care not to remove or comment out any settings. Doing so, may cause your final "dspace.cfg" file to be misconfigured with regards to that particular setting. Instead, if you wish to remove/disable a particular setting, just clear out its value. For example, if you don't want to be notified of new user registrations, ensure the "mail.registration.notify" setting has no value, e.g.
As another example, if you are running the DSpace UI of your choice (XMLUI or JSPUI) directly under tomcat's root, leave "dspace.ui" empty but do not delete the setting, e.g. dspace.ui= |
...
Info | ||
---|---|---|
| ||
Based on your institution's needs, you may wish to add settings to your own build.properties (or custom *.properties) file. This is actually a relatively easy process. Any existing DSpace configuration (any config in
|
...
The dspace.cfg
Configuration Properties File
...
Property: | plugin.classpath |
---|---|
Example Value: | /opt/dspace/plugins/aPlugin.jar:/opt/dspace/moreplugins |
Informational Note: | Search path for third-party plugin classes. This is a colon-separated list of directories and JAR files, each of which will be searched for plugin classes after looking in all the places where DSpace classes are found. In this way you can designate one or more locations for plugin files which will not be affected by DSpace upgrades. |
Configuring the Search Engine
Info |
---|
Since DSpace 4.0 the advanced search module named Discovery (based on Apache SOLR) is the default search provider. It provides up-to-date features, such as filtering/faceting, hit highlighting, search snippets, etc. A detailed documentation is available for customization, see Discovery Please refer to Legacy methods for re-indexing content if you want re-enable and customize the "legacy" DSpace search engine (based on Apache Lucene). |
Handle Server Configuration
The CNRI Handle system is a 3rd party service for maintaining persistent URL's. For a nominal fee, you can register a handle prefix for your repository. As a result, your repository items will be also available under the links http://handle.net/<<handle prefix>>/<<item id>>. As the base url of your repository might change or evolve, the persistent handle.net URL's secure the consistency of links to your repository items. For complete information regarding the Handle server, the user should consult The Handle Server section of Installing DSpace.
...
Community Administration: Subcommunities and Collections | |||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to create subcommunities or collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to delete subcommunities or collections. | ||
Community Administration: Policies and The group of administrators | |||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the community policies. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to edit the group of community admins. | ||
Community Administration: Collections in the above Community |
| ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the policies for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the item template for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the group of submitters for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the workflows for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the group of administrators for underlying collections. | ||
Community Administration: Items Owned by Collections in the Above Community | |||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to delete items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to withdraw items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to reinstate items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate item policies in underlying collections. | ||
Community Administration: Bundles of Bitstreams, related to items owned by collections in the above Community | |||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to create additional bitstreams in items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to delete bitstreams from items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administer licenses from items in underlying collections. | ||
Community Administration: |
| ||
Collection Administration: |
| ||
Collection Administration: |
| ||
Item Administration. |
| ||
Item Administration: |
|
...
If you are unfamiliar with the Event System in DSpace, and require additional information with terms like "Consumer" and "Dispatcher" please refer to:http://wiki.dspace.org/index.php/EventSystemPrototypeto EventSystemPrototype.
Property: |
|
Example Value: |
|
Informational Note: | This is the default synchronous dispatcher (Same behavior as traditional DSpace). |
Property: |
|
Example Value: |
|
Informational Note: | This is the default synchronous dispatcher (Same behavior as traditional DSpace). |
Property: |
|
Example Value: |
|
Informational Note: | The noindex dispatcher will not create search or browse indexes (useful for batch item imports). |
Property: |
|
Example Value: |
|
Informational Note: | The noindex dispatcher will not create search or browse indexes (useful for batch item imports). |
Property: |
|
Example Value: |
|
Informational Note: | Consumer to maintain the search index. |
Property: |
|
Example Value: | {{event.consumer.search.filters = }} |
Informational Note: | Consumer to maintain the search index. |
Property: |
|
Example Value: |
|
Informational Note: | Consumer to maintain the browse index. |
Property: |
|
Example Value: |
|
Informational Note: | Consumer to maintain the browse index. |
Property: |
|
Example Value: |
|
Informational Note: | Consumer related to EPerson changes |
Property: |
|
Example Value: |
|
Informational Note: | Consumer related to EPerson changes |
Property: |
|
Example Value: |
|
Informational Note: | Test consumer for debugging and monitoring. Commented out by default. |
Property: |
|
Example Value: |
|
Informational Note: | Test consumer for debugging and monitoring. Commented out by default. |
Property: |
|
Example Value: |
|
Informational Note: | Set this to true to enable testConsumer messages to standard output. Commented out by default. |
...
These settings control three aspects of the submission process: thesis submission permission, whether or not a bitstream file is required when submitting to a collection and whether to show a progress bar during the file upload.
Property: |
|
Example Value: |
|
Informational Note: | Controls whether or not the UI blocks a submission which is marked as a thesis. |
Property: |
|
Example Value: |
|
Informational Note: | Whether or not a file is required to be uploaded during the "Upload" step in the submission process. The default is true. If set to "false", then the submitter (human being) has the option to skip the uploading of a file. |
Property: |
|
Example Value: | webui.submit.upload.html5 = true |
Informational Note: | If the browser supports it, JSPUI uses html5 File API to enhance file upload. If this property is set to false the enhanced file upload is not used even if the browser would support it. |
Property: |
|
Example Value: | webui.submit.upload.progressbar = true |
Informational Note: | Whether to show a progress bar during file upload. Please note that to work this feature requires a JSON endpoint (json/uploadProgress) that is enabled by default. See the named plugin for the interface org.dspace.app.webui.json.JSONRequest org.dspace.app.webui.json.UploadProgressJSON = uploadProgress This property is actually supported only by the JSPUI. The XMLUI doesn't yet provide a progress bar indicator for file upload. |
...
DSpace 4.0 introduced integration with the Sherpa/RoMEO Publishers Policy Database in order to allow displaying the publisher policy in the submission upload step. The submission step interface is available in JSPUI (since DSpace 4.0) and in XMLUI (since DSpace 5.0) and enabled by default, however to use it in production (over 500 requests per day), you must register for a free API key (see below for details).
Property: | webui.submission.sherparomeo-policy-enabled |
Example Value: | webui.submission.sherparomeo-policy-enabled = true |
Informational Note: | Controls whether or not the UI submission should try to use the Sherpa/RoMEO Publishers Policy Database Integration (default true) |
Property: | sherpa.romeo.url |
Example Value: | sherpa.romeo.url = http://www.sherpa.ac.uk/romeo/api29.php |
Informational Note: | The Sherpa/RoMEO endpoint. Shared with the authority control feauture for Journal Title autocomplete see AuthorityControlSettings |
Property: | sherpa.romeo.apikey |
Example Value: | sherpa.romeo.apikey = YOUR-API-KEY |
Informational Note: | Allow to use a specific API key to raise the usage limit (500 calls/day for unregistred user). You can register for a free api access key at http://www.sherpa.ac.uk/news/romeoapikeys.htm |
...
Configuring Creative Commons License
This enables The following configurations are for the Creative Commons license step in the submission process of either the JSP or XML User Interface (JSP UI or XML UI). Submitters are given an opportunity to select a Creative Common license to accompany the item. Creative Commons licenses govern the use of the content. For further details, refer to the Creative Commons website at at http://creativecommons.org .
Creative Commons licensing is enabled as one step of the configurable submission process, and therefore optionally available and may be configured for any given collection that has a defined submission sequence, or be part of the "default" submission process. This process is described in the "Customizing and Configuring the Submission User Interface" section of this manual. There is a Creative Commons step already defined (step 5), but it is commented out, so enabling Creative Commons licensing is typically just a matter of uncommenting the CC License step.
Since DSpace 5.6 For the JSP UI, Creative Commons licensing is effected by opening an Iframe to the Creative Commons site and capturing the selection result in several bitstreams, but the XML UI utilizes a more flexible web service. By default, when a license is selected in the interface, the URI for the license is stored in the 'captured in exactly the same way in each UI. The Create Commons REST API is utilized. This allows DSpace to store metadata references to the selected CC license, while also storing the CC License as a bitstream. The following CC License information are captured:
- The URL of the CC License is stored in the "dc.rights.uri
...
- " metadata field
...
- (or whatever field is configured in the "cc.license.uri" setting below)
- The name of the CC License is stored in the "dc.rights" metadata field (or whatever field is configured in the "cc.license.name" setting below). This only occurs if "cc.submit.setname=true" (default value)
- The RDF version of the CC License is stored in a bitstream named "license_rdf" in the CC-LICENSE bundle (as long as "cc.submit.addbitstream=true", which is the default value)
The following configurations (in dspace.cfg) relate to the Creative Commons license process:
Property: |
|
Example Value: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: | Should a jurisdiction be used? If so, which one? See http://creativecommons.org/international/ for a list of possible codes (e.g. nz = New Zealand, uk = England and Wales, jp = Japan) Commenting out this field will cause DSpace to select the latest, unported CC license (currently version 4.0). However, as Creative Commons 4.0 does not provide jurisdiction specific licenses, if you specify this setting, your DSpace will continue to use older, Creative Commons 3.0 jurisdiction licenses. |
WEB User Interface Configurations
...
Property: | webui.licence_bundle.show |
Example Value: | webui.licence_bundle.show = false |
Informational Note: | Sets whether to display the contents of the license bundle (often just the deposit license in the standard DSpace installation). |
Property: |
|
Example Value: |
|
Informational Note: | Controls whether to display thumbnails on browse and search result pages. If you have customized the Browse columnlist, then you must also include a "thumbnail" column in your configuration. _(This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them)._ |
Property: |
|
Example Value: |
|
Informational Note: | This property determines the maximum height of the browse/search thumbnails in pixels (px). This only needs to be set if the thumbnails are required to be smaller than the dimensions of thumbnails generated by MediaFilter. |
Property: |
|
Example Value: |
|
Informational Note: | This determines the maximum width of the browse/search thumbnails in pixels (px). This only needs to be set if the thumbnails are required to be smaller than the dimensions of thumbnails generated by MediaFilter. |
Property: |
|
Example Value: |
|
Informational Note: | This determines whether or not to display the thumbnail against each bitstream. (This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them). |
Property: |
|
Example Value: |
|
Informational Note: | This determines where clicks on the thumbnail in browse and search screens should lead. The only values currently supported are "item" or "bitstream", which will either take the user to the item page, or directly download the bitstream. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum width of generated thumbnails that are being displayed on item pages. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum height of generated thumbnails that are being displayed on item pages. |
Property: |
|
Example Value: |
|
Informational Note: | Whether or not the user can "preview" the image. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum width for the preview image. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum height for the preview image. |
Property: |
|
Example Value: |
|
Informational Note: | This is the brand text that will appear with the image. |
Property: |
|
Example Value: |
|
Informational Note: | An abbreviated form of the full Branded Name. This will be used when the preview image cannot fit the normal text. |
Property: |
|
Example Value: |
|
Informational Note: | The height (in px) of the brand. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the font for your Brand text that appears with the image. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the font point (size) for your Brand text that appears with the image. |
Property: |
|
Example Value: |
|
Informational Note: | The Dublin Core field that will display along with the preview. This field is optional. |
Property: |
|
Example Value: |
|
Informational Note: | Determines if communities and collections should display item counts when listed. The default behavior if omitted, is true. (This configuration property key is not used by XMLUI. To show strengths using XMLUI, you need to create a theme which displays them)false. |
Property: |
|
Example Value: |
|
Informational Note: | When showing the strengths, should they With Discovery enabled (by default), this option does nothing. |
...
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
Defining the Indexes
...
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:metadataitem:dc.title: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 ofwebui.browse.index.<n> = <index-name> :
...
item : <sort-type> : (asc | desc)
- "
metadata
" indexes which have a format ofwebui.browse.index.<n> = <index-name> : metadata : <comma-separated-list-of-metadata-fields> : (date | text) : (asc | dec)
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) |
---|---|
| |
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 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: (JSPUI) or messages.xml (XMLUI) with new message keys referencing this <index-name>. JSPUI Example (Messages.properties):
XMLUI Example (messages. |
| Only two options are available: " |
| The schema used for the field to be 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. 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 of the field: |
| Choose |
If you are customizing this list beyond the default, you will need to insert the text you wish to appear in the navigation and on link and buttons. You need to edit the Messages.properties
file. The form of the parameter(s) in the file:
browse.type.<index name>
Defining Sort Options
Info |
---|
If you make changes in this section be sure to update your SOLR indexes running the Discovery Maintenance Script, see Discovery |
Sort options will be available when browsing a list of items (i.e. only in "full" mode, not "single" mode). 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:
Code Block |
---|
webui.itemlist.sort-option.1 = title:dc.title:title
webui.itemlist.sort-option.2 = dateissued:dc.date.issued:date
webui.itemlist.sort-option.3 = dateaccessioned:dc.date.accessioned:date |
The format of each entry is web.browse.sort-option.<n> = <option name>:<schema prefix>.<element>.<qualifier>:<datatype>
. Please notice the punctuation used between the different elements. The following table explains the each element:
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 sort type / data type of the field:
|
| (Optional) The default sort order. Choose |
Defining Sort Options
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 (see also the "item
" index type above). You can define an arbitrary number of fields to sort on. For example, the default entries that appear in the dspace.cfg as default installation:
Code Block |
---|
webui.itemlist.sort-option.1 = title:dc.title:title
webui.itemlist.sort-option.2 = dateissued:dc.date.issued:date
webui.itemlist.sort-option.3 = dateaccessioned:dc.date.accessioned:date |
The format of each entry is web.browse.sort-option.<n> = <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 is the name by which it is referred in the "webui.browse.index" settings (see Defining the Indexes). |
| |
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. |
| 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: |
Browse Index Normalization Rule Configuration
...
Property: |
|
Example Value: |
|
Informational Note: |
Tag cloud
Apart from the single (type=metadata) and full (type=item) browse pages, tag cloud is a new way to display the unique values of a metadata field.
...
Property: |
|
Example Value: |
|
Informational Note: | The directory where the generate sitemaps are stored. |
Property: |
|
Example Value: | _sitemap.engineurls = http://www.google.com/webmasters/sitemaps/ping?sitemap=_ |
Informational Note: | Comma-separated list of search engine URLs to "ping" when a new Sitemap has been created. Include everything except the Sitemap UL itself (which will be URL-encoded and appended to form the actual URL "pinged").Add the following to the above parameter if you have an application ID with Yahoo: http://search.yahooapis.com/SiteExplorererService/V1/updateNotification?appid=REPLACE_ME?url=_ . (Replace the component _REPLACE_ME with your application ID). There is no known "ping" URL for MSN/Live search. |
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | This is used to customize the DC metadata fields that display in the item display (the brief display) when pulling up a record. The format is: | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | When using "resolver" in webui.itemdisplay to render identifiers as resolvable links, the base URL is taken from <code>webui.resolver.<n>.baseurl<code> where <code>webui.resolver.<n>.baseurl<code> matches the urn specified in the metadata value. The value is appended to the "baseurl" as is, so the baseurl needs to end with the forward slash almost in any case. If no urn is specified in the value it will be displayed as simple text. For the doi and hdl urn defaults values are provided, respectively http://dc.doi.org and http://hdl.handle.net are used. If a metadata value with style "doi", "handle" or "resolver" matches a URL already, it is simply rendered as a link with no other manipulation. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which strategy to use for select the style for an item. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which collections use which views by Handle. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which metadata to use as name of the style | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Customize the DC fields to use in the item listing page. Elements will be displayed left to right in the order they are specified here. The form is <schema prefix>.<element>[.<qualifier> | .*][(date)], ... | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | You can customize the width of each column with the following line--you can have numbers (pixels) or percentages. For the 'thumbnail' column, a setting of '*' will use the max width specified for browse thumbnails (cf. | ||
Property: |
| ||
Example Value: | |||
Informational Note: | You can override the DC fields used on the listing page for a given browse index and/or sort option. As a sort option or index may be defined on a field that isn't normally included in the list, this allows you to display the fields that have been indexed/sorted on. There are a number of forms the configuration can take, and the order in which they are listed below is the priority in which they will be used (so a combination of an index name and sort name will take precedence over just the browse name).In the last case, a sort option name will always take precedence over a browse index name. Note also, that for any additional columns you list, you will need to ensure there is an itemlist.<field name> entry in the messages file. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This would display the date of the accession in place of the issue date whenever the dateaccessioned browsed index or sort option is selected. Just like webui.itemlist.columns, you will need to include a 'thumbnail' entry to display the thumbnails in the item list. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | As in the aforementioned property key, you can customize the width of the columns for each configured column list, substituting ".widths" for ".columns" in the property name. See the setting for webui.itemlist.widths for more information. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | You can also set the overall size of the item list table with the following setting. It can lead to faster table rendering when used with the column widths above, but not generally recommended. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Enable or disable session invalidation upon login or logout. This feature is enabled by default to help prevent session hijacking but may cause problems for shibboleth, etc. If omitted, the default value is "true". [Only used for JSPUI authentication]. | ||
| |||
Example Value: | jspui.google.analytics.key = UA-XXXXXX-X | ||
Informational Note: | If you would like to use Google Analytics to track general website statistics then use the following parameter to provide your Analytics key. |
...
Property: |
| |
Example Value: |
| |
|
| |
Informational Note: | SFX query is appended to this URL. If this property is commented out or omitted, SFX support is switched off. |
...
webui.submit.upload.required
JSPUI: Per item visual indicators for browse and search results
...
Visual indicators per item allow users to mark items in browse and search results. This could be useful in many scenarios, some of them follow:
...
- Multiple marks can be added per item (i.e. mark the type of the item and the availability of the bitstreams)
- Easy configuration of the strategy of what mark to display in every item
- Marks based on images or a generic class (i.e. a glyphicon icon for bootstrap)
- Display tooltip when hovering the mark + localization of the tooltip
- Easy addtion of new strategies for any type of mark the user desires
- Add css styles for the user to configure the position of the marks in the list row
Some theory:
A mark is an instance of the class: org.dspace.app.itemmarking.ItemMarkingInfo.
...
Moreover, this strategy add a link in the mark (in case there are bitstreams in the item) to the first bitstream of the item
...
How to:
In order to enable a mark for the result or browse list you need to change the option:
...
Keep in mind that the Strategy that you may write can have its own logic on how to create the ItemMarkingInfo per item. The only requirement of the feature is to add in the Spring configuration file the initial beans one for each mark you have declared in the dspace.cfg file.
Styling:
The title for the column of each mark is titled based on the localized key “itemlist.mark_[value]”, so you just need to add the specific keys in the messages.propertied files.
...
Add these classes to the css file and apply any style you like (like centering the text or the image)
Optimized 'Select Collection' Performance
Property: |
|
Example Value: |
|
Informational Note: | Enable performance optimization for select-collection-step collection query (for example, in the dropdown lists used to select a collection for item submission). |
Warning | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Since DSpace 5.6 Creative Commons licensing is captured in exactly the same way in each UI and some fix has been introduced. For JSPUI users this mean:
For XMLUI users:
|
|