Renders a link to a resource on a Subversion (SVN) repository.

Categories

Link / Information System

Tags

Remote References
svn
Link Resource

Iteration

Deprecated

Extension

Information Systems 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 or file within a project on a Subversion server.

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

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 'subversion' 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-subversion
Check for a space property subversion
Only available with projectdoc Toolbox version 1.11 and up!
Check for a space property shortcut-id-subversion.
Lookup the connection information from the shortcut links with the value retrieved from the space property.
Check the shortcut links for a value subversion.
Check application navigator for a value subversion.

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 name of the project to link to. If not specified, the name defaults to Project Artifact ID and version provided by the space properties.

File

The file within the project to link to. If not specified, the link references the project.

Label

The label for the link.

Defaults to the name of the file - and if not given - to the name of the project.

If checked, the resource the URL points to is checked for existence.

Dependent on whether the resource exists or not a CSS class is added.

CSS Class	Status
`projectdoc-resource-exists`	Resource exists
`projectdoc-resource-not-exists`	Resource does not exist

Note that the check does not use any application link configuration (available since version 1.4). The autoconvert service does. Hence a link macro may show the title of the referenced page as a label, but still is a dead link for users with insufficient privileges.

Details

Space Properties

The following space properties help to provide defaults for the subversion macro.

Space Property	Description
`url-subversion`	The root URL for the subversion resources for this project.
`subversion-subfolder`	The folder within the SVN root.
`project-artifactId`	The name of folder the sources are part of.
`project-version`	Appended to the project-identifier to form the name.

Suppose you want to reference the following file on your subversion server:

https://www.example.com/svn/os/util/tags/my-open-source-lib-1.0.2

Configure your space properties like this:

url-subversion	https://www.example.com/svn/os
subversion-subfolder	util/tags
project-artifact-id	my-open-source-lib
project-version	1.0.2

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

Subversion Link Macro