projectdoc Toolbox

Transcludes a snippet from a project on a Subversion (SVN) server.

Categories

Link / Information System

Tags

Type

Content Reuse

Iteration

Deprecated

Extension

Information Systems Extension

Since

1.0

Deprecated since 1.0

Replace the macro with the System Transclusion 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.

Transcludes a snippet from a project on a Subversion (SVN) server.

Including unknown text snippets inside a web page is dangerous!

Please be very careful when transcluding information from external servers!

Usually you should only transclude pages or parts of pages, if you also are in control of the contents. Transcluding arbitrary information my result in executing scripts on your server. A malicious attacker may steal other user's authentication cookie or do other harmful things!

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

File

The file within the project to transclude from.

Snippet ID

The identifier of the snippet to include.

Lines

The line or line ranges to match.

Specified		Description
`-12`		Transclude all lines up to and including line 12.
`23`		Transclude line 23 only.
`42-50`		Transclude lines 42 to 50, both edge values included.
`90-`		Transclude from line 90 to the end of the file.
`-12, 23, 42-50, 90-`		All of the above in combination.

Not used if snippet ID is provided.

Encoding

The encoding of the file. Defaults to the chartype announced by the response.

Use extra Snippet Marker

If the extra labels "SNIPPET START" and "SNIPPET END" should rendered.

Plain

If unchecked, the snippet is rendered within the Code Block Macro (only then do the following code attributes apply). Otherwise it is rendered as plain text fragment.

Plain

If unchecked, the snippet is rendered within the Code Block Macro (only then do the following code attributes apply). Otherwise it is rendered as plain text fragment.