Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

DSpace System Documentation: JPSUI Configuration and Customization

Table of Contents
outlinetrue

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 JPSUI interface.

Table of Contents
minLevel2
outlinetrue
stylenone

Configuration

The user will need to refer to the extensive WebUI/JSPUI configurations that are contained in 5.2.36 JSP Web Interface Settings.

...

The JSPs are available in one of two places:

...

  • _\[dspace-source\]/dspace-jspui/dspace-jspui-webapp/src/main/webapp/_ \ - Only exists if you downloaded the full Source Release of DSpace
  • Wiki Markup_\[dspace-source\]/dspace/target/dspace-\[version\].dir/webapps/dspace-jspui-webapp/_ \ - The location where they are copied after first building DSpace.

If

...

you

...

wish

...

to

...

modify

...

a

...

particular

...

JSP,

...

place

...

your

...

edited

...

version

...

in

...

the

...

[dspace-source

...

]/dspace/modules/jspui/src/main/webapp/

...

directory

...

(

...

this

...

is

...

the

...

replacement

...

for

...

the

...

pre-1.5

...

/jsp/local

...

directory

...

),

...

with

...

the

...

same

...

path

...

as

...

the

...

original.

...

If

...

they

...

exist,

...

these

...

will

...

be

...

used

...

in

...

preference

...

to

...

the

...

default

...

JSPs.

...

For

...

example:

DSpace default

Locally-modified version

...

[

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9c9f50bb-725e-4938-8aa9-a10f2fc58af0"><ac:plain-text-body><![CDATA[

jsp.dir]/community-list.jsp

[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/community-list.jsp

...

]]></ac:plain-text-body></ac:structured-macro>

[jsp.dir]/mydspace/main.jsp

[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/mydspace/main.jsp

...

]]></ac:plain-text-body></ac:structured-macro>

Wiki MarkupHeavy use is made of a style sheet, _styles.css_. If you make edits, copy the local version to _\[jsp.custom-dir\]/dspace/modules/jspui/src/main/webapp/styles.css_, and it will be used automatically in preference to the default, as described above.

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.unmigrated-wiki-markup

The 'layout' of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs _/layout/header\-_{*}_.jsp{_}* * and * *_/layout/footer\-_{*}_.jsp_. You can provide modified versions of these (in _\[jsp.custom-dir\]/dspace/modules/jspui/src/main/webapp/layout_), or define more styles and apply them to pages by using the "style" attribute of the _dspace:layout_ tag.

...

  1. Rebuild the DSpace installation package by running the following command from your _\[dspace-source\]/dspace/_ directory:
    Code Block
    mvn package
    Wiki Markup
  2. Update all DSpace webapps to _\[dspace\]/webapps_ by running the following command from your _\[dspace-source\]/dspace/target/dspace-\[version\]-build.dir_ directory:
    Code Block
    ant -Dconfig=[dspace]/config/dspace.cfg update 
  3. Deploy the the new webapps:
    Code Block
    cp -R /[dspace]/webapps/* /[tomcat]/webapps
  4. Restart Tomcat Tomcat
    When you restart the web server you should see your customized JSPs.