changemail: New plugin, sends emails about changed pages.

2 files changed, 15 insertions, 0 deletions

diff --git a/doc/plugins/changeemail.mdwn b/doc/plugins/changeemail.mdwn
new file mode 100644
index 000000000..f37d0f5ad
--- /dev/null
+++ b/doc/plugins/changeemail.mdwn
@@ -0,0 +1,12 @@
+This plugin allows emailing users when pages are created or changed. 
+It needs the [[!cpan Mail::SendMail]] perl module, and sends mail
+using the local MTA.
+
+Each user can configure which pages they are interested in, using an
+[[ikiwiki/PageSpec]] on their Preferences page. Any change to a page
+matching the pagespec will send an email that includes the new content of
+the page, and a link to the page on the web.
+
+To make it easy to subscribe to comment threads when posting a comment,
+there is a check box that can be used to subscribe, without needing to
+manually edit the [[ikiwiki/PageSpec]].
diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 43bf9ee51..ca3f1412a 100644
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -82,10 +82,13 @@ Here is a full list of the template files used:
   make calendar archive pages.
 * `trails.tmpl` - Used by the trail plugin to generate links on each page
   that is a member of a trail.
+* `changemail.tmpl` - Used by the changemail plugin to generate mails about
+  changed pages.
 * `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
   `editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
   `editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,
   `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user
   interface; do not normally need to be customised.
 
+
 [[!meta robots="noindex, follow"]]