[docs] xmldocs - docelic modified 13 files

docs at icdevgroup.org docs at icdevgroup.org
Sun Mar 6 06:51:29 EST 2005


User:      docelic
Date:      2005-03-06 11:51:29 GMT
Modified:  glossary ITL
Modified:  refs     AlwaysSecure banner
Modified:  refs/area control description example4 synopsis
Added:     glossary robot safe
Added:     refs     bounce.tag
Added:     refs/area example5 example6 notes
Log:
Some fixes, more examples and new items

Revision  Changes    Path
1.9       +1 -0      xmldocs/glossary/ITL


rev 1.9, prev_rev 1.8
Index: ITL
===================================================================
RCS file: /var/cvs/xmldocs/glossary/ITL,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ITL	16 Feb 2005 17:59:33 -0000	1.8
+++ ITL	6 Mar 2005 11:51:28 -0000	1.9
@@ -272,6 +272,7 @@
 
 <section>
 <title>Deeper Look at Argument Quoting</title>
+<!-- TODO Explain quoting on examples from [area] -->
 
 <para>
 The question is &mdash; exactly when can you omit the quotes around



1.1                  xmldocs/glossary/robot


rev 1.1, prev_rev 1.0
Index: robot
===================================================================
<!--
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:

=over 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=KvWna2PT>).

* 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=4>).

=back

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!
-->



1.1                  xmldocs/glossary/safe


<<safe: empty>>


1.2       +2 -2      xmldocs/refs/AlwaysSecure


rev 1.2, prev_rev 1.1
Index: AlwaysSecure
===================================================================
RCS file: /var/cvs/xmldocs/refs/AlwaysSecure,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AlwaysSecure	3 Mar 2005 15:19:55 -0000	1.1
+++ AlwaysSecure	6 Mar 2005 11:51:28 -0000	1.2
@@ -19,7 +19,7 @@
 __END__
 
 __NAME__ example: Specifying AlwaysSecure
-<programlisting>
+<programlisting><![CDATA[
 AlwaysSecure ord/checkout
 
 AlwaysSecure   <<EOD
@@ -33,6 +33,6 @@
   ord/shipping
   query/order_detail
 EOD
-</programlisting>
+]]></programlisting>
 __END__
 



1.8       +9 -4      xmldocs/refs/banner


rev 1.8, prev_rev 1.7
Index: banner
===================================================================
RCS file: /var/cvs/xmldocs/refs/banner,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- banner	14 Dec 2004 19:15:43 -0000	1.7
+++ banner	6 Mar 2005 11:51:28 -0000	1.8
@@ -2,7 +2,6 @@
 display banner ads or messages, based on category and optional weighting
 __END__
 
-
 __NAME__ synopsis
 <row>
 	<entry>
@@ -28,7 +27,8 @@
 	<entry><literal>banner</literal></entry>
 	<entry>
 	The banner table name. The default is reasonable and
-	rarely needs to be changed.</entry>
+	rarely needs to be changed. <mv>my_banner_table</mv> can be set to 
+	override this value.</entry>
 </row>
 <row>
 	<entry>
@@ -41,7 +41,8 @@
 	class='field'>banner</database> column (separated by specified delimiters).
 	The column specified by <database class='field'>r_field</database> is 
 	consulted (expecting a boolean value) to determine whether to
-	sequentially rotate banners.
+	sequentially rotate banners. This is only used with non-weighted banner
+	display scheme.
 	</entry>
 </row>
 <row>
@@ -65,6 +66,8 @@
 	<entry><literal>category</literal></entry>
 	<entry>
 	Specify the column containing banner category.
+	Only banners from the selected category will be taken as possible
+	candidates for display.
 	This is only used with weighted ads.
 	</entry>
 </row>
@@ -115,7 +118,9 @@
 	to contain multiple entries with the same
 	<database class='field'>category</database>, and then the banners are
 	selected in regard to their relative weight (more weight = more 
-	visibility).
+	visibility). The sum of weights can be arbitrary and does not need to 
+	equal 1 (obviously - because that would require a manual intervention
+	on every banner addition/remove operation).
 	</entry>
 </row>
 <row>



1.1                  xmldocs/refs/bounce.tag


rev 1.1, prev_rev 1.0
Index: bounce.tag
===================================================================
__NAME__ purpose
send a HTTP Redirect request and follow to the new page
__END__


__NAME__ see also
area, page
__END__


__NAME__ synopsis
<row>
	<entry>
			<arg choice='plain'>href</arg>
	</entry>
	<entry>Yes</entry><entry>Yes</entry>
	<entry></entry>
	<entry>Page to "bounce" to. The URL must be absolute.</entry>
</row>
<row>
	<entry>
			<arg choice='plain'>if</arg>
	</entry>
	<entry>Yes</entry><entry></entry>
	<entry></entry>
	<entry>
	Bounce if the specified condition is met.
	</entry>
</row>
&ROW_INTERPOLATE_0;
__END__


__NAME__ notes
Due to special processing, this tag cannot be used from embedded
&PERL;.
__END__


__NAME__ description
The tag is designed to send an HTTP redirect (status code 302)
to the browser and redirect it to another (possibly &IC;-parsed) page.
</para><para>
When &tag-bounce; is encountered, &IC; will stop ITL code execution;
all tags lexically following &tag-bounce; will not
be run through the parser. Bear in mind that if you are inside a looping
list, that list will run to completion (due to special handling of lists)
and the &tag-bounce; tag will not be seen until the loop is complete.
__END__


