SUNScholar/XMLUI Theme/M2

Back to XMLUI Theme

PLEASE NOTE:

1. Mirage 2 with DSpace => 5.X requires Ubuntu 14.04.
2. If you want to upgrade to 14.04 LTS, then check:
   http://wiki.lib.sun.ac.za/index.php/SUNScholar/Upgrading/Server_Software
3. If you are building on a test server, then make sure that the test server is able to download dependencies from the internet.

Introduction

This is a very brief installation guide for the new Mirage2 theme released with DSpace version 5.

It is intended for those familiar with maintaining Ubuntu servers.

Requirements

Install Ubuntu Software

• After logging in as the "dspace" user, install the required Ubuntu software, by typing the following:

sudo apt-get install git curl maven default-jdk default-jre

Source Code Symlink

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

Make sure you have correctly "symlinked" to the DSpace => 5.X source code, see step 3.2 in the link above.

Step 1 - Install Non-Ubuntu Software

Just install them, do not try to use them yet!!

Install "node.js" software: https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager

sudo curl -sL https://deb.nodesource.com/setup | sudo bash -

Install node version manager (nvm): https://github.com/creationix/nvm

sudo curl https://raw.githubusercontent.com/creationix/nvm/v0.24.0/install.sh | bash

Install ruby version manager (rvm): http://rvm.io

sudo curl -sSL https://get.rvm.io | bash -s stable

Step 2 - Install Theme Build Software

• When the above software above has been installed correctly, then logout and login again as the "dspace" user.
• Type the following to install the software required to customise and build the theme:

sudo -i

npm install --no-check-certificate -g bower

npm install --no-check-certificate -g grunt

npm install --no-check-certificate -g grunt-cli

npm install --no-check-certificate -g less2sass

exit

Step 3 - Build Theme

Full Build

• Rebuild DSpace by adding the following switch to the Maven build instruction.

-Dmirage2.on=true

• For example;

mvn -U clean package -Dmirage2.on=true

See example build report below.

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] 
[INFO] DSpace Parent Project ............................. SUCCESS [5.717s]
[INFO] DSpace Services Framework :: API and Implementation  SUCCESS [1.557s]
[INFO] DSpace Kernel :: API and Implementation ........... SUCCESS [5.619s]
[INFO] DSpace Addon Modules .............................. SUCCESS [0.048s]
[INFO] DSpace Kernel :: Additions and Local Customizations  SUCCESS [3.098s]
[INFO] DSpace XML-UI (Manakin) ........................... SUCCESS [2.737s]
[INFO] DSpace XML-UI Mirage2 Theme ....................... SUCCESS [0.209s]
[INFO] DSpace XML-UI Mirage2 Theme :: Local Customisations  SUCCESS [3:32.133s]
[INFO] DSpace XML-UI (Manakin) :: Local Customizations ... SUCCESS [13.554s]
[INFO] DSpace JSP-UI ..................................... SUCCESS [2.898s]
[INFO] DSpace JSP-UI :: Local Customizations ............. SUCCESS [4.898s]
[INFO] DSpace RDF ........................................ SUCCESS [3.811s]
[INFO] DSpace RDF :: Local Customizations ................ SUCCESS [5.349s]
[INFO] DSpace REST :: API and Implementation ............. SUCCESS [4.596s]
[INFO] DSpace REST :: Local Customizations ............... SUCCESS [5.610s]
[INFO] DSpace SWORD ...................................... SUCCESS [2.005s]
[INFO] DSpace SWORD :: Local Customizations .............. SUCCESS [4.508s]
[INFO] DSpace SWORD v2 ................................... SUCCESS [4.027s]
[INFO] DSpace SWORD v2 :: Local Customizations ........... SUCCESS [3.948s]
[INFO] Apache Solr Webapp ................................ SUCCESS [16.859s]
[INFO] DSpace SOLR :: Local Customizations ............... SUCCESS [6.708s]
[INFO] DSpace OAI-PMH .................................... SUCCESS [5.272s]
[INFO] DSpace OAI-PMH :: Local Customizations ............ SUCCESS [4.985s]
[INFO] DSpace Assembly and Configuration ................. SUCCESS [40.124s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6:00.947s
[INFO] Finished at: Thu Apr 02 10:27:29 SAST 2015
[INFO] Final Memory: 78M/392M
[INFO] ------------------------------------------------------------------------

Theme Only Re-Build

Try the following to rebuild the theme without having to download dependencies again:

 mvn -U clean package -Dmirage2.on=true -Dmirage2.deps.included=false

Please Note: https://jira.duraspace.org/browse/DS-2368.

This error appears when adding -Dmirage2.deps.included=false to the build.

Rebuild DSpace script update

If you want to use the Mirage2 theme permanently, then make sure to add the Mirage2 build switch to your DSpace rebuild script.

• For example;

mvn -U clean package -Dmirage2.on=true

Step 4 - Activate Theme

• Type the following:

nano $HOME/dspace/source/dspace/config/xmlui.xconf

Check that the "Mirage2" theme is the ONLY active theme and not enclosed with <!-- .... -->. See below for an example.

<theme name="Mirage 2" regex=".*" path="Mirage2/" />

See: https://github.com/DSpace/DSpace/blob/dspace-5_x/dspace/config/xmlui.xconf#L185

Step 5 - Customise Theme

Click on the heading above.

Build Issues

• https://jira.duraspace.org/browse/DS-2368
• https://wiki.duraspace.org/display/DSDOC5x/Mirage+2+Configuration+and+Customization#Mirage2ConfigurationandCustomization-CommonBuildIssues

References

• https://github.com/DSpace/DSpace/tree/master/dspace-xmlui-mirage2
• https://github.com/atmire/DSpace/tree/master/dspace-xmlui-mirage2
• https://atmire.com/website/?q=content/fresh-look-and-feel-dspace-4
• http://duraspace.org/now-available-mirage-2-dspace-3-and-4
• https://atmire.com/website/?q=contributions/dspace-mirage-2
• http://www.duraspace.org/mirage-2-fresh-look-and-feel-dspace-4
• https://rogerdudler.github.io/git-guide