Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Doctypemacrohide
NameTour MacroShort DescriptionRenders a predefined list of documents in a table.
Doctypemacrohide
NameTour Macro
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
propertyAudience

Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
namesDisplay / Property
propertyAudience

Tags

Tag List
cssprojectdoc-compact
namesProperty Value Transclusion, Tour, Deep Link


Type

Name List
doctypemacro-type
namesContent Reuse


Iteration
Iteration
valueproduction
hide
Sort Keyhide


...

Section
titleProperties

This macro provides the following properties.

projectdoc-sectiontransclusion-macro
taget-heading-level*
documentDisplay Table Macro
idsCounter Column



projectdoc-
level2
titleCounter Column

If checked adds a counter as the first column.

Since version 1.11 table cells are tagged with a CSS class named 'projectdoc-counter-column'.

projectdoc-section
level2
titleReplace Title with Name

If checked, the title column will be replaced with the name property value.

Use this parameter if the title is due to the uniqueness within its space requirement not the desired reference to the document.


Section
titleReplace Property Name

If 

In-Document Link
anchorReplace Title with Name
is selected, this property allows to substitute the Name property with any other property.

Version Box

This parameter is available since version 4.10 of the projectdoc Toolbox.



Section
level2
titleRender no Hits as blank

If checked and there is no value in the title column referencing a document, then the table will not be rendered.


Section
titleNo Hits Text

Text to be rendered if no hits are shown.


Section
level2
titleMarker Column Property Name

If specified, references to documents is only checked in this column.

Use this parameter, if you have multiple columns with references to documents. Joins are currently not supported.


Comma-separated list of key value pairs. Key is the header to be replaced by the value. Format: k1=v1, k2=v2.

Use this parameter if the name of the property shown in the table is not appropriate as the column header. For instance the name of the person documents may be headed by the label "Team Members".
projectdoc-section
level2
titleHeader Translations
transclusion-macro
taget-heading-level*
documentDisplay Table Macro
idsHeader Translations



Section
level2
titleChild Page Reference Columns

If specified, the named columns will render references to child pages.

This is a very specific use case for this macro. Suppose you want to reference a couple of documents to be reviewed. For each document reviewers will create one additional document they add as a child to the reviewed document. This macro parameter allows to add a link to this document.

The syntax is as follows:

Code Block
languagetext
name=pageTitlePart?|propertyNameForLabel?|pageType?


ParameterDescription
nameThe name of the column this rule applies to.
pageTitlePartThe part to the name of the page to be appended. If not given, defaults to the value of the name parameter, appended with a dash ('-') to the referenced page title.
propertyNameForLabelThe name of the property of the document to be used as a label.
pageTypeRelevant for page title construction. If it is subpage, the name of the page containing the tour macro will be added. If it is page, the title is not affected.

The default rule is this:

Code Block
languagetext
[THE NAME IS REQUIRED]=|n/a|page

Some examples, suppose the linked page is titled "X", the page containing the macro is titled "Y":

  • My Column Name - A link is rendered in the column with the name 'My Column Name', if there is a page in this space called X-My Column Name.
  • My Column Name=-Review - A link is rendered, if there is a page in this space called X-Review.
  • My Column Name=-Review||subpage - A link is rendered, if there is a page in this space called X-Review - Y.


Section
level2
titlePrefer Definition List

If checked and their are only two columns, prefer rendering the value in a definition list instead of a table.

If there are not exactly two columns, the values are rendered in a table regardless of the value of this checkbox.


Section
level2
titleStyle Class

The CSS class to append to the toplevel element (table or definition list).

Since version 1.5.0 setting the widths of the columns is supported. Added a columns descriptor in brackets after the CSS class name. The comma-separated list of width is passed ass CSS style values for the width attribute.

 

Example Box
  • mystyle
  • mystyle[columns=20px,120px,80px]


projectdoc-box-version
since5

Since version 5 of the projectdoc Toolbox besides commas also semicolons are allowed to separate the column width.

Code Block
languagetext
mystyle[columns=20px;120px;80px]





projectdoc-section
titleBody

The body of the macro contains a table with table headers in the first row.

One column contains a link to the document, all other columns specify property names or templates with property names.

Version Box
since4.5

Since version 4.5 templates are supported.

Example with TemplatesImage Added

To reference a property from a template use ${...} (curly brackets). In case a link should be rendered to the document containing the property use $[...] (square brackets). Any other text (like " with " or " and " in the example) is rendered verbatim.

Code Block
languagetext
titleTemplate Example with Document Link
#T{$[Title] / ${Iteration}}

Note that Deep Links are supported. Both forms ( and ->) are supported.

Code Block
languagetext
titleTemplate Example
#SD{${Short Description} with ${Subject} and ${Ref→Tags}}



Version Box
since6.2

Since version 6.2 the body not only allows rows with data cells for structuring, but also accepts table header cells.

Also any formatting in the identifying column is preserved. This allows add indents to create hierarchy information.

The following example shows a single separator line that takes all table columns and some arrows to mimic indenting.

Image Added

The macro will (with the table heading removed) render like this:

Image Added



Section
titleDetails


Section
level2
titleExample

The following example shows a small table that renders books with short descriptions and also adds an additional comment column.

Content Marker
idtour-macro-in-editor

 


Version Box

Since version 2.4 the macro renders an error box if the body does not contain a table.

Image Added


 The result will add the short descriptions of the referenced books to the second column.

Content Marker
idtour-macro-in-view

 



Section
titleTemplate Support

Since version 1.17 of the projectdoc Toolbox the value columns support templates.

A template may reference properties with ${} and $[] (the latter generating a link to the document). If there is a non-empty value in a table cell, this value is rendered (and not the property value as this has been the case prior to version 1.17).

Example Box

This example shows the usage of a template in the second table row.



...

Section
titleReferences


Section
titleResources


Tour
render-as-definition-listtrue
replace-title-with-nametrue


TitleShort Description
Additional Properties




Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typemodular


...