[interchange-docs] xmldocs - docelic modified 43 files

docs at icdevgroup.org docs at icdevgroup.org
Fri Feb 15 13:24:51 EST 2008


User:      docelic
Date:      2008-02-15 18:24:51 GMT
Modified:  .        TODO
Modified:  glossary ActionMap tax
Modified:  guides   programming-style.xml
Modified:  refs     ActionMap AddDirective AdminSub AdminUser
Modified:           AlwaysSecure ConfigAllAfter ConfigAllBefore
Modified:           CreditCardAuto DatabaseAuto DirectoryIndex
Modified:           DomainTail Environment ErrorFile HTMLsuffix
Modified:           HouseKeeping IPCsocket IpHead Limit PGP
Modified:           ParseVariables Password ProductDir ProductFiles
Modified:           Replace SOAP_Perms SOAP_Socket SeparateItems
Modified:           SocketFile SocketPerms TemplateDir TrackFile XHTML
Modified:           perl_warnings_in_page query.tag
Modified:  refs/area missing
Added:     docbook  xmldocs_search.xml
Added:     refs     DataDir DefaultTables TrackDateFormat
Log:
* Collection of mostly style fixes for config directive 'purpose' lines
* Documented in programming style: return;s (Mike) and local filehandles (Jon)
* Some examples added for [query]
* 3 directives description added

Revision  Changes    Path
1.114     +1 -0      xmldocs/TODO


rev 1.114, prev_rev 1.113
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.113
retrieving revision 1.114
diff -u -r1.113 -r1.114
--- TODO	14 Nov 2007 22:42:39 -0000	1.113
+++ TODO	15 Feb 2008 18:24:49 -0000	1.114
@@ -1,4 +1,5 @@
 Bugs:
+-document <ParseVaribles Yes>
 - work on bin/mkreport
 - search doc se nevidi jer je search neki actionmap
 - provide static files for download, describe keys like alt+n



1.1                  xmldocs/docbook/xmldocs_search.xml


rev 1.1, prev_rev 1.0
Index: xmldocs_search.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
 xmlns:moz="http://www.mozilla.org/2006/browser/search/">

	<ShortName>icdevgroup.org search</ShortName>

	<Description>
	Search the Interchange documentation at www.icdevgroup.org
	</Description>

	<Url type="text/html" method="POST"
	 template="http://www.icdevgroup.org/i/dev/Swish">
		<Param name="search_mailinglists" value="1"/>
		<Param name="mv_searchspec" value="{searchTerms}"/>
	</Url>

	<Image width="16" height="16">http://www.icdevgroup.org/favicon.ico</Image>

	<InputEncoding>UTF-8</InputEncoding>

</OpenSearchDescription>



1.8       +5 -18     xmldocs/glossary/ActionMap


rev 1.8, prev_rev 1.7
Index: ActionMap
===================================================================
RCS file: /var/cvs/xmldocs/glossary/ActionMap,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ActionMap	11 Jul 2007 16:43:40 -0000	1.7
+++ ActionMap	15 Feb 2008 18:24:50 -0000	1.8
@@ -1,6 +1,6 @@
 &IC; allows you to create "virtual catalog pages" by associating 
-code (such as &PERL; subroutines) with parts of an URL. This can be
-used for anything from implementing one-click searches and orders
+code (such as &PERL; subroutines or &glos-ITL; tags) with parts of an URL.
+This can be used for anything from implementing one-click searches and orders
 to displaying on-the-fly data.
 </para><para>
 On every &glos-catalog; access, the leading part of a requested page path
@@ -16,12 +16,9 @@
 <listitem><para>
 <literal>process</literal> - Generic form processing function.
 
-<!-- 
-Besides using Perl, Interchange tags may be used in an action, though they are not nearly as efficient.
-^^- only process or all actions?
-
-pointers to all variables it honors.
--->
+</para></listitem>
+<listitem><para>
+<literal>process</literal>  -  Generic &glos-HTML; form processor for user data
 </para></listitem>
 <listitem><para>
 <literal>order</literal>  -  Order items
@@ -36,16 +33,6 @@
 
 
 <!--
-TODO format
-Interchange form processing is based on an C<action> and a C<todo>. The 
-predefined actions at the first level are:
-
-    process       process a todo
-    search        form-based search
-    scan          path-based search
-    order         order an item
-    minimate      get access to a database via MiniMate
-
 You can define any action you desire with C<ActionMap>.
 
 The C<process> action has a second C<todo> level called with C<mv_todo>



