]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/todo/progressbar_plugin.mdwn
comments
[git.ikiwiki.info.git] / doc / todo / progressbar_plugin.mdwn
index 19e23a6f0cd72252be84140841d25f654cce7c5c..9695f3ca1c94b342db60a4bb34ce31dfce501d59 100644 (file)
@@ -18,6 +18,19 @@ A here is its HTML result:
 Note: I was trying with `<span>` tags too, but that tag is inline, so I can't
 set `width` property for it.
 
+> In the poll plugin, I ended up using a `<hr>` for the progress-like
+> thing. One reason I did so is because it actually works in text-mode
+> browsers (w3m, lynx), that do not support css or colorized
+> divs. Since the hr is an element they display, just setting its width can
+> make a basic progress-type display. The style then makes it display
+> better in more capable browsers.
+> 
+> The other advantage to that approach is that the htmlscrubber lets
+> through the `class` and `width` fields, that are all that are needed for
+> it to work. No need to work around htmlscrubber.
+> 
+> So I suggest adapting this to use similar html. --[[Joey]]
+
 Default CSS styles for the plugin can be like below:
 
     div.progress {
@@ -38,6 +51,10 @@ Default CSS styles for the plugin can be like below:
             vertical-align: middle;
     }
 
+> Please make sure to always set a foreground color if a background color is
+> set, and use '!important' so the foreground color can be overridden. (CSS
+> best practices) --[[Joey]]
+
 You can use alternative, commented CSS code for `div.progress` if you dislike
 padding around done strip.
 
@@ -51,11 +68,22 @@ Any comments? --[[Paweł|ptecza]]
 > to have a progress bar marking how many bugs were compete for a
 > particular milestone.  -- [[Will]]
 
+>> Thanks a lot for your comment, Will! It seems very interesting for me.
+>> I need to think more about improving that plugin. --[[Paweł|ptecza]]
+
 >> Attached is a [[patch]] (well, source) for this.  You also need to add the proposed CSS above to `style.css`.
 >> At the moment this plugin interacts poorly with the [[plugins/htmlscrubber]] plugin.
 >> HTMLScrubber plugin removes the `style` attribute from the `progress-done` `div` tag, and so it defaults
 >> to a width of 100%. -- [[Will]]
 
+>>> Thank you for the code! I know how to fix that problem, because I had
+>>> the same issue while writing [[todo/color_plugin]] :) --[[Paweł|ptecza]]
+
+>>>> Ahh - good idea.  Patch updated to work with HTMLScrubber. --[[Will]]
+
+>>>>> I like it, but I think that Joey should take a look at that patch too :)
+>>>>> --[[Paweł|ptecza]]
+
     #!/usr/bin/perl
     package IkiWiki::Plugin::progress;
     
@@ -68,6 +96,7 @@ Any comments? --[[Paweł|ptecza]]
     sub import { #{{{
        hook(type => "getsetup", id => "progress", call => \&getsetup);
        hook(type => "preprocess", id => "progress", call => \&preprocess);
+       hook(type => "format",     id => "progress", call => \&format);
     } # }}}
     
     sub getsetup () { #{{{
@@ -118,4 +147,38 @@ Any comments? --[[Paweł|ptecza]]
     
     } # }}}
     
+    sub format(@) { #{{{
+       my %params = @_;
+    
+       # If HTMLScrubber has removed the style attribute, then bring it back
+    
+       $params{content} =~ s!<div class="progress-done">($percentage_pattern)</div>!<div class="progress-done" style="width: $1">$1</div>!g;
+    
+       return $params{content};    
+    } #}}}
+    
     1
+
+Here is a potential documentation page:
+
+-----
+
+[[!template id=plugin name=progress author="[[Will]]"]]
+[[!tag type/meta]]
+
+Provides a \\[[!progress ]] [[ikiwiki/PreProcessorDirective]] that is
+replaced with 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 [[ikiwiki/PageSpec]]s,
+`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"]]