Scribd
Upload
85 views

03 Dspace Theme PDF

Uploaded by

angelojms
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
85 views

03 Dspace Theme PDF

Uploaded by

angelojms
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

Customizing Manakin (pt.

1)

1. Introduction 2
HTML / CSS style Tier 2
XML / XSL Theme Tier 2
Java / Cocoon development Tier 2

2. HTML / CSS style Tier 2


Creating your own Style 2
Installing your theme 3
Exercise 1: Customizing the header 3
Exercise 2: Customizing the trail 3

3. XML / XSL Theme Tier 4


Theme Overview 4
Reusing Base Theme Components 4
Base XSL library 5
Main XSL 5
Structural Display 5
Metadata handlers 5
Base i18n 5
Exercise 1: Customizing Header & Footer 6
Exercise 2: Customizing the item display page 6
Exercise 3: Item listing 6

1/7

© 2009 @mire N.V. www.atmire.com


1. Introduction
The component architecture of Manakin consists of three tiers:

• HTML / CSS style Tier


• XML / XSL Theme Tier
• Java / Cocoon development Tier

As the tiers descend, progressively more skill and experience are required of someone to be productive at
that tier.

HTML / CSS style Tier


Requires only basic XHTML knowledge and can change the style of how information is presented to the
user across an entire Theme.

XML / XSL Theme Tier


Requires XML and XSLT knowledge, but no Java experience. At this tier; information currently being
displayed by DSpace can be further processed before being displayed to the user. Major site-wide
presentation, structural, and limited computational changes may be made to an entire Theme, or an
individual page.

Java / Cocoon development Tier


Requires Java development and Cocoon expertise and is able to perform any functional customization to
DSpace using the supplied component architecture.

This session will focus on the HTML/CSS style tier and the XML/XSL Theme tier.

2. HTML / CSS style Tier


Creating your own Style
1. Create theme skeleton
cd [dspace-source]/dspace/modules/dspace-xmlui/src/main/webapp/themes/

cp -R
[dspace-source]/dspace/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/themes/template/
[theme-dir]

2. Modify theme variables


[theme-dir]/sitemap.xmap
<global-variables>
<theme-path>[theme-dir]</theme-path>
<theme-name>[your-name]</theme-name>
</global-variables>

3. Create your own CSS stylesheet

4. Add your CSS stylesheet


[theme-dir]/style.css
[theme-dir]/style-ie.css

5. Rebuild your project

2/7

© 2009 @mire N.V. www.atmire.com


cd [dspace-source]/dspace/; mvn package
Deploy web application

Installing your theme


1. Open XMLUI configuration
[dspace]/config/xmlui.xconf

2. Add a new theme rule


<theme name=”[theme-name]”
path=”[theme-dir]”
handle=”123/1” />

or
<theme name=”[theme-name]”
path=”[theme-dir]”
regex=”.*” />

3. Restart Tomcat

Exercise 1: Customizing the header


Create your own theme based on the steps outlined above and reuse the classic theme using the
<xsl:import> element.

A default installation of DSpace contains a header with a DSpace logo included when using either the
Reference or the Classic theme. This logo is part of the style.css contained within this theme. This
header can be customized to contain your own logo by copying the header-logo style to your customized
css file and changing the image to a banner from your own institution.

Exercise 2: Customizing the trail


Use the theme created in the previous exercise.

A default installation of DSpace contains a trail in the item display page containing the parent collection and
communities. The Classic theme displays this trail as separate lines underneath each other. Alter this trail
(and any other occurrence of the trail) to place all links behind each other.

3/7

© 2009 @mire N.V. www.atmire.com


3. XML / XSL Theme Tier
Theme Overview

Reusing Base Theme Components

4/7

© 2009 @mire N.V. www.atmire.com


Base XSL library
Main XSL
/themes/dri2xhtml.xsl

Structural Display
/themes/dri2xhtml/structural.xsl

