System Link Macro

Document Properties Marker

override	false

Doctype

macro

hide

Name

System Link Macro

Short Description

Links to a resource on a server.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Tags

Tag List

names	Remote References, checking

Iteration


value	production

hide

Extension

Information Systems Extension

Since

1.0

Sort Key

hide

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

Section

title	Properties

Section

title	System Identifier

Identifies the connection information via Confluence shortcuts or space properties.

Transclusion

document	System Identifier to URI Resolution Algorithm
ids	Fragment

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.

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

Section

title	Label

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

Section

level	2
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

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.

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.

Transclusion

taget-heading-level	*
document	Authentication with Information Systems Extension
ids	Authentication

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

index	true
title	Sub-Macros

Display Table

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

title	Notes

Section

title	References

Section

title	Resources

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 4

New Version 5

Key

About

Keep up-to-date!

Powered by