]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/inline.mdwn
* Add otl format plugin, which handles files as created by vimoutliner.
[git.ikiwiki.info.git] / doc / plugins / inline.mdwn
1 This is a [[PreProcessorDirective]] that allows including one wiki page
2 inside another. For example:
4         \[[inline pages="blog/*"]]
6 The most common use of inlining is generating blogs and RSS feeds.
7 See [[blog]] for details.
9 ## usage
11 Here are descriptions of all the supported parameters to the `inline`
12 directive:
14 * `pages` - A [[PageSpec]] of the pages to inline.
15 * `show` - Specify the maximum number of matching pages to inline.
16   Default is 10, unless archiving, when the default is to show all.
17   Set to 0 to show all matching pages.
18 * `rss` - Controls generation of an RSS feed. On by default, set to "no" to
19   disable.
20 * `rootpage` - Enables a form to post new pages to a [[blog]].
21 * `archive` - If set to "yes", only list page titles and some metadata, not
22   full controls.
23 * `raw` - Rather than the default behavior of creating a [[blog]],
24   if raw is set to "yes", the page will be included raw, without additional
25   markup around it, as if it were a literal part of the source of the 
26   inlining page.
28 This plugin is enabled by default.
30 [[tag type/core]]