All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
The full table of contents follows:
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
In the following sections you will learn about the different configuration files that you will need to edit so that you may make your DSpace installation work. Of the several configuration files which you will work with, it is the dspace.cfg file you need to learn to configure first and foremost.
...
The property value may contain references to other configuration properties, in the form ${property.name
}. This follows the ant convention of allowing references in property files. A property may not refer to itself. Examples:
Code Block |
---|
property.name = word1 ${other.property.name} more words
property2.name = ${dspace.dir}/rest/of/path
|
Property values can include other, previously defined values, by enclosing the property name in ${...}. For example, if your dspace.cfg contains:
Code Block |
---|
dspace.dir = /dspace
dspace.history = ${dspace.dir}/history |
...
Things you should know about editing dspace.cfg
files.
It is important to remember that there are * two dspace.cfg
files after an installation of DSpace.*
[dspace-source
\]/dspace/config/dspace.cfg
}}[dspace
\]/config/dspace.cfg
}}
dspace.cfg
}} in addition to the runtime file. The two files should always be identical, since the source {{dspace.cfg
}} will be the basis of your next upgrade. To keep the two files in synchronization, you can edit your files in {{\ Wiki Markup [dspace-source
\]/dspace/config/
}} and then you would run the following commands:
Code Block |
---|
cd [dspace-source]/dspace/ mvn package cd [dspace-source]/dspace/target/dspace-<version>-build.dir ant update_configs |
This will copy the source {{ Wiki Markup dspace.cfg
}} (along with other configuration files) into the runtime ({{\[dspace
\]/config
}}) directory.
You should remember that after editing your configuration file(s), and you are done and wish to implement the changes, you will need to:
...
ant
\ -Dconfig=
\[dspace
\]/config/dspace.cfg
update
}} if you are updating your {{dspace.cfg
}} file and wish to see the changes appear. Follow the usual sequence with copying your webapps.dspace.cfg
Configuration Properties File...
...
Sometimes DSpace automatically sends e-mail messages to users, for example, to inform them of a new work flow task, or as a subscription e-mail alert. The wording of emails can be changed by editing the relevant file in {{\[dspace
\]/config/emails
}} . Each file is commented. Be careful to keep the right number 'placeholders' (e.g._\{2\}_).
Note: You should replace the contact-information "dspace-help@myu.edu or call us at xxx-555-xxxx
" with your own contact details in:
config/emails/change_password
config/emails/register
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | This is Asset (bitstream) store number 0 (Zero). You need not place your assetstore under the /dspace directory, but may want to place it on a different logical volume on the server that DSpace resides. So, you might have something like this: | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property specifies extra asset stores like the one above, counting from one (1) upwards. This property is commented out (#) until it is needed. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Informational Note: Specify the number of the store to use for new bitstreams with this property. The default is 0 [zero] which corresponds to the 'assestore.dir' above. As the asset store number is stored in the item metadata (in the database), always keep the assetstore numbering consistent and don't change the asset store number in the item metadata. | ]]></ac:plain-text-body></ac:structured-macro> |
Info | ||
---|---|---|
| ||
In the examples above, you can see that your storage does not have to be under the |
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | This is where your logging configuration file is located. You may override the default log4j configuration by providing your own. Existing alternatives are:
| ||
Property: |
| ||
Example value: |
| ||
Informational Note: | This is where to put the logs. (This is used for initial configuration only) | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | If your DSpace instance is protected by a proxy server, in order for log4j to log the correct IP address of the user rather than of the proxy, it must be configured to look for the X-Forwarded-For header. This feature can be enabled by ensuring this setting is set to true. This also affects IPAuthentication, and should be enabled for that to work properly if your installation uses a proxy server. |
...
In the example above, search.index.1
and search.index.2
and search.index.3
are configured as the author
search field. The author
index is created by Lucene indexing all dc.contributor.*
,dc.creator.*
and description.statementofresponsibility
metadata fields.unmigrated-wiki-markup
After changing the configuration run {{/
\[dspace
\]/bin/dspace
index-init
}} to regenerate the indexes.
While the indexes are created, this only affects the search results and has no effect on the search components of the user interface. One will need to customize the user interface to reflect the changes, for example, to add the a new search category to the Advanced Search.
...
You can also implement more dynamic or configurable Media/Format Filters which extend SelfNamedPlugin
.
Info | ||
---|---|---|
| ||
For more information on Media/Format Filters, see the section on Transforming DSpace Content (MediaFilters). |
The subsections below give configuration details based on the types of crosswalks and packager plugins you need to implement.
Info | ||
---|---|---|
| ||
For more information on using Packagers and Crosswalks, see the section on Importing and Exporting Content via Packages. |
...
Properties: |
| ||||
Example Values: |
| ||||
Informational Note: | This defines a crosswalk named MODS whose configuration comes from the file | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6a889c83-badd-4d69-aa84-c1be46e7610b"><ac:plain-text-body><![CDATA[ | Informational Note: | This defines a crosswalk named MODS whose configuration comes from the file | ]]></ac:plain-text-body></ac:structured-macro> |
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 |
---|
crosswalk.submissionPluginName.stylesheet = 1 2 3 4 |
{{ Wiki Markup crosswalk
}} first part of the property key.
{{submission}} second part of the property key.
{{PluginName}} is the name of the plugin. The _path_ value is the path to the file containing the crosswalk stylesheet (relative to {{/\[dspace\]/config}}).
Here is an example that configures a crosswalk named "LOM" using a stylesheet in {{\[dspace\
submission
second part of the property key.
PluginName
is the name of the plugin. The path value is the path to the file containing the crosswalk stylesheet (relative to /[dspace]/config
).
Here is an example that configures a crosswalk named "LOM" using a stylesheet in [dspace]/config/crosswalks/d-lom.xsl
}}:
{{crosswalk.submission.LOM.stylesheet
=
crosswalks/d-lom.xsl
}}
A dissemination crosswalk can be configured by starting with the property key _crosswalk.dissemination_. Example:
{{crosswalk.dissemination.PluginName.stylesheet
=
path
}}
The _PluginName_ is the name of the plugin (\!) . The _path_ value is the path to the file containing the crosswalk stylesheet (relative to {{/\[dspace\]/config}}
The PluginName is the name of the plugin (!) . The path value is the path to the file containing the crosswalk stylesheet (relative to /[dspace]/config
).
You can make two different plugin names point to the same crosswalk, by adding two configuration entries with the same path:
Code Block |
---|
crosswalk.submission.MyFormat.stylesheet = crosswalks/myformat.xslt
crosswalk.submission.almost_DC.stylesheet = crosswalks/myformat.xslt |
The dissemination crosswalk must also be configured with an XML Namespace (including prefix and URI) and an XML schema for its output format. This is configured on additional properties in the DSpace configuration:
Code Block |
---|
crosswalk.dissemination.PluginName.namespace.Prefix = namespace-URI
crosswalk.dissemination.PluginName.schemaLocation = schemaLocation value |
For example:
Code Block |
---|
crosswalk.dissemination.qdc.namespace.dc = http://purl.org/dc/elements/1.1/
crosswalk.dissemination.qdc.namespace.dcterms = http://purl.org/dc/terms/
crosswalk.dissemination.qdc.schemalocation = http://purl.org/dc/elements/1.1/ \
http://dublincore.org/schemas/xmls/qdc/2003/04/02/qualifieddc.xsd |
...
Testing the submission crosswalk is more difficult, so we have supplied a command-line utility to help. It calls the crosswalk plugin to translate an XML document you submit, and displays the resulting intermediate XML (DIM). Invoke it with:
Code Block |
---|
[dspace]/bin/dspace dsrun
org.dspace.content.crosswalk.XSLTIngestionCrosswalk [-l] plugin input-file |
...
Properties: |
| ||
Example Value: |
| ||
Properties: |
| ||
Example Value: |
| ||
Properties: |
| ||
Example Value: |
| ||
Properties: |
| ||
Example Value: |
| ||
Informational Note: | Configuration of the QDC Crosswalk dissemination plugin for Qualified DC. (Add lower-case name for OAI-PMH. That is, change QDC to qdc.)}} |
...
In the property key "{{crosswalk.qdc.properties.QDC
}}" the value of this property is a path to a separate properties file containing the configuration for this crosswalk. The pathname is relative to the DSpace configuration directory {{/
\[dspace
\]/config
}} . Referring back to the "Example Value" for this property key, one has {{crosswalks/qdc.properties
}} which defines a crosswalk named {{QDC
}} whose configuration comes from the file {{\[dspace
\]/config/crosswalks/qdc.properties
}} .
You will also need to configure the namespaces and schema location strings for the XML output generated by this crosswalk. The namespaces properties names are formatted:
...
You can add names for the existing plugins, and add new plugins, by altering these configuration properties. See the Plugin Manager architecture for more information about plugins.
...
Property: |
|
Example Value: |
|
Informational Note: | Embargo terms will be stored in the item metadata. This property determines in which metadata field these terms will be stored. An example could be dc.embargo.terms |
Property: |
|
Example Value: |
|
Informational Note: | The Embargo lift date will be stored in the item metadata. This property determines in which metadata field the computed embargo lift date will be stored. You may need to create a DC metadata field in your Metadata Format Registry if it does not already exist. An example could be dc.embargo.liftdate |
Property: |
|
Example Value: |
|
Informational Note: | You can determine your own values for the embargo.field.terms property (see above). This property determines what the string value will be for indefinite embargos. The string in terms field to indicate indefinite embargo. |
Property: |
|
Example Value: |
|
Informational Note: | To implement the business logic to set your embargos, you need to override the EmbargoSetter class. If you use the value DefaultEmbargoSetter, the default implementation will be used. |
Property: |
|
Example Value: |
|
Informational Note: | To implement the business logic to lift your embargos, you need to override the EmbargoLifter class. If you use the value DefaultEmbargoLifter, the default implementation will be used. |
Key Recommendations:
After the fields defined for terms and lift date have been assigned in dspace.cfg, and created and configured wherever they will be used, you can begin to embargo items simply by entering data (dates, if using the default setter) in the terms field. They will automatically be embargoed as they exit workflow. For the embargo to be lifted on any item, however, a new administrative procedure must be added: the 'embargo lifter' must be invoked on a regular basis. This task examines all embargoed items, and if their 'lift date' has passed, it removes the access restrictions on the item. Good practice dictates automating this procedure using cron jobs or the like, rather than manually running it. The lifter is available as a target of the 1.6 DSpace launcher: see Section 8.
The 1.6 Embargo system supplies a default 'interpreter/imposition' class (the 'Setter') as well as a 'Lifter', but they are fairly rudimentary in several aspects.
Code Block |
---|
# implementation of embargo setter plugin - replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DefaultEmbargoSetter |
Code Block |
---|
# implementation of embargo lifter plugin--replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoLifter = org.dspace.embargo.DefaultEmbargoLifter |
Wiki Markup |
---|
Expose the metadata field. Edit _\[dspace\]/config/input-forms.xml_ . If you have only one form‚ usually 'traditional', add it there. If you have multiple forms, add it only to the forms linked to collections for which embargo applies: |
Code Block |
---|
<form name="traditional">
<page number="1">
...
<field>
<dc-schema>dc</dc-schema>
<dc-element>description</dc-element>
<dc-qualifier>embargo</dc-qualifier>
<repeatable>false</repeatable>
<label>Embargo Date</label>
<input-type>onebox</input-type>
<hint>If required, enter date 'yyyy-mm-dd' when embargo expires or 'forever'.</hint>
<required></required>
</field>
|
Wiki Markup |
---|
Configure Embargo. Edit _\[dspace\]/config/dspace.cfg_. Find the Embargo properties and set these two: |
Code Block |
---|
# DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = dc.description.embargo
# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = dc.description.embargo |
Wiki Markup |
---|
Periodically run the lifter. Run the task:_\[dspace\]/bin/dspace embargo-lifter_You will want to run this task in a cron-scheduled or other repeating way. Item embargoes will be lifted as their dates pass. |
Wiki Markup |
---|
Expose the 'term' metadata field. The lift field will be assigned by the embargo system, so it should not be exposed directly. Edit _\[dspace\]/config/input-forms.xml_ . If you have only one form (usually 'traditional') add it there. If you have multiple forms, add it only to the form(s) linked to collection(s) for which embargo applies. First, add the new field to the 'form definition': |
Code Block |
---|
<form name="traditional">
<page number="1">
...
<field>
<dc-schema>dc</dc-schema>
<dc-element>embargo</dc-element>
<dc-qualifier>terms</dc-qualifier>
<repeatable>false</repeatable>
<label>Embargo Terms</label>
<input-type value-pairs-name="embargo_terms">dropdown</input-type>
<hint>If required, select embargo terms.</hint>
<required></required>
</field> |
Code Block |
---|
<form-value-pairs>
...
<value-pairs value-pairs-name="embargo_terms" dc-term="embargo.terms">
<pair>
<displayed-value>90 days</displayed-value>
<stored-value>90 days</stored-value>
</pair>
<pair>
<displayed-value>6 months</displayed-value>
<stored-value>6 months</stored-value>
</pair>
<pair>
<displayed-value>1 year</displayed-value>
<stored-value>1 year</stored-value>
</pair>
</value-pairs>
|
Code Block |
---|
# DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = dc.embargo.terms
# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = dc.embargo.lift
# implementation of embargo setter plugin - replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DayTableEmbargoSetter |
Now add a new property called 'embargo.terms.days' as follows:
Code Block |
---|
# DC metadata field to hold computed "lift date" of embargo
embargo.terms.days = 90 days:90, 6 months:180, 1 year:365 |
Wiki Markup |
---|
Periodically run the lifter. Run the task:
{{\[dspace\]/bin/dspace embargo-lifter}} .
You will want to run this task in a cron-scheduled or other repeating way. Item embargoes will be lifted as their dates pass. |
Info | ||
---|---|---|
| ||
More details on Embargo configuration, including specific examples can be found in the Embargo section of the documentation. |
DSpace now comes with a Checksum Checker script ([dspace]/bin/dspace checker
) which can be scheduled to verify the checksum of every item within DSpace. Since DSpace calculates and records the checksum of every file submitted to it, this script is able to determine whether or not a file has been changed (either manually or by some sort of corruption or virus). The idea being that the earlier you can identify a file has changed, the more likely you'd be able to recover it (assuming it was not a wanted DSpace now comes with a Checksum Checker script ({{\[dspace\]/bin/dspace checker}}) which can be scheduled to verify the checksum of every item within DSpace. Since DSpace calculates and records the checksum of every file submitted to it, this script is able to determine whether or not a file has been changed (either manually or by some sort of corruption or virus). The idea being that the earlier you can identify a file has changed, the more likely you'd be able to recover it (assuming it was not a wanted change). Wiki Markup
Property: |
|
Example Value: |
|
Informational Note: | The Default dispatcher is case non is specified. |
Property: |
|
Example Value: |
|
Informational Note: | This option specifies the default time frame after which all checksum checks are removed from the database (defaults to 10 years). This means that after 10 years, all successful or unsuccessful matches are removed from the database. |
Property: |
|
Example Value: |
|
Informational Note: | This option specifies the time frame after which a successful match will be removed from your DSpace database (defaults to 8 weeks). This means that after 8 weeks, all successful matches are automatically deleted from your database (in order to keep that database table from growing too large). |
Info | ||
---|---|---|
| ||
For more information on using DSpace's built-in Checksum verification system, see the section on Validating CheckSums of Bitstreams. |
...
...
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|http://creativecommons.org|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 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: |
|
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) |
...
General Web User Interface Configurations
In this section of Configuration, we address the agnostic WEB User Interface that is used for JSP UI and XML UI. Some of the configurations will give information towards customization or refer you to the appropriate documentation.
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 thumbnails using XMLUI, you need to create a theme which displays them). | |
Property: |
| |
Example Value: |
| |
Informational Note: | When showing the strengths, should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count of the database contents every time a page with this feature is requested, which will not scale. If you set the property key is set to cache ("true") you must run the following command periodically to update the count: | ]]></ac:plain-text-body></ac:structured-macro> |
...
Property: |
(property key broken up for display purposes only) | ||
Example Value: |
| ||
Informational Note: | It is possible include contextual information in the submission license using substitution variables. The text substitution is driven by a plugin implementation. |
...
Two new features of DSpace 1.6 fall under the header of Authority Control: Choice Management and Authority Control of Item ("DC") metadata values. Authority control is a fully optional feature in DSpace 1.6. Implemented out of the box are the Library of Congress Names service, and the Sherpa Romeo authority plugin.
For an in-depth description of this feature, please consult: http://wiki.dspace.org/index.php/Authority_Control_of_Metadata_consult: Authority Control of Metadata Values
Property: |
| ||
Example Value: |
| ||
Informational Note: |
| ||
Property: |
| ||
Example Value: |
| ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Location (URL) of the Library of Congress Name Service | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Location (URL) of the SHERPA/RoMEO authority plugin | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This sets the default lowest confidence level at which a metadata value is included in an authority-controlled browse (and search) index. It is a symbolic keyword, one of the following values (listed in descending order): accepted, uncertain, ambiguous, notfound, failed, rejected, novalue, unset. See | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property sets the number of selectable choices in the Choices lookup popup |
...
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 take 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].]]></ac:plain-text-body></ac:structured-macro> |
\[i18n -- – Locales\] Wiki Markup
...
If you set webui.supported.locales make sure that all the related additional files for each language are available. LOCALE should correspond to the locale set in webui.supported.locales, e. g.: for webui.supported.locales = en, de, fr, there should be:
[dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages.properties
}}unmigrated-wiki-markup[dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_en.properties
}}unmigrated-wiki-markup[dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_de.properties
}}[dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_fr.properties
}}
\\
Files to be localized:[dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_LOCALE.properties
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/input-forms_LOCALE.xml
}}[dspace-source
\]/dspace/config/default_LOCALE.license
-
should
be
pure
ASCII
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/news-top_LOCALE.html
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/news-side_LOCALE.html
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/change_password_LOCALE
}}[dspace-source
\]/dspace/config/emails/feedback_LOCALE
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/internal_error_LOCALE
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/register_LOCALE
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/submit_archive_LOCALE
}}[dspace-source
\]/dspace/config/emails/submit_reject_LOCALE
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/submit_task_LOCALE
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/subscription_LOCALE
}}unmigrated-wiki-markup[dspace-source
\]/dspace/config/emails/suggest_LOCALE
}}[dspace
\]/webapps/jspui/help/collection-admin_LOCALE.html
-
in
html
keep
the
jump
link
as
original;
must
be
copied
to
\ [dspace-source
\]/dspace/modules/jspui/src/main/webapp/help
}}unmigrated-wiki-markup[dspace
\]/webapps/jspui/help/index_LOCALE.html
-
must
be
copied
to
\ [dspace-source
\]/dspace/modules/jspui/src/main/webapp/help
}}[dspace
\]/webapps/jspui/help/site-admin_LOCALE.html
-
must
be
copied
to
\ [dspace-source
\]/dspace/modules/jspui/src/main/webapp/help
}}Because the item mapper requires a primitive implementation of the browse system to be present, we simply need to tell that system which of our indexes defines the author browse (or equivalent) so that the mapper can list authors' items for mapping
...
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. |
All the parameters mapping are defined in {{\ Wiki Markup [dspace
\]/config/sfx.xml
}} file. The program will check the parameters in {{sfx.xml
}} and retrieve the correct metadata of the item. It will then parse the string to your resolver.
For the following example, the program will search the first query-pair which is DOI of the item. If there is a DOI for that item, your retrieval results will be, for example:
http://researchspace.auckland.ac.nz/handle/2292/5763
...
Code Block |
---|
<query-pairs> <field> <querystring>rft_id=info:doi/</querystring> <dc-schema>dc</dc-schema> <dc-element>identifier</dc-element> <dc-qualifier>doi</dc-qualifier> </field> </query-pairs> |
If there is no DOI for that item, it will search next query-pair based on the {{\ Wiki Markup [dspace
\]/config/sfx.xml
}} and then so on.
Example of using ISSN, volume, issue for item without DOI
{{\ Wiki Markup [http://researchspace.auckland.ac.nz/handle/2292/4947
\]
}}
For parameter passing to the <querystring>
Code Block |
---|
<querystring>rft_id=info:doi/</querystring> |
...
Please refer to these:
{{\[http://ocoins.info/cobgbook.html
\]}}
{{\]
[http://ocoins.info/cobg.html
\]
}}
Program assume won't won’t get empty string for the item, as there will at least author, title for the item to pass to the resolver.
For contributor author, program maintains original DSpace SFX function of extracting author's author‘s first and last name.
Code Block |
---|
<field> <querystring>rft.aulast=</querystring> <dc-schema>dc</dc-schema> <dc-element>contributor</dc-element> <dc-qualifier>author</dc-qualifier> </field> <field> <querystring>rft.aufirst=</querystring> <dc-schema>dc</dc-schema> <dc-element>contributor</dc-element> <dc-qualifier>author</dc-qualifier> </field> |
...
The taxonomies are described in XML following this (very simple) structure:
Code Block |
---|
<node id="acmccs98" label="ACMCCS98">
<isComposedBy>
<node id="A." label="General Literature">
<isComposedBy>
<node id="A.0" label="GENERAL"/>
<node id="A.1" label="INTRODUCTORY AND SURVEY"/>
</isComposedBy>
</node>
</isComposedBy>
</node> |
...
webui.controlledvocabulary.enable = true
unmigrated-wiki-markup
New vocabularies should be placed in {{\[dspace
\]/config/controlled-vocabularies/
}} and must be according to the structure described. A validation XML Schema (named {{controlledvocabulary.xsd
}}) is also available in that directory.
Vocabularies need to be associated with the correspondent DC metadata fields. Edit the file {{\ Wiki Markup [dspace
\]/config/input-forms.xml
}} and place a _"vocabulary"_ tag under the _"field"_ element that you want to control. Set value of the _"vocabulary"_ element to the name of the file that contains the vocabulary, leaving out the extension (the add-on will only load files with extension "*.xml"). For example:
Code Block |
---|
<field>
<dc-schema>dc</dc-schema>
<dc-element>subject</dc-element>
<dc-qualifier></dc-qualifier>
<!-- An input-type of twobox MUST be marked as repeatable -->
<repeatable>true</repeatable>
<label>Subject Keywords</label>
<input-type>twobox</input-type>
<hint> Enter appropriate subject keywords or phrases below. </hint>
<required></required>
<vocabulary [closed="false"]>nsi</vocabulary>
</field> |
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | Is used by the SolrLogger Client class to connect to the SOLR server over http and perform updates and queries. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Spiders file is utilized by the SolrLogger, this will be populated by running the following command: | ||
Property: | | ||
Example Value: | | ||
: |
| ||
Example Value: |
| ||
Informational Note: | The following refers to the GeoLiteCity database file utilized by the LocationUtils to calculate the location of client requests based on IP address. During the Ant build process (both fresh_install and update) this file will be downloaded from [http://www.maxmind.com/app/geolitecity] if a new version has been published or it is absent from your | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Timeout for the resolver in the DNS lookup time in milliseconds, defaults to 200 for backward compatibility; your system's default is usually set in | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Enables access control restriction on DSpace Statistics pages, Restrictions are based on access rights to Community, Collection and Item Pages. This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available. | ||
Property: |
| ||
Example Value: | {{solr.statistics.logBots = true }} | ||
Informational Note: | Enable/disable logging of spiders in solr statistics. If false, and IP matches an address in solr.spiderips.urls, event is not logged. If true, event will be logged with the 'isBot' field set to true (see | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Controls solr statistics querying to filter out spider IPs. False by default. | ||
Property: | {{solr.statistics.query.filter.isBot }} | ||
Example Value: |
| ||
Informational Note: | Controls solr statistics querying to look at "isBot" field to determine if record is a bot. True by default. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | URLs to download IP addresses of search engine spiders from |
...
The _\[dspace\]/config/registries_ directory contains three XML files. These are used to load the _initial_ contents of the Dublin Core Metadata registry and Bitstream Format registry and SWORD metadata registry. After the initial loading (performed by _ant fresh_install_ above), the registries reside in the database; the XML files are not updated. Wiki Markup
In order to change the registries, you may adjust the XML files before the first installation of DSpace. On an already running instance it is recommended to change bitstream registries via DSpace admin UI, but the metadata registries can be loaded again at any time from the XML files without difficult. The changes made via admin UI are not reflected in the XML files.
...
If you wish to add more metadata elements, you can do this in one of two ways. Via the DSpace admin UI you may define new metadata elements in the different available schemas. But you may also modify the XML file (or provide an additional one), and re-import the data as follows:
Code Block |
---|
[dspace]/bin/dspace dsrun org.dspace.administer.MetadataImporter -f [xml file] |
...
...
The bitstream formats recognized by the system and levels of support are similarly stored in the bitstream format registry. This can also be edited at install-time via _\[dspace\]/config/registries/bitstream-formats.xml_ or by the administration Web UI. The contents of the bitstream format registry are entirely up to you, though the system requires that the following two formats are present:
...
Download the jai_imageio library version 1.0_01 or 1.1 found at: https://jai-imageio.dev.java.net/binary-builds.html#Stable_builds .
For these filters you do NOT have to worry about the native code, just the JAR, so choose a download for any platform.
Code Block |
---|
curl -O http://download.java.net/media/jai-imageio/builds/release/1.1/jai_imageio-1_1-lib-linux-i586.tar.gz
tar xzf jai_imageio-1_1-lib-linux-i586.tar.gz
|
The preceding example leaves the JAR in jai_imageio-1_1/lib/jai_imageio.jar . Now install it in your local Maven repository, e.g.: (changing the path after file= if necessary)
Code Block |
---|
mvn install:install-file \
-Dfile=jai_imageio-1_1/lib/jai_imageio.jar \
-DgroupId=com.sun.media \
-DartifactId=jai_imageio \
-Dversion=1.0_01 \
-Dpackaging=jar \
-DgeneratePom=true
|
...
Code Block |
---|
filter.org.dspace.app.mediafilter.XPDF2Thumbnail.inputFormats = Adobe PDFfilterPDF filter.org.dspace.app.mediafilter.XPDF2Text.inputFormats = Adobe PDF |
...