Glossary of Tags F - R


^ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ? Panel

Select the first letter of the word from the list above to link to appropriate section of the glossary.


F


face
Within a file, *.tag, defines the face which can be place on a tame button. Unlike an image this tag includes both an image and a text face. Depending on the use of the *TAGNAME* either the image or the test will appear on the tame page.

<tame>
face:
*TAGNAME* BUTTON-FACE-TEXT DOCUMENT-LOCATION HTML-OPTION-LIST
</tame>

TAGNAME:
The name to use as the tag name for the image.
HTML-OPTION-LIST:
List of options for the image. Can include any valid options for the HTML <image> tag.

Example:

<tame face: *buy* buy buy.gif alt="[ Buy ]" width=82 height=28 border=0>

Adding this command to *.tag file will provide a "buy button" that can be used on a tame page by using the syntax {*buy*}.

See Also: image, define, button-face-area, creating tags


foreach
Iterates through all the rows in the table. foreach will generate a HTML/TAME area for each row of the table designated by the workwith command. This tag established a context of a particular row, therefore the row indicator in the data retrieval tags can be omitted.
 
<tame foreach:: HTML-AREA>
Note the double colons.
HTML-AREA:
The HTML to format the data and the TAME command to retrieve the required information from a table.

Note: foreach must be used with the workwith command.

Example:

<table width=50% cellpadding=1 border=2>
<tr><td>ITEM</td> <td>PRICE</td> <td>DESCRIPTION</td> <td>SELECT TO PURCHASE</td></tr>
<tame workwith: data>
<tame foreach::
<tr><td>{?item}</td>
<td>{?price}</td>
<td>{?descrip}</td>
<td><tame ^buy: {?item}></td></tr>
>
<tame /workwith>
</table>

This example will provide the item, price, description and a buy button for each item in the table data. The information will be presented on the page within a HTML table.

See Also: workwith, {?}, define_wgrep, define_sql, define_tdb


field-name
The column name of a field in a database. The field is distingished by a ? at the beginning of the name.

{?FIELD-NAME}

Example:

<tame form>
<tame workwith: product.tdb>
ITEM NUMBER: {?item}<br>
PRICE: {?item,price}<br>
DESCRIPTION: {?item,descrip}<br>
<tame /workwith>
<tame /form>

This example presents an item with price and description to the customer.

See also: ?, pass


form
Generates the HTML to start a tame form area and syncronizes the form with tame input tags.

End Mark Required: /form

<tame form: DOCUMENT-LOCATION>

DOCUMENT-LOCATION
The URL where the form will be submitted. The default is to submit to the same page that generated the current form which is usually the desired location.

Example:

<tame form>
<tame text: name 40> Your name
<tame text: email 40> Your email address
<tame checked box: send_flyer> Send you a flyer?
<tame /form>
 
This example presents a questionaire for customer completion.

See also: text, radio, box


G


getcart
Accesses variables saved in the cart for presentation.
 
<tame getcart: VARIABLE >
 

H


hidden
An input type that allows for information store with a page to be hidden from view.

<tame hidden: NAME VALUE >

Example:

<tame hidden: computer.item computer>
<tame hidden: computer.qty 1>
<tame buysubmit: Go to order page>

Using the hidden input type, the computer item code and quantity values are associated with the page, but are not visible to the customer. The buysubmit will add the computer to the shopping cart.

See Also: form buying, item, ^buysubmit


HTML-AREA
This is the normal type of area on any .html, .htm or .tam page. It functions as if it were not contained within a tame markup. On a tame page the html-area can contain tame markup sections.

See Also: HTML-argument-area


HTML-ARGUMENT-AREA
This is an area within a tame markup to the right of the colon (:) that contains text, HTML markups or Tame extensions. An HTML-argument-area is ended with a semicolon and the section after the semicolon is a program-area. HTML-argument-areas are also ended by a }, > or </tame> like HTML-areas. Unless you are using advanced features of tame be aware of the use of semicolons, they may create results you do not expect or want.

See Also: HTML-area


htmlfile
Presents an html file from a directory or referenced from a table, dynamically on a page.

<tame>htmlfile: PATH-FILE </tame>

Example:

<tame> htmlfile: coolfile.tam </tame>

The information in the coolfile.tam are retrieved with this command.

If you create your product table like this one:

item price description detail
P001 4.95 "Hot item" hotpage.tam

Then on the page where you want the file to appear you put:

<tame>htmlfile: {?pdb,P001,detail}</tame>

This will show the file, hotpage.tam, to the customer. This tag works within workwith tags and can also include field variables such as ?item.

