* inline: Add ability to sort by page name, based on a patch from
[ikiwiki.git] / doc / plugins / inline.mdwn
index a142df1548d9272fe51b26b3fc14c1b69f0e5387..ef08d2cb23c5079d72ee6bb6c463cef164aaf895 100644 (file)
@@ -1,3 +1,6 @@
+[[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:
 
@@ -24,7 +27,10 @@ directive:
   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]]
+* `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).
+* `sort` - Controls how inlined pages are sorted. The default, "age" is to
+  sort newest pages first. Setting it to "title" will sort pages by title.