add warnings about using map, inline, etc with the sidebar causing

[ikiwiki.git] / doc / blog.mdwn

diff --git a/doc/blog.mdwn b/doc/blog.mdwn
index 9142733624a4fc24fe0f9a9f1a57fca2c5f957ea..be4ed41e249e4088a05224314b241701595029e3 100644 (file)
--- a/doc/blog.mdwn
+++ b/doc/blog.mdwn
@@ -5,8 +5,8 @@
 [[if test="enabled(inline)"
      then="You can"
      else="If this wiki had the inline plugin enabled, you could"]]
-turn any page on this wiki into a weblog by using the [[plugins/inline]]
-[[PreProcessorDirective]].  For example:
+turn any page on this wiki into a weblog by using the `inline`
+[[PreProcessorDirective]]. For example:
 
        \[[inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
 
@@ -40,3 +40,54 @@ all pages that have a given tag:
 Or include some tags and exclude others:
 
        \[[inline pages="link(debian) and !link(social)"]]
+
+## 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.
+* `skip` - Specify a number of pages to skip displaying. Can be useful
+  to produce a feed that only shows archived pages.
+* `rss` - controls generation of an rss feed. On by default if the wiki is
+  configured to use rss feeds, set to "no" to disable.
+* `atom` - controls generation of an atom feed. On by default if the wiki is
+  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.
+* `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.
+* `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 
+  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).
+* `sort` - Controls how inlined pages are sorted. The default, "age" is to
+  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.
+* `feedpages` - A [[PageSpec]] of inlined pages to include in the rss/atom
+  feeds. The default is the same as the `pages` value above, and only pages
+  matches by that value are included, but some of those can be excluded by
+  specifying a tighter [[PageSpec]] here.
+* `feedshow` - Specify the maximum number of matching pages to include in
+  the rss/atom feeds. The default is the same as the `show` value above,