Add path and path_natural sort orders
[ikiwiki.git] / doc / ikiwiki / pagespec / sorting.mdwn
1 Some [[directives|ikiwiki/directive]] that use
2 [[PageSpecs|ikiwiki/pagespec]] allow
3 specifying the order that matching pages are shown in. The following sort
4 orders can be specified.
5
6 * `age` - List pages from the most recently created to the oldest.
7
8 * `mtime` - List pages with the most recently modified first.
9
10 * `title` - Order by title (page name), e.g. "z/a a/b a/c"
11
12 * `path` - Order by page name including parents, e.g. "a/b a/c z/a"
13 [[!if test="enabled(sortnaturally)" then="""
14 * `title_natural` - Orders by title, but numbers in the title are treated
15   as such, ("1 2 9 10 20" instead of "1 10 2 20 9")
16
17 * `path_natural` - Like `path`, but numbers in the title are treated as such
18 """]]
19 [[!if test="enabled(meta)" then="""
20 * `meta(title)` - Order according to the `\[[!meta title="foo" sortas="bar"]]`
21   or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
22   full title was set. `meta(author)`, `meta(date)`, `meta(updated)`, etc.
23   also work.
24 """]]
25
26 In addition, you can combine several sort orders and/or reverse the order of
27 sorting, with a string like `age -title` (which would sort by age, then by
28 title in reverse order if two pages have the same age).
29
30 [[!meta robots="noindex, follow"]]