All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Each major version of DSpace has its own Wiki Space.
In order to prepare for the next release, you obviously need to begin Unreleased Documentation early. The easiest way to do this is to generate a new Documentation Space for that unreleased version, and copy the latest Documentation over to that space. Luckily, the "Copy Partial Space" plugin for Confluence makes this relatively easy to do.
Here's the steps:
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:
There are three types of headers we use on Documentation spaces.
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:
Current Release
This documentation covers the latest release of DSpace, version 5.x. Looking for another version? See all documentation.
Wiki Source:
{tip:title=Current Release} This documentation covers the latest release of DSpace, version 5.x. Looking for another version? [See all documentation|DSDOC:All Documentation]. {tip}
This header is used to notify users that they are looking at an old version of the Documentation.
What it looks like:
Old Release
This documentation relates to an old version of DSpace, version 4.x. Looking for another version? See all documentation.
Wiki Source:
{note:title=Old Release} This documentation relates to an old version of DSpace, version 4.x. Looking for another version? [See all documentation|DSDOC:All Documentation]. {note}
This header is used to notify users that they are currently viewing documentation for an unreleased version of DSpace.
What it looks like:
Unreleased Documentation
This documentation is unreleased and still in development. It may describe features which are not yet released in DSpace.
(if it exists). Looking for another version? See 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:DSDOC5x|alias=View this same page in the current documentation} (if it exists). Looking for another version? [See all documentation|DSDOC:All Documentation] {warning}
As mentioned above, on each Documentation Space we want to have a shared left sidebar which keeps all our Documentation looking similar in nature and allows users to more easily jump between versions of the Documentation. This shared left sidebar is actually a very simple Wiki page (see _DocLeftSidebar), which we load into the "navigation" section of each of the Documentation spaces.
Editing The Left Sidebar:
In the "Navigation" field, you want to place the following Wiki Markup (which will cause the _DocLeftSidebar wiki page to appear as the sidebar):
{include:DSDOC:_DocLeftSidebar}
Now, we'll likely want to ensure this version of DSpace is listed in the Sidebar. To do that, just visit the _DocLeftSidebar page, edit it, and add a line similar to the following:
Create a new "div" macro (creates a new HTML <div> tag for us)
Set Class as "DSDOC4x" (for DSDOC4x space)
Set Style as "padding-left: 10px" (to align with all others in the list
As the text (inside the "div"): "DSpace 4.x (Unreleased)" (and link it to the DSDOC4x Homepage)
Click "Edit" and add a style similar to the following (notice that this "div" style matches the "div" macro defined above):
/** Bold sidebar link to this Space **/ div.DSDOC5x { font-weight:bold; }
The final result is that, when you go back to the Space, you'll see that the contents of the _DocLeftSidebar wiki page now appear in the left sidebar. You'll also notice that this Space's name should appear bolded, and when you click on different versions of the Documentation those Space names should appear bolded instead. This allows the sidebar to always be identical across all Documentation Spaces, which makes it easier to manage across all our documentation.
Reusable content can be found on the ReusableContent child page.