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="4aabd5c3-db03-4082-990b-7056db203745"><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 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="363ddea9-7106-4de7-909a-5f34eb1270e1"><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 "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="a8f2a1d7-0dff-48f4-a4d2-f883f86cffef"><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="1a87ba4e-11af-4d1d-a699-459a1f5709bc"><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! |