Links to a resource on a versioned site.
Description
The Site Link Macro allows to render a link to a resource on a versioned site. The system is identified via Confluence shortcuts or space properties. The Project Group ID, Project Artifact ID, and Project Version provide additional information to construct the URL to the resource.
This link construction makes it easy to define the base URL (e.b. via url-site
) and the project coordinates via space properties. If the version of the project's product changes, the URLs created by this macro automatically use the version information.
Properties
System Identifier
Identifies the connection information via Confluence shortcuts or space properties.
The system identifier is checked at three locations
The search for the system connection information is conducted as follows. Use the URI discovered first to connect to the server.
- Check for a space property
url-site
- Check for a space property
site
Only available with projectdoc Toolbox version 1.11 and up! - Check for a space property
shortcut-id-site
.
Lookup the connection information from the shortcut links with the value retrieved from the space property. - Check the shortcut links for a value
site
. - Check application navigator for a value
site
.
If no value is specified at any of the locations above, the macro renders an error message like this:
In this example for a system macro the referenced, but undefined system, is called test-repo
.
File
The file on the site to link to.
Label
The label for the link. Defaults to the name of the file - and if not given - the identifier of the site.
Server Root Based
Uncheck to suppress g/a/v path generation.
May be overridden by the space property Server Root Based.