Contribute to the DSpace Development Fund

The newly established DSpace Development Fund supports the development of new features prioritized by DSpace Governance. For a list of planned features see the fund wiki page.

Contents

Introduction

This short booklet is intended to introduce the commonest non-obvious customization-related tasks for newcomers to DSpace administration. It has been written against the stable version 1.4.2 of DSpace and the Manakin user interface, version 1.1.

We have tried to include instructions for different operating systems as required; most customizations, however, work identically cross-platform.

Before you start

Different parts of DSpace live in different areas on the DSpace server. Because each DSpace administrator decides where some parts of DSpace live, and operating systems have different ideas about where other parts live, we have employed italics to mark missing pieces of file paths. Some directories whose precise location varies among systems require special attention:

  • [dspace-source] – The directory into which the DSpace administrator unpacks the downloaded DSpace code.
  • [manakin-source] – The directory into which the DSpace administrator unpacks the downloaded Manakin source code.
  • [dspace] – The directory into which the Java
    ant
    command deposits compiled DSpace code. This location is set in DSpace's configuration file, dspace.cfg, as
    dspace.dir
  • [tomcat] – The directory where Apache Tomcat is installed. If you are not using Apache Tomcat, you may wish to customize some of these "how-to" documents to better match your servlet engine of choice (e.g. Jetty, Resin, etc).

Other DSpace resources

Although this "DSpace How-To Guide" introduces many common customizations currently available within DSpace, it should not be considered a stand-alone document. You should be aware of many other valuable DSpace resources, including:

Other useful resources

This "DSpace How-To Guide" introduces many customizations which rely on some general knowledge of other technologies, including XHTML, CSS, XML and XSLT. If you need a refresher on any of these technologies, here are a few useful web resources (available as of June 2007):

  • W3Schools Tutorials/Guides – introductory tutorials, references, and examples for XHTML, CSS, XML, XSLT, SQL, among many others.
  • HTML Dog – HTML and CSS References and tutorials for all levels of knowledge
  • Holy CSS Zeldman! – all things CSS, with intermixed links to good HTML, Javascript, and web design sites.
  • MaxDesign - CSS tutorials for web developers. Covers customizing page layout using CSS-based floats, lists and selectors.

Other useful skills

Many tasks that are cumbersome to manage through the DSpace web interface can be easily managed in the database with a little SQL. For example, withdrawing all the items in a particular collection takes quite some time in DSpace proper, but can be done in just one quick SQL query. However, you should always be sure to backup your database before running any SQL queries which will modify or remove a large number of items! Time spent learning SQL basics will reap rich returns in time saved.