(no commit message)
[ikiwiki.git] / doc / plugins / contrib / imailhide.mdwn
1 # Mailhide Plugin for Ikiwiki
2
3 This plugin provides the directive mailhide, that uses the [Mailhide
4 API][1] to protect email addresses from spammers.
5
6 ## Dependencies
7
8 The [Captcha::reCAPTCHA::Mailhide][2] perl module is required for this
9 plugin.
10
11 ## Download
12
13 You can get the source code from [github][3].
14
15 ## Installation
16
17 Copy `imailhide.pm` to `/usr/share/perl/5.10.0/IkiWiki/Plugin` or
18 `~/.ikiwiki/IkiWiki/Plugin`, and enable it in your `.setup` file
19
20     add_plugins => [qw{goodstuff imailhide ....}],
21     mailhide_public_key => "8s99vSA99fF11mao193LWdpa==",
22     mailhide_private_key => "6b5e4545326b5e4545326b5e45453223",
23     mailhide_default_style => "short",
24
25 ## Configuration
26
27 ### `mailhide_public_key`
28
29 This is your personal public key that you can get at [Google][4].
30
31 ### `mailhide_private_key`
32
33 This is your personal private key that you can get at [Google][4].
34
35 ### `mailhide_default_style`
36
37 As per the recommendation of the [Mailhide API documentation][5], you
38 can define this as `short` or `long`. The `short` parameter will
39 result in `<a href="...">john</a>` links, while the `long` parameter
40 will result in `joh<a href="...">...</a>@example.com`.
41
42 ## Parameters
43
44 ### `email`
45
46 *Required.* This is the email addres that you want to hide.
47
48 ### `style`
49
50 *Optional.* You can set the style parameter individually for each
51  `mailhide` call. See `mailhide_default_style` for details.
52
53 ## Known Issues
54
55 1. [opening new window when displaying email address][6]
56
57 [1]: http://www.google.com/recaptcha/mailhide/
58 [2]: http://search.cpan.org/perldoc?Captcha::reCAPTCHA::Mailhide
59 [3]: http://github.com/petervizi/imailhide
60 [4]: http://www.google.com/recaptcha/mailhide/apikey
61 [5]: http://code.google.com/apis/recaptcha/docs/mailhideapi.html
62 [6]: http://github.com/petervizi/imailhide/issues#issue/1