SUNScholar/XMLUI Theme/M1/Creation

Back to Mirage 1

Requirements

Please see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03

Make sure you have correctly "symlinked" to the source code, see step 3.2 in the link above.

The default folder is:

$HOME/source/dspace/modules/xmlui/src/main/webapp/themes/[custom-theme-dir]

Method

We will be using the "modules" overlay method to create a custom theme.

You can replace "Mytheme" with a theme name of your choice for all of the following instructions.

Step 1 - Copy the "Mirage" reference theme to a custom "Mytheme"

Type the following to create your own custom theme folder and files using the reference "Mirage" theme.

mkdir $HOME/source/dspace/modules/xmlui/src/main/webapp/themes

mkdir $HOME/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme

cd $HOME/source/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/themes

cp -R Mirage $HOME/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme

Step 2 - Modify the "xmlui.xconf" file to use "Mytheme"

Type the following to go to your DSpace config directory.

cd $HOME/source/dspace/config

Type the following to edit the DSpace XMLUI config file.

nano xmlui.xconf

Add the following to "xmlui.xconf" file in the themes section using copy and paste with firefox and nano. Make sure to comment out all other theme references !!

<theme name="Mytheme" path="Mytheme/" regex=".*" />

---

NANO Editor Help

CTL+O	= Save the file and then press Enter
CTL+X	= Exit "nano"
CTL+K	= Delete line
CTL+U	= Undelete line
CTL+W	= Search for %%string%%
CTL+\	= Search for %%string%% and replace with $$string$$
CTL+C	= Show line numbers

More info = http://en.wikipedia.org/wiki/Nano_(text_editor)

---

Step 3 - Modify the "sitemap.xmap" file to use "Mytheme"

Type the following to change directory to the "Mytheme" folder.

cd $HOME/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme

Modify the sitemap.xmap config file for your new theme by typing the following.

nano sitemap.xmap

Change the "theme-path" and "theme-name" parameters in the sitemap.xmap file using the "nano" editor.

<map:component-configurations>
    <global-variables>
       <theme-path>Mytheme</theme-path>
       <theme-name>Mytheme</theme-name>
    </global-variables>
</map:component-configurations>

---

NANO Editor Help

CTL+O	= Save the file and then press Enter
CTL+X	= Exit "nano"
CTL+K	= Delete line
CTL+U	= Undelete line
CTL+W	= Search for %%string%%
CTL+\	= Search for %%string%% and replace with $$string$$
CTL+C	= Show line numbers

More info = http://en.wikipedia.org/wiki/Nano_(text_editor)

---

Step 4 - Rename the "Mirage.xsl" file to "Mytheme.xsl"

Type the following.

cd $HOME/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme

Rename the "Mirage.xsl" file to "Mytheme.xsl" by typing the following.

mv Mirage.xsl Mytheme.xsl