git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1165 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-08-17 18:30:16 +00:00
parent 105d4b6ba9
commit cd5a2ae041
1 changed files with 11 additions and 4 deletions

View File

@ -49,8 +49,8 @@
&ralphm;
<revision>
<version>1.10pre6</version>
<date>in progress, last updated 2007-08-16</date>
<version>1.10pre7</version>
<date>in progress, last updated 2007-08-17</date>
<initials>psa</initials>
<remark>
<ul>
@ -60,6 +60,7 @@
<li>Added publish-options functionality</li>
<li>Added developer-friendly How It Works section</li>
<li>Split several long sections into smaller sub-sections.</li>
<li>Clarified that a pubsub service must generate an ItemID if the publisher does not provide one.</li>
</ul>
</remark>
</revision>
@ -2251,8 +2252,14 @@ And by opposing end them?
<section1 topic='Publisher Use Cases' anchor='publisher'>
<section2 topic='Publish an Item to a Node' anchor='publisher-publish'>
<section3 topic='Request' anchor='publisher-publish-request'>
<p>Any entity that is allowed to publish items to a node (i.e., a publisher or an owner) may do so at any time by sending an IQ-set to the service containing a pubsub element with a &lt;publish/&gt; child; the &lt;publish/&gt; element MUST possess a 'node' attribute and depending on the node configuration MAY contain no &ITEM; elements, one &ITEM; element, or (for <link url='#impl-batch'>Batch Processing</link>) more than one &ITEM; element.</p>
<p>Note: It is not necessary for a publication request to include a payload or even an &ITEM; element in order to trigger a notification. For example, the result of publishing to a transient, notification-only node will be a notification that does not include even an &ITEM; element (as shown in the <link url='#intro-example'>Motivating Example</link> section of this document). However, for the sake of convenience we refer to the act of publication as "publishing an item" (rather than, say, "triggering a notification") even though a publication request will not always contain an &ITEM; element.</p>
<p>Any entity that is allowed to publish items to a node (i.e., a publisher or an owner) may do so at any time by sending an IQ-set to the service containing a pubsub element with a &lt;publish/&gt; child.</p>
<p>The syntax is as follows:</p>
<ul>
<li>The &lt;publish/&gt; element MUST possess a 'node' attribute, specifying the NodeID of the node.</li>
<li>Depending on the node configuration, the &lt;publish/&gt; element MAY contain no &ITEM; elements, one &ITEM; element, or (for <link url='#impl-batch'>Batch Processing</link>) more than one &ITEM; element. <note>It is not necessary for a publication request to include a payload or even an &ITEM; element in order to trigger a notification. For example, the result of publishing to a transient, notification-only node will be a notification that does not include even an &ITEM; element. However, for the sake of convenience we refer to the act of publication as "publishing an item" (rather than, say, "triggering a notification") even though a publication request will not always contain an &ITEM; element.</note></li>
<li>The &lt;item/&gt; element provided by the publisher MAY possess an 'id' attribute, specifying a unique ItemID for the item. If an ItemID is not provided in the publish request, the pubsub service MUST generate one and MUST ensure that it is unique for that node.</li>
</ul>
<p>An example follows.</p>
<example caption='Publisher publishes an item with an ItemID'><![CDATA[
<iq type='set'
from='hamlet@denmark.lit/blogbot'