diff --git a/build.gradle b/build.gradle index 78cb47e0e..a5ad8a99c 100644 --- a/build.gradle +++ b/build.gradle @@ -6,7 +6,7 @@ buildscript { maven { url 'http://dl.bintray.com/content/aalmiray/kordamp' } } dependencies { - classpath 'org.kordamp:markdown-gradle-plugin:0.1.1' + classpath 'org.kordamp:markdown-gradle-plugin:1.0.0' classpath 'org.kordamp.gradle:clirr-gradle-plugin:0.1.0' } } diff --git a/documentation/README.md b/documentation/README.md new file mode 120000 index 000000000..dd0ea36c8 --- /dev/null +++ b/documentation/README.md @@ -0,0 +1 @@ +index.md \ No newline at end of file diff --git a/documentation/connections.md b/documentation/connections.md index aad264873..c53ba16b7 100644 --- a/documentation/connections.md +++ b/documentation/connections.md @@ -1,7 +1,7 @@ Smack: XMPPConnection Management ================================ -[Back](index.html) +[Back](index.md) Creating a Connection --------------------- diff --git a/documentation/debugging.md b/documentation/debugging.md index 800b15afc..41f236172 100644 --- a/documentation/debugging.md +++ b/documentation/debugging.md @@ -1,7 +1,7 @@ Debugging with Smack ==================== -[Back](index.html) +[Back](index.md) Smack includes two built-in debugging consoles that will let you track all XML traffic between the client and server. A lite debugger and an diff --git a/documentation/extensions/index.md b/documentation/extensions/index.md index da63d59bd..49c4cefc9 100644 --- a/documentation/extensions/index.md +++ b/documentation/extensions/index.md @@ -14,7 +14,7 @@ Currently supported XEPs of smack-tcp | Name | XEP | Description | |---------------------------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------| -| [Stream Management](streammanagement.html) | [XEP-0198](http://xmpp.org/extensions/xep-0198.html) | Allows active management of an XML Stream between two XMPP entities (stanza acknowledgement, stream resumption). | +| [Stream Management](streammanagement.md) | [XEP-0198](http://xmpp.org/extensions/xep-0198.html) | Allows active management of an XML Stream between two XMPP entities (stanza acknowledgement, stream resumption). | Smack Extensions and currently supported XEPs by Smack (smack-extensions) @@ -22,32 +22,32 @@ Smack Extensions and currently supported XEPs by Smack (smack-extensions) | Name | XEP | Description | |---------------------------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------| -| [Data Forms](dataforms.html) | [XEP-0004](http://xmpp.org/extensions/xep-0004.html) | Allows to gather data using Forms. | +| [Data Forms](dataforms.md) | [XEP-0004](http://xmpp.org/extensions/xep-0004.html) | Allows to gather data using Forms. | | Last Activity | [XEP-0012](http://xmpp.org/extensions/xep-0012.html) | Communicating information about the last activity associated with an XMPP entity. | | Flexible Offline Message Retrieval | [XEP-0013](http://xmpp.org/extensions/xep-0013.html) | Extension for flexible, POP3-like handling of offline messages. | -| [Privacy Lists](privacy.html) | [XEP-0016](http://xmpp.org/extensions/xep-0016.html) | Enabling or disabling communication with other entities. | -| [Service Discovery](disco.html) | [XEP-0030](http://xmpp.org/extensions/xep-0030.html) | Allows to discover services in XMPP entities. | +| [Privacy Lists](privacy.md) | [XEP-0016](http://xmpp.org/extensions/xep-0016.html) | Enabling or disabling communication with other entities. | +| [Service Discovery](disco.md) | [XEP-0030](http://xmpp.org/extensions/xep-0030.html) | Allows to discover services in XMPP entities. | | Extended Stanza Addressing | [XEP-0033](http://xmpp.org/extensions/xep-0033.html) | Allows to include headers in stanzas in order to specifiy multiple recipients or sub-addresses. | -| [Multi User Chat](muc.html) | [XEP-0045](http://xmpp.org/extensions/xep-0045.html) | Allows configuration of, participation in, and administration of individual text-based conference rooms. | +| [Multi User Chat](muc.md) | [XEP-0045](http://xmpp.org/extensions/xep-0045.html) | Allows configuration of, participation in, and administration of individual text-based conference rooms. | | In-Band Bytestreams | [XEP-0047](http://xmpp.org/extensions/xep-0047.html) | Enables any two entities to establish a one-to-one bytestream between themselves using plain XMPP. | | Bookmarks | [XEP-0048](http://xmpp.org/extensions/xep-0048.html) | Bookmarks, for e.g. MUC and web pages. | -| [Private Data](privatedata.html) | [XEP-0049](http://xmpp.org/extensions/xep-0049.html) | Manages private data. | +| [Private Data](privatedata.md) | [XEP-0049](http://xmpp.org/extensions/xep-0049.html) | Manages private data. | | Ad-Hoc Commands | [XEP-0050](http://xmpp.org/extensions/xep-0050.html) | Advertising and executing application-specific commands. | | vcard-temp | [XEP-0054](http://xmpp.org/extensions/xep-0054.html) | The vCard-XML format currently in use. | | Jabber Search | [XEP-0055](http://xmpp.org/extensions/xep-0055.html) | Search information repositories on the XMPP network. | | Result Set Management | [XEP-0059](http://xmpp.org/extensions/xep-0059.html) | Page through and otherwise manage the receipt of large result sets | -| [PubSub](pubsub.html) | [XEP-0060](http://xmpp.org/extensions/xep-0060.html) | Generic publish and subscribe functionality. | +| [PubSub](pubsub.md) | [XEP-0060](http://xmpp.org/extensions/xep-0060.html) | Generic publish and subscribe functionality. | | SOCKS5 Bytestrams | [XEP-0065](http://xmpp.org/extensions/xep-0065.html) | Out-of-band bytestream between any two XMPP entities. | -| [XHTML-IM](xhtml.html) | [XEP-0071](http://xmpp.org/extensions/xep-0071.html) | Allows send and receiving formatted messages using XHTML. | +| [XHTML-IM](xhtml.md) | [XEP-0071](http://xmpp.org/extensions/xep-0071.html) | Allows send and receiving formatted messages using XHTML. | | In-Band Registration | [XEP-0077](http://xmpp.org/extensions/xep-0077.html) | In-band registration with XMPP services. | | Advanced Message Processing | [XEP-0079](http://xmpp.org/extensions/xep-0079.html) | Enables entities to request, and servers to perform, advanced processing of XMPP message stanzas. | | XMPP Date Time Profiles | [XEP-0082](http://xmpp.org/extensions/xep-0082.html) | Standardization of Date and Time representation in XMPP. | | Chat State Notifications | [XEP-0085](http://xmpp.org/extensions/xep-0085.html) | Communicating the status of a user in a chat session. | -| [Time Exchange](time.html) | [XEP-0090](http://xmpp.org/extensions/xep-0090.html) | Allows local time information to be shared between users. | +| [Time Exchange](time.md) | [XEP-0090](http://xmpp.org/extensions/xep-0090.html) | Allows local time information to be shared between users. | | Software Version | [XEP-0092](http://xmpp.org/extensions/xep-0092.html) | Retrieve and announce the software application of an XMPP entity. | | Stream Initation | [XEP-0095](http://xmpp.org/extensions/xep-0095.html) | Initiating a data stream between any two XMPP entities. | -| [SI File Transfer](filetransfer.html) | [XEP-0096](http://xmpp.org/extensions/xep-0096.html) | Transfer files between two users over XMPP. | -| [Entity Capabilities](caps.html) | [XEP-0115](http://xmpp.org/extensions/xep-0115.html) | Broadcasting and dynamic discovery of entity capabilities. | +| [SI File Transfer](filetransfer.md) | [XEP-0096](http://xmpp.org/extensions/xep-0096.html) | Transfer files between two users over XMPP. | +| [Entity Capabilities](caps.md) | [XEP-0115](http://xmpp.org/extensions/xep-0115.html) | Broadcasting and dynamic discovery of entity capabilities. | | Data Forms Validation | [XEP-0122](http://xmpp.org/extensions/xep-0122.html) | Enables an application to specify additional validation guidelines . | | Stream Compression | [XEP-0138](http://xmpp.org/extensions/xep-0138.html) | Support for optional compression of the XMPP stream. | Data Forms Layout | [XEP-0141](http://xmpp.org/extensions/xep-0141.html) | Enables an application to specify form layouts. | @@ -58,8 +58,8 @@ Smack Extensions and currently supported XEPs by Smack (smack-extensions) | Delayed Delivery | [XEP-0203](http://xmpp.org/extensions/xep-0203.html) | Extension for communicating the fact that an XML stanza has been delivered with a delay. | | XMPP Over BOSH | [XEP-0206](http://xmpp.org/extensions/xep-0206.html) | Use Bidirectional-streams Over Synchronous HTTP (BOSH) to transport XMPP stanzas. | | Attention | [XEP-0224](http://xmpp.org/extensions/xep-0224.html) | Getting attention of another user. | -| [Group Chat Invitations](invitation.html) | n/a | Send invitations to other users to join a group chat room. | -| [Jive Properties](properties.html) | n/a | TODO | +| [Group Chat Invitations](invitation.md) | n/a | Send invitations to other users to join a group chat room. | +| [Jive Properties](properties.md) | n/a | TODO | Experimental Smack Extensions and currently supported XEPs by Smack (smack-experimental) @@ -68,7 +68,7 @@ Experimental Smack Extensions and currently supported XEPs by Smack (smack-exper | Name | XEP | Description | |---------------------------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------| | Message Carbons | [XEP-0280](http://xmpp.org/extensions/xep-0280.html) | Keep all IM clients for a user engaged in a conversation, by carbon-copy outbound messages to all interested resources. -| [HTTP over XMPP transport](hoxt.html) | [XEP-0332](http://xmpp.org/extensions/xep-0332.html) | Allows to transport HTTP communication over XMPP peer-to-peer networks. | +| [HTTP over XMPP transport](hoxt.md) | [XEP-0332](http://xmpp.org/extensions/xep-0332.html) | Allows to transport HTTP communication over XMPP peer-to-peer networks. | | JSON Containers | [XEP-0335](http://xmpp.org/extensions/xep-0335.html) | Encapsulation of JSON data within XMPP Stanzas. | | Google GCM JSON payload | n/a | Semantically the same as XEP-0335: JSON Containers | | Client State Indication | [XEP-0352](http://xmpp.org/extensions/xep-0352.html) | A way for the client to indicate its active/inactive state. | @@ -81,6 +81,6 @@ If a XEP becomes 'Deprecated' or 'Obsolete' the code will be moved to the *smack | Name | XEP | Description | |---------------------------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------| -| [Message Events](messageevents.html) | [XEP-0022](http://xmpp.org/extensions/xep-0022.html) | Requests and responds to message events. | +| [Message Events](messageevents.md) | [XEP-0022](http://xmpp.org/extensions/xep-0022.html) | Requests and responds to message events. | -| [Roster Item Exchange](rosterexchange.html) | [XEP-0093](http://xmpp.org/extensions/xep-0093.html) | Allows roster data to be shared between users. | +| [Roster Item Exchange](rosterexchange.md) | [XEP-0093](http://xmpp.org/extensions/xep-0093.html) | Allows roster data to be shared between users. | diff --git a/documentation/extensions/intro.md b/documentation/extensions/intro.md index b1832dc26..fa7393a75 100644 --- a/documentation/extensions/intro.md +++ b/documentation/extensions/intro.md @@ -6,92 +6,92 @@ Current Extensions **XEP #** **Description** -[Private Data](privatedata.html) +[Private Data](privatedata.md) [XEP-0049](http://www.xmpp.org/extensions/xep-0049.html) Manages private data. -[XHTML Messages](xhtml.html) +[XHTML Messages](xhtml.md) [XEP-0071](http://www.xmpp.org/extensions/xep-0071.html) Allows send and receiving formatted messages using XHTML. -[Message Events](messageevents.html) +[Message Events](messageevents.md) [XEP-0022](http://www.xmpp.org/extensions/xep-0022.html) Requests and responds to message events. -[Data Forms](dataforms.html) +[Data Forms](dataforms.md) [XEP-0004](http://www.xmpp.org/extensions/xep-0004.html) Allows to gather data using Forms. -[Multi User Chat](muc.html) +[Multi User Chat](muc.md) [XEP-0045](http://www.xmpp.org/extensions/xep-0045.html) Allows configuration of, participation in, and administration of individual text-based conference rooms. -[Roster Item Exchange](rosterexchange.html) +[Roster Item Exchange](rosterexchange.md) [XEP-0093](http://www.xmpp.org/extensions/xep-0093.html) Allows roster data to be shared between users. -[Time Exchange](time.html) +[Time Exchange](time.md) [XEP-0090](http://www.xmpp.org/extensions/xep-0090.html) Allows local time information to be shared between users. -[Group Chat Invitations](invitation.html) +[Group Chat Invitations](invitation.md) N/A Send invitations to other users to join a group chat room. -[Service Discovery](disco.html) +[Service Discovery](disco.md) [XEP-0030](http://www.xmpp.org/extensions/xep-0030.html) Allows to discover services in XMPP entities. -[File Transfer](filetransfer.html) +[File Transfer](filetransfer.md) [XEP-0096](http://www.xmpp.org/extensions/xep-0096.html) Transfer files between two users over XMPP. -[PubSub](pubsub.html) +[PubSub](pubsub.md) [XEP-0060](http://www.xmpp.org/extensions/xep-0060.html) Generic publish and subscribe functionality. -[Entity Capabilities](caps.html) +[Entity Capabilities](caps.md) [XEP-0115](http://www.xmpp.org/extensions/xep-0115.html) Broadcasting and dynamic discovery of entity capabilities. -[Privacy Lists](privacy.html) +[Privacy Lists](privacy.md) [XEP-0016](http://www.xmpp.org/extensions/xep-0016.html) Enabling or disabling communication with other entities. -[HTTP over XMPP transport](hoxt.html) +[HTTP over XMPP transport](hoxt.md) [XEP-0332](http://www.xmpp.org/extensions/xep-0332.html) Allows to transport HTTP communication over XMPP peer-to-peer networks. -[Jive Properties](properties.html) +[Jive Properties](properties.md) N/A diff --git a/documentation/gettingstarted.md b/documentation/gettingstarted.md index 5913cc2f1..d0050fbb2 100644 --- a/documentation/gettingstarted.md +++ b/documentation/gettingstarted.md @@ -1,7 +1,7 @@ Smack: Getting Started ====================== -[Back](index.html) +[Back](index.md) This document will introduce you to the Smack API and provide an overview of important classes and concepts. @@ -15,14 +15,14 @@ features applications require: * `smack-core.jar` -- provides core XMPP functionality. All XMPP features that are part of the XMPP RFCs are included. * `smack-tcp.jar` -- support for XMPP over TCP. Includes XMPPTCPConnection class, which you usually want to use - * `smack-extensions.jar` -- support for many of 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](extensions/index.html). + * `smack-extensions.jar` -- support for many of 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](extensions/index.md). * `smack-experimental.jar` -- support for experimental extensions (XEPs) defined by the XMPP Standards Foundation. The API and functionality of those extensions should be considered as unstable. * `smack-legacy.jar` -- support for legacy extensions (XEPs) defined by the XMPP Standards Foundation. * `smack-bosh.jar` -- support for BOSH (XEP-0124). This code should be considered as beta. * `smack-jingle.jar` -- support for Jingle. This code is old and currenlty unmaintained. * `smack-resolver-dnsjava.jar` -- support for resolving DNS SRV records with the help of dnsjava. Ideal for platforms that do not support the javax.naming API. * `smack-resolver-javax.jar` -- support for resolving DNS SRV records with the javax namespace API. - * `smack-debug.jar` -- an enhanced GUI debugger for protocol traffic. It will automatically be used when found in the classpath and when [debugging](debugging.html) is enabled. + * `smack-debug.jar` -- an enhanced GUI debugger for protocol traffic. It will automatically be used when found in the classpath and when [debugging](debugging.md) is enabled. Configuration ------------- @@ -65,7 +65,7 @@ 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. See -[XMPPConnection Management](connections.html) for full details. +[XMPPConnection Management](connections.md) for full details. Once you've created a connection, you should login with the `XMPPConnection.login()` method. Once you've logged in, you can being diff --git a/documentation/index.md b/documentation/index.md index c390866ea..00e98e92e 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -2,13 +2,13 @@ **Contents:** - * [Overview](overview.html) - * [Getting Started Guide](gettingstarted.html) - * [Managing Connections](connections.html) - * [Messaging Basics](messaging.html) - * [Roster and Presence](roster.html) - * [Processing Incoming Stanzas](processing.html) - * [Provider Architecture](providers.html) - * [Debugging with Smack](debugging.html) + * [Overview](overview.md) + * [Getting Started Guide](gettingstarted.md) + * [Managing Connections](connections.md) + * [Messaging Basics](messaging.md) + * [Roster and Presence](roster.md) + * [Processing Incoming Stanzas](processing.md) + * [Provider Architecture](providers.md) + * [Debugging with Smack](debugging.md) - * [Smack Extensions Manual](extensions/index.html) + * [Smack Extensions Manual](extensions/index.md) diff --git a/documentation/messaging.md b/documentation/messaging.md index b2727267c..3ee5a4b0c 100644 --- a/documentation/messaging.md +++ b/documentation/messaging.md @@ -1,7 +1,7 @@ Messaging using Chats ===================== -[Back](index.html) +[Back](index.md) Sending messages back and forth is at the core of instant messaging. Although individual messages can be sent and received as packets, it's generally easier diff --git a/documentation/overview.md b/documentation/overview.md index 0ce78d4e1..9c9d00334 100644 --- a/documentation/overview.md +++ b/documentation/overview.md @@ -1,7 +1,7 @@ Smack Overview ============== -[Back](index.html) +[Back](index.md) Smack is a library for communicating with XMPP servers to perform real-time communications, including instant messaging and group chat. diff --git a/documentation/processing.md b/documentation/processing.md index 5c7e387e5..868b88d4c 100644 --- a/documentation/processing.md +++ b/documentation/processing.md @@ -1,7 +1,7 @@ Processing Incoming Stanzas =========================== -[Back](index.html) +[Back](index.md) Smack provides a flexible framework for processing incoming packets using two constructs: diff --git a/documentation/providers.md b/documentation/providers.md index e1356319a..954fc64e3 100644 --- a/documentation/providers.md +++ b/documentation/providers.md @@ -1,14 +1,14 @@ Provider Architecture: Stanza Extensions and Custom IQ's ======================================================== -[Back](index.html) +[Back](index.md) Introduction ------------ The Smack provider architecture is a system for plugging in custom XML parsing of packet extensions and IQ packets. The standard [Smack -Extensions](extensions/index.html) are built using the provider architecture. +Extensions](extensions/index.md) are built using the provider architecture. There are two types of providers: * `IQProvider` -- parses IQ requests into Java objects. diff --git a/documentation/roster.md b/documentation/roster.md index c37b6ea5f..b901a59ed 100644 --- a/documentation/roster.md +++ b/documentation/roster.md @@ -1,7 +1,7 @@ Roster and Presence =================== -[Back](index.html) +[Back](index.md) The roster lets you keep track of the availability ("presence") of other users. A roster also allows you to organize users into groups such as