All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
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.
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.
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.
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
Recommended so that people can easily navigate using the Table of Contents at the top.
Heading 5 is generally not used and has no visual difference with heading 4. When in doubt, don't use Heading lvl 5.
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?
Here is a very short introduction to the hierarchy of the documentation. when in doubt, put your page straight under Using DSpace.
1 Comment
Peter Dietz
I'll add that I've found myself peeking at the documentation for Discovery, as my gold standard of documentation, to help ensure my features have good documentation. Its helpful to follow the tone/language/style, and to have roughly the same good formatting, and sections.