Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please note that there are in fact two options available, choose whichever you prefer :-

  • '"ant update_configs' " ==> Moves existing configs in [dspace]/config/ to *.old files and replaces them with what is in [dspace-source]/dspace/config/
  • '"ant -Doverwrite=false update_configs' " ==> Leaves existing configs in [dspace]/config/ intact. Just copies new configs from
    [dspace-source]/dspace/config/ over to *.new files.

...

Property:

jspui.search.index.display.< n >

Example Value

          jspui.search.index.display.1 = ANY

Informational Note:

Set the N-value of the index dropdown in the advanced search form. The value must match one of the defined index

...

The MODS crosswalk properties file is a list of properties describing how DSpace metadata elements are to be turned into elements of the MODS XML output document. The property name is a concatenation of the metadata schema, element name, and optionally the qualifier. For example, the contributor.author element in the native Dublin Core schema would be: dc.contributor.author. The value of the property is a line containing two segments separated by the vertical bar ("|"_): The first part is an XML fragment which is copied into the output document. The second is an XPath expression describing where in that fragment to put the value of the metadata element. For example, in this property:

Code Block
languagehtml/xml
dc.contributor.author = <mods:name>
				<mods:role>
					                            <mods:role>
                                <mods:roleTerm type="text">author</mods:roleTerm>
                        	</mods:role>
                             		<mods:namePart>%s</mods:namePart>
                        </mods:name>

Some of the examples include the string "%s" in the prototype XML where the text value is to be inserted, but don't pay any attention to it, it is an artifact that the crosswalk ignores. For example, given an author named Jack Florey, the crosswalk will insert

Code Block
languagehtml/xml
<mods:name>
    <mods:role>
        <mods:roleTerm type="text">author</mods:roleTerm>
    </mods:role>
    <mods:namePart>Jack Florey</mods:namePart>
</mods:name>

...

DSpace embargoes utilize standard metadata fields to hold both the '"terms' " and the '"lift date'". Which fields you use are configurable, and no specific metadata element is dedicated or predefined for use in embargo. Rather, you specify exactly what field you want the embargo system to examine when it needs to find the terms or assign the lift date.

...

This enables 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 http://creativecommons.org . Creative Commons licensing is enabled as one step of the configurable submission process, and therefore 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 Submission User Interface' section " 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. 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 'dc.rights.uri' metadata field for the Item, and a representation of the license text is stored in a license bundle. In addition, the following properties in [dspace]/config/dspace.cfg may be customized for use:

Property:

cc.api.rooturl

Example Value:

cc.api.rooturl = http://api.creativecommons.org/rest/1.5

Informational Note:

Generally will never have to assign a different value - this is the base URL of the Creative Commons service API.

Property:

cc.license.uri

Example Value:

cc.license.uri = dc.rights.uri

Informational Note:

The field that holds the Creative Commons license URI. If you change from the default value (dc.rights.uri), you will have to reconfigure the XMLUI for proper display of license data

Property:

cc.license.name

Example Value:

cc.license.name = dc.rights

Informational Note:

The field that holds the Creative Commons license Name. If you change from the default value (dc.rights), you will have to reconfigure the XMLUI for proper display of license data

Property:

cc.submit.setname

Example Value:

cc.submit.setname = true

Informational Note:

If true, the license assignment will add the field configured with the '"cc.license.name' " with the name of the CC license; if false, only '"cc.license.uri' " field is added.

Property:

cc.submit.addbitstream

Example Value:

cc.submit.addbitstream = true

Informational Note:

If true, the license assignment will add a bitstream with the CC license RDF; if false, only metadata field(s) are added.

Property:

cc.license.classfilter

Example Value:

cc.license.classfilter = recombo,mark

Informational Note:

This list defines the values that will be excluded from the license (class) selection list, as defined by the web service at the URL: http://api.creativecommons.org/rest/1.5/classes

Property:

cc.license.jurisdiction

Example Value:

cc.license.jurisdiction = nz

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)

...

Property:

websvc.opensearch.enable

Example Value:

websvc.opensearch.enable = false

Informational Note:

Whether or not OpenSearch is enabled. By default, the feature is disabled. Change the property key to '"true' " to enable.

Property:

websvc.opensearch.uicontext

Example Value:

websvc.opensearch.uicontext = simple-search

Informational Note:

Context for HTML request URLs. Change only for non-standard servlet mapping.
IMPORTANT: If you are using XMLUI and have Discovery enabled, this property's value should be changed to discover.

Property:

websvc.opensearch.svccontext

Example Value:

websvc.opensearch.svccontext = open-search/

Informational Note:

Context for RSS/Atom request URLs. Change only for non-standard servlet mapping.
IMPORTANT: If you are using XMLUI and have Discovery enabled, this property's value should be changed to open-search/discover.

Property:

websvc.opensearch.autolink

Example Value:

websvc.opensearch.autolink = true

Informational Note:

Present autodiscovery link in every page head.

Property:

websvc.opensearch.validity

Example Value:

websvc.opensearch.validity = 48

Informational Note:

Number of hours to retain results before recalculating. This applies to the Manakin interface only.

Property:

websvc.opensearch.shortname

Example Value:

websvc.opensearch.shortname = DSpace

Informational Note:

A short name used in browsers for search service. It should be sixteen (16) or fewer characters.

Property:

websvc.opensearch.longname

Example Value:

websvc.opensearch.longname = ${dspace.name}

Informational Note:

A longer name up to 48 characters.

Property:

websvc.opensearch.description

Example Value:

websvc.opensearch.description = ${dspace.name} DSpace repository

