Section |
---|
| Specify the type of the documents to select. If documents from more than one document type are to be selected, enumerate them in a comma-separated list. Leave blank to select documents from any doctypes. If a property selected from a document is not supported by a doctype, a blank cell will be rendered. |
Section |
---|
| Specify a comma-separated list of document properties or section names to display. If not specified, the name and short description of the document is displayed per default. The property name may be the name of a section of the document to be transcluded. projectdoc-sectionbox-version |
---|
| If no link should be generated, add '-' at the end of the property name. For properties to show a link, add a '+' at the end of the name. Example Box |
---|
title | Any Column may have a Link |
---|
| Short Description+, Date+ |
Example Box |
---|
title | Link on Short Name instead of Name |
---|
| Name-, Short Name+ |
Section |
---|
| The last character may also be a '#' in which case the property value is applied to the Count Function. The Count Function counts the number of table rows, number of list items, or number of definition terms (whichever of these three is encountered first). Otherwise the count function returns zero. This allows to render the count of a result set rendered in a section. The Count Macro also provides this function to the contents of its body. | Since version 4.13 the parameter supports to reference a Static Document Link |
---|
document | Space Properties |
---|
label | space property |
---|
| . The name of the space property has to be prefixed with the paragraph sign ('§ ').For instance, if the value for the select parameter is specified by the space property my-select , then the value of the select parameter is §my-select . |
Transclusion |
---|
document | Display Document Properties Macro |
---|
ids | supported-html-elements |
---|
|
|
Section |
---|
| If no link should be generated, add '-' at the end of the property name. For properties to show a link, add a '+' at the end of the name. | Version Box |
---|
title | Count Function (#) |
---|
since | 3.2 |
---|
| The count functions is available since version 3.2 of the projectdoc Toolbox. |
Section |
---|
| Column alignment can be controlled by using '< ' for left, '| ' for center, and '> ' for right alignment. Add this character at the end of the name (even after the '+' or '#' indicator). Example Box |
---|
title | Control Alignment | | Any Column may have a Link |
---|
| Short Description+, Date+ |
Example Box |
---|
title | Link on Short Name instead of Name |
---|
| Name-Name, Iteration|, Short Name+> |
|
Section |
---|
| Transclusion |
---|
document | PDAC:Deep Link |
---|
ids | Deep Links for Select Clauses |
---|
| | The last character may also be a '#' in which case the property value is applied to the Count Function. The Count Function counts the number of table rows, number of list items, or number of definition terms (whichever of these three is encountered first). Otherwise the count function returns zero. This allows to render the count of a result set rendered in a section. The Count Macro also provides this function to the contents of its body. |
Section |
---|
| Column alignment can be controlled by using '< ' for left, '| ' for center, and '> ' for right alignment. Add this character at the end of the name (even after the '+' or '#' indicator). | Section |
---|
| Use Templates to render complex values in a column cell. The syntax to specify a template is Code Block |
---|
#COLUMN_NAME{TEMPLATE_SPECIFICATION} |
The column name is the label to use for the column heading. It may be replaced using 123634119. Tip Box |
---|
| A comma is considered to separate two properties to be rendered. To use a comma in your template specification you need to escape it. Use , to replace a comma that should be used verbatim. |
The template specification uses placeholders to reference properties. Example Box |
---|
title | Example Template Specification | Control Alignment |
---|
| Name, Iteration|, Short Name+> |
|
Section |
---|
| Transclusion |
---|
document | PDAC:Deep Link |
---|
ids | Deep Links for Select Clauses |
---|
|
|
|
Section |
---|
| Use Templates to render complex values in a column cell. The syntax to specify a template is Code Block |
---|
#COLUMN_NAME{TEMPLATE_SPECIFICATION} |
The column name is the label to use for the column heading. It may be replaced using Header Translations. Tip Box |
---|
| A comma is considered to separate two properties to be rendered. To use a comma in your template specification you need to escape it. Use , to replace a comma that should be used verbatim. |
The template specification uses placeholders to reference properties. Example Box |
---|
title | Example Template Specification |
---|
| Code Block |
---|
#My Label{${Doctype} / ${Iteration}} |
The template will access the Doctype and Iteration property to render the specified string for each row in the given column. |
To render a link for a property in a template, the curly braces (${...}) need to be replaced by square braces ($[...]) when referencing a document property. Example Box |
---|
#T{$[Short Description] Code Block | #My Label{${Doctype} / ${Iteration}} |
The template will access the Doctype and Iteration property to render the specified string for each row in the given column.To render a link for a property in a template, the curly braces (${...}) need to be replaced by square braces (example renders a link with the value of the Short Description property. |
|
Section |
---|
| A Lucene search expression to filter on the results. If the property contains spaces, remove them or use $[...] ) when referencing a document property.. Examples: Name = "foo" AND ShortDescription NOT \"bar\" Name = "foo" AND
Example Box | #T{ ${Iteration}}Please refer to Search Tips for information on limitations and extensions on the search expression syntax provided by projectdoc The example renders a link with the value of the Short Description property. Version Box |
---|
| 2 | 3 Templates are supported since version 2.3 of the projectdoc Toolbox. |
| Section |
---|
| | Since version 4.13 the parameter supports to reference a Static Document Link |
---|
document | Space Properties |
---|
label | space property |
---|
| . The name of the space property has to be prefixed with the paragraph sign ('§ ').For instance, if the value for the where parameter is specified by the space property my-where , then the value of the select parameter is §my-where |
A Lucene search expression to filter on the results. If the property contains spaces, remove them or use $[...] . Examples: Name = "foo" AND ShortDescription NOT \"bar\" Name = "foo" AND $[Short Description] NOT \"bar\" Please refer to Search Tips for information on limitations and extensions on the search expression syntax provided by projectdoc Transclusion |
---|
document | Search Tips |
---|
ids | curly-braces |
---|
|
|
Transclusion |
---|
document | Search Tips |
---|
ids | Deep Links in Where Clause |
---|
|
|
|
Transclusion |
---|
taget-heading-level | * |
---|
document | Sort By Property |
---|
ids | Sort By |
---|
|
|
Section |
---|
| The maximum number of hits requested. |
Section |
---|
title | Restrict to immediate Children |
---|
| If checked, only immediate children of the current document are valid as hits. |
Section |
---|
| If checked adds a counter as the first column. projectdoc-box-version |
---|
| If checked, only documents marked with a star are valid hits. This feature allows to filter documents in the result set that are not marked as favored. Pages that are marked with are star a currently defined as "Saved for Later" and where previously deemed as favorite (or favourite) | CSS support | since | 1.11 | Since version 1.11 table cells are tagged with a CSS class named 'projectdoc-counter-column'. Version Box | title |
---|
Counter Column Heading | since | 27.5 |
---|
| Since version 2.5 the label of the column heading can be overridden by a space property named Counter Column Header | This feature is available since version 7.0 of the projectdoc Toolbox. |
Section |
---|
| If checked adds a counter as the first column. |
Section |
---|
| 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 is not appropriate as the column header. Version Box |
---|
| title | Counter Column Heading |
---|
since | 2.5 |
---|
| Since version 2.5 the The default label '#' may be overridden locally like this: The label of all number column headings is also controlled by a space property named Counter Column Header.
Section |
---|
| List column names to apply for calculation. The column names are separated by comas. projectdoc-box-note | Since version 1.7.0. | Per default the values are treated as integers. You may select the number type by the following selectors: Selector | Description |
---|
i | Integer value (Long Precision) | f | Float value (Double Precision) |
Separate the selector with a colon from the column name (e.g. Value:f ). If you require to specify the number format, add it after an equal sign (e.g. Value:f =#0.00). Transclusion |
---|
document | Number Format |
---|
ids | Content |
---|
|
|
The sum is rendered in additional row. The td element is rendered with the CSS selector projectdoc-calculated-value .
Section |
---|
| If checked excludes this document from the query result. |
Section |
---|
| 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 space keys text field (in addition to this field). |
Section |
---|
| 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. Space key may reference space categories introduced by the hashmark (e.g. #myproject ). Refer to Search Space for more information on selecting spaces by their Confluence Space Category (specified via the space admin page). |
Section |
---|
title | Render no hits as blank |
---|
| If the query found no hits, the result is rendered as a short text message. If a result with no hits should not be rendered at all, check this box. |
Section |
---|
| Text to be rendered if no hits are shown. This allows to customize the text message. Version Box |
---|
| | This parameter is supported since version 3.0.
Section |
---|
| Controls how the table should render properties of the document result set. There are three render modes: table, list, and section. Section |
---|
| If you want to render the result in a table, leave this parameter value blank. You may also explicitly set this value to table . Add a CSS class by separating it with a "= ". Since version 1.5.0 setting 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 as CSS style values for the width attribute. Example Box |
---|
=mystyle table=mystyle table=mystyle[columns=20px,120px,80px] is passed as CSS style values for the width attribute. Example Box |
---|
=mystyle table=mystyle table=mystyle[columns=20px,120px,80px]
|
Version Box |
---|
| Since version 5 of the projectdoc Toolbox besides commas also semicolons are allowed to separate the column width. Code Block |
---|
| table=projectdoc-alternating[columns=220px;*;220px] |
|
Since version 4.11 the columns must provide a value for the counter column (if selected). These CSS classes are provided by the projectdoc Toolbox to style your tables: Display Table |
---|
doctype | property |
---|
select | Name, Short Description |
---|
where | $<Component>=[HTML Table] |
---|
property | select | Name, Short Description |
---|
where | $<Component>=[HTML Table] |
---|
|
|
Section |
---|
| You may render a two column result in a list. Usually this is the case for the document name and short description. The following values are valid: definition - for a definition listnumbered - for a numbered listunnumbered - for an unnumbered listplain - for a comma separated list as text
Tip Box |
---|
title | Plain text in plain list |
---|
| If the list render mode is set to plain , then the elements of the list are still rendered as specified with the Select Parameter. In case you need to render a plain list (aka comma-separated list) then you could set the Select Parameter to Name- . |
| Section |
---|
| You may render a two column result in a list. Usually this is the case for the document name and short description. The following values are valid: definition - for a definition listnumbered - for a numbered listunnumbered - for an unnumbered listplain - for a comma separated list as plain textYou may add a CSS class by separating it with a "=". If you add a "-" at the end, the first character of the second column value (e.g. the short description) will be lower cased. Note |
---|
Note that there is specialized macro for rendering lists with an easier interface: Display List Macro. The render mode parameter allows to switch between tables and lists quickly, if you started with a table, but later decide to use a more compact format for your two-column result. |
Here are a few examples with valid values: Value | Description |
---|
definition | Renders as a definition list. | unnumbered- | Renders as an unnumbered list. The first character of the second column value is lower-cased. | definition=simpleindent- | Renders a definition list with class simpleindent . The first character of the second column value is lower-cased. | |
Section |
---|
| To render the result with vertical tables in sections, the parameter value has to be an asterisk ('* ') or an integer between 0 to 6, optionally be followed by a "+". Version Box |
---|
| The asterisk ('* ') allows to calculate the heading level dynamically, similar to the feature provided by the Section Macro. |
Otherwise there is a separate table for each document, where the first column contains the name of the property, the second its value. If the digit is zero, there will be no heading generated in front of the table. The first property in the select clause provides the value for this heading. If a "+" sign is added (e.g. "2+"), the first property will be rendered in the heading and in the first row of the table. You may use this option to render the name as the heading and as a link in the first row of the table. Since version 1.17 the properties table above the sections may be rendered as definition list (append an 'l '). Also the widths of the table may be controlled. For both representations a CSS class may be applied. projectdoc-box-exampleexample |
---|
* 1l - 1+l
1=mystyle[columns=120px,250px]
| Styles for definition lists provided by the projectdoc Toolbox are documented in Definition List MacroStyles for definition lists provided by the projectdoc Toolbox are documented in Definition List Macro. Since version 4.5 the short description can be extracted to be rendered in front of the table by placing the character 's' after the level (e.g. "*s"). Version Box |
---|
Since version 4.5 the additional modifiers for the section render mode may appear in any order after the level is specified. |
|
|
Section |
---|
| If checked renders heading as link to the document. If no heading is rendered, this flag has no effect. Since version 1.11. |
Section |
---|
| If specified renders the label as link to the document. The link is rendered after the possibly extracted short description and in front of the properties table. Since version 1.11. |
Section |
---|
| If checked, rows in two-column tables will be hidden, if the value is blank. |
Section |
---|
title | Remove Template Buttons |
---|
| If checked template buttons are not transcluded. |
Section |
---|
title | Render Reference Box |
---|
| If checked, a box that marks the transcluded text is rendered with a link to the part in the document (if the transcluded part is uniquely identifiable). Since version 1.11. Prior to that version the box can only be suppressed with the space property Render Transclusion Box. |
Section |
---|
| The label for the table caption. |
Section |
---|
| If checked no heading will be rendered. Since version 1.17 this parameter also applies for the table above the sections in 123634119 Section Render Mode. |
Section |
---|
| Apply identifier classes to render this macro as part of a group Apply identifier classes to render this macro as part of a group. Version Box |
---|
| | This parameter is available since version 2.3 of the projectdoc Toolbox. This identifier is used for Remote Control and Context Controlled Macros. Multiple macros on a page may have only one unique 123634119 Identifier, but may share common identifier classes.
Section |
---|
| Transclusion |
---|
document | Display List Macro |
---|
ids | Remote Controls |
---|
|
|
|
Section |
---|
| If checked, the values will be rendered as paragraphs instead of table row. Applies only to two-column tables and only makes sense if there is only one row. |
Section |
---|
| Deprecated Box |
---|
The parameter has been removed with version 1.5.0, since the no-table mode has been removed in favour for the Transclude Documents Macro. |
If checked, headings will not be rendered in no-table mode. |
Section |
---|
| Deprecated Box |
---|
The parameter has been removed with version 1.5.0, since the no-table mode has been removed in favour for the Transclude Documents Macro. |
If checked the details link to the document will not be rendered in no-table mode. |
|