Glossary of GoldPaint Terms A-E

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

A

allow_nofill: A dialog link modifier. Allows dialog links to bypass a required input feature. Use this modifier on any dialog link to allow the user to leave the page without completing "required" fields. This is especially helpful for a customer who has inadvertently entered a page and wants to leave without completing the required information.

Note: This modifier is used to allow a link to function on a page modified by "required_filling".

Example:

<tame require_filling tamepage: 2/13/97 pword.tam>
<tame form>
<tame required passwd: pword 10> Please enter a password
<tame ^submit: enter password>
<tame allow_nofill ^goto: nopasswd.tam Pages that do not require a password>
<tame /form>
<tame /tamepage>

The ^goto tag, with the allow_nofill modifier, will allow the customer who does not wish to provide a password access to a page where this information is not required.

B

backable

A link modifier. When used to modify a link within a dialog, enables the new page to have a ^back button to return customers directly to the page on which the link was initiated.

TAMECOMMAND:: Linking commands such as ^link can be used with this modifier.

Note: Backable and ^back currently can not be used on the same page to support different links.

Note: Backable and ^back are designed for use within a dialog. Use dialog buttons for access between dialogs.

Example:

On the first page to present to the customer the following command is used:
<tame backable ^link: page2.tam NewPage>

On the second page, NewPage, the following command is used:
<tame ^back: OldPage>

On the first page the hot link "NewPage" will appear. When this link is selected the second page will be retrieved. The second page will have a hot link "OldPage" which will return the customer to the first page.

C

carry: Imbeds the names and current values of variables into any forms on the page as hidden variables. These variables are then available on the next page to which the form submits. Carry is often used in dialogs where multiple pages are placed in the same *.tam file using <tamecase: >.

<tame> carry: NAME . . . </tame>

NAME: The names of the variables to carry.

Note: Carry can be used multiple times on the same page. Each time carry is used, more names are added to the carry list.

Example:

<tame> carry: &dept 3 &size 5 </tame>

This example will move the dept and size name value pairs to all future pages.

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

checked: An input button modifier. When used it causes a tame box or radio button to be checked when the customer initially enters the screen.

Example:

<tame form>
<tame checked ^buyradio: items "NONE"> Nothing today

<tame ^buyradio: items example>
<tame descrip: example>
<tame &CU price: example>/each

<tame ^buysubmit: Purchase selected items>
<tame /form>

This will present a two radio buttons for "None" and "example". The "None" radio button will be pre-selected because of the checked modifier.

<tame checked box: mailing_list> Put you on our mailing list?

Provides a checkbox followed by the question on mailing lists. The box will default to "checked" to indicate yes.

CLASS: A common identifier. This user-defined word links an item with selectable qualities or attributes. For convenience, the identifier can be the ITEM CODE if the customer can only purchase the item one way on a page. When multiple method for purchasing are available to the customer, use different words for CLASS in each format.

Example:

<tame form>
<tame ^buyselect: thing NONE example widget>
<tame select_quality: thing color red blue pink>
<tame ^buysubmit: Purchase selected items>
<tame /form>

This example will present two selection box. When the customer selects an item "example" or "widget" it is associated with the user-defined CLASS "thing". Next the customer selects a color which is also assoicated with the CLASS "thing". Because of the CLASS association the item will appear in the cart with the appropriate color selection.

D

data_access: This tag is required on all pages where a query is completed. The tag instructs the shopping system to remember variables and database context for a page so that a return to that page from the shopping system or a link will yield the same dynamic results as the last time the page was calculated.

<tame>
data_access PATH-FILE>
</tame>

PATH-FILE:

The tamepage for which the dynamic results should be stored.

See Also: image, face

define_sql: Used to retrieve a table from a SQL database server.

TABLE:

The name of the table to be used for future reference in workwith and {?} tags. It should not be confused with the tables in the SQL database from which the data is retrieved. This is the name that the retireved data will be known as on the tame pages.

SQL-QUERY:

The exact SQL statement which will retrieve the desired data from the database.

