projectdoc Toolbox

Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.

Audience

Categories

Link / Document

Tags

Link
Name

Type

Content Organization

Use the Name List Macro to create references to documents by name. If the document of a given document type exists with the given name, the name is rendered as a link. If the document does not exist, the name is rendered as plain text.

Note that the name of a projectdoc document may be different from its title. Please refer to Name and Title for details.

Use this macro to mark property values within a document properties table. Other than the display macros that transclude a property from another document, this macro contains the value added by the author.

Properties

Names

The comma-separated list of document names to reference.

Each name will be rendered as a link to the document, if a document with such a name (and doctype, see next section) exists.

Doctype

The doctype of the documents to select.

The name of a document must be unique within its doctype for this macro to work property. It is not possible to reference several documents with the same name and document type.

Empty Where Clause Handling

If unchecked treat an empty where clause as match any (i.e. no constraint) or treat it as no valid match exists (in which case the displayed result is always empty).

You may temporarily uncheck the box to display all possible values.

Restrict to one Value

If checked only one value is allowed to be selected.

If authors specify more than one value, only the first one is taken into account and rendered.

Available since version 1.11.

Restrict to Range

If checked only values defined by the referenced doctype and constraints are allowed.

The range of valid values is defined by the doctype and the where parameter.

Refer to Define Status Tags for an example on how to define property value ranges.

If authors specify values not within the defined range, they are dropped.

Available since version 1.11.

If in addition to the range restriction the one-value restriction is also enforced, only the first value will be taken into account. That is: if two values are specified, where the first is not in the range, but the second is, then no value will be rendered.

Render List as comma-separated Values

If checked, the list is comma-separated, otherwise the rendering produces an unordered list. If rendered with commas, the names are always shown as text. Otherwise they may be rendered as boxes.

Please refer to Box Style for details.

Property

The name of the property the values in this list are values for. This property is useful for template designers to associate the value with the name of a property.

This allows queries to reference the ancestors of a document referenced here. See Search Tips for details.

Space Key

To limit the search on documents to the space with the given key. The editor allows to scan for space names. If you want to select more than one space, use the text field below in addition to this field. Only if no space is specified, the current and its delegate spaces are taken into account.

Space Keys

To limit the search on documents to the spaces with the given keys. Use this if you want to search in several spaces. Leave blank, if you want to search in the current space only. Use "@all" to search in all spaces. Only if no spaces are specified, the current and its delegate spaces are taken into account.

Where

A Lucene search expression to filter on the results.

For more information on queries, please refer to Search Tips.

Curly Braces

Curly braces may cause problems on some instances of Confluence when used in a string parameter field of a macro. This is especially true (and reproducible) if you use an opening and an immediate closing bracket like this: "{}".

This is a known issue (CONFSERVER-33399) and is also discussed in Do curly braces in string macro parameters break the macro?

To work around this problem you may escape the curly braces with a backslash as in

$[Story Points] = $\{Magic Value\}

You need to use this workaround if you cannot save the page (as described in the issue above). Otherwise it is just a failed rendering of the macro in the macro editor.

This issue is solved since version 5.0.

Unique Property

The name of the property to select the document. The property has to be unique and defaults to the Name property.

Display Template

Template to render instead of the plain property value.

