diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/progress.mdwn | 19 | ||||
| -rw-r--r-- | doc/style.css | 16 | ||||
| -rw-r--r-- | doc/todo/progressbar_plugin.mdwn | 99 |
3 files changed, 36 insertions, 98 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"]] diff --git a/doc/style.css b/doc/style.css index 44a6e0fe1..595a38dfa 100644 --- a/doc/style.css +++ b/doc/style.css @@ -249,6 +249,22 @@ div.poll { border: 1px solid #aaa; } +div.progress { + margin-top: 1ex; + margin-bottom: 1ex; + border: 1px solid #888; + width: 400px; + background: #eee; + color: black !important; + padding: 1px; +} +div.progress-done { + background: #ea6 !important; + color: black !important; + text-align: center; + padding: 1px; +} + input#openid_url { background: url(wikiicons/openidlogin-bg.gif) no-repeat; background-color: #fff; diff --git a/doc/todo/progressbar_plugin.mdwn b/doc/todo/progressbar_plugin.mdwn index 3401bca85..263e7a69d 100644 --- a/doc/todo/progressbar_plugin.mdwn +++ b/doc/todo/progressbar_plugin.mdwn @@ -127,101 +127,4 @@ Any comments? --[[Paweł|ptecza]] >>>>> 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; - - use warnings; - use strict; - use IkiWiki 2.00; - - 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 () { #{{{ - return - plugin => { - safe => 1, - rebuild => undef, - }, - } #}}} - - sub preprocess (@) { #{{{ - my %params=@_; - - my $fill; - - if (defined $params{percent}) { - $fill = $params{percent}; - ($fill) = $fill =~ m/($percentage_pattern)/; # fill is untainted now - } - elsif (defined $params{totalpages} and defined $params{donepages}) { - add_depends($params{page}, $params{totalpages}); - add_depends($params{page}, $params{donepages}); - - my @pages=keys %pagesources; - my $totalcount=0; - my $donecount=0; - foreach my $page (@pages) { - $totalcount++ if pagespec_match($page, $params{totalpages}, location => $params{page}); - $donecount++ if pagespec_match($page, $params{donepages}, location => $params{page}); - } - - if ($totalcount == 0) { - $fill = "100%"; - } else { - my $number = $donecount/$totalcount*100; - $fill = sprintf("%u%%", $number); - } - } - else { - error("Missing parameters to progress plugin. Need either `percent` or `totalpages` and `donepages` parameters."); - } - - return <<EODIV - <div class="progress"> - <div class="progress-done" style="width: $fill">$fill</div> - </div> - EODIV - - } # }}} - - 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/Directive]] 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"]] +>>>>>> Reviewed, looks excellent, added. [[done]] --[[Joey]] |