[Rt-commit] r17176 - in rt/3.8/trunk: .

[sartak at bestpractical.com]

Author: sartak
Date: Thu Dec 11 19:47:52 2008
New Revision: 17176

Modified:
   rt/3.8/trunk/   (props changed)
   rt/3.8/trunk/lib/RT/Template_Overlay.pm

Log:
 r77052 at onn:  sartak | 2008-12-11 19:47:40 -0500
 Document the variables that are set in T::


Modified: rt/3.8/trunk/lib/RT/Template_Overlay.pm
==============================================================================
--- rt/3.8/trunk/lib/RT/Template_Overlay.pm	(original)
+++ rt/3.8/trunk/lib/RT/Template_Overlay.pm	Thu Dec 11 19:47:52 2008
@@ -297,6 +297,33 @@
 It returns a tuple of (val, message). If val is false, the message contains
 an error message.
 
+The variables that your templates may use include:
+
+=over 4
+
+=item C<$Transaction>
+
+The transaction object.
+
+=item C<$rtname>
+
+The value of the "rtname" config variable.
+
+=item C<$Ticket>
+
+The ticket object. This is only set during a ticket transaction.
+
+=item C<$Requestor>
+
+This is not an object, but the name of the first requestor on the ticket.
+If this is not what you need, inspect C<< $Ticket->Requestors >>.
+
+=item C<loc>
+
+A localization function. See L<Locale::Maketext>.
+
+=item 
+
 =cut
 
 sub Parse {