The XMPP protocol includes a base protocol and many optional extensions
- typically documented as "JEP's". Smack provides the org.jivesoftware.smack
+ typically documented as "XEP's". Smack provides the org.jivesoftware.smack
package for the core XMPP protocol, and the org.jivesoftware.smackx package for
many of the protocol extensions.
@@ -18,41 +18,41 @@
@@ -20,11 +20,24 @@ important classes and concepts.
-The only requirement for Smack is JDK 1.5 or later. An XML parser is embedded in the
-smack.jar file and no other third party libraries are required.
+Smack is meant to be easily embedded into any existing JDK 1.5 or later Java application.
+It has no external dependencies (except for the Jingle voice chat functionality) and is optimized
+to be as small as possible. The library ships as several JAR files to provide more flexibility
+over which features applications require:
+
+
+ - smack.jar -- provides core XMPP functionality and is the only required
+ library. All XMPP features that are part of the XMPP RFCs are included.
+ - smackx.jar -- support for many of the the extensions (XEPs) defined
+ by the XMPP Standards Foundation, including multi-user chat, file transfer, user search, etc.
+ The extensions are documented in the extensions manual.
+ - smackx-debug.jar -- an enhanced GUI debugger for protocol traffic. It will
+ automatically be used when found in the classpath and when debugging
+ is enabled.
+
Note that maximum security will be used when connecting to the server by default (and when possible),
including use of TLS encryption. The ConnectionConfiguration class provides advanced control
- over the connection created, such as the ability to disable or require encryption.
+ over the connection created, such as the ability to disable or require encryption. See
+
Connection Management for full details.
Once you've created a connection, you should login using a username and password
with the XMPPConnection.login(String username, String password) method.
diff --git a/documentation/index.html b/documentation/index.html
index 2bfcdab7b..4fba6b56c 100644
--- a/documentation/index.html
+++ b/documentation/index.html
@@ -15,7 +15,8 @@
- Overview
- Getting Started Guide
-
- Messaging Basics
+
- Managing Connections
+ - Messaging Basics
- Roster and Presence
- Processing Incoming Packets
- Provider Architecture
diff --git a/documentation/messaging.html b/documentation/messaging.html
index bf3856d15..bb98ab344 100644
--- a/documentation/messaging.html
+++ b/documentation/messaging.html
@@ -29,8 +29,7 @@ A chat creates a new thread of messages (using a thread ID) between two users. T
following code snippet demonstrates how to create a new Chat with a user and then send
them a text message:
-
// Assume we've created an XMPPConnection name
- "connection".
+// Assume we've created an XMPPConnection name "connection".
ChatManager chatmanager = connection.getChatManager();
Chat newChat = chatmanager.createChat("jsmith@jivesoftware.com", new MessageListener() {
diff --git a/documentation/overview.html b/documentation/overview.html
index 01ae354bf..ac33e9ad9 100644
--- a/documentation/overview.html
+++ b/documentation/overview.html
@@ -16,8 +16,8 @@ Smack Overview
-Smack is a library for communicating with XMPP servers to perform
-instant messaging and chat.
+Smack is a library for communicating with XMPP servers to perform real-time communications, including
+instant messaging and group chat.
-XMPP (eXtensible Messaging and Presence Protocol) is an open, XML based protocol
-making it's way through the IETF approval process under the guidance of the
-Jabber Software Foundation (http://www.jabber.org).
+XMPP (eXtensible Messaging and Presence Protocol) is an open protocol standardized by the IETF
+and supported and extended by the XMPP Standards Foundation
+((http://www.xmpp.org).