new version; splitting docs between plugin and directive pages
[ikiwiki.git] / doc / plugins / contrib / report.mdwn
1 [[!template id=plugin name=report author="[[rubykat]]"]]
2 [[!tag type/meta type/format]]
3 IkiWiki::Plugin::report - Produce templated reports from page field data.
4
5 This plugin provides the [[ikiwiki/directive/report]] directive.  This enables
6 one to report on the structured data ("field" values) of multiple pages; the
7 output is formatted via a template.  This depends on the
8 [[plugins/contrib/field]] plugin.
9
10
11 ## Activate the plugin
12
13     # activate the plugin
14     add_plugins => [qw{goodstuff report ....}],
15
16 ## PREREQUISITES
17
18     IkiWiki
19     IkiWiki::Plugin::field
20     HTML::Template
21     Encode
22
23 ## DOWNLOAD
24
25 * browse at GitHub: <http://github.com/rubykat/ikiplugins/blob/master/IkiWiki/Plugin/report.pm>
26 * git repo at git://github.com/rubykat/ikiplugins.git