Page History

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.

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

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

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.

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.

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

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)

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.

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). UNSUPPORTED in DSpace 7.0

Example Value:

webui.browse.thumbnail.show maxwidth = true80

Informational Note:

This property sets the maximum width of generated thumbnails that are being displayed on item pages.

Example Value:

thumbnail.maxheight = 80

Informational Note:

This property sets the maximum height of generated thumbnails that are being displayed on item pagesControls 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).

Example Value:

webui.browsepreview.thumbnail.maxheight maxwidth = 80600

Informational Note:

This property determines sets 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.width for the preview image.  Only used for BrandedPreviewJPEGFilter

Example Value:

webui.browsepreview.thumbnail.maxwidth maxheight = 80600

Informational Note:

This determines property sets 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.height for the preview image.  Only used for BrandedPreviewJPEGFilter

Example Value:

webui.preview.brand = My Institution Name

Informational Note:

This is the brand text that will appear with the image.  Only used for BrandedPreviewJPEGFilter

Example Value:

webui.itempreview.thumbnailbrand.show abbrev = trueMyOrg

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).An abbreviated form of the full Branded Name. This will be used when the preview image cannot fit the normal text.  Only used for BrandedPreviewJPEGFilter

Example Value:

webui.browsepreview.thumbnailbrand.linkbehavior height = item20

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.

The height (in px) of the brand.  Only used for BrandedPreviewJPEGFilter

Example Value:

thumbnail.maxwidth = 80webui.preview.brand.font = SansSerif

Informational Note:

This property sets the maximum width of generated thumbnails that are being displayed on item pages.font for your Brand text that appears with the image.  Only used for BrandedPreviewJPEGFilter

Example Value:

thumbnail.maxheight = 80webui.preview.brand.fontpoint = 12

Informational Note:

This property sets the maximum height of generated thumbnails that are being displayed on item pages.font point (size) for your Brand text that appears with the image.  Only used for BrandedPreviewJPEGFilter

Example Value:

webui.preview.enabled dc = falserights

Informational Note:

Whether or not the user can "preview" the image.The Dublin Core field that will display along with the preview. This field is optional. Only used for BrandedPreviewJPEGFilter

Example Value:

webui.previewstrengths.maxwidth cache = 600false

Informational Note:

This property sets the maximum width for the preview image.

Example Value:

webui.preview.maxheight = 600

Informational Note:

This property sets the maximum height for the preview image.

Example Value:

webui.preview.brand = My Institution Name

Informational Note:

When showing the strengths (i.e. item counts), should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count of the index contents every time a page with this feature is requested, which may not scale. If you set the property key is set to cache ("true"), the counts will be cached on first load  

Example Value:

webui.previewbrowse.brandindex.abbrev = MyOrg

Informational Note:

An abbreviated form of the full Branded Name. This will be used when the preview image cannot fit the normal text.

1 = dateissued:item:dateissued


webui.

browse.

Example Value:

webui.preview.brand.height = 20index.2 = author:metadata:dc.contributor.*,dc.creator:text

Informational Note:

The height (in px) of the brandThis is an example of how one "Defines the Indexes". See "Defining the Indexes" in the next sub-section.

Example Value:

webui.previewitemlist.brandsort-option.font = SansSerif1 = title:dc.title:title

Informational Note:

This property sets the font for your Brand text that appears with the imageis an example of how one "Defines the Sort Options". See "Defining Sort Options" in the following sub-section.

Example Value:

webui.preview.brand.fontpoint = 12browseDAO.class = org.dspace.browse.SolrBrowseDAO

Informational Note:

This property sets the font point (size) for your Brand text that appears with the image.

Example Value:

webui.preview.dc = rights

Informational Note:

The Dublin Core field that will display along with the preview. This field is optional.

Example Value:

webui.strengths.show = false

Informational Note:

Determines if communities and collections should display item counts when listed. The default behavior if omitted, is false.

Example Value:

webui.strengths.cache = false

Informational Note:

When showing the strengths (i.e. item counts), should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count of the index contents every time a page with this feature is requested, which may not scale. If you set the property key is set to cache ("true"), the counts will be cached on first load  

Example Value:

webui.browse.index.1 = dateissued:item:dateissued
webui.browse.index.2 = author:metadata:dc.contributor.*,dc.creator:text

Informational Note:

This is an example of how one "Defines the Indexes". See "Defining the Indexes" in the next sub-section.

Example Value:

