From f418341e2bff3cf483710a56dfc29b19659a13f1 Mon Sep 17 00:00:00 2001 From: Matt Tucker Date: Thu, 1 Mar 2007 01:51:12 +0000 Subject: [PATCH] Documentation work. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@7330 b35dd754-fafc-0310-a699-88a17e54d16e --- documentation/connections.html | 69 +++++++++++++++++++++++++++++ documentation/extensions/intro.html | 22 ++++----- documentation/gettingstarted.html | 26 ++++++++--- documentation/index.html | 3 +- documentation/messaging.html | 3 +- documentation/overview.html | 10 ++--- 6 files changed, 108 insertions(+), 25 deletions(-) create mode 100644 documentation/connections.html diff --git a/documentation/connections.html b/documentation/connections.html new file mode 100644 index 000000000..2539dda35 --- /dev/null +++ b/documentation/connections.html @@ -0,0 +1,69 @@ + + + Smack: Connection Management - Jive Software + + + + + +
+ Smack: Connection Management +
+ +
+ « Table of Contents +
+ +

+ Creating a Connection +

+ +

+ The org.jivesoftware.smack.XMPPConnection class manages your connection to an XMPP + server. Two constructors are available. The first, XMPPConnection(String) takes + the server name you'd like to connect to as an argument. All default connection settings will + be used: +

+ + Alternatively, you can use the XMPPServer(ConnectionConfiguration) constructor to + specify advanced connection settings. Some of these settings include: + + + +

+ +

+ Connect and Disconnect +

+ + + + + +


+ +
+ Copyright © Jive Software 2002-2007 +
+ + + diff --git a/documentation/extensions/intro.html b/documentation/extensions/intro.html index f97de3e0e..cf923e67f 100644 --- a/documentation/extensions/intro.html +++ b/documentation/extensions/intro.html @@ -7,7 +7,7 @@
Smack Extensions Manual

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 @@ - + - + - + - + - + - + - + - + @@ -62,12 +62,12 @@ - + - +
NameJEP #DescriptionNameXEP #Description
Private DataJEP-49XEP-0049 Manages private data.
XHTML MessagesJEP-71XEP-0071 Allows send and receiving formatted messages using XHTML.
Message EventsJEP-22JEP-0022 Requests and responds to message events.
Data FormsJEP-4JEP-0004 Allows to gather data using Forms.
Multi User ChatJEP-45JEP-0045 Allows configuration of, participation in, and administration of individual text-based conference rooms.
Roster Item ExchangeJEP-93XEP-0093 Allows roster data to be shared between users.
Time ExchangeJEP-90XEP-0090 Allows local time information to be shared between users.
Service DiscoveryJEP-30XEP-0030 Allows to discover services in XMPP entities.
File TransferJEP-96XEP-0096 Transfer files between two users over XMPP.
diff --git a/documentation/gettingstarted.html b/documentation/gettingstarted.html index b2dfd1894..f9e2c2963 100644 --- a/documentation/gettingstarted.html +++ b/documentation/gettingstarted.html @@ -1,13 +1,13 @@ Smack: Getting Started - Jive Software -
-Getting Started With Smack +Smack: Getting Started
@@ -20,11 +20,24 @@ important classes and concepts.

-Requirements +JAR Files and Requirements

-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: + +

@@ -48,7 +61,8 @@ conn2.connect();

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 @@