mirror of
https://github.com/DSpace/DSpace.git
synced 2025-10-07 01:54:22 +00:00
Updated 1.5 Documentation based on decision on path names in DSpace 1.5. [dspace-source] will refer to the source of either the 'dspace-1.5.tar.gz' or the 'dspace-1.5-src.tar.gz' (which will be the two distribution options via sourceforge). Also a few other smaller documentation changes.
git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@2638 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Tim Donohue
@@ -1236,7 +1236,13 @@ The following vocabularies are currently available by default:
|
||||
|
||||
<p>Thus, if possible, it is recommeded you limit your changes to the 'layout' JSPs and the stylesheet.</P>
|
||||
|
||||
<p>The JSPs are stored in <code><i>[dspace-source]</i>/jsp</code>. Place your edited version of a JSP in the <code><i>[dspace-source]</i>/modules/dspace-jspui/src/main/webapp/</code> directory (<i>this is the replacement for the pre-1.5 <code>/jsp/local</code> directory</i>), with the same path as the original. If they exist, these will be used in preference to the distributed versions in <code><i>[dspace-source]</i>/jsp</code>. For example:</p>
|
||||
<p>The JSPs are available in one of two places:
|
||||
<ul>
|
||||
<li><code><i>[dspace-source]</i>/dspace-jspui/dspace-jspui-webapp/src/main/webapp/</code> - Only exists if you downloaded the full Source Release of DSpace</li>
|
||||
<li><code><i>[dspace-source]</i>/dspace/target/dspace-[version].dir/webapps/dspace-jspui-webapp/</code> - The location where they are copied after first building DSpace.</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>If you wish to modify a particular JSP, place your edited version in the <code><i>[dspace-source]</i>/dspace/modules/dspace-jspui/src/main/webapp/</code> directory (<i>this is the replacement for the pre-1.5 <code>/jsp/local</code> directory</i>), with the same path as the original. If they exist, these will be used in preference to the default JSPs. For example:</p>
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
@@ -1247,34 +1253,34 @@ The following vocabularies are currently available by default:
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><code><i>[dspace-source]</i>/jsp/community-list.jsp</code></td>
|
||||
<td><code><i>[jsp.dir]</i>/community-list.jsp</code></td>
|
||||
|
||||
<td><code><i>[dspace-source]</i>/modules/dspace-jspui/src/main/webapp/community-list.jsp</code></td>
|
||||
<td><code><i>[dspace-source]</i>/dspace/modules/dspace-jspui/src/main/webapp/community-list.jsp</code></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td><code><i>[dspace-source]</i>/jsp/mydspace/main.jsp</code></td>
|
||||
<td><code><i>[jsp.dir]</i>/mydspace/main.jsp</code></td>
|
||||
|
||||
<td><code><i>[dspace-source]</i>/modules/dspace-jspui/src/main/webapp/mydspace/main.jsp</code></td>
|
||||
<td><code><i>[dspace-source]</i>/dspace/modules/dspace-jspui/src/main/webapp/mydspace/main.jsp</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>Heavy use is made of a style sheet, in <code><i>[dspace-source]</i>/jsp/styles.css.jsp</code>. If you make edits, call the local version <code><i>[dspace-source]</i>/modules/dspace-jspui/src/main/webapp/styles.css.jsp</code>, and it will be used automatically in preference to the default, as described above.</p>
|
||||
<p>Heavy use is made of a style sheet, <code>styles.css.jsp</code>. If you make edits, copy the local version to <code><i>[dspace-source]</i>/dspace/modules/dspace-jspui/src/main/webapp/styles.css.jsp</code>, and it will be used automatically in preference to the default, as described above.</p>
|
||||
|
||||
<p>Fonts and colors can be easily changed using the stylesheet. The stylesheet is a JSP so that the user's browser version can be detected and the stylesheet tweaked accordingly.</p>
|
||||
|
||||
<p>The 'layout' of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs <code><i>[dspace-source]</i>/jsp/layout/header-*.jsp</code> and <code><i>[dspace-source]</i>/jsp/layout/footer-*.jsp</code>. You can provide modified versions of these (in <code><i>[dspace-source]</i>/jsp/local/layout</code>, or define more styles and apply them to pages by using the "style" attribute of the <code>dspace:layout</code> tag.</p>
|
||||
<p>The 'layout' of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs <code>/layout/header-*.jsp</code> and <code>/layout/footer-*.jsp</code>. You can provide modified versions of these (in <code><i>[dspace-source]</i>/dspace/modules/dspace-jspui/src/main/webapp/layout</code>), or define more styles and apply them to pages by using the "style" attribute of the <code>dspace:layout</code> tag.</p>
|
||||
|
||||
<p>After you've customized your JSPs, <strong>you must rebuild the DSpace Web application</strong>. If you haven't already built and installed it, follow the <a href="install.html">install</a> directions. Otherwise, follow the steps below:</p>
|
||||
|
||||
<ol>
|
||||
<li>
|
||||
<p>Rebuild the DSpace installation package by running the following command from your <code><i>[dspace-source]</i></code> directory:</p>
|
||||
<p>Rebuild the DSpace installation package by running the following command from your <code><i>[dspace-source]</i>/dspace/</code> directory:</p>
|
||||
<pre>mvn package</pre>
|
||||
</li>
|
||||
<li>
|
||||
<p>Re-install the DSpace WAR(s) to <code><i>[dspace]</i>/webapps</code> by running the following command from your <code><i>[dspace-source]</i>/target/dspace-[version].dir</code> directory:</p>
|
||||
<p>Re-install the DSpace WAR(s) to <code><i>[dspace]</i>/webapps</code> by running the following command from your <code><i>[dspace-source]</i>/dspace/target/dspace-[version].dir</code> directory:</p>
|
||||
<pre>
|
||||
ant -Dconfig=<i>[dspace]</i>/config/dspace.cfg update
|
||||
</pre>
|
||||
|
||||
@@ -30,64 +30,69 @@
|
||||
<ul>
|
||||
<li><code><i>[dspace-source]</i></code>
|
||||
<ul>
|
||||
<li><code>build.xml</code> - The Build file for Ant -- used to preform a fresh_install, upgrade, or deploy new changes.</li>
|
||||
<li><code>CHANGES</code> - Detailed list of code changes between versions.</li>
|
||||
<li><code>KNOWN_BUGS</code> - Known bugs in the current version.</li>
|
||||
<li><code>LICENSE</code> - DSpace source code license.</li>
|
||||
<li><code>README</code> - Obligatory basic information file.</li>
|
||||
<li><code>bin/</code> - Some shell and Perl scripts for running DSpace command-line tasks.</li>
|
||||
<li><code>config/</code> - Configuration files:
|
||||
<ul>
|
||||
<li><code>controlled-vocabularies/</code> - Fixed, limited vocabularies used in metadata entry</li>
|
||||
<li><code>crosswalks/</code> - Metadata crosswalks - property files or XSL stylesheets</li>
|
||||
<li><code>dspace.cfg</code> - The Main DSpace configuration file (You will need to edit this).</li>
|
||||
<li><code>dc2mods.cfg</code> - Mappings from Dublin Core metadata to <A HREF="http://www.loc.gov/standards/mods/">MODS</A> for the METS export.</li>
|
||||
<li><code>default.license</code> - The default license that users must grant when submitting items.</li>
|
||||
<li><code>dstat.cfg</code>, <code>dstat.map</code> - Configuration for statistical reports.</li>
|
||||
<li><code>input-forms.xml</code> - Submission UI metadata field configuration.</li>
|
||||
<li><code>news-side.html</code> - Text of the front-page news in the sidebar, only used in JSPUI.</li>
|
||||
<li><code>news-top.html</code> - Text of the front-page news in the top box, only used in teh JSPUI.</li>
|
||||
<li><code>emails/</code> - Text and layout templates for emails sent out by the system.</li>
|
||||
<li><code>language-packs/</code> - Contains "dictionary files" -- Java properties files that contain user interface text in different languages</li>
|
||||
<li><code>registries/</code> - <strong>Initial</strong> contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.</li>
|
||||
<li><code>templates/</code> - Configuration files for libraries and external applications (e.g. Apache, Tomcat) are kept and edited here. They can refer to properties in the main DSpace configuration - have a look at a couple. When they're updated, a command line tool fills out these files with appropriate values from dspace.cfg, and copies them to their appropriate location (hence "templates".)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>docs/</code> - DSpace system documentation. The technical documentation for functionality, installation, configuration, etc.</li>
|
||||
<li><code>etc/</code> - Miscelleanous configuration need to install DSpace that isn't really to do with system configuration - e.g. the PostgreSQL database schema, and a couple of configuration files that are used during the build process but not by the live system. Also contains the deployment descriptors (<code>web.xml</code> files) for the Web UI and OAI-PMH support <code>.war</code> files.
|
||||
<ul>
|
||||
<li><code>oracle/</code> - Versions of the database schema and updater SQL scripts for Oracle.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>modules/</code> - The Web UI modules "overlay" directory. DSpace uses Maven to automatically look here for any customizations you wish to make to DSpace Web interfaces.
|
||||
<ul>
|
||||
<li><code>dspace-jspui</code> - Contains all customizations for the JSP User Interface.
|
||||
<ul>
|
||||
<li><code>src/main/resources/</code> - The overlay for JSPUI Resources. This is the location to place any custom Messages.properties files.</li>
|
||||
<li><code>src/main/webapp/</code> - The overlay for JSPUI Web Application. This is the location to place any custom JSPs to be used by DSpace.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>dspace-lni</code> - Contains all customizations for the Lightweight Network Interface.</li>
|
||||
<li><code>dspace-oai</code> - Contains all customizations for the OAI-PMH Interface.</li>
|
||||
<li><code>dspace-xmlui</code> - Contains all customizations for the XML User Interface (aka Manakin).
|
||||
<ul>
|
||||
<li><code>src/main/webapp/</code> - The overlay for XMLUI Web Application. This is the location to place custom Themes or Configurations.
|
||||
<ul>
|
||||
<li><code>i18n/</code> - The location to place a custom version of the XMLUI's messages.xml</li>
|
||||
<li><code>themes/</code> - The location to place custom Themes for the XMLUI</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>src/</code> - Maven configurations for DSpace System. This directory contains the Maven and Ant build files for DSpace.</li>
|
||||
<li><code>target/</code> - (Only exists after building DSpace) This is the location Maven uses to build your DSpace installation package.
|
||||
<ul>
|
||||
<li><code>dspace-[version].dir</code> - The location of the DSpace Installation Package (which can then be installed by running <code>ant update</code>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<li><code>dspace/</code> - Directory which contains all build and configuration information for DSpace
|
||||
|
||||
<ul>
|
||||
<li><code>build.xml</code> - The Build file for Ant -- used to preform a fresh_install, upgrade, or deploy new changes.</li>
|
||||
<li><code>CHANGES</code> - Detailed list of code changes between versions.</li>
|
||||
<li><code>KNOWN_BUGS</code> - Known bugs in the current version.</li>
|
||||
<li><code>LICENSE</code> - DSpace source code license.</li>
|
||||
<li><code>README</code> - Obligatory basic information file.</li>
|
||||
<li><code>bin/</code> - Some shell and Perl scripts for running DSpace command-line tasks.</li>
|
||||
<li><code>config/</code> - Configuration files:
|
||||
<ul>
|
||||
<li><code>controlled-vocabularies/</code> - Fixed, limited vocabularies used in metadata entry</li>
|
||||
<li><code>crosswalks/</code> - Metadata crosswalks - property files or XSL stylesheets</li>
|
||||
<li><code>dspace.cfg</code> - The Main DSpace configuration file (You will need to edit this).</li>
|
||||
<li><code>dc2mods.cfg</code> - Mappings from Dublin Core metadata to <A HREF="http://www.loc.gov/standards/mods/">MODS</A> for the METS export.</li>
|
||||
<li><code>default.license</code> - The default license that users must grant when submitting items.</li>
|
||||
<li><code>dstat.cfg</code>, <code>dstat.map</code> - Configuration for statistical reports.</li>
|
||||
<li><code>input-forms.xml</code> - Submission UI metadata field configuration.</li>
|
||||
<li><code>news-side.html</code> - Text of the front-page news in the sidebar, only used in JSPUI.</li>
|
||||
<li><code>news-top.html</code> - Text of the front-page news in the top box, only used in teh JSPUI.</li>
|
||||
<li><code>emails/</code> - Text and layout templates for emails sent out by the system.</li>
|
||||
<li><code>language-packs/</code> - Contains "dictionary files" -- Java properties files that contain user interface text in different languages</li>
|
||||
<li><code>registries/</code> - <strong>Initial</strong> contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.</li>
|
||||
<li><code>templates/</code> - Configuration files for libraries and external applications (e.g. Apache, Tomcat) are kept and edited here. They can refer to properties in the main DSpace configuration - have a look at a couple. When they're updated, a command line tool fills out these files with appropriate values from dspace.cfg, and copies them to their appropriate location (hence "templates".)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>docs/</code> - DSpace system documentation. The technical documentation for functionality, installation, configuration, etc.</li>
|
||||
<li><code>etc/</code> - Miscelleanous configuration need to install DSpace that isn't really to do with system configuration - e.g. the PostgreSQL database schema, and a couple of configuration files that are used during the build process but not by the live system. Also contains the deployment descriptors (<code>web.xml</code> files) for the Web UI and OAI-PMH support <code>.war</code> files.
|
||||
<ul>
|
||||
<li><code>oracle/</code> - Versions of the database schema and updater SQL scripts for Oracle.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>modules/</code> - The Web UI modules "overlay" directory. DSpace uses Maven to automatically look here for any customizations you wish to make to DSpace Web interfaces.
|
||||
<ul>
|
||||
<li><code>dspace-jspui</code> - Contains all customizations for the JSP User Interface.
|
||||
<ul>
|
||||
<li><code>src/main/resources/</code> - The overlay for JSPUI Resources. This is the location to place any custom Messages.properties files.</li>
|
||||
<li><code>src/main/webapp/</code> - The overlay for JSPUI Web Application. This is the location to place any custom JSPs to be used by DSpace.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>dspace-lni</code> - Contains all customizations for the Lightweight Network Interface.</li>
|
||||
<li><code>dspace-oai</code> - Contains all customizations for the OAI-PMH Interface.</li>
|
||||
<li><code>dspace-xmlui</code> - Contains all customizations for the XML User Interface (aka Manakin).
|
||||
<ul>
|
||||
<li><code>src/main/webapp/</code> - The overlay for XMLUI Web Application. This is the location to place custom Themes or Configurations.
|
||||
<ul>
|
||||
<li><code>i18n/</code> - The location to place a custom version of the XMLUI's messages.xml</li>
|
||||
<li><code>themes/</code> - The location to place custom Themes for the XMLUI</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>src/</code> - Maven configurations for DSpace System. This directory contains the Maven and Ant build files for DSpace.</li>
|
||||
<li><code>target/</code> - (Only exists after building DSpace) This is the location Maven uses to build your DSpace installation package.
|
||||
<ul>
|
||||
<li><code>dspace-[version].dir</code> - The location of the DSpace Installation Package (which can then be installed by running <code>ant update</code>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -134,7 +134,7 @@
|
||||
or user interfaces, using basic pre-built interface "overlays". However, it will not allow you to customize or change the
|
||||
underlying DSpace Java API, as <em>all Java code comes pre-compiled.</em></li>
|
||||
<li><strong>This method is highly recommended for those who are new to DSpace,
|
||||
may not have available technical staff for DSpace at their institutions,
|
||||
may not have as much technical staff for DSpace at their institutions,
|
||||
or do not wish to make changes to the underlying DSpace Java API.</strong></li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -201,13 +201,16 @@ of them in order to install DSpace, you do need to know they exist and also know
|
||||
<PRE>useradd -m dspace</PRE>
|
||||
</li>
|
||||
<li>
|
||||
<P>Download the <A HREF="http://sourceforge.net/projects/dspace/">latest DSpace source code</A> and unpack it
|
||||
into a temporary location. It is not necessary to keep this directory around after you install DSpace.</P>
|
||||
<P>Download the <A HREF="http://sourceforge.net/projects/dspace/">latest DSpace release</A> and unpack it.
|
||||
Although there are two available releases (<code>dspace-1.x.tar.gz</code> and <code>dspace-1.x-src.tar.gz</code>),
|
||||
you only need to choose one. If you want a copy of all underlying Java source code, you should download
|
||||
the <code>dspace-1.x-src.tar.gz</code> release.
|
||||
</P>
|
||||
|
||||
<PRE>gunzip -c dspace-1.x.tar.gz | tar -xf -</PRE>
|
||||
|
||||
<P>For ease of reference, we will refer to the location of this unzipped version
|
||||
of the DSpace installation package as <code><i>[dspace-source]</i> in the
|
||||
of the DSpace release as <code><i>[dspace-source]</i> in the
|
||||
remainder of these instructions.</code>
|
||||
|
||||
</P>
|
||||
@@ -220,7 +223,7 @@ of them in order to install DSpace, you do need to know they exist and also know
|
||||
<ol type="i">
|
||||
<li>
|
||||
<p><a name="pgdriver"></a>Copy the PostgreSQL JDBC driver (<code>.jar</code> file) into
|
||||
<code><i>[dspace-source]</i>/lib</code>. If you compiled PostgreSQL yourself, it'll be in <code>postgresql-7.x.x/src/interfaces/jdbc/jars/postgresql.jar</code>. Alternatively you can download it directly from <a href="http://jdbc.postgresql.org/download.html">the PostgreSQL JDBC site</a>. Make sure you get the recommended driver for the version of PostgreSQL you're running.</p></li>
|
||||
<code><i>[dspace-source]</i>/dspace/lib</code>. If you compiled PostgreSQL yourself, it'll be in <code>postgresql-7.x.x/src/interfaces/jdbc/jars/postgresql.jar</code>. Alternatively you can download it directly from <a href="http://jdbc.postgresql.org/download.html">the PostgreSQL JDBC site</a>. Make sure you get the recommended driver for the version of PostgreSQL you're running.</p></li>
|
||||
<li>
|
||||
<p>Create a <code>dspace</code> database, owned by the <code>dspace</code> PostgreSQL user:</p>
|
||||
|
||||
@@ -233,21 +236,21 @@ createdb -U dspace -E UNICODE dspace</pre>
|
||||
<p><strong>Oracle:</strong>
|
||||
<ol type="i">
|
||||
<li>
|
||||
<p>Copy the Oracle JDBC driver into <code><i>[dspace-source]</i>/lib</code>.</p>
|
||||
<p>Copy the Oracle JDBC driver into <code><i>[dspace-source]</i>/dspace/lib</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is suggested that the Oracle database use the same character set. Create a user account for DSpace (e.g. <code>dspace</code>,) and ensure that it has permissions to add and remove tables in the database.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Edit the config/dspace.cfg file in your source directory for the following settings:</p>
|
||||
<p>Edit the <code><i>[dspace-source]</i>/dspace/config/dspace.cfg</code> database settings:</p>
|
||||
<pre>db.name = oracle
|
||||
db.url = jdbc.oracle.thin:@//host:port/dspace
|
||||
db.driver = oracle.jdbc.OracleDriver</pre>
|
||||
</li>
|
||||
<li>
|
||||
<p>Go to <code><i>[dspace-source]</i>/etc/oracle</code> and copy the contents to their parent directory, overwriting the versions in the parent:
|
||||
<p>Go to <code><i>[dspace-source]</i>/dspace/etc/oracle</code> and copy the contents to their parent directory, overwriting the versions in the parent:
|
||||
|
||||
<pre>cd [dspace-source]/etc/oracle
|
||||
<pre>cd [dspace-source]/dspace/etc/oracle
|
||||
cp * ..</pre>
|
||||
<p>You now have Oracle-specific <code>.sql</code> files in your <code>etc</code> directory, and your dspace.cfg is modified to point to your Oracle database.</p>
|
||||
</li>
|
||||
@@ -255,7 +258,7 @@ cp * ..</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<P>Edit <code><i>[dspace-source]</i>/config/dspace.cfg</code>, in particular you'll need to set these properties:
|
||||
<P>Edit <code><i>[dspace-source]</i>/dspace/config/dspace.cfg</code>, in particular you'll need to set these properties:
|
||||
|
||||
<br><code>dspace.dir</code> -- must be set to the <code>[dspace]</code> (installation) directory.
|
||||
|
||||
@@ -298,8 +301,8 @@ chown dspace <i>[dspace]</i></PRE>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<P>As the <code>dspace</code> UNIX user, generate the DSpace installation package in the <code><i>[dspace-source]</i>/target/dspace-[version].dir/</code> directory:</P>
|
||||
<pre>cd <i>[dspace-source]</i>
|
||||
<P>As the <code>dspace</code> UNIX user, generate the DSpace installation package in the <code><i>[dspace-source]</i>/dspace/target/dspace-[version].dir/</code> directory:</P>
|
||||
<pre>cd <i>[dspace-source]</i>/dspace/
|
||||
mvn package</pre>
|
||||
|
||||
<P>Note: without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If you want to use Oracle instead,
|
||||
@@ -310,7 +313,7 @@ mvn package</pre>
|
||||
<li>
|
||||
<P>As the <code>dspace</code> UNIX user, initialize the DSpace database and install DSpace to <code><i>[dspace]</i></code>:</P>
|
||||
|
||||
<pre>cd <i>[dspace-source]</i>/target/dspace-[version].dir/
|
||||
<pre>cd <i>[dspace-source]</i>/dspace/target/dspace-[version].dir/
|
||||
ant fresh_install</pre>
|
||||
|
||||
<P><strong>Note:</strong> to see a complete list of build targets, run</P>
|
||||
@@ -378,36 +381,36 @@ cp -r <i>[dspace]</i>/webapps/dspace-oai <i>[tomcat]</i>/webapps</PRE>
|
||||
<PRE>useradd -m dspace</PRE>
|
||||
</li>
|
||||
<li>
|
||||
<P>Create the parent directory for the DSpace modules to reside (i.e. <code>[dspace-parent]</code>). As <em>root</em> (or a user with appropriate permissions), run:</P>
|
||||
<P>Create the source directory for the DSpace modules to reside (i.e. <code>[dspace-source]</code>). As <em>root</em> (or a user with appropriate permissions), run:</P>
|
||||
|
||||
<PRE>mkdir <i>[dspace-parent]</i>
|
||||
chown dspace <i>[dspace-parent]</i></PRE>
|
||||
<PRE>mkdir <i>[dspace-source]</i>
|
||||
chown dspace <i>[dspace-source]</i></PRE>
|
||||
|
||||
<P>(Assuming the <code>dspace</code> UNIX username.)</P>
|
||||
</li>
|
||||
<li>
|
||||
<P>Checkout the DSpace Source code from SourceForge SVN into <code>[dspace-parent]</code>. For example:</P>
|
||||
<P>Checkout the DSpace Source code from SourceForge SVN into <code>[dspace-source]</code>. For example:</P>
|
||||
|
||||
<PRE>svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5 [dspace-parent]</PRE>
|
||||
<PRE>svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5 [dspace-source]</PRE>
|
||||
|
||||
<P>If you wish, you can choose to <em>only</em> checkout the source code for the specific DSpace "modules"
|
||||
which you want to install. However, you must <em>always</em> checkout the <code>'dspace'</code> module, as
|
||||
it is the module which builds DSpace. For example, if you only want to install the XML-UI and the OAI-PMH interface
|
||||
you can perform the following checkouts:</P>
|
||||
|
||||
<PRE>svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace [dspace-parent]
|
||||
svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-xmlui [dspace-parent]
|
||||
svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-oai [dspace-parent]
|
||||
<PRE>svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace [dspace-source]
|
||||
svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-xmlui [dspace-source]
|
||||
svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-oai [dspace-source]
|
||||
</PRE>
|
||||
|
||||
<P>In order, you are checking out the <code>'dspace'</code> module (builds DSpace),
|
||||
<code>'dspace-xmlui'</code> module (provides XML-UI), and <code>'dspace-oai'</code> module (provides OAI-PMH).</P>
|
||||
|
||||
<P>In the end, you should have a folder structure similar to the following in <code><i>[dspace-parent]</i></code>:
|
||||
<P>In the end, you should have a folder structure similar to the following in <code><i>[dspace-source]</i></code>:
|
||||
<ul>
|
||||
<li><code><i>[dspace-parent]</i></code>
|
||||
<li><code><i>[dspace-source]</i></code>
|
||||
<ul>
|
||||
<li><code>dspace/</code> - DSpace 'build' and configuration module (this is what is normally referred to as <code><i>[dspace-source]</i></code>)</li>
|
||||
<li><code>dspace/</code> - DSpace 'build' and configuration module</li>
|
||||
<li><code>dspace-api/</code> - DSpace Java API module</li>
|
||||
<li><code>dspace-jspui/</code> - DSpace JSP-UI module</li>
|
||||
<li><code>dspace-oai/</code> - DSpace OAI-PMH interface module</li>
|
||||
@@ -417,33 +420,18 @@ svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<P>Build your custom DSpace installation package (from within the <code>'dspace'</code> module)</P>
|
||||
|
||||
<PRE>cd [dspace-parent]/dspace/
|
||||
mvn package</PRE>
|
||||
|
||||
<P>Note: without any extra arguments, DSpace is built for PostgreSQL. If you want to use Oracle instead,
|
||||
you should build DSpace as follows:</P>
|
||||
|
||||
<PRE>mvn -Ddb.name=oracle package</PRE>
|
||||
</li>
|
||||
<li>
|
||||
<P>Building DSpace may take awhile. But, once it is complete, you should have your
|
||||
custom DSpace installation package ready in your
|
||||
<code><i>[dspace-parent]</i>/dspace/target/dspace-[version].dir/</code> directory.</P>
|
||||
<P>Note: Although we won't go into this in detail, you can also create your own
|
||||
completely custom Maven-based modules in your <code><i>[dspace-parent]</i></code> directory.
|
||||
<P>Note: Although we won't go into this in detail, you can also create your own
|
||||
completely custom Maven-based modules in your <code><i>[dspace-source]</i></code> directory.
|
||||
To build your custom modules into DSpace, you would need to modify the <code>'dspace'</code>
|
||||
module's <code>pom.xml</code> (Project Object Model) to look for those custom modules, and
|
||||
then re-build your DSpace installation package. Look
|
||||
at the <a href="http://maven.apache.org/">Maven Documentation</a> or
|
||||
<a href="http://wiki.dspace.org/">DSpace Wiki</a> for more hints and tricks.</P>
|
||||
</li>
|
||||
<li><P>Once your DSpace installation package has been built, you can follow the steps in the
|
||||
<A href="#installsteps">Quick Installation Method</A> above to finish installing and configure DSpace.
|
||||
Just remember that you can <em>skip</em> downloading the DSpace Source Code from
|
||||
SourceForge. In addition, remember that your <code><i>[dspace-parent]</i>/dspace</code> module is
|
||||
the <i>same</i> as what is referred to as <code><i>[dspace-source]</i></code></P>
|
||||
<li><P>Once you've downloaded the appropriate DSpace modules into <code><i>[dspace-source]</i></code>, you can follow the steps in the
|
||||
<A href="#installsteps">Quick Installation Method</A> above to finish installing and configuring DSpace.
|
||||
Just remember that you can <em>skip</em> downloading the Latest DSpace Release from
|
||||
SourceForge, as you've already downloaded it via Maven.</P>
|
||||
</li>
|
||||
</ol>
|
||||
</P>
|
||||
@@ -726,7 +714,7 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
|
||||
<P>A Handle server runs as a separate process that receives TCP requests from other Handle servers, and issues resolution requests to a global server or servers if a Handle entered locally does not correspond to some local content. The Handle protocol is based on TCP, so it will need to be installed on a server that can broadcast and receive TCP on port 2641.</P>
|
||||
|
||||
<P>The Handle server code is included with the DSpace code in
|
||||
<code><i>[dspace-source]</i>/lib/handle.jar</code>. <strong>Note:</strong> The latest version of the <code>handle.jar</code> file is not included in the release due to licensing conditions changing between the provided version and later versions. It is recommended you read the <a href="http://www.handle.net/upgrade_6-2_DSpace.html">new license conditions</a> and decide whether you wish to update your installation's <code>handle.jar</code>. If you decide to update, you should replace the existing <code>handle.jar</code> in <i>[dspace-source]</i>/lib with the new version and rebuild your war files.</p>
|
||||
<code><i>[dspace]</i>/lib/handle.jar</code>. <strong>Note:</strong> The latest version of the <code>handle.jar</code> file is not included in the release due to licensing conditions changing between the provided version and later versions. It is recommended you read the <a href="http://www.handle.net/upgrade_6-2_DSpace.html">new license conditions</a> and decide whether you wish to update your installation's <code>handle.jar</code>. If you decide to update, you should replace the existing <code>handle.jar</code> in <i>[dspace]</i>/lib with the new version and rebuild your war files.</p>
|
||||
<p>A script exists to create a simple Handle configuration - simply run <code><i>[dspace]</i>/bin/make-handle-config</code> after you've set the appropriate parameters in <code>dspace.cfg</code>. You can also create a Handle configuration directly by following the <A HREF="http://www.handle.net/hs_manual_18jan02/server_manual_2.html">installation instructions on handle.net</A>, but with these changes:</P>
|
||||
|
||||
<UL>
|
||||
@@ -805,13 +793,13 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
|
||||
|
||||
<p><ol>
|
||||
<li><p>Download the DSpace source from <a href="http://sourceforge.net/projects/dspace">SourceForge</a> and untar it (<a href="http://www.winzip.com/">WinZip</a> will do this)</p></li>
|
||||
<li><p>Copy the PostgreSQL JDBC driver across to the DSpace source tree. The drivers will be in <code>C:\Program Files\PostgreSQL\8.x\jdbc\</code>. The <code>postgresql-8.x-yyy.jdbc2.jar</code> is the jar file you need. Copy it to <code>[dspace-source]/lib</code>.</p></li>
|
||||
<li><p>Copy the PostgreSQL JDBC driver across to the DSpace source tree. The drivers will be in <code>C:\Program Files\PostgreSQL\8.x\jdbc\</code>. The <code>postgresql-8.x-yyy.jdbc2.jar</code> is the jar file you need. Copy it to <code>[dspace]/lib</code>.</p></li>
|
||||
<li><p>Ensure the PostgreSQL service is running, and then run pgAdmin III (Start -> PostgreSQL 8.0 -> pgAdmin III). Connect to the local database as the postgres user and:
|
||||
<ul>
|
||||
<li>Create a 'Login Role' (user) called <code>dspace</code> with the password <code>dspace</code></li>
|
||||
<li>Create a database called <code>dspace</code> owned by the user <code>dspace</code>, with UTF-8 encoding
|
||||
</ul></p></li>
|
||||
<li><p>Update paths in <code>[dspace-source]\config\dspace.cfg</code>. <strong>Note:</strong> Use forward slashes / for path separators, though you can still use drive letters, e.g.:
|
||||
<li><p>Update paths in <code>[dspace-source]\dspace\config\dspace.cfg</code>. <strong>Note:</strong> Use forward slashes / for path separators, though you can still use drive letters, e.g.:
|
||||
<p><code>dspace.dir = C:/DSpace</code><p>
|
||||
Make sure you change all of the parameters with file paths to suit, specifically:
|
||||
<p><pre>
|
||||
@@ -830,7 +818,20 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
|
||||
<li><p>Run:<p><code>ant fresh_install</code></p></p></li>
|
||||
<li><p>Create an administrator account, e.g. assuming <code>C:\dspace</code> is where your DSpace installation is:<p><code>C:\dspace\bin\dsrun org.dspace.administer.CreateAdministrator</code></p>
|
||||
<p>and enter the required information</p></p></li>
|
||||
<li><p>Copy the <code>.war</code> Web application files from <code>[dspace-source]\build</code> to Tomcat's webapps dir, which should be somewhere like <code>C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps</code></p></li>
|
||||
<li><p>Copy the Web application directories from <code>[dspace]\webapps\</code> to Tomcat's webapps dir, which should be somewhere like <code>C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps</code></p>
|
||||
<ul>
|
||||
<li><P>Alternatively, Tell your Tomcat installation where to find your DSpace web application(s).
|
||||
As an example, in the <code><Host></code> section of your <code><em>[tomcat]</em>/conf/server.xml</code> you could add lines similar to the following
|
||||
(but replace <code><em>[dspace]</em></code> with your installation location):</P>
|
||||
|
||||
<PRE><!-- DEFINE A CONTEXT PATH FOR DSpace JSP User Interface -->
|
||||
<Context path="/dspace-jspui" docBase="[dspace]\webapps\dspace-jspui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>
|
||||
|
||||
<!-- DEFINE A CONTEXT PATH FOR DSpace OAI User Interface -->
|
||||
<Context path="/dspace-oai" docBase="[dspace]\webapps\dspace-oai" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/></PRE>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p>Start the Tomcat service</p></li>
|
||||
<li><p>Browse <code>http://localhost:8080/dspace</code>. You should see the DSpace home page</p></li>
|
||||
</ol></p>
|
||||
|
||||
@@ -24,15 +24,15 @@
|
||||
|
||||
<p>All calls to the <code>Database Manager</code> require a <a href="business.html#core">DSpace <code>Context</code> object</a>. Example use of the database manager API is given in the <code>org.dspace.storage.rdbms</code> package Javadoc.</p>
|
||||
|
||||
<p>The database schema used by DSpace (for PostgreSQL) is stored in <code><i>[dspace-source]</i>/etc/database_schema.sql</code> 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.</p>
|
||||
<p>The database schema used by DSpace (for PostgreSQL) is stored in <code><i>[dspace-source]</i>/dspace/etc/database_schema.sql</code> 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.</p>
|
||||
|
||||
<P>Also in <code><i>[dspace-source]</i>/etc</code> are various SQL files called <code>database_schema_1x_1y</code>. These contain the necessary SQL commands to update a live DSpace database from version 1.<code>x</code> to 1.<code>y</code>. Note that this might not be the only part of an upgrade process: see <a href="update.html">Updating a DSpace Installation</a> for details.</P>
|
||||
<P>Also in <code><i>[dspace-source]</i>/dspace/etc</code> are various SQL files called <code>database_schema_1x_1y</code>. These contain the necessary SQL commands to update a live DSpace database from version 1.<code>x</code> to 1.<code>y</code>. Note that this might not be the only part of an upgrade process: see <a href="update.html">Updating a DSpace Installation</a> for details.</P>
|
||||
|
||||
<p>The DSpace database code uses an SQL function <code>getnextid</code> 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 <code>SEQUENCES</code> for each table in order to create new IDs. If an alternative database backend were to be used, the implementation of <code>getnextid</code> could be updated to operate with that specific DBMS.</p>
|
||||
|
||||
<p>The <code>etc</code> directory in the source distribution contains two further SQL files. <code>clean-database.sql</code> contains the SQL necessary to completely clean out the database, so use with caution! The Ant target <code>clean_database</code> can be used to execute this. <code>update-sequences.sql</code> contains SQL to reset the primary key generation sequences to appropriate values. You'd need to do this if, for example, you'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.</p>
|
||||
|
||||
<P>Versions of the <code>*.sql*</code> files for Oracle are stored in <code><i>[dspace-source]</i>/etc/oracle</code>. These need to be copied over their PostgreSQL counterparts in <code><i>[dspace-source]</i>/etc</code> prior to installation.</P>
|
||||
<P>Versions of the <code>*.sql*</code> files for Oracle are stored in <code><i>[dspace-source]</i>/dspace/etc/oracle</code>. These need to be copied over their PostgreSQL counterparts in <code><i>[dspace-source]</i>/dspace/etc</code> prior to installation.</P>
|
||||
|
||||
<h3>Maintenance and Backup</h3>
|
||||
|
||||
@@ -55,9 +55,9 @@ DELETE FROM epersongroup;
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>After restoring a backup, you will need to reset the primary key generation sequences so that they do not produce already-used primary keys. Do this by executing the SQL in <code><i>[dspace-source]</i>/etc/update-sequences.sql</code>, for example with:</p>
|
||||
<p>After restoring a backup, you will need to reset the primary key generation sequences so that they do not produce already-used primary keys. Do this by executing the SQL in <code><i>[dspace-source]</i>/dspace/etc/update-sequences.sql</code>, for example with:</p>
|
||||
<pre>
|
||||
psql -U dspace -f <i>[dspace-source]</i>/etc/update-sequences.sql
|
||||
psql -U dspace -f <i>[dspace-source]</i>/dspace/etc/update-sequences.sql
|
||||
</pre>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -31,8 +31,8 @@
|
||||
<a name="configurationFile" id="configurationFile"></a>
|
||||
<H2>Understanding the Submission Configuration File</H2>
|
||||
|
||||
<p>The <code>[dspace]/config/item-submission.xml</code> contains the submission configurations for <em>both</em> the DSpace JSP user interface (JSP-UI) or the DSpace XML user interface
|
||||
(XML-UI or Manakin). This configuration file contains detailed documentation within the file itself,
|
||||
<p>The <code>[dspace]/config/item-submission.xml</code> contains the submission configurations for <em>both</em> 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>
|
||||
|
||||
@@ -159,8 +159,8 @@
|
||||
<a name="stepStructure" id="stepStructure"></a>
|
||||
<H4>Structure of the <step> Definition</H4>
|
||||
|
||||
<p>The same <step> definition is used by both the DSpace JSP user interface (JSP-UI) an the DSpace XML user interface
|
||||
(XML-UI or Manakin). Therefore, you will notice each <step> definition contains information
|
||||
<p>The same <step> definition is used by both the DSpace JSP user interface (JSPUI) an the DSpace XML user interface
|
||||
(XMLUI or Manakin). Therefore, you will notice each <step> definition contains information
|
||||
specific to each of these two interfaces.</p>
|
||||
|
||||
<p>The structure of the <step> Definition is as follows:
|
||||
@@ -180,13 +180,13 @@
|
||||
<DL>
|
||||
<DT><STRONG><CODE>heading</CODE></STRONG></DT>
|
||||
|
||||
<DD>Partial I18N key (defined in <code>Messages.properties</code> for JSP-UI or <code>messages.xml</code> for XML-UI) which corresponds to
|
||||
<DD>Partial I18N key (defined in <code>Messages.properties</code> for JSPUI or <code>messages.xml</code> for XMLUI) which corresponds to
|
||||
the text that should be displayed in the submission Progress Bar for this step.
|
||||
This partial I18N key is prefixed within either the Messages.properties or messages.xml file, depending on the interface you are using.
|
||||
Therefore, to find the actual key, you will need to search for the partial key with the following prefix:
|
||||
<ul>
|
||||
<li>XML-UI: prefix is <code>xmlui.Submission.</code> (e.g. "xmlui.Submission.submit.progressbar.describe" for 'Describe' step)</li>
|
||||
<li>JSP-UI: prefix is <code>jsp.</code> (e.g. "jsp.submit.progressbar.describe" for 'Describe' step)</li>
|
||||
<li>XMLUI: prefix is <code>xmlui.Submission.</code> (e.g. "xmlui.Submission.submit.progressbar.describe" for 'Describe' step)</li>
|
||||
<li>JSPUI: prefix is <code>jsp.</code> (e.g. "jsp.submit.progressbar.describe" for 'Describe' step)</li>
|
||||
</ul>
|
||||
<em>The 'heading' need not be defined if the step should not appear in the progress bar
|
||||
(e.g. steps which perform automated processing, i.e. non-interactive, should not appear
|
||||
@@ -196,26 +196,26 @@
|
||||
<DT><STRONG><CODE>processing-class</CODE></STRONG> <EM>(Required)</EM></DT>
|
||||
|
||||
<DD>Full Java path to the Processing Class for this Step. This Processing Class
|
||||
<em>must</em> perform the primary processing of any information gathered in this step, <em>for both the XML-UI and JSP-UI</em>.
|
||||
<em>must</em> perform the primary processing of any information gathered in this step, <em>for both the XMLUI and JSPUI</em>.
|
||||
All valid step processing classes must extend the abstract `<code>org.dspace.submit.AbstractProcessingStep</code>` class
|
||||
(or alternatively, extend one of the pre-existing step processing classes in
|
||||
<code>org.dspace.submit.step.*</code>)</DD>
|
||||
|
||||
<DT><STRONG><CODE>jspui-binding</CODE></STRONG></DT>
|
||||
|
||||
<DD>Full Java path of the JSP-UI "binding" class for this Step. This "binding" class
|
||||
<DD>Full Java path of the JSPUI "binding" class for this Step. This "binding" class
|
||||
should initialize and call the appropriate JSPs to display the step's user interface. A valid
|
||||
JSP-UI "binding" class <em>must</em> extend the abstract `<code>org.dspace.app.webui.submit.JSPStep</code>` class.
|
||||
<em>This property need not be defined if you are using the XML-UI interface, or for steps which
|
||||
JSPUI "binding" class <em>must</em> extend the abstract `<code>org.dspace.app.webui.submit.JSPStep</code>` class.
|
||||
<em>This property need not be defined if you are using the XMLUI interface, or for steps which
|
||||
only perform automated processing, i.e. non-interactive steps.</em>
|
||||
</DD>
|
||||
|
||||
<DT><STRONG><CODE>xmlui-binding</CODE></STRONG></DT>
|
||||
|
||||
<DD>Full Java path of the XML-UI "binding" class for this Step. This "binding" class
|
||||
<DD>Full Java path of the XMLUI "binding" class for this Step. This "binding" class
|
||||
should generate the Manakin XML (DRI document) necessary to generate the step's user interface. A valid
|
||||
XML-UI "binding" class <em>must</em> extend the abstract `<code>org.dspace.app.xmlui.submission.AbstractSubmissionStep</code>` class.
|
||||
<em>This property need not be defined if you are using the JSP-UI interface, or for steps which
|
||||
XMLUI "binding" class <em>must</em> extend the abstract `<code>org.dspace.app.xmlui.submission.AbstractSubmissionStep</code>` class.
|
||||
<em>This property need not be defined if you are using the JSPUI interface, or for steps which
|
||||
only perform automated processing, i.e. non-interactive steps.</em>
|
||||
</DD>
|
||||
|
||||
@@ -616,7 +616,7 @@
|
||||
<P>The <em>Upload</em> step in the DSpace submission process has two configuration options
|
||||
which can be set with your <code>[dspace]/config/dspace.cfg</code> configuration file. They are as follows:</P>
|
||||
<UL>
|
||||
<LI><code>upload.max</code> - The maximum size of a file (in bytes) that can be uploaded from the JSP-UI (not applicable for the XML-UI). It defaults to 536870912 bytes (512MB). You may set this to -1 to disable any file size limitation.
|
||||
<LI><code>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.
|
||||
<UL><LI><em>Note:</em> Increasing this value or setting to -1 does <strong>not</strong> 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.</LI></UL>
|
||||
</LI>
|
||||
<LI><code>webui.submit.upload.required</code> - Whether or not all users are <em>required</em> 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.</LI>
|
||||
@@ -638,14 +638,14 @@
|
||||
<code>org.dspace.submit.AbstractProcessingStep</code> class and
|
||||
implement all methods defined by that abstract class.</li>
|
||||
<li>This class should be built in such a way that it can process the
|
||||
input gathered from <em>either</em> the XML-UI or JSP-UI interface.</li>
|
||||
input gathered from <em>either</em> the XMLUI or JSPUI interface.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>(<em>For steps using JSP-UI</em>) Create the JSPs to display
|
||||
the user interface. Create a new JSP-UI "binding" class to initialize
|
||||
<li>(<em>For steps using JSPUI</em>) Create the JSPs to display
|
||||
the user interface. Create a new JSPUI "binding" class to initialize
|
||||
and call these JSPs.</li>
|
||||
<ul>
|
||||
<li>Your JSP-UI "binding" class must extend the abstract class <code>org.dspace.app.webui.submit.JSPStep</code>
|
||||
<li>Your JSPUI "binding" class must extend the abstract class <code>org.dspace.app.webui.submit.JSPStep</code>
|
||||
and implement all methods defined there. It's recommended to use one
|
||||
of the classes in <code>org.dspace.app.webui.submit.step.*</code> as a reference.</li>
|
||||
<li>Any JSPs created should be loaded by calling the showJSP() method of
|
||||
@@ -654,11 +654,11 @@
|
||||
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>review-<em>[step]</em>.jsp</code>) in the
|
||||
<code><em>[dspace-source]</em>/jsp/submit</code> directory.</li>
|
||||
of Review JSPs (named similar to <code>review-<em>[step]</em>.jsp</code>) in the JSP
|
||||
<code>submit/</code> directory.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>(<em>For steps using XML-UI</em>) Create an XML-UI "binding" Step Transformer
|
||||
<li>(<em>For steps using XMLUI</em>) Create an XMLUI "binding" Step Transformer
|
||||
which will generate the DRI XML which Manakin requires.
|
||||
<ul>
|
||||
<li>The Step Transformer must extend and implement
|
||||
@@ -670,10 +670,8 @@
|
||||
</li>
|
||||
<li>(<strong>Required</strong>) Add a valid Step Definition to the <code>item-submission.xml</code> configuration file.
|
||||
<ul>
|
||||
<li>This may also require that you add an I18N key for this
|
||||
step's <code>heading</code> to
|
||||
the <code><em>[dspace-source]</em>/config/language-packs/Messages.properties</code> (for JSP UI) or
|
||||
<code><em>[manakin-source]</em>/config/i18n/messages.xml</code> (for Manakin XML UI) properties files.</li>
|
||||
<li>This may also require that you add an I18N (Internationalization) key for this
|
||||
step's <code>heading</code>. See the sections on <a href="configure.html#jspui-multilingual">Configuring Multilingual Support for JSPUI</a> or <a href="configure.html#xmlui-multilingual">Configuring Multilingual Support for XMLUI</a> for more details.</li>
|
||||
<li>For more information on <code><step></code> definitions
|
||||
within the <code>item-submission.xml</code>, see the section above
|
||||
on <a href="#stepDefinitions">Defining Steps (<code><step></code>) within the <CODE>item-submission.xml</CODE></a>.
|
||||
|
||||
@@ -41,10 +41,10 @@
|
||||
<li><b>Build DSpace</b>
|
||||
<p>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 <a href="file:///Users/scott/Development/Workspaces/DSpace1.5/dspace-1.5/dspace/docs/install.html">Installation section</a> for more information on building DSpace using the new maven-based build system. Run the following commands to compile DSpace.</p>
|
||||
<pre>
|
||||
cd [dspace-source];
|
||||
cd [dspace-source]/dspace/;
|
||||
mvn package
|
||||
</pre>
|
||||
<p>You will find the result in <code>[dspace-source]/target/dspace-1.5-build.dir/</code>; inside this directory is the compiled binary distribution of DSpace.</p>
|
||||
<p>You will find the result in <code>[dspace-source]/dspace/target/dspace-1.5-build.dir/</code>; inside this directory is the compiled binary distribution of DSpace.</p>
|
||||
</li>
|
||||
|
||||
|
||||
@@ -133,7 +133,7 @@ event.consumer.eperson.filters = EPerson+Create
|
||||
<li><b>Add <code>xmlui.xconf</code> Manakin configuration</b>
|
||||
<p>The new Manakin user interface available with DSpace 1.5 requires an extra configuration file that you will need to manually copy over to your configuration directory. </p>
|
||||
<pre>
|
||||
cp [dspace-source]/config/xmlui.xconf [dspace]/config/xmlui.xconf
|
||||
cp [dspace-source]/dspace/config/xmlui.xconf [dspace]/config/xmlui.xconf
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
@@ -143,10 +143,10 @@ cp [dspace-source]/config/xmlui.xconf [dspace]/config/xmlui.xconf
|
||||
<p>The database schema needs updating. SQL files contain the relevant updates are provided, note if you have made any local customizations to the database schema you should consult these updates and make sure they will work for you.</p>
|
||||
<ul>
|
||||
<li>For PostgreSQL
|
||||
<p><code>psql -U [dspace-user] -f [dspace-source]/etc/database_schema_14-15.sql [database-name]</code></p>
|
||||
<p><code>psql -U [dspace-user] -f [dspace-source]/dspace/etc/database_schema_14-15.sql [database-name]</code></p>
|
||||
</li>
|
||||
<li>For Oracle
|
||||
<p><code>[dspace-source]/etc/oracle/database_schema_142-15.sql</code> contains the
|
||||
<p><code>[dspace-source]/dspace/etc/oracle/database_schema_142-15.sql</code> contains the
|
||||
commands necessary to upgrade your database schema on oracle.</p>
|
||||
</li></ul></li>
|
||||
|
||||
@@ -154,7 +154,7 @@ commands necessary to upgrade your database schema on oracle.</p>
|
||||
|
||||
<li><b>Apply any customizations</b>
|
||||
<p>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 "JSP" pages located inside the <code>[dspace 1.4.2]/jsp/local</code> directory. These should be moved
|
||||
<code>[dspace-source]/modules/dspace-jspui/src/main/webapp/</code> in the new build structure. See <a href="file:///Users/scott/Development/Workspaces/DSpace1.5/dspace-1.5/dspace/docs/configure.html#jspui-jsp">Customizing the JSP Pages</a> for more information.
|
||||
<code>[dspace-source]/dspace/modules/dspace-jspui/src/main/webapp/</code> in the new build structure. See <a href="file:///Users/scott/Development/Workspaces/DSpace1.5/dspace-1.5/dspace/docs/configure.html#jspui-jsp">Customizing the JSP Pages</a> for more information.
|
||||
</li>
|
||||
|
||||
|
||||
@@ -162,9 +162,9 @@ commands necessary to upgrade your database schema on oracle.</p>
|
||||
|
||||
|
||||
<li><b>Update DSpace</b>
|
||||
<p> Update the DSpace installed directory with new code and libraries. Inside the <code>[dspace-source]/target/dspace-1.5-build.dir/</code> directory run:</p>
|
||||
<p> Update the DSpace installed directory with new code and libraries. Inside the <code>[dspace-source]/dspace/target/dspace-1.5-build.dir/</code> directory run:</p>
|
||||
<pre>
|
||||
cd [dspace-source]/target/dspace-1.5-build.dir/;
|
||||
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/;
|
||||
ant -Dconfig=[dspace]/config/dspace.cfg update
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user