[docs] docs - kwalsh modified ictags.sdf
docs@interchange.redhat.com
docs@interchange.redhat.com
Wed Jul 31 08:15:01 2002
User: kwalsh
Date: 2002-07-31 12:14:44 GMT
Modified: . ictags.sdf
Log:
* Lots of extra SDF jumps to create extra tag cross-reference
links. I got as far as section 4.6 ([banner]) and will do
the rest some other time.
* Fixed a bunch of broken links.
* Lots of small format changes to try to maintain a consistent
layout throughout the document.
Revision Changes Path
1.95 +747 -751 docs/ictags.sdf
rev 1.95, prev_rev 1.94
Index: ictags.sdf
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /var/cvs/docs/ictags.sdf,v
retrieving revision 1.94
retrieving revision 1.95
diff -u -r1.94 -r1.95
--- ictags.sdf 27 Jul 2002 00:48:10 -0000 1.94
+++ ictags.sdf 31 Jul 2002 12:14:41 -0000 1.95
@@ -1,10 +1,10 @@
!init OPT_LOOK=3D"akopia"; OPT_STYLE=3D"manual"=20
-# $Id: ictags.sdf,v 1.94 2002/07/27 00:48:10 kwalsh Exp $
+# $Id: ictags.sdf,v 1.95 2002/07/31 12:14:41 kwalsh Exp $
=20
!define DOC_NAME "Interchange Tags Reference"
!define DOC_TYPE ""
!define DOC_CODE "ictags"
-!define DOC_VERSION substr('$Revision: 1.94 $', 11, -2)
+!define DOC_VERSION substr('$Revision: 1.95 $', 11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ictags.html"
@@ -86,8 +86,8 @@
between the left bracket ('[') and the tagname.
=20
If a tag name includes an underscore or dash, as in
-{{CMD[jump=3D"#item_list"]item_list}}, a dash is just as appropriate
-(i.e. C<item-list>). The two forms are interchangeable, except that an
+E<lbracket>{{CMD[jump=3D"#item-list"]item_list}}], a dash is just as appro=
priate
+(i.e. C<[item-list]>). The two forms are interchangeable, except that an
ending tag must match the tag (i.e., don't use
C<E<lbracket>item-list]E<nbspace>listE<nbspace>[/item_list]>).
=20
@@ -190,7 +190,7 @@
=20
H3: {{CMD[id=3D"attr_interpolate"]interpolate}}
=20
-This attribute behaves differently depending on whether the tag is a
+This attribute behaves differently depending upon whether the tag is a
I<container> or I<standalone> tag. A container tag is one which has
an end tag, i.e. C<[tag] stuff [/tag]>. A standalone tag has no end
tag, as in
@@ -374,7 +374,7 @@
=20
{{CMD[id=3D"subtags"]}}Certain tags are not standalone; these are the
ones that are interpreted as part of a surrounding looping tag
-like E<lbracket>{{CMD[jump=3D"#loop"]loop}}], E<lbracket>{{CMD[jump=3D"#it=
em_list"]item-list}}], E<lbracket>{{CMD[jump=3D"#query"]query}}], or E<lbra=
cket>{{CMD[jump=3D"#region"]region}}E<rbracket>.
+like E<lbracket>{{CMD[jump=3D"#loop"]loop}}], E<lbracket>{{CMD[jump=3D"#it=
em-list"]item-list}}], E<lbracket>{{CMD[jump=3D"#query"]query}}], or E<lbra=
cket>{{CMD[jump=3D"#search-region"]search-region}}E<rbracket>.
=20
. E<lbracket>{{CMD[jump=3D"#PREFIX-accessories"]PREFIX-accessories}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-alternate"]PREFIX-alternate}}]
@@ -382,30 +382,30 @@
. E<lbracket>{{CMD[jump=3D"#PREFIX-change"]PREFIX-change}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-code"]PREFIX-code}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-data"]PREFIX-data}}]
-. E<lbracket>{{CMD[jump=3D"#PREFIX-description"]PREFIX-description}}] (Not=
e safe-data and ed( ) escape)
+. E<lbracket>{{CMD[jump=3D"#PREFIX-description"]PREFIX-description}}] (Not=
e C<safe-data> and C<ed()> escape)
. E<lbracket>{{CMD[jump=3D"#PREFIX-discount"]PREFIX-discount}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-discount-subtotal"]PREFIX-discount-subt=
otal}}]
-. E<lbracket>{{CMD[jump=3D"#PREFIX-exec"]PREFIX-exec}}]=20
+. C<[if-PREFIX-exec]>
. E<lbracket>{{CMD[jump=3D"#PREFIX-field"]PREFIX-field}}] (Optimization no=
te-- one query per field if you use this; we optimize around this if only o=
ne products table)=20
-. E<lbracket>{{CMD[jump=3D"#PREFIX-filter"]PREFIX-filter}}] (like filter t=
ag but doesn't interpolate)
+. C<[if-PREFIX-filter]>
. E<lbracket>{{CMD[jump=3D"#PREFIX-increment"]PREFIX-increment}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-last"]PREFIX-last}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-line"]PREFIX-line}}] (tab-delimited lis=
t of parameters returned)
-. E<lbracket>{{CMD[jump=3D"#PREFIX-match"]PREFIX-match}}]
+. C<[if-PREFIX-match]>
. E<lbracket>{{CMD[jump=3D"#PREFIX-modifier"]PREFIX-modifier}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-next"]PREFIX-next}}]
-. E<lbracket>{{CMD[jump=3D"#PREFIX-options"]PREFIX-options}}]
+. C<[if-PREFIX-options]>
. E<lbracket>{{CMD[jump=3D"#PREFIX-param"]PREFIX-param}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-pos"]PREFIX-pos}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-price"]PREFIX-price}}]
. E<lbracket>{{CMD[jump=3D"#PREFIX-quantity"]PREFIX-quantity}}]
-. E<lbracket>{{CMD[jump=3D"#PREFIX-sub"]PREFIX-sub}}]
+. C<[if-PREFIX-sub]>
. E<lbracket>{{CMD[jump=3D"#PREFIX-subtotal"]PREFIX-subtotal}}]
. E<lbracket>{{CMD[jump=3D"#if-PREFIX-data"]if-PREFIX-data}}]
. E<lbracket>{{CMD[jump=3D"#if-PREFIX-field"]if-PREFIX-field}}]
-. E<lbracket>{{CMD[jump=3D"#if-PREFIX-modifier"]if-PREFIX-modifier}}] (has=
h list only)
-. E<lbracket>{{CMD[jump=3D"#if-PREFIX-param"]if-PREFIX-param}}]
-. E<lbracket>if-I<prefix>-{{CMD[jump=3D"#if_prefix_pos"]pos}}]
+. C<[if-PREFIX-modifier]> (hash list only)
+. C<[if-PREFIX-param]>
+. C<[if-PREFIX-pos]>
. E<lbracket>{{CMD[jump=3D"#modifier-name"]modifier-name}}]
. E<lbracket>{{CMD[jump=3D"#quantity-name"]quantity-name}}]
=20
@@ -416,8 +416,8 @@
!block table
Tag|Prefix|Examples
E<lbracket>{{CMD[jump=3D"#loop"]loop}}]|loop|E<lbracket>loop-code], [loop-=
field price], [loop-increment]
-E<lbracket>{{CMD[jump=3D"#item_list"]item-list}}]|item|E<lbracket>item-cod=
e], [item-field price], [item-increment]
-E<lbracket>{{C[jump=3D"#search_list"]search-list}}]|item|E<lbracket>item-c=
ode], [item-field price], [item-increment]
+E<lbracket>{{CMD[jump=3D"#item-list"]item-list}}]|item|E<lbracket>item-cod=
e], [item-field price], [item-increment]
+E<lbracket>{{C[jump=3D"#search-list"]search-list}}]|item|E<lbracket>item-c=
ode], [item-field price], [item-increment]
E<lbracket>{{CMD[jump=3D"#query"]query}}]|sql|E<lbracket>sql-code], [sql-f=
ield price], [sql-increment]
!endblock
=20
@@ -497,17 +497,19 @@
N<list:>
=20
!block example
- [accessories code=3DI<current_item_code> arg=3DI<arglist>]
- [item-accessories I<arglist>]
+ [accessories code=3DI<current_item_code> arg=3DI<arglist>]
+ [item-accessories I<arglist>]
!endblock
=20
-See the {{C[jump=3D"#accessories"]accessories}} tag for more
+See the E<lbracket>{{C[jump=3D"#accessories"]accessories}}] tag for more
detail. Note that you must use the comma-delimited list to set
attributesE<nbspace>E<emdash> you cannot set named attributes with the
usual 'attribute=3Dvalue' syntax.
=20
-If the list is a hash list, i.e. an [item-list], then the value of
-the current item hash is passed so that a value default can be established.
+If the list is a hash list,
+i.e. an E<lbracket>{{C[jump=3D"#item-list"]item-list}}],
+then the value of the current item hash is passed so that a value default
+can be established.
=20
=20
H2: PREFIX-alternate
@@ -527,7 +529,9 @@
=20
E: E<lbracket>PREFIX-calc] 2 + [item-field price] [/PREFIX-calc]
=20
-Executes Perl code in the tag body. This is equivalent to the [calc] [/cal=
c] tag pair, except it's calculated at loop time instead of later when the =
rest of the page is parsed.
+Executes Perl code in the tag body. This is equivalent to the
+E<lbracket>{{C[jump=3D"#calc"]calc}}] ... [/calc] tag pair, except it's
+calculated at loop time instead of later when the rest of the page is pars=
ed.
=20
H2: PREFIX-change
=20
@@ -541,9 +545,10 @@
\[condition] and [/condition] changes its value. This allows indented lists
similar to database reports to be easily formatted. The repeating value
must be a tag interpolated in the search process, such as
-E<lbracket>C<PREFIX-field field>] or E<lbracket>C<PREFIX-data database fie=
ld>]. If you need
-access to ITL tags, you can use [PREFIX-calc] with a $Tag->foo()=20
-call.
+E<lbracket>{{C[jump=3D"#PREFIX-field"]PREFIX-field}}]
+or E<lbracket>{{C[jump=3D"#PREFIX-field"]PREFIX-field}}C< database field>].
+If you need access to ITL tags, you can use
+E<lbracket>{{C[jump=3D"#PREFIX-calc"]PREFIX-calc}}] with a C<$Tag->foo()> =
call.
=20
Of course, this will only work as you expect when the search results
are properly sorted.
@@ -594,17 +599,21 @@
=20
E: E<lbracket>PREFIX-code]
=20
-The key or code of the current loop. In an [item-list] this is always
+The key or code of the current loop.
+In an E<lbracket>{{C[jump=3D"#item-list"]item-list}}] this is always
the product code; in a loop list it is the value of the current argument;
-in a search it is whatever you have defined as the first mv_return_field (=
rf).
+in a search it is whatever you have defined as the first C<mv_return_field>
+(C<rf>).
=20
H2: PREFIX-data
=20
E: E<lbracket>PREFIX-data table field]
=20
Calls the column C<field> in database table C<table> for the current
-E<lbracket>PREFIX-code]. This may or may not be equivalent to E<lbracket>P=
REFIX-field field]
-depending on whether your search table is defined as one of the C<ProductF=
iles>.
+E<lbracket>{{C[jump=3D"#PREFIX-code"]PREFIX-code}}]
+This may or may not be equivalent to
+E<lbracket>{{C[jump=3D"#PREFIX-field"]PREFIX-field}} field]
+depending upon whether your search table is defined as one of the C<Produc=
tFiles>.
=20
H2: PREFIX-description
=20
@@ -624,8 +633,8 @@
=20
The price of the current item is calculated, and the difference between
that price and the list price (quantity one) price is output. This may have
-different behavior than you expect if you set the [discount] [/discount]
-tag along with quantity pricing.
+different behavior than you expect if you set the
+E<lbracket>{{C[jump=3D"#discount"]discount}}] tag along with quantity pric=
ing.
=20
=20
H2: PREFIX-discount-subtotal
@@ -661,7 +670,8 @@
of C<bar>. When it is found, you wish to display the value of C<foo_field>.
Unless C<foo> is in C<ProductFiles> and the code is not present in a previ=
ous
product file, you will get a blank or some value you don't want. What
-you really want is C<[loop-data foo foo_field]>, which specifically=20
+you really want is
+E<lbracket>{{C[jump=3D"#PREFIX-data"]loop-data}}C< foo field>], which spec=
ifically=20
addresses the table C<foo>. See also E<lbracket>{{C[jump=3D"#PREFIX-param"=
]PREFIX-param}}]
and E<lbracket>{{C[jump=3D"#PREFIX-pos"]PREFIX-pos}}].
=20
@@ -671,7 +681,7 @@
E: E<lbracket>PREFIX-increment]
=20
The current count on the list, starting from either 1 in a zero-anchored
-list like E<lbracket>{{C[jump=3D"#loop"]loop}}] or E<lbracket>{{C[jump=3D"=
#item_list"]item-list}}], or from the match count in a
+list like E<lbracket>{{C[jump=3D"#loop"]loop}}] or E<lbracket>{{C[jump=3D"=
#item-list"]item-list}}], or from the match count in a
search list.
=20
If you skip items with E<lbracket>{{C[jump=3D"#PREFIX-last"]PREFIX-last}}]
@@ -703,7 +713,8 @@
=20
E: E<lbracket>PREFIX-modifier attribute]
=20
-If the item is a hash list (i.e. [item-list]), this will return the value
+If the item is a hash list (i.e.
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]), this will return the val=
ue
of the C<attribute>.
=20
H2: PREFIX-next
@@ -723,8 +734,8 @@
the search result, but by setting those parameters you can return
whichever columns you wish.
=20
-In a E<lbracket>query ...] ITL tag you can select multiple return fields w=
ith
-something like:
+In a E<lbracket>{{C[jump=3D"#query"]query}}] ITL tag you can select multip=
le
+return fields with something like:
=20
> [query prefix=3Dprefix sql=3D"select foo, bar from baz where foo=3D'b=
uz'"]
> [prefix-code] [prefix-param foo] [prefix-param bar]
@@ -813,14 +824,16 @@
E: E<lbracket>PREFIX-quantity]
=20
The value of the C<quantity> attribute in a hash list. Most commonly
-used to display the quantity of an item in a shopping cart [item-list].
+used to display the quantity of an item in a shopping cart
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}].
=20
H2: PREFIX-subtotal
=20
E: E<lbracket>PREFIX-subtotal]
=20
-The [PREFIX-quantity] times the [PREFIX-price]. This does take discounts
-into effect.
+The E<lbracket>{{C[jump=3D"#PREFIX-quantity"]PREFIX-quantity}}]
+times the E<lbracket>{{C[jump=3D"#PREFIX-price"]PREFIX-price}}].
+This does take discounts into account.
=20
H2: if-PREFIX-data
=20
@@ -831,10 +844,11 @@
i.e. blank or zero, the C<ELSE text> will be returned to the page.
=20
This is much more efficient than the otherwise equivalent
-C<[if type=3Ddata term=3Dtable::field::[PREFIX-code]]>.
+E<lbracket>{{C[jump=3D"#if"]if}} C<type=3Ddata term=3Dtable::field::>E<lbr=
acket>{{C[jump=3D"#PREFIX-code"]PREFIX-code}}]].
=20
-You cannot place a condition; i.e. [if-PREFIX-data table field eq 'somethi=
ng'].
-Use C<[if type=3Ddata ...]> for that.
+You cannot place a condition;
+i.e. C<[if-PREFIX-data table field eq 'something']>.
+Use E<lbracket>{{C[jump=3D"#if"]if}}C< type=3Ddata> ...] for that.
=20
Careful, a space is not a false value!
=20
@@ -842,7 +856,9 @@
=20
E: E<lbracket>if-PREFIX-field field] IF text [else] ELSE text [/else] [/=
if-PREFIX-field]
=20
-Same as E<lbracket>if-PREFIX-data ...] except uses the same data rules as =
E<lbracket>PREFIX-field].
+Same as E<lbracket>{{C[jump=3D"#if-PREFIX-data"]if-PREFIX-data}} ...]
+except uses the same data rules as
+E<lbracket>{{C[jump=3D"#PREFIX-field"]PREFIX-field}}].
=20
# H2: {{CMD[id=3D"modifier-name"]modifier-name}}
H2: modifier-name
@@ -859,6 +875,10 @@
=20
etc.
=20
+C<[modifier-name] quantity>
+would be the same as
+E<lbracket>{{C[jump=3D"#quantity-name"]quantity-name}}].
+
# H2: {{CMD[id=3D"quantity-name"]quantity-name}}
H2: quantity-name
=20
@@ -870,13 +890,17 @@
> 2. quantity1
> 3. quantity2
=20
-etc. C<[modifier-name quantity]> would be the same as C<[quantity-name]>.
+etc.
+
+E<lbracket>{{C[jump=3D"#modifier-name"]modifier-name}}C< quantity>]
+would be the same as C<[quantity-name]>.
=20
=20
H1: Tags
=20
Each ITL tag is show below. Calling information is defined for the main ta=
g,
-sub-tags are described in C<Sub-tags>.
+sub-tags are described in
+{{CMD[jump=3D"#Looping tags and Sub-tags"]Looping tags and Sub-tags}}.
=20
=20
H2: accessories
@@ -965,7 +989,7 @@
=20
!block example
E<lbracket>accessories os28044 size]
----------------------------------------------------------------
+---
<SELECT NAME=3D"mv_order_size"><OPTION VALUE=3D"10oz">10oz\
<OPTION VALUE=3D"15oz">15oz<OPTION VALUE=3D"20oz">20oz</SELECT>
!endblock
@@ -1015,8 +1039,9 @@
!endblock
=20
You can also set modifier names with the mv_UseModifier
-scratch variableE<nbspace>E<emdash> E<lbracket>{{C[jump=3D"#set"]set}}
-mv_UseModifier]size colorE<lbracket>/set] has the same effect as
+scratch variableE<nbspace>E<emdash>
+E<lbracket>{{C[jump=3D"#set"]set}}E<nbsp>mv_UseModifier] size color
+E<lbracket>/set] has the same effect as
above. This allows multiple options to be set for products. Whichever
one is in effect at order time will be used. Be careful; you cannot
set it more than once on the same page. Setting the
@@ -1024,38 +1049,44 @@
ordered item on a separate line, simplifying attribute handling. The
scratch setting for C<mv_separate_items> has the same effect.
=20
-The modifier value is accessed in the E<lbracket>{{C[jump=3D"#item_list"]i=
tem-list}}] loop with the
-C<[item-param attribute]> tag, and form input fields are placed with the
-C<[modifier-name attribute]> tag. This is similar to the way that quantity
+The modifier value is accessed in the E<lbracket>{{C[jump=3D"#item-list"]i=
tem-list}}] loop with the
+E<lbracket>{{C[jump=3D"#PREFIX-param"]item-param}}C< attribute>]
+tag, and form input fields are placed with the
+E<lbracket>{{C[jump=3D"#modifier-name"]modifier-name}}C< attribute>]
+tag. This is similar to the way that quantity
is handled.
=20
!block note; label=3D"Note: "
You must be sure that no fields in your forms have digits appended to
their names if the variable is the same name as the attribute name you
-select, as the C<[modifier-name size]> variables will be placed in the
+select, as the
+E<lbracket>{{C[jump=3D"#modifier-name"]modifier-name}}C< size>]
+variables will be placed in the
user session as the form variables size0, size1, size2, etc.
!endblock
=20
Interchange will automatically generate the select boxes when the
-E<lbracket>C<accessories>E<nbspace>code=3D[[EXAMPLE_SKU]]E<nbspace>attribu=
te=3Dsize]
-or C<[item-accessories size]> tags are called. They have the syntax:
+E<lbracket>{{C[jump=3D"#accessories"]accessories}}
+C<code=3D>"[[EXAMPLE_SKU]]"E<nbspace>C<attribute=3D>"size"] or
+E<lbracket>{{C[jump=3D"#PREFIX-accessories"]item-accessories}}C< size>]
+tags are called. They have the syntax:
=20
!block example
- [item-accessories attribute, type, column, table, name, outboard, passe=
d]
+ [item-accessories attribute, type, column, table, name, outboard, pass=
ed]
=20
- [accessories code=3Dsku
+ [accessories code=3Dsku
attribute=3Dmodifier
type=3Dselect
column=3Ddb_table_column_name
table=3Ddb_table
name=3Dvarname
outboard=3Dkey
- passed=3D"value=3Dlabel, value2*, value3=3Dlabel 3" ]
+ passed=3D"value=3Dlabel, value2*, value3=3Dlabel 3"]
=20
- [accessories js=3D| onChange=3D"set_description(simple_options, variant=
)"; |
+ [accessories js=3D| onChange=3D"set_description(simple_options, varian=
t)"; |
type=3Dselect
name=3D"[item-param o_group]"
- passed=3D"=3D--choose--,[item-param o_value]" ]
+ passed=3D"=3D--choose--,[item-param o_value]"]
!endblock
=20
!block note; label=3D"Notes: "
@@ -1100,9 +1131,9 @@
If used in an item list, and the user has changed the value, the generated
select box will automatically retain the current value the user has select=
ed.
=20
-The value can then be displayed with E<lbracket>{{C[jump=3D"#item_modifier=
"]item-modifier}} color] on the
+The value can then be displayed with E<lbracket>{{C[jump=3D"#PREFIX-modifi=
er"]item-modifier}} color] on the
order report, order receipt, or any other page containing an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}].=20
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}].=20
=20
H4: Emulating with a loop
=20
@@ -1112,7 +1143,7 @@
display form which shows a selectable size with "sticky" setting and a
price that changes based upon the modifier setting. (Note that this
example would normally be contained within the
-E<lbracket>{{C[jump=3D"#item_list"]item_list}}]C<[/item-list]> pair.)
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]C<[/item-list]> pair.)
=20
!block example
<SELECT NAME=3D"[modifier-name size]">
@@ -1131,21 +1162,21 @@
H4: {{CMD[id=3D"accessories_hash_lists"]Hash Lists}} E<emdash> Technical N=
ote
=20
As a technical note, some of the features of this tag work differently
-depending on whether it was called with an '$item' hash reference, for
+depending upon whether it was called with an '$item' hash reference, for
example, as E<lbracket>C<item-accessories>] within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}].
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}].
=20
In this context, the tag will have access to ancillary data from the
item (including, perhaps, a user's chosen item attribute value). For
example, if building a TEXTAREA widget within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}], the widget will show
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}], the widget will show
the chosen item attribute value. On the other hand, within an array
-list such as a E<lbracket>{{C[jump=3D"#search_list"]search-list}}] in a
-E<lbracket>{{C[jump=3D"#search_region"]search-region}}], the widget
+list such as a E<lbracket>{{C[jump=3D"#search-list"]search-list}}] in a
+E<lbracket>{{C[jump=3D"#search-region"]search-region}}], the widget
would be empty.
=20
If you really know what you're doing, you can pass it the item hash
-reference within a {{C[jump=3D"#perl"]perl}} tag like this:
+reference within a E<lbracket>{{C[jump=3D"#perl"]perl}}] tag like this:
=20
!block example; lang=3D"Perl"
$Tag->accessories( $code,
@@ -1154,8 +1185,8 @@
$item_hashref );
!endblock
=20
-See also {{C[jump=3D"#Looping tags and Sub-tags"]LoopingE<nbspace>tagsE<nb=
space>andE<nbspace>Sub-tags}} for
-information about hash- and array-context in looping tags.
+See also {{C[jump=3D"#Looping tags and Sub-tags"]Looping tags and Sub-tags=
}} for
+information about hash-context and array-context in looping tags.
=20
=20
H4: {{CMD[id=3D"accessories_code"]code}}
@@ -1174,7 +1205,8 @@
B<Deprecated after Interchange 4.6>
=20
This allows you to pass values for some of the more commonly used
-attributes in the manner of the E<lbracket>C<PREFIX-accessories>] tag,
+attributes in the manner of the
+E<lbracket>{{C[jump=3D"#PREFIX-accessories"]item-accessories}}] tag,
as a comma-delimited positional N<list:>
=20
E: B<arg>=3D"attribute, type, column, table, name, outboard, passed"
@@ -1193,9 +1225,12 @@
E: B<arg>=3D"color, radio, , products"
=20
Although you must use such a comma-delimited list to pass attributes
-to the E<lbracket>C<PREFIX-accessories>] tag, please use named
-attributes instead for the E<lbracket>C<accessories>] tag. The
-'C<arg>' attribute is deprecated.
+to the
+E<lbracket>{{C[jump=3D"#PREFIX-accessories"]item-accessories}}] tag,
+please use named
+attributes instead for the
+E<lbracket>{{C[jump=3D"#accessories"]accessories}}] tag.
+The 'C<arg>' attribute is deprecated.
=20
For detail about a specific attribute, please see its subheading below.
=20
@@ -1223,7 +1258,7 @@
display|<<
Shows the label text for *only the selected option* if called in
{{C[jump=3D"#accessories_hash_lists"]Hash List}} context (e.g., within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}]). Ignored otherwise
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]). Ignored otherwise
(i.e., the tag will build the default <SELECT> menu).
>>
show|<<
@@ -1322,7 +1357,7 @@
A textarea with XX columns and YY rows. The textarea will contain the
selected item attribute value if used in
{{C[jump=3D"#accessories_hash_lists"]Hash List}} context (e.g., within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}]).
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]).
=20
If you simply use 'C<type>=3Dtextarea', the size will default to 4 rows
by 40 columns, unless you have set the
@@ -1333,7 +1368,7 @@
A text box with YY width in characters. The HTML tag's VALUE will be
set to the selected item attribute value if used in
{{C[jump=3D"#accessories_hash_lists"]Hash List}} context (e.g., within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}]).
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]).
=20
If you simply use 'C<type>=3Dtext', the width will default to 60, unless
you have set the {{C[jump=3D"#accessories_cols"]cols}} tag attribute.
@@ -1364,19 +1399,19 @@
value|<<
Returns the selected value if called in
{{C[jump=3D"#accessories_hash_lists"]Hash List}} context (e.g., within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}]), or nothing otherwise.
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]), or nothing otherwise.
>>
hidden|<<
Creates a hidden form field. The hidden field's VALUE will be set to
the selected item attribute value if used in
{{C[jump=3D"#accessories_hash_lists"]Hash List}} context (e.g., within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}]).
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]).
>>
password_YY|<<
A password box with YY width in characters. The HTML tag's VALUE will be
set to the selected item attribute value if used in
{{C[jump=3D"#accessories_hash_lists"]Hash List}} context (e.g., within an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}]).
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}]).
=20
If you simply use 'C<type>=3Dpassword', the width will default to 12,
unless you have set the {{C[jump=3D"#accessories_cols"]cols}} tag
@@ -1393,7 +1428,8 @@
C<type>=3D"textarea_6_33_wrap=3Dvirtual" specifies a TEXTAREA widget with
ROWS=3D6, COLS=3D33, and WRAP=3Dvirtual. You should resort to this only wh=
en
you cannot use the named parameters, for example within an
-E<lbracket>C<item-accessories>] tag. Otherwise, use the
+E<lbracket>{{C[jump=3D"#PREFIX-accessories"]item-accessories}}]
+tag. Otherwise, use the
{{C[jump=3D"#accessories_rows"]rows}}=3DI<m> and
{{C[jump=3D"#accessories_cols"]cols}}=3DI<n> tag attributes instead.
=20
@@ -1480,8 +1516,9 @@
in a different table from other item data,
'{{C[jump=3D"#accessories_code"]code}}' should be set to the master key
in this table. See '{{C[jump=3D"#accessories_outboard"]outboard}}') if
-you are using E<lbracket>item-accessoriesE<nbspace>...] and cannot
-specify C<code>=3Dkey.
+you are using
+E<lbracket>{{C[jump=3D"#PREFIX-accessories"]item-accessories}}] and cannot
+specify C<code=3Dkey>.
=20
=20
H4: {{CMD[id=3D"accessories_name"]name}}
@@ -1521,7 +1558,7 @@
!block example
[accessories type=3Dselect
name=3Dcolor
- passed=3D"=3D--select--*, blue=3DBlue, green=3DSea Green" ]
+ passed=3D"=3D--select--*, blue=3DBlue, green=3DSea Green"]
!endblock
=20
This will generate:
@@ -1552,16 +1589,16 @@
=20
For example,
!block example
- [accessories code=3Dos28044
- type=3Dselect
- attribute=3Dsize
- append=3D"Append Me<br>"
- prepend=3D"Prepend Me"]
-------------------------------------------------------
- Prepend Me<SELECT NAME=3D"mv_order_size">\
- <OPTION VALUE=3D"10oz">10oz\
- <OPTION VALUE=3D"15oz">15oz\
- <OPTION VALUE=3D"20oz">20oz</SELECT>B<Append Me><br>
+ [accessories code=3Dos28044
+ type=3Dselect
+ attribute=3Dsize
+ append=3D"Append Me<br>"
+ prepend=3D"Prepend Me"]
+---
+ Prepend Me<SELECT NAME=3D"mv_order_size">\
+ <OPTION VALUE=3D"10oz">10oz\
+ <OPTION VALUE=3D"15oz">15oz\
+ <OPTION VALUE=3D"20oz">20oz</SELECT>B<Append Me><br>
!endblock
=20
H4: {{CMD[id=3D"accessories_append"]append}}
@@ -1578,17 +1615,17 @@
the C<append>, C<extra> and C<js> N<options:>
=20
!block example
- [accessories code=3Dos28044
- type=3Dselect
- attribute=3Dsize
- append=3D"Append Me<br>"
- extra=3D"Last=3DExtra"
- js=3D"javascript_here"]
-------------------------------------------------------
- <SELECT NAME=3D"mv_order_size" javascript_here Last=3DExtra>\
- <OPTION VALUE=3D"10oz">10oz\
- <OPTION VALUE=3D"15oz">15oz\
- <OPTION VALUE=3D"20oz">20oz</SELECT>Append Me<br>
+ [accessories code=3Dos28044
+ type=3Dselect
+ attribute=3Dsize
+ append=3D"Append Me<br>"
+ extra=3D"Last=3DExtra"
+ js=3D"javascript_here"]
+---
+ <SELECT NAME=3D"mv_order_size" javascript_here Last=3DExtra>\
+ <OPTION VALUE=3D"10oz">10oz\
+ <OPTION VALUE=3D"15oz">15oz\
+ <OPTION VALUE=3D"20oz">20oz</SELECT>Append Me<br>
!endblock
=20
H4: {{CMD[id=3D"accessories_js"]js}}
@@ -1613,7 +1650,7 @@
{{C[jump=3D"#accessories_type"]type}}=3D"textarea_6_33_wrap=3Dvirtual" spe=
cifies a
TEXTAREA widget with ROWS=3D6, COLS=3D33, and WRAP=3Dvirtual. You should r=
esort to this
only when you cannot use the named parameters, for example within an
-E<lbracket>C<item-accessories>] tag.
+E<lbracket>{{C[jump=3D"#PREFIX-accessories"]item-accessories}}] tag.
=20
The result of setting conflicting values in the
{{C[jump=3D"#accessories_type"]type}} string and the C<rows>=3DI<n>
@@ -1644,14 +1681,14 @@
it would otherwise have done,
=20
!block example
- [accessories type=3Dselect
- name=3Dcolor
- passed=3D"blue=3Dblue, green=3DSea Green*"
- default=3D"blue"]
-------------------------
- <SELECT NAME=3D"color"><OPTION VALUE=3D"blue" SELECTED>blue\
- <OPTION VALUE=3D"green">Sea Green</SELECT>
-------------------------
+ [accessories type=3Dselect
+ name=3Dcolor
+ passed=3D"blue=3Dblue, green=3DSea Green*"
+ default=3D"blue"]
+---
+ <SELECT NAME=3D"color"><OPTION VALUE=3D"blue" SELECTED>blue\
+ <OPTION VALUE=3D"green">Sea Green</SELECT>
+---
!endblock
=20
Obscure technical note: the tag ignores the 'C<default>' attribute if
@@ -1669,14 +1706,14 @@
the displayed price in the widget.
=20
!block example
- [accessories type=3Dcheck
- name=3Dcolor
- price=3D1
- price_data=3D"blue=3D20, green=3D50"
- passed=3D"blue=3DBlue, green=3DSea Green*" ]
----------------------------------------------------
- <INPUT TYPE=3D"checkbox" NAME=3D"color" VALUE=3D"blue" > Blue =
($20.00)
- <INPUT TYPE=3D"checkbox" NAME=3D"color" VALUE=3D"green" CHECKED> Se=
a Green ($50.00)
+ [accessories type=3Dcheck
+ name=3Dcolor
+ price=3D1
+ price_data=3D"blue=3D20, green=3D50"
+ passed=3D"blue=3DBlue, green=3DSea Green*"]
+---
+ <INPUT TYPE=3D"checkbox" NAME=3D"color" VALUE=3D"blue" > Blue&nbs=
p;($20.00)
+ <INPUT TYPE=3D"checkbox" NAME=3D"color" VALUE=3D"green" CHECKED> =
Sea Green ($50.00)
!endblock
=20
=20
@@ -1734,9 +1771,9 @@
value (blank, blue, or green), do N<this:>
=20
!block example
- [accessories type=3Dlinks
- name=3Dcolor
- passed=3D"=3D--select--, blue=3DBlue, green=3DSea Green"]
+ [accessories type=3Dlinks
+ name=3Dcolor
+ passed=3D"=3D--select--, blue=3DBlue, green=3DSea Green"]
!endblock
=20
This will generate something like the following:
@@ -1778,27 +1815,27 @@
attribute values of "Sm=3D10oz,E<nbspace>Med=3D15oz,E<nbspace>Lg=3D20oz"N<=
:>
=20
!block example
- [accessories code=3Dos28044 attribute=3Dsize type=3Dcombo new=3D"my_new_=
value"]
-------------------------------------------------------
- <INPUT TYPE=3Dtext NAME=3D"mv_order_size" SIZE=3D16 VALUE=3D"">
- <SELECT NAME=3D"mv_order_size" SIZE=3D"1">
- <OPTION VALUE=3D"my_new_value">my_new_value
- <OPTION VALUE=3D"Sm">10oz
- <OPTION VALUE=3D"Med">15oz
- <OPTION VALUE=3D"Lg">20oz</SELECT>
+ [accessories code=3Dos28044 attribute=3Dsize type=3Dcombo new=3D"my_ne=
w_value"]
+---
+ <INPUT TYPE=3Dtext NAME=3D"mv_order_size" SIZE=3D16 VALUE=3D"">
+ <SELECT NAME=3D"mv_order_size" SIZE=3D"1">
+ <OPTION VALUE=3D"my_new_value">my_new_value
+ <OPTION VALUE=3D"Sm">10oz
+ <OPTION VALUE=3D"Med">15oz
+ <OPTION VALUE=3D"Lg">20oz</SELECT>
!endblock
=20
Or, with the default new value:
=20
!block example
- [accessories code=3Dos28044 attribute=3Dsize type=3Dcombo]
-------------------------------------------------------
- <INPUT TYPE=3Dtext NAME=3D"mv_order_size" SIZE=3D16 VALUE=3D"">
- <SELECT NAME=3D"mv_order_size" SIZE=3D"1">
- <OPTION VALUE=3D""><-- New
- <OPTION VALUE=3D"Sm">10oz
- <OPTION VALUE=3D"Med">15oz
- <OPTION VALUE=3D"Lg">20oz</SELECT>
+ [accessories code=3Dos28044 attribute=3Dsize type=3Dcombo]
+---
+ <INPUT TYPE=3Dtext NAME=3D"mv_order_size" SIZE=3D16 VALUE=3D"">
+ <SELECT NAME=3D"mv_order_size" SIZE=3D"1">
+ <OPTION VALUE=3D""><-- New
+ <OPTION VALUE=3D"Sm">10oz
+ <OPTION VALUE=3D"Med">15oz
+ <OPTION VALUE=3D"Lg">20oz</SELECT>
!endblock
=20
Default is no VALUE with option text set to '<-- New' for a combo
@@ -1867,33 +1904,37 @@
B<Tag expansion example:>
=20
!block example
- [value name=3Dfname set=3D"Mike" hide=3D1]
- [value name=3Dlname set=3D"" hide=3D1]
- ...
+ [value name=3Dfname set=3D"Mike" hide=3D1]
+ [value name=3Dlname set=3D"" hide=3D1]
=20
- [if value fname]
- [and value lname]
- Both first and last name are present.
- [else]
- Missing one of "fname" and "lname" from $Values.
- [/else]
- [/if]
+ ...
+
+ [if value fname]
+ [and value lname]
+ Both first and last name are present.
+ [else]
+ Missing one of "fname" and "lname" from $Values.
+ [/else]
+ [/if]
---
- Missing one of "fname" and "lname" from $Values.
+ Missing one of "fname" and "lname" from $Values.
!endblock
=20
=20
B<ASP-like Perl call:>
=20
-Not applicable. The [and ...] tag only is used with [if ...], and Perl
-logic obviates the [if ...] tag.
+Not applicable. The [C<and> ...] tag only is used with
+E<lbracket>{{C[jump=3D"#if"]if}} ...], and Perl
+logic obviates the
+E<lbracket>{{C[jump=3D"#if"]if}} ...] tag.
=20
# END +++++++++++++++ and End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
=20
-The [and ...] tag is only used in conjunction with [if ...]. Example:
+The [and ...] tag is only used in conjunction with
+E<lbracket>{{C[jump=3D"#if"]if}} ...]. Example:
=20
> [if value fname]
> [and value lname]
@@ -1903,7 +1944,7 @@
> [/else]
> [/if]
=20
-See E<lbracket>{{C[jump=3D"#if"]if}} ...].
+See the description of the E<lbracket>{{C[jump=3D"#if"]if}}] tag.
=20
=20
=20
@@ -1981,10 +2022,10 @@
B<Tag expansion example:>
=20
!block example
- [area href=3Ddir/page.html arg=3D"arg1=3DAA/arg2=3DBB"]
+ [area href=3Ddir/page.html arg=3D"arg1=3DAA/arg2=3DBB"]
=20
- [[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/page.html?mv_session_id=
=3D[[EXAMPLE_SESSION]]&\
- mv_pc=3D1&mv_arg=3Darg1%3dAA/arg2%3dBB
+ [[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/page.html?mv_session_id=
=3D[[EXAMPLE_SESSION]]&\
+ mv_pc=3D1&mv_arg=3Darg1%3dAA/arg2%3dBB
!endblock
=20
B<ASP-like Perl call:>
@@ -2008,7 +2049,7 @@
H3: Description
=20
=20
-The C<area> tag is very similar to the {{CMD[jump=3D"#page"]page}}
+The C<area> tag is very similar to the E<lbracket>{{C[jump=3D"#page"]page}=
}]
tag. It produces the URL to call an Interchange page, but it differs
from C<page> in that it does not supply the surrounding
E<lt>AE<nbspace>HREFE<nbspace>...E<gt> notation. This can be used to
@@ -2039,7 +2080,7 @@
mv_todo=3Drefresh"]"> Order [[EXAMPLE_SIZE]] [[EXA=
MPLE_DESCRIPTION]]</A>
!endblock
=20
-See the description of the {{CMD[jump=3D"#page_form"]page}} tag for more
+See the description of the E<lbracket>{{C[jump=3D"#page"]page}}] tag for m=
ore
detail.
=20
=20
@@ -2089,10 +2130,10 @@
B<Tag expansion example:>
=20
!block example
- [area href=3Ddir/page.html arg=3D"arg1=3DAA/arg2=3DBB"]
+ [area href=3Ddir/page.html arg=3D"arg1=3DAA/arg2=3DBB"]
=20
- [[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/page.html?mv_session_id=
=3D[[EXAMPLE_SESSION]]&\
- mv_pc=3D1&mv_arg=3Darg1%3dAA/arg2%3dBB
+ [[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/page.html?mv_session_id=
=3D[[EXAMPLE_SESSION]]&\
+ mv_pc=3D1&mv_arg=3Darg1%3dAA/arg2%3dBB
!endblock
=20
Positional call example:
@@ -2195,14 +2236,14 @@
$4.99 regardless of weight and N<destination:>
=20
!block example
- [assign salestax=3D0 shipping=3D4.99]
+ [assign salestax=3D0 shipping=3D4.99]
!endblock
=20
This restores the E<lbracket>{{C[jump=3D"#salestax"]salestax}}] tag and
eliminates handling N<charges:>
=20
!block example
- [assign salestax=3D"" handling=3D0]
+ [assign salestax=3D"" handling=3D0]
!endblock
=20
This restores the normal behavior to the
@@ -2210,7 +2251,7 @@
E<lbracket>{{C[jump=3D"#handling"]handling}}] N<tags:>
=20
!block example
- [assign clear=3D1]
+ [assign clear=3D1]
!endblock
=20
Assignment affects only the value returned by a tag. Other behavior,
@@ -2257,18 +2298,18 @@
=20
=20
Note that you cannot assign to
-E<lbracket>{{C[jump=3D"#total_cost"]total-cost}}]E<nbspace>E<emdash> it
+E<lbracket>{{C[jump=3D"#total-cost"]total-cost}}]E<nbspace>E<emdash> it
will always be the sum of the four above.
=20
Before using the C<assign> tag, please be sure you understand the
dependencies within the pricing system, such as the relationship
-between E<lbracket>{{C[jump=3D"#total_cost"]total-cost}}] and assigned
+between E<lbracket>{{C[jump=3D"#total-cost"]total-cost}}] and assigned
tags.
=20
=20
-H2: attr_list
+H2: attr-list
=20
-This tag is intended for use within embedded perl rather than as a standal=
one tag within a template (i.e., the E<lbracket>attr_list ...] syntax does =
not apply).
+This tag is intended for use within embedded perl rather than as a standal=
one tag within a template (i.e., the E<lbracket>C<attr-list> ...] syntax do=
es not apply).
=20
The C<$Tag-E<gt>attr_list($template, $hashref)> usage provides a shorthand=
for accessing values of a hash within embedded perl. It also allows you to=
control defaults or set up conditional values.
=20
@@ -2276,7 +2317,7 @@
=20=20
# BEGIN ############### attr_list Summary Tables ####################
!block example;
- [B<attr_list> hash]
+ C<$Tag-E<gt>attr_list($template, $hashref)>
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -2304,40 +2345,40 @@
B<Tag expansion example> (ASP-like Perl call):
=20
!block example
- [perl tables=3Dproducts]
- my %opt =3D ( hashref =3D> 1,
+ [perl tables=3Dproducts]
+ my %opt =3D ( hashref =3D> 1,
sql =3D> 'select * from products', );
=20
- my $ary_of_hash =3D $Db{products}->query(\%opt);
+ my $ary_of_hash =3D $Db{products}->query(\%opt);
=20
- my B<$template> =3D <<EOF;
- {sku} - {description} - {price|Call for price}
- {image?}<IMG SRC=3D"{image}">{/image?}
- {image:}No image available{/image:}
- <br>
- More body Text here
- <br>
+ my B<$template> =3D <<EOF;
+ {sku} - {description} - {price|Call for price}
+ {image?}<IMG SRC=3D"{image}">{/image?}
+ {image:}No image available{/image:}
+ <br>
+ More body Text here
+ <br>
EOF
=20
- foreach my B<$ref> (@$ary_of_hash) {
- $out .=3D $Tag->B<attr_list($template, $ref)>;
- }
- return $out;
- [/perl]
----
- os28113 - The Claw Hand Rake - Call for price
- <IMG SRC=3D"/[[EXAMPLE_CATALOG]]/images/os28113.gif">
-
- <br>
- More body Text here
- <br>
- os28006 - Painters Brush Set - 29.99
- No image available
-
- <br>
- More body Text here
- <br>
- ...
+ foreach my B<$ref> (@$ary_of_hash) {
+ $out .=3D $Tag->B<attr_list($template, $ref)>;
+ }
+ return $out;
+ [/perl]
+---
+ os28113 - The Claw Hand Rake - Call for price
+ <IMG SRC=3D"/[[EXAMPLE_CATALOG]]/images/os28113.gif">
+
+ <br>
+ More body Text here
+ <br>
+ os28006 - Painters Brush Set - 29.99
+ No image available
+
+ <br>
+ More body Text here
+ <br>
+ ...
!endblock
=20
# END +++++++++++++++ attr_list End Summary Tables ++++++++++++++++++++
@@ -2427,7 +2468,7 @@
B<Tag expansion example:>
=20
!block example
- [banner category=3D]
+ [B<banner> category=3Dmy_category]
!endblock
=20
B<ASP-like Perl call:>
@@ -2619,9 +2660,9 @@
B<Tag expansion example:>
=20
!block example
- [bounce href if]
+ [bounce href if]
---
- TAG RESULT
+ TAG RESULT
!endblock
=20
=20
@@ -2855,9 +2896,9 @@
B<Tag expansion example:>
=20
!block example
- [cart name]
+ [cart name]
---
- TAG RESULT
+ TAG RESULT
!endblock
=20
=20
@@ -2900,7 +2941,7 @@
You can also return a result based on the error message caught in the try =
block with paired subtags, like N<this:>
=20
!block example
- [I<error message>]body text[/I<error message>]
+ [I<error message>]body text[/I<error message>]
!endblock
=20
Note that this feature excises I<all> tag/endtag pairs if interpolation is=
turned off, so the C<catch> tag interpolates by default.
@@ -2962,19 +3003,19 @@
Ignoring whitespace, the following would return division result if success=
ful, 0 on a division by zero, or an error N<message:>
=20
!block example
- [set divisor]0[/set]
- [try label=3Ddiv]
- [perl] eval(1 / [scratch divisor]) [/perl]
- [/try]
- [catch div]
- [/Illegal division by zero/]
- 0
- [/Illegal division by zero/]
- [/eval "string" trapped by operation mask/]
- Perl {{CMD[jump=3D"http://www.perl.com/pub/doc/manual/html/lib/Sa=
fe.html"]Safe}} error
- [/eval "string" trapped by operation mask/]
- Other division error
- [/catch]
+ [set divisor]0[/set]
+ [try label=3Ddiv]
+ [perl] eval(1 / [scratch divisor]) [/perl]
+ [/try]
+ [catch div]
+ [/Illegal division by zero/]
+ 0
+ [/Illegal division by zero/]
+ [/eval "string" trapped by operation mask/]
+ Perl {{CMD[jump=3D"http://www.perl.com/pub/doc/manual/html/lib=
/Safe.html"]Safe}} error
+ [/eval "string" trapped by operation mask/]
+ Other division error
+ [/catch]
---
Perl {{CMD[jump=3D"http://www.perl.com/pub/doc/manual/html/lib/Safe.htm=
l"]Safe}} error
!endblock
@@ -2999,7 +3040,7 @@
=20
# BEGIN ############### catch Summary Tables ####################
!block example;
- [B<catch> ]
+ [catch]
!endblock
=20
!block table; colvaligns=3D"TT"
@@ -3020,9 +3061,9 @@
B<Tag expansion example:>
=20
!block example
- [catch ]
+ [catch]
---
- TAG RESULT
+ TAG RESULT
!endblock
=20
=20
@@ -3049,7 +3090,7 @@
You can also return a result based on the error message caught in the try =
block with paired subtags, like N<this:>
=20
!block example
- [/I<error message>/]special catch block for the error[/I<error message>=
/]
+ [/I<error message>/]special catch block for the error[/I<error message=
>/]
!endblock
=20
The error message to use in the special block will generally be part of the
@@ -3114,9 +3155,9 @@
Assuming CGI variable 'foo' =3D 'bar',
=20
!block example
- [cgi foo]
+ [cgi foo]
---
- bar
+ bar
!endblock
=20
B<ASP-like Perl call:>
@@ -3142,7 +3183,8 @@
=20
Displays the value of a CGI variable B<submitted to the current page>.
This is similar to E<lbracket>{{C[jump=3D"#value"]value}} ...], except it
-displays the transitory values that are submitted with every request.
+displays the transitory values that have been submitted with the current
+request.
=20
For instance, if you access the following URL:
=20
@@ -3193,8 +3235,8 @@
otherwise false. The following will expand to N<"Using default":>
=20
!block example
- [cgi name=3Dmyname set=3D0 hide=3D1]
- [cgi name=3Dmyname default=3D"Using default"]
+ [cgi name=3Dmyname set=3D0 hide=3D1]
+ [cgi name=3Dmyname default=3D"Using default"]
!endblock
=20
=20
@@ -3261,7 +3303,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#checked_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -3278,13 +3319,11 @@
B<Tag expansion example:>
=20
!block example
- [value name=3Dexample set=3Dneato]
- <INPUT TYPE=3Dcheckbox NAME=3Dneato VALUE=3D1 [checked name=3Dneato val=
ue=3D1]>
- <INPUT TYPE=3Dcheckbox NAME=3Dsilly VALUE=3D1 [checked name=3Dsilly val=
ue=3D1]>
----
-
- <INPUT TYPE=3Dcheckbox NAME=3Dneato VALUE=3D1 CHECKED>
- <INPUT TYPE=3Dcheckbox NAME=3Dsilly VALUE=3D1 >
+ [value name=3Dexample set=3Dneato]
+ <INPUT TYPE=3Dcheckbox NAME=3Dneato VALUE=3D1 [checked name=3Dneato va=
lue=3D1]>
+ <INPUT TYPE=3Dcheckbox NAME=3Dsilly VALUE=3D1 [checked name=3Dsilly va=
lue=3D1]>
+ <INPUT TYPE=3Dcheckbox NAME=3Dneato VALUE=3D1 CHECKED>
+ <INPUT TYPE=3Dcheckbox NAME=3Dsilly VALUE=3D1 >
!endblock
=20
=20
@@ -3351,7 +3390,7 @@
H3: Summary
=20
!block example;
- [B<control> name defaultI<other_named_attributes>]
+ [B<control> name default I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -3373,7 +3412,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#control_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -3390,9 +3428,9 @@
B<Tag expansion example:>
=20
!block example
- [control name default]
+ [control name default]
---
- TAG RESULT
+ TAG RESULT
!endblock
=20
=20
@@ -3449,11 +3487,11 @@
This example sets var_one, var_two and var_three in the scratchpad on page=
5 (index begins with 0).
=20
!block example
- [control_set index=3D4]
- [var_one]I<var_one_value>[/var_one]
- [var_two]I<var_two_value>[/var_two]
- [var_three]I<var_three_value>[/var_three]
- [/control_set]
+ [control_set index=3D4]
+ [var_one]I<var_one_value>[/var_one]
+ [var_two]I<var_two_value>[/var_two]
+ [var_three]I<var_three_value>[/var_three]
+ [/control_set]
!endblock
=20
\Parameters: B<index>
@@ -3491,7 +3529,7 @@
=20
# BEGIN ############### control_set Summary Tables ####################
!block example;
- [B<control_set> indexI<other_named_attributes>]
+ [B<control_set> index I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -3502,7 +3540,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#control_set_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -3520,9 +3557,9 @@
B<Tag expansion example:>
=20
!block example
- [control_set index]
+ [control_set index]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -3618,9 +3655,9 @@
B<Tag expansion example:>
=20
!block example
- [counter file]
+ [counter file]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -3703,7 +3740,7 @@
Then access it with:
=20
!block example
- [counter sql=3D"sometable:foo"]
+ [counter sql=3D"sometable:foo"]
!endblock
=20
You can create as many sequences as you like.
@@ -3725,7 +3762,7 @@
Then access it with:
=20
!block example
- [counter sql=3D"sequence_name:sequence_name"]
+ [counter sql=3D"sequence_name:sequence_name"]
!endblock
=20
Alternatively, you can create the table without Interchange definition
@@ -3739,7 +3776,7 @@
by the table that has the AUTO_INCREMENT key:
=20
!block example
- [counter sql=3D"products:sequence_name"]
+ [counter sql=3D"products:sequence_name"]
!endblock
=20
To set up an Oracle counter, create a sequence:
@@ -3752,7 +3789,7 @@
Then access via a table already connected to Oracle, in below C<sometable>:
=20
!block example
- [counter sql=3D"sometable:foo"]
+ [counter sql=3D"sometable:foo"]
!endblock
=20
!block example
@@ -3769,7 +3806,7 @@
Then access it with:
=20
!block example
- [counter sql=3D"sequence_name:sequence_name"]
+ [counter sql=3D"sequence_name:sequence_name"]
!endblock
=20
Alternatively, you can create the table without Interchange definition
@@ -3783,7 +3820,7 @@
by the table that has the AUTO_INCREMENT key:
=20
!block example
- [counter sql=3D"products:sequence_name"]
+ [counter sql=3D"products:sequence_name"]
!endblock
=20
# END ++++++++++++ counter Subsections +++++++++++++
@@ -3857,9 +3894,9 @@
B<Tag expansion example:>
=20
!block example
- [currency convert noformat]
+ [currency convert noformat]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -3967,7 +4004,7 @@
=20
# BEGIN ############### data Summary Tables ####################
!block example;
- [B<data> table field keyI<other_named_attributes>]
+ [B<data> table field key I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -4005,7 +4042,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#data_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -4022,9 +4058,9 @@
B<Tag expansion example:>
=20
!block example
- [data table field key]
+ [data table field key]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4056,7 +4092,7 @@
filter=3D"uc|lc|name|namecase|no_white|etc."*
append=3D1*
value=3D"value to set to"*
- increment=3D1* ]
+ increment=3D1*]
=20
Returns the value of the field in a database table, or from the C<session>
namespace. If the optional B<value> is supplied, the entry will be
@@ -4178,7 +4214,7 @@
=20
# BEGIN ############### default Summary Tables ####################
!block example;
- [B<default> name defaultI<other_named_attributes>]
+ [B<default> name default I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -4191,7 +4227,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#default_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -4208,9 +4243,9 @@
B<Tag expansion example:>
=20
!block example
- [default name default]
+ [default name default]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4318,9 +4353,9 @@
B<Tag expansion example:>
=20
!block example
- [description code base]
+ [description code base]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4436,9 +4471,9 @@
B<Tag expansion example:>
=20
!block example
- [discount code]
+ [discount code]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4571,7 +4606,7 @@
=20
# BEGIN ############### dump Summary Tables ####################
!block example;
- [B<dump> ]
+ [B<dump>]
!endblock
=20
!block table; colvaligns=3D"TT"
@@ -4592,9 +4627,9 @@
B<Tag expansion example:>
=20
!block example
- [dump ]
+ [dump]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4630,7 +4665,7 @@
H3: Summary
=20
!block example;
- [B<ecml> name functionI<other_named_attributes>]
+ [B<ecml> name function I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -4644,7 +4679,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#ecml_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -4661,9 +4695,9 @@
B<Tag expansion example:>
=20
!block example
- [ecml name function]
+ [ecml name function]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4782,13 +4816,13 @@
H3: Summary
=20
!block example
- [either]
- This
- [or]
- That
- [or]
- The other
- [/either]
+ [either]
+ This
+ [or]
+ That
+ [or]
+ The other
+ [/either]
!endblock
=20
No parameters.
@@ -4820,7 +4854,7 @@
=20
# BEGIN ############### either Summary Tables ####################
!block example;
- [B<either> ]
+ [B<either>]
!endblock
=20
!block table; colvaligns=3D"TT"
@@ -4842,9 +4876,9 @@
B<Tag expansion example:>
=20
!block example
- [either ]
+ [either]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -4919,7 +4953,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#error_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -4936,9 +4969,9 @@
B<Tag expansion example:>
=20
!block example
- [error name]
+ [error name]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -5080,7 +5113,7 @@
H3: Summary
=20
!block example;
- [B<export> tableI<other_named_attributes>]
+ [B<export> table I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -5136,7 +5169,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#export_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -5153,9 +5185,9 @@
B<Tag expansion example:>
=20
!block example
- [export table]
+ [export table]
---
- 1
+ 1
!endblock
=20
=20
@@ -5324,9 +5356,9 @@
B<Tag expansion example:>
=20
!block example
- [field name code]
+ [field name code]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -5439,9 +5471,9 @@
B<Tag expansion example:>
=20
!block example
- [file name type]
+ [file name type]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -5555,9 +5587,9 @@
B<Tag expansion example:>
=20
!block example
- [filter op]
+ [filter op]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -5931,9 +5963,9 @@
B<Tag expansion example:>
=20
!block example
- [flag type]
+ [flag type]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -5960,7 +5992,7 @@
For example, you can call
=20
!block example
- [flag type=3Dwrite value=3D1 table=3Dproducts]
+ [flag type=3Dwrite value=3D1 table=3Dproducts]
!endblock
=20
to mark the C<products> DBM database writable. B<This must be done
@@ -6037,7 +6069,7 @@
=20
# END +++++++++++++ flag Subsections ++++++++++++
=20
-H2: fly_list
+H2: fly-list
=20
=20
H3: Summary
@@ -6051,7 +6083,7 @@
=20
Must pass named parameter interpolate=3D1 to cause interpolation.
=20
-This is a container tag, i.e. [fly_list] FOO [/fly_list].
+This is a container tag, i.e. [fly-list] FOO [/fly-list].
\Nesting: NO
=20
Invalidates cache: B<no>
@@ -6074,9 +6106,9 @@
=20
=20=20
=20
-# BEGIN ############### fly_list Summary Tables ####################
+# BEGIN ############### fly-list Summary Tables ####################
!block example;
- [B<fly_list> code base]
+ [B<fly-list> code base]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -6106,9 +6138,9 @@
B<Tag expansion example:>
=20
!block example
- [fly_list code base]
+ [fly-list code base]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -6126,7 +6158,7 @@
$Tag->fly_list(code,base, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ fly_list End Summary Tables ++++++++++++++++++++
+# END +++++++++++++++ fly-list End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
@@ -6161,7 +6193,7 @@
=20
=20
=20
-# BEGIN ########### fly_list Subsections ##############
+# BEGIN ########### fly-list Subsections ##############
H4: {{CMD[id=3D"fly_list_base"]base}}
=20
=20
@@ -6170,9 +6202,9 @@
=20
=20
=20
-# END ++++++++++++ fly_list Subsections +++++++++++++
+# END ++++++++++++ fly-list Subsections +++++++++++++
=20
-H2: fly_tax
+H2: fly-tax
=20
=20
H3: Summary
@@ -6204,9 +6236,9 @@
=20
=20=20
=20
-# BEGIN ############### fly_tax Summary Tables ####################
+# BEGIN ############### fly-tax Summary Tables ####################
!block example;
- [B<fly_tax> area]
+ [fly-tax area]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -6233,9 +6265,9 @@
B<Tag expansion example:>
=20
!block example
- [fly_tax area]
+ [fly-tax area]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -6252,7 +6284,7 @@
$Tag->fly_tax(area, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ fly_tax End Summary Tables ++++++++++++++++++++
+# END +++++++++++++++ fly-tax End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
@@ -6262,12 +6294,12 @@
=20
=20
=20
-# BEGIN ########### fly_tax Subsections ##############
+# BEGIN ########### fly-tax Subsections ##############
H4: {{CMD[id=3D"fly_tax_area"]area}}
=20
=20
=20
-# END ++++++++++++ fly_tax Subsections +++++++++++++
+# END ++++++++++++ fly-tax Subsections +++++++++++++
=20
H2: goto
=20
@@ -6276,17 +6308,17 @@
H3: Summary
=20
!block example
- [goto name=3DI<label_name> if=3DI<condition>]
- I<content to skip>
- [label name=3DI<label_name>]
+ [goto name=3DI<label_name> if=3DI<condition>]
+ I<content to skip>
+ [label name=3DI<label_name>]
!endblock
=20
or positionally,
=20
!block example
- [goto name if]
- I<content to skip>
- [label name]
+ [goto name if]
+ I<content to skip>
+ [label name]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -6340,8 +6372,8 @@
For example, this will not execute the goto:
=20
!block example
- [set go]0[/set]
- [goto name=3D"there" if=3D"[scratch go]"]
+ [set go]0[/set]
+ [goto name=3D"there" if=3D"[scratch go]"]
!endblock
=20
=20
@@ -6390,7 +6422,7 @@
=20
# BEGIN ############### handling Summary Tables ####################
!block example;
- [B<handling> modeI<other_named_attributes>]
+ [B<handling> mode I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -6413,7 +6445,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#handling_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -6430,9 +6461,9 @@
B<Tag expansion example:>
=20
!block example
- [handling mode]
+ [handling mode]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -6491,7 +6522,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#harness_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -6509,9 +6539,9 @@
B<Tag expansion example:>
=20
!block example
- [harness ]
+ [harness]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -6555,14 +6585,14 @@
Alias for [{{CMD[jump=3D"#area"]area}}] tag.
=20
=20
-H2: html_table
+H2: html-table
=20
Builds an HTML table
=20
H3: Summary
=20
!block example;
- [B<html_table> I<other_named_attributes>]
+ [html-table I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -6595,7 +6625,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#html_table_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -6613,9 +6642,9 @@
B<Tag expansion example:>
=20
!block example
- [html_table ]
+ [html-table]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -6640,7 +6669,7 @@
=20
=20
=20
-# BEGIN ############ html_table Subsections ##############
+# BEGIN ############ html-table Subsections ##############
H4: {{CMD[id=3D"html_table_columns"]columns}}
=20
Whitespace-delimited list of columns
@@ -6681,7 +6710,7 @@
HTML attributes for <TR>
=20
=20
-# END +++++++++++++ html_table Subsections ++++++++++++
+# END +++++++++++++ html-table Subsections ++++++++++++
=20
H2: if
=20
@@ -6718,14 +6747,9 @@
> comp =3D=3D> compare
> condition =3D=3D> compare
> operator =3D=3D> op
-
-
=20=20
=20
# BEGIN ############### if Summary Tables ####################
-!block example;
- [B<if> type term op compare]
-!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
Parameters|Description|Default
@@ -6770,9 +6794,9 @@
B<Tag expansion example:>
=20
!block example
- [if type term op compare]
+ [if type term op compare]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -7185,7 +7209,7 @@
=20
# BEGIN ############### import Summary Tables ####################
!block example;
- [B<import> table typeI<other_named_attributes>]
+ [B<import> table type I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -7204,7 +7228,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#import_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -7222,9 +7245,9 @@
B<Tag expansion example:>
=20
!block example
- [import table type]
+ [import table type]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -7357,9 +7380,9 @@
B<Tag expansion example:>
=20
!block example
- [include file locale]
+ [include file locale]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -7409,7 +7432,7 @@
H3: Summary
=20
!block example;
- [B<index> tableI<other_named_attributes>]
+ [B<index> table I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -7453,7 +7476,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#index_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -7470,9 +7492,9 @@
B<Tag expansion example:>
=20
!block example
- [index table]
+ [index table]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -7548,7 +7570,7 @@
=20
# END +++++++++++++ index Subsections ++++++++++++
=20
-H2: item_list
+H2: item-list
=20
=20
H3: Summary
@@ -7561,7 +7583,7 @@
=20
Must pass named parameter interpolate=3D1 to cause interpolation.
=20
-This is a container tag, i.e. [item_list] FOO [/item_list].
+This is a container tag, i.e. [item-list] FOO [/item-list].
\Nesting: NO
=20
Invalidates cache: B<YES>
@@ -7593,9 +7615,9 @@
=20
=20=20
=20
-# BEGIN ############### item_list Summary Tables ####################
+# BEGIN ############### item-list Summary Tables ####################
!block example;
- [B<item_list> name I<other_named_attributes>]
+ [B<item-list> name I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -7609,7 +7631,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#item_list_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -7627,9 +7648,9 @@
B<Tag expansion example:>
=20
!block example
- [item_list name]
+ [item-list name]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -7646,15 +7667,15 @@
$Tag->item_list(name, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ item_list End Summary Tables ++++++++++++++++++++
+# END +++++++++++++++ item-list End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
=20
=20
-Within any page, the [item_list cart*] element shows a list of all the
+Within any page, the C<[item-list cart*]> element shows a list of all the
items ordered by the customer so far. It works by repeating the source
-between [item_list] and [/item_list] once for each item ordered.
+between C<[item-list]> and C<[/item-list]> once for each item ordered.
=20
\NOTE: The special tags that reference item within the list are not normal
Interchange tags, do not take named attributes, and cannot be contained in
@@ -7663,16 +7684,16 @@
corresponding list container. Normal Interchange tags can be interspersed,
though they will be interpreted I<after> all of the list-specific tags.
=20
-Between the item_list markers the following elements will return
+Between the [C<item-list>] markers the following elements will return
information for the current item:
=20
=20
H4: E<lbracket>if-data table column]
=20
If the database field C<column> in table I<table> is non-blank, the
-following text up to the [/if_data] tag is substituted. This can be
+following text up to the C<[/if_data]> tag is substituted. This can be
used to substitute IMG or other tags only if the corresponding source
-item is present. Also accepts a [else]else text[/else] pair for the
+item is present. Also accepts a C<[else]>else textC<[/else]> pair for the
opposite condition.
=20
H4: E<lbracket>if-data ! table column]
@@ -7751,14 +7772,14 @@
> [/calc][/item-last]
=20
If this is contained in your
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}] (or
-E<lbracket>{{C[jump=3D"#search_list"]search-list}}] or
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}] (or
+E<lbracket>{{C[jump=3D"#search-list"]search-list}}] or
flypage) and the weight field is empty, then a numerical C<-1> will be
output from the [calc][/calc] tags; the list will end and the item
will B<not> be shown. If the product's weight field is less than 1, a
numerical 1 is output. The item will be shown, but will be the last
item shown. (If it is an
-E<lbracket>{{C[jump=3D"#item_list"]item-list}}], any price for
+E<lbracket>{{C[jump=3D"#item-list"]item-list}}], any price for
the item will still be added to the subtotal.)
=20
H4: E<lbracket>item-modifier attribute]
@@ -7773,10 +7794,10 @@
=20
> [item-next][calc][item-field weight] < 1[/calc][/item-next]
=20
-If this is contained in your E<lbracket>{{C[jump=3D"#item_list"]item-list}=
}] (or E<lbracket>{{C[jump=3D"#search_list"]search-list}}] or flypage)
+If this is contained in your E<lbracket>{{C[jump=3D"#item-list"]item-list}=
}] (or E<lbracket>{{C[jump=3D"#search-list"]search-list}}] or flypage)
and the product's weight field is less than 1, then a numerical C<1> will
be output from the [calc][/calc] operation. The item will not be shown. (If
-it is an E<lbracket>{{C[jump=3D"#item_list"]item-list}}], any price for th=
e item will still be added to the
+it is an E<lbracket>{{C[jump=3D"#item-list"]item-list}}], any price for th=
e item will still be added to the
subtotal.)
=20
H4: E<lbracket>item-price n* noformat*]
@@ -7822,12 +7843,12 @@
=20
=20
=20
-# BEGIN ########### item_list Subsections ##############
+# BEGIN ########### item-list Subsections ##############
H4: {{CMD[id=3D"item_list_name"]name}}
=20
=20
=20
-# END ++++++++++++ item_list Subsections +++++++++++++
+# END ++++++++++++ item-list Subsections +++++++++++++
=20
H2: label
=20
@@ -7836,9 +7857,9 @@
\Parameter: B<name>
=20
!block example
- [goto name=3DI<label_name> if=3DI<condition>]
- I<content to skip>
- [label name=3DI<label_name>]
+ [goto name=3DI<label_name> if=3DI<condition>]
+ I<content to skip>
+ [label name=3DI<label_name>]
!endblock
=20
=20
@@ -7849,7 +7870,7 @@
=20
# BEGIN ############### label Summary Tables ####################
!block example;
- [B<label> ]
+ [B<label>]
!endblock
=20
!block table; colvaligns=3D"TT"
@@ -7870,9 +7891,9 @@
B<Tag expansion example:>
=20
!block example
- [label ]
+ [label]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -7903,7 +7924,7 @@
H3: Summary
=20
!block example;
- [B<log> fileI<other_named_attributes>]
+ [B<log> file I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -7940,7 +7961,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#log_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -7958,9 +7978,9 @@
B<Tag expansion example:>
=20
!block example
- [log file]
+ [log file]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -8076,7 +8096,7 @@
=20
# BEGIN ############### loop Summary Tables ####################
!block example;
- [B<loop> listI<other_named_attributes>]
+ [B<loop> list I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -8093,7 +8113,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#loop_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -8111,9 +8130,9 @@
B<Tag expansion example:>
=20
!block example
- [loop list]
+ [loop list]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -8296,7 +8315,7 @@
Outputs the B<IF> if the returned C<param> is non-empty, and the
B<ELSE> (if any) otherwise.
=20
-See E<lbracket>{{CMD[jump=3D"#if-PREFIX-param"]if-PREFIX-param}}E<rbracket=
>.
+See C<[if-PREFIX-param]>.
=20
H4: E<lbracket>if-loop-pos N] IF [else] ELSE [/else][/if-loop-pos]
=20
@@ -8309,7 +8328,7 @@
Outputs the B<IF> if the returned positional parameter C<N> is
non-empty, and the B<ELSE> (if any) otherwise.
=20
-See E<lbracket>{{CMD[jump=3D"#if-PREFIX-pos"]if-PREFIX-pos}}E<rbracket>.
+See C<[if-PREFIX-pos]>.
=20
H4: E<lbracket>loop-accessories]
=20
@@ -8414,7 +8433,7 @@
H3: Summary
=20
!block example;
- [B<mail> toI<other_named_attributes>]
+ [B<mail> to I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -8440,7 +8459,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#mail_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -8458,9 +8476,9 @@
B<Tag expansion example:>
=20
!block example
- [mail to]
+ [mail to]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -8565,22 +8583,22 @@
B<Tag expansion example:>
=20
!block example
- [mvasp tables=3D"products" failure=3D"ASP Broke <BR>"]
- <P>This is HTMLE<lt>/p>
- <% my $sku =3D $Values->{code}; %>
- <P>More HTMLE<lt>/p>
- <% my $result =3D "Looked up SKU $sku. It is a ";
- $result .=3D $Tag->data('products', 'description', $sku );
- $Document->write( "$result <br>\n" ); %>
- <P>Still more HTMLE<lt>/p>
- [/mvasp]
-------------------------------------------------------
- <P>This is HTMLE<lt>/p>
-=20=20=20=20=20=20
- <P>More HTMLE<lt>/p>
- Looked up SKU [[EXAMPLE_SKU]]. It is a [[EXAMPLE_DESCRIPTION]] <br>
+ [mvasp tables=3D"products" failure=3D"ASP Broke <BR>"]
+ <P>This is HTMLE<lt>/p>
+ <% my $sku =3D $Values->{code}; %>
+ <P>More HTMLE<lt>/p>
+ <% my $result =3D "Looked up SKU $sku. It is a ";
+ $result .=3D $Tag->data('products', 'description', $sku );
+ $Document->write( "$result <br>\n" ); %>
+ <P>Still more HTMLE<lt>/p>
+ [/mvasp]
+---
+ <P>This is HTMLE<lt>/p>
=20
- <P>Still more HTMLE<lt>/p>
+ <P>More HTMLE<lt>/p>
+ Looked up SKU [[EXAMPLE_SKU]]. It is a [[EXAMPLE_DESCRIPTION]] <br>
+
+ <P>Still more HTMLE<lt>/p>
!endblock
=20
=20
@@ -8637,7 +8655,7 @@
=20
H4: {{CMD[id=3D"mvasp_file"]file}}
=20
-Prepend the contents of the specified file or FileDatabase entry to
+Prepend the contents of the specified file or C<FileDatabase> entry to
the perl code before C<eval>'ing it. See {{C[jump=3D"#perl_file"]perl}} ta=
g.
=20
=20
@@ -8692,9 +8710,9 @@
B<Tag expansion example:>
=20
!block example
- [nitems name]
+ [nitems name]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -8751,20 +8769,20 @@
=20
!block example
=3D=3D=3D
- [options code=3Dos28005]
+ [options code=3Dos28005]
---
- <input type=3Dhidden name=3Dmv_item_option value=3D"logo">
- <SELECT NAME=3D"mv_order_logo">
- <OPTION VALUE=3D"c">Construct Something
- <OPTION VALUE=3D"y" SELECTED>Your Logo</SELECT><BR>
- <input type=3Dhidden name=3Dmv_item_option value=3D"color">
- <INPUT TYPE=3D"radio" NAME=3D"mv_order_color" VALUE=3D"BLK" > Bl=
ack
- <INPUT TYPE=3D"radio" NAME=3D"mv_order_color" VALUE=3D"BEIGE" > =
Beige
- <INPUT TYPE=3D"radio" NAME=3D"mv_order_color" VALUE=3D"WHITE" > =
White<BR>
- <input type=3Dhidden name=3Dmv_item_option value=3D"bristle">
- <SELECT NAME=3D"mv_order_bristle">
- <OPTION VALUE=3D"synthetic">Synthetic
- <OPTION VALUE=3D"camel">Camel Hair</SELECT>
+ <input type=3Dhidden name=3Dmv_item_option value=3D"logo">
+ <SELECT NAME=3D"mv_order_logo">
+ <OPTION VALUE=3D"c">Construct Something
+ <OPTION VALUE=3D"y" SELECTED>Your Logo</SELECT><BR>
+ <input type=3Dhidden name=3Dmv_item_option value=3D"color">
+ <INPUT TYPE=3D"radio" NAME=3D"mv_order_color" VALUE=3D"BLK" > =
;Black
+ <INPUT TYPE=3D"radio" NAME=3D"mv_order_color" VALUE=3D"BEIGE" >&nb=
sp;Beige
+ <INPUT TYPE=3D"radio" NAME=3D"mv_order_color" VALUE=3D"WHITE" >&nb=
sp;White<BR>
+ <input type=3Dhidden name=3Dmv_item_option value=3D"bristle">
+ <SELECT NAME=3D"mv_order_bristle">
+ <OPTION VALUE=3D"synthetic">Synthetic
+ <OPTION VALUE=3D"camel">Camel Hair</SELECT>
=3D=3D=3D
!endblock
=20
@@ -8866,9 +8884,9 @@
B<Tag expansion example:>
=20
!block example
- [options code]
+ [options code]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -9068,9 +9086,9 @@
B<Tag expansion example:>
=20
!block example
- [or type term op compare]
+ [or type term op compare]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -9160,11 +9178,11 @@
B<Tag expansion example:>
=20
!block example
- [order [[EXAMPLE_SKU]] 2]Buy [[EXAMPLE_DESCRIPTION]]E<lbracket>/order]
+ [order [[EXAMPLE_SKU]] 2]Buy [[EXAMPLE_DESCRIPTION]]E<lbracket>/order]
---
- <A HREF=3D"http://localhost.localdomain/cgi-bin/tag72/ord/basket?\
- mv_session_id=3D[[EXAMPLE_SESSION]]&mv_pc=3D1&mv_action=3Drefresh&\
- mv_order_item=3D[[EXAMPLE_SKU]]&mv_order_quantity=3D3">Buy [[EXAMPLE_DE=
SCRIPTION]]</A>
+ <A HREF=3D"http://localhost.localdomain/cgi-bin/tag72/ord/basket?\
+ mv_session_id=3D[[EXAMPLE_SESSION]]&mv_pc=3D1&mv_action=3Drefresh&\
+ mv_order_item=3D[[EXAMPLE_SKU]]&mv_order_quantity=3D3">Buy [[EXAMPLE_D=
ESCRIPTION]]</A>
!endblock
=20
B<ASP-like Perl call:>
@@ -9310,10 +9328,10 @@
B<Tag expansion example:>
=20
!block example
- [page href=3Ddir/page.html arg=3D"arg1=3DAA/arg2=3DBB"]
+ [page href=3Ddir/page.html arg=3D"arg1=3DAA/arg2=3DBB"]
=20
- <a href=3D"[[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/page.html?mv_=
session_id=3D[[EXAMPLE_SESSION]]&\
- mv_pc=3D1&mv_arg=3Darg1%3dAA/arg2%3dBB">
+ <a href=3D"[[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/page.html?mv=
_session_id=3D[[EXAMPLE_SESSION]]&\
+ mv_pc=3D1&mv_arg=3Darg1%3dAA/arg2%3dBB">
!endblock
=20
B<ASP-like Perl call:>
@@ -9447,23 +9465,22 @@
These are identical:
=20
!block example
- [page scan
- se=3DImpressionists
- sf=3Dcategory]
- Impressionist Paintings
- </a>
+ [page scan
+ se=3DImpressionists
+ sf=3Dcategory]
+ Impressionist Paintings
+ </a>
=20
- [page href=3Dscan
+ [page href=3Dscan
arg=3D"se=3DImpressionists
sf=3Dcategory"]
- Impressionist Paintings
- </A>
-
- [page search=3D"se=3DImpressionists
- sf=3Dcategory"]
- Impressionist Paintings
- </a>
+ Impressionist Paintings
+ </A>
=20
+ [page search=3D"se=3DImpressionists
+ sf=3Dcategory"]
+ Impressionist Paintings
+ </a>
!endblock
=20
Here is the same thing from a non-Interchange page (e.g., a home
@@ -9638,17 +9655,18 @@
B<Tag expansion example:>
=20
!block example
- [perl tables=3D"products" failure=3D"Perl code error <BR>"]
+ [perl tables=3D"products" failure=3D"Perl code error <BR>"]
!endblock
+
!block example; lang=3D"Perl"
- my $result =3D "Looked up SKU $Values->{code}. It is a ";
- $result .=3D $Tag->data('products', 'description', $Values->{code} );
- return ("$result <br>\n");
+ my $result =3D "Looked up SKU $Values->{code}. It is a ";
+ $result .=3D $Tag->data('products', 'description', $Values->{code} );
+ return ("$result <br>\n");
!endblock
!block example
- [/perl]
-------------------------------------------------------
- Looked up SKU [[EXAMPLE_SKU]]. It is a [[EXAMPLE_DESCRIPTION]] <br>
+ [/perl]
+---
+ Looked up SKU [[EXAMPLE_SKU]]. It is a [[EXAMPLE_DESCRIPTION]] <br>
!endblock
=20
B<ASP-like Perl call:> (e.g., to use it like a runtime eval() within your =
code)
@@ -9770,12 +9788,12 @@
the (default) products table:
=20
!block example;
- [accessories code=3Dos28044 attribute=3Dsize]
+ [accessories code=3Dos28044 attribute=3Dsize]
=20
- [perl]
- return $Tag->accessories( { attribute =3D> 'size',
- code =3D> 'os28085' } );
- [/perl]
+ [perl]
+ return $Tag->accessories( { attribute =3D> 'size',
+ code =3D> 'os28085' } );
+ [/perl]
!endblock
=20
If you remove the first E<lbracket>accessories ...] tag, then the
@@ -9879,7 +9897,7 @@
=20
H4: {{CMD[id=3D"perl_file"]file}}
=20
-This prepends the contents of the specified file or FileDatabase entry to
+This prepends the contents of the specified file or C<FileDatabase> entry =
to
the enclosed perl code (if any), then executes as usual.
=20
For example,=20
@@ -9891,7 +9909,7 @@
would execute myscript.pl and expand to its return value.
=20
Absolute filenames (or filenames containing '../') are prohibited by
-the {{C[jump=3D"icconfig.html#NoAbsolute *global* *global*"]NoAbsolute}}
+the {{C[jump=3D"icconfig.html#NoAbsolute *global*"]NoAbsolute}}
catalog directive.
=20
If the filename is not absolute, Interchange first looks for a file in
@@ -9899,7 +9917,7 @@
{{C[jump=3D"icconfig.html#TemplateDir *global*"]TemplateDir}} catalog
directive. If it fails to find a file by that name, it then looks for
an entry by that name in the database specified with the
-{{C[jump=3D"icconfig.html#FileDatabase *global*"]FileDatabase}} catalog di=
rective.
+C<FileDatabase> catalog directive.
=20
H4: {{CMD[id=3D"perl_number_errors"]file}}
=20
@@ -9927,7 +9945,6 @@
=20
=20
=20
-
H2: price
=20
H3: Summary
@@ -9968,7 +9985,7 @@
=20
# BEGIN ############### price Summary Tables ####################
!block example;
- [B<price> codeI<other_named_attributes>]
+ [B<price> code I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -9982,7 +9999,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#price_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -9999,9 +10015,9 @@
B<Tag expansion example:>
=20
!block example
- [price code]
+ [price code]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -10132,10 +10148,10 @@
This is a shortcut for the 'process' action, expanding to your catalog URL=
and session ID. It is analogous to the {{C[jump=3D"#area"]area}} tag for t=
he 'process' page, but is more limited. The following expansion is N<illust=
rative:>
=20
!block example
- [process target=3Dtargetframe]
+ [process target=3Dtargetframe]
---
- http://[[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/process.html?\
- id=3D[[EXAMPLE_SESSION]]" TARGET=3D"targetframe
+ http://[[EXAMPLE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/process.html?\
+ id=3D[[EXAMPLE_SESSION]]" TARGET=3D"targetframe
!endblock
=20
(the trailing backslash indicates continuation, i.e., the result should be=
only one line)
@@ -10181,10 +10197,10 @@
B<Tag expansion example:>
=20
!block example
- [process targetframe 1]
+ [process targetframe 1]
---
- http://[[EXAMPLE_SECURE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/process.ht=
ml?\
- id=3D[[EXAMPLE_SESSION]]" TARGET=3D"targetframe
+ http://[[EXAMPLE_SECURE_DOMAIN]]/cgi-bin/[[EXAMPLE_CATALOG]]/process.h=
tml?\
+ id=3D[[EXAMPLE_SESSION]]" TARGET=3D"targetframe
!endblock
=20
B<ASP-like Perl call:>
@@ -10201,9 +10217,9 @@
!endblock
=20
=20
-H2: process_search
+H2: process-search
=20
-This is an exact alias for [area search].
+This is an exact alias for E<lbracket>{{C[jump=3D"#area"]area}}<C search>].
=20
=20
H2: query
@@ -10270,7 +10286,7 @@
the SQL statement.
=20
!block example
- [query sql=3D"select sku, description, price from products where price =
< [value mv_arg]"
+ [query sql=3D"select sku, description, price from products where price=
< [value mv_arg]"
type=3Dlist
more=3D1
ml=3D10]
@@ -10285,7 +10301,7 @@
[more_list]
[more]
[/more_list]
- [/query]
+ [/query]
!endblock
=20
=20
@@ -10434,10 +10450,10 @@
to calculate a value, I<etc.>
=20
!block example
- [query sql=3D"select description, price from products
+ [query sql=3D"select description, price from products
where price < [value mv_arg]" ...]
- ...
- [/query]
+ ...
+ [/query]
!endblock
=20
H4: {{CMD[id=3D"query_table"]table}}
@@ -10530,7 +10546,7 @@
set C<more>=3D1, then the links to later pages will merely redisplay
the first page of your results.
=20
-H4: {{I[jump=3D"#query_form_variables"]form variable abbreviations}}
+H4: {{CMD[id=3D"query_form_variables"]form variable abbreviations}}
=20
Requires '{{C[jump=3D"#query_type"]type}}=3Dlist'.
=20
@@ -10575,7 +10591,7 @@
and the second with explicitly set C<prefix> and C<list_prefix>.
=20
!block example
- [query sql=3D"select sku, description, price from products
+ [query sql=3D"select sku, description, price from products
where price < 20"
type=3Dlist
more=3D1
@@ -10591,17 +10607,15 @@
[more_list]
[more]
[/more_list]
- [/query]
-
-------------------------------------------------------------
-
- [query sql=3D"select sku, description, price from products
+ [/query]
+---
+ [query sql=3D"select sku, description, price from products
where price < 20"
- type=3Dlist
- B<prefix=3Dfoo>
- B<list_prefix=3Dbar>
- more=3D1
- ml=3D10]
+ type=3Dlist
+ B<prefix=3Dfoo>
+ B<list_prefix=3Dbar>
+ more=3D1
+ ml=3D10]
=20
[on_match]Matched<br>[/on_match]
[no_match]Not Found<br>[/no_match]
@@ -10613,7 +10627,7 @@
[more_list]
[more]
[/more_list]
- [/query]
+ [/query]
!endblock
=20
=20
@@ -10631,7 +10645,7 @@
priced under 20.
=20
!block example
- [query sql=3D"select * from products
+ [query sql=3D"select * from products
where price < 20"
type=3Dlist
random=3D3]
@@ -10640,7 +10654,7 @@
[sql-code] [sql-param description] [sql-price]
[/list]
=20
- [/query]
+ [/query]
!endblock
=20
=20
@@ -10702,7 +10716,7 @@
are also affected by this unless you set wantarray.
=20
=20
-H2: read_cookie
+H2: read-cookie
=20
Returns the value of the named cookie. Returns nothing if the cookie
does not exist.
@@ -10711,8 +10725,8 @@
H3: Summary
=20
!block example;
- [B<read_cookie> name]
- [B<read_cookie> name=3Dmycookie]
+ [read-cookie name]
+ [read-cookie name=3Dmycookie]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -10737,9 +10751,9 @@
B<Usage example:>
=20
!block example
- [read-cookie name=3DMV_SESSION_ID]
-------------------------------------------------------
- [[EXAMPLE_SESSION]]
+ [read-cookie name=3DMV_SESSION_ID]
+---
+ [[EXAMPLE_SESSION]]
!endblock
=20
=20
@@ -10823,9 +10837,9 @@
B<Usage example:>
=20
!block example
- [read-cookie name=3DMV_SESSION_ID]
-------------------------------------------------------
- [[EXAMPLE_SESSION]]
+ [read-cookie name=3DMV_SESSION_ID]
+---
+ [[EXAMPLE_SESSION]]
!endblock
=20
=20
@@ -10930,9 +10944,9 @@
B<Tag expansion example:>
=20
!block example
- [row width]
+ [row width]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -11076,9 +11090,9 @@
B<Tag expansion example:>
=20
!block example
- [salestax name noformat]
+ [salestax name noformat]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -11185,9 +11199,9 @@
B<Tag expansion example:>
=20
!block example
- [scratch name]
+ [scratch name]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -11265,13 +11279,13 @@
B<Tag expansion example:>
=20
!block example
- [set myvar]This is myvar[/set]
- .
- .
- .
- [scratchd myvar]
+ [set myvar]This is myvar[/set]
+ .
+ .
+ .
+ [scratchd myvar]
---
- This is myvar
+ This is myvar
!endblock
=20
B<ASP-like Perl call:>
@@ -11286,14 +11300,14 @@
Deletes the named scratch variable and returns its value before the deleti=
on.
=20
=20
-H2: search_list
+H2: search-list
=20
Formats results returned by a search. Must be enclosed within a
-{{C[jump=3D"#search_region"]search_region}}. Has sub-tags (see
-{{C[jump=3D"#Looping tags and Sub-tags"]LoopingE<nbspace>tagsE<nbspace>and=
E<nbspace>Sub-tags}}).=20
+{{C[jump=3D"#search-region"]search-region}}. Has sub-tags (see
+{{C[jump=3D"#Looping tags and Sub-tags"]Looping tags and Sub-tags}}).=20
=20
=20
-H2: search_region
+H2: search-region
=20
=20
H3: Summary
@@ -11306,7 +11320,7 @@
=20
Must pass named parameter interpolate=3D1 to cause interpolation.
=20
-This is a container tag, i.e. [search_region] FOO [/search_region].
+This is a container tag, i.e. [search-region] FOO [/search-region].
\Nesting: NO
=20
Invalidates cache: B<no>
@@ -11335,9 +11349,9 @@
=20
=20=20
=20
-# BEGIN ############### search_region Summary Tables ####################
+# BEGIN ############### search-region Summary Tables ####################
!block example;
- [B<search_region> argI<other_named_attributes>]
+ [search-region arg I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -11357,7 +11371,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#search_region_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -11375,9 +11388,9 @@
B<Tag expansion example:>
=20
!block example
- [search_region arg]
+ [search-region arg]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -11394,7 +11407,7 @@
$Tag->search_region(arg, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ search_region End Summary Tables ++++++++++++++++++++
+# END +++++++++++++++ search-region End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
@@ -11405,12 +11418,12 @@
=20
=20
=20
-# BEGIN ########### search_region Subsections ##############
+# BEGIN ########### search-region Subsections ##############
H4: {{CMD[id=3D"search_region_arg"]arg}}
=20
=20
=20
-# END ++++++++++++ search_region Subsections +++++++++++++
+# END ++++++++++++ search-region Subsections +++++++++++++
=20
H2: selected
=20
@@ -11470,7 +11483,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#selected_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -11487,13 +11499,12 @@
B<Tag expansion example:>
=20
!block example
- [value name=3Dexample set=3Dneato]
- <OPTION[selected example neato]>Neato
- <OPTION[selected example silly]>Silly
+ [value name=3Dexample set=3Dneato]
+ <OPTION[selected example neato]>Neato
+ <OPTION[selected example silly]>Silly
---
-
- <OPTION SELECTED>Neato
- <OPTION>Silly
+ <OPTION SELECTED>Neato
+ <OPTION>Silly
!endblock
=20
# END +++++++++++++++ selected End Summary Tables ++++++++++++++++++++
@@ -11673,14 +11684,14 @@
=20
# END ++++++++++++ set Subsections +++++++++++++
=20
-H2: set_cookie
+H2: set-cookie
=20
Sets browser cookie(s) with the specified attributes.
=20
H3: Summary
=20
!block example;
- [B<set_cookie> I<named_attributes>]
+ [set-cookie I<named_attributes>]
!endblock
=20
Parameters must be named (no positional usage except in Perl call)
@@ -11717,11 +11728,11 @@
B<Usage example:>
=20
!block example
- [set-cookie name=3Dmycookie
- value=3D"the value"
- expire=3D"Tue, 03-Apr-2001 17:00:00 GMT" ]
-------------------------------------------------------
- I<This tag returns no value in the page>
+ [set-cookie name=3Dmycookie
+ value=3D"the value"
+ expire=3D"Tue, 03-Apr-2001 17:00:00 GMT"]
+---
+ I<This tag returns no value in the page>
!endblock
=20
=20
@@ -11871,9 +11882,9 @@
B<Tag expansion example:>
=20
!block example
- [seti name]value[/seti]
+ [seti name]value[/seti]
---
-
+ TODO: (tag result)
!endblock
=20
B<ASP-like Perl call:>
@@ -11914,7 +11925,7 @@
H3: Summary
=20
!block example;
- [B<setlocale> ]
+ [B<setlocale>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -11950,9 +11961,9 @@
B<Tag expansion example:>
=20
!block example
- [setlocale ]
+ [setlocale]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -12069,10 +12080,10 @@
{{CMD[jump=3D"#shipping_label"]label}}|<<
By default, returns HTML <OPTION ...> widget for shipping mode(s), includi=
ng description and cost. You can override the widget with the B<format> att=
ribute. Note that B<label> overrides B<noformat>.
* Here is an example from the foundation checkout.html page:
-> [shipping
-> label=3D1
-> mode=3D|E<lbracket>{{CMD[jump=3D"#data"]data}} table=3Dcountry key=
=3D'[default country US]' col=3Dshipmodes]|
-> ]
+> [shipping
+> label=3D1
+> mode=3D|E<lbracket>{{CMD[jump=3D"#data"]data}} table=3Dcountry ke=
y=3D'[default country US]' col=3Dshipmodes]|
+> ]
>>|DEFAULT_VALUE
{{CMD[jump=3D"#shipping_mode"]mode}}|<<
* N<Aliases:> B<name>, B<modes>
@@ -12124,9 +12135,9 @@
B<Tag expansion example:>
=20
!block example
- [shipping mode]
+ [shipping mode]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -12212,10 +12223,10 @@
=20
By default, returns HTML <OPTION ...> widget for shipping mode(s), includi=
ng description and cost. You can override the widget with the B<format> att=
ribute. Note that B<label> overrides B<noformat>.
* Here is an example from the foundation checkout.html page:
-> [shipping
-> label=3D1
-> mode=3D|E<lbracket>{{CMD[jump=3D"#data"]data}} table=3Dcountry key=
=3D'[default country US]' col=3Dshipmodes]|
-> ]
+> [shipping
+> label=3D1
+> mode=3D|E<lbracket>{{CMD[jump=3D"#data"]data}} table=3Dcountry ke=
y=3D'[default country US]' col=3Dshipmodes]|
+> ]
=20
=20
H4: {{CMD[id=3D"shipping_mode"]mode}}
@@ -12251,23 +12262,23 @@
=20
# END +++++++++++++ shipping Subsections ++++++++++++
=20
-H2: shipping_desc
+H2: shipping-desc
=20
Returns the shipping description for the specified shipping B<mode>. See =
the {{CMD[jump=3D"icdatabase.html#Shipping"]Shipping}} section of the Datab=
ase documentation. See also shipping.asc database for shipping modes.
=20
-N<Alias:> B<shipping_description>
+N<Alias:> B<shipping-description>
=20
The two tags below are identical in N<operation:>
=20
-> [shipping_desc mode]
-> [shipping_description mode]
+> [shipping-desc mode]
+> [shipping-description mode]
=20
=20
H3: Summary
=20
!block example;
- [B<shipping_desc> mode]
- [B<shipping_desc> mode=3DI<shipping_mode>]
+ [B<shipping-desc> mode]
+ [B<shipping-desc> mode=3DI<shipping_mode>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"244"
@@ -12287,9 +12298,9 @@
B<Tag expansion example:>
=20
!block example
- [shipping_desc 1DM]
+ [shipping-desc 1DM]
---
- UPS Next Day Air Early AM
+ UPS Next Day Air Early AM
!endblock
=20
B<ASP-like Perl call:>
@@ -12338,7 +12349,7 @@
=20
# BEGIN ############### soap Summary Tables ####################
!block example;
- [B<soap> call uri proxyI<other_named_attributes>]
+ [B<soap> call uri proxy I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -12353,7 +12364,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#soap_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -12370,9 +12380,9 @@
B<Tag expansion example:>
=20
!block example
- [soap call uri proxy]
+ [soap call uri proxy]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -12523,9 +12533,9 @@
B<Tag expansion example:>
=20
!block example
- [subtotal name noformat]
+ [subtotal name noformat]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -12620,7 +12630,7 @@
=20
# BEGIN ############### tag Summary Tables ####################
!block example;
- [B<tag> op argI<other_named_attributes>]
+ [B<tag> op arg I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -12636,7 +12646,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#tag_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -12654,9 +12663,9 @@
B<Tag expansion example:>
=20
!block example
- [tag op arg]
+ [tag op arg]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -12729,8 +12738,8 @@
shopping cart to the file logs/transactions.txt:
=20
> [tag log logs/transactions.txt]
-> [item_list][item-code] [item-description]
-> [/item_list][/tag]
+> [item-list][item-code] [item-description]
+> [/item-list][/tag]
=20
The file is relative to the catalog directory, and only may be
an absolute path name if I<NoAbsolute> is set to C<No>.
@@ -12851,7 +12860,7 @@
=20
# BEGIN ############### time Summary Tables ####################
!block example;
- [B<time> localeI<other_named_attributes>]
+ [B<time> locale I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -12862,7 +12871,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#time_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -12880,9 +12888,9 @@
B<Tag expansion example:>
=20
!block example
- [time locale]
+ [time locale]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -13044,7 +13052,7 @@
=20
# END ++++++++++++ time Subsections +++++++++++++
=20
-H2: timed_build
+H2: timed-build
=20
=20
H3: Summary
@@ -13060,7 +13068,7 @@
=20
Must pass named parameter interpolate=3D1 to cause interpolation.
=20
-This is a container tag, i.e. [timed_build] FOO [/timed_build].
+This is a container tag, i.e. [timed-build] FOO [/timed-build].
\Nesting: NO
=20
Invalidates cache: B<no>
@@ -13082,9 +13090,9 @@
=20
=20=20
=20
-# BEGIN ############### timed_build Summary Tables ####################
+# BEGIN ############### timed-build Summary Tables ####################
!block example;
- [B<timed_build> file I<other_named_attributes>]
+ [timed-build file I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -13095,7 +13103,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#timed_build_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -13113,9 +13120,9 @@
B<Tag expansion example:>
=20
!block example
- [timed_build file]
+ [timed-build file]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -13132,7 +13139,7 @@
$Tag->timed_build(file, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ timed_build End Summary Tables ++++++++++++++++++++
+# END +++++++++++++++ timed-build End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
@@ -13140,7 +13147,7 @@
=20
Allows you to build CPU-intensive regions of ITL tags on a timed basis.
=20
-In the simplest case, surround a region of ITL with E<lbracket>{{C[jump=3D=
"#timed_build"]timed-build}}]
+In the simplest case, surround a region of ITL with E<lbracket>{{C[jump=3D=
"#timed-build"]timed-build}}]
and C<[/timed-build]>:
=20
> [timed-build]
@@ -13226,12 +13233,12 @@
=20
=20
=20
-# BEGIN ########### timed_build Subsections ##############
+# BEGIN ########### timed-build Subsections ##############
H4: {{CMD[id=3D"timed_build_file"]file}}
=20
=20
=20
-# END ++++++++++++ timed_build Subsections +++++++++++++
+# END ++++++++++++ timed-build Subsections +++++++++++++
=20
H2: tmp
=20
@@ -13299,9 +13306,7 @@
B<Tag expansion example:>
=20
!block example
- [tmp name]value[/tmp]
----
-
+ [tmp name]value[/tmp]
!endblock
=20
=20
@@ -13443,7 +13448,7 @@
# END ++++++++++++ tmpn Subsections +++++++++++++
=20
=20
-H2: total_cost
+H2: total-cost
=20
=20
H3: Summary
@@ -13481,9 +13486,9 @@
=20
=20=20
=20
-# BEGIN ############### total_cost Summary Tables ####################
+# BEGIN ############### total-cost Summary Tables ####################
!block example;
- [B<total_cost> name noformat]
+ [total-cost name noformat]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -13515,9 +13520,9 @@
B<Tag expansion example:>
=20
!block example
- [total_cost name noformat]
+ [total-cost name noformat]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -13535,7 +13540,7 @@
$Tag->total_cost(name,noformat, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ total_cost End Summary Tables ++++++++++++++++++++
+# END +++++++++++++++ total-cost End Summary Tables ++++++++++++++++++++
=20
=20
H3: Description
@@ -13549,7 +13554,7 @@
=20
=20
=20
-# BEGIN ########### total_cost Subsections ##############
+# BEGIN ########### total-cost Subsections ##############
H4: {{CMD[id=3D"total_cost_name"]name}}
=20
=20
@@ -13558,7 +13563,7 @@
=20
=20
=20
-# END ++++++++++++ total_cost Subsections +++++++++++++
+# END ++++++++++++ total-cost Subsections +++++++++++++
=20
H2: tree
=20
@@ -13606,7 +13611,7 @@
=20
# BEGIN ############### tree Summary Tables ####################
!block example;
- [B<tree> table master subordinate startI<other_named_attributes>]
+ [B<tree> table master subordinate start I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -13626,7 +13631,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#tree_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate}}|I<No>
{{CMD[jump=3D"#attr_reparse"]reparse}}|I<Yes>
!endblock
@@ -13644,9 +13648,9 @@
B<Tag expansion example:>
=20
!block example
- [tree table master subordinate start]
+ [tree table master subordinate start]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -13672,7 +13676,7 @@
H3: Description
=20
Provides iterative list capability for binary trees. It produces
-hash-based rows use the same tags as E<lbracket>{{C[jump=3D"#item_list"]it=
em-list}}]; sets some additional
+hash-based rows use the same tags as E<lbracket>{{C[jump=3D"#item-list"]it=
em-list}}]; sets some additional
hash key entries to describe the tree and provide display control.
=20
Works on a data set with the structure:
@@ -13963,13 +13967,13 @@
B<Tag expansion example:>
=20
!block example
- [set divisor]0[/set]
- [try label=3Ddiv]
- [calc] 1 / [scratch divisor] [/calc]
- [/try]
- [catch div]Division error[/catch]
+ [set divisor]0[/set]
+ [try label=3Ddiv]
+ [calc] 1 / [scratch divisor] [/calc]
+ [/try]
+ [catch div]Division error[/catch]
---
- Division Error
+ Division Error
!endblock
=20
=20
@@ -14011,11 +14015,11 @@
The try tag will also place a result in the $Session object. For example,=
the following returns the 'Illegal division by zero...' error message if i=
t N<occurs:>
=20
!block example
- [try label=3Ddivide][calc] 1 / [scratch divisor] [/calc][/try]
+ [try label=3Ddivide][calc] 1 / [scratch divisor] [/calc][/try]
=20
- [catch divide]
- [calc]$Session->{try}{divide}[/calc]
- [/catch]
+ [catch divide]
+ [calc]$Session->{try}{divide}[/calc]
+ [/catch]
!endblock
=20
The $Session->{try}{divide} object will be set to the empty string ('') if=
there was no error, or it will contain the error message if there was an e=
rror.
@@ -14100,9 +14104,9 @@
B<Tag expansion example:>
=20
!block example
- [update function]
+ [update function]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -14205,7 +14209,6 @@
=20
!block table; colvaligns=3D"TT"
Attributes|Default
-{{CMD[jump=3D"#userdb_ATT1"]ATT1}}|I<none>
{{CMD[jump=3D"#attr_interpolate"]interpolate (reparse)}}|I<No>
!endblock
=20
@@ -14222,9 +14225,9 @@
B<Tag expansion example:>
=20
!block example
- [userdb function]
+ [userdb function]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -14250,7 +14253,7 @@
=20
Interchange provides a C<[userdb ...]> tag to access the UserDB functions.
=20
-> [userdb
+> [userdb
> function=3Dfunction_name
> username=3D"username"*
> password=3D"password"*
@@ -14265,7 +14268,7 @@
> hide=3D1
> show=3D1
> ...
-> ]
+> ]
=20
\* Optional
=20
@@ -14365,9 +14368,9 @@
Assuming form variable 'foo' =3D 'bar',
=20
!block example
- [value foo]
+ [value foo]
---
- bar
+ bar
!endblock
=20
B<ASP-like Perl call:>
@@ -14458,8 +14461,8 @@
otherwise false. The following will expand to N<"Using default":>
=20
!block example
- [value name=3Dmyname set=3D0 hide=3D1]
- [value name=3Dmyname default=3D"Using default"]
+ [value name=3Dmyname set=3D0 hide=3D1]
+ [value name=3Dmyname default=3D"Using default"]
!endblock
=20
=20
@@ -14469,7 +14472,7 @@
This conversion can be disabled using 'C<enable_html>=3D1'.
=20
=20
-H2: value_extended
+H2: value-extended
=20
=20
H3: Summary
@@ -14503,9 +14506,9 @@
=20
=20=20
=20
-# BEGIN ############### value_extended Summary Tables ####################
+# BEGIN ############### value-extended Summary Tables ####################
!block example;
- [B<value_extended> name I<other_named_attributes>]
+ [value-extended name I<other_named_attributes>]
!endblock
=20
!block table; colvaligns=3D"TTT"; format=3D"262"
@@ -14533,9 +14536,9 @@
B<Tag expansion example:>
=20
!block example
- [value_extended name]
+ [value-extended name]
---
- TODO: (tag result)
+ TODO: (tag result)
!endblock
=20
=20
@@ -14552,7 +14555,7 @@
$Tag->value_extended(name, $attribute_hash_reference, $body);
!endblock
=20
-# END +++++++++++++++ value_extended End Summary Tables ++++++++++++++++++=
++
+# END +++++++++++++++ value-extended End Summary Tables ++++++++++++++++++=
++
=20
=20
=20
@@ -14650,12 +14653,12 @@
=20
=20
=20
-# BEGIN ########### value_extended Subsections ##############
+# BEGIN ########### value-extended Subsections ##############
H4: {{CMD[id=3D"value_extended_name"]name}}
=20
=20
=20
-# END ++++++++++++ value_extended Subsections +++++++++++++
+# END ++++++++++++ value-extended Subsections +++++++++++++
=20
H1: User-defined Tags
=20
@@ -14931,7 +14934,7 @@
[/selected]
[/bar-button]
</tr></table>
-------------------------------------------------------
+---
PAGE-1 PAGE-2-selected PAGE-3
!endblock
=20
@@ -14984,8 +14987,8 @@
H3: Summary
=20
!block example;
- [B<convert_date> day* other_named_attributes>[/convert_date]
- [B<convert_date> day=3Dn* other_named_attributes[/convert_date]
+ [B<convert_date> day* I<other_named_attributes>[/convert_date]
+ [B<convert_date> day=3Dn* I<other_named_attributes>[/convert_date]
!endblock
=20
!block note; label=3D"Positional parameters: "
@@ -15028,7 +15031,7 @@
i. [convert-date]200 1 - --051 =3D9[/convert-date]
j. [convert-date]2001 - --05 -20 11 1 5[/convert-date]
k. [convert-date raw=3D1]2001-05-21 11:15[/convert-date]
-------------------------------------------------------
+---
a. 18-May-2001 03:15AM (todays day and time)
b. 19-May-2001 03:15AM (today + 1 day)
c. 17-May-2001 03:15AM (today - 1 day)
@@ -15114,13 +15117,13 @@
B<Tag expansion example:>
=20
!block example
- [db-date]
- [db-date cat]
- [db-date table=3Dcat format=3D"%d %b %Y"]
-------------------------------------------------------
- Wednesday 02 May 2001 (products.txt)
- Wednesday 03 May 2001 (cat.txt)
- 03 May 2001 (cat.txt)
+ [db-date]
+ [db-date cat]
+ [db-date table=3Dcat format=3D"%d %b %Y"]
+---
+ Wednesday 02 May 2001 (products.txt)
+ Wednesday 03 May 2001 (cat.txt)
+ 03 May 2001 (cat.txt)
!endblock
=20
B<ASP-like Perl call:>
@@ -15182,9 +15185,8 @@
B<Tag expansion example:>
=20
!block example
- [delete_cart mycart]
- [delete_cart nickname=3D"mycart"]
-------------------------------------------------------
+ [delete_cart mycart]
+ [delete_cart nickname=3D"mycart"]
!endblock
=20
B<ASP-like Perl call:>
@@ -15253,14 +15255,13 @@
B<Tag expansion example:>
=20
!block example
- [email
- to=3D"foo@bar.com"
- subject=3D"Greetings"
- from=3D"bar@foo.com"
- ]
- Hello World
- [/email]
-------------------------------------------------------
+ [email
+ to=3D"foo@bar.com"
+ subject=3D"Greetings"
+ from=3D"bar@foo.com"
+ ]
+ Hello World
+ [/email]
!endblock
=20
B<ASP-like Perl call:>
@@ -15338,14 +15339,13 @@
B<Tag expansion example:>
=20
!block example
- [email_raw]
+ [email_raw]
From: foo@bar.com
To: bar@foo.com
Subject: baz
=20
The text of the message.
- [/email_raw]
-------------------------------------------------------
+ [/email_raw]
!endblock
=20
The headers must be at the beginning of the line, and the header
@@ -15440,9 +15440,8 @@
B<Tag expansion example:>
=20
!block example
- [get-url http://demo.akopia.com/]
- [get-url url=3D"http://demo.akopia.com/" strip=3D1]
-------------------------------------------------------
+ [get-url http://demo.akopia.com/]
+ [get-url url=3D"http://demo.akopia.com/" strip=3D1]
!endblock
=20
B<ASP-like Perl call:>
@@ -15514,9 +15513,8 @@
B<Tag expansion example:>
=20
!block example
- [load_cart mycart:990102732:c]
- [load_cart nickname=3D"mycart:990102732:c"]
-------------------------------------------------------
+ [load_cart mycart:990102732:c]
+ [load_cart nickname=3D"mycart:990102732:c"]
!endblock
=20
B<ASP-like Perl call:>
@@ -15598,9 +15596,8 @@
B<Tag expansion example:>
=20
!block example
- [save_cart mycart]
- [save_cart nickname=3Dmycart recurring=3D1]
-------------------------------------------------------
+ [save_cart mycart]
+ [save_cart nickname=3Dmycart recurring=3D1]
!endblock
=20
B<ASP-like Perl call:>
@@ -15681,14 +15678,14 @@
B<Tag expansion example:>
=20
!block example
- [loop list=3D"10 20 30.5"]
- [summary amount=3D"[loop-code]" hide=3D1]
- [/loop]
- [summary total=3D1 format=3D"%.3f"]
- [summary total=3D1 currency=3D1]
-------------------------------------------------------
- 60.500
- $60.50
+ [loop list=3D"10 20 30.5"]
+ [summary amount=3D"[loop-code]" hide=3D1]
+ [/loop]
+ [summary total=3D1 format=3D"%.3f"]
+ [summary total=3D1 currency=3D1]
+---
+ 60.500
+ $60.50
!endblock
=20
B<ASP-like Perl call:>
@@ -15764,11 +15761,11 @@
H3: Summary
=20
!block example;
- [B<table-organize> cols* other_named_attributes]
+ [B<table-organize> cols* I<other_named_attributes>]
[loop ....] <td> [loop-tags] </td> [/loop]
[/table-organize]
=20=09
- [B<table-organize> cols=3Dn* other_named_attributes]
+ [B<table-organize> cols=3Dn* I<other_named_attributes>]
[loop ....] <td> [loop-tags] </td> [/loop]
[/table-organize]
!endblock
@@ -15821,10 +15818,10 @@
td.0=3D'align=3Dright'
td.1=3D'align=3Dcenter'
td.2=3D'align=3Dleft'
- ]
+ ]
[loop list=3D"1 2 3 1a 2a 3a 1b"] <td> [loop-code] </td> [/loo=
p]
[/table-organize]
-------------------------------------------------------
+---
<tr bgcolor=3D"#EEEEEE">
<td align=3Dright>1</td>
<td align=3Dcenter>2</td>
@@ -16018,9 +16015,8 @@
B<Tag expansion example:>
=20
!block example
- [title-bar 600 5 red]My title[/title-bar]
- [title-bar width=3D600 size=3D5 color=3D"#ff0000"]My title[/title-bar]
-------------------------------------------------------
+ [title-bar 600 5 red]My title[/title-bar]
+ [title-bar width=3D600 size=3D5 color=3D"#ff0000"]My title[/title-bar]
!endblock
=20
B<ASP-like Perl call:>
@@ -16072,7 +16068,7 @@
H2: var
=20
=20
-H2: xml_generator
+H2: xml-generator
=20
This is a quick and dirty tag that generates XML tags based upon one of
two types of data (delimited and session).
@@ -16080,9 +16076,9 @@
H3: Summary
=20
!block example;
- [B<xml-generator> type* other_named_attributes][/xml-generator]
- [B<xml-generator> type=3Dvalue* other_named_attributes][/xml-generator]
- [B<xml-generator> type=3Dvalue* other_named_attributes][][/xml-generat=
or]
+ [B<xml-generator> type* I<other_named_attributes>][/xml-generator]
+ [B<xml-generator> type=3Dvalue* I<other_named_attributes>][/xml-genera=
tor]
+ [B<xml-generator> type=3Dvalue* I<other_named_attributes>][][/xml-gene=
rator]
=20
*Optional
!endblock
@@ -16124,27 +16120,28 @@
B<Tag expansion example:>
=20
!block example
-[xml-generator=20
- type=3Ddelimited=20
- attributes=3D"date"=20
- date=3D"[tag time]%d-%b-%Y[/tag]"
- toplevel_tag=3Dproducts]code description price
-[query list=3D1 sql=3D"select sku, description, price from products" prefi=
x=3Dxml][xml-code] [xml-param description] [xml-param price]
-[/query][/xml-generator]
-------------------------------------------------------
-<products date=3D"18-May-2001">
- <record key=3D"os28113">
- <code>os28113</code>
- <description>The Claw Hand Rake</description>
- <price>14.99</price>
- </record>
- <record key=3D"os28006">
- <code>os28006</code>
- <description>Painters Brush Set</description>
- <price>29.99</price>
- </record>
- ...
-</products>
+ [xml-generator type=3Ddelimited=20
+ attributes=3D"date"=20
+ date=3D"[tag time]%d-%b-%Y[/tag]"
+ toplevel_tag=3Dproducts
+ ]code description price
+ [query list=3D1 sql=3D"select sku, description, price from product=
s" prefix=3Dxml][xml-code] [xml-param description] [xml-param price]
+ [/query]
+ [/xml-generator]
+---
+ <products date=3D"18-May-2001">
+ <record key=3D"os28113">
+ <code>os28113</code>
+ <description>The Claw Hand Rake</description>
+ <price>14.99</price>
+ </record>
+ <record key=3D"os28006">
+ <code>os28006</code>
+ <description>Painters Brush Set</description>
+ <price>29.99</price>
+ </record>
+ ...
+ </products>
!endblock
=20
B<ASP-like Perl call:>
@@ -16255,11 +16252,11 @@
=20
The attributes (if any) to pass on to the top level tag. For instance,
!block example
- [xml-generator
- attributes=3D"date"
- date=3D"[tag time]%d-%b-%Y[/tag]"
- toplevel_tag=3Dorder
- ][/xml-generator]
+ [xml-generator
+ attributes=3D"date"
+ date=3D"[tag time]%d-%b-%Y[/tag]"
+ toplevel_tag=3Dorder
+ ][/xml-generator]
=20
will generate a toplevel tag pair of:
=20
@@ -16367,10 +16364,10 @@
=20
!block example
[xml-generator type=3D"values|scratch"=20
- values=3D"value1|value2"=20
- scratch=3D"scratch1|scratch2"
- spacer=3D"|"
- ][/xml-generator]
+ values=3D"value1|value2"=20
+ scratch=3D"scratch1|scratch2"
+ spacer=3D"|"
+ ][/xml-generator]
!endblock
=20
H4: {{CMD[id=3D"xml_generator_skip_empty"]skip_empty}}
@@ -16447,11 +16444,11 @@
B<Tag expansion example:>
=20
!block example
- [dummy first=3Dpig_latin second=3D"Capitalize"]\
- Body text acted on by the tag goes here.[/dummy]
-------------------------------------------------------
- OdyBay ExtTaY ActedAy OnAy YBay EThay AgTay OesGay \
- EreHay.
+ [dummy first=3Dpig_latin second=3D"Capitalize"]\
+ Body text acted on by the tag goes here.[/dummy]
+---
+ OdyBay ExtTaY ActedAy OnAy YBay EThay AgTay OesGay \
+ EreHay.
!endblock
=20
!block note; label=3D"Reading the tag expansion example: "
@@ -16526,17 +16523,16 @@
=20
.{{}}
=20
-+ Any E<lbracket>{{C[jump=3D"ictags.html#pragma"]pragma}}] tags anywhere
++ Any C<[pragma]> tags anywhere
in the text are processed, and the specified pragmas are set.
=20
-** Since E<lbracket>{{C[jump=3D"ictags.html#pragma"]pragma}}] tags are
-preprocessed before any other content,
-{{C[jump=3D"ictags.html#attr_reparse"]reparse}} will not catch them, nor
+** Since C<[pragma]> tags are preprocessed before any other content,
+{{C[jump=3D"#attr_reparse"]reparse}} will not catch them, nor
will they work if included in variables. Also, the specified pragma
will apply to the entire template (not just the section after the tag).
=20
** If you want to apply a pragma with a variable or only to part of a
-document, you must use E<lbracket>{{C[jump=3D"ictags.html#tag"]tag}}E<nbsp=
ace>pragma=3D"..."]
+document, you must use E<lbracket>{{C[jump=3D"#tag"]tag}}E<nbspace>pragma=
=3D"..."]
instead.
=20
.{{}}
@@ -16555,8 +16551,8 @@
.{{}}
=20
+ False-endtag macros are expanded (e.g.,
-E<lbracket>{{C[jump=3D"ictags.html#page"]/page}}] and
-E<lbracket>{{C[jump=3D"ictags.html#order"]/order}}]).
+E<lbracket>{{C[jump=3D"#page"]/page}}] and
+E<lbracket>{{C[jump=3D"#order"]/order}}]).
=20
..{{}}
=20
@@ -16575,16 +16571,16 @@
=20
+ The main tag parser is called.
=20
-** Some tags parse recursively (depending on
-{{C[jump=3D"ictags.html#attr_reparse"]reparse}} and
-{{C[jump=3D"ictags.html#attr_interpolate"]interpolate}} settings, of cours=
e).
+** Some tags parse recursively (depending upon
+{{C[jump=3D"#attr_reparse"]reparse}} and
+{{C[jump=3D"#attr_interpolate"]interpolate}} settings, of course).
=20
-** Some tags (e.g., E<lbracket>{{C[jump=3D"ictags.html#loop"]loop}}])
+** Some tags (e.g., E<lbracket>{{C[jump=3D"#loop"]loop}}])
process PREFIX-tags in their contained body text. Hence, the PREFIX-tags a=
re
not handled recursively.
=20
-** Some tags are interpreted in the lib/Vend/Parse.pm:start routine. You c=
annot call them with the '$Tag->I<tagname>' syntax. They N<are:>
-*** The E<lbracket>{{C[jump=3D"#goto"]goto}}] tag. Note also that the {{C[=
jump=3D"#goto"]goto}} tag handles the E<lbracket>{{C[jump=3D"#label"]label}=
}] tag.
+** Some tags are interpreted in the lib/Vend/Parse.pm:start routine. You c=
annot call them with the '$Tag->I<tagname>()' syntax. They N<are:>
+*** The E<lbracket>{{C[jump=3D"#goto"]goto}}] tag. Note also that the E<lb=
racket>{{C[jump=3D"#goto"]goto}}] tag handles the E<lbracket>{{C[jump=3D"#l=
abel"]label}}] tag.
*** The E<lbracket>{{C[jump=3D"#bounce"]bounce}}] tag.
=20
.{{}}
@@ -16599,7 +16595,7 @@
A2: Nonstandard parsing within the admin interface
=20
Parsing of content via the specialized
-{{C[jump=3D"ictags.html#UI_ut_regenerate"]regenerate}} usertag included
+{{C[jump=3D"#UI_ut_regenerate"]regenerate}} usertag included
with the administrative interface does not obey the above order. The
MV_AUTOLOAD and '<!--[tagname]-->' escapes are skipped. There are
some other more subtle differences as well; in the very unlikely event