Author: as
Date: Mon Feb  4 13:12:34 2008
New Revision: 7281

Log:
- Added documentation for RSS2 pubDate element.

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] Mon Feb  4 13:12:34 2008
@@ -44,6 +44,8 @@
 | |ezcFeed-skipDays|_ ?      | x                       | x                     
     | |RSS2-skipDays|_ ?        |
 
+----------------------------+-------------------------+----------------------------+---------------------------+
 | |ezcFeed-rating|_ ?        | x                       | x                     
     | |RSS2-rating|_ ?          |
++----------------------------+-------------------------+----------------------------+---------------------------+
+| |ezcFeed-published|_ ?     | x                       | x                     
     | |RSS2-pubDate|_ ?         |
 
+----------------------------+-------------------------+----------------------------+---------------------------+
 | |ezcFeed-cloud|_ ?         | x                       | x                     
     | |RSS2-cloud|_ ?           |
 
+----------------------------+-------------------------+----------------------------+---------------------------+
@@ -256,6 +258,33 @@
 
 ezcFeed-link
 ````````````
+
+
+ezcFeed-published
+`````````````````
+
+The time the feed was published.
+
+Optional (not recommended). Only `RSS2`_ feeds will have this element after
+generating the feed. It will be ignored for the other feed types
+(`RSS1`_, `ATOM`_).
+
+Can appear only once.
+
+Must conform be a Unix timestamp. It will be converted to the datetime format
+required by each feed type.
+
+Create example::
+
+  // $feed is an ezcFeed object
+  $feed->published = now();
+
+Parse example::
+
+  // $feed is an ezcFeed object
+  $published = $feed->published;
+
+Equivalents: `ezcFeed-published`_, ATOM-none, RSS1-none, `RSS2-pubDate`_.
 
 
 ezcFeed-rating
@@ -1459,6 +1488,20 @@
 `RSS2-managingEditor`_.
 
 
+RSS2-pubDate
+````````````
+
+The time the feed was published.
+
+Optional (not recommended).
+
+Can appear only once.
+
+Must conform to `RFC 822`_ (eg. ``Sat, 07 Sep 2002 09:42:31 GMT``).
+
+Equivalents: `ezcFeed-published`_, ATOM-none, RSS1-none, `RSS2-pubDate`_.
+
+
 RSS2-rating
 ```````````
 
@@ -1728,6 +1771,7 @@
 .. |ezcFeed-item| replace:: item
 .. |ezcFeed-language| replace:: language
 .. |ezcFeed-link| replace:: link
+.. |ezcFeed-published| replace:: published
 .. |ezcFeed-rating| replace:: rating
 .. |ezcFeed-skipDays| replace:: skipDays
 .. |ezcFeed-skipHours| replace:: skipHours
@@ -1800,6 +1844,7 @@
 .. |RSS2-lastBuildDate| replace:: lastBuildDate
 .. |RSS2-link| replace:: link
 .. |RSS2-managingEditor| replace:: managingEditor
+.. |RSS2-pubDate| replace:: pubDate
 .. |RSS2-rating| replace:: rating
 .. |RSS2-skipDays| replace:: skipDays
 .. |RSS2-skipHours| replace:: skipHours


-- 
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components

Reply via email to