diff options
Diffstat (limited to 'doc/plugins/progress.mdwn')
| -rw-r--r-- | doc/plugins/progress.mdwn | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/plugins/progress.mdwn b/doc/plugins/progress.mdwn new file mode 100644 index 000000000..987d1ec06 --- /dev/null +++ b/doc/plugins/progress.mdwn @@ -0,0 +1,19 @@ +[[!template id=plugin name=progress author="[[Will]]"]] +[[!tag type/meta]] + +Provides a \\[[!progress ]] [[ikiwiki/directive]] that displays a +progress bar. + +There are two possible parameter sets. The first is a single parameter +`percent` which holds a percentage figure for how complete the progress bar is. + +The second possible set of parameters is a pair of [PageSpecs|[ikiwiki/PageSpec]], +`totalpages` and `donepages`. The progress plugin counts the number of +pages in each pagespec and shows the percentage of the total pages that are +done. + +This plugin is included in ikiwiki, but is not enabled by default. + +If it is turned on it can show what percentage of pages have discussion pages: + + \[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]] |