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

Final release for 1.7

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5983 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Jeffrey Trimble
2010-12-16 17:00:17 +00:00
parent 98ecece84d
commit 9e54e648d0
3 changed files with 1961 additions and 1747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

276
dspace/docs/html/XMLUI Configuration and Customization.html
View File

@@ -16,12 +16,36 @@
</span>
</div>
<div class="pagesubheading">
This page last changed on Apr 24, 2010 by <font color="#0050B2">mdiggory</font>.
This page last changed on Dec 15, 2010 by <font color="#0050B2">bram</font>.
</div>
<h1><a name="XMLUIConfigurationandCustomization-DSpaceSystemDocumentation%3AManakin%5CXMLUI%5CConfigurationandCustomization"></a>DSpace System Documentation: Manakin [XMLUI] Configuration and Customization</h1>
<p>The DSpace digital repository supports two user interfaces: one based on JavaServer Pages (JSP) technologies and one based upon the Apache Cocoon framework. This chapter describes those parameters which are specific to the Manakin (XMLUI) interface based upon the Cocoon framework.</p>
<p>The DSpace digital repository supports two user interfaces: one based on JavaServer Pages (JSP) technologies and one based upon the Apache Cocoon framework (XMLUI). This chapter describes those parameters which are specific to the Manakin (XMLUI) interface based upon the Cocoon framework.</p>
<style type='text/css'>/*<![CDATA[*/
div.rbtoc1292428718703 {margin-left: 0px;padding: 0px;}
div.rbtoc1292428718703 ul {list-style: none;margin-left: 0px;}
div.rbtoc1292428718703 li {margin-left: 0px;padding-left: 0px;}
/*]]>*/</style><div class='rbtoc1292428718703'>
<ul>
<li><span class='TOCOutline'>1</span> <a href='#XMLUIConfigurationandCustomization-ManakinConfigurationPropertyKeys'>Manakin Configuration Property Keys</a></li>
<li><span class='TOCOutline'>2</span> <a href='#XMLUIConfigurationandCustomization-ConfiguringThemesandAspects'>Configuring Themes and Aspects</a></li>
<ul>
<li><span class='TOCOutline'>2.1</span> <a href='#XMLUIConfigurationandCustomization-Aspects'>Aspects</a></li>
<li><span class='TOCOutline'>2.2</span> <a href='#XMLUIConfigurationandCustomization-Themes'>Themes</a></li>
</ul>
<li><span class='TOCOutline'>3</span> <a href='#XMLUIConfigurationandCustomization-MultilingualSupport'>Multilingual Support</a></li>
<li><span class='TOCOutline'>4</span> <a href='#XMLUIConfigurationandCustomization-CreatingaNewTheme'>Creating a New Theme</a></li>
<li><span class='TOCOutline'>5</span> <a href='#XMLUIConfigurationandCustomization-CustomizingtheNewsDocument'>Customizing the News Document</a></li>
<li><span class='TOCOutline'>6</span> <a href='#XMLUIConfigurationandCustomization-AddingStaticContent'>Adding Static Content</a></li>
<li><span class='TOCOutline'>7</span> <a href='#XMLUIConfigurationandCustomization-EnablingOAIOREHarvesterusingXMLUI'>Enabling OAI-ORE Harvester using XMLUI</a></li>
<ul>
<li><span class='TOCOutline'>7.1</span> <a href='#XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29'>Automatic Harvesting (Scheduler)</a></li>
</ul>
<li><span class='TOCOutline'>8</span> <a href='#XMLUIConfigurationandCustomization-AdditionalXMLUILearningResources'>Additional XMLUI Learning Resources</a></li>
</ul></div>
<h2><a name="XMLUIConfigurationandCustomization-ManakinConfigurationPropertyKeys"></a>Manakin Configuration Property Keys</h2>
@@ -29,212 +53,184 @@
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.supportedLocales</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.supportedLocales</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.supportedLocales = en, de</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.supportedLocales = en, de</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>A list of supported locales for Manakin. Manakin will look at a user's browser configuration for the first language that appears in this list to make available to in the interface. This parameter is a comma separated list of Locales. All types of Locales country, country_language, country_language_variant. Note that if the appropriate files are not present (i.e. Messages_XX_XX.xml) then Manakin will fall back through to a more general language.</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> A list of supported locales for Manakin. Manakin will look at a user's browser configuration for the first language that appears in this list to make available to in the interface. This parameter is a comma separated list of Locales. All types of Locales country, country_language, country_language_variant. Note that if the appropriate files are not present (i.e. Messages_XX_XX.xml) then Manakin will fall back through to a more general language. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.force.ssl</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.force.ssl</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.force.ssl = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.force.ssl = true</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Force all authenticated connections to use SSL, only non-authenticated connections are allowed over plain http. If set to true, then you need to ensure that the '<em>dspace.hostname</em>' parameter is set to the correctly. </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Force all authenticated connections to use SSL, only non-authenticated connections are allowed over plain http. If set to true, then you need to ensure that the '<em>dspace.hostname</em>' parameter is set to the correctly.</td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.registration</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.registration = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.registration</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine if new users should be allowed to register. This parameter is useful in conjunction with Shibboleth where you want to disallow registration because Shibboleth will automatically register the user. Default value is true. </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.registration = true</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.editmetadata</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine if new users should be allowed to register. This parameter is useful in conjunction with Shibboleth where you want to disallow registration because Shibboleth will automatically register the user. Default value is true.</td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.editmetadata = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determines if users should be able to edit their own metadata. This parameter is useful in conjunction with Shibboleth where you want to disable the user's ability to edit their metadata because it came from Shibboleth. Default value is true. </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.editmetadata</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.assumelogon</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.editmetadata = true</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.assumelogon = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determines if users should be able to edit their own metadata. This parameter is useful in conjunction with Shibboleth where you want to disable the user's ability to edit their metadata because it came from Shibboleth. Default value is true.</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running dspace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.loginredirect</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.assumelogon</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.loginredirect = /profile</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.assumelogon = true</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> After a user has logged into the system, which url should they be directed? Leave this parameter blank or undefined to direct users to the homepage, or <em>/profile</em> for the user's profile, or another reasonable choice is <em>/submissions</em> to see if the user has any tasks awaiting their attention. The default is the repository home page. </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running dspace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user.</td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.theme.allowoverrides</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.theme.allowoverrides = false</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.loginredirect</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Allow the user to override which theme is used to display a particular page. When submitting a request add the HTTP parameter "themepath" which corresponds to a particular theme, that specified theme will be used instead of the any other configured theme. Note that this is a potential security hole allowing execution of unintended code on the server, this option is only for development and debugging it should be turned off for any production repository. The default value unless otherwise specified is "false". </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.loginredirect = /profile</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.bundle.upload</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>After a user has logged into the system, which url should they be directed? Leave this parameter blank or undefined to direct users to the homepage, or <em>/profile</em> for the user's profile, or another reasonable choice is <em>/submissions</em> to see if the user has any tasks awaiting their attention. The default is the repository home page.</td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine which bundles administrators and collection administrators may upload into an existing item through the administrative interface. If the user does not have the appropriate privileges (add and write) on the bundle then that bundle will not be shown to the user as an option. </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.community-list.render.full</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides = false</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.community-list.render.full = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Allow the user to override which theme is used to display a particular page. When submitting a request add the HTTP parameter "themepath" which corresponds to a particular theme, that specified theme will be used instead of the any other configured theme. Note that this is a potential security hole allowing execution of unintended code on the server, this option is only for development and debugging it should be turned off for any production repository. The default value unless otherwise specified is "false".</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> On the community-list page should all the metadata about a community/collection be available to the theme. This parameter defaults to true, but if you are experiencing performance problems on the community-list page you should experiment with turning this option off. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.community-list.cache</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bundle.upload</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.community-list.cache = 12 hours</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Normally, Manakin will fully verify any cache pages before using a cache copy. This means that when the community-list page is viewed the database is queried for each community/collection to see if their metadata has been modified. This can be expensive for repositories with a large community tree. To help solve this problem you can set the cache to be assumed valued for a specific set of time. The downside of this is that new or editing communities/collections may not show up the website for a period of time. </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine which bundles administrators and collection administrators may upload into an existing item through the administrative interface. If the user does not have the appropriate privileges (add and write) on the bundle then that bundle will not be shown to the user as an option.</td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.bistream.mods</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.bistream.mods = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.community-list.render.full</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The MODS metadata file must be inside the "METADATA" bundle and named MODS.xml. If this option is set to 'true' and the bitstream is present then it is made available to the theme for display. </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.community-list.render.full = true</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.bitstream.mets</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>On the community-list page should all the metadata about a community/collection be available to the theme. This parameter defaults to true, but if you are experiencing performance problems on the community-list page you should experiment with turning this option off.</td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.bitstream.mets = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The METS metadata file must be inside the "METADATA" bundle and named METS.xml. If this optino is set to "true" and the bitstream is present then it is made available to the theme for display. </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.community-list.cache</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.google.analytics.key</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.community-list.cache = 12 hours</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.google.analytics.key = UA-XXXXXX-X</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Normally, Manakin will fully verify any cache pages before using a cache copy. This means that when the community-list page is viewed the database is queried for each community/collection to see if their metadata has been modified. This can be expensive for repositories with a large community tree. To help solve this problem you can set the cache to be assumed valued for a specific set of time. The downside of this is that new or editing communities/collections may not show up the website for a period of time.</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> If you would like to use google analytics to track general website statistics then use the following parameter to provide your analytics key. First sign up for an account at <a href="http://analytics.google.com" title="http://analytics.google.com">http://analytics.google.com</a>, then create an entry for your repositories website. Google Analytics will give you a snipit of javascript code to place on your site, inside that snip it is your google analytics key usually found in the line: &#95;uacct = "UA-XXXXXXX-X" Take this key (just the UA-XXXXXX-X part) and place it here in this parameter. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.max</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bistream.mods</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.max = 250</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bistream.mods = true</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Assign how many page views will be recorded and displayed in the control panel's activity viewer. The activity tab allows an administrator to debug problems in a running DSpace by understanding who and how their dspace is currently being used. The default value is 250. </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The MODS metadata file must be inside the "METADATA" bundle and named MODS.xml. If this option is set to 'true' and the bitstream is present then it is made available to the theme for display.</td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.ipheader</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.ipheader = X-Forward-For</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bitstream.mets</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bitstream.mets = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The METS metadata file must be inside the "METADATA" bundle and named METS.xml. If this optino is set to "true" and the bitstream is present then it is made available to the theme for display.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.google.analytics.key</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.google.analytics.key = UA-XXXXXX-X</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>If you would like to use google analytics to track general website statistics then use the following parameter to provide your analytics key. First sign up for an account at <a href="http://analytics.google.com" title="http://analytics.google.com">http://analytics.google.com</a>, then create an entry for your repositories website. Google Analytics will give you a snipit of javascript code to place on your site, inside that snip it is your google analytics key usually found in the line: _uacct = "UA-XXXXXXX-X" Take this key (just the UA-XXXXXX-X part) and place it here in this parameter.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.max</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.max = 250</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Assign how many page views will be recorded and displayed in the control panel's activity viewer. The activity tab allows an administrator to debug problems in a running DSpace by understanding who and how their dspace is currently being used. The default value is 250.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.ipheader</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.ipheader = X-Forward-For</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine where the control panel's activity viewer recieves an events IP address from. If your DSpace is in a load balanced enviornment or otherwise behind a context-switch then you will need to set the paramater to the HTTP parameter that records the original IP address.</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine where the control panel's activity viewer recieves an events IP address from. If your DSpace is in a load balanced enviornment or otherwise behind a context-switch then you will need to set the paramater to the HTTP parameter that records the original IP address. </td>
</tr>
</tbody></table>
</div>
@@ -258,12 +254,12 @@
</span> &lt;aspect name=<span class="code-quote">"Submission and Workflow"</span> path=<span class="code-quote">"resource:<span class="code-comment">//aspects/Submission/"</span> /&gt;
</span> &lt;/aspects&gt;</pre>
</div></div>
<p>A standard distribution of Manakin/DSpace includes four "core" aspects: </p>
<p>A standard distribution of Manakin/DSpace includes four "core" aspects:</p>
<ul>
<li>*Artifact Browser*The Artifact Browser Aspect is responsible for browsing communities, collections, items and bitstreams, viewing an individual item and searching the repository.</li>
<li>*E-Person*The E-Person Aspect is responsible for logging in, logging out, registering new users, dealing with forgotten passwords, editing profiles and changing passwords.</li>
<li>*Submission*The Submission Aspect is responsible for submitting new items to DSpace, determining the workflow process and ingesting the new items into the DSpace repository.</li>
<li>*Administrative*The Administrative Aspect is responsible for administrating DSpace, such as creating, modifying and removing all communities, collections, e-persons, groups, registries and authorizations.</li>
<li><b>Artifact Browser</b> The Artifact Browser Aspect is responsible for browsing communities, collections, items and bitstreams, viewing an individual item and searching the repository.</li>
<li><b>E-Person</b> The E-Person Aspect is responsible for logging in, logging out, registering new users, dealing with forgotten passwords, editing profiles and changing passwords.</li>
<li><b>Submission</b> The Submission Aspect is responsible for submitting new items to DSpace, determining the workflow process and ingesting the new items into the DSpace repository.</li>
<li><b>Administrative</b> The Administrative Aspect is responsible for administrating DSpace, such as creating, modifying and removing all communities, collections, e-persons, groups, registries and authorizations.</li>
</ul>
@@ -285,7 +281,7 @@ If you use the "handle" attribute, the effect is cascading, meaning if a rule is
&lt;theme name=<span class="code-quote">"Reference Theme"</span> regex=<span class="code-quote">".*"</span> path=<span class="code-quote">"Reference/"</span>/&gt;
&lt;/themes&gt;</pre>
</div></div>
<p>In the example above three themes are configured: "Theme 1", "Theme 2", and the "Reference Theme". The first rule specifies that "Theme 1" will apply to all communities, collections, or items that are contained under the parent community "123456789/23". The next rule specifies any URL containing the string "community-list" will get "Theme 2". The final rule, using the regular expression ".<b>", will match *anything</b>, so all pages which have not matched one of the preceding rules will be matched to the Reference Theme.</p></li>
<p>In the example above three themes are configured: "Theme 1", "Theme 2", and the "Reference Theme". The first rule specifies that "Theme 1" will apply to all communities, collections, or items that are contained under the parent community "123456789/23". The next rule specifies any URL containing the string "community-list" will get "Theme 2". The final rule, using the regular expression ".<b>", will match &#42;anything</b>, so all pages which have not matched one of the preceding rules will be matched to the Reference Theme.</p></li>
</ul>
@@ -295,11 +291,11 @@ If you use the "handle" attribute, the effect is cascading, meaning if a rule is
<p>The XMLUI user interface supports multiple languages through the use of internationalization catalogues as defined by the <a href="http://cocoon.apache.org/2.1/userdocs/i18nTransformer.html" title="Cocoon Internationalization Transformer">Cocoon Internationalization Transformer</a>. Each catalog contains the translation of all user-displayed strings into a particular language or variant. Each catalog is a single xml file whose name is based upon the language it is designated for, thus:</p>
<p>messages_<em>language</em>_<em>country</em>_<em>variant</em>.xml</p>
<p>messages&#95;<em>language</em>_<em>country</em>_<em>variant</em>.xml</p>
<p>messages_<em>language</em>_<em>country</em>.xml</p>
<p>messages&#95;<em>language</em>_<em>country</em>.xml</p>
<p>messages_<em>language</em>.xml</p>
<p>messages&#95;<em>language</em>.xml</p>
<p>messages.xml</p>
@@ -408,7 +404,7 @@ This will ensure the theme has been installed as described in the previous secti
<p>The XMLUI user interface supports the addition of globally static content (as well as static content within individual themes).</p>
<p>Globally static content can be placed in the <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/static/</em> directory. By default this directory only contains the default <em>robots.txt</em> file, which provides helpful site information to web spiders/crawlers. However, you may also add static HTML (<em>*.html</em>) content to this directory, as needed for your installation.</p>
<p>Globally static content can be placed in the <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/static/</em> directory. By default this directory only contains the default <em>robots.txt</em> file, which provides helpful site information to web spiders/crawlers. However, you may also add static HTML (<em>&#42;.html</em>) content to this directory, as needed for your installation.</p>
<p>Any static HTML content you add to this directory may also reference static content (e.g. CSS, Javascript, Images, etc.) from the same <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/static/</em> directory. You may reference other static content from your static HTML files similar to the following:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -443,12 +439,13 @@ At this point the settings are saved and the menu changes to provide three optio
<ul>
<li>"Change Settings" takes you back to the edit screen.</li>
<li>"Import Now" performs a single harvest from the remote collection into the local one. Success, notes, and errors encountered in the process will be reflected in the "Last Harvest Result" entry. More detailed information is available in the dspace log. Note that the whole harvest cycle is execuited withtin a single HTTP request and will time out for large collections. For this reason, it is advisable to use the automatic harvest scheduler set up<br/>
either in XMLUI or from the command line. If the scheduler is running, "Import Now" will handle the harvest task as a separate thread.</li>
<li>"Reset and Reimport Collection" will perform the same function as "Import Now", but will clear the collection of all existing items before doing so.
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3></li>
either in XMLUI or from the command line. If the scheduler is running, "Import Now" will handle the harvest task as a separate thread.</li>
<li>"Reset and Reimport Collection" will perform the same function as "Import Now", but will clear the collection of all existing items before doing so.</li>
</ul>
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3>
<p>Setting up automatic harvesting in the Control Panel Screen.</p>
<ul>
@@ -468,6 +465,17 @@ At this point the settings are saved and the menu changes to provide three optio
</ul>
<h2><a name="XMLUIConfigurationandCustomization-AdditionalXMLUILearningResources"></a>Additional XMLUI Learning Resources</h2>
<p>Useful links with further information into XMLUI Development</p>
<ul>
<li><a href="http://www.slideshare.net/tdonohue/making-dspace-xmlui-your-own">Making DSpace XMLUI Your Own</a> &#45; Concentrates on using Maven to build Overlays in the XMLUI (Manakin). Also has very basic examples for JSPUI. Based on DSpace 1.6.x.</li>
<li><a href="http://www.tdl.org/files/LearningToUseManakin.pdf">Learning to Use Manakin (XMLUI)</a> &#45; Overview of how to use Manakin and how it works. Based on DSpace 1.5, but also valid for 1.6.</li>
<li><a href="http://www.tdl.org/wp-content/uploads/2009/04/Introducing%20Manakin.pdf">Introducing Manakin (XMLUI)</a></li>
</ul>
</td>
</tr>
@@ -477,7 +485,7 @@ At this point the settings are saved and the menu changes to provide three optio
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
<td align="center"><font color="grey">Document generated by Confluence on Dec 16, 2010 16:47</font></td>
</tr>
</table>
</body>