All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
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 | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a29262b3-b251-4620-89da-395b5b748f96"><ac:plain-text-body><![CDATA[ |
Relative Link (Good!) |
|
]]></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 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="bebc6c0c-17ec-4d72-8c6c-b0ead5b9997c"><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="2027b82d-da18-41df-b9f2-82206ceaa552"><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="30728913-cfbc-4767-8719-f1091f5df1ba"><ac:plain-text-body><![CDATA[ |
Relative Link (Good!) |
|
]]></ac:plain-text-body></ac:structured-macro> |
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 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:
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).
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!