Linking Plugin
This plugin contains macros for linking to templates, the dashboard and other Confluence features.
This plugin includes the following macros:
- add-page - This will create a link on your page which, when clicked, is equivalent to clicking 'Add Page' on the Page Operations bar.
- add-page-form - Creates a simple form on a page for users to enter the name of the new page to add.
- child-countert - Allows display of the 'current' and 'next' Child Counter value, as well as the ability to disable or reset the value if required.
- incoming-linksl - Generates a list of links of pages which link into this page.
- link-page - This will create a link to a page, or a link to create a page based on a template and/or parent page.
- link-to - Creates a link to special Confluence locations. All locations are case-insensitive.
- link-window - Links to a page or URL, popping it up into a new window.
- orphaned-links - Creates a list of pages which do not have any other pages linking to them.
- outgoing-links - Creates a list of pages, websites and email addresses the current page links to.
- undefined-links - Creates a list of pages which are linked to but have not yet been created.
This will create a link on your page which, when clicked, is equivalent to clicking 'Add Page' on the Page Operations bar.
The Code
{add-page:template=[template name]|live=true|parent=[<at:var at:name="self," />parent,@home,Page Name]}[link text]{add-page}
Parameters
Very similar to the add-page macro, this will then create a new page, which may be based on a template if so desired.
Code
{add-page-form:template=A Template|live=true}Add new page{add-page-form}
Parameters
When 'child counting' is enabled for a page, the plugin will keep track of how many children have been added to this page over time. This is different to the 'current page count', since it will not decrease when pages are deleted. This makes it useful for creating new pages with unique ID values which will never be duplicated.
Code
{macro:current/next/disable/enable/reset X|source=[page name]}
Parameters
Generates a list of links of pages which link into this page.
Code
{incoming-links:page=Another Page|types=page,comment}No links were found.{incoming-links}
Examples
{incoming-links}No links exist{incoming-links}
{incoming-links:style=square|excerpt=true}
{incoming-links:scope=Another Page>children}
{incoming-links:scope=A Different Page>descendents}
{incoming-links:spaces=MYSPACE}
{incoming-links:page=Another Page|types=page,comment}
Parameters
Creates a list of pages which do not have any other pages linking to them.
Code
{orphaned-links:spaces=MYSPACE}
Examples
{orphaned-links}No links exist{orphaned-links}
{orphaned-links:style=square|excerpt=true}
{orphaned-links:scope=Another Page>children}
{orphaned-links:scope=A Different Page>descendents}
{orphaned-links:spaces=MYSPACE}
{orphaned-links:types=page,comment}
Parameters
Wiki content may be included as the body to be shown if no links exist.
Code
{outgoing-links}No links exist{outgoing-links}
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}
Parameters
Creates a list of pages which are linked to but have not yet been created.
Code
{undefined-links}No links exist{undefined-links}
Examples
{undefined-links}No links exist{undefined-links}
{undefined-links:style=square|excerpt=true}
{undefined-links:scope=Another Page>children}
{undefined-links:scope=A Different Page>descenents}
{undefined-links:spaces=MYSPACE}
{undefined-links:types=page,comment}
Parameters
This will create a link to a page, or a link to create a page based on a template and/or parent page.
Code
{link-page:[Page Name]|template=[template name]|parent=[<at:var at:name="self," />parent,@home,Page Name]}[link text]{link-page}
Example
{link-page:My Page|template=My Template|parent=Home}Click here{link-page}.
Parameters
Links to a page or URL, popping it up into a new window.
Code
{link-window:http://www.foo.com/}Link text{link-window}
Examples
View Google in a popup window.
{link-window:http://www.google.com/|type=popup}Search with Google{link-window}
Link to a URL with an '=' in it.
{link-window:href=http://www.google.com.au/#hl=en&q=fish}Search for 'fish'{link-window}