Documents the use of the Sort Key Property of search macros.
Content
Sort By
The comma-separated list of document property names to use for sorting.
Per default the sort key then the name of the document is used.
The last modification date is the last arbiter if all other properties are equal.
Sort Order
Add a '+' (default) for ascending, a '-' for descending order.
Sort Directives
The directive selects the sort order breadth first (display direct children, then children at level two, the three, and so on) or depth first (run from the root node to the first leaf, second leaf, and so on until no leaf is left, then proceed with the parents sibling and so on). The sorter takes the position of the child (as specified via the space content tool to reorder pages) into account. This may be called the natural sort order since it is the sort order imposed by Confluence and it does not depend on any document property.
Directives cannot be used together with other sort constraints. A directive starts with a hashmark (#).
| Directive | Description | Syntax |
|---|
| Breadth First | A breadth first sort of a page tree. | #BREADTH_FIRST |
| Depth First | A depth first sort of a page tree. | #DEPTH_FIRST |
There are three different implementations to choose from. Per default the Memory Implementation is used, which should be fine for almost all use cases.
| Implementation | Description | Syntax |
|---|
| No Memory | The sorter does not use additional memory to speed up sorting. | #BREADTH_FIRST:no-mem
#DEPTH_FIRST:no-mem |
| Memory | The sorter uses additional memory to store intermediate results for reuse. This speeds up the sorting process for larger result sets. This is the default implementation. | #BREADTH_FIRST:mem
#DEPTH_FIRST:mem
#BREADTH_FIRST
#DEPTH_FIRST
|
| Materialize | The sorter materializes the complete subtree and stores it for all look-ups. This is typically the fastest sorter, but requires to know the root node in advance (root page ID). If the page identifier is not specified, the Memory implementation is used. | #BREADTH_FIRST:mat:{root page ID}
#DEPTH_FIRST:mat:{root page ID} |
Artificial Properties
The projectdoc Toolbox provides a number of artificial properties, some of which may be helpful for sorting.
| Property Name | Example Value |
|---|
| Creation Date§ | 20151008 |
| Creation Timestamp | 0000001444337808000 |
| Last Modification Date§ | 20170429 |
| Last Modification Date Timestamp | 0000001493416800000 |
Type Conversion
Add a type descriptor of the form
The type is mandatory if the additional type descriptor is given. Valid values are
The pattern is optional to define a parsing pattern for the specified type.
Transcluded By
| Name | Short Description | Doctype |
|---|
| Calculation Macro | Run calculations on a set of result documents and renders the results. | app-macro |
| Display List Macro | Lists references to projectdoc documents in a list. List contain names and optional short descriptions. | macro |
| Display List Template Macro | Lists references to projectdoc documents in a list. List items are defined by templates referencing properties. | macro |
| Display Table Macro | Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | macro |
| Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. | macro |