Metadata handlers
/themes/dri2xhtml/DIM-Handler.xsl
/themes/dri2xhtml/MODS-Handler.xsl
/themes/dri2xhtml/QDC-Handler.xsl
/themes/dri2xhtml/General-Handler.xsl

These handlers arre responsible for: displaying items, collections, and communities and there are different
versions for DIM, MODS, and QDC metadata.

In this base xsl library four display types are distinguished:

• SummaryList = Summarized list of objects (Community/Collection listing, item browse/search)


• SummaryView= Summarized view of single object (Item page summary metadata)
• DetailList= Detailed list of objects Rarely used: (“Item appears in following collections”)
• DetailView= Detailed view of single object (Item’s full record page, collection/community pages)

Base i18n
The XMLUI user interface supports multiple languages through the use of internationalization catalogues as
defined by the Cocoon Internationalization Transformer. Each catalogue contains the translation of all user-
displayed strings into a particular language or variant. Each catalogue is a single xml file whose name is
based upon the language it is designated for:
• messages_language_country_variant.xml
• messages_language_country.xml
• messages_language.xml
• messages.xml

DSpace will automatically determine which file to select based upon the user's browser and system
configuration. For example, if the user's browser is set to Australian English then first the system will check
if messages_en_au.xml is available. If this translation is not available it will fall back to messages_en.xml,
and finally if that is not available, messages.xml.

Manakin supplies an English only translation of the interface. In order to add other translations to the
system, locate the [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.

To set a language other than English as the default language for the repository's interface, simply name the
translation catalogue for the new default language "messages.xml"

5/7

© 2009 @mire N.V. www.atmire.com


Exercise 1: Customizing Header & Footer
Override the default XSL /themes/dri2xhtml/structural.xsl In your theme’s local XSL document add the
following template definitions:
<xsl:template name=”buildHeader”>
....
</xsl:template>

<xsl:template name=”buildFooter”>
....
</xsl:template>

Exercise 2: Customizing the item display page


Contrary to JSPUI, in Manakin the item display page needs to be configured in the stylesheets. Changing
the list of fields present in the simple item view can be done by overriding the template

<xsl:template match="dim:dim" mode="itemSummaryView-DIM">

which is present in DIM-handler.xsl. Copy this block to your local XSL document, and extend this to
also include the Publisher (dc.publisher) present in your item. Make sure you’re either checking an item
containing a publisher, or add one by editing the metadata to view the results.

Exercise 3: Item listing


Item listings such as the ones in “Browse by title” or the search results contain a specified set of metadata
fields from your item. This listing can be extended by overriding the appropriate template and adding a
comma-separate list of subjects in the display list. A hint towards finding the appropriate template is
checking the DRI for the browse listing, and searching for the type in the referenceSet in the existing xsl’s.

6/7

© 2009 @mire N.V. www.atmire.com


TERMS OF USE

PLEASE READ THESE TERMS OF USE CAREFULLY BEFORE USING THESE COURSE MATERIALS. By
using these course materials, you signify your assent to these terms of use. If you do not agree to these
terms of use, please do not use these course materials.

RESTRICTIONS ON USE OF MATERIALS. These course materials are owned by @mire NV, Technologielaan
9, 3001 Heverlee (Belgium).

No components from these course materials owned, licensed or controlled by @mire NV may be copied,
reproduced, republished, uploaded, posted, transmitted, or distributed in any way, except that you may
download one copy of the materials on any single computer for your personal, non-commercial home use
only, provided you keep intact all copyright and other proprietary notices.

Modification of the materials or use of the materials for any other purpose is a violation of @mire's copyright
and other proprietary rights. The use of any such material on any other web site or networked computer
environment is prohibited.

To request permission to reproduce materials,


call +32 2 888 29 56,
email [email protected],
or write to @mire NV, Technologielaan 9, 3001 Heverlee, Belgium.

7/7

© 2009 @mire N.V. www.atmire.com

You might also like