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 f27972d4ebad13becf442eec9c4b35eec41ca0ef..9173ab599618a7c34ebdd10b9551f6565b27d416 100644 (file)
--- a/doc/ikiwiki/pagespec/sorting.mdwn
+++ b/doc/ikiwiki/pagespec/sorting.mdwn
@@ -1,25 +1,30 @@
 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_natural` - Only available if [[!cpan Sort::Naturally]] is
-  installed. Orders by title, but numbers in the title are treated
+
+* `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")
   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="""
 [[!if test="enabled(meta)" then="""

-* `meta_title` - Order according to the `\[[!meta title="foo" sort="bar"]]`
+* `meta(title)` - Order according to the `\[[!meta title="foo" sortas="bar"]]`

   or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
   or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no

-  full title was set.
+  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).
 
 """]]
 
 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).
 

-Plugins can add additional sort orders, so more might be available on this
-wiki.
-

 [[!meta robots="noindex, follow"]]
 [[!meta robots="noindex, follow"]]