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.
Introduction
This is a template page for a new DSpace contribution. If you are unsure about the appropriate format or content, just look at this example. This page can be copied and used to fill out your new documentation.
Make sure you do NOT use Heading level 1, and stick to level 2 as the highest level in your document. Level one is reserved for the top level headings in the PDF version of the documentation.
How to use info boxes
Info boxes are important highlights of information that are not really warnings. Often they are used to highlight users to differences in functionality between different versions of DSpace.
"DSpace Discovery has become the default search and browse solution as of DSpace 4.0" is an example.
0%
Checklist: this is when you're done
Use case and high level benefits
Describe which need the contribution is fulfilling and why it was originally created. Screenshots are always nice and will make people enthusiastic about your contribution.
Installation
If it takes any work to enable the contribution, please elaborate in detail. It is recommended that you provide a good default configuration so that your configuration can run straight out of the box.
Technical Implementation Details
If there are any possibilities to customize the contribution, it is good to provide some details on your implementation, or which design decisions have been taken.
How to use warnings
If your contribution is known to be untested or incompatible with certain parts of DSpace, for example JSPUI/XMLUI, Oracle, ... highlight it in a warning like this. Warnings can be found under Insert > Other Macros
Sub headings are generally fine
Recommended so that people can easily navigate using the Table of Contents at the top.
but don't
drive it too far
Heading 5 is generally not used and has no visual difference with heading 4. When in doubt, don't use Heading lvl 5.
Configuration
Explain which configuration parameters are available, in which files they can be found and which procedure is required for updating. Does it require a rebuild or is a tomcat restart enough, etc?
Where should I put my page? (DELETE this section from template when finished)
Here is a very short introduction to the hierarchy of the documentation. when in doubt, put your page straight under Using DSpace.
- Installing DSpace
- Upgrading DSpace
- Using DSpace: documentation that applies to a working, functional DSpace
- Ingesting Content and Metadata: relevant section if your feature is related to the creation of content in DSpace
- Exporting Content and Metadata: relevant section for getting content out of DSpace
- System Administration: activities and diagnostic to restore your DSpace to a full working state, or to maintain it that it stays that way.
- Command Line Operations: important page that you can edit if your new contribution introduces any new command line operations.
- DSpace reference: glossary, overviews, often linking out to other parts of the documentation for more detail
Overview
Content Tools
All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license
, unless otherwise noted.