Mercurial > libervia-pubsub
comparison doc/index.rst @ 404:105a0772eedd
doc: first draft
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 24 Jul 2019 19:26:43 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 403:1dc606612405 | 404:105a0772eedd |
|---|---|
| 1 .. SàT PubSub documentation master file, created by | |
| 2 sphinx-quickstart on Wed Jul 24 08:06:59 2019. | |
| 3 You can adapt this file completely to your liking, but it should at least | |
| 4 contain the root `toctree` directive. | |
| 5 | |
| 6 SàT PubSub documentation | |
| 7 ======================== | |
| 8 | |
| 9 SàT PubSub is a XMPP PubSub service component (XEP-0060) It's based on Ralph Meijer's | |
| 10 Idavoll, and provides special features necessary for the « Salut à Toi » project | |
| 11 (https://salut-a-toi.org) , but it can also be used for any other XMPP project. The use | |
| 12 of a standard external component allow to use this features with most XMPP servers. One | |
| 13 of the main addition is fine access tuning for PubSub, which allow the publication of | |
| 14 items for only some groups, even if the entire node is open. The protocol is explained on | |
| 15 http://www.goffi.org/post/2012/06/24/Fine-access-tuning-for-PubSub for the moment, and a | |
| 16 protoxep should be proposed to the XSF in the future… | |
| 17 | |
| 18 | |
| 19 .. toctree:: | |
| 20 :maxdepth: 3 | |
| 21 :caption: Contents: | |
| 22 | |
| 23 installation.rst | |
| 24 | |
| 25 | |
| 26 Indices and tables | |
| 27 ================== | |
| 28 | |
| 29 * :ref:`genindex` | |
| 30 * :ref:`modindex` | |
| 31 * :ref:`search` |