X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/0eab8e9e67e963502a359f298f14eb919272f56f..6432d15cb42b7b5b885b766d67f35ff2356f883c:/doc/todo/progressbar_plugin.mdwn

diff --git a/doc/todo/progressbar_plugin.mdwn b/doc/todo/progressbar_plugin.mdwn
index 2325d2e40..1df131ca3 100644
--- a/doc/todo/progressbar_plugin.mdwn
+++ b/doc/todo/progressbar_plugin.mdwn
@@ -18,6 +18,8 @@ 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 
+
 Default CSS styles for the plugin can be like below:
 
     div.progress {
@@ -51,11 +53,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;
     
@@ -63,11 +76,12 @@ Any comments? --[[Paweł|ptecza]]
     use strict;
     use IkiWiki 2.00;
     
-    my $percentage_pattern = qr/[0-9]\%/; # pattern to validate percentages
+    my $percentage_pattern = qr/[0-9]+\%/; # pattern to validate percentages
     
     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 () { #{{{
@@ -100,7 +114,7 @@ Any comments? --[[Paweł|ptecza]]
     		}
     		
     		if ($totalcount == 0) {
-    			$fill = "100%"
+    			$fill = "100%";
     		} else {
     			my $number = $donecount/$totalcount*100;
     			$fill = sprintf("%u%%", $number);
@@ -118,4 +132,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"]]