web commit by JoshTriplett: Differentiate the postformtext of plugins/contrib from...

[git.ikiwiki.info.git] / doc / plugins / inline.mdwn

diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn
index a607474df4c251a5eccb57ba378cc995a12dc586..7c8f54d11bd7b5fec6edc60cde206a6592177bb1 100644 (file)
--- a/doc/plugins/inline.mdwn
+++ b/doc/plugins/inline.mdwn
@@ -29,11 +29,20 @@ directive:
   configured to use atom feeds, set to "no" to disable.
 * `feeds` - controls generation of all types of feeds. Set to "no" to
   disable generating any feeds.
   configured to use atom feeds, set to "no" to disable.
 * `feeds` - controls generation of all types of feeds. Set to "no" to
   disable generating any feeds.

-* `rootpage` - Enables a form to post new pages to a [[blog]].
+* `postform` - Set to "yes" to enables a form to post new pages to a [[blog]].
+* `postformtext` - Set to specify text that is displayed in a postform.
+* `rootpage` - Also enables a form to post new pages to a [[blog]], and
+  allows specifying of a page that is used as the parent page for new pages.

 * `archive` - If set to "yes", only list page titles and some metadata, not
   full controls.
 * `quick` - Build archives in quick mode, without reading page contents for
   metadata. By default, this also turns off generation of any feeds.
 * `archive` - If set to "yes", only list page titles and some metadata, not
   full controls.
 * `quick` - Build archives in quick mode, without reading page contents for
   metadata. By default, this also turns off generation of any feeds.

+* `template` - Specifies the template to fill out to display each inlined
+  page. By default the `inlinepage` [[template|wikitemplates]] is used, while
+  the `archivepage` template is used for archives. Set this parameter to
+  use some other, custom template, such as the `titlepage` template that
+  only shows post titles. Note that you should still set `archive=yes` if
+  your custom template does not include the page content.

 * `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 
 * `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 


@@ -44,5 +53,6 @@ directive:
   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
   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.
+  sort newest created pages first. Setting it to "title" will sort pages by
+  title, and "mtime" sorts most recently modified pages first.

 * `reverse` - If set to "yes", causes the sort order to be reversed.
 * `reverse` - If set to "yes", causes the sort order to be reversed.