[xxx] Tags that are Available Anywhere
The following tags can be used in any template file that WebCatalog displays.
Additionally, if you have defined a SUFFIX-MAPPING and ACTION for WebCatalog to process
.tpl or .HTML pages, then simply using a web browser to link to any .tpl or .HTML
page on your site is equivalent to performing a ShowPage using that file as a template.
Depending on the preference settings, you may have to include <!--HAS_WEBDNA_TAGS-->
at the top of your files to indicate that WebCatalog should interpret the [xxx] tags
inside the file.
- Note: These are not containers, so they should not be followed
by a corresponding [/xxx] tag.
[AUTHENTICATE Some Text]
- Putting [AUTHENTICATE] in your template will cause the remote browser to display
the Username/Password dialog, with whatever text you specify. When the visitor types
a username and password into their browser, your templates can get that information
by including the [USERNAME] and [PASSWORD]
tags. Normally you put [AUTHENTICATE] inside [ShowIf] or [HideIf] contexts that compare
- Putting [BROWSERNAME] in your template will display the name of the remote browser
program running on the visitor's computer.
- Putting [CLEARLINEITEMS] in your template will remove all line items from the
specified shopping cart. Normally carts are found insidethe ShoppingCarts folder,
but you may specify a cart in any folder by using file=/folder/cartID instead
- Putting [CLOSEDATABASE FileName] in your template will cause the specified database
file (or full path) to be written and closed. This is only needed for special cases
(usually before appending to a file) where you need to change a file that may be
cached in RAM. WebCatalog automatically closes databases when it needs more memory,
so you typically do not need to use this tag.
- Putting [COMMAND] in your template will display the WebCatalog command that was
used to get to this page. Some examples are ShowPage, Search, ShowCart, etc. These
commands are often used in Form Actions, but can also be specified in an HREF hyperlink.
- Putting [COMMITDATABASE FileName] in your template will cause the specified database
file (or full path) to be written but not closed (so it will remain in RAM). This
is only needed for special cases where you want to be absolutely certain that a database
has been written to disk.
- Putting [COPYFILE path=fred&to=wilma] in your template will immediately copy
the file called "fred" to another file called "wilma".
- Putting [CREATEFOLDER StarShip/Troopers] in your template will immediately create
a new folder with the name "Troopers" inside a folder called "StarShip"
which is in the same folder as the template itself.
- Putting [DATE] in your template will display the current date as defined by the
clock on your web server. The format of the date is normally MM/DD/YYYY, but you
can change the default format by changing the DateFormat preference. You can override
the default date format preference on a case-by-case basis by specifying a format
inside the tag, as in [DATE %m/%d/%Y]. See [Time].
- Here are the valid date formats:
|Abbreviated weekday name "Wed"
|Full weekday name "Wednesday"
|Abbreviated month name "Feb"
|Full month name "February"
|Date and time in the form Wed Sep 19 18:24:21 1997
|Day of month 01-31
|Day of year 001-365
|AM or PM
|Week # of year (Sunday is first day of first week)
|Weekday 0 (Sunday) - 6 (Saturday)
|Week # of year (Monday is first day of first week)
|Date as Sep 11 1997
|Time as 14:01:12
|Year without century 00-99
|Year with century 1900-2199
|Time zone of server
- Putting [DELETE db=DatabasePath&eqNAMEdata=Fred] in your template will open
the database specified by DatabasePath, find all the records whose NAME field contains
"Fred", and delete those records. Any valid search parameters are allowed,
as defined in the Search command and [Search]
context. Note: if the database has username and password fields, then the
records will not be deleted unless the visitor's web browser username/password match
the record's username/password.
- Putting [DELETEFILE fred] in your template will immediately delete the file called
"fred" in the same folder as the template. Paths are relative to the template,
so "somefolder/fred" will delete the file down inside a folder called "somefolder",
and "../fred" will delete the file in the folder one level up from the
- Putting [DELETEFOLDER StarShip] in your template will immediately delete the
folder called "StarShip" in the same folder as the template. Paths are
relative to the template, so "somefolder/fred" will delete the folder down
inside a folder called "somefolder", and "../fred" will delete
the folder in the folder one level up from the template. All files inside the
folder are deleted, and all subfolders are deleted, as though you had dragged the
folder to the trashcan and emptied it immediately. This operation is not
Note: if the
parameter to [DeleteFolder] is an alias, then just the alias itself is deleted.
- Putting [ELAPSEDTIME] in your template will display the elapsed time (in 60ths
of a second) since the beginning of processing this page. Put one at the top of a
page, and another at the bottom to see how long the entire page takes to process
(subtract the 2 numbers to get the answer).
- Putting [FLUSHDATABASES] in your template will cause all databases to be written
and closed. This is only needed for special cases (usually before appending to a
file) where you need to change a file that may be cached in RAM, and you don't know
the exact name of the database. WebCatalog automatically closes databases when it
needs more memory, so you typically do not need to use this tag.
- Putting [FREEMEMORY] in your template will display the amount of memory available
to WebCatalog. This number is reduced whenever templates are cached, or databases
- Putting [GETCOOKIE fred] in your template will display the value of the cookie
named "fred" that the remote browser has remembered. If no cookie of that
name exists, then nothing is returned. Use [ListCookies]
to see all the cookies your browser is sending.
- Putting [GETMIMEHEADER Accept-Language] in your template will display the value
of the MIME header called "Accept-Language", which is a code that represents
the human language that the viewer is able to read. Use [ListMIMEHeaders]
to see all the headers your browser is sending.
- Putting [IPADDRESS] in your template will display the ip address of the remote
computer that the visitor is using to view your site. All sections of the IP address
are expanded to 3 digits, so that 22.214.171.124 will display as 207.067.002.014. This
helps make comparisons inside [ShowIf] tags work
- Putting [INCLUDE FilePath] in your template replaces the [INCLUDE] tag with the
contents of the specified file. The included file can use any [xxx] tags that will
be substituted as though you had typed the entire contents of the file at that place
in the template.
| Optional Parameters
||raw=T means the file should be included unchanged, without performing any [xxx] substitutions.
||Passes any variable names (and their values) you choose into the included template,
which can then use [var1] anywhere inside it.
- Putting [ISSECURECLIENT] in your template replaces the [ISSECURECLIENT] tag with
"T" if the remote browser is capable of SSL (Secure Socket Layer) connections,
and "F" if not. As new browsers are released, you can control which ones
are reported as secure by changing the "Browser
Info.txt" file to indicate what level of HTML it supports, and whether or
not it supports SSL.
- Putting [LASTRANDOM] in your template will display the same value as the last
[RANDOM] number displayed. See [RANDOM].
- Putting [LOOKUP] in your template will perform an extremely fast search through
the specified database and return either the value of the returnField in the found
record, or the literal text of the notFound value. The search is an exact match,
case-sensitive, so "Grant" does not equal "grant". If
you want more control over the search criteria, then use a [SEARCH]
- Putting [MOVEFILE path=fred&to=wilma] in your template will immediately move
the file called "fred" to another file called "wilma", and delete
the file "fred" after the move is complete. You may specify a different
folder for the file to be moved to.
- Putting [PASSWORD] in your template will display the password entered into the
remote browser's last Realm password dialog. See [USERNAME]
- Putting [PLATFORM] in your template will display the computer platform (Windows
or Macintosh) that WebCatalog is running on.
- Putting [PROTECT Groups] in your template will cause the remote browser to display
the Username/Password dialog until the visitor enters a username/password that belongs
to one of the specified groups. The Users.db database provided with WebCatalog (and
administered here) contains all
the username/password/group information.
- Putting [PURCHASE cart=cartID] in your template will move the specified shopping
cart file from the ShoppingCarts folder to the Orders folder, effectively the same
as a Purchase command. If the cart file is not
in a ShoppingCarts folder, you may use the alternate file=/folder/cartID instead
- Putting [RANDOM] in your template will display a random number between 1-100.
- Putting [REDIRECT http://www.pacific-coast.com/] in your template will force
the remote browser to immediately 'jump' to the new location specified, rather than
displaying whatever is in the template. Any other text in the template will be ignored.
[REFERRER] or [REFERER]
- Putting [REFERRER] in your template will display the URL of the referring page
that led to this one. This is a handy way to give visitors a "back up"
button. Note: this will not work if the previous page was a FORM METHOD="POST".
- Putting [REMOVELINEITEM] in your template will immediately delete the specified
line item from the specified shopping cart file. Alternately, you may use the Remove command. See also [AddLineItem]
and Add. If the cart file is not in a ShoppingCarts
folder, you may use the alternate form file=/folder/cartID instead of cart=cartID.
- Putting a [SETCOOKIE] tag into a template causes the remote browser to create
or replace a cookie of that name in its local list of cookies. You can use [GETCOOKIE]
or [LISTCOOKIES] later to retrieve that value
from the remote browser. The expiration date of the cookie must be of the form Wednesday,
09-Nov-1999 23:12:40 GMT. The domain must be the name of your web server, otherwise
the browser will not provide the cookie information.
[SETCOOKIE name=Visits&value=12&expires=Wednesday, 09-Nov-1999 23:12:40 GMT&path=/&domain=www.pacific-coast.com]
- Putting a [SETMIMEHEADER] tag into a template causes WebCatalog to add a new
MIME header to the outgoing HTML text for that page. MIME headers are normally used
to create redirect requests and cookies. WebCatalog already has special tags for
generating redirects and cookies, but in the future you
may need to create MIME headers for other purposes.
- Putting [THISURL] in your template will display the URL of the current page being
displayed as a relative path from the root of the server hierarchy.
- Putting [TIME] in your template will display the current time set on your web
server's clock. The format of the time is normally HH:MM:SS (24-hour clock), but
you can change the default format by changing the TimeFormat preference. You can
also override the default time format by specifying a format inside the tag, such
as [TIME %H:%M:%S]. See [DATE] for details.
- Putting [USERNAME] in your template will display the username entered into the
remote browser's last Realm password dialog. See [PASSWORD]
- Putting [VALIDCARD] into a template will display T or F (True or False), depending
on the value of the number in accountNum. If the accountNum is a reasonable credit
card number for the specified bank network, then T indicates it is good. Conversely,
F indicates it is bad. This does not call the bank to verify funds on the
card -- it merely does a simple numeric checksum to verify the number is consistent
with a credit card number.
|(Required) The credit card number. Any extra spaces or non-numeric characters will
|(Optional) Set card to the names of the credit cards that are allowed, separated
by space or +. Possible values are ALL, IGNORE, VISA, MC, AMEX, DISC, JCB,
DINER. If not specified, then ALL cards are allowed. IGNORE tells it to always
validate the card regardless of its checksum.
- Putting [VERSION] in your template will display the version of the currently-running
WebCatalog program or plugin.