annotated-rss20.rst 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. _annotated.rss20:
  2. :abbr:`RSS (Rich Site Summary)` 2.0
  3. ===================================
  4. This is a sample :abbr:`RSS (Rich Site Summary)` 2.0 feed, annotated with links
  5. that show how each value can be accessed once the feed is parsed.
  6. .. caution::
  7. Even though many of these elements are required according to the specification,
  8. real-world feeds may be missing any element. If an element is not present in
  9. the feed, it will not be present in the parsed results. You should not rely on
  10. any particular element being present.
  11. .. rubric:: Annotated :abbr:`RSS (Rich Site Summary)` 2.0 feed
  12. .. container:: pre
  13. <?xml version="1.0" encoding=":ref:`utf-8 <reference.encoding>`"?>
  14. <rss version=":ref:`2.0 <reference.version>`">
  15. <channel>
  16. <title>\ :ref:`Sample Feed <reference.feed.title>`\</title>
  17. <description>\ :ref:`For documentation &lt;em&gt;only&lt;/em&gt; <reference.feed.subtitle>`\</description>
  18. <link>\ :ref:`http://example.org/ <reference.feed.link>`\</link>
  19. <language>\ :ref:`en <reference.feed.language>`\</language>
  20. <copyright>\ :ref:`Copyright 2004, Mark Pilgrim <reference.feed.rights>`\</copyright>
  21. <managingEditor>\ :ref:`editor@example.org <reference.feed.author>`\</managingEditor>
  22. <webMaster>\ :ref:`webmaster@example.org <reference.feed.publisher>`\</webMaster>
  23. <pubDate>\ :ref:`Sat, 07 Sep 2002 0:00:01 GMT <reference.feed.published>`\</pubDate>
  24. <category>\ :ref:`Examples <reference.feed.tags.term>`\</category>
  25. <generator>\ :ref:`Sample Toolkit <reference.feed.generator>`\</generator>
  26. <docs>\ :ref:`http://feedvalidator.org/docs/rss2.html <reference.feed.docs>`\</docs>
  27. <cloud domain=":ref:`rpc.example.com <reference.feed.cloud.domain>`"
  28. port=":ref:`80 <reference.feed.cloud.port>`"
  29. path=":ref:`/RPC2 <reference.feed.cloud.path>`"
  30. registerProcedure=":ref:`pingMe <reference.feed.cloud.registerProcedure>`"
  31. protocol=":ref:`soap <reference.feed.cloud.protocol>`"/>
  32. <ttl>\ :ref:`60 <reference.feed.ttl>`\</ttl>
  33. <image>
  34. <url>\ :ref:`http://example.org/banner.png <reference.feed.image.href>`\</url>
  35. <title>\ :ref:`Example banner <reference.feed.image.title>`\</title>
  36. <link>\ :ref:`http://example.org/ <reference.feed.image.link>`\</link>
  37. <width>\ :ref:`80 <reference.feed.image.width>`\</width>
  38. <height>\ :ref:`15 <reference.feed.image.height>`\</height>
  39. </image>
  40. <textInput>
  41. <title>\ :ref:`Search <reference.feed.textinput.title>`\</title>
  42. <description>\ :ref:`Search this site: <reference.feed.textinput.description>`\</description>
  43. <name>\ :ref:`q <reference.feed.textinput.name>`\</name>
  44. <link>\ :ref:`http://example.org/mt/mt-search.cgi <reference.feed.textinput.link>`\</link>
  45. </textInput>
  46. <item>
  47. <title>\ :ref:`First item title <reference.entry.title>`\</title>
  48. <link>\ :ref:`http://example.org/item/1 <reference.entry.link>`\</link>
  49. <description>\ :ref:`Watch out for
  50. &lt;span style="background: url(javascript:window.location='http://example.org/')"&gt;
  51. nasty tricks&lt;/span&gt; <reference.entry.summary>`
  52. </description>
  53. <author>\ :ref:`mark@example.org <reference.entry.author>`\</author>
  54. <category>\ :ref:`Miscellaneous <reference.entry.tags.term>`\</category>
  55. <comments>\ :ref:`http://example.org/comments/1 <reference.entry.comments>`\</comments>
  56. <enclosure url=":ref:`http://example.org/audio/demo.mp3 <reference.entry.enclosures.href>`" length=":ref:`1069871 <reference.entry.enclosures.length>`" type=":ref:`audio/mpeg <reference.entry.enclosures.type>`"/>
  57. <guid>\ :ref:`http://example.org/guid/1 <reference.entry.id>`\</guid>
  58. <pubDate>\ :ref:`Thu, 05 Sep 2002 0:00:01 GMT <reference.entry.published>`\</pubDate>
  59. </item>
  60. </channel>
  61. </rss>