cfea8006e0262b81360b815c45d440064baf82e0
[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 or Atom 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 * `skip` - Specify a number of pages to skip displaying. Can be useful
22   to produce a feed that only shows archived pages.
23 * `rss` - controls generation of an rss feed. On by default if the wiki is
24   configured to use rss feeds, set to "no" to disable.
25 * `atom` - controls generation of an atom feed. On by default if the wiki is
26   configured to use atom feeds, set to "no" to disable.
27 * `feeds` - controls generation of all types of feeds. Set to "no" to
28   disable generating any feeds.
29 * `rootpage` - Enables a form to post new pages to a [[blog]].
30 * `archive` - If set to "yes", only list page titles and some metadata, not
31   full controls.
32 * `quick` - Build archives in quick mode, without reading page contents for
33   metadata. By default, this also turns off generation of any feeds.
34 * `raw` - Rather than the default behavior of creating a [[blog]],
35   if raw is set to "yes", the page will be included raw, without additional
36   markup around it, as if it were a literal part of the source of the 
37   inlining page.
38 * `description` - Sets the description of the rss feed if one is generated.
39   Defaults to the name of the wiki.
40 * `actions` - If set to "yes" add links to the bottom of the inlined pages 
41   for editing and discussion (if they would be shown at the top of the page
42   itself).
43 * `sort` - Controls how inlined pages are sorted. The default, "age" is to
44   sort newest pages first. Setting it to "title" will sort pages by title.