1 [[template id=plugin name=inline core=1 author="[[Joey]]"]]
3 This is a [[PreProcessorDirective]] that allows including one wiki page
4 inside another. For example:
6 \[[inline pages="blog/*"]]
8 The most common use of inlining is generating blogs and RSS or Atom feeds.
9 See [[blog]] for details.
13 Here are descriptions of all the supported parameters to the `inline`
16 * `pages` - A [[PageSpec]] of the pages to inline.
17 * `show` - Specify the maximum number of matching pages to inline.
18 Default is 10, unless archiving, when the default is to show all.
19 Set to 0 to show all matching pages.
20 * `feedshow` - Specify the maximum number of matching pages to include in
21 the rss/atom feeds. The default is the same as the `show` value above,
22 and it cannot be larger than that value, but can be set to a smaller
23 value to avoid producing excessively large feed files.
24 * `skip` - Specify a number of pages to skip displaying. Can be useful
25 to produce a feed that only shows archived pages.
26 * `rss` - controls generation of an rss feed. On by default if the wiki is
27 configured to use rss feeds, set to "no" to disable.
28 * `atom` - controls generation of an atom feed. On by default if the wiki is
29 configured to use atom feeds, set to "no" to disable.
30 * `feeds` - controls generation of all types of feeds. Set to "no" to
31 disable generating any feeds.
32 * `rootpage` - Enables a form to post new pages to a [[blog]].
33 * `archive` - If set to "yes", only list page titles and some metadata, not
35 * `quick` - Build archives in quick mode, without reading page contents for
36 metadata. By default, this also turns off generation of any feeds.
37 * `template` - Specifies the template to fill out to display each inlined
38 page. By default the `inlinepage` [[template|templates]] is used, while
39 the `archivepage` template is used for archives. Set this parameter to
40 use some other, custom template, such as the `titlepage` template that
41 only shows post titles. Note that you should still set `archive=yes` if
42 your custom template does not include the page content.
43 * `raw` - Rather than the default behavior of creating a [[blog]],
44 if raw is set to "yes", the page will be included raw, without additional
45 markup around it, as if it were a literal part of the source of the
47 * `description` - Sets the description of the rss feed if one is generated.
48 Defaults to the name of the wiki.
49 * `actions` - If set to "yes" add links to the bottom of the inlined pages
50 for editing and discussion (if they would be shown at the top of the page
52 * `sort` - Controls how inlined pages are sorted. The default, "age" is to
53 sort newest pages first. Setting it to "title" will sort pages by title.
54 * `reverse` - If set to "yes", causes the sort order to be reversed.