Versions Compared

Old Version 4

changes.mady.by.user Bram Luyten (Atmire)

Saved on

compared with

New Version 5

changes.mady.by.user Bram Luyten (Atmire)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: general mirage 2 customization guideline

...

Code Block
### Settings for the Item page in Mirage2 theme ###
# Whether the title or the label of a file should be used to display it on the item page
mirage2.item-view.bitstream.href.label.1 = label

# Whether the title or the label of a file should be used as a fallback to display it on the item page
mirage2.item-view.bitstream.href.label.2 = title

Developer documentation

...

Customizing Mirage 2 

Warning
titleDo not attempt the following

Do not attempt to manage local customizations to Mirage 2 in:

  • src/dspace/modules/xmlui/src/main/webapp/themes
    • This is where you would put standard XMLUI Themes or customizations. However, because of the Mirage 2 build process, this won't work.
  • src/dspace-xmlui-mirage2
    • This is the place where the community, committers and contributors manage the STANDARD version of Mirage 2. You could change files there if your intention is to create a contribution that would benefit everyone. But in this case, we are not talking about a local customization.
Tip
titleRecommended approach

Manage your local Mirage 2 customizations or derived themes in:

src/dspace/modules/xmlui-mirage2

Managing your local customizations in this folder comes with the advantage that you ONLY need to keep files you have changed, compared to the standard Mirage 2 folder. To get you started, the contributors have added a _styles.scss file where you can make local scss customizations:

https://github.com/DSpace/DSpace/tree/master/dspace/modules/xmlui-mirage2/src/main/webapp/themes/Mirage2/styles

Automatically retrieving the latest versions of Mirage 2 dependencies

...

You can make these changes in the bower.json file: bower.json

Just like any other changes to Mirage 2As mentioned in the previous section, make sure you manage them this file and any changes you make to it in /dspace/modules e.g. dspace/modules/xmlui-mirage2/src/main/webapp/themes/Mirage2. It is not recommended to update the officially distributed bower.json file directly in /dspace-xmlui-mirage2

Additional Developer documentation

Specific guidelines and technical details about Mirage 2 are part of the Readme.MD file in the Mirage 2 sourcetree.