changeset 804:8d2b8248ac9f

Improve documentation about the digest list text.
author Ben Schmidt
date Wed, 04 Jan 2012 04:06:37 +1100
parents 43979253cf97
children 255d277b37db
files README.listtexts
diffstat 1 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.listtexts	Fri Dec 30 00:13:54 2011 +1100
+++ b/README.listtexts	Wed Jan 04 04:06:37 2012 +1100
@@ -135,7 +135,9 @@
   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 @@
 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.