Author: as Date: Tue Jan 29 11:22:36 2008 New Revision: 7252 Log: - Added equivalents links for feed elements.
Modified: trunk/Feed/docs/specifications.txt Modified: trunk/Feed/docs/specifications.txt ============================================================================== --- trunk/Feed/docs/specifications.txt [iso-8859-1] (original) +++ trunk/Feed/docs/specifications.txt [iso-8859-1] Tue Jan 29 11:22:36 2008 @@ -94,7 +94,7 @@ +---------------------------------+-------------------------------+------------------------------+------------------------------+ | |ezcFeed-item-comments|_ ? | x | x | |RSS2-item-comments|_ ? | +---------------------------------+-------------------------------+------------------------------+------------------------------+ -| |ezcFeed-item-link|_ !* | |ATOM-entry-link|_ !* | x | |RSS2-item-enclosure|_ ? | +| |ezcFeed-item-enclosure|_ ? | |ATOM-entry-link|_ ?* | x | |RSS2-item-enclosure|_ ? | +---------------------------------+-------------------------------+------------------------------+------------------------------+ | ! = required @@ -130,6 +130,31 @@ ezcFeed/cloud ````````````` +Allows processes to register with a cloud to be notified of updates to the +channel, implementing a lightweight publish-subscribe protocol for RSS feeds. + +Optional (not recommended). + +Can appear only once. + +Has the required attributes: *domain*, *port*, *path*, *registerProcedure*, +*protocol*. + +Example:: + + // $feed is an ezcFeed object + $feed->add( 'cloud' ); + $feed->domain = 'rpc.sys.com'; + $feed->port = 80; + $feed->path = '/RPC2'; + $feed->registerProcedure = 'myCloud.rssPleaseNotify'; + $feed->protocol = 'xml-rpc'; + +Only `RSS2`_ feeds will have the cloud element after generating the feed. It +will be ignored for the other feed types (`RSS1`_, `ATOM`_). + +Equivalents: `ezcFeed-cloud`_, ATOM-none, RSS1-none, `RSS2-cloud`_. + .. _ezcFeed-contributor: @@ -276,6 +301,12 @@ ezcFeed/item/description ```````````````````````` + + +.. _ezcFeed-item-enclosure: + +ezcFeed/item/enclosure +`````````````````````` .. _ezcFeed-item-id: @@ -388,7 +419,8 @@ <email>[EMAIL PROTECTED]</email> </author> -Equivalents: `ATOM-author`_, RSS1-none, `RSS2-managingEditor`_. +Equivalents: `ezcFeed-author`_, `ATOM-author`_, RSS1-none, +`RSS2-managingEditor`_. .. _ATOM-category: @@ -406,7 +438,8 @@ Has 2 optional attributes: *scheme*, *label*. -Equivalents: `ATOM-category`_, RSS1-none, `RSS2-category`_. +Equivalents: `ezcFeed-category`_, `ATOM-category`_, RSS1-none, +`RSS2-category`_. .. _ATOM-contributor: @@ -430,7 +463,8 @@ <email>[EMAIL PROTECTED]</email> </contributor> -Equivalents: `ATOM-contributor`_, RSS1-none, RSS2-none. +Equivalents: `ezcFeed-contributor`_, `ATOM-contributor`_, RSS1-none, +RSS2-none. .. _ATOM-entry: @@ -444,7 +478,7 @@ Multiple entries can appear. -Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_. +Equivalents: `ezcFeed-item`_, `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_. .. _ATOM-generator: @@ -460,7 +494,8 @@ Has 2 optional attributes: *url*, *version*. -Equivalents: `ATOM-generator`_, RSS1-none, `RSS2-generator`_. +Equivalents: `ezcFeed-generator`_, `ATOM-generator`_, RSS1-none, +`RSS2-generator`_. .. _ATOM-icon: @@ -474,7 +509,7 @@ Can appear only once. -Equivalents: `ATOM-icon`_, RSS1-none, RSS2-none. +Equivalents: `ezcFeed-icon`_, `ATOM-icon`_, RSS1-none, RSS2-none. .. _ATOM-id: @@ -489,7 +524,7 @@ Can appear only once. -Equivalents: `ATOM-id`_, `RSS1-about`_, RSS2-none. +Equivalents: `ezcFeed-id`_, `ATOM-id`_, `RSS1-about`_, RSS2-none. .. _ATOM-link: @@ -510,7 +545,7 @@ A maximum of one link with ``rel="alternate"`` can appear per *type* and *hreflang*. -Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_. +Equivalents: `ezcFeed-link`_, `ATOM-link`_, `RSS1-link`_, `RSS2-link`_. .. _ATOM-logo: @@ -524,7 +559,7 @@ Can appear only once. -Equivalents: `ATOM-logo`_, `RSS1-image`_, `RSS2-image`_. +Equivalents: `ezcFeed-image`_, `ATOM-logo`_, `RSS1-image`_, `RSS2-image`_. .. _ATOM-rights: @@ -545,7 +580,8 @@ list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: `ATOM-rights`_, RSS1-none, `RSS2-copyright`_. +Equivalents: `ezcFeed-copyright`_, `ATOM-rights`_, RSS1-none, +`RSS2-copyright`_. .. _ATOM-subtitle: @@ -566,7 +602,8 @@ list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_. +Equivalents: `ezcFeed-description`_, `ATOM-subtitle`_, `RSS1-description`_, +`RSS2-description`_. .. _ATOM-title: @@ -588,7 +625,7 @@ list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_. +Equivalents: `ezcFeed-title`_, `ATOM-title`_, `RSS1-title`_, `RSS2-title`_. .. _ATOM-updated: @@ -604,7 +641,7 @@ Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``). -Equivalents: `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_. +Equivalents: `ezcFeed-updated`_, `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_. Item elements @@ -632,7 +669,8 @@ <email>[EMAIL PROTECTED]</email> </author> -Equivalents: `ATOM-entry-author`_, RSS1-none, `RSS2-item-author`_. +Equivalents: `ezcFeed-item-author`_, `ATOM-entry-author`_, RSS1-none, +`RSS2-item-author`_. .. _ATOM-entry-category: @@ -650,7 +688,8 @@ Has 2 optional attributes: *scheme*, *label*. -Equivalents: `ATOM-entry-category`_, RSS1-none, `RSS2-item-category`_. +Equivalents: `ezcFeed-item-category`_, `ATOM-entry-category`_, RSS1-none, +`RSS2-item-category`_. .. _ATOM-entry-content: @@ -686,8 +725,8 @@ Otherwise, a base64 encoded document of the indicated media type is contained inline. -Equivalents: `ATOM-entry-summary`_/`ATOM-entry-content`_, `RSS1-item-description`_, -`RSS2-item-description`_. +Equivalents: `ezcFeed-item-description`_, `ATOM-entry-summary`_/ +`ATOM-entry-content`_, `RSS1-item-description`_, `RSS2-item-description`_. .. _ATOM-entry-contributor: @@ -711,7 +750,8 @@ <email>[EMAIL PROTECTED]</email> </contributor> -Equivalents: `ATOM-entry-contributor`_, RSS1-none, RSS2-none. +Equivalents: `ezcFeed-item-contributor`_, `ATOM-entry-contributor`_, +RSS1-none, RSS2-none. .. _ATOM-entry-id: @@ -726,7 +766,8 @@ Can appear only once. -Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_. +Equivalents: `ezcFeed-item-id`_, `ATOM-entry-id`_, `RSS1-item-about`_, +`RSS2-item-guid`_. .. _ATOM-entry-link: @@ -750,7 +791,8 @@ Recommended only one ``rel="enclosure"`` link to keep compatibility with RSS2 |RSS2-item-enclosure|_. -Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_/ +Equivalents: `ezcFeed-item-link`_/`ezcFeed-item-enclosure`_, +`ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_/ `RSS2-item-enclosure`_. @@ -767,7 +809,8 @@ Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``). -Equivalents: `ATOM-entry-published`_, RSS1-none, `RSS2-item-pubDate`_. +Equivalents: `ezcFeed-item-published`_, `ATOM-entry-published`_, RSS1-none, +`RSS2-item-pubDate`_. .. _ATOM-entry-rights: @@ -788,8 +831,8 @@ list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: `ATOM-entry-rights`_, RSS1-none, RSS2-none (`RSS2-copyright`_ for -the whole feed). +Equivalents: `ezcFeed-item-copyright`_, `ATOM-entry-rights`_, RSS1-none, +RSS2-none (`RSS2-copyright`_ for the whole feed). .. _ATOM-entry-summary: @@ -810,8 +853,8 @@ list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: `ATOM-entry-summary`_/`ATOM-entry-content`_, `RSS1-item-description`_, -`RSS2-item-description`_. +Equivalents: `ezcFeed-item-description`_, `ATOM-entry-summary`_/ +`ATOM-entry-content`_, `RSS1-item-description`_, `RSS2-item-description`_. .. _ATOM-entry-title: @@ -832,7 +875,8 @@ list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_. +Equivalents: `ezcFeed-item-title`_, `ATOM-entry-title`_, `RSS1-item-title`_, +`RSS2-item-title`_. .. _ATOM-entry-updated: @@ -848,7 +892,8 @@ Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``). -Equivalents: `ATOM-entry-updated`_, RSS1-none, RSS2-none. +Equivalents: `ezcFeed-item-updated`_, `ATOM-entry-updated`_, RSS1-none, +RSS2-none. RSS1 @@ -940,7 +985,7 @@ Can appear only once. -Equivalents: `ATOM-id`_, `RSS1-about`_, RSS2-none. +Equivalents: `ezcFeed-id`_, `ATOM-id`_, `RSS1-about`_, RSS2-none. .. _RSS1-description: @@ -954,7 +999,8 @@ Can appear only once. -Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_. +Equivalents: `ezcFeed-description`_, `ATOM-subtitle`_, `RSS1-description`_, +`RSS2-description`_. .. _RSS1-image: @@ -973,7 +1019,7 @@ Has 3 required sub-elements: *title*, *link*, *url*. -Equivalents: `ATOM-logo`_, `RSS1-image`_, `RSS2-image`_. +Equivalents: `ezcFeed-image`_, `ATOM-logo`_, `RSS1-image`_, `RSS2-image`_. .. _RSS1-item: @@ -987,7 +1033,7 @@ Multiple entries can appear. -Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_. +Equivalents: `ezcFeed-item`_, `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_. .. _RSS1-link: @@ -1001,7 +1047,7 @@ Can appear only once. -Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_. +Equivalents: `ezcFeed-link`_, `ATOM-link`_, `RSS1-link`_, `RSS2-link`_. .. _RSS1-textinput: @@ -1020,7 +1066,8 @@ Has four required sub-elements: *title*, *description*, *name*, *link*. -Equivalents: ATOM-none, `RSS1-textinput`_, `RSS2-textInput`_. +Equivalents: `ezcFeed-textInput`_, ATOM-none, `RSS1-textinput`_, +`RSS2-textInput`_. .. _RSS1-title: @@ -1035,7 +1082,7 @@ Can appear only once. -Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_. +Equivalents: `ezcFeed-title`_, `ATOM-title`_, `RSS1-title`_, `RSS2-title`_. Item elements @@ -1054,7 +1101,8 @@ Can appear only once. -Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_. +Equivalents: `ezcFeed-item-id`_, `ATOM-entry-id`_, `RSS1-item-about`_, +`RSS2-item-guid`_. .. _RSS1-item-description: @@ -1068,8 +1116,8 @@ Can appear only once. -Equivalents: `ATOM-entry-summary`_, `RSS1-item-description`_, -`RSS2-item-description`_. +Equivalents: `ezcFeed-item-description`_, `ATOM-entry-summary`_, +`RSS1-item-description`_, `RSS2-item-description`_. .. _RSS1-item-link: @@ -1083,7 +1131,8 @@ Can appear only once. -Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_. +Equivalents: `ezcFeed-item-link`_, `ATOM-entry-link`_, `RSS1-item-link`_, +`RSS2-item-link`_. .. _RSS1-item-title: @@ -1097,7 +1146,8 @@ Can appear only once. -Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_. +Equivalents: `ezcFeed-item-title`_, `ATOM-entry-title`_, `RSS1-item-title`_, +`RSS2-item-title`_. RSS2 @@ -1170,7 +1220,8 @@ The value of the category element must be specified. -Equivalents: `ATOM-category`_, RSS1-none, `RSS2-category`_. +Equivalents: `ezcFeed-category`_, `ATOM-category`_, RSS1-none, +`RSS2-category`_. .. _RSS2-cloud: @@ -1192,7 +1243,7 @@ <cloud domain="rpc.sys.com" port="80" path="/RPC2" registerProcedure="myCloud.rssPleaseNotify" protocol="xml-rpc" /> -Equivalents: ATOM-none, RSS1-none, `RSS2-cloud`_. +Equivalents: `ezcFeed-cloud`_, ATOM-none, RSS1-none, `RSS2-cloud`_. .. _RSS2-copyright: @@ -1206,7 +1257,8 @@ Can appear only once. -Equivalents: `ATOM-rights`_, RSS1-none, `RSS2-copyright`_. +Equivalents: `ezcFeed-copyright`_, `ATOM-rights`_, RSS1-none, +`RSS2-copyright`_. .. _RSS2-description: @@ -1220,7 +1272,8 @@ Can appear only once. -Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_. +Equivalents: `ezcFeed-description`_, `ATOM-subtitle`_, `RSS1-description`_, +`RSS2-description`_. .. _RSS2-generator: @@ -1234,7 +1287,8 @@ Can appear only once. -Equivalents: `ATOM-generator`_, RSS1-none, `RSS2-generator`_. +Equivalents: `ezcFeed-generator`_, `ATOM-generator`_, RSS1-none, +`RSS2-generator`_. .. _RSS2-image: @@ -1252,7 +1306,7 @@ Has 3 optional sub-elements: *width*, *height*, *description*. -Equivalents: `ATOM-logo`_, `RSS1-image`_, `RSS2-image`_. +Equivalents: `ezcFeed-image`_, `ATOM-logo`_, `RSS1-image`_, `RSS2-image`_. .. _RSS2-item: @@ -1266,7 +1320,7 @@ Multiple entries can appear. -Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_. +Equivalents: `ezcFeed-item`_, `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_. .. _RSS2-language: @@ -1283,7 +1337,8 @@ A list of allowed languages can be found here: http://www.rssboard.org/rss-language-codes. -Equivalents: ATOM-*xml:lang* for each element, RSS1-none, `RSS2-language`_. +Equivalents: `ezcFeed-language`_, ATOM-*xml:lang* for each element, RSS1-none, +`RSS2-language`_. .. _RSS2-lastBuildDate: @@ -1299,7 +1354,8 @@ Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``). -Equivalents: `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_. +Equivalents: `ezcFeed-updated`_, `ATOM-updated`_, RSS1-none, +`RSS2-lastBuildDate`_. .. _RSS2-link: @@ -1313,7 +1369,7 @@ Can appear only once. -Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_. +Equivalents: `ezcFeed-link`_, `ATOM-link`_, `RSS1-link`_, `RSS2-link`_. .. _RSS2-managingEditor: @@ -1332,7 +1388,8 @@ <managingEditor>[EMAIL PROTECTED] (John Doe)</managingEditor> -Equivalents: `ATOM-author`_, RSS1-none, `RSS2-managingEditor`_. +Equivalents: `ezcFeed-author`_, `ATOM-author`_, RSS1-none, +`RSS2-managingEditor`_. .. _RSS2-rating: @@ -1346,7 +1403,7 @@ Can appear only once. -Equivalents: ATOM-none, RSS1-none, `RSS2-rating`_. +Equivalents: `ezcFeed-rating`_, ATOM-none, RSS1-none, `RSS2-rating`_. .. _RSS2-skipDays: @@ -1363,7 +1420,7 @@ Can have up to 7 *day* elements, each with a value from ``Monday`` to ``Sunday``. -Equivalents: ATOM-none, RSS1-none, `RSS2-skipDays`_. +Equivalents: `ezcFeed-skipDays`_, ATOM-none, RSS1-none, `RSS2-skipDays`_. .. _RSS2-skipHours: @@ -1379,9 +1436,9 @@ Can appear only once. Can have up to 24 *hour* elements, each with an integer value from `` 0`` -(midnight) to ``23``. - -Equivalents: ATOM-none, RSS1-none, `RSS2-skipHours`_. +(midnight) to ``23``. The value ``24`` can also be used for midnight. + +Equivalents: `ezcFeed-skipHours`_, ATOM-none, RSS1-none, `RSS2-skipHours`_. .. _RSS2-textInput: @@ -1397,7 +1454,8 @@ Has four required sub-elements: *title*, *description*, *name*, *link*. -Equivalents: ATOM-none, `RSS1-textinput`_, `RSS2-textInput`_. +Equivalents: `ezcFeed-textInput`_, ATOM-none, `RSS1-textinput`_, +`RSS2-textInput`_. .. _RSS2-title: @@ -1412,7 +1470,7 @@ Can appear only once. -Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_. +Equivalents: `ezcFeed-title`_, `ATOM-title`_, `RSS1-title`_, `RSS2-title`_. .. _RSS2-ttl: @@ -1427,7 +1485,7 @@ Can appear only once. -Equivalents: ATOM-none, RSS1-none, `RSS2-ttl`_. +Equivalents: `ezcFeed-ttl`_, ATOM-none, RSS1-none, `RSS2-ttl`_. .. _RSS2-webMaster: @@ -1446,7 +1504,7 @@ <webMaster>[EMAIL PROTECTED] (John Doe)</webMaster> -Equivalents: ATOM-none, RSS1-none, `RSS2-webMaster`_. +Equivalents: `ezcFeed-webMaster`_, ATOM-none, RSS1-none, `RSS2-webMaster`_. Item elements @@ -1468,7 +1526,8 @@ <author>[EMAIL PROTECTED] (John Doe)</author> -Equivalents: `ATOM-entry-author`_, RSS1-none, `RSS2-item-author`_. +Equivalents: `ezcFeed-item-author`_, `ATOM-entry-author`_, RSS1-none, +`RSS2-item-author`_. .. _RSS2-item-category: @@ -1486,7 +1545,8 @@ The value of the category element must be specified. -Equivalents: `ATOM-entry-category`_, RSS1-none, `RSS2-item-category`_. +Equivalents: `ezcFeed-item-category`_, `ATOM-entry-category`_, RSS1-none, +`RSS2-item-category`_. .. _RSS2-item-comments: @@ -1500,7 +1560,8 @@ Can appear only once. -Equivalents: ATOM-none, RSS1-none, `RSS2-item-comments`_. +Equivalents: `ezcFeed-item-comments`_, ATOM-none, RSS1-none, +`RSS2-item-comments`_. .. _RSS2-item-description: @@ -1514,8 +1575,8 @@ Can appear only once. -Equivalents: `ATOM-entry-summary`_, `RSS1-item-description`_, -`RSS2-item-description`_. +Equivalents: `ezcFeed-item-description`_, `ATOM-entry-summary`_, +`RSS1-item-description`_, `RSS2-item-description`_. .. _RSS2-item-enclosure: @@ -1531,7 +1592,8 @@ Has 3 required attributes: *url*, *length*, *type*. -Equivalents: `ATOM-entry-link`_, RSS1-none, `RSS2-item-enclosure`_. +Equivalents: `ezcFeed-item-enclosure`_, `ATOM-entry-link`_, RSS1-none, +`RSS2-item-enclosure`_. .. _RSS2-item-guid: @@ -1549,7 +1611,8 @@ Has an optional attribute *isPermaLink* with possible values ``true`` or ``false`` (default), which specifies if the *guid* value is an URL. -Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_. +Equivalents: `ezcFeed-item-id`_, `ATOM-entry-id`_, `RSS1-item-about`_, +`RSS2-item-guid`_. .. _RSS2-item-link: @@ -1563,7 +1626,8 @@ Can appear only once. -Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_. +Equivalents: `ezcFeed-item-link`_, `ATOM-entry-link`_, `RSS1-item-link`_, +`RSS2-item-link`_. .. _RSS2-item-pubDate: @@ -1579,7 +1643,8 @@ Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``). -Equivalents: `ATOM-entry-published`_, RSS1-none, `RSS2-item-pubDate`_. +Equivalents: `ezcFeed-item-published`_, `ATOM-entry-published`_, RSS1-none, +`RSS2-item-pubDate`_. .. _RSS2-item-title: @@ -1593,7 +1658,8 @@ Can appear only once. -Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_. +Equivalents: `ezcFeed-item-title`_, `ATOM-entry-title`_, `RSS1-item-title`_, +`RSS2-item-title`_. Resources @@ -1642,6 +1708,7 @@ .. |ezcFeed-item-contributor| replace:: contributor .. |ezcFeed-item-copyright| replace:: copyright .. |ezcFeed-item-description| replace:: description +.. |ezcFeed-item-enclosure| replace:: enclosure .. |ezcFeed-item-id| replace:: id .. |ezcFeed-item-link| replace:: link .. |ezcFeed-item-published| replace:: published -- svn-components mailing list svn-components@lists.ez.no http://lists.ez.no/mailman/listinfo/svn-components