[Rt-commit] rt branch, 4.2/update-templates-doc, created. rt-4.1.19-32-g104e00d

[Jim Brandt]

The branch, 4.2/update-templates-doc has been created
        at  104e00d9f6ed0ab5cbf93a6f57ccf89e4d79edfa (commit)

- Log -----------------------------------------------------------------
commit 104e00d9f6ed0ab5cbf93a6f57ccf89e4d79edfa
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Thu Aug 22 13:32:10 2013 -0400

    Update docs with HTML template details for 4.2
    
    Also add some more examples for Ticket and Transaction
    objects.

diff --git a/docs/customizing/templates.pod b/docs/customizing/templates.pod
index 5733f60..a4693a4 100644
--- a/docs/customizing/templates.pod
+++ b/docs/customizing/templates.pod
@@ -1,7 +1,14 @@
 =head1 Templates
 
-Each template is split into two sections. A block of headers and a body. These
-sections are separated by a blank line.
+Templates are used in RT to send notifications, typically email. You have
+access to RT data via variables available to you in the scope of the template.
+Templates can also be used for some special actions like creating a new ticket
+as part of the execution of a scrip.
+
+Each template is split into two sections: a block of headers and a body. These
+sections are separated by a blank line. Blank lines are not allowed before
+the headers, but can be included in the body as needed after the headers
+section.
 
 Templates are processed by the L<Text::Template> module. This module
 allows you to embed arbitrary Perl code into your templates. Text wrapped
@@ -28,17 +35,17 @@ readable, while users with clients which can display HTML will receive the full
 experience. Please be aware that HTML support in mail clients varies greatly,
 much more so than different web browsers.
 
-We welcome contributions of HTML-ization of builtin templates.
+Starting in RT 4.2, HTML templates are included along with plain text templates
+for the standard RT notifications.
 
 =back
 
 =head2 Template Types
 
-Templates have a Type which dictates which level of code execution is
-allowed.
+Templates have a Type which dictates the level of code execution allowed.
 
 Templates of type C<Perl> are evaluated using L<Text::Template>
-which allows arbitrary code execution. Only users which have the global
+which allows arbitrary code execution. Only users with the global
 C<ExecuteCode> privilege may write templates of type C<Perl>. Prior to
 RT 4.0, this was the only type of Template available.
 
@@ -82,6 +89,24 @@ A localization function. See L<Locale::Maketext>.
 
 =back
 
+The C<$Transaction> and C<$Ticket> objects are particularly useful. For
+example, here are some values you can get from each:
+
+    $Ticket->Status      # Current status
+    $Ticket->Owner       # Current owner
+    $Ticket->FirstCustomFieldValue('CustomFieldName') # CF value
+    $Ticket->DueAsString # Current due date as a string
+    $Ticket->DueObj      # Due as an RT::Date object
+    $Ticket->QueueObj    # Queue object for this ticket
+
+    $Transaction->Type     # Type of transaction
+    $Transaction->OldValue # Previous value, if type is Set
+    $Transaction->NewValue # New value, if type is Set
+    $Transaction->CreatorObj->EmailAddress # Email address of trans creator
+
+You can see the methods available in the L<RT::Ticket> and L<RT::Transaction>
+documentation.
+
 =head3 Selected Simple template variables
 
 Since method calls are not allowed in simple templates, many common

-----------------------------------------------------------------------