outgoing-links

orphaned-links

Macros

pageacknowledgement-report

Discussion

Got a question or comment about this macro?

Get Satisfaction support network

{outgoing-links}

Plugin: Linking Plugin

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

Description

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

Usage

{outgoing-links}No links exist{outgoing-links}

Parameters

Name	Required	Default	Description
page		current location	The page to search on.
spaces		current space	The spaces from which linked pages must come from. Spaces should be comma-separated.
mode		list	The mode in which incoming links are displayed. Available modes: list - Links are displayed in a bullet-pointed list. flat - Links are displayed in a single row, with a separator between each item.
separator		comma	The style of separator to have. Defaults to ', ' when in flat mode. Available separators: commas - Each item is separated by a ', ' brackets - Each item is surrounded by square brackets ('[' and ']'). braces - Each item is surrounded by curly braces ('{' and '}'). parens - Each item is surrounded by parentheses ('(' and ')'). pipe - Each item is separated by a pipe ('|'). "other" - The value inside the quotes is the separator.
style			The style of the bullet points. 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 are also allowed. Eg. 'disc', 'square', etc.
maxResults			The maximum number of results to display.
name			Parameter description goes here.
excerpt		false	If 'true', any excerpt set for the page is displayed next to the link.
types		any type	The types of pages to list. Must be a comma-separated list of any of the following: page - a standard page. news - a news item. comment - a page/news item comment. spacedescription - a space description. userinfo - the user's profile information details. attachment - an attachment. mail - an archived mail message. mailto - a 'mailto' link. url - an external link.
scope			Allows the possible pages to be restricted to a specific page parent/child scope. More than one filter may be applied. Eg: scope=My Page>children - the direct children of 'My Page' 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			Specify the labels a page may or may not have attached. Eg. labels=one, two - may have either 'one' or 'two' attached. labels=+one, +two - must have both 'one' and 'two' attached. labels=+one, -two - must have 'one', but not 'two' attached.

Examples

{outgoing-links}No links exist{outgoing-links}
{outgoing-links:style=square|excerpt=true}
{outgoing-links:scope=Another Page>children}
{outgoing-links:scope=A Different Page>descendents}
{outgoing-links:spaces=MYSPACE}
{outgoing-links:types=page,comment}

Notes

Filtering Options

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 "foo" label but not the "bar" label would look like this:

labels=foo, -bar

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="foo-bar"

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 had 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.

See Also

• incoming-links
• orphaned-links
• [unresolved-links]

orphaned-links

Macros

pageacknowledgement-report