progress: New plugin to generate progress bars (willu)
[ikiwiki.git] / doc / plugins / progress.mdwn
1 [[!template id=plugin name=progress author="[[Will]]"]]
2 [[!tag type/meta]]
3
4 Provides a \\[[!progress ]] [[ikiwiki/directive]] that displays a
5 progress bar.
6
7 There are two possible parameter sets.  The first is a single parameter
8 `percent` which holds a percentage figure for how complete the progress bar is.
9
10 The second possible set of parameters is a pair of [PageSpecs|[ikiwiki/PageSpec]],
11 `totalpages` and `donepages`.  The progress plugin counts the number of
12 pages in each pagespec and shows the percentage of the total pages that are
13 done.
14
15 This plugin is included in ikiwiki, but is not enabled by default.
16
17 If it is turned on it can show what percentage of pages have discussion pages:
18
19         \[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]