Glossary of GoldPaint Terms S-Z


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


S


select
Within a form, creates a drop down box from which to select. The information in the selection box is stored in the VARIABLE for use by the system. The value can be automatiically prefill.
 
<tame select: VARIABLE VALUE. . .>
VALUE:
List of selection values to display in the select box.
 
Note: Any of the following words or single characters can be used as one of the selection values to generate a null value. NONE, *, ., and #

Example:

<tame form>
<tame select: size small medium large> Select a size
<tame /form>

This example will present a drop down box with the words "Select a size" next to it. When the customer selects small, medium or large, it is associated with the variable "size" for use by the system. The variable can be present on the screen using "&size".

See Also: ^buyselect, select2


select2
Within a form, creates a drop down box from which to select. The information in the selection box, DISPLAY, is paired with the information supplied to the system, CODE-RETURN. This enables the list to have a user friendly display while providing system related information in the background. The value can be automatiically prefill.
 
<tame select2: VARIABLE [DISPLAY] [CODE-RETURN]>
[DISPLAY] [CODE-RETURN]:
List of selection pairs to display in the select box and return to the system. Brackets, [ ], are required if spaces are imbedded in the display or return arguments.
 
Note: Any of the following words or single characters can be used as one of the selection values to generate a null value. NONE, *, ., and #

Note: This tag will function only with browsers that support HTML 3.0 features.

Example:

<tame form>
<tame select2: size small [8 oz] medium [12 oz] large [16 oz}> Select a size
<tame /form>

The drop down box presented will list small, medium and large. Upon selection the system will store 8, 12 or 16 oz in the variable, size.

See Also: select, ^buyselect, ^buyselect2


select_quality
Within a form, offers drop down boxes 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 select_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:

<tame form>
A Personalized Widget
<tame select_quality: widget size small medium large>
<tame ^buy: widget Buy a Widget>
<tame /form>

In this example the item widget can be specialized by size. The customer will see a drop down selection list for size. Once a choice is made and the ^buy button is selected, the information associated with the widget will appear in the description section on the cart panel.

See Also: ^buy, form buy, select_quality2, box_quality, radio_quality, text_quality


select_quality2
Within a form, offers drop down boxes 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 select_quality2: ITEM QUALITY [DISPLAY] [CODE-RETURN] . . . >

QUALITY:
The quality of the product, such as color, for which values are provided.
 
[DISPLAY] [CODE-RETURN]:
List of selection pairs to display in the select box and return to the system. Brackets, [ ], are required if spaces are imbedded in the display or return arguments.

Note: Any of the following words or single characters can be used as one of the selection values to generate a null value. NONE, *, ., and #

Note: This tag will function only with browsers that support HTML 3.0 features.

Example:

<tame form>
Please select your size.
<tame select_quality2: socks size Small 1 Medium 2 [Large X-Large] 3>
<tame ^buysubmit: Purchase socks>
<tame /form>

When the customer selects a size, it is associated with the product socks. The size appears in the description along with the product selection. Note the use of [ ] to enclose arguments with embedded spaces.

See Also: ^buy, form buy, select_quality, box_quality, radio_quality, text_quality


select_qty
Within a form, creates a selection box from which to select the QUANTITY. This tag provides a restricted quantities list. To allow any quantity input use the input_qty tag.

<tame select_qty: ITEM QUANTITY . . .>

QUANTITY:
The list of numbers representing the quantity of the ITEM a customer can purchase.

Example:

<tame form>
<tame descrip: example>
<tame select_quality2: example size Small 1 Medium 2 [Large X-Large] 3>
<tame select_qty: example 0 1 2 3 4> Select quantity<br>
<tame ^buy: example>
<tame /form>

This example provides provides details about and sizes for an "example" and then limits the quantity to purchase (0 to 4) with the select_qty button. Selecting the ^buy button will associate all information with "example: and submit it to the cart_panel.

See Also: input_qty, ^buyselectqty


setgate
Define the source and method by which to access data for use in a shop.

<tame>
setgate:
ACCESS-TYPE DIRECTORY/DATA-SOURCE
</tame>

ACCESS-TYPE

FILE - for .tdb and .tab (tab delimited) ASCII flat files.

WGREP - for tables retrieved by the wgrep search engine

ODBC - for SQL retrieval of tables coming from a ODBC data source on Windows95 or the NT

