Attaching HTML Chat Capabilities to an Entry

If your administrators implemented this customization, you can attach an HTML-based chat capabilitity to a topic, document, URL, or survey. In this way, you can combine real-time conversation with offline discussion chains (topics, documents, and replies). This flexible environment can assist in the reviewing of documents, having online meetings, checking with teammates before posting additional entries, and other tasks that require dynamic interaction.

This chat feature allows people to participate in real-time discussions without having to obtain additional client or server software; this feature works within the context of the SiteScape Forum and your web browser. Since this chat feature is based on HTML, it allows people to chat across firewalls, which can require additional configuration work when using IRC. In addition to real-time chatting, this customization provides readers with an option for reading the transcript of the chat session, which is saved to an HTML file on the server and can exist long after the real-time conversation ends.

The first step in the process is to create the discussion topic, document, URL, or survey topic about which you want to chat. Then, view the entry. Notice that the Entry Tools menu includes the item, "Enable this entry for on-line Chat," as follows:

          
Example          Note: The following is an illustration only.


              

When you choose the "Enable this entry for on-line Chat," you see a page similar to the following:

          
Example          Note: The following is an illustration only.

-----------------------------------------------
Summit    Next Unseen  List Unseen  Search    Previous Topic  Next Topic    Help            

  Widget Version 3.5 Project Discussions

   14. Brainstorming for the next version of the product.

      
  AVF Administrator
Posted on 07/16/98 01:17 PM
      
Let's take a half hour to have an online brainstorming session.
      
  • Open this entry for Chat
To view or participate in the chat session, click on this hyperlink.

[View top of page]


              

It is often a good idea to specify in the topic (or document profile) a date and time for the chat session, so that people know when to participate. At the specified time, users view this topic and click on the Open this entry for Chat hyperlink to participate in the real-time discussion.

When a user clicks on the Open this entry for Chat hyperlink, the Forum displays the chat page for that entry. The Chat page includes two frames. The top frame enables you to control how you view and participate in the chat session. The bottom frame displays the contents of the chat conversation (the transcript).

The following is an example of the top frame of the chat window:

          
Example          Note: The following is an illustration only.

On-line Chat - "Brainstorming for the next version of the product."

                      
View
all entries
the last 20 entries


              

For basic interaction, type your comment in the second text box (the one with no text in it). When you are finished, click on the Submit button, and your comment appears in the bottom frame.

The following list describes the text boxes, buttons, and radio buttons shown in the previous example:

The Top Text Area
Is the title of the comment to which you are replying (optional). It initially contains the instructional text, "To reply to a specific entry, click its title."

In the bottom frame, if you want to reply to someone's comment, click on that comment's hyperlinked username, which is its title. (The next example shows you the bottom frame with its hyperlinks.) When you do this, the username and the beginning of the comment to which you want to respond appear in this top text area. In this way, your comment reflects that it is replying to someone else's comment.

Do not position the cursor in this text box and type. The Forum ignores any typed data in this box.

The Bottom Text Area
Is the area where you enter your comment.

The Submit Button
Submits your comment, so that it appears in the bottom frame, where it is viewable by others in the chat session.

The Reset Button
Clears the two text boxes so that you can start entering your comment again.

The Close Button
Closes the chat window and returns you to the displayed entry. (Other users may continue to use the chat session after you close your window and stop participating.)

The Pause Button
Pauses the window, so that the chat transcript in the bottom frame is not updated.

After you click on this button, a Resume button appears in its place. To update the bottom frame with all comments entered while you paused the window, click on the Resume button.

The Participants Button
Displays a window that lists all users currently viewing the chat session for this entry.

The View Radio Buttons
Determines the size of the bottom frame.

If the chat session is long (requiring a scroll bar in the bottom frame) and if you prefer to view information in smaller chunks, click on the "the last 20 entries" radio button.

The following is an example of a chat transcript located in the bottom frame of the chat window, with the most recently entered comments appearing at the bottom of the window:

          
Example          Note: The following is an illustration only.

