meta: generalize meta_title into meta(title); support author, updated, date
[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 * `mtime` - List pages with the most recently modified first.
8 * `title` - Order by title (page name).
9 [[!if test="enabled(sortnaturally)" then="""
10 * `title_natural` - Orders by title, but numbers in the title are treated
11   as such, ("1 2 9 10 20" instead of "1 10 2 20 9")
12 """]]
13 [[!if test="enabled(meta)" then="""
14 * `meta(title)` - Order according to the `\[[!meta title="foo" sort="bar"]]`
15   or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
16   full title was set. `meta(author)`, `meta(date)`, `meta(updated)`, etc.
17   also work.
18 """]]
19
20 In addition, you can combine several sort orders and/or reverse the order of
21 sorting, with a string like `age -title` (which would sort by age, then by
22 title in reverse order if two pages have the same age).
23
24 Plugins can add additional sort orders, so more might be available on this
25 wiki.
26
27 [[!meta robots="noindex, follow"]]