DAO - for SQL tables retrieved through GateBoy using the MS Jet engine. (Requires GateBoy software extentions.)

DIRECTORY/DATA-SOURCE

for the ACCESS-TYPES of FILE or WGREP specifies the path to the directory containing the ACCII flat files.

for ODBD and DAO specifies the data source name as entered in the ODBC manager in the NT or Windows95 control panel.

Note: You can define multiple setgate tags within a page or shop; however only one setgate tag is active at any given time.

Note: To set a default data source, place the setgate in the custom.tag file.

Example:

<tame setgate: FILE ~shop>
<tame define_tdb: data product.tdb>

<tame workwith: data>
<tame foreach::
item: {?item}<br>
price: {?price}<br>
description: {?descrip}<p>
>
<tame /workwith>

The setgate in this example define the data source as a FILE and the default shop directory as the location of the database file. The remainder of the example shows the access and presentation of the data on a page.

See Also: define_tdb, workwith, foreach, data access


setpdb
Designates a table to use for a product database. This will set the &pdb variable and specifies in which table or file the shopping system will look to find the items designated by the buy buttons.

<tame>
setpdb:
TABLE/PATH-FILE
</tame>

TABLE/PATH-FILE
Designates the name of a table defined by a define_tdb, define_wgrep, or define_sql tag. It may also designate a path and name to a .tdb file.

Note: The &pdb variable is set in the Admin config.tag file for the shop.

Example:

<tame setpdb: ~//shop/example.tdb>

Will designate the use of the example.tdb from this point onward on this page instead of the file designated in the Admin config.tag file. The ~//shop/ indicates that this file will be found in the shop data-mirror directory.

See Also: setgate, define_tdb


show_panel
Presents the panel indicated by PANEL_NAME.
 
<tame>
show_panel:
PANEL_NAME OPTION-LIST
</tame>
 
PANEL_NAME
The name of a tame panel to present on the page. All the panel are listed in the panel glossary.
OPTION-LIST
The options associated with a panel to customize it's presentation.

LIST OPTIONS HERE!

Example:

See Also: panel, cart.pan


T


TAMECOMMAND


tamecase
A primary tag which marks up an area of a form that will be displayed or executed. A primary tag functions as if it is a direct HTML tag. The case is set by the calling link which can be in the same page or a different page. The default case is always named "main". The default case is the one activated when the document is opened without a case being specified.

End Mark Required: /tamecase

<tamecase: CASE-NAME>
HTML-AREA
</tamecase>

CASE-NAME:
The name of the case. The name can be multiple words but cannot contain a period.

Example:

Create a tamecase on curpage using the following format:

<tamecase: pagecase>
This is the pagecase area of the file
</tamecase>

To access this case use the following command:

<tame ^link: pagecase Go to this pages case area>

This goes to the tamecase "pagecase" in the same document that contained the link. Note that there are no periods used in the link statement which indicates the use of case-name instead of document-location.

To access the curpage pagecase from another document use the tocase modifier:

<tame tocase: pagecase; ^link: curpage.tam Go to the new page>

See also: tocase, document-location, ^link


tamehead
This tag can be used to start a tame page with the minimal tame footprint. This tag simply generates a <base href="http://yourdomain/yourshop/yourpage.tam"> html statement that supplies the client browsers with the correct page and directory.

Note: The tamepage command provides additional functionality.

HTML-AREA
<head>
<tame tamehead>
HTML-AREA
</head>
HTML-AREA

Note: When you use this tag you must place it between the <head> </head> html directives at the top of the page, and you are responsible for including all other HTML tags that normally start a page.

Note: If you do not use the tamehead or tamepage tag, the client browser might not know how to form requests for images called from your page.

Example:

<html>
<head>
<tame tamehead>
<title>This page requires additional HTML information</title>
</head>
<body bgcolor="#FFFFFF">

In this example the tamehead provides the basic information to allow the GoldPaint Shopping System to access images on the page. To define the background and title requires the additional html markups.

See also: tamepage


TAMEIMAGE
A tame markup name defined with {image: TAMEIMAGE image definition} or {face: TAMEIMAGE image presentation}. This image can then be used on a button as a BUTTON-FACE-AREA.

Example:

<tame ^goto: pagea.tam {*star*}>

In this example the hyperlink to goto the page pagea.tam is represented by a star image. This image was first defined with an image or face definition.

