Space Jump Macro
This page describes the Space Jump macro, which is provided with the Documentation theme. You can use space jumping to link from a page in one space to a page with the same name in another space, without knowing the name of the page when you create the link.
The Documentation theme is going away in Confluence 6.0.
Read more about this change.
Example: We use the Space Jump macro to put a standard message at the top of our archive spaces, telling people that they’re reading an old version of the documentation and letting them jump quickly to the same page in the latest documentation. See the words 'this page in the current documentation' in the screenshot below.
Screenshot: One way of using the Space Jump macro
Using the Space Jump macro
To add the Space Jump macro to a page:
- In the Confluence editor, choose Insert > Other Macros
- Find and select the required macro
Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros and mentions.
To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.
Parameters
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).
Parameter | Default | Description |
|---|---|---|
| Space | None | The space key that contains a page with the same page title that you want the link to jump to. Space keys are case-sensitive. |
Alias | None | The text to display as the hyperlinked text. If you do not supply an alias, Confluence will display the page name. |
Notes
What happens if there is no page with the same name in the target space?
For the space jump to work, the target space must contain a page with the same name as the page that renders the Space Jump macro. If the target space does not contain such a page, you will see a broken link. Confluence handles this in its usual manner: the link is coloured red. If you click the link, Confluence offers to create the page for you.
Can I use the Space Jump macro in any space?
Yes. You can use the Space Jump macro in any space, even if that space is not currently using the Documentation theme. Provided that the Documentation theme plugin and its components are installed and enabled on your Confluence site, the Space Jump macro is available in any space.
Code examples
The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.
Macro name: spacejump
Macro body: None.
Storage format example
<ac:structured-macro ac:name="spacejump">
<ac:parameter ac:name="alias">My Space</ac:parameter>
<ac:parameter ac:name="space">
<ri:space ri:space-key="SS"/>
</ac:parameter>
</ac:structured-macro>Wiki markup example
{spacejump:alias=my link|space=ds}