aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/listsubscribe.mdwn
blob: 0b93cde221faded79b2e2f743854c6b803de0bfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
[[!template id=plugin name=listsubscribe author="[[schmonz]]"]]
[[!template id=gitbranch branch=schmonz/listsubscribe author="[[schmonz]]"]]
[[!tag type/web]]

This plugin provides the `listsubscribe` directive, which inserts a web
form for your readers to subscribe to a mailing list. The directive
takes a required `listname` parameter, which must refer to one of the
lists named in the wiki setup file.

## Example

In `ikiwiki.setup`:

    add_plugins:
    - listsubscribe
    
    listsubscribe:
      'my supercool mailing list': supercool-subscribe@neato.great

(Where `supercool-subscribe@neato.great` is the subscription address
provided by your mailing list manager.)

In any wiki page:

    [[!listsubscribe listname="my supercool mailing list"]]