Author: as
Date: Fri Jan 18 13:51:26 2008
New Revision: 7179
Log:
- Alphabetical sorting of descriptions.
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] Fri Jan 18 13:51:26 2008
@@ -118,52 +118,6 @@
Feed elements
-------------
-.. _ATOM-id:
-
-ATOM/id
-```````
-
-A universally unique and permanent URI for a feed. For example, it can be an
-Internet domain name.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-id`_, `RSS1-about`_, RSS2-none.
-
-
-.. _ATOM-title:
-
-ATOM/title
-``````````
-
-Human readable title for the feed. For example, it can be the same as the
-website title.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_.
-
-
-.. _ATOM-updated:
-
-ATOM/updated
-````````````
-
-The last time the feed was updated.
-
-Required.
-
-Can appear only once.
-
-Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``).
-
-Equivalents: `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_.
-
-
.. _ATOM-author:
ATOM/author
@@ -189,6 +143,35 @@
Equivalents: `ATOM-author`_, RSS1-none, `RSS2-managingEditor`_.
+.. _ATOM-entry:
+
+ATOM/entry
+``````````
+
+Feed entry.
+
+Optional.
+
+Multiple entries can appear.
+
+Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_.
+
+
+.. _ATOM-id:
+
+ATOM/id
+```````
+
+A universally unique and permanent URI for a feed. For example, it can be an
+Internet domain name.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-id`_, `RSS1-about`_, RSS2-none.
+
+
.. _ATOM-link:
ATOM/link
@@ -210,20 +193,6 @@
Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_.
-.. _ATOM-entry:
-
-ATOM/entry
-``````````
-
-Feed entry.
-
-Optional.
-
-Multiple entries can appear.
-
-Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_.
-
-
.. _ATOM-subtitle:
ATOM/subtitle
@@ -238,56 +207,39 @@
Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_.
+.. _ATOM-title:
+
+ATOM/title
+``````````
+
+Human readable title for the feed. For example, it can be the same as the
+website title.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_.
+
+
+.. _ATOM-updated:
+
+ATOM/updated
+````````````
+
+The last time the feed was updated.
+
+Required.
+
+Can appear only once.
+
+Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``).
+
+Equivalents: `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_.
+
+
Item elements
-------------
-
-.. _ATOM-entry-id:
-
-ATOM/entry/id
-`````````````
-
-A unique identifier in respect to other *id* values of entries in the feed. It
-identifies the entry.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_.
-
-
-.. _ATOM-entry-title:
-
-ATOM/entry/title
-````````````````
-
-A title for the feed item.
-
-Required.
-
-Can appear only once.
-
-Has an optional attribute *type* with possible values ``text`` (default),
-``html``, ``xml``.
-
-Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_.
-
-
-.. _ATOM-entry-updated:
-
-ATOM/entry/updated
-``````````````````
-
-The last time the feed entry was updated.
-
-Required.
-
-Can appear only once.
-
-Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``).
-
-Equivalents: `ATOM-entry-updated`_, RSS1-none, `RSS2-item-pubDate`_.
-
.. _ATOM-entry-author:
@@ -314,6 +266,54 @@
Equivalents: `ATOM-entry-author`_, RSS1-none, `RSS2-item-author`_.
+.. _ATOM-entry-content:
+
+ATOM/entry/content
+``````````````````
+
+A short description for the feed item.
+
+Required. Can be substituted with |ATOM-entry-summary|_ (recommended).
+
+Can appear only once.
+
+Has an optional attribute *type* with possible values ``text`` (default),
+``html``, ``xhtml``.
+
+Has an optional attribute *src* which specifies the URI where the full content
+is located.
+
+If *src* is present, the *type* attribute, if present, is the media type of the
+content.
+
+Otherwise, if the type attribute ends in ``+xml`` or ``/xml``, then an XML
+document of this type is contained inline.
+
+Otherwise, if the type attribute starts with ``text``, then an escaped document
+of this type is contained inline.
+
+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`_.
+
+
+.. _ATOM-entry-id:
+
+ATOM/entry/id
+`````````````
+
+A unique identifier in respect to other *id* values of entries in the feed. It
+identifies the entry.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_.
+
+
.. _ATOM-entry-link:
ATOM/entry/link
@@ -353,37 +353,37 @@
`RSS2-item-description`_.
-.. _ATOM-entry-content:
-
-ATOM/entry/content
+.. _ATOM-entry-title:
+
+ATOM/entry/title
+````````````````
+
+A title for the feed item.
+
+Required.
+
+Can appear only once.
+
+Has an optional attribute *type* with possible values ``text`` (default),
+``html``, ``xml``.
+
+Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_.
+
+
+.. _ATOM-entry-updated:
+
+ATOM/entry/updated
``````````````````
-A short description for the feed item.
-
-Required. Can be substituted with |ATOM-entry-summary|_ (recommended).
-
-Can appear only once.
-
-Has an optional attribute *type* with possible values ``text`` (default),
-``html``, ``xhtml``.
-
-Has an optional attribute *src* which specifies the URI where the full content
-is located.
-
-If *src* is present, the *type* attribute, if present, is the media type of the
-content.
-
-Otherwise, if the type attribute ends in ``+xml`` or ``/xml``, then an XML
-document of this type is contained inline.
-
-Otherwise, if the type attribute starts with ``text``, then an escaped document
-of this type is contained inline.
-
-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`_.
+The last time the feed entry was updated.
+
+Required.
+
+Can appear only once.
+
+Must conform to `RFC 3339`_ (eg. ``2003-12-13T18:30:02Z``).
+
+Equivalents: `ATOM-entry-updated`_, RSS1-none, `RSS2-item-pubDate`_.
RSS1
@@ -413,6 +413,48 @@
Equivalents: `ATOM-id`_, `RSS1-about`_, RSS2-none.
+.. _RSS1-description:
+
+RSS1/description
+````````````````
+
+A short description of the feed.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_.
+
+
+.. _RSS1-item:
+
+RSS1/item
+`````````
+
+Feed entry.
+
+Required.
+
+Multiple entries can appear.
+
+Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_.
+
+
+.. _RSS1-link:
+
+RSS1/link
+`````````
+
+The URL to the HTML website corresponding to the channel.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_.
+
+
.. _RSS1-title:
RSS1/title
@@ -426,48 +468,6 @@
Can appear only once.
Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_.
-
-
-.. _RSS1-description:
-
-RSS1/description
-````````````````
-
-A short description of the feed.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_.
-
-
-.. _RSS1-link:
-
-RSS1/link
-`````````
-
-The URL to the HTML website corresponding to the channel.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_.
-
-
-.. _RSS1-item:
-
-RSS1/item
-`````````
-
-Feed entry.
-
-Required.
-
-Multiple entries can appear.
-
-Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_.
Item elements
@@ -489,6 +489,35 @@
Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_.
+.. _RSS1-item-description:
+
+RSS1/item/description
+`````````````````````
+
+A short description of the feed item.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-entry-summary`_, `RSS1-item-description`_,
+`RSS2-item-description`_.
+
+
+.. _RSS1-item-link:
+
+RSS1/item/link
+``````````````
+
+The URL to the HTML website corresponding to the feed item.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_.
+
+
.. _RSS1-item-title:
RSS1/item/title
@@ -503,23 +532,130 @@
Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_.
-.. _RSS1-item-link:
-
-RSS1/item/link
-``````````````
-
-The URL to the HTML website corresponding to the feed item.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_.
-
-
-.. _RSS1-item-description:
-
-RSS1/item/description
+RSS2
+====
+
+Specifications
+--------------
+
+`RSS1`_
+
+
+Feed elements
+-------------
+
+.. _RSS2-description:
+
+RSS2/description
+````````````````
+
+A short description of the feed.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_.
+
+
+.. _RSS2-item:
+
+RSS2/item
+`````````
+
+Feed entry.
+
+Required.
+
+Multiple entries can appear.
+
+Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_.
+
+
+.. _RSS2-lastBuildDate:
+
+RSS2/lastBuildDate
+``````````````````
+
+The last time the feed was updated.
+
+Optional.
+
+Can appear only once.
+
+Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``).
+
+Equivalents: `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_.
+
+
+.. _RSS2-link:
+
+RSS2/link
+`````````
+
+The URL to the HTML website corresponding to the channel.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_.
+
+
+.. _RSS2-managingEditor:
+
+RSS2/managingEditor
+```````````````````
+
+One author of the feed.
+
+Optional.
+
+Can appear only once.
+
+Equivalents: `ATOM-author`_, RSS1-none, `RSS2-managingEditor`_.
+
+
+.. _RSS2-title:
+
+RSS2/title
+``````````
+
+Human readable title for the feed. For example, it can be the same as the
+website title.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_.
+
+
+Item elements
+-------------
+
+.. _RSS2-item-author:
+
+RSS2/item/author
+````````````````
+
+The email address of the person who created the feed item.
+
+Optional.
+
+Can appear only once.
+
+It is a good practice to include the name and email of the author, for
+example::
+
+ <author>John Doe ([EMAIL PROTECTED])</author>
+
+Equivalents: `ATOM-entry-author`_, RSS1-none, `RSS2-item-author`_.
+
+
+.. _RSS2-item-description:
+
+RSS2/item/description
`````````````````````
A short description of the feed item.
@@ -532,108 +668,6 @@
`RSS2-item-description`_.
-RSS2
-====
-
-Specifications
---------------
-
-`RSS1`_
-
-
-Feed elements
--------------
-
-.. _RSS2-title:
-
-RSS2/title
-``````````
-
-Human readable title for the feed. For example, it can be the same as the
-website title.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-title`_, `RSS1-title`_, `RSS2-title`_.
-
-
-.. _RSS2-description:
-
-RSS2/description
-````````````````
-
-A short description of the feed.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-subtitle`_, `RSS1-description`_, `RSS2-description`_.
-
-
-.. _RSS2-link:
-
-RSS2/link
-`````````
-
-The URL to the HTML website corresponding to the channel.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-link`_, `RSS1-link`_, `RSS2-link`_.
-
-
-.. _RSS2-item:
-
-RSS2/item
-`````````
-
-Feed entry.
-
-Required.
-
-Multiple entries can appear.
-
-Equivalents: `ATOM-entry`_, `RSS1-item`_, `RSS2-item`_.
-
-
-.. _RSS2-lastBuildDate:
-
-RSS2/lastBuildDate
-``````````````````
-
-The last time the feed was updated.
-
-Optional.
-
-Can appear only once.
-
-Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``).
-
-Equivalents: `ATOM-updated`_, RSS1-none, `RSS2-lastBuildDate`_.
-
-
-.. _RSS2-managingEditor:
-
-RSS2/managingEditor
-```````````````````
-
-One author of the feed.
-
-Optional.
-
-Can appear only once.
-
-Equivalents: `ATOM-author`_, RSS1-none, `RSS2-managingEditor`_.
-
-
-Item elements
--------------
-
.. _RSS2-item-guid:
RSS2/item/guid
@@ -652,6 +686,36 @@
Equivalents: `ATOM-entry-id`_, `RSS1-item-about`_, `RSS2-item-guid`_.
+.. _RSS2-item-link:
+
+RSS2/item/link
+``````````````
+
+The URL to the HTML website corresponding to the feed item.
+
+Required.
+
+Can appear only once.
+
+Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_.
+
+
+.. _RSS2-item-pubDate:
+
+RSS2/item/pubDate
+`````````````````
+
+The last time the feed item was updated.
+
+Optional.
+
+Can appear only once.
+
+Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``).
+
+Equivalents: `ATOM-entry-updated`_, RSS1-none, `RSS2-item-pubDate`_.
+
+
.. _RSS2-item-title:
RSS2/item/title
@@ -664,70 +728,6 @@
Can appear only once.
Equivalents: `ATOM-entry-title`_, `RSS1-item-title`_, `RSS2-item-title`_.
-
-
-.. _RSS2-item-pubDate:
-
-RSS2/item/pubDate
-`````````````````
-
-The last time the feed item was updated.
-
-Optional.
-
-Can appear only once.
-
-Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``).
-
-Equivalents: `ATOM-entry-updated`_, RSS1-none, `RSS2-item-pubDate`_.
-
-
-.. _RSS2-item-author:
-
-RSS2/item/author
-````````````````
-
-The email address of the person who created the feed item.
-
-Optional.
-
-Can appear only once.
-
-It is a good practice to include the name and email of the author, for
-example::
-
- <author>John Doe ([EMAIL PROTECTED])</author>
-
-Equivalents: `ATOM-entry-author`_, RSS1-none, `RSS2-item-author`_.
-
-
-.. _RSS2-item-link:
-
-RSS2/item/link
-``````````````
-
-The URL to the HTML website corresponding to the feed item.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-entry-link`_, `RSS1-item-link`_, `RSS2-item-link`_.
-
-
-.. _RSS2-item-description:
-
-RSS2/item/description
-`````````````````````
-
-A short description of the feed item.
-
-Required.
-
-Can appear only once.
-
-Equivalents: `ATOM-entry-summary`_, `RSS1-item-description`_,
-`RSS2-item-description`_.
Resources
--
svn-components mailing list
[EMAIL PROTECTED]
http://lists.ez.no/mailman/listinfo/svn-components
