Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / ikiwiki / directive / progress.mdwn
1 The `progress` directive is supplied by the [[!iki plugins/progress desc=progress]] plugin.
2
3 This directive generates a progress bar.
4
5 There are two possible parameter sets.  The first is a single parameter
6 "percent" which holds a percentage figure of how complete the progress bar is.
7
8 The second possible set of parameters is a pair of [[ikiwiki/PageSpec]]s,
9 `totalpages` and `donepages`. The directive counts the number of
10 pages in each pagespec and shows the percentage of the total pages that are
11 done.
12
13 For example, to show what percentage of pages have
14 discussion pages:
15
16         \[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]
17
18 [[!meta robots="noindex, follow"]]