Jabber Applet Users Guide
This users guide is organized as follows:
Starting the Applet
Starting the Applet
Starting the applet requires accessing an html page that is located on a Jabber Server machine. A user then (if not already registered) registers with the Jabber Server and logs on.
Loading the applet is accomplished by accessing an html page that containing the Jabber Applet load instructions (described in the installation section).
Connecting to the Server consists of registering (1st time only) and logging on. Whenever starting the applet you will be given a logon page. If you don't currently have an account on the Jabber Server where the applet was loaded you'll need to create an account using the registration/New Account button. Completing the Registration/New Account information allows you to logon to the specified Jabber Server with the Jabber Applet (or any other Jabber Client) in the future.
- Registration/New Account when using the applet requires minimal input (username and password). Using Applet registration will register the user with the Jabber Server that the applet has connected to (using the xmlhostname parameter). The Jabber Server being registered to is the same Server machine the applet was loaded from. ie. If the Jabber Applet was retreived by accessing an html page served from the jabber.org web server then the user can only regiseter with the jabber.org Jabber Server.
- Logon uses the xmlhostname parameter and the host computer during it's logon processing. The jabber server is not a user input (as it is with installable clients).
The applet will attempt to logon to the local jabber server. Attempts to logon to remote servers will be unsuccessful due to browser/applet 'sandbox' issues. In other words an applet delivered from the jabber.com site must logon to the jabber.com jabber server (not the jabber.org server).
During initial logon (if the server is busy) as each communication step is complete a Done flag will be shown next to the status display.
Following the initial communication setup
(a) first time users will see brief instructions on what to do next OR
(b) a roster/contact list will be displayed.
The Contact List (or Roster) is the primary visual tool used to determine someones online status (presence). Following a successful logon your contact list will be displayed. The toolbar at the top of the display allows the user to perform administrative type functions to their contact list. The contact list consists of users (and gateways) you have 'subscribed' to. These contacts are organized in groups you've created. Selecting (double-clicking) a contact in the list starts a chat session with a user.
Contact List Display
The Contact List consists of groups. Each Group has one or more Contacts.
Each of the Contacts has a presence/status associated with him/her. No status corresponds to offline.
- Groups are displayed with '+' or '-' preceding the group name. When a '-' precedes the group name the group is expanded (all contacts in the list are shown). When a '+' precedes the group name the group is minimized with a group status displayed in the form (x of y), where x = number of users online and y = total number of users in that group. Double-clicking the group name will change the group display +/-. If the 'Show Online Users' option is set only those contacts that are currently signed on will be displayed.
Groups fall into one of 3 different types:
- All groups you've created while organizing your subscribed users
- A group containing all gateways (aim, icq, msn, yahoo) you've subscribed to (not shown in the sample)
- All GroupChat rooms you've joined. GroupChat type groups are automatically given names consisting of (a) the groupchat/room name, (b) an @ separator and (c) the groupchat server name.
Status is displayed corresponding to a contact. The status of a contact is displayed between brackets <status>. When there is no <status> indicator next to a contact the contact is not logged on. A Jabber Applet users status can be set to Available or Away. When a user sets Status=Away the top toolbar will indicate the current status prompting the user to set status back to Available. Clicking on the toolbar will automatically change the status back to Available. Note: changing status in this manner changes only the displayed status. If a user wants messages to be store by the server until a later date/time he/she must logoff.
Nickname is used to give a friendly name to a contact. Contacts are tracked by the jabber system via JIDs (Jabber IDs). A JID consists of a unique username/server combination. The displayed nickname allows you to give a friendly name to the JID.
Contact List Administration
Your Contact List is administered by your subscribing to other people. It is also automatically administered for you in the case of GroupChat.
- Add Contact adds a user to your contact list. When the user is added a <Pending> status will be shown next to the nickname in your contact list.When the user confirms your contact list add the <Pending> status will change.3 fields are used when adding a user
1. Jabber ID.This field is an ID similar to an email address. The format is username followed by "@" followed by Jabber Server.An example of a jabber.com user would be firstname.lastname@example.org.If this user was at jabber.org the address would be email@example.com.
2. Nickname. This field is a nickname/friendly name.It may contain numbers, characters and spaces.
3. Group.This field allows you to group the users in your contact list. If the group doesn't already exist it will be automatically created when the user is added.
A contact is added to your contact list (a) using the toolbar User/Add Contact option or (b) a user subscribes to your presence and you accept his/her subscription invitation.
Note: When someone is adding you to his/her contact list you will be shown a similar form with the JabberID automatically filled. Pressing <Ok> will automatically add the user to your contact list, pressing <Cancel> will reject the users add.
- Edit Contact allows you to modify the Nickname and/or Group associated with a user. After pressing <Ok> the users nickname and group will automatically be updated. The Edit Contact function is accessable via the toolbar User/Edit Contact option.
- Remove Contact allows you to remove someone from your contact list. The Remove contact function is accessable via the toolbar User/Remove Contact option.
- GroupChat Contacts will automatically be added to your contact list when you join a groupchat. As members join or leave the groupchat room they are automatically added or removed from your contact list. When you leave the groupchat room (close the groupchat chat window) the groupchat room and all its member contacts will be removed from your contact list. A GroupChat room is joined (a) using the toolbar User/Join Group Chat option or (b) when you accept an invitation to a groupchat.
A JabberApplet Instant Messaging (or GroupChat) session is a basic chat session with history (for that current chat session).
Chat Session Window - As you chat the history of your current chat session is displayed in the chat window. As part of the chat history any status changes made by the person you're chatting with will be displayed in the chat window. If/when you change your status this status change will be broadcast to others you are chatting with. Recording of chat sessions is accomplished by pressing the <record> button during a chat followed by pressing the stop record button when recording should be stopped. When recording has been halted a window containing the recorded text will be displayed. You can cut and paste from this window to your favorite editor to print and/or save the recorded session.
- Starting Chat Window
- One-On-One Chat
(1) double-click on a contact in your list or
(2) selecting a contact from your list followed by using the toolbar/Send Message option or
(3) receiving a message from a user
(1) selecting User/GroupChat from the toolbar or
(2) receiving an invite to a Groupchat (which you accept)
There are several minor differences between a One-On-One chat window and a GroupChat window:
- One-On-One chat headers contains the nickname of the contact your chatting with vs the GroupChat header which contains the room name.
- One-On-One chat header has an additional 'is replying...' indicator when the person your chatting with starts to reply.
- GroupChat has an <invite> button. Pressing the <Invite> button gives you a list of members in your Contact List to invite. Selecting a user to invite and pressing the <ok> button will send an invitation to that contact. If the contact accepts the invitation he/she will enter the GroupChat room.
A typical One-On-One chat session may look similar to the snapshot below. Each member of the conversation has his/her nickname displayed in a unique color. System messages and member status changes are displayed in green.
A typical GroupChat session may look similar to the snapshot below. Member nicknames, system messages and member status changes are displayed the same as in One-On-One chat sessions.