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

Compare with Current View Page History

« Previous Version 11 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/DSDOCDEV/Configuration

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0ae506ff-5a89-4abf-9729-3d4aa40a8f9b"><ac:plain-text-body><![CDATA[

Relative Link (Good!)

[DSDOCDEV:Configuration]
(info) General format is: [DSDOCDEV:page name]

]]></ac:plain-text-body></ac:structured-macro>

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

Harcoded Link (BAD!)

https://wiki.duraspace.org/display/DSDOCDEV/Configuration#Configuration-BatchMetadataEditing

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1b9b21df-85e7-41bf-8bc7-81df7193b94c"><ac:plain-text-body><![CDATA[

Relative Link (Good!)

[DSDOC18:Configuration#Batch Metadata Editing]
(info) General format is: [DSDOCDEV:page name#header text]

]]></ac:plain-text-body></ac:structured-macro>

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4dfb753a-68fc-4bb3-8dfc-0b5d5cf29f79"><ac:plain-text-body><![CDATA[

Harcoded Link (BAD!)

[Configuration for Batch Metadata Editing|https://wiki.duraspace.org/display/DSDOCDEV/Configuration#Configuration-BatchMetadataEditing]

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="29bb289d-978d-4b44-ae7a-be4cac5b796b"><ac:plain-text-body><![CDATA[

Relative Link (Good!)

[Configuration for Batch Metadata Editing|DSDOC18:Configuration#Batch Metadata Editing]
(info) General format is: [text of link|DSDOCDEV:page name#header text]

]]></ac:plain-text-body></ac:structured-macro>

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 (just replace "<PAGE NAME>" with the name of the page)

h1. DSpace System Documentation: <PAGE NAME>

{toc:outline=true|style=none|minLevel=2}

This table of contents does a few things:

  1. starts the page off with an <H1> heading (all headings after that should be h2. or h3. or h4. , etc.)
  2. formats the TOC like an "outline" (1, 1.1, 1.2, 2, 2.1, etc.)
  3. turns off any special styling
  4. Ensures the TOC skips over the first <H1> heading and starts at all headings below it.

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

All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license, unless otherwise noted.