[docs] docs - heins modified icconfig.sdf

[docs@icdevgroup.org]

User:      heins
Date:      2002-09-09 18:49:27 GMT
Modified:  .        icconfig.sdf
Log:
* Add Jonathan's documentation for RobotIP and RobotUA.

Revision  Changes    Path
1.72      +68 -4     docs/icconfig.sdf


rev 1.72, prev_rev 1.71
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: /anon_cvs/repository/docs/icconfig.sdf,v
retrieving revision 1.71
retrieving revision 1.72
diff -u -r1.71 -r1.72
--- icconfig.sdf	1 Sep 2002 17:05:27 -0000	1.71
+++ icconfig.sdf	9 Sep 2002 18:49:26 -0000	1.72
@@ -1,10 +1,10 @@
 !init OPT_LOOK=3D"akopia"; OPT_STYLE=3D"manual"
-# $Id: icconfig.sdf,v 1.71 2002/09/01 17:05:27 mheins Exp $
+# $Id: icconfig.sdf,v 1.72 2002/09/09 18:49:26 mheins Exp $
=20
 !define DOC_NAME "Configuration Reference"
 !define DOC_TYPE ""
 !define DOC_CODE "icconfig"
-!define DOC_VERSION substr('$Revision: 1.71 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.72 $',11, -2)
 !define DOC_STATUS "Draft"
 !define DOC_PROJECT "Interchange"
 !define DOC_URL "http://interchange.redhat.com/doc/icconfig.html"
@@ -684,9 +684,73 @@
    Profiles     etc/profiles.common
 !endblock
=20
+H2: RobotIP *global*
+
+The RobotIP directive defines a list of IP numbers which will be classed as
+crawler robots (search engines) and causes Interchange to alter its
+behavior to improve the chance of Interchange-served content being crawled
+and listed.
+
+The directive accepts a wildcard list - * represents any number of
+characters, ? represents a single character. The elements of the list are
+separated by a comma.
+
+See {{CMD[jump=3D"icconfig.html#RobotUA *global*"]RobotUA}} for a full des=
cription of the behavioural changes.
+
+\Example:
+
+!block example
+  RobotIP   209.135.65, 64.172.5
+!endblock
+
+H2: RobotUA *global*
+
+The RobotUA directive defines a list of User Agents which will be classed =
as
+crawler robots (search engines) and causes Interchange to alter its
+behavior to improve the chance of Interchange-served content being crawled
+and listed.
+
+The directive accepts a wildcard list - * represents any number of
+characters, ? represents a single character. The elements of the list are
+separated by a comma.
+
+If a User Agent is recognised as a robot, the following will be performed =
by Interchange:
+
+=3Dover 4
+
+* C<mv_tmp_session> scratch variable is set to 1, causing sessions to be
+disabled and therefore avoiding the writing of session data to disk.
+
+* C<mv_no_session_id> scratch variable is set to 1, causing Interchange to
+generate URLs without a session id (eg. C<mv_session_id=3DKvWna2PT>).
+
+* C<mv_no_count> scratch variable is set to 1, causing Interchange to
+generate URLs without an incremental number, normally used to prevent
+proxy caching (eg. C<mv_pc=3D4>).
+
+=3Dback
+
+It should be noted that once you have identified you are serving a page to=
 a
+robot, you should not use this to massively alter your page content in an
+attempt to improve your ranking. If you do this, you stand the chance of
+being blacklisted. You have been warned!
+
+\Example:
+
+!block example
+  RobotUA   Inktomi, Scooter, *Robot*, *robot*, *Spider*, *spider*
+!endblock
+
+See also {{CMD[jump=3D"icconfig.html#RobotIP *global*"]RobotIP}}.
+
 H2: SafeUntrap *global*
=20
-Sets the codes that will be untrapped in the C<Safe.pm> module and used fo=
r embedded Perl and conditional operations. View the Safe.pm documentation =
by typing C<perldoc Safe> at the command prompt. The default is C<ftfile so=
rt>, which untraps the file existence test operator and the sort operator. =
Define it as blank to prevent any operators but the default restrictive one=
s.
+Sets the codes that will be untrapped in the C<Safe.pm> module and used
+for embedded Perl and conditional operations. View the Safe.pm
+documentation by typing C<perldoc Safe> at the command prompt. The
+default is C<ftfile sort>, which untraps the file existence test
+operator and the sort operator. Define it as blank to prevent any
+operators but the default restrictive ones.
=20
 !block example
    SafeUntrap     ftfile sort ftewrite rand
@@ -1534,7 +1598,7 @@
=20
 With dynamic variables, all @_VARIABLE_@ and __VARIABLE__ settings are che=
cked
 first to see if the source file is defined. If there is a key
-present, even if its contents are blank, it is returned. Example: in
+present, even if its contents are blank, it is returned. Example -- in
 the case of this catalog.cfg entry:
=20
 !block example