Page History
Editing Best Practices (to avoid release errors)
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Always use Relative Wiki Links!
...
For example, if you wanted to link to the Configuration page:
...
Harcoded Link (BAD!)
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9466633b-207c-4967-a4f6-8316de91a6d1"><ac:plain-text-body><![CDATA[
...
Relative Link (Good!)
...
[DSDOC18:Configuration]
General format is: [DSDOC18:page name]
- 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)
...
Another example! This time, of a link to a specific heading on a page. Suppose you wanted to link to the Batch Metadata Editing General Configuration header on the Configuration page:
Harcoded Link (BAD!) | https://wiki.duraspace.org/display/DSDOC18/Configuration#Configuration-GeneralConfiguration | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ce16dd26-2c86-4c94-a4e1-6e38f2e26489"><ac:plain-text-body><![CDATA[ | Relative Link (Good!) | | ]]></ac:plain-text-body></ac:structured-macro> |
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"
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd01f098-af8e-42da-ac72-504d3f57025b"><ac:plain-text-body><![CDATA[
...
Harcoded Link (BAD!)
...
[General Configuration Options|https://wiki.duraspace.org/display/DSDOC18/Configuration#Configuration-GeneralConfiguration]
...
]]></ac:plain-text-body></ac:structured-macro>
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8b210a9a-a5a0-4062-9d26-a5ac704d1f6e"><ac:plain-text-body><![CDATA[
...
Relative Link (Good!)
...
[General Configuration Options|DSDOC18:Configuration#General Configuration]
General format is: [text of link|space-id:page name#header text]
- 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")
...
| Info |
|---|
You can view the source of this page for examples |
...
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:
...
- formats the TOC like an "outline" (1, 1.1, 1.2, 2, 2.1, etc.) (Display Section Numbering = checked)
- turns off any special styling (List Style = none)
- ensures the numbering begins with the first "Heading 2" (Minimum Heading Level = 2)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!
...
| Info |
|---|
Obviously, just clicking "Edit" on any wiki page (and especially looking at the "Wiki Markup") is a great resource as well! |
Avoid special characters in page titles
Many people arrive on a specific page of the documentation after a google search. That's why it's important to ensure that the relevant keywords for the page are in the URL. This also makes URLs easy to read and share. When you put special characters in the titles, keywords will NOT show in the page URLs. Therefore, avoid special characters like brackets etc.
Official resource on special characters in page titles and effect on page urls.
Overview
Content Tools