[docs] docs - jon modified 8 files
docs@interchange.redhat.com
docs@interchange.redhat.com
Wed Jun 5 22:02:01 2002
User: jon
Date: 2002-06-06 02:01:52 GMT
Modified: . ic_ecommerce.sdf iccattut.sdf icconfig.sdf
Modified: icdatabase.sdf icfaq.sdf ictags-more.txt ictags.sdf
Modified: ictemplates.sdf
Log:
Flesh out [order] tag docs.
Change [/order] and [/page] to </a> in examples.
Remove some stuff that's been taken care of from ictags-more.txt.
Other minor stuff.
Revision Changes Path
1.13 +10 -10 docs/ic_ecommerce.sdf
rev 1.13, prev_rev 1.12
Index: ic_ecommerce.sdf
===================================================================
RCS file: /var/cvs/docs/ic_ecommerce.sdf,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -u -r1.12 -r1.13
--- ic_ecommerce.sdf 6 May 2002 18:04:07 -0000 1.12
+++ ic_ecommerce.sdf 6 Jun 2002 02:01:51 -0000 1.13
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ic_ecommerce.sdf,v 1.12 2002/05/06 18:04:07 jon Exp $
+# $Id: ic_ecommerce.sdf,v 1.13 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Interchange Ecommerce Functions"
!define DOC_TYPE ""
!define DOC_CODE "ic_ecommerce"
-!define DOC_VERSION substr('$Revision: 1.12 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.13 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ic_ecommerce.html"
@@ -70,7 +70,7 @@
N:
N: Example:
-> Order a [order TK112]Toaster[/order] today.
+> Order a [order TK112]Toaster</a> today.
Note that this is the same as:
@@ -82,8 +82,8 @@
=item [/order]
-Expands into </a>. Used with the order element, such as: Buy a
-C<[order TK112]>ToasterC<[/order]> today.
+Expands into </a>. May be used to give the order tag the appearance
+of being a container tag, but neither necessary nor recommended.
=back
@@ -125,12 +125,12 @@
On a product display page, use:
-> [order 00-0011]Order the Mona Lisa[/order]
+> [order 00-0011]Order the Mona Lisa</a>
If coming from a search results or on-the-fly page, you may use the generated
C<[item-code]> thusly:
-> [order [item-code]]Order [item-field name][/order]
+> [order [item-code]]Order [item-field name]</a>
Bear in mind that if you have not reached the page via a search or
on-the-fly operation, C<[item-code]> means nothing and will cause an error.
@@ -339,7 +339,7 @@
^ Set the SpecialPage C<order> to the page to display
when an item is ordered.
-+ Use the C<[order code=item page=page_name] Order it! [/order]> form of
++ Use the C<[order code=item page=page_name] Order it! </aE<gt>> form of
order tag to specify an arbitrary order page for an item.
+ If already on an order page, set the mv_orderpage,
mv_nextpage, mv_successpage, or mv_failpage variables.
@@ -385,7 +385,7 @@
One shopping cart -- main, by name -- is defined when the user session
starts. If the user orders item M1212 with the following tag:
-> [order code=M1212 cart=layaway] Order this item! [/order]
+> [order code=M1212 cart=layaway] Order this item! </a>
the order will be placed in the cart named I<layaway>. However, by default
you won't see the just-ordered item on the basket page. That is because
@@ -394,7 +394,7 @@
to a new file, insert a C<[cart layaway]> tag, and specify it as the target
page in your C<[order]> tag:
-> [order code=M1212 cart=layaway page=ord/lay_basket] Order this item! [/order]
+> [order code=M1212 cart=layaway page=ord/lay_basket] Order this item! </a>
Now the contents of the I<layaway> cart will be displayed. Most of the ITL
tags that are fundamental to cart display accept a 'cartname' option,
1.15 +6 -6 docs/iccattut.sdf
rev 1.15, prev_rev 1.14
Index: iccattut.sdf
===================================================================
RCS file: /var/cvs/docs/iccattut.sdf,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -u -r1.14 -r1.15
--- iccattut.sdf 12 Apr 2002 22:53:18 -0000 1.14
+++ iccattut.sdf 6 Jun 2002 02:01:51 -0000 1.15
@@ -1,13 +1,13 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: iccattut.sdf,v 1.14 2002/04/12 22:53:18 jon Exp $
+# $Id: iccattut.sdf,v 1.15 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Catalog-Building Tutorial"
!define DOC_TYPE ""
!define DOC_CODE "iccattut"
-!define DOC_VERSION substr('$Revision: 1.14 $', 11, -2)
+!define DOC_VERSION substr('$Revision: 1.15 $', 11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
-!define DOC_URL "http://interchange.redhat.com/doc/icadvanced.html"
+!define DOC_URL "http://interchange.redhat.com/doc/iccattut.html"
!define DOC_OWNER "2000-2002 Red Hat, Inc. E<lt>{{EMAIL:interchange@redhat.com}}E<gt>"
!build_title
@@ -436,14 +436,14 @@
H2:A link for ordering
-N:Now that you have your products available, let's add a shopping cart so customers can purchase them. This is created using the [order] [/order] tags. These tags create an HTML link that causes the specified item to be ordered and transfers the shopper to the basket page. This is a built-in shortcut to the complete order process which uses an HTML form submission process. The parameter for the [order] tag is the product ID. To add these tags to the catalog, make the following change to {{FILE:pages/index.html}}:
+N:Now that you have your products available, let's add a shopping cart so customers can purchase them. This is created using the [order] tag. These tags create an HTML link that causes the specified item to be ordered and transfers the shopper to the basket page. This is a built-in shortcut to the complete order process which uses an HTML form submission process. The parameter for the [order] tag is the product ID. To add these tags to the catalog, make the following change to {{FILE:pages/index.html}}:
!block example;
<tr>
<td>[loop-code]</td>
<td>[loop-field description]</td>
<td align=right>[loop-field price]</td>
-+ <td>[order [loop-code]]Order Now[/order]</td>
++ <td>[order [loop-code]]Order Now</a></td>
</tr>
[/loop]
!endblock
@@ -989,7 +989,7 @@
<td>[item-code]</td>
<td><a href="[item-code].html">[item-field description]</a></td>
<td align=right>[item-field price]</td>
- <td>[order [item-code]]order now[/order]</td>
+ <td>[order [item-code]]order now</a></td>
</tr>
[/search-list]
[on-match]
1.63 +4 -4 docs/icconfig.sdf
rev 1.63, prev_rev 1.62
Index: icconfig.sdf
===================================================================
RCS file: /var/cvs/docs/icconfig.sdf,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -u -r1.62 -r1.63
--- icconfig.sdf 29 May 2002 09:26:46 -0000 1.62
+++ icconfig.sdf 6 Jun 2002 02:01:51 -0000 1.63
@@ -1,13 +1,13 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: icconfig.sdf,v 1.62 2002/05/29 09:26:46 racke Exp $
+# $Id: icconfig.sdf,v 1.63 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Configuration Reference"
!define DOC_TYPE ""
!define DOC_CODE "icconfig"
-!define DOC_VERSION substr('$Revision: 1.62 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.63 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
-!define DOC_URL "http://interchange.redhat.com/doc/icadvanced.html"
+!define DOC_URL "http://interchange.redhat.com/doc/icconfig.html"
!build_title
H1: Interchange Configuration Files
@@ -2045,7 +2045,7 @@
or with mp=profile in the one-click search.
!block example
- [page scan se=Renaissance/mp=dict_search]Renaissance Art[/page]
+ [page scan se=Renaissance/mp=dict_search]Renaissance Art</a>
!endblock
Multiple profiles can reside in the same file, if separated by C<__END__> tokens. C<__NAME__> tokens should be left-aligned, and C<__END__> must be on a line by itself with no leading or trailing whitespace.
1.41 +15 -15 docs/icdatabase.sdf
rev 1.41, prev_rev 1.40
Index: icdatabase.sdf
===================================================================
RCS file: /var/cvs/docs/icdatabase.sdf,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -u -r1.40 -r1.41
--- icdatabase.sdf 15 Apr 2002 16:13:20 -0000 1.40
+++ icdatabase.sdf 6 Jun 2002 02:01:51 -0000 1.41
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: icdatabase.sdf,v 1.40 2002/04/15 16:13:20 jon Exp $
+# $Id: icdatabase.sdf,v 1.41 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Interchange Databases"
!define DOC_TYPE ""
!define DOC_CODE "icdatabase"
-!define DOC_VERSION substr('$Revision: 1.40 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.41 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/icdatabase.html"
@@ -811,7 +811,7 @@
The same search for a fixed string, say "shirt," could be performed with the use of a hot link, using the special scan URL:
!block example
- [page search="se=shirt"]See our shirt collection![/page]
+ [page search="se=shirt"]See our shirt collection!</a>
!endblock
The default is to search every field on the line. To match on the string "shirt" in the product database field "description," modify the search:
@@ -826,7 +826,7 @@
[page search="
se=shirt
sf=category
- "]See our shirt collection![/page]
+ "]See our shirt collection!</a>
!endblock
To let the user decide on the search parameters, use checkboxes or radiobox fields to set the fields:
@@ -1063,7 +1063,7 @@
se=[value title]
" ]
Search for [value artist], [value title]
- [/page]
+ </a>
[page search="
co=yes
@@ -1073,7 +1073,7 @@
" ]
Search for [value searchstring]
in [value column]
- [/page]
+ </a>
!endblock
H2: Range Searching
@@ -1117,7 +1117,7 @@
sf=category
"]
Impressionist Paintings
- [/page]
+ </a>
!endblock
This is the same:
@@ -1125,7 +1125,7 @@
!block example
[page scan se=Impressionists/sf=category]
Impressionist Paintings
- [/page]
+ </a>
!endblock
Here is the same thing from a home page (assuming /cgi-bin/vlink is the CGI path for Interchange's vlink):
@@ -1227,7 +1227,7 @@
!block example; listitem=2
[page scan se=Surreal/se=Gogh/os=yes/su=yes/sf=artist/sf=category]
Van Gogh -- compare to surrealists
- [/page]
+ </a>
!endblock
.In this method of specification, to replace a / (slash) in a file name (for the sp, bd, or fi parameter), the shorthand of :: must be used, i.e., sp=results::standard. (This may not work for some browsers, so put the page in the main pages directory or define the page in a search profile.)
@@ -1244,7 +1244,7 @@
su=yes
sf=artist
sf=category
- ] Van Gogh -- compare to surrealists [/page]
+ ] Van Gogh -- compare to surrealists </a>
!endblock
.Any "unsafe" characters will be escaped. To search for trailing spaces (unlikely), quote.
@@ -1256,7 +1256,7 @@
!block example; listitem=2
[page href=scan se="Van Gogh"&sp=lists/surreal&os=yes&su=yes&sf=artist&sf=category]
Van Gogh -- compare to surrealists
- [/page]
+ </a>
!endblock
.Any "unsafe" characters will be escaped.
@@ -1270,7 +1270,7 @@
arg="se=Renaissance
se=Impressionists
va=category_name=Renaissance and Impressionist Paintings
- os=yes"]Renaissance and Impressionist Paintings[/page]
+ os=yes"]Renaissance and Impressionist Paintings</a>
!endblock
Display the appropriate category on the search results page with C<[value category_name]>.
@@ -1364,7 +1364,7 @@
In a one-click search, use the C<mp> modifier:
!block example
-[page scan se=Leonardo/mp=artist_profile]A left-handed artist[/page]
+[page scan se=Leonardo/mp=artist_profile]A left-handed artist</a>
!endblock
They can also be placed in a file. Define the file name in the C<SearchProfile> directive. The catalog must be reconfigured for Interchange to read it. The profile is named by placing a name following a __NAME__ pragma:
@@ -2962,7 +2962,7 @@
function=check_acl
location=cartcfg/editcart]"
]
- [page cartcfg/editcart]Edit your cart configuration[/page]
+ [page cartcfg/editcart]Edit your cart configuration</a>
[/if]
!endblock
@@ -3002,7 +3002,7 @@
location=inventory]"
]
[userdb function=set_acl location=cartcfg/edit_inventory]
- [page cartcfg/edit_inventory]You may edit the inventory database[/page]
+ [page cartcfg/edit_inventory]You may edit the inventory database</a>
[else]
[userdb function=set_acl location=cartcfg/edit_inventory delete=1]
Sorry, you can't edit inventory.
1.10 +3 -3 docs/icfaq.sdf
rev 1.10, prev_rev 1.9
Index: icfaq.sdf
===================================================================
RCS file: /var/cvs/docs/icfaq.sdf,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -u -r1.9 -r1.10
--- icfaq.sdf 27 Apr 2002 12:57:26 -0000 1.9
+++ icfaq.sdf 6 Jun 2002 02:01:51 -0000 1.10
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: icfaq.sdf,v 1.9 2002/04/27 12:57:26 kwalsh Exp $
+# $Id: icfaq.sdf,v 1.10 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Frequently Asked Questions"
!define DOC_TYPE ""
!define DOC_CODE "icfaq"
-!define DOC_VERSION substr('$Revision: 1.9 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.10 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/icfaq.html"
@@ -1452,7 +1452,7 @@
[benchmark]
<P>
- [page @@MV_PAGE@@]Again[/page]
+ [page @@MV_PAGE@@]Again</a>
---- end test ---
!endblock
1.4 +1 -311 docs/ictags-more.txt
rev 1.4, prev_rev 1.3
Index: ictags-more.txt
===================================================================
RCS file: /var/cvs/docs/ictags-more.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -u -r1.3 -r1.4
--- ictags-more.txt 21 Aug 2001 15:11:17 -0000 1.3
+++ ictags-more.txt 6 Jun 2002 02:01:51 -0000 1.4
@@ -1,4 +1,4 @@
-To include in ictags:
+To rework and include in ictags:
------------------------------------------------------------------------------
@@ -38,46 +38,8 @@
------------------------------------------------------------------------------
-H2: Basic Interchange Tags
-
-Note: In the descriptions that follow, parameters marked with an asterisk (*) are optional. When a tag is separated by an underscore, as in C<item_list>, a dash is just as appropriate (i.e., C<item-list>). They are interchangeable, except that the ending tag and beginning tag should match (don't use C<[item-list] list [/item_list]>). B<*> I<indicates an optional argument>
-
-H2: Inserting Hyperlinks
-
-.Named parameters: [area href="dir/page" secure=1* arg="argument"* form="form string"*]
-
-.Positional parameters: [area pg arg*]
-
-.Produces the URL to call an Interchange page, without the surrounding C<A HREF> notation. This can be used to get control of HREF items, perhaps to place an ALT string or a JavaScript construct. It was originally named C<area> because it also can be used in a client-side image map.
-
-!block example; listitem=2
- <A HREF="[area catalog]" ALT="Main catalog page">
-!endblock
-
-.The optional arg is used just as in the page tag.
-
-.The optional C<form> argument is used to encode a form in the link.
-
-!block example; listitem=2
- <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>
-!endblock
-
-.See above for more information.
-
LI1: [page ...]
-.Named parameters: {{EX:[page href="dir/page" arg="argument" secure=1* form="form string"]}}
-
-.Positional parameters: {{EX:[page dir/page arg*] (only two positional parameters)}}
-
-.Insert a hyperlink to the specified catalog page pg. For example, [page shirts] will expand into <a href="http://machine.company.com/cgi-bin/vlink/shirts?id=WehUkATn&pc=33">. The catalog page displayed will come from "shirts.html" in the pages directory.
-
.If the user has sent a cookie to Interchange (meaning the second page they access), and the scratch value C<mv_no_session_id> is set in their session, the session ID will not be appended to the URL. If the scratch value C<mv_no_count> is set, then the page count will not be appended. This is not dependent on cookies. So, if placed in the initial page:
!block example; listitem=2
@@ -100,102 +62,6 @@
.A bit of magic occurs if Interchange has built a static plain HTML page for the target page. Instead of generating a normal Interchange-parsed page reference, a static page reference will be inserted if the user has accepted and sent back a cookie with the session ID.
-.The optional C<form> argument allows for encoding a form in the link.
-
-!block example; listitem=2
- [page 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>
-!endblock
-
-.The two form values C<mv_session_id> and C<mv_arg> are automatically added
-when appropriate. (mv_arg is the C<arg> parameter for the tag.)
-
-.If the parameter C<href> is not supplied, process is used, causing normal Interchange form processing. If the C<href> points to an http://link no Interchange URL processing will be done, but the C<mv_session_id>. This would generate a form that ordered item number 99-102 on a separate line (C<mv_separate_items> being set), with size C<L>, in quantity 2. Since the page is not set, the user will go to the default shopping cart page.
-
-.At the same time, C<mv_orderpage=yourpage> could be set to go to C<yourpage>. Theoretically, any form can be submitted with this, though none of the included values can have newlines or trailing whitespace. To do so requires the writing of a UserTag. Foreign forms can also be submitted, but they will not touch the href if it begins with http:, ftp:, or the like.
-
-LI1: [/page], [/order]
-
-.Expands into </a>. Used with the page element, such as:
-
-!block example; listitem=2
- [page shirts]Our shirt collection[/page].
-!endblock
-
-.\TIP: A small efficiency boost is to just use the </A> tag.
-
-H2: How to Order an Item
-
-Interchange can either use a form-based order or a link-based order to place an item in the shopping cart. The link-based order uses the special C<[order item-code]> tag:
-
-LI1: [order code]
-.Named parameters:
-
-!block example; listitem=2
- C<[order code="sku" href="page" cart="cartname"* base="table"]>
-!endblock
-
-.Expands into a hypertext link which will include the specified code in the list of products to order and display the order page. C<Code> should be a product SKU listed in one of the "products" tables. The optional argument C<cart/page> selects the shopping cart where the item will be placed (begin with / to use the default cart C<main>) and the order page that will display the order. The optional argument base constrains the order to a particular products file. If not specified, all tables defined as products files will be searched in sequence for the item.
-
-.Example:
-
-!block example; listitem=2
-Order a [order TK112]Toaster[/order] today.
-!endblock
-
-.Note that this is the same as:
-
-!block example; listitem=2
-Order a [page order TK112]Toaster</A> today.
-!endblock
-
-.You can change frames for the order with:
-
-!block example; listitem=2
-Order a <A HREF="[area order TK112]" TARGET=newframe>Toaster</A> today.
-!endblock
-
-LI1: [/order]
-
-.Expands into </a>. Used with the order element, such as: Buy a C<[order TK112]>ToasterC<[/order]> today.
-
-To order with a form, you set the form variable C<mv_order_item> to the item-code/SKU and use the C<refresh> action:
-
-!block example; listitem=2
-<FORM ACTION="[process-target]" METHOD=POST>
-<INPUT TYPE=hidden NAME="mv_todo" VALUE="refresh">
-<INPUT TYPE=hidden NAME="mv_order_item" VALUE="TK112">
-
-Order <INPUT NAME="mv_order_quantity" SIZE=3 VALUE=1> toaster
-
-<INPUT TYPE=submit VALUE="Order!">
-</FORM>
-!endblock
-
-Groups of items may be batched:
-
-!block example; listitem=2
-<FORM ACTION="[process-target]" METHOD=POST>
-<INPUT TYPE=hidden NAME="mv_todo" VALUE="refresh">
-
-<INPUT TYPE=hidden NAME="mv_order_item" VALUE="TK112">
-<INPUT NAME="mv_order_quantity" SIZE=3> Standard Toaster
-
-<INPUT TYPE=hidden NAME="mv_order_item" VALUE="TK200">
-<INPUT NAME="mv_order_quantity" SIZE=3> Super Toaster
-
-<INPUT TYPE=submit VALUE="Order!">
-</FORM>
-!endblock
-
-Items that have a quantity of zero (or blank) will be skipped. Only items with a positive quantity will be placed in the basket.
-
-Attributes like size or color may be specified at time of order. Order the T-shirt from the more details page of the C<simple> demo to see how it is done.
-
H2: Accessing Form Values
When a form is sent to Interchange, the program reads the values and places them in the user session. The following form:
@@ -230,36 +96,10 @@
Date: Wed, 11 Oct 2000 08:10:02 -0400
From: Mike Heins <mikeh@minivend.com>
-Reply-To: mike@minivend.com
To: alison@akopia.com, tech@akopia.com
Subject: Re: Tag reference issues...
Quoting Jeff Barr Akopia" (barr@akopia.com):
-> Hi Alison,
->
-> I did a bunch of reviewing of the tag lists found
-> in various places. Here is some info. Let's get
-> what we can in for 4.6 and the rest we can get
-> the next time. I've written these myself. Mike,
-> can you verify for me?
->
-> 1. Try and Catch Tags
-> [try] ... [/try]
-> [catch] ... [/catch]
-> These four tags are used together. The tags within
-> the [try] block are executed. If all of the code
-> within the block executes without error then the
-> output produced by the tags is passed through to
-> the output. Otherwise, this output is discarded
-> and the output produced by the tags within the
-> [catch] block is inserted into the output. If
-> the code within the [try] block has side effects
-> then these effects must be explicitly reversed
-> by the catch block if the operation fails.
->
-
-This looks good. Another key thing is that this will avoid any 500 server
-error if code does a die().
> 2. "-" / "_" in tag names. Let's standardize on
> "-" and note that "_" is a worthy alternative.
@@ -299,25 +139,11 @@
as above, but it is not deprecated.
-> - [search] is deprecated.
-
-Search is not deprecated, but is completely removed.
-
> - [sql] is deprecated.
Yes. No mention need be made of it in the docs.
>
-> 5. Expected documentation - According to Mike you should have info on
-> the following tags:
->
-> [scratchd]
-> [seti]
-> [tmp]
-
-Should have come in the redline comments.
-
->
> 6. [tag time] should be changed to [time].
Yes, but we need to document the options.
@@ -337,13 +163,6 @@
of a mess, and I would hope that we fix this for 4.7.
>
-> 8. Log Tag
->
-> This tag is documented as [tag log]; it should be changed to [log].
-
-Yes. The options should be the same, but it needs to be checked.
-
->
> 9. Filter Tag
>
> Longer-term, we need to have a complete document which describes
@@ -357,132 +176,3 @@
Yes, those shipmodes defined in mv_handling.
->
-> 11. Counter and FCounter
->
-> [counter file=FILE start=START value=VALUE decrement*]
->
-> Inserts the value of a persistent counter. The counter value is
-> stored in the given file, which is created if necessary. If the
-> file name begins with a "/" then it is an absolute path, otherwise
-> it is relative to VendRoot. If the tag causes the counter file to
-> be created then the value is initialized to start. If value is
-> given then the counter's value is set to the given value. If value
-> is not supplied then the counter is incremented and its value
-> returned, unless decrement is supplied, in which case the counter
-> is decremented and its value is returned. The counter is
-> implemented using Perl's File::Counter module which protects the
-> file against simultaneous access by multiple processes.
->
-> [fcounter file=FILE start=START]
->
-> Fcounter is a simpler version of [counter], implemented as a
-> UserTag on top of Perl's File::Counter module.
->
-
-Yes. We don't need to document fcounter, it is no longer in any of the
-demos.
-
-> 12. The export tag.
->
-> This tag is documented as [tag export]; it should be changed to
-> [export].
->
-
-Yes. Options are the same.
-
---
-Akopia, Inc., 131 Willow Lane, Floor 2, Oxford, OH 45056
-phone +1.513.523.7621 fax 7501 <heins@akopia.com>
-
-Research is what I'm doing when I don't know what I'm doing.
--- Wernher Von Braun
-
-
-
-Date: Mon, 9 Oct 2000 19:02:52 -0700
-From: "Jeff Barr (Akopia)" <barr@akopia.com>
-To: tech@akopia.com
-Subject: Bringing Order to the Tag List
-
-I've tried to rationalize the various sources of information about
-tags. My three sources are:
-
-1. The code, 4.5.7, as taken from CVS on the morning of October 9th.
- Specifically the Interpolate.pm and Parse.pm files.
-
-2. The tag list from Alison. There is a section titled "INTERCHANGE
- TAGS"; this was part of a document that Mike reviewed last
- week. This list is identical to that found in mvdocs.pod and
- may have originated there.
-
-3. The Tag Reference on developer.akopia.com.
-
-The goal is to end up with a consistent list of tags in all three
-places. (Ultimately of course it would be good to drive all of
-the lists from one place).
-
-Here is what I found:
-
-1. [try] and [catch] are in the tag reference but not the other
- places.
-
-2. Note that the "_" and "-" characters are interchangeable in a tag
- name as long as the same delimiter is used within a matching pair
- of tags. Nevertheless, the tag reference should consistently use
- one and note that the other is available. (This is a note that I
- will pass on to Alison for her information).
-
-3. [discount_subtotal] is not documented. DONE
-
-4. [PREFIX-calc] is not documented. DONE
-
-5. [region] is now [search-region] ; [region] is still accepted.
-
-6. [on_match] is not documented. DONE
-
-7. [search] in on the Tag Reference but nowhere else.
-
-8. [scratch] and [scratchd] are not documented.
-
-9. [tmp] is not documented.
-
-10. [seti] is not documented. It appears to be a synonym for [set].
-
-11. [time] is in the Tag Reference but nowhere else.
-
-12. [fly_tax] is on the Tag Reference but nowhere else.
-
-13. [harness] is in the Tag Reference. It is apparently part of the test
- harness. Perhaps this should not be enabled in shipped code.
-
-14. [log] is on the Tag Reference but nowhere else.
-
-15. Mike scratched [onfly] out of the latest tag reference but it is
- still in the code. Is it deprecated?
-
-16. [filter] is on the Tag Reference but nowhere else.
-
-17. [handling] is on the Tag Reference but nowhere else.
-
-18. [sql] is on the Tag Reference but nowhere else. REMOVED
-
-19. [counter] and [fcounter] are not documented.
-
-20. [export] is on the Tag Reference but nowhere else.
-
-Anything that anyone can add/subtract/clarify within here will
-be greatly appreciated!
-
-Thanks,
-
-Jeff;
-
-
-
----------------------
-
-16:36:48 GlassBanjo: I also notice that I forgot to remove the depreciated [region] tag from ictags.
-16:37:37 GlassBanjo: If you wish, you could remove it and update CVS
-16:38:24 GlassBanjo: It's a complex tag and best not to have our generous contributors waste their time on it.
-16:39:19 GlassBanjo: Note that search region is still relevant, still complicated, and similar to the [query] tag docs
1.83 +60 -21 docs/ictags.sdf
rev 1.83, prev_rev 1.82
Index: ictags.sdf
===================================================================
RCS file: /var/cvs/docs/ictags.sdf,v
retrieving revision 1.82
retrieving revision 1.83
diff -u -u -r1.82 -r1.83
--- ictags.sdf 3 Jun 2002 18:13:36 -0000 1.82
+++ ictags.sdf 6 Jun 2002 02:01:51 -0000 1.83
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ictags.sdf,v 1.82 2002/06/03 18:13:36 kwalsh Exp $
+# $Id: ictags.sdf,v 1.83 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Interchange Tags Reference"
!define DOC_TYPE ""
!define DOC_CODE "ictags"
-!define DOC_VERSION substr('$Revision: 1.82 $', 11, -2)
+!define DOC_VERSION substr('$Revision: 1.83 $', 11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ictags.html"
@@ -1943,7 +1943,7 @@
including the Interchange session ID and supplied arguments. This is
very similar to the {{CMD[jump="#page"]page}} tagE<nbspace>E<emdash> these are
equivalent:
-> [page href=dir/page arg=mv_arg]TargetName[/page]
+> [page href=dir/page arg=mv_arg]TargetName</A>
> <A HREF="[area href=dir/page arg=mv_arg]">TargetName</A>
@@ -5042,7 +5042,7 @@
!block example
[export table]
---
- TODO: (tag result)
+ 1
!endblock
@@ -6032,8 +6032,8 @@
in a file named C<flypage2.html>, it will make these two calls
display identical pages:
-> [page 00-0011] One way to display the Mona Lisa [/page]
-> [page flypage2 00-0011] Another way to display the Mona Lisa [/page]
+> [page 00-0011] One way to display the Mona Lisa </a>
+> [page flypage2 00-0011] Another way to display the Mona Lisa </a>
If you place a [fly-list] tag alone at the top of the page, it will
cause any page to act as a flypage.
@@ -9013,7 +9013,7 @@
H3: Summary
!block example;
- [B<order> code quantity]I<Link Text>E<lbracket>/order]
+ [B<order> code quantity]I<Link Text>E<lt>/A>
[B<order> code=[[EXAMPLE_SKU]] quantity=2]I<Link Text>E<lt>/A>
!endblock
@@ -9028,6 +9028,11 @@
!block table; colvaligns="TT"
Attributes|Default
+code|I<No>
+page|I<SpecialPage order>
+cart|I<main cart>
+base|I<ProductFiles array>
+area|I<off>
{{CMD[jump="#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
@@ -9060,8 +9065,18 @@
Expands into a hypertext link which will include the specified
-code in the list of products to order and display the order page. B<code>
-should be a product code listed in one of the "products" databases.
+code in the list of products to order and display the order page.
+
+B<code> should be a product code listed in one of the "products"
+databases. The optional argument B<base> constrains the order to
+a particular products file. If not specified, all tables defined as
+ProductFiles will be searched in sequence for the item.
+
+The optional argument B<cart> selects the shopping cart where the item
+will be placed.
+
+B<page> allows you to specify a different order page than the default
+one specified by SpecialPage order.
H3: How to Order an Item
@@ -9081,6 +9096,13 @@
TARGET=newframe> Order [[EXAMPLE_DESCRIPTION]]</A>
!endblock
+This can also be done more easily with the C<area> option to the C<order> tag:
+
+!block example
+ <A HREF="[order code=[[EXAMPLE_SKU]] quantity=2 area=1]"
+ TARGET=newframe> Order [[EXAMPLE_DESCRIPTION]]</A>
+!endblock
+
To order with a form, you set the form variable C<mv_order_item> to
the item-code/SKU and use the C<refresh> N<action:>
@@ -9128,7 +9150,7 @@
If you do not want the E<lt>AE<nbspace>HREFE<nbspace>...E<gt>, use the
{{CMD[jump="#area"]area}} tag insteadE<nbspace>E<emdash> these are
equivalent:
-> [page href=dir/page arg=mv_arg]TargetName[/page]
+> [page href=dir/page arg=mv_arg]TargetName</A>
> <A HREF="[area href=dir/page arg=mv_arg]">TargetName</A>
@@ -9316,7 +9338,7 @@
se=Impressionists
sf=category]
Impressionist Paintings
- [/page]
+ </a>
[page href=scan
arg="se=Impressionists
@@ -9327,7 +9349,7 @@
[page search="se=Impressionists
sf=category"]
Impressionist Paintings
- [/page]
+ </a>
!endblock
@@ -9378,7 +9400,7 @@
> [page scan se=Surreal/se=Gogh/os=yes/su=yes/sf=artist/sf=category]
> Van Gogh -- compare to surrealists
-> [/page]
+> </a>
In this method of specification, to replace a / (slash) in a file name
(for the sp, bd, or fi parameter) you must use the shorthand of ::,
@@ -9393,7 +9415,7 @@
> [page scan se="Van Gogh"&sp=lists/surreal&os=yes&su=yes&sf=artist&sf=category]
> Van Gogh -- compare to surrealists
-> [/page]
+> </a>
Any "unsafe" characters will be escaped.
@@ -9408,7 +9430,7 @@
> su=yes
> sf=artist
> sf=category
-> ] Van Gogh -- compare to surrealists [/page]
+> ] Van Gogh -- compare to surrealists </a>
Any "unsafe" characters will be escaped. You may not search for trailing
spaces in this method; it is allowed in the other notations.
@@ -11703,7 +11725,7 @@
# BEGIN ############### seti Summary Tables ####################
!block example;
- [B<seti> name]
+ [B<seti> name]value[/seti]
!endblock
!block table; colvaligns="TTT"; format="262"
@@ -11728,6 +11750,14 @@
!endblock
+B<Tag expansion example:>
+
+!block example
+ [seti name]value[/seti]
+---
+
+!endblock
+
B<ASP-like Perl call:>
!block example; lang="Perl"
@@ -13088,7 +13118,7 @@
# BEGIN ############### tmp Summary Tables ####################
!block example;
- [B<tmp> name]
+ [B<tmp> name]value[/tmp]
!endblock
!block table; colvaligns="TTT"; format="262"
@@ -13113,6 +13143,18 @@
!endblock
+<<<<<<< ictags.sdf
+B<Tag expansion example:>
+
+!block example
+ [tmp name]value[/tmp]
+---
+
+!endblock
+
+
+=======
+>>>>>>> 1.82
B<ASP-like Perl call:>
!block example; lang="Perl"
@@ -13721,7 +13763,7 @@
H2: try
-Allows you to trap errors. Interchange processes the body text of the E<lbracket>C<try>]E<lbracket>C</try>] block and returns it normally if it does not generate an error. If it does generate an error, interchange executes the E<lbracket>C<catch>]E<lbracket>C</catch>] block.
+Allows you to trap errors. Interchange processes the body text of the E<lbracket>C<try>]E<lbracket>C</try>] block and returns it normally if it does not generate an error. If it does generate an error, Interchange executes the E<lbracket>C<catch>]E<lbracket>C</catch>] block.
See also '{{C[jump="#catch"]catch}}'.
@@ -15191,9 +15233,6 @@
Will send the content between the E<lbracket>email_raw][/email_raw]
tags as a raw email message to the recipient specified in the supplied
headers using the SendmailProgram with -t option.
-
-
-H2: fcounter
H2: fedex_query
1.38 +4 -4 docs/ictemplates.sdf
rev 1.38, prev_rev 1.37
Index: ictemplates.sdf
===================================================================
RCS file: /var/cvs/docs/ictemplates.sdf,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -u -r1.37 -r1.38
--- ictemplates.sdf 3 May 2002 21:59:25 -0000 1.37
+++ ictemplates.sdf 6 Jun 2002 02:01:51 -0000 1.38
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ictemplates.sdf,v 1.37 2002/05/03 21:59:25 racke Exp $
+# $Id: ictemplates.sdf,v 1.38 2002/06/06 02:01:51 jon Exp $
!define DOC_NAME "Template Guide"
!define DOC_TYPE ""
!define DOC_CODE "ictemplates"
-!define DOC_VERSION substr('$Revision: 1.37 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.38 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ictemplates.html"
@@ -2188,8 +2188,8 @@
.If placed around the contents of the demo flypage, in a file named <flypage2.html>, it will make these two calls display identical pages:
!block example; listitem=2
- [page 00-0011] One way to display the Mona Lisa [/page]
- [page flypage2 00-0011] Another way to display the Mona Lisa [/page]
+ [page 00-0011] One way to display the Mona Lisa </a>
+ [page flypage2 00-0011] Another way to display the Mona Lisa </a>
!endblock
If the directive PageSelectField is set to a valid product database field which contains a valid Interchange page name (relative to the catalog pages directory, without the .html suffix), it will be used to build the on-the-fly page.