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.

The system identifier is checked at three locations

 

Typically do not change the system identifier provided by the macro (if one is specified). Keep the default value of 'site' as long as you do not need to reference multiple server of the same type in one space. Then set the space property to reference the specific server accordingly. This makes it easier to create new links to artifacts since the system identifier need not to be changed.

The search for the system connection information is conducted as follows. Use the URI discovered first to connect to the server.

  1. Check for a space property url-site
  2. Check for a space property site
    Only available with projectdoc Toolbox version 1.11 and up!
  3. Check for a space property shortcut-id-site.
    Lookup the connection information from the shortcut links with the value retrieved from the space property.
  4. Check the shortcut links for a value site.
  5. 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.

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.
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.