See Also: Data Access


http:
^link modifier. Causes an http:// link to be generated. Used to switch out of https back to http.

<tame http ^link: DOCUMENT-LOCATION HTML-AREA>

Example:

<tame http ^link: gotcard.tam credit card number was entered>

This example will link the customer, currently on a secure page where the credit card number was entered, to the page gotcard.tam and exit https secure mode.

See Also: ^link, https, outside, unique


https:
^link modifier. Causes an https:// link to be generated when the browser supports https.

<tame https ^link: DOCUMENT-LOCATION HTML-AREA>

Example:

<tame https ^link: getcard.tam enter credit card number>

This example will link the customer in a secure mode so that the credit card number can be input.

See Also: ^link, http, outside, unique


I


image
Defines a tame image that can be placed in documents as a single tag or used within other tame commands.
 
<tame>
image: *TAGNAME* DOCUMENT-LOCATION HTML-OPTION-LIST
</tame>
TAGNAME:
The name to use as the tag name for the image.
HTML-OPTION-LIST:
List of options for the image. Can include any valid options for the HTML <image> tag.

Example:

<tame image: *ball* /images/ball.gif alt="*" width=14 height=14 align=bottom>

See also: place, ^goto, define, face, creating tags


include
Associates the user-defined commands within a tag file with the *.tam file. The include must be presented prior to using functions define in the tag file.

<tame>include: PATH-FILE</tame>

Example:

In the file coolfile.tam:

<tame>include: coolfile.tag </tame>

All the information and variables defined in the coolfile.tag are now accessable in the coolfile.tam file.

See Also: define, place, face, Creating your own tags


input_quality


input_quality2


input_qty


ITEM
Item code corresponding to an item entry in the product database. When the ITEM is already being supplied by another input box or hidden variable on the page, leave off the arguments or make the ITEM argument null by using an empty pair of square brackets [ ].

item_image
??

<tame item_image: ITEM HTML-ARGUMENT-AREA1 HTML-ARGUMENT-AREA2>

HTML-ARGUMENT-AREA1
Text or image to display if the item-code is not in the cart.
 
HTML-ARGUMENT-AREA2
Text or image to display if the item-code is in the cart.
Note: This feature is not sensitive to item qualities. It detects only the existence of the item code in the cart. It does not differentiate between items with different qualities such as "color", "size", etc. A red shoe1 in the cart will be the same as a green shoe1 in the cart.

Example

See Also:


J K L


M


N


new_query
Modifier used with ^link tag to reset a query page to which you return your customer to the first hit. If you don't use this modifier, the query sequence available to the customer the last time he was on the page will be used. Therefore, your customer will not necessarily start out on hit 1.
 
Note: When you use pass on a link, you don't need new_query.

<tame> new_query ^LINK/^GOTO: DOCUMENT-LOCATION HTML-ARGUMENT-AREA </tame>

Example:

<tame new_query ^goto: search.tam Search by Title>

Using the new_query modifier will return the customer to the first record returned by the query. This is useful if an item has been selected and you want the customer to have access to an entire listing for his next choice.

See Also: query.pan, subquery.pan, Data Access


O


Outside
^link modifier. Creates a link outside of tamespace to another domain or a pure html page. When a customer passes through an ouside link, tame will loose the lock on the customer's identity. Pure html pages can be displayed using outside links as long as the customer is requried to use the browser back button to continue browsing. A link from a html page will ot contain tame tracking information such as the shopping cart.

See Also: ^link


P


page_end
This tag is place a the end of a tame page to provide a footer on the page. The information presented is defined in the shop admin wizard under the page_end sections for application and catalog pages. You can also create unique page_end information by using the define tag at the top of a page.

<tame> page_end </tame>
</body>
</html>

Note: The page_end tag is used in conjunction with the html </body> and </html> tags.

Example:

<html>
<head>
<tame tamehead: index.tam page>
<title>Books and Video Shop Front Page</title>
</head>
<body bgcolor="ffffff" text="000000" link="0000ff" vlink="0000ff" alink="0000ff">
You would put your information here [html and tame code]
<tame page_end>
</body>
</html>

This is a standard tame page which will present the page_end define in the admin wizard on the bottom of the page.

<html>
<tame> define page_end: Special orders are gladly accepted. </tame>
<head>
<tame tamehead: index.tam page>
<title>Books and Video Shop Front Page</title>
</head>
<body bgcolor="ffffff" text="000000" link="0000ff" vlink="0000ff" alink="0000ff">
You would put your information here [html and tame code]
<tame page_end>
</body>
</html>

