reference-entry-summary.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .. _reference.entry.summary:
  2. :py:attr:`entries[i].summary`
  3. =============================
  4. A summary of the entry.
  5. If this contains :abbr:`HTML (HyperText Markup Language)` or :abbr:`XHTML
  6. (Extensible HyperText Markup Language)`, it is :ref:`sanitized
  7. <advanced.sanitization>` by default.
  8. If this contains :abbr:`HTML (HyperText Markup Language)` or :abbr:`XHTML
  9. (Extensible HyperText Markup Language)`, certain (X)HTML elements within this
  10. value may contain relative :abbr:`URI (Uniform Resource Identifier)`\s. If so,
  11. they are :ref:`resolved according to a set of rules <advanced.base>`.
  12. Some publishing systems auto-generate this value from the first few words or
  13. first paragraph of the entry. Other publishing systems misuse it to include
  14. the full content. In the latter cases, :program:`Universal Feed Parser` ought
  15. to detect it and put the value in :ref:`reference.entry.content` instead, but
  16. it doesn't.
  17. .. note::
  18. Some feeds include both a summary and description element for each entry. In
  19. this case, the first element will be available in ``entry['summary']`` and the
  20. second will be available in ``entry['content'][0]``.
  21. .. rubric:: Comes from
  22. * /atom10:feed/atom10:entry/atom10:summary
  23. * /atom03:feed/atom03:entry/atom03:summary
  24. * /rss/channel/item/description
  25. * /rss/channel/item/dc:description
  26. * /rdf:RDF/rdf:item/rdf:description
  27. * /rdf:RDF/rdf:item/dc:description
  28. .. seealso::
  29. * :ref:`reference.entry.summary_detail`