xep-template.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>XEP Template</title>
  <abstract>This specification provides an example of the format for XMPP Extension Protocols (XEPs).</abstract>
  &LEGALNOTICE;
  <number>xxxx</number>
  <status>ProtoXEP</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0001</spec>
    <spec>Etc.</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  <tags>
    <tag>template</tag>
  </tags>
  <author>
    <firstname>Peter</firstname>
    <surname>Saint-Andre</surname>
    <email>stpeter@jabber.org</email>
    <jid>stpeter@jabber.org</jid>
  </author>
  <revision>
    <version>0.0.1</version>
    <date>2001-09-14</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>This is a template for use in writing XMPP Extension Protocol specifications (XEPs). For detailed information about the XSF's standards process and how to write a XEP, refer to "XEP-0001: XMPP Extension Protocols" and "XEP-0143: Guidelines for Authors of XMPP Extension Protocols".</p>
</section1>
<section1 topic='Requirements' anchor='reqs'>
  <p>STRONGLY RECOMMENDED.</p>
</section1>
<section1 topic='Glossary' anchor='glossary'>
  <p>OPTIONAL.</p>
</section1>
<section1 topic='Use Cases' anchor='usecases'>
  <p>STRONGLY RECOMMENDED.</p>
</section1>
<section1 topic='Business Rules' anchor='rules'>
  <p>OPTIONAL.</p>
</section1>
<section1 topic='Implementation Notes' anchor='impl'>
  <p>OPTIONAL.</p>
</section1>
<section1 topic='Accessibility Considerations' anchor='access'>
  <p>REQUIRED.</p>
</section1>
<section1 topic='Internationalization Considerations' anchor='i18n'>
  <p>OPTIONAL.</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>
  <p>REQUIRED.</p>
</section1>
<section1 topic='Privacy Considerations' anchor='privacy'>
  <p>REQUIRED.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
  <p>REQUIRED.</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <p>REQUIRED.</p>
</section1>
<section1 topic='Design Considerations' anchor='design'>
  <!-- Use this section to describe other approaches which have been considered
  during the design of this protocol and why they have been rejected. Having
  the result and a summary of long or complicated discussions in the document
  itself instead of list or chat archives serves future readers. -->
  <p>RECOMMENDED.</p>
</section1>
<section1 topic='XEP Styling Examples (1st Level Heading)' anchor='styling'>
  <p>PLEASE REMOVE THIS SECTION. These are just examples for the RECOMMENDED ways to style your XEP.</p>
  <section2 topic='2nd Level Heading' anchor='styling-examples'>
    <p>This is regular XEP text. It can contain <strong>strong</strong> and <em>emphasized</em> markup as well as <tt>fixed-width text</tt>.</p>
    <p>This is text with a line break.<br/>New line.</p>
    <p>This is text with a footnote<note>This is the footnote.</note>.</p>
    <p>This is a <link url='#styling-examples'>link to a section in this document</link>.</p>
    <p>This is a reference to another XEP: &xep0001;, it can be re-referenced as <cite>XEP-0001</cite> later in the text.</p>
    <code caption='Code block caption'>Code block content.</code>
    <ol>
      <li>This is an ordered list. First item</li>
      <li>Second item</li>
    </ol>
    <ul>
      <li>This is an unordered list. First item</li>
      <li>Second item</li>
    </ul>
    <dl>
      <di>
        <dt>Definition List</dt>
        <dd>
          A definition list contains definition items with a title and a description.
        </dd>
      </di>
    </dl>
    <p class='box'>Note: This is an informational box</p>
    <example caption='Example of embedding XMPP XML'><![CDATA[
<iq from='hag66@shakespeare.lit/pda'
    id='h7ns81g'
    to='shakespeare.lit'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#items'/>
</iq>
]]></example>
    <cve id="2017-5589" url="https://rt-solutions.de/en/cve-2017-5589_xmpp_carbons/">Name of a CVE relevant to the XEP</cve>
    <cve id="2017-5589">Another CVE with no primary source</cve>
    <section3 topic='3rd Level Heading' anchor='syling-examples-3rd'>
      <p>Text in a Sub-Sub-Section.</p>
      <section4 topic='4th Level Heading' anchor='syling-examples-4th'>
        <p>Text in a Sub-Sub-Sub-Section.</p>
      </section4>
    </section3>
  </section2>
</section1>
<section1 topic='XML Schema' anchor='schema'>
  <p>REQUIRED for protocol specifications.</p>
</section1>
</xep>