This page last changed on Jun 01, 2009 by ggaskell.

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 this value with the URL:

http://confluence.atlassian.com/

Hence, if you used the link value display/DOC/Working+with+Macros, the resulting URL is:
http://confluence.atlassian.com/display/DOC/Working+with+Macros

Documentation Links are generated against the contents of this macro's body text, allowing you to customise the text of this link.

For example, if you view this page's wiki markup, you will see that this link uses the Documentation Link macro and that it leads back to the parent of this page in the Confluence 'DOC' space.

On this page:

Usage with the Macro Browser

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

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the Documentation Link macro and have added the required parameter values, click 'insert' to add it to your page.

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

Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.

Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).

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

Document generated by Confluence on Dec 10, 2009 18:45