This page last changed on Sep 07, 2011 by pwatson.

The Documentation Link macro generates a customisable text link to a page on http://confluence.atlassian.com/.

This macro accepts a relative link value and automatically prefixes that value with the URL:

http://confluence.atlassian.com/

For example, if you use the following relative link:

display/DOC/Working+with+Macros

then the resulting URL is:

http://confluence.atlassian.com/display/DOC/Working+with+Macros

The text that will be hyperlinked is the macro's body text (that is, the text between the macro tags). See the example below.

Usage with the Macro Browser

To insert the Documentation Link macro into a page using the Macro Browser:

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

Usage with the Wiki Markup Editor

Example of what you need to type

What you will get

{doc:display/DOC/Working+with+Macros}this link{doc}

this link

Parameters

When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser.

Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.

Parameter

Required in Wiki Markup?

Default

Description

Relative Link

yes

none

The relative link (that is, the URL portion after http://confluence.atlassian.com/) that leads to the required page on

http://confluence.atlassian.com/

.

 

Related Topics

Working with Macros

Take me back to the Confluence User's Guide.

Document generated by Confluence on Sep 19, 2011 02:35