ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / contrib / jssearchfield.mdwn
1 [[!template id=plugin name=jssearchfield author="[[rubykat]]"]]
2 [[!tag type/search]]
3 IkiWiki::Plugin::jssearchfield - Create a search form to search page field data.
4
5 This plugin provides the [[ikiwiki/directive/jssearchfield]] directive.  This
6 enables one to search the structured data ("field" values) of multiple pages.
7 This uses Javascript for the searching, which means that the entire thing
8 is self-contained and does not require a server or CGI access, unlike
9 the default IkiWiki search. This means that it can be used in places such
10 as ebook readers.  The disadvantage is that because Javascript runs
11 in the browser, the searching is only as fast as the machine your browser
12 is running on.
13
14 Because this uses Javascript, the htmlscrubber must be turned off for any page where the directive is used.
15
16 This plugin depends on the [[!iki plugins/contrib/field]] plugin.
17
18 ## Activate the plugin
19
20     # activate the plugin
21     add_plugins => [qw{goodstuff field jssearchfield ....}],
22
23     # disable scrubbing for search page
24     htmlscrubber_skip => 'mysearchpage',
25
26 ## PREREQUISITES
27
28     IkiWiki
29     IkiWiki::Plugin::field
30     HTML::Template
31
32 ## DOWNLOAD
33
34 * browse at GitHub: <http://github.com/rubykat/ikiplugins/blob/master/IkiWiki/Plugin/jssearchfield.pm>
35 * git repo at git://github.com/rubykat/ikiplugins.git