Mac-based Software for Conferencing, Guestbooks, Site Feedback, etc.

CONFERWEB USER GUIDE
ConferWeb Home Page


Software, documentation and data files copyright 1998-2004 Brian Johnson, Department of Architecture, University of Washington.

STANDARD CONFIGURATIONS

    Bulletin Board Configuration

    Guestbook Configuration

    Index.html
    caveat.html (optional)
    (thread files)
    NewItem.tmpl (optional)
    ref_link.tmpl (optional)
    response.tmpl (optional)
    datetime.tmpl (optional)
    password.acgi (optional)
    filter.words (optional)
    confer.mail-config (optional)
    newitem_email.tmpl (optional)
    response_email.tmpl (optional)
    Guestbook.html
    caveat.html (optional)
    response.tmpl (optional)
    datetime.tmpl (optional)
    password.acgi (optional)
    filter.words (optional)
    confer.mail-config (optional)
    newitem_email.tmpl (optional)
    response_email.tmpl (optional)

Purpose of each file

Index.html
The disucssion Index file. Usually introduces the larger context, spells out rules for bulletin board use (for public discussions), etc. It must also contain an "insertion point" where new threads are listed. The page may include, or may link to, an HTML form with which new threads are created.

caveat.html
A short description of how to use the system, including information on how to properly configure your browser's file caching behavior so that services such as ConferWeb work correctly.

Guestbook.html
Basically, a single thread file to which updates are posted as needed. Useful for Guestbooks, comment forms, announcement pages, etc.

(thread files)
Each time a new topic thread is created, it is given a unique numerical file name. The contents of the file are initially set by the NewItem.tmpl file and any substitution tags which it contains, after being replaced by values from the form used to initiate creation of the thread.

The NewItem.tmpl file usually provides a "response" form which may then be used to add response entries to the thread. Each of these is built from the response.tmpl file, any substitution tags it contains, and the user's entries in the response form.

NewItem.tmpl
A template file containing both HTML and ConferWeb "tags". This file is not intended to be served or browsed. When a new Thread is created by ConferWeb, the NewItem.tmpl file is used to establish the initial contents for the thread. After replacing the ConferWeb tags with data from the user's submission, the thread file is saved to the discussion folder and linked to Index.html. If no file is found, the following internal template is used to format the response:

    <h1><Confer_Topic></h1><Confer_Cdate><h3> <Confer_By></h3><blockquote><Confer_Text></blockquote><hr> Response form not available without NewItem template.

(This file name may not be changed.)

ref_link.tmpl
A template used to format the HTML being added to the Index to form the link to a new Thread. This may be fairly simple, or moderately complex. Again, it consists of standard HTML and ConferWeb tags which are replaced during operation. If no file is found, the following internal template is used to format the response:

    <!--CW_RESPONSE--><li><b><a href="<Confer_Thread>"><Confer_Topic></a></b> - <Confer_Cdate> - <Confer_By><br>

(This file name may not be changed.)

response.tmpl
A template used to format the HTML being added to a Thread when a visitor posts a response to the Thread discussion. If no file is found, the following internal template is used to format the response:

    <!--CW_RESPONSE--> <B><Confer_By></b> - (<Confer_Client>) - <Confer_Cdate> <br> <Confer_Text><p>

(This file name may not be changed.)

datetime.tmpl
A template file containing a formatting string for timestamps. If the associated DATE/TIME OSAX, is not installed, ConferWeb uses the current system time format for time stamps. If the DATE/TIME OSAX is installed, but no datetime.tmpl file file is found, the following format is used for time stamps:

    %m/%d/%y@%H:%M

(This file name may not be changed.)

password.acgi
A text file containing the password for the conference or guestbook. The name is used to render the file "unservable" since any link to the file causes the server to attempt to launch it as an application, which fails.
(This file name may not be changed.)

filter.words
A text file containing a list of words, one per line, without leading or trailing spaces. User names, topics, and discussion text is filtered against this list of words and illegal words are removed from the user input before it is processed futher. AUX input is NOT filtered. If you are trying to suppress HTML entries, listing simply "<" and ">" will do it. for tags which somtimes occur with modifiers, try just the first part of the tag, as in "<a" or "<font" or just "javascript". This will remove only part of the tag, which may result in unsightly input, but it will prevent the undesirable side-effects.

If "filter.words" is not present no word filtering occurs.
(This file name may not be changed.)

confer.mail-config
A text file which establishes the remote mail server and the email address "from" which all ConferWeb email will seem to originate. While optional in the case of individual conferences, a "confer.mail-config" file, providing default settings, is required in the same folder as confer.acgi in order to enable email sending.
(This file name may not be changed.)

newitem_email.tmpl
A text file which establishes contents of the email notification generated when a new thread, or topic, is added to a discussion. In addition to static text, ConferWeb substitution tags may appear in the template. If no file is found, the following internal template is used to construct the notice:

    [CW-NewThread] <Confer_Title>
    By <Confer_Username><Confer_By>
    At:<Confer_Path>
    <Confer_Text>

(This file name may not be changed.)

response_email.tmpl
A text file which determines the contents of the email notification generated a reply or response is posted to a discussion topic or thread. In addition to static text, ConferWeb substitution tags may appear in the template. If no file is found, the following internal template is used to construct the notice:

    [CW-Post] <Confer_Title>
    By <Confer_Username><Confer_By>
    <Confer_Path>
    <Confer_Text>

(This file name may not be changed.)

 


©1995-2004 Brian R. Johnson, Dept. of Architecture, University of Washington