Versions Compared

Key

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

...

Section
titleProperties

This macro provides the following properties.

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


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'.

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
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
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-transclusion-sectionmacro
taget-heading-level2
titleHeader Translations
*
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.
propertyNameForLabel
The name of the property of the document to be used as a label.
pageType
Relevant 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]



...