See Also: BUTTON-FACE-AREA, image, face


tamepage
Creates the HTML for a page top, processes any form input, and loads customer variables.

End Mark Required: /tamepage

<tame tamepage: MODIFIED>
 
MODIFIED:
Text representing the date and person last modifying the page.

Modifiers: require_register, require_filling, request_bookmark, passgate

See also: tamehead


tamewhen
A primary tag which provides you with custom logic functionality. A primary tag functions as if it is a direct HTML tag.

End Mark Required: /tamewhen

<tamewhen: TEST>
HTML-AREA
</tamewhen>

TEST:
A test that results in logic true or false.

Example:

<tamewhen: {&total > &balance}>
Your account is over balance<br>
Please contact us if you feel this message is in error<br>
</tamewhen>

This example test to see of the variable "&total" is greater then the variable "&balance", if it is the message is presented. Otherwise the page continues to function and the information in the tamewhen is ignored.

See Also: tamecase


tb
Modifier that wraps table borders around a button.

<tame tb: TAMECOMMAND>

Example:

<tame tb: {^buysubmit: Purchase selected items}>

In this example the words "Purchase selected items" appears on a button with a border. This can give a button extra enhances.

See also: ^buysubmit


text
Creates a HTML text input box. The value can be prefill automatically when used in conjunction with other tame commands.

<tame text: VARIABLE SIZE>

SIZE:
The size in characters of the text box.

Example:

<tame text: name 40> Your name

Modifiers: required

See also: passwd


text_face
??.

<tame text_face??>

See also:


TEXT/IMAGE
The tex or image definition to signify the buy button. The standard icon for ^buy will be supplied if this object is omitted. Can include any valid HTML img src attributes within this area.

Example:

<img src="imagename.gif" width=20 height=30>

text_quality
A text block in which specialized information such as engraving or personalization can be placed. This information, along with the QUALITY, will appear in the description section of the cart panel.

<tame text_quality: ITEM QUALITY WIDTH HEIGHT DEFAULT_TEXT>

QUALITY
The variable in which to store the specialize information about the product.
 
WIDTH & HEIGHT
The width in characters and the height in lines of the input box. The default width is 40 and the default height is 1.
 
DEFAULT_TEXT
The text that will appear in the box initially. The default is blank.

Example:

<tame form>
A Personalized Widget
How do you wish to be personalize your widget?
<text_quality: widget Personalization 40 3>
<tame /form>

In this example the input block for the personalization is 40 characters by 3 lines. This text will appear in the description section on the cart panel.

See Also: text, form


thisform
A page designation to use within a link command. This allows you to create a link to an anchor located in the current page.

<tame thisform>#ANCHOR

ANCHOR:
An HTML anchor define on a page.

Example:

<tame ^link: <tame thisform>#newtopic {*star*}>

See also: ^link


tocase
A link modifier which links to a case other than "main" in a different document.

<tame tocase: CASE-NAME; LINK_TAG: DOCUMENT-LOCATION HTML-ARGUMENT-AREA>

LINK_TAG:
Use any linking command such as ^link, ^goto, or ^next to link to another page.
 
CASE-NAME:
The name of the case or location defined by the <tamecase> tag. The name can be multiple words but cannot contain a period.

Example:

Create a tamecase on curpage using the following format:

<tamecase: pagecase>
This is the pagecase area of the file
</tamecase>

To access the curpage pagecase from another document use the tocase modifier:

<tame tocase: pagecase; ^link: curpage.tam Go to the new page>

See also: tamecase, document-location, ^link


transfer
A link modifier. This modifier attaches variables (NAMEs) with their associated VALUES to the link making them available on the next page. The data will be available on the destination page by using the name to return the value to the customer. This modifier must end with a semicolon (;) before the tag name.

<tame> transfer: NAME VALUE . . .; ^LINK/^GOTO: DOCUMENT-LOCATION HTML-ARGUMENT-AREA</tame>

Note: Multiple NAME VALUE pairs can be included in a transfer. They should be separated by a space.

Note: Review the use and position of the semicolon.

Example:

<tame>transfer: shoesize 10; goto: showshoes.tam ALL SHOES SIZE 10</tame>

This example will transfer the shoesize 10 to the next page where all shoes for that size are shown.

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


U


