Skip to content

Customizations

Jump to bottom
Amanda French edited this page Dec 22, 2015 · 12 revisions

This page lists theme customizations that are not configurations

Configurations = DSpace assumes the code will be changed and provides support for the change

Customizations = DSpace does not assume the code will be changed, and therefore system upgrades will overwrite the change

Overlays

Maven provides for overlays, which we consider to be customizations, not configurations. This is a method of overriding Java classes. The advantages include

  • overwritten classes can be written once and used in multiple locations
  • the common location for overlays makes it easier to maintain customizations as the DSpace software evolves

Basically, you will need to find the file that you wish to change; copy the file to the correct overlay location in [dspace-source]/dspace/modules/*; then make the changes to that copy. You can also create new overlay files in this location. If a change is in the [dspace-source]dspace/modules directory, it is considered an overlay. For instance, if you want to change a system messages displayed on a page, you can make a change in [dspace-source]dspace/modules/xmlui/src/main/webapp/i18n/messages.xml. Major updates to DSpace will overwrite this file.

DSpace 5 User Manual - Maven WAR Overlays
Maven Overlays
Making DSpace 1.5 Your Own: Customizations via Overlays is old but explains how overlays work in DSpace.

###Mirage2 The Mirage2 theme does allow for certain configurations, but other changes to the theme will be overwritten by theme / system upgrades.

DSpace wiki for the location of local theme customizations
Mirage2 readme
SUNScholar Mirage2 Guide

Current Customizations

Give the path of the file name(s) customized and a short description of the change. If we have a list paths to system files changed, we can take the most recent copies of those files and simply put them in the correct place in new versions of DSpace.

  • Changes to various system messages: /dspace/modules/xmlui/src/main/webapp/i18n
  • Add content-type facet browser after search, etc.
  • Add link to off-campus sign-in on front page
  • Allow all users to see statistics & put stats on front page
  • Video playback within in item record
  • Item - Subtitle/caption support (only in use by 1 video at present)
  • Collection - Custom submission form for NDTLD
  • Collection - Custom submission form for OMALS
  • Collection - Customizations for computer science technical reports collection
  • Collection - Add Discovery browse facets for ETD collection
  • Theme - customization to force smaller thumbnail width in Mirage theme
  • Theme - header/footer/logo/links
  • Theme - force Advanced Search link to appear even when Discovery search is enabled
  • Theme - left justify text in full item
  • Theme - customized favicon
  • Functions - Customized item importer to allow embargo date to be set on etds upon import (not sure if this feature is in use)

Customizations to DSpace 2.x (implemented previously but not present May 20, 2015)

  • Theme like old Virginia Tech website
  • Expandable communities/collections list
  • Video from Rebecca embedded in theme: https://www.youtube.com/watch?v=0I3bklg8wz4
  • Display HTML articles inline for VT news collection
  • Display images inline for 4/16 collection
Clone this wiki locally