Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
indextrue
show-titlefalse
titleDescription

The System Link Macro allows to render a link to a resource on a remote server. The system is identified via Confluence shortcuts or space properties.

Transclusion
documentInformation System Extension Notice
idsSummary
projectdoc-toolbox-version=1.0



projectdoc-section
titleProperties


Section
titleLabel

The label for the link. Defaults to the name of the file - and if not given - the identifier of the system.

The value may contains property placeholders.

Image Added


Section
titleTooltip

The tooltip to render with the like. May contain placeholders.


Section
titleSystem Identifier

Identifies the connection information via Confluence shortcuts or space properties.

Transclusion
documentSystem Identifier to URI Resolution Algorithm
idsFragment
system-id=<system-id>

The system identifier is added as CSS class to the link element.


Section
titleSystem Type

Identifies the type of system referenced.

If no system identifier is specified, the system type is used as default. If no predefined system type is applicable, use generic.

The system type is added as CSS class to the link element.

Since version 1.0.


Section
titleFile

The file on the server  to link to.

The value may contains property placeholders.

Control with the Check Resource parameter, how the macro should signal a missing resource.


Section
titleLabelDelimiter

The label for the link. Defaults to the name of the file - and if not given - the identifier of the system.

The value may contains property placeholders.

Image Removed

delimiter to check in case the file is appended. If the delimiter is neither the last character of the system URL nor the first character of the file then this delimiter is inserted between the system URL and file name.

The delimiter is required to be one character. If more characters are specified, for instance none, then no delimiter will be inserted.

If no value is specified, the default delimiter is '/'.

Version Box
since3.4

Available since version 3.4 of the Information Systems Extension.



Section
titleApply Space Properties

If checked the properties defined by the space of the document this macro is part of are applied as defaults.


Section
titleRender Full URL

If checked and no label specified the URL is rendered in full.


2
Section
Section
level
titleCheck Resource

If checked, the resource the URL points to is checked for existence.

Dependent on whether the resource exists or not a CSS class is added.

CSS ClassStatus
projectdoc-resource-existsResource exists
projectdoc-resource-not-existsResource does not exist


Note Box

Note that the check does not use any application link configuration (available since version 1.4). The autoconvert service does. Hence a link macro may show the title of the referenced page as a label, but still is a dead link for users with insufficient privileges.



...