inline: add pagenames parameter

[ikiwiki.git] / doc / ikiwiki / directive / inline.mdwn

diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn
index 3f9a9ede5ccca8949114c6bfe5beabbe389b0a2c..9c55e07c2ec95805c51f4fed1b1265ad27b51b6d 100644 (file)
--- a/doc/ikiwiki/directive/inline.mdwn
+++ b/doc/ikiwiki/directive/inline.mdwn
@@ -79,7 +79,8 @@ Here are some less often needed parameters:
   page. By default the `inlinepage` template is used, while
   the `archivepage` template is used for archives. Set this parameter to
   use some other, custom template, such as the `titlepage` template that
-  only shows post titles. Note that you should still set `archive=yes` if
+  only shows post titles or the `microblog` template, optimised for
+  microblogging. Note that you should still set `archive=yes` if
   your custom template does not include the page content.
 * `raw` - Rather than the default behavior of creating a blog,
   if raw is set to "yes", the page will be included raw, without additional
@@ -88,9 +89,9 @@ Here are some less often needed parameters:
 * `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
-  [Sort::Naturally](http://search.cpan.org/dist/Sort-Naturally/lib/Sort/Naturally.pm)
-  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").
+  [[!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").
 * `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.
@@ -112,6 +113,11 @@ Here are some less often needed parameters:
   For example, set "feedfile=feed" to cause it to generate `page/feed.atom`
   and/or `page/feed.rss`. This option is not supported if the wiki is
   configured not to use `usedirs`.
+* `pagenames` - If given instead of `pages`, this is interpreted as a
+  space-separated list of links to pages (with the same
+  [[SubPage/LinkingRules]] as in a [[ikiwiki/WikiLink]]), and they are inlined
+  in exactly the order given: the `sort` and `pages` parameters cannot be used
+  in conjunction with this one.
 
 [[!meta robots="noindex, follow"]]