X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9dd8007b44541c752174c5d2a07e83613c7439bd..e3e6ca2777990caf96e524f59e22925841c79e6e:/doc/ikiwiki/directive/inline.mdwn?ds=inline diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn index c0d4e035b..dfe3e171f 100644 --- a/doc/ikiwiki/directive/inline.mdwn +++ b/doc/ikiwiki/directive/inline.mdwn @@ -5,14 +5,15 @@ The most common use of inlining is generating blogs and RSS or Atom feeds. Example: - \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]] + \[[!inline pages="blog/* and !*/Discussion" limit="10" rootpage="blog"]] Any pages that match the specified [[PageSpec]] (in the example, any [[SubPage]] of "blog") will be part of the blog, and the newest 10 of them will appear in the page. Note that if files that are not pages match the [[PageSpec]], they will be included in the feed using RSS -enclosures, which is useful for simple podcasting; for fuller-featured -podcast feeds, enclose media files in blog posts using [[meta]]. +enclosures, which is useful for simple [[!iki podcast desc=podcasting]]; +for fuller-featured podcast feeds, enclose media files in blog posts +using [[meta]]. The optional `rootpage` parameter tells the wiki that new posts to this blog should default to being [[SubPages|SubPage]] of "blog", and enables a @@ -45,11 +46,15 @@ There are many parameters you can use with the `inline` directive. These are the commonly used ones: * `pages` - A [[PageSpec]] of the pages to inline. -* `show` - Specify the maximum number of matching pages to inline. +* `limit` - Specify the maximum number of matching pages to inline. Default is 10, unless archiving, when the default is to show all. Set to 0 to show all matching pages. + In older versions of IkiWiki this parameter was called `show`, which + also still works. * `archive` - If set to "yes", only list page titles and some metadata, not full contents. +* `title` - Sets the title of the rss feed if one is generated. + Defaults to the name of the page. * `description` - Sets the description of the rss feed if one is generated. Defaults to the name of the wiki. * `skip` - Specify a number of pages to skip displaying. Can be useful @@ -93,8 +98,10 @@ Here are some less often needed parameters: * `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. +* `feedlimit` - Specify the maximum number of matching pages to include in + the rss/atom feeds. The default is the same as the `limit` value above. + In older versions of IkiWiki this parameter was called `feedshow`, which + also still works. * `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 @@ -121,7 +128,7 @@ Here are some less often needed parameters: * `trail` - If set to "yes" and 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 + and `limit` options are ignored by the trail, so the next/previous links traverse through all matching pages. [[!meta robots="noindex, follow"]]