Define property placeholders which will be replaced by the referenced property values. A property placeholder starts with ${, contains the name of the property it is a placeholder for, and ends with a curly brace.

Use templates like this to refer to properties.

The ${Name} is not ${Subject}.

The placeholders will be replaced by the values of the property Name and Subject.

Since version 1.16.

Link Properties

If the Display Template Parameter is specified, name the properties here to render a link to the document the name value refers to.

If none is specified, the whole template value is considered to be the label for the link.

Since version 1.16.

Details

Box Style

Configure the Name List Macro to draws boxes around the referencing names. Per default boxes are drawn for categories and tags. This can be switched on or off by using the space property called name-list-(doctype)-box-style.

The default behavior is configured by the space property name-list-default-box-style.

The syntax for the space property's name is based on this naming scheme:

name-list-(doctype)-boxstyle true/false

For example use the following to disable the rendering boxes for categories:

name-list-category-boxstyle false

Change the style of the box - most commonly used to change the background color - by adding a document property to the document instance for which you want to change the style.

For instance, if you want to change the background color for the document Example of the doctype Category, add the document property CSS Style Information to the Example document (please refer to Document Properties Marker Macro for more information on document properties and how to add them to a document instance).

Since version 1.14 of the projectdoc Toolbox the value for the CSS Style Information may not only contain verbatim text. Therefore from that version on you may use macros to construct the value.

Related macros

Name	Short Description	Tags
Breadcrumb Macro	Renders a breadcrumb for the current page.	Link
Child Documents Macro	Renders the list of child documents, matching the given filter criteria.	Link Children Autocomplete
Display Document Properties Macro	Renders a template with property references.	Display Property Value Transclusion Development Deep Link Autocomplete
Display Document Property As Image Macro	Renders the value of a document property as an image. The property value is required to an URL that points to an image.	Display Property Value Transclusion Autocomplete
Display Document Property As Link Macro	Renders the value of a document property as a link with an alternative label.	Display Property Value Transclusion Autocomplete
Display Document Property As List Macro	Renders the list value of a document property.	Display Property Value Transclusion Autocomplete
Display Document Property Macro	Renders the value of a property of a document.	Display Property Value Transclusion Autocomplete
Display Document Property Ref Concat Macro	Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property.	Display Property Value Transclusion Autocomplete
Display Document Property Ref Macro	Displays a document property from a referenced document.	Display Property Value Transclusion Autocomplete
Display List Macro	Lists references to projectdoc documents in a list. List contain names and optional short descriptions.	Dynamic List Query Deep Link Remote Control Context Control Autocomplete Remote Controller
Display List Template Macro	Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.	Dynamic List Query Deep Link Remote Control Context Control Autocomplete Remote Controller
Display Space Attribute Macro	Renders a space attribute value.	Display Property Value Transclusion Space
Display Space Property Macro	Renders a space property value.	Display Property Value Transclusion Space
Display Table Macro	Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.	Dynamic List Query Deep Link Remote Control Context Control Autocomplete Remote Controller
External Link Macro	Renders a locale dependent link to an external resource. The body of the macro contains the link label.	Link Link Resource Remote Reference checking
Hudson Link Macro	Render links to jobs and services on a Hudson server.	Link Resource Remote Reference
Index Card Macro	Renders transcluded content fetched from documents of a result set.	Dynamic List Query Transclusion Glossary Deep Link Autocomplete
Index Entries Table Macro	Renders a table of index entries.	Dynamic List Query Glossary Remote Control Deep Link Context Control Autocomplete Remote Controller
Javadoc Link Macro	Links API documentation pages for Java elements.	Link Resource Remote Reference
Name Body List Macro	Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.	Link Name
Name List Macro	Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.	Link Name Autocomplete
Nexus Link Macro	Renders a link to an artifact stored on a Nexus server.	Link Resource Remote Reference
Parent Property Macro	Renders the property of the parent document, if it has the same doctype.	Link Ancestor
Role List Macro	Renders a name list while taking care of special role semantics. Confluence names of groups with view permissions are added to the list of values.	Link Autocomplete Name
Site Link Macro	Links to a resource on a versioned site.	Link Resource Remote Reference
Sonar Link Macro	Renders a link to a project on a Sonar service.	Link Resource Remote Reference
Subversion Link Macro	Renders a link to a resource on a Subversion (SVN) repository.	Remote References svn Link Resource
Tag Body List Macro	Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.	Link Name
Tag List Macro	Renders a name list while taking care of special tag semantics. Confluence labels are added virtually to this list and displayed in the tags table row of the document properties table.	Link Autocomplete Name
Tour Macro	Renders a predefined list of documents in a table.	Property Value Transclusion Tour Deep Link
Tour-by-Property Macro	Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.	Property Value Transclusion Tour Remote Control Deep Link Context Control Remote Controller
Transclude Documents Macro	Renders transcluded content fetched from documents of a result set.	Dynamic List Query Transclusion Deep Link Remote Control Context Control Autocomplete Remote Controller
Transclusion Macro	Transcludes content from a document marked with the content marker macro.	Transclusion Remote Control Deep Link Context Control Remote Controller
Transclusion Reference Macro	Transcludes content via a reference from a document marked with the content marker macro.	Transclusion Remote Control Deep Link Context Control Remote Controller
Wiki Link Macro	Allows to render a link to a wiki page.	Link Link Resource Create Page Remote Controller

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java