/
Constants.html
112 lines (110 loc) · 3.74 KB
/
Constants.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
[%#
# IMPORTANT NOTE
# This documentation is generated automatically from source
# templates. Any changes you make here may be lost.
#
# The 'docsrc' documentation source bundle is available for download
# from http://www.template-toolkit.org/docs.html and contains all
# the source templates, XML files, scripts, etc., from which the
# documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
page = 'Constants'
%]
[% WRAPPER toc;
INCLUDE tocitem title="SYNOPSIS";
INCLUDE tocitem title="DESCRIPTION";
INCLUDE tocitem title="EXPORTABLE TAG SETS";
INCLUDE tocitem title="AUTHOR";
INCLUDE tocitem title="VERSION";
INCLUDE tocitem title="COPYRIGHT";
INCLUDE tocitem title="SEE ALSO";
END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
title="SYNOPSIS"
-%]<pre> use Template::Constants qw( :status :error :all );</pre>
[%- END %]
[% WRAPPER section
title="DESCRIPTION"
-%]<p>
The Template::Constants modules defines, and optionally exports into the
caller's namespace, a number of constants used by the Template package.
</p>
<p>
Constants may be used by specifying the Template::Constants package
explicitly:
</p>
<pre> use Template::Constants;</pre>
<pre> print Template::Constants::STATUS_DECLINED;</pre>
<p>
Constants may be imported into the caller's namespace by naming them as
options to the <code>'use Template::Constants'</code> statement:
</p>
<pre> use Template::Constants qw( STATUS_DECLINED );</pre>
<pre> print STATUS_DECLINED;</pre>
<p>
Alternatively, one of the following tagset identifiers may be specified
to import sets of constants; :status, :error, :all.
</p>
<pre> use Template::Constants qw( :status );</pre>
<pre> print STATUS_DECLINED;</pre>
<p>
See [% ttlink('Exporter') -%] for more information on exporting variables.
</p>
[%- END %]
[% WRAPPER section
title="EXPORTABLE TAG SETS"
-%]<p>
The following tag sets and associated constants are defined:
</p>
<pre> :status
STATUS_OK # no problem, continue
STATUS_RETURN # ended current block then continue (ok)
STATUS_STOP # controlled stop (ok)
STATUS_DONE # iterator is all done (ok)
STATUS_DECLINED # provider declined to service request (ok)
STATUS_ERROR # general error condition (not ok)</pre>
<pre> :error
ERROR_RETURN # return a status code (e.g. 'stop')
ERROR_FILE # file error: I/O, parse, recursion
ERROR_UNDEF # undefined variable value used
ERROR_PERL # error in [% tt_start_tag %] PERL [% tt_end_tag %] block</pre>
<pre> :chomp # for PRE_CHOMP and POST_CHOMP
CHOMP_NONE # do not remove whitespace
CHOMP_ALL # remove whitespace
CHOMP_COLLAPSE # collapse whitespace to a single space</pre>
<pre> :all All the above constants.</pre>
[%- END %]
[% WRAPPER section
title="AUTHOR"
-%]<p>
Andy Wardley <abw@kfs.org>
</p>
<p>
[% ttlink('http://www.andywardley.com/', 'http://www.andywardley.com/') -%]
</p>
[%- END %]
[% WRAPPER section
title="VERSION"
-%]<p>
2.12, distributed as part of the
Template Toolkit version 2.03, released on 15 June 2001.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
-%]<pre> Copyright (C) 1996-2001 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2001 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
title="SEE ALSO"
-%]<p>
[% ttlink('Template', 'Template') -%], [% ttlink('CPAN::Exporter', 'CPAN::Exporter') -%]
</p>
[%- END %]