summaryrefslogtreecommitdiff
path: root/ikiwiki/pagespec/sorting.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-07-17 15:21:24 +0200
committerJonas Smedegaard <dr@jones.dk>2010-07-17 15:21:24 +0200
commit8a6868efccbba0c8f6fbb35e2f19c79d794221e5 (patch)
treebe35890e81c2ab9a5f333607f957204099d10fbf /ikiwiki/pagespec/sorting.mdwn
parent262712e706420c9f421c7a4fc7a33ebe9bf1b1bf (diff)
parent6b53960c5bbcf6a43f2e48b0b37a94e1f909b522 (diff)
Merge branch 'master' into scsscs
Diffstat (limited to 'ikiwiki/pagespec/sorting.mdwn')
-rw-r--r--ikiwiki/pagespec/sorting.mdwn26
1 files changed, 26 insertions, 0 deletions
diff --git a/ikiwiki/pagespec/sorting.mdwn b/ikiwiki/pagespec/sorting.mdwn
new file mode 100644
index 0000000..ccd7f7e
--- /dev/null
+++ b/ikiwiki/pagespec/sorting.mdwn
@@ -0,0 +1,26 @@
+Some [[directives|ikiwiki/directive]] that use
+[[PageSpecs|ikiwiki/pagespec]] allow
+specifying the order that matching pages are shown in. The following sort
+orders can be specified.
+
+* `age` - List pages from the most recently created to the oldest.
+
+* `mtime` - List pages with the most recently modified first.
+
+* `title` - Order by title (page name).
+[[!if test="enabled(sortnaturally)" then="""
+* `title_natural` - Orders by title, but numbers in the title are treated
+ as such, ("1 2 9 10 20" instead of "1 10 2 20 9")
+"""]]
+[[!if test="enabled(meta)" then="""
+* `meta(title)` - Order according to the `\[[!meta title="foo" sortas="bar"]]`
+ or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
+ full title was set. `meta(author)`, `meta(date)`, `meta(updated)`, etc.
+ also work.
+"""]]
+
+In addition, you can combine several sort orders and/or reverse the order of
+sorting, with a string like `age -title` (which would sort by age, then by
+title in reverse order if two pages have the same age).
+
+[[!meta robots="noindex, follow"]]