[interchange-docs] xmldocs - docelic modified 16 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Jan 7 23:04:06 UTC 2009
User: docelic
Date: 2009-01-07 23:04:06 GMT
Modified: . TODO
Modified: docbook literals.ent
Modified: glossary attribute table
Modified: refs AcrossLocks ActionMap AddDirective AdminSub
Modified: AdminUser AliasTable AllowGlobal AutoEnd
Modified: AutoModifier AutoVariable
Added: glossary modifier scalar
Log:
* Updates/corrections to A* config directives
Revision Changes Path
1.121 xmldocs/TODO
rev 1.121, prev_rev 1.120
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.120
retrieving revision 1.121
diff -u -r1.120 -r1.121
--- TODO 6 Jan 2009 13:22:45 -0000 1.120
+++ TODO 7 Jan 2009 23:04:06 -0000 1.121
@@ -1,5 +1,7 @@
- adjust title of <question> olinks (see if just id/title= works)
- adjust iccattut to use tarball install paths
+-see how AcrossLocks works... does it open tables directly, or opens all tables so you dont have to put perl tables=
+- see why 'attribute' glossentry isn't found
- manpages, first line of <screen> loses linebreaks
- work on bin/mkreport
1.69 xmldocs/docbook/literals.ent
rev 1.69, prev_rev 1.68
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -r1.68 -r1.69
--- literals.ent 6 Jan 2009 13:22:45 -0000 1.68
+++ literals.ent 7 Jan 2009 23:04:06 -0000 1.69
@@ -129,8 +129,8 @@
<!ENTITY edl "Ed LaFrance">
-<!ENTITY TAB_DELIMITED_NOTICE "You might notice that the fields names and
-values above are not properly aligned. This is an unfortunate nature of
+<!ENTITY TAB_DELIMITED_NOTICE "You might notice that the field names and
+values above are not properly aligned. This is the nature of
&glos-tab-delimited; files.">
<!ENTITY GE "glossary entry">
1.5 xmldocs/glossary/attribute
rev 1.5, prev_rev 1.4
Index: attribute
===================================================================
RCS file: /var/cvs/xmldocs/glossary/attribute,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- attribute 28 Sep 2006 16:34:55 -0000 1.4
+++ attribute 7 Jan 2009 23:04:06 -0000 1.5
@@ -1,4 +1,3 @@
-
Attributes (sometimes also called
<emphasis>modifiers</emphasis>, <emphasis>options</emphasis> or
<emphasis>params</emphasis>)
@@ -382,6 +381,5 @@
</para>
</qandaentry>
-
-
-->
+
1.2 xmldocs/glossary/table
rev 1.2, prev_rev 1.1
Index: table
===================================================================
RCS file: /var/cvs/xmldocs/glossary/table,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- table 5 Jul 2007 19:25:33 -0000 1.1
+++ table 7 Jan 2009 23:04:06 -0000 1.2
@@ -1 +1 @@
-See Interchange synonym, &glos-database;.
+See &glos-database;.
1.1 xmldocs/glossary/modifier
rev 1.1, prev_rev 1.0
Index: modifier
===================================================================
See &glos-attribute;.
1.1 xmldocs/glossary/scalar
<<scalar: empty>>
1.3 xmldocs/refs/AcrossLocks
rev 1.3, prev_rev 1.2
Index: AcrossLocks
===================================================================
RCS file: /var/cvs/xmldocs/refs/AcrossLocks,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AcrossLocks 12 Oct 2006 13:51:35 -0000 1.2
+++ AcrossLocks 7 Jan 2009 23:04:06 -0000 1.3
@@ -14,7 +14,7 @@
__NAME__ description
All configured &glos-database;s are opened every time an &IC; page is
visited and enters processing. Opening a new database connection takes
-time, so &IC; provides fast dummy pointer to each database until that
+time, so &IC; provides fast dummy pointer to each database until the
database is actually used within the page.
</para><para>
Enabling this directive has the effect of disabling fast pointers
1.12 xmldocs/refs/ActionMap
rev 1.12, prev_rev 1.11
Index: ActionMap
===================================================================
RCS file: /var/cvs/xmldocs/refs/ActionMap,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ActionMap 17 Sep 2008 20:27:27 -0000 1.11
+++ ActionMap 7 Jan 2009 23:04:06 -0000 1.12
@@ -32,9 +32,9 @@
The standard <literal>process</literal> ActionMap has a number of
configuration settings which can be controlled through &conf-FormAction;.
</para><para>
-For catalog-level &glos-ActionMap;s, &IC; does not strip the actionmap nam
-from the requested HTTP path; for global ActionMaps it does. See
-<xref linkend='ActionMap_examples'/>.
+In the past, global &glos-ActionMap;s had the action name stripped from the
+HTTP path. Beginning with &IC; 5.5, catalog and global &glos-ActionMap;s are
+consistent in behavior and do not strip action name from the path.
__END__
1.8 xmldocs/refs/AddDirective
rev 1.8, prev_rev 1.7
Index: AddDirective
===================================================================
RCS file: /var/cvs/xmldocs/refs/AddDirective,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AddDirective 15 Feb 2008 18:24:50 -0000 1.7
+++ AddDirective 7 Jan 2009 23:04:06 -0000 1.8
@@ -4,10 +4,8 @@
__NAME__ synopsis
<arg choice='plain'><replaceable>directive_name</replaceable></arg>
- <arg>
- <replaceable>parse_function_name</replaceable>
- <arg><replaceable>default_value</replaceable></arg>
- </arg>
+ <arg><replaceable>parse_function_name</replaceable>
+ <arg><replaceable>default_value</replaceable></arg></arg>
__END__
@@ -22,7 +20,7 @@
<literal>parse_function_name</literal> and
<literal>default_value</literal>.
</para><para>
-If the parser function is not defined (either by omitting it or
+If the parse function is not defined (either by omitting it or
literally specifying <literal>undef</literal>), then no parser
will be called on the value at all,
and the value of the directive will be exactly what users specify in their
@@ -37,11 +35,11 @@
<literal>parse_</literal>. (You do not, however, include
<literal>parse_</literal> in the <literal>parse_function_name</literal>.)
</para><para>
-The <literal>default_value</literal> does not have to be specified.
+The <literal>default_value</literal> is optional.
</para><para>
Directly modifying <filename>Config.pm</filename> (or any other
-files from the &IC; installation) is discouraged for portability and other
-reasons. Therefore, to add your custom parsing function, you should
+files from the &IC; installation) is discouraged for portability
+reasons. Therefore, to add a custom parsing function, you should
modify &gcf; as seen in <xref linkend="AddDirective_examples"/>
(note again that the parser definition
must logically come before &conf-AddDirective;).
1.5 xmldocs/refs/AdminSub
rev 1.5, prev_rev 1.4
Index: AdminSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminSub,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AdminSub 15 Feb 2008 18:24:50 -0000 1.4
+++ AdminSub 7 Jan 2009 23:04:06 -0000 1.5
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify global subroutines that can be used only by catalogs listed under AllowGlobal directive
+restrict specific global subroutines to catalogs listed under AllowGlobal directive
__END__
@@ -15,11 +15,11 @@
__NAME__ description
-Specify global subroutines that may only be used by &glos-catalog;s
-which are listed under the &conf-AllowGlobal; directive.
+Restrict usage of specified global subroutines to &glos-catalog;s
+listed under the &conf-AllowGlobal; directive.
</para><para>
-Otherwise, in the default course of action, global subroutines can be used
-by all catalogs.
+If __FILENAME__ is unspecified, all global subroutines can be used by
+all catalogs.
__END__
__NAME__ example: Defining AdminSub
1.6 xmldocs/refs/AdminUser
rev 1.6, prev_rev 1.5
Index: AdminUser
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminUser,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AdminUser 15 Feb 2008 18:24:50 -0000 1.5
+++ AdminUser 7 Jan 2009 23:04:06 -0000 1.6
@@ -9,11 +9,11 @@
__END__
__NAME__ description
-Username and password pairs for users which are given administrator
+Username and password pairs which are given administrator
privileges to all catalogs.
</para><para>
This functionality is standalone —
-you do not need to have the access &glos-database; since
-usernames and passwords here are specified directly.
+you do not need to have the users present in the &glos-UserDB; or the
+access &glos-database;.
__END__
1.6 xmldocs/refs/AliasTable
rev 1.6, prev_rev 1.5
Index: AliasTable
===================================================================
RCS file: /var/cvs/xmldocs/refs/AliasTable,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AliasTable 16 Mar 2008 21:29:27 -0000 1.5
+++ AliasTable 7 Jan 2009 23:04:06 -0000 1.6
@@ -1,19 +1,19 @@
__NAME__ purpose
-specify database that contains page aliases ("redirect" instructions)
+specify table containing page aliases ("redirect" instructions)
__END__
__NAME__ synopsis
-<arg choice='plain'><replaceable>database_name</replaceable></arg>
+<arg choice='plain'><replaceable>table_name</replaceable></arg>
__END__
__NAME__ description
-The directive specifies Interchange &glos-database; that
-contains page aliases (default database name is
+The directive specifies Interchange &glos-table; that
+contains page aliases (default table name is
<database>alias</database>).
</para><para>
-This way, flypages can be aliased and redirected to different locations
+This way, &glos-flypage;s can be aliased and redirected to different locations
without performing file lookup cycles.
</para><para>
Primary applications include content management and creation of
1.6 xmldocs/refs/AllowGlobal
rev 1.6, prev_rev 1.5
Index: AllowGlobal
===================================================================
RCS file: /var/cvs/xmldocs/refs/AllowGlobal,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AllowGlobal 12 Oct 2006 13:51:35 -0000 1.5
+++ AllowGlobal 7 Jan 2009 23:04:06 -0000 1.6
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify catalogs that may define subroutines and tags which operate with full Interchange server permissions
+specify catalogs allowed to operate with full Interchange server permissions
__END__
@@ -12,9 +12,9 @@
__NAME__ description
-Specify catalogs that can operate with the full permissions of the &IC; server.
+Specify catalogs allowed to operate with the full permissions of the &IC; server.
</para><para>
-Don't use this directive unless the catalog user is completely trusted.
+Don't use this directive unless the catalog is completely trusted.
__END__
__NAME__ example: Defining AllowGlobal
@@ -25,4 +25,5 @@
__NAME__ missing
how does SafeTrap/Untrap play with AllowGlobal?
+what is disabled if catalog isn't listed under allowglobal
__END__
1.5 xmldocs/refs/AutoEnd
rev 1.5, prev_rev 1.4
Index: AutoEnd
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoEnd,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AutoEnd 23 Apr 2008 01:49:36 -0000 1.4
+++ AutoEnd 7 Jan 2009 23:04:06 -0000 1.5
@@ -17,7 +17,7 @@
page access. This step is performed after all page parsing occurs,
just before the whole transaction ends.
</para><para>
-In other respects, it behaves the same as its closely related
+Except for the time of execution, it behaves the same as its closely related
directive &conf-Autoload;.
__END__
1.12 xmldocs/refs/AutoModifier
rev 1.12, prev_rev 1.11
Index: AutoModifier
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoModifier,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- AutoModifier 16 Mar 2008 21:29:27 -0000 1.11
+++ AutoModifier 7 Jan 2009 23:04:06 -0000 1.12
@@ -1,12 +1,11 @@
__NAME__ purpose
-specify products database columns containing values for product attributes
+specify products table columns containing values for product attributes
__END__
__NAME__ missing
improve description based on syntax seen in examples
in the examples, explain mv_sku lookup, not clear now
-incorporate NAME=table:column syntax in synopsis
__END__
@@ -15,17 +14,14 @@
__END__
__NAME__ synopsis
-<arg choice='plain' rep='repeat'>
- <arg choice='opt'><replaceable>table</replaceable>:</arg>
- <replaceable>column</replaceable>
- <arg choice='opt'>:<replaceable>key</replaceable></arg>
+<arg choice='opt'><replaceable>name</replaceable>=</arg><arg choice='plain' rep='repeat'><arg choice='opt'><replaceable>table</replaceable>:</arg><replaceable>column</replaceable><arg choice='opt'>:<replaceable>key</replaceable></arg>
</arg>
__END__
__NAME__ description
The directive specifies names of the product &glos-attribute;s
-which should be automatically loaded from database columns.
+which should be automatically loaded from table columns.
Table, column and key identifiers belonging to a single specification
are separated by a colon (<literal>:</literal>), while multiple specifications
are separated by whitespace.
@@ -39,13 +35,13 @@
&glos-price;, &glos-discount;, &glos-tax; and &glos-shipping;, and
other custom attributes; these attributes will probably
be used in custom &PERL; code that will scan the electronic
-&glos-cart; contents and perform some decisions. For example, by defining
-database columns <database class='field'>heavy</database> and
+&glos-cart; contents and perform decisions. For example, by defining
+columns <database class='field'>heavy</database> and
<database class='field'>downloadable</database>, you will be
able to perform decisions
based on <code>$item->{heavy}</code> and
<code>$item->{downloadable}</code> (but there are more access methods,
-see the &glos-attribute; &GE;.
+see the &glos-attribute; &GE;).
__END__
@@ -75,19 +71,19 @@
<database>products</database> database.
__END__
-__NAME__ example: set attribute 'heavy' from inventory table
+__NAME__ example: set attribute 'heavy' from table 'inventory'
<programlisting>
AutoModifier inventory:heavy
</programlisting>
__END__
-__NAME__ example: set attribute 'weighty' from inventory table, column 'heavy'
+__NAME__ example: set attribute 'weighty' from table 'inventory', column 'heavy'
<programlisting>
AutoModifier weighty=inventory:heavy
</programlisting>
__END__
-__NAME__ example: set attribute 'heavy' from inventory table, with a different SKU
+__NAME__ example: set attribute 'heavy' from table 'inventory', with a different SKU
<programlisting>
AutoModifier inventory:heavy:mv_sku
</programlisting>
1.6 xmldocs/refs/AutoVariable
rev 1.6, prev_rev 1.5
Index: AutoVariable
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoVariable,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AutoVariable 9 Aug 2008 15:09:40 -0000 1.5
+++ AutoVariable 7 Jan 2009 23:04:06 -0000 1.6
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify config directives that are to be made available through the Variable space
+specify config directives to make available through the Variable space
__END__
@@ -24,15 +24,15 @@
number or hash key respectively.
See <xref linkend="AutoVariable_examples"/> for clarification.
</para><para>
-Note that the behavior of &conf-__FILENAME__; is not dynamic — if need
-to re-invoke &conf-__FILENAME__; every time you want to "refresh" the
-value visible through <code>__<replaceable>DirectiveName</replaceable>__</code>.
+Note that the behavior of &conf-__FILENAME__; is not dynamic — you need
+to re-invoke &conf-__FILENAME__; every time you want to update the
+value in <code>__<replaceable>DirectiveName</replaceable>__</code>.
__END__
__NAME__ notes
The directive does not support &glos-hash; keys that contain non-word
-characters or whitespace. Also, only the first-level of array and hash
+characters or whitespace. In addition, only the first-level of array and hash
indices/keys is translated properly.
__END__
More information about the docs
mailing list