From 3e4473c6b8bebc819b794ff3ea151f530395fc97 Mon Sep 17 00:00:00 2001 From: Matt Tucker Date: Tue, 19 Aug 2003 13:22:31 +0000 Subject: [PATCH] Minor tweaks. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2038 b35dd754-fafc-0310-a699-88a17e54d16e --- documentation/gettingstarted.html | 19 +++++++++++-------- documentation/overview.html | 8 ++++++++ documentation/processing.html | 5 +++-- documentation/roster.html | 7 ++++++- 4 files changed, 28 insertions(+), 11 deletions(-) diff --git a/documentation/gettingstarted.html b/documentation/gettingstarted.html index 2997af5e4..04069aef3 100644 --- a/documentation/gettingstarted.html +++ b/documentation/gettingstarted.html @@ -59,10 +59,13 @@ new Chat or GroupChat objects.

Working with the Roster

+The roster lets you keep track of the availability (presence) of other users. Users +can be organized into groups such as "Friends" and "Co-workers", and then you +discover whether each user is online or offline.

-Retrieve a roster using the XMPPConnection.getRoster() method. The roster +Retrieve the roster using the XMPPConnection.getRoster() method. The roster class allows you to find all the roster entries, the groups they belong to, and the -current presence status each entry. +current presence status of each entry.

Reading and Writing Packets @@ -70,12 +73,12 @@ Reading and Writing Packets Each message to the XMPP server from a client is called a packet and is sent as XML. The org.jivesoftware.smack.packet package contains -classes that encapsulate the different packet types allowed by XMPP (message, -presence, and IQ). Classes such as Chat and GroupChat +classes that encapsulate the three different basic packet types allowed by +XMPP (message, presence, and IQ). Classes such as Chat and GroupChat provide higher-level constructs that manage creating and sending packets automatically, but you can also create and send packets directly. Below -is a code example for changing our presence to let people know we're unavailable -because we're "out fishing":

+is a code example for changing your presence to let people know you're unavailable +and "out fishing":

@@ -94,8 +97,8 @@ while a packet collector has a result queue of packets that you can do
 polling and blocking operations on. So, a packet listener is useful when
 you want to take some action whenever a packet happens to come in, while a
 packet collector is useful when you want to wait for a specific packet
-to come through. Packet collectors and listeners can be created using the
-connection object.
+to arrive. Packet collectors and listeners can be created using an
+XMPPConnection instance.
 
 
 

diff --git a/documentation/overview.html b/documentation/overview.html
index c23d9104e..76ec373eb 100644
--- a/documentation/overview.html
+++ b/documentation/overview.html
@@ -57,7 +57,15 @@ Jabber Software Foundation (http://www.jabber.or
 For a good overview of the protocol, read the first chapter of Instant Messaging
 in Java, available free at 
 http://www.jivesoftware.com/products/messenger/book/
+ 
+

+How To Use This Documentation
+

 
+This documentation assumes that you're already familiar with the main features of XMPP
+instant messaging. It's also highly recommended that you open the Javadoc API guide and
+use that as a reference while reading through this documentation.
+ 
 



 

 Copyright © Jive Software 2002-2003
diff --git a/documentation/processing.html b/documentation/processing.html
index 9534a6b31..6aeaa24e0 100644
--- a/documentation/processing.html
+++ b/documentation/processing.html
@@ -27,7 +27,7 @@ A packet listener is used for event style programming, while a packet collector
 result queue of packets that you can do polling and blocking operations on. So, a packet 
 listener is useful when you want to take some action whenever a packet happens to come in, 
 while a packet collector is useful when you want to wait for a specific packet to come 
-through. Packet collectors and listeners can be created using an XMPPConnection object.

+arrive. Packet collectors and listeners can be created using an XMPPConnection instance.

 	
 The org.jivesoftware.smack.filter.PacketFilter interface determines which
 specific packets will be delivered to a PacketCollector or PacketListener.
@@ -76,8 +76,9 @@ to the PacketFilter interface. The default set of filters includes:
 	
  •  NotFilter -- implements the logical NOT operation on a filter.
 
 
-


    
 
+
+


    
 
    
 Copyright © Jive Software 2002-2003
 
    
diff --git a/documentation/roster.html b/documentation/roster.html
index fa4a654cb..7c88df07d 100644
--- a/documentation/roster.html
+++ b/documentation/roster.html
@@ -16,7 +16,12 @@ Roster and Presence
 
 
    
 
-Content to be added.
+The roster lets you keep track of the availability (presence) of other users. Users
+can be organized into groups such as "Friends" and "Co-workers", and then you
+discover whether each user is online or offline.
    
+
+A Roster instance is obtained using the XMPPConnection.getRoster()
+method, but only after