docs: fix rest issues
This commit is contained in:
parent
9d61655215
commit
010bf6dd70
9 changed files with 173 additions and 169 deletions
|
@ -2,6 +2,7 @@ IQ Stanza
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. module:: slixmpp.stanza
|
.. module:: slixmpp.stanza
|
||||||
|
:noindex:
|
||||||
|
|
||||||
.. autoclass:: Iq
|
.. autoclass:: Iq
|
||||||
:members:
|
:members:
|
||||||
|
|
|
@ -2,6 +2,7 @@ Message Stanza
|
||||||
==============
|
==============
|
||||||
|
|
||||||
.. module:: slixmpp.stanza
|
.. module:: slixmpp.stanza
|
||||||
|
:noindex:
|
||||||
|
|
||||||
.. autoclass:: Message
|
.. autoclass:: Message
|
||||||
:members:
|
:members:
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
.. module:: slixmpp.xmlstream.tostring
|
.. module:: slixmpp.xmlstream.tostring
|
||||||
|
:noindex:
|
||||||
|
|
||||||
.. _tostring:
|
.. _tostring:
|
||||||
|
|
||||||
|
|
|
@ -309,10 +309,6 @@ Event Index
|
||||||
- **Data:** :py:class:`~slixmpp.Message`
|
- **Data:** :py:class:`~slixmpp.Message`
|
||||||
- **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333`
|
- **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333`
|
||||||
|
|
||||||
message_correction
|
|
||||||
- **Data:** :py:class:`~slixmpp.Message`
|
|
||||||
- **Source:** :py:class:`~slixmpp.plugins.xep_0308.XEP_0308`
|
|
||||||
|
|
||||||
attention
|
attention
|
||||||
- **Data:** :py:class:`~slixmpp.Message`
|
- **Data:** :py:class:`~slixmpp.Message`
|
||||||
- **Source:** :py:class:`~slixmpp.plugins.xep_0224.XEP_0224`
|
- **Source:** :py:class:`~slixmpp.plugins.xep_0224.XEP_0224`
|
||||||
|
@ -408,7 +404,3 @@ Event Index
|
||||||
pubsub_subscription
|
pubsub_subscription
|
||||||
- **Data:** :py:class:`~slixmpp.Message`
|
- **Data:** :py:class:`~slixmpp.Message`
|
||||||
- **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060`
|
- **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060`
|
||||||
|
|
||||||
pubsub_retract
|
|
||||||
- **Data:** :py:class:`~slixmpp.Message`
|
|
||||||
- **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060`
|
|
||||||
|
|
|
@ -32,3 +32,11 @@ Glossary
|
||||||
|
|
||||||
substanza
|
substanza
|
||||||
See :term:`stanza plugin`
|
See :term:`stanza plugin`
|
||||||
|
|
||||||
|
interfaces
|
||||||
|
A set of keys defined on a :term:`stanza plugin`.
|
||||||
|
|
||||||
|
stanza
|
||||||
|
An XML payload sent over the XML stream, which is the root of XMPP.
|
||||||
|
A stanza is either ``<iq/>``, ``<message/>`` or ``<presence/>``. Other
|
||||||
|
elements are called nonzas.
|
||||||
|
|
|
@ -76,13 +76,13 @@ Plik zawiera prostą strukturę, która pozwoli nam zapisać dane logowania.
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
#!/usr/bin/python3
|
#!/usr/bin/python3
|
||||||
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import time
|
import time
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
#~ prefix = ["x-terminal-emulator", "-e"] # Osobny terminal dla kazdego klienta, może być zastąpiony inną konsolą.
|
#~ prefix = ["x-terminal-emulator", "-e"] # Osobny terminal dla kazdego klienta, może być zastąpiony inną konsolą.
|
||||||
#~ prefix = ["xterm", "-e"]
|
#~ prefix = ["xterm", "-e"]
|
||||||
prefix = []
|
prefix = []
|
||||||
|
@ -1263,13 +1263,13 @@ W poniższym kodzie zostały pozostawione oryginalne komentarze w języku angiel
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
#!/usr/bin/python3
|
#!/usr/bin/python3
|
||||||
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import time
|
import time
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
|
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
|
||||||
#~ prefix = ["xterm", "-e"]
|
#~ prefix = ["xterm", "-e"]
|
||||||
prefix = []
|
prefix = []
|
||||||
|
|
|
@ -76,13 +76,13 @@ This file contains a simple structure for logging credentials:
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
#!/usr/bin/python3
|
#!/usr/bin/python3
|
||||||
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import time
|
import time
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
|
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
|
||||||
#~ prefix = ["xterm", "-e"]
|
#~ prefix = ["xterm", "-e"]
|
||||||
prefix = []
|
prefix = []
|
||||||
|
@ -1260,13 +1260,13 @@ Complete code from tutorial
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
#!/usr/bin/python3
|
#!/usr/bin/python3
|
||||||
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import time
|
import time
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
|
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
|
||||||
#~ prefix = ["xterm", "-e"]
|
#~ prefix = ["xterm", "-e"]
|
||||||
prefix = []
|
prefix = []
|
||||||
|
|
|
@ -2,4 +2,5 @@
|
||||||
|
|
||||||
License (MIT)
|
License (MIT)
|
||||||
=============
|
=============
|
||||||
.. include:: ../LICENSE
|
|
||||||
|
.. literalinclude:: ../LICENSE
|
||||||
|
|
|
@ -38,8 +38,8 @@ Updated Code
|
||||||
def handleIncomingMessage(self, message):
|
def handleIncomingMessage(self, message):
|
||||||
self.xmpp.send_message(message["from"], message["body"])
|
self.xmpp.send_message(message["from"], message["body"])
|
||||||
|
|
||||||
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ |
|
`View full source (1) <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ |
|
||||||
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_
|
`View original code (1) <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_
|
||||||
|
|
||||||
Example 14-1. (Page 215)
|
Example 14-1. (Page 215)
|
||||||
------------------------
|
------------------------
|
||||||
|
@ -88,8 +88,8 @@ Updated Code
|
||||||
for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
|
for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
|
||||||
self.xmpp.send_message(subscriberJID, body, mhtml=htmlBody)
|
self.xmpp.send_message(subscriberJID, body, mhtml=htmlBody)
|
||||||
|
|
||||||
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ |
|
`View full source (2) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ |
|
||||||
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_
|
`View original code (2) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_
|
||||||
|
|
||||||
|
|
||||||
Example 14-3. (Page 217)
|
Example 14-3. (Page 217)
|
||||||
|
@ -131,8 +131,8 @@ Updated Code
|
||||||
if self.backend.getShouldMonitorPresenceFromUser(user):
|
if self.backend.getShouldMonitorPresenceFromUser(user):
|
||||||
self.handleIncomingXMPPEvent(event)
|
self.handleIncomingXMPPEvent(event)
|
||||||
|
|
||||||
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ |
|
`View full source (3) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ |
|
||||||
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_
|
`View original code (3) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_
|
||||||
|
|
||||||
|
|
||||||
Example 14-4. (Page 220)
|
Example 14-4. (Page 220)
|
||||||
|
@ -176,8 +176,8 @@ Updated Code
|
||||||
for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
|
for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
|
||||||
self.xmpp.send_message(subscriberJID, body, mfrom=self.xmpp.jid)
|
self.xmpp.send_message(subscriberJID, body, mfrom=self.xmpp.jid)
|
||||||
|
|
||||||
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ |
|
`View full source (4) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ |
|
||||||
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_
|
`View original code (4) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_
|
||||||
|
|
||||||
|
|
||||||
Example 14-6. (Page 223)
|
Example 14-6. (Page 223)
|
||||||
|
@ -195,8 +195,8 @@ implementation should work correctly.
|
||||||
To see how to implement in-band registration as a Slixmpp plugin,
|
To see how to implement in-band registration as a Slixmpp plugin,
|
||||||
see the tutorial :ref:`tutorial-create-plugin`.
|
see the tutorial :ref:`tutorial-create-plugin`.
|
||||||
|
|
||||||
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ |
|
`View full source (5) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ |
|
||||||
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_
|
`View original code (5) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_
|
||||||
|
|
||||||
Example 14-7. (Page 225)
|
Example 14-7. (Page 225)
|
||||||
------------------------
|
------------------------
|
||||||
|
@ -245,5 +245,5 @@ Updated Code
|
||||||
if contactJID == self.componentDomain :
|
if contactJID == self.componentDomain :
|
||||||
self.sendAllContactSubscriptionRequestsToUser(userJID)
|
self.sendAllContactSubscriptionRequestsToUser(userJID)
|
||||||
|
|
||||||
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ |
|
`View full source (6) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ |
|
||||||
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_
|
`View original code (6) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_
|
||||||
|
|
Loading…
Reference in a new issue