System Link Macro

...

Section

index	true
show-title	false
title	Description

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

document	Information System Extension Notice
ids	Summary

projectdoc-toolbox-version=1.0

projectdoc-section

title	Properties

Section

title	Label

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

title	Tooltip

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

Section

title	System Identifier

Identifies the connection information via Confluence shortcuts or space properties.

Transclusion

document	System Identifier to URI Resolution Algorithm
ids	Fragment

system-id=<system-id>

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

Section

title	System 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

title	File

The file on the server to link to.

The value may contains property placeholders.

Image Added

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

Section

title	LabelDelimiter

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

Section

level

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

since	3.4

Available since version 3.4 of the Information Systems Extension.

Section

title	Apply Space Properties

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

Section

title	Render Full URL

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

2

Section

title	Check 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 Class	Status
`projectdoc-resource-exists`	Resource exists
`projectdoc-resource-not-exists`	Resource does not exist

projectdoc-box-note
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.

projectdoc-section

title	Details

Section

title	Autoconvert

To create the macro authors may simply paste the URI to the resource to the editor.

All is needed is a configuration of the resource repository base URI. For more information on this topic, please refer to Autoconvert Information System URIs.

Labels for the generated link may be determined correctly (i.e. will show the title of the page) even if the page needs authentication to be accessed. See Authentication for details.

Note Box

In case you need to use the macro on URLs pointing to the Confluence instance, you should use the tiny URLs. Otherwise (usually) the Confluence built-in autoconverter will take priority in converting the link.

You can determine the tiny URL easily by typing 'k' in the view mode of a page.

Labels may be determined correctly (i.e. will show the title of the page) even if the page needs authentication to be accessed. See Authentication for details.

Section

index	true
title	Related macros

The following macros help with referencing resources on other information servers:

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Categories = "Information System" AND NOT Iteration = Deprecated

...

Section

title	References

Section

title	Resources

Tour

render-as-definition-list	true
replace-title-with-name	true

Title	Short Description
Confluence as the Information Hub

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	remote

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 7

New Version Current

Key

About

Keep up-to-date!

Powered by