You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
Renders a predefined list of documents in a table.
Renders a predefined list of documents in a table.
The contents is a table with a header line. The column headers contain the document property names to transclude. There is one column that contains the references to the documents to transclude property values from. The column is determined by the HTML anchor element. The href attribute of the anchor is used to determine the space, the label (i.e. content of the anchor element) is the title of the document.
You may add additional columns to add additional information that is rendered as specified.
Properties
This macro provides the following properties.
Counter 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'.
Replace 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.
Render 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.
Marker 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.
Child 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:
name=pageTitlePart?|propertyNameForLabel?|pageType?
| Parameter | Description |
|---|
name | The name of the column this rule applies to. |
pageTitlePart | The 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:
[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.
Prefer 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.
Style 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.
Details
Example
The following example shows a small table that renders books with short descriptions and also adds an additional comment column.
The result will add the short descriptions of the referenced books to the second column.
Template 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).
