doc/plugins/contrib/listsubscribe.mdwn

   1 [[!template id=plugin name=listsubscribe author="[[schmonz]]"]]
   2 [[!template id=gitbranch branch=schmonz/listsubscribe author="[[schmonz]]"]]
   3 [[!tag type/web patch reviewed]]
   4
   5 This plugin provides the `listsubscribe` directive, which inserts a web
   6 form for your readers to subscribe to a mailing list. The directive
   7 takes a required `listname` parameter, which must refer to one of the
   8 lists named in the wiki setup file.
   9
  10 ## Example
  11
  12 In `ikiwiki.setup`:
  13
  14     add_plugins:
  15     - listsubscribe
  16
  17     listsubscribe:
  18       'my supercool mailing list': supercool-subscribe@neato.great
  19
  20 (Where `supercool-subscribe@neato.great` is the subscription address
  21 provided by your mailing list manager.)
  22
  23 In any wiki page:
  24
  25     [[!listsubscribe listname="my supercool mailing list"]]