Document wc plugin.
[ikiwiki.git] / doc / plugins / contrib / wc.mdwn
1 [[!template id=plugin name=wc author="[[schmonz]]"]]
2 [[!template id=gitbranch branch=schmonz/wc author="[[schmonz]]"]]
3 [[!tag type/meta]]
4
5 This plugin counts words in a page. For a single page, write a
6 `\[[!wc]]` directive and the word count will be interpolated there.
7 For a site, add `<TMPL_VAR WORDCOUNT>` to your [[templates]].
8
9 If [[!cpan HTML::Strip]] is installed, the wordcount will be slightly
10 more accurate.
11
12 Possible enhancements:
13
14 * Optimize: count words iff the result will be displayed. `sanitize()`
15   seems like the right place to count. Since it's called well after
16   `preprocess()`, I can tell whether a directive needs the result,
17   but since it appears to be called before `pagetemplate()`, I can't
18   tell whether a template wants to know and possibly skip the
19   computation. (In other words, if I add `$needed_for_template`
20   like `$needed_for_directive`, it gets set too late for `sanitize()`
21   to see.)