Merge branch 'master' of ssh://git.ikiwiki.info

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

diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn
index 3f9a9ede5ccca8949114c6bfe5beabbe389b0a2c..4b11e599737819036f7b8bbe40a2ed2292e456af 100644 (file)
--- a/doc/ikiwiki/directive/inline.mdwn
+++ b/doc/ikiwiki/directive/inline.mdwn
@@ -56,7 +56,7 @@ directive. These are the commonly used ones:
 * `postform` - Set to "yes" to enable a form to post new pages to a
   blog.
 * `postformtext` - Set to specify text that is displayed in a postform.
 * `postform` - Set to "yes" to enable a form to post new pages to a
   blog.
 * `postformtext` - Set to specify text that is displayed in a postform.

-* `rootpage` - Enable the postform, and allows controling where
+* `rootpage` - Enables the postform, and allows controling where

   newly posted pages should go, by specifiying the page that
   they should be a [[SubPage]] of.
 
   newly posted pages should go, by specifiying the page that
   they should be a [[SubPage]] of.
 


@@ -75,29 +75,29 @@ Here are some less often needed parameters:
   disable generating any feeds.
 * `emptyfeeds` - Set to "no" to disable generation of empty feeds.
   Has no effect if `rootpage` or `postform` is set.
   disable generating any feeds.
 * `emptyfeeds` - Set to "no" to disable generation of empty feeds.
   Has no effect if `rootpage` or `postform` is set.

+* `id` - Set to specify the value of the HTML `id` attribute for the
+ feed links or the post form. Useful if you have multiple forms in the
+ same page.

 * `template` - Specifies the template to fill out to display each inlined
   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
 * `template` - Specifies the template to fill out to display each inlined
   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
   markup around it, as if it were a literal part of the source of the 
   inlining page.
   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
   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
-  [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").
+* `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.
 * `feedonly` - Only generate the feed, do not display the pages inline on
   the page.
 * `quick` - Build archives in quick mode, without reading page contents for
 * `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.
 * `feedonly` - Only generate the feed, do not display the pages inline on
   the page.
 * `quick` - Build archives in quick mode, without reading page contents for

-  metadata. By default, this also turns off generation of any feeds.
+  metadata. This also turns off generation of any feeds.

 * `timeformat` - Use this to specify how to display the time or date for pages
   in the blog. The format string is passed to the strftime(3) function.
 * `feedpages` - A [[PageSpec]] of inlined pages to include in the rss/atom
 * `timeformat` - Use this to specify how to display the time or date for pages
   in the blog. The format string is passed to the strftime(3) function.
 * `feedpages` - A [[PageSpec]] of inlined pages to include in the rss/atom


@@ -112,8 +112,15 @@ 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`.
   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.
+* `trail` - If the [[!iki plugins/trail desc=trail]] plugin is enabled, turn
+  the inlined pages into a trail with next/previous links, by passing the same
+  options to [[ikiwiki/directive/trailitems]]. The `skip` and `show` options
+  are ignored by the trail, so the next/previous links traverse through
+  all matching pages.

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

-
-A related directive is the [[ikiwiki/directive/edittemplate]] directive, which allows
-default text for a new page to be specified.