[Templates-cvs] cvs commit: Template2/docs/src/Modules/Template Base.html Config.html Constants.html Context.html Document.html Exception.html Filters.html Iterator.html Parser.html Plugin.html Plugins.html Provider.html Service.html Stash.html Test.html
cvs@template-toolkit.org
cvs@template-toolkit.org
Thu, 24 Jul 2003 17:16:09 +0100
cvs 03/07/24 16:16:08
Modified: docs/src/Modules/Template Base.html Config.html
Constants.html Context.html Document.html
Exception.html Filters.html Iterator.html
Parser.html Plugin.html Plugins.html Provider.html
Service.html Stash.html Test.html
Log:
version 2.10
Revision Changes Path
1.55 +3 -3 Template2/docs/src/Modules/Template/Base.html
Index: Base.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Base.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Base.html 2003/04/24 09:14:28 1.54
+++ Base.html 2003/07/24 16:16:03 1.55
@@ -150,13 +150,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.61, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.62, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Config.html
Index: Config.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Config.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Config.html 2003/04/24 09:14:28 1.54
+++ Config.html 2003/07/24 16:16:03 1.55
@@ -170,13 +170,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.61, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.62, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Constants.html
Index: Constants.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Constants.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Constants.html 2003/04/24 09:14:28 1.54
+++ Constants.html 2003/07/24 16:16:03 1.55
@@ -121,13 +121,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.61, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.62, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Context.html
Index: Context.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Context.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Context.html 2003/04/24 09:14:28 1.54
+++ Context.html 2003/07/24 16:16:03 1.55
@@ -675,13 +675,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.79, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.81, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +4 -4 Template2/docs/src/Modules/Template/Document.html
Index: Document.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Document.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Document.html 2003/04/24 09:14:28 1.54
+++ Document.html 2003/07/24 16:16:03 1.55
@@ -190,7 +190,7 @@
-%]<p>
This package subroutine is provided to effect persistance of compiled
templates. If the COMPILE_EXT option (to indicate a file extension
-for saving compiled templates) then the Template::Parser module call
+for saving compiled templates) then the Template::Parser module calls
this subroutine before calling the new() constructor. At this stage,
the parser has a representation of the template as text strings
containing Perl code. We can write that to a file, enclosed in a
@@ -212,13 +212,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.64, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.65, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Exception.html
Index: Exception.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Exception.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Exception.html 2003/04/24 09:14:28 1.54
+++ Exception.html 2003/07/24 16:16:04 1.55
@@ -91,13 +91,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.58, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.59, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +34 -12 Template2/docs/src/Modules/Template/Filters.html
Index: Filters.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Filters.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Filters.html 2003/04/24 09:14:28 1.54
+++ Filters.html 2003/07/24 16:16:04 1.55
@@ -48,10 +48,10 @@
"repeat(iterations)",
"remove(string) ",
"replace(search, replace) ",
- "redirect(file)",
+ "redirect(file, options)",
"eval / evaltt",
"perl / evalperl",
- "stdout(binmode)",
+ "stdout(options)",
"stderr",
"null",
"latex(outputType)"
@@ -80,7 +80,7 @@
[% WRAPPER section
title="DESCRIPTION"
-%]<p>
-The Template::Plugins module implements a provider for creating and/or
+The Template::Filters module implements a provider for creating and/or
returning subroutines that implement the standard filters. Additional
custom filters may be provided via the FILTERS options.
</p>
@@ -379,7 +379,7 @@
encoded (via the escape_html() or encode_entities() subroutines
respectively) to convert all extended characters into their
appropriate HTML entities (e.g. converting 'é' to '&eacute;'). If
-neither module is available on your system then an 'html_all' exception
+neither module is available on your system then an 'html_entity' exception
will be thrown reporting an appropriate message.
</p>
<p>
@@ -539,7 +539,7 @@
<pre> The_cat_sat_on_the_mat</pre>
[%- END %]
[% WRAPPER subsection
- title = "redirect(file)"
+ title = "redirect(file, options)"
-%]<p>
The 'redirect' filter redirects the output of the block into a separate
file, specified relative to the OUTPUT_PATH configuration item.
@@ -559,6 +559,23 @@
<p>
A 'file' exception will be thrown if the OUTPUT_PATH option is undefined.
</p>
+<p>
+An optional 'binmode' argument can follow the filename to explicitly set
+the output file to binary mode.
+</p>
+<pre> [% tt_start_tag %] PROCESS my/png/generator
+ FILTER redirect("images/logo.png", binmode=1) [% tt_end_tag %]</pre>
+<p>
+For backwards compatibility with earlier versions, a single true/false
+value can be used to set binary mode.
+</p>
+<pre> [% tt_start_tag %] PROCESS my/png/generator
+ FILTER redirect("images/logo.png", 1) [% tt_end_tag %]</pre>
+<p>
+For the sake of future compatibility and clarity, if nothing else, we
+would strongly recommend you explicitly use the named 'binmode' option
+as shown in the first example.
+</p>
[%- END %]
[% WRAPPER subsection
title = "eval / evaltt"
@@ -614,12 +631,17 @@
</p>
[%- END %]
[% WRAPPER subsection
- title = "stdout(binmode)"
+ title = "stdout(options)"
-%]<p>
The stdout filter prints the output generated by the enclosing block to
-STDOUT. If binmode is set, binary mode on STDOUT is turned on (see the
-binmode perl function.
-</p>
+STDOUT. The 'binmode' option can be passed as either a named parameter
+or a single argument to set STDOUT to binary mode (see the
+binmode perl function).
+</p>
+<pre> [% tt_start_tag %] PROCESS something/cool
+ FILTER stdout(binmode=1) # recommended [% tt_end_tag %]</pre>
+<pre> [% tt_start_tag %] PROCESS something/cool
+ FILTER stdout(1) # alternate [% tt_end_tag %]</pre>
<p>
The stdout filter can be used to force binmode on STDOUT, or also inside
redirect, null or stderr blocks to make sure that particular output goes
@@ -732,13 +754,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.67, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.72, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Iterator.html
Index: Iterator.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Iterator.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Iterator.html 2003/04/24 09:14:28 1.54
+++ Iterator.html 2003/07/24 16:16:04 1.55
@@ -241,13 +241,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.58, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.59, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Parser.html
Index: Parser.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Parser.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Parser.html 2003/04/24 09:14:28 1.54
+++ Parser.html 2003/07/24 16:16:04 1.55
@@ -496,14 +496,14 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.73, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.75, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
<pre> </pre>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +4 -4 Template2/docs/src/Modules/Template/Plugin.html
Index: Plugin.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Plugin.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Plugin.html 2003/04/24 09:14:28 1.54
+++ Plugin.html 2003/07/24 16:16:04 1.55
@@ -225,7 +225,7 @@
-%]<p>
As of version 2.01, the Template::Plugin module no longer provides an
AUTOLOAD method to delegate to other objects or classes. This was a
-badly designed featured that caused more trouble than good. You can
+badly designed feature that caused more trouble than good. You can
easily add your own AUTOLOAD method to perform delegation if you
require this kind of functionality.
</p>
@@ -242,13 +242,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.59, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.60, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Plugins.html
Index: Plugins.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Plugins.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Plugins.html 2003/04/24 09:14:28 1.54
+++ Plugins.html 2003/07/24 16:16:06 1.55
@@ -790,13 +790,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.64, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.65, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Provider.html
Index: Provider.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Provider.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Provider.html 2003/04/24 09:14:28 1.54
+++ Provider.html 2003/07/24 16:16:06 1.55
@@ -452,13 +452,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.69, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.70, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Service.html
Index: Service.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Service.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Service.html 2003/04/24 09:14:28 1.54
+++ Service.html 2003/07/24 16:16:06 1.55
@@ -454,13 +454,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.69, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.70, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +4 -4 Template2/docs/src/Modules/Template/Stash.html
Index: Stash.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Stash.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Stash.html 2003/04/24 09:14:28 1.54
+++ Stash.html 2003/07/24 16:16:06 1.55
@@ -111,7 +111,7 @@
element, or 0 if none.
</p>
<pre> [% tt_start_tag %] foo.bar(10).baz(20) [% tt_end_tag %]</pre>
-<pre> $stash->get([ 'foo', 0, 'bar', [ 10 ], 'baz', [ 20 ]);</pre>
+<pre> $stash->get([ 'foo', 0, 'bar', [ 10 ], 'baz', [ 20 ] ]);</pre>
[%- END %]
[% WRAPPER subsection
title = "set(\$variable, \$value, \$default)"
@@ -182,13 +182,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.74, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.78, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
1.55 +3 -3 Template2/docs/src/Modules/Template/Test.html
Index: Test.html
===================================================================
RCS file: /template-toolkit/Template2/docs/src/Modules/Template/Test.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- Test.html 2003/04/24 09:14:28 1.54
+++ Test.html 2003/07/24 16:16:06 1.55
@@ -296,13 +296,13 @@
[% WRAPPER section
title="VERSION"
-%]<p>
-2.62, distributed as part of the
-Template Toolkit version 2.09b, released on 24 April 2003.
+2.64, distributed as part of the
+Template Toolkit version 2.10, released on 24 July 2003.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
--%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
+-%]<pre> Copyright (C) 1996-2003 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or