Documentation Administration

Documentation Wiki Spaces Overview

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
  • For 3.x, the docs are in DSDOC3x
• 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.
• Shared 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.

Copying Existing Docs to a New 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:

1. First, you need to login as an Administrative user and visit the homepage of the latest Documentation (e.g. DSDOC17)
2. Under the "Tools" side-menu, select the "Copy into New Space" option (should be at the bottom)
3. Select a new Space Name and Space Key (ID) for this brand new space. Make sure to follow our recommended Space ID naming conventions as described above.
   • Space Name Format: "DSpace #.x Documentation" (e.g. "DSpace 3.x Documentation")
   • Space Key (ID) format: "DSDOC#x" (e.g. DSDOC3x for 3.x Documentation)
4. Once the new Space has been generated, visit the new Space. You'll need to change the main page name to match the new version number (e.g. "DSpace 3.x Documentation").
5. Next you'll need to tweak several Space settings to get it formatted similar to the rest of our Documentation. We'll start simple by tweaking the "Space Description"
   • Go to "Browse -> Space Admin" and change the "Space Description" to have the correct version number (e.g. "Official docs for DSpace 3.x") and click "Save".
6. Now, change the "Documentation Space Header" so that we have the "Unreleased Documentation Header" in place. The full instructions can be found below in the #Documentation Space Headers section.
7. Now, change the Left Sidebar to load up the _DocLeftSidebar shared content (this displays the DSpace logo and list of recent versions). The full instructions can be found below in the #Documentation Shared Sidebar section.
8. Modify the All Documentation wiki page to list this version of the Documentation, and make sure to note that it is UNRELEASED.
9. Let's check/update the Space permissions / access rights
   • Go to "Browse -> Space Admin" and click on "Permissions"
   • On the Permissions page, assign these permissions to these groups:
     • 'confluence-users' group -> "View" and "Add Comments" permissions only
     • 'dspace-committer' group -> Full permissions (select all options, including Admin)
     • 'dspace-docgardener' group -> Full permissions (select all options, including Admin)
10. Finally, to ensure everything was copied properly (and no links were "broken" in the process), you may want to look at these reports:
    • "Orphaned Pages" Report (Go to "Browse -> Advanced -> Orphaned Pages") : This is a list of all pages in the space which are not being linked to from another page (no incoming links)
    • "Undefined Pages" Report (Go to "Browse -> Advanced -> Undefined Pages") : This is a list of all broken internal wiki links within the space (and the page the link appears on). Confluence sees a broken link as leading to an "undefined page". Therefore you can use this report to determine if any links are now broken in the Documentation, and fix them appropriately.

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:

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:

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}

Documentation Shared Sidebar

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:

• The left sidebar 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)

• 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}

• Click "Save"

• 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)

  • NOTE: Obviously you can copy from another "div" macro if these settings change.
• Finally, let's tweak the stylesheet of the Space, so that its listing in the sidebar appears bolded.
  • Go back to the "Browse -> Space Admin"
  • Click on "Stylesheet" (Under "Look and Feel" section)

  • 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.DSDOC4x
    {
       font-weight:bold;
    }

  • Click Save

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

Reusable content can be found on the ReusableContent child page.