Tour-by-Property Macro

...

Document Properties Marker

doctype	macro
override	false

Short Description

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.

Doctype

macro

hide

Name

Tour-by-Property Macro

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	Author, Template Author
property	Audience

Tags

Tag List


css	projectdoc-compact
names	Property Value Transclusion, Tour, Remote Control, Deep Link, Context Control, Remote Controller

Type

Name List

doctype	macro-type
names	Content Reuse

Iteration


value	production

hide

Since

1.16

Supports Wiki Markup

Sort Key

hide

...

Wiki Markup is supported

since version 2.5

.

Section

index	true
show-title	false
title	Description

The Tour-by-Property Macro allows to render a table of documents based on a document property.

Specify the documents you want to render in a list. Each link to a document is considered in the order given.

Version Box

since	2.5

Section

title	Properties

Section

title	Document

Specify the document to fetch the list of document references from.

Section

title	Properties

The names of the properties whose value is a list of document references.

If more than one property is specified, all documents are lined up by the name of the first property.

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Select

Section

title	Traverse Strategy

Select how the list of document references is traversed.

Strategy	Description
`none`	No traversal of references in documents
`breadth-first`	Documents are traversed breadth first
`depth-first`	Documents are traversed depth first

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Counter Column

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Header Translations

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Calculation Columns

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Render no hits as blank

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	No Hits Text

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Render Mode

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Heading Link

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Add Link

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Hide Empty Row

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Remove Template Buttons

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Render Reference Box

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Caption

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	No Table Heading

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Identifier

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Identifier Classes

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Context controlled

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Remote Controls

...

Section

title	Details

projectdoc-box-version are available since version 2.0 of the projectdoc Toolbox.

Section

title	Remote Controlled Documents

	Remote Controlled Documents

Remote Controlled Documents allow to control the content at request time. A HTTP request may override parameters of the macro. A request parameter addresses a macro by its identifier. After the identifier the name of the parameter is appended, separated by a colon.

Example Box

title	Override Parameters

Assume that the identifier of the macro is set to 'my', the following call will override the property parameter on the page 'MyPage' in space 'MYS'.

Code Block
confluence/display/MYS/MyPage?my:property=Help

The list of parameters allowed to override:

document
property
select
traverse
render-counter-column
header-translations
calc-columns
render-no-hits-as-blank
render-mode
render-heading-as-link
render-link-label
hide-empty-row
remove-buttons
render-reference-box
table-caption
suppress-table-heading

These parameters can also be controlled by the context of the macro.

Section

title	Debugging

This macro renders information from names read from a given property. If that name is not referencing a projectdoc document then this name is simply dropped. This may be considered a configuration issue.

together with the page coordinates (space key, title, identifier)

If the space property

Static Document Link

document	Debug Mode

is set to true, then – depended on

projectdoc-static-document-link-macro

document	Debug Access Mode

– an error box is rendered that lists all undefined terms.

projectdoc-box-version

since	34.113

This feature is available since version 4.13 of the projectdoc ToolboxSince version 3.1 these parameters can also be controlled by the context of the macro.

Section

index	true
title	Related macros

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Categories = "Display / Query" OR $<Tags>=[Tour]

...

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 21

New Version 22

Key

About

Keep up-to-date!

Powered by