The Anchor Macro allows you to link to specific parts of a page. Anchor links can be especially useful when navigating between sections of a long document or when you want to link to a segment of a page and not to the page as a whole.
Anchors are invisible to the reader when the page is rendered.
Anchors are made up of two parts:
- The link
- The content to which you are linking.
On this page:
Usage with the Macro Browser
To insert the anchor macro into a page using the Macro Browser,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - 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.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto 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 anchor macro, click 'insert' to add it to your page.
Usage with the Wiki Markup Editor
The following code creates an anchor called "here", but you can substitute this with whatever name you like.
{anchor:here}
Once an anchor is in the page, you can link to it by putting #here (or whatever anchor name you choose) at the end of a link pointing to that page.
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 |
Default |
Description |
|---|---|---|
Anchor Name |
None; name must be supplied |
This is the name of the anchor that you will link to. |
Examples
In the next example, there are two anchors in this page called "top" and "bottom", which you can link to like so:
[#top] [#bottom]
These links come out like this: #top #bottom.
More examples follow.
Linking to an anchor in the same page
[#anchorname]
Linking to an anchor in another page
[nameofpage#anchorname]
Linking to an anchor in a page in another space
[spacekey:nameofpage#anchorname]
Linking to headings
Confluence treats all headings as anchors. So you don't have to place an anchor but simply link to it like this:
[#textofheading]
Warning
Page titles and links to other spaces can be combined with anchors and attachments, but you can't use attachments and anchors in the same link.
Note that if you are adding an anchor to the site welcome message, it must be to another page. Internal-only links such as {anchor:bottom} will not render.
RELATED TOPICS
Take me back to the Wikis Help Guide.