Editing Best Practices (to avoid release errors)

Always use Relative Wiki Links!

...

For example, if you wanted to link to the Configuration page:

...

Harcoded Link (BAD!)

...

• Insert a new "Link"
  
  • Under the "Search" sidetab, type in "Configuration"
  • Locate the appropriate "Configuration" page in the Wiki and select it (pay close attention to the Wiki space it's in..there may be several pages called "Configuration")
  • Optionally, provide custom "Link Text" (at the bottom)

...

Relative Link (Good!)

...

Another example! This time, of a link to a specific heading on a page. Suppose you wanted to link to the General Configuration header on the Configuration page:

...

Harcoded Link (BAD!)

...

Relative Link (Good!)

...

One final example. It's the same as the above "General Configuration" example above, but now we are changing the text in the link to say "General Configuration Options"

...

Harcoded Link (BAD!)

...

[General Configuration Options|https://wiki.duraspace.org/display/DSDOC18/Configuration#Configuration-GeneralConfiguration]

• Insert a new "Link"
  
  • Select the "Advanced" sidetab
  • In the "Link" field, type: "Configuration#General Configuration"  (Format: "Page Name#Heading")
  • In the "Link Text" field, add some text for the link (e.g. "General Configuration")

...

Relative Link (Good!)

...

...

In the Official DSpace Documentation, we try to use a standard "table of contents" on each and every page (it's even at the top of this page).Here's the Wiki code to create that standard

• Insert a new Table of Contents

...

• Macro, with the following settings
  
  • Output Type: list
  • Display Section Numbering: (checked/selected)
  • List Style: none
  • Minimum Heading Level: 2

This table of contents does a few things:

1. formats the TOC like an "outline" (1, 1.1, 1.2, 2, 2.1, etc.)
2. turns off any special styling
3. ensures the numbering begins with the first "Heading 2"

For an example, just view the Wiki Markup for this page!

...