[docs] xmldocs - docelic modified 17 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Feb 19 19:59:51 EST 2005
User: docelic
Date: 2005-02-20 00:59:51 GMT
Modified: . TODO
Modified: bin findtagopts
Modified: refs Catalog ErrorDestination SendMailProgram
Modified: SocketPerms
Added: refs Inet_Mode PreFork RobotHost RobotIP RobotUA
Added: SafeUntrap StartServers TagDir TagGroup TagInclude
Added: Unix_Mode
Log:
Wow hey.
New items, some fixes, decent stuff
Revision Changes Path
1.65 +1 -7 xmldocs/TODO
rev 1.65, prev_rev 1.64
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -r1.64 -r1.65
--- TODO 16 Feb 2005 17:59:33 -0000 1.64
+++ TODO 20 Feb 2005 00:59:49 -0000 1.65
@@ -1,10 +1,4 @@
-- Skripta ce pratiti koji $opt->{} se koristi u tagu, i skrenuti pozornost
- na one koji ne koriste ime $opt->{}, a trebali bi. Onda item mora imati
- u refs/ listu opcija i opisa, a skripta sama nadje jesu li obavezni,
- pozicioni, i warnira ako se u sourceu koriste neki koji nisu
- zavedeni u listu. I autogenerira cijeli onaj crapload XMLa.
-
-
+On config directives, include parse_<> function in source context
- See that if 'crypt' is put in see also, all symbols of that name appear
in see also line and their type is distinguished visually.
- Add ROW_REPARSE along ROW_INTERPOLATE in tag refs
1.2 +4 -2 xmldocs/bin/findtagopts
rev 1.2, prev_rev 1.1
Index: findtagopts
===================================================================
RCS file: /var/cvs/xmldocs/bin/findtagopts,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- findtagopts 17 Feb 2005 23:11:31 -0000 1.1
+++ findtagopts 20 Feb 2005 00:59:50 -0000 1.2
@@ -2,8 +2,10 @@
# docelic at icdevgroup.org
-# The script parses cache files made by bin/stattree, and generates
-# the refs/*.xml files.
+# The script opens the cvs-head cache file (generated by bin/stattree),
+# and for a given tag retrieves its source contexts, then tries to find
+# $opt->{...} and similar strings to generate the "synopsis" section
+# for a tag.
use warnings;
use strict;
1.2 +1 -1 xmldocs/refs/Catalog
rev 1.2, prev_rev 1.1
Index: Catalog
===================================================================
RCS file: /var/cvs/xmldocs/refs/Catalog,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Catalog 19 Feb 2005 17:14:03 -0000 1.1
+++ Catalog 20 Feb 2005 00:59:50 -0000 1.2
@@ -48,7 +48,7 @@
__END__
__NAME__ notes
-&conf-Catalog; is one of the basic &IC; &glos-configuration; directives.
+&conf-Catalog; is one of the basic Interchange &glos-configuration; directives.
</para><para>
<command>makecat</command>, the catalog creation helper script, automatically inserts
the &conf-Catalog; line in the &gcf; file as part of the standard procedure.
1.2 +1 -1 xmldocs/refs/ErrorDestination
rev 1.2, prev_rev 1.1
Index: ErrorDestination
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorDestination,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ErrorDestination 2 Feb 2005 11:35:58 -0000 1.1
+++ ErrorDestination 20 Feb 2005 00:59:50 -0000 1.2
@@ -5,7 +5,7 @@
__NAME__ synopsis
<group choice='req'>
- <arg choice='plain'>tag or message</arg>
+ <arg choice='plain'>tag_or_message</arg>
<arg choice='plain'>filename</arg>
</group>
__END__
1.2 +2 -1 xmldocs/refs/SendMailProgram
rev 1.2, prev_rev 1.1
Index: SendMailProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/SendMailProgram,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SendMailProgram 15 Dec 2004 00:19:40 -0000 1.1
+++ SendMailProgram 20 Feb 2005 00:59:50 -0000 1.2
@@ -25,7 +25,8 @@
</para><para>
If this directive is not defined (and none of the defaults are available at
startup), it won't be possible to send any e-mails using standard &IC;
-facilities.
+facilities. In that case, you'll have to pick orders from a tracking
+file, logs, or some other means.
__END__
__NAME__ example: Setting SendMailProgram
1.4 +3 -1 xmldocs/refs/SocketPerms
rev 1.4, prev_rev 1.3
Index: SocketPerms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketPerms,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SocketPerms 13 Dec 2004 00:04:41 -0000 1.3
+++ SocketPerms 20 Feb 2005 00:59:50 -0000 1.4
@@ -17,7 +17,9 @@
__NAME__ description
Specify permissions (&glos-mode;) for the Interchange UNIX-domain socket.
</para><para>
-Prepend a starting <literal>0</literal> to indicate an octal value.
+Prepend a starting <literal>0</literal> to indicate an octal value. The
+directive can be overriden from the command line using <literal>interchange
+-r SocketPerms=<replaceable>value</replaceable></literal>.
__END__
__NAME__ notes
1.1 xmldocs/refs/Inet_Mode
rev 1.1, prev_rev 1.0
Index: Inet_Mode
===================================================================
__NAME__ purpose
specify whether Interchange server should open an Inet socket and listen on a port
__END__
__NAME__ see also
Unix_Mode
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
Specify whether the &IC; server should open an INET-domain socket and
listen on some port.
</para><para>
This &glos-configuration; directive can be overriden using
<literal>interchange -i</literal> switch on the command line.
</para><para>
__END__
__NAME__ notes
You will need &IC; Inet mode in only rare circumstances (that is, only if your
Web and &IC; server are not the same machine).
__END__
__NAME__ example: Enabling Inet_Mode
<programlisting>
Inet_Mode Yes
</programlisting>
__END__
1.1 xmldocs/refs/PreFork
rev 1.1, prev_rev 1.0
Index: PreFork
===================================================================
__NAME__ purpose
specify whether Interchange server should pre-fork processes that wait for client connections
__END__
__NAME__ see also
StartServers
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
For each new client connection, &IC; must spawn a new process that will
handle communication with the client.
By using &conf-PreFork; it is possible to <emphasis>pre-fork</emphasis>
(or in other words, "start ahead of time") some number of &IC; servers
that will be ready to serve client requests immediately as they come in.
</para><para>
This method reduces system overhead due to forking and is the fastest and
best way to run a busy &IC; server.
__END__
__NAME__ notes
Regardless of the &conf-PreFork; setting, each spawned server will serve
&conf-MaxRequestsPerChild; requests, before being shut down and respawned.
(This technique is used to prevent any memory leaks).
</para><para>
For an introduction to &IC; run modes and practical implications, please
see the &glos-ic-run-mode; glossary entry.
__END__
__NAME__ example: Enabling PreFork
<programlisting>
PreFork yes
</programlisting>
__END__
1.1 xmldocs/refs/RobotHost
rev 1.1, prev_rev 1.0
Index: RobotHost
===================================================================
__NAME__ purpose
specify hostnames that will be classified as crawler bots (search engines) visiting the site
__END__
__NAME__ see also
RobotUA, RobotIP
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
</group>
__END__
__NAME__ description
The &conf-RobotHost; directive defines a list of hostnames which will be
classified as crawler robots (search engines), and cause &IC; to alter its
behavior to improve the chance of &IC;-served content being crawled
and indexed.
</para><para>
Note that this directive (and all other work done to identify robots)
only serves to improve the way in which &IC; pages are indexed, and to
reduce server overhead for clients that don't require our full attention
in the way humans do (for example, session information is not kept around
for spider bots).
Using this to "tune" the actual page content depending on a crawler
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
It's important to note that the directive accepts a wildcard list -
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
__NAME__ notes
For more details regarding web spiders/bots and &IC; see
&glos-robot; glossary entry.
__END__
__NAME__ example: Defining RobotHost
<programlisting><![CDATA[
RobotHost <<EOR
*.crawler*.com, *.excite.com, *.googlebot.com,
*.infoseek.com, *.inktomi.com, *.inktomisearch.com,
*.lycos.com, *.pa-x.dec.com, add-url.altavista.com,
westinghouse-rsl-com-usa.NorthRoyalton.cw.net,
EOR
]]></programlisting>
__END__
1.1 xmldocs/refs/RobotIP
rev 1.1, prev_rev 1.0
Index: RobotIP
===================================================================
__NAME__ purpose
specify IP numbers or ranges that will be classified as crawler bots (search engines) visiting the site
__END__
__NAME__ see also
RobotUA, RobotIP, RobotHost
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>IP address</replaceable></arg>
</group>
__END__
__NAME__ description
The &conf-RobotIP; directive defines a list of IP numbers which will be
classified as crawler robots (search engines), and cause &IC; to alter its
behavior to improve the chance of &IC;-served content being crawled
and indexed.
</para><para>
Note that this directive (and all other work done to identify robots)
only serves to improve the way in which &IC; pages are indexed, and to
reduce server overhead for clients that don't require our full attention
in the way humans do (for example, session information is not kept around
for spider bots).
Using this to "tune" the actual page content depending on a crawler
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
It's important to note that the directive accepts a wildcard list -
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
__NAME__ notes
For more details regarding web spiders/bots and &IC; see
&glos-robot; glossary entry.
__END__
__NAME__ example: Defining RobotIP
<programlisting><![CDATA[
RobotIP <<EOR
202.9.155.123, 204.152.191.41, 208.146.26.19,
208.146.26.233, 209.185.141.209, 209.185.141.211,
209.202.148.36, 209.202.148.41, 216.200.130.207,
216.35.103.6?, 216.35.103.70,
EOR
]]></programlisting>
__END__
1.1 xmldocs/refs/RobotUA
rev 1.1, prev_rev 1.0
Index: RobotUA
===================================================================
__NAME__ purpose
specify user-agents that will be classified as crawler bots (search engines) visiting the site
__END__
__NAME__ see also
RobotUA, RobotIP
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>useragent string</replaceable></arg>
</group>
__END__
__NAME__ description
The &conf-RobotUA; directive defines a list of useragent strings which will be
classified as crawler robots (search engines), and cause &IC; to alter its
behavior to improve the chance of &IC;-served content being crawled
and indexed.
</para><para>
Note that this directive (and all other work done to identify robots)
only serves to improve the way in which &IC; pages are indexed, and to
reduce server overhead for clients that don't require our full attention
in the way humans do (for example, session information is not kept around
for spider bots).
Using this to "tune" the actual page content depending on a crawler
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
It's important to note that the directive accepts a wildcard list -
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
__NAME__ notes
For more details regarding web spiders/bots and &IC; see
&glos-robot; glossary entry.
__END__
__NAME__ example: Defining RobotUA
<programlisting><![CDATA[
RobotUA <<EOR
ATN_Worldwide, AltaVista, Arachnoidea, Aranha, Architext, Ask, Atomz,
BackRub, Builder, CMC, Contact, Digital*Integrity, Directory, EZResult,
Excite, Ferret, Fireball, Google, Gromit, Gulliver, Harvest, Hubater,
H?m?h?kki, INGRID, IncyWincy, Jack, KIT*Fireball, Kototoi, LWP, Lycos,
MegaSheep, Mercator, Nazilla, NetMechanic, NetResearchServer, NetScoop,
ParaSite, Refiner, RoboDude, Rover, Rutgers, Scooter, Slurp, Spyder,
T-H-U-N-D-E-R-S-T-O-N-E, Toutatis, Tv*Merc, Valkyrie, Voyager, WIRE,
Walker, Wget, WhizBang, Wire, Wombat, Yahoo, Yandex, ZyBorg, appie,
asterias, bot, contact, crawl, collector, fido, find, gazz, grabber,
griffon, archiver, legs, marvin, mirago, moget, newscan, seek, speedy,
spider, suke, tarantula, agent, topiclink, whowhere, winona, worm, xtreme,
EOR
]]></programlisting>
__END__
1.1 xmldocs/refs/SafeUntrap
rev 1.1, prev_rev 1.0
Index: SafeUntrap
===================================================================
__NAME__ purpose
specify operation codes to untrap in Safe.pm compartments
__END__
__NAME__ see also
Require,Suggest
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'>opcode</arg>
</group>
__END__
__NAME__ description
The directive defines the opcodes that will be untrapped in the
<classname>Safe</classname> compartments, for use in
embedded &PERL; and conditional operations.
Define it as blank to prevent any operators but the default restrictive ones.
__END__
__NAME__ notes
Please see the &glos-safe; glossary entry for the introduction and guidelines
to programming under <classname>Safe.pm</classname> restrictions.
__END__
__NAME__ example: Disabling all but most restrictive opcodes
<programlisting>
SafeUntrap
</programlisting>
__END__
TODO: enabling all
1.1 xmldocs/refs/StartServers
rev 1.1, prev_rev 1.0
Index: StartServers
===================================================================
__NAME__ purpose
specify the number of Interchange servers to prefork when running in PreFork mode
__END__
__NAME__ see also
PreFork
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>count</arg>
</group>
__END__
__NAME__ description
The directive specifies the number of &IC; servers that should be
preforked when &IC; is run in &conf-PreFork; mode.
__END__
__NAME__ notes
For an introduction to &IC; run modes and practical implications, please
see the &glos-ic-run-mode; glossary entry.
__END__
__NAME__ example: Defining StartServers
<programlisting>
StartServers 10
</programlisting>
__END__
1.1 xmldocs/refs/TagDir
rev 1.1, prev_rev 1.0
Index: TagDir
===================================================================
__NAME__ purpose
directory containing code declaration blocks
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'>directory</arg>
</group>
__END__
__NAME__ description
Specify directories containing tag, filter, widget, actionmap and other
code declarations.
__END__
__NAME__ notes
The specified location is treated relative to the &glos-ICROOT;.
__END__
__NAME__ example: Setting TagDir
<programlisting>
TagDir code etc/other_code
</programlisting>
__END__
1.1 xmldocs/refs/TagGroup
rev 1.1, prev_rev 1.0
Index: TagGroup
===================================================================
__NAME__ purpose
group Interchange code declarations in groups, for later convenient inclusion or exclusion from the setup
__END__
__NAME__ synopsis
<arg choice='plain'><literal>:</literal>group</arg>
<arg choice='plain' rep='repeat'>code_declaration_names</arg>
__END__
__NAME__ description
The directive groups symbols (usually depending on their type) under
group names. This allows for very convenient inclusion or exclusion
of whole tag groups from the &IC; server.
__END__
__NAME__ example: Defining TagGroup
<programlisting>
TagGroup :file "counter file include log value_extended"
</programlisting>
__END__
1.1 xmldocs/refs/TagInclude
rev 1.1, prev_rev 1.0
Index: TagInclude
===================================================================
__NAME__ purpose
include (a group of) tags in Interchange
__END__
__NAME__ see also
TagGroup, TagExclude
__END__
__NAME__ synopsis
<arg choice='opt'><literal>!</literal></arg>
<group choice='opt' rep='repeat'>
<arg choice='plain'><literal>:</literal>group</arg>
<arg choice='plain'>tag</arg>
</group>
__END__
__NAME__ description
Include a set of tags for compilation and use under the &IC; server.
&conf-TagDir;s are scanned for files, then they're assigned to groups
according to &conf-TagGroup; directives, and finally they're included
using &conf-TagInclude;.
</para><para>
The syntax supports the use of <literal>!</literal> to exclude items,
and keyword <literal>ALL</literal>. Tag group names should be prefixed
with <literal>:</literal>. See <xref linkend="TagInclude_examples"/>.
__END__
__NAME__ example: Defining TagInclude
The following would include all tags, except those in group
<literal>crufty</literal> and tag &tag-get-url; specifically.
<programlisting>
TagInclude ALL !:crufty !get_url
</programlisting>
__END__
1.1 xmldocs/refs/Unix_Mode
rev 1.1, prev_rev 1.0
Index: Unix_Mode
===================================================================
__NAME__ purpose
specify whether Interchange server should open an UNIX socket
__END__
__NAME__ see also
Unix_Mode,Inet_Mode
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>Yes</arg>
<arg choice='plain'>No</arg>
</group>
__END__
__NAME__ description
Specify whether the &IC; server should listen on an UNIX-domain socket.
</para><para>
This &glos-configuration; directive can be overriden using
<literal>interchange -u</literal> switch on the command line.
</para><para>
__END__
__NAME__ notes
In most cases, you will want &IC; running in UNIX mode, so it is
enabled by default.
__END__
__NAME__ example: Disabling Inet_Mode
<programlisting>
Unix_Mode No
</programlisting>
__END__
More information about the docs
mailing list