hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-18 07:23:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update headings to 1.5.2, and fix most of the broken internal links.

Browse Source 
More to follow.



git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@3663 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Brad McLean
2009-03-31 14:50:55 +00:00
parent 53a56e504a
commit faff36653d
36 changed files with 583 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
dspace/docs/convert2DB.sh
View File

@@ -5,7 +5,9 @@
# Developed On Ubuntu Hardy Heron, you'll need at least:
# apt-get install herold docbook-utils docbook2x xsltproc docbook-xsl dbdoclet
VERSION="1.5.1"
if [ "a$DS_VERSION" == "a" ]; then
DS_VERSION="1.5.2"
fi
DBxml="docbook"
HTMLfinal="html"
@@ -45,7 +47,7 @@ if [ $haveDB -lt 1 ]; then
filelist=`ls *html`
cd ..
title="DSpace $VERSION Manual"
title="DSpace $DS_VERSION Manual"
# The initial raw html to db conversion:
for file in $filelist; do
@@ -93,7 +95,7 @@ if [ $haveDB -lt 1 ]; then
<book>
<bookinfo>
<title>DSpace $VERSION Manual</title>
<title>DSpace $DS_VERSION Manual</title>
<author>
<surname>The DSpace Foundation</surname>
@@ -236,7 +238,7 @@ XSLTP=" -param body.start.indent 0pt \
if [ "a$FOP_HOME" == "a" ]; then
FOP_HOME=/usr/local/share/fop-0.94
fi
java -Xmx128m -Dfop.home=$FOP_HOME -jar $FOP_HOME/build/fop.jar -xml $DBxml/book.xml -xsl $xslprint -pdf $PDFfinal/DSpace-$VERSION.pdf $XSLTP
java -Xmx128m -Dfop.home=$FOP_HOME -jar $FOP_HOME/build/fop.jar -xml $DBxml/book.xml -xsl $xslprint -pdf $PDFfinal/DSpace-$DS_VERSION.pdf $XSLTP
# HTML it using XSL
if [ ! -d $HTMLfinal ]; then
@@ -290,7 +292,7 @@ please feel free to add them to the wiki page below. You may also email suggest
//--> \
</script>.
\$a\
</p><br/><iframe src="http://wiki.dspace.org/index.php/AnnotateDoc_$VERSION_${file/.html/}" width="100%" height="600"/></body></html>
</p><br/><iframe src="http://wiki.dspace.org/index.php/AnnotateDoc_$DS_VERSION_${file/.html/}" width="100%" height="600"/></body></html>
EOF
done
fi

2
dspace/docs/docbook/DRISchemaReference.xml
View File

@@ -29,7 +29,7 @@
<section remap="h3">
<title>Themes</title>
<para>A Theme is a collection of XSL stylesheets and supporting files like images, CSS styles, translations, and help documents. The XSL stylesheets are applied to the DRI Document to covert it into a readable format and give it structure and basic visual formatting in that format. The supporting files are used to provide the page with a specific look and feel, insert images and other media, translate the content, and perform other tasks. The currently used output format is XHTML and the supporting files are generally limited to CSS, images, and JavaScript. More output formats, like PDF or SVG, may be added in the future.</para>
<para>A DSpace installation running Manakin may have several Themes associated with it. When applied to a page, a Theme determines most of the pageís look and feel. Different themes can be applied to different sets of DSpace pages allowing for both variety of styles between sets of pages and consistency within those sets. The xmlui.xconf configuration file determines which Themes are applied to which DSpace pages (see the <ulink url="configure.html#xmlui-configure">Configuration and Customization chapter</ulink> for more information on installing and configuring themes). Themes may be configured to apply to all pages of specific type, like browse-by-title, to all pages of a one particular community or collection or sets of communities and collections, and to any mix of the two. They can also be configured to apply to a singe arbitrary page or handle.</para>
<para>A DSpace installation running Manakin may have several Themes associated with it. When applied to a page, a Theme determines most of the pageís look and feel. Different themes can be applied to different sets of DSpace pages allowing for both variety of styles between sets of pages and consistency within those sets. The xmlui.xconf configuration file determines which Themes are applied to which DSpace pages (see the <link linkend="docbook-configure.html-xmlui-configure">Configuration and Customization chapter</link> for more information on installing and configuring themes). Themes may be configured to apply to all pages of specific type, like browse-by-title, to all pages of a one particular community or collection or sets of communities and collections, and to any mix of the two. They can also be configured to apply to a singe arbitrary page or handle.</para>
</section>
<section remap="h3">
<title>Aspect Chains</title>

5
dspace/docs/docbook/appendix.xml
View File

@@ -1,9 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Appendices</title>
<title><anchor id="docbook-appendix.html"/>DSpace System Documentation: Appendices</title>
<section remap="h2">
<title><anchor id="docbook-appendix.html-dublincoreregistry" xreflabel="Default
Dublin Core Metadata Registry"/>Default Dublin Core Metadata Registry</title>
<title><anchor id="docbook-appendix.html-dublincoreregistry" xreflabel="Default Dublin Core Metadata Registry"/>Default Dublin Core Metadata Registry</title>
<informaltable frame="all">
<tgroup cols="4">
<colspec colname="c1" colwidth="25*"/>

30
dspace/docs/docbook/application.xml
View File

@@ -1,8 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Application Layer</title>
<title><anchor id="docbook-application.html"/>DSpace System Documentation: Application Layer</title>
<para>
<ulink url="architecture.html">Back to architecture overview</ulink>
<link linkend="docbook-architecture.html">Back to architecture overview</link>
</para>
<section remap="h2">
<title><anchor id="docbook-application.html-webui" xreflabel="Web User Interface"/>Web User Interface</title>
@@ -106,7 +106,7 @@
</para>
</entry>
<entry>
<para>This is where you can place customized versions of JSPs -- see <ulink url="configure.html#customui">the configuration section</ulink></para>
<para>This is where you can place customized versions of JSPs -- see <link linkend="docbook-configure.html-customui">the configuration section</link></para>
</entry>
</row>
<row>
@@ -212,7 +212,7 @@ ant -D<emphasis> [dspace]</emphasis>/config/dspace.cfg update
<para><literal>[dspace-source]/jsp/dspace-admin/index.jsp</literal>, the administration UI index page, is invoked directly by Tomcat and not through a servlet for similar reasons.</para>
<para>At the top of each JSP file, right after the license and copyright header, is documented the appropriate attributes that a servlet must fill out prior to forwarding to that JSP. No validation is performed; if the servlet does not fill out the necessary attributes, it is likely that an internal server error will occur.</para>
<para>Many JSPs containing forms will include hidden parameters that tell the servlets which form has been filled out. The submission UI servlet (<literal>SubmissionController</literal> is a prime example of a servlet that deals with the input from many different JSPs. The <literal>step</literal> and <literal>page</literal> hidden parameters (written out by the <literal>SubmissionController.getSubmissionParameters()</literal> method) are used to inform the servlet which page of which step has just been filled out (i.e. which page of the submission the user has just completed).</para>
<para>Below is a detailed, scary diagram depicting the flow of control during the whole process of processing and responding to an HTTP request. More information about the authentication mechanism is mostly <ulink url="configure.html#authenticate">described in the configuration section</ulink>.</para>
<para>Below is a detailed, scary diagram depicting the flow of control during the whole process of processing and responding to an HTTP request. More information about the authentication mechanism is mostly <link linkend="docbook-configure.html-authenticate">described in the configuration section</link>.</para>
<para>
<inlinemediaobject>
<imageobject>
@@ -425,7 +425,7 @@ https://dspace.mit.edu/html/1721.1/12345/contents.html
https://dspace.mit.edu/html/1721.1/12345/figure1.gif
</screen>
<para>The HTML document servlet can work out which item the user is looking at, and then which Bitstream in it is called <literal>figure1.gif</literal>, and serve up that bitstream. Similar for following links to other HTML pages. Of course all the links and image references have to be relative and not absolute.</para>
<para>HTML documents must be &quot;self-contained&quot;, as <ulink url="functional.html#html">explained here</ulink>. Provided that full path information is known by DSpace, any depth or complexity of HTML document can be served subject to those contraints. This is usually possible with some kind of batch import. If, however, the document has been uploaded one file at a time using the Web UI, the path information has been stripped. The system can cope with relative links that refer to a deeper path, e.g.</para>
<para>HTML documents must be &quot;self-contained&quot;, as <link linkend="docbook-functional.html-html">explained here</link>. Provided that full path information is known by DSpace, any depth or complexity of HTML document can be served subject to those contraints. This is usually possible with some kind of batch import. If, however, the document has been uploaded one file at a time using the Web UI, the path information has been stripped. The system can cope with relative links that refer to a deeper path, e.g.</para>
<screen>
&lt;IMG SRC=&quot;images/figure1.gif&quot;&gt;
</screen>
@@ -746,7 +746,7 @@ t;
<section remap="h3">
<title><anchor id="docbook-application.html-importingitems" xreflabel="Importing
Items"/>Importing Items</title>
<para><emphasis role="bold">Note:</emphasis> Before running the item importer over items previously exported from a DSpace instance, please first refer to <ulink url="application.html#transferitem">Transferring Items Between DSpace Instances</ulink>.</para>
<para><emphasis role="bold">Note:</emphasis> Before running the item importer over items previously exported from a DSpace instance, please first refer to <link linkend="docbook-application.html-transferitem">Transferring Items Between DSpace Instances</link>.</para>
<para>The item importer is in <literal>org.dspace.app.itemimport.ItemImport</literal>, and is run with the <literal>import</literal> utility in the <literal>dspace/bin</literal> directory. Running it with -h gets the current command-line arguments. Another very important flag is the --test flag, which you can use with any command to simulate all of the actions it will perform without actually making any changes to your DSpace instance - very useful for validating your item directories before doing an import. In the importer&apos;s arguments you can use either the user&apos;s database ID or email address and the eperson ID, and the collection&apos;s database ID or handle as arguments. Currently with the importer you can add, remove, and replace items in a collection. If you specify more than one collection argument then the items will be imported to multiple collections, and the first collection specified becomes the &quot;owning&quot; collection. If there is an error and the import is aborted, there is a --resume flag that you can try to resume the import where you left off after you fix the error.</para>
<para>To add items to a collection with an EPerson as the submitter, type:</para>
<screen>
@@ -827,10 +827,10 @@ Between DSpace Instances"/>Transferring Items Between DSpace Instances</title>
<section remap="h2">
<title><anchor id="docbook-application.html-registration" xreflabel="Registering (Not
Importing) Bitstreams"/>Registering (Not Importing) Bitstreams</title>
<para>Registration is an alternate means of incorporating items, their metadata, and their bitstreams into DSpace by taking advantage of the bitstreams already being in storage accessible to DSpace. An example might be that there is a repository for existing digital assets. Rather than using the normal <ulink url="functional.html#ingest">interactive ingest process</ulink> or the <ulink url="functional.html#importexport">batch import</ulink> to furnish DSpace the metadata and to upload bitstreams, registration provides DSpace the metadata and the location of the bitstreams. DSpace uses a variation of the import tool to accomplish registration.</para>
<para>Registration is an alternate means of incorporating items, their metadata, and their bitstreams into DSpace by taking advantage of the bitstreams already being in storage accessible to DSpace. An example might be that there is a repository for existing digital assets. Rather than using the normal <link linkend="docbook-functional.html-ingest">interactive ingest process</link> or the <link linkend="docbook-functional.html-importexport">batch import</link> to furnish DSpace the metadata and to upload bitstreams, registration provides DSpace the metadata and the location of the bitstreams. DSpace uses a variation of the import tool to accomplish registration.</para>
<section remap="h3">
<title>Accessible Storage</title>
<para>To register an item its bitstreams must reside on storage accessible to DSpace and therefore referenced by an asset store number in <literal>dspace.cfg</literal>. The configuration file <literal>dspace.cfg</literal> establishes one or more asset stores through the use of an integer asset store number. This number relates to a directory in the DSpace host&apos;s file system or a set of SRB account parameters. This asset store number is described in <ulink url="configure.html#dspacecfg">The <literal>dspace.cfg</literal> Configuration Properties File</ulink> section and in the <literal>dspace.cfg</literal> file itself. The asset store number(s) used for registered items should generally not be the value of the <literal>assetstore.incoming</literal> property since it is unlikely that that you will want to mix the bitstreams of normally ingested and imported items and registered items.</para>
<para>To register an item its bitstreams must reside on storage accessible to DSpace and therefore referenced by an asset store number in <literal>dspace.cfg</literal>. The configuration file <literal>dspace.cfg</literal> establishes one or more asset stores through the use of an integer asset store number. This number relates to a directory in the DSpace host&apos;s file system or a set of SRB account parameters. This asset store number is described in <link linkend="docbook-configure.html-dspacecfg">The <literal>dspace.cfg</literal> Configuration Properties File</link> section and in the <literal>dspace.cfg</literal> file itself. The asset store number(s) used for registered items should generally not be the value of the <literal>assetstore.incoming</literal> property since it is unlikely that that you will want to mix the bitstreams of normally ingested and imported items and registered items.</para>
</section>
<section remap="h3">
<title>Registering Items Using the Item Importer</title>
@@ -882,9 +882,9 @@ dsrun org.dspace.app.itemimport.ItemImport --add
dsrun org.dspace.app.itemimport.ItemImport -a -e joe@user.com -c
collectionID -s items_dir -m mapfile
</screen>
<para>The <literal>--workflow</literal> and <literal>--test</literal> flags will function as described in <ulink url="application.html#importingitems">Importing Items</ulink>.</para>
<para>The <literal>--delete</literal> flag will function as described in <ulink url="application.html#importingitems">Importing Items</ulink> but the registered content files will not be removed from storage. See <link linkend="docbook-application.html-deletingregistereditems">Deleting Registered Items</link>.</para>
<para>The <literal>--replace</literal> flag will function as described in <ulink url="application.html#importingitems">Importing Items</ulink> but care should be taken to consider different cases and implications. With old items and new items being registered or ingested normally, there are four combinations or cases to consider. Foremost, an old registered item deleted from DSpace using <literal>--replace</literal> will not be removed from the storage. See <ulink url="application.html#deletingregistereditems">Deleting Registered Items</ulink>. where is resides. A new item added to DSpace using <literal>--replace</literal> will be ingested normally or will be registered depending on whether or not it is marked in the <literal>contents</literal> files with the -r.</para>
<para>The <literal>--workflow</literal> and <literal>--test</literal> flags will function as described in <link linkend="docbook-application.html-importingitems">Importing Items</link>.</para>
<para>The <literal>--delete</literal> flag will function as described in <link linkend="docbook-application.html-importingitems">Importing Items</link> but the registered content files will not be removed from storage. See <link linkend="docbook-application.html-deletingregistereditems">Deleting Registered Items</link>.</para>
<para>The <literal>--replace</literal> flag will function as described in <link linkend="docbook-application.html-importingitems">Importing Items</link> but care should be taken to consider different cases and implications. With old items and new items being registered or ingested normally, there are four combinations or cases to consider. Foremost, an old registered item deleted from DSpace using <literal>--replace</literal> will not be removed from the storage. See <link linkend="docbook-application.html-deletingregistereditems">Deleting Registered Items</link>. where is resides. A new item added to DSpace using <literal>--replace</literal> will be ingested normally or will be registered depending on whether or not it is marked in the <literal>contents</literal> files with the -r.</para>
</section>
<section remap="h3">
<title>Internal Identification and Retrieval of Registered Items</title>
@@ -905,7 +905,7 @@ dsrun org.dspace.app.itemimport.ItemImport -a -e joe@user.com -c
</section>
<section remap="h3">
<title><anchor id="docbook-application.html-deletingregistereditems"/>Deleting Registered Items</title>
<para>If a registered item is deleted from DSpace, either interactively or by using the <literal>--delete</literal> or <literal>--replace</literal> flags described in <ulink url="application.html#importingitems">Importing Items</ulink>, the item will disappear from DSpace but it&apos;s registered content files will remain in place just as they were prior to registration. Bitstreams not registered but added by DSpace as part of registration, such as <literal>license.txt</literal> files, will be deleted.</para>
<para>If a registered item is deleted from DSpace, either interactively or by using the <literal>--delete</literal> or <literal>--replace</literal> flags described in <link linkend="docbook-application.html-importingitems">Importing Items</link>, the item will disappear from DSpace but it&apos;s registered content files will remain in place just as they were prior to registration. Bitstreams not registered but added by DSpace as part of registration, such as <literal>license.txt</literal> files, will be deleted.</para>
</section>
</section>
<section remap="h2">
@@ -975,7 +975,7 @@ dsrun org.dspace.app.itemimport.ItemImport -a -e joe@user.com -c
</listitem>
<listitem>
<para> A <literal>fileSec</literal> containing a list of the bitstreams in the item. Each bundle constitutes a <literal>fileGrp</literal>. Each bitstream is represented by a <literal>file</literal> element, which contains an <literal>FLocat</literal> element with a simple XLink to the bitstream in the same directory as the <literal>mets.xml</literal> file. The <literal>file</literal> attributes consist of most of the basic technical metadata for the bitstream. Additionally, for those bitstreams that are thumbnails or text extracted from another bitstream in the item, those &apos;derived&apos; bitstreams have the same <literal>GROUPID</literal> as the bitstream they were derived from, in order that clients understand that there is a relationship.</para>
<para>The <literal>OWNERID</literal> of each <literal>file</literal> is the <ulink url="functional.html#bitstream_ids">&apos;persistent&apos; bitstream identifier</ulink> assigned by the DSpace instance. The <literal>ID</literal> and <literal>GROUPID</literal> attributes consist of the item&apos;s Handle, together with the bitstream&apos;s sequence ID, which underscores used in place of dots and slashes. For example, a bitstream with sequence ID 24, in the item <literal>hdl:123.456/789</literal> will have the <literal>ID</literal><literal>123_456_789_24</literal>. This is because <literal>ID</literal> and <literal>GROUPID</literal> attributes must be of type <literal>xsd:id</literal>.</para>
<para>The <literal>OWNERID</literal> of each <literal>file</literal> is the <link linkend="docbook-functional.html-bitstream_ids">&apos;persistent&apos; bitstream identifier</link> assigned by the DSpace instance. The <literal>ID</literal> and <literal>GROUPID</literal> attributes consist of the item&apos;s Handle, together with the bitstream&apos;s sequence ID, which underscores used in place of dots and slashes. For example, a bitstream with sequence ID 24, in the item <literal>hdl:123.456/789</literal> will have the <literal>ID</literal><literal>123_456_789_24</literal>. This is because <literal>ID</literal> and <literal>GROUPID</literal> attributes must be of type <literal>xsd:id</literal>.</para>
</listitem>
</itemizedlist>
</section>
@@ -1003,7 +1003,7 @@ dsrun org.dspace.app.itemimport.ItemImport -a -e joe@user.com -c
<section remap="h2">
<title><anchor id="docbook-application.html-mediafilters" xreflabel="MediaFilters:
Transforming DSpace Content"/>MediaFilters: Transforming DSpace Content</title>
<para>DSpace can apply filters to content/bitstreams, creating new content. Filters are included that extract text for <emphasis role="bold">full-text searching</emphasis>, and create <emphasis role="bold">thumbnails</emphasis> for items that contain images. The media filters are controlled by the <literal>MediaFilterManager</literal> which traverses the asset store, invoking the <literal>MediaFilter</literal> or <literal>FormatFilter</literal> classes on bitstreams. The media filter plugin configuration <literal>filter.plugins</literal> in <literal>dspace.cfg</literal> contains a list of all enabled media/format filter plugins (see <ulink url="configure.html#mediafilters">Configuring Media Filters</ulink> for more information). The media filter system is intended to be run from the command line (or regularly as a cron task):</para>
<para>DSpace can apply filters to content/bitstreams, creating new content. Filters are included that extract text for <emphasis role="bold">full-text searching</emphasis>, and create <emphasis role="bold">thumbnails</emphasis> for items that contain images. The media filters are controlled by the <literal>MediaFilterManager</literal> which traverses the asset store, invoking the <literal>MediaFilter</literal> or <literal>FormatFilter</literal> classes on bitstreams. The media filter plugin configuration <literal>filter.plugins</literal> in <literal>dspace.cfg</literal> contains a list of all enabled media/format filter plugins (see <link linkend="docbook-configure.html-mediafilters">Configuring Media Filters</link> for more information). The media filter system is intended to be run from the command line (or regularly as a cron task):</para>
<screen>
[dspace]/bin/filter-media
</screen>
@@ -1087,7 +1087,7 @@ Transforming DSpace Content"/>MediaFilters: Transforming DSpace Content</title>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Adding your own filters is done by creating a class which <literal>implements</literal> the <literal>org.dspace.app.mediafilter.FormatFilter</literal> interface. See the <ulink url="configure.html#newfilter">Creating a new Media Filter</ulink> topic and comments in the source file FormatFilter.java for more information. In theory filters could be implemented in any programming language (C, Perl, etc.) However, they need to be invoked by the Java code in the Media Filter class that you create.</para>
<para>Adding your own filters is done by creating a class which <literal>implements</literal> the <literal>org.dspace.app.mediafilter.FormatFilter</literal> interface. See the <link linkend="docbook-configure.html-newfilter">Creating a new Media Filter</link> topic and comments in the source file FormatFilter.java for more information. In theory filters could be implemented in any programming language (C, Perl, etc.) However, they need to be invoked by the Java code in the Media Filter class that you create.</para>
</section>
<section remap="h2">
<title><anchor id="docbook-application.html-filiator" xreflabel="Sub-Community