Informational Note:

Brief service description

Property:

websvc.opensearch.faviconurl

Example Value:

_websvc.opensearch.faviconurl = http://www.dspace.org/images/favicon.ico_

Informational Note:

Location of favicon for service, if any. They must by 16 x 16 pixels. You can provide your own local favicon instead of the default.

Property:

websvc.opensearch.samplequery

Example Value:

websvc.opensearch.samplequery = photosynthesis

Informational Note:

Sample query. This should return results. You can replace the sample query with search terms that should actually yield results in your repository.

Property:

websvc.opensearch.tags

Example Value:

websc.opensearch.tags = IR DSpace

Informational Note:

Tags used to describe search service.

Property:

websvc.opensearch.formats

Example Value:

websvc.opensearch.formats = html,atom,rss

Informational Note:

Result formats offered. Use one or more comma-separated from the list: html, atom, rss. Please note that html is required for auto discovery in browsers to function, and must be the first in the list if present.

...

Property:

sitemap.dir

Example Value:

sitemap.dir = ${dspace.dir}/sitemaps

Informational Note:

The directory where the generate sitemaps are stored.

Property:

sitemap.engineurls

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.

Authority Control Settings

...

google analytics

Property:

webui.itemdisplay.default

Example Value:

Code Block
webui.itemdisplay.default = dc.title, dc.title.alternative, \
           dc.contributor.*, dc.subject, dc.data.issued(date), \
           dc.publisher, dc.identifier.citation, \
           dc.relation.ispartofseries, dc.description.abstract, \
           dc.description, dc.identifier.govdoc, \
           dc.identifier.uri(link), dc.identifier.isbn, \
           dc.identifier.issn, dc.identifier.ismn, dc.identifier

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: <schema>.<element>.<_optional_qualifier> . In place of the qualifier, one can use the wildcard "*" to include all fields of the same element, or, leave it blank for unqualified elements. Additionally, two additional options are available for behavior/rendering: (date) and (link). See the following examples:

dc.title = Dublin Core element '"title' " (unqualified)
dc.title.alternative = DC element '"title'", qualifier '"alternative' "
dc.title.* = All fields with Dublin Core element 'title' (any or no qualifier)
dc.identifier.uri(link) = DC identifier.uri, rendered as a link
dc.date.issued(date) = DC date.issued, rendered as a date
The Messages.properties file controls how the fields defined above will display to the user. If the field is missing from the _Messages.properties_ file, it will not be displayed. Look in Messages.properties}} under {{the metadata.dc.<field>. Example:
metadata.dc.contributor.other = Authors
metadata.dc.contributor.author = Authors
metadata.dc.title.* = Title
Please note: The order in which you place the values to the property key control the order in which they will display to the user on the outside world. (See the Example Value above).

Property:

Code Block
webui.resolver.1.urn
webui.resolver.1.baseurl
webui.resolver.2.urn
webui.resolver.2.baseurl

Example Value:

Code Block
webui.resolver.1.urn = doi
webui.resolver.1.baseurl = http://dx.doi.org/
webui.resolver.2.urn = hdl
webui.resolver.2.baseurl = http://hdl.handle.net/

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:

plugin.single.org.dspace.app.webui.util.StyleSelection

Example Value:

Code Block
plugin.single.org.dspace.app.webui.util.StyleSelection = \
  org.dspace.app.web.util.CollectionStyleSelection
  #org.dspace.app.web.util.MetadataStyleSelection

Informational Note:

Specify which strategy to use for select the style for an item.

Property:

webui.itemdisplay.thesis.collections

Example Value:

webui.itemdisplay.thesis.collections = 123456789/24, 123456789/35

Informational Note:

Specify which collections use which views by Handle.

Property:

Code Block
webui.itemdisplay.metadata-style
webui.itemdisplay.metadata-style

Example Value:

Code Block
webui.itemdisplay.metadata-style = schema.element[.qualifier|.*]
webui.itemdisplay.metadata-style = dc.type

Informational Note:

Specify which metadata to use as name of the style

Property:

webui.itemlist.columns

Example Value:

Code Block
webui.itemlist.columns = thumbnail, dc.date.issued(date), dc.title, \
          dc.contributor.*

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)], ...
Although not a requirement, it would make sense to include among the listed fields at least the date and title fields as specified by the webui.browse.index configuration options in the next section mentioned. (cf.)
If you have enabled thumbnails (webui.browse.thumbnail.show), you must also include a 'thumbnail' entry in your columns‚ this is where the thumbnail will be displayed.

Property:

webui.itemlist.width

Example Value:

webui.itemlist.width = *, 130, 60%, 40%

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. webui.browse.thumbnail.maxwidth, thumbnail.maxwidth)

Property:

Code Block
webui.itemlist.browse.<index name>.sort.<sort name>.columns
webui.itemlist.sort.<sort name>.columns
webui.itemlist.browse.<browse name>.columns
webui.itemlist.<sort or index name>.columns

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:

webui.itemlist.dateaccessioned.columns

Example Value:

webui.itemlist.dateaccessioned.columns = thumbnail, dc.date.accessioned(date), dc.title, dc.contributor.*

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:

webui.itemlist.dateaccessioned.widths

Example Value:

webui.itemlist.dateaccessioned.widths = *, 130, 60%, 40%

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:

webui.itemlist.tablewidth

Example Value:

webui.itemlist.tablewidth = 100%

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:

webui.session.invalidate

Example Value:

webui.session.invalidate = true

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].

Property:

jspui.google.analytics.key

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.

JSPUI Configuring Multilingual Support

...