mirror of
https://github.com/DSpace/DSpace.git
synced 2025-10-16 14:33:09 +00:00
Integrate doc changes from foundation's webmaster@dspace.org backlog
of submissions, and regenerate the docbook, html, and pdf. git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@3053 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Brad McLean
@@ -135,6 +135,7 @@ if [ $haveDB -lt 1 ]; then
|
||||
|
||||
<!-- &art01; -->
|
||||
&art02;
|
||||
&art11;
|
||||
&art03;
|
||||
&art04;
|
||||
&art05;
|
||||
@@ -143,7 +144,6 @@ if [ $haveDB -lt 1 ]; then
|
||||
&art08;
|
||||
&art09;
|
||||
&art10;
|
||||
&art11;
|
||||
&art12;
|
||||
&art13;
|
||||
&art14;
|
||||
|
||||
@@ -95,16 +95,17 @@ Documents"/>Merging of DRI Documents</title>
|
||||
<para>The DRI schema will continue to evolve overtime as the needs of interface design require. The version attribute on the document will indicate which version of the schema the document conforms to. At the time Manakin was incorporated into the standard distribution of DSpac the current version was "1.1", however earlier versions of the Manakin interface may use "1.0".</para>
|
||||
<section remap="h3">
|
||||
<title>Changes from 1.0 to 1.1</title>
|
||||
<para>There were major structural changes between these two version numbers. Several elements were removed from the schema:<literal>includeSet</literal>, <literal>include</literal>, <literal>objectMeta</literal>, and <literal>object</literal>. Originaly all metadata for objects were included in-line with the DRI document, this proved to have several problems and has been removed in version 1.1 of the DRI schema. Instead of including metadata in-line, external references to the metadata is included. Thus, a <literal>reference</literal> element has been added along with <literal>referenceSet</literal>. These new elements operate like their counterparts in the previous version except refrencing metadata contained on the <literal>objectMeta</literal> element they reference metadata in external files. The <literal>repository</literal> and <literal>repositoryMeta</literal> elements were alse modified in a similar mannor removing in-line metadata and refrencing external metadata documents.</para>
|
||||
<para>There were major structural changes between these two version numbers. Several elements were removed from the schema:<literal>includeSet</literal>, <literal>include</literal>, <literal>objectMeta</literal>, and <literal>object</literal>. Originally all metadata for objects were included in-line with the DRI document, this proved to have several problems and has been removed in version 1.1 of the DRI schema. Instead of including metadata in-line, external references to the metadata is included. Thus, a <literal>reference</literal> element has been added along with <literal>referenceSet</literal>. These new elements operate like their counterparts in the previous version except refrencing metadata contained on the <literal>objectMeta</literal> element they reference metadata in external files. The <literal>repository</literal> and <literal>repositoryMeta</literal> elements were alse modified in a similar mannor removing in-line metadata and refrencing external metadata documents.</para>
|
||||
</section>
|
||||
</section>
|
||||
<section remap="h2">
|
||||
<title><anchor id="docbook-DRISchemaReference.html-Element_Reference" xreflabel="Element Refenence"/>Element Refenence</title>
|
||||
<title><anchor id="docbook-DRISchemaReference.html-Element_Reference" xreflabel="Element Reference"/>Element Reference</title>
|
||||
<informaltable frame="all">
|
||||
<tgroup cols="3">
|
||||
<colspec colname="c1" colwidth="33*"/>
|
||||
<colspec colname="c2" colwidth="33*"/>
|
||||
<colspec colname="c3" colwidth="33*"/>
|
||||
<tgroup cols="4">
|
||||
<colspec colname="c1" colwidth="25*"/>
|
||||
<colspec colname="c2" colwidth="25*"/>
|
||||
<colspec colname="c3" colwidth="25*"/>
|
||||
<colspec colname="c4" colwidth="25*"/>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
@@ -114,7 +115,7 @@ Documents"/>Merging of DRI Documents</title>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
<emphasis role="bold">Attributes</emphasis>
|
||||
<emphasis role="bold">Attributes (if required, noted)</emphasis>
|
||||
</para>
|
||||
</entry>
|
||||
<entry>
|
||||
@@ -193,12 +194,7 @@ Documents"/>Merging of DRI Documents</title>
|
||||
<para>action</para>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>required for interactive</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<para>behavior</para>
|
||||
<para>required for interactive behavior</para>
|
||||
</entry>
|
||||
<entry>
|
||||
<para/>
|
||||
@@ -702,7 +698,7 @@ Documents"/>Merging of DRI Documents</title>
|
||||
</row>
|
||||
<row>
|
||||
<entry align="center" morerows="2" valign="middle">
|
||||
<para><anchor id="docbook-DRISchemaReference.html--element:refrence" xreflabel="refrence"/>refrence</para>
|
||||
<para><anchor id="docbook-DRISchemaReference.html--element:reference" xreflabel="reference"/>reference</para>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>url</para>
|
||||
@@ -2316,9 +2312,9 @@ Element"/>
|
||||
<screen>
|
||||
<document version=1.0>
|
||||
|
||||
<meta> ... </meta>
|
||||
<meta> Ö </meta>
|
||||
|
||||
<body> ... </body>
|
||||
<body> Ö </body>
|
||||
|
||||
<emphasis role="bold"> <options></emphasis>
|
||||
|
||||
@@ -2587,14 +2583,14 @@ Element"/>
|
||||
<!--end of params element-->
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title><anchor id="docbook-DRISchemaReference.html-element:refrence" xreflabel="refrence"/>refrence</title>
|
||||
<title><anchor id="docbook-DRISchemaReference.html-element:reference" xreflabel="reference"/>reference</title>
|
||||
<para>
|
||||
<anchor id="docbook-DRISchemaReference.html--type:Metadata-Reference-Element" xreflabel="Metadata Reference
|
||||
Element"/>
|
||||
</para>
|
||||
<para>Metadata Reference Element</para>
|
||||
<para><literal>refrence</literal> is a reference element used to access information stored in an extarnal metadata file. The <emphasis>url</emphasis> attribute is used to locate the external metadata file. The <emphasis>type</emphasis> attribute provides a short limited description of the referenced object's type.</para>
|
||||
<para><literal>refrence</literal> elements can be both contained by <literal>includeSet</literal> elements and contain <literal>includeSets</literal> themselves, making the structure recursive.</para>
|
||||
<para><literal>reference</literal> is a reference element used to access information stored in an extarnal metadata file. The <emphasis>url</emphasis> attribute is used to locate the external metadata file. The <emphasis>type</emphasis> attribute provides a short limited description of the referenced object's type.</para>
|
||||
<para><literal>reference</literal> elements can be both contained by <literal>includeSet</literal> elements and contain <literal>includeSets</literal> themselves, making the structure recursive.</para>
|
||||
<para>Parent</para>
|
||||
<para>
|
||||
<anchor id="docbook-DRISchemaReference.html--element:referenceSet.3" xreflabel="referenceSet"/>
|
||||
@@ -2626,17 +2622,17 @@ Element"/>
|
||||
<term>type</term>
|
||||
<listitem>
|
||||
<para>optional</para>
|
||||
<para>Description of the refrence object's type.</para>
|
||||
<para>Description of the reference object's type.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<screen>
|
||||
<includeSet n="browse-list"
|
||||
id="XMLTest.includeSet.browse-list">
|
||||
<emphasis role="bold"> <refrence url="/metadata/handle/123/4/mets.xml"
|
||||
<emphasis role="bold"> <reference url="/metadata/handle/123/4/mets.xml"
|
||||
repositoryID="123" type="DSpace
|
||||
Item"/></emphasis>
|
||||
<emphasis role="bold"> <refrence url="/metadata/handle/123/5/mets.xml"
|
||||
<emphasis role="bold"> <reference url="/metadata/handle/123/5/mets.xml"
|
||||
repositoryID="123" /></emphasis>
|
||||
...
|
||||
</includeSet>
|
||||
@@ -2658,9 +2654,9 @@ Element"/>
|
||||
</para>
|
||||
<para>div</para>
|
||||
<para>
|
||||
<anchor id="docbook-DRISchemaReference.html--element:refrence.1" xreflabel="refrence"/>
|
||||
<anchor id="docbook-DRISchemaReference.html--element:reference.1" xreflabel="reference"/>
|
||||
</para>
|
||||
<para>refrence</para>
|
||||
<para>reference</para>
|
||||
<para>Children</para>
|
||||
<para>
|
||||
<anchor id="docbook-DRISchemaReference.html--element:head.3" xreflabel="head"/>
|
||||
@@ -2668,9 +2664,9 @@ Element"/>
|
||||
<para>head</para>
|
||||
<para> (zero or one)</para>
|
||||
<para>
|
||||
<anchor id="docbook-DRISchemaReference.html--element:refrence.2" xreflabel="refrence"/>
|
||||
<anchor id="docbook-DRISchemaReference.html--element:reference.2" xreflabel="reference"/>
|
||||
</para>
|
||||
<para>refrence</para>
|
||||
<para>reference</para>
|
||||
<para> (any)</para>
|
||||
<para>Attributes</para>
|
||||
<variablelist>
|
||||
@@ -2748,9 +2744,9 @@ Element"/>
|
||||
id="XMLTest.referenceSet.browse-list" type="summaryView"
|
||||
informationModel="DSpace"></emphasis>
|
||||
<head>A header for the includeset</head>
|
||||
<refrence
|
||||
<reference
|
||||
url="/metadata/handle/123/34/mets.xml"/>
|
||||
<refrence
|
||||
<reference
|
||||
url=""metadata/handle/123/34/mets.xml/>
|
||||
<emphasis role="bold"> </referenceSet></emphasis>
|
||||
...
|
||||
@@ -2805,7 +2801,7 @@ Element"/>
|
||||
<anchor id="docbook-DRISchemaReference.html--type:Metadata-Element.2" xreflabel="Metadata Element"/>
|
||||
</para>
|
||||
<para>Metadata Element</para>
|
||||
<para>The <literal>repositoryMeta</literal> element contains metadata refernces about the repositories used in the used or refrenced in the documnet. It can contain any number of <literal>repository</literal> elements.</para>
|
||||
<para>The <literal>repositoryMeta</literal> element contains metadata refernces about the repositories used in the used or referenced in the document. It can contain any number of <literal>repository</literal> elements.</para>
|
||||
<para>See the <literal>repository</literal> tag entry for more information on the structure of <literal>repository</literal> elements.</para>
|
||||
<para>Parent</para>
|
||||
<para>
|
||||
|
||||
@@ -711,7 +711,7 @@ archive_directory/
|
||||
file_1.png
|
||||
...
|
||||
</screen>
|
||||
<para>The <literal>dublin_core.xml</literal> file has the following format, where each Dublin Core element has it's own entry within a <literal><dcvalue></literal> tagset. There are currently three tag elements available in the <literal><dcvalue></literal> tagset:</para>
|
||||
<para>The <literal>dublin_core.xml</literal> file has the following format, where each Dublin Core element has it's own entry within a <literal><dcvalue></literal> tagset. There are currently three tag attributes available in the <literal><dcvalue></literal> tagset:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><literal><element></literal> - the Dublin Core element</para>
|
||||
@@ -736,7 +736,7 @@ t;
|
||||
</dublin_core>
|
||||
|
||||
</screen>
|
||||
<para>(Note the optional language tag which notifies the system that the optional title is in French.)</para>
|
||||
<para>(Note the optional language tag attribute which notifies the system that the optional title is in French.)</para>
|
||||
<para>The <literal>contents</literal> file simply enumerates, one file per line, the bitstream file names. The bitstream name may optionally be followed by the sequence:</para>
|
||||
<para>
|
||||
<literal>\tbundle:bundlename</literal>
|
||||
@@ -892,7 +892,7 @@ dsrun org.dspace.app.itemimport.ItemImport -a -e joe@user.com -c
|
||||
<para>First, the randomly generated internal ID is not used because DSpace does not control the file path and name of the bitstream. Instead, the file path and name are that specified in the <literal>contents</literal> file.</para>
|
||||
<para>Second, the <literal>store_number</literal> column of the bitstream database row contains the asset store number specified in the <literal>contents</literal> file.</para>
|
||||
<para>Third, the <literal>internal_id</literal> column of the bitstream database row contains a leading flag (<literal>-R</literal>) followed by the registered file path and name. For example, <literal>-Rfilepath</literal> where <literal>filepath</literal> is the file path and name relative to the asset store corresponding to the asset store number. The asset store could be traditional storage in the DSpace server's file system or an SRB account.</para>
|
||||
<para>Fourth, an MD5 checksum is calculated by reading the registered file if it is in local storage. If the registerd file is in remote storage (say, SRB) a checksup is calulated on just the file name! This is an efficiency choice since registering a large number of large files that are in SRB would consume substantial network resources and time. A future option could be to have an SRB proxy process calculate MD5s and store them in SRB's metadata catalog (MCAT) for rapid retrieval. SRB offers such an option but it's not yet in production release.</para>
|
||||
<para>Fourth, an MD5 checksum is calculated by reading the registered file if it is in local storage. If the registerd file is in remote storage (say, SRB) a checksum is calulated on just the file name! This is an efficiency choice since registering a large number of large files that are in SRB would consume substantial network resources and time. A future option could be to have an SRB proxy process calculate MD5s and store them in SRB's metadata catalog (MCAT) for rapid retrieval. SRB offers such an option but it's not yet in production release.</para>
|
||||
<para>Registered items and their bitstreams can be retrieved transparently just like normally ingested items.</para>
|
||||
</section>
|
||||
<section remap="h3">
|
||||
|
||||
@@ -68,11 +68,11 @@
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
<para>The storage and business logic layer APIs are extensively documented with Javadoc-style comments. Generate the HTML version of these by entering the source directory and running:</para>
|
||||
<para>The storage and business logic layer APIs are extensively documented with Javadoc-style comments. Generate the HTML version of these by entering the [dspace-source]/dspace directory and running:</para>
|
||||
<screen>
|
||||
ant public_api
|
||||
mvn javadoc:javadoc
|
||||
</screen>
|
||||
<para>The package-level documentation of each package usually contains an overview of the package and some example usage. This information is not repeated in this architecture document; this and the Javadoc APIs are intended to be used in parallel.</para>
|
||||
<para> The resulting documentation will be at <literal>[dspace-source]dspace-api/target/site/apidocs/index.html</literal>. The package-level documentation of each package usually contains an overview of the package and some example usage. This information is not repeated in this architecture document; this and the Javadoc APIs are intended to be used in parallel.</para>
|
||||
<para>Each layer is described in a separate section:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
|
||||
@@ -62,6 +62,7 @@
|
||||
|
||||
<!-- &art01; -->
|
||||
&art02;
|
||||
&art11;
|
||||
&art03;
|
||||
&art04;
|
||||
&art05;
|
||||
@@ -70,7 +71,6 @@
|
||||
&art08;
|
||||
&art09;
|
||||
&art10;
|
||||
&art11;
|
||||
&art12;
|
||||
&art13;
|
||||
&art14;
|
||||
|
||||
@@ -340,7 +340,7 @@ context.complete();
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title><anchor id="docbook-business.html-dublincore" xreflabel="Dublin Core Metadata"/>Dublin Core Metadata</title>
|
||||
<para>The <literal>DCValue</literal> class is a simple container that represents a single Dublin Core element, optional qualifier, value and language. Note that as of DSpace 1.4 the <literal>MetadataValue</literal> and associated classes are preferred (see <link linkend="docbook-business.html-otherschemas">Support for Other Metadata Schemas</link>). The other classes starting with <literal>DC</literal> are utility classes for handling types of data in Dublin Core, such as people's names and dates. As supplied, the DSpace registry of elements and qualifiers corresponds to the <ulink url="http://www.dublincore.org/documents/2002/09/24/library-application-profile/">Library Application Profile</ulink> for Dublin Core. It should be noted that these utility classes assume that the values will be in a certain syntax, which will be true for all data generated within the DSpace system, but since Dublin Core does not always define strict syntax, this may not be true for Dublin Core originating outside DSpace.</para>
|
||||
<para>The <literal>DCValue</literal> class is a simple container that represents a single Dublin Core element, optional qualifier, value and language. Note that since DSpace 1.4 the <literal>MetadataValue</literal> and associated classes are preferred (see <link linkend="docbook-business.html-otherschemas">Support for Other Metadata Schemas</link>). The other classes starting with <literal>DC</literal> are utility classes for handling types of data in Dublin Core, such as people's names and dates. As supplied, the DSpace registry of elements and qualifiers corresponds to the <ulink url="http://www.dublincore.org/documents/2002/09/24/library-application-profile/">Library Application Profile</ulink> for Dublin Core. It should be noted that these utility classes assume that the values will be in a certain syntax, which will be true for all data generated within the DSpace system, but since Dublin Core does not always define strict syntax, this may not be true for Dublin Core originating outside DSpace.</para>
|
||||
<para>Below is the specific syntax that DSpace expects various fields to adhere to:</para>
|
||||
<informaltable frame="none">
|
||||
<tgroup cols="4">
|
||||
@@ -538,7 +538,7 @@ Schemas"/>Support for Other Metadata Schemas</title>
|
||||
<para>The Plugin Manager supports three different patterns of usage:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">Singleton Plugins</emphasis> There is only one implementation class for the plugin. It is indicated in the configuration. This type of plugin chooses an implementations of a service, for the entire system, at configuration time. Your application just fetches the plugin for that interface and gets the configured-in choice. See the <link linkend="docbook-business.html-pluginmethods">getSinglePlugin()</link> method.</para>
|
||||
<para><emphasis role="bold">Singleton Plugins</emphasis> There is only one implementation class for the plugin. It is indicated in the configuration. This type of plugin chooses an implementation of a service, for the entire system, at configuration time. Your application just fetches the plugin for that interface and gets the configured-in choice. See the <link linkend="docbook-business.html-pluginmethods">getSinglePlugin()</link> method.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">Sequence Plugins</emphasis> You need a sequence or series of plugins, to implement a mechanism like Stackable Authentication or a pipeline, where each plugin is called in order to contribute its implementation of a process to the whole. The Plugin Manager supports this by letting you configure a sequence of plugins for a given interface. See the <link linkend="docbook-business.html-pluginmethods">getPluginSequence()</link> method.</para>
|
||||
@@ -789,7 +789,7 @@ osswalk = \
|
||||
<para>Here are some usage examples to illustrate how the Plugin Manager works.</para>
|
||||
<section remap="h4">
|
||||
<title>Managing the MediaFilter plugins transparently</title>
|
||||
<para>The existing DSpace 1.3 MediaFilterManager implementation have been largely replaced by the Plugin Manager. The MediaFilter classes become plugins named in the configuration. Refer to the <ulink url="configure.html#mediafilters">configuration guide</ulink> for further details.</para>
|
||||
<para>The existing DSpace 1.3 MediaFilterManager implementation has been largely replaced by the Plugin Manager. The MediaFilter classes become plugins named in the configuration. Refer to the <ulink url="configure.html#mediafilters">configuration guide</ulink> for further details.</para>
|
||||
</section>
|
||||
<section remap="h4">
|
||||
<title>A Singleton Plugin</title>
|
||||
@@ -1454,7 +1454,7 @@ action --hasAgent--> User
|
||||
</section>
|
||||
<section remap="h2">
|
||||
<title><anchor id="docbook-business.html-checker" xreflabel="Checksum checker"/>Checksum checker</title>
|
||||
<para>The architecture of the checker is documented in the package javadocs, run <literal>ant public_api</literal>, and look in <literal>build/public_api/index.html</literal>.</para>
|
||||
<para>The architecture of the checker is documented in the package javadocs, run <literal>cd [dspace-source]/dspace;mvn javadoc:javadoc</literal>, and look in <literal>[dspace-source]dspace-api/target/site/apidocs/index.html</literal>.</para>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -340,7 +340,7 @@ Manakin)"/>Contents of XMLUI Web Application (aka Manakin)</title>
|
||||
</para>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>Main DSpace log file. This is where the DSpace code writes a simple log of events and errors that occur within the DSpace code. You can control the verbosity of this by editing the <literal>[dspace]/config/templates/log4j.properties</literal> file and then running <literal>[dspace]/bin/install-configs</literal>.</para>
|
||||
<para>Main DSpace log file. This is where the DSpace code writes a simple log of events and errors that occur within the DSpace code. You can control the verbosity of this by editing the <literal>[dspace-source]/config/templates/log4j.properties</literal> file and then running "ant init_configs". [dspace]/bin/install-configs in [dspace-sorce]/dspace/target/dspace-1.5.0-build/.</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
@@ -390,7 +390,7 @@ Manakin)"/>Contents of XMLUI Web Application (aka Manakin)</title>
|
||||
</para>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>The Handle server runs as a separate process from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation of log4j's 'rolling file appenders', the DSpace code running in the Handle server's JVM must use a separate log file. The DSpace code that is run as part of a Handle resolution request writes log information to this file. You can control the verbosity of this by editing <literal>[dspace]/config/templates/log4j-handle-plugin.properties</literal>.</para>
|
||||
<para>The Handle server runs as a separate process from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation of log4j's 'rolling file appenders', the DSpace code running in the Handle server's JVM must use a separate log file. The DSpace code that is run as part of a Handle resolution request writes log information to this file. You can control the verbosity of this by editing <literal>[dspace-source]/config/templates/log4j-handle-plugin.properties</literal>.</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
|
||||
@@ -655,7 +655,7 @@ Export"/>Import and Export</title>
|
||||
</section>
|
||||
<section remap="h2">
|
||||
<title><anchor id="docbook-functional.html-statistics" xreflabel="Statistics"/>Statistics</title>
|
||||
<para>Various statistical report about the contents and use of your system can be automatically generated by the system. These are generated by analysing DSpace's log files. Statistics can be broken down monthly.</para>
|
||||
<para>Various statistical reports about the contents and use of your system can be automatically generated by the system. These are generated by analysing DSpace's log files. Statistics can be broken down monthly.</para>
|
||||
<para>The report includes data such as:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
|
||||
@@ -1,6 +1,127 @@
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<chapter remap="h1">
|
||||
<title>DSpace System Documentation: Version History</title>
|
||||
<section remap="h2">
|
||||
<title><anchor id="docbook-history.html-version1_5" xreflabel="Changes in DSpace 1.5"/>Changes in DSpace 1.5</title>
|
||||
<section remap="h3">
|
||||
<title>General Improvements</title>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para> Highly configurable and theme-able new user interface (Manakin).</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> Apache Maven-based modular build system.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> LNI (Lightweight Network Interface) service. Allows programmatic ingest of content via WebDAV or SOAP.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> SWORD (Simple Web-service Offering Repository Deposit): repository-standard ingest service using Atom Publishing Protocol.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> Highly configurable item web submission system. All submission steps are configurable not just metadata pages.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> Browse functionality allowing customisation of the available indexes via dspace.cfg and pluggable normalisation of the sort strings. Integration with both JSP-UI and XML-UI included.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> Extensible content event notification service.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> Generation of Google and HTML sitemaps</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title>Bug fixes and smaller patches</title>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para> New options for ItemImporter to support bitstream permissions and descriptions.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1824710 Fix - Change in Creative Commons RDF.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1794700 Fix - Stat-monthly and stat-report-monthly</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1566820 Patch - Authentication code moved to new org.dspace.authenticate package, add IP AUth</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1670093 Patch - More stable metadata and schema registry import Option to generate community and collection "strength" as a batch job</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1659868 Patch - Improved database level debugging</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1620700 Patch - Add Community and Sub-Community to OAI Sets</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1679972 Fix - OAIDCCrosswalk NPE and invalid character fix, also invalid output prevented</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1549290 Fix - Suggest Features uses hard coded strings</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1727034 Fix - Method MetadataField.unique() is incorrect for null values</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1614546 Fix - Get rid of unused mets_bitstream_id column</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1450491 Patch - i18n configurable multilingualism support</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1764069 Patch - Replace "String" with "Integer" in PreparedStatement where needed</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1743188 Patch - for Request #1145499 - Move Items</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 179196 Patch - Oracle SQL in Bitstream Checker</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1751638 Patch - Set http disposition header to force download of large bitstreams</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1799575 Patch - New EPersonConsumer event consumer</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1566572 Patch - Item metadata in XHTML head elements</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1589429 Patch - "Self-Named" Media Filters (i.e. MediaFilter Plugins) (updated version of this patch)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1888652 Patch - Statistics Rewritten In Java</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1444364 Request - Metadata registry exporter</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1221957 Request - Admin browser for withdrawn items</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1740454 Fix - Concurrency</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1552760 Fix - Submit interface looks bad in Safari</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1642563 Patch - bin/update-handle-prefix rewritten in Java</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1724330 Fix - Removes "null" being displayed in community-home.jsp</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1763535 Patch - Alert DSpace administrator of new user registration</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> 1759438 Patch - Multilingualism Language Switch - DSpace Header</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</section>
|
||||
<section remap="h2">
|
||||
<title><anchor id="docbook-history.html-version1_4_1" xreflabel="Changes in DSpace 1.4.1"/>Changes in DSpace 1.4.1</title>
|
||||
<section remap="h3">
|
||||
|
||||
@@ -61,7 +61,7 @@ host dspace dspace 127.0.0.1 255.255.255.255 md5
|
||||
<para>
|
||||
<emphasis role="bold">Oracle 9 or greater</emphasis>
|
||||
</para>
|
||||
<para>Details on aquiring Oracle can be downloaded from the following location: <ulink url="http://www.oracle.com/database/">http://www.oracle.com/database/</ulink></para>
|
||||
<para>Details on acquiring Oracle can be downloaded from the following location: <ulink url="http://www.oracle.com/database/">http://www.oracle.com/database/</ulink></para>
|
||||
<para> You will need to create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is suggested that the Oracle database use the same character set. You will also need to create a user account for DSpace (e.g. <literal>dspace</literal>,) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.</para>
|
||||
<para><emphasis role="bold">NOTE:</emphasis> DSpace uses sequences to generate unique object IDs - beware Oracle sequences, which are said to lose their values when doing a database export/import, say restoring from a backup. Be sure to run the script <literal>etc/update-sequences.sql</literal>.</para>
|
||||
<para><emphasis role="bold">ALSO NOTE:</emphasis> Everything is fully functional, although Oracle limits you to 4k of text in text fields such as item metadata or collection descriptions.</para>
|
||||
@@ -77,11 +77,13 @@ host dspace dspace 127.0.0.1 255.255.255.255 md5
|
||||
<emphasis role="bold">Jakarta Tomcat 4.x or later.</emphasis>
|
||||
</para>
|
||||
<para> Tomcat can be dowloaded from the following location: <ulink url="http://tomcat.apache.org/whichversion.html">http://tomcat.apache.org</ulink></para>
|
||||
<para> Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called '<literal>dspace</literal>'.</para>
|
||||
<para> Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called '<literal>dspace</literal>'. Set the environment variable TOMCAT_USER appropriately.</para>
|
||||
<para> Modifications in [tomcat]/tomcat.conf</para>
|
||||
<para> You need to ensure that Tomcat has a) enough memory to run DSpace and b) uses UTF-8 as its default file encoding for international character support. So ensure in your startup scripts (etc) that the following environment variable is set: </para>
|
||||
<screen>
|
||||
JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"
|
||||
</screen>
|
||||
<para> Modifications in [tomcat]/config/server.xml</para>
|
||||
<para> You also need to alter Tomcat's default configuration to support searching and browsing of multi-byte UTF-8 correctly. You need to add a configuration option to the <literal><Connector></literal> element in <literal>[tomcat]/config/server.xml</literal>: </para>
|
||||
<screen>
|
||||
URIEncoding="UTF-8"
|
||||
@@ -99,6 +101,7 @@ URIEncoding="UTF-8"
|
||||
<emphasis role="bold"> URIEncoding="UTF-8"</emphasis>
|
||||
/>
|
||||
</screen>
|
||||
<para> You may change the port from 8080 by editing it in the file above, and by setting the variable CONNECTOR_PORT in tomcat.conf</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
@@ -109,6 +112,11 @@ URIEncoding="UTF-8"
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title>Perl (required for [dspace]/bin/dspace-info.pl)</title>
|
||||
<para>
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
<section remap="h2">
|
||||
<title><anchor id="docbook-install.html-installoptions" xreflabel="Installation Options"/>Installation Options</title>
|
||||
@@ -214,7 +222,7 @@ dspace-<version>-src-release.zip )"/>Source Release ( dspace-<version&g
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Both approaches provide you with the same control over how DSpace builds itself (especially in terms of adding completely custom/3rd-party DSpace "modules" you wish to use). Both methods allow you the ability to create more complex user interface "overlays" in Maven. An interface "overlay" allows you to only manage your local custom code (in your local CVS or SVN), and automatically download the rest of the interface code from the maven central repository whenever you build DSpace. This reduces the amount of out-of-the-box DSpace interface code maintained in your local CVS/SVN.</para>
|
||||
<para>Both approaches provide you with the same control over how DSpace builds itself (especially in terms of adding completely custom/3rd-party DSpace "modules" you wish to use). Both methods allow you the ability to create more complex user interface "overlays" in Maven. An interface "overlay" allows you to only manage your local custom code (in your local CVS or SVN), and automatically download the rest of the interface code from the maven central repository whenever you build DSpace. This reduces the amount of out-of-the-box DSpace interface code maintained in your local CVS / SVN.</para>
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title><anchor id="docbook-install.html-directories" xreflabel="Overview of DSpace Directories"/>Overview of DSpace Directories</title>
|
||||
@@ -451,11 +459,11 @@ crontab -e
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title>Multilingual Installation</title>
|
||||
<para> In order to deploy a multilingual version of DSpace you have to configure two parameters in <literal>[dspace]/config/dspace.cfg:</literal></para>
|
||||
<para> In order to deploy a multilingual version of DSpace you have to configure two parameters in <literal>[dspace-source]/config/dspace.cfg:</literal></para>
|
||||
<para><literal>default.locale</literal>, e. g. default.locale = en</para>
|
||||
<para><literal>webui.supported locales</literal>, e. g. webui.supported.locales = en, de</para>
|
||||
<para> The Locales might have the form country, country_language, country_language_variant.</para>
|
||||
<para> Accoding to the languages you wish to support, you have to make sure, that all the i18n related files are available see the <ulink url="configure.html#multilingualui">Multilingual User Interface</ulink> section in the configuration documentation. </para>
|
||||
<para> Accoding to the languages you wish to support, you have to make sure, that all the i18n related files are available see the <ulink url="configure.html#multilingualui">Multilingual User Interface Configuring MultiLingual Support</ulink> section for the JSPUI or the Multilingual Support for XMLUI in the configuration documentation. </para>
|
||||
</section>
|
||||
<section remap="h3">
|
||||
<title><anchor id="docbook-install.html-https" xreflabel="DSpace over HTTPS"/>DSpace over HTTPS</title>
|
||||
@@ -629,7 +637,7 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize
|
||||
</itemizedlist>
|
||||
<para>If you want to use the Handle system, you'll need to set up a Handle server. This is included with DSpace. Note that this is not required in order to evaluate DSpace; you only need one if you are running a production service. You'll need to obtain a Handle prefix from <ulink url="http://www.handle.net/">the central CNRI Handle site</ulink>.</para>
|
||||
<para>A Handle server runs as a separate process that receives TCP requests from other Handle servers, and issues resolution requests to a global server or servers if a Handle entered locally does not correspond to some local content. The Handle protocol is based on TCP, so it will need to be installed on a server that can broadcast and receive TCP on port 2641.</para>
|
||||
<para>The Handle server code is included with the DSpace code in <literal>[dspace]/lib/handle.jar</literal>. <emphasis role="bold">Note:</emphasis> The latest version of the <literal>handle.jar</literal> file is not included in the release due to licensing conditions changing between the provided version and later versions. It is recommended you read the <ulink url="http://www.handle.net/upgrade_6-2_DSpace.html">new license conditions</ulink> and decide whether you wish to update your installation's <literal>handle.jar</literal>. If you decide to update, you should replace the existing <literal>handle.jar</literal> in <emphasis>[dspace]</emphasis>/lib with the new version and rebuild your war files.</para>
|
||||
<para>The Handle server code is included with the DSpace code in <literal>[dspace-source]/lib/handle.jar</literal>. <emphasis role="bold">Note:</emphasis> The latest version of the <literal>handle.jar</literal> file is not included in the release due to licensing conditions changing between the provided version and later versions. It is recommended you read the <ulink url="http://www.handle.net/upgrade_6-2_DSpace.html">new license conditions</ulink> and decide whether you wish to update your installation's <literal>handle.jar</literal>. If you decide to update, you should replace the existing <literal>handle.jar</literal> in <emphasis>[dspace-source]</emphasis>/lib with the new version and rebuild your war files.</para>
|
||||
<para>A script exists to create a simple Handle configuration - simply run <literal>[dspace]/bin/make-handle-config</literal> after you've set the appropriate parameters in <literal>dspace.cfg</literal>. You can also create a Handle configuration directly by following the <ulink url="http://www.handle.net/hs_manual_18jan02/server_manual_2.html">installation instructions on handle.net</ulink>, but with these changes:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
@@ -689,7 +697,7 @@ java -cp /hs/bin/handle.jar net.handle.server.SimpleSetup /hs/svr_1
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para> When running <literal>[dspace]/bin/generate-sitemaps</literal> the script informs Google that the sitemaps have been updated. For this update to register correctly, you must first register your Google sitemap index page (<literal>/dspace/sitemap</literal>) with Google at <ulink url="http://www.google.com/webmasters/sitemaps/">http://www.google.com/webmasters/sitemaps/</ulink>. If your DSpace server requires the use of a HTTP proxy to connect to the Internet, ensure that you have set <literal>http.proxy.host</literal> and <literal>http.proxy.port</literal> in <literal>[dspace]/config/dspace.cfg</literal></para>
|
||||
<para>The URL for pinging Google, and in future, other search engines, is configured in <literal>[dspace]/config/dspace.cfg</literal> using the <literal>sitemap.engineurls</literal> setting where you can provide a comma-separated list of URLs to 'ping'.</para>
|
||||
<para>The URL for pinging Google, and in future, other search engines, is configured in <literal>[dspace-space]/config/dspace.cfg</literal> using the <literal>sitemap.engineurls</literal> setting where you can provide a comma-separated list of URLs to 'ping'.</para>
|
||||
<para>You can generate the sitemaps automatically every day using an additional cron job:</para>
|
||||
<screen>
|
||||
# Generate sitemaps
|
||||
|
||||
@@ -164,10 +164,10 @@
|
||||
|
||||
<h3> Changes from 1.0 to 1.1 </h3>
|
||||
|
||||
<p>There were major structural changes between these two version numbers. Several elements were removed from the schema:<code>includeSet</code>, <code>include</code>, <code>objectMeta</code>, and <code>object</code>. Originaly all metadata for objects were included in-line with the DRI document, this proved to have several problems and has been removed in version 1.1 of the DRI schema. Instead of including metadata in-line, external references to the metadata is included. Thus, a <code>reference</code> element has been added along with <code>referenceSet</code>. These new elements operate like their counterparts in the previous version except refrencing metadata contained on the <code>objectMeta</code> element they reference metadata in external files. The <code>repository</code> and <code>repositoryMeta</code> elements were alse modified in a similar mannor removing in-line metadata and refrencing external metadata documents.</p>
|
||||
<p>There were major structural changes between these two version numbers. Several elements were removed from the schema:<code>includeSet</code>, <code>include</code>, <code>objectMeta</code>, and <code>object</code>. Originally all metadata for objects were included in-line with the DRI document, this proved to have several problems and has been removed in version 1.1 of the DRI schema. Instead of including metadata in-line, external references to the metadata is included. Thus, a <code>reference</code> element has been added along with <code>referenceSet</code>. These new elements operate like their counterparts in the previous version except refrencing metadata contained on the <code>objectMeta</code> element they reference metadata in external files. The <code>repository</code> and <code>repositoryMeta</code> elements were alse modified in a similar mannor removing in-line metadata and refrencing external metadata documents.</p>
|
||||
|
||||
|
||||
<h2><a name="Element_Reference">Element Refenence</a></h2>
|
||||
<h2><a name="Element_Reference">Element Reference</a></h2>
|
||||
|
||||
<div class="tables">
|
||||
<table border="1">
|
||||
@@ -182,7 +182,7 @@
|
||||
|
||||
<th>
|
||||
|
||||
Attributes
|
||||
Attributes (if required, noted)
|
||||
|
||||
</th>
|
||||
|
||||
@@ -340,17 +340,7 @@
|
||||
|
||||
<td>
|
||||
|
||||
required for interactive
|
||||
|
||||
</td>
|
||||
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
|
||||
<td>
|
||||
|
||||
behavior
|
||||
required for interactive behavior
|
||||
|
||||
</td>
|
||||
|
||||
@@ -1364,7 +1354,7 @@
|
||||
|
||||
<td rowspan="3">
|
||||
|
||||
<a href="#element:refrence">refrence</a>
|
||||
<a href="#element:reference">reference</a>
|
||||
|
||||
</td>
|
||||
|
||||
@@ -3157,7 +3147,7 @@ Example needed.</pre>
|
||||
<div class="element">
|
||||
|
||||
<h3 class="element-name">
|
||||
<a name="element:refrence">refrence</a>
|
||||
<a name="element:reference">reference</a>
|
||||
</h3>
|
||||
|
||||
<div class="element-type">
|
||||
@@ -3165,8 +3155,8 @@ Example needed.</pre>
|
||||
</div>
|
||||
|
||||
<div class="element-descsription">
|
||||
<p><code>refrence</code> is a reference element used to access information stored in an extarnal metadata file. The <em>url</em> attribute is used to locate the external metadata file. The <em>type</em> attribute provides a short limited description of the referenced object's type. </p>
|
||||
<p><code>refrence</code> elements can be both contained by <code>includeSet</code> elements and contain <code>includeSets</code> themselves, making the structure recursive.</p>
|
||||
<p><code>reference</code> is a reference element used to access information stored in an extarnal metadata file. The <em>url</em> attribute is used to locate the external metadata file. The <em>type</em> attribute provides a short limited description of the referenced object's type. </p>
|
||||
<p><code>reference</code> elements can be both contained by <code>includeSet</code> elements and contain <code>includeSets</code> themselves, making the structure recursive.</p>
|
||||
</div>
|
||||
|
||||
<div class="element-parents">
|
||||
@@ -3190,15 +3180,15 @@ Example needed.</pre>
|
||||
<dd class="element-attribute-description">A reference to the repositoryIdentifier of the repository.</dd>
|
||||
<dt>type</dt>
|
||||
<dd class="element-attribute-selection">optional</dd>
|
||||
<dd class="element-attribute-description">Description of the refrence object's type.</dd>
|
||||
<dd class="element-attribute-description">Description of the reference object's type.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="element-example">
|
||||
<pre>
|
||||
<includeSet n="browse-list" id="XMLTest.includeSet.browse-list">
|
||||
<b><refrence url="/metadata/handle/123/4/mets.xml" repositoryID="123" type="DSpace Item"/></b>
|
||||
<b><refrence url="/metadata/handle/123/5/mets.xml" repositoryID="123" /></b>
|
||||
<b><reference url="/metadata/handle/123/4/mets.xml" repositoryID="123" type="DSpace Item"/></b>
|
||||
<b><reference url="/metadata/handle/123/5/mets.xml" repositoryID="123" /></b>
|
||||
...
|
||||
</includeSet>
|
||||
</pre>
|
||||
@@ -3223,13 +3213,13 @@ Example needed.</pre>
|
||||
<div class="element-parents">
|
||||
<span class="term">Parent</span>
|
||||
<span class="def"><a href="#element:div">div</a></span>
|
||||
<span class="def"><a href="#element:refrence">refrence</a></span>
|
||||
<span class="def"><a href="#element:reference">reference</a></span>
|
||||
</div>
|
||||
|
||||
<div class="element-children">
|
||||
<span class="term">Children</span>
|
||||
<span class="def"><a href="#element:head">head</a> (zero or one)</span>
|
||||
<span class="def"><a href="#element:refrence">refrence</a> (any)</span>
|
||||
<span class="def"><a href="#element:reference">reference</a> (any)</span>
|
||||
</div>
|
||||
|
||||
<div class="element-attributes">
|
||||
@@ -3276,8 +3266,8 @@ Example needed.</pre>
|
||||
</list>
|
||||
<b><referenceSet n="browse-list" id="XMLTest.referenceSet.browse-list" type="summaryView" informationModel="DSpace"></b>
|
||||
<head>A header for the includeset</head>
|
||||
<refrence url="/metadata/handle/123/34/mets.xml"/>
|
||||
<refrence url=""metadata/handle/123/34/mets.xml/>
|
||||
<reference url="/metadata/handle/123/34/mets.xml"/>
|
||||
<reference url=""metadata/handle/123/34/mets.xml/>
|
||||
<b></referenceSet></b>
|
||||
...
|
||||
</p></pre>
|
||||
@@ -3343,7 +3333,7 @@ Example needed.</pre>
|
||||
</div>
|
||||
|
||||
<div class="element-description">
|
||||
<p>The <code>repositoryMeta</code> element contains metadata refernces about the repositories used in the used or refrenced in the documnet. It can contain any number of <code>repository</code> elements.</p>
|
||||
<p>The <code>repositoryMeta</code> element contains metadata refernces about the repositories used in the used or referenced in the document. It can contain any number of <code>repository</code> elements.</p>
|
||||
<p>See the <code>repository</code> tag entry for more information on the structure of <code>repository</code> elements.</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -687,7 +687,7 @@ archive_directory/
|
||||
...
|
||||
</pre>
|
||||
|
||||
<p>The <code>dublin_core.xml</code> file has the following format, where each Dublin Core element has it's own entry within a <code><dcvalue></code> tagset. There are currently three tag elements available in the <code><dcvalue></code> tagset:</p>
|
||||
<p>The <code>dublin_core.xml</code> file has the following format, where each Dublin Core element has it's own entry within a <code><dcvalue></code> tagset. There are currently three tag attributes available in the <code><dcvalue></code> tagset:</p>
|
||||
|
||||
<ul>
|
||||
<li><code><element></code> - the Dublin Core element</li>
|
||||
@@ -705,7 +705,7 @@ archive_directory/
|
||||
|
||||
</pre>
|
||||
|
||||
<p>(Note the optional language tag which notifies the system that the optional title is in French.)</p>
|
||||
<p>(Note the optional language tag attribute which notifies the system that the optional title is in French.)</p>
|
||||
|
||||
<p>The <code>contents</code> file simply enumerates, one file per line, the bitstream file names. The bitstream name may optionally be followed by the sequence:<br><br> <code>\tbundle:bundlename</code><br><br> where '\t' is the tab character and 'bundlename' is replaced by the name of the bundle to which the bitstream should be added. If no bundle is specified, the bitstream will be added to the 'ORIGINAL' bundle.<p>
|
||||
|
||||
@@ -851,7 +851,7 @@ dsrun org.dspace.app.itemimport.ItemImport -a -e joe@user.com -c collectionID -
|
||||
|
||||
<p>Third, the <code>internal_id</code> column of the bitstream database row contains a leading flag (<code>-R</code>) followed by the registered file path and name. For example, <code>-Rfilepath</code> where <code>filepath</code> is the file path and name relative to the asset store corresponding to the asset store number. The asset store could be traditional storage in the DSpace server's file system or an SRB account.</p>
|
||||
|
||||
<p>Fourth, an MD5 checksum is calculated by reading the registered file if it is in local storage. If the registerd file is in remote storage (say, SRB) a checksup is calulated on just the file name! This is an efficiency choice since registering a large number of large files that are in SRB would consume substantial network resources and time. A future option could be to have an SRB proxy process calculate MD5s and store them in SRB's metadata catalog (MCAT) for rapid retrieval. SRB offers such an option but it's not yet in production release.</p>
|
||||
<p>Fourth, an MD5 checksum is calculated by reading the registered file if it is in local storage. If the registerd file is in remote storage (say, SRB) a checksum is calulated on just the file name! This is an efficiency choice since registering a large number of large files that are in SRB would consume substantial network resources and time. A future option could be to have an SRB proxy process calculate MD5s and store them in SRB's metadata catalog (MCAT) for rapid retrieval. SRB offers such an option but it's not yet in production release.</p>
|
||||
|
||||
<p>Registered items and their bitstreams can be retrieved transparently just like normally ingested items.</p>
|
||||
|
||||
|
||||
@@ -83,8 +83,8 @@ and <code>app</code>)</td>
|
||||
<p>The storage and business logic
|
||||
layer APIs are extensively documented
|
||||
with Javadoc-style comments. Generate the HTML version of these by
|
||||
entering the source directory and running:</p>
|
||||
<pre>ant public_api</pre>
|
||||
entering the [dspace-source]/dspace directory and running:</p>
|
||||
<pre>mvn javadoc:javadoc</pre> The resulting documentation will be at <code>[dspace-source]dspace-api/target/site/apidocs/index.html</code>.
|
||||
<p>The package-level documentation
|
||||
of each package usually contains an
|
||||
overview of the package and some example usage. This information is not
|
||||
|
||||
@@ -265,7 +265,7 @@ context.complete();</PRE>
|
||||
|
||||
<H3><A NAME="dublincore">Dublin Core Metadata</A></H3>
|
||||
|
||||
<P>The <code>DCValue</code> class is a simple container that represents a single Dublin Core element, optional qualifier, value and language. Note that as of DSpace 1.4 the <code>MetadataValue</code> and associated classes are preferred (see <a href="#otherschemas">Support for Other Metadata Schemas</a>). The other classes starting with <code>DC</code> are utility classes for handling types of data in Dublin Core, such as people's names and dates. As supplied, the DSpace registry of elements and qualifiers corresponds to the <A HREF="http://www.dublincore.org/documents/2002/09/24/library-application-profile/">Library Application Profile</A> for Dublin Core. It should be noted that these utility classes assume that the values will be in a certain syntax, which will be true for all data generated within the DSpace system, but since Dublin Core does not always define strict syntax, this may not be true for Dublin Core originating outside DSpace.</P>
|
||||
<P>The <code>DCValue</code> class is a simple container that represents a single Dublin Core element, optional qualifier, value and language. Note that since DSpace 1.4 the <code>MetadataValue</code> and associated classes are preferred (see <a href="#otherschemas">Support for Other Metadata Schemas</a>). The other classes starting with <code>DC</code> are utility classes for handling types of data in Dublin Core, such as people's names and dates. As supplied, the DSpace registry of elements and qualifiers corresponds to the <A HREF="http://www.dublincore.org/documents/2002/09/24/library-application-profile/">Library Application Profile</A> for Dublin Core. It should be noted that these utility classes assume that the values will be in a certain syntax, which will be true for all data generated within the DSpace system, but since Dublin Core does not always define strict syntax, this may not be true for Dublin Core originating outside DSpace.</P>
|
||||
|
||||
<P>Below is the specific syntax that DSpace expects various fields to adhere to:</P>
|
||||
|
||||
@@ -406,7 +406,7 @@ packager plugin's implementation.</p>
|
||||
<ol>
|
||||
<li><strong>Singleton Plugins</strong>
|
||||
|
||||
<p>There is only one implementation class for the plugin. It is indicated in the configuration. This type of plugin chooses an implementations of a service, for the entire system, at configuration time. Your application just fetches the plugin for that interface and gets the configured-in choice. See the <a href="#pluginmethods">getSinglePlugin()</a> method.</p></li>
|
||||
<p>There is only one implementation class for the plugin. It is indicated in the configuration. This type of plugin chooses an implementation of a service, for the entire system, at configuration time. Your application just fetches the plugin for that interface and gets the configured-in choice. See the <a href="#pluginmethods">getSinglePlugin()</a> method.</p></li>
|
||||
|
||||
<li><strong>Sequence Plugins</strong>
|
||||
|
||||
@@ -662,7 +662,7 @@ plugin.selfnamed.crosswalk.org.dspace.content.metadata.DisseminationCrosswalk =
|
||||
|
||||
<h4>Managing the MediaFilter plugins transparently</h4>
|
||||
|
||||
<p>The existing DSpace 1.3 MediaFilterManager implementation have been largely replaced by the Plugin Manager. The MediaFilter classes become plugins named in the configuration. Refer to the <a href="configure.html#mediafilters">configuration guide</a> for further details.</p>
|
||||
<p>The existing DSpace 1.3 MediaFilterManager implementation has been largely replaced by the Plugin Manager. The MediaFilter classes become plugins named in the configuration. Refer to the <a href="configure.html#mediafilters">configuration guide</a> for further details.</p>
|
||||
|
||||
<h4>A Singleton Plugin</h4>
|
||||
|
||||
@@ -1187,7 +1187,7 @@ action --hasAgent--> User</PRE>
|
||||
<P>This history system is a largely untested experiment. It also needs further documentation. There have been no serious efforts to determine whether the information written by the history system, either to files or the database tables, is accurate. In particular, the <code>historystate</code> table does not seem to be correctly written.</P>
|
||||
|
||||
<h2><a name="checker">Checksum checker</a></h2>
|
||||
<p>The architecture of the checker is documented in the package javadocs, run <code>ant public_api</code>, and look in <code>build/public_api/index.html</code>.</p>
|
||||
<p>The architecture of the checker is documented in the package javadocs, run <code>cd [dspace-source]/dspace;mvn javadoc:javadoc</code>, and look in <code>[dspace-source]dspace-api/target/site/apidocs/index.html</code>.</p>
|
||||
<HR>
|
||||
|
||||
<ADDRESS>
|
||||
|
||||
@@ -101,7 +101,7 @@ property.name = property value
|
||||
property.name = word1 ${other.property.name} more words
|
||||
property2.name = ${dspace.dir}/rest/of/path
|
||||
</pre>
|
||||
|
||||
Whenever you edit dspace.cfg in [dspace-source]/dspace/config/, you should then run 'ant init_configs' in the directory [dspace-source]/dspace/target/dspace-1.5.0-build.dir so that any changes you may have made are reflected in the configuration files of other applications, for example Apache. You may then need to restart those applications, depending on what you changed.
|
||||
<table>
|
||||
<caption>
|
||||
<code>dspace.cfg</code> Main Properties (Not Complete)
|
||||
@@ -1080,7 +1080,7 @@ To set a language other than English as the default language for the repository'
|
||||
|
||||
<h3><a name="jspui-dspacecfg" id="jspui-dspacecfg">JSPUI Configuration Properties </a></h3>
|
||||
|
||||
<p>There are many options effecting how the JSP-based user interface for DSpace operates. Listed below are the major elements and their description, refere to the <code>dspace.cfg</code> file itself for the exhaustive list of configuration parameters.
|
||||
<p>There are many options effecting how the JSP-based user interface for DSpace operates. Listed below are the major elements and their description, refer to the <code>dspace.cfg</code> file itself for the exhaustive list of configuration parameters.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
@@ -1113,7 +1113,7 @@ To set a language other than English as the default language for the repository'
|
||||
|
||||
<td><code>true</code></td>
|
||||
|
||||
<td>Setting this parameter to ture will result in a hyperlink being rendered on the item View page that points to the item's licence.</td>
|
||||
<td>Setting this parameter to true will result in a hyperlink being rendered on the item View page that points to the item's licence.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
@@ -1121,7 +1121,7 @@ To set a language other than English as the default language for the repository'
|
||||
|
||||
<td><code>true</code></td>
|
||||
|
||||
<td>Determine if thumbnails should be displayed on browe-by pages and item view pages when available. The default behavior, if omitted, is false.</td>
|
||||
<td>Determine if thumbnails should be displayed on browse-by pages and item view pages when available. The default behavior, if omitted, is false.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
@@ -1249,12 +1249,12 @@ The following vocabularies are currently available by default:
|
||||
|
||||
<h3><a name="jspui-multilingual" id="multilingualui">Configuring Multilingual Support</a></h3>
|
||||
<h4>Setting the default language for the application</h4>
|
||||
The default language for the application is set via the <code><i>[dspace]</i>/config/dspace.cfg</code> parameter <code>default.locale</code>. <br />
|
||||
The default language for the application is set via the <code><i>[dspace-source]</i>/config/dspace.cfg</code> parameter <code>default.locale</code>. <br />
|
||||
This is a locale according to i18n and might consist of country, country_language or country_language_variant, <br />
|
||||
e. g.: <code>default.locale=en</code>. If not default locale is specified the server locale will be used instead.
|
||||
<h4>Supporting more than one language</h4>
|
||||
<h5>Changes in dspace.cfg</h5>
|
||||
With the <code><i>[dspace]</i>/config/dspace.cfg</code> parameter <code>webui.supported.locales</code> you may provide a comma seperated list of supported (including the default locale) locales. <br />
|
||||
With the <code><i>[dspace-source]</i>/config/dspace.cfg</code> parameter <code>webui.supported.locales</code> you may provide a comma seperated list of supported (including the default locale) locales. <br />
|
||||
The locales might have the form country, country_language or country_language_variant, e. g.:<br />
|
||||
<code>webui.supported.locales = en, de</code> or <code>webui.supported.locales = en, en_ca, de</code>.<br />
|
||||
This will result in:
|
||||
@@ -1273,30 +1273,30 @@ The following vocabularies are currently available by default:
|
||||
If you set webui.supported.locales make sure that all the related additional files for each language are available. <code>LOCALE</code> should correspond to the locale set in <code>webui.supported.locales</code>,
|
||||
e. g.: for webui.supported.locales = en, de, fr, there should be:
|
||||
<ul>
|
||||
<li><code><i>[dspace]</i>/modules/jspui/src/main/resources/Messages.properties</code></li>
|
||||
<li><code><i>[dspace]</i>/modules/jspui/src/main/resources/Messages_en.properties</code></li>
|
||||
<li><code><i>[dspace]</i>/modules/jspui/src/main/resources/Messages_de.properties</code></li>
|
||||
<li><code><i>[dspace]</i>/modules/jspui/src/main/resources/Messages_fr.properties</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/resources/Messages.properties</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/resources/Messages_en.properties</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/resources/Messages_de.properties</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/resources/Messages_fr.properties</code></li>
|
||||
</ul>
|
||||
Files to be localized:
|
||||
<ul>
|
||||
<li><code><i>[dspace]</i>/modules/jspui/src/main/resources/Messages_LOCALE.properties</code></li>
|
||||
<li><code><i>[dspace]</i>/config/input-forms_LOCALE.xml</code></li>
|
||||
<li><code><i>[dspace]</i>/config/default_LOCALE.license</code> <i>should be pure ascii</i></li>
|
||||
<li><code><i>[dspace]</i>/config/news-top_LOCALE.html</code></li>
|
||||
<li><code><i>[dspace]</i>/config/news-side_LOCALE.html</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/change_password_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/feedback_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/internal_error_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/register_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/submit_archive_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/submit_reject_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/submit_task_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/subscription_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/config/emails/suggest_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/jsp/help/collection-admin_LOCALE.html</code> <i>in html keep the jump link as original</i></li>
|
||||
<li><code><i>[dspace]</i>/jsp/help/index_LOCALE.html</code></li>
|
||||
<li><code><i>[dspace]</i>/jsp/help/site-admin_LOCALE.html</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/resources/Messages_LOCALE.properties</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/input-forms_LOCALE.xml</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/default_LOCALE.license</code> <i>should be pure ascii</i></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/news-top_LOCALE.html</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/news-side_LOCALE.html</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/change_password_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/feedback_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/internal_error_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/register_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/submit_archive_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/submit_reject_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/submit_task_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/subscription_LOCALE</code></li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/config/emails/suggest_LOCALE</code></li>
|
||||
<li><code><i>[dspace]</i>/webapps/jspui/help/collection-admin_LOCALE.html</code> <i>in html keep the jump link as original; must be copied to [dspace-source]/dspace/modules/jspui/src/main/webapp/help</i></li>
|
||||
<li><code><i>[dspace]</i>/webapps/jspui/help/index_LOCALE.html</code><i>must be copied to [dspace-source]/dspace/modules/jspui/src/main/webapp/help</i></li>
|
||||
<li><code><i>[dspace]</i>/webapps/jspui/help/site-admin_LOCALE.html</code><i>must be copied to [dspace-source]/dspace/modules/jspui/src/main/webapp/help</i></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -1310,7 +1310,7 @@ The following vocabularies are currently available by default:
|
||||
|
||||
<p>Note that the data (attributes) passed from an underlying Servlet to the JSP may change between versions, so you may have to modify your customized JSP to deal with the new data.</p>
|
||||
|
||||
<p>Thus, if possible, it is recommeded you limit your changes to the 'layout' JSPs and the stylesheet.</P>
|
||||
<p>Thus, if possible, it is recommended you limit your changes to the 'layout' JSPs and the stylesheet.</P>
|
||||
|
||||
<p>The JSPs are available in one of two places:
|
||||
<ul>
|
||||
@@ -1331,22 +1331,22 @@ The following vocabularies are currently available by default:
|
||||
<tr>
|
||||
<td><code><i>[jsp.dir]</i>/community-list.jsp</code></td>
|
||||
|
||||
<td><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/webapp/community-list.jsp</code></td>
|
||||
<td><code><i>[jsp.custom-dir]</i>/dspace/modules/jspui/src/main/webapp/community-list.jsp</code></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><code><i>[jsp.dir]</i>/mydspace/main.jsp</code></td>
|
||||
|
||||
<td><code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/webapp/mydspace/main.jsp</code></td>
|
||||
<td><code><i>[jsp.custom-dir]</i>/dspace/modules/jspui/src/main/webapp/mydspace/main.jsp</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>Heavy use is made of a style sheet, <code>styles.css.jsp</code>. If you make edits, copy the local version to <code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/webapp/styles.css.jsp</code>, and it will be used automatically in preference to the default, as described above.</p>
|
||||
<p>Heavy use is made of a style sheet, <code>styles.css.jsp</code>. If you make edits, copy the local version to <code><i>[jsp.custom-dir]</i>/dspace/modules/jspui/src/main/webapp/styles.css.jsp</code>, and it will be used automatically in preference to the default, as described above.</p>
|
||||
|
||||
<p>Fonts and colors can be easily changed using the stylesheet. The stylesheet is a JSP so that the user's browser version can be detected and the stylesheet tweaked accordingly.</p>
|
||||
|
||||
<p>The 'layout' of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs <code>/layout/header-*.jsp</code> and <code>/layout/footer-*.jsp</code>. You can provide modified versions of these (in <code><i>[dspace-source]</i>/dspace/modules/jspui/src/main/webapp/layout</code>), or define more styles and apply them to pages by using the "style" attribute of the <code>dspace:layout</code> tag.</p>
|
||||
<p>The 'layout' of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs <code>/layout/header-*.jsp</code> and <code>/layout/footer-*.jsp</code>. You can provide modified versions of these (in <code><i>[jsp.custom-dir]</i>/dspace/modules/jspui/src/main/webapp/layout</code>), or define more styles and apply them to pages by using the "style" attribute of the <code>dspace:layout</code> tag.</p>
|
||||
|
||||
<p>After you've customized your JSPs, <strong>you must rebuild the DSpace Web application</strong>. If you haven't already built and installed it, follow the <a href="install.html">install</a> directions. Otherwise, follow the steps below:</p>
|
||||
|
||||
@@ -1358,7 +1358,7 @@ The following vocabularies are currently available by default:
|
||||
<li>
|
||||
<p>Re-install the DSpace WAR(s) to <code><i>[dspace]</i>/webapps</code> by running the following command from your <code><i>[dspace-source]</i>/dspace/target/dspace-[version].dir</code> directory:</p>
|
||||
<pre>
|
||||
ant -Dconfig=<i>[dspace]</i>/config/dspace.cfg update
|
||||
ant -Dconfig=<i>[dspace-source]</i>/config/dspace.cfg update
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
@@ -1710,31 +1710,31 @@ bin/checker -L # Loops continuously through the repository</pre>
|
||||
This setting will enable or disable LDAP authentication in DSpace. With the setting off, users will be required to register and login with their email address. With this setting on, users will be able to login and register with their LDAP user ids and passwords.</li>
|
||||
|
||||
<li><b>webui.ldap.autoregister</b><br>
|
||||
This will turn LDAP autoregistration on or off. With this on, a new EPerson object will be created for any user who successfully authenticates against the LDAP server when they first login. With this setting off, the user must first register to get an EPerson object by entering their ldap username and password and filling out the forms.</li>
|
||||
This will turn LDAP autoregistration on or off. With this on, a new EPerson object will be created for any user who successfully authenticates against the LDAP server when they first login. With this setting off, the user must first register to get an EPerson object by entering their LDAP username and password and filling out the forms.</li>
|
||||
|
||||
<li><b>ldap.provider_url = ldap://ldap.myu.edu/o=myu.edu</b><br>
|
||||
This is the url to your institution's ldap server. You may or may not need the /o=myu.edu part at the end. Your server may also require the ldaps:// protocol.</li>
|
||||
This is the url to your institution's LDAP server. You may or may not need the /o=myu.edu part at the end. Your server may also require the ldaps:// protocol.</li>
|
||||
|
||||
<li><b>ldap.id_field = uid</b><br>
|
||||
This is the unique identifier field in the LDAP directory where the username is stored.</li>
|
||||
|
||||
<li><b>ldap.object_context = ou=people,o=myu.edu</b><br>
|
||||
This is the object context used when authenticating the user. It is appended to the ldap.id_field and username. For example uid=username,ou=people,o=myu.edu. You will need to modify this to match your ldap configuration.</li>
|
||||
This is the object context used when authenticating the user. It is appended to the ldap.id_field and username. For example uid=username,ou=people,o=myu.edu. You will need to modify this to match your LDAP configuration.</li>
|
||||
|
||||
<li><b>ldap.search_context = ou=people</b><br>
|
||||
This is the search context used when looking up a user's ldap object to retrieve their data for autoregistering. With ldap.autoregister turned on, when a user authenticates without an EPerson object we search the ldap directory to get their name and email address so that we can create one for them. So after we have authenticated against uid=username,ou=people,o=byu.edu we now search in ou=people for filtering on [uid=username]. Often the ldap.search_context is the same as the ldap.object_context parameter. But again this depends on your ldap server configuration.</li>
|
||||
This is the search context used when looking up a user's LDAP object to retrieve their data for autoregistering. With ldap.autoregister turned on, when a user authenticates without an EPerson object we search the LDAP directory to get their name and email address so that we can create one for them. So after we have authenticated against uid=username,ou=people,o=byu.edu we now search in ou=people for filtering on [uid=username]. Often the ldap.search_context is the same as the ldap.object_context parameter. But again this depends on your LDAP server configuration.</li>
|
||||
|
||||
<li><b>ldap.email_field = mail</b><br>
|
||||
This is the ldap object field where the user's email address is stored. "mail" is the default and the most common for ldap servers. If the mail field is not found the username will be used as the email address when creating the eperson object.</li>
|
||||
This is the LDAP object field where the user's email address is stored. "mail" is the default and the most common for ldap servers. If the mail field is not found the username will be used as the email address when creating the eperson object.</li>
|
||||
|
||||
<li><b>ldap.surname_field = sn</b><br>
|
||||
This is the ldap object field where the user's last name is stored. "sn" is the default and is the most common for ldap servers. If the field is not found the field will be left blank in the new eperson object.</li>
|
||||
This is the LDAP object field where the user's last name is stored. "sn" is the default and is the most common for LDAP servers. If the field is not found the field will be left blank in the new eperson object.</li>
|
||||
|
||||
<li><b>ldap.givenname_field = givenName</b><br>
|
||||
This is the ldap object field where the user's given names are stored. I'm not sure how common the givenName field is in different ldap instances. If the field is not found the field will be left blank in the new eperson object.</li>
|
||||
This is the LDAP object field where the user's given names are stored. I'm not sure how common the givenName field is in different LDAP instances. If the field is not found the field will be left blank in the new eperson object.</li>
|
||||
|
||||
<li><b>ldap.phone_field = telephoneNumber</b><br>
|
||||
This is the field where the user's phone number is stored in the ldap directory. If the field is not found the field will be left blank in the new eperson object.</li>
|
||||
This is the field where the user's phone number is stored in the LDAP directory. If the field is not found the field will be left blank in the new eperson object.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
@@ -188,7 +188,7 @@
|
||||
</TR>
|
||||
<TR>
|
||||
<TD><code><i>[dspace]</i>/log/dspace.log</code></TD>
|
||||
<TD>Main DSpace log file. This is where the DSpace code writes a simple log of events and errors that occur within the DSpace code. You can control the verbosity of this by editing the <code><i>[dspace]</i>/config/templates/log4j.properties</code> file and then running <code><i>[dspace]</i>/bin/install-configs</code>.</TD>
|
||||
<TD>Main DSpace log file. This is where the DSpace code writes a simple log of events and errors that occur within the DSpace code. You can control the verbosity of this by editing the <code><i>[dspace-source]</i>/config/templates/log4j.properties</code> file and then running "ant init_configs". [dspace]/bin/install-configs in [dspace-sorce]/dspace/target/dspace-1.5.0-build/.</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD><code><i>[tomcat]</i>/logs/catalina.out</code></TD>
|
||||
@@ -208,7 +208,7 @@
|
||||
</TR>
|
||||
<TR>
|
||||
<TD><code><i>[dspace]</i>/log/handle-plug.log</code></TD>
|
||||
<TD>The Handle server runs as a separate process from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation of log4j's 'rolling file appenders', the DSpace code running in the Handle server's JVM must use a separate log file. The DSpace code that is run as part of a Handle resolution request writes log information to this file. You can control the verbosity of this by editing <code><i>[dspace]</i>/config/templates/log4j-handle-plugin.properties</code>.</TD>
|
||||
<TD>The Handle server runs as a separate process from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation of log4j's 'rolling file appenders', the DSpace code running in the Handle server's JVM must use a separate log file. The DSpace code that is run as part of a Handle resolution request writes log information to this file. You can control the verbosity of this by editing <code><i>[dspace-source]</i>/config/templates/log4j-handle-plugin.properties</code>.</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD><code><i>[dspace]</i>/log/handle-server.log</code></TD>
|
||||
|
||||
@@ -612,7 +612,7 @@ of new items are also available for collections and communities.</p>
|
||||
|
||||
<h2><a name="statistics">Statistics</a></h2>
|
||||
|
||||
<p>Various statistical report about the contents and use of your system can be automatically generated by the system. These are generated by analysing DSpace's log files. Statistics can be broken down monthly.</P>
|
||||
<p>Various statistical reports about the contents and use of your system can be automatically generated by the system. These are generated by analysing DSpace's log files. Statistics can be broken down monthly.</P>
|
||||
|
||||
<P>The report includes data such as:</P>
|
||||
|
||||
|
||||
@@ -10,6 +10,50 @@
|
||||
<h1>DSpace System Documentation: Version History</h1>
|
||||
<p><a href="index.html">Back to contents</a></p>
|
||||
|
||||
<h2><a name="version1_5">Changes in DSpace 1.5</a></h2>
|
||||
|
||||
<h3>General Improvements</h3>
|
||||
<ul>
|
||||
<li>Highly configurable and theme-able new user interface (Manakin).</li>
|
||||
<li>Apache Maven-based modular build system.</li>
|
||||
<li>LNI (Lightweight Network Interface) service. Allows programmatic ingest of content via WebDAV or SOAP.</li>
|
||||
<li>SWORD (Simple Web-service Offering Repository Deposit): repository-standard ingest service using Atom Publishing Protocol.</li>
|
||||
<li>Highly configurable item web submission system. All submission steps are configurable not just metadata pages.</li>
|
||||
<li>Browse functionality allowing customisation of the available indexes via dspace.cfg and pluggable normalisation of the sort strings. Integration with both JSP-UI and XML-UI included.</li>
|
||||
<li>Extensible content event notification service.</li>
|
||||
<li>Generation of Google and HTML sitemaps</li>
|
||||
</ul>
|
||||
<h3>Bug fixes and smaller patches</h3>
|
||||
<ul><li>New options for ItemImporter to support bitstream permissions and descriptions.</li>
|
||||
<li>1824710 Fix - Change in Creative Commons RDF.</li>
|
||||
<li>1794700 Fix - Stat-monthly and stat-report-monthly</li>
|
||||
<li>1566820 Patch - Authentication code moved to new org.dspace.authenticate package, add IP AUth</li>
|
||||
<li>1670093 Patch - More stable metadata and schema registry import
|
||||
Option to generate community and collection "strength" as a batch job</li>
|
||||
<li>1659868 Patch - Improved database level debugging</li>
|
||||
<li>1620700 Patch - Add Community and Sub-Community to OAI Sets</li>
|
||||
<li>1679972 Fix - OAIDCCrosswalk NPE and invalid character fix, also invalid output prevented</li>
|
||||
<li>1549290 Fix - Suggest Features uses hard coded strings</li>
|
||||
<li>1727034 Fix - Method MetadataField.unique() is incorrect for null values</li>
|
||||
<li>1614546 Fix - Get rid of unused mets_bitstream_id column</li>
|
||||
<li>1450491 Patch - i18n configurable multilingualism support</li>
|
||||
<li>1764069 Patch - Replace "String" with "Integer" in PreparedStatement where needed</li>
|
||||
<li>1743188 Patch - for Request #1145499 - Move Items</li>
|
||||
<li>179196 Patch - Oracle SQL in Bitstream Checker</li>
|
||||
<li>1751638 Patch - Set http disposition header to force download of large bitstreams</li>
|
||||
<li>1799575 Patch - New EPersonConsumer event consumer</li>
|
||||
<li>1566572 Patch - Item metadata in XHTML head <meta> elements</li>
|
||||
<li>1589429 Patch - "Self-Named" Media Filters (i.e. MediaFilter Plugins) (updated version of this patch)</li>
|
||||
<li>1888652 Patch - Statistics Rewritten In Java</li>
|
||||
<li>1444364 Request - Metadata registry exporter</li>
|
||||
<li>1221957 Request - Admin browser for withdrawn items</li>
|
||||
<li>1740454 Fix - Concurrency</li>
|
||||
<li>1552760 Fix - Submit interface looks bad in Safari</li>
|
||||
<li>1642563 Patch - bin/update-handle-prefix rewritten in Java</li>
|
||||
<li>1724330 Fix - Removes "null" being displayed in community-home.jsp</li>
|
||||
<li>1763535 Patch - Alert DSpace administrator of new user registration</li>
|
||||
<li>1759438 Patch - Multilingualism Language Switch - DSpace Header</li>
|
||||
</ul>
|
||||
<h2><a name="version1_4_1">Changes in DSpace 1.4.1</a></h2>
|
||||
|
||||
<h3>General Improvements</h3>
|
||||
|
||||
@@ -68,7 +68,7 @@
|
||||
</LI>
|
||||
<LI>
|
||||
<P><strong>Oracle 9 or greater</strong></P>
|
||||
<p> Details on aquiring Oracle can be downloaded from the following location: <a href="http://www.oracle.com/database/">http://www.oracle.com/database/</a><br>
|
||||
<p> Details on acquiring Oracle can be downloaded from the following location: <a href="http://www.oracle.com/database/">http://www.oracle.com/database/</a><br>
|
||||
<br>
|
||||
You will need to create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is suggested that the Oracle database use the same character set. You will also need to create a user account for DSpace (e.g. <code>dspace</code>,) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.</p>
|
||||
<P><STRONG>NOTE:</STRONG> DSpace uses sequences to generate unique object IDs - beware Oracle sequences, which are said to lose their values when doing a database export/import, say restoring from a backup. Be sure to run the script <code>etc/update-sequences.sql</code>.</P>
|
||||
@@ -82,10 +82,13 @@
|
||||
<br>
|
||||
Tomcat can be dowloaded from the following location: <a href="http://tomcat.apache.org/whichversion.html">http://tomcat.apache.org</a><br>
|
||||
<br>
|
||||
Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called '<code>dspace</code>'.<br>
|
||||
Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called '<code>dspace</code>'. Set the environment variable TOMCAT_USER appropriately.<br>
|
||||
<br>
|
||||
Modifications in [tomcat]/tomcat.conf <br>
|
||||
You need to ensure that Tomcat has a) enough memory to run DSpace and b) uses UTF-8 as its default file encoding for international character support. So ensure in your startup scripts (etc) that the following environment variable is set:
|
||||
<PRE>JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"</PRE>
|
||||
<br>
|
||||
Modifications in [tomcat]/config/server.xml <br>
|
||||
You also need to alter Tomcat's default configuration to support searching and browsing of multi-byte UTF-8 correctly. You need to add a configuration option to the <code><Connector></code> element in <code><i>[tomcat]</i>/config/server.xml</code>:
|
||||
<PRE>URIEncoding="UTF-8"</PRE>
|
||||
e.g. if you're using the default Tomcat config, it should read:
|
||||
@@ -95,6 +98,8 @@
|
||||
enableLookups="false" redirectPort="8443" acceptCount="100"
|
||||
connectionTimeout="20000" disableUploadTimeout="true"
|
||||
<strong>URIEncoding="UTF-8"</strong> /></PRE>
|
||||
<br>
|
||||
You may change the port from 8080 by editing it in the file above, and by setting the variable CONNECTOR_PORT in tomcat.conf
|
||||
</li>
|
||||
<li><strong>Jetty or Caucho Resin</strong><br>
|
||||
<br>
|
||||
@@ -102,6 +107,7 @@
|
||||
<br>
|
||||
Jetty and Resin are configured for correct handling of UTF-8 by default.</li>
|
||||
</ul>
|
||||
<h3>Perl (required for [dspace]/bin/dspace-info.pl) </h3>
|
||||
|
||||
<p> </p>
|
||||
<H2><A NAME="installoptions">Installation Options</A></H2>
|
||||
@@ -177,7 +183,7 @@
|
||||
An interface "overlay" allows you to only manage your local custom code (in your local CVS or SVN),
|
||||
and automatically download the rest of the interface code from the maven central repository whenever
|
||||
you build DSpace. This reduces the amount of out-of-the-box
|
||||
DSpace interface code maintained in your local CVS/SVN.</p>
|
||||
DSpace interface code maintained in your local CVS / SVN.</p>
|
||||
|
||||
<H3><A NAME="directories">Overview of DSpace Directories</A></H3>
|
||||
|
||||
@@ -426,12 +432,12 @@ cp -r <i>[dspace]</i>/webapps/oai <i>[tomcat]</i>/webapps</PRE>
|
||||
<P>For information on customising the output of this see <A HREF="configure.html#statistics">configuring system statistical reports</A>.</P>
|
||||
|
||||
<h3>Multilingual Installation</h3>
|
||||
In order to deploy a multilingual version of DSpace you have to configure two parameters in <code><i>[dspace]</i>/config/dspace.cfg:</code><br />
|
||||
In order to deploy a multilingual version of DSpace you have to configure two parameters in <code><i>[dspace-source]</i>/config/dspace.cfg:</code><br />
|
||||
<code>default.locale</code>, e. g. default.locale = en<br />
|
||||
<code>webui.supported locales</code>, e. g. webui.supported.locales = en, de<br />
|
||||
The Locales might have the form country, country_language, country_language_variant.<br />
|
||||
Accoding to the languages you wish to support, you have to make sure, that all the i18n related files are available
|
||||
see the <a href="configure.html#multilingualui">Multilingual User Interface</a> section in the configuration documentation.
|
||||
see the <a href="configure.html#multilingualui">Multilingual User Interface Configuring MultiLingual Support</a> section for the JSPUI or the Multilingual Support for XMLUI in the configuration documentation.
|
||||
|
||||
<H3><A NAME="https">DSpace over HTTPS</a></H3>
|
||||
|
||||
@@ -649,7 +655,7 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
|
||||
<P>A Handle server runs as a separate process that receives TCP requests from other Handle servers, and issues resolution requests to a global server or servers if a Handle entered locally does not correspond to some local content. The Handle protocol is based on TCP, so it will need to be installed on a server that can broadcast and receive TCP on port 2641.</P>
|
||||
|
||||
<P>The Handle server code is included with the DSpace code in
|
||||
<code><i>[dspace]</i>/lib/handle.jar</code>. <strong>Note:</strong> The latest version of the <code>handle.jar</code> file is not included in the release due to licensing conditions changing between the provided version and later versions. It is recommended you read the <a href="http://www.handle.net/upgrade_6-2_DSpace.html">new license conditions</a> and decide whether you wish to update your installation's <code>handle.jar</code>. If you decide to update, you should replace the existing <code>handle.jar</code> in <i>[dspace]</i>/lib with the new version and rebuild your war files.</p>
|
||||
<code><i>[dspace-source]</i>/lib/handle.jar</code>. <strong>Note:</strong> The latest version of the <code>handle.jar</code> file is not included in the release due to licensing conditions changing between the provided version and later versions. It is recommended you read the <a href="http://www.handle.net/upgrade_6-2_DSpace.html">new license conditions</a> and decide whether you wish to update your installation's <code>handle.jar</code>. If you decide to update, you should replace the existing <code>handle.jar</code> in <i>[dspace-source]</i>/lib with the new version and rebuild your war files.</p>
|
||||
<p>A script exists to create a simple Handle configuration - simply run <code><i>[dspace]</i>/bin/make-handle-config</code> after you've set the appropriate parameters in <code>dspace.cfg</code>. You can also create a Handle configuration directly by following the <A HREF="http://www.handle.net/hs_manual_18jan02/server_manual_2.html">installation instructions on handle.net</A>, but with these changes:</P>
|
||||
|
||||
<UL>
|
||||
@@ -704,7 +710,7 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
|
||||
|
||||
<p>When running <code>[dspace]/bin/generate-sitemaps</code> the script informs Google that the sitemaps have been updated. For this update to register correctly, you must first register your Google sitemap index page (<code>/dspace/sitemap</code>) with Google at <a href="http://www.google.com/webmasters/sitemaps/">http://www.google.com/webmasters/sitemaps/</a>. If your DSpace server requires the use of a HTTP proxy to connect to the Internet, ensure that you have set <code>http.proxy.host</code> and <code>http.proxy.port</code> in <code>[dspace]/config/dspace.cfg</code></p>
|
||||
|
||||
<p>The URL for pinging Google, and in future, other search engines, is configured in <code>[dspace]/config/dspace.cfg</code> using the <code>sitemap.engineurls</code> setting where you can provide a comma-separated list of URLs to 'ping'.
|
||||
<p>The URL for pinging Google, and in future, other search engines, is configured in <code>[dspace-space]/config/dspace.cfg</code> using the <code>sitemap.engineurls</code> setting where you can provide a comma-separated list of URLs to 'ping'.
|
||||
|
||||
<p>You can generate the sitemaps automatically every day using an additional cron job:</p>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 1. DSpace System Documentation: Introduction</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="pr01.html" title="Preface"><link rel="next" href="ch02.html" title="Chapter 2. DSpace System Documentation: Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 1. DSpace System Documentation: Introduction</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="pr01.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch02.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N1002C"></a>Chapter 1. DSpace System Documentation: Introduction</h2></div></div></div><p>DSpace is an open source software platform that enables organisations to:</p><div class="itemizedlist"><ul type="disc"><li><p> capture and describe digital material using a submission workflow module, or a variety of programmatic ingest options</p></li><li><p> distribute an organisation's digital assets over the web through a search and retrieval system</p></li><li><p> preserve digital assets over the long term</p></li></ul></div><p>This system documentation includes <a class="ulink" href="functional.html" target="_top">a functional overview of the system</a>, which is a good introduction to the capabilities of the system, and should be readable by non-technical folk. Everyone should read this section first because it introduces some terminology used throughout the rest of the documentation.</p><p>For people actually running a DSpace service, there is <a class="ulink" href="install.html" target="_top">an installation guide</a>, and sections on <a class="ulink" href="configure.html" target="_top">configuration</a> and <a class="ulink" href="directories.html" target="_top">the directory structure</a>. Note that as of DSpace 1.2, the administration user interface guide is now on-line help available from within the DSpace system.</p><p>Finally, for those interested in the details of how DSpace works, and those potentially interested in modifying the code for their own purposes, there is <a class="ulink" href="architecture.html" target="_top">a detailed architecture and design section</a>.</p><p>Other good sources of information are:</p><div class="itemizedlist"><ul type="disc"><li><p> The DSpace Public API Javadocs. Build these with the command <code class="literal">mvn javadoc:javadoc</code>.</p></li><li><p> The <a class="ulink" href="http://wiki.dspace.org/" target="_top">DSpace Wiki</a> contains stacks of useful information about the DSpace platform and the work people are doing with it. You are strongly encouraged to visit this site and add information about your own work. Useful Wiki areas are: </p><div class="itemizedlist"><ul type="circle"><li><p><a class="ulink" href="http://wiki.dspace.org/DspaceResources" target="_top">A list of DSpace resources</a> (Web sites, mailing lists etc.)</p></li><li><p>
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 1. DSpace System Documentation: Introduction</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="pr01.html" title="Preface"><link rel="next" href="ch02.html" title="Chapter 2. DSpace System Documentation: Functional Overview"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 1. DSpace System Documentation: Introduction</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="pr01.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch02.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N1002C"></a>Chapter 1. DSpace System Documentation: Introduction</h2></div></div></div><p>DSpace is an open source software platform that enables organisations to:</p><div class="itemizedlist"><ul type="disc"><li><p> capture and describe digital material using a submission workflow module, or a variety of programmatic ingest options</p></li><li><p> distribute an organisation's digital assets over the web through a search and retrieval system</p></li><li><p> preserve digital assets over the long term</p></li></ul></div><p>This system documentation includes <a class="ulink" href="functional.html" target="_top">a functional overview of the system</a>, which is a good introduction to the capabilities of the system, and should be readable by non-technical folk. Everyone should read this section first because it introduces some terminology used throughout the rest of the documentation.</p><p>For people actually running a DSpace service, there is <a class="ulink" href="install.html" target="_top">an installation guide</a>, and sections on <a class="ulink" href="configure.html" target="_top">configuration</a> and <a class="ulink" href="directories.html" target="_top">the directory structure</a>. Note that as of DSpace 1.2, the administration user interface guide is now on-line help available from within the DSpace system.</p><p>Finally, for those interested in the details of how DSpace works, and those potentially interested in modifying the code for their own purposes, there is <a class="ulink" href="architecture.html" target="_top">a detailed architecture and design section</a>.</p><p>Other good sources of information are:</p><div class="itemizedlist"><ul type="disc"><li><p> The DSpace Public API Javadocs. Build these with the command <code class="literal">mvn javadoc:javadoc</code>.</p></li><li><p> The <a class="ulink" href="http://wiki.dspace.org/" target="_top">DSpace Wiki</a> contains stacks of useful information about the DSpace platform and the work people are doing with it. You are strongly encouraged to visit this site and add information about your own work. Useful Wiki areas are: </p><div class="itemizedlist"><ul type="circle"><li><p><a class="ulink" href="http://wiki.dspace.org/DspaceResources" target="_top">A list of DSpace resources</a> (Web sites, mailing lists etc.)</p></li><li><p>
|
||||
<a class="ulink" href="http://wiki.dspace.org/TechnicalFaq" target="_top">Technical FAQ</a>
|
||||
</p></li><li><p>
|
||||
<a class="ulink" href="http://wiki.dspace.org/DspaceProjects" target="_top">A list of projects using DSpace</a>
|
||||
@@ -11,4 +11,4 @@
|
||||
<span class="inlinemediaobject"><img src="http://i.creativecommons.org/l/by/3.0/us/88x31.png"></span>
|
||||
Licensed under a Creative Commons Attribution 3.0 United States License
|
||||
</a>
|
||||
</p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="pr01.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="ch02.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Preface </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Chapter 2. DSpace System Documentation: Installation</td></tr></table></div></body></html>
|
||||
</p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="pr01.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="ch02.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Preface </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Chapter 2. DSpace System Documentation: Functional Overview</td></tr></table></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,6 +1,6 @@
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 11. Customizing and Configuring Submission User Interface</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch10.html" title="Chapter 10. DSpace System Documentation: Functional Overview"><link rel="next" href="ch12.html" title="Chapter 12. docbook/DRISchemaReference.html"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 11. Customizing and Configuring Submission User Interface</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch10.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch12.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N145E9"></a>Chapter 11. Customizing and Configuring Submission User Interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch11.html#N145F4">11.1. Understanding the Submission Configuration File</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14601">11.1.1. The Structure of item-submission.xml</a></span></dt><dt><span class="section"><a href="ch11.html#N14630">11.1.2. Defining Steps (<step>) within the item-submission.xml</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N14764">11.2. Reordering/Removing Submission Steps</a></span></dt><dt><span class="section"><a href="ch11.html#N14811">11.3. Assigning a custom Submission Process to a Collection</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14864">11.3.1. Getting A Collection's Handle</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N14887">11.4. Custom Metadata-entry Pages for Submission</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N1488B">11.4.1. Introduction</a></span></dt><dt><span class="section"><a href="ch11.html#N148B6">11.4.2. Describing Custom Metadata Forms</a></span></dt><dt><span class="section"><a href="ch11.html#N148D9">11.4.3. The Structure of input-forms.xml</a></span></dt><dt><span class="section"><a href="ch11.html#N14B67">11.4.4. Deploying Your Custom Forms</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N14B84">11.5. Configuring the File Upload step</a></span></dt><dt><span class="section"><a href="ch11.html#N14BB0">11.6. Creating new Submission Steps</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14C49">11.6.1. Creating a Non-Interactive Step</a></span></dt></dl></dd></dl></div><p>This page explains various customization and configuration options that are available within DSpace for the Item Submission user interface.</p><p>
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 11. Customizing and Configuring Submission User Interface</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch10.html" title="Chapter 10. DSpace System Documentation: Business Logic Layer"><link rel="next" href="ch12.html" title="Chapter 12. docbook/DRISchemaReference.html"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 11. Customizing and Configuring Submission User Interface</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch10.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch12.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N145FC"></a>Chapter 11. Customizing and Configuring Submission User Interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch11.html#N14607">11.1. Understanding the Submission Configuration File</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14614">11.1.1. The Structure of item-submission.xml</a></span></dt><dt><span class="section"><a href="ch11.html#N14643">11.1.2. Defining Steps (<step>) within the item-submission.xml</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N14777">11.2. Reordering/Removing Submission Steps</a></span></dt><dt><span class="section"><a href="ch11.html#N14824">11.3. Assigning a custom Submission Process to a Collection</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14877">11.3.1. Getting A Collection's Handle</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N1489A">11.4. Custom Metadata-entry Pages for Submission</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N1489E">11.4.1. Introduction</a></span></dt><dt><span class="section"><a href="ch11.html#N148C9">11.4.2. Describing Custom Metadata Forms</a></span></dt><dt><span class="section"><a href="ch11.html#N148EC">11.4.3. The Structure of input-forms.xml</a></span></dt><dt><span class="section"><a href="ch11.html#N14B7A">11.4.4. Deploying Your Custom Forms</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N14B97">11.5. Configuring the File Upload step</a></span></dt><dt><span class="section"><a href="ch11.html#N14BC3">11.6. Creating new Submission Steps</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14C5C">11.6.1. Creating a Non-Interactive Step</a></span></dt></dl></dd></dl></div><p>This page explains various customization and configuration options that are available within DSpace for the Item Submission user interface.</p><p>
|
||||
<a name="docbook-submission.html-configurationFile"></a>
|
||||
</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N145F4"></a>11.1. Understanding the Submission Configuration File</h2></div></div></div><p>The <code class="literal">[dspace]/config/item-submission.xml</code> contains the submission configurations for <span class="emphasis"><em>both</em></span> the DSpace JSP user interface (JSPUI) or the DSpace XML user interface (XMLUI or Manakin). This configuration file contains detailed documentation within the file itself, which should help you better understand how to best utilize it.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14601"></a>11.1.1. The Structure of <code class="literal">item-submission.xml</code></h3></div></div></div><pre class="screen">
|
||||
</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14607"></a>11.1. Understanding the Submission Configuration File</h2></div></div></div><p>The <code class="literal">[dspace]/config/item-submission.xml</code> contains the submission configurations for <span class="emphasis"><em>both</em></span> the DSpace JSP user interface (JSPUI) or the DSpace XML user interface (XMLUI or Manakin). This configuration file contains detailed documentation within the file itself, which should help you better understand how to best utilize it.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14614"></a>11.1.1. The Structure of <code class="literal">item-submission.xml</code></h3></div></div></div><pre class="screen">
|
||||
|
||||
<code class="literal"> <item-submission> <!-- Where submission processes are
|
||||
mapped to specific Collections --> <submission-map> <name-map
|
||||
@@ -22,7 +22,7 @@
|
||||
<code class="literal">Select Collection -> Initial Questions -> Describe -> Upload -> Verify -> License -> Complete</code>
|
||||
</p><p>If you would like to customize the steps used or the ordering of the steps, you can do so within the <code class="literal"><submission-definition></code> section of the <code class="literal">item-submission.xml</code> .</p><p>In addition, you may also specify different Submission Processes for different DSpace Collections. This can be done in the <code class="literal"><submission-map></code> section. The <code class="literal">item-submission.xml</code> file itself documents the syntax required to perform these configuration changes.</p><p>
|
||||
<a name="docbook-submission.html--stepDefinitions"></a>
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14630"></a>11.1.2. Defining Steps (<code class="literal"><step></code>) within the <code class="literal">item-submission.xml</code></h3></div></div></div><p>This section describes how Steps of the Submission Process are defined within the <code class="literal">item-submission.xml</code>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14641"></a>Where to place your <code class="literal"><step></code> definitions</h4></div></div></div><p><code class="literal"><step></code> definitions can appear in one of two places within the <code class="literal">item-submission.xml</code> configuration file.</p><div class="orderedlist"><ol type="1"><li><p> Within the <code class="literal"><step-definitions></code> section </p><div class="itemizedlist"><ul type="disc"><li><p> This is for globally defined <code class="literal"><step></code> definitions (i.e. steps which are used in multiple <code class="literal"><submission-process></code> definitions). Steps defined in this section <span class="bold"><strong>must</strong></span> define a unique <code class="literal">id</code> which can be used to reference this step.</p></li><li><p> For example: </p><pre class="screen">
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14643"></a>11.1.2. Defining Steps (<code class="literal"><step></code>) within the <code class="literal">item-submission.xml</code></h3></div></div></div><p>This section describes how Steps of the Submission Process are defined within the <code class="literal">item-submission.xml</code>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14654"></a>Where to place your <code class="literal"><step></code> definitions</h4></div></div></div><p><code class="literal"><step></code> definitions can appear in one of two places within the <code class="literal">item-submission.xml</code> configuration file.</p><div class="orderedlist"><ol type="1"><li><p> Within the <code class="literal"><step-definitions></code> section </p><div class="itemizedlist"><ul type="disc"><li><p> This is for globally defined <code class="literal"><step></code> definitions (i.e. steps which are used in multiple <code class="literal"><submission-process></code> definitions). Steps defined in this section <span class="bold"><strong>must</strong></span> define a unique <code class="literal">id</code> which can be used to reference this step.</p></li><li><p> For example: </p><pre class="screen">
|
||||
|
||||
<code class="literal"> <step-definitions> <step id="custom-step"> ...
|
||||
</step> ... </step-definitions> </code>
|
||||
@@ -32,7 +32,7 @@
|
||||
<code class="literal"> <submission-process> <step> ... </step>
|
||||
</submission-process></code>
|
||||
|
||||
</pre></li></ul></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N1469D"></a>The ordering of <code class="literal"><step></code> definitions <span class="bold"><strong>matters</strong></span>!</h4></div></div></div><p>The ordering of the <code class="literal"><step></code> tags within a <code class="literal"><submission-process></code> definition directly corresponds to the order in which those steps will appear!</p><p>For example, the following defines a Submission Process where the <span class="emphasis"><em>License</em></span> step directly precedes the <span class="emphasis"><em>Initial Questions</em></span> step (more information about the structure of the information under each <step> tag can be found in the section on <a class="link" href="ch11.html#docbook-submission.html-stepStructure">Structure of the <step> Definition</a> below):</p><pre class="screen">
|
||||
</pre></li></ul></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N146B0"></a>The ordering of <code class="literal"><step></code> definitions <span class="bold"><strong>matters</strong></span>!</h4></div></div></div><p>The ordering of the <code class="literal"><step></code> tags within a <code class="literal"><submission-process></code> definition directly corresponds to the order in which those steps will appear!</p><p>For example, the following defines a Submission Process where the <span class="emphasis"><em>License</em></span> step directly precedes the <span class="emphasis"><em>Initial Questions</em></span> step (more information about the structure of the information under each <step> tag can be found in the section on <a class="link" href="ch11.html#docbook-submission.html-stepStructure">Structure of the <step> Definition</a> below):</p><pre class="screen">
|
||||
|
||||
<code class="literal"> <submission-process> <!--Step 1 will be to Sign off on
|
||||
the License--> <step> <heading>submit.progressbar.license</heading>
|
||||
@@ -55,7 +55,7 @@ tialQuestionsStep</xmlui-binding>
|
||||
|
||||
</pre><p>
|
||||
<a name="docbook-submission.html-stepStructure"></a>
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N146CB"></a>Structure of the <step> Definition</h4></div></div></div><p>The same <step> definition is used by both the DSpace JSP user interface (JSPUI) an the DSpace XML user interface (XMLUI or Manakin). Therefore, you will notice each <step> definition contains information specific to each of these two interfaces.</p><p>The structure of the <step> Definition is as follows:</p><pre class="screen">
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N146DE"></a>Structure of the <step> Definition</h4></div></div></div><p>The same <step> definition is used by both the DSpace JSP user interface (JSPUI) an the DSpace XML user interface (XMLUI or Manakin). Therefore, you will notice each <step> definition contains information specific to each of these two interfaces.</p><p>The structure of the <step> Definition is as follows:</p><pre class="screen">
|
||||
|
||||
<code class="literal"> <step> <heading>submit.progressbar.describe</heading>
|
||||
<processing-class>org.dspace.submit.step.DescribeStep</processing-clas
|
||||
@@ -80,13 +80,13 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
<span class="bold"><strong>workflow-editable</strong></span>
|
||||
</span></dt><dd><p>Defines whether or not this step can be edited during the <span class="emphasis"><em>Edit Metadata</em></span> process with the DSpace approval/rejection workflow process. Possible values include <code class="literal">true</code> and <code class="literal">false</code>. If undefined, defaults to <code class="literal">true</code> (which means that workflow reviewers would be allowed to edit information gathered during that step).</p></dd></dl></div><p>
|
||||
<a name="docbook-submission.html-stepOrdering"></a>
|
||||
</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14764"></a>11.2. Reordering/Removing Submission Steps</h2></div></div></div><p>The removal of existing steps and reordering of existing steps is a relatively easy process!</p><p>
|
||||
</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14777"></a>11.2. Reordering/Removing Submission Steps</h2></div></div></div><p>The removal of existing steps and reordering of existing steps is a relatively easy process!</p><p>
|
||||
<span class="bold"><strong>Reordering steps</strong></span>
|
||||
</p><div class="orderedlist"><ol type="1"><li><p> Locate the <code class="literal"><submission-process></code> tag which defines the Submission Process that you are using. If you are unsure which Submission Process you are using, it's likely the one with <code class="literal">name="traditional"</code>, since this is the traditional DSpace submission process.</p></li><li><p> Reorder the <code class="literal"><step></code> tags within that <code class="literal"><submission-process></code> tag. Be sure to move the <span class="emphasis"><em>entire</em></span><code class="literal"><step></code> tag (i.e. everything between and including the opening <code class="literal"><step></code> and closing <code class="literal"></step></code> tags). </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Hint #1:</em></span> The <code class="literal"><step></code> defining the <span class="emphasis"><em>Review/Verify</em></span> step only allows the user to review information from steps which appear <span class="bold"><strong>before</strong></span> it. So, it's likely you'd want this to appear as one of your last few steps</p></li><li><p><span class="emphasis"><em>Hint #2:</em></span> If you are using it, the <code class="literal"><step></code> defining the <span class="emphasis"><em>Initial Questions</em></span> step should always appear <span class="bold"><strong>before</strong></span> the <span class="emphasis"><em>Upload</em></span> or <span class="emphasis"><em>Describe</em></span> steps since it asks questions which help to set up those later steps.</p></li></ul></div></li></ol></div><p>
|
||||
<span class="bold"><strong>Removing one or more steps</strong></span>
|
||||
</p><div class="orderedlist"><ol type="1"><li><p> Locate the <code class="literal"><submission-process></code> tag which defines the Submission Process that you are using. If you are unsure which Submission Process you are using, it's likely the one with <code class="literal">name="traditional"</code>, since this is the traditional DSpace submission process.</p></li><li><p> Comment out (i.e. surround with <!-- and -->) the <code class="literal"><step></code> tags which you want to remove from that <code class="literal"><submission-process></code> tag. Be sure to comment out the <span class="emphasis"><em>entire</em></span><code class="literal"><step></code> tag (i.e. everything between and including the opening <code class="literal"><step></code> and closing <code class="literal"></step></code> tags). </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Hint #1:</em></span> You cannot remove the <span class="emphasis"><em>Select a Collection</em></span> step, as an DSpace Item cannot exist without belonging to a Collection.</p></li><li><p><span class="emphasis"><em>Hint #2:</em></span> If you decide to remove the <code class="literal"><step></code> defining the <span class="emphasis"><em>Initial Questions</em></span> step, you should be aware that this may affect your <span class="emphasis"><em>Describe</em></span> and <span class="emphasis"><em>Upload</em></span> steps! The <span class="emphasis"><em>Initial Questions</em></span> step asks questions which help to initialize these later steps. If you decide to remove the <span class="emphasis"><em>Initial Questions</em></span> step you may wish to create a custom, automated step which will provide default answers for the questions asked!</p></li></ul></div></li></ol></div><p>
|
||||
<a name="docbook-submission.html-collectionSubmission"></a>
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14811"></a>11.3. Assigning a custom Submission Process to a Collection</h2></div></div></div><p>Assigning a custom submission process to a Collection in DSpace involves working with the <code class="literal">submission-map</code> section of the <code class="literal">item-submission.xml</code>. For a review of the structure of the <code class="literal">item-submission.xml</code> see the section above on <a class="link" href="ch11.html#docbook-submission.html-configurationFile">Understanding the Submission Configuration File</a>.</p><p>Each <code class="literal">name-map</code> element within <code class="literal">submission-map</code> associates a collection with the name of a submission definition. Its <code class="literal">collection-handle</code> attribute is the Handle of the collection. Its <code class="literal">submission-name</code> attribute is the submission definition name, which must match the <code class="literal">name</code> attribute of a <code class="literal">submission-process</code> element (in the <code class="literal">submission-definitions</code> section of <code class="literal">item-submission.xml</code>.</p><p>For example, the following fragment shows how the collection with handle "12345.6789/42" is assigned the "custom" submission process:</p><pre class="screen">
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14824"></a>11.3. Assigning a custom Submission Process to a Collection</h2></div></div></div><p>Assigning a custom submission process to a Collection in DSpace involves working with the <code class="literal">submission-map</code> section of the <code class="literal">item-submission.xml</code>. For a review of the structure of the <code class="literal">item-submission.xml</code> see the section above on <a class="link" href="ch11.html#docbook-submission.html-configurationFile">Understanding the Submission Configuration File</a>.</p><p>Each <code class="literal">name-map</code> element within <code class="literal">submission-map</code> associates a collection with the name of a submission definition. Its <code class="literal">collection-handle</code> attribute is the Handle of the collection. Its <code class="literal">submission-name</code> attribute is the submission definition name, which must match the <code class="literal">name</code> attribute of a <code class="literal">submission-process</code> element (in the <code class="literal">submission-definitions</code> section of <code class="literal">item-submission.xml</code>.</p><p>For example, the following fragment shows how the collection with handle "12345.6789/42" is assigned the "custom" submission process:</p><pre class="screen">
|
||||
<submission-map>
|
||||
<name-map collection-handle="<span class="bold"><strong> 12345.6789/42</strong></span>" submission-name="<span class="bold"><strong>
|
||||
custom</strong></span>" />
|
||||
@@ -98,12 +98,12 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
custom</strong></span>">
|
||||
...
|
||||
</submission-definitions>
|
||||
</pre><p>It's a good idea to keep the definition of the <code class="literal">default</code> name-map from the example <code class="literal">input-forms.xml</code> so there is always a default for collections which do not have a custom form set.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14864"></a>11.3.1. Getting A Collection's Handle</h3></div></div></div><p>You will need the <span class="emphasis"><em>handle</em></span> of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities & Collections" page under "<span class="bold"><strong>Browse</strong></span>" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:</p><pre class="screen">
|
||||
</pre><p>It's a good idea to keep the definition of the <code class="literal">default</code> name-map from the example <code class="literal">input-forms.xml</code> so there is always a default for collections which do not have a custom form set.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14877"></a>11.3.1. Getting A Collection's Handle</h3></div></div></div><p>You will need the <span class="emphasis"><em>handle</em></span> of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities & Collections" page under "<span class="bold"><strong>Browse</strong></span>" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:</p><pre class="screen">
|
||||
http://myhost.my.edu/dspace/handle/<span class="underline">
|
||||
12345.6789/42</span>
|
||||
</pre><p>The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the <code class="literal">collection-handle</code> attribute of your <code class="literal">name-map</code> element.</p><p>
|
||||
<a name="docbook-submission.html-metadataEntry"></a>
|
||||
</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14887"></a>11.4. Custom Metadata-entry Pages for Submission</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1488B"></a>11.4.1. Introduction</h3></div></div></div><p>This section explains how to customize the Web forms used by submitters and editors to enter and modify the metadata for a new item. These metadata web forms are controlled by the <span class="emphasis"><em>Describe</em></span> step within the Submission Process. However, they are also configurable via their own XML configuration file (<code class="literal">input-forms.xml</code>).</p><p>You can customize the "default" metadata forms used by all collections, and also create alternate sets of metadata forms and assign them to specific collections. In creating custom metadata forms, you can choose:</p><div class="itemizedlist"><ul type="disc"><li><p> The number of metadata-entry pages.</p></li><li><p> Which fields appear on each page, and their sequence.</p></li><li><p> Labels, prompts, and other text associated with each field.</p></li><li><p> List of available choices for each menu-driven field.</p></li></ul></div><p><span class="bold"><strong>N.B.</strong></span>The cosmetic and ergonomic details of metadata entry fields remain the same as the fixed metadata pages in previous DSpace releases, and can only be altered by modifying the appropriate stylesheet and JSP pages.</p><p>All of the custom metadata-entry forms for a DSpace instance are controlled by a single XML file, <code class="literal">input-forms.xml</code>, in the <code class="literal">config</code> subdirectory under the DSpace home. DSpace comes with a sample configuration that implements the traditional metadata-entry forms, which also serves as a well-documented example. The rest of this section explains how to create your own sets of custom forms.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N148B6"></a>11.4.2. Describing Custom Metadata Forms</h3></div></div></div><p>The description of a set of pages through which submitters enter their metadata is called a <span class="emphasis"><em>form</em></span> (although it is actually a set of forms, in the HTML sense of the term). A form is identified by a unique symbolic <span class="emphasis"><em>name</em></span>. In the XML structure, the <span class="emphasis"><em>form</em></span> is broken down into a series of <span class="emphasis"><em>pages</em></span>: each of these represents a separate Web page for collecting metadata elements.</p><p>To set up one of your DSpace collections with customized submission forms, first you make an entry in the <span class="emphasis"><em>form-map</em></span>. This is effectively a table that relates a collection to a form set, by connecting the collection's <span class="emphasis"><em>Handle</em></span> to the form name. Collections are identified by handle because their names are mutable and not necessarily unique, while handles are unique and persistent.</p><p>A special map entry, for the collection handle "default", defines the <span class="emphasis"><em>default</em></span> form set. It applies to all collections which are not explicitly mentioned in the map. In the example XML this form set is named <code class="literal">traditional</code> (for the "traditional" DSpace user interface) but it could be named anything.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N148D9"></a>11.4.3. The Structure of <code class="literal">input-forms.xml</code></h3></div></div></div><p>The XML configuration file has a single top-level element, <code class="literal">input-forms</code>, which contains three elements in a specific order. The outline is as follows:</p><pre class="screen">
|
||||
</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N1489A"></a>11.4. Custom Metadata-entry Pages for Submission</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1489E"></a>11.4.1. Introduction</h3></div></div></div><p>This section explains how to customize the Web forms used by submitters and editors to enter and modify the metadata for a new item. These metadata web forms are controlled by the <span class="emphasis"><em>Describe</em></span> step within the Submission Process. However, they are also configurable via their own XML configuration file (<code class="literal">input-forms.xml</code>).</p><p>You can customize the "default" metadata forms used by all collections, and also create alternate sets of metadata forms and assign them to specific collections. In creating custom metadata forms, you can choose:</p><div class="itemizedlist"><ul type="disc"><li><p> The number of metadata-entry pages.</p></li><li><p> Which fields appear on each page, and their sequence.</p></li><li><p> Labels, prompts, and other text associated with each field.</p></li><li><p> List of available choices for each menu-driven field.</p></li></ul></div><p><span class="bold"><strong>N.B.</strong></span>The cosmetic and ergonomic details of metadata entry fields remain the same as the fixed metadata pages in previous DSpace releases, and can only be altered by modifying the appropriate stylesheet and JSP pages.</p><p>All of the custom metadata-entry forms for a DSpace instance are controlled by a single XML file, <code class="literal">input-forms.xml</code>, in the <code class="literal">config</code> subdirectory under the DSpace home. DSpace comes with a sample configuration that implements the traditional metadata-entry forms, which also serves as a well-documented example. The rest of this section explains how to create your own sets of custom forms.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N148C9"></a>11.4.2. Describing Custom Metadata Forms</h3></div></div></div><p>The description of a set of pages through which submitters enter their metadata is called a <span class="emphasis"><em>form</em></span> (although it is actually a set of forms, in the HTML sense of the term). A form is identified by a unique symbolic <span class="emphasis"><em>name</em></span>. In the XML structure, the <span class="emphasis"><em>form</em></span> is broken down into a series of <span class="emphasis"><em>pages</em></span>: each of these represents a separate Web page for collecting metadata elements.</p><p>To set up one of your DSpace collections with customized submission forms, first you make an entry in the <span class="emphasis"><em>form-map</em></span>. This is effectively a table that relates a collection to a form set, by connecting the collection's <span class="emphasis"><em>Handle</em></span> to the form name. Collections are identified by handle because their names are mutable and not necessarily unique, while handles are unique and persistent.</p><p>A special map entry, for the collection handle "default", defines the <span class="emphasis"><em>default</em></span> form set. It applies to all collections which are not explicitly mentioned in the map. In the example XML this form set is named <code class="literal">traditional</code> (for the "traditional" DSpace user interface) but it could be named anything.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N148EC"></a>11.4.3. The Structure of <code class="literal">input-forms.xml</code></h3></div></div></div><p>The XML configuration file has a single top-level element, <code class="literal">input-forms</code>, which contains three elements in a specific order. The outline is as follows:</p><pre class="screen">
|
||||
<input-forms>
|
||||
|
||||
<-- <span class="emphasis"><em> Map of Collections to Form Sets</em></span> -->
|
||||
@@ -127,7 +127,7 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
...
|
||||
</form-value-pairs>
|
||||
</input-forms>
|
||||
</pre><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N148F2"></a>Adding a Collection Map</h4></div></div></div><p>Each <code class="literal">name-map</code> element within <code class="literal">form-map</code> associates a collection with the name of a form set. Its <code class="literal">collection-handle</code> attribute is the Handle of the collection, and its <code class="literal">form-name</code> attribute is the form set name, which must match the <code class="literal">name</code> attribute of a <code class="literal">form</code> element.</p><p>For example, the following fragment shows how the collection with handle "12345.6789/42" is attached to the "TechRpt" form set:</p><pre class="screen">
|
||||
</pre><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14905"></a>Adding a Collection Map</h4></div></div></div><p>Each <code class="literal">name-map</code> element within <code class="literal">form-map</code> associates a collection with the name of a form set. Its <code class="literal">collection-handle</code> attribute is the Handle of the collection, and its <code class="literal">form-name</code> attribute is the form set name, which must match the <code class="literal">name</code> attribute of a <code class="literal">form</code> element.</p><p>For example, the following fragment shows how the collection with handle "12345.6789/42" is attached to the "TechRpt" form set:</p><pre class="screen">
|
||||
<form-map>
|
||||
<name-map collection-handle="<span class="bold"><strong> 12345.6789/42</strong></span>" form-name="<span class="bold"><strong> TechRpt</strong></span>"
|
||||
/>
|
||||
@@ -139,12 +139,12 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
TechRept</strong></span>">
|
||||
...
|
||||
</form-definitions>
|
||||
</pre><p>It's a good idea to keep the definition of the <code class="literal">default</code> name-map from the example <code class="literal">input-forms.xml</code> so there is always a default for collections which do not have a custom form set.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N1492B"></a>Getting A Collection's Handle</h5></div></div></div><p>You will need the <span class="emphasis"><em>handle</em></span> of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities & Collections" page under "<span class="bold"><strong>Browse</strong></span>" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:</p><pre class="screen">
|
||||
</pre><p>It's a good idea to keep the definition of the <code class="literal">default</code> name-map from the example <code class="literal">input-forms.xml</code> so there is always a default for collections which do not have a custom form set.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N1493E"></a>Getting A Collection's Handle</h5></div></div></div><p>You will need the <span class="emphasis"><em>handle</em></span> of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities & Collections" page under "<span class="bold"><strong>Browse</strong></span>" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:</p><pre class="screen">
|
||||
http://myhost.my.edu/dspace/handle/<span class="underline">
|
||||
12345.6789/42</span>
|
||||
</pre><p>The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the <code class="literal">collection-handle</code> attribute of your <code class="literal">name-map</code> element.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14949"></a>Adding a Form Set</h4></div></div></div><p>You can add a new form set by creating a new <code class="literal">form</code> element within the <code class="literal">form-definitions</code> element. It has one attribute, <code class="literal">name</code>, which as seen above must match the value of the <code class="literal">name-map</code> for the collections it is to be used for.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N1495F"></a>Forms and Pages</h5></div></div></div><p>The content of the <code class="literal">form</code> is a sequence of <code class="literal">page</code> elements. Each of these corresponds to a Web page of forms for entering metadata elements, presented in sequence between the initial "Describe" page and the final "Verify" page (which presents a summary of all the metadata collected).</p><p>A <code class="literal">form</code> must contain at least one and at most six pages. They are presented in the order they appear in the XML. Each <code class="literal">page</code> element must include a <code class="literal">number</code> attribute, that should be its sequence number, e.g.</p><pre class="screen">
|
||||
</pre><p>The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the <code class="literal">collection-handle</code> attribute of your <code class="literal">name-map</code> element.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N1495C"></a>Adding a Form Set</h4></div></div></div><p>You can add a new form set by creating a new <code class="literal">form</code> element within the <code class="literal">form-definitions</code> element. It has one attribute, <code class="literal">name</code>, which as seen above must match the value of the <code class="literal">name-map</code> for the collections it is to be used for.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14972"></a>Forms and Pages</h5></div></div></div><p>The content of the <code class="literal">form</code> is a sequence of <code class="literal">page</code> elements. Each of these corresponds to a Web page of forms for entering metadata elements, presented in sequence between the initial "Describe" page and the final "Verify" page (which presents a summary of all the metadata collected).</p><p>A <code class="literal">form</code> must contain at least one and at most six pages. They are presented in the order they appear in the XML. Each <code class="literal">page</code> element must include a <code class="literal">number</code> attribute, that should be its sequence number, e.g.</p><pre class="screen">
|
||||
<page number="1">
|
||||
</pre><p>The <code class="literal">page</code> element, in turn, contains a sequence of <code class="literal">field</code> elements. Each field defines an interactive dialog where the submitter enters one of the Dublin Core metadata items.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14988"></a>Composition of a Field</h5></div></div></div><p>Each <code class="literal">field</code> contains the following elements, in the order indicated. The required sub-elements are so marked:</p><div class="variablelist"><dl><dt><span class="term">
|
||||
</pre><p>The <code class="literal">page</code> element, in turn, contains a sequence of <code class="literal">field</code> elements. Each field defines an interactive dialog where the submitter enters one of the Dublin Core metadata items.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N1499B"></a>Composition of a Field</h5></div></div></div><p>Each <code class="literal">field</code> contains the following elements, in the order indicated. The required sub-elements are so marked:</p><div class="variablelist"><dl><dt><span class="term">
|
||||
<span class="bold"><strong>dc-schema</strong></span>
|
||||
<span class="emphasis"><em>(Required)</em></span>
|
||||
</span></dt><dd><p>Name of metadata schema employed, e.g. <code class="literal">dc</code> for Dublin Core. This value must match the value of the <code class="literal">schema</code> element defined in <code class="literal">dublin-core-types.xml</code></p></dd><dt><span class="term">
|
||||
@@ -173,7 +173,7 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
</span></dt><dd><p>When this optional element is included with a value, it restricts the visibility of the field to the scope defined by that value. If the element is missing or empty, the field is visible in all scopes. Currently supported scopes are: <div class="itemizedlist"><ul type="disc"><li><p><span class="bold"><strong>workflow</strong></span> : the field will only be visible in the workflow stages of submission. This is good for hiding difficult fields for users, such as subject classifications, thereby easing the use of the submission system.</p></li><li><p><span class="bold"><strong>submit</strong></span> : the field will only be visible in the initial submission, and not in the workflow stages.</p></li></ul></div>
|
||||
For example:</p><p>
|
||||
<code class="literal"><visibility>workflow</visibility></code>
|
||||
</p><p> Note that it is considered a configuration error to limit a field's scope while also requiring it - an exception will be generated when this combination is detected.</p></dd></dl></div><p>Look at the example <code class="literal">input-forms.xml</code> and experiment with a a trial custom form to learn this specification language thoroughly. It is a very simple way to express the layout of data-entry forms, but the only way to learn all its subtleties is to use it.</p><p>For the use of controlled vocabularies see the <a class="ulink" href="configure.html#controlledvocabulary" target="_top">Configuring Controlled Vocabularies</a> section.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14AC8"></a>Automatically Elided Fields</h5></div></div></div><p>You may notice that some fields are automatically skipped when a custom form page is displayed, depending on the kind of item being submitted. This is because the DSpace user-interface engine skips Dublin Core fields which are not needed, according to the initial description of the item. For example, if the user indicates there are no alternate titles on the first "Describe" page (the one with a few checkboxes), the input for the <code class="literal">title.alternative</code> DC element is automatically elided, <span class="emphasis"><em>even on custom submission pages.</em></span></p><p> When a user initiates a submission, DSpace first displays what we'll call the "initial-questions page". By default, it contains three questions with check-boxes: <div class="orderedlist"><ol type="1"><li><p>
|
||||
</p><p> Note that it is considered a configuration error to limit a field's scope while also requiring it - an exception will be generated when this combination is detected.</p></dd></dl></div><p>Look at the example <code class="literal">input-forms.xml</code> and experiment with a a trial custom form to learn this specification language thoroughly. It is a very simple way to express the layout of data-entry forms, but the only way to learn all its subtleties is to use it.</p><p>For the use of controlled vocabularies see the <a class="ulink" href="configure.html#controlledvocabulary" target="_top">Configuring Controlled Vocabularies</a> section.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14ADB"></a>Automatically Elided Fields</h5></div></div></div><p>You may notice that some fields are automatically skipped when a custom form page is displayed, depending on the kind of item being submitted. This is because the DSpace user-interface engine skips Dublin Core fields which are not needed, according to the initial description of the item. For example, if the user indicates there are no alternate titles on the first "Describe" page (the one with a few checkboxes), the input for the <code class="literal">title.alternative</code> DC element is automatically elided, <span class="emphasis"><em>even on custom submission pages.</em></span></p><p> When a user initiates a submission, DSpace first displays what we'll call the "initial-questions page". By default, it contains three questions with check-boxes: <div class="orderedlist"><ol type="1"><li><p>
|
||||
<span class="bold"><strong>The item has more than one title, e.g. a translated title</strong></span>
|
||||
</p><p> Controls <code class="literal">title.alternative</code> field.</p></li><li><p>
|
||||
<span class="bold"><strong>The item has been published or publicly distributed before</strong></span>
|
||||
@@ -188,9 +188,9 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
</p><p>
|
||||
<span class="emphasis"><em>Does not affect any metadata input fields.</em></span>
|
||||
</p></li></ol></div>
|
||||
The answers to the first two questions control whether inputs for certain of the DC metadata fields will displayed, even if they are defined as fields in a custom page. Conversely, if the metadata fields controlled by a checkbox are not mentioned in the custom form, the checkbox is elided from the initial page to avoid confusing or misleading the user.</p><p>The two relevant checkbox entries are "The item has more than one title, e.g. a translated title", and "The item has been published or publicly distributed before". The checkbox for multiple titles trigger the display of the field with dc-element equal to 'title' and dc-qualifier equal to 'alternative'. If the controlling collection's form set does not contain this field, then the multiple titles question will not appear on the initial questions page.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14B14"></a>Adding <code class="literal">Value-Pairs</code></h4></div></div></div><p> Finally, your custom form description needs to define the "value pairs" for any fields with input types that refer to them. Do this by adding a <code class="literal">value-pairs</code> element to the contents of <code class="literal">form-value-pairs</code>. It has the following required attributes: <div class="itemizedlist"><ul type="disc"><li><p><span class="bold"><strong>value-pairs-name</strong></span> -- Name by which an <code class="literal">input-type</code> refers to this list.</p></li><li><p><span class="bold"><strong>dc-term</strong></span> -- Qualified Dublin Core field for which this choice list is selecting a value.</p></li></ul></div>
|
||||
The answers to the first two questions control whether inputs for certain of the DC metadata fields will displayed, even if they are defined as fields in a custom page. Conversely, if the metadata fields controlled by a checkbox are not mentioned in the custom form, the checkbox is elided from the initial page to avoid confusing or misleading the user.</p><p>The two relevant checkbox entries are "The item has more than one title, e.g. a translated title", and "The item has been published or publicly distributed before". The checkbox for multiple titles trigger the display of the field with dc-element equal to 'title' and dc-qualifier equal to 'alternative'. If the controlling collection's form set does not contain this field, then the multiple titles question will not appear on the initial questions page.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14B27"></a>Adding <code class="literal">Value-Pairs</code></h4></div></div></div><p> Finally, your custom form description needs to define the "value pairs" for any fields with input types that refer to them. Do this by adding a <code class="literal">value-pairs</code> element to the contents of <code class="literal">form-value-pairs</code>. It has the following required attributes: <div class="itemizedlist"><ul type="disc"><li><p><span class="bold"><strong>value-pairs-name</strong></span> -- Name by which an <code class="literal">input-type</code> refers to this list.</p></li><li><p><span class="bold"><strong>dc-term</strong></span> -- Qualified Dublin Core field for which this choice list is selecting a value.</p></li></ul></div>
|
||||
Each <code class="literal">value-pairs</code> element contains a sequence of <code class="literal">pair</code> sub-elements, each of which in turn contains two elements: <div class="itemizedlist"><ul type="disc"><li><p><span class="bold"><strong>displayed-value</strong></span> -- Name shown (on the web page) for the menu entry.</p></li><li><p><span class="bold"><strong>stored-value</strong></span> -- Value stored in the DC element when this entry is chosen.</p></li></ul></div>
|
||||
Unlike the HTML <code class="literal">select</code> tag, there is no way to indicate one of the entries should be the default, so the first entry is always the default choice.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14B51"></a>Example</h5></div></div></div><p>Here is a menu of types of common identifiers:</p><pre class="screen">
|
||||
Unlike the HTML <code class="literal">select</code> tag, there is no way to indicate one of the entries should be the default, so the first entry is always the default choice.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14B64"></a>Example</h5></div></div></div><p>Here is a menu of types of common identifiers:</p><pre class="screen">
|
||||
<value-pairs value-pairs-name="common_identifiers"
|
||||
dc-term="identifier">
|
||||
<pair>
|
||||
@@ -218,18 +218,18 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
<option VALUE="uri">URI</option>
|
||||
<option VALUE="isbn">ISBN</option>
|
||||
</select>
|
||||
</pre><span class="bold"><strong>Identifiers:</strong></span>Gov't Doc #URIISBN</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14B67"></a>11.4.4. Deploying Your Custom Forms</h3></div></div></div><p> The DSpace web application only reads your custom form definitions when it starts up, so it is important to remember: <div class="blockquote"><blockquote class="blockquote"><p>
|
||||
</pre><span class="bold"><strong>Identifiers:</strong></span>Gov't Doc #URIISBN</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14B7A"></a>11.4.4. Deploying Your Custom Forms</h3></div></div></div><p> The DSpace web application only reads your custom form definitions when it starts up, so it is important to remember: <div class="blockquote"><blockquote class="blockquote"><p>
|
||||
<span class="emphasis"><em><span class="bold"><strong>You must always restart Tomcat</strong></span> (or whatever servlet container you are using) for changes made to the <code class="literal">input-forms.xml</code> file take effect.</em></span>
|
||||
</p></blockquote></div>
|
||||
Any mistake in the syntax or semantics of the form definitions, such as poorly formed XML or a reference to a nonexistent field name, will cause a fatal error in the DSpace UI. The exception message (at the top of the stack trace in the <code class="literal">dspace.log</code> file) usually has a concise and helpful explanation of what went wrong. Don't forget to stop and restart the servlet container before testing your fix to a bug.</p><p>
|
||||
<a name="docbook-submission.html-uploadStep"></a>
|
||||
</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14B84"></a>11.5. Configuring the File Upload step</h2></div></div></div><p>The <span class="emphasis"><em>Upload</em></span> step in the DSpace submission process has two configuration options which can be set with your <code class="literal">[dspace]/config/dspace.cfg</code> configuration file. They are as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">upload.max</code> - The maximum size of a file (in bytes) that can be uploaded from the JSPUI (not applicable for the XMLUI). It defaults to 536870912 bytes (512MB). You may set this to -1 to disable any file size limitation. </p><div class="itemizedlist"><ul type="circle"><li><p><span class="emphasis"><em>Note:</em></span> Increasing this value or setting to -1 does <span class="bold"><strong>not</strong></span> guarantee that DSpace will be able to successfully upload larger files via the web, as large uploads depend on many other factors including bandwidth, web server settings, internet connection speed, etc.</p></li></ul></div></li><li><p><code class="literal">webui.submit.upload.required</code> - Whether or not all users are <span class="emphasis"><em>required</em></span> to upload a file when they submit an item to DSpace. It defaults to 'true'. When set to 'false' users will see an option to skip the upload step when they submit a new item.</p></li></ul></div><p>
|
||||
</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14B97"></a>11.5. Configuring the File Upload step</h2></div></div></div><p>The <span class="emphasis"><em>Upload</em></span> step in the DSpace submission process has two configuration options which can be set with your <code class="literal">[dspace]/config/dspace.cfg</code> configuration file. They are as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">upload.max</code> - The maximum size of a file (in bytes) that can be uploaded from the JSPUI (not applicable for the XMLUI). It defaults to 536870912 bytes (512MB). You may set this to -1 to disable any file size limitation. </p><div class="itemizedlist"><ul type="circle"><li><p><span class="emphasis"><em>Note:</em></span> Increasing this value or setting to -1 does <span class="bold"><strong>not</strong></span> guarantee that DSpace will be able to successfully upload larger files via the web, as large uploads depend on many other factors including bandwidth, web server settings, internet connection speed, etc.</p></li></ul></div></li><li><p><code class="literal">webui.submit.upload.required</code> - Whether or not all users are <span class="emphasis"><em>required</em></span> to upload a file when they submit an item to DSpace. It defaults to 'true'. When set to 'false' users will see an option to skip the upload step when they submit a new item.</p></li></ul></div><p>
|
||||
<a name="docbook-submission.html-createStep"></a>
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14BB0"></a>11.6. Creating new Submission Steps</h2></div></div></div><p>First, a brief warning: <span class="emphasis"><em>Creating a new Submission Step requires some Java knowledge, and is therefore recommended to be undertaken by a Java programmer whenever possible</em></span></p><p>That being said, at a higher level, creating a new Submission Step requires the following (in this relative order):</p><div class="orderedlist"><ol type="1"><li><p> (<span class="bold"><strong>Required</strong></span>) Create a new Step Processing class </p><div class="itemizedlist"><ul type="disc"><li><p> This class <span class="bold"><strong>must</strong></span> extend the abstract <code class="literal">org.dspace.submit.AbstractProcessingStep</code> class and implement all methods defined by that abstract class.</p></li><li><p> This class should be built in such a way that it can process the input gathered from <span class="emphasis"><em>either</em></span> the XMLUI or JSPUI interface.</p></li></ul></div></li><li><p> (<span class="emphasis"><em>For steps using JSPUI</em></span>) Create the JSPs to display the user interface. Create a new JSPUI "binding" class to initialize and call these JSPs.</p></li><li><p>
|
||||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N14BC3"></a>11.6. Creating new Submission Steps</h2></div></div></div><p>First, a brief warning: <span class="emphasis"><em>Creating a new Submission Step requires some Java knowledge, and is therefore recommended to be undertaken by a Java programmer whenever possible</em></span></p><p>That being said, at a higher level, creating a new Submission Step requires the following (in this relative order):</p><div class="orderedlist"><ol type="1"><li><p> (<span class="bold"><strong>Required</strong></span>) Create a new Step Processing class </p><div class="itemizedlist"><ul type="disc"><li><p> This class <span class="bold"><strong>must</strong></span> extend the abstract <code class="literal">org.dspace.submit.AbstractProcessingStep</code> class and implement all methods defined by that abstract class.</p></li><li><p> This class should be built in such a way that it can process the input gathered from <span class="emphasis"><em>either</em></span> the XMLUI or JSPUI interface.</p></li></ul></div></li><li><p> (<span class="emphasis"><em>For steps using JSPUI</em></span>) Create the JSPs to display the user interface. Create a new JSPUI "binding" class to initialize and call these JSPs.</p></li><li><p>
|
||||
<div class="itemizedlist"><ul type="disc"><li><p> Your JSPUI "binding" class must extend the abstract class <code class="literal">org.dspace.app.webui.submit.JSPStep</code> and implement all methods defined there. It's recommended to use one of the classes in <code class="literal">org.dspace.app.webui.submit.step.*</code> as a reference.</p></li><li><p> Any JSPs created should be loaded by calling the showJSP() method of the <code class="literal">org.dspace.app.webui.submit.JSPStepManager</code> class</p></li><li><p> If this step gathers information to be reviewed, you must also create a Review JSP which will display a read-only view of all data gathered during this step. The path to this JSP must be returned by your getReviewJSP() method. You will find examples of Review JSPs (named similar to <code class="literal">review-[step].jsp</code>) in the JSP <code class="literal">submit/</code> directory.</p></li></ul></div>
|
||||
</p></li><li><p> (<span class="emphasis"><em>For steps using XMLUI</em></span>) Create an XMLUI "binding" Step Transformer which will generate the DRI XML which Manakin requires. </p><div class="itemizedlist"><ul type="disc"><li><p> The Step Transformer must extend and implement all necessary methods within the abstract class <code class="literal">org.dspace.app.xmlui.submission.AbstractSubmissionStep</code></p></li><li><p> It is useful to use the existing classes in <code class="literal">org.dspace.app.xmlui.submission.submit.*</code> as references</p></li></ul></div></li><li><p> (<span class="bold"><strong>Required</strong></span>) Add a valid Step Definition to the <code class="literal">item-submission.xml</code> configuration file. </p><div class="itemizedlist"><ul type="disc"><li><p> This may also require that you add an I18N (Internationalization) key for this step's <code class="literal">heading</code>. See the sections on <a class="ulink" href="configure.html#jspui-multilingual" target="_top">Configuring Multilingual Support for JSPUI</a> or <a class="ulink" href="configure.html#xmlui-multilingual" target="_top">Configuring Multilingual Support for XMLUI</a> for more details.</p></li><li><p> For more information on <code class="literal"><step></code> definitions within the <code class="literal">item-submission.xml</code>, see the section above on <a name="docbook-submission.html--stepDefinitions.1"></a>Defining Steps (<code class="literal"><step></code>) within the <code class="literal">item-submission.xml</code>.</p></li></ul></div></li></ol></div><p>
|
||||
<a name="docbook-submission.html-createStep.1"></a>
|
||||
</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14C49"></a>11.6.1. Creating a Non-Interactive Step</h3></div></div></div><p>Non-interactive steps are ones that have no user interface and only perform backend processing. You may find a need to create non-interactive steps which perform further processing of previously entered information.</p><p>To create a non-interactive step, do the following:</p><div class="orderedlist"><ol type="1"><li><p> Create the required Step Processing class, which extends the abstract <code class="literal">org.dspace.submit.AbstractProcessingStep</code> class. In this class add any processing which this step will perform.</p></li><li><p> Add your non-interactive step to your <code class="literal">item-submission.xml</code> at the place where you wish this step to be called during the submission process. For example, if you want it to be called <span class="emphasis"><em>immediately after</em></span> the existing 'Upload File' step, then place its configuration immediately after the configuration for that 'Upload File' step. The configuration should look similar to the following: </p><pre class="screen">
|
||||
</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N14C5C"></a>11.6.1. Creating a Non-Interactive Step</h3></div></div></div><p>Non-interactive steps are ones that have no user interface and only perform backend processing. You may find a need to create non-interactive steps which perform further processing of previously entered information.</p><p>To create a non-interactive step, do the following:</p><div class="orderedlist"><ol type="1"><li><p> Create the required Step Processing class, which extends the abstract <code class="literal">org.dspace.submit.AbstractProcessingStep</code> class. In this class add any processing which this step will perform.</p></li><li><p> Add your non-interactive step to your <code class="literal">item-submission.xml</code> at the place where you wish this step to be called during the submission process. For example, if you want it to be called <span class="emphasis"><em>immediately after</em></span> the existing 'Upload File' step, then place its configuration immediately after the configuration for that 'Upload File' step. The configuration should look similar to the following: </p><pre class="screen">
|
||||
|
||||
<code class="literal"> <step>
|
||||
<processing-class>org.dspace.submit.step.MyNonInteractveStep</processi
|
||||
@@ -243,4 +243,4 @@ cribeStep</xmlui-binding> <workflow-editable>true</workflow-edita
|
||||
<span class="inlinemediaobject"><img src="http://i.creativecommons.org/l/by/3.0/us/88x31.png"></span>
|
||||
Licensed under a Creative Commons Attribution 3.0 United States License
|
||||
</a>
|
||||
</p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ch10.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="ch12.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Chapter 10. DSpace System Documentation: Functional Overview </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Chapter 12. docbook/DRISchemaReference.html</td></tr></table></div></body></html>
|
||||
</p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ch10.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="ch12.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Chapter 10. DSpace System Documentation: Business Logic Layer </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Chapter 12. docbook/DRISchemaReference.html</td></tr></table></div></body></html>
|
||||
@@ -1,4 +1,4 @@
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 12. docbook/DRISchemaReference.html</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch11.html" title="Chapter 11. Customizing and Configuring Submission User Interface"><link rel="next" href="ch13.html" title="Chapter 13. DRI Schema Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 12. docbook/DRISchemaReference.html</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch11.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch13.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N14C6E"></a>Chapter 12. docbook/DRISchemaReference.html</h2></div></div></div><p> /* Code style */ div.element-example pre { border: 1px dashed black; overflow-x: hidden; background: rgb(240,240,240); margin: 0px; padding: 10px;} </p></div><HR><p class="copyright">Copyright © 2002-2008
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 12. docbook/DRISchemaReference.html</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch11.html" title="Chapter 11. Customizing and Configuring Submission User Interface"><link rel="next" href="ch13.html" title="Chapter 13. DRI Schema Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 12. docbook/DRISchemaReference.html</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch11.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch13.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N14C81"></a>Chapter 12. docbook/DRISchemaReference.html</h2></div></div></div><p> /* Code style */ div.element-example pre { border: 1px dashed black; overflow-x: hidden; background: rgb(240,240,240); margin: 0px; padding: 10px;} </p></div><HR><p class="copyright">Copyright © 2002-2008
|
||||
<a class="ulink" href="http://www.dspace.org/" target="_top">The DSpace Foundation</a>
|
||||
</p><div class="legalnotice"><a name="N10017"></a><p>
|
||||
<a class="ulink" href="http://creativecommons.org/licenses/by/3.0/us/" target="_top">
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,4 +1,4 @@
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 15. DSpace System Documentation: Appendices</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch14.html" title="Chapter 14. DSpace System Documentation: Version History"><link rel="next" href="ix01.html" title="Index"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 15. DSpace System Documentation: Appendices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch14.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ix01.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N1679D"></a>Chapter 15. DSpace System Documentation: Appendices</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch15.html#N167A1">15.1. Default Dublin Core Metadata Registry</a></span></dt><dt><span class="section"><a href="ch15.html#N16CFA">15.2. Default Bitstream Format Registry</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N167A1"></a>15.1. <a name="docbook-appendix.html-dublincoreregistry"></a>Default Dublin Core Metadata Registry</h2></div></div></div><div class="informaltable"><table border="1"><colgroup><col><col><col><col></colgroup><tbody><tr><td>
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 15. DSpace System Documentation: Appendices</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch14.html" title="Chapter 14. DSpace System Documentation: Version History"><link rel="next" href="ix01.html" title="Index"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 15. DSpace System Documentation: Appendices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch14.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ix01.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N1682A"></a>Chapter 15. DSpace System Documentation: Appendices</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch15.html#N1682E">15.1. Default Dublin Core Metadata Registry</a></span></dt><dt><span class="section"><a href="ch15.html#N16D87">15.2. Default Bitstream Format Registry</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N1682E"></a>15.1. <a name="docbook-appendix.html-dublincoreregistry"></a>Default Dublin Core Metadata Registry</h2></div></div></div><div class="informaltable"><table border="1"><colgroup><col><col><col><col></colgroup><tbody><tr><td>
|
||||
<p>
|
||||
<span class="bold"><strong>Element</strong></span>
|
||||
</p>
|
||||
@@ -506,7 +506,7 @@
|
||||
<p></p>
|
||||
</td></tr></tbody></table></div><p>
|
||||
<a name="docbook-appendix.html-note1"></a>
|
||||
</p><p>¹Used by system: do not remove</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N16CFA"></a>15.2. <a name="docbook-appendix.html-bitstreamformatregistry"></a>Default Bitstream Format Registry</h2></div></div></div><div class="informaltable"><table border="1"><colgroup><col><col><col><col><col><col></colgroup><tbody><tr><td>
|
||||
</p><p>¹Used by system: do not remove</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N16D87"></a>15.2. <a name="docbook-appendix.html-bitstreamformatregistry"></a>Default Bitstream Format Registry</h2></div></div></div><div class="informaltable"><table border="1"><colgroup><col><col><col><col><col><col></colgroup><tbody><tr><td>
|
||||
<p>
|
||||
<span class="bold"><strong>Mimetype</strong></span>
|
||||
</p>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,4 +1,4 @@
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Index</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch15.html" title="Chapter 15. DSpace System Documentation: Appendices"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Index</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch15.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> </td></tr></table><hr></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a name="N171B6"></a>Index</h2></div></div></div><div class="index"></div></div><HR><p class="copyright">Copyright © 2002-2008
|
||||
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Index</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1Beta1 Manual"><link rel="prev" href="ch15.html" title="Chapter 15. DSpace System Documentation: Appendices"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Index</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch15.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> </td></tr></table><hr></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a name="N17243"></a>Index</h2></div></div></div><div class="index"></div></div><HR><p class="copyright">Copyright © 2002-2008
|
||||
<a class="ulink" href="http://www.dspace.org/" target="_top">The DSpace Foundation</a>
|
||||
</p><div class="legalnotice"><a name="N10017"></a><p>
|
||||
<a class="ulink" href="http://creativecommons.org/licenses/by/3.0/us/" target="_top">
|
||||
|
||||
Binary file not shown.
Reference in New Issue
Block a user