Mentioning the locale option

git-svn-id: https://ledger-smb.svn.sourceforge.net/svnroot/ledger-smb/trunk@1585 4979c152-3d1c-0410-bac9-87ea11338e46

1 files changed, 7 insertions, 1 deletions

diff --git a/LedgerSMB/Template.pm b/LedgerSMB/Template.pm
index ba17f03e..1b59f664 100755
--- a/LedgerSMB/Template.pm
+++ b/LedgerSMB/Template.pm
@@ -11,7 +11,7 @@ This module renders templates.
 
 =over
 
-=item new(user => \%myconfig, template => $string, format => $string, [language => $string], [include_path => $path], [no_auto_output => $bool], [method => $string], [no_escape => $bool], [debug => $bool] );
+=item new(user => \%myconfig, template => $string, format => $string, [locale => $locale] [language => $string], [include_path => $path], [no_auto_output => $bool], [method => $string], [no_escape => $bool], [debug => $bool] );
 
 This command instantiates a new template:
 
@@ -25,6 +25,12 @@ The name of the template file to be processed.
 
 The format to be used.  Currently HTML, PS, PDF, TXT and CSV are supported.
 
+=item locale (optional)
+
+The locale object to use for regular gettext lookups.  Having this option adds
+the text function to the usable list for the templates.  Has no effect on the
+gettext function.
+
 =item language (optional)
 
 The language for template selection.