Glossary of GoldPaint 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.

<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


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

<tame http ^link: DOCUMENT-LOCATION TEXT/IMAGE>

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 TEXT/IMAGE>

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
...

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 TEXT/IMAGE1 TEXT/IMAGE2>

TEXT/IMAGE1
Text or image to display if the item-code is not in the cart.
 
TEXT/IMAGE2
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 is born.

You need this modifier on your e15.tam page where you goto the e15all.tam page since you are not using pass to pass any
information. If you don't use this modifier, the page retrieval sequence you were on the last time you were on the page will be
used. I.e. you won't necessarily start out on hit 1.

Rules:

Using new_query on a link will make sure the page starts out on hit 1.
When you use pass on a link, you don't need new_query.

Please add this modifier to the doc in the same section as the pass modifier.


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


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 when placed at the top. By placing this tag lower in the page, only the remaining part of the page is protected.

<tame> passgate </tame>

Example:

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-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:

<tame tamepage: >
~web = {~web}
~shop = {~shop}
~dept = {~dept}
~// = {~//}
<tame /tamepage: >

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


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


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>

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.

Example:

Modifier: checked

See Also:


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.

<tame tamepage: cleanup.tam>
<tame clear_cart:>
<tame relink: curpage.tam>
<tame /tamepage>

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: tamepage, 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, tamepage


Draft: Katherine C. Davis 2/27/97