SUNScholar/Customisation

Back to Guidelines

Back to After Installation Tasks

EIFL Webinar
https://www.youtube.com/watch?v=ddMZgn16l3g

SOFTWARE DEVELOPMENT
Click on the heading above,

OPERATIONAL GUIDE
This customisation relates to the technical details involved in the customisation of features available with DSpace, not the customisation required when performing operational management of the research archive. For example, the creation of communities and collections is for the repository director/manager to determine. See: http://scholar.sun.ac.za for an example of a communities and collections hierarchy.

Please consult the OPERATIONAL GUIDE  for recommendations regarding the operational management of a digital research archive using DSpace software.

CUSTOMISATION SCOPE AND CAPACITY
If the feature customisation is to be preserved on the repository system for the long term, then adequate resources must be provided to ensure continuity of the customisation during system upgrades. Depending on the amount of customisation, this could turn out to be VERY EXPENSIVE  for the institution if using an external service provider and if upgrades are done on a yearly basis. Therefore, the rule of thumb, for resource scarce institutions that do not have the system capacity, is to keep customisation to the ABSOLUTE MINIMUM or acquire the resources to build adequate system capacity locally in-house.

README FIRST - Advanced Feature Customisation (Modules Overlay Method)
Please read about advanced customisation before starting any customisation work, as it is the basis for most of the customisation tasks.

The idea is to put all your customised code into the folder: $HOME//dspace/modules The source code is copied from the folder: $HOME/

*** What is this $HOME thing ***
This allows you to keep the source code intact and to keep your modifications in one separate place. Using this method also helps greatly during upgrades.

Also please note, that to apply these customisations you will usually have to rebuild DSpace.

See the official explanation below:
 * https://wiki.duraspace.org/display/DSDOC5x/Advanced+Customisation
 * https://wiki.duraspace.org/display/DSDOC4x/Advanced+Customisation
 * https://wiki.duraspace.org/display/DSDOC3x/Advanced+Customisation

Introduction
All of the feature customisation and system administration documentation assumes:


 * 1) That DSpace has been installed according to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/DSpace.
 * 2) That you are working as the "dspace" user, which was created during the installation of the Ubuntu server software.

Now that you have a working repository, you will probably want to make it your own using a proper change management system.

Below are links to help pages with detailed information on how to customise your repository, to make it fit for the purpose for which it was created.

For more information consult the official DSpace documentation and subscribe to the DSpace help mailing lists (see bottom of page below) so that you can ask the experts for help.

Before beginning customization using this guide, please familiarize yourself with command line editor, nano. See below for brief instructions.

Repository

 * 1) Browse and Search Indexes
 * 2) Web Analytics
 * 3) Theme
 * 4) Licences
 * 5) Language
 * 6) Email Templates

Items

 * 1) Submission System
 * 2) Usage Statistics
 * 3) Media Filters (Item full text search and thumbnails)
 * 4) Digital Object Checksums
 * 5) Digital Object Identifier's
 * 6) Open Search
 * 7) RSS Feeds

Users

 * 1) Researcher Authorisation (LDAP Server)
 * 2) Researcher Identification (ORCID Server)

Items

 * 1) Curation
 * 2) Export and Import
 * 3) Versioning
 * 4) PDF Cover Page

Interoperability

 * 1) Harvest Remote Collections (OAI Consumer)
 * 2) Allow Remote Harvesters (OAI Producer)
 * 3) Allow Remote Deposits (SWORD interface)

International DSpace Support
''' Before posting a request, please see: https://wiki.duraspace.org/display/DSPACE/Mailing+List+Etiquette first. '''
 * DSpace General
 * DSpace Technical
 * DSpace Change Log

African Repository Support

 * http://lists.lib.sun.ac.za/mailman/listinfo/irtalk
 * http://lists.lib.sun.ac.za/mailman/listinfo/duraspace

DSpace References

 * https://wiki.duraspace.org/display/DSDOC5x/DSpace+Reference
 * https://wiki.duraspace.org/display/DSDOC4x/DSpace+Reference
 * https://wiki.duraspace.org/display/DSDOC3x/Appendices