Web Crossing Template Language
Commands & Variables

Table of Contents

» About WCTL Commands and Built-in Variables

Note that when you use a variable to get HTML text from the Web Crossing database, this text is generally available either formatted or unformatted. Formatted text has been run through the quick-editor and checked for legal and balanced HTML tags. Unformatted text is the raw text as originally entered by the user. There is an extensive set of string functions to allow you to convert any text to the desired format.

» Variables by function

User Information
Current user values
Kind of user
User last login time
Current user configuration
User subscriptions
Selecting and sorting users
Current user access to current location
Other registered user access to current location
Author information

Conference and Chat Management
Current location
Current location values
Current location nested contents
Selecting and sorting folder and discussion contents
Group commands
Chat rooms
Site information
Enclosures
Moderated messages
Queue for moderated messages

Current Web Crossing Context
Authentication
Browser information
Error Handling
Forms processing
CGI environment variables and HTTP response values
Current page type
Message item, discussion heading, and folder heading information
Standard layouts
User interface directives
Message list context.
Login and registration actions
Editing information
Preferences editing information
Search commands
Threaded Messages Display
Newsgroups
E-mail list mirroring
Source/Mirror cluster
Modules
Filters
Graphics
Enabled Features and Licenses

WCTL Directives
String operations
Date and time operations
Path operations
File system and logging
Scripting and e-mail
Persistent variables
Create/destroy commands
General directives

» Current user values

