You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Editing Best Practices (to avoid release errors)

Always use Relative Wiki Links!

When entering in links to other pages in this wiki, never use the Full Harcoded Link. Instead, always use a relative link!

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

Harcoded Link (BAD!)

https://wiki.duraspace.org/display/DSDOC18/Configuration

Relative Link (Good!)

[DSDOC18:Configuration]

(info) General format is: [space-id:page name]

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

https://wiki.duraspace.org/display/DSDOC18/Configuration#Configuration-GeneralConfiguration

Relative Link (Good!)

[DSDOC18:Configuration#General Configuration]

(info) General format is: [space-id:page name#header text]

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]

Relative Link (Good!)

[General Configuration Options|DSDOC18:Configuration#General Configuration]

(info) General format is: [text of link|space-id:page name#header text]

You can view the source of this page for examples

Use our standard Table of Contents when creating a new page

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 Table of Contents

{toc:outline=true|style=none}

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

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

There may be occasional exceptions to this rule. One example is the Upgrading a DSpace Installation page, which uses a bulleted-list based Table of Contents (as the outline numbers look confusing next to the DSpace version numbers).

Additional General Wiki Syntax Hints

Some general Wiki Syntax hints/tips can be found in our DSpace Wiki Style Guide.

Obviously, just clicking "Edit" on any wiki page (and especially looking at the "Wiki Markup") is a great resource as well!

  • No labels