summaryrefslogtreecommitdiff
path: root/doc/ikiwiki
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2010-03-24 03:18:24 +0000
committerSimon McVittie <smcv@debian.org>2010-03-24 03:18:24 +0000
commitb0ae19872d443860aeaab7069255e3a68a520887 (patch)
treeacaec88d259d9a9d31397603a2fa407db0d84e7a /doc/ikiwiki
parent0618f099dab8bd4f7f47e2695db01eabe49e3316 (diff)
Add an optional "sort" argument to meta titles, defaulting to the title
This allows correct sorting of titles, names, etc., with: [[!meta title="David Bowie" sort="Bowie, David"]] [[!meta title="The Beatles" sort="Beatles, The"]]
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r--doc/ikiwiki/directive/meta.mdwn7
-rw-r--r--doc/ikiwiki/pagespec/sorting.mdwn7
2 files changed, 11 insertions, 3 deletions
diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
index 557441c0b..8d2a5b1ad 100644
--- a/doc/ikiwiki/directive/meta.mdwn
+++ b/doc/ikiwiki/directive/meta.mdwn
@@ -23,6 +23,13 @@ Supported fields:
be set to a true value in the template; this can be used to format things
differently in this case.
+ An optional `sort` parameter will be used preferentially when
+ [[ikiwiki/pagespec/sorting]] by `meta_title`:
+
+ \[[!meta title="The Beatles" sort="Beatles, The"]]
+
+ \[[!meta title="David Bowie" sort="Bowie, David"]]
+
* license
Specifies a license for the page, for example, "GPL". Can contain
diff --git a/doc/ikiwiki/pagespec/sorting.mdwn b/doc/ikiwiki/pagespec/sorting.mdwn
index 3a9fef9b6..61516bec5 100644
--- a/doc/ikiwiki/pagespec/sorting.mdwn
+++ b/doc/ikiwiki/pagespec/sorting.mdwn
@@ -5,13 +5,14 @@ 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` - 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
as such, ("1 2 9 10 20" instead of "1 10 2 20 9")
[[!if test="enabled(meta)" then="""
-* `meta_title` - Order by the full title set by the `\[[!meta title="foo"]]`
- [[ikiwiki/directive]].
+* `meta_title` - Order according to the `\[[!meta title="foo" sort="bar"]]`
+ or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
+ full title was set.
"""]]
Plugins can add additional sort orders, so more might be available on this