- Created by Robert Reiner, last modified on 16. Apr 2016
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
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.
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.
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.
- 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
