General Info | Template Language | WCTL Commands | WebX/Chat | WebX/Pro |
Release Notes | Standard Templates | URL Codes | WebX/Multi | FastCGI, NSAPI, ISAPI |
Visit the Web Crossing Conference to find a wealth of WebX info and a community of WebX experts on the Web!
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.
User Information
Conference and Chat Management
Current Web Crossing Context
WCTL Directives
» Current user values
user | User unique ID in hexadecimal. Used in user.function expressions. |
userCreate( name ) user.userDestroy | Create or destroy a user |
userLookup( name ) | Lookup a user by name |
username user.setUserName( name ) | Name |
userEmail user.setUserEmail( email ) | E-mail address |
user.setUserPassword( password ) user.userCheckPassword( password ) | Set or check a user password |
userHomePage user.setUserHomePage( url ) | Home page URL |
user2ndLine user.setUser2ndLine( text ) | Second line of information |
userBio user.setUserBio( text ) | User biographical information |
userUrlsRaw | User URL list, unformatted |
userUrls user.setUserUrls( text ) | User URL list, formatted |
userHasPicture | User has picture |
userPicture | URL to user's picture |
userField | Additional custom fields added to user's information record |
userCanAddLinks | True if the user can add links to the current location |
userEmailCode | The user's e-mail code after an automated e-mail message has been sent to them |
userUniqueId | User's unique ID |
userUseCookies user.setUserUseCookies( flag ) | True if the user has cookies enabled |
postCount | Number of posts tracked for this user |
posts | Return most recent posts by this user |
user.userIsMember( group ) user.addUserToGroup( group ) user.removeUserFromGroup( group ) | Check, add, or remove membership in a group |
» Kind of user
userIsUnknown | User has neither logged in nor posted as a guest |
userIsGuest | Guest user (e.g. the user has posted as a guest) |
userIsRegistered | Registered user |
userIsHost | Host user (for the current location) |
userIsSysop | Sysop user |
userIsHostOrSysop | Sysop |
userIsProvisional user.setUserIsProvisional( flag ) | True if the user is provisional or host user (for the current location) |
» User last login time
awayHours | Check hours since last login |
userAwayHours | Number of hours user has been away for a user ID |
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 |
» Current user configuration
userFolderSortBy user.setUserFolderSortBy( sortBy ) | The sort-sequence used to list folders for this user |
userShowPictures user.setUserShowPictures( flag ) | Include user pictures with messages |
userPictBorder user.setUserPictBorder( flag ) | Show picture borders for this user |
userHasRespNameSize | Check whether the user has specified a font size for the user name in message |
userHasRespInfoSize | Check whether the user has specified a font size for the secondary information in messages |
userHasRespBodySize user.setUserRespBodySize( size ) | Check whether the user has specified a font size for the body of a message |
userRespNameSize user.setUserRespNameSize( size ) | The font size for user names in a message (0 if not specified by the user) |
userRespInfoSize user.setUserRespInfoSize( size ) | The font size for secondary information in a message (0 if not specified by the user) |
userRespBodySize | The font size for message bodies (0 if not specified by the user) |
id.userLogoutTime user.setUserLogoutTime( time ) | User logout time in minutes |
userMaxData user.setUserMaxData( max ) | Maximum number of data bytes in a list of messages |
userMaxMessages user.setUserMaxMessages( max ) | Maximum number of messages in a list of messages |
userShowPrepared user.setUserShowPrepared( flag ) | Show the "prepared for..." line at the top of each page |
userSubscriptionList | User subscription list, as displayed in the user preferences page |
userCheckRemoteAddr | Check that user certificate is from the same IP address as originally |
user.userMarkCurrent | Mark a user's subscription list as current |
» User subscriptions
userIsSubscribed | User is subscribed to the current location |
userSubscriptions | List of locations and whether they are subscribed to or not |
userSubscribe | Subscribe a user to the current location |
userUnsubscribe | Cancel a user's subscription to the current location |
u.userClearSubscriptions | Clear a user's entire subscription list |
userHasSubscriptions | Check whether a user has any subscriptions |
u.userNewMessages | Returns a list of all new message locations (one per discussion) |
mostRecentNewMessage | Returns the date/time of the most recent new message from the last userNewMessages |
» Selecting users.
These commands let you select a subset of the user directory.
selectUsers | Return a list of users matching some selection criteria |
selectRandomUser | Return a randomly selected user |
» Current user access to current location
user.userCanView | User can view the current location |
userCanAddFolders | User can add folders to current location |
userCanAddDiscussions | User can add discussions 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 |
u.userIsParticipant | User is a participant at the current location |
u.userIsModerated | User is moderated at the current location |
u.userIsReadOnly | User is read-only at the current location |
u.userHasNoAccess | User has no access 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. |
setPathAuthor( userId ) | Change the author of record for the current location |
setAuthor | Set the current author to a particular user, and clear the current location |
authorIsSysop | Current location created by the sysop |
authorShow | Show author information for the current location |
authorName | Name of the author of the current location |
authorLine2 | Author's secondary information |
authorInfoUrl | URL to author's personal information page |
authorEmail | E-mail address of author |
authorHasPicture | Author has a picture |
authorPicture | URL to author's picture |
authorHomePage | URL to author's home page |
authorBio | Author's biographical information |
authorUrlsRaw | Author's favorite URLs, unformatted |
authorUrls | Author's favorite URLs, formatted |
authorField | Author's additional fields |
authorUniqueID | Author's unique ID in hexadecimal |
» 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.
location | Pathname of the current location |
pathItemNumber | Item number for a discussion or message |
setPath | Set current location |
setPathToParent | Move to the parent of the current location |
setPathToLink | Move to the location pointed to by the current link, without making the link part of the current pathname |
setPathFollowLink | Move to the location pointed to by the current link and make the link part of the current pathname |
pathIsNone | Not at a valid location |
pathIsTop | At top level |
pathIsFolder | Current location is a folder |
pathIsDiscussion | Current location is a discussion |
pathIsMessage | Current location is a message |
pathIsLink | Current location is a link |
pathIsChat | Current location is a chat room |
pathTitle | Title or name of current location |
pathTitleUrl | Same as pathTitle, but URL quoted (blanks are %20, etc.) |
pathUrl | URL to current location |
parentTitle | Title of parent at specified level |
parentTitleUrl | Same as parentTitle, but URL quoted (blanks as %20, etc.) |
parentUrl | URL to parent at specified level |
pathIcon | URL of icon for current location |
» Current location values
pathCreatedDate | Creation date |
pathModifiedDate | Last modified date |
pathBody | Body text, unformatted |
pathBodyFormatted | Body text, formatted |
pathMessage | Message text (if a message item), unformatted |
pathListItems | List items in a folder |
pathAddSubfolders | Allow subfolders to be added |
pathAddSubfoldersOnce | Allow subfolders, but they may only contain discussions |
pathNoSubfolders | No subfolders may be added |
pathAddDiscussions | Allow discussions to be added |
pathBackground | Background, unformatted |
pathBanner | Banner, unformatted |
pathFooter | Footer, unformatted |
pathIsDeleted | Has a message been deleted |
pathSortSeq | Sort sequence for folder items |
pathTemplate | Template for location (e.g. folder template) |
pathArchiveDays | For a folder, the number of days before a discussion expires |
pathArchiveType | Disposition of an elapsed discussion: move to a folder, delete, or purge |
pathArchiveFolder | If disposition for an elapsed discussion is to move to a folder, then this is the unique ID of the destination folder |
pathIsPermanent | Checks whether a discussion is permanent, e.g. never expires |
linkShowDescription | Current location is a link that shows its description |
linkDescription | Descriptive text for a link |
pathHosts | List of hosts for the current location |
pathModeratedUsers | List of moderated users for the current location |
pathParticipants | List of participants for the current location |
pathReadOnlyUsers | List of read-only users for the current location |
» Current location nested contents
pathHasItems | Current location has nested items |
pathHasFolders | Current location has nested folders |
pathHasOneFolder | Current location has exactly one nested folder |
pathFolderCount | Nested folder count |
pathHasDiscussions | Current location has nested discussions |
pathHasOneDiscussion | Current location has exactly one nested discussion |
pathDiscussionCount | Nested discussion count |
newDiscuss | Count of new discussions in current location |
pathHasMessages | Current location has nested messages |
pathHasOneMessage | Current location has exactly one message |
pathMessageCount | Count of nested messages |
pathHasNewMessages | Current location has new messages for the current user |
pathHasOneNewMessage | Current location has exactly one new message for the current user |
pathNewMessageCount | Count of new messages for the current user |
» Site information.
urlBase | /...webx? portion of a Web Crossing URL |
usersCount | Number of registered users |
siteTitle | Site title |
sysopEmail | Sysop e-mail address |
siteLicensee | Site licensee name |
siteUrl | URL to top-level site page |
siteImages | Images string from sysop general settings |
siteHelp | Help string from sysop general settings |
version | Web Crossing version string |
platform | Site platform |
servePictures | Site is serving user pictures everywhere |
serveInfoPictures | Site is serving user pictures in the personal information page only |
siteCanAutoRegister | Users may auto-register |
siteCanSearchTop | Top-level search button is enabled |
siteOneSearch | Search the Net via Forum One. |
siteCanSearch | Search button is enabled in nested folders and discussions |
siteEmailValidate | E-mail validation is enabled for this site |
useChatService | Chat services are enabled for this site |
siteUseCookies | Site is configured to use cookies |
siteIsSecure | Site is running through a secure server, so use https:// instead of http:// in forwarded URLs |
siteHost | Domain name of the Web server used to access Web Crossing |
waitingForSynch | Slave server is waiting for synch with master to complete |
pictSizeSite | WIDTH and HEIGHT for site icon |
pictSizeDivider | WIDTH and HEIGHT for pathname divider icon |
pictSizeFolder | WIDTH and HEIGHT for folder icon |
pictSizeConversation | WIDTH and HEIGHT for conversation icon |
pictSizeLink | WIDTH and HEIGHT for inline link icon |
pictSizeButton | WIDTH and HEIGHT for button icon |
pictSizeInlineButton | WIDTH and HEIGHT for inline button icon |
pictSizeOutline | WIDTH and HEIGHT for outline button icon |
siteHasPasswordForm | TRUE iff site has a 2-stage login using a separate password form |
siteAllowsHttpBasic | TRUE iff site is using HTTP basic authentication |
userIsHttpBasic | TRUE iff the current user was authenticated through HTTP Basic |
siteUseEmailScript | TRUE iff site uses a script to get a user's e-mail address |
siteToolbarAcross | Number of buttons across for old-style toolbar |
siteFolderShowSysop | TRUE iff the sysop is show in folder headings when this user is the author |
siteFolderShowAuthor | TRUE iff the author of a folder is shown in the folder's heading |
siteDiscussionShowSysop | TRUE iff the syop |
siteDiscussionShowAuthor | TRUE iff the author of a discussion is shown in the discussion's heading |
copyright | The copyright string for the program |
programDesc | A short string that describes the program |
» Enclosures
pathEnclosures | Returns list of enclosures. |
pathIsDocument | TRUE iff the current location is a document |
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. |
siteHttpUploads | TRUE iff the site supports Web-based uploads |
siteHttpDownloads | TRUE iff the site supports Web-based downloads |
pathHttpUploads | TRUE iff the current location supports Web-based uploads |
pathHttpDownloads | TRUE iff the current location supports Web-based downloads |
pathInheritsEnclosures | TRUE iff the current location inherits its enclosure settings from its parent |
» 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 |
» Chat rooms.
pathIsChat | Current location is a chat room or table |
pathIsAnonymous | Current location is a chat room that allows anonymous users |
pathHasTables | Current location is part of a chat room with multiple tables |
pathMaxUsers | Maximum users per table for a chat table |
pathPlayFile | Playback file for a chat table |
pathPlayMillisecs | Playback total time in milliseconds |
pathRecordFile | Recording file for a chat table |
broadcast | Broadcast to all tables in a chat room |
enterChat | Enter a chat room, text-chat only |
enterChatTable | Enter a specific overflow table, text-chat only |
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 |
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 |
roomPort | Port to call Fanout Server |
» Authentication certificate
certificate | Current user's authentication certificate |
alwaysCertificate | Generate an authentication (URL) certificate even if the user came in through a cookie. |
certificateIs | Check current certificate's tag |
certificateLogout | Immediately expire a user's authentication certificate |
» Browser information.
imgButton | Client browser supports image buttons |
userAgent | Client browser "user agent" string |
browserCanUseLabels | Client browser can use JavaScript labels |
» Error Handling
errorTitle | Suggested title for error page |
error | Error message for error page |
» Forms processing
getValue | Get a field from a post |
hasValue | Check for a field in a post |
» CGI environment variables and HTTP response values
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 |
addResponseHttp | Add a keyword=value pair to the HTTP response being generated |
» Current page type
pageIs | Kind of page being prepared |
loginIs | Kind of login 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.
itemDate | Creation date |
itemShowPictures | Show author picture in this item |
itemShowPictBorder | Show border around picture in this item |
itemShowTimeDate | Show time/date |
itemNameFontSize | Font size for author name |
itemInfoFontSize | Font size for secondary information |
itemBodyFontSize | Font size for item body |
itemShowOperations | Show edit and/or delete buttons |
itemCanEdit | Item can be edited by current user |
itemCanDelete | Item can be deleted by current user |
itemNumber | Item number |
itemCount | Total number of items in this list |
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.
pathStandardHeading | Show standard heading for top-level, folder, or discussion |
pathItems | Show items |
pathItemsAll | Show all items |
pathItemsInContext | Show items in context |
pathItemsPrevious | Show items previous |
pathItemsAreAtEnd | Items are at the end of the list |
responsePost | Standard form to post a message |
unknownUserHelp | Standard help text for an unknown user |
folderListBefore | Show HTML before a list of items in a folder |
folderListItem | Show HTML for an item in a folder |
folderListAfter | Show HTML after a list of items in a folder |
folderListEmpty | Show HTML for an empty folder list |
» User interface directives.
loginNews | Login news template, formatted |
passwordNews | Password news template, formatted |
greetingNews | Greeting news template, formatted |
registerHeading | Registration heading, formatted |
registeredHeading | Registered heading, formatted |
registerError | Registration error message |
backPath | Default parent location with links to parent folders |
backPathThis | Default current location with links to parent folders (e.g. includes the current location in the list of folders) |
toolbar | Standard toolbar |
toolbarBefore | HTML to insert before toolbar |
toolbarBetween | HTML to insert between toolbar rows |
toolbarAfter | HTML to insert after toolbar |
editHelp | Edit help text, formatted |
message | Current message item in standard format |
banner | Banner for current location, formatted |
footer | Footer for current location, formatted |
background | Current background |
showPreparedFor | Show Prepared for... line for current user |
preparedFor | Default Prepared for... heading or none |
pad | Insert padding in <pre> sections |
» 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 |
msgListPrevious | %% location %% of previous item or none |
msgListCountPrevious | Count of preceding items |
msgListFollowing | %% location %% of following item or none |
msgListCountFollowing | Count of following items |
msgListEmpty | Message list is empty |
msgListBetween | Eval to code "between" messages |
» Login and registration actions
actionPath | Action path for login and registration |
doActionPath | Action path for login and registration, with embedded certificate |
actionPathCommand | Command code in action path |
» Editing information.
(For registration,
user preferences, new folder, new discussion, etc.)
editName | User name |
editPassword | Password |
editEmail | E-mail address |
editTitle | Title |
editHeading | Heading |
editMessage | Message |
editBanner | Banner text, unformatted |
editFooter | Footer text, unformatted |
editBackground | Background text, unformatted |
editTemplate | Template |
moderatedMessage | Display moderated message in default format |
moderatedDiscussion | Display moderated discussion in default format |
moderatedFolder | Display moderated folder in default format |
editFolderIcon | Type of icon for a link |
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
prefsRenameMessage | Error message for rename or none |
prefsNewName | New user name from preferences form |
prefsEmailError | Error message for e-mail change or none |
prefsNewEmail | New e-mail address |
prefsSubscrUpdated | Message for subscription list update |
prefsSysopCertificate | Sysop authorization certificate when the sysop is changing a user's preferences |
prefsPasswordError | Password change error to report |
prefsPasswordMessage | Message for password change (an error only if prefsPasswordError is set) |
» Search commands
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 iff current location inherits its threading settings from its parent |
pathShowByUserPreferences | TRUE iff threading display is from user preferences |
pathNetTreeView | TRUE iff net effect of all settings is to show as threaded messages |
pathNetReplyTo | TRUE iff net effect of all settings is to show a Reply button with each message |
pathNetSummaryButton | TRUE iff net effect of all settings is to show an Outline button next to discussions in their folder listing |
pathNetMessageTitle | TRUE iff net effect of all settings is to request a title for all messages |
u.userThreadingBySite | TRUE iff user uses site settings for threading |
siteUserDefaultThreading | TRUE iff site default is for a user to view as threaded messages |
u.userThreading | TRUE if user preference is to view as threaded messages |
u.userReplyTo | TRUE iff user preference is to show a Reply button with each message |
siteUserDefaultReplyTo | TRUE iff site default is for a user to see a Reply button with each message |
u.userSummaryButton | TRUE iff user preference is to see an Outline button next to discussions in their folder listing |
siteUserDefaultSummaryButton | TRUE iff site default is for a user to see a Outline button next to discussions in their folder listing |
» Newsgroups
pathNewsgroup | Newsgroup for current location |
siteHasNews | TRUE iff news service is enabled for the site |
editNewsgroup | Name of newsgroup when editing an Add Folder or Edit Folder form. |
» E-mail list mirroring
siteHasEmailServices | TRUE iff site has e-mail services (e.g. DNS server address is available) |
pathEmailMirror | Mailbox from which to read e-mail list messages |
pathEmailPW | Password for pathEmailMirror mailbox |
pathEmailStripSig | Signature to strip from tail of incoming messages |
pathEmailPostThru | TRUE if messages posted to Web Crossing are forwarded to the e-mail list |
pathEmailReply | Address to which to send messages posted directly to Web Crossing |
pathEmailReplyTo | Reply-to value for messages forwarded to the list, or blank to use the user's e-mail address |
pathEmailFrom | From value for messages forwarded to the list, or blank to use the user's e-mail address |
editEmailMirror | Setting for pathEmailMirror during Add Folder or Edit Folder |
editEmailPW | Setting for pathEmailPW during Add Folder or Edit Folder |
editEmailStripSig | Setting for pathEmailStripSig during Add Folder or Edit Folder |
editEmailPostThru | Setting for pathEmailPostThru 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 |
editEmailFrom | Setting for pathEmailFrom during Add Folder or Edit Folder |
» String Operations
String manipulation | |
count | Number of characters in a string |
split | Split the first token off a string |
tail | Split the last token off a string |
lookup | Lookup a pattern in a string |
substring | Get a substring of a string |
getchar | Get a character from a string |
putchar | Put a character into a string |
trim | Remove leading and trailing white space |
toLower | Convert to lower case |
toUpper | Convert to upper case |
eval | Evaluate a string as a WCTL expression |
evalTemplate | Evaluate a string as a WCTL template |
isObjectionable | Check for objectionable words |
markObjectionable | Mark objectionable words |
crlf | A carriage-return/line-feed string |
cr | A carriage-return string |
lf | A line-feed string |
randomString | A random 8-character string |
User names | |
getFirstName | First name from a name string |
getLastName | Last name from a name string |
nameToFirstLast | Convert name to first-last format |
nameToLastFirst | Convert name to last-comma-first format |
HTML | |
toSGML | Convert to SGML quoted format |
fromSGML | Convert from SGML quotes to original string |
htmlClosure | Fixup for HTML tag closure and remove illegal tags |
quickEdit | Process a string with the Web Crossing quick editor |
selfRef | Insert correct certificate in all local URLs |
htmlStripTags | Strip all HTML tags from a string |
URLs | |
toURL | Convert to URL quoted format |
fromURL | Convert from URL quotes to original string |
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( format ) | Convert a numeric string to a specified numeric format. Number formats include currency and scientific notation. |
MIME Formats | |
toBase64 | Convert a string to base-64 format |
fromBase64 | Convert a string from base-64 format |
toQuotedPrintable | Convert a string to quoted-printable format |
fromQuotedPrintable | Convert a string from quoted-printable format |
canUseQuotedPrintable | Check whether a string is suitable for quoted-printable formatting (otherwise use base-64) |
» Date and time operations
date | Current date |
time | Current time |
secsFrom1970 | Time in seconds since Jan 1, 1970 (GMT) |
dateGMT | Current date/time in GMT |
date.dateToGmt | Convert a date object from local to GMT |
date.dateFromGmt> | Convert a date object from GMT to local time |
dateObject | Time/date format to get a date object (Date objects are strings with the format "Y4-M2-D2-H4.I2.S2".) |
dateObj | Same as dateObject |
dateString.dateFormat( format ) | Formats a date per the format string |
dateString.dateAddSeconds( seconds ) | Adds the specified number of seconds (positive or negative) and returns the adjusted dateObject. |
dateString.dateSubtractSeconds( seconds ) | Subtracts the specified number of seconds (positive or negative) and returns the adjusted dateObject. |
dateString.dateDeltaSeconds( date2 ) | Returns the number of seconds for (date2 - dateString). |
dateString.dateLessThan( date2 ) | Returns TRUE iff dateString < date2 |
dateString.dateEqual( date2 ) | Returns TRUE iff dateString == date2 |
dateString.dateGreaterThan( date2 ) | Returns TRUE iff dateString > date2 |
» Path Operations
pathDelete | Delete the current location |
pathExport | Export the current location |
pathImport | Import to the current location |
pathHitsDec | Decrement hits counter for current location |
pathHitsInc | Increment hits counter for current location |
pathPostsDec | Decrement posts counter for current location |
pathPostsInc | Increment posts counter for current location |
» File system and logging
file | Get the contents of a file |
fileError | Error message from last file command |
fileDelete | Delete a file |
string.log | Writes a string into the log file, if the Web Crossing master log switch is on |
» Scripting and E-mail
exec | Run a script program |
cgi | Run a script program with CGI environment variables |
scriptError | Error from last exec or cgi, or none |
Send an e-mail message |
» Variable | Usage | ||||||
---|---|---|---|---|---|---|---|
%% if otherCanAddDiscussions %% |
Check if other registered users can add discussions to the current location.
%% if otherCanAddFolders %%
|
Check if other registered users can add folders to the current location.
| %% if otherCanAddLinks %%
|
Check if other registered users can add links to the current location.
| %% if otherCanAddMessages %%
|
Check if other registered users can add messages to the current location.
| |
» Variable | Usage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
%% pad column %% |
Insert padding in <pre> sections.
This variable assumes that text is being laid out inside a <pre> section,
so that blanks can be used to align columns.
It inserts enough blanks so that the next character will be output at the
specified column. Columns are numbered from 1 at the leftmost edge.
For example,
<pre>> Location%% pad 30 %% Count %% setPath /Books %% %% pathTitle %% %% pad 30 %% %% pathDiscussionCount %% %% setPath /New Ideas %% %% pathTitle %% %% pad 30 %% %% pathDiscussionCount %%might display as Location Count Books 23 New Ideas 35 %% if pageIs Kind %%
|
Kind of page being prepared.
| Kind ---------- login password greeting loginToPost register registered view toolbar toplevel folder addFolder editFolder previewFolder editPreviewFolder checkDeleteFolder deletedFolder discussion addDiscussion editDiscussion previewDiscussion editPreviewDiscussion checkDeleteDiscussion deletedDiscussion 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 %% parentTitle %% | %% parentTitle level %%
Title of parent, or title of parent from the top down. For example, if the current location is
| /Books/History/18th Centurythen %% parentTitle %%would be History (e.g the immediate parent); %% parentTitle 1 %%would be Books (e.g the 1st-level parent); %% parentTitle 2 %%would be History (e.g the 2nd-level parent). %% parentTitleUrl %% | %% parentTitleUrl level %%
Same as parentTitle, but the title is URL-quoted (e.g. blanks are %20, etc.)
| %% parentUrl %% | %% parentUrl level %%
URL to parent at specified level. For example, if the current location is
| /Books/History/18th Centurythen %% parentUrl %%would be something like http://yoursite/webx?14@@.efa453, a URL to /Books/History (e.g the immediate parent); %% parentUrl 1 %%would be a URL to /Books (e.g the 1st-level parent); %% parentUrl 2 %%would be a URL to /Books/History (e.g the 2nd-level parent). %% passwordNews %%
|
Password news template, formatted
| %% pathSearch( spec ) %%
|
Returns a list of locations matching a search specification. The whole site is searched.
The spec is a blank-delimited list of keyword=value pairs.
Values are URL quoted so that they do not contain any blanks.
| The specification can include the following:
For example, %% set items pathSearch( "keywords=testing%20software" ) %%will return up to 20 messages, dicussions, or folders containing both the words testing and software. %% pathSelect( "spec" ) %%
|
Select a list of items in a folder or discussion.
spec is an optional expression, and defaults to all items.
It is a blank-delimited list of selection criteria:
|
%% pathShowByUserPreferences %%
|
TRUE iff threading display is from user preferences
| %% list.pathSort( "spec" ) %%
|
Sort a list of location items. list is a blank-delimited list of unique pathname IDs,
as returned from pathSelect.
spec is a blank-delimited list of sort keys, from most to least significant:
| * path.userField/t will treat as time/date info, * path.userField/n will treat as numeric info. Time/date formats may not contain blank characters. The sort is normally in ascending sequence (alphabetical or oldest to newest). You can add /d to any item to sort that key in reverse sequence. For example, Spec == "title date/d" will sort by title. If two items have the same title, then they are sorted with the most-recently-modified item first. You can use the /n, /t, and /d directives together. For example, "path.priority/n" will sort by a user-defined numeric priority field, from smallest to largest values. "path.priority/n/d" will sort by the same field, but from largest to smallest. You can specify a date format with path.userFields, such as path.userField/t=Y4M2D2 Descending sequence with a time/date format is specified after the format, as in date=Y4M2D2/d, or path.userField/t=Y4M2D2/d. %% if pathAddDiscussions %%
|
Users may add discussions to the current location (with appropriate access)
| %% if pathAddSubfolders %%
|
Users may add folders to the current location (with appropriate access)
| %% if pathAddSubfoldersOnce %%
|
Users may add folders to the current location (with appropriate access),
but these folders may only contain discussions
| %% pathArchiveDays %%
|
For a folder, the number of days before a discussion expires
| %% if pathArchiveType == "type" %%
|
"type" may be "folder", "delete", or "purge".
Disposition of an elapsed discussion: move to a folder, delete, or purge
| %% pathArchiveFolder %%
|
If disposition for an elapsed discussion is to move to a folder, then this is the unique ID of the destination folder
| %% pathBackground %%
|
Background, unformatted, for the current location
| %% pathBanner %%
|
Banner, unformatted, for the current location
| %% pathBody %%
|
Body text, unformatted, for the current location
| %% pathBodyFormatted %%
|
Body text, formatted, for the current location
| %% pathCreatedDate( "format" ) %%
|
Creation date for the current location. A format is optional.
| %% pathDelete %%
|
Delete the current location without saving it to the deleted file.
| %% pathDiscussionCount %%
|
Nested discussion count if the current location is a folder, otherwise empty
| %% pathDocumentIsImage %%
|
Returns TRUE iff the current location is a document enclosure that
is an image file.
| %% pathDocumentIsText %%
|
Returns TRUE iff the current location is a document enclosure that
is a text file.
| %% pathDocumentName %%
|
If the current location is an enclosure document, then
this returns the original name of the enclosure. If
the item is not an enclosure, or if no name is available,
then returns the empty string.
| %% pathEmailFrom %%
|
From value for messages forwarded to the list, or blank
to use the user's e-mail address
| %% pathEmailMirror %%
|
Mailbox from which to read e-mail list messages
| %% pathEmailPostThru %%
|
TRUE if messages posted to Web Crossing are forwarded to the e-mail list
| %% pathEmailPW %%
|
Password for pathEmailMirror mailbox
| %% pathEmailReply %%
|
Address to which to send messages posted directly to Web Crossing
| %% pathEmailReplyTo %%
|
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
| %% pathEnclosures %%
|
Returns a blank-delimited list of enclosures at the current location.
Each item in the list can be opened by using %% setPath( item ) %%.
| %% pathExport( filename ) %%
|
Export the current location to filename (which can be any expression).
Will append to an existing file.
| %% pathFolderCount %%
|
Nested folder count if the current location is a folder, otherwise empty
| %% pathFooter %%
|
Footer, unformatted, for the current location
| %% if pathHasDiscussions %%
|
Current location has nested discussions
| %% if pathHasFolders %%
|
Current location has nested folders
| %% if pathHasItems %%
|
Current location has nested items
| %% if pathHasMessages %%
|
Current location has nested messages
| %% if pathHasNewMessages %%
|
Current location has new messages for the current user
| %% if pathHasOneDiscussion %%
|
Current location has exactly one nested discussion
| %% if pathHasOneFolder %%
|
Current location has exactly one nested folder
| %% if pathHasOneMessage %%
|
Current location has exactly one message
| %% if pathHasOneNewMessage %%
|
Current location has exactly one new message for the current user
| %% if pathHasTables %%
|
True if the current location is a chat room/table in a room with multiple tables.
| %% pathHitsDec %%
|
Decrement the hits counter for the current location.
| %% pathHitsInc %%
|
Increment the hits counter for the current location.
| %% pathHosts delim %%
|
Evaluates to a list of host user names for the current location, separated by delim.
For example,
|
%% if pathHttpDownloads %%
|
Check to see if the current location supports enclosure downloads by regular users.
| %% if pathHttpUploads %%
|
Check to see if the current location supports enclosure uploads by regular users.
| %% pathIcon %%
|
URL of icon for current location
| %% pathImport( filename ) %%
|
Import from filename into the current location (a folder).
filename may be any expression.
| %% pathInheritsByUserPreferences %%
|
TRUE iff current location inherits its threading settings from its parent
| %% pathInheritsEnclosures %%
|
TRUE iff current location inherits its enclosure settings from its parent
| %% if pathIsAnonymous %%
|
True if the current location is a chat room/table that allows anonymous users
| %% if pathIsChat %%
|
True if the current location is a chat room/table
| %% if pathIsDeleted %%
|
Check whether a message has been deleted
| %% if pathIsDiscussion %%
|
Current location is a discussion
| %% pathIsDocument %%
|
Returns TRUE iff the current location is an enclosure document.
| %% if pathIsFolder %%
|
Current location is a folder
| %% if pathIsLink %%
|
True if the current location is a link
| %% if pathIsMessage %%
|
Current location is a message
| %% if pathIsNone %%
|
Not at a valid location
| %% if pathIsPermanent %%
|
Checks whether a discussion is permanent, e.g. never expires
| %% if pathIsTop %%
|
At top level
| %% pathItemNumber %%
|
The item number for a discussion or message.
This number is assigned when the item is first created and never changes.
You can use this number in a pathname URL to the item.
| %% pathItems %%
|
Displays items in a folder or discussion in standard format.
The display stops when the user's limits on message count or total size are reached.
| %% pathItemsAll %%
|
Displays all items in a folder or discussion in standard format.
Ignores user's limits on message count and total size.
| %% pathItemsAreAtEnd %%
|
True if the list of messages goes through the last message.
| %% pathItemsInContext %%
|
Displays items in a folder or discussion in standard format, and
includes one or more previous messages to show context.
The display stops when the user's limits on message count or total size are reached.
| %% pathItemsPrevious %%
|
Displays items in a folder or discussion in standard format, showing previous items.
The display stops when the user's limits on message count or total size are reached.
| %% pathListItems %%
|
Folder setting to list items in that folder
| %% pathMainRoom %%
|
Common room for a chat table
| %% pathMaxUsers %%
|
Maximum users for a chat table. When this number is reached, an overflow table
will be started automatically.
| %% pathMessage %%
|
Message text (if a message item), unformatted
| %% pathMessageCount %%
|
Count of nested messages for current location
| %% pathModeratedUsers delim %%
|
Evaluates to a list of moderated user names for the current location, separated by delim.
For example,
|
%% pathModifiedDate( "format" ) %%
|
Last modified date for current location. A format is optional.
| %% pathNetMessageTitle %%
|
TRUE iff net effect of all settings is to request a title for all messages
| %% pathNetReplyTo %%
|
TRUE iff net effect of all settings is to show a Reply button with each message
| %% pathNetSummaryButton %%
|
TRUE iff net effect of all settings is to show an Outline button
next to discussions in their folder listing
| %% pathNetTreeView %%
|
TRUE iff net effect of all settings is to show as threaded messages
| |