aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/inline.mdwn
blob: 05dea3a705d167b971d6e9821281a44d3d31df30 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
[[template id=plugin name=inline core=1 included=1 author="[[Joey]]"]]
[[tag type/core]]

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.
See [[blog]] for details.

## usage

Here are descriptions of all the supported parameters to the `inline`
directive:

* `pages` - A [[PageSpec]] of the pages to inline.
* `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.
* `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.
* `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 
  inlining page.
* `description` - Sets the description of the rss feed if one is generated.
  Defaults to the name of the wiki.
* `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).