Unique
Link modifier. Adds a unique number to the link query string forcing the link to always be unique. Use this modifier on any link to a page that displays dynamic information. This helps prevent the customer browser from catching the dynamic page locally which could cause the display of out-of-date information.

Example:

<tame unique ^link: local-weather.tam local weather forcast>
See Also: http, https, ^link, outside

V


VARIABLE
The name of a tame local variable to fill with a value. A variable name begins with an ampersand (&) and is followed immediately by a variable name.

Note: Variable are discussed in detail in the Variables section.


W


when
A logic statement which if true, completes the tame command which follows.

<tame when: {TEST} {TAMECOMMAND}>

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.

See also: relink, tamewhen


when_allow_tables
Checks browser and displays HTML-ARGUMENT-AREA area when the browser can display tables.

<tame when_allow_tables: HTML-ARGUMENT-AREA>

See also: when_not_allow_tables


when_cart
Detects if the shopping cart contains items and displays the HTML-ARGUMENT-AREA when items have been selected.
 
<tame when_cart: HTML-ARGUMENT-AREA>

See also: when_not_cart


when_filled
Detects if any "required" input boxes are empty and displays the HTML-ARGUMENT-AREA when all fields are completed.

<tame when_filled: HTML-ARGUMENT-AREA>

Note: Only works on a <tame form> page that loops to itself. Asked Nathan for help.

See also: when_not_filled, form


when_hits
An HTML-ARGUMENT-AREA to display only when a query has returned hits.

<tame when_hits: HTML-ARGUMENT-AREA >

Note: This tag will only work within a workwith area.

See also: workwith, when_not_hits


when_known
Detects if the customer is known and displays HTML-ARGUMENT-AREA when the customer can be identified.

<tame when_known: HTML-ARGUMENT-AREA>

See also: when_not_known


when_not_allow_tables
Checks browser and displays HTML-ARGUMENT-AREA area when the browser cannot display tables.

<tame when_not_allow_tables: HTML-ARGUMENT-AREA>

See also: when_allow_tables


when_not_cart
Detects if the shopping cart contains items and displays HTML-ARGUMENT-AREA when the cart is empty.
 
<tame when_not_cart: HTML-ARGUMENT-AREA>

See also: when_cart


when_not_filled
Detects if any "required" input boxes are empty and displays HTML-ARGUMENT-AREA.

<tame when_not_filled: HTML-ARGUMENT-AREA>

See also: when_filled, form, required


when_not_hits
An HTML-ARGUMENT-AREA to display only when a query returns no hits.

<tame when_not_hits: HTML-ARGUMENT-AREA >

Note: This tag will only work within a workwith area.

See also: workwith, when_hits


when_not_known
Detects if the customer is known and displays HTML-ARGUMENT-AREA when the customer cannot be identified.

<tame when_not_known: HTML-ARGUMENT-AREA>

See also: when_known


when_not_so
Detects if a sales order number has been assigned. Conditionally displays HTML-ARGUMENT-AREA area when no sales order is active for the customer.

<tame when_not_so: HTML-ARGUMENT-AREA>

See also: when_so


when_so
HTML-ARGUMENT-AREA is displayed if a sales order number has been assigned to the customers cart. After a customer completes a purchase, this condition will fail until the customer visits the checkstand with more items.

<tame when_so: HTML-ARGUMENT-AREA>

See also: when_not_so


when_special_instructions
HTML-ARGUMENT-AREA to display when the customer has supplied special instructions.
 
<tame when_special_instructions: HTML-ARGUMENT-AREA>
 

workwith
Designates from which TABLE data will be retrieved for tags like {?ROW,COLUMN}, foreach and pass. All tags needing a TABLE context will operate on this table until the next /workwith is encountered.

End Mark Required: /workwith

<tame workwith: TABLE> ... HTML-AREA ... <tame /workwith>

Note: Workwith areas may be nested.

Example:

<tame workwith: states>
{?Washington,population}

<tame workwith: cities>
{?Seattle,population}
<tame /workwith>

{?Washington,capital}
<tame /workwith>

The first and last sections of this query are made against the table "states". Nested in the middle is a query against the table "cities".

See Also: foreach, ?, pass, data_access


X Y Z ?


{?}
Please see DISPLAY DATABASE INFORMATION and DISPLAY PRODUCT INFORMATION

Draft Katherine C. Davis 3/27/97