u.userPasswordMD5	MD5 hash of the user's original password
u.userPostCount	Number of posts tracked for this user.
u.setUserCheckRemoteAddr	Set a user's flag for checking the remote IP address.
user	User unique ID in hexadecimal. Used in user.function expressions.
user2ndLine (also user.setUser2ndLine)	Second line of information.
userAlias (also user.setUserAlias)	Email alias.
userBio (also user.setUserBio)	User biographical information.
userCanAddLinks	True if the user can add links to the current location.
userCreate	Create a new user.
user.userDestroy	Create or destroy a user.
u.userDate	Date/time a user was created.
u.userDefaultDomain	Default domain name of the server for the user's local e-mail box.
username.emailLookupUser( domain, index )	Looks up a user by email name and optional domain.
userEmail (also user.setUserEmail)	E-mail address. See u.userMailbox for the local email address of a user.
userEmailAliases (also user.setUserEmailAliases)	User's e-mail aliases (i.e. multiple different e-mail addresses for the same user).
userEmailCode	The user's e-mail code after an automated e-mail message has been sent to them.
userField	Additional custom fields added to user's information record.
user.userForwardTo (also user.setUserForwardTo)	Forwarding address for incoming email. If set, all email sent to this user will be forwarded as specified.
user.userFtpHome (also user.setUserFtpHome(h))	Get/set a user's home FTP directory.
userGroups	List of user groups the user belongs to.
userHasPicture	User has picture.
userHomePage (also user.setUserHomePage)	Home page URL.
userLastExport	Return name of last file exported by user.
userLookup	Lookup a user by name.
u.userMailbox	Local email address for a user (versus userEmail, which is the external email address).
username (also user.setUserName)	Name.
string.usernameLogin	Check to login a username/password, returns the userId if login is successful.
u.userNetEmail	Email address after taking into account local mailboxes, forwarding,etc.
userOutsideEmail	Outside e-mail address for a user (i.e. the user's contact e-mail address). If not set, or the user has forwarding e-mail address set, the function returns user's forward e-mail address to.
user.setUserPassword (also user.userCheckPassword)	Set or check a user password.
userPicture	URL to user's picture.
userSpellCheckIgnores (also user.setUserSpellCheckIgnores)	List of personal spelling words for a user.
userUniqueId	User's unique ID.
userUrls (also user.setUserUrls)	User URL list, formatted.
userUrlsRaw	User URL list, unformatted.
userUseCookies (also user.setUserUseCookies)	True if the user has cookies enabled.
user.addUserToGroup user.removeUserFromGroup user.userIsMember user.userIsMemberAny	Check, add, or remove membership in a group.
userPathAccess	Return "host," "participant," "readOnly," "moderated," or "none."
u.setUserImap (value)	Set user's access to IMAP email.
u.setUserPathAccess	Set access for a user u.
u.setUserPop3 (value)	Set user's access to POP3 email.
u.setUserWebEmail (value)	Set user's access to web email.
u.userPosts( count )	Get a list of most recent posts by a user, if "track user posts" is enabled.

» Kind of user

userIsCgiUser also u.userIsCgiUser	Returns 1 if the user is sysop/superhost or is a member of the cgiUser group.
u.userIsDeleted	Returns 1 if tje user is deleted but is still in the database.
userIsGuest	Guest user (i.e. the user has posted as a guest).
userIsHost	Host user (for the current location).
userIsHostOrSysop	Sysop.
userIsProvisional (also user.setUserIsProvisional)	True if the user is provisional or host user (for the current location).
userIsRegistered	Registered user.
userIsSuperhost	Superhost user (treated as sysop except for site service IPs, ports, etc. settings)
userIsSysop	Sysop or superhost user.
userIsUnknown	User has neither logged in nor posted as a guest.
userIsWctlUser also u.userIsWctlUser	Returns 1 if the user is sysop/superhost or is a member of the wctlUsers group.

» User last login time

awayHours	Check hours since last login.
userAwayHours	Number of hours user has been away for a user ID (e.g. the number of hours between the current login and the prior login).
lastLogin	Check for last login before a specific date. (Note that %% if lastLogin... %% doesn't make any sense in a login message, because the user is unknown at that point -- if the user is a guest or not logged in, this expression will evaluate as true.)
userLastLogin	Check for last login before a specific date for a user ID.
userLastLoginValue	Prior login date/time before the last (or current) login for a user ID.
userThisLogin	Last (current) login date/time for a user ID.
userThisLoginValue	Last (current) login date/time for a user ID.

» Current user configuration

userBouncedEmail also (user.setUserBouncedEmail)	Check if a user has bounced e-mail (i.e. no messages will be sent to the user, until his/her next login and check/confirm his/her e-mail address).
userChatPreference (also user.setUserChatPreference)	Type of chat service used in a chat room for a user. This can be "JavaApplet" or "HTML".
userCheckChangePassword (also user.setUserCheckChangePassword)	Check if a user has to change password the next time he or she logs in.
userCheckRemoteAddr	Check that user certificate is from the same IP address as originally
userDigestTimes (also user.setUserDigestTimes)	List of e-mail digest mailing times for a user.
userFolderSortBy (also user.setUserFolderSortBy)	The sort-sequence used to list folders for this user.
userHasCookie	TRUE iff the current user was validated by a webxUser cookie.
userHasImap	Check whether a user has an Internet Message Access Protocol (IMAP4rev1) access to his or her e-mail account.
userHasPop3	Check whether a user has a POP3 e-mail account (i.e. the POP3 e-mail service, such as Eudora or Outlook Express, is enabled for the user, and the user is provided with personal e-mail box).
userHasRespBodySize (also user.setUserRespBodySize)	Check whether the user has specified a font size for the body of a message.
userHasRespInfoSize	Check whether the user has specified a font size for the secondary information in messages.
userHasRespNameSize	Check whether the user has specified a font size for the user name in message.
userHasWebEmail	Check whether a user has a Web e-mail account (i.e. the Web e-mail service is enabled for the user, and the user is provided with personal e-mail box).
userInboxIsFull	TRUE if a number of messages in the user's Inbox is greater or equal to the limit set in the user preferences or in the sysop control panel.
userImapIsSpecific (also user.setUserImapIsSpecific)	Check whether the default site settings are used, or whether the user property ( userImapSpecific ) is used to determine if a user has the IMAP access to his or her e-mail account.
userImapSpecific (also user.setUserImapSpecific)	TRUE if the user preference is to have the IMAP e-mail service enabled for a user.
id.userLogoutTime (also user.setUserLogoutTime)	User logout time in minutes.
u.setUserPicture( picture )	Set a user's picture
userPickedEmailBox (also user.setUserPickedEmailBox)	TRUE if the user has chosen whether to receive e-mail to a local e-mail address ( userMailbox ) or to have it forwarded to an external e-mail address ( userEmail ).
userPictBorder (also user.setUserPictBorder)	Show picture borders for this user.
setUserPop3 ( value )	Set user access to POP3 services, where value can be 0, 1 or "default" to turn services off, on or reset-to-default.
userRegisteredTd (also user.setUserRegisteredTd( dateObj ))	Get/set the date when a user registered.
userRespBodySize	The font size for message bodies (0 if not specified by the user).
userRespInfoSize (also user.setUserRespInfoSize)	The font size for secondary information in a message (0 if not specified by the user).
user.userMarkCurrent	Mark a user's subscription list as current.
userMaxData (also user.setUserMaxData)	Maximum number of data bytes in a list of messages.
userMaxEmailMessages (also user.setUserMaxEmailMessages)	Maximum number of e-mail messages allowed in the user's inbox.
userMaxMessages (also user.setUserMaxMessages)	Maximum number of messages in a list of messages.
userNextDigest	Scheduled date/time when the next digest of messages will be sent for a user by e-mail, if there any message that is waiting to be sent for the user.
userNextDigestCount	Number of messages that are waiting to be sent for a user as a digest by e-mail.
userNextDigestList	List of messages queued for e-mail digest as message location unique IDs.
userPop3IsSpecific (also user.setUserPop3IsSpecific)	Check whether the default site settings are used, or whether the user property ( userPop3Specific ) is used to determine if a user has the POP3 e-mail account.
userPop3Specific (also user.setUserPop3Specific)	TRUE if the user preference is to have the POP3 e-mail service enabled for a user.
userRespNameSize (also user.setUserRespNameSize)	The font size for user names in a message (0 if not specified by the user).
userShowPictures (also user.setUserShowPictures)	Include user pictures with messages.
userShowPrepared (also user.setUserShowPrepared)	Show the "prepared for..." line at the top of each page.
userSubscriptionList	User subscription list, as displayed in the user preferences page.
userUseEmoticons (also setUserUseEmoticons )	Get/set a user's emoticons preference.
userWebEmailIsSpecific (also user.setUserWebEmailIsSpecific)	Check whether the default site settings are used, or whether the user property ( userWebEmailSpecific ) is used to determine if a user has a Web e-mail account.
userWebEmailSpecific (also user.setUserWebEmailSpecific)	TRUE if the user preference is to have the Web e-mail service enabled for a user.

» User subscriptions

mostRecentNewMessage	Returns the date/time of the most recent new message from the last userNewMessages.
u.userAddSubscriptions( subscriptionTypes )	Subscribes a user to the current location (folder or discussion) by the specified subscription types (i.e. allowing the user to receive new messages by web, by e-mail, and to receive digests of new messages by e-mail).
u.userClearSubscriptions	Clear a user's entire subscription list.
u.userCountNewEmail	Number of new (unread) email messages for a user
u.userFullEmail (also user.setUserFullEmail)	Send URL notification or full messages in email for user's e-mail subscriptions.
u.userHasNewEmail	Check whether a user has any new (unread) email messages.
userHasSubscriptions	Check whether a user has any subscriptions.
userIsSubscribed	User is subscribed to the current location.
userIsSubscribedDigest	Check whether a user is subscribed to the current location and he has checked the Email Digest option (i.e. the user gets an email digest of new messages, sent to the user on a regular basis).
userIsSubscribedEmail	Check whether a user is subscribed to the current location and he has checked the Email option (i.e. the user gets an email message every time a new message is posted).
userIsSubscribedMsgs	Check whether a user is subscribed to the current location and he has checked the Check Messages option (i.e. the user sees new messages when he clicks on Check Messages, and sees new messages in his Message Center page).
u.userNewMessages	Returns a list of all new message locations (one per discussion).
u.userRemoveSubscriptions( subscriptionTypes )	Cancels a user's subscription methods (i.e. allowing the user to receive new messages by web, by e-mail, and to receive digests of new messages by e-mail) to the current location (folder or discussion).
userSubscribe	Subscribe a user to the current location.
u.userSubscribeCleanup	Clean up the user's subscription lists.
userSubscribeDigest	Subscribe a user to the current location (folder or discussion) and allow him to receive digests of new messages by e-mail.
userSubscribeEmail	Subscribe a user to the current location (folder or discussion) and allow him to receive new messages by e-mail.
userSubscribeMsgs	Subscribe a user to the current location (folder or discussion) and allow him to find new messages by logging in to the site and clicking on Check Messages, or through the Message Center page.
userSubscriptions	List of locations and whether they are subscribed to or not.
userUnsubscribe	Cancel a user's subscription to the current location.
userUnsubscribeDigest	Cancel a user's subscription method to the current location (folder or discussion) allowing the user to receive digests of new messages by e-mail.
userUnsubscribeEmail	Cancel a user's subscription method to the current location (folder or discussion) allowing the user to receive new messages by e-mail.
userUnsubscribeMsgs	Cancel a user's subscription method to the current location (folder or discussion) by logging in to the site and clicking on Check Messages, or through the Message Center page.

» Selecting and sorting users.
These commands let you select and sort the user directory or a subset.

selectRandomUser	Return a randomly selected user.
selectUsers	Return a list of users matching some selection criteria.
userList.userSort( spec )	Sort a list of userIDs.

» Current user access to current location

userCanAddDiscussions	User can add discussions to current location.
userCanAddFolders	User can add folders to current location.
userCanAddMessages	User can add messages to current location.
userCanDelete	User can delete the current location.
userCanEdit	User can edit to current location.
user.userCanView	User can view the current location.
u.userHasNoAccess	User has no access at the current location.
u.userIsModerated	User is moderated at the current location.
u.userIsParticipant	User is a participant at the current location.
u.userIsReadOnly	User is read-only at the current location.

» Other registered user access to current location

otherCanAddFolders	Other registered users can add folders to the current location.
otherCanAddDiscussions	Other registered users can add discussions to the current location.
otherCanAddMessages	Other registered users can add messages to the current location.
otherCanAddLinks	Other registered users can add links to the current location.

» Author information.
This is about the author of the current folder, discussion, message, or personal information page.

author	The unique ID in hexadecimal of the current author. Used in author.function expressions.
authorAlias	Author's email alias.
authorBio	Author's biographical information.
authorEmail	E-mail address of author.
authorField	Author's additional fields.
authorHasPicture	Author has a picture.
authorHomePage	URL to author's home page.
authorInfoUrl	URL to author's personal information page.
authorIsCgiUser	Returns 1 the author is sysop/superhost or is a member of the cgiUser group .
authorIsSuperhost	Returns TRUE iff the user is in the superhost group, else false.
authorIsSysop	Current location created by the sysop.
authorIsWctlUser	Returns 1 the author is sysop/superhost or is a member of the wctlUser group.
authorLine2	Author's secondary information.
authorName	Name of the author of the current location.
authorPicture	URL to author's picture.
authorShow	Show author information for the current location.
authorUniqueID	Author's unique ID in hexadecimal.
authorUrls	Author's favorite URLs, formatted.
authorUrlsRaw	Author's favorite URLs, unformatted.
pathShowAuthor (also setPathShowAuthor)	The Flag is the location in the database that tells whether the author's name should be shown when that location is displayed.
setAuthor	Set the current author to a particular user, and clear the current location.
setPathAuthor	Change the author of record for the current location.

» Current location
The current location is initially set to the folder, discussion, message, link, or chat room referenced by the user (the location portion of a Web Crossing URL). You can change the location by using the setPath location or other directives, and you can return to the original location at any time by using setPath with no location parameter.

setLinkUrl	Set the URL that a link entry points to.
linkUrl	Return the url that a link references.
location	Pathname of the current location.
parentTitle	Title of parent at specified level.
parentTitleUrl	Same as parentTitle, but URL quoted (blanks as %20, etc.). If the current location is a message, pathTitleUrl returns title or name of the message's discussion, URL-quoted.
parentUrl	URL to parent at specified level.
setPath	Set current location.
setPathContentType	Set content-type for a location.
setPathFollowLink	Move to the location pointed to by the current link and make the link part of the current pathname.
setPathId( id )	Change the unique ID of the current location.
setPathListable( flag )	Change the "hidden" status of a folder.
setPathNoLink( location )	Set a location to a link instead of automatically following the link.
pathIcon	URL of icon for current location.
pathIconParent	URL of icon for parent of current location.
pathIsChat	Current location is a chat room.
pathIsChild (loc)	Returns TRUE if the current path is a child (at any level) of the specified location.
pathIsDiscussion	Current location is a discussion.
pathIsFolder	Current location is a folder.
pathIsLink	Current location is a link.
pathIsMessage	Current location is a message.
pathIsNone	Not at a valid location.
pathIsParent (loc)	Returns TRUE if the current path is a parent (at any level) of the specified location.
pathIsTop	At top level.
pathItemNumber	Item number for a discussion or message.
pathMainRoom (also setPathMainRoom)	Common room for a chat table.
pathMoveTo	Move a folder, chat room, link, node, discussion, or message to a new location
pathMoveTreeTo	Move a folder, chat room, link, node, discussion-tree, or message-tree to a new location
pathTitle (also setPathTitle)	Title or name of current location. If the current location is a message, pathTitle returns title or name of the message's discussion.
pathTitleRaw	Title or name of current location without any quoting.
pathTitleUrl	Same as pathTitle, but URL quoted (blanks are %20, etc.).
setPathToGroup	Set the current location to a user group.
setPathToLink	Move to the location pointed to by the current link, without making the link part of the current pathname.
setPathToParent	Move to the parent of the current location.
setPathToTreeParent	If the current location is a message, change the current location to the parent item of this message.
pathTreeTitle	Returns the title of a message (i.e. the "tree" title).
pathUrl	Returns a URL to the current location.
pathUrlCmd( command )	Returns a URL for the current location with the specified command code or macro name.
pathUrlCmdFull( command )	Returns a full URL (e.g. with http(s)://domain/...) for the current location with the specified command code or macro name.
pathUrlFull	Returns a full URL (e.g. with http(s)://domain/...) for the current location.

» Current location values

linkDescription (also setLinkDescription)	Descriptive text for a link.
linkShowDescription (also setLinkShowDescription)	Current location is a link that shows its description.
pathAddDiscussions (also setPathAddDiscussions)	Allow discussions to be added.
pathAddSubfolders (also setPathAddSubfolders)	Allow subfolders to be added.
pathAddSubfoldersOnce (also setPathAddSubfoldersOnce)	Allow subfolders, but they may only contain discussions.
pathArchiveDays (also setPathArchiveDays)	For a folder, the number of days before a discussion expires.
pathArchiveFolder (also setPathArchiveFolder)	If disposition for an elapsed discussion is to move to a folder, then this is the unique ID of the destination folder.
pathArchiveType	Disposition of an elapsed discussion: move to a folder, delete, or purge.
pathBackground (also setPathBackground)	Background, unformatted. (deprecated - see pathBodyTag )
pathBanner (also setPathBanner)	Banner, unformatted.
pathBody (also setPathBody)	Body text, unformatted.
pathBodyFormatted	Body text, formatted.
pathBodyRaw	Fetch raw data from folder headings, discussions, and messages.
pathBodyTag	Background, unformatted, for the current location.
pathCreatedDate (also setPathCreatedDate)	Creation date.
pathFooter (also setPathFooter)	Footer, unformatted.
pathHosts pathHostIds	List of hosts for the current location.
pathIsDeleted	Has a message been deleted.
pathIsNew	Returns true if the current location is a folder, discussion, or message, and this item has not yet been read by the user.
pathIsPermanent (also setPathPermanent)	Checks whether a discussion is permanent, i.e. never expires.
pathIsPlugin	Checks whether an object is a plugin.
pathListItems (also setPathListItems)	List items in a folder.
pathMarkAsRead pathMarkAsReadAll	Mark a location as having been read, or a location and all of its children
pathMessage (also setPathMessage)	Message text (if a message item), unformatted.
pathMimeFrom (also setPathMimeFrom)	The "From" header for incoming MIME-formatted messages
pathMimeOther (also setPathMimeOther)	Other heading fields/values for incoming MIME-formatted messages. From/To are kept separately, all other header values are in other, including Reply-To. (pathMimeReplyTo is a convenience routing to extract the Reply-To value from the pathMimeOther values.)
pathMimeReplyTo	The "Reply-To" header for incoming MIME-formatted messages
pathMimeTo (also setPathMimeTo)	The "To" header for incoming MIME-formatted messages
pathModeratedUsers pathModeratedUserIds	List of moderated users for the current location.
pathModifiedDate	Last modified date.
pathNetHasObjectionable	1 if the current location has an objectionable word list or is checking for phone numbers in posts, 0 otherwise
pathNetObjectionable	Actual objectionable-word list used for the current location
pathNetObjectionablePhone	1 if the current location is checking for phone numbers, otherwise 0
pathNetUrlHttpDomain	Returns the net "http(s)://domain" for the current location
pathNoAccessUsers pathNoAccessUserIds	List of users with no access to the current location.
pathNoSubfolders (also setPathNoSubfolders)	No subfolders may be added.
pathObjectionable (also setPathObjectionable)	Objectionable word list for a specific location in the pathname hierarchy
pathParticipants pathParticipantIds	List of participants for the current location.
pathReadOnlyUsers pathReadOnlyUserIds	List of read-only users for the current location.
setPathShowByUserPreferences	Use this for threading.
pathSortSeq (also setPathSortSeq))	Sort sequence for folder items.
pathSource	Track how discussions and messages were posted.
pathTemplate (also setPathTemplate)	Template for location (i.e. folder template).
pluginCreate( title )	Create a new plugin object in the current folder.

» Current location nested contents

newDiscuss	Returns HTML list of new discussion titles, with hyperlinks and graphical path dividers.
pathChatCount	Chat rooms in a folder.
pathDepth	The nesting depth in the hierarchical threaded tree.
pathDiscussionCount	Nested discussion count.
pathFolderCount	Nested folder count.
pathHasDiscussions	Current location has nested discussions.
pathHasFolders	Current location has nested folders.
pathHasItems	Current location has nested items.
pathHasMessages	Current location has nested messages.
pathHasOneDiscussion	Current location has exactly one nested discussion.
pathHasOneFolder	Current location has exactly one nested folder.
pathHasOneMessage	Current location has exactly one message.
pathHasNewMessages	Current location has new messages for the current user.
pathHasOneNewMessage	Current location has exactly one new message for the current user.
pathLinkCount	Links in a folder.
pathLinkToDiscussionCount	The number of links to folders.
pathLinkToFoldersCount	The number of links to folders.
pathMessageCount	Count of nested messages, igoring messages that are moved or deleted-and-not-showing for the current user
pathMessageTotal	Total number of items in a discussion, including all deleted and moved messages
pathNewMessageCount	Count of new messages for the current user.

» Site information.

copyright	The copyright string for the program.
hostIsTemplate	Returns TRUE if the site is configured so that sysop and host posts are evaluated as WCTL macros.
pictSizeButton	WIDTH and HEIGHT for button icon.
pictSizeConversation	WIDTH and HEIGHT for conversation icon.
pictSizeDivider	WIDTH and HEIGHT for pathname divider icon.
pictSizeFolder	WIDTH and HEIGHT for folder icon.
pictSizeInlineButton	WIDTH and HEIGHT for inline button icon.
pictSizeLink	WIDTH and HEIGHT for inline link icon.
pictSizeOutline	WIDTH and HEIGHT for outline button icon.
pictSizePlugin	WIDTH and HEIGHT for plugin icon.
pictSizeSite	WIDTH and HEIGHT for site icon.
platform	Site platform.
programDesc	A short string that describes the program.
serveInfoPictures	Site is serving user pictures in the personal information page only.
servePictures	Site is serving user pictures everywhere.
setSite86edEmail	Set the list of email addresses that are not allowed for registered users at this site.
setSiteCertificate	Install a new certificate for the server
setSiteCalendar	Set path to site calendar directory
showsiteBuildDateInt	Return the current build date.
siteDbVersion	Return the current database internal version number.
setSiteDocs	Set path to site documentation files directory
setSiteEmail	Set site email address.
setSiteFullBackground( bg )	Set site background string.
setSiteHelp	Set path to site help files directory
setSiteHtmlActive( flag )	Set whether or not the site is serving HTTP (direct web service or DWS)
setSiteHttpAllowDeny( list )	Set the allow/deny list for HTTP access
setSiteHttpDataFiles( list )	Set the directory for serving static html files
setSiteIcons	Set path to site icons directory
setSiteImages	Set path to site images directory
setSiteLogoutTime( minutes)	Set the default automatic logout time.
setSiteNntpAllowDeny( list )	Set the NNTP allow/deny list.
setSiteWebMap( table )	Set the web service mapping and redirection table.
setSiteResponseTimeFormat( format )	Set the response time format for the site.
setSiteTimeFormat( format )	Set the default time format for the site.
site86edEmail	Get the list of email addresses that are not allowed for registered users at this site.
siteAllowsHttpBasic	TRUE iff site is using HTTP basic authentication.
siteBuildDate	Returns build date of binaries of current instance.
siteCanAutoRegister	Users may auto-register.
siteCanSearch	Search button is enabled in nested folders and discussions.
siteCanSearchTop	Top-level search button is enabled.
siteCertExpires	Returns number of days to expire, -1 if no limit, 0 if expired.
siteCertIsOld	Returns 1 if the certificate is for an old version, else 0.
siteCertIsSeats	Returns 1 if the certificate is seat-based.
siteCertLicense	Returns license (Platinum, 5T, 5S, etc).
siteCertLimitItems	Returns item limits, LE 0 for no limit.
siteCertLimitSeats	Returns seat limits, LE 0 for no limit.
siteCertLimitPages	Returns page limits, LE 0 for no limit.
siteCharSet (also setSiteCharSet)	Returns the site character set.
siteChatSeats	Returns number of chat seats, LE 0 for no limit.
siteCreateDiscussChoice	Sysop has enabled users to choose the type of discussion at the time they create it.
site.cssRev	Counter incremented on template cache resets.
siteDbId	Returns the unique database ID for this site.
siteDiscussionShowAuthor	TRUE iff the author of a discussion is shown in the discussion's heading.
siteDiscussionShowSysop	TRUE iff the sysop is author of a discussion and is shown in the discussion's heading.
siteDocs	Sysop-documentation-directory URL string from sysop general settings.
siteLogEmailFilename	return the value of the "Log Email" filename
siteEmail	Site email address (same as sysopEmail).
siteEmailDomains	Returns the list of local email domains.
siteEmailValidate	E-mail validation is enabled for this site.
siteEmailValidateTemplate setSiteEmailValidateTemplate	Get/set the email validation template
siteEmoticons setSiteEmoticons	Get/set the URL of the directory for emoticons.
siteEmoticonsDefinition setSiteEmoticonsDefinition	Get/set the site emoticons mapping.
siteFolderShowAuthor	TRUE iff the author of a folder is shown in the folder's heading.
siteFolderShowSysop	TRUE iff the sysop is show in folder headings when this user is the author.
siteFullBackground	Returns site's background setting string.
siteHasPasswordForm	TRUE iff site has a 2-stage login using a separate password form.
siteHelp	End-user help-directory URL string from sysop general settings.
siteHost	Domain name of the Web server used to access Web Crossing.
siteHostAccessEdit	TRUE iff hosts can edit their access lists.
siteHostDirectoryDelim	Returns the directory delimiter for the current host (/ for Unix, \ for Windows, : for Mac).
siteHostFull	Full access/domain/port of the Web server used to access Web Crossing.
siteHtmlActive	Returns whether or not the site is serving HTTP (direct web service or DWS)
siteHtmlCompressionActive (also setSiteHtmlCompressionActive	Get/set the HTTP compression setting
siteHtmlRemove	Return a list of the html tags removed for this site
siteHttpAllowDeny	Return the allow/deny list for HTTP access
siteHttpDataFiles	Return the directory for serving static html files
siteIcons	Icons-directory URL string from sysop general settings.
siteImages	Buttons-directory URL (used to be all images) string from sysop general settings.
siteImapAllowDeny setSiteImapAllowDeny( list )	Returns the IMAP allow/deny list.
siteIp	Returns site IP address.
siteIsSecure	Site is running through a secure server.
siteLicensee	Site licensee name.
siteLogEmailFilename	return the value of the "Log Email" filename from the sysop control panel.
siteLogoutTime	The default automatic logout time in minutes.
siteLogPort	returns the current port being logged, 0 for all, -port for all except port, or a specific port number
siteMaxDiscussHeading	The maximum number of characters allowed for discussion headings.
siteMaxEmailMessages setSiteMaxEmailMessages(n)	Number of email messages stored for a user.
siteMaxFolderHeading	The maximum number of characters allowed for folder headings.
siteMaxItemsPerPage	returns the number of items displayed per page in a folder or threaded-discussion summary.
siteMaxMessage	The maximum number of characters allowed in a message.
siteMaxMessages	returns the number of messages displayed in a discussion page.
siteMaxTitle	The maximum number of characters allowed in a folder or discussion title.
siteMisc	Miscellaneous-files-directory URL string from sysop general settings.
siteMySubscribers	Returns true if the site allows users to subscribe other users to their discussions .
siteName setSiteName( name )	Site name/title.
siteNntpAllowDeny	Returns the NNTP allow/deny list.
siteOldDbVersion	Return the prior database internal version number.
siteOneSearch	Search the Net via Forum One.
sitePathLimit setSitePathLimit( limit )	Returns the maximum length of a pathname before switching to query-style urls.
sitePop3AllowDeny setSitePop3AllowDeny( list )	Returns the POP3 allow/deny list.
siteRelayAfterLogin setSiteRelayAfterLogin( list )	Returns the number of minutes where a login is considered recent.
siteRelayAllowDeny setSiteRelayAllowDeny( list )	Returns the SMTP relay allow/deny list.
siteResponseTimeFormat	Site's time formatting for messages.
siteScriptName setSiteScriptName( value )	Get/set the script name.
siteServerName setSiteServerName( value )	Get/set the server name.
siteSmtpAllowDeny setSiteSmtpAllowDeny( list )	Returns the incoming SMTP allow/deny list.
siteStripsHtml	TRUE if html is stripped from all non-sysop/non-host posts.
siteSysopIsTemplate	TRUE if the site is configured so that sysop posts are evaluated as WCTL macros.
siteSysopUseQuickEdit	TRUE if the site uses the quick-editor for host/sysop posts.
siteTemplateDir setSiteTemplateDir	Get/set the site's template subdirectory path.
siteTemplateErrors	Return the error messages for the current templates.
siteTemplateStatus	Return the template status.
siteTimeFormat	Site time format.
siteTimeZoneSuffix	Site time zone suffix, derived from the current siteTimeFormat.
siteTitle setTitleTitle("title")	Site title.
siteToolbarAcross	Number of buttons across for old-style toolbar.
siteUrl	URL to top-level site page.
siteUseCookies	Site is configured to use cookies.
siteUseEmailScript	TRUE iff site uses a script to get a user's e-mail address.
siteUseEmoticons	TRUE iff use of emoticons is enabled.
siteUseQuickEdit	TRUE iff site uses the quick-editor for user posts.
siteUseTemplates	Return 1/0 when the site's templates are on/off.
siteUserRegisters	TRUE iff site allows users to register other users.
siteUsersSetAliases	TRUE iff site allows users to set their own email aliases.
siteUseWctlUsers setSiteUseWctlUsers ( f )	Get/set whether the wctlUsers group is used to control access to templates
siteWebFileLimit setSiteWebFileLimit( limit )	Returns the maximum length of a webfile pathname before switching to query-style urls.
siteWebMap	Returns current web service mapping and redirection table.
siteWrapperInside	Returns 1/0 for inside/other.
siteWrapperMode siteSetWrapperMode( v )	Returns -1/0/1 for outside/none/inside.
siteWrapperOutside	Returns 1/0 for outside/other.
siteVersion	Returns version number of current instance.
statusExtras	The output of this macro is appended to the html section of the returned value from the 199@@ command.
statusExtrasXml	The output of this macro is appended to the XML section of the returned value from the 199@@ command.
sysopEmail	Sysop e-mail address.
urlBase	/...webx? portion of a Web Crossing URL.
urlBaseSlash	The URL pathname for the root WebX folder.
urlBaseSlashFull	Same as % % pathNetUrlHttpDomain & urlBaseSlash % %
useChatService	Chat services are enabled for this site.
userIsHttpBasic	TRUE iff the current user was authenticated through HTTP Basic.
usersCount	Number of registered users.
version	Web Crossing version string.
waitingForSynch	Slave server is waiting for synch with master to complete.

» Enclosures

pathDocumentImgHeight	Returns the height of a document or attachment that is an image.
pathDocumentImgWidth	Returns the width of a document or attachment that is an image.
pathDocumentImgWidthHeight	Returns the width and height of a document or attachment that is an image.
pathDocumentIsImage	TRUE iff the current location is an enclosure document.
pathDocumentIsText	TRUE iff the current location is a text enclosure document.
pathDocumentName	Original filename iff the current location is an enclosure document.
pathEnclosures	Returns list of enclosures.
pathAddEnclosure	Add an enclosure to a location (duplicating one already attached somewhere else)
pathRemoveEnclosure	Remove an enclosure from a location
pathHttpDownloads (also setPathHttpDownloads)	TRUE iff the current location supports Web-based downloads.
pathHttpUploads (also setPathHttpUploads)	TRUE iff the current location supports Web-based uploads.
pathInheritsEnclosures (also setPathInheritsEnclosures)	TRUE iff the current location inherits its enclosure settings from its parent.
pathIsDocument	TRUE iff the current location is a document.
siteHttpDownloads	TRUE iff the site supports Web-based downloads.
siteHttpUploads	TRUE iff the site supports Web-based uploads.

» Moderated messages

s.isObjectionable	Returns TRUE iff a string contains objectionable words.
s.markObjectionable	Inserts tags before and after all possibly objectionable words in a string.

» Selecting and sorting folder and discussion contents.

pathSelect	Select items from a folder or discussion.
pathSort	Sort a list of pathname items.

» Queue for moderated messages

item.moderatedApprove	Approve the moderated item, post it to its parent, and remove it from the moderated list.
item.moderatedApprovePath	Approve a moderated item and return the pathname of the new folder/discussion/message.
item.moderatedAuthor	Return authorID of the moderated item.
item.moderatedBody	Return body text.
item.moderatedDate	Return date, default format is as a date object.
item.moderatedDecline	Decline to approve a moderated item, destroy it, and remove it from the moderated list.
item.moderatedExists	Return TRUE iff item still exists.
moderatedLookup	Return blank-delimited list of moderated items that can be processed by this user.
moderatedLookupLocation	Return blank-delimited list of moderated items that can be processed by this user. Only returns items contained (at any level) in the current location.
item.moderatedSetPathToParent	Set the current location to the parent of a moderated item. (Used to be named moderatedParentOpen.)
item.moderatedShowAuthor	Returns "Show Author" flag for moderated item.
item.moderatedTitle	Return the title of the moderated item.
item.moderatedType	Return "folder," "discussion," or "message."
item.moderatedValue( name )	Return a custom path variable set for a moderated item.
item.moderatedSetValue( name, value )	Set a custom path variable set for a moderated item.

» Group commands

"groups".groupCount	Examine the master list of all groups.
groupCreate( name )	Create a new user group.
groupDestroy( name )	Destroy a user group.
groupname.groupFirst( prefix )	First group name matching a prefix
"groups".groupItem	Returns the group ID of the indexed item.
groupname.groupLast( prefix )	Last group name matching a prefix
groupName.groupItem	Return the user ID of the indexed item.
groupNameCount	Return number of items in a group.
groupLookup	Return group handle if found.
u.isGroup	Return TRUE iff the user-handle-ID "u" is a group.
u.userName	Return users's name, or a group's name for use with groupCount or groupItem, etc.

» Chat rooms.

broadcast	Broadcast to all tables in a chat room.
chatMessages	List of messages from the other chat users.
chatTables	List of chat tables.
chatTableUsers	Return the total number of users at a chat table.
chatMembers	List of chat members in this particular room.
enterChat	Enter a chat room, text-chat only.
enterChatTable	Enter a specific overflow table, text-chat only.
enterPrivateRoom( id )	Same as the "enterRoom" command, except that the parameter is the id of the room created with an earlier newPrivateRoom command.
enterRoom	Enter a chat room, text plus other services if any.
enterRoomTable	Enter a specific overflow table in a chat room, text plus other services if available.
newPrivateRoom( params )	Create a private, unnamed chat room.
pathHasTables	Current location is part of a chat room with multiple tables.
pathIsAnonymous (also setPathIsAnonymous)	Current location is a chat room that allows anonymous users.
pathIsChat	Current location is a chat room or table.
pathIsPlayLoopback (also setPathIsPlayLoopback)	Same as playback loop mode for a chat room.
pathMaxUsers (also setPathMaxUsers)	Maximum users per table for a chat table.
pathPlayFile (also setPathPlayFile)	Playback file for a chat table.
pathPlayMillisecs (also setPathPlayMillisecs)	Playback total time in milliseconds.
pathRecordFile (also setPathRecordFile)	Recording file for a chat table.
privatePlayback	Enter a private playback table.
roomError	Error message if room could not be entered.
roomHandle	Handle ID for client to use in call to chat Fanout Server.
roomIp	IP address of Fanout Server.
roomIsHost	Test whether the current user is a host for HTML chat pages.
roomPort	Port to call Fanout Server.

» Authentication

alwaysCertificate	Generate an authentication (URL) certificate even if the user came in through a cookie.
certificate	Current user's authentication certificate.
certificateLogout	Immediately expire a user's authentication certificate.
siteUseWebAuthenticate	Return 1 IFF the site uses either HTTP basic or HTTP digest authentication, or both.
siteUseWebBasic (also setSiteUseWebBasic	Get/set the site setting to use HTTP Digest authentication.
siteUseWebSecureSessions (also setSiteUseWebSecureSessions	Get/set the site setting to use SSL for registered user sessions.
sessionIsDigest	Return 1 IFF the current request is digest authenticated.
sessionIsBasic	Return 1 IFF the current request is basic authenticated.
sessionWebAuthSlot	Returns the slot number for an authenticated session.
sessionWebAuthCert	Returns the session certificate for an authenticated session.
sessionWebAuthUserID	Returns the user ID for an authenticated session.

» Browser information.

browserCanUseLabels	Client browser can use JavaScript labels.
imgButton	Client browser supports image buttons.
userAgent	Client browser "user agent" string.

» Error Handling

error	Error message for error page.
errorTitle	Suggested title for error page.

» Forms processing

allInputAsHidden( exclude )	Add all input name/value pairs as hidden fields.
line.fieldvalue( name )	Extract a field value from a MIME header line.
formGetNames	Return all names from a form. Each name is URL quoted and space delimited.
formGetNameValues	Return all name=values from a form. Each value is URL quoted and space delimited using an '=' between the name and value.
formGetValues	Return all values from a form. Each value is URL quoted and space delimited.
getValue("name") or form.name	Get a field from a post.
formHeader("name")	Return the MIME-header for a field posted through a multi-part MIME envelope.
hasValue	Check for a field in a post.

» CGI environment variables and HTTP response values

addResponseHttp	Add a keyword=value pair to the HTTP response being generated.
envir	Get the value of a CGI environment variable.
envirCookie	Get the value of a cookie in the CGI request from the client.
envirList	Get a list of CGI environment variables.
set httpDataFromServer url.http	Issue an HTTP request and wait for the response.
set httpDataFromServer url.httpReq	Allows you to generate a POST or other requests.

» Current page type

loginIs	Kind of login page being prepared.
pageIs	Kind of page being prepared.
registerIs	Kind of registration page being prepared.

» Message item, discussion heading, and folder heading information.
This information is available while laying out a message, discussion heading, or folder heading.

discussionHeader	Formatted header (not including banner or title) for a discussion
itemBodyFontSize	Font size for item body.
itemCanDelete	Item can be deleted by current user.
itemCanEdit	Item can be edited by current user.
itemCount	Total number of items in this list.
itemDate	Creation date.
itemInfoFontSize	Font size for secondary information.
itemNameFontSize	Font size for author name.
itemNumber	Item number.
itemShowOperations	Show edit and/or delete buttons.
itemShowPictBorder	Show border around picture in this item.
itemShowPictures	Show author picture in this item.
itemShowTimeDate	Show time/date.
itemIsThreaded	Set if the display is to be presented as a threaded discussion, instead of linear
itemBaseDepth	This is the depth of the "root" message for the current view. This allows you to display things relative to some node in the message hierarchy.
msgListThreaded	TRUE iff the message list is being laid out threaded. (Only meaningful in messageListBefore and messageListAfter macros.)

» Standard layouts.
Standard layouts for folders or discussion messages.

folderListAfter	Show HTML after a list of items in a folder.
folderListBefore	Show HTML before a list of items in a folder.
folderListItem	Show HTML for an item in a folder.
folderListEmpty	Show HTML for an empty folder list.
pathItems	Show items.
pathItemsAll	Show all items.
pathItemsAreAtEnd	Items are at the end of the list.
pathItemsInContext	Show items in context.
pathItemsPrevious	Show items previous.
pathStandardHeading	Show standard heading for top-level, folder, or discussion.
responsePost	Standard form to post a message.
unknownUserHelp	Standard help text for an unknown user.

» User interface directives.

backPath	Default parent location with links to parent folders.
backpathContext	Context for the backPath macro to evaluate in (e.g. the icons to use) .
background	Current background; bodyTag gives the identical results.
banner	Banner for current location, formatted.
backPathThis	Default current location with links to parent folders.
bodyTag	Current background; background gives the identical results.
editHelp	Edit help text, formatted.
footer	Footer for current location, formatted.
greetingNews	Greeting news template, formatted.
loginNews	Login news template, formatted.
message	Current message item in standard format.
pad	Insert padding in <pre> sections.
passwordNews	Password news template, formatted.
preparedFor	Default Prepared for... heading or none.
registerError	Registration error message.
registeredHeading	Registered heading, formatted.
registerHeading	Registration heading, formatted.
showPreparedFor	Show Prepared for... line for current user.
toolbar	Standard toolbar.
toolbarAfter	HTML to insert after toolbar.
toolbarBefore	HTML to insert before toolbar.
toolbarBetween	HTML to insert between toolbar rows.

» Message list context.
This information is available when a message list is being laid out.

cmdIsShowAll	True if the display command is Show All.
cmdIsShowInContext	True if the display command is Show In Context.
cmdIsShowPrevious	True if the display command is Show Previous.
msgListBetween	Eval to code "between" messages.
msgListCountFollowing	Count of following items.
msgListCountPrevious	Count of preceding items.
msgListFirst	Actual first item in the current slice of the discussion
msgListFollowing	%% location %% of following item or none.
msgListEmpty	Message list is empty.
msgListLast	Actual last item in the current slice of the discussion
msgListPrevious	%% location %% of previous item or none.

» Login and registration actions

actionPath	Action path for login and registration.
actionPathCommand	Command code in action path.
doActionPath	Action path for login and registration, with embedded certificate.
loginPassword (password)	Password with which user is attempting to log in; used by loginAuthenticateFilter
loginProtocol ("nntp")	Protocol by which user is attempting to log in; used by loginAuthenticateFilter
loginUsername (username)	Username with which user is attempting to log in; used by loginAuthenticateFilter

» Editing information.
(For registration, user preferences, new folder, new discussion, etc.)

editBanner	Banner text, unformatted.
editBackground	Background text, unformatted.
editEmail	E-mail address.
editFolderIcon	Type of icon for a link.
editFooter	Footer text, unformatted.
editHeading	Heading.
editMessage	Message.
editName	User name.
editPassword	Password.
editTemplate	Template.
editTitle	Title.
moderatedDiscussion	Display moderated discussion in default format.
moderatedFolder	Display moderated folder in default format.
moderatedMessage	Display moderated message in default format.
editShowAuthor	True to show the item's author.
editShowDescription	True to show a link's description.
editSortSeq	The sort sequence value.
editUrl	A link's URL.

» Preferences editing information

prefsEmailError	Error message for e-mail change or none.
prefsNewEmail	New e-mail address.
prefsNewName	New user name from preferences form.
prefsPasswordError	Password change error to report.
prefsRenameMessage	Error message for rename or none.
prefsPasswordMessage	Message for password change.
prefsSubscrUpdated	Message for subscription list update.
prefsSysopCertificate	Sysop authorization certificate when the sysop is changing a user's preferences.

» Search commands

name.custIndexAddRaw ( value keywordData )	Add items to a custom index.
name.custIndexAddStemmed ( value keywordData )	Add items to a custom index.
name.custIndexClose	Close a named custom index file.
name.custIndexExists	Test whether a named custom index file exists.
name.custIndexLookupRaw ( keywordData )	Look up items in a non-stemmed custom index.
name.custIndexLookupStemmed ( keywordData )	Look up items in a stemmed custom index.
name.custIndexRemoveRaw ( value keywords )	Remove items from a custom index.
name.custIndexRemoveStemmed ( value keywords )	Remove items from a custom index.
searchItems	Total number of matching items found by the last pathSearch command.
siteSearchIsReady	TRUE iff searches can be performed at this time.
siteIndexSearchStatus	Current status of search, such as indexing status.
pathSearch	Returns a list of items matching a search query.

» Threaded Messages Display

pathInheritsByUserPreferences	TRUE if current location inherits its threading settings from its parent.
pathNetMessageTitle	TRUE if net effect of all settings is to request a title for all messages.
pathNetReplyTo	TRUE if net effect of all settings is to show a Reply button with each message.
pathNetSummaryButton	TRUE if net effect of all settings is to show an Outline button next to discussions in their folder listing.
pathNetTreeView	TRUE if net effect of path hierarchy settings (ignoring user settings) is to show as threaded messages.
pathShowByUserPreferences	TRUE if threading display is from user preferences.
siteUserDefaultReplyTo	TRUE if site default is for a user to see a Reply button with each message.
siteUserDefaultThreading	TRUE if site default is for a user to view as threaded messages.
u.userReplyTo	TRUE if user preference is to show a Reply button with each message.
u.userSummaryButton	TRUE if user preference is to see an Outline button next to discussions in their folder listing.
u.userThreading	TRUE if user preference is to view as threaded messages.
u.userThreadingBySite	TRUE if user uses site settings for threading.
siteUserDefaultSummaryButton	TRUE if site default is for a user to see an Outline button next to discussions in their folder listing.

» Newsgroups

editNewsgroup	Name of newsgroup when editing an Add Folder or Edit Folder form.
firstLocal	Save the first local new message found by userNewMessages.
pathNewsGetFrom (also setPathNewsGetFrom)	The external server for mirroring that we get new messages from. This value is a ip address and optional port, such as "206.52.123.1:119."
pathNewsGetMode (also setPathNewsGetMode)	Get messages from an external news server.
pathNewsGetPassword (also setPathNewsGetPassword)	The the login password for mirroring, when we pull new messages.
pathNewsGetUsername (also setPathNewsGetUsername)	The login username for mirroring when pulling new messages.
pathNewsMode (alsosetPathNewsMode)	Control how we mirror a Web Crossing folder/newsgroup with external servers.
pathNewsSendPassword (and setPathNewsSendPassword)	The login username for mirroring when sending new messages.
pathNewsSendTo (also setPathNewsSendTo)	IP of external server for mirroring, that we send new messages to.
pathNewsSendUsername (also pathNewsSendUsername)	Login username for mirroring when sending new messages.
pathNntpPostsOk (also setPathNntpPostsOk)	Allow external newsgroup clients to post messages without logging in.
siteHasNews	TRUE iff news service is enabled for the site.

» E-mail list mirroring

editEmailFrom	Setting for pathEmailFrom during Add Folder or Edit Folder
editEmailMirror	Setting for pathEmailMirror during Add Folder or Edit Folder.
editEmailPostThru	Setting for pathEmailPostThru during Add Folder or Edit Folder
editEmailPW	Setting for pathEmailPW during Add Folder or Edit Folder.
editEmailReply	Setting for pathEmailReply during Add Folder or Edit Folder.
editEmailReplyTo	Setting for pathEmailReplyTo during Add Folder or Edit Folder
editEmailStripSig	Setting for pathEmailStripSig during Add Folder or Edit Folder
pathEmailFrom (also setPathEmailFrom)	From value for messages forwarded to the list, or blank to use the user's e-mail address.
pathEmailMirror (also setPathEmailMirror	Mailbox from which to read e-mail list messages.
pathEmailNotify	Send emails to subscribed users, and post-through to any external email list.
pathEmailPostsOk (also setPathEmailPostsOk)	TRUE if messages posted by email are permitted.
pathEmailPostThru (also setPathEmailPostThru)	TRUE if messages posted to Web Crossing are forwarded to the e-mail list.
pathEmailPW	Password for pathEmailMirror mailbox.
pathEmailReply (also setPathEmailReply)	Address to which to send messages posted directly to Web Crossing.
pathEmailReplyTo (also setPathEmailReplyTo)	Reply-to value for messages forwarded to the list, or blank to use the user's e-mail address.
pathEmailStripSig	Signature to strip from tail of incoming messages.
siteHasEmailServices	TRUE iff site has e-mail services (i.e. DNS server address is available).
siteHasWebEmail	TRUE iff site has e-mail boxes (i.e. Web-based email is available).

» Source/Mirror cluster

siteIsSlave

TRUE if instance is a mirror in a source/mirror cluster

» Modules

moduleName	Module name
moduleVersion	Module version
setModuleName	Set the module name
setModuleVersion	Set the module version

» Filters

filterNeedsUrlNotify

Variable for the emailFilterIndividual filter.

» Graphics

These directives all start with the siteImages or siteIcons URL. If langDir is present and non-blank, this is the language directory, and is inserted one level up from the lowest-level directory. For example, if siteImages is "/Images/b1", them "ok.gif".siteImagesUrl( "French" ) is "/Images/French/b1/ok.gif".

The width/height of the image are obtained by reading and parsing the image file to extract this information. If the file is not present, or is not a legal gif/jpeg, then these are not included in the tags, and are returned as 0 by the xxxWidth/Height directives. Once the width/height have been read and parsed, they are cached in the server for later use. Resetting the template files will reset this cache. So if you upload new icons/images, you need to reset the webx.tpl cache. The xxxImg directive returns a full <img...> tag, with the src field coming from the button/image name, the current siteImages/Icons, and the langDir values. If alt is present and non-blank, then an alt="alt" attribute is added. If attrs is present and non-blank, then this value is added at the end of the tag as additional attributes.

If spacerToWidth is present, then a transparent spacer (/Images/m/t.gif) is added to make the total width of the image and space be spacerToWidth.

» Enabled Features and Licenses

The site "enable" directives get or set the value that indicates whether a particular service is available in a Web Crossing instance. If the current license does not enable some service, then the "siteXXX" value will always return false, regardless of what it is set to. A service may be installed and licensed, but not enabled in the control panel. The license "enable" directives indicate whether the site is licensed for a particular service.

siteUseDiscussions (also setSiteUseDiscussions)	Get/set the flag for discussion usage
siteHtmlActive (also setSiteHtmlActive)	Get/set whether or not the site is serving HTTP (direct web service or DWS)
sitePop3 (also setSiteHasPop3)	Get/set the flag for POP3 service
siteImap (also setSiteHasImap)	Get/set the flag for Imap service
siteHasWebEmail (also setSiteHasWebEmail)	Get/set the flag for Webmail service
siteHasNews (also setSiteHasNews)	Get/set the flag for NNTP service
useChatService (also setUseChatService)	Get/set the flag for chat service
siteHasFtp (also setSiteHasFtp)	Get/set the flag for FTP service
siteSmtp (also setSiteHasSmtp)	Get/set the flag for SMTP service
siteSmtpForwarding (also setSiteHasSmtpForwarding)	Get/set the flag for SMTP forwarding service
licenseHasDiscussions	Site is licensed for discussion usage
licenseHasHtml	Site is licensed for serving HTTP (direct web service or DWS)
licenseHasPop3	Site is licensed for POP3 service
licenseHasImap	Site is licensed for Imap service
licenseHasWebEmail	Site is licensed for Webmail service
licenseHasNews	Site is licensed NNTP service
licenseHasChatService	Site is licensed for chat service
licenseHasFtp	Site is licensed for FTP service
licenseHasSmtp	Site is licensed for SMTP service
licenseHasSmtpForwarding	Site is licensed for SMTP forwarding service

» String Operations

String manipulation
count	Number of characters in a string.
cr	A carriage-return string.
crlf	A carriage-return/line-feed string.
emoticonsReplace	Replace emoticon patterns in a string.
eval	Evaluate a string as a WCTL expression.
evalTemplate	Evaluate a string as a WCTL template.
getchar	Get a character from a string.
hardWrap	Convert a string to preserve linebreaks and indents. All hard linebreaks are converted to either <br> or <p> and all indents (both tabs and spaces) are converted to &nbsp; equivalents.
htmlOut	Format "string" into normal output format per the rules for the given source/contentType.
htmlToPlainText	Convert a string into similar-looking plain text.
isObjectionable	Check for objectionable words.
lf	A line-feed string.
lookup	Lookup a pattern in a string.
markObjectionable	Mark objectionable words.
putchar	Put a character into a string.
randomString	A random 11-character string.
replace( from, to, startIx, length )	Replace a section of a string.
spellCheckSetup	Sets up a spell-checking dialog for a string.
split	Split the first token off a string.
splitCount	Count the number of tokens in a string.
splitEmail	Split the first email address off a string.
splitList	Split the first token off a string.
substring	Get a substring of a string.
tail	Split the last token off a string.
toJIS	Convert to 7-bit Japanese characters.
toJisIfSiteIsJapanese	Convert to 7-bit Japanese characters if the site default charset is Japanese
toLower	Convert to lower case.
toShiftJIS	Convert to 8-bit Japanese characters.
toUpper	Convert to upper case.
trim	Remove leading and trailing white space.
validEmail	Check for a valid email address.
wrap	Wrap text to a specified column width.
User names
nameToFirstLast	Convert name to first-last format.
nameToLastFirst	Convert name to last-comma-first format.
getFirstName	First name from a name string.
getLastName	Last name from a name string.
XML Parsing Logic
string.fromXML	Returns plain-text string.
string.toXML	Returns string formatted with XML escapes.
string.toXMLData	Returns string formatted with XML escapes.
setXmlIndex (and string.xmlParse)	Return TRUE iff the input string was not empty.
xmlParseClose	Add text to the current xmlData string until the closing element matching xmlElement is found.
HTML
fromSGML	Convert from SGML quotes to original string.
htmlClosure	Fixup for HTML tag closure and remove illegal tags.
htmlStripTags	Strip all HTML tags from a string.
httpToLinks	Convert all HTML tags in a string to links.
quickEdit	Process a string with the Web Crossing quick editor.
s.revertHtmlLinks	Revert automatic conversion of pasted links back to the original link.
selfRef	Insert correct certificate in all local URLs.
textToHtml	Convert hard line-breaks to <br> and blank lines to <p>.
toSGML	Convert to SGML quoted format.
toSgmlNoEscs	Convert strings to SGML quoted format but leave any SGML escaped characters in the original string.
URLs
fromURL	Convert from URL quotes to original string.
toURL	Convert to URL quoted format.
Numbers
hexToInt	Convert a hexadecimal string to an integer.
intToHex	Convert an integer to hexadecimal.
intWithCommas	Convert an integer to a numeric string with commas.
numberString.numberFormat	Convert a numeric string to a specified numeric format.
MIME Formats
canUseQuotedPrintable	Check whether a string is suitable for quoted-printable formatting.
fromBase64	Convert a string from base-64 format.
fromQuotedPrintable	Convert a string from quoted-printable format.
toBase64	Convert a string to base-64 format.
toQuotedPrintable	Convert a string to quoted-printable format.

» Date and time operations

date	Current date.
dateNamesSetDefault( spec )	Set default date format.
dateNamesSetCurrent( spec )	Set date format for current command only.
dateString.dateAddSeconds	Adds the specified number of seconds (positive or negative) and returns the adjusted dateObject.
dateString.dateDeltaSeconds( date2 )	Returns the number of seconds for (dateString-date2).
dateString.dateEqual	Returns TRUE iff dateString == date2.
dateString.dateFormat	Formats a date per the format string.
date.dateFromGmt	Convert a date object from GMT to local time.
dateGMT	Current date/time in GMT.
dateString.dateGreaterThan	Returns TRUE iff dateString > date2.
dateString.dateLessThan	Returns TRUE iff dateString < date2.
dateObject	Time/date format to get a date object.
dateObj	Same as dateObject.
dateString.dateSetHours( hours )	Sets the hours (24 hour clock, so the hour is from 0 to 23) and returns the adjusted dateObject.
dateString.dateSetMinutes( minutes )	Sets the minutes (from 0 to 59) and returns the adjusted dateObject.
dateString.dateSetSeconds( seconds )	Sets the seconds (from 0 to 59) and returns the adjusted dateObject.
dateString.dateSubtractSeconds	Subtracts the specified number of seconds (positive or negative) and returns the adjusted dateObject.
date.dateToGmt	Convert a date object from local to GMT.
milliseconds	Return current milliseconds since 12 a.m. local time.
secsFrom1970	Time in seconds since Jan 1, 1970 (GMT).
time	Current time.

» Path operations

pathAccess( separator )	Return a list of all user/group names that have entries in the access list for the current location.
pathAccessIds	Return a list of all user/group IDs that have entries in the access list for the current location.
pathAddBtree	Add a new btree to the current location (folder or discusion only).
pathAddEnclosure	Add an existing enclosure to a new/different location.
pathAddLinks (also setPathAddLinks)	The control for whether links can be added to a folder or not.
pathAppendTo	The location that additional items should be appended to for a move-multiple command.
pathBtreeKey	Show what the internal sort keys look like.
pathBtreeSpec	Return the sortSpec for a btree at the current location.
setPathDate	Sets last modified date.
pathDefaultContentType	Returns the default content-type for the current location.
pathDefaultRanking	Returns the default ranking for a location.
pathDelete	Delete the current location.
pathDocumentDataBinary	Returns the data from an attachment in binary form.
pathDocumentDataQuoted	Returns the data from an attachment in either quoted-printable or base64 form as appropriate.
pathDocumentSize	Returns the size of the attachment and header with its default formatting.
pathDocumentSizeBinary	Returns the size of the attachment file in binary without any header.
pathExists( path )	Returns 1 if path exists.
pathExport( filename )	Export the current location.
pathExportTail( filename )	Export the tail of a discussion.
pathFolderItemCount	Returns the total number of items in a folder.
pathFromMessageId (also setPathFromMessageId)	Open the specified message.
pathHasAccessList	Return 1 if the current location has an access list.
pathHasBtree	Return 1 if the current location has a btree with this name.
pathHierLocation	Return the location of the last path$var lookup.
pathHitsDec	Decrement hits counter for current location.
pathHitsInc	Increment hits counter for current location.
pathHostCount	Return the numer of host files in a folder.
pathHostDir	Get/set the host directory mapping and excluded file/directory names for a folder. (also setPathHostDir( dir ))
pathHostName	Returns the host pathname of a file
pathHostSynch	Resynch the current location to the host filesystem
pathHttpDownloadsLocal	A flag (0 or 1) that indicates whether Web-based attachments can be downloaded or not.
pathHttpUploadsLocal	A flag (0 or 1) that indicates whether Web-based attachments can be uploaded or not.
pathIconFilename (also setPathIconFilename)	If set, returns name of icon used by the built-in folder listing code.
pathImport	Import to the current location.
pathImportAsGuests	Same as pathImport, but users in the import who do not already exist are treated as guests (e.g. they are not added as new registered users)
pathIsCommon	Get common vs local status for host files and folders.
pathIsHost	True if the current location is a mirrored host file.
pathIsListable	Returns -1/0/1 for inherited/don't-list/list.
pathIsLocal	Get local vs common status for host files and folders.
pathItemsShowHidden	List folder items including normally hidden (e.g. not listable) items .
pathMarkIndividual( setting )	Mark individual messages for a user.
pathName (also setPathName)	Returns the name of a location.
pathNameFullUri	Deprecated.
pathNameUri	Return the non-query URL for the current location.
pathNetContentType	Returns the net content-type for the current location.
pathNetLocal	True if the current location has net local status for host files and folders.
pathNewDiscussionCount	Returns the number of new discussions in a folder.
pathNewIndividualCount	Returns the number of new individually marked messages nested under a location.
pathNodeCount	Returns the number of nodes in a folder.
pathPlugTemplate ( also setPathPlugTemplate)	If specified, will be checked/used if a macro is not in the normal pathTemplate envelope.
pathPostsDec	Decrement posts counter for current location.
pathPostsInc	Increment posts counter for current location.
pathRanking (also setPathRanking)	Returns ranking string for the current location.
pathRemoveBtree	Remove an existing btree from the current location.
pathRemoveEnclosure	Remove an existing enclosure from the current location.
pathSetLocal (v)	Set local vs common status for host files and folders.
pathShowsLinkToParent (also setPathShowsLinkToParent)	Tell whether the current location shows a link to parent items in threaded message format.
setPathShowsLinkToParentLocal	Same as pathShowsLinkToParent, except this is the exact setting of the current location.
pathShowsLinkToPrevious (also setPathShowsLinkToPrevious)	Tell whether the current location shows a link to the previous item in threaded message format.
pathShowsReplyTo (also setPathShowsReplyTo)	Tells whether the current location shows a "Reply" button.
pathShowsSummaryButtonLocal (also setPathShowsSummaryButton)	Controls whether the listing of a threaded discussion in a folder has a "summary icon" to show the discussion in outline format.
pathShowsThreaded (also setPathShowsThreaded)	Tell whether the current location shows discussions in threaded message format. Looks at both path settings and user preferences. (See also pathShowsThreadedLocal.)
pathShowsThreadedLocal	Same as pathShowsThreaded, except this is the exact setting of the current location.
pathShowsTitle (also setPathShowsTitle)	Tell whether the current location shows a title for each message.
pathSubscribeOnly (also setPathSubscribeOnly( flag ))	Check whether subscriptions are for a given folder only.
pathSubscriptionList( "med" ))	Returns a list of users with subscriptions at a location.
setPathSource	Set the source of a discussion or message to the specified string.
pathUrlHttpDomain (also setPathUrlHttpDomain( flag ))	Controls usage of http:// or https:// based on the site secure-forwarding setting.
pathVirtualArea (also setPathVirtualArea( flag ))	Get/set the flag that indicates that a location is a virtual area (e.g. that the backpath for nested items stops with this location)
pathVirtualTopLevel	Returns the location of the closest virtual folder to the current location (will be itself if the current location is a virtual folder).
path$wrap_defaultFontFace	Returns the local default font face.
path$wrap_defaultFontSize	Returns the local default font size.
path$wrap_Images	Returns the local images path setting; if set, supersedes siteImages
path$wrap_iconColumnWidth	Returns the width of the icon column in a folder.
path$wrap_Icons	Returns the local icons path setting; if set, supersedes siteIcons
path$wrap_Background	Returns the local background setting; if set, supersedes siteBackground, background, and pathBackground (deprecated)

» File system and logging

commonLog( text )	Write to the common.log file.
file	Get the contents of a file.
fileDelete	Delete a file.
fileError	Error message from last file command.
filename.fileExists	Return 1 if the filename exists.
filename.fileLength	Return the length of the file, or "" if no such file.
filename.fileRead	Read data and returns it as a string.
filename.fileRename	Rename the file to the newname.
filename.fileWrite	Write data into a file.
logFilename	Return the current logNNN name.
logUsageMTD	Add a MONTH-TO-DATE entry to the logUsage file.
noRollForward	Suppress roll-forward logging of a variable.
noSynch	Suppress master-slave synchronization of a variable.
rollForward	Enable roll-forward logging of a variable.
string.log	Writes a string into the log file, if the Web Crossing master log switch is on.
synch	Enable synchronization of a variable.

» Scripting and E-mail

cgi	Run a script program with CGI environment variables.
exec	Run a script program.
takeAction( request )	Process a Web Crossing URL for the current user
sysopAction( request )	Process a Web Crossing URL as the sysop
email	Send an e-mail message.
emailAddressTrace( forward )	Trace of evaluation of an email address for delivery.
userImportMailSpool	Import Unix mail spool data as email messages for a user
scriptError	Error from last exec or cgi, or none.
MxFlush	Flush the mail exchange (MX record) address cache.

» Persistent Variables

nosynch	Suppress synchronization of selected session variables across source/mirror clusters.
... session.name ...	Return the current value of a session variable, or the index of a saved container for use in subsequent scXxx calls.
set session.name value	Save a string or number into a session variable.
sessionZeroSeqNo	Causes the current session to always use a zero sequence number.

» Create/destroy commands

folderCreate	Set current location to new folder if created OK.
discussionCreate	Set current location to new discussion if created OK.
messageCreate	Set current location to new message if created OK.
linkCreate	Set current location to new link if created OK.
chatCreate	Set current location to new chat if created OK.
pathDestroy	Destroy the current location and Set the location to the original location.

» General directives

clearOutput	Clear the accumulated output generated by a macro.
clearOutputNoWrapper	Clear the accumulated output generated by a macro; will not automatically insert the wrapper banner/footer in the page as with clearOutput
"macroname".queue	Queue a macro for later execution.
queueClear( name )	Clear (e.g. don't run) any queued macros with the specified name
use macroname	Call a macro.
useParent macroname	Call a macro from the parent folder.
yield	Interrupt the current request.

» Variables listed alphabetically

A B C D E F G H I L M N O P R S T U V W X Y

» Variable	Usage
%% actionPath %%	Action path for login and registration. When a user logs in or registers, the original URL has to be remembered so that it can be used after the login/registration is complete. The actionPath is the original request, reformatted as <command>@<action>. For example, an actionPath to show a folder might look like 14@.eaf433. You need to use the actionPath whenever you build a URL to process a login or registration form. See the login template in the standard.tpl file for examples of this usage.
%% actionPathCommand %%	Command code from actionPath.
%% addResponseHttp ( "name:value" )%%	Add a keyword:value pair to the HTTP response being generated. The CRLF at the end of the keyword-value pair is added automatically by Web Crossing. Do not add the CRLF in this function, or the HTTP response will be invalid.
%% user.addUserToGroup ( group )%%	Add a user to a group. For example, user.addUserToGroup( "abc" ) will add the current user to the group abc.
%% allInputAsHidden ( exclude ) %%	Add all input name/value pairs as hidden fields. The "exclude" list is a blank/comma-delimited list of fields to exclude, where each fieldname is either exact or is a prefix*. For example, % % allInputAsHidden( "title showauthor name email header SpellCheck* SpellEdit* enclosure* fix_*" ) % % is used to propagate extra fields during a spelling check
%% alwaysCertificate %%	Generate an authentication (URL) certificate even if the user came in through a cookie. For example, when forwarding to a new location in Web Crossing, this is recommended for the certificate portion of the destination URL. This will guarantee that the user is logged in a recognized correctly even though the destination URL has a different host name from the currently installed cookie. (This is possible when running on multi-homed servers.)
%% author %%	The unique ID in hexadecimal of the current author. Used in author.function expressions.
%% authorAlias %%	The author's email alias. If present, the email alias is inserted in the "from" address of outgoing email, as "alias ".
%% authorBio %%	The formatted biographical information for the author of the current location.
%% authorEmail %%	The e-mail address of the author of the current location.
%% authorField field %%	Author's additional fields, where field is the field name. See the example section on adding your own fields.
%% if authorHasPicture %%	True if the author of the current location has a picture.
%% authorHomePage %%	URL of the home page for the author of the current location.
%% authorInfoUrl %%	URL to the personal information page for the author of the current location.
%% authorIsCgiUser %%	Returns 1 if the author is sysop/superhost or is a member of the cgiUser group
%% if authorIsSuperhost %%	Returns TRUE iff the user is in the superhost group, else false.
%% if authorIsSysop %%	True if the author of the current location is the sysop.
%% authorIsWctlUser %%	Returns 1 if the author is sysop/superhost or is a member of the wctlUsers group
%% authorLine2 %%	Secondary information for the author of the current location.
%% authorName %%	Name of the author of the current location.
%% authorPicture %%	URL to the picture of the author of the current location. If the author does not have a picture, this will be to the default picture specified by the sysop.
%% if authorShow %%	True if the author has requested that he/she be shown as part of the presentation of the current location.
%% authorUniqueID %%	Author's unique ID in hexadecimal.
%% authorUrls %%	Favorite URLs of the author of the current location, formatted.
%% authorUrlsRaw %%	Favorite URLs of the author of the current location, unformatted.
%% if awayHours > count %%	Check whether the current user last logged in more than count hours ago. For example, %% if awayHours > 4 %% Welcome back... %% endif %% will show the Welcome back... text when the user has been away for more than 4 hours.

B

<body %% background %%>

%% broadcast form.message %%

C

"%% urlBase %%14@%% certificate %%@/Books"

   %% "test.ci".custIndexRemoveRaw( "v3", "ABC" ) %%
   

   %% "test.ci".custIndexRemoveStemmed( "s1", "follows" ) %%
   

D

14@.aef456

14@%% certificate %%@.aef456

E

%% envir.query_string %%

%% set item "query_string" %%
%% envir( item ) %%

 %% set delim "%" & "%" %% %% set template "abc" & delim & "1+2" & delim
 & "def" %% %% template.evalTemplate %%

F

G

%% getValue "message" %%

%% getValue( "message" ) %%

H

%% if hasValue "message" %%

%% if hasValue
( "message" ) %%

I

%% if imgButton %%
 <input type=image
 name=" Create Folder " src="...">
%% else %%
 <input type=submit
 value=" Create Folder ">
%% endif %%

L

%% if lastLogin < 02/15/1996.00:00%%
 We've added a new service...
%% endif %%

"%% urlBase %%14@%% certificate %%@%% location %%"

Kind Meaning
------------ ----------------------------
normal initial login form
failure login failure for some reason
noSlots no free slots to login
noRegister auto-register not supported

%% if loginIs normal %%
%% else %%
 Login failure.
%% endif %%

M

 %% set new item.moderatedApprove %%
 %% setPath( path ) %%
 %% if location %%
 ... current location is the new item. If the item
 was already approved by someone else or there was
 some error on the approval/post, then the location is none.
 %% endif %%

N

O

P

<pre>
Location%% pad 30 %%
Count
%% setPath /Books %%
 %% pathTitle %%
 %% pad 30 %%
 %% pathDiscussionCount %%
%% setPath /New Ideas %%
 %% pathTitle %%
 %% pad 30 %%
 %% pathDiscussionCount %%

Location                     Count
Books                        23
New Ideas                    35

Kind
----------
login
password
greeting
loginToPost
register
registered

view
toolbar

toplevel
folder
addFolder
editFolder
previewFolder
editPreviewFolder
checkDeleteFolder
deletedFolder

discussion
addDiscussion
editDiscussion
previewDiscussion
editPreviewDiscussion
checkDeleteDiscussion
deletedDiscussion
discussionSummary
spellCheckAddDiscussion
spellCheckEditDiscussion

addMessage
messageError
editMessage
previewMessage
editPreviewMessage
checkDeleteMessage
deletedMessage
editHelp

addChat
editChat
deleteChat
chatRoom

addLink
editLink
deletedLink

editPreferences
editedPreferences

userInfo

subscribed
unsubscribed
noSubscriptions
noNewMesssages

accessList
groups

search
searchResults

sysop
userMacro
fileToServe
checkModerated
emailValidate
chat
error

/Books/History/18th Century

%% parentTitle %%

%% parentTitle 1 %%

%% parentTitle 2 %%

/Books/History/18th Century

%% parentUrl %%

%% parentUrl 1 %%

%% parentUrl 2 %%

 
  % % set d pathDocumentDataBinary % % 
  % % set ix d.lookup( crlf & crlf ) % %
  % % set d d.remove( 0, ix+4 ) % %