doc/plugins/contrib/imailhide.mdwn

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