[interchange-docs] xmldocs - docelic modified 12 files

docs at icdevgroup.org docs at icdevgroup.org
Mon Jan 12 18:29:45 UTC 2009


User:      docelic
Date:      2009-01-12 18:29:45 GMT
Modified:  docbook  literals.ent
Modified:  refs     PostURL SOAP_Control SOAP_StartServers SafeTrap
Modified:           SafeUntrap SalesTax SecurePostURL SetGroup
Modified:           SocketFile SpecialPage Sub
Log:
* Updates to the S* config directives.

  This was the last remaining part, and it completes this round of work
  on conf directives.

Revision  Changes    Path
1.71                 xmldocs/docbook/literals.ent


rev 1.71, prev_rev 1.70
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -r1.70 -r1.71
--- literals.ent	7 Jan 2009 23:18:57 -0000	1.70
+++ literals.ent	12 Jan 2009 18:29:45 -0000	1.71
@@ -520,8 +520,6 @@
 <!ENTITY conf-GPG_PATH "<literal>GPG_PATH</literal>">
 <!ENTITY filter-strip "<filter>strip</filter>">
 <!ENTITY glos-captcha "<literal>captcha</literal>">
-<!ENTITY glos-form "<literal>form</literal>">
-<!ENTITY glos-safe "<literal>safe</literal>">
 <!ENTITY glos-UserTag "<literal>UserTag</literal>">
 <!ENTITY howto-dump-vend-structure "<literal>dump-vend-structure</literal>">
 <!ENTITY pragma-filter_sql_no_backslash "<literal>filter_sql_no_backslash</literal>">



1.2                  xmldocs/refs/PostURL


rev 1.2, prev_rev 1.1
Index: PostURL
===================================================================
RCS file: /var/cvs/xmldocs/refs/PostURL,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PostURL	23 May 2008 23:51:52 -0000	1.1
+++ PostURL	12 Jan 2009 18:29:45 -0000	1.2
@@ -18,7 +18,7 @@
 </para><para>
 This allows an automatically different path for GET and POST
 requests, presuming you use the &tag-process; tag as 
-&glos-form; action target.
+form action target.
 __END__
 
 



1.2                  xmldocs/refs/SOAP_Control


rev 1.2, prev_rev 1.1
Index: SOAP_Control
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_Control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP_Control	9 May 2008 15:15:52 -0000	1.1
+++ SOAP_Control	12 Jan 2009 18:29:45 -0000	1.2
@@ -6,7 +6,7 @@
 SOAP, SOAP_Action
 __END__
 
-__NAME__ example: Allow actions only.
+__NAME__ example: Allow actions only
 <programlisting>
 SOAP_Control Action always
 SOAP_Control Tag never



1.3                  xmldocs/refs/SOAP_StartServers


rev 1.3, prev_rev 1.2
Index: SOAP_StartServers
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_StartServers,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAP_StartServers	6 Nov 2006 18:41:21 -0000	1.2
+++ SOAP_StartServers	12 Jan 2009 18:29:45 -0000	1.3
@@ -16,7 +16,7 @@
 
 __NAME__ description
 The directive specifies the number of servers which should be started
-and handling &glos-SOAP-RPC; requests.
+to handle &glos-SOAP-RPC; requests.
 </para><para>
 The default is <literal>1</literal>. Setting the directive to more than
 <literal>50</literal> is unreasonable and produces an error.



1.2                  xmldocs/refs/SafeTrap


rev 1.2, prev_rev 1.1
Index: SafeTrap
===================================================================
RCS file: /var/cvs/xmldocs/refs/SafeTrap,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SafeTrap	6 Nov 2006 22:04:40 -0000	1.1
+++ SafeTrap	12 Jan 2009 18:29:45 -0000	1.2
@@ -26,7 +26,7 @@
 to programming under <classname>Safe.pm</classname> restrictions.
 </para><para>
 The &conf-SafeUntrap; directive runs <emphasis role='bold'>after</emphasis> 
-&conf-SafeTrap; (so, it takes priority). Make sure the opcodes you want
+&conf-SafeTrap; and takes precedence. Make sure the opcodes you want
 to trap are not later untrapped with &conf-SafeUntrap;.
 __END__
 



