- Created by Robert Reiner, last modified on 02. Oct 2016
projectdoc Toolbox
Renders a link to a project on a Sonar service.
- 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.
Renders a link to a project on a Sonar server.
The macros purpose is to specify the reference to the Sonar server at one place (as a Confluence shortcut or space property) and reuse this URL throughout the usage of this macro.
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.
Defaults to sonar
.
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 'sonar
' 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.
- Check for a space property
url-sonar
- Check for a space property
sonar
Only available with projectdoc Toolbox version 1.11 and up! - Check for a space property
shortcut-id-
.sonar
Lookup the connection information from the shortcut links with the value retrieved from the space property. - Check the shortcut links for a value
sonar
. - Check application navigator for a value
sonar
.
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
.
Project
The identifier of the project to link to. Defaults to
Project Group ID/Project Artifact ID
, if given as space properties.
Assume for this example that your Sonar server is at
https://www.example.com/sonar
To reference your project with group ID de.example.apps
and artifact ID my-app
(specified as space properties), the constructed URL is:
https://www.example.com/sonar/dashboard/index/de.example.apps:my-app
Service
The service on Sonar to reference.
If not specified the value defaults to a space property named sonar-service
. If this again is not specified, it defaults to /dashboard/index
.
To reference the component service enter this: /components/index
Please note that the service is required to start with a slash.
Options
The options to append to the URL.
The '?
' to separate the request parameters will be added by the system.
Sonar references pages within services by optional request parameters. E.g. to reference the hotspots page use "did=2
" as the value for the options property.
Label
The label for the link. Defaults to the name of the project.
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.
- 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.