<%doc> Template for Params.pod, used in make_params_pod.pl. # # 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, while the Apache version uses C with a C prefix. The conversion from one version to the other is otherwise very predictable. For example, =over 4 =item * C C--E> C =item * C C--E> C =item * C C--E> C =back =head2 Where Apache Names Are Used The Apache parameter names are used in the Apache configuration file in an L. =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, you can pass most of these parameters to the L constructor. =item * In a L, you can pass most of these parameters to the L constructor. =item * When launching a L, you can pass any of the C parameters to L. =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; <%args> @params @pods <%init> %pods = map { $_ => 1 } @pods; %#----------- <%def .oneline> <%init>; (my $content = $m->content) =~ s/\n/ /g; $m->out($content); %#----------- <%def .trim> <%init>; my $content = $m->content; for ($content) { s/^\s+//; s/\s+$// } $m->out($content); %#----------- <%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; %#----------- <%def .class_html_link><&| .trim &> % if (exists($pods{"Mason/$class_url.pm"})) { <% $class %> % } else { <% $class %> % } <%init>; my ($class) = @_; (my $class_url = $class) =~ s/^HTML::Mason:://; $class_url =~ s/::/\//g;