Outgoing Links

Description

(warning) This macro is currently not available on Cloud.

Creates a list of pages, websites and email addresses the current page links to.

Default content may be included as the body to be shown if no links exist.

The link has a character limit of 255 characters. If the link is too long, it will be trimmed down and cause a broken link. This may affect links that were created prior to Linking 4.0.5.


Parameters

NameRequiredAvailable InMigratable to Cloud?Default ValueDescription
Page
 Optional
Server, Data Center
No
The page to search on.
Spaces
 Optional
Server, Data Center
No
The key spaces from which linked pages must come from. Spaces should be comma-separated.
Display Mode
 Optional
Server, Data Center
No
list
The mode in which the links are displayed; either in list or flat mode.
Separator
 Optional
Server, Data Center
No
comma

The style of the separator, if Display Mode is set to flat.

May be one of the following:

  • brace - Braces (''{'', ''}'') surrounding each item.
  • comma - A comma ('','') between each item.
  • paren - Parentheses (''('', '')'') surrounding each item.
  • pipe - A pipe (''|'') between each item.
  • newline - A line break after each item.
  • "custom" - Any other value you wish, specified between quotes.
Bullet Style
 Optional
Server, Data Center
No

The style of the bullet points, if Display Mode is set to list. May be one of the following:

  • icons - Displays the standard Confluence page-type icons.
  • none - No bullets displayed.
  • CSS list-styles - Any standard CSS list-style values. e.g.: "disc", "square", etc.
Maximum Results
 Optional
Server, Data Center
No
The maximum number of results to display.
Display Excerpt
 Optional
Server, Data Center
No
false
If enabled (true), displays the page excerpt next to the link.
Content Types
 Optional
Server, Data Center
No

The types of content to list, separated by commas.

May be one or more of:

  • page
  • blogpost
  • comment
  • spacedescription
  • userinfo
  • attachment
  • mailto
  • url
Scope
 Optional
Server, Data Center
No

Allows the possible pages to be restricted to a specific page parent/child scope. More than one filter may be applied.

e.g:

  • scope=My Page>children - the direct children of "My Page"
  • scope=ds:My Page>children - the direct children of "My Page" in "ds" space
  • scope=My Page>descendents - any descendents of "My Page".
  • scope=My Page>ancestors, Other Page>ancestors - any ancestors of both "My Page" and "Other Page".
Labels
 Optional
Server, Data Center
No
The list of labels the page may or may not have attached. Specify + for required, or - for excluded.


Notes

In general, all filtering parameters are lists of optional, required or excluded values. Optional items simply list the value, required items are prefixed with a '+', and excluded values are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "local" label but not the "international" label would look like this:

labels=local, -international

If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just wrap it in a set of quotes. Eg:

labels="factory-made"

This will work for all filter properties below.

  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which has the "two" label but not the "three" label.
  • spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
    • @all - All spaces, both personal and global
    • @personal - All personal spaces
    • @global - All non-personal spaces
    • @favourites - All the current user's favourite spaces
  • types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
    • page - Wiki pages
    • news - Blog/News posts
    • comment - Page or blog comments
    • spacedescription - Space description
    • userinfo - User profile
    • attachment - An attachment
    • mail - Mail archive
    • mailto - A 'mailto' link
    • url - An external URL.
    • unresolved - An unresolved link.