1.7                  xmldocs/refs/SafeUntrap


rev 1.7, prev_rev 1.6
Index: SafeUntrap
===================================================================
RCS file: /var/cvs/xmldocs/refs/SafeUntrap,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SafeUntrap	17 Dec 2007 21:38:25 -0000	1.6
+++ SafeUntrap	12 Jan 2009 18:29:45 -0000	1.7
@@ -52,7 +52,7 @@
 SafeUntrap :filesys_read
 </programlisting>
 
-As said, see the 
+See the 
 <citerefentry><refentrytitle>Opcode</refentrytitle>
 <manvolnum>3perl</manvolnum></citerefentry> manual page for
 more information and the complete list of operation codes and groups.



1.3                  xmldocs/refs/SalesTax


rev 1.3, prev_rev 1.2
Index: SalesTax
===================================================================
RCS file: /var/cvs/xmldocs/refs/SalesTax,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SalesTax	29 Feb 2008 18:13:44 -0000	1.2
+++ SalesTax	12 Jan 2009 18:29:45 -0000	1.3
@@ -3,7 +3,7 @@
 __END__
 
 __NAME__ synopsis
-<arg choice='plain'><replaceable>value</replaceable></arg>
+<group choice='plain'><arg choice='plain'><literal>multi</literal></arg><arg choice='plain'><replaceable>ITL_code</replaceable></arg><arg choice='plain' rep='repeat'><replaceable>name</replaceable></arg></group>
 __END__
 
 __NAME__ description
@@ -18,15 +18,14 @@
 </thead>
 <tbody>
 <row><entry><literal>multi</literal></entry>
-<entry>Enables table-based lookup of tax rates, based upon form input values, by default the values used are country and state.</entry>
+<entry>Enables table-based lookup of tax rates, based upon form input values, by default the values used are <literal>country</literal> and <literal>state</literal>.</entry>
 </row>
-<row><entry>ITL</entry><entry>If the <replaceable>value</replaceable>
+<row><entry>ITL</entry><entry>If the value
 contains a square bracket, it is interpolated as &glos-ITL;. The result is
 used as the amount of the salestax.
 This could be useful if you want to use a custom UserTag for sales tax
 calculations.</entry></row>
-<row><entry><replaceable>name1, name2,
-...</replaceable></entry><entry>A comma-separated list of form values in
+<row><entry><replaceable>name</replaceable>...</entry><entry>A comma-separated list of form values in
 priority order. Enables look up of the tax rate "salestax.asc" file.</entry></row>
 </tbody>
 </tgroup>
@@ -41,4 +40,4 @@
 
 __NAME__ see also
 salestax
-__END__
\ No newline at end of file
+__END__



1.2                  xmldocs/refs/SecurePostURL


rev 1.2, prev_rev 1.1
Index: SecurePostURL
===================================================================
RCS file: /var/cvs/xmldocs/refs/SecurePostURL,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SecurePostURL	23 May 2008 23:51:52 -0000	1.1
+++ SecurePostURL	12 Jan 2009 18:29:45 -0000	1.2
@@ -19,7 +19,7 @@
 </para><para>
 This allows an automatically different path for GET and POST
 requests, presuming you use the &tag-process; tag as 
-&glos-form; action target.
+form <literal>action=</literal> target.
 __END__
 
 



1.3                  xmldocs/refs/SetGroup


rev 1.3, prev_rev 1.2
Index: SetGroup
===================================================================
RCS file: /var/cvs/xmldocs/refs/SetGroup,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SetGroup	6 Nov 2006 18:41:21 -0000	1.2
+++ SetGroup	12 Jan 2009 18:29:45 -0000	1.3
@@ -13,22 +13,14 @@
 run under the same Unix user ID and user group (UID and GID).
 </para><para>
 This directive allows you to switch group at the catalog level.
