You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

projectdoc Toolbox

Links to a resource on a versioned site.

Categories
Tags
Iteration
Deprecated
Extension
Since
1.0

Description

Deprecated since 1.0

 

Replace the macro with the System Link Macro and the use of placeholders with space properties.

Due to the use of placeholders the URL is no longer required to be divided into reusable parts by the macro.

In version 1.0 the macro is still part of the add-on, but already disabled.

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.

 

Since projectdoc Toolbox version 1.11 this macro is part of the Information Systems Extension. Prior to that version the macro has been part of the projectdoc Toolbox.

The Since attribute above refers to the version of the extension, not to the version of the projectdoc Toolbox.

Properties

System Identifier

Identifies the connection information via Confluence shortcuts or space properties.

Cannot find content to transclude!

Please check the reference (ids=Fragment / tags=) to the document 'System Identifier to URL Resolution Algorithm' to transclude from.

If you want to silence this message on missing content, check 'Missing Content Message'.

Please refer to the Transclusion Macro documentation for more information about this macro.

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.

Check Resource

 If checked, the resource the URL points to is checked for existence a CSS class ('projectdoc-resource-exists' or 'projectdoc-resource-not-exists') is added.

Server Root Based

Uncheck to suppress g/a/v path generation.

May be overridden by the space property server-root-based.

 

Prior to version 1.11 of the projectdoc Toolbox this property has been available since version 1.8.0.

Related macros

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

Enterprise Architect Image Link Macro
Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
HTML Snippet Macro
Transclude HTML content from a remote server.
Hudson Link Macro
Render links to jobs and services on a Hudson server.
Javadoc Link Macro
Links API documentation pages for Java elements.
Nexus Link Macro
Renders a link to an artifact stored on a Nexus server.
Site Link Macro
Links to a resource on a versioned site.
Sonar Link Macro
Renders a link to a project on a Sonar service.
Subversion Link Macro
Renders a link to a resource on a Subversion (SVN) repository.
Subversion Transclusion Macro
Transcludes a snippet from a project on a Subversion (SVN) server.
System Image Link Macro
Renders an image transcluded from a remote server.
System Link Macro
Links to a resource on a server.
System Transclusion Macro
Transclude content from a resource from a remote system.
Text Snippet Macro
Transclude text content from a remote server.

  • No labels