50
dspace/docs/docbook/architecture.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Architecture</title>
<title><anchor id="docbook-architecture.html"/>DSpace System Documentation: Architecture</title>
<section remap="h2">
<title><anchor id="docbook-architecture.html-overview" xreflabel="Overview"/>Overview</title>
<para>The DSpace system is organized into three layers, each of which consists of a number of components.</para>
@@ -77,16 +77,16 @@ mvn javadoc:javadoc
<itemizedlist>
<listitem>
<para>
<ulink url="storage.html">Storage Layer</ulink>
<link linkend="docbook-storage.html">Storage Layer</link>
<itemizedlist>
<listitem>
<para>
<ulink url="storage.html#rdbms">RDBMS</ulink>
<link linkend="docbook-storage.html-rdbms">RDBMS</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="storage.html#bitstreams">Bitstream Store</ulink>
<link linkend="docbook-storage.html-bitstreams">Bitstream Store</link>
</para>
</listitem>
</itemizedlist>
@@ -94,61 +94,61 @@ mvn javadoc:javadoc
</listitem>
<listitem>
<para>
<ulink url="business.html">Business Logic Layer</ulink>
<link linkend="docbook-business.html">Business Logic Layer</link>
<itemizedlist>
<listitem>
<para>
<ulink url="business.html#core">Core Classes</ulink>
<link linkend="docbook-business.html-core">Core Classes</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#content">Content Management API</ulink>
<link linkend="docbook-business.html-content">Content Management API</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#workflow">Workflow System</ulink>
<link linkend="docbook-business.html-workflow">Workflow System</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#administer">Administration Toolkit</ulink>
<link linkend="docbook-business.html-administer">Administration Toolkit</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#eperson">E-person/Group Manager</ulink>
<link linkend="docbook-business.html-eperson">E-person/Group Manager</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#authorize">Authorisation</ulink>
<link linkend="docbook-business.html-authorize">Authorisation</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#handle">Handle Manager/Handle Plugin</ulink>
<link linkend="docbook-business.html-handle">Handle Manager/Handle Plugin</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#search">Search</ulink>
<link linkend="docbook-business.html-search">Search</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#browse">Browse API</ulink>
<link linkend="docbook-business.html-browse">Browse API</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#history">History Recorder</ulink>
<link linkend="docbook-business.html-history">History Recorder</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#checker">Checksum Checker</ulink>
<link linkend="docbook-business.html-checker">Checksum Checker</link>
</para>
</listitem>
</itemizedlist>
@@ -156,46 +156,46 @@ mvn javadoc:javadoc
</listitem>
<listitem>
<para>
<ulink url="application.html">Application Layer</ulink>
<link linkend="docbook-application.html">Application Layer</link>
<itemizedlist>
<listitem>
<para>
<ulink url="application.html#webui">Web User Interface</ulink>
<link linkend="docbook-application.html-webui">Web User Interface</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#oai">OAI-PMH Data Provider</ulink>
<link linkend="docbook-application.html-oai">OAI-PMH Data Provider</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#itemimporter">Item Importer and Exporter</ulink>
<link linkend="docbook-application.html-itemimporter">Item Importer and Exporter</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#transferitem">Transferring Items Between DSpace Instances</ulink>
<link linkend="docbook-application.html-transferitem">Transferring Items Between DSpace Instances</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#registration">Registration</ulink>
<link linkend="docbook-application.html-registration">Registration</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#mets">METS Tools</ulink>
<link linkend="docbook-application.html-mets">METS Tools</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#mediafilters">Media Filters</ulink>
<link linkend="docbook-application.html-mediafilters">Media Filters</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#filiator">Sub-Community Management</ulink>
<link linkend="docbook-application.html-filiator">Sub-Community Management</link>
</para>
</listitem>
</itemizedlist>

4
dspace/docs/docbook/book.xml
View File

@@ -20,7 +20,7 @@
<book>
<bookinfo>
<title>DSpace 1.5.1 Manual</title>
<title>DSpace 1.5.2 Manual</title>
<author>
<surname>The DSpace Foundation</surname>
@@ -30,7 +30,7 @@
</author>
<copyright>
<year>2002-2008</year>
<year>2002-2009</year>
<holder>
<ulink url="http://www.dspace.org/">The DSpace Foundation</ulink>
</holder>

16
dspace/docs/docbook/business.xml
View File

@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Business Logic Layer</title>
<title><anchor id="docbook-business.html"/>DSpace System Documentation: Business Logic Layer</title>
<section remap="h2">
<title><anchor id="docbook-business.html-core" xreflabel="Core Classes"/>Core Classes</title>
<para>The <literal>org.dspace.core</literal> package provides some basic classes that are used throughout the DSpace code.</para>
<section remap="h3">
<title>The Configuration Manager (<literal>ConfigurationManager</literal>)</title>
<para>The configuration manager is responsible for reading the main <literal>dspace.cfg</literal> properties file, managing the &apos;template&apos; configuration files for other applications such as Apache, and for obtaining the text for e-mail messages.</para>
<para>The system is configured by editing the relevant files in <literal>/dspace/config</literal>, as described in the <ulink url="configure.html">configuration section</ulink>.</para>
<para>The system is configured by editing the relevant files in <literal>/dspace/config</literal>, as described in the <link linkend="docbook-configure.html">configuration section</link>.</para>
<para>
<emphasis role="bold">When editing configuration files for applications that DSpace uses, such as Apache, remember to edit the file in /dspace/config/templates and then run /dspace/bin/install-configs rather than editing the &apos;live&apos; version directly!</emphasis>
</para>
@@ -19,7 +19,7 @@
<literal> /dspace/bin/install-configs</literal>
</screen>
This processes and installs configuration files for other applications, as described in the <ulink url="configure.html#templates">configuration section</ulink>.</para>
This processes and installs configuration files for other applications, as described in the <link linkend="docbook-configure.html-templates">configuration section</link>.</para>
</listitem>
<listitem>
<para><screen>
@@ -214,7 +214,7 @@
<section remap="h2">
<title><anchor id="docbook-business.html-content" xreflabel="Content Management API"/>Content Management API</title>
<para>The content management API package <literal>org.dspace.content</literal> contains Java classes for reading and manipulating content stored in the DSpace system. This is the API that components in the application layer will probably use most.</para>
<para>Classes corresponding to the main elements in the <ulink url="functional.html#data_model">DSpace data model</ulink> (<literal>Community</literal>, <literal>Collection</literal>, <literal>Item</literal>, <literal>Bundle</literal> and <literal>Bitstream</literal>) are sub-classes of the abstract class <literal>DSpaceObject</literal>. The <literal>Item</literal> object handles the Dublin Core metadata record.</para>
<para>Classes corresponding to the main elements in the <link linkend="docbook-functional.html-data_model">DSpace data model</link> (<literal>Community</literal>, <literal>Collection</literal>, <literal>Item</literal>, <literal>Bundle</literal> and <literal>Bitstream</literal>) are sub-classes of the abstract class <literal>DSpaceObject</literal>. The <literal>Item</literal> object handles the Dublin Core metadata record.</para>
<para>Each class generally has one or more static <literal>find</literal> methods, which are used to instantiate content objects. Constructors do not have public access and are just used internally. The reasons for this are:</para>
<itemizedlist>
<listitem>
@@ -240,7 +240,7 @@ Collection myNewCollection = existingCommunity.createCollection();
</screen>
<para>The primary reason for this is for determining authorization. In order to know whether an e-person may create an object, the system must know which container the object is to be added to. It makes no sense to create a collection outside of a community, and the authorization system does not have a policy for that.</para>
<para><literal>Item</literal>s are first created in the form of an implementation of <literal>InProgressSubmission</literal>. An <literal>InProgressSubmission</literal> represents an item under construction; once it is complete, it is installed into the main archive and added to the relevant collection by the <literal>InstallItem</literal> class. The <literal>org.dspace.content</literal> package provides an implementation of <literal>InProgressSubmission</literal> called <literal>WorkspaceItem</literal>; this is a simple implementation that contains some fields used by the Web submission UI. The <literal>org.dspace.workflow</literal> also contains an implementation called <literal>WorkflowItem</literal> which represents a submission undergoing a workflow process.</para>
<para>In the previous chapter there is an <ulink url="functional.html#ingest">overview of the item ingest process</ulink> which should clarify the previous paragraph. Also see the section on <link linkend="docbook-business.html-workflow">the workflow system</link>.</para>
<para>In the previous chapter there is an <link linkend="docbook-functional.html-ingest">overview of the item ingest process</link> which should clarify the previous paragraph. Also see the section on <link linkend="docbook-business.html-workflow">the workflow system</link>.</para>
<para><literal>Community</literal> and <literal>BitstreamFormat</literal> do have static <literal>create</literal> methods; one must be a site administrator to have authorization to invoke these.</para>
<section remap="h3">
<title>Other Classes</title>
@@ -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 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>
<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 <link linkend="docbook-configure.html-mediafilters">configuration guide</link> for further details.</para>
</section>
<section remap="h4">
<title>A Singleton Plugin</title>
@@ -865,7 +865,7 @@ public class XsltDisseminationCrosswalk extends SelfNamedPlugin
</section>
<section remap="h4">
<title>Stackable Authentication</title>
<para>The Stackable Authentication mechanism needs to know all of the plugins configured for the interface, in the order of configuration, since order is significant. It gets a Sequence Plugin from the Plugin Manager. Refer to the <ulink url="configure.html#authenticate">configuration guide</ulink> for further details.</para>
<para>The Stackable Authentication mechanism needs to know all of the plugins configured for the interface, in the order of configuration, since order is significant. It gets a Sequence Plugin from the Plugin Manager. Refer to the <link linkend="docbook-configure.html-authenticate">configuration guide</link> for further details.</para>
</section>
</section>
</section>
@@ -1027,7 +1027,7 @@ hdl:1721.123/4567
http://hdl.handle.net/1721.123/4567
</screen>
<para>It is the responsibility of the caller to extract the basic form from whichever displayed form is used.</para>
<para>The <literal>handle</literal> table maps these Handles to resource type/resource ID pairs, where resource type is a value from <literal>org.dspace.core.Constants</literal> and resource ID is the internal identifier (database primary key) of the object. This allows Handles to be assigned to any type of object in the system, though as <ulink url="functional.html#handles">explained in the functional overview</ulink>, only communities, collections and items are presently assigned Handles.</para>
<para>The <literal>handle</literal> table maps these Handles to resource type/resource ID pairs, where resource type is a value from <literal>org.dspace.core.Constants</literal> and resource ID is the internal identifier (database primary key) of the object. This allows Handles to be assigned to any type of object in the system, though as <link linkend="docbook-functional.html-handles">explained in the functional overview</link>, only communities, collections and items are presently assigned Handles.</para>
<para><literal>HandleManager</literal> contains static methods for:</para>
<itemizedlist>
<listitem>

