 |
Help Document |
|
 |
|
Brief description of templates
Templates are HTML documents that render FirstClass information onto the web.
Following is a list of templates, by number, and a brief description of what each one does:
Conferences
-1 main conference template (for all conferences and folders)
non-frames mode: these templates are output after the -1 (in the same file), unless the -1 contains the <X-FC-FRAMESET> tag
-10 conference listing master header
-11 conference folder listing header
-12 conference folder listing row separator (output every four folders)
-13 conference folder listing item (for example, outputs one for every folder)
-14 conference folder listing footer
-15 separator between folders and messages
-16 conference message listing header
-17 conference message listing item (for example, outputs one for every message)
-18 conference message listing footer
-2 conference listing master footer
Frames mode, conference folder list
These templates can be accessed from the -1 template with the URL <X-FC-OBJURL>?folders
-200 conference folder list header
-201 conference folder list item (one for each folder)
-202 conference folder list footer
Frames mode, conference message list
These templates can be access from the -1 template with the URL <X-FC-OBJURL>?items
-210 conference message list header
-211 conference message list item (one for each message)
-212 conference message list footer
Directory (accessed from/Login/Directory or /Login/Directory/Lookup?charset=<charset code>&srch=<search string>
-100 directory form (always output)
-101 directory listing header (output after the -100 when a directory search has been initiated (the second URL))
-102 directory listing item (output for each element of a directory listing)
-103 directory listing footer (output after the -101 and all the -102s in a directory listing)
History (accessed from a message form with the URL <X-FC-OBJURL>^H)
-110 history listing header
-111 history listing item
-112 history listing footer
Search (accessed from URL/search, to search everything at or below URL)
8000 search form
-300 search results header
-301 search results item
-302 search results folder (output for every folder output)
-303 search results folder
Who's online (accessed from /Login/Who's Online)
-400 who's online header
-401 who's online item
-402 who's online footer
Calendar
158 calendar monthly view
159 calendar weekly view
160 calendar daily view
Events and Tasks
161 calendar event (read-only)
Send.161 calendar event (edit)
163 calendar task (read-only)
Send.163 calendar task (edit)
Messages
Send & Send.141: standard message forms
Forms
All forms have two templates: a read version - whose file name is the formid and a send/edit version whose name is either Send.formid or Edit.formid.
Whether the editable version is send.formid or edit.formid depends on the form type (basically, if you can send it to someone, it is a send form, if not it is an edit form).
For example, phone call, which is a send (message) form with a formid 128 has two templates: Send.128 and 128.
For example, address book entry, which is not a send form, with a formid of 105, also has two templates: Edit.105 and 105.
Conference listings on the web
Container listings include container items and leaf objects, such as conferences, folders, messages, calendars and others. Container objects are rendered on the web through templates that contain specific <X-FC-tags> that call the information you require. Container contents are divided in two separate listings :
Container items
Container items can be any item that houses other containers and objects. For example, folders, conferences, and calendars (in list view). They can also be items that cannot be opened normally. For example, chats and stationary. Basically, anything that appears in the upper pane in a horizontal split view in the client.
Leaf objects
Leaf objects can be any item that is not a container. For example, message, documents, bookmarks, events, tasks, and uploaded files. Basically anything that appears in the lower pane in a horizontal split view in the client.
Listing objects
There are two modes for listing objects:
Complete
This lists both container and leaf objects all in the same file; header followed by listing followed by leaf objects. This is the default setting. Uses -1, -2, and, -10 through -18 templates.
Separated
This lists each component on separate pages. The three components can be accessed as follows:
1 List headers (consists only of the -1 template) using the <X-FC-CONFERENCE-HEADER-ONLY> tag, which suppresses the full listing (default).
2 List containers using ? folders URL param.
3 List leaves using ? items.
Templates used in separated listing of objects
• Uses -1 template for the conference header. This template should contain the <X-FC-CONFERENCE-HEADER-ONLY> tag.
• Uses the -200, -201, and -202 templates for the container listing. Access from the -1 using <X-FC-OBJURL>? folders=1.
• Uses the -210, -211, -212 templates for the leaf object listing. Access from the -1 using <X-FC-OBJURL>? items=1.
• Paging
Leaf objects and containers output
The leaf objects and containers output in a listing can be limited to a specific range (typically used to introduce 'paging' to reduce download time). The leaf object and container listings each maintain separate ranges, which can be controlled (at the URL param level) by using nItems, nFolders, FirstItem, FirstFolder, LastItem and LastFolder, or (inside the templates) using the various CONFERENCE-LIST and CONFERENCE-FOLDER-LIST X-FC tags.
You can only use up to two of the CONFERENCE-LIST tags at a time or two of the CONFERENCE-FOLDER-LIST tags.
Date formats
Use date formats to modify the date display for the DATE_LOCAL, DATE_GMT, AND LAST_MODIFIED tags. You can use the following arguments on the timefmt variable:
This code Produces this
%a abbreviated weekday name
%A full weekday name
%b abbreviated month name
%B full month name
%c fixed format date and time (Mon, 22 Feb, 99 3:15pm)
For the long date and time, use %#c. (Monday, 22 February, 1999 12:43:54 AM).
%d day of the month as a decimal number (01-31)
To remove any leading zeros, use %#d.
%H hour in 24-hour format (00-23)
To remove any leading zeros, use %#H.
%l hour in 12-hour format (01-12)
To remove any leading zeros, use %#l.
%j day of the year as decimal number (001-366)
To remove any leading zeros, use %#j.
%m month as decimal number (01-12)
To remove any leading zeros, use %#m.
%M minute as decimal number (00-59)
To remove any leading zeros, use %#M.
%N seconds since Jan 1, 1970
%p locale's a.m./p.m. indicator for a 12-hour clock
%S second as decimal number (00-59)
To remove any leading zeros, use %#S.
%U week of the year as decimal number (00-51, Sunday = first day of the week)
To remove any leading zeros, use %#U.
%w weekday as decimal number (0-6, Sunday = 0)
To remove any leading zeros, use %#w.
%W week of the year as decimal number (00-51, Monday = first day of the week)
To remove any leading zeros, use %#W.
%x fixed format date representation (22 Feb, 99)
For the long date, use %#x (22 February, 1999).
%X time representation for locale
%y year without century, as decimal number (00-99)
%Y year with century, as decimal number
%z time zone name or abbreviation
%Z numeric version of timezone (if available) in the form +/-HHMM (-0400, where 0000 is GMT)
%% percent sign
Field data formats
Use the field data format to specify how Internet Services should render the data in a given field. The supported formats are:
NUMBER[,format]
Outputs field data in numeric format. The optional format argument formats the data for the specified radix. If no format is specified, the signed decimal format is used by default:
• %d Unsigned decimal
• %u Signed decimal
• %x Unsigned hexadecimal (uses lowercase letters a-f)
• %X Unsigned hexadecimal (uses uppercase letters A-F)
LITERALSTRING
Outputs the field data as a string with no escaping
STRING
Outputs field data as a string suitable escaped for most markup languages. For example, all <s are replaced y <," are replaced by "e;.
MENUSTRING
Outputs the field data as a string with all ampersands (&) removed. This is useful when removing the menu hot key from LANG string resources.
MULTILINESTRING
Outputs the field data with all line feed and carriage returns removed.
RGB
Outputs the field data as a hexadecimal number with a "#" prefix. Suitable for specifying HTML colors.
DATA[,"format"]
Outputs the field data as a date, according to the specified format (for information on formatting see <<>>**JUMP). If no format is specified, the server's default date format is used.
LIST (semi-colon separated list)
Compares numeric field data with a semicolon separated list of strings, and outputs the appropriate one. the semi-colon separated list should be in the form of value1=string1,value2=string2,value3=string3 and so on. If no value is specified for a specific entry, it is assumed to be one greater than the previous entry. If no value is specified for the first entry, it is assumed to be zero. IS will also accept lists with the values and strings reversed, providing the first string is not a number , and the format remains consistent throughout the list.
For example:
0 zero;one;two;5=5 and zero=0;one;two;five=5 are both valid lists, but 0=0;one;two;5=5 and 0=zero;one;two;five=5 are not.
IS will not accept any white space in the list. If a given string has white spaces, it much be enclosed in quotes. Quotes must also be used if the string contains any = or ; characters.
For example:
1=string1;2="string 2" is a valid list, but 1 = string1 and 1=string 1 and 1-string1; 2=string2 are not.
If IS cannot match the value of the field to any entry in the list, the field is output in numeric format.
IS script expressions
An IS script expression is basically any series of operations resulting in a single value. An IS script expression can contain any number of fixed values (strings, numbers, and others), IS script variables, IS script functions, X-FC tags and operators. Order of operations is as specified by standard mathematical convention. IS script does not support floating point operations.
Operators supported by IS script
+ standard addition
- standard subtraction (or unary negation, depending on context)
* standard multiplication
/standard (integer) division
% integer remainder (modulus)
() used to alter order of operations
++ used only with IS script variables; pre/post increment
-- used only with IS script variables; pre/post decrement
= or == equality operator (since IS script does not have an assignment operator, instead using the SET command, a single = sign is accepted as the equality operator as well as the C standard double == operator)
!= inequality operator
< less than operator
> greater than operator
<= less than or equal to operator
>= greater than or equal to operator
==~ string equality operator (case insensitive)
!=~ string inequality operator (case insensitive)
&& AND operator
!NOT operator (unary)
!! OR operator
Expressions surrounded in forward slashes ('/') are interpreted as regular expressions. To prevent regular expression parsing, surround the section in question with backquotes (').
IS script string functions may fail if used on data that can be interpreted as a number. To prevent this, surround the data in single quotes (').
IS script will evaluate any non-zero, non-empty string value as true, for purposes of boolean analysis (in IF and WHILE statement).
MIME types
The MIMETYPE file is used by Internet Services, in order to control the rendering of content over the Internet. It can be used to determine what programs to associate with what file types, and what type of content to send back in response to a request from a browser.
Entries in the file take the following form:
MIMETYPE<tab>data type<tab>program<tab> file extension
A typical entry might be:
text/html<tab1>text<tab>MSIE<tab>.html
The MIMETYPE file determines which documents to send down without templates. Typically, when a document is opened on the web, a template is used to render it. However, some users may want to create their homepages using HTML or some other markup language. This means that they must have a way of sending down files without templates. This is accomplished by associating an extension with a file type. For example:
text/html<tab1>text<tab>MSIE<tab>.html
This causes all files with a .html extension to be sent to the browser directly.
The MIMETYPE file also determines which files types should be server parsed. Users may want to use IS script with their HTML pages. This can be accomplished by associating an extension with server-parsing, as follows:
text/x-server-parsed-type<tab>ext<tab>program<tab>extension
It will then parse files of this type and send down the resultant file as text/type. Typical server-parsed extensions are .shtml, .shtml, and .inc.
X-FC-tags for all templates
X-FC-FCPURL
Use the X-FC-FCPURL tag to output a link to open the current object in the FirstClass client.
Note
The client must be installed on the user's machine and be configured to respond to fcp:// URLs in order for this to work.
Syntax
<X-FC-FCPURL>
Context
All templates
X-FC-FIELD
Use the X-FC-Field tag to output the contents of a field of the current object. The ID numbers of the various fields on a form can be seen by viewing that form in FirstClass Designer.
Note1
In some cases, a given field may contain more than one piece of data. In this case, use the <X-FC-FIELD-COUNT> tag to determine the number of data elements, along with the second (indexed field) syntax, for the X-FC-FIELD tag.
Note2
It should be noted that the basic X-FC-FIELD syntax can only access the editable (data) fields of forms. To access hard coded strings and numbers use the X-FC-FIELD LANG syntax.
Syntax
Standard format
<X-FC-FIELD FieldID [DEFAULT=DefaultValue] Format>
Indexed format
<X-FC-FIELD FieldID.Index [DEFAULT=DefaultValue] Format>
LANG syntax
X-FC-FIELD LANG is a way of accessing resources in IS language configuration file(s). They are called two letter ISO language code.fc or lang.fc for short. For example, the english resource config file is called EN.fc. When X-FC-FIELD LANG appears in a template, IS substitutes the specified data out of the correct lang.fc file for the users preferred language based on their browser settings.
There are two kinds of resources that can be accessed with X-FC-FIELD LANG: string resources and form resources. To determine what kind of resource you are looking for, examine the lang.fc file in FirstClass Designer.
String resources
Syntax
<X-FC-FIELD LANG.RezID.Index [DEFAULT=DefaultValue] Format>
Form Resources
Syntax
<X-FC-FIELD LANG.FormID.FieldID.PropertyID [DEFAULT=DefaultValue] Format>
The FieldID can reference a specific user interface control on the specified form (remember that the lang.fc file contains only read-only data, not constant data). However, this alone is insufficient to uniquely identify a piece of data. It is therefore necessary to identify the specific property of the desired user interface control. Data about the form itself, such as the form title can be used by specifying a field ID of 0.
Example
The alternate message form (formID=134) contains a checkbox (fieldID=1001). This checkbox has a number of properties that you can see them by opening the "field attributes" dialog in designer, then by selecting the checkbox in the form in the lang.fc file. Some of the properties are a label ("RSVP"), a default checked state (0 or not checked), an x and y coordinate on the form (407,14), whether or not the checkbox is tri-state (the property is always 0) and so on.
Any of these properties can be accessed using the correct property ID (see the list below for some common property IDs). For instance, the label of the checkbox ("RSVP") can be accessed using <X-FC-FIELD LANG.134.1001.9 STRING>. However, the current state of the checkbox CANNOT be determined using an X-FC-FIELD LANG tag, as this is not read-only data. For example, the checkbox state can change any time the user clicks it. You therefore have to access it using the standard X-FC-FIELD syntax from within the 134 template. For example, <X-FC-FIELD 1001 DEFAULT=0 NUMBER>.
Commonly Used Propery IDs
ID # Label
9 Label/Guide Text
10 List options
11 Default Value
25 Tab/Form Title
30 Help Text
PREFS syntax
Syntax
<X-FC-FIELD PREFS.fieldID [DEFAULT=DefaultValue] Format>
The X-FC-FIELD PREFS tag is used to access data about the user's preferences. The fieldIDs match those on the preferences form (formID=127) and the multisite preferences form (formID=49). When used, the X-FC-FIELD PREFS tag accesses preferences in this order.
1 User's preferences form
2 .siteprefs form in the root folder of the current web site
3 IS' Global Site Preferences form
4 DEFAULT clause
5 any hard coded default
Note
Most fields don't have a hard coded default. Always specify a DEFAULT clause. The search stops as soon as IS finds a value.
Arguments
FieldID
The field id must be the ID number of the field in question for the current context. Field ids are always positive, and numbers under 1000 are reserved by Centrinity for common and/or special fields.
Index
This argument is used with indexed field data to specify which datum is wanted. Index must be from 0 to (number of data - 1). The number of available data can be determined using the X-FC-FIELD-COUNT tag.
DefaultValue
Specifies the value to use if the field has no current value. It is recommended that this value be specified for all send or edit forms, and anywhere els where the possibility exists that there will be no data available.
Format
A String specifying an output format for the data acquired.
Context
All templates
X-FC-FIELD-COUNT
Use the X-FC-FIELD-COUNT tag to determine the number of items in an indexed field. If the field is empty, returns 0. If the field is not indexed, returns 1.
Syntax
<X-FC-FIELD-COUNT>
Context
All templates
X-FC-OBJNAME
Use the X-FC-OBJNAME tag to output the name of the current object.
Syntax
<X-FC-OBJNAME>
Context
All templates
X-FC-OBJPATH
Use the X-FC-OBJPATH tag to output the URL to the current object in a manner useable by the Java Chat program.
Syntax
<X-FC-OBJPATH>
Context
All templates
X-FC-OBJTYPE
Use the X-FC-OBJTYPE tag to determine the general type of the current object.
Syntax
X-FC-OBJTYPE [ObjType|NUMBER]>
Behaviour
Outputs the type of the current object as a string pulled from teh lang.fc file.
Arguments
NUMBER
Outputs the Object's Type in numeric format.
ObjType
Used to test whether the current object is of a specific type. If the object type matches the one specified, the tag returns 1, otherwise it returns 0.
The possible object types are:
• Desktop
• Conference
• Folder
• ConfItem
• Message
• Text
• File
• DirList
• Profile
• UserList
• ACL
• Form
• History
• Chat
• ChatInvite
• SystemMonitor
• FormDoc
• MemForm
• User
• Document
• WorkForm
• MailBox
• PrivGroup Folder
• GatewayFolder
• MailListFolder
• DeskTopFolder
• Archive
• ModelFolder
• PermStationery
• FCFile
• RemoteAdmin
Context
All templates
X-FC-PERMISSIONS
Use the X-FC-PERMISSIONS tag to determine the current user's permissions for the current object.
Syntax
<X-FC-PERMISSIONS [Permission]>
Behaviour
Outputs a bitmask of the user's permissions for the current object (as seen on teh conference's access control list (permissions form)).
Generally speaking, most of these permissins are only meaningful in conferences/folders, but some can be used in documents and messages as well (Delete, Write, Download (refers to attachments), ViewHist, GetInfo).
Note
Some actions require not only a permission but a privilege as well. For example, uploading a file to a conference requires theuser to have both the upload privilege (in general) and the upload/download permission, for that conference.
The fact that a user possesses a particular permission for a given object does not necessarily imply that the user has any associated privileges required that use that permission (or vice versa).
Arguments
PERMISSION
Used to test for the presence or absence of a specific permission. If the user possesses thepermission in question, the tag returns 1, otherwise the tag returns 0. The possible permissions that can be tested for are:
Permission Effect
EditACL User may edit the permission form
Moderator User is a moderator
Delete User may delete or move items
Create User may directly create items
(documents and sub-folders)
Edit User may edit read only items (sent
messages)
Write User may edit (non-read-only) items
EditWInfo User may place and size and sort
window (change View Properties permission)
Approve User may approve/unapprove items
(mail sent to this conference by the user does not require approval)
DeleteOwn User may delete owned items (user
can unsend messages that they have sent to this conference)
Read User may open this conference
Search User may search this
conference/folder
Send User may send mail to this
conference
Open User may open items/read
messages
CrtConf User may create subconferences
Download User may upload/download files to
this conference
ViewACL User may view the permissions form
ViewHist This object supports history, and the
user is allowed to view it.
GetInfo This object supports get info(Mac) /
properties (Windows)
OpenByName This object may be opened by
directory name using the URL <X-FC-LOGIN> open-user/<X-FC-OBJNAME>)
ViewDates User may view calendar times
Context
All templates
X-FC-STATUS
Use the X-FC-STATUS tag to determine the status of the current object.
Syntax
<X-FC-STATUS [Status]>
Behaviour
Outputs a bitmask of the status of the current object (the same as in the 'status' column that can be turned on in conference listings).
Note
Some of these statuses are only meaninful for messages (one does not find too many 'sent' documents, or 'urgent' conferences.
Arguments
Status
Used to test for a specific status. If the specified status is enabled for this object, the tag returns 1, otheriwse it returns 0. Possible statuses that can be tested for are:
Status Effect
UnRead This object's unread flag is on
Urgent This object has its priority set to
'Urgent'
Sent This object is a sent message
Deleted This object has been deleted
Outgoing This object is the outgoing copy of a
message
Protected This object's protected bit is on
(protected checkbox on the properties/get info form)
Unapproved This object is unapproved
Moved This object has been moved
elsewhere
Moved This object has been moved
elsewhere
AutoOpen This object's auto-open bit is set
(auto-open checkbox on the
properties/get info form)
Addressed This object is an outgoing message
with at least 1 valid recipient
Attachments This object has at least one
attachment(s)
Replicated This object has been replicated from
another site
Partial This object is a partially uploaded file
URLDoc This object is a bookmark
Voice This file has at least one voice
attachment(s)
Context
All templates
X-FC-SUBTYPE
Use the X-FC-SUBTYPE tag to determine the specific type of the current object.
This provides a finer gradation than that of X-FC-OBJTYPE. For example, Internet Services, Voice greetings, and Address Book are all of object type 'Folder', however they each have a distince subtype.
Syntax
<X-FC-SUBTYPE [SubType]>
Behaviour
Outputs the numeric subtype of the current object.
Note
A subtype of 0 indicates "No special subtype", meaning that the 'objtype' is considered sufficient to describe this object. In general, most subtyped objects only appear on the admin Desktop or inside the folders that live on it. There are, however, a few notable exceptions (such as, the address book and bookmarks folders).
Arguments
SubType
Used to test whether the current object is of a specific subtype. If the object's subtype matches the one specified, the tag returns 1, otherwise it returns 0. The possible subtypes are:
Subtype Object
OfflineConfs Offline conferences folder (admin Desktop)
DireSync DirSync folder (under the multisite setup folder)
SiteSync SiteSync folder (under the multisite setup folder)
Conferences Conferences folder
Gateways Gateways folder (admin Desktop)
AddressBook Personal Address book
Unapproved This object is unapproved
PrivGroups Groups folder (admin Desktop)
MailList Mail Lists folder (admin Desktop)
InternetServicesConfig Internet Services folder (admin Desktop)
VoiceServicesConfig Voice Services folder (admin Desktop)
ResourceLibrary FC Resource Registry (under the multisite setup folder)
UserHomePage Home page folder
BookMarks Bookmarks folder
JavaFolder Java folder (under the IS folder)
SPAMFilters Filters folder (under the IS folder)
VoiceGreetings Voice greetings folder
Calendar Personal or Group Calendar
ResourceCalendar Resource Calendar
LocationCalendar Location Calendar
Volumes Volumes folder (admin Desktop)
MultiVolConferences MultiVolConferences folder (admin Desktop)
MemosFolder Memos folder (used with the Palm Conduits)
CertificatesFolder SSL Certificates folder (under the IS folder)
Context
All templates
X-FC-tags conference and search listings
X-FC-CONFERENCE-ITEM
Use the X-FC-CONFERENCE-ITEM tag in conference or search listings to output data about the current item in the listing.
Syntax
<X-FC-CONFERENCE-ITEM COLUMN[CollD] [FormatSpecifier]>
Arguments
CollD
Can be one of:
• a positive integer determined by the use of <X-FC-SCHEMA COLUMN[n].FIELDID>
• a string representing one of the set of "default" columns available in most conference listings.
The default columns are as follows:
Default columns
Column name: Objtype
Numeric ColID: 0
Column data type: 2 (resstr)
Valid arguments: same as for <X-FC-OBJTYPE>
Column name: Subtype
Numeric ColID: 1
Column data type: 8 (numeric)
Valid arguments: same as for <X-FC-SUBTYPE>
Column name: Date
Numeric ColID: 2
Column data type: 16 (date)
Valid arguments: same as any date type column
Column name: Status
Numeric ColID: 3
Column data type: 16 (date)
Valid arguments: same as for <X-FC-STATUS>
Column name: Location
Numeric ColID: 4
Column data type: 0 (text)
Valid arguments: X==X-Coordinate only, Y==Y-Coordinate Only
Column name: Icon
Numeric ColID: 5
Column data type: 1 (icon)
Valid arguments: None
Column name: Size
Numeric ColID: 6
Column data type: 0 (text)
Valid arguments: BYTES outputs the file size in bytes, K outputs the file size in kilobytes, SCALED outputs the file size in the most appropriate metric unit. For example, KB, M, G, T, or (default).
Column name: Name
Numeric ColID: 7
Column data type: 0 (text)
Valid arguments: same as any string type column
Column name: Subject
Numeric ColID: 8
Column data type: 0 (text)
Valid arguments: same as any string type column
Column name: Flag
Numeric ColID: 9
Column data type: 8 (numeric)
Valid arguments: None
Column name: Attach
Numeric ColID: 10
Column data type: 8 (numeric)
Valid arguments: None
Column name: ThreadID
Numeric ColID: 11
Column data type: 0 (text)
Valid arguments: None
Column name: MessageID
Numeric ColID: 12
Column data type: 0 (text)
Valid arguments: same as any string type column
Column name: SysID
Numeric ColID: 13
Column data type: 8 (numeric)
Valid arguments: none
Column name: Title
Numeric ColID: 14
Column data type: 0 (text)
Valid arguments: same as any string type column
Column name: InFolder
Numeric ColID: 15
Column data type: 0 (text)
Valid arguments: same as any string type column
Column name: Expiry
Numeric ColID: 16
Column data type: 16 (date)
Valid arguments: same as any data type column
Column name: Options
Numeric ColID: 17
Column data type: 8 (numeric)
Valid arguments: same as for <X-FC-OPTIONS>
Column name: EndTime
Numeric ColID: 18
Column data type: 16 (date)
Valid arguments: same as any date type column
Note
Each item in the above 'default columns' subheadings relate to each other by lower case letter. For example, the String CollD 'a) objtype' has a Numeric CollD of 'a) 0', Column Title 'a) Kind', and Valid Argument 'a) same as for <X-FC-OBJTYPE>'.
Format specifier
A string that specifies how to format the data when it is output. The valid format specifiers depend on the column data type.
• Columns with a data type date can take a quoted string as a format specifier. The quoted string can contain any of the standard date formatting token. For example, %Y==year, %H==Hour (in 12 hour format).
• Columns with a data type string can take the argument PLAIN. By default, string data is output with all quotes, double quotes, line feeds, and backslashes escaped in a manner designed to alow easy assignment to a javascript variable. Use the PLAIN format argument to escape this escaping.
• Some of the default columns tak especial format arguments. See the list above under the Default columns heading.
Context
All conference or search listing templates -13, -17, -201, -211, -301.
X-FC-CONFERENCE-ITEM-URI
Use the X-FC-CONFERENCE-ITEM-URI tag in conference or search listings to ouput the URL used to open the current item in the listing.
Syntax
<X-FC-CONFERENCE-ITEM-URI>
Context
All conference or search listing templates -13. 17, -201, -211, -301.
X-FC-tags for conferences
X-FC-CONFERENCE-FOLDER-LIST-LAST
Use the X-FC-CONFERENCE-FOLDER-LIST-LAST tag in conference listings to either output the index of the last folder on the current page, or, in conjunction with the X-FC-CONFERENCE-FOLDER-LIST-FIRST or X-FC-CONFERENCE-FOLDER-LIST-MAX tags, to specify a range of folders to display on the current page.
Note
Setting any two of <X-FC-CONFERENCE-FOLDER-LIST-LAST>, <X-FC-CONFERENCE-FOLDER-LIST-FIRST> and <X-FC-CONFERENCE-FOLDER-LIST-MAX> is sufficient to specify any range of folders on a page. Attempting to set the values of all three of these tags in one template has unpredictable results.
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-LAST[LastFolder]>
Arguments
LastFolder
This is an integer number which, if present, specifies the number of the last folder to display on this page. If this argument is absent, the tag returns the index of the last folder on the current page.
Context
templates -1 or -200
X-FC-CONFERENCE-FOLDER-LIST-MAX
Use the X-FC-CONFERENCE-FOLDER-LIST-MAX tag in conference listings to either output the number of the folders on the current page, or, in conjunction with the X-FC-CONFERENCE-FOLDER-LIST-FIRST or X-FC-CONFERENCE-FOLDER-LIST-LAST tags, to specify a range of folders to display on the current page.
Note
Setting any two of <X-FC-CONFERENCE-FOLDER-LIST-LAST>, <X-FC-CONFERENCE-FOLDER-LIST-FIRST> and <X-FC-CONFERENCE-FOLDER-LIST-MAX> is sufficient to specify any range of folders on a page. Attempting to set the values of all three of these tags in one template has unpredictable results.
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-LAST[NumFolders]>
Arguments
NumFolders
This is an integer number which, if present, specifies the maximum number of folders to display on this page. If this argument is absent, the tag returns the current maximum number of folders per page.
Context
templates -1 or -200
X-FC-CONFERENCE-FOLDER-LIST-NEXT
Use the X-FC-CONFERENCE-FOLDER-LIST-NEXT tag in conference listings to provide a link to the next page of the folder.
Behaviour
if there are more folders to display
gets string 7501:8 from the language resource file (lang.fc), substitutes the number of messages to display for the first %d in the string, and makes a link that displays the next page
If the first character in the tring is <. the string can contain HTML code.
if there are no more folders to display
gets string 7501:7 from the language resource file
This string tells users that there are no more folders to display.
If there are no folders in the ocnferencr or folder
nothing
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-NEXT>
Context
templates -1 or -200
X-FC-CONFERENCE-FOLDER-LIST-PREV
Use the X-FC-CONFERENCE-FOLDER-LIST-PREV tag in conference listings to provide a link to the previous page of the folder.
Behaviour
if there are previous folders to display
gets string 7501:6 from the language resource file (lang.fc), substitutes the number of previous folders to display for the first %d in the string, and makes a link that displays the next page.
If the first character in the string is <. the string can contain HTML code.
if there are no previous folders to display
gets string 7501:5 from the language resource file
This string tells users that there are no more folders to display.
If there are no folders in the ocnferencr or folder
nothing
Syntax
<X-FC-CONFERENCE-FOLDER-LIST-PREV>
Context
templates -1 or -200
X-FC-CONFERENCE-LIST-FIRST
Use the X-FC-CONFERENCE-LIST-FIRST tag in conference listings to either output the index of the first message on the current page, or in conjunction with the X-FC-CONFERENCE-LIST-LAST or X-FC-CONFERENCE-LIST-MAX tags, to specify a range of messages to display on the current page.
Note
Setting any two of <X-FC-CONFERENCE-LIST-LAST>, <X-FC-CONFERENCE-LIST-FIRST> and <X-FC-CONFERENCE-LIST-MAX> is sufficient to specify any range of messages on a page. Attempting to set the values of all three of these tags in one template has unpredictable results.
Syntax
<X-FC-CONFERENCE-LIST-FIRST[FirstMessage>
Arguments
FirstMessage
This is an integer number which, if present, specifies the number of the first message to display on this page. If this argument is absent, the tag returns the index of the first message on the current page.
Context
templates -1 or -210
X-FC-CONFERENCE-LIST-LAST
Use the X-FC-CONFERENCE-LIST-LAST tag in conference listings to either output the index of the last message on the current page, or in conjunction with the X-FC-CONFERENCE-LIST-FIRST or X-FC-CONFERENCE-LIST-MAX tags, to specify a range of messages to display on the current page.
Note
Setting any two of <X-FC-CONFERENCE-LIST-LAST>,<X-FC-CONFERENCE-LIST-FIRST>, and <X-FC-CONFERENCE-LIST-MAX> is sufficient to specify any range of messages on a page. Attempting to set the values of all three of these tags in one template has unpredictable result.
Syntax
<X-FC-CONFERENCE-LIST-LAST[LastMessage>
Arguments
LastMessage
This is an integer number which, if present, specifies the number of the last message to display on this page. If this argument is absent, the tag returns the index of the last message on the current page.
Context
templates -1 or -210
X-FC-CONFERENCE-LIST-MAX
Use the X-FC-CONFERENCE-LIST-MAX tag in conference listings to either output the number of messages on the current page, or in conjunction with the X-FC-CONFERENCE-LIST-FIRST or X-FC-CONFERENCE-LIST-LAST tags, to specify a range of messages to display on the current page.
Note
Setting any two of <X-FC-CONFERENCE-LIST-LAST>,<X-FC-CONFERENCE-LIST-FIRST>, and <X-FC-CONFERENCE-LIST-MAX> is sufficient to specify any range of messages on a page. Attempting to set the values of all three of these tags in one template has unpredictable results.
Syntax
<X-FC-CONFERENCE-LIST-MAX[NumMessage>
Arguments
NumMessage
This is an integer number which, if present, specifies the maximum number of messages to display on this page. If this argument is absent, the tag returns the current maximum number of messages per page.
Context
templates -1 or -210
X-FC-CONFERENCE-LIST-NEXT
Use the X-FC-CONFERENCE-LIST-NEXT tag in conference listings to provide a link to the next page of messages.
Behavior
if there are more messages to display
gets string 7501:4 from the language resource file (lang.fc), substitutes the number of messages to display for the first %d in the string, and makes a link that displays the next page.
If the first character in the string is <, the string can contain HTML code.
if there are no more messages to display
gets string 7501:3 from the language resource file
This string tells users that there are no more messages to display.
if there are no messages in the conference or folder
nothing
Syntax
<X-FC-CONFERENCE-LIST-NEXT>
Context
templates -1 or -210
X-FC-CONFERENCE-LIST-PREV
Use the X-FC-CONFERENCE-LIST-PREV tag in conference listings to provide a link to the previous page of messages.
Behavior
if there are previous messages to display
gets string 7501:2 from the language resource file (lang.fc), substitutes the number of previous messages to display for the first %d in the string, and makes a link that displays the previous page.
If the first character in the string is <, the string can contain HTML code.
if there are no more messages to display
gets string 7501:1 from the language resource file
This string tells users that there are no more messages to display.
if there are no messages in the conference or folder
nothing
Syntax
<X-FC-CONFERENCE-LIST-PREV>
Context
templates -1 or -210
X-FC-FRAMESET
Use the X-FC-FRAMESET tag in conference listings to suppress the output of the -10 to -19 and -2 templates after the -1 template. Useful when displaying a conference in a framed view.
Syntax
<X-FC-FRAMESET>
Context
Template -1
X-FC-LAYOUT
Use the X-FC-LAYOUT tag to determine the display properties of a conference.
Syntax
<X-FC-LAYOUT SPLITTYPE[.H|V|N]|SPLITPOS|NCOLS>
<X-FC-LAYOUT Pane.ViewProperty>
Arguments
SPLITTYPE
Whether or not to split the folders and items into different frames (0==no split, 1==horizontal split (folders are upper pane, messages are lower pane), 2==vertical split (folders aer left pane, messages are right pane)
SPLITTYPE.H:
SPLITTYPE.V:
SPLITTYPE.N:
Return 1 if the split type is the one specified (H==horizontal, V==vertical, N==None), 0 if it is not.
SPLITPOS
The size (in pixels) of the upper pane (if split is horizontal) or the left hand pane (if split is vertical)
NCOLS
The number of columns currently being displayed if the output is in list view mode
Pane
One of UPPER, LOWER, LEFT, or RIGHT. Specifies which pane's view properties are being requested.
Note 1
In practice, UPPER==LEFT and LOWER==RIGHT, so there is no need to separate out which set of panes to use in which split mode. For example, you can requrest the view properties for the UPPER pane in a vertical split and it will refer to the left pane's properties.
Note 2
In non-split mode, the only pane is the UPPER/LEFT one. Trying to access the view properties of the LOWER/RIGHT pane is inadvisable.
ViewProperty
Requests data about a specific view propertyof a particular pane.
View Property Effect
REVSORT if false, items will be output, oldest first
DISPLAYFORMAT 0=list, 1=small icon, 2=icon
SORTON the data fieldid of the column to sort on (This is NOT the colid, it is the SCHEMA[colid].fieldid)
Context
All conference templates: -1, -2, -10 to -19, -200 to -202, -210 to -212
X-FC-NUMFILES
Use the X-FC-NUMFILES tag in conference listings to output the number of messages.
Syntax
<X-FC-NUMFILES>
Context
-1, -2, -10 to -19, -200 to -202, -210 to -212
X-FC-SCHEMA
Use the X-FC-SCHEMA tag to gather information about the possible columns available for a conference in list view mode.
Syntax
<X-FC-SCHEMA NCOLS>
<X-FC-SCHEMA COLUMN[ColID].Property>
Arguments
NCOLS
Outputs the number of possible columns available.
CollD
Can be one of :
• a negative integer between 0 and and (X-FC-SCHEMA NCOLS> -1)
Gathers information about the |CollD|th possible column.
• a positive integer as determined by the use of <X-FC-LAYOUT Pan.FIELDID[n]>
• a string representing one of the set of "default" columns available in most conference listings.
The default columns are:
String CollD Numeric CollD Column Title
ObjType 0 Kind
Subtype 1 SubType
Date 2 LastModified
Status 3 Status
Location 4 Position
Icon 5 Icon
Size 6 Size
Name 7 Name
Subject 8 Subject
Flag 9 Flag
Attach 10 Attachments
ThreadID 11 Thread
MessageID 12 Message
SysID 13 SysID
Title 14 Icon Title
InFolder 15 InFolder
Expiry 16 Expiry
Options 17 Options
EndTime 18 EndTime
Note
EndTime is really only meaningful in calendar listings and InFolder is only meaningful in search listings.
Property
Property Name Effect
FIELDID Field ID of the data for this column (when using the <X-FC-CONFERENCE-ITEM> tag.
TYPE Data type for this column (0=text, 1=icon, 2=resstr, 4=pict, 8=numeric, 16=date).
TITLE Title for this column. If ICONID is non-zero, this usually becomes the tool tip for the column title. For example, the 'alt' tag.
WIDTH The default width of this column (this is the default width of the column when it is first displayed. To find the current width, use <X-FC-LAYOUT Pane.WIDTH[n]>.
ATTR Outputs a bitmask of the columns sorting and alignment attributes.
ATTR.REVSORT Returns 1 if the column should be reverse sorted by default; if not 0.
ATTR.ALIGN Returns the alignment of the column in a format suitable for introduction into an HTML 'align' attribute (since HTML doesn't support 'Justify' alignment, it is translated as "left").
ATTR.ALIGN.LEFT
ATTR.ALIGN.RIGHT
ATTR.ALIGN.CENTER
ATTR.ALIGN.JUSTIFY Returns 1 if the alignment attribute of the column matches the one specified; otherwise 0.
Context
All conference listing templates: -1, -2, -10 to -19, -200 to -202, -210 to -212. The default columns also work in search templates -300 to -303.
X-FC-NUMFOLDERS
Use the X-FC-NUMFOLDERS tag in conference listings to output the number of folders objects in this conference.
Syntax
<X-FC-NUMFOLDERS>
Context
All conference listing templates: -1, -2, -10 to -19, -200 to -202, -210 to -212
X-FC-tags for directory listings
X-FC-DIRECTORY-ITEM-ATTR
Use the X-FC-DIRECTORY-ITEM-ATTR tag in a directory or Who's Online listing to output the bitmask of the current directory item's attributes.
Syntax
<X-FC-DIRECTORY-ITEM-ATTR[Attribute]>
Arguments
LOGGEDON
Returns 1 if the directory item is a user who is currentlylogged on.
Otherwise
0
CHATCLOAK
Returns 1 if the directory item is a user who cannot or will not accept chat invitations.
Otherwise
0
ALIAS
Returns 1 if the directory item is an alias.
Otherwise
0
USERCLASS
Returns the numeric userclass of the directory item.
USERCLASS.UserClassType
Returns 1 if the user's class matches the one specified.
Otherwise
0
Possible user classes
• Any
• Person
• Conference
• FAX
• Gateway
• Telecom
• DeadUser
• Model
• Remote
• System
• Route
• PrivGroup
• MailList
• MailAlias
• DBExtension
• Process
• ConfGroup
• Calendar
• Resource
• CalGroup
• Location
Context
Directory or Who's Online item templates: -102, -401.
X-FC-DIRECTORY-ITEM-IMAGE
Use the X-FC-DIRECTORY-ITEM-IMAGE tag in a directory or Who's Online listing to output the icon for the current directory item.
Syntax
<X-FC-DIRECTORY-ITEM-IMAGE>
Context
Directory or Who's Online item templates: -102, -104.
X-FC-DIRECTORY-ITEM-NAME
Use the X-FC-DIRECTORY-ITEM-NAME tag in a directory or Who's Online listing to output the name for the current directory item.
Syntax
<X-FC-DIRECTORY-ITEM-NAME[ESCAPED]>
Arguments
ESCAPED
Escapes the name in a manner appropriate for assignment to a Javascript string.
Context
Directory or Who's Online item templates: -102, -401.
X-FC-DIRECTORY-ITEM-NAME-HOMEPAGE
Use the X-FC-DIRECTORY-ITEM-NAME-HOMEPAGE tag in a directory or Who's Online listing to output a link to a directory item's homepage (if it exists).
Behaviour
If the directory item is a user
Outputs a link to that user's homepage. The link text is the user's name.
Otherwise
Outputs the directory item's name.
Syntax
<X-FC-DIRECTORY-ITEM-NAME-HOMEPAGE[URL]>
Arguments
URL
Outputs just the URL to the directory item's homepage. If the directory is not a user, outputs nothing.
Context
Directory or Who's Online itme templates: -102, -401.
X-FC-tags for forms
X-FC-ATTACHMENT-COUNT
Use the X-FC-ATTACHMENT-COUNT tag in a form to output the current number of attachments.
Syntax
<X-FC-ATTACHMENT-COUNT>
Context
All forms templates.
X-FC-ATTACHMENT-ICON
Use the X-FC-ATTACHMENT-ICON tag in a form to output the icon number of the specified attachment.
Syntax
<X-FC-ATTACHMENT-ICON Index>
Arguments
Index
The index of the attachment for the icon you want. Must be between 0 and <X-FC-ATTACHMENT-COUTN>-1), inclusive.
Context
All forms templates.
X-FC-ATTACHMENT-NAME
Use the X-FC-ATTACHMENT-NAME tag in a form to output the name of the specified attachment.
Syntax
<X-FC-ATTACHMENT-NAME Index>
Arguments
Index
The index of the attachment whose name you want. Must be between 0 and <X-FC-ATTACHMENT-COUNT>-1), inclusive.
Context
All forms templates.
X-FC-ATTACHMENT-SIZE
Use the X-FC-ATTACHMENT-SIZE tag in a form to output the size of the specified attachment.
Syntax
<X-FC-ATTACHMENT-SIZE index[BYTES|K|SCALED]>
Arguments
Index
The index of the attachment whose size you want. Must be between 0 and <X-FC-ATTACHMENT-COUNT>-1), inclusive.
BYTES
Formats the output to display the size in bytes.
K
Formats the output to display the size in the most appropriate metric unit (K,M,G,T).
Context
All forms templates.
X-FC-ATTACHMENT-URL [index]
Use the X-FC-ATTACHMENT-URL index] tag in a form to output the URL of the specified attachement.
Syntax
X-FC-ATTACHMENT-URL [index]
Arguments
Index
The index of the attachment whose URL you want. Must be between 0 and (X-FC-ATTACHMENT-COUNT>-1), inclusive.
Context
All forms templates.
X-FC-BODY
Use the X-FC-BODY tag in a form to output the body of that form.
Syntax
X-FC-BODY[FORMAT=format][ESCAPED]>
Arguments
FORMAT=Format
Properly formats the body.
Support formats are:
• HTML
Default format, add <img> and <a> tags and uses style sheets and other display formatting tags where appropriate.
• WML
Outputs the body in a manner compatible with WAP/WML enabled devices.
• PLAIN
Outputs the body with no formatting.
• ESCAPED
Escpated all quotes, double-quotes, line breaks, and backslashed, appropriate for use with JavaScript variables.
Context
All forms templates.
X-FC-DATE
Use the X-FC-DATE tag in a form to output the date and time the message was sent (for messages) or last modified (for other forms).
Syntax
<X-FC-DATE["DateFormat"]>
Arguments
DateFormat
Specifies an output format for the date.
Context
All forms templates.
X-FC-ICON-NUMBER
Use the X-FC-ICON-NUMBER tag in a form to output the ID number of that form's icon.
Syntax
<X-FC-ICON-NUMBER>
Context
All forms templates
X-FC-OPTIONS
Use the X-FC-OPTIONS tag in a form to output a bitmask of that form's message options.
Syntax
<X-FC-OPTIONS [OptionName]>
Arguments
OptionName
Returns data about a particular message option.
Valid message options are:
Option
PRIORITY
Returned Value
numeric priority (0-3)
Option
PRIORITY.NORMAL
Returned Value
1, if priority is normal, otherwise 0
Option
PRIORITY.URGENT
Returned Value
1, if priority is urgent, otherwise 0
Option
PRIORITY.BULK
Returned Value
1, if priority is bulk, otherwise 0
Option
PRIORITY.JUNK
Returned Value
1, if priority is junk, otherwise 0
Option
SENSITIVITY
Returned Value
numeric sensitivity (0-3)
Option
SENSITIVITY.NORMAL
Returned Value
1 if sensitivity is normal, otherwise 0
Option
SENSITIVITY.PERSONAL
Returned Value
1 if sensitivity is personal, otherwise 0
Option
SENSITIVITY.PRIVATE
Returned Value
1 if sensitivity is private, otherwise 0
Option
SENSITIVITY.COMPANY
Returned Value
1 if sensitivity is company, otherwise 0
Option
DELIVERYRECEIPT
Returned Value
1 if delivery receipt is enabled, otherwise 0
Option
READRECEIPT
Returned Value
1 if read receipt is enabled, otherwise 0
Option
ROUTERECEIPT
Returned Value
1 if route receipt is enabled, otherwise 0
Option
VERBOSERECEIPT
Returned Value
1 if receipts are more verbose, 0 if receipts are normal
Option
REMOTEONLYRECEIPT
Returned Value
1 if receipts are only to be generated for remote recipients, 0 if receipts are to be generated for all recipients
Option
SUPPRESSNDN
Returned Value
1 if NDN suppression is enabled, otherwise 0
Option
RETURNCONTENT
Returned Value
1 if NDNs should return the entire message, otherwise 0
Option
MACHINEGENERATED
Returned Value
1 if this message was machine generated (for example, auto-reply or system message), otherwise 0
Context
All forms templates.
X-FC-PICTURE-PATH
Use the X-FC-PICTURE-PATH tag in a form to output a URL to the first picture embedded in that form.
Syntax
<X-FC-PICTURE-PATH>
Context
All forms templates
Note
This tag is in fact of little use in FC6. It is left here to allow the rendering of certain older forms that require it.
X-FC-RECIPIENT-ADDRESS [type][index]
Use the X-FC-RECIPIENT-ADDRESS [type][index] tag in a form to output the address of the specified recipient in a format useable in a FirstClass To field.
Syntax
<X-FC-RECIPIENT-ADDRESS RecipientType RecipientNumber>
Arguments
RecipientType
Specifies the type of recipient. Valid types are TO, CC, BCC, and FWD. For convenient use with IS script, these types may be expressed as the numbers 0-3 (0==To, 1==Cc, 2==Bcc, 3==Fwd).
RecipientNumber
Specifies the particular recipient of the specified type. Must be between 0 and (<X-FC-RECIPIENT-COUNT RecipientType>-1)
Context
All forms templates.
X-FC-RECIPIENT-COUNT [type][index]
Use the X-FC-RECIPIENT-COUNT [type][index] tag in a form to output the number of recipients of the specified type.
Syntax
<X-FC-RECIPIENT-COUNT RecipientType>
Arguments
RecipientType
Specifies the type of recipient. Valid types are TO, CC, BCC, and FWD. For convenient use with IS script, these types may be expressed as the numbers 0-3 (0==To, 1==Cc, 2==Bcc, 3==Fwd).
Context
All forms templates.
X-FC-RECIPIENT-ICON [type][index]
Use the X-FC-RECIPIENT-ICON [type][index] tag in a form to output the icon of the specified recipient.
Syntax
<X-FC-RECIPIENT-COUNT RecipientType RecipientNumber>
Arguments
RecipientType
Specifies the type of recipient. Valid types are TO, CC, BCC, and FWD. For convenient use with IS script, these types may be expressed as the numbers 0-3 (0==To, 1==Cc, 2==Bcc, 3==Fwd).
RecipientNumber
Specifies the particular recipient of the specified type. Must be between 0 and (<X-FC-RECIPIENT-COUNT RecipientType>-1)
Note
The first FWD name (RecipientNumber==0) is the FROM name.
Context
All forms templates.
X-FC-RECIPIENT-MAILTO [type][index]
Use the X-FC-RECIPIENT-MAILTO [type][index] tag in a form to output the address of the specified recipient in a format useable in a mailto link.
Syntax
<X-FC-RECIPIENT-MAILTO RecipientType RecipientNumber>
Arguments
RecipientType
Specifies the type of recipient. Valid types are TO, CC, BCC, and FWD. For convenient use with IS script, these types may be expressed as the numbers 0-3 (0==To, 1==Cc, 2==Bcc, 3==Fwd).
RecipientNumber
Specifies the particular recipient of the specified type. Must be between 0 and (<X-FC-RECIPIENT-COUNT RecipientType>-1)
Note
The first FWD name (RecipientNumber==0) is the FROM name.
Context
All forms templates.
X-FC-RECIPIENT-NAME [type][index]
Use the X-FC-RECIPIENT-NAME [type][index] tag in a form to output the name of the specified recipient.
Syntax
<X-FC-RECIPIENT-NAME RecipientType RecipientNumber>
Arguments
RecipientType
Specifies the type of recipient. Valid types are TO, CC, BCC, and FWD. For convenient use with IS script, these types may be expressed as the numbers 0-3 (0==To, 1==Cc, 2==Bcc, 3==Fwd).
RecipientNumber
Specifies the particular recipient of the specified type. Must be between 0 and (<X-FC-RECIPIENT-COUNT RecipientType>-1)
Note
The first FWD name (RecipientNumber==0) is the FROM name.
Context
All forms templates.
X-FC-RECIPIENT-URL [type][index]
Use the X-FC-RECIPIENT-URL [type][index] tag in a form to output the FirstClass mail address of the specified recipient to a To URL parameter.
Syntax
<X-FC-RECIPIENT-URL RecipientType RecipientNumber>
Arguments
RecipientType
Specifies the type of recipient. Valid types are TO, CC, BCC, and FWD. For convenient use with IS script, these types may be expressed as the numbers 0-3 (0==To, 1==Cc, 2==Bcc, 3==Fwd).
RecipientNumber
Specifies the particular recipient of the specified type. Must be between 0 and (<X-FC-RECIPIENT-COUNT RecipientType>-1)
Note
The first FWD name (RecipientNumber==0) is the FROM name.
Context
All forms templates.
X-FC-SUBJECT
Use the X-FC-SUBJECT tag in a form to output the subject of that form.
Syntax
<X-FC-SUBJECT>
Context
All forms templates.
X-FC-tags for history listings
X-FC-HISTORY-ITEM-IMAGE
Use the X-FC-HISTORY-ITEM-IMAGE tag in a history listing to output the icon for the current history entry.
Syntax
<X-FC-HISTORY-ITEM-IMAGE>
Context
-111 template
X-FC-HISTORY-ITEM-WHAT
Use the X-FC-HISTORY-ITEM-WHAT tag in a history listing to output the name of the current action.
Syntax
<X-FC-HISTORY-ITEM-WHAT>
Context
-111 template
X-FC-HISTORY-ITEM-WHEN
Use the X-FC-HISTORY-ITEM-WHEN tag in a history listing to output the date and/or time of the current action.
Syntax
<X-FC-HISTORY-ITEM-WHEN["DateFormat"]>
Arguments
DateFormat
An optional date format to use when outputting the date.
Context
-111 template
X-FC-HISTORY-ITEM-WHO
Use the X-FC-HISTORY-ITEM-WHO tag in a history listing to output the name of the user who performed the current action.
Syntax
<X-FC-HISTORY-ITEM-WHO>
Context
-111 template
X-FC-tags for server parsed files
X-FC-USER-PASS (PASSWORD)
Use the X-FC-URL-PASSWORD tag to output the password of the current user. If the current user is unauthenticated then this tag returns nothing.
Syntax
<X-FC-URL-PASS>
<X-FC-URL-PASSWORD>
Context
All server parsed files.
X-FC-USER-NAME
Use the X-FC-USER-NAME tag to output the name of the current user. If the current user is unauthenticated then this tag returns nothing.
Syntax
<X-FC-URL-NAME>
Context
All server parsed files.
X-FC-USER-ID
Use the X-FC-URL-ID tag to output the user id of the current user. If the current is unauthenticated then this tag returns nothing.
Syntax
<X-FC-URL-ID>
Context
All server parsed files.
X-FC-URL-PARAMETER
Use the X-FC-URL-PARAMETER tag to output the value of the specified URL parameter. If the URL parameter in question does not exist, this tag returns nothing.
Syntax
<X-FC-URL-PARAMETER>
Arguments
ParameterName
The name of the URL parameter whose value is being sought.
Context
All server parsed files.
X-FC-PRIVILEGES
Use the X-FC-PRIVILEGES tag to determine what privileges have been granted to the current user.
Syntax
<X-FC-PRIVILEGES [Privilege]>
Behaviour
Outputs a bitmask of the user's privileges (as seen on the "Features" tab of the User Information Form).
Note
Most actions require not only a privilege but a permission as well (ie, uploading a file to a conference requires the user to have both upload privilege (in general) and upload/download permission for that conference). The fact that a user has been granted a particular privilege does not necessarily imply that the user possesses any associated permissions required to use that privilege (or vice versa).
Arguments
Privilege
Used to test for the presence or absence of a specific privilege. If the user possesses the privilege in question, the tag returns 1, otherwise the tag return 0.
The possible privileges that can be tested for are:
Privilege Effect
Mail User may create and send private mail
Conferencing User may create and send mail to conferences
CrtConfs User may create personal conferences
Unsend User may unsend mail
Urgent User may create and send urgent messages
Unread User may toggle the unread flag (ie read mail without appearing in the history)
Forward User may forward mail
AutoMail User may use Mail Rules, Auto-Forward and Auto-Reply
SetExpiry User may set the expiry on owned items
Receipt User may ask for receipts on messages
SeePrivate User can see unlisted directory entries
ViewUserData User may view other users' information forms
EditPrivate User may edit other users' information forms
GUIAccess User may log in using the FC Client
InternetAccess User may log in using via web
CmdLineAccess User may log in using the CLUI
WorkOffline User may use FC Personal
VoiceAccess User may log in using a telephone
Chat User may initiate chats
Search User may use the search feature
Upload User may upload files and attachments
Download User may download files and attachments
ViewResumes User may view other users' resumes
ChgPrefs User may change their own password and preferences
AddrBook User may create and use a personal address book
Calendaring User may create and use a personal calendar
HomePage User may publish their own home page
NoUserExpiry User does not expire
Administrator User is an admin or subadmin
Context
All server parsed files.
X-FC-OBJURL-UP
Use the X-FC-OBJURL-UP tag to output the absolute URL of the current object's parent object.
Syntax
<X-FC-OBJURL-UP [|SLASH|NOSLASH]>
Arguments
SLASH
Forces a trailing slash at the end of the URL.
NOSLASH
Supresses any trailing slash at the end of the URL.
Context
All server parsed files.
X-FC-OBJURL
Use the X-FC-OBJURL tag to output the absolute URL of the current object.
Syntax
<X-FC-OBJURL|SLASH\NOSLASH]>
Arguments
SLASH
Forces a trailing slash at the end of the URL.
NOSLASH
Supresses any trailing slash at the end of the URL.
Context
All server parsed files.
X-FC-LOGIN
Use the X-FC-LOGIN tag in URLs to maintain the login state of the user while navigating.
Syntax
<X-FC-LOGIN>
Behaviour
If the user is logged in, returns /Login/. If the user is not logged in, returns /.
Context
All server parsed files.
X-FC-LOGGED-IN
Use the X-FC-LOGGED-IN tag to determine whether or not the user is logged in.
Syntax
<X-FC-LOGGED-IN>
Behaviour
Returns '1' if the user is logged in and returns '0' if the user is not logged in.
Context
All server parsed files.
X-FC-LANGUAGE
Use the X-FC-LANGUAGE tag to output the ISO code for the user's preferred language.
Syntax
<X-FC-LANGUAGE>
Context
All server parsed files.
X-FC-CHARSET
Use the X-FC-CHARSET tag to output the Multi Internet Mail Extension (MIME) - compatible character set name for the file.
Syntax
<X-FC-CHARSET>
Context
All server parsed files.
X-FC-BROWSER
Use the X-FC-BROWSER tag to gather information about the browser.
Syntax
<X-FC-BROWSER [NAME|OS|VERSION|LANGUAGE]>
Arguments
NAME
returns the name of the browser
OS
returns the type OS the browser is running on
VERSION
returns the version of the browser
LANGUAGE
return's the browser's language
Context
All server parsed files.
IS script global variables
Auth_TYPE
Use the AUTH_TYPE global variable to display the authentication method used to encode the user ID and password required to access the current page.
Note
This variable is either 'basic' or no value (for non-authenticated users).
DATE_GMT
Use the DATE_GMT global variable to display the server's date and time, according to GMT.
Note
The format can be controlled using the #config timefmt IS script command.
DATE_LOCAL
Use the DATE_LOCAL global variable to display the server's date and time, according its local time zone.
DOCUMENT_NAME
Use the DOCUMEENT_NAME global variable to display the filename of the current document.
DOCUMENT_URI
Use the DOCUMENT_URI global variable to display the URL for the current document.
HTTPS
Use the HTTPS global variable to display that HTTPS is being used.
Note
If HTTPS is being used, IS sets the value to 'on'.
Value type
flag
HTTPS_CIPHER
Use the HTTPS_CIPHER to show the cipher specification name (SSL/TLS cipherspec).
Syntax
HTTPS_CIPHER <string>
HTTPS_KEYSIZE
Use the HTTPS_KEYSIZE global variable to set the number of bits in the session key.
Syntax
HTTPS_KEYSIZE<number>
HTTPS_SECRETKEYSIZE
Use the HTTPS_SECRETKEYSIZE global variable to set the number of bits in the secret key.
Syntax
HTTPS_SECRETKEYSIZE <number>
HTTP_ACCEPT
Use the HTTP_ACCEPT global variable to display the file formats supported by the user agent (browser).
This depends on the browser.
HTTP_REFERER
Use the HTTP_REFERER global variable to display the URL of the HTML page that linked to the current page.
HTTP_USER_AGENT
Use the HTTP_USER_AGENT global variable to display information about the browser and the operating system it is running on.
Typical values
Netscape
Mozilla 4.08 {en}(Win98;1)
Microsoft Internet Explorer:
Mozilla 4.0 (compatible;MSIE4.0;Windows 98)
LAST_MODIFIED
Use the LAST_MODIFIED global variable to display the date on which the current document was last modified.
Note
The format can be controlled with config timefmt IS script command.
PATH_INFO
Use the PATH_INFO global variable to display the path of the current document, relative to the site root.
QUERY_STRING_UNESCAPED
Use the QUERY_STRING_UNESCAPED global variable to display the unescaped list of the URI parameters for this document.
REMOTE_ADDR
Use the REMOTE_ADDR global variable to display the IP address of the machine running the browser.
REMOTE_HOST
Use the REMOTE_HOST global variable to display the DNS host name of the machine the browser is running on.
Note
If there is no host name defined for the computer or the reverse DNS lookup fails, it displays the IP address.
REMOTE_USER
Use the REMOTE_USER global variable to display the remote user log in name, if the user is logged into your system.
SERVER_NAME
Use the SERVER_NAME global variable to display the name of the machine Internet Services is installed on.
SERVER_PORT
Use the SERVER_PORT global variable to display the HTTP port number as set in the HTTP port field.
Typical values
80
SERVER_PROTOCOL
Use the SERVER_PROTOCOL global variable to display the version of the protocol implemented on your server.
Typical values
HTTP/1.1
Value type
string
SERVER_SOFTWARE
Use the SERVER_SOFTWARE global variable to display the text FirstClass/(version #)
Typical values
FirstClass/5.9
SRVR_ERR_CODE
only valid in error templates
Use the SRVR_ERR_CODE IS script local variable to display the HTTP error code.
SRVR_ERR_JUMP
valid only n err202
Use the SRVR_ERR_JUMP local variable to output the URL of the message or forms present.
Example
The URL in the 'click here to return to URL'.
SRVR_ERR_JUMP_ARGS
valid only in err202
Use the SRVR_ERR_JUMP_ARGS IS script local variable to output the URL parameters for the jump URL. Used for calendar tasks and events.
SRVR_ERR_REASON
only valid in error templates
Use the SRVR_ERR_REASON IS script local variable to output the LANG string error message. The LANG string depends on the message (found in LANG.fc resources 7515 to 7522).
SRVR_ERR_RESULT
Use the SRVR_ERR_RESULT local variable to output the FirstClass error code.
Example
1081 - Not Found
1021 - Link Down
SSL_CIPHER
The same as HTTPS_CIPHER.
Syntax
SSL_CIPHER <string>
Value type
string
SSL_CLIENT_<x509>
Use the SSL_CLIENT <x509> to set the component of the client's DN.
Note
x509 is a component of a X.509 DN: C, ST, L, O, OU, CN, T, I, G, S, D, UID, Email.
Syntax
SSL_CLIENT <x509> <string>
SSL_CLIENT_CERT
Use the SSL_CLIENT_CERT to set the Base64-encoded client certificate.
Syntax
SSL_CLIENT_CERT <string>
SSL_CLIENT_CERT_CHAIN_n
Use the SSL_CLIENT_CERT_CHAINn to display the Base64-encoded certificates in the client certificate chain, where <x509> is a component of an x509 DN.
Value type
string
SSL_CLIENT_DN
Use the SSL_CLIENT_DN to set the DN in the client's certificate.
Syntax
SSL_CLIENT_DN <string>
SSL_CLIENT_I_<x509>
Use the SSL_CLIENT_I_<x509> global variable to set the component of the client's issuer's DN.
Syntax
SSL_CLIENT_I_<x509> <string>
SSL_CLIENT_I_CERT
The SSL_CLIENT_I_CERT IS script global variable is the PEM encoded certificate of the issuer of the client's certificate. For example, browser.
SSL_CLIENT_I_DN
Use the SSL_CLIENT_I_DN global variable to set the issuer DN of the client's certificate.
Syntax
SSL_CLIENT_I_DN <string>
Value type
string
SSL_PROTOCOL_VERSION
Self explanatory (2 or 3).
Syntax
SSL_PROTOCOL_VERSION <version>
Value type
string
SSL_SERVER_<x509>
Use the SSL_SERVER_<x509> global variable to display the component of server's DN.
Syntax
SSL_SERVER_<x509> <string>
SSL_SERVER_CERT
The SSL_SERVER_CERT IS script global variable is the PEM encoded server certificate.
SSL_SERVER_DN
Use the SSL_SERVER_DN global variable to display the issuer DN of the server's certificate.
Syntax
SSL_SERVER_DN <string>
Value type
string
SSL_SERVER_I_<x509>
Use the SSL_SERVER_I_<x509> global variable to display the component of the server's DN.
Syntax
SSL_SERVER_I_<x509><string>
SSL_SERVER_I_CERT
The SSL_SERVER_I_CERT IS script global variable is the PEM encoded certificate of the issuer of the server's certificate. For example, the certificate the VeriSign used to sign the server's certificate.
SSL_SERVER_I_DN
Use the SSL_SERVER_I_DN global variable to display the DN of the issuer of the server's certificate.
Syntax
SSL_SERVER_I_DN <string>
SSL_SSLEAY_VERSION<string>
Self explanatory ('OpenSSL 0.9.6 24 Sep 2000')
Syntax
SSL_SSLEAY_VERSION<string>
IS script commands
config
Use the config IS script command to control various aspects of the parsing.
Syntax
<!--#config errmsg="Value "-->
<!--#config sizefmt="Value "-->
<!--#config timefmt="Value "-->
<!--#config escapechars="Value "-->
Parameters
errmsg
This value is a message that is output if an error occurs while parsing the document.
sizefmt
This value sets the format to be used when outputting the size of a file. Valid values are:
• 'bytes' for a count in bytes
• 'abbrev' for a count in Kb (Kilobytes)
• MB (Megabytes)
timefmt
This value is a string to be used to format date/tiime values, in a format that is compatible with strftime. Specify an empty string to revert to the default timefmt string.
escapechars
This value is a string to be used to control which characters are escaped with the @escape character. The backslash, carriage return, and line feed characters (decimal 13 and 10) cannot be overridden with this string. Specify an empty string to revert to the default escapechars string.
Example
<!--#config errmsg="Custom error message" -->
<!--#config sizefmt="abbrev" -->
<!--#config timefmt="%H;%M;%S" -->
<!--#config escapechars="\\~#()" --><!-- \needs to be escaped -->
echo
Use the echo IS script command to output the value of a variable or the result of an expression into the HTTP stream.
Syntax
<!--#echo var="HTTP_USER_AGENT" -->
<!--#echo expr="@indexof ($HTTP_USER_AGENT, 'MSIE') -->
Parameters
var
The value is the name of the variable to output.
expr
The value is the expression to evaluate. The result is output. This is shorthand for a set/echo pair.
A variable can include standard variables, or ones assigned a value with the set IS script command. If the variable is unset, there is no output.
else
Use the else IS script command to control which parts of an HTML document are sent to the browser, based on runtime condition(s).
This command is optional, in any given 'if' block, but if usedit must occur only once after all 'if' and 'elif' commands, but before the 'endif' command.
Syntax
<!#else --> 'Apache, IS
Example
<!--#if expre="@indexof ($HTTP_USER_AGENT, 'MSIE')> -1" --> You are using Internet Explorer<br>
<!--#elif expr="@indexof ($HTTP_USER_AGENT, 'MOZILLA')>-1 && @indexof ($HTTP_USER_AGENT, 'compatible')==-1" --> You are using Netscape<br>
<!--#else-->You are using <!--#var="HTTP_USER_AGENT"--><br>
<!--#endif-->
Requirements(must be used with)
if
endif
endif
Use the endif IS script command to indicate the end of a conditional code block.
Syntax
<!#endif --> 'Apache, IS
Requirements(must be used with)
'if'
endwhile
Use the endwhile IS script command to indicate the end of a looped code block.
Syntax
<!--#endwhile-->
Requirements (must be used with)
while
exec
Use the exec IS script command to execute a CGI script.
Syntax
<!--#exec cgi="CGI script "-->
Parameters
cgi
The value is a CGI script to execute (relative vs absolute).
cmd
The value is a shell command to execute. This command is not supported by Internet Services.
Example
This page has been accessed <!--#exec cgi="/cgi-bin/counter.pl" -->
flastmod
Use the flastmod IS script command to output the last modification date of the current document, subject to the timefmt format specification date.
Syntax
<!--#flastmod file="path "-->
<!--#flastmod virtual="path "-->
Parameters
file
The value is the name of this document.
virtual
The value is a URL path to this document.
Example
This document is <!--#flastmod file="index.shtml"-->bytes
if
Use the if IS script command to control which parts of an HTML document are sent to the browser, based on runtime condition(s). These conditions are tested when a browser accesses the document.
Parameters
expr
If the result of this expression is non-zero, text following the 'if' command is sent to the browser. Otherwise, the text following the matching 'elif', 'else', or 'endif' commands is sent.
Syntax
<!--#if expr="expression "--> 'Apache, IS
Examples
<!--#if expr="@indexof ($HTTP_USER_AGENT,'MSIE')>-1" --> You are using Internet Explorer<br>
<!--#endif-->
Requirements(must be used with)
endif
include
Use the IS script command to include the contents of another document or file into the current file.
Syntax
<!--#include file="path "--> 'Apache, IS
<!--#include virtual="path "--> 'Apache, IS
Parameters
file
The value is a path relative to the folder containing the current document. It cannot contain ../ and it may not be an absolute path. The virtual attribute should be used instead of this one.
virtual
Tha value is a URL relative to the current document. The URL cannot contain a scheme or hostname, only a path and an optional query string. If it doesn't begin with a slash, then it is taken to be relative to the current document.
Example
<!--#include file="header.inc" -->
<!--#include virtual-"/.templates/buttonbar.shtml"-->
printenv
Use the printenv IS script command to output a listing of all existing variables and their values. This is generally only useful as a debugging aid.
Syntax
<!--#printenv--> 'Apache, IS
set
Use the set IS script command to set the value of a variable.
Syntax
<!--#set var"name "value="value" --> 'Apache, IS
<!--#set var"value "value="value" --> 'IS
<!--#set var"value "expr="expression" --> 'IS
<!--#set var"name "expr="expression" -->
Paremeters
var
The name of the variable to set.
value
The value to give to the variable.
expr
The result of this expression is assigned to the variable.
while
Use the while IS script command to send part of an HTML document to the browser, zero or more times, based on runtime conditions(s).
Syntax
<!--#while expr="expression"-->
Parameters
expr
If the result of this expression evaluates to 'true', text between the 'while' IS script command and the matching 'endwhile' IS script command is sent to the browser. Otherwise, the text following the matching 'endwhile' IS script command is sent.
Example
<!--#set var="Counter"value="11"-->
<!--#while expr="--$Counter>= 0"-->
<!--#echo var="Counter"-->...<br>
<!--#endwhile-->Blastoff!<br>
Requirements (must be used with)
endwhile
IS script functions
@escape
Use the @escape IS script function to return a copy of the argument with all 'special' characters preceeded with a backslash. The default set of special characters are \,",',$, and %.
See the 'config' IS script command **JUMP** for details on replacing the default special characters.
Syntax
@escape(string)
Arguments
string
see @upper
Example
<!--#set var="str" value="This is a #string\n, with \"characters\" that 'need' escaping: '"-->
str escaped
[This is a #string\n, with \"characters\" that \'need\' escaping: \']<br>
set custom escape characters
<!--#config escpaechars="#,:"-->
str escaped
[This is a \#string\n\, with "characters" that 'need' escaping\:']<br>
@indexof
Use the @indexof IS script function to return the location of the first occurance of the second argument within the first argument (in bytes).
If the second argument does not occur in the first argument, -1 is returned. There are three forms of this function:
First form
This form specifies a single character string or number as the second argument, and returns the location of the first occurance in first argument.
Second form
This form specifies a multicharacter string as the second argument.
Third form
This form accepts a regular expression as the second argument.
Syntax
@indexof (string, character)
@indexof (string, substring)
@indexof (string, regexp)
Arguments
string
see @upper
character
A style character to search for in the specified string.
substring
A subset to search for in the specified string.
regexp
A regular expression to search for in the specified string.
Example
<!--#set var="n" expr="@indexof ('abcdef012345', 'c')" -->
<!--n now contains "2" -->
<!--#set var="n" expr=@indexof (abcdef012345', 'ef01')"-->
<!--n now contains "4"-->
<!--#set var="n"expr="@indexof ('abcdef012345', '/ [Cc]/') "-->
<!--n now contains "2" -->
<!--#set var="n"expr="@indexof ('abcdef012345', 'z')"-->
<!--n now contains "-1" -->
@length
Use the @length IS script function to return the length of the argument in characters.
Syntax
@length(string)
Arguments
String
see @upper
Example
<!--#set var="len" expr='@length($name)"-->
<!--#if expr="$len <5"--> Please enter at least 5 characters<!--#endif-->
@lower
Use the @lower IS script function to return a copy of the argument with all ASCll alphabetic characters converted to lower case.
Syntax
@lower (string)
Arguments
string
see @upper
Example
<!--#set var="str" expr="@lower('This is a mixed case string')"-->
<!-- str now contains "this is a Mixed Case String" -->
@split
Use the @split IS script function to decode a separator delimited list.
The '@split' function parses its string argument for the specified separator and returns everything up to the first occurrence. If the separator does not occur in the string, the whole string is returned. If the string argument is an IS script variable the returned portion, plus the first (if any) occurrence of the separator, is removed from it.
Syntax
@split(string, 'separator')
Arguments
string
see @upper
separator
A character or string used to delimit entries in a list. Typical separators are semi-colon (;), comman (.), tab (\t), and linefeed (\h).
Example
<!--#set var="string1" value="value1;value2;value3"-->
<!--#set var="string2" expr="@split($string1,',)"-->
string1 now contains "value2;value3
string2 now contains "value1"
@substr
Use the @substr IS script function to extract a portion of a string.
Syntax
@substr(string, start, length)
Arguments
string
see @upper
start
The index where the desired sub string starts within the desired string. Starts at zero (0).
length
The length of the desired string.
Example
<!--#echo expr="@substr('abcdef',1,3)"--> Result: bcd
@upper
Use the @upper IS script function to return a copy of the argument with all ASCll alphabetic characters converted to upper case.
Syntax
@upper (string)
Arguments
string
Any string value can be a literal string, IS script variable (global or user defined), or an X-FC tag.
Note
If the string might be interpreted as a number, you must enclose it in a single quote, in order to ensure the correct functionality. For example, @upper('10)).
Example
<!--#set var="str" expr="@upper ('This is a Mixed Case String')"-->
<!-- str now contains "THIS IS A MIXED CASE STRING"-->
@URLescape
Use the @URLescape IS script function to encode a string as a URL.
Syntax
@URLescpate(string)
Arguments
string
see @upper
Example
<!--#echo expr="@URLescape('This is a #1 message')"-->
result: This%20is%20a%20%231%20message