X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/1aeb64e14858dc7dbce6ac553fc6dc43efb29fae..639e2f9ec7cda307411a2d832d9ec68d18c35f5c:/doc/plugins/inline.mdwn diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn index 05dea3a70..fc6f9e8af 100644 --- a/doc/plugins/inline.mdwn +++ b/doc/plugins/inline.mdwn @@ -1,34 +1,10 @@ -[[template id=plugin name=inline core=1 included=1 author="[[Joey]]"]] -[[tag type/core]] +[[template id=plugin name=inline core=1 author="[[Joey]]"]] -This is a [[PreProcessorDirective]] that allows including one wiki page +This is a [[ikiwiki/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. +The most common use of inlining is generating blogs and RSS or Atom feeds. +See [[ikiwiki/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).