Note: This tag is available when you have installed the additional GateBoy module and have added the database to the ODBD data sources.

Example:

<tame define_sql: new-products SELECT code, price, description FROM products where status = "new">

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

define_tdb

Assigns a table name to a .tdb structured file. The system will retrieve the entire file as a table for access. Every row in the file becomes available for access:

by iteration with the foreach combined with {?COLUMN}tag or

directly into the particular record with a {?ROW,COLUMN} tag.

TABLE:

The name of the table to be used for future reference by other data access tags such as <tame workwith: TABLE> and {?TABLE,ROW,COLUMN}.

PATH-FILE:

The name the file as know by the operating system. This file must reside in the directory given by the <tame setgate: FILE DIRECTORY> tag.

Note: There is no selection as with define_wgrep or define_sql.

Example:

<tame setgate: FILE ~shop>
<tame define_tdb: newfile test.tdb>
<table width=50% cellpadding=1 border=2>
<tr><td>item</td>
<td>price</td>
<td>description</td></tr>
<tame workwith: newfile>
<tame foreach::
<tr><td>{?item}</td>
<td>{?price}</td>
<td>{?descrip}</td>
<td><tame ^buy: {?item}></td></tr>
>
<tame /workwith>
</table>

In this example, the table NEWFILE is define and contains all the records in the file test.tdb. Once defined this table can be used to present information to the customers using the workwith and foreach commands.

define_wgrep: Used to retrieve a table from a larger file. This tag defines a particular search.

TABLE:

The name of the table to be used for future reference by other data access tags such as <tame workwith: TABLE> and {?TABLE,ROW,COLUMN}.

PATH-FILE:

The name the file as know by the operating system. This file must reside in the directory given by the <tame setgate: FILE DIRECTORY> tag.

TYPE T:

The keyword TYPE defines the search to be performed. TYPE requires an argument T, where T is one or more of the options listed below. The default is "af".

a - All arguments associated with the keyword WORDS must be present for the row of data to be included in the retrieved table. (This is the default setting)

o - The row will be included in the retrieved table if ANY of the arguments associated with the keyword WORDS is present in the row of data. This feature is NOT currently available.
t - The file uses the tab character to separate columns rather than spaces. (The default is to expect a .tdb data structure which is space delimited.)

f - The file begins with a ;fields definition row that is not to be searched. (This is the default setting)

w - Compare whole words rather than search for the arguments inside of any word. (The default setting is to search within words.)

c - The search will be case sensitive. (The default is case insensitive.)

e - The search will return all lines, up to the hit#, when the query is NULL. This type is required to return all entries in a database. (The defualt setting is to return no lines when the query is NULL.)

FIRSTLINE #

The row number # on which to start the search. This is usually not required because the paging software provided it.

FIRSTCOL #

The first data column, #. This indicates where the search should begin. (The default is column 2)

LASTCOL #

Last data column, #, that will be searched. The default is the last column of the database. The combination of FIRSTCOL and LASTCOL allows a search across a specific range of columns.

HITS #

The maximum number of records that match query to return to the table.

WORDS W

A list of words, called arguments, for which to search. The keyword WORDS and its arguments must be the last parameter given in this command. If the WORDS F keyword parameter pair not included, then the search resultwill be the entire table.

Note: When designing the database it is useful to group columns that are likely to be searched together.

Example:

<tame define_wgrep: my-shoes shoes.tdb TYPE af FIRSTCOL 3 LASTCOL 5 WORDS "oxford brown" >

This request will search the shoes.tdb for rows containing the words "oxford" and "brown" between column 3 and column 5 and will name the the resultant table my-shoes.

<tame define_wgrep: my-shoes shoes.tdb FIRSTCOL 3 HITS 3 WORDS {&query}>

This request will search the shoes.tdb from column 3 to the last column for first 3 instances of the words in the variable &query. &query is a stored variable usually input by the consumer on a form.

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

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

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: price, ^buy, form

dialog: A linking button which assist in the flow of a dialog. Dialog buttons are discussed in the Buttons: All Kinds section.

