From: Ben Schmidt <none@none>
Date: Tue, 3 Jan 2012 17:06:37 +0000 (+1100)
Subject: Improve documentation about the digest list text.
X-Git-Tag: RELEASE_1_2_18a1~61
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=753d342da8ea2ab9ab2540ece783572631266376;p=thirdparty%2Fmlmmj.git

Improve documentation about the digest list text.
---

diff --git a/README.listtexts b/README.listtexts
index 568c661e..5abc727f 100644
--- a/README.listtexts
+++ b/README.listtexts
@@ -135,7 +135,9 @@ is given in brackets. Those with asterisks (*) are not yet used.
   sent to the list owner when somebody is (un-)subscribed
 
 - digest
-  sent at the start of a digest
+  sent at the start of a digest (NOTE: the only header supported in this list
+  text so far is a single-line 'Subject:' header; however, the contents of
+  control/customheaders is included when digests are sent)
 
 - probe (bounce-probe)
   sent to a subscriber after an email to them bounced to inform them of the
@@ -180,6 +182,8 @@ The Subject: header is treated specially: it may include UTF-8 characters,
 which will automatically be escaped using the =?utf-8?q?...?= quoting
 mechanism.
 
+(NOTE: the 'digest' list text is a bit different. See its description above.)
+
 Both headers and bodies of list texts may include conditionals, formatting
 directives and substitutions. These are explained in the following sections.