Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleProperties


Section
level2
titleSpace 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
level2
titleDocument

The title of the document to link to.

Overrides the page parameter.


Section
titleAnchor

The Anchor allows to define a page fragment to reference on the target page.

Version Box
since4.5

The parameter is available since version 4.5 of the projectdoc Toolbox.

The anchor value may have one of two forms:

  1. If the first character is a hashmark (#), then the anchor is used verbatim as fragment part of the generated URL
  2. If the first character is not a hashmark (#), then the anchor is a section title and a proper anchor is derived

So the bottom line is: If if the reference is to a section using the Section Macro, simply add the title of the section title. If the user knows the identifier or anchor in the HTML code, use that identifier an put a hashmark (#) in front.

Example Box
titleValid values: Section Titles and Identifiers
  • My Section Title
  • #my-element-id
  • #myAnchorName



Section
level2
titleLabel

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
titleTooltip

Allows to override the tooltip which defaults to the short description provided by the referenced projectdoc document.

Version Box
since4.1 / 4.2

The tooltip feature is available since version 4.1 of the projectdoc Toolbox.

Since version 4.2 it can be overridden with this parameter.



Section
level2
titleCSS Classes

The optional CSS classes to add to the link.

Section
level3
titleAutomatic Classes



Section
level2
titleSpace Closure

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

Valid values are

  • space-default
  • delegate-space
  • search-space
  • self-space (since 4.5)

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.

The value self-space restricts the search to the local space, that is the space the the page with the macro is part of. This supports the use case where the template authors want to limit the search. 

Version Box
since3.1

Since version 3.1 the default checks the space property Default Space Closure for the default space closure. If this space property is not set, the default is still Delegate Space.



Section
titleRender No Docs Style

Signal no existing docs in this space visually.

The projectdoc space renders homepages for doctypes. This flag checks if there is an index page for a given doctype.

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

Tip Box

See Doctype Instances Localization Mode for controlling the search mode for determining the existence of documents of a given type.

Since version 1.10.


Section
titleRender Space Style

Signal space reference visually.

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

Since version 1.10.


Section
titleLink Render Control

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

Values are

Definition List


create-linkRender a link to create a document (default)
emptyRender nothing
plain-textRender the link label.


Since version 1.10.


Section
level2
titleEmpty if not exists


Deprecated Box

Deprecated since version 1.10. Use Link Render Control 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
level2
titlePlain text if not exists


Deprecated Box

Deprecated since version 1.10. Use Link Render Control 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
level2
titleBlueprint

The complete key of the page blueprint.

Info Box

A page blueprint key looks like this:

Code Block
languagetext
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
titleRequest Parameters

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

Version Box

Available since version 2.4.

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]


Note Box
titleRemote Controller

This macro passes the Remote Controls via HTTP request parameters. Other Remote Controllers do this via macro parameters set in the rendering context.



Section
level2
titlePage

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:

PlaceholderDescription
@parentPageTitleIf the page has a parent page, the placeholder is replace with that page's title.
@spaceKeyThe placeholder is replaced with the page's space key.
@spaceNameThe 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>




...