aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-10-08 18:17:36 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-10-08 18:18:34 -0400
commit65d57902ca9f05b7958ea0a47b3fa3c651da89f5 (patch)
tree25718465c6e33d694f8fb021a9bc80e189a8acac /doc
parentde24c0df873a772a8b44098d1b4d2e1258640c9e (diff)
downloadikiwiki-65d57902ca9f05b7958ea0a47b3fa3c651da89f5.tar
ikiwiki-65d57902ca9f05b7958ea0a47b3fa3c651da89f5.tar.gz
add sorting page
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki/directive/inline.mdwn8
-rw-r--r--doc/ikiwiki/pagespec/sorting.mdwn11
2 files changed, 13 insertions, 6 deletions
diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn
index 4e087ab6c..c6a23ce3c 100644
--- a/doc/ikiwiki/directive/inline.mdwn
+++ b/doc/ikiwiki/directive/inline.mdwn
@@ -86,12 +86,8 @@ Here are some less often needed parameters:
if raw is set to "yes", the page will be included raw, without additional
markup around it, as if it were a literal part of the source of the
inlining page.
-* `sort` - Controls how inlined pages are sorted. The default, "age" is to
- sort newest created pages first. Setting it to "title" will sort pages by
- title, and "mtime" sorts most recently modified pages first. If
- [[!cpan Sort::Naturally]] is installed, `sort` can be set to "title_natural"
- to sort by title with numbers treated as such ("1 2 9 10 20" instead of
- "1 10 2 20 9").
+* `sort` - Controls how inlined pages are [[sorted|pagespec/sorting]].
+ The default is to sort the newest created pages first.
* `reverse` - If set to "yes", causes the sort order to be reversed.
* `feedshow` - Specify the maximum number of matching pages to include in
the rss/atom feeds. The default is the same as the `show` value above.
diff --git a/doc/ikiwiki/pagespec/sorting.mdwn b/doc/ikiwiki/pagespec/sorting.mdwn
new file mode 100644
index 000000000..1e0366029
--- /dev/null
+++ b/doc/ikiwiki/pagespec/sorting.mdwn
@@ -0,0 +1,11 @@
+Some [[directives|ikiwiki/directive]] that use
+[[PageSpecs|ikiwiki/pagespec]], such as [[ikiwiki/directive/inline]], 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.
+* `title_natural` - Only available if [[!cpan Sort::Naturally]] is
+ installed. Orders by title, but numbers in the title are treated
+ as such, ("1 2 9 10 20" instead of "1 10 2 20 9")