[docs] docs - jon modified icconfig.sdf

[docs@interchange.redhat.com]

User:      jon
Date:      2002-07-01 14:15:19 GMT
Modified:  .        icconfig.sdf
Log:
Change capitalization on AutoEnd to match Config.pm.
Minor other twiddling.

Revision  Changes    Path
1.64      +20 -12    docs/icconfig.sdf


rev 1.64, prev_rev 1.63
Index: icconfig.sdf
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /var/cvs/docs/icconfig.sdf,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -u -r1.63 -r1.64
--- icconfig.sdf	6 Jun 2002 02:01:51 -0000	1.63
+++ icconfig.sdf	1 Jul 2002 14:15:19 -0000	1.64
@@ -1,10 +1,10 @@
 !init OPT_LOOK=3D"akopia"; OPT_STYLE=3D"manual"
-# $Id: icconfig.sdf,v 1.63 2002/06/06 02:01:51 jon Exp $
+# $Id: icconfig.sdf,v 1.64 2002/07/01 14:15:19 jon Exp $
=20
 !define DOC_NAME "Configuration Reference"
 !define DOC_TYPE ""
 !define DOC_CODE "icconfig"
-!define DOC_VERSION substr('$Revision: 1.63 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.64 $',11, -2)
 !define DOC_STATUS "Draft"
 !define DOC_PROJECT "Interchange"
 !define DOC_URL "http://interchange.redhat.com/doc/icconfig.html"
@@ -1083,34 +1083,41 @@
=20
 If a C<Route> is set up to C<supplant>, this is ignored.
=20
-H2: Autoend
+H2: AutoEnd
+
+Sets an action that is automatically performed at the end of every
+access. It is performed after any page parsing occurs, just before
+the transaction ends. It takes the same kinds of parameters as
+C<Autoload>.
=20
-Sets an action that is automatically performed at the end every access. It=
 is performed after any page parsing occurs, just before the transaction en=
ds. See C<Autoload>.
=20
 H2: Autoload
=20
 Sets an action that is automatically performed for every access. It is
 performed before any page parsing occurs, and before the action or page
-is even determined. Can contain ITL tags or a global subroutine name. If
-the return value is true, a normal display of $CGI->{mv_nextpage} will
-occur -- if it returns a false (zero, undef, or blank) value, no page will
-be processed.
+is even determined. It can be set to a string containing ITL tags or to
+the name of a catalog (Sub) or global subroutine. The return value from
+the code run is discarded.
+
+For example, to automatically run the Sub or GlobalSub named 'testsub':
=20
-As an example, to remap any C<mv_nextpage> accesses to the C<private>
-subdirectory of pages, set:
+E:   Autoload testsub
+
+To remap any C<mv_nextpage> accesses to the C<private> subdirectory of
+pages, set:
=20
 !block example
    Autoload   [perl] $CGI->{mv_nextpage} =3D~ s:^private/:public/:; [/perl]
 !endblock
=20
 You can temporarily change any of the catalog configuration settings,
-for example use a different flypage.
+for example, to use a different flypage depending on the user's browser ty=
pe:
=20
 !block example
    Autoload       <<EOA
    [perl]=20
    if ($Session->{browser} =3D~ /msie/i) {
-      $Config->{Special}->{flypage}=3D'ms_flypage'};
+      $Config->{Special}->{flypage} =3D 'ie_flypage';
    }
    [/perl]
    EOA
@@ -1120,6 +1127,7 @@
 the catalog configuration, not C<Special>. This is an exceptional case.
 Usually the hash key has the same name as the catalog configuration
 directive.
+
=20
 H2: AutoModifier
=20