git.oblomov.eu Git - ikiwiki/blob - doc/todo/progressbar_plugin.mdwn

   1 I would like to add next plugin to Ikiwiki. It's `progressbar` or simply `progress`.
   2 I'm not sure what plugin name better is, probably that shorter ;) I know that
   3 [DokuWiki](http://wiki.splitbrain.org/plugin:progressbar) has similar plugin,
   4 so I think it can be useful also for Ikiwiki users.
   5
   6 Here is proposition of the plugin syntax:
   7
   8     \[[!progress done=50]]
   9
  10 Of course, `done` argument is integer from 0 to 100.
  11
  12 A here is its HTML result:
  13
  14     <div class="progress">
  15       <div class="progress-done" style="width: 50%">50%</div>
  16     </div>
  17
  18 Note: I was trying with `<span>` tags too, but that tag is inline, so I can't
  19 set `width` property for it.
  20
  21 Default CSS styles for the plugin can be like below:
  22
  23     div.progress {
  24             border: 1px solid #ddd;
  25             /* border: 2px solid #ddd; */
  26             width: 200px;
  27             background: #fff;
  28             padding: 2px;
  29             /* padding: 0px; */
  30             border: 2px solid #aaa;
  31             background: #eee;
  32     }
  33     div.progress-done {
  34             height: 14px;
  35             background: #ff6600;
  36             font-size: 12px;
  37             text-align: center;
  38             vertical-align: middle;
  39     }
  40
  41 You can use alternative, commented CSS code for `div.progress` if you dislike
  42 padding around done strip.
  43
  44 Any comments? --[[Paweł|ptecza]]
  45
  46 > This looks like a nice idea.  If I could add one further suggestion: Allow your
  47 > ratio to be a pair of pagespecs.  Then you could have something like:
  48
  49     \[[!progress totalpages="bugs/* and backlink(milestoneB)" donepages="bugs/* and backlink(milestoneB) and !link(bugs/done)"]]
  50
  51 > to have a progress bar marking how many bugs were compete for a
  52 > particular milestone.  -- [[Will]]
  53
  54 >> Thanks a lot for your comment, Will! It seems very interesting for me.
  55 >> I need to think more about improving that plugin. --[[Paweł|ptecza]]
  56
  57 >> Attached is a [[patch]] (well, source) for this.  You also need to add the proposed CSS above to `style.css`.
  58 >> At the moment this plugin interacts poorly with the [[plugins/htmlscrubber]] plugin.
  59 >> HTMLScrubber plugin removes the `style` attribute from the `progress-done` `div` tag, and so it defaults
  60 >> to a width of 100%. -- [[Will]]
  61
  62 >>> Thank you for the code! I know how to fix that problem, because I had
  63 >>> the same issue while writing [[todo/color_plugin]] :) --[[Paweł|ptecza]]
  64
  65 >>>> Ahh - good idea.  Patch updated to work with HTMLScrubber. --[[Will]]
  66
  67 >>>>> I like it, but I think that Joey should take a look at that patch too :)
  68 >>>>> --[[Paweł|ptecza]]
  69
  70     #!/usr/bin/perl
  71     package IkiWiki::Plugin::progress;
  72
  73     use warnings;
  74     use strict;
  75     use IkiWiki 2.00;
  76
  77     my $percentage_pattern = qr/[0-9]+\%/; # pattern to validate percentages
  78
  79     sub import { #{{{
  80         hook(type => "getsetup", id => "progress", call => \&getsetup);
  81         hook(type => "preprocess", id => "progress", call => \&preprocess);
  82         hook(type => "format",     id => "progress", call => \&format);
  83     } # }}}
  84
  85     sub getsetup () { #{{{
  86         return
  87                 plugin => {
  88                         safe => 1,
  89                         rebuild => undef,
  90                 },
  91     } #}}}
  92
  93     sub preprocess (@) { #{{{
  94         my %params=@_;
  95
  96         my $fill;
  97
  98         if (defined $params{percent}) {
  99                 $fill = $params{percent};
 100                 ($fill) = $fill =~ m/($percentage_pattern)/; # fill is untainted now
 101         }
 102         elsif (defined $params{totalpages} and defined $params{donepages}) {
 103                 add_depends($params{page}, $params{totalpages});
 104                 add_depends($params{page}, $params{donepages});
 105
 106                 my @pages=keys %pagesources;
 107                 my $totalcount=0;
 108                 my $donecount=0;
 109                 foreach my $page (@pages) {
 110                         $totalcount++ if pagespec_match($page, $params{totalpages}, location => $params{page});
 111                         $donecount++ if pagespec_match($page, $params{donepages}, location => $params{page});
 112                 }
 113
 114                 if ($totalcount == 0) {
 115                         $fill = "100%";
 116                 } else {
 117                         my $number = $donecount/$totalcount*100;
 118                         $fill = sprintf("%u%%", $number);
 119                 }
 120         }
 121         else {
 122                 error("Missing parameters to progress plugin.  Need either `percent` or `totalpages` and `donepages` parameters.");
 123         }
 124
 125         return <<EODIV
 126     <div class="progress">
 127       <div class="progress-done" style="width: $fill">$fill</div>
 128     </div>
 129     EODIV
 130
 131     } # }}}
 132
 133     sub format(@) { #{{{
 134         my %params = @_;
 135
 136         # If HTMLScrubber has removed the style attribute, then bring it back
 137
 138         $params{content} =~ s!<div class="progress-done">($percentage_pattern)</div>!<div class="progress-done" style="width: $1">$1</div>!g;
 139
 140         return $params{content};
 141     } #}}}
 142
 143     1
 144
 145 Here is a potential documentation page:
 146
 147 -----
 148
 149 [[!template id=plugin name=progress author="[[Will]]"]]
 150 [[!tag type/meta]]
 151
 152 Provides a \\[[!progress ]] [[ikiwiki/PreProcessorDirective]] that is
 153 replaced with a progress bar.
 154
 155 There are two possible parameter sets.  The first is a single parameter
 156 `percent` which holds a percentage figure for how complete the progress bar is.
 157
 158 The second possible set of parameters is a pair of [[ikiwiki/PageSpec]]s,
 159 `totalpages` and `donepages`.  The progress plugin counts the number of
 160 pages in each pagespec and shows the percentage of the total pages that are
 161 done.
 162
 163 This plugin is included in ikiwiki, but is not enabled by default.
 164
 165 If it is turned on it can show what percentage of pages have discussion pages:
 166
 167 [[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]