[interchange-docs] xmldocs - racke modified refs/shipping-desc.tag

[docs at icdevgroup.org]

User:      racke
Date:      2008-08-09 14:08:14 GMT
Modified:  refs     shipping-desc.tag
Log:
example from CVS logs added, purpose added, et al

Revision  Changes    Path
1.3                  xmldocs/refs/shipping-desc.tag


rev 1.3, prev_rev 1.2
Index: shipping-desc.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/shipping-desc.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- shipping-desc.tag	15 Jul 2008 13:36:25 -0000	1.2
+++ shipping-desc.tag	9 Aug 2008 14:08:14 -0000	1.3
@@ -1,4 +1,6 @@
-
+__NAME__ purpose
+displays shipping mode description
+__END__
 
 
 __NAME__ synopsis
@@ -17,7 +19,7 @@
 	<!-- DFL -->
 	</entry>
 	<entry>
-	<!-- DSC -->
+	shipping mode
 	</entry>
 
 </row> 
@@ -33,7 +35,7 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	<literal>description</literal>
 	</entry>
 	<entry>
 	<!-- DSC -->
@@ -42,3 +44,46 @@
 </row> 
 &TAG_NON_CONTAINER;
 __END__
+
+__NAME__ see also
+shipping
+__END__
+
+__NAME__ description
+<tag>shipping-desc</tag> allows access to arbitrary keys in the shipping
+configuration.
+__END__
+
+__NAME__ example: Display shipping modes and corresponding information
+<para>
+The following snippet out of <filename>shipping.asc</filename> contains 
+additional information which can be displayed with <tag>shipping-desc</tag>.
+<programlisting>
+usps: USPS 1st class
+        crit        [onlyitems]
+        min         0
+        max         0
+        cost        e No shipping needed!
+        at_least    0
+        adder       0
+        p_time      1-2 business days
+        s_time      3-7 business days
+
+        min         1
+        max         6
+        cost        4.00
+
+        min         7
+        max         12
+        cost        7.00
+</programlisting>
+<para>
+<programlisting><![CDATA[
+[loop list="[shipping possible=1]"]
+Shipping Mode:   [shipping-desc mode="[loop-code]"]
+Processing time: [shipping-desc mode="[loop-code]" key=p_time]
+Shipping time:   [shipping-desc mode="[loop-code]" key=s_time]
+Cost:            [shipping mode="[loop-code]"]
+[/loop]
+]]></programlisting>
+__END__