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

From Libopedia
Jump to navigation Jump to search
 
(43 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{SUNScholar}}
+
<center>
 +
'''[[SUNScholar/XMLUI_Theme/M1|Back to Mirage 1]]'''
 +
</center>
 +
===Requirements===
 +
{{THEME-REQUIREMENTS}}
  
−
{{VERSION-DSPACE}}
+
Please see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03
−
----
 
−
;Using modules overlay method
 
−
'''<font color="red">We will be using the "modules" method to create a custom theme.</font>'''
 
  
−
The default folder is:
+
''Make sure you have correctly "symlinked" to the source code, see step 3.2 in the link above.''
−
/home/dspace/dspace-1.8.2-src-release/dspace/modules/xmlui/src/main/webapp/themes/[custom-theme-dir]
 
  
−
You can replace "Mytheme" with a theme name of your choice for all of the following instructions.
+
===Overlay Method===
 +
We will be using the "modules" overlay method to create a custom theme.
  
−
;Step 1 - Copy the "Mirage" reference theme to a custom "Mytheme"
+
'''<font color="red">You can replace "SUNScholar" with a theme name of your choice for all of the following instructions.</font>'''
 +
 
 +
===Step 1 - Copy the "Mirage" reference theme to a custom "SUNScholar"===
 
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.
 
   
 
   
−
  mkdir /home/dspace/dspace-1.8.2-src-release/dspace/modules/xmlui/src/main/webapp/themes
+
  mkdir $HOME/{{Source}}/dspace/modules/xmlui/src/main/webapp/themes
  
−
  mkdir /home/dspace/dspace-1.8.2-src-release/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
+
  cd $HOME/{{Source}}/dspace-xmlui/src/main/webapp/themes
  
−
  cd /home/dspace/dspace-1.8.2-src-release/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/themes
+
  cp -R Mirage $HOME/{{Source}}/dspace/modules/xmlui/src/main/webapp/themes/
  
−
  cp -R Mirage /home/dspace/dspace-1.8.2-src-release/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
+
  cd $HOME/{{Source}}/dspace/modules/xmlui/src/main/webapp/themes
  
−
;Step 2 - Modify the "xmlui.xconf" file to use "Mytheme"
+
  mv Mirage SUNScholar
−
Type the following to go to your DSpace config directory.
 
−
  cd /home/dspace/dspace-1.8.2-src-release/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 !!'''
+
===Step 2 - Modify the "sitemap.xmap" file to use "SUNScholar"===
−
<pre>
+
Type the following to change directory to the "SUNScholar" folder.
−
<theme name="Mytheme" path="Mytheme/" regex=".*" />
 
−
</pre>
 
  
−
{{NANO}}
+
cd $HOME/{{Source}}/dspace/modules/xmlui/src/main/webapp/themes/SUNScholar
−
 
 
−
;Step 3 - Modify the "sitemap.xmap" file to use "Mytheme"
 
−
Type the following to change directory to the "Mytheme" folder.
 
−
 
 
−
cd /home/dspace/dspace-1.8.2-src-release/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
 
  
 
Modify the '''sitemap.xmap''' config file for your new theme by typing the following.
 
Modify the '''sitemap.xmap''' config file for your new theme by typing the following.
 
   
 
   
 
  nano sitemap.xmap
 
  nano sitemap.xmap
−
 
+
====Step 2.1====
−
Change the "theme-path" and "theme-name" parameters in the '''sitemap.xmap''' file using the "nano" editor.
+
Change all the values of <tt>'''{global:theme-path}'''</tt> to <tt>'''SUNScholar'''</tt>.
−
 
+
====Step 2.2====
 +
Change the "theme-path" and "theme-name" parameters to <tt>'''SUNScholar'''</tt>.
 
<pre>
 
<pre>
 
<map:component-configurations>
 
<map:component-configurations>
 
     <global-variables>
 
     <global-variables>
−
       <theme-path>Mytheme</theme-path>
+
       <theme-path>SUNScholar</theme-path>
−
       <theme-name>Mytheme</theme-name>
+
       <theme-name>SUNScholar</theme-name>
 
     </global-variables>
 
     </global-variables>
 
</map:component-configurations>
 
</map:component-configurations>
 
</pre>
 
</pre>
 +
===Step 3 - Rename the "Mirage.xsl" file to "SUNScholar.xsl"===
 +
Type the following.
 +
cd $HOME/{{Source}}/dspace/modules/xmlui/src/main/webapp/themes/SUNScholar
 +
Rename the "Mirage.xsl" file to "SUNScholar.xsl" by typing the following.
 +
mv Mirage.xsl SUNScholar.xsl
 +
===Step 4 - Modify the "xmlui.xconf" file to use "SUNScholar"===
 +
Edit the following file:
 +
nano $HOME/{{Source}}/dspace/config/xmlui.xconf
  
−
{{NANO}}
+
Add the following to "xmlui.xconf" file in the themes section using copy and paste with firefox and nano.
  
−
;Step 4 - Rename the "Mirage.xsl" file to "Mytheme.xsl"
+
<font color="red">'''Make sure to comment out all other theme references !!'''</font>
−
Type the following.
+
<pre>
−
cd /home/dspace/dspace-1.8.2-src-release/dspace/modules/xmlui/src/main/webapp/themes/Mytheme
+
<theme name="SUNScholar" regex=".*" path="SUNScholar/" />
−
Rename the "Mirage.xsl" file to "Mytheme.xsl" by typing the following.
+
</pre>
−
mv Mirage.xsl Mytheme.xsl
 
  
−
'''[[SUNScholar/XMLUI_Theme|Back to Theme]]'''
+
{{NANO}}
 +
__NOTOC__
 +
[[Category:Customisation]]

Latest revision as of 12:03, 28 May 2016

Back to Mirage 1

Requirements

  1. Use port 80 and 443 as default on the Tomcat Java webapp server.
  2. Configure chosen UI as the default ROOT Java webapp.

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.

Overlay Method

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

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

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

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

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

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

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

mv Mirage SUNScholar

Step 2 - Modify the "sitemap.xmap" file to use "SUNScholar"

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

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

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

nano sitemap.xmap

Step 2.1

Change all the values of {global:theme-path} to SUNScholar.

Step 2.2

Change the "theme-path" and "theme-name" parameters to SUNScholar. 

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

Step 3 - Rename the "Mirage.xsl" file to "SUNScholar.xsl"

Type the following. 

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

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

mv Mirage.xsl SUNScholar.xsl

Step 4 - Modify the "xmlui.xconf" file to use "SUNScholar"

Edit the following file: 

nano $HOME/source/dspace/config/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="SUNScholar" regex=".*" path="SUNScholar/" />
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)

Retrieved from "http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/XMLUI_Theme/M1/Creation&oldid=42744"