- Created by Robert Reiner, last modified on 31. Jan 2020
projectdoc Toolbox
Renders a locale dependent link to an external resource. The body of the macro contains the link label.
- Audience
- Categories
- Tags
Renders a locale dependent link to an external resource. The body of the macro contains the link label.
This macro is relevant for template authors for creating links to external resources.
Example Using Resource Keys
This example uses resource keys found in a text resource bundle of the blueprint plugin.
<ac:structured-macro ac:name="projectdoc-link-external">
<ac:parameter ac:name="title">myproject.url.something.title</ac:parameter>
<ac:parameter ac:name="base-url">myproject.url</ac:parameter>
<ac:parameter ac:name="page">myproject.url.something</ac:parameter>
<ac:rich-text-body>
<at:i18n at:key="myproject.url.something.label"/>
</ac:rich-text-body>
</ac:structured-macro>
And here is the resource bundle:
myproject.url=http://www.example.com/documents myproject.url.something=The+important+Document myproject.url.something.label=Example Document myproject.url.something.title=Just an Example
Properties
Base URL
The base URL to the resource to create a link to.
The value of the property is checked for being a space property (since version 1.8) or a key in a resource bundle. If both is not true, the base URL is used as given.
Referring to a key in a resource bundle is only relevant for template authors.
Since version 4.3 it is possible to provide an absolute URL with the Page parameter and leave the Base URL parameter blank.
Page
The path to the page within the base URL.
The value of the property is checked for being a space property (since version 1.8) or a key in a resource bundle. If both is not true, the base URL is used as given.
Referring to a key in a resource bundle is only relevant for template authors.
Since version 4.3 it is possible to provide an absolute URL with the Page parameter and leave the Base URL parameter blank.
Title
The title to add to the link.
The value of the property is checked for being a space property (since version 1.8) or a key in a resource bundle. If both is not true, the title is used as given.
Referring to a key in a resource bundle is only relevant for template authors.
Check Link
Checks if the link actually points to a resource. If the link is dead, the CSS class projectdoc-resource-not-exists will be rendered.
A value of default checks the space property named check. The default value is false.
Since 2.0
This parameter is available since version 2.0.
Target
Optional target for the link.
The default value of self will not be rendered.
Since 4.3
This parameter is available since version 4.3 of the projectdoc Toolbox.
ID
Provide a unique identifier to the HTML link element.
Since 4.3
This parameter is available since version 4.3 of the projectdoc Toolbox.
CSS Classes
Provides CSS classes for the HTML element.
Use the regular style syntax (like comp-external link). The syntax is not validated and written to the element as encoded HTML attribute value.
Since 4.3
This parameter is available since version 4.3 of the projectdoc Toolbox.
Styles
Provide additional CSS Styles for the HTML element.
Use the regular style syntax (like color: orange;). The syntax is not validated and written to the element as encoded HTML attribute value.
Since 4.3
This parameter is available since version 4.3 of the projectdoc Toolbox.
Related macros
- Breadcrumb Macro
- Renders a breadcrumb for the current page.
- Child Documents Macro
- Renders the list of child documents, matching the given filter criteria.
- 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.
- Name Body List Macro
- Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.
- Name List Macro
- Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.
- Nexus Link Macro
- Renders a link to an artifact stored on a Nexus server.
- Parent Property Macro
- Renders the property of the parent document, if it has the same doctype.
- Role List Macro
- Renders a name list while taking care of special role semantics. Confluence names of groups with view permissions are added to the list of values.
- 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.
- Tag Body List Macro
- Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.
- Tag List Macro
- Renders a name list while taking care of special tag semantics. Confluence labels are added virtually to this list and displayed in the tags table row of the document properties table.
- Text Snippet Macro
- Transclude text content from a remote server.
- Wiki Link Macro
- Allows to render a link to a wiki page.