40
dspace/docs/docbook/configure.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Configuration and Customization</title>
<title><anchor id="docbook-configure.html"/>DSpace System Documentation: Configuration and Customization</title>
<para>There are a number of ways in which DSpace can be configured and/or customized:</para>
<itemizedlist>
<listitem>
@@ -195,7 +195,7 @@ stack"/>authentication stack. Authentication methods are called on in the order
</para>
</entry>
<entry>
<para>The Handle prefix for your site, <ulink url="install.html#handles">see the Handle section</ulink></para>
<para>The Handle prefix for your site, <link linkend="docbook-install.html-handles">see the Handle section</link></para>
</entry>
</row>
<row>
@@ -225,7 +225,7 @@ stack"/>authentication stack. Authentication methods are called on in the order
</para>
</entry>
<entry>
<para>The location in the file system of asset (bitstream) store number <literal>n</literal>. When adding additional stores, start with 1 (<literal>assetstore.dir.1</literal> and count upwards. Always leave asset store zero (<literal>assetstore.dir</literal>). For more details, see <ulink url="storage.html#bitstreams">the Bitstream Storage section</ulink>.</para>
<para>The location in the file system of asset (bitstream) store number <literal>n</literal>. When adding additional stores, start with 1 (<literal>assetstore.dir.1</literal> and count upwards. Always leave asset store zero (<literal>assetstore.dir</literal>). For more details, see <link linkend="docbook-storage.html-bitstreams">the Bitstream Storage section</link>.</para>
</entry>
</row>
<row>
@@ -240,7 +240,7 @@ stack"/>authentication stack. Authentication methods are called on in the order
</para>
</entry>
<entry>
<para>The asset store number to use for storing new bitstreams. For example, if <literal>assetstore.dir.1</literal> is <literal>/anotherdisk/store1</literal>, and <literal>assetstore.incoming</literal> is <literal>1</literal>, new bitstreams will be stored under <literal>/anotherdisk/store1</literal>. A value of <literal>0</literal> (zero) corresponds to <literal>assetstore.dir</literal>. For more details, see <ulink url="storage.html#bitstreams">the Bitstream Storage section</ulink>.</para>
<para>The asset store number to use for storing new bitstreams. For example, if <literal>assetstore.dir.1</literal> is <literal>/anotherdisk/store1</literal>, and <literal>assetstore.incoming</literal> is <literal>1</literal>, new bitstreams will be stored under <literal>/anotherdisk/store1</literal>. A value of <literal>0</literal> (zero) corresponds to <literal>assetstore.dir</literal>. For more details, see <link linkend="docbook-storage.html-bitstreams">the Bitstream Storage section</link>.</para>
</entry>
</row>
<row>
@@ -252,7 +252,7 @@ stack"/>authentication stack. Authentication methods are called on in the order
<para>/zone/home/user.domain</para>
</entry>
<entry>
<para>The sets of SRB access parameters (see dspace.cfg) if one or more SRB accounts are used. The srb.xxx set would correspond to asset (bitstream) store number zero. The srb.xxx.n set would correspond to asset (bitstream) store number n. For more details, see <ulink url="storage.html#bitstreams">the Bitstream Storage section</ulink>.</para>
<para>The sets of SRB access parameters (see dspace.cfg) if one or more SRB accounts are used. The srb.xxx set would correspond to asset (bitstream) store number zero. The srb.xxx.n set would correspond to asset (bitstream) store number n. For more details, see <link linkend="docbook-storage.html-bitstreams">the Bitstream Storage section</link>.</para>
</entry>
</row>
<row>
@@ -653,7 +653,7 @@ recent.submissions.sort-option = dateaccessioned
<screen>
recent.submissions.count = 5
</screen>
<para>Now we need to set up the processors that the <ulink url="business.html#plugin">PluginManager</ulink> will load to actually perform the recent submissions query on the relevant pages.</para>
<para>Now we need to set up the processors that the <link linkend="docbook-business.html-plugin">PluginManager</link> will load to actually perform the recent submissions query on the relevant pages.</para>
<para>Tell the community and collection pages that we are using the Recent Submissions code</para>
<screen>
plugin.sequence.org.dspace.plugin.CommunityHomeProcessor = \
@@ -677,7 +677,7 @@ itemmap.author.index = author
<section remap="h3">
<title><anchor id="docbook-configure.html-general-mediafilter" xreflabel="Configuring Media Filters"/>Configuring Media Filters</title>
<para>Media or Format Filters are classes used to generate derivative or alternative versions of content or bitstreams within DSpace. For example, the PDF Media Filter will extract textual content from PDF bitstreams, the JPEG Media Filter can create thumbnails from image bitstreams.</para>
<para>Media Filters are configured as <ulink url="business.html#plugin">Named Plugins</ulink>, with each filter also having a separate configuration setting (in <literal>dspace.cfg</literal>) indicating which formats it can process. The default configuration is shown below.</para>
<para>Media Filters are configured as <link linkend="docbook-business.html-plugin">Named Plugins</link>, with each filter also having a separate configuration setting (in <literal>dspace.cfg</literal>) indicating which formats it can process. The default configuration is shown below.</para>
<screen>
#### Media Filter / Format Filter plugins (through
PluginManager) ####
@@ -720,7 +720,7 @@ s = GIF, JPEG, image/png
</screen>
<para>The enabled Media/Format Filters are named in the <literal>filter.plugins</literal> field above.</para>
<para>Names are assigned to each filter using the <literal>plugin.named.org.dspace.app.mediafilter.FormatFilter</literal> field (e.g. by default the <literal>PDFFilter</literal> is named &quot;PDF Text Extractor&quot;).</para>
<para>Finally the appropriate <literal>filter.&lt;class path&gt;.inputFormats</literal> defines the vaild input formats which each filter can be applied to. These format names <emphasis role="bold">must match</emphasis> the <literal>short description</literal> field of the <ulink url="appendix.html#bitstreamformatregistry">Bitstream Format Registry</ulink>.</para>
<para>Finally the appropriate <literal>filter.&lt;class path&gt;.inputFormats</literal> defines the vaild input formats which each filter can be applied to. These format names <emphasis role="bold">must match</emphasis> the <literal>short description</literal> field of the <link linkend="docbook-appendix.html-bitstreamformatregistry">Bitstream Format Registry</link>.</para>
<para>You can also implement more dynamic or configurable Media/Format Filters which extend <ulink url="business.html#selfnamedplugin">
<literal>SelfNamedPlugin</literal>
</ulink>
@@ -749,7 +749,7 @@ Messages"/>Wording of E-mail Messages</title>
<section remap="h2">
<title><anchor id="docbook-configure.html-general-registries" xreflabel="The
Metadata and Bitstream Format Registries"/>The Metadata and Bitstream Format Registries</title>
<para>The <literal>[dspace]/config/registries</literal> directory contains three XML files. These are used to load the <emphasis>initial</emphasis> contents of the Metadata Schema Registry, <ulink url="appendix.html#dublincoreregistry">Dublin Core Metadata registry</ulink> and <ulink url="appendix.html#bitstreamformatregistry">Bitstream Format registry</ulink>. After the initial loading (performed by <literal>ant fresh_install</literal> above), the registries reside in the database; the XML files are not updated.</para>
<para>The <literal>[dspace]/config/registries</literal> directory contains three XML files. These are used to load the <emphasis>initial</emphasis> contents of the Metadata Schema Registry, <link linkend="docbook-appendix.html-dublincoreregistry">Dublin Core Metadata registry</link> and <link linkend="docbook-appendix.html-bitstreamformatregistry">Bitstream Format registry</link>. After the initial loading (performed by <literal>ant fresh_install</literal> above), the registries reside in the database; the XML files are not updated.</para>
<para>In order to change the registries, you may adjust the XML files before the first installation of DSpace. On an allready running instance it is recommended to change bitstream registries via DSpace admin UI, but the metadata registries can be loaded again at any time from the XML files without difficult. The changes made via admin UI are not reflected in the XML files.</para>
<section remap="h3">
<title>Metadata Schema Registry</title>
@@ -773,7 +773,7 @@ Metadata and Bitstream Format Registries"/>The Metadata and Bitstream Format Reg
<section remap="h3">
<title>Metadata Format Registries</title>
<para>The default metadata schema is Dublin Core, so DSpace is distributed with a default Dublin Core Metadata Registry. Currently, the system requires that every item have a Dublin Core record.</para>
<para>There is a set of Dublin Core Elements, which is used by the system and should not be removed or moved to another schema, see <ulink url="appendix.html#dublincoreregistry">Appendix: Default Dublin Core Metadata registry</ulink>.</para>
<para>There is a set of Dublin Core Elements, which is used by the system and should not be removed or moved to another schema, see <link linkend="docbook-appendix.html-dublincoreregistry">Appendix: Default Dublin Core Metadata registry</link>.</para>
<para><emphasis role="bold">Note</emphasis>: altering a Metadata Registry has no effect on corresponding parts, e.g. item submission interface, item display, item import and vice versa. Every metadata element used in submission interface or item import must be registered before using it.</para>
<para><emphasis role="bold">Note</emphasis> also that deleting a metadata element will delete all its corresponding values.</para>
<para>If you wish to add more metadata elements, you can do this in one of two ways. Via the DSpace admin UI you may define new metadata elements in the different available schemas. But you may also modify the XML file (or provide an additional one), and re-import the data as follows:</para>
@@ -881,7 +881,7 @@ Submission License"/>The Default Submission License</title>
<section remap="h2">
<title><anchor id="docbook-configure.html-general-submission" xreflabel="Submission
Configuration"/>Submission Configuration</title>
<para>Instructions for customizing and configuring the Item Submission user interface for either the JSP-UI or XML-UI are contained in the separate <ulink url="submission.html">Customizing and Configuring Submission User Interface</ulink> page.</para>
<para>Instructions for customizing and configuring the Item Submission user interface for either the JSP-UI or XML-UI are contained in the separate <link linkend="docbook-submission.html">Customizing and Configuring Submission User Interface</link> page.</para>
</section>
<section remap="h2">
<title><anchor id="docbook-configure.html-xmlui" xreflabel="XMLUI Interface Customizations
@@ -1251,7 +1251,7 @@ Theme"/>Creating a New Theme</title>
<para>
<emphasis role="bold">4) Install theme and rebuild DSpace</emphasis>
</para>
<para>Next rebuild &amp; deploy DSpace as described in the <ulink url="install.html">installation portion of the manual</ulink>, and ensure the theme has been installed as described in the previous section &quot;<ulink url="configure.html#xmlui-configure">Configuring Themes and Aspects</ulink>&quot;.</para>
<para>Next rebuild &amp; deploy DSpace as described in the <link linkend="docbook-install.html">installation portion of the manual</link>, and ensure the theme has been installed as described in the previous section &quot;<link linkend="docbook-configure.html-xmlui-configure">Configuring Themes and Aspects</link>&quot;.</para>
</section>
<section remap="h3">
<title><anchor id="docbook-configure.html-xmlui-staticcontent" xreflabel="Static Content"/>Adding Static Content</title>
@@ -1605,7 +1605,7 @@ Multilingual Support"/>Configuring Multilingual Support</title>
pages"/>Customizing the JSP pages</title>
<para>The JSPUI interface is implemented using Java Servlets which handle the business logic, and JavaServer Pages (JSPs) which produce the HTML pages sent to an end-user. Since the JSPs are much closer to HTML than Java code, altering the look and feel of DSpace is relatively easy.</para>
<para>To make it even easier, DSpace allows you to &apos;override&apos; the JSPs included in the source distribution with modified versions, that are stored in a separate place, so when it comes to updating your site with a new DSpace release, your modified versions will not be overwritten. It should be possible to dramatically change the look of DSpace to suit your organization by just changing the CSS style file and the site &apos;skin&apos; or &apos;layout&apos; JSPs in <literal>jsp/layout</literal>; if possible, it is recommended you limit local customizations to these files to make future upgrades easier.</para>
<para>You can also easily edit the text that appears on each JSP page by editing the dictionary file. However, note that unless you change the entry in all of the different language message files, users of other languages will still see the default text for their language. See <ulink url="application.html#i18n">internationalization</ulink>.</para>
<para>You can also easily edit the text that appears on each JSP page by editing the dictionary file. However, note that unless you change the entry in all of the different language message files, users of other languages will still see the default text for their language. See <link linkend="docbook-application.html-i18n">internationalization</link>.</para>
<para>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.</para>
<para>Thus, if possible, it is recommended you limit your changes to the &apos;layout&apos; JSPs and the stylesheet.</para>
<para>The JSPs are available in one of two places:</para>
@@ -1665,7 +1665,7 @@ pages"/>Customizing the JSP pages</title>
<para>Heavy use is made of a style sheet, <literal>styles.css.jsp</literal>. If you make edits, copy the local version to <literal>[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/styles.css.jsp</literal>, and it will be used automatically in preference to the default, as described above.</para>
<para>Fonts and colors can be easily changed using the stylesheet. The stylesheet is a JSP so that the user&apos;s browser version can be detected and the stylesheet tweaked accordingly.</para>
<para>The &apos;layout&apos; of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs <literal>/layout/header-*.jsp</literal> and <literal>/layout/footer-*.jsp</literal>. You can provide modified versions of these (in <literal>[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/layout</literal>), or define more styles and apply them to pages by using the &quot;style&quot; attribute of the <literal>dspace:layout</literal> tag.</para>
<para>After you&apos;ve customized your JSPs, <emphasis role="bold">you must rebuild the DSpace Web application</emphasis>. If you haven&apos;t already built and installed it, follow the <ulink url="install.html">install</ulink> directions. Otherwise, follow the steps below:</para>
<para>After you&apos;ve customized your JSPs, <emphasis role="bold">you must rebuild the DSpace Web application</emphasis>. If you haven&apos;t already built and installed it, follow the <link linkend="docbook-install.html">install</link> directions. Otherwise, follow the steps below:</para>
<orderedlist>
<listitem>
<para> Rebuild the DSpace installation package by running the following command from your <literal>[dspace-source]/dspace/</literal> directory:</para>
@@ -1898,7 +1898,7 @@ Authentication"/>Custom Authentication</title>
<para>The X.509 authentication method uses an X.509 certificate sent by the client to establish his/her identity. It requires the client to have a personal Web certificate installed on their browser (or other client software) which is issued by a Certifying Authority (CA) recognized by the web server.</para>
<orderedlist>
<listitem>
<para> See the <ulink url="install.html#https">HTTPS installation instructions</ulink> to configure your Web server. If you are using HTTPS with Tomcat, note that the <literal>&lt;Connector&gt;</literal> tag <emphasis>must</emphasis> include the attribute <literal>clientAuth=&quot;true&quot;</literal> so the server requests a personal Web certificate from the client.</para>
<para> See the <link linkend="docbook-install.html-https">HTTPS installation instructions</link> to configure your Web server. If you are using HTTPS with Tomcat, note that the <literal>&lt;Connector&gt;</literal> tag <emphasis>must</emphasis> include the attribute <literal>clientAuth=&quot;true&quot;</literal> so the server requests a personal Web certificate from the client.</para>
</listitem>
<listitem>
<para> Add the <literal>org.dspace.authenticate.X509Authentication</literal> plugin <emphasis>first</emphasis> to the list of stackable authentication methods in the value of the configuration key <literal>plugin.sequence.org.dspace.authenticate.AuthenticationMethod</literal><emphasis>E.g.:</emphasis></para>
@@ -2129,12 +2129,12 @@ Crosswalks"/>Activating Additional OAI-PMH Crosswalks</title>
</section>
<section remap="h3">
<title><anchor id="docbook-configure.html-packager" xreflabel="Configuring Packager Plugins"/>Configuring Packager Plugins</title>
<para>Package ingester plugins are configured as <ulink url="business.html#plugin">named or self-named plugins</ulink> for the interface <literal>org.dspace.content.packager.PackageIngester</literal>. Package disseminator plugins are configured as <ulink url="business.html#plugin">named or self-named plugins</ulink> for the interface <literal>org.dspace.content.packager.PackageDisseminator</literal>.</para>
<para>You can add names for the existing plugins, and add new plugins, by altering these configuration properties. See the <ulink url="business.html#plugin">Plugin Manager</ulink> architecture for more information about plugins.</para>
<para>Package ingester plugins are configured as <link linkend="docbook-business.html-plugin">named or self-named plugins</link> for the interface <literal>org.dspace.content.packager.PackageIngester</literal>. Package disseminator plugins are configured as <link linkend="docbook-business.html#plugin">named or self-named plugins</link> for the interface <literal>org.dspace.content.packager.PackageDisseminator</literal>.</para>
<para>You can add names for the existing plugins, and add new plugins, by altering these configuration properties. See the <link linkend="docbook-business.html-plugin">Plugin Manager</link> architecture for more information about plugins.</para>
</section>
<section remap="h3">
<title><anchor id="docbook-configure.html-crosswalk" xreflabel="Configuring Crosswalk Plugins"/>Configuring Crosswalk Plugins</title>
<para>Ingestion crosswalk plugins are configured as <ulink url="business.html#plugin">named or self-named plugins</ulink> for the interface <literal>org.dspace.content.crosswalk.IngestionCrosswalk</literal>. Dissemination crosswalk plugins are configured as <ulink url="business.html#plugin">named or self-named plugins</ulink> for the interface <literal>org.dspace.content.crosswalk.DisseminationCrosswalk</literal>.</para>
<para>Ingestion crosswalk plugins are configured as <link linkend="docbook-business.html-plugin">named or self-named plugins</link> for the interface <literal>org.dspace.content.crosswalk.IngestionCrosswalk</literal>. Dissemination crosswalk plugins are configured as <link linkend="docbook-business.html#plugin">named or self-named plugins</link> for the interface <literal>org.dspace.content.crosswalk.DisseminationCrosswalk</literal>.</para>
<para>You can add names for existing crosswalks, add new plugin classes, and add new configurations for the configurable crosswalks as noted below.</para>
<section remap="h4">
<title><anchor id="docbook-configure.html-mods" xreflabel="Configurable MODS dissemination
@@ -2316,7 +2316,7 @@ Filter"/>Creating a new Media/Format Filter</title>
MediaFilter</literal>
</screen>
<para>You must give your new filter a &quot;name&quot;, by adding it and its name to the <literal>plugin.named.org.dspace.app.mediafilter.FormatFilter</literal> field in <literal>dspace.cfg</literal>. In addition to naming your filter, make sure to specify its input formats in the <literal>filter.&lt;class path&gt;.inputFormats</literal> config item. Note the input formats must match the <literal>short description</literal> field in the <ulink url="appendix.html#bitstreamformatregistry">Bitstream Format Registry</ulink> (i.e. <literal>bitstreamformatregistry</literal> table).</para>
<para>You must give your new filter a &quot;name&quot;, by adding it and its name to the <literal>plugin.named.org.dspace.app.mediafilter.FormatFilter</literal> field in <literal>dspace.cfg</literal>. In addition to naming your filter, make sure to specify its input formats in the <literal>filter.&lt;class path&gt;.inputFormats</literal> config item. Note the input formats must match the <literal>short description</literal> field in the <link linkend="docbook-appendix.html-bitstreamformatregistry">Bitstream Format Registry</link> (i.e. <literal>bitstreamformatregistry</literal> table).</para>
<screen>
<literal> plugin.named.org.dspace.app.mediafilter.FormatFilter = \
@@ -2343,7 +2343,7 @@ Filter"/>Creating a new Media/Format Filter</title>
SelfNamedPlugin implements FormatFilter</literal>
</screen>
<para>Since <literal>SelfNamedPlugins</literal> are self-named (as stated), they must provide the various names the plugin uses by defining a <ulink url="business.html#pluginmethods">getPluginNames()</ulink> method. Generally speaking, each &quot;name&quot; the plugin uses should correspond to a different type of filter it implements (e.g. &quot;Word2PDF&quot; and &quot;Excel2CSV&quot; are two good names for a complex media filter which performs both Word to PDF and Excel to CSV conversions).</para>
<para>Since <literal>SelfNamedPlugins</literal> are self-named (as stated), they must provide the various names the plugin uses by defining a <link linkend="docbook-business.html-pluginmethods">getPluginNames()</link> method. Generally speaking, each &quot;name&quot; the plugin uses should correspond to a different type of filter it implements (e.g. &quot;Word2PDF&quot; and &quot;Excel2CSV&quot; are two good names for a complex media filter which performs both Word to PDF and Excel to CSV conversions).</para>
<para>Self-Named Media/Format Filters are also configured differently in <literal>dspace.cfg</literal>. Below is a general template for a Self Named Filter (defined by an imaginary <literal>MyComplexMediaFilter</literal> class, which can perform both Word to PDF and Excel to CSV conversions):</para>
<screen>

2
dspace/docs/docbook/directories.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Directories and Files</title>
<title><anchor id="docbook-directories.html"/>DSpace System Documentation: Directories and Files</title>
<section remap="h2">
<title><anchor id="docbook-directories.html-overview" xreflabel="Overview"/>Overview</title>
<para>A complete DSpace installation consists of three separate directory trees:</para>

4
dspace/docs/docbook/functional.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Functional Overview</title>
<title><anchor id="docbook-functional.html"/>DSpace System Documentation: Functional Overview</title>
<para>The following sections describe the various functional aspects of the DSpace system.</para>
<section remap="h2">
<title><anchor id="docbook-functional.html-data_model" xreflabel="Data Model"/>Data Model</title>
@@ -152,7 +152,7 @@ DSpace in one of two ways:"/>Items can be removed from DSpace in one of two ways
<title><anchor id="docbook-functional.html-plugin" xreflabel="Plugin Manager"/>Plugin Manager</title>
<para>The PluginManager is a very simple component container. It creates and organizes components (plugins), and helps select a plugin in the cases where there are many possible choices. It also gives some limited control over the lifecycle of a plugin.</para>
<para>A plugin is defined by a Java interface. The consumer of a plugin asks for its plugin by interface. A Plugin is an instance of any class that implements the plugin interface. It is interchangeable with other implementations, so that any of them may be &quot;plugged in&quot;.</para>
<para>The mediafilter is a simple example of a plugin implementation. Refer to the <ulink url="business.html#plugin">Business Logic Layer</ulink> for more details on Plugins.</para>
<para>The mediafilter is a simple example of a plugin implementation. Refer to the <link linkend="docbook-business.html-plugin">Business Logic Layer</link> for more details on Plugins.</para>
</section>
<section remap="h2">
<title><anchor id="docbook-functional.html-metadata" xreflabel="Metadata"/>Metadata</title>

40
dspace/docs/docbook/history.xml
View File

@@ -1,6 +1,44 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Version History</title>
<title><anchor id="docbook-history.html"/>DSpace System Documentation: Version History</title>
<section remap="h2">
<title><anchor id="docbook-history.html-version1_5_2" xreflabel="Changes in DSpace 1.5.2"/>Changes in DSpace 1.5.2</title>
<section remap="h3">
<title>General Improvements</title>
<itemizedlist>
<listitem>
<para> TBD</para>
</listitem>
</itemizedlist>
</section>
<section remap="h3">
<title>Bug fixes and smaller patches</title>
<itemizedlist>
<listitem>
<para> TBD</para>
</listitem>
</itemizedlist>
</section>
</section>
<section remap="h2">
<title><anchor id="docbook-history.html-version1_5_1" xreflabel="Changes in DSpace 1.5.1"/>Changes in DSpace 1.5.1</title>
<section remap="h3">
<title>General Improvements</title>
<itemizedlist>
<listitem>
<para> TBD</para>
</listitem>
</itemizedlist>
</section>
<section remap="h3">
<title>Bug fixes and smaller patches</title>
<itemizedlist>
<listitem>
<para> TBD</para>
</listitem>
</itemizedlist>
</section>
</section>
<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">

276
dspace/docs/docbook/index.xml
View File

@@ -1,142 +1,142 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Contents</title>
<title><anchor id="docbook-index.html"/>DSpace System Documentation: Contents</title>
<para>Authors: Robert Tansley, Mick Bass, Margret Branschofsky, Grace Carpenter, Greg McClellan, David Stuve, and others</para>
<para>For DSpace Version: <emphasis role="bold">1.5</emphasis> (January-2008)</para>
<para>Documentation for other versions of DSpace are included with the source code.</para>
<itemizedlist>
<listitem>
<para>
<ulink url="introduction.html">Introduction</ulink>
<link linkend="docbook-introduction.html">Introduction</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html">Functional Overview</ulink>
<link linkend="docbook-functional.html">Functional Overview</link>
<itemizedlist>
<listitem>
<para>
<ulink url="functional.html#data_model">Data Model</ulink>
<link linkend="docbook-functional.html-data_model">Data Model</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#plugin">Plugin Manager</ulink>
<link linkend="docbook-functional.html-plugin">Plugin Manager</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#metadata">Metadata</ulink>
<link linkend="docbook-functional.html-metadata">Metadata</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#packager">Packager Plugins</ulink>
<link linkend="docbook-functional.html-packager">Packager Plugins</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#crosswalk">Crosswalk Plugins</ulink>
<link linkend="docbook-functional.html-crosswalk">Crosswalk Plugins</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#epeople">E-people and Groups</ulink>
<link linkend="docbook-functional.html-epeople">E-people and Groups</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#authentication">Authentication</ulink>
<link linkend="docbook-functional.html-authentication">Authentication</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#auth">Authorization</ulink>
<link linkend="docbook-functional.html-auth">Authorization</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#ingest">Ingest Process and Workflow</ulink>
<link linkend="docbook-functional.html-ingest">Ingest Process and Workflow</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#supervision">Supervision and Collaboration</ulink>
<link linkend="docbook-functional.html-supervision">Supervision and Collaboration</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#handles">Handles</ulink>
<link linkend="docbook-functional.html-handles">Handles</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#bitstream_ids">Bitstream &apos;Persistent&apos; Identifiers</ulink>
<link linkend="docbook-functional.html-bitstream_ids">Bitstream &apos;Persistent&apos; Identifiers</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#srb">Storage Resource Broker (SRB) Support</ulink>
<link linkend="docbook-functional.html-srb">Storage Resource Broker (SRB) Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#search_browse">Search and Browse</ulink>
<link linkend="docbook-functional.html-search_browse">Search and Browse</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#html">HTML Support</ulink>
<link linkend="docbook-functional.html-html">HTML Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#oai">OAI Support</ulink>
<link linkend="docbook-functional.html-oai">OAI Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#openurl">OpenURL Support</ulink>
<link linkend="docbook-functional.html-openurl">OpenURL Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#creativecommons">Creative Commons Support</ulink>
<link linkend="docbook-functional.html-creativecommons">Creative Commons Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#subscriptions">Subscriptions</ulink>
<link linkend="docbook-functional.html-subscriptions">Subscriptions</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#history">History</ulink>
<link linkend="docbook-functional.html-history">History</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#history">Import and Export</ulink>
<link linkend="docbook-functional.html-history">Import and Export</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#registration">Registration</ulink>
<link linkend="docbook-functional.html-registration">Registration</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#statistics">Statistical Reports</ulink>
<link linkend="docbook-functional.html-statistics">Statistical Reports</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#checker">Checksum Checker</ulink>
<link linkend="docbook-functional.html-checker">Checksum Checker</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#usage">Usage Instrumentation</ulink>
<link linkend="docbook-functional.html-usage">Usage Instrumentation</link>
</para>
</listitem>
</itemizedlist>
@@ -144,36 +144,36 @@
</listitem>
<listitem>
<para>
<ulink url="install.html">Installation</ulink>
<link linkend="docbook-install.html">Installation</link>
<itemizedlist>
<listitem>
<para>
<ulink url="install.html#prerequisite">Prerequisite Software</ulink>
<link linkend="docbook-install.html-prerequisite">Prerequisite Software</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="install.html#installsteps">Quick Installation Steps</ulink>
<link linkend="docbook-install.html-installsteps">Quick Installation Steps</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="install.html#advancedinstall">Advanced Installation</ulink>
<link linkend="docbook-install.html-advancedinstall">Advanced Installation</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="install.html#windows">Windows Installation</ulink>
<link linkend="docbook-install.html-windows">Windows Installation</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="install.html#knownbugs">Known Bugs</ulink>
<link linkend="docbook-install.html-knownbugs">Known Bugs</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="install.html#problems">Common Problems</ulink>
<link linkend="docbook-install.html-problems">Common Problems</link>
</para>
</listitem>
</itemizedlist>
@@ -181,56 +181,56 @@
</listitem>
<listitem>
<para>
<ulink url="update.html">Updating a DSpace Installation</ulink>
<link linkend="docbook-update.html">Updating a DSpace Installation</link>
<itemizedlist>
<listitem>
<para>
<ulink url="update.html#142_15">Updating from 1.4.2 to 1.5</ulink>
<link linkend="docbook-update.html-142_15">Updating from 1.4.2 to 1.5</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#14_141">Updating From 1.4 to 1.4.1</ulink>
<link linkend="docbook-update.html-14_141">Updating From 1.4 to 1.4.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#132_14">Updating From 1.3.x to 1.4.x</ulink>
<link linkend="docbook-update.html-132_14">Updating From 1.3.x to 1.4.x</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#131_132">Updating From 1.3.1 to 1.3.2</ulink>
<link linkend="docbook-update.html-131_132">Updating From 1.3.1 to 1.3.2</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#12_13">Updating From 1.2.x to 1.3.x</ulink>
<link linkend="docbook-update.html-12_13">Updating From 1.2.x to 1.3.x</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#121_122">Updating From 1.2.1 to 1.2.2</ulink>
<link linkend="docbook-update.html-121_122">Updating From 1.2.1 to 1.2.2</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#12_121">Updating From 1.2 to 1.2.1</ulink>
<link linkend="docbook-update.html-12_121">Updating From 1.2 to 1.2.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#11_12">Updating From 1.1 (or 1.1.1) to 1.2</ulink>
<link linkend="docbook-update.html-11_12">Updating From 1.1 (or 1.1.1) to 1.2</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#11_111">Updating From 1.1 to 1.1.1</ulink>
<link linkend="docbook-update.html-11_111">Updating From 1.1 to 1.1.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="update.html#101_11">Updating From 1.0.1 to 1.1</ulink>
<link linkend="docbook-update.html-101_11">Updating From 1.0.1 to 1.1</link>
</para>
</listitem>
</itemizedlist>
@@ -238,7 +238,7 @@
</listitem>
<listitem>
<para>
<ulink url="configure.html">Configuration and Customization</ulink>
<link linkend="docbook-configure.html">Configuration and Customization</link>
</para>
</listitem>
<listitem>
@@ -246,7 +246,7 @@
<itemizedlist>
<listitem>
<para>
<ulink url="configure.html#general">General Configuration</ulink>
<link linkend="docbook-configure.html-general">General Configuration</link>
</para>
</listitem>
<listitem>
@@ -254,71 +254,71 @@
<itemizedlist>
<listitem>
<para>
<ulink url="configure.html#general-dspacecfg">dspace.cfg</ulink>
<link linkend="docbook-configure.html-general-dspacecfg">dspace.cfg</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#general-search">Search Indexes</ulink>
<link linkend="docbook-configure.html-general-search">Search Indexes</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#general-browse">Browse Configuration</ulink>
<link linkend="docbook-configure.html-general-browse">Browse Configuration</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#general-mediafilter">Configuring Media Filters</ulink>
<link linkend="docbook-configure.html-general-mediafilter">Configuring Media Filters</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#general-email">Email Messages</ulink>
<link linkend="docbook-configure.html-general-email">Email Messages</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#general-registries">Metadata and Bitstream Format Registries</ulink>
<link linkend="docbook-configure.html-general-registries">Metadata and Bitstream Format Registries</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#general-license">Default Submission License</ulink>
<link linkend="docbook-configure.html-general-license">Default Submission License</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="submission.html">Submission Configuration</ulink>
<link linkend="docbook-submission.html">Submission Configuration</link>
<itemizedlist>
<listitem>
<para>
<ulink url="submission.html#configurationFile">Understanding the Submission Configuration File</ulink>
<link linkend="docbook-submission.html-configurationFile">Understanding the Submission Configuration File</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="submission.html#stepOrdering">Reordering/Removing Submission Steps</ulink>
<link linkend="docbook-submission.html-stepOrdering">Reordering/Removing Submission Steps</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="submission.html#collectionSubmission">Assigning a custom Submission Process to a Collection</ulink>
<link linkend="docbook-submission.html-collectionSubmission">Assigning a custom Submission Process to a Collection</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="submission.html#metadataEntry">Customizing the Metadata-entry pages</ulink>
<link linkend="docbook-submission.html-metadataEntry">Customizing the Metadata-entry pages</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="submission.html#uploadStep">Configuring the File Upload step</ulink>
<link linkend="docbook-submission.html-uploadStep">Configuring the File Upload step</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="submission.html#createStep">Creating new Submission Steps</ulink>
<link linkend="docbook-submission.html-createStep">Creating new Submission Steps</link>
</para>
</listitem>
</itemizedlist>
@@ -329,26 +329,26 @@
</listitem>
<listitem>
<para>
<ulink url="configure.html#xmlui">XMLUI Interface Customizations (Manakin)</ulink>
<link linkend="docbook-configure.html-xmlui">XMLUI Interface Customizations (Manakin)</link>
<itemizedlist>
<listitem>
<para>
<ulink url="configure.html#xmlui-dspacecfg">dspace.cfg</ulink>
<link linkend="docbook-configure.html-xmlui-dspacecfg">dspace.cfg</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#xmlui-configure">Configuring Themes and Aspects</ulink>
<link linkend="docbook-configure.html-xmlui-configure">Configuring Themes and Aspects</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#xmlui-multilingual">Multilingual Support</ulink>
<link linkend="docbook-configure.html-xmlui-multilingual">Multilingual Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#xmlui-newtheme">Creating a New Theme</ulink>
<link linkend="docbook-configure.html-xmlui-newtheme">Creating a New Theme</link>
</para>
</listitem>
</itemizedlist>
@@ -356,7 +356,7 @@
</listitem>
<listitem>
<para>
<ulink url="configure.html#jspui">JSPUI Interface Customizations</ulink>
<link linkend="docbook-configure.html-jspui">JSPUI Interface Customizations</link>
</para>
</listitem>
<listitem>
@@ -364,22 +364,22 @@
<itemizedlist>
<listitem>
<para>
<ulink url="configure.html#jspui-dspacecfg">dspace.cfg</ulink>
<link linkend="docbook-configure.html-jspui-dspacecfg">dspace.cfg</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#jspui-controlledvocabulary">Configuring Controlled Vocabularies</ulink>
<link linkend="docbook-configure.html-jspui-controlledvocabulary">Configuring Controlled Vocabularies</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#jspui-multilingual">Configuring Multilingual Support</ulink>
<link linkend="docbook-configure.html-jspui-multilingual">Configuring Multilingual Support</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#jspui-jsp">Customizing the JSP Pages</ulink>
<link linkend="docbook-configure.html-jspui-jsp">Customizing the JSP Pages</link>
</para>
</listitem>
</itemizedlist>
@@ -387,7 +387,7 @@
</listitem>
<listitem>
<para>
<ulink url="configure.html#advanced">Advanced DSpace Customizations</ulink>
<link linkend="docbook-configure.html-advanced">Advanced DSpace Customizations</link>
</para>
</listitem>
<listitem>
@@ -395,47 +395,47 @@
<itemizedlist>
<listitem>
<para>
<ulink url="configure.html#checksum">Checksum Checker</ulink>
<link linkend="docbook-configure.html-checksum">Checksum Checker</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#authentication">Custom Authentication</ulink>
<link linkend="docbook-configure.html-authentication">Custom Authentication</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#statistics">Configuring Statistical Reports</ulink>
<link linkend="docbook-configure.html-statistics">Configuring Statistical Reports</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#oai">Activating Additional OAI-PMH Crosswalks</ulink>
<link linkend="docbook-configure.html-oai">Activating Additional OAI-PMH Crosswalks</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#packager">Configuring Packager Plugins</ulink>
<link linkend="docbook-configure.html-packager">Configuring Packager Plugins</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#crosswalk">Configuring Crosswalk Plugins</ulink>
<link linkend="docbook-configure.html-crosswalk">Configuring Crosswalk Plugins</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#mediafilters">Creating new Media/Format Filters</ulink>
<link linkend="docbook-configure.html-mediafilters">Creating new Media/Format Filters</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#templates">Configuration Files for Other Applications</ulink>
<link linkend="docbook-configure.html-templates">Configuration Files for Other Applications</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="configure.html#browse-index">Browse Index Creation</ulink>
<link linkend="docbook-configure.html-browse-index">Browse Index Creation</link>
</para>
</listitem>
</itemizedlist>
@@ -446,26 +446,26 @@
</listitem>
<listitem>
<para>
<ulink url="directories.html">Directories and Files</ulink>
<link linkend="docbook-directories.html">Directories and Files</link>
<itemizedlist>
<listitem>
<para>
<ulink url="directories.html#sourcedir">Source Directory Layout</ulink>
<link linkend="docbook-directories.html-sourcedir">Source Directory Layout</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="directories.html#installdir">Installed Directory Layout</ulink>
<link linkend="docbook-directories.html-installdir">Installed Directory Layout</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="directories.html#webapp">Contents of Web Application</ulink>
<link linkend="docbook-directories.html-webapp">Contents of Web Application</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="directories.html#logfiles">Log Files</ulink>
<link linkend="docbook-directories.html-logfiles">Log Files</link>
</para>
</listitem>
</itemizedlist>
@@ -473,25 +473,25 @@
</listitem>
<listitem>
<para>
<ulink url="architecture.html">Architecture</ulink>
<link linkend="docbook-architecture.html">Architecture</link>
<itemizedlist>
<listitem>
<para>
<ulink url="architecture.html#overview">Overview</ulink>
<link linkend="docbook-architecture.html-overview">Overview</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="storage.html">Storage Layer</ulink>
<link linkend="docbook-storage.html">Storage Layer</link>
<itemizedlist>
<listitem>
<para>
<ulink url="storage.html#rdbms">RDBMS</ulink>
<link linkend="docbook-storage.html-rdbms">RDBMS</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="storage.html#bitstreams">Bitstream Store</ulink>
<link linkend="docbook-storage.html-bitstreams">Bitstream Store</link>
</para>
</listitem>
</itemizedlist>
@@ -499,61 +499,61 @@
</listitem>
<listitem>
<para>
<ulink url="business.html">Business Logic Layer</ulink>
<link linkend="docbook-business.html">Business Logic Layer</link>
<itemizedlist>
<listitem>
<para>
<ulink url="business.html#core">Core Classes</ulink>
<link linkend="docbook-business.html-core">Core Classes</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#content">Content Management API</ulink>
<link linkend="docbook-business.html-content">Content Management API</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#plugin">Plugin Manager</ulink>
<link linkend="docbook-business.html-plugin">Plugin Manager</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#workflow">Workflow System</ulink>
<link linkend="docbook-business.html-workflow">Workflow System</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#administer">Administration Toolkit</ulink>
<link linkend="docbook-business.html-administer">Administration Toolkit</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#eperson">E-person/Group Manager</ulink>
<link linkend="docbook-business.html-eperson">E-person/Group Manager</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#authorize">Authorization</ulink>
<link linkend="docbook-business.html-authorize">Authorization</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#handle">Handle Manager/Handle Plugin</ulink>
<link linkend="docbook-business.html-handle">Handle Manager/Handle Plugin</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#search">Search</ulink>
<link linkend="docbook-business.html-search">Search</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#browse">Browse API</ulink>
<link linkend="docbook-business.html-browse">Browse API</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="business.html#history">History Recorder</ulink>
<link linkend="docbook-business.html-history">History Recorder</link>
</para>
</listitem>
</itemizedlist>
@@ -561,56 +561,56 @@
</listitem>
<listitem>
<para>
<ulink url="application.html">Application Layer</ulink>
<link linkend="docbook-application.html">Application Layer</link>
<itemizedlist>
<listitem>
<para>
<ulink url="application.html#webui">Web User Interface</ulink>
<link linkend="docbook-application.html-webui">Web User Interface</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#oai">OAI-PMH Data Provider</ulink>
<link linkend="docbook-application.html-oai">OAI-PMH Data Provider</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#structbuilder">Community and Collection Structure Importer</ulink>
<link linkend="docbook-application.html-structbuilder">Community and Collection Structure Importer</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#packager">Package Importer and Exporter</ulink>
<link linkend="docbook-application.html-packager">Package Importer and Exporter</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#itemimporter">Item Importer and Exporter</ulink>
<link linkend="docbook-application.html-itemimporter">Item Importer and Exporter</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#transferitem">Transferring Items Between DSpace Instances</ulink>
<link linkend="docbook-application.html-transferitem">Transferring Items Between DSpace Instances</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#registration">Registering (Not Importing) Bitstreams</ulink>
<link linkend="docbook-application.html-registration">Registering (Not Importing) Bitstreams</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#mets">METS Tools</ulink>
<link linkend="docbook-application.html-mets">METS Tools</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#mediafilters">Media Filters</ulink>
<link linkend="docbook-application.html-mediafilters">Media Filters</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="application.html#filiator">Sub-Community Management</ulink>
<link linkend="docbook-application.html-filiator">Sub-Community Management</link>
</para>
</listitem>
</itemizedlist>
@@ -621,41 +621,41 @@
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html">DRI Schema Reference</ulink>
<link linkend="docbook-DRISchemaReference.html">DRI Schema Reference</link>
<itemizedlist>
<listitem>
<para>
<ulink url="DRISchemaReference.html#Introduction">Introduction</ulink>
<link linkend="docbook-DRISchemaReference.html-Introduction">Introduction</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html#DRI_in_Manakin">DRI in Manakin</ulink>
<link linkend="docbook-DRISchemaReference.html-DRI_in_Manakin">DRI in Manakin</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html#Common_Design_Patterns">Common Design Patterns</ulink>
<link linkend="docbook-DRISchemaReference.html-Common_Design_Patterns">Common Design Patterns</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html#Schema_Overview">Schema Overview</ulink>
<link linkend="docbook-DRISchemaReference.html-Schema_Overview">Schema Overview</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html#Merging_of_DRI_Documents">Merging of DRI Documents</ulink>
<link linkend="docbook-DRISchemaReference.html-Merging_of_DRI_Documents">Merging of DRI Documents</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html#Version_Changes">Version Changes</ulink>
<link linkend="docbook-DRISchemaReference.html-Version_Changes">Version Changes</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="DRISchemaReference.html#Element_Reference">Element Reference</ulink>
<link linkend="docbook-DRISchemaReference.html-Element_Reference">Element Reference</link>
</para>
</listitem>
</itemizedlist>
@@ -663,61 +663,61 @@
</listitem>
<listitem>
<para>
<ulink url="history.html">Version History</ulink>
<link linkend="docbook-history.html">Version History</link>
<itemizedlist>
<listitem>
<para>
<ulink url="history.html#version1_5">Changes in DSpace 1.5</ulink>
<link linkend="docbook-history.html-version1_5">Changes in DSpace 1.5</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_4_1">Changes in DSpace 1.4.1</ulink>
<link linkend="docbook-history.html-version1_4_1">Changes in DSpace 1.4.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_4">Changes in DSpace 1.4</ulink>
<link linkend="docbook-history.html-version1_4">Changes in DSpace 1.4</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_3_2">Changes in DSpace 1.3.2</ulink>
<link linkend="docbook-history.html-version1_3_2">Changes in DSpace 1.3.2</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_3_1">Changes in DSpace 1.3.1</ulink>
<link linkend="docbook-history.html-version1_3_1">Changes in DSpace 1.3.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_3">Changes in DSpace 1.3</ulink>
<link linkend="docbook-history.html-version1_3">Changes in DSpace 1.3</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_2_2">Changes in DSpace 1.2.2</ulink>
<link linkend="docbook-history.html-version1_2_2">Changes in DSpace 1.2.2</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_2_1">Changes in DSpace 1.2.1</ulink>
<link linkend="docbook-history.html-version1_2_1">Changes in DSpace 1.2.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_2">Changes in DSpace 1.2</ulink>
<link linkend="docbook-history.html-version1_2">Changes in DSpace 1.2</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_1_1">Changes in DSpace 1.1.1</ulink>
<link linkend="docbook-history.html-version1_1_1">Changes in DSpace 1.1.1</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="history.html#version1_1">Changes in DSpace 1.1</ulink>
<link linkend="docbook-history.html-version1_1">Changes in DSpace 1.1</link>
</para>
</listitem>
</itemizedlist>
@@ -725,16 +725,16 @@
</listitem>
<listitem>
<para>
<ulink url="appendix.html">Appendices</ulink>
<link linkend="docbook-appendix.html">Appendices</link>
<itemizedlist>
<listitem>
<para>
<ulink url="appendix.html#dublincoreregistry">Default Dublin Core Metadata Registry</ulink>
<link linkend="docbook-appendix.html-dublincoreregistry">Default Dublin Core Metadata Registry</link>
</para>
</listitem>
<listitem>
<para>
<ulink url="appendix.html#bitstreamformatregistry">Default Bitstream Format Registry</ulink>
<link linkend="docbook-appendix.html-bitstreamformatregistry">Default Bitstream Format Registry</link>
</para>
</listitem>
</itemizedlist>

12
dspace/docs/docbook/install.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Installation</title>
<title><anchor id="docbook-install.html"/>DSpace System Documentation: Installation</title>
<section remap="h2">
<title><anchor id="docbook-install.html-prerequisite" xreflabel="Prerequisite Software"/>Prerequisite Software</title>
<para>The list below describes the third-party components and tools you&apos;ll need to run a DSpace server. These are just guidelines. Since DSpace is built on open source, standards-based tools, there are numerous other possibilities and setups.</para>
@@ -251,7 +251,7 @@ dspace-&lt;version&gt;-src-release.zip )"/>Source Release ( dspace-&lt;version&g
to <literal>[tomcat]/webapps/</literal> (with <literal>[tomcat]</literal> being wherever you installed Tomcat--also known as <literal>$CATALINA_HOME</literal>).</para>
</listitem>
</orderedlist>
<para>For details on the contents of these separate directory trees, refer to <ulink url="directories.html">directories.html</ulink>. <emphasis>Note that the <literal>[dspace-source]</literal> and <literal>[dspace]</literal> directories are always separate!</emphasis></para>
<para>For details on the contents of these separate directory trees, refer to <link linkend="docbook-directories.html">directories.html</link>. <emphasis>Note that the <literal>[dspace-source]</literal> and <literal>[dspace]</literal> directories are always separate!</emphasis></para>
</section>
<section remap="h3">
<title><anchor id="docbook-install.html-installsteps" xreflabel="Installation"/>Installation</title>
@@ -455,7 +455,7 @@ crontab -e
0 2 * * * [dspace]/bin/stat-report-monthly
</screen>
<para>Obviously, you should choose execution times which are most useful to you, and you should ensure that the <literal>-report-</literal> scripts run a short while after the analysis scripts to give them time to complete (a run of around 8 months worth of logs can take around 25 seconds to complete); the resulting reports will let you know how long analysis took and you can adjust your cron times accordingly.</para>
<para>For information on customising the output of this see <ulink url="configure.html#statistics">configuring system statistical reports</ulink>.</para>
<para>For information on customising the output of this see <link linkend="docbook-configure.html-statistics">configuring system statistical reports</link>.</para>
</section>
<section remap="h3">
<title>Multilingual Installation</title>
@@ -463,7 +463,7 @@ crontab -e
<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 Configuring MultiLingual Support</ulink> section for the JSPUI or the Multilingual Support for XMLUI 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 <link linkend="docbook-configure.html-multilingualui">Multilingual User Interface Configuring MultiLingual Support</link> 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>
@@ -494,7 +494,7 @@ crontab -e
</screen>
</listitem>
<listitem>
<para> Optional -- ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the <ulink url="configure.html#authenticate">configuration section</ulink> for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in <literal>client1.pem</literal>:</para>
<para> Optional -- ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the <link linkend="docbook-configure.html-authenticate">configuration section</link> for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in <literal>client1.pem</literal>:</para>
<screen>
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1
@@ -587,7 +587,7 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize
<para>When answering the questions to identify the certificate, be sure to respond to &quot;First and last name&quot; with the fully-qualified domain name of your server (e.g. <literal>test-dspace.myuni.edu</literal>). The other questions are not important.</para>
</listitem>
<listitem>
<para> Optional -- ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the <ulink url="configure.html#authenticate">configuration section</ulink> for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in <literal>client1.pem</literal>:</para>
<para> Optional -- ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the <link linkend="docbook-configure.html-authenticate">configuration section</link> for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in <literal>client1.pem</literal>:</para>
<screen>
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1

8
dspace/docs/docbook/introduction.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Introduction</title>
<title><anchor id="docbook-introduction.html"/>DSpace System Documentation: Introduction</title>
<para>DSpace is an open source software platform that enables organisations to:</para>
<itemizedlist>
<listitem>
@@ -13,9 +13,9 @@
<para> preserve digital assets over the long term</para>
</listitem>
</itemizedlist>
<para>This system documentation includes <ulink url="functional.html">a functional overview of the system</ulink>, 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.</para>
<para>For people actually running a DSpace service, there is <ulink url="install.html">an installation guide</ulink>, and sections on <ulink url="configure.html">configuration</ulink> and <ulink url="directories.html">the directory structure</ulink>. Note that as of DSpace 1.2, the administration user interface guide is now on-line help available from within the DSpace system.</para>
<para>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 <ulink url="architecture.html">a detailed architecture and design section</ulink>.</para>
<para>This system documentation includes <link linkend="docbook-functional.html">a functional overview of the system</link>, 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.</para>
<para>For people actually running a DSpace service, there is <link linkend="docbook-install.html">an installation guide</link>, and sections on <link linkend="docbook-configure.html">configuration</link> and <link linkend="docbook-directories.html">the directory structure</link>. Note that as of DSpace 1.2, the administration user interface guide is now on-line help available from within the DSpace system.</para>
<para>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 <link linkend="docbook-architecture.html">a detailed architecture and design section</link>.</para>
<para>Other good sources of information are:</para>
<itemizedlist>
<listitem>

14
dspace/docs/docbook/storage.xml
View File

@@ -1,8 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Storage Layer</title>
<title><anchor id="docbook-storage.html"/>DSpace System Documentation: Storage Layer</title>
<para>
<ulink url="architecture.html">Back to architecture overview</ulink>
<link linkend="docbook-architecture.html">Back to architecture overview</link>
</para>
<section remap="h2">
<title><anchor id="docbook-storage.html-rdbms" xreflabel="RDBMS"/>RDBMS</title>
@@ -12,9 +12,9 @@
</para>
<para>Most of the functionality that DSpace uses can be offered by any standard SQL database that supports transactions. Presently, the browse indices use some features specific to <ulink url="http://www.postgresql.org/">PostgreSQL</ulink> and <ulink url="http://www.oracle.com/database/">Oracle</ulink>, so some modification to the code would be needed before DSpace would function fully with an alternative database back-end.</para>
<para>The <literal>org.dspace.storage.rdbms</literal> package provides access to an SQL database in a somewhat simpler form than using JDBC directly. The main class is <literal>DatabaseManager</literal>, which executes SQL queries and returns <literal>TableRow</literal> or <literal>TableRowIterator</literal> objects. The <literal>InitializeDatabase</literal> class is used to load SQL into the database via JDBC, for example to set up the schema.</para>
<para>All calls to the <literal>Database Manager</literal> require a <ulink url="business.html#core">DSpace <literal>Context</literal> object</ulink>. Example use of the database manager API is given in the <literal>org.dspace.storage.rdbms</literal> package Javadoc.</para>
<para>All calls to the <literal>Database Manager</literal> require a <link linkend="docbook-business.html-core">DSpace <literal>Context</literal> object</link>. Example use of the database manager API is given in the <literal>org.dspace.storage.rdbms</literal> package Javadoc.</para>
<para>The database schema used by DSpace (for PostgreSQL) is stored in <literal>[dspace-source]/dspace/etc/database_schema.sql</literal> in the source distribution. It is stored in the form of SQL that can be fed straight into the DBMS to construct the database. The schema SQL file also directly creates two e-person groups in the database that are required for the system to function properly.</para>
<para>Also in <literal>[dspace-source]/dspace/etc</literal> are various SQL files called <literal>database_schema_1x_1y</literal>. These contain the necessary SQL commands to update a live DSpace database from version 1.<literal>x</literal> to 1.<literal>y</literal>. Note that this might not be the only part of an upgrade process: see <ulink url="update.html">Updating a DSpace Installation</ulink> for details.</para>
<para>Also in <literal>[dspace-source]/dspace/etc</literal> are various SQL files called <literal>database_schema_1x_1y</literal>. These contain the necessary SQL commands to update a live DSpace database from version 1.<literal>x</literal> to 1.<literal>y</literal>. Note that this might not be the only part of an upgrade process: see <link linkend="docbook-update.html">Updating a DSpace Installation</link> for details.</para>
<para>The DSpace database code uses an SQL function <literal>getnextid</literal> to assign primary keys to newly created rows. This SQL function must be safe to use if several JVMs are accessing the database at once; for example, the Web UI might be creating new rows in the database at the same time as the batch item importer. The PostgreSQL-specific implementation of the method uses <literal>SEQUENCES</literal> for each table in order to create new IDs. If an alternative database backend were to be used, the implementation of <literal>getnextid</literal> could be updated to operate with that specific DBMS.</para>
<para>The <literal>etc</literal> directory in the source distribution contains two further SQL files. <literal>clean-database.sql</literal> contains the SQL necessary to completely clean out the database, so use with caution! The Ant target <literal>clean_database</literal> can be used to execute this. <literal>update-sequences.sql</literal> contains SQL to reset the primary key generation sequences to appropriate values. You&apos;d need to do this if, for example, you&apos;re restoring a backup database dump which creates rows with specific primary keys already defined. In such a case, the sequences would allocate primary keys that were already used.</para>
<para>Versions of the <literal>*.sql*</literal> files for Oracle are stored in <literal>[dspace-source]/dspace/etc/oracle</literal>. These need to be copied over their PostgreSQL counterparts in <literal>[dspace-source]/dspace/etc</literal> prior to installation.</para>
@@ -104,9 +104,9 @@ psql -U dspace -f <emphasis>
<para>DSpace offers two means for storing content. The first is in the file system on the server. The second is using <ulink url="http://www.sdsc.edu/srb">SRB (Storage Resource Broker)</ulink>. Both are achieved using a simple, lightweight API.</para>
<para>SRB is purely an option but may be used in lieu of the server&apos;s file system or in addition to the file system. Without going into a full description, SRB is a very robust, sophisticated storage manager that offers essentially unlimited storage and straightforward means to replicate (in simple terms, backup) the content on other local or remote storage resources.</para>
<para>The terms &quot;store&quot;, &quot;retrieve&quot;, &quot;in the system&quot;, &quot;storage&quot;, and so forth, used below can refer to storage in the file system on the server (&quot;traditional&quot;) or in SRB.</para>
<para>The <literal>BitstreamStorageManager</literal> provides low-level access to bitstreams stored in the system. In general, it should not be used directly; instead, use the <literal>Bitstream</literal> object in the <ulink url="business.html#content">content management API</ulink> since that encapsulated authorization and other metadata to do with a bitstream that are not maintained by the <literal>BitstreamStorageManager</literal>.</para>
<para>The <literal>BitstreamStorageManager</literal> provides low-level access to bitstreams stored in the system. In general, it should not be used directly; instead, use the <literal>Bitstream</literal> object in the <link linkend="docbook-business.html-content">content management API</link> since that encapsulated authorization and other metadata to do with a bitstream that are not maintained by the <literal>BitstreamStorageManager</literal>.</para>
<para>The bitstream storage manager provides three methods that store, retrieve and delete bitstreams. Bitstreams are referred to by their &apos;ID&apos;; that is the primary key <literal>bitstream_id</literal> column of the corresponding row in the database.</para>
<para>As of DSpace version 1.1, there can be multiple bitstream stores. Each of these bitstream stores can be traditional storage or SRB storage. This means that the potential storage of a DSpace system is not bound by the maximum size of a single disk or file system and also that traditional and SRB storage can be combined in one DSpace installation. Both traditional and SRB storage are specified by <ulink url="configure.html">configuration parameters</ulink>. Also see Configuring the Bitstream Store below.</para>
<para>As of DSpace version 1.1, there can be multiple bitstream stores. Each of these bitstream stores can be traditional storage or SRB storage. This means that the potential storage of a DSpace system is not bound by the maximum size of a single disk or file system and also that traditional and SRB storage can be combined in one DSpace installation. Both traditional and SRB storage are specified by <link linkend="docbook-configure.html">configuration parameters</link>. Also see Configuring the Bitstream Store below.</para>
<para>Stores are numbered, starting with zero, then counting upwards. Each bitstream entry in the database has a store number, used to retrieve the bitstream when required.</para>
<para>At the moment, the store in which new bitstreams are placed is decided using a configuration parameter, and there is no provision for moving bitstreams between stores. Administrative tools for manipulating bitstreams and stores will be provided in future releases. Right now you can move a whole store (e.g. you could move store number 1 from <literal>/localdisk/store</literal> to <literal>/fs/anotherdisk/store</literal> but it would still have to be store number 1 and have the exact same contents.</para>
<para>Bitstreams also have an 38-digit internal ID, different from the primary key ID of the bitstream table row. This is not visible or used outside of the bitstream storage manager. It is used to determine the exact location (relative to the relevant store directory) that the bitstream is stored in traditional or SRB storage. The first three pairs of digits are the directory path that the bitstream is stored under. The bitstream is stored in a file with the internal ID as the filename.</para>
@@ -165,7 +165,7 @@ psql -U dspace -f <emphasis>
<para>The bitstream storage manager is fully transaction-safe. In order to implement transaction-safety, the following algorithm is used to store bitstreams:</para>
<orderedlist>
<listitem>
<para> A database connection is created, separately from the currently active connection in the <ulink url="business.html#core">current DSpace context</ulink>.</para>
<para> A database connection is created, separately from the currently active connection in the <link linkend="docbook-business.html-core">current DSpace context</link>.</para>
</listitem>
<listitem>
<para> An unique internal identifier (separate from the database primary key) is generated.</para>

6
dspace/docs/docbook/submission.xml
View File

@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>Customizing and Configuring Submission User Interface</title>
<title><anchor id="docbook-submission.html"/>Customizing and Configuring Submission User Interface</title>
<para>This page explains various customization and configuration options that are available within DSpace for the Item Submission user interface.</para>
<para>
<anchor id="docbook-submission.html-configurationFile"/>
@@ -491,7 +491,7 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/workflow-edita
</varlistentry>
</variablelist>
<para>Look at the example <literal>input-forms.xml</literal> 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.</para>
<para>For the use of controlled vocabularies see the <ulink url="configure.html#controlledvocabulary">Configuring Controlled Vocabularies</ulink> section.</para>
<para>For the use of controlled vocabularies see the <link linkend="docbook-configure.html-controlledvocabulary">Configuring Controlled Vocabularies</link> section.</para>
</section>
<section remap="h5">
<title>Automatically Elided Fields</title>
@@ -676,7 +676,7 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/workflow-edita
<para> (<emphasis role="bold">Required</emphasis>) Add a valid Step Definition to the <literal>item-submission.xml</literal> configuration file. </para>
<itemizedlist>
<listitem>
<para> This may also require that you add an I18N (Internationalization) key for this step&apos;s <literal>heading</literal>. See the sections on <ulink url="configure.html#jspui-multilingual">Configuring Multilingual Support for JSPUI</ulink> or <ulink url="configure.html#xmlui-multilingual">Configuring Multilingual Support for XMLUI</ulink> for more details.</para>
<para> This may also require that you add an I18N (Internationalization) key for this step&apos;s <literal>heading</literal>. See the sections on <link linkend="docbook-configure.html-jspui-multilingual">Configuring Multilingual Support for JSPUI</link> or <link linkend="docbook-configure.html#xmlui-multilingual">Configuring Multilingual Support for XMLUI</link> for more details.</para>
</listitem>
<listitem>
<para> For more information on <literal>&lt;step&gt;</literal> definitions within the <literal>item-submission.xml</literal>, see the section above on <anchor id="docbook-submission.html--stepDefinitions.1" xreflabel="Defining Steps

22
dspace/docs/docbook/update.xml
View File

@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter remap="h1">
<title>DSpace System Documentation: Updating a DSpace Installation</title>
<para>This section describes how to update a DSpace installation from one version to the next. Details of the differences between the functionality of each version are given in the <ulink url="history.html">Version History</ulink> section.</para>
<title><anchor id="docbook-update.html"/>DSpace System Documentation: Updating a DSpace Installation</title>
<para>This section describes how to update a DSpace installation from one version to the next. Details of the differences between the functionality of each version are given in the <link linkend="docbook-history.html">Version History</link> section.</para>
<section remap="h2">
<title><anchor id="docbook-update.html-142_15" xreflabel="Updating From 1.4.2 to 1.5"/>Updating From 1.4.2 to 1.5</title>
<para>The changes in DSpace 1.5 are significant and wide spread involving database schema upgrades, code restructuring, completely new user and programatic interfaces, and new build system.</para>
@@ -28,7 +28,7 @@
<para><emphasis role="bold">Download DSpace 1.5</emphasis> Get the new DSpace 1.5 source code either as a download from <ulink url="#">SourceForge</ulink> or check it out directly from the <ulink url="#">SVN code repository</ulink>. If you downloaded DSpace do not unpack it on top of your existing installation.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Build DSpace</emphasis> The build process has radically changed for DSpace 1.5. With this new release the build system has moved to a maven-based system enabling the various projects (JSPUI, XMLUI, OAI, and Core API) into separate projects. See the <ulink url="install.html">Installation section</ulink> for more information on building DSpace using the new maven-based build system. Run the following commands to compile DSpace.</para>
<para><emphasis role="bold">Build DSpace</emphasis> The build process has radically changed for DSpace 1.5. With this new release the build system has moved to a maven-based system enabling the various projects (JSPUI, XMLUI, OAI, and Core API) into separate projects. See the <link linkend="docbook-install.html">Installation section</link> for more information on building DSpace using the new maven-based build system. Run the following commands to compile DSpace.</para>
<screen>
cd [dspace-source]/dspace/;
mvn package
@@ -181,7 +181,7 @@ cp [dspace-source]/dspace/config/emails/registration_notify
</itemizedlist>
</listitem>
<listitem>
<para><emphasis role="bold">Apply any customizations</emphasis> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to &quot;JSP&quot; pages located inside the <literal>[dspace 1.4.2]/jsp/local</literal> directory. These should be moved <literal>[dspace-source]/dspace/modules/jspui/src/main/webapp/</literal> in the new build structure. See <ulink url="configure.html#jspui-jsp">Customizing the JSP Pages</ulink> for more information.</para>
<para><emphasis role="bold">Apply any customizations</emphasis> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to &quot;JSP&quot; pages located inside the <literal>[dspace 1.4.2]/jsp/local</literal> directory. These should be moved <literal>[dspace-source]/dspace/modules/jspui/src/main/webapp/</literal> in the new build structure. See <link linkend="docbook-configure.html-jspui-jsp">Customizing the JSP Pages</link> for more information.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Update DSpace</emphasis> Update the DSpace installed directory with new code and libraries. Inside the <literal>[dspace-source]/dspace/target/dspace-1.5-build.dir/</literal> directory run:</para>
@@ -440,7 +440,7 @@ search.index.1 = title:dc.title.alternative
</screen>
</listitem>
<listitem>
<para> If you use LDAP or X509 authentication, you&apos;ll need to add <literal>org.dspace.eperson.LDAPAuthentication</literal> or <literal>org.dspace.eperson.X509Authentication</literal> respectively. See also <ulink url="configure.html#authenticate">configuring custom authentication code</ulink>.</para>
<para> If you use LDAP or X509 authentication, you&apos;ll need to add <literal>org.dspace.eperson.LDAPAuthentication</literal> or <literal>org.dspace.eperson.X509Authentication</literal> respectively. See also <link linkend="docbook-configure.html-authenticate">configuring custom authentication code</link>.</para>
</listitem>
<listitem>
<para> If you have custom Media Filters, note that these are now configured through <literal>dspace.cfg</literal> (instead of <literal>mediafilter.cfg</literal> which is obsolete.)</para>
@@ -600,7 +600,7 @@ report.dir = /dspace/reports/
</para>
</listitem>
<listitem>
<para> Customise the stat generating statistics as per the instructions in <ulink url="configure.html#statistics">System Statistical Reports</ulink></para>
<para> Customise the stat generating statistics as per the instructions in <link linkend="docbook-configure.html-statistics">System Statistical Reports</link></para>
</listitem>
<listitem>
<para> Initialise the statistics using:</para>
@@ -653,7 +653,7 @@ cp postgresql.jar <emphasis> [dspace-1.2.2-source]</emphasis>/lib
<para> Take down Tomcat (or whichever servlet container you&apos;re using).</para>
</listitem>
<listitem>
<para> Your &apos;localized&apos; JSPs (those in jsp/local) now need to be maintained in the <emphasis>source</emphasis> directory. If you have locally modified JSPs in your <literal>[dspace]/jsp/local</literal> directory, you might like to merge the changes in the new 1.2.2 versions into your locally modified ones. You can use the <literal>diff</literal> command to compare the 1.2.1 and 1.2.2 versions to do this. Also see <ulink url="history.html#jsp-changes-1_2_1-1_2_2">the version history</ulink> for a list of modified JSPs.</para>
<para> Your &apos;localized&apos; JSPs (those in jsp/local) now need to be maintained in the <emphasis>source</emphasis> directory. If you have locally modified JSPs in your <literal>[dspace]/jsp/local</literal> directory, you might like to merge the changes in the new 1.2.2 versions into your locally modified ones. You can use the <literal>diff</literal> command to compare the 1.2.1 and 1.2.2 versions to do this. Also see <link linkend="docbook-history.html-jsp-changes-1_2_1-1_2_2">the version history</link> for a list of modified JSPs.</para>
</listitem>
<listitem>
<para> You need to add a new parameter to your <literal>[dspace]/dspace.cfg</literal> for configurable fulltext indexing</para>
@@ -708,7 +708,7 @@ cp postgresql.jar <emphasis> [dspace-1.2.1-source]</emphasis>/lib
<para> Take down Tomcat (or whichever servlet container you&apos;re using).</para>
</listitem>
<listitem>
<para> Your &apos;localized&apos; JSPs (those in jsp/local) now need to be maintained in the <emphasis>source</emphasis> directory. If you have locally modified JSPs in your <literal>[dspace]/jsp/local</literal> directory, you might like to merge the changes in the new 1.2.1 versions into your locally modified ones. You can use the <literal>diff</literal> command to compare the 1.2 and 1.2.1 versions to do this. Also see <ulink url="history.html#jsp-changes-1_2-1_2_1">the version history</ulink> for a list of modified JSPs.</para>
<para> Your &apos;localized&apos; JSPs (those in jsp/local) now need to be maintained in the <emphasis>source</emphasis> directory. If you have locally modified JSPs in your <literal>[dspace]/jsp/local</literal> directory, you might like to merge the changes in the new 1.2.1 versions into your locally modified ones. You can use the <literal>diff</literal> command to compare the 1.2 and 1.2.1 versions to do this. Also see <link linkend="docbook-history.html-jsp-changes-1_2-1_2_1">the version history</link> for a list of modified JSPs.</para>
</listitem>
<listitem>
<para> You need to add a few new parameters to your <literal>[dspace]/dspace.cfg</literal> for browse/search and item thumbnails display, and for configurable DC metadata fields to be indexed.</para>
@@ -789,7 +789,7 @@ cp <emphasis> [dspace-1.2.1-source]</emphasis>/build/*.war <emphasis>
<para> Get the new DSpace 1.2 source code from <ulink url="http://sourceforge.net/projects/dspace/">the DSpace page on SourceForge</ulink> and unpack it somewhere. Do not unpack it on top of your existing installation!!</para>
</listitem>
<listitem>
<para> Copy the <ulink url="install.html#javalibs">required Java libraries</ulink> that we couldn&apos;t include in the bundle to the source tree. For example:</para>
<para> Copy the <link linkend="docbook-install.html-javalibs">required Java libraries</link> that we couldn&apos;t include in the bundle to the source tree. For example:</para>
<screen>
cd <emphasis> [dspace]</emphasis>/lib
cp activation.jar servlet.jar mail.jar <emphasis>
@@ -824,7 +824,7 @@ cp activation.jar servlet.jar mail.jar <emphasis>
thumbnail.maxwidth 80
thumbnail.maxheight 80
</screen>
<para>There are one or two other, optional extra parameters (for controlling the pool of database connections). See <ulink url="history.html">the version history</ulink> for details. If you leave them out, defaults will be used.</para>
<para>There are one or two other, optional extra parameters (for controlling the pool of database connections). See <link linkend="docbook-history.html">the version history</link> for details. If you leave them out, defaults will be used.</para>
<para>Also, to avoid future confusion, you might like to <emphasis role="bold">remove</emphasis> the following property, which is no longer required:</para>
<screen>
config.template.oai-web.xml = <emphasis>
@@ -1037,7 +1037,7 @@ CREATE VIEW CollectionItemsByDateAccession AS SELECT
<para>(If you haven&apos;t modified any JSPs, you don&apos;t have to do anything.)</para>
</listitem>
<listitem>
<para> Copy the <ulink url="install.html#javalibs">required Java libraries</ulink> that we couldn&apos;t include in the bundle to the source tree. For example:</para>
<para> Copy the <link linkend="docbook-install.html-javalibs">required Java libraries</link> that we couldn&apos;t include in the bundle to the source tree. For example:</para>
<screen>
cd <emphasis> [dspace]</emphasis>/lib
cp *.policy activation.jar servlet.jar mail.jar <emphasis>

4
dspace/docs/html/ch01.html
View File

@@ -1,10 +1,10 @@
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;1.&nbsp;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.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="pr01.html" title="Preface"><link rel="next" href="ch02.html" title="Chapter&nbsp;2.&nbsp;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&nbsp;1.&nbsp;DSpace System Documentation: Introduction</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="pr01.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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&nbsp;1.&nbsp;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&nbsp;1.&nbsp;DSpace System Documentation: Introduction</title><meta content="DocBook XSL Stylesheets V1.74.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="pr01.html" title="Preface"><link rel="next" href="ch02.html" title="Chapter&nbsp;2.&nbsp;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&nbsp;1.&nbsp;DSpace System Documentation: Introduction</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="pr01.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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&nbsp;1.&nbsp;<a name="docbook-introduction.html"></a>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="link" href="ch02.html#docbook-functional.html">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="link" href="ch03.html#docbook-install.html">an installation guide</a>, and sections on <a class="link" href="ch05.html#docbook-configure.html">configuration</a> and <a class="link" href="ch07.html#docbook-directories.html">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="link" href="ch08.html#docbook-architecture.html">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>
</p></li><li><p>
<a class="ulink" href="http://wiki.dspace.org/ContributionGuidelines" target="_top">Guidelines for contributing back to DSpace</a>
</p></li></ul></div></li><li><p><a class="ulink" href="http://www.dspace.org/" target="_top">www.dspace.org</a> has announcements and contains useful information about bringing up an instance of DSpace at your organization.</p></li><li><p> The <a class="ulink" href="#" target="_top">dspace-tech e-mail list on SourceForge</a> is the recommended place to ask questions, since a growing community of DSpace developers and users is on hand on that list to help with any questions you might have. The e-mail archive of that list is a useful resource.</p></li><li><p> The <a class="ulink" href="#" target="_top">dspace-devel e-mail list</a>, for those developing with the DSpace with a view to contributing to the core DSpace code.</p></li></ul></div></div><HR><p class="copyright">Copyright &copy; 2002-2008
</p></li></ul></div></li><li><p><a class="ulink" href="http://www.dspace.org/" target="_top">www.dspace.org</a> has announcements and contains useful information about bringing up an instance of DSpace at your organization.</p></li><li><p> The <a class="ulink" href="#" target="_top">dspace-tech e-mail list on SourceForge</a> is the recommended place to ask questions, since a growing community of DSpace developers and users is on hand on that list to help with any questions you might have. The e-mail archive of that list is a useful resource.</p></li><li><p> The <a class="ulink" href="#" target="_top">dspace-devel e-mail list</a>, for those developing with the DSpace with a view to contributing to the core DSpace code.</p></li></ul></div></div><HR><p class="copyright">Copyright &copy; 2002-2009
<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">

20
dspace/docs/html/ch02.html
View File

File diff suppressed because one or more lines are too long

34
dspace/docs/html/ch03.html
View File

File diff suppressed because one or more lines are too long

36
dspace/docs/html/ch04.html
View File

File diff suppressed because one or more lines are too long

129
dspace/docs/html/ch05.html
View File

File diff suppressed because one or more lines are too long

18
dspace/docs/html/ch06.html
View File

File diff suppressed because one or more lines are too long

12
dspace/docs/html/ch07.html
View File

File diff suppressed because one or more lines are too long

54
dspace/docs/html/ch08.html
View File

@@ -1,6 +1,6 @@
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;8.&nbsp;DSpace System Documentation: Architecture</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="ch07.html" title="Chapter&nbsp;7.&nbsp;DSpace System Documentation: Directories and Files"><link rel="next" href="ch09.html" title="Chapter&nbsp;9.&nbsp;DSpace System Documentation: Application Layer"></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&nbsp;8.&nbsp;DSpace System Documentation: Architecture</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch07.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="ch09.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N12DF2"></a>Chapter&nbsp;8.&nbsp;DSpace System Documentation: Architecture</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch08.html#N12DF6">8.1. Overview</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N12DF6"></a>8.1.&nbsp;<a name="docbook-architecture.html-overview"></a>Overview</h2></div></div></div><p>The DSpace system is organized into three layers, each of which consists of a number of components.</p><p>
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;8.&nbsp;DSpace System Documentation: Architecture</title><meta content="DocBook XSL Stylesheets V1.74.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="ch07.html" title="Chapter&nbsp;7.&nbsp;DSpace System Documentation: Directories and Files"><link rel="next" href="ch09.html" title="Chapter&nbsp;9.&nbsp;DSpace System Documentation: Application Layer"></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&nbsp;8.&nbsp;DSpace System Documentation: Architecture</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch07.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="ch09.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N12E6E"></a>Chapter&nbsp;8.&nbsp;<a name="docbook-architecture.html"></a>DSpace System Documentation: Architecture</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch08.html#N12E74">8.1. Overview</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N12E74"></a>8.1.&nbsp;<a name="docbook-architecture.html-overview"></a>Overview</h2></div></div></div><p>The DSpace system is organized into three layers, each of which consists of a number of components.</p><p>
<span class="inlinemediaobject"><img src="image/architecture-600x450.gif" width="585"></span>
</p><p>DSpace System Architecture</p><p>The storage layer is responsible for physical storage of metadata and content. The business logic layer deals with managing the content of the archive, users of the archive (e-people), authorization, and workflow. The application layer contains components that communicate with the world outside of the individual DSpace installation, for example the Web user interface and the <a class="ulink" href="http://www.openarchives.org/" target="_top">Open Archives Initiative</a> protocol for metadata harvesting service.</p><p>Each layer only invokes the layer below it; the application layer may not used the storage layer directly, for example. Each component in the storage and business logic layers has a defined public API. The union of the APIs of those components are referred to as the Storage API (in the case of the storage layer) and the DSpace Public API (in the case of the business logic layer). These APIs are in-process Java classes, objects and methods.</p><p>It is important to note that each layer is <span class="emphasis"><em>trusted</em></span>. Although the logic for <span class="emphasis"><em>authorising actions</em></span> is in the business logic layer, the system relies on individual applications in the application layer to correctly and securely <span class="emphasis"><em>authenticate</em></span> e-people. If a 'hostile' or insecure application were allowed to invoke the Public API directly, it could very easily perform actions as any e-person in the system.</p><p>The reason for this design choice is that authentication methods will vary widely between different applications, so it makes sense to leave the logic and responsibility for that in these applications.</p><p>The source code is organized to cohere very strictly to this three-layer architecture. Also, only methods in a component's public API are given the <code class="literal">public</code> access level. This means that the Java compiler helps ensure that the source code conforms to the architecture.</p><div class="table"><a name="N12E26"></a><p class="title"><b>Table&nbsp;8.1.&nbsp;Source Code Packages</b></p><div class="table-contents"><table summary="Source Code Packages" border="0"><colgroup><col><col></colgroup><tbody><tr><td>
</p><p>DSpace System Architecture</p><p>The storage layer is responsible for physical storage of metadata and content. The business logic layer deals with managing the content of the archive, users of the archive (e-people), authorization, and workflow. The application layer contains components that communicate with the world outside of the individual DSpace installation, for example the Web user interface and the <a class="ulink" href="http://www.openarchives.org/" target="_top">Open Archives Initiative</a> protocol for metadata harvesting service.</p><p>Each layer only invokes the layer below it; the application layer may not used the storage layer directly, for example. Each component in the storage and business logic layers has a defined public API. The union of the APIs of those components are referred to as the Storage API (in the case of the storage layer) and the DSpace Public API (in the case of the business logic layer). These APIs are in-process Java classes, objects and methods.</p><p>It is important to note that each layer is <span class="emphasis"><em>trusted</em></span>. Although the logic for <span class="emphasis"><em>authorising actions</em></span> is in the business logic layer, the system relies on individual applications in the application layer to correctly and securely <span class="emphasis"><em>authenticate</em></span> e-people. If a 'hostile' or insecure application were allowed to invoke the Public API directly, it could very easily perform actions as any e-person in the system.</p><p>The reason for this design choice is that authentication methods will vary widely between different applications, so it makes sense to leave the logic and responsibility for that in these applications.</p><p>The source code is organized to cohere very strictly to this three-layer architecture. Also, only methods in a component's public API are given the <code class="literal">public</code> access level. This means that the Java compiler helps ensure that the source code conforms to the architecture.</p><div class="table"><a name="N12EA4"></a><p class="title"><b>Table&nbsp;8.1.&nbsp;Source Code Packages</b></p><div class="table-contents"><table summary="Source Code Packages" border="0"><colgroup><col><col></colgroup><tbody><tr><td>
<p>
<span class="bold"><strong>Packages within</strong></span>
</p>
@@ -29,57 +29,57 @@
</td></tr></tbody></table></div></div><br class="table-break"><p>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:</p><pre class="screen">
mvn javadoc:javadoc
</pre><p> The resulting documentation will be at <code class="literal">[dspace-source]dspace-api/target/site/apidocs/index.html</code>. 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.</p><p>Each layer is described in a separate section:</p><div class="itemizedlist"><ul type="disc"><li><p>
<a class="ulink" href="storage.html" target="_top">Storage Layer</a>
<a class="link" href="ch06.html#docbook-storage.html">Storage Layer</a>
<div class="itemizedlist"><ul type="circle"><li><p>
<a class="ulink" href="storage.html#rdbms" target="_top">RDBMS</a>
<a class="link" href="ch06.html#docbook-storage.html-rdbms">RDBMS</a>
</p></li><li><p>
<a class="ulink" href="storage.html#bitstreams" target="_top">Bitstream Store</a>
<a class="link" href="ch06.html#docbook-storage.html-bitstreams">Bitstream Store</a>
</p></li></ul></div>
</p></li><li><p>
<a class="ulink" href="business.html" target="_top">Business Logic Layer</a>
<a class="link" href="ch10.html#docbook-business.html">Business Logic Layer</a>
<div class="itemizedlist"><ul type="circle"><li><p>
<a class="ulink" href="business.html#core" target="_top">Core Classes</a>
<a class="link" href="ch10.html#docbook-business.html-core">Core Classes</a>
</p></li><li><p>
<a class="ulink" href="business.html#content" target="_top">Content Management API</a>
<a class="link" href="ch10.html#docbook-business.html-content">Content Management API</a>
</p></li><li><p>
<a class="ulink" href="business.html#workflow" target="_top">Workflow System</a>
<a class="link" href="ch10.html#docbook-business.html-workflow">Workflow System</a>
</p></li><li><p>
<a class="ulink" href="business.html#administer" target="_top">Administration Toolkit</a>
<a class="link" href="ch10.html#docbook-business.html-administer">Administration Toolkit</a>
</p></li><li><p>
<a class="ulink" href="business.html#eperson" target="_top">E-person/Group Manager</a>
<a class="link" href="ch10.html#docbook-business.html-eperson">E-person/Group Manager</a>
</p></li><li><p>
<a class="ulink" href="business.html#authorize" target="_top">Authorisation</a>
<a class="link" href="ch10.html#docbook-business.html-authorize">Authorisation</a>
</p></li><li><p>
<a class="ulink" href="business.html#handle" target="_top">Handle Manager/Handle Plugin</a>
<a class="link" href="ch10.html#docbook-business.html-handle">Handle Manager/Handle Plugin</a>
</p></li><li><p>
<a class="ulink" href="business.html#search" target="_top">Search</a>
<a class="link" href="ch10.html#docbook-business.html-search">Search</a>
</p></li><li><p>
<a class="ulink" href="business.html#browse" target="_top">Browse API</a>
<a class="link" href="ch10.html#docbook-business.html-browse">Browse API</a>
</p></li><li><p>
<a class="ulink" href="business.html#history" target="_top">History Recorder</a>
<a class="link" href="ch10.html#docbook-business.html-history">History Recorder</a>
</p></li><li><p>
<a class="ulink" href="business.html#checker" target="_top">Checksum Checker</a>
<a class="link" href="ch10.html#docbook-business.html-checker">Checksum Checker</a>
</p></li></ul></div>
</p></li><li><p>
<a class="ulink" href="application.html" target="_top">Application Layer</a>
<a class="link" href="ch09.html#docbook-application.html">Application Layer</a>
<div class="itemizedlist"><ul type="circle"><li><p>
<a class="ulink" href="application.html#webui" target="_top">Web User Interface</a>
<a class="link" href="ch09.html#docbook-application.html-webui">Web User Interface</a>
</p></li><li><p>
<a class="ulink" href="application.html#oai" target="_top">OAI-PMH Data Provider</a>
<a class="link" href="ch09.html#docbook-application.html-oai">OAI-PMH Data Provider</a>
</p></li><li><p>
<a class="ulink" href="application.html#itemimporter" target="_top">Item Importer and Exporter</a>
<a class="link" href="ch09.html#docbook-application.html-itemimporter">Item Importer and Exporter</a>
</p></li><li><p>
<a class="ulink" href="application.html#transferitem" target="_top">Transferring Items Between DSpace Instances</a>
<a class="link" href="ch09.html#docbook-application.html-transferitem">Transferring Items Between DSpace Instances</a>
</p></li><li><p>
<a class="ulink" href="application.html#registration" target="_top">Registration</a>
<a class="link" href="ch09.html#docbook-application.html-registration">Registration</a>
</p></li><li><p>
<a class="ulink" href="application.html#mets" target="_top">METS Tools</a>
<a class="link" href="ch09.html#docbook-application.html-mets">METS Tools</a>
</p></li><li><p>
<a class="ulink" href="application.html#mediafilters" target="_top">Media Filters</a>
<a class="link" href="ch09.html#docbook-application.html-mediafilters">Media Filters</a>
</p></li><li><p>
<a class="ulink" href="application.html#filiator" target="_top">Sub-Community Management</a>
<a class="link" href="ch09.html#docbook-application.html-filiator">Sub-Community Management</a>
</p></li></ul></div>
</p></li></ul></div><p> 2002-2008 The DSpace Foundation </p></div></div><HR><p class="copyright">Copyright &copy; 2002-2008
</p></li></ul></div><p> 2002-2008 The DSpace Foundation </p></div></div><HR><p class="copyright">Copyright &copy; 2002-2009
<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">

60
dspace/docs/html/ch09.html
View File

File diff suppressed because one or more lines are too long

54
dspace/docs/html/ch10.html
View File

File diff suppressed because one or more lines are too long

44
dspace/docs/html/ch11.html
View File

@@ -1,6 +1,6 @@
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;11.&nbsp;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.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="ch10.html" title="Chapter&nbsp;10.&nbsp;DSpace System Documentation: Business Logic Layer"><link rel="next" href="ch12.html" title="Chapter&nbsp;12.&nbsp;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&nbsp;11.&nbsp;Customizing and Configuring Submission User Interface</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch10.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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&nbsp;11.&nbsp;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 (&lt;step&gt;) 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>
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;11.&nbsp;Customizing and Configuring Submission User Interface</title><meta content="DocBook XSL Stylesheets V1.74.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="ch10.html" title="Chapter&nbsp;10.&nbsp;DSpace System Documentation: Business Logic Layer"><link rel="next" href="ch12.html" title="Chapter&nbsp;12.&nbsp;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&nbsp;11.&nbsp;Customizing and Configuring Submission User Interface</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch10.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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="N1467E"></a>Chapter&nbsp;11.&nbsp;<a name="docbook-submission.html"></a>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#N1468B">11.1. Understanding the Submission Configuration File</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14698">11.1.1. The Structure of item-submission.xml</a></span></dt><dt><span class="section"><a href="ch11.html#N146C7">11.1.2. Defining Steps (&lt;step&gt;) within the item-submission.xml</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N147FB">11.2. Reordering/Removing Submission Steps</a></span></dt><dt><span class="section"><a href="ch11.html#N148A8">11.3. Assigning a custom Submission Process to a Collection</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N148FB">11.3.1. Getting A Collection's Handle</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N1491E">11.4. Custom Metadata-entry Pages for Submission</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14922">11.4.1. Introduction</a></span></dt><dt><span class="section"><a href="ch11.html#N1494D">11.4.2. Describing Custom Metadata Forms</a></span></dt><dt><span class="section"><a href="ch11.html#N14970">11.4.3. The Structure of input-forms.xml</a></span></dt><dt><span class="section"><a href="ch11.html#N14BFE">11.4.4. Deploying Your Custom Forms</a></span></dt></dl></dd><dt><span class="section"><a href="ch11.html#N14C1B">11.5. Configuring the File Upload step</a></span></dt><dt><span class="section"><a href="ch11.html#N14C47">11.6. Creating new Submission Steps</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#N14CE0">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="N14607"></a>11.1.&nbsp;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.&nbsp;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="N1468B"></a>11.1.&nbsp;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="N14698"></a>11.1.1.&nbsp;The Structure of <code class="literal">item-submission.xml</code></h3></div></div></div><pre class="screen">
<code class="literal"> &lt;item-submission&gt; &lt;!-- Where submission processes are
mapped to specific Collections --&gt; &lt;submission-map&gt; &lt;name-map
@@ -22,7 +22,7 @@
<code class="literal">Select Collection -&gt; Initial Questions -&gt; Describe -&gt; Upload -&gt; Verify -&gt; License -&gt; 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">&lt;submission-definition&gt;</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">&lt;submission-map&gt;</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="N14643"></a>11.1.2.&nbsp;Defining Steps (<code class="literal">&lt;step&gt;</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">&lt;step&gt;</code> definitions</h4></div></div></div><p><code class="literal">&lt;step&gt;</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">&lt;step-definitions&gt;</code> section </p><div class="itemizedlist"><ul type="disc"><li><p> This is for globally defined <code class="literal">&lt;step&gt;</code> definitions (i.e. steps which are used in multiple <code class="literal">&lt;submission-process&gt;</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="N146C7"></a>11.1.2.&nbsp;Defining Steps (<code class="literal">&lt;step&gt;</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="N146D8"></a>Where to place your <code class="literal">&lt;step&gt;</code> definitions</h4></div></div></div><p><code class="literal">&lt;step&gt;</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">&lt;step-definitions&gt;</code> section </p><div class="itemizedlist"><ul type="disc"><li><p> This is for globally defined <code class="literal">&lt;step&gt;</code> definitions (i.e. steps which are used in multiple <code class="literal">&lt;submission-process&gt;</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"> &lt;step-definitions&gt; &lt;step id="custom-step"&gt; ...
&lt;/step&gt; ... &lt;/step-definitions&gt; </code>
@@ -32,7 +32,7 @@
<code class="literal"> &lt;submission-process&gt; &lt;step&gt; ... &lt;/step&gt;
&lt;/submission-process&gt;</code>
</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">&lt;step&gt;</code> definitions <span class="bold"><strong>matters</strong></span>!</h4></div></div></div><p>The ordering of the <code class="literal">&lt;step&gt;</code> tags within a <code class="literal">&lt;submission-process&gt;</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 &lt;step&gt; tag can be found in the section on <a class="link" href="ch11.html#docbook-submission.html-stepStructure">Structure of the &lt;step&gt; 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="N14734"></a>The ordering of <code class="literal">&lt;step&gt;</code> definitions <span class="bold"><strong>matters</strong></span>!</h4></div></div></div><p>The ordering of the <code class="literal">&lt;step&gt;</code> tags within a <code class="literal">&lt;submission-process&gt;</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 &lt;step&gt; tag can be found in the section on <a class="link" href="ch11.html#docbook-submission.html-stepStructure">Structure of the &lt;step&gt; Definition</a> below):</p><pre class="screen">
<code class="literal"> &lt;submission-process&gt; &lt;!--Step 1 will be to Sign off on
the License--&gt; &lt;step&gt; &lt;heading&gt;submit.progressbar.license&lt;/heading&gt;
@@ -55,7 +55,7 @@ tialQuestionsStep&lt;/xmlui-binding&gt;
</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="N146DE"></a>Structure of the &lt;step&gt; Definition</h4></div></div></div><p>The same &lt;step&gt; 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 &lt;step&gt; definition contains information specific to each of these two interfaces.</p><p>The structure of the &lt;step&gt; 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="N14762"></a>Structure of the &lt;step&gt; Definition</h4></div></div></div><p>The same &lt;step&gt; 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 &lt;step&gt; definition contains information specific to each of these two interfaces.</p><p>The structure of the &lt;step&gt; Definition is as follows:</p><pre class="screen">
<code class="literal"> &lt;step&gt; &lt;heading&gt;submit.progressbar.describe&lt;/heading&gt;
&lt;processing-class&gt;org.dspace.submit.step.DescribeStep&lt;/processing-clas
@@ -80,13 +80,13 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/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="N14777"></a>11.2.&nbsp;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="N147FB"></a>11.2.&nbsp;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">&lt;submission-process&gt;</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">&lt;step&gt;</code> tags within that <code class="literal">&lt;submission-process&gt;</code> tag. Be sure to move the <span class="emphasis"><em>entire</em></span><code class="literal">&lt;step&gt;</code> tag (i.e. everything between and including the opening <code class="literal">&lt;step&gt;</code> and closing <code class="literal">&lt;/step&gt;</code> tags). </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Hint #1:</em></span> The <code class="literal">&lt;step&gt;</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">&lt;step&gt;</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">&lt;submission-process&gt;</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 &lt;!-- and --&gt;) the <code class="literal">&lt;step&gt;</code> tags which you want to remove from that <code class="literal">&lt;submission-process&gt;</code> tag. Be sure to comment out the <span class="emphasis"><em>entire</em></span><code class="literal">&lt;step&gt;</code> tag (i.e. everything between and including the opening <code class="literal">&lt;step&gt;</code> and closing <code class="literal">&lt;/step&gt;</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">&lt;step&gt;</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="N14824"></a>11.3.&nbsp;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="N148A8"></a>11.3.&nbsp;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">
&lt;submission-map&gt;
&lt;name-map collection-handle="<span class="bold"><strong> 12345.6789/42</strong></span>" submission-name="<span class="bold"><strong>
custom</strong></span>" /&gt;
@@ -98,12 +98,12 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/workflow-edita
custom</strong></span>"&gt;
...
&lt;/submission-definitions&gt;
</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.&nbsp;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 &amp; 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="N148FB"></a>11.3.1.&nbsp;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 &amp; 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="N1489A"></a>11.4.&nbsp;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.&nbsp;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.&nbsp;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.&nbsp;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="N1491E"></a>11.4.&nbsp;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="N14922"></a>11.4.1.&nbsp;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="N1494D"></a>11.4.2.&nbsp;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="N14970"></a>11.4.3.&nbsp;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">
&lt;input-forms&gt;
&lt;-- <span class="emphasis"><em> Map of Collections to Form Sets</em></span> --&gt;
@@ -127,7 +127,7 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/workflow-edita
...
&lt;/form-value-pairs&gt;
&lt;/input-forms&gt;
</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">
</pre><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="N14989"></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">
&lt;form-map&gt;
&lt;name-map collection-handle="<span class="bold"><strong> 12345.6789/42</strong></span>" form-name="<span class="bold"><strong> TechRpt</strong></span>"
/&gt;
@@ -139,12 +139,12 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/workflow-edita
TechRept</strong></span>"&gt;
...
&lt;/form-definitions&gt;
</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 &amp; 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="N149C2"></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 &amp; 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="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">
</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="N149E0"></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="N149F6"></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">
&lt;page number="1"&gt;
</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">
</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="N14A1F"></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&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/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">&lt;visibility&gt;workflow&lt;/visibility&gt;</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="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>
</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="link" href="">Configuring Controlled Vocabularies</a> section.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="N14B5F"></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&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/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="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>
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="N14BAB"></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="N14B64"></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="N14BE8"></a>Example</h5></div></div></div><p>Here is a menu of types of common identifiers:</p><pre class="screen">
&lt;value-pairs value-pairs-name="common_identifiers"
dc-term="identifier"&gt;
&lt;pair&gt;
@@ -218,25 +218,25 @@ cribeStep&lt;/xmlui-binding&gt; &lt;workflow-editable&gt;true&lt;/workflow-edita
&lt;option VALUE="uri"&gt;URI&lt;/option&gt;
&lt;option VALUE="isbn"&gt;ISBN&lt;/option&gt;
&lt;/select&gt;
</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.&nbsp;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="N14BFE"></a>11.4.4.&nbsp;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="N14B97"></a>11.5.&nbsp;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="N14C1B"></a>11.5.&nbsp;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="N14BC3"></a>11.6.&nbsp;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="N14C47"></a>11.6.&nbsp;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">&lt;step&gt;</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">&lt;step&gt;</code>) within the <code class="literal">item-submission.xml</code>.</p></li></ul></div></li></ol></div><p>
</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="link" href="ch05.html#docbook-configure.html-jspui-multilingual">Configuring Multilingual Support for JSPUI</a> or <a class="link" href="">Configuring Multilingual Support for XMLUI</a> for more details.</p></li><li><p> For more information on <code class="literal">&lt;step&gt;</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">&lt;step&gt;</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="N14C5C"></a>11.6.1.&nbsp;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="N14CE0"></a>11.6.1.&nbsp;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"> &lt;step&gt;
&lt;processing-class&gt;org.dspace.submit.step.MyNonInteractveStep&lt;/processi
/processing-class&gt; &lt;workflow-editable&gt;false&lt;/workflow-editable&gt;
&lt;/step&gt;</code>
</pre></li></ol></div><p>Note: Non-interactive steps will not appear in the Progress Bar! Therefore, your submitters will not even know they are there. However, because they are not visible to your users, you should make sure that your non-interactive step does not take a large amount of time to finish its processing and return control to the next step (otherwise there will be a visible time delay in the user interface).</p></div></div></div><HR><p class="copyright">Copyright &copy; 2002-2008
</pre></li></ol></div><p>Note: Non-interactive steps will not appear in the Progress Bar! Therefore, your submitters will not even know they are there. However, because they are not visible to your users, you should make sure that your non-interactive step does not take a large amount of time to finish its processing and return control to the next step (otherwise there will be a visible time delay in the user interface).</p></div></div></div><HR><p class="copyright">Copyright &copy; 2002-2009
<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">

2
dspace/docs/html/ch12.html
View File

@@ -1,4 +1,4 @@
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;12.&nbsp;docbook/DRISchemaReference.html</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="ch11.html" title="Chapter&nbsp;11.&nbsp;Customizing and Configuring Submission User Interface"><link rel="next" href="ch13.html" title="Chapter&nbsp;13.&nbsp;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&nbsp;12.&nbsp;docbook/DRISchemaReference.html</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch11.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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&nbsp;12.&nbsp;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 &copy; 2002-2008
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;12.&nbsp;docbook/DRISchemaReference.html</title><meta content="DocBook XSL Stylesheets V1.74.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="ch11.html" title="Chapter&nbsp;11.&nbsp;Customizing and Configuring Submission User Interface"><link rel="next" href="ch13.html" title="Chapter&nbsp;13.&nbsp;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&nbsp;12.&nbsp;docbook/DRISchemaReference.html</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch11.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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="N14D05"></a>Chapter&nbsp;12.&nbsp;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 &copy; 2002-2009
<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">

62
dspace/docs/html/ch13.html
View File

File diff suppressed because one or more lines are too long

6
dspace/docs/html/ch14.html
View File

File diff suppressed because one or more lines are too long

6
dspace/docs/html/ch15.html
View File

@@ -1,4 +1,4 @@
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter&nbsp;15.&nbsp;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.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="ch14.html" title="Chapter&nbsp;14.&nbsp;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&nbsp;15.&nbsp;DSpace System Documentation: Appendices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch14.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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&nbsp;15.&nbsp;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.&nbsp;<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&nbsp;15.&nbsp;DSpace System Documentation: Appendices</title><meta content="DocBook XSL Stylesheets V1.74.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="ch14.html" title="Chapter&nbsp;14.&nbsp;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&nbsp;15.&nbsp;DSpace System Documentation: Appendices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch14.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<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="N168DE"></a>Chapter&nbsp;15.&nbsp;<a name="docbook-appendix.html"></a>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#N168E4">15.1. Default Dublin Core Metadata Registry</a></span></dt><dt><span class="section"><a href="ch15.html#N16E3D">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="N168E4"></a>15.1.&nbsp;<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>&sup1;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.&nbsp;<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>&sup1;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="N16E3D"></a>15.2.&nbsp;<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>
@@ -964,7 +964,7 @@
<p>mov, qt</p>
</td></tr></tbody></table></div><p>
<a name="docbook-appendix.html-note2"></a>
</p><p>&sup1; Used by system: do not remove</p></div></div><HR><p class="copyright">Copyright &copy; 2002-2008
</p><p>&sup1; Used by system: do not remove</p></div></div><HR><p class="copyright">Copyright &copy; 2002-2009
<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">

6
dspace/docs/html/index.html
View File

File diff suppressed because one or more lines are too long

2
dspace/docs/html/ix01.html
View File

@@ -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.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="ch15.html" title="Chapter&nbsp;15.&nbsp;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>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;</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 &copy; 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.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="ch15.html" title="Chapter&nbsp;15.&nbsp;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>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;</td></tr></table><hr></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a name="N172F9"></a>Index</h2></div></div></div><div class="index"></div></div><HR><p class="copyright">Copyright &copy; 2002-2009
<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">

4
dspace/docs/html/pr01.html
View File

@@ -1,8 +1,8 @@
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Preface</title><meta content="DocBook XSL Stylesheets V1.74.0" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.1 Manual"><link rel="up" href="index.html" title="DSpace 1.5.1 Manual"><link rel="prev" href="index.html" title="DSpace 1.5.1 Manual"><link rel="next" href="ch01.html" title="Chapter&nbsp;1.&nbsp;DSpace System Documentation: Introduction"></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">Preface</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="index.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N10026"></a>Preface</h2></div></div></div><p></p></div><HR><p class="copyright">Copyright &copy; 2002-2008
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Preface</title><meta content="DocBook XSL Stylesheets V1.74.3" name="generator"><link rel="home" href="index.html" title="DSpace 1.5.2 Manual"><link rel="up" href="index.html" title="DSpace 1.5.2 Manual"><link rel="prev" href="index.html" title="DSpace 1.5.2 Manual"><link rel="next" href="ch01.html" title="Chapter&nbsp;1.&nbsp;DSpace System Documentation: Introduction"></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">Preface</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="index.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N10026"></a>Preface</h2></div></div></div><p></p></div><HR><p class="copyright">Copyright &copy; 2002-2009
<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">
<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="index.html">Prev</a>&nbsp;</td><td align="center" width="20%">&nbsp;</td><td align="right" width="40%">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">DSpace 1.5.1 Manual&nbsp;</td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%">&nbsp;Chapter&nbsp;1.&nbsp;DSpace System Documentation: Introduction</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="index.html">Prev</a>&nbsp;</td><td align="center" width="20%">&nbsp;</td><td align="right" width="40%">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">DSpace 1.5.2 Manual&nbsp;</td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%">&nbsp;Chapter&nbsp;1.&nbsp;DSpace System Documentation: Introduction</td></tr></table></div></body></html>

BIN
dspace/docs/pdf/DSpace-Manual.pdf
View File

Binary file not shown.