escape directive properly; add paragraph breaks

[git.ikiwiki.info.git] / doc / ikiwiki / directive / aggregate.mdwn

diff --git a/doc/ikiwiki/directive/aggregate.mdwn b/doc/ikiwiki/directive/aggregate.mdwn
index 58c580b8fe3e4a7729d46d600639be829f7fa176..ddfcd40b79edfa4678e6a8a1c5b08fb9b9251634 100644 (file)
--- a/doc/ikiwiki/directive/aggregate.mdwn
+++ b/doc/ikiwiki/directive/aggregate.mdwn
@@ -1,4 +1,4 @@
-The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin.
+The `aggregate` directive is supplied by the [[!iki plugins/aggregate desc=aggregate]] plugin.

 This plugin requires extra setup, specifically, a cron job. See the
 plugin's documentation for details.
 
 This plugin requires extra setup, specifically, a cron job. See the
 plugin's documentation for details.
 


@@ -14,11 +14,16 @@ more frequently than once every 15 minutes (though possibly less
 frequently, if the cron job runs less frequently than that), and puts a
 page per post under the example/ directory in the wiki.
 
 frequently, if the cron job runs less frequently than that), and puts a
 page per post under the example/ directory in the wiki.
 

-You can then use ikiwiki's [[ikiwiki/blog]] support to create a blog of one or
+You can then use ikiwiki's [[inline]] directive to create a blog of one or

 more aggregated feeds. For example:
 
        \[[!inline pages="internal(example/*)"]]
 
 more aggregated feeds. For example:
 
        \[[!inline pages="internal(example/*)"]]
 

+Note the use of `internal()` in the [[ikiwiki/PageSpec]] to match
+aggregated pages. By default, aggregated pages are internal pages,
+which prevents them from showing up directly in the wiki, and so this
+special [[PageSpec]] is needed to match them.
+

 ## usage
 
 Here are descriptions of all the supported parameters to the `aggregate`
 ## usage
 
 Here are descriptions of all the supported parameters to the `aggregate`