See Also: ^goto, ^cancel, ^finish, ^prior, ^next, ^return

display database information: Retrieve data from a table. The table must first be defined with define_tdb, or define_wgrep, or define_sql, then data can be accessed randomly from any row, and column with a fully qualified data access tag {?TABLE,ROW,COLUMN}.

{?TABLE,ROW,COLUMN}

or: {?ROW,COLUMN}

or: {?COLUMN}

TABLE

A table name assigned by define_tdb, define_wgrep, or define_sql.

ROW

Is the literal value in the first column of the record you wish to retrieve. It may be a variable like &myrecord or a expression like {&page +1}.

COLUMN

Is the name of the column from which data is to be displayed.

Note: This tag need not be contained within a workwith section.

Note: There are no spaces used in this command.

Example:

The capitol of Washington is {?states,Washington,capitol}.

In this example the defined table name is "states" and the row name is "Washington". The column name for the variable to return to the page is "capital". Your customer would see:
The capitol of Washington is Olympia.

Note: Once the context of a particular TABLE has been established inside a workwith area, the TABLE slot may be omitted and only the row, and column need be specified.

<tame workwith: states>
Capitol: {?Washington,capitol}
Population: {?Washington,population}
<tame /workwith>

This example shows the state of Washington with the capital and population.

Note: Once the context of a particular row is established inside a foreach template, even the row may be omitted.

<tame workwith: states>
<tame foreach::
Capitol: {?capitol}
Population: {?population}
Rainfall: {?rainfall}
>
<tame /workwith>

This example will show all the states and the associated information requested that are listed in the table.

See Also: define_wgrep, define_tdb, define_sql

display product information: A special case of the display database information tag which retrieve data from the product database. This tag access the product database then data can be accessed randomly from any row, and column.

{?ITEM,COLUMN}

Note: There are no spaces between the question mark and the item or on either side of the comma.

Example:

Consider the following product database:

;item	price	descrip	wholesale-price
widget	10.95	A great widget	5.95
gizmo	100.00	Expensive gizmo	40.00

{?widget,descrip}
Item: {?widget,item}
Retail Price: ${?widget,price}
Wholesale Price: ${?widget,wholesale-price}

This example displays information from the database above. It will appear as follows:
A great widget
Item: widget
Retail Price: $10.95
Wholesale Price: $5.95

See Also: define_wgrep, define_tdb, define_sql

DOCUMENT-LOCATION: The document name and location on the Web Server relative to the current document. It is what follows "http://domain-name" in the URL of the browser. The location can be a separate document or a location within the current document.

Note: In most cases it is exactly what you would put after the href= in a standard hyperlink.

Note: Do not confuse this will a PATH-FILE which is a path to a file on a disk drive.

<tame tamecommand: DOCUMENT-LOCATION>

New page:

To access a new page the document_location must have a period in the name. For example: newpage.tam

Case within the current page:

To access another location within the current document no period is used in the name. For example: curpage/case.

Note: The tamecase command is required for the document_location to function within a page.

Example:

<tame ^next: page2.tam>

In this example, the "next" page to present is in the same web directory as the current page.

<tame ^link: dept/page.tam>

In this example, the linked page is in the a subdirectory of current page directory location.

<tame ^link: /diffshop/theirpage.tam>

In this example, the linked page is in the web directory of a different shop. It is under the same web root.

<tame ^goto: curpage/case>

In this example, the goto will link to the current page at the location case. The location case must be defined with a tamecase tag.

See Also: thisform, ^link, ^next, ^goto, tamecase

dos: Passes a command to the operating system command processor for execution.

OSCOMMAND:

Any valid operating system command.

Example:

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

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

<tame dos: {~cgi-bin/myscript.pl}>

Execute a perl script in the cgi-bin. The ~ is a path-file-operator indicating to use the default cgi-bin location to find the script.

<tame dos: ls -l {~web/TAMICONS}>

Directory listing of the webroot/TAMICONS directory. The ~ is a path-file-operator indicating the path to the web root.

E

Draft Katherine C. Davis 3/17/97