This is a standard tame page which will present the unique page_end "Special orders are gladly accepted." at the bottom of the page instead of the page_end defined in the admin wizard.

See Also: tamehead


pass
This modifier of ^link and ^goto tags is used to pass variables to another page. The variables included in the pass on the page where the link is initiated will be passed to and remembered on the destination page. In addition, the database context of the workwith area containing this tag will be passed and remembered on the destination page. The passed data will be available on the destination page as &VARIABLES. This modifier must end with a semicolon (;) before the tag name.

Note: If the tag contains ?FIELDNAME variables, it must be contained inside of a workwith area.

Note: To move variable outside the context of a query, use the transfer or carry modifier.

<tame> pass: &VARIABLE-NAME ?FIELD-NAME . . .; ^LINK/^GOTO: DOCUMENT-LOCATION HTML-ARGUMENT-AREA</tame>

Note: Multiple &VARIABLES or ?FIELD-NAMES can be included in a pass. They should be separated by a space.

Note: Review the use and position of the semicolon.

Note: A ^goto must be used inside a form area to create a submission button which will acquire input variable from the browser to present on the next page.

Example:

<tame>
pass: ?item &dept &size; ^goto: details.tam {*pointer*}
</tame>

This example will pass the field-name, item, and the variables, dept and size, to the page details.tam.

See Also: ^goto, ^link, variables, carry, transfer


passgate
Password protects a page or series of pages. Placing the tag at the top of the page protects the entire page. By placing this tag lower in the page, only the remaining part of the page is protected. When the customer satisifes the passgate criteria, the rest of the page will be displayed and the password panel will disappear.

<tame> passgate </tame>

Example:

Password:

User name:
Password:

The first is the simple password presentation and the second is the full password screen. This mask would appear with any information place on the page above the passgate tag and would hid any information below this tag until the password is approved.

See Also: passwd


passwd
Creates a HTML password input box. The field can be automatically pre-fill with a value.
 
<tame passwd: VARIABLE SIZE>
SIZE:
The size in characters of the password box.

Modifiers: required

Example:

<tame passwd: passwd 40> Password

This will present a HTML password box which is 40 characters long

See also: text, passgate


PATH-FILE
Path and file name to retrieve. Tame allows access to any file on the system for which the Web Server has access privileges.

Note: Paths can be entered as full path to the file or by using Tame path-file-operators. A path-file-operator is a tame short-cut to entering the full path.

Note: Do not confuse PATH-FILE with DOCUMENT-LOCATION which is the document name and location on the Web Server relative to the current document.

Example:

<tame dos: dir d:\currentdomain\myshop>

This will return the directory of "myshop" to the page on the d drive of the server.

c:\website\htdocs\pagea.tam

This is the PATH-FILE for pagea.tam, the document-location would be /pagea.tam.

See Also: path-file-operator, document-location, path operators


PATH-FILE-OPERATOR
Tame shortcut to present path and file names to retrieve and present to the customer. Tame allows access to any file on the system for which the Web Server has access privileges. The tilde (~) path operator generates tame directory and file paths.

The operator provides several built-in aliases that represent common tame directories such as department and mirror
directories.

Note: See path-file-operator section for more details.

Example:

<html><head>
<tame tamehead>
</head>
~web = {~web}
~shop = {~shop}
~dept = {~dept}
~// = {~//}
</html>

This example might present the following information on a page:

~ = C:/WEBSITE/HTDOCS/examples
~web = C:/WEBSITE/HTDOCS
~shop = C:/WEBSITE/HTDOCS/examples
~dept = C:/WEBSITE/HTDOCS/examples
~// = c:/tame/localhost

See Also: path-file, path operators


place
Places an image, not currently defined as a tame image, on a button or within a page.

<tame> place: DOCUMENT-LOCATION HTML-OPTION-LIST </tame>

HTML-OPTION-LIST:
List of options for the image. Can include any valid options for the HTML <img scr> tag.

Example:

<tame> place: star.gif align=center width=50 height=50 alt="test star" </tame>

Placing the image star on a page is accomplished with the place tag. star is a *.gif that has not been defined as an tame image within your pages. See image and face to define the image for multiple pages.

<tame> ^buy: example {place: star.gif align=center width=50 height=50 alt="test star"} </tame>

The buy button is presented using the image star. In this case star is a *.gif that has not been defined as an tame image within your pages. See image and face to define the image for multiple pages.

See Also: face, image, define, defining


price
Provides the price entry associated with a product in the database. This command is useful within other tame command. By using this command in place of typing the price on the page, the price is automatically updated when changes are made to the product database.

<tame price: ITEM>

Example:

