]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/inline.mdwn
(no commit message)
[git.ikiwiki.info.git] / doc / plugins / inline.mdwn
index a142df1548d9272fe51b26b3fc14c1b69f0e5387..3eb849fdbcc237ae5bc6706e24d4cc6ac23db49c 100644 (file)
@@ -1,30 +1,6 @@
-This is a [[PreProcessorDirective]] that allows including one wiki page
-inside another. For example:
+[[!template id=plugin name=inline core=1 author="[[Joey]]"]]
+[[!tag type/widget]]
 
-       \[[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.
-
-This plugin is enabled by default.
-
-[[tag type/core]]
+This plugin provides the [[ikiwiki/directive/inline]]
+[[ikiwiki/directive]], which allows including one wiki page
+inside another.