This page last changed on Dec 17, 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 or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
  2. Click the Macro Browser icon on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode.
  3. Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
  4. Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to put the macro into the page.

You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.


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 options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

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 Jul 09, 2010 01:08