Clarify how to use sorting

[git.ikiwiki.info.git] / doc / ikiwiki / pagespec / sorting.mdwn

diff --git a/doc/ikiwiki/pagespec/sorting.mdwn b/doc/ikiwiki/pagespec/sorting.mdwn
index 37995f1e89d6387f26f50e7553d47b8ed86f123a..9173ab599618a7c34ebdd10b9551f6565b27d416 100644 (file)
--- a/doc/ikiwiki/pagespec/sorting.mdwn
+++ b/doc/ikiwiki/pagespec/sorting.mdwn
@@ -1,14 +1,20 @@
 Some [[directives|ikiwiki/directive]] that use
 [[PageSpecs|ikiwiki/pagespec]] allow
 specifying the order that matching pages are shown in. The following sort
 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.
+orders can be specified using the `sort` parameter:

 
 * `age` - List pages from the most recently created to the oldest.
 
 * `age` - List pages from the most recently created to the oldest.

+

 * `mtime` - List pages with the most recently modified first.
 * `mtime` - List pages with the most recently modified first.

-* `title` - Order by title (page name).
+
+* `title` - Order by title (page name), e.g. "z/a a/b a/c"
+
+* `path` - Order by page name including parents, e.g. "a/b a/c z/a"

 [[!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(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")

+
+* `path_natural` - Like `path`, but numbers in the title are treated as such

 """]]
 [[!if test="enabled(meta)" then="""
 * `meta(title)` - Order according to the `\[[!meta title="foo" sortas="bar"]]`
 """]]
 [[!if test="enabled(meta)" then="""
 * `meta(title)` - Order according to the `\[[!meta title="foo" sortas="bar"]]`