underlays/basewiki/directive/progress.mdwn

   1 The `progress` directive is supplied by the [[!iki plugins/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 progress plugin counts the number of
  10 pages in each pagespec and shows the percentage of the total pages that are
  11 done.
  12
  13 This plugin is included in ikiwiki, but is not enabled by default.
  14
  15 If it is turned on it can show what percentage of pages have discussion pages:
  16
  17 [[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]