X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/17e742a6ebd489565d415325bd61d31f6f06ef49..ea8c166a053c3c5f78e4a27f26a59f4bc9011b4e:/doc/ikiwiki/directive/inline.mdwn diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn index db4d935a5..8afd65a05 100644 --- a/doc/ikiwiki/directive/inline.mdwn +++ b/doc/ikiwiki/directive/inline.mdwn @@ -54,7 +54,7 @@ directive. These are the commonly used ones: * `skip` - Specify a number of pages to skip displaying. Can be useful to produce a feed that only shows archived pages. * `postform` - Set to "yes" to enable a form to post new pages to a - [[blog]]. + blog. * `postformtext` - Set to specify text that is displayed in a postform. * `rootpage` - Enable the postform, and allows controling where newly posted pages should go, by specifiying the page that @@ -73,19 +73,25 @@ Here are some less often needed parameters: configured to `allowatom`, set to "yes" to enable. * `feeds` - controls generation of all types of feeds. Set to "no" to disable generating any feeds. +* `emptyfeeds` - Set to "no" to disable generation of empty feeds. + Has no effect if `rootpage` or `postform` is set. * `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]], +* `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. + 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"). * `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. @@ -97,10 +103,18 @@ Here are some less often needed parameters: 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 feeds. The default is the same as the `pages` value above, and only pages - matches by that value are included, but some of those can be excluded by + matched by that value are included, but some of those can be excluded by specifying a tighter [[PageSpec]] here. * `guid` - If a URI is given here (perhaps a UUID prefixed with `urn:uuid:`), the Atom feed will have this as its ``. The default is to use the URL of the page containing the `inline` directive. +* `feedfile` - Can be used to change the name of the file generated for the + feed. This is particularly useful if a page contains multiple feeds. + 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`. [[!meta robots="noindex, follow"]] + +A related directive is the [[ikiwiki/directive/edittemplate]] directive, which allows +default text for a new page to be specified.