Versions Compared

Old Version 1

changes.mady.by.user Bram Luyten (Atmire)

Saved on

compared with

New Version Current

changes.mady.by.user Bram Luyten (Atmire)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed location, added Step by step how to use

...

Info
titleHow 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. 

Tasklist
titleChecklist: this is when you're done
enableLockingtrue
||Completed||Priority||Locked||CreatedDate||CompletedDate||Assignee||Name||
|F|M|T|1389620440889|          |bram|Use Case and high level benefits. Can someone with limited technical background understand what this is about?|
|F|M|T|1389620638059|          |bram|Step by step how to use. Can someone with limited technical background use the feature?|
|F|M|T|1389620491621|          |bram|Technical implementation details. Did you provide enough details for other developers to add or extend on your work?|
|F|M|T|1389620524789|          |bram|Configuration. Did you describe which aspects of your contribution can be configured and where configuration happens?|
|F|M|T|1389620576924|          |bram|Template text cleanup. Have you removed the template text that was initially included on this page?|
|F|M|F|1389620841679|          |bram|Installation details. If your functionality will not be enabled by default in DSpace, provide details on how the functionality can be installed or enabled.|

 

Use case and high level benefits

...

Warning
titleHow 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.

...