Sort By Property

Versions Compared

Key

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

Document Properties Marker

override	false

Short Description	Documents the use of the Sort Key Property of search macros.


Doctype	docmodule	hide
Name	Sort By Property

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Tags

Tag List

property	Tags

Iteration


value	finished

hide

Type

Name List

doctype	module-type
render-no-hits-as-blank	true
property	Type


Sort Key		hide

Section

title	Description

Section

title	Content

Section

level	2
title	Sort By

The comma-separated list of document property names to use for sorting.

Section

level	3
title	Sort Order

Add a '+' (default) for ascending, a '-' for descending order.

Section

title	Sort Directives

Since version 2.0 the following directives are available to control the sort order. Directives cannot be used together with other sorting strategies.

Directive Description Syntax

Breadth First

A breadth first sort of a page tree.

Note that all documents in the result set must have a common ancestor.

#BREADTH_FIRST

Depth First

A depth first sort of a page tree.

Note that all documents in the result set must have a common ancestor.

#DEPTH_FIRST

There are three different implementations to choose from. Per default the Memory Implementation is used.

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 materilizes the complete subtree and stores it for lookups. This is typically the fastest sorter, but requires to know the root node in advance. #BREADTH_FIRST:mat:{root page ID}
#DEPTH_FIRST:mat:{root page ID}

Section

title	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

Section

level	3
title	Type Conversion

Add a type descriptor of the form

Code Block

language	text

@{type/pattern}

The type is mandatory if the additional type descriptor is given. Valid values are

date
number

The pattern is optional to define a parsing pattern for the specified type.

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.

Example Box

Here are some examples

Sort By	The sort order is defined by the ...
`Name-`	... alphanumerical order of names, descending.
`Calendar Week@{number}`	... numerical order of the calender week, ascending.
`Date of Birth-@{date}`	... date of birth, descending.
`Date of Birth@{date/dd.MM.yyyy}`	... date of birth, using the defined date pattern.

Section

title	Subordinate Modules

Display Table

doctype	docmodule
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 4

New Version 5

Key

About

Keep up-to-date!

Powered by