diff options
Diffstat (limited to 'docs/api/xmlstream/stanzabase.rst')
| -rw-r--r-- | docs/api/xmlstream/stanzabase.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/api/xmlstream/stanzabase.rst b/docs/api/xmlstream/stanzabase.rst index f575299e..ad43a44a 100644 --- a/docs/api/xmlstream/stanzabase.rst +++ b/docs/api/xmlstream/stanzabase.rst @@ -4,9 +4,9 @@ Stanza Objects ============== -.. module:: sleekxmpp.xmlstream.stanzabase +.. module:: slixmpp.xmlstream.stanzabase -The :mod:`~sleekmxpp.xmlstream.stanzabase` module provides a wrapper for the +The :mod:`~slixmpp.xmlstream.stanzabase` module provides a wrapper for the standard :mod:`~xml.etree.ElementTree` module that makes working with XML less painful. Instead of having to manually move up and down an element tree and insert subelements and attributes, you can interact with an object @@ -52,17 +52,17 @@ elements of the original XML chunk. .. seealso:: :ref:`create-stanza-interfaces`. -Because the :mod:`~sleekxmpp.xmlstream.stanzabase` module was developed +Because the :mod:`~slixmpp.xmlstream.stanzabase` module was developed as part of an `XMPP <http://xmpp.org>`_ library, these chunks of XML are -referred to as :term:`stanzas <stanza>`, and in SleekXMPP we refer to a +referred to as :term:`stanzas <stanza>`, and in Slixmpp we refer to a subclass of :class:`ElementBase` which defines the interfaces needed for interacting with a given :term:`stanza` a :term:`stanza object`. To make dealing with more complicated and nested :term:`stanzas <stanza>` or XML chunks easier, :term:`stanza objects <stanza object>` can be composed in two ways: as iterable child objects or as plugins. Iterable -child stanzas, or :term:`substanzas`, are accessible through a special -``'substanzas'`` interface. This option is useful for stanzas which +child stanzas, or :term:`substanzas <substanza>`, are accessible through a +special ``'substanzas'`` interface. This option is useful for stanzas which may contain more than one of the same kind of element. When there is only one child element, the plugin method is more useful. For plugins, a parent stanza object delegates one of its XML child elements to the @@ -72,7 +72,7 @@ plugin stanza object. Here is an example: <iq type="result"> <query xmlns="http://jabber.org/protocol/disco#info"> - <identity category="client" type="bot" name="SleekXMPP Bot" /> + <identity category="client" type="bot" name="Slixmpp Bot" /> </query> </iq> @@ -84,13 +84,13 @@ we can access the plugin as so:: >>> iq['disco_info'] '<query xmlns="http://jabber.org/protocol/disco#info"> - <identity category="client" type="bot" name="SleekXMPP Bot" /> + <identity category="client" type="bot" name="Slixmpp Bot" /> </query>' We can then drill down through the plugin object's interfaces as desired:: >>> iq['disco_info']['identities'] - [('client', 'bot', 'SleekXMPP Bot')] + [('client', 'bot', 'Slixmpp Bot')] Plugins may also add new interfaces to the parent stanza object as if they had been defined by the parent directly, and can also override the behaviour @@ -101,7 +101,7 @@ of an interface defined by the parent. - :ref:`create-stanza-plugins` - :ref:`create-extension-plugins` - :ref:`override-parent-interfaces` - + Registering Stanza Plugins -------------------------- |