Difference between revisions of "SUNScholar/XMLUI Theme/M2/Customisation"
Jump to navigation
Jump to search
m |
m (→Theme Archive) |
||
| (53 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
This [[SUNScholar/Theme#Design_Considerations|customisation is very basic]] and is intended for those who have basic web 2.0 design skills. | This [[SUNScholar/Theme#Design_Considerations|customisation is very basic]] and is intended for those who have basic web 2.0 design skills. | ||
| + | ====<font color="red">Please Note:</font>==== | ||
| + | *''It is assumed that the Mirage 2 theme was installed according to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/XMLUI_Theme/M2.'' | ||
| + | *''It is also assumed that you installed DSpace according to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/DSpace.'' | ||
| + | *''After you have completed your customisation, you will have to [[SUNScholar/Rebuild_DSpace|rebuild DSpace]]''. | ||
| − | + | ===Procedures=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
#[[SUNScholar/Bootstrap Framework|Requirements]] | #[[SUNScholar/Bootstrap Framework|Requirements]] | ||
| − | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Introduction Text| | + | #[[SUNScholar/XMLUI_Theme/Common_Elements|Review Common Elements]] |
| + | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Introduction Text|Front Page Text]] | ||
| + | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Palette|Palette (colours)]] | ||
| + | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Typography|Typography (fonts)]] | ||
| + | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Logo|Banner Logo]] | ||
#[[SUNScholar/XMLUI_Theme/M2/Customisation/Institutional Branding|Institutional Branding]] | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Institutional Branding|Institutional Branding]] | ||
#[[SUNScholar/XMLUI_Theme/M2/Customisation/Document Structure|Document Structure]] | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Document Structure|Document Structure]] | ||
| − | |||
| − | |||
| − | |||
#[[SUNScholar/XMLUI_Theme/M2/Customisation/Footer Design|Footer Design]] | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Footer Design|Footer Design]] | ||
| − | #[[SUNScholar/XMLUI_Theme/M2/Customisation/ | + | #[[SUNScholar/XMLUI_Theme/M2/Customisation/Extra Customisation|Extra Customisation (Optional)]] |
| − | === | + | ===Live Webapp Quick Changes=== |
| − | ==== | + | ====CSS changes==== |
This saves you from having to recompile the whole DSpace webapp just to see what effect a few SASS CSS changes will make. | This saves you from having to recompile the whole DSpace webapp just to see what effect a few SASS CSS changes will make. | ||
Type the following: | Type the following: | ||
| − | cd $HOME/ | + | cd $HOME/webapps/xmlui/themes/Mirage2 |
compass watch | compass watch | ||
| − | Now using another login session, you can modify the SASS CSS stylesheets in the <tt>'''styles'''</tt> folders and the <tt>'''main.css'''</tt> file will compile instantly. | + | <font color="red">'''Now using another login session, you can modify the SASS CSS stylesheets in the <tt>'''styles'''</tt> folders and the <tt>'''main.css'''</tt> file will compile almost instantly.'''</font> |
| − | + | If you make a serious error, then compass will crash, so you must watch the terminal where compass is running to check for errors and if needed restart compass. | |
| − | To synchronise the live webapp styles folder with the source folder, type the following: | + | ''<u>Just remember to make the same changes to the source SASS CSS files, so that your changes will be applied after the next DSpace rebuild:</u>'' |
| − | rsync -av $HOME/ | + | |
| + | To synchronise the live webapp CSS styles folder with the source folder, type the following: | ||
| + | rsync -av $HOME/webapps/xmlui/themes/Mirage2/styles/ $HOME/{{Source}}/dspace-xmlui-mirage2/src/main/webapp/styles/ | ||
| + | |||
| + | ====XSL changes==== | ||
| + | After modifying the XSL stylesheets in the live webapp XSL folder, just press refresh in your browser to view the changes. If your browser has caching enabled, try to disable caching while doing development work. | ||
| + | |||
| + | ''<u>Just remember to make the same changes to the source XSL files, so that your changes will be applied after the next DSpace rebuild:</u>'' | ||
| + | |||
| + | To synchronise the live webapp XSL stylesheet folder with the source folder, type the following: | ||
| + | rsync -av $HOME/webapps/xmlui/themes/Mirage2/xsl/ $HOME/{{Source}}/dspace-xmlui-mirage2/src/main/webapp/xsl/ | ||
===Screenshots=== | ===Screenshots=== | ||
| + | Below are screenshots of our modified Mirage2 theme. | ||
| + | ====Front Page==== | ||
[[File:M2.png|1000px|border]] | [[File:M2.png|1000px|border]] | ||
| + | ====View Item==== | ||
| + | [[File:M2-1.png|1000px|border]] | ||
| + | |||
| + | ====View Community==== | ||
| + | [[File:M2-2.png|1000px|border]] | ||
| + | |||
| + | ====ORCID Lookup==== | ||
| + | [[File:M2-3.png|1000px|border]] | ||
| − | [[File:M2- | + | ====Simple Submission Form==== |
| + | [[File:M2-4.png|1000px|border]] | ||
===Help Links=== | ===Help Links=== | ||
| − | |||
*[http://github.com/DSpace/DSpace/tree/master/dspace-xmlui-mirage2 Read about Mirage 2 theme customisation on github.] | *[http://github.com/DSpace/DSpace/tree/master/dspace-xmlui-mirage2 Read about Mirage 2 theme customisation on github.] | ||
| − | |||
*http://gianthatworks.com/entry/bootstrap-for-designers | *http://gianthatworks.com/entry/bootstrap-for-designers | ||
*http://mdo.github.io/code-guide | *http://mdo.github.io/code-guide | ||
*https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_variables.scss | *https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_variables.scss | ||
*https://github.com/twbs/bootstrap/blob/master/less/variables.less | *https://github.com/twbs/bootstrap/blob/master/less/variables.less | ||
| − | + | ||
| + | ===Theme Archive=== | ||
| + | Below are links to archived themes that can be used as examples. | ||
| + | *https://github.com/DSpace-Labs/Mirage2-Frozen | ||
| + | *https://github.com/hamslaai/Mirage2 | ||
| + | *https://github.com/lannguyenbe/Mirage2 | ||
| + | *https://github.com/dbaker3/phw-mirage2 | ||
| + | |||
| + | ===Reference=== | ||
| + | *http://wiki.duraspace.org/display/DSDOC5x/Mirage+2+Configuration+and+Customization | ||
| + | [[Category:Customisation]] | ||
Latest revision as of 11:31, 26 June 2016
Back to Mirage 2 Theme
Contents
Introduction
These wiki pages will assist you in customising the Mirage 2 theme that was introduced with DSpace 5.X.
Please read the requirements first, to gain an understanding of the "bootstrap" framework, then proceed with the rest of the customisation.
This customisation is very basic and is intended for those who have basic web 2.0 design skills.
Please Note:
- It is assumed that the Mirage 2 theme was installed according to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/XMLUI_Theme/M2.
- It is also assumed that you installed DSpace according to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/DSpace.
- After you have completed your customisation, you will have to rebuild DSpace.
Procedures
- Requirements
- Review Common Elements
- Front Page Text
- Palette (colours)
- Typography (fonts)
- Banner Logo
- Institutional Branding
- Document Structure
- Footer Design
- Extra Customisation (Optional)
Live Webapp Quick Changes
CSS changes
This saves you from having to recompile the whole DSpace webapp just to see what effect a few SASS CSS changes will make.
Type the following:
cd $HOME/webapps/xmlui/themes/Mirage2
compass watch
Now using another login session, you can modify the SASS CSS stylesheets in the styles folders and the main.css file will compile almost instantly.
If you make a serious error, then compass will crash, so you must watch the terminal where compass is running to check for errors and if needed restart compass.
Just remember to make the same changes to the source SASS CSS files, so that your changes will be applied after the next DSpace rebuild:
To synchronise the live webapp CSS styles folder with the source folder, type the following:
rsync -av $HOME/webapps/xmlui/themes/Mirage2/styles/ $HOME/source/dspace-xmlui-mirage2/src/main/webapp/styles/
XSL changes
After modifying the XSL stylesheets in the live webapp XSL folder, just press refresh in your browser to view the changes. If your browser has caching enabled, try to disable caching while doing development work.
Just remember to make the same changes to the source XSL files, so that your changes will be applied after the next DSpace rebuild:
To synchronise the live webapp XSL stylesheet folder with the source folder, type the following:
rsync -av $HOME/webapps/xmlui/themes/Mirage2/xsl/ $HOME/source/dspace-xmlui-mirage2/src/main/webapp/xsl/
Screenshots
Below are screenshots of our modified Mirage2 theme.
Front Page
View Item
View Community
ORCID Lookup
Simple Submission Form
Help Links
- Read about Mirage 2 theme customisation on github.
- http://gianthatworks.com/entry/bootstrap-for-designers
- http://mdo.github.io/code-guide
- https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_variables.scss
- https://github.com/twbs/bootstrap/blob/master/less/variables.less
Theme Archive
Below are links to archived themes that can be used as examples.
- https://github.com/DSpace-Labs/Mirage2-Frozen
- https://github.com/hamslaai/Mirage2
- https://github.com/lannguyenbe/Mirage2
- https://github.com/dbaker3/phw-mirage2
