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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
<%doc>
Template for Params.pod, used in make_params_pod.pl.
</%doc>
#
# This documentation was automatically generated by the
# make_params_pod.pl script in the release
# directory of the CVS repository.
#
# Edit that script instead of this document.
#
=head1 NAME
HTML::Mason::Params - Mason configuration parameters
=head1 DESCRIPTION
This document lists all of the Mason configuration parameters that are
intended to be used by end users.
=head1 PERL AND APACHE NAMES
Each parameter has two names: a Perl version and an Apache version.
The Perl version uses C<lowercase_with_underscores>, while the Apache
version uses C<StudlyCaps> with a C<Mason> prefix. The conversion from
one version to the other is otherwise very predictable. For example,
=over 4
=item *
C<autohandler_name> C<E<lt>--E<gt>> C<MasonAutohandlerName>
=item *
C<comp_root> C<E<lt>--E<gt>> C<MasonCompRoot>
=item *
C<data_cache_defaults> C<E<lt>--E<gt>> C<MasonDataCacheDefaults>
=back
=head2 Where Apache Names Are Used
The Apache parameter names are used in the Apache configuration file
in an L<httpd-based configuration|HTML::Mason::Admin/BASIC
CONFIGURATION VIA httpd.conf DIRECTIVES>.
=head2 Where Perl Names Are Used
The Perl parameter names are used from Perl code, i.e. anywhere other
than the Apache configuration file. For example,
=over 4
=item *
In an L<custom wrapper-based configuraiton|HTML::Mason::Admin/ADVANCED
CONFIGURATION>, you can pass most of these parameters to the
L<ApacheHandler|HTML::Mason::ApacheHandler> constructor.
=item *
In a L<standalone Mason script|HTML::Mason::Admin/Using Mason from a
standalone script>, you can pass most of these parameters to the
L<Interp|HTML::Mason::Interp> constructor.
=item *
When launching a L<subrequest|HTML::Mason::Devel/Subrequests>, you can
pass any of the C<HTML::Mason::Request> parameters to
L<make_subrequest|HTML::Mason::Request/item_make_subrequest>.
=back
=head1 PARAMETERS
% foreach my $param (@params) {
=head2 <% $param->{name} %>
=over 4
=item * Perl name: <% $param->{name} %>
% if ($param->{apache_name}) {
=item * Apache name: Mason<% $param->{apache_name} %>
% }
=item * Type in httpd.conf: <% $param->{type} %>
=item * Default: <% defined($param->{default}) && $param->{default} =~ /\S/ ? $param->{default} : 'None' %>
=item * Belongs to: <& .class_pod_link, $param->{class} &>
=back
<% $param->{pod} %>
% }
<%shared>
my %pods;
</%shared>
<%args>
@params
@pods
</%args>
<%init>
%pods = map { $_ => 1 } @pods;
</%init>
%#-----------
<%def .oneline>
<%init>;
(my $content = $m->content) =~ s/\n/ /g;
$m->out($content);
</%init>
</%def>
%#-----------
<%def .trim>
<%init>;
my $content = $m->content;
for ($content) { s/^\s+//; s/\s+$// }
$m->out($content);
</%init>
</%def>
%#-----------
<%def .class_pod_link><&| .trim &>
% if (exists($pods{"Mason/$class_url.pm"})) {
L<<% $class %>|<% $class %>>
% } else {
C<<% $class %>>
% }
</&>
<%init>;
my ($class) = @_;
(my $class_url = $class) =~ s/^HTML::Mason:://;
$class_url =~ s/::/\//g;
</%init>
</%def>
%#-----------
<%def .class_html_link><&| .trim &>
% if (exists($pods{"Mason/$class_url.pm"})) {
<a href="<% $class_url %>.html"><% $class %></a>
% } else {
<tt><% $class %></tt>
% }
</&>
<%init>;
my ($class) = @_;
(my $class_url = $class) =~ s/^HTML::Mason:://;
$class_url =~ s/::/\//g;
</%init>
</%def>
|
