| Version Box |
|---|
| Since version 2.0 the sort by allows directives to control the sort order. |
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. | Warning |
|---|
Note that all documents in the result set must have a common ancestor. |
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 lookups. This is typically the fastest sorter, but requires to know the root node in advance (root page ID). | #BREADTH_FIRST:mat:{root page ID}
#DEPTH_FIRST:mat:{root page ID} |
| 