<tame form>
<tame descrip: example>
<tame price: example>
<tame ^buy: example>
<tame /form>
 
This will present the description, price and a buy button for the product "example". To update the information, changes are made in the product database.

See Also: descrip, ^buy, form


putcart
Places variables in the cart for storage and future presentation.
 
<tame putcart: VARIABLE >
 

Q


quality_price
This modifier of quality tags is used to associate a price with a quality of an item. Therefore, the additional cost is only added to the base item price, if the quality is select. This modifier must end with a semicolon (;) before the tag name.

Note: This modifier can be used with radio_quality, box_quality, select_quality and text_quality.

Note: The radio_quality and box_quality tags include the pricelet as an optional argument to provide the quality_price. See radio_quality and box_quality for this syntax.

<tame> quality_price: CLASS QUALITY VALUE PRICELET; QUALITY-TAG </tame>

Note: With the radio_quality and box_quality tags a shortened version of this tag can be used:
<tame> quality_price: PRICELET; QUALITY-TAG </tame>
 
PRICELET:
The skew code to add to the item's base price when the quality is selected.
QUALITY-TAG:
The appropriate syntax for radio_quality, box_quality, select_quality or text_quality.

Example:

<tame form>
A Personalized Widget which costs {?widget,price}
<tame> quality_price: widget size large 10; quality_price: widget size medium 5; select_quality: widget size small medium large</tame>
<tame> ^buy: widget Buy a Widget</tame>
<tame /form>

In this example, a customer will see a drop-down selection list of sizes for the widget. If he selects small or medium the base item price will be used. However, if he selects the medium size a $5 additional price will be added to the widget's base price or $10 if he selects large.

<tame form>
<tame> quality_price: 5; box_quality: dress with belt</tame> With matching belt for an additional $5<br>
<tame> quality_price: 10; box_quality: dress size xlarge</tame> Make it extra large for an additional $10<br>
<tame> box_quality: dress color yellow</tame> YELLOW instead of the standard white for no additional charge<br>
<tame> ^buy: dress</tame><br>
<tame /form>

In this example, the shortened version of the quality_price modifier is used with the box_quality. The customer can select three special options associated with the item "dress". Based on the boxes checked the customer can customize the "dress" with a matching belt for $5, extra large size for $10 or the color yellow which has no additional cost.

See Also: radio_quality , box_quality, select_quality, text_quality


quality_skew
This modifier of quality tags is used to associate a skew code with a quality of an item. Therefore, the additional skew information is only added to the base item price, if the quality is select. This modifier must end with a semicolon (;) before the tag name.

Note: This modifier can be used with radio_quality, box_quality, select_quality and text_quality.

Note: The radio_quality and box_quality tags include the codelet as an optional argument to provide the quality_skew. See radio_quality and box_quality for this syntax.

<tame> quality_skew: CLASS QUALITY VALUE CODELET; QUALITY-TAG </tame>

Note: With the radio_quality and box_quality tags a shortened version of this tag can be used:
<tame> quality_skew: CODELET; QUALITY-TAG </tame>
 
CODELET:
The skew code to add to the item code when the quality is selected.
QUALITY-TAG:
The appropriate syntax for radio_quality, box_quality, select_quality or text_quality.

Example:

<tame form>
A Personalized Widget which costs {?widget,price}
<tame> quality_skew: widget size small 1; quality_skew: widget size medium 2; quality_skew: widget size large 3; select_quality: widget size small medium large</tame>
<tame> ^buy: widget Buy a Widget</tame>
<tame /form>

In this example, a customer will see a drop-down selection list of sizes for the widget. Based on the size he selected a 1, 2 or 3 will be added to the widget's item code to present an extended item code. This code assist with order fulfillment.

<tame form>
This is an dress which costs {?1000,price}
<tame> quality_skew: 1432; box_quality: example with belt</tame> With matching belt for an additional $5<br>
<tame> quality_skew: 345; quality_price: 10; box_quality: example xlarge</tame> Make it extra large for 10<br>
<tame> quality_skew: 179; box_quality: example color yellow</tame> YELLOW instead of the standard white<br>
<tame> ^buy: example</tame><br>
<tame /form>

In this example, the shortened version of the quality_skew modifier is used with the box_quality. The customer can select three special options associated with the item "dress". Based on the boxes checked the customer can customize the "dress" with a matching belt, extra large size or the color yellow. Each quality will append the item code with the skew number provided by the quality_skew. If the customer selects a belt and yellow the item number on the invoice will read 10001432179.

See Also: radio_quality , box_quality, select_quality, text_quality


