stas 2004/09/14 13:47:23
Modified: src/docs/2.0/api/Apache Const.pod
src/docs/2.0/user/config custom.pod
Log:
- more xrefs
- more style fixes
Revision Changes Path
1.26 +42 -14 modperl-docs/src/docs/2.0/api/Apache/Const.pod
Index: Const.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Const.pod,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -u -r1.25 -r1.26
--- Const.pod 14 Sep 2004 19:29:34 -0000 1.25
+++ Const.pod 14 Sep 2004 20:47:23 -0000 1.26
@@ -89,11 +89,17 @@
The C<:cmd_how> constants group is used in
C<L<@APACHE_MODULE_COMMANDS|docs::2.0::user::config::custom/C_args_how_>>
and
-C<L<$cmds-E<gt>args_how()|docs::2.0::api::Apache::Command/C_args_how_>>
+C<L<$cmds-E<gt>args_how|docs::2.0::api::Apache::Command/C_args_how_>>.
+
+
+
+
+
=head3 C<Apache::FLAG>
-One of I<On> or I<Off>
+One of I<On> or I<Off> (L<full
+description|docs::2.0::user::config::custom/C_Apache__FLAG_>).
=over
@@ -107,7 +113,10 @@
=head3 C<Apache::ITERATE>
-One argument, occuring multiple times
+One argument, occuring multiple times (L<full
+description|docs::2.0::user::config::custom/C_Apache__ITERATE_>).
+
+
=over
@@ -119,10 +128,10 @@
-
=head3 C<Apache::ITERATE2>
-Two arguments, the second occurs multiple times
+Two arguments, the second occurs multiple times (L<full
+description|docs::2.0::user::config::custom/C_Apache__ITERATE2_>).
=over
@@ -136,7 +145,8 @@
=head3 C<Apache::NO_ARGS>
-No arguments at all
+No arguments at all (L<full
+description|docs::2.0::user::config::custom/C__C_Apache__NO_ARGS_>).
=over
@@ -150,7 +160,8 @@
=head3 C<Apache::RAW_ARGS>
-The command will parse the command line itself
+The command will parse the command line itself (L<full
+description|docs::2.0::user::config::custom/C_Apache__RAW_ARGS_>).
=over
@@ -164,7 +175,8 @@
=head3 C<Apache::TAKE1>
-One argument only
+One argument only (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE1_>).
=over
@@ -178,7 +190,8 @@
=head3 C<Apache::TAKE12>
-One or two arguments
+One or two arguments (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE12_>).
=over
@@ -192,7 +205,8 @@
=head3 C<Apache::TAKE123>
-One, two or three arguments
+One, two or three arguments (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE123_>).
=over
@@ -206,7 +220,8 @@
=head3 C<Apache::TAKE13>
-One or three arguments
+One or three arguments (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE13_>).
=over
@@ -220,7 +235,8 @@
=head3 C<Apache::TAKE2>
-Two arguments
+Two arguments (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE2_>).
=over
@@ -234,7 +250,8 @@
=head3 C<Apache::TAKE23>
-Two or three arguments
+Two or three arguments (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE23_>).
=over
@@ -248,13 +265,24 @@
=head3 C<Apache::TAKE3>
-Three arguments
+Three arguments (L<full
+description|docs::2.0::user::config::custom/C_Apache__TAKE3_>).
=over
=item since: 1.99_12
=back
+
+
+
+
+
+
+
+
+
+
1.14 +70 -18 modperl-docs/src/docs/2.0/user/config/custom.pod
Index: custom.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/user/config/custom.pod,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -u -r1.13 -r1.14
--- custom.pod 14 Sep 2004 20:37:04 -0000 1.13
+++ custom.pod 14 Sep 2004 20:47:23 -0000 1.14
@@ -477,21 +477,32 @@
The following values of the I<L<args_how|/C_args_how_>> attribute
define how many arguments and what kind of arguments directives can
accept. These values are constants that can be imported from the
-C<L<Apache::Const|docs::2.0::api::Apache::Const>>
-package. For example:
+C<L<Apache::Const|docs::2.0::api::Apache::Const>> package
+(C<L<:cmd_how constants
+group|docs::2.0::api::Apache::Const/C__cmd_how_>>).
+
+For example:
use Apache::Const -compile => qw(TAKE1 TAKE23);
+
+
+
+
=head3 C<Apache::NO_ARGS>
The directive takes no arguments. The callback will be invoked once
each time the directive is encountered. For example:
sub MyParameter {
- my($self, $parms) = @_;
- $self->{MyParameter}++;
+ my($self, $parms) = @_;
+ $self->{MyParameter}++;
}
+
+
+
+
=head3 C<Apache::TAKE1>
The directive takes a single argument. The callback will be invoked
@@ -499,20 +510,28 @@
passed as the third argument. For example:
sub MyParameter {
- my($self, $parms, $arg) = @_;
- $self->{MyParameter} = $arg;
+ my($self, $parms, $arg) = @_;
+ $self->{MyParameter} = $arg;
}
+
+
+
+
=head3 C<Apache::TAKE2>
The directive takes two arguments. They are passed to the callback as
the third and fourth arguments. For example:
sub MyParameter {
- my($self, $parms, $arg1, $arg2) = @_;
- $self->{MyParameter} = {$arg1 => $arg2};
+ my($self, $parms, $arg1, $arg2) = @_;
+ $self->{MyParameter} = {$arg1 => $arg2};
}
+
+
+
+
=head3 C<Apache::TAKE3>
This is like C<L<Apache::TAKE1|/C_Apache__TAKE1_>> and
@@ -520,10 +539,14 @@
mandatory arguments. For example:
sub MyParameter {
- my($self, $parms, @args) = @_;
- $self->{MyParameter} = [EMAIL PROTECTED];
+ my($self, $parms, @args) = @_;
+ $self->{MyParameter} = [EMAIL PROTECTED];
}
+
+
+
+
=head3 C<Apache::TAKE12>
This directive takes one mandatory argument, and a second optional
@@ -531,22 +554,35 @@
that the user may want to override. For example:
sub MyParameter {
- my($self, $parms, $arg1, $arg2) = @_;
- $self->{MyParameter} = {$arg1 => $arg2||'default'};
+ my($self, $parms, $arg1, $arg2) = @_;
+ $self->{MyParameter} = {$arg1 => $arg2||'default'};
}
+
+
+
+
=head3 C<Apache::TAKE23>
C<L<Apache::TAKE23|/C_Apache__TAKE23_>> is just like
C<L<Apache::TAKE12|/C_Apache__TAKE12_>>, except now there are two
mandatory arguments and an optional third one.
+
+
+
+
=head3 C<Apache::TAKE123>
In the C<Apache::TAKE123> variant, the first argument is mandatory and
the other two are optional. This is useful for providing defaults for
two arguments.
+
+
+
+
+
=head3 C<Apache::ITERATE>
C<Apache::ITERATE> is used when a directive can take an unlimited
@@ -556,11 +592,15 @@
argument passing that Perl provides. For example:
sub MyParameter {
- my($self, $parms, $args) = @_;
- push @{ $self->{MyParameter} }, $arg;
+ my($self, $parms, $args) = @_;
+ push @{ $self->{MyParameter} }, $arg;
}
+
+
+
+
=head3 C<Apache::ITERATE2>
C<Apache::ITERATE2> is used for directives that take a mandatory first
@@ -580,11 +620,14 @@
For example:
sub MyParameter {
- my($self, $parms, $key, $val) = @_;
- push @{ $self->{MyParameter}{$key} }, $val;
+ my($self, $parms, $key, $val) = @_;
+ push @{ $self->{MyParameter}{$key} }, $val;
}
+
+
+
=head3 C<Apache::RAW_ARGS>
An I<L<args_how|/C_args_how_>> of C<Apache::RAW_ARGS> instructs
@@ -599,8 +642,8 @@
string-valued scalar containing the text following the directive.
sub MyParameter {
- my($self, $parms, $val) = @_;
- # process $val
+ my($self, $parms, $val) = @_;
+ # process $val
}
If this mode is used to implement a custom "container" directive, the
@@ -649,6 +692,9 @@
Syntax error on line 54 of httpd.conf:
</MyContainer> outside a <MyContainer> container
+
+
+
=head3 C<Apache::FLAG>
When C<Apache::FLAG> is used, Apache will only allow the argument to
@@ -666,6 +712,12 @@
my($self, $parms, $arg) = @_;
$self->{MyFlag} = $arg; # 1 or 0
}
+
+
+
+
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
