X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1aeb64e14858dc7dbce6ac553fc6dc43efb29fae..d9e4a3718ec84a2855aa3b585cd2d8ec0bea182e:/doc/plugins/inline.mdwn diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn index 05dea3a70..a607474df 100644 --- a/doc/plugins/inline.mdwn +++ b/doc/plugins/inline.mdwn @@ -1,12 +1,11 @@ -[[template id=plugin name=inline core=1 included=1 author="[[Joey]]"]] -[[tag type/core]] +[[template id=plugin name=inline core=1 author="[[Joey]]"]] This is a [[PreProcessorDirective]] that allows including one wiki page inside another. For example: \[[inline pages="blog/*"]] -The most common use of inlining is generating blogs and RSS feeds. +The most common use of inlining is generating blogs and RSS or Atom feeds. See [[blog]] for details. ## usage @@ -18,11 +17,23 @@ directive: * `show` - 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. -* `rss` - Controls generation of an RSS feed. On by default, set to "no" to - disable. +* `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, + and it cannot be larger than that value, but can be set to a smaller + value to avoid producing excessively large feed files. +* `skip` - Specify a number of pages to skip displaying. Can be useful + to produce a feed that only shows archived pages. +* `rss` - controls generation of an rss feed. On by default if the wiki is + configured to use rss feeds, set to "no" to disable. +* `atom` - controls generation of an atom feed. On by default if the wiki is + configured to use atom feeds, set to "no" to disable. +* `feeds` - controls generation of all types of feeds. Set to "no" to + disable generating any feeds. * `rootpage` - Enables a form to post new pages to a [[blog]]. * `archive` - If set to "yes", only list page titles and some metadata, not full controls. +* `quick` - Build archives in quick mode, without reading page contents for + metadata. By default, this also turns off generation of any feeds. * `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 @@ -32,3 +43,6 @@ directive: * `actions` - If set to "yes" add links to the bottom of the inlined pages for editing and discussion (if they would be shown at the top of the page itself). +* `sort` - Controls how inlined pages are sorted. The default, "age" is to + sort newest pages first. Setting it to "title" will sort pages by title. +* `reverse` - If set to "yes", causes the sort order to be reversed.