05dea3a705d167b971d6e9821281a44d3d31df30
[ikiwiki.git] / doc / plugins / inline.mdwn
1 [[template id=plugin name=inline core=1 included=1 author="[[Joey]]"]]
2 [[tag type/core]]
3
4 This is a [[PreProcessorDirective]] that allows including one wiki page
5 inside another. For example:
6
7         \[[inline pages="blog/*"]]
8
9 The most common use of inlining is generating blogs and RSS feeds.
10 See [[blog]] for details.
11
12 ## usage
13
14 Here are descriptions of all the supported parameters to the `inline`
15 directive:
16
17 * `pages` - A [[PageSpec]] of the pages to inline.
18 * `show` - Specify the maximum number of matching pages to inline.
19   Default is 10, unless archiving, when the default is to show all.
20   Set to 0 to show all matching pages.
21 * `rss` - Controls generation of an RSS feed. On by default, set to "no" to
22   disable.
23 * `rootpage` - Enables a form to post new pages to a [[blog]].
24 * `archive` - If set to "yes", only list page titles and some metadata, not
25   full controls.
26 * `raw` - Rather than the default behavior of creating a [[blog]],
27   if raw is set to "yes", the page will be included raw, without additional
28   markup around it, as if it were a literal part of the source of the 
29   inlining page.
30 * `description` - Sets the description of the rss feed if one is generated.
31   Defaults to the name of the wiki.
32 * `actions` - If set to "yes" add links to the bottom of the inlined pages 
33   for editing and discussion (if they would be shown at the top of the page
34   itself).