1.7       +8 -0      xmldocs/glossary/tax


rev 1.7, prev_rev 1.6
Index: tax
===================================================================
RCS file: /var/cvs/xmldocs/glossary/tax,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- tax	28 Sep 2006 16:34:55 -0000	1.6
+++ tax	15 Feb 2008 18:24:50 -0000	1.7
@@ -257,4 +257,12 @@
 <!-- TODO where does "Levy" come from? -->
 </section>
 
+<section>
+	<title>Conclusion</title>
+<para>
+To prevent tax calculation routines from ever applying a negative
+tax amount, see pragma &pragma-no-negative-tax;.
+</para>
+</section>
+
 <para>



1.14      +16 -1     xmldocs/guides/programming-style.xml


rev 1.14, prev_rev 1.13
Index: programming-style.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/programming-style.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- programming-style.xml	20 Aug 2007 23:19:36 -0000	1.13
+++ programming-style.xml	15 Feb 2008 18:24:50 -0000	1.14
@@ -127,6 +127,20 @@
 return if $::Pragma->{download};
 </programlisting>
 	</para></listitem>
+	<listitem><para>
+		<emphasis role='bold'>Filehandles</emphasis> - Use lexical variables (added in 2008):
+<programlisting>
+# BAD
+open SRC, $assertfile
+
+# GOOD
+open my $src, $assertfile
+</programlisting>
+	</para></listitem>
+
+	<listitem><para>
+		<emphasis role='bold'>Return from subroutines</emphasis> - Use explicit <code>return</code> statements.
+	</para></listitem>
 
 	<listitem><para>
 		<emphasis role='bold'>Globals</emphasis> - global variables and subs
@@ -172,7 +186,8 @@
 	<listitem><para>
 		<emphasis role='bold'>HTML</emphasis> - in late 2004, it was agreed to
 		make the HTML code as XHTML-compliant as possible, but without using
-		XHTML constructs that could cause problems for older browsers.
+		XHTML constructs that could cause problems for older browsers. (This
+		subset of support should also be common to HTML).
 		</para>
 		<para>
 		In essence, all &glos-HTML; tag and argument names should be lowercased,



1.7       +56 -13    xmldocs/refs/ActionMap


rev 1.7, prev_rev 1.6
Index: ActionMap
===================================================================
RCS file: /var/cvs/xmldocs/refs/ActionMap,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ActionMap	27 Jun 2007 00:02:31 -0000	1.6
+++ ActionMap	15 Feb 2008 18:24:50 -0000	1.7
@@ -1,5 +1,5 @@
 __NAME__ purpose
-modify or define custom Interchange actions
+modify existing or define custom Interchange actions
 __END__
 
 
@@ -8,21 +8,34 @@
 __END__
 
 
-#__NAME__ synopsis
-#<group choice='req'>
-#	<arg choice='plain'>No</arg>
-#	<arg choice='plain'>Yes</arg>
-#</group>
-#__END__
+__NAME__ synopsis
+<arg choice='plain'>action_name</arg>
+<arg choice='plain'>perl_subroutine_or_ITL_code</arg>
+__END__
 
 
 __NAME__ description
-The directive allows definition of Interchange &glos-ActionMap;s, whose
-contents are usually &PERL; subroutines.
+The directive allows creation of new (and modification of existing)
+Interchange &glos-ActionMap;s. ActionMap contents are usually &PERL;
+subroutines.
+</para><para>
+If the action does not return a &glos-true; value, &IC; processing
+will stop right there, allowing you to fully handle the request from
+your action.
+</para><para>
+See &glos-ActionMap; glossary entry for more explanation and the list
+of built-in &IC; actionmaps.
 __END__
 
 __NAME__ notes
 For an introduction to Action Maps, see &glos-ActionMap; glossary entry.
+</para><para>
+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'/>.
 __END__
 
 
@@ -33,12 +46,42 @@
 </programlisting>
 Since we effectively turned Order into a no-operation action, the usual
 order link such as
-<code><![CDATA[<A HREF="[area order/nextpage]">Go to the next page</A>]]></code>
-would be equivalent to <code><![CDATA[[page order/nextpage]Go to the next page</a>]]></code>.
+<code><![CDATA[<A HREF="[area order/nextpage]">Order</a>]]></code>
+would be equivalent to <code><![CDATA[[page nextpage]Order (does nothing)</a>]]></code>.
+__END__
+
+__NAME__ example: Splitting a request into action map, page name and arguments
+Here's an example of an actionmap "<literal>test</literal>" that translates
+HTTP requests in form of <literal>test/<replaceable>page</replaceable>/<replaceable>arguments</replaceable></literal>
+into actual page requests to <literal>page.html</literal> with optional <literal>arguments</literal>.
+</para><para>
+Note that, as hinted above, global-level actionmap have the actionmap name
+already already stripped from the URL.
+
+<programlisting><![CDATA[
+ActionMap test <<EOA
+sub {
+  my $url = shift;
+
+  # Remove actionmap name from the URL (only needed for catalog-level
+  # actionmaps which do not receive the URL with actionmap name already
+  # removed)
+  $url =~ s:^test/+::i;
+
+  # Arguments are optional
+  if ($url =~ s:/+(.*)$::) {
+    $CGI->{mv_arg} = $1;
+  }
+
+  $CGI->{mv_nextpage} = $url;
+  return 1;
+}   
+EOA 
+]]></programlisting>
 __END__
 
+
 __NAME__ missing
-In the example, I provided some erroneous comment (the part about [area].. equal to [page]...
-Also fix description and add synopsis
+Kevon's example of /prod/cat/search
 __END__
 



1.7       +12 -13    xmldocs/refs/AddDirective


rev 1.7, prev_rev 1.6
Index: AddDirective
===================================================================
RCS file: /var/cvs/xmldocs/refs/AddDirective,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- AddDirective	27 Jun 2007 00:02:31 -0000	1.6
+++ AddDirective	15 Feb 2008 18:24:50 -0000	1.7
@@ -59,18 +59,23 @@
 on config directives.
 __END__
 
-__NAME__ example: Adding a new catalog configuration directive
+__NAME__ example: Adding a new catalog configuration directive with a custom parse routine
 Let's add the <literal>DocRoot</literal> directive. Put the following 
 in your &gcf;:
 <programlisting><![CDATA[
 GlobalSub <<EOS
-sub parse_docroot {
-	my ($var, $value) = @_;
+sub declare_extra_config {
 
-	unless ( -d $value ) { $@ = errmsg("Directory $value: $!") }
-	if ($@) { config_warn($@) }
+	package Vend::Config;
 
-	return;
+	sub parse_docroot {
+		my ($var, $value) = @_;
+
+		unless ( -d $value ) { $@ = errmsg("Directory $value: $!") }
+		if ($@) { config_warn($@) }
+
+		return;
+	}
 }
 EOS
 
@@ -78,7 +83,7 @@
 ]]></programlisting>
 __END__
 
-__NAME__ example: Adding the Swish directive
+__NAME__ example: Adding the "Swish" directive with an existing parse routine
 <programlisting> 
 Require       module  Vend::Swish
 
@@ -86,11 +91,5 @@
 
 AddDirective  Swish   hash
 </programlisting>
-__END__
-
-__NAME__ missing
-Make better example, and exactly show how to define a new parser function without modifying Config.pm directly.
-Docroot example doesn't work
-also, does it only extends the set available in catalog.cfg or also in interchange.cfg ?
 __END__
 



1.4       +1 -6      xmldocs/refs/AdminSub


rev 1.4, prev_rev 1.3
Index: AdminSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminSub,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AdminSub	27 Jun 2007 00:02:31 -0000	1.3
+++ AdminSub	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,10 +1,5 @@
 __NAME__ purpose
-specify global subroutines that can be used only by catalogs listed under AllowGlobal
-directive
-__END__
-
-
-__NAME__ missing
+specify global subroutines that can be used only by catalogs listed under AllowGlobal directive
 __END__
 
 



1.5       +1 -1      xmldocs/refs/AdminUser


rev 1.5, prev_rev 1.4
Index: AdminUser
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminUser,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AdminUser	27 Jun 2007 00:02:31 -0000	1.4
+++ AdminUser	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-usernames that are given full access to all catalogs, regardless of any permissions
+specify usernames that are given full access to all catalogs, regardless of any permissions
 __END__
 
 __NAME__ synopsis



1.4       +1 -1      xmldocs/refs/AlwaysSecure


rev 1.4, prev_rev 1.3
Index: AlwaysSecure
===================================================================
RCS file: /var/cvs/xmldocs/refs/AlwaysSecure,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AlwaysSecure	12 Oct 2006 13:51:35 -0000	1.3
+++ AlwaysSecure	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-list pages that are always to be served over a HTTPS connection
+specify pages that are always to be served over a HTTPS connection
 __END__
 
 



1.5       +1 -1      xmldocs/refs/ConfigAllAfter


rev 1.5, prev_rev 1.4
Index: ConfigAllAfter
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllAfter,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ConfigAllAfter	19 Oct 2006 20:28:13 -0000	1.4
+++ ConfigAllAfter	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-config files to read as part of every catalog's configuration, after all its files are read in first
+specify config files to read as part of every catalog's configuration, after all its files are read in first
 __END__
 
 __NAME__ synopsis



1.4       +1 -1      xmldocs/refs/ConfigAllBefore


rev 1.4, prev_rev 1.3
Index: ConfigAllBefore
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllBefore,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfigAllBefore	19 Oct 2006 20:28:13 -0000	1.3
+++ ConfigAllBefore	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-config files to read as part of every catalog's configuration, before any of its files are read in
+specify config files to read as part of every catalog's configuration, before any of its files are read in
 __END__
 
 



1.5       +1 -1      xmldocs/refs/CreditCardAuto


rev 1.5, prev_rev 1.4
Index: CreditCardAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/CreditCardAuto,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CreditCardAuto	6 Nov 2006 18:41:20 -0000	1.4
+++ CreditCardAuto	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-automatically encrypt credit card information
+encrypt credit card information automatically
 __END__
 
 



1.11      +1 -1      xmldocs/refs/DatabaseAuto


rev 1.11, prev_rev 1.10
Index: DatabaseAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAuto,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- DatabaseAuto	6 Nov 2006 18:41:20 -0000	1.10
+++ DatabaseAuto	15 Feb 2008 18:24:50 -0000	1.11
@@ -1,5 +1,5 @@
 __NAME__ purpose
-automatically register existing database tables for use with Interchange
+register database tables for use with Interchange automatically
 __END__
 
 __NAME__ synopsis



1.4       +1 -1      xmldocs/refs/DirectoryIndex


rev 1.4, prev_rev 1.3
Index: DirectoryIndex
===================================================================
RCS file: /var/cvs/xmldocs/refs/DirectoryIndex,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DirectoryIndex	6 Nov 2006 18:41:20 -0000	1.3
+++ DirectoryIndex	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-set the default page in a directory
+specify the default page in a directory
 __END__
 
 



1.4       +1 -1      xmldocs/refs/DomainTail


rev 1.4, prev_rev 1.3
Index: DomainTail
===================================================================
RCS file: /var/cvs/xmldocs/refs/DomainTail,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DomainTail	22 Nov 2007 01:22:13 -0000	1.3
+++ DomainTail	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-only honor the toplevel domain in IP qualification
+honor only the toplevel domain in IP qualification
 __END__
 
 



1.4       +1 -1      xmldocs/refs/Environment


rev 1.4, prev_rev 1.3
Index: Environment
===================================================================
RCS file: /var/cvs/xmldocs/refs/Environment,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Environment	6 Nov 2006 18:41:20 -0000	1.3
+++ Environment	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-environment variables to inherit from the calling CGI link program
+specify environment variables to inherit from the calling CGI link program
 __END__
 
 



1.5       +1 -1      xmldocs/refs/ErrorFile


rev 1.5, prev_rev 1.4
Index: ErrorFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorFile,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ErrorFile	6 Nov 2006 18:41:20 -0000	1.4
+++ ErrorFile	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-error log filename
+specify error log filename
 __END__
 
 



1.5       +1 -1      xmldocs/refs/HTMLsuffix


rev 1.5, prev_rev 1.4
Index: HTMLsuffix
===================================================================
RCS file: /var/cvs/xmldocs/refs/HTMLsuffix,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- HTMLsuffix	6 Nov 2006 18:41:20 -0000	1.4
+++ HTMLsuffix	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-filename extension for files in the pages/ directory
+specify filename extension for files in the PageDir and TemplateDir directories
 __END__
 
 



1.9       +1 -1      xmldocs/refs/HouseKeeping


rev 1.9, prev_rev 1.8
Index: HouseKeeping
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeeping,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- HouseKeeping	10 Nov 2007 18:28:14 -0000	1.8
+++ HouseKeeping	15 Feb 2008 18:24:50 -0000	1.9
@@ -1,5 +1,5 @@
 __NAME__ purpose
-number of seconds between periodic "house keeping" jobs
+specify number of seconds between periodic "house keeping" jobs
 __END__
 
 



1.2       +1 -1      xmldocs/refs/IPCsocket


rev 1.2, prev_rev 1.1
Index: IPCsocket
===================================================================
RCS file: /var/cvs/xmldocs/refs/IPCsocket,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IPCsocket	6 Nov 2006 22:04:40 -0000	1.1
+++ IPCsocket	15 Feb 2008 18:24:50 -0000	1.2
@@ -1,5 +1,5 @@
 __NAME__ purpose
-IPC socket filename
+specify IPC socket filename
 __END__
 
 __NAME__ see also



1.5       +1 -1      xmldocs/refs/IpHead


rev 1.5, prev_rev 1.4
Index: IpHead
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpHead,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- IpHead	22 Nov 2007 01:22:13 -0000	1.4
+++ IpHead	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-use only part of the IP to qualify user sessions?
+use only part of the IP to qualify user sessions
 __END__
 
 



1.5       +1 -1      xmldocs/refs/Limit


rev 1.5, prev_rev 1.4
Index: Limit
===================================================================
RCS file: /var/cvs/xmldocs/refs/Limit,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Limit	15 Sep 2007 17:16:57 -0000	1.4
+++ Limit	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,5 +1,5 @@
 __NAME__ purpose
-imposes or modifies miscellaneous limits
+set or modify various limits
 __END__
 
 __NAME__ description



1.3       +1 -1      xmldocs/refs/PGP


rev 1.3, prev_rev 1.2
Index: PGP
===================================================================
RCS file: /var/cvs/xmldocs/refs/PGP,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PGP	6 Nov 2006 18:41:21 -0000	1.2
+++ PGP	15 Feb 2008 18:24:50 -0000	1.3
@@ -1,5 +1,5 @@
 __NAME__ purpose
-automatically encrypt complete order reports
+encrypt complete order reports automatically
 __END__
 
 



1.3       +1 -1      xmldocs/refs/ParseVariables


rev 1.3, prev_rev 1.2
Index: ParseVariables
===================================================================
RCS file: /var/cvs/xmldocs/refs/ParseVariables,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ParseVariables	6 Nov 2006 18:41:21 -0000	1.2
+++ ParseVariables	15 Feb 2008 18:24:50 -0000	1.3
@@ -1,5 +1,5 @@
 __NAME__ purpose
-parse (interpolate) variable values before storing them
+parse (interpolate) config file variables
 __END__
 
 



1.4       +1 -1      xmldocs/refs/Password


rev 1.4, prev_rev 1.3
Index: Password
===================================================================
RCS file: /var/cvs/xmldocs/refs/Password,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Password	6 Nov 2006 18:41:21 -0000	1.3
+++ Password	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-password for RemoteUser
+specify password for RemoteUser
 __END__
 
 



1.3       +3 -0      xmldocs/refs/ProductDir


rev 1.3, prev_rev 1.2
Index: ProductDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ProductDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ProductDir	6 Nov 2006 18:41:21 -0000	1.2
+++ ProductDir	15 Feb 2008 18:24:50 -0000	1.3
@@ -15,6 +15,9 @@
 
 __NAME__ notes
 The specified location is, unless absolute, treated relative to &glos-CATROOT;.
+</para><para>
+This directive is also available through an alias
+<literal>DataDir</literal>.
 __END__
 
 __NAME__ example: Setting ProductDir



1.4       +6 -0      xmldocs/refs/ProductFiles


rev 1.4, prev_rev 1.3
Index: ProductFiles
===================================================================
RCS file: /var/cvs/xmldocs/refs/ProductFiles,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ProductFiles	6 Nov 2006 18:41:21 -0000	1.3
+++ ProductFiles	15 Feb 2008 18:24:50 -0000	1.4
@@ -17,6 +17,12 @@
 __END__
 
 
+__NAME__ notes
+This directive is also available through an alias
+<literal>DefaultTables</literal>.
+__END__
+
+
 __NAME__ example: Setting ProductFiles
 <programlisting>
 ProductFiles vendor_a vendor_b



1.2       +1 -1      xmldocs/refs/Replace


rev 1.2, prev_rev 1.1
Index: Replace
===================================================================
RCS file: /var/cvs/xmldocs/refs/Replace,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Replace	11 Jun 2005 23:39:25 -0000	1.1
+++ Replace	15 Feb 2008 18:24:50 -0000	1.2
@@ -1,5 +1,5 @@
 __NAME__ purpose
-re-set directive to a new value, or its default
+reset directive to a new value, or to its default
 __END__
 
 



1.3       +1 -1      xmldocs/refs/SOAP_Perms


rev 1.3, prev_rev 1.2
Index: SOAP_Perms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_Perms,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAP_Perms	6 Nov 2006 18:41:21 -0000	1.2
+++ SOAP_Perms	15 Feb 2008 18:24:50 -0000	1.3
@@ -1,5 +1,5 @@
 __NAME__ purpose
-Interchange SOAP-RPC Unix socket permissions
+specify SOAP RPC Unix socket permissions
 __END__
 
 __NAME__ see also



1.3       +1 -1      xmldocs/refs/SOAP_Socket


rev 1.3, prev_rev 1.2
Index: SOAP_Socket
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_Socket,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAP_Socket	6 Nov 2006 18:41:21 -0000	1.2
+++ SOAP_Socket	15 Feb 2008 18:24:50 -0000	1.3
@@ -1,5 +1,5 @@
 __NAME__ purpose
-name of SOAP RPC socket files
+specify name of SOAP RPC socket file
 __END__
 
 __NAME__ see also



1.4       +1 -1      xmldocs/refs/SeparateItems


rev 1.4, prev_rev 1.3
Index: SeparateItems
===================================================================
RCS file: /var/cvs/xmldocs/refs/SeparateItems,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SeparateItems	6 Nov 2006 18:41:21 -0000	1.3
+++ SeparateItems	15 Feb 2008 18:24:50 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-treat the same items in the cart as separate, instead of just increasing quantity?
+treat items with quantity greater than 1 as separate items
 __END__
 
 



1.6       +1 -1      xmldocs/refs/SocketFile


rev 1.6, prev_rev 1.5
Index: SocketFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketFile,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- SocketFile	6 Nov 2006 18:41:21 -0000	1.5
+++ SocketFile	15 Feb 2008 18:24:50 -0000	1.6
@@ -1,5 +1,5 @@
 __NAME__ purpose
-Unix socket filename
+specify Unix socket filename
 __END__
 
 __NAME__ see also



1.11      +1 -1      xmldocs/refs/SocketPerms


rev 1.11, prev_rev 1.10
Index: SocketPerms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketPerms,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- SocketPerms	6 Nov 2006 18:41:21 -0000	1.10
+++ SocketPerms	15 Feb 2008 18:24:50 -0000	1.11
@@ -1,5 +1,5 @@
 __NAME__ purpose
-Interchange Unix socket permissions
+specify Unix socket permissions
 __END__
 
 __NAME__ see also



1.4       +6 -0      xmldocs/refs/TemplateDir


rev 1.4, prev_rev 1.3
Index: TemplateDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/TemplateDir,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TemplateDir	6 Nov 2006 18:41:21 -0000	1.3
+++ TemplateDir	15 Feb 2008 18:24:50 -0000	1.4
@@ -22,3 +22,9 @@
 </programlisting>
 __END__
 
+__NAME__ example: Setting TemplateDir to multiple directories
+<programlisting>
+TemplateDir /usr/local/interchange/default_pages /common/pages
+</programlisting>
+__END__
+



1.6       +1 -1      xmldocs/refs/TrackFile


rev 1.6, prev_rev 1.5
Index: TrackFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrackFile,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TrackFile	6 Nov 2006 18:41:21 -0000	1.5
+++ TrackFile	15 Feb 2008 18:24:50 -0000	1.6
@@ -1,5 +1,5 @@
 __NAME__ purpose
-user tracking log filename
+specify user tracking log filename
 __END__
 
 



1.5       +1 -1      xmldocs/refs/XHTML


rev 1.5, prev_rev 1.4
Index: XHTML
===================================================================
RCS file: /var/cvs/xmldocs/refs/XHTML,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XHTML	6 Nov 2006 18:41:21 -0000	1.4
+++ XHTML	15 Feb 2008 18:24:50 -0000	1.5
@@ -1,6 +1,6 @@
 
 __NAME__ purpose
-affect Interchange to output XHTML compatible HTML output
+enable XHTML-conformant HTML output
 __END__
 
 __NAME__ see also



1.4       +8 -1      xmldocs/refs/perl_warnings_in_page


rev 1.4, prev_rev 1.3
Index: perl_warnings_in_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/perl_warnings_in_page,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- perl_warnings_in_page	6 Nov 2006 22:34:44 -0000	1.3
+++ perl_warnings_in_page	15 Feb 2008 18:24:50 -0000	1.4
@@ -23,7 +23,14 @@
 __END__
 
 
-__NAME__ example: Enable perl_warnings_in_page page-wide
+__NAME__ example: Enable __FILENAME__ catalog-wide
+Put the following in &ccf;:
+<programlisting>
+Pragma perl_warnings_in_page
+</programlisting>
+__END__
+
+__NAME__ example: Enable __FILENAME__ page-wide
 <programlisting>
 [pragma perl_warnings_in_page]
 </programlisting>



1.3       +9 -1      xmldocs/refs/query.tag


rev 1.3, prev_rev 1.2
Index: query.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/query.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- query.tag	6 Apr 2006 09:44:38 -0000	1.2
+++ query.tag	15 Feb 2008 18:24:50 -0000	1.3
@@ -119,4 +119,12 @@
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ example: Ad-hoc table display
+<programlisting>
+[query sql="select * from products" type=html /]
+</programlisting>
+__END__
+



1.1                  xmldocs/refs/DataDir


rev 1.1, prev_rev 1.0
Index: DataDir
===================================================================
__NAME__ purpose
specify directory containing database files
__END__


__NAME__ synopsis
<arg choice='plain'><replaceable>directory</replaceable></arg>
__END__


__NAME__ description
Specify the directory containing database files.
The directory cannot be absolute, unless &conf-NoAbsolute; is disabled.
</para><para>
This directive is an alias for &conf-ProductDir;; see the other
&glos-configuration; directive for complete documentation.
__END__

__NAME__ example: Setting DataDir
<programlisting>
DataDir databases
</programlisting>
__END__




1.1                  xmldocs/refs/DefaultTables


rev 1.1, prev_rev 1.0
Index: DefaultTables
===================================================================
__NAME__ purpose
specify all databases containing products that form one big "products" database
__END__


__NAME__ synopsis
<arg choice='plain' rep='repeat'><replaceable>database_name</replaceable></arg>
__END__


__NAME__ description
Specify &glos-database; tables that should be, all together, logically seen
as one bigger <database>products</database> database.
</para><para>
This directive is an alias for &conf-ProductFiles;; see the other
&glos-configuration; directive for complete documentation.
__END__


__NAME__ example: Setting DefaultDataTables
<programlisting>
DefaultDataTables vendor_a vendor_b
</programlisting>
__END__





1.1                  xmldocs/refs/TrackDateFormat


rev 1.1, prev_rev 1.0
Index: TrackDateFormat
===================================================================
__NAME__ purpose
specify time format used in TrackFile logs
__END__

__NAME__ synopsis
<arg choice='plain'><replaceable>time_format</replaceable></arg>
__END__

__NAME__ description
The &conf-__FILENAME__; directive specifies the time format to be 
used in &conf-TrackFile; logs.
</para><para>
The default format is <literal>%Y%m%d</literal>. For a list of 
accepted POSIX format specifiers, see the &glos-time; glossary entry.
__END__

__NAME__ example: Apache-equivalent time format
<programlisting>
__FILENAME__ %d/%b/%Y:%H:%M:%S %z
</programlisting>
__END__

__NAME__ example: ISO 8601 time format
<programlisting>
__FILENAME__ %Y-%m-%dT%H:%M:%S%z
</programlisting>
__END__




1.2       +1 -0      xmldocs/refs/area/missing


rev 1.2, prev_rev 1.1
Index: missing
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/missing,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- missing	16 Feb 2005 17:59:33 -0000	1.1
+++ missing	15 Feb 2008 18:24:51 -0000	1.2
@@ -1 +1,2 @@
 more work on passing multiple values in arg=
+napisat sve one posebne targete order/11001 , scan/ , search/ etc.








More information about the docs mailing list