Wiki Link Macro

...

Document Properties Marker

doctype	macro
override	false

Doctype

macro

hide

Name

Wiki Link Macro

Short Description

Allows to render a link to a wiki page.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Documentation Architect, Template Author

Tags

Tag List

names	Link, Link Resource, Create Page

Iteration


value	production

hide

Sort Key

hide

Section

index	true
show-title	false
title	Description

Renders a link to a page in the wiki. It uses the delegate space or the search space for searching the page with the specified title.

This macro is usually relevant for template authors and documentation architects. It allows to reference the home page of a document type, without knowing exactly, where it is located.

Example Box

title	Example with 4 different Link Styles

All four link styles are automatically generated, dependent on the location or existence of the target page within the wiki.

...

Section

title	Properties

Section

level	2
title	Space Key

The key to the space the page is part of. If empty, the macro tries to find a page with the given page title on the delegate space.

Section

level	2
title	Document

The title of the document to link to.

Overrides the page parameter.

Section

level	2
title	Label

The label to render instead of the page name.

If neither the document or page parameter is set, the label is used as a the page title.

Section

level	2
title	CSS Classes

The optional CSS classes to add to the link.

Section

level	3
title	Automatic Classes

If the page is not located in this space, the CSS class projectdoc-space-reference is added automatically (see Render Space Style 60883493.
If it points to a home page of a doctype without an index page, the class projectdoc-no-docs is added automatically (see Render No Docs Style 60883493).

Section

level	2
title	Space Closure

The space closure defines which spaces are to be considered for searching.

Per default the delegate spaces are used. This is what the is most often needed: the location where new documents are stored per default is the location this macro will link to.

If you have a space that references the latest version of a product space, you may want to link to information to be found in any space. In this case the space contains the latest version of a space in its search space. Using this link will ensure that the latest version is linked.

Section

title	Render No Docs Style

Signal no existing docs in this space visually.

Allows to suppress rendering the CSS style projectdoc-no-docs.

Since version 1.10.

Section

title	Render Space Style

Signal space reference visually.

Allows to suppress rendering the CSS style projectdoc-space-reference.

Since version 1.10.

Section

title	Link Render Control

Control how the link is rendered if the target document does not exist.

Values are

Definition List

create-link	Render a link to create a document (default)
empty	Render nothing
plain-text	Render the link label.

Since version 1.10.

Section

level	2
title	Empty if not exists

Deprecated Box
Deprecated since version 1.10. Use Link Render Control 60883493 with a value of `empty` instead.

If checked, the link text will not be rendered, if the target page within the wiki does not exist.

Section

level	2
title	Plain text if not exists

Deprecated Box
Deprecated since version 1.10. Use Link Render Control 60883493 with a value of plain-text instead.

If checked, the link text will be rendered as plain text, if the target page within the wiki does not exist.

If the option "Empty if not exists" is selected, the text will not shown. That is: this option is overridden by the empty text option.

Section

level	2
title	Blueprint

The complete key of the page blueprint.

Info Box

A page blueprint key looks like this:

Code Block

language	text

de.smartics.atlassian.confluence.smartics-projectdoc-confluence:projectdoc-blueprint-doctype-blank

This example refers to the Blank Document.

If omitted, the new page will be based on the empty page template.

Section

title	Request Parameters

Request parameters allow to call a Remote Controlled Document (e.g. using the Display Table Macro).

The left side (value) of the parameter assignments will be URL encoded. The expected pattern is

Code Block
id-x:name1=value A, value B&id-y:$<name2>=[some value]

Version Box
Available since version 2.3.1.

Section

level	2
title	Page

The name of the page to link to.

For template developers: This may be the key to the localized information. This is useful if you create blueprint projects with space blueprints.

The name may contains special placeholder values that will be replaced:

Placeholder	Description
`@parentPageTitle`	If the page has a parent page, the placeholder is replace with that page's title.
`@spaceKey`	The placeholder is replaced with the page's space key.
`@spaceName`	The placeholder is replaced with the page's space name.
/	Signals to link to the space homepage (since Version 1.8.0).

Placeholders referencing the current date or time are not supported.

Example Box

If template authors want to reference the parent page of a Section document instance, they use the following:

Code Block
<ac:structured-macro ac:name="projectdoc-link-wiki"> <ac:parameter ac:name="page"><at:i18n at:key="my.page.name.i18n.key"/> - @parentPageTitle</ac:parameter> </ac:structured-macro>

...

Section

title	References

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	navigate

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 4

New Version 5

Key

About

Keep up-to-date!

Powered by