Difference between revisions of "SUNScholar/XMLUI Theme/M1/Creation"

From Libopedia
Jump to navigation Jump to search
Line 2: Line 2:
 
  '''[[SUNScholar/XMLUI_Theme|Back to XMLUI Theme]]'''
 
  '''[[SUNScholar/XMLUI_Theme|Back to XMLUI Theme]]'''
 
</center>
 
</center>
;Requirements
+
==Requirements==
 
Please see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03
 
Please see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03
  
Line 14: Line 14:
 
You can replace "Mytheme" with a theme name of your choice for all of the following instructions.
 
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"
+
==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.
 
Type the following to create your own custom theme folder and files using the reference "Mirage" theme.
 
   
 
   
Line 25: Line 25:
 
  cp -R Mirage /home/dspace/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
 
  cp -R Mirage /home/dspace/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
 
----
 
----
;Step 2 - Modify the "xmlui.xconf" file to use "Mytheme"
+
==Step 2 - Modify the "xmlui.xconf" file to use "Mytheme"==
 
Type the following to go to your DSpace config directory.
 
Type the following to go to your DSpace config directory.
 
  cd /home/dspace/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/config
 
  cd /home/dspace/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/config
Line 38: Line 38:
 
{{NANO}}
 
{{NANO}}
 
----
 
----
;Step 3 - Modify the "sitemap.xmap" file to use "Mytheme"
+
==Step 3 - Modify the "sitemap.xmap" file to use "Mytheme"==
 
Type the following to change directory to the "Mytheme" folder.
 
Type the following to change directory to the "Mytheme" folder.
  
Line 60: Line 60:
 
{{NANO}}
 
{{NANO}}
 
----
 
----
;Step 4 - Rename the "Mirage.xsl" file to "Mytheme.xsl"
+
==Step 4 - Rename the "Mirage.xsl" file to "Mytheme.xsl"==
 
Type the following.
 
Type the following.
 
  cd /home/dspace/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
 
  cd /home/dspace/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
 
Rename the "Mirage.xsl" file to "Mytheme.xsl" by typing the following.
 
Rename the "Mirage.xsl" file to "Mytheme.xsl" by typing the following.
 
  mv Mirage.xsl Mytheme.xsl
 
  mv Mirage.xsl Mytheme.xsl

Revision as of 15:59, 22 January 2014

Back to XMLUI Theme

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 above.

The default folder is:

/home/dspace/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/dspace/source/dspace/modules/xmlui/src/main/webapp/themes
mkdir /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
cd /home/dspace/source/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/themes
cp -R Mirage /home/dspace/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/dspace/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/dspace/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/dspace/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