Documentation Wiki Spaces

Starting with 1.7.x, each major version of DSpace has its own Wiki Space.

• Space ID: Each DSpace Documentation space has a "Space ID" of the following format: "DSDOCxx" (where 'xx' represents the version of DSpace)
  • (e.g.) 1.7.x docs are in DSDOC17, 1.8.x docs are in DSDOC18
• General Space: The DSDOC (generic) space is used to inform people of all available DSpace Documentation, e.g. All Documentation, as well as provide a central place for these internal Documentation Management notes.
• Space Header: Each DSpace Documentation space also has a header (see Documentation Space Headers below) which lets users know if it refers to an old, current or unreleased version of the software.
• Left Sidebar: The Left Sidebar on all Documentation Spaces is identical – it just loads the _DocLeftSidebar reusable content page. This is very powerful as it means that the sidebar on all existing Spaces can be edited from a single location.
  • Note: If you view the Wiki source, you'll notice that the _DocLeftSidebar actually assigns CSS classes to each Documentation link in the "All Documentation" list. This is so that each Documentation Space can have a custom CSS style which makes its listing appear bold when you are in that Space. For an example, see the DSDOC17, and DSDOC18 spaces – notice how different items in that listing are bolded. This is a custom CSS style enabled for each Space.

Documentation Space Headers

As mentioned above, on each Documentation Space we want to provide users with context information to let them know whether the Documentation they are looking at is current, and also give them information on how to get to current or older documentation (based on the version of DSpace they are using).

Editing Headers:

• Space Headers can be edited only by a Wiki Space Administrator
• Visit "Browse -> Space Admin"
• Click on "Themes" (Under "Look and Feel" section)
• Click on "Configure Theme" (for the current Documentation Theme)
• You'll see a "Header" field that you can fill out and click "Save"

There are three types of headers we use on Documentation spaces.

Current Documentation Header

This header is used to notify users that the Documentation Space they are visiting is for the current version of DSpace:

What it looks like:

Wiki Source:

{tip:title=Current Release}
This documentation covers the latest release of DSpace, version 1.8.0. Looking for another version? [See all documentation|DSDOC:All Documentation].
{tip}

Old Documentation Header

This header is used to notify users that they are looking at an old version of the Documentation.

What it looks like:

This documentation relates to an old version of DSpace. {spacejump:DSDOC18|alias=View this same page in the current documentation} (if it exists). Looking for another version? [See all documentation|DSDOC:All Documentation].

Wiki Source:

{note:title=Old Release}
This documentation relates to an old version of DSpace. {spacejump:DSDOC18|alias=View this same page in the current documentation} (if it exists). Looking for another version? [See all documentation|DSDOC:All Documentation].
{note}

Unreleased Documentation Header

This header is used to notify users that they are currently viewing documentation for an unreleased version of DSpace.

What it looks like:

This documentation is unreleased and still in development. *It may describe features which are not yet released in DSpace.* \\ {spacejump:DSDOC18|alias=View this same page in the current documentation} (if it exists). Looking for another version? [See all documentation|DSDOC:All Documentation]

Wiki Source:

{warning:title=Unreleased Documentation}
This documentation is unreleased and still in development. *It may describe features which are not yet released in DSpace.* \\ {spacejump:DSDOC18|alias=View this same page in the current documentation} (if it exists). Looking for another version? [See all documentation|DSDOC:All Documentation]
{warning}

Reusable Content

We