query.pan
To place a panel on the customer's screen which asks for an entry of keywords and provides a button with which to submit the search and a button to page through the results.
 
<show_panel: query.pan OPTION . . .>

Note: Must be used inside a workwith area.

OPTIONs
Where OPTIONs are selected from the following:
BORDER [SIZE]
The border size around the panel. The default is set in the administration shop.
 
QUERYVAR [NAME]
The name of the variable that contains the search query. Defaults to "query".
PRIORFACE [BUTTON-FACE-AREA]
Text or tame image for the prior button face. Defaults to "Prior".

Note: The "prior" button is never available with wgrep database access. This is an SQL only button. For wgrep, use the ^submit button to start the search over at the beginning.

NEXTFACE [BUTTON-FACE-AREA]
Text or tame image for the next button face. Defaults to "Next".
SUBMITFACE [BUTTON-FACE-AREA]
Text or tame image for the new query button face. Defaults to "New Query".
SUBMIT_PAGE [PAGE]
Page to submit a new search to. Default is to loop on the same page.
NOSEARCH
Hides the next query button.

Example

<tame>
show_panel: query.pan BORDER 5 SUBMITFACE [New Search] NEXTFACE [Next HITS]
</tame>

might present the following panel:

See Also: workwith, Writing a Search Page, subquery.pan


R


radio
Creates a HTML radio button element. Can prefill value automatically.
 
<tame radio: VARIABLE VALUE>
VALUE:
Optional value for the button. When not given, value is taken from the assigned variable.

Example:

<tame checked radio: color red> Red
<tame radio: color green> Green
<tame radio: color blue> Blue
 
In this example three radio buttons will appear with the text Red, Green or Blue next to each one. The red button will be checked as the default.

Modifier: checked

See also: box


radio_quality
Within a form, offers radio buttons that present product qualities to the customer. Once a ^buybutton is selected, these qualities will appear in the product description section of the cart.

<tame radio_quality: ITEM QUALITY VALUE PRICELET>

QUALITY:
The quality of the product, such as color, for which values are provided.
 
VALUE:
The different values or options from which a customer can choose. For example, blue green yellow.
 
PRICLET:
An additional cost that is added to the item's price when the radio button is selected. This can be a set value or a field from your product database. The quality_price modifier can be used in place of this argument.

Example:

Please select a size:
<tame> radio_quality: shirt Size Small} Purchase a shirt in size small </tame>
<tame> radio_quality: shirt Size Medium} Purchase a shirt in size medium </tame>
<tame> checked radio_quality: shirt Size Large 1} Purchase a shirt in size large ($1 extra) </tame>
<tame> radio_quality: shirt Size Extra Large 2} Purchase a shirt in size x-large ($2 extra) </tame>
<tame> ^buy: shirt </tame>

In this example, the customer can purchase a shirt in a variety of sizes. If they purchase small or medium the cost is the price from the ?price field in the database for the shirt. If they select the large or extra large the PRICELET variable is used to add additional cost to the shirt when it is placed in the cart.

Modifier: checked, quality_price, quality_skew

See Also: box_quality, radio, text_quality, ^buy


relink
Creates a link to another tame document without showing the current page. It is generally used to present an error page or another special page based on some logic test.

<tame relink: DOCUMENT-LOCATION>

Example

<tame when: {&total > 200.00} {relink: overlimit.tam}>

In this example, the customer will not goto the payment screen if he has spent more than $200.00, instead he will be sent to the overlimit.tam page.

<html><head>
<tame tamehead>
</head>
<tame clear_cart:>
<tame relink: curpage.tam>

The cleanup.tam page would contain only this information. When it is accessed with a ^link command from the curpage.tam, the customer's cart is cleared, the curpage.tam is reloaded and the customer never see this page.

See also: ^link, clear_cart, when


request_bookmark
Page modifier. Presents the customer with the bookmark screen if the customer has not yet had the opportunity to bookmark.

See also: tamehead


required
An input box modifier. Causes a text or password input box to require input. The page will cycle until the item is completed. The "require_filling" page top tag must be used and the form must submit to itself by use of <tame form>.

See Also: require_filling, form, ^submit, text, passwd, when_not_filled


require_filling
A page modifier. Forces the customer to complete an input box before continuing to shop.

See Also: required, form, ^submit, text, passwd


require_register
A page modifier. Forces the browsing customer to become registered before accessing the page. The modifier presents the customer panel if the customer is not regisitered and is inactive when the customer is registered.

See Also: customer_panel, form, tamehead


Created: Katherine C. Davis 4/24/97
Edited: Katherine C. Davis 10/13/97