[Rt-commit] r17191 - in rt/3.8/trunk: docs

[sartak at bestpractical.com]

Author: sartak
Date: Fri Dec 12 15:22:50 2008
New Revision: 17191

Modified:
   rt/3.8/trunk/   (props changed)
   rt/3.8/trunk/docs/templates.pod

Log:
 r77076 at onn:  sartak | 2008-12-12 15:22:42 -0500
 Document the special header content-type: text/html


Modified: rt/3.8/trunk/docs/templates.pod
==============================================================================
--- rt/3.8/trunk/docs/templates.pod	(original)
+++ rt/3.8/trunk/docs/templates.pod	Fri Dec 12 15:22:50 2008
@@ -1,5 +1,33 @@
 =head1 Templates
 
+Each template is split into two sections. A block of headers and a body. These
+sections are separated by a blank line.
+
+=head2 Headers
+
+Your template may specify arbitrary email headers. Each header is a name, a
+colon, then a value. So, for example, to specify a subject, you can use:
+
+    Subject: Thanks for your bug report.
+
+=head3 Special Headers
+
+=over
+
+=item Content-Type: text/html
+
+The special header "Content-Type: text/html" tells RT that the template should
+be parsed as HTML. RT will automatically make the outgoing message multipart.
+That way, recipients who can read only plaintext email will receive something
+readable, while users with clients which can display HTML will receive the full
+experience.
+
+We welcome contributions of HTML-ization of builtin templates.
+
+=back
+
+=head2 Variables
+
 The variables that your templates may use include:
 
 =over 4