webui.itemlist.sort-option.1 = title:dc.title:title

Informational Note:

This is an example of how one "Defines the Sort Options". See "Defining Sort Options" in the following sub-section.

Example Value:

browseDAO.class = org.dspace.browse.SolrBrowseDAO

Informational Note:

This property configures the Java class that is used for READ operations by the Browse System. You need to have Discovery enabled (this is the default since DSpace 4.0) to use the Solr Browse DAOs

configures the Java class that is used for READ operations by the Browse System. You need to have Discovery enabled (this is the default since DSpace 4.0) to use the Solr Browse DAOs

webui.browse.index.<n>

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

<index-name>

The name by which the index will be identified. In order for the DSpace UI to display human-friendly description for this index, you'll need to update either your Messages.properties (JSPUI) or messages.xml (XMLUI) with new message keys referencing this <index-name>.

JSPUI Example (Messages.properties):

• browse.type.metadata.<index-name> = My New Field

XMLUI Example

webui.browse.index.<n>

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

<index-name>

The name by which the index will be identified. In order for the DSpace UI to display human-friendly description for this index, you'll need to update either your Messages.properties (JSPUI) or messages.xml (XMLUI) with new message keys referencing this <index-name>.

JSPUI Example (Messages.properties):

• browse.type.metadata.<index-name> = My New Field

XMLUI Example (messages.xml):

• <message key= "xmlui.ArtifactBrowser.Navigation.browse_<index-name>" >My New Fields</message>
• <message key= "xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.<index-name>" >Browsing { 0 } by My New Field { 1 }</message>
• <message key= "xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.<index-name>" >Browsing { 0 } by My New Field</message>
• <message key= "xmlui.ArtifactBrowser.ConfigurableBrowse.<index-name>.column_heading" >My New Field</message>

(metadata|item)

Only two options are available: "metadata" or "item"

• "metadata" indexes allow you to index all items based on one or more metadata fields. The list of fields should be provided as part of the "metadata" configuration. Only items which have values for these fields will appear in this index (e.g. if you have a "metadata" index for "dc.subject.*", an item will not appear in that browse/search if it doesn't have a "dc.subject.*" value). The browse index will have to parts: first it lists all values of the specified metadata fields. If the user select one of these values the index lists all items in which the specified metadata field is assigned with the selected value.
  
  • Note: If you set a <sort-type> to be used, this sort type is not used on the values of the metadata fields but on the order of the items when listing all items that have a specific value of the metadata field.
• "item" indexes provide you with a browseable list of ALL items in the site, sorted by a particular metadata field. The field this index is sorted by is referenced by <sort-option-name> (which should refer to a corresponding "webui.itemlist.sort-option.<n>" setting... see Defining Sort Options below for more information)

<schema-prefix>

(Only for "metadata" indexes) The schema used for the field to be index. The default is dc (for Dublin Core).

<element>

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

<qualifier>

<sort-type>

(Optional, should be set for "item" indexes) This refers to the sort type / data type of the field:

• date the index type will be treated as a date object and sorted as such
• text the index type will be treated as plain text and sorted as such
• (any other value refers to a custom <sort-type> which should be defined in a corresponding webui.itemlist.sort-option.<n> setting. See Defining Sort Options below for more information.)

<sort-order>

(Optional) The default sort order. Choose asc (ascending) or desc (descending).  Ascending is the default value, but descending may be useful for date-based indexes (e.g. to display most recent submissions first)

displayScore

Should display the score of each tag next to it? Default: false

shouldCenter

Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true

totalTags

How many tags will be shown. Value -1 means all of them. Default: -1

cloudCase

The letter case of the tags.

Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE

Default: Case.PRESERVE_CASE

randomColors

If the 3 css classes of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true

fontFrom

The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1

fontTo

The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2

cuttingLevel

The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0

cloudCaseordering

The ordering letter case of the tags (based either on the name or the score of the tag).

Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc

Default: Tag.GreekNameComparatorAsc

Example Value:

webui.browse.author-field = dc.contributor.*

Informational Note:

This defines which field is the author/editor, etc. listing.

Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE

Default: Case.PRESERVE_CASE

randomColors

If the 3 css classes of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true

fontFrom

The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1

fontTo

The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2

cuttingLevel

The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0

ordering

The ordering of the tags (based either on the name or the score of the tag)

Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc

Default: Tag.GreekNameComparatorAsc

Example Value:

webui.browse.author-limit = < n >