web commit by JoshTriplett: Application submitted 03-06-2007.

[ikiwiki.git] / doc / blog.mdwn

diff --git a/doc/blog.mdwn b/doc/blog.mdwn
index 598ad98d5a08157ac9be1456358d68b498f57206..6e697d7e2d952b1ad8d1a5cd79711ef857f1caa8 100644 (file)
--- a/doc/blog.mdwn
+++ b/doc/blog.mdwn
@@ -1,18 +1,42 @@
-You can turn any page on this wiki into a weblog by inserting a
-[[PostProcessorDirective]]. Like this:
+[[if test="enabled(inline)"
+     then="This wiki has the inline plugin **enabled**."
+     else="This wiki has the inline plugin **disabled**."]]
 
-\\[[inline pages="blog/* !*/Discussion" show="10"]]
+[[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:
 
-Any pages that match the specified [[GlobList]] (in the exaple, any
-[[SubPages]] of "blog") will be part of the blog, and the newest 10
-of them will appear in the page.
+       \[[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
+of them will appear in the page. Note that if files that are not pages
+match the [[PageSpec]], they will be included in the feed using RSS
+enclosures, which is useful for podcasting.
+
+The optional `rootpage` parameter tells the wiki that new posts to this blog
+should default to being [[SubPage]]s of "blog", and enables a form at the
+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/* !*/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="* !*/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)"]]
+
+Or include some tags and exclude others:
+
+       \[[inline pages="link(debian) and !link(social)"]]