13:25 - Jack
Let's start the discussion!
13:26 - Sally     (Re: 13:25 - Jack 'Let's start the discussion!...')
Okay
13:27 - Jack
I think we need to do whatever we can to shorten the shipping cycle of the product.
13:27 - Sam
I think that we need to add better error tracing.
13:28 - Sally      (Re: 13:27 - Jack 'I think we need to do...')
I know what you mean. The product "disappears" from the public's view for a year. That's too long.
13:29 - Loretta     (Re: 13:27 - Jack 'I think we need to do...')
I think that 6 months is about right.
13:29 - Jack      (Re: 13:29 - Loretta 'I think that 6 months is...')
I think that 9 is more reasonable.
13:30 - Sally      (Re: 13:27 - Sam 'I think that we need to...')
What type of error tracing are you thinking of?


              

At the top of the chat-transcript frame, Jack entered a comment, and Sally replied to that comment. Let's take a step-by-step look at how to enter and reply to comments. Here is an example of the the top frame displayed in Jack's browser just before he entered his comment:

          
Example          Note: The following is an illustration only.

On-line Chat - "Brainstorming for the next version of the product."

                      
View
all entries
the last 20 entries


              

After Jack clicks on the Submit button, the following appears in the chat-transcript frame of everyone viewing and participating in the chat session:

          
Example          Note: The following is an illustration only.

13:25 - Jack
Let's start the discussion!


              

When Sally sees this comment in the chat-transcript frame of her browser, she clicks on the 13:25 - Jack hyperlink in order to reply to it. The following is the top frame of Sally's browser as she replies to Jack's comment:

          
Example          Note: The following is an illustration only.

On-line Chat - "Brainstorming for the next version of the product."

                      
View
all entries
the last 20 entries


              

When Sally clicks on the Submit button, the following appears in the chat-transcript frame of everyone who is viewing or participating in the chat session:

          
Example          Note: The following is an illustration only.

13:25 - Jack
Let's start the discussion!
13:26 - Sally     (Re: 13:25 - Jack 'Let's start the discussion!...')
Okay


              

If you click on the Close button in the top frame, the Forum displays the entry's page. As users participate in a chat session, the Forum maintains a transcript of that session. Once you return to the entry's displayed page, the Forum displays additional links that allow you to view the transcript in different formats. Consider the following example:

          
Example          Note: The following is an illustration only.

-----------------------------------------------
Summit    Next Unseen  List Unseen  Search    Previous Topic  Next Topic    Help            

  Widget Version 3.5 Project Discussions

   14. Brainstorming for the next version of the product.

      
  AVF Administrator
Posted on 07/16/98 01:17 PM
      
Let's take a half hour to have an online brainstorming session.
      
  • Open this entry for Chat
  • View the transcript ordered by time
  • View the transcript ordered by threads
      


Attachments:
       chat_transcript.htm

[View top of page]


              

The View the transcript ordered by time hyperlink displays the chat comments in the same format as the transcript that is displayed in the bottom frame of the chat page. When you view the transcript this way, you cannot enter new comments or reply to other's comments; you can only read comments that have been made up until the point you click on the hyperlink. Using this hyperlink, you can review the transcript of the chat session long after it is over.

The View the transcript ordered by threads hyperlink displays the transcript and places replies under the corresponding comment. This format is similar to the topic-and-reply format of the docshare application, and it can make it easier to follow the "thread" of the conversation. The following is an example of the transcript from the previous examples ordered by threads:

          
Example          Note: The following is an illustration only.

1)  13:25 - Jack
Let's start the discussion!
      13:26 - Sally     (Re: 13:25 - Jack 'Let's start the discussion!...')
Okay
2)  13:27 - Jack
I think we need to do whatever we can to shorten the shipping cycle of the product.
      13:28 - Sally     (Re: 13:27 - Jack 'I think we need to do...')
I know what you mean. The product "disappears" from the public's view for a year. That's too long.
      13:29 - Loretta     (Re: 13:27 - Jack 'I think we need to do...')
I think that 6 months is about right.
      13:29 - Jack     (Re: 13:29 - Loretta 'I think that 6 months is...')
I think that 9 is more reasonable.
3)  13:27 - Sam
I think that we need to add better error tracing.
      13:30 - Sally     (Re: 13:27 - Sam 'I think that we need to...')
What type of error tracing are you thinking of?


              

To end the chat session, view the entry, and choose the "Disable this entry for on-line Chat" menu item. After you disable chat, the entry appears as follows:

          
Example          Note: The following is an illustration only.

-----------------------------------------------
Summit    Next Unseen  List Unseen  Search    Previous Topic  Next Topic    Help            

  Widget Version 3.5 Project Discussions

   14. Brainstorming for the next version of the product.

      
  AVF Administrator
Posted on 07/16/98 01:17 PM
      
Let's take a half hour to have an online brainstorming session.
      
  • View the transcript ordered by time
  • View the transcript ordered by threads
      


Attachments:
       chat_transcript.htm

[View top of page]


              

The Forum removes the Open this entry for Chat hyperlink; the transcript hyperlinks remain for future reference.

If you once again enable this entry for chat, the Forum places comments from the transcript into the bottom frame of the chat page, and the conversation continues from the point at which it was disabled. If you want to clear the chat transcript to create a "fresh start," use the Delete menu item to delete the chat_transcript.htm attachment file. After you do this, the Chat page appears with an empty transcript frame.