Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

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

diff --git a/doc/ikiwiki/directive/progress.mdwn b/doc/ikiwiki/directive/progress.mdwn
index c477c435abb8e50bd161655cce2a8095d1716a17..c619ef3fc43c73ee5e3d70943fe836fe91de5af3 100644 (file)
--- a/doc/ikiwiki/directive/progress.mdwn
+++ b/doc/ikiwiki/directive/progress.mdwn
@@ -1,4 +1,4 @@
-The `progress` directive is supplied by the [[!iki plugins/progress]] plugin.
+The `progress` directive is supplied by the [[!iki plugins/progress desc=progress]] plugin.
 
 This directive generates a progress bar.
 
@@ -6,7 +6,7 @@ There are two possible parameter sets.  The first is a single parameter
 "percent" which holds a percentage figure of how complete the progress bar is.
 
 The second possible set of parameters is a pair of [[ikiwiki/PageSpec]]s,
-`totalpages` and `donepages`.  The progress plugin counts the number of
+`totalpages` and `donepages`. The directive counts the number of
 pages in each pagespec and shows the percentage of the total pages that are
 done.
 
@@ -15,4 +15,8 @@ discussion pages:
 
        \[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]
 
+Which would result in the following:
+
+[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]
+
 [[!meta robots="noindex, follow"]]