Document [[inline guid="..."]]

[ikiwiki.git] / doc / ikiwiki / blog.mdwn

diff --git a/doc/ikiwiki/blog.mdwn b/doc/ikiwiki/blog.mdwn
index 6e5eec4aada473f6b10c94d2bdffec6d1e56fb75..90159e939640187a754d200edde99ba84ebc46cc 100644 (file)
--- a/doc/ikiwiki/blog.mdwn
+++ b/doc/ikiwiki/blog.mdwn
@@ -1,14 +1,15 @@
-[[if test="enabled(inline)"
+[[!meta robots="noindex, follow"]]
+[[!if test="enabled(inline)"
      then="This wiki has the inline plugin **enabled**."
      else="This wiki has the inline plugin **disabled**."]]
 
-[[if test="enabled(inline)"
+[[!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 `inline`
 [[PreProcessorDirective]]. For example:
 
-       \[[inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
+       \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
 
 Any pages that match the specified [[PageSpec]] (in the example, any
 [[SubPage]] of "blog") will be part of the blog, and the newest 10
@@ -23,23 +24,23 @@ top of the blog that can be used to add new items.
 If you want your blog to have an archive page listing every post ever made
 to it, you can accomplish that like this:
 
-       \[[inline pages="blog/* and !*/Discussion" archive="yes"]]
+       \[[!inline pages="blog/* and !*/Discussion" archive="yes"]]
 
 You can even create an automatically generated list of all the pages on the
 wiki, with the most recently added at the top, like this:
 
-       \[[inline pages="* and !*/Discussion" archive="yes"]]
+       \[[!inline pages="* and !*/Discussion" archive="yes"]]
 
 If you want to be able to add pages to a given blog feed by tagging them,
 you can do that too. To tag a page, just make it link to a page or pages 
 that represent its tags. Then use the special `link()` [[PageSpec]] to match
 all pages that have a given tag:
 
-       \[[inline pages="link(life)"]]
+       \[[!inline pages="link(life)"]]
 
 Or include some tags and exclude others:
 
-       \[[inline pages="link(debian) and !link(social)"]]
+       \[[!inline pages="link(debian) and !link(social)"]]
 
 ## usage
 
@@ -52,10 +53,12 @@ directive:
   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.
+* `rss` - controls generation of an rss feed. If the wiki is configured to
+  generate rss feeds by default, set to "no" to disable. If the wiki is
+  configured to `allowrss`, set to "yes" to enable.
+* `atom` - controls generation of an atom feed. If the wiki is configured to
+  generate atom feeds by default, set to "no" to disable. If the wiki is
+  configured to `allowatom`, set to "yes" to enable.
 * `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]].
@@ -95,3 +98,6 @@ directive:
   the page.
 * `timeformat` - Use this to specify how to display the time or date for pages
   in the blog. The format string is passed to the strftime(3) function.
+* `guid` - If a URI is given here (perhaps a UUID prefixed with `urn:uuid:`),
+  the Atom feed will have this as its `<id>`. The default is to use the URL
+  of the page containing the `inline` directive.