Child pages
  • Documentation Link Macro
Skip to end of metadata
Go to start of metadata

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.

On this page:

Usage with the Macro Browser

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

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

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

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

  • No labels