Page History
Wiki Markup |
---|
DSpace System Documentation: Manakin \[DSDOCDEV:XMLUI\] Configuration and Customization |
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.
...
Wiki Markup |
---|
The repository administrator is able to define which aspects and themes are installed for the particular repository by editing the _\[DSDOCDEV:dspace\]/config/xmlui.xconf_ configuration file. The _xmlui.xconf_ file consists of two major sections: Aspects and Themes. |
...
Wiki Markup |
---|
Manakin supplies an English only translation of the interface. In order to add other translations to the system, locate the _\[DSDOCDEV:dspace-source\]/dspace/modules/xmlui/src/main/webapp/i18n/_ directory. By default this directory will be empty; to add additional translations add alternative versions of the _messages.xml_ file in specific language and country variants as needed for your installation. |
...
Wiki Markup |
---|
Manakin themes stylize the look-and-feel of the repository, community, or collection and are distributed as self-contained packages. A Manakin/DSpace installation may have multiple themes installed and available to be used in different parts of the repository. The central component of a theme is the sitemap.xmap, which defines what resources are available to the theme such as XSL stylesheets, CSS stylesheets, images, or multimedia files. *1) Create theme skeleton* Most theme developers do not create a new theme from scratch; instead they start from the standard theme template, which defines a skeleton structure for a theme. The template is located at: _\[DSDOCDEV:dspace-source\]/dspace-xmlui/dspace-xmlui-webbapp/src/main/webbapp/themes/template_. To start your new theme simply copy the theme template into your locally defined modules directory, _\[DSDOCDEV:dspace-source\]/dspace/modules/xmlui/src/main/webbapp/themes/\[DSDOCDEV:your theme's directory\]/_. *2) Modify theme variables* The next step is to modify the theme's parameters so that the theme knows where it is located. Open the _\[DSDOCDEV:your theme's directory\]/sitemap.xmap_ and look for _<global-variables>_ |
...
Update both the theme's path to the directory name you created in step one. The theme's name is used only for documentation.
3) Add your CSS stylesheets
The base theme template will produce a repository interface without any style - just plain XHTML with no color or formatting. To make your theme useful you will need to supply a CSS Stylesheet that creates your desired look-and-feel. Add your new CSS stylesheets:
Wiki Markup |
---|
_\[DSDOCDEV:your theme's directory\]/lib/style.css_ (The base style sheet used for all browsers) |
Wiki Markup |
---|
_\[DSDOCDEV:your theme's directory\]/lib/style-ie.css_ (Specific stylesheet used for internet explorer)
*4) Install theme and rebuild DSpace*
Next rebuild and deploy DSpace (replace <version> with the your current release): |
Wiki Markup Rebuild the DSpace installation package by running the following command from your _\[DSDOCDEV:dspace-source\]/dspace/_ directory:
Code Block mvn package
Wiki Markup Update all DSpace webapps to _\[DSDOCDEV:dspace\]/webapps_ by running the following command from your _\[DSDOCDEV:dspace-source\]/dspace/target/dspace-\[DSDOCDEV:version\]-build.dir_ directory:
Code Block ant -Dconfig=[dspace]/config/dspace.cfg update
- Deploy the the new webapps:
Code Block cp -R /[dspace]/webapps/* /[tomcat]/webapps
- Restart Tomcat
This will ensure the theme has been installed as described in the previous section "Configuring Themes and Aspects".
...
Wiki Markup |
---|
The news document is located at _\[DSDOCDEV:dspace\]/dspace/config/news-xmlui.xml_. There is only one version; it is localized by inserting "i18n" callouts into the text areas. It must be a complete and valid XML DRI document (see Chapter 15). |
...
Wiki Markup |
---|
Globally static content can be placed in the _\[DSDOCDEV:dspace-source\]/dspace/modules/xmlui/src/main/webapp/static/_ directory. By default this directory only contains the default _robots.txt_ file, which provides helpful site information to web spiders/crawlers. However, you may also add static HTML (_\*.html_) content to this directory, as needed for your installation. |
Wiki Markup |
---|
Any static HTML content you add to this directory may also reference static content (e.g. CSS, Javascript, Images, etc.) from the same _\[DSDOCDEV:dspace-source\]/dspace/modules/xmlui/src/main/webapp/static/_ directory. You may reference other static content from your static HTML files similar to the following: |
...
This feature allows you to harvest Items (both metadata and bitstreams) from one DSpace to another DSpace . However, both DSpace instances must be running XMLUI. In addition, the source DSpace (from which you are harvesting) should be running an or from one OAI-PMH server (as it is used by default to harvest the metadata)/OAI-ORE server to a DSpace instance.
This section will give the necessary steps to set up the OAI-ORE/OAI-PMH Harvester from the XMLUI (Manakin). This feature is currently not available in the JSPUI.
Setting up a Harvesting Collection:
...