-However, this approach has its drawbacks. First of all, the &IC; user
-must already be a member of the target group, that is &mdash; have the
-target group in its list of secondary groups. Verify that using the
-<command>id <replaceable>USERNAME</replaceable></command> command.
-Another, related problem is of a more technical nature. Namely, most
-operating systems limit the number of secondary groups per user;
-on Linux, this limit is <literal>32</literal> groups (run 
-<command>grep -r NGROUPS_MAX /usr/include/</command> to verify).
-This means that you cannot develop a generic site scheme based on
-&conf-SetGroup; if you plan to serve more than 30 catalogs, or
-switch between more than 30 groups.
+__END__
+
+__NAME__ notes
+To be able to switch group with &conf-__FILENAME__;, the &IC; user must
+be a member of the target group.
 </para><para>
-One viable solution is to either run separate &IC; daemons (each 
-serving 30 catalogs), or give each catalog user it's own &IC;
-server. The latter is beneficial in terms of tighter access control and
-greater user freedom, and is a generally acceptable approach.
+On Linux, the number of secondary groups per user is 32, which means
+you can serve a maximum of 31 catalogs using &conf-SetGroup;.
 __END__
 
 __NAME__ example: Defining SetGroup



1.7                  xmldocs/refs/SocketFile


rev 1.7, prev_rev 1.6
Index: SocketFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketFile,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SocketFile	15 Feb 2008 18:24:50 -0000	1.6
+++ SocketFile	12 Jan 2009 18:29:45 -0000	1.7
@@ -14,7 +14,7 @@
 
 __NAME__ description
 The directive specifies the filename which &IC; should create to enable
-Unix-domain socket communication. The filename must, of course, be writable
+Unix-domain socket communication. The filename must be writable
 by the Interchange daemon.
 __END__
 



1.7                  xmldocs/refs/SpecialPage


rev 1.7, prev_rev 1.6
Index: SpecialPage
===================================================================
RCS file: /var/cvs/xmldocs/refs/SpecialPage,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SpecialPage	28 Aug 2008 12:15:10 -0000	1.6
+++ SpecialPage	12 Jan 2009 18:29:45 -0000	1.7
@@ -35,7 +35,7 @@
 	<listitem><para>
 	<literal>failed</literal> &mdash; 
 
-	standard handler for failed orders.
+	Standard handler for failed orders.
 	</para></listitem>
 	<listitem><para>
 	<literal>flypage</literal> &mdash; 
@@ -65,7 +65,7 @@
 	<listitem><para>
 	<literal>put_handler</literal> &mdash; 
 
-	standard handler for <literal>PUT</literal> operations.
+	Standard handler for <literal>PUT</literal> operations.
 	</para></listitem>
 	<listitem><para>
 	<literal>receipt</literal> &mdash; 
@@ -100,7 +100,7 @@
 </itemizedlist>
 __END__
 
-__NAME__ example: Setting SpecialPages
+__NAME__ example: Setting __FILENAME__
 <programlisting>
 SpecialPage  catalog        index
 SpecialPage  violation      special/violation
@@ -119,6 +119,16 @@
 </programlisting>
 __END__
 
+__NAME__ example: Setting __FILENAME__
+<programlisting>
+SpecialPage catalog   index
+SpecialPage target    index
+SpecialPage missing   not_found
+SpecialPage violation not_found
+SpecialPage order     cart
+</programlisting>
+__END__
+
 __NAME__ see also
 SpecialPageDir, DirectoryIndex
 __END__



1.4                  xmldocs/refs/Sub


rev 1.4, prev_rev 1.3
Index: Sub
===================================================================
RCS file: /var/cvs/xmldocs/refs/Sub,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Sub	6 Nov 2006 18:41:21 -0000	1.3
+++ Sub	12 Jan 2009 18:29:45 -0000	1.4
@@ -58,7 +58,7 @@
 __NAME__ notes
 As with &PERL; "here documents," the "<literal>EOF</literal>" (or arbitrarily
 named end marker) must be the <emphasis>only</emphasis> thing on the line,
-without leading or trailing white space. Do not even append a semicolon to the
+without leading or trailing white space. Do not append a semicolon to the
 marker (as you would in &PERL;).
 </para><para>
 Catalog subroutines may not perform unsafe operations. The







More information about the docs mailing list