Mercurial > libervia-pubsub

annotate doc/index.rst @ 494:468b7cd6c344 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bookmark compat: handle mapped errors: This convert error on request (e.g. missing node) to appropriate stanza error.
author Goffi <goffi@goffi.org>
date Fri, 13 Dec 2024 12:23:47 +0100
parents 105a0772eedd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 .. SàT PubSub documentation master file, created by
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 sphinx-quickstart on Wed Jul 24 08:06:59 2019.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3 You can adapt this file completely to your liking, but it should at least
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
4 contain the root `toctree` directive.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
5
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6 SàT PubSub documentation
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
7 ========================
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
8
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
9 SàT PubSub is a XMPP PubSub service component (XEP-0060) It's based on Ralph Meijer's
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
10 Idavoll, and provides special features necessary for the « Salut à Toi » project
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11 (https://salut-a-toi.org) , but it can also be used for any other XMPP project. The use
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12 of a standard external component allow to use this features with most XMPP servers. One
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13 of the main addition is fine access tuning for PubSub, which allow the publication of
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14 items for only some groups, even if the entire node is open. The protocol is explained on
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15 http://www.goffi.org/post/2012/06/24/Fine-access-tuning-for-PubSub for the moment, and a
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16 protoxep should be proposed to the XSF in the future…
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19 .. toctree::
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 :maxdepth: 3
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 :caption: Contents:
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
23 installation.rst
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26 Indices and tables
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27 ==================
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29 * :ref:`genindex`
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30 * :ref:`modindex`
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31 * :ref:`search`