__NAME__ example: Simple bounce
<programlisting><![CDATA[
[if !scratch real_user]
  [bounce href="[area violation]"]
[/if]
]]></programlisting>
__END__


__NAME__ example: Bouncing to the Welcome page
<programlisting><![CDATA[
Note that the URL must always be absolute, so you must have the 
<varname>SERVER_NAME</varname> variable defined for this to work:
[if value go_home]
  [bounce href="__SERVER_NAME__/"]
[/if]
]]></programlisting>
__END__


__NAME__ missing
Explanation for if= and example
__END__



1.3       +1 -1      xmldocs/refs/area/control


rev 1.3, prev_rev 1.2
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/control,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- control	22 Sep 2004 21:13:07 -0000	1.2
+++ control	6 Mar 2005 11:51:28 -0000	1.3
@@ -1,3 +1,3 @@
 purpose: produce a hypertext link
 see also: page
-missing: under example 2, tell how to extract arg1=val1/arg2=val2 as separate fields from [data session arg]
+missing: under example 2, tell how to extract arg1=val1/arg2=val2 as separate fields from [data session arg]. Also see why there's no href in synopsis



1.6       +2 -1      xmldocs/refs/area/description


rev 1.6, prev_rev 1.5
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/description,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- description	16 Feb 2005 17:59:33 -0000	1.5
+++ description	6 Mar 2005 11:51:28 -0000	1.6
@@ -1,6 +1,7 @@
 The <tag>area</tag> tag expands to a proper hypertext URL &glos-link; which
 preserves Interchange session information and arguments passed onto
-the targeted page. The target page argument you supply is treated relatively
+the targeted page or &glos-form-action;. The target page argument you
+supply is treated relatively
 to the <filename class='directory'>pages/</filename> directory inside your
 catalog root directory (CATROOT).
 </para><para>



1.2       +4 -4      xmldocs/refs/area/example4


rev 1.2, prev_rev 1.1
Index: example4
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/example4,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example4	31 Aug 2004 14:58:36 -0000	1.1
+++ example4	6 Mar 2005 11:51:28 -0000	1.2
@@ -5,13 +5,13 @@
 </title>
 
 <programlisting><![CDATA[
-<A HREF="[area form="
+<a href="[area form="
   mv_order_item=99-102
   mv_order_size=L
   mv_order_quantity=1
   mv_separate_items=1
   mv_todo=refresh"
-]">Order T-shirt in Large size</A>
+]">Order T-shirt in Large size</a>
 ]]></programlisting>
 
 <para>
@@ -31,8 +31,8 @@
 </para>
 
 <programlisting><![CDATA[
-<form action="[area process]" method=post>
-  <input type='hidden' name='mv_todo' VALUE="refresh">
+<form action="[area process]" method="post">
+  <input type='hidden' name='mv_todo' value="refresh">
   <input type='hidden' name='mv_order_item' value="000101">
   Qty: <input size='2' name='mv_order_quantity' value="1">
   <input type='hidden' name='mv_order_fly' value="description=An on-the-fly item|price=100.00">



1.7       +160 -0    xmldocs/refs/area/synopsis


rev 1.7, prev_rev 1.6
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/synopsis,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- synopsis	16 Feb 2005 17:59:33 -0000	1.6
+++ synopsis	6 Mar 2005 11:51:28 -0000	1.7
@@ -1,3 +1,4 @@
+<!--
 <row>
 	<entry>href</entry>
 	<entry>Yes</entry><entry>Yes</entry>
@@ -17,3 +18,162 @@
 	<entry>0</entry>
 	<entry>Use HTTPS for the target page?</entry>
 </row>
+-->
+
+
+
+
+<row>
+
+	<entry>
+	alias
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	once
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	search
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	form
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	add_dot_html
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	no_session
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	secure
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	no_count
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;



1.1                  xmldocs/refs/area/example5


rev 1.1, prev_rev 1.0
Index: example5
===================================================================
<example>

<title>
Implementing searches using href=/arg= options
</title>

<programlisting><![CDATA[
<a href="[area scan
    se=Impressionists
    sf=category]
">Search for Impressionist Paintings</a>
]]></programlisting>

<para>
Or the equivalent, using named parameters and more understandable quoting:
</para>

<programlisting><![CDATA[
<a href="[area href=scan
    arg="se=Impressionists
         sf=category"]
">Search for Impressionist Paintings</a>
]]></programlisting>


<para>
If the <arg choice='plain'>arg</arg> parameter is set, it will be available
within the search display page as <code>[value mv_arg]</code>.
</para>

</example>



1.1                  xmldocs/refs/area/example6


rev 1.1, prev_rev 1.0
Index: example6
===================================================================
<example>

<title>
Implementing searches using search= option
</title>

<para>
The <arg choice='plain'>search</arg> attribute is a shorthand for the 
<arg choice='plain'>href</arg>/<arg choice='plain'>arg</arg> scheme. 
When <arg choice='plain'>search</arg> is used, 
<arg choice='plain'>href</arg> will be set to <literal>scan</literal> and
<arg choice='plain'>arg</arg> to the value of 
<arg choice='plain'>search</arg>.
</para>

<programlisting><![CDATA[
<a href="[area search="
    se=Impressionists
    sf=category"]
">Search for Impressionist Paintings</a>
]]></programlisting>

</example>



1.1                  xmldocs/refs/area/notes


rev 1.1, prev_rev 1.0
Index: notes
===================================================================
The &tag-area; tag examples use some advanced argument-quoting concepts.
To minimize
confusion, please see the proper and complete quoting explanation in the 
&glos-ITL; glossary entry.








More information about the docs mailing list