Interchange Reference Pages: Tags


For a complete introduction to the Interchange Tag Language and the supported syntax, please see the ITL glossary entry.

Table of Contents

accessories — access to product options attributes
accounting
add-gpg-key — add a GPG/PGP key to keyring
address
area — produce a hypertext link URL
assign — assign overrides for salestax, shipping, handling and subtotal
assume-identity — override value of MV_PAGE on a page
attr_list
auto-wizard
available_ups_internal
available_www_shipping
backup-database — backup Interchange databases, even rows selectively
backup-file — backup Interchange file
banner — display banner ads or messages, based on category and optional weighting
bar-button — display content (usually a menu bar) based on page name
base-url — retrieve value of the VendURL directive
breadcrumbs
button — create HTML or JavaScript form submit button
calc — evaluate the enclosed arithmetic expression or Perl block
calcn — evaluate the enclosed arithmetic expression or Perl block
captcha — handle captcha images used for authentication
capture_page — process page and save output to file and/or scratch variable
cart — set the current shopping cart
catch — handle failed 'try' blocks
cgi — expand to value of the CGI variable specified in body
charge — perform a transaction with a payment gateway
check-upload
checked — indicate checked status of checkboxes
child-process
comment — comment (disable) parts of Interchange or HTML code
component — display component
content-editor
content-info
content-modify
control — Retrieve component attributes
control-set — Retrieve component attributes
convert-date — convert date to a specified format
counter — manipulate a persistent, named counter
cp — copy a file
crypt — run Unix crypt() function on input data
css — generate CSS file and create a link to it
currency — format number as currency, honoring default or specified locale
data — get or set value of a named field or row from a database table or user session
db-date — report last-modified time of the named database source file
db-hash
db_columns — retrieve column names from a database table
debug — send messages to debug log
default — (deprecated) return content of the named form input field, defaulting to value 'default'
delete_cart — delete shopping cart from UserDB
deliver — deliver arbritary content verbatim, without Interchange processing
description — return description for a specific product from the products database
diff
diffmerge
directive_value
discount — implement per-customer item or order discounts
discount_space
dispatch
display — display HTML form element
dump — display dump of current session
dump_session — dump named user session partially or in whole
either
email — send e-mail using SendMailProgram
email-raw — send raw-formatted e-mail using SendMailProgram
env — provides read-only access to the HTTP environment variables
error — display and manipulate errors stored in session
evalue — return encoded content of the named form input field
export — export a database to a text file
export-database
fcounter
field — quickly retrieve field from Products database
file — include file into the current page verbatim
file-info — retrieve file information
file-navigator
filter — apply one or multiple filters
flag
flag_job
flex-select — tabular overview for a database table
fly-list — display item in a flypage-like fashion
fly-tax
form-session-id — insert hidden form field containing the session ID
formel — generate HTML form elements
fortune — use the "fortune" program to display random saying
forum — display forum threads
forum-userlink
get-gpg-keys — lists GPG keys
get-url — dispatch HTTP request and return response
global-value
grep-mm
handling — calculate and display handling costs
harness
history-scan — generate link to (or just display name of) a previously visited page
href
html-table — output HTML table
if — conditional parsing
if-mm — check permissions for UI tasks
if_not_volatile
image — general purpose tag for generating HTML <img> tags
import — import records into database
import_fields
include — include file into the current page and reparse contents for tags
index
input-filter — add or remove filters applied to CGI variables
item-list — iterate through items in the cart
jsq — return a string for use in JavaScript, quoted and with variables substituted
jsqn — return a string for use in JavaScript, quoted, without variables substituted
jsquote
l
labeled_data_row
levies — display total cost of levy charges
levy-list — display a list of levy charges
list-databases
list-keys
list_glob — list files matching a pattern
list_pages — list pages
load_cart — load shopping cart from UserDB
loc — localize provided input
local
log — write custom message to arbitrary log file
loop — iterate through a list
loop_list
mail
menu — displays HTML menu
menu-load
meta-info
meta-record
mm-value — display UI access control value
mm_locale
more_list — pagination for Interchange lists
msg
mvasp
newer
nitems — return the total number of items in the electronic cart
object
onfly
options
order — produce an order link
output-to — map output
page — produce a hypertext link
page-meta
parse_locale
pay-cert
pay-cert-redeem
perl — evaluate embedded Perl code
price — calculate product price
process
process-order
process-target
profile — set UserDB profile
query — run SQL query
quick_table
rand — return random element from an arbitrarily-separated list
read-cookie — reads browser cookie
read-shipping
reconfig
reconfig-time
record
region
report-table
return_to
rotate-table
row
row-edit
run-profile — runs form profile
salestax — display salestax for products within cart
save_cart — save shopping cart to UserDB
scratch — return content of the named scratch variable
scratchd — return value of scratch variable, then delete the variable
search
search-region — container for search results
search_region
selected — identicate selected status of HTML options
self_contained_if
set — set value of scratch variable, without interpolation
set-cookie — sets browser cookie
seti — set value of scratch variable, with interpolation
setlocale — Change current locale
shipping — display shipping cost for items in electronic cart
shipping-desc — displays shipping mode description
shipping-description
soap
soap_entity
sort_ary
sort_hash
sql_list
strip — trim leading and trailing whitespace
su
substitute_file
subtotal — display total cost of products within cart
summary
tabbed-display
table-editor — table editor
table-organize — automatically organize table cells into rows or columns
tag
time — display formatted date, similar to strftime POSIX function
timed-build — save output of Interchange interpolation to named file (cache pages)
timed-display
title-bar
tmp — temporarily set value of scratch variable, with interpolation
tmpn — temporarily set value of scratch variable, without interpolation
tn
total-cost — display total cost of electronic cart, including all adjustments
traffic-report
tree — display tree-like structure from database
try — safely execute a code block and test for errors
ts
tv
uc-attr-list — replaces placeholders in curly braces with provided values
uneval
uninstall_feature
unless
unlink_file — safely delete a file within catalog root directory
unpack — unpacks mapped output into template
update — refresh specific set of internal data
update-order-status
ups-query
user-merge
userdb — access user database functions
usertrack — append usertrack entry with arbitrary key=value pair
usps-query
value — expand to value of the UserDB variable specified in body
value-extended — Expand value
value_extended
values-space — switch between value namespaces
var — access local (catalog) and global Interchange variables
version — print all sorts of Interchange-related system information
warning — display and manipulate warnings stored in session
warnings — display and manipulate warnings stored in session
weight — calculate total weight of items in shopping cart
widget
widget-info — Access information for a particular widget
widget-meta
write-relative-file — save content to a filename inside the catalog directory
write-shipping

DocBook! Interchange!