add some initial notes - sfeed_tests - sfeed tests and RSS and Atom files | |
git clone git://git.codemadness.org/sfeed_tests | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 3008c110d07eb98413e02e57eced0d53a92b0802 | |
parent bf4a44fa6fa48c2ea0710a50f872efa5dd45360c | |
Author: Hiltjo Posthuma <[email protected]> | |
Date: Sun, 16 Apr 2023 12:59:28 +0200 | |
add some initial notes | |
Centralize them at some place. | |
Diffstat: | |
A notes/rss-title.txt | 43 ++++++++++++++++++++++++++++++ | |
A notes/specs.txt | 45 +++++++++++++++++++++++++++++… | |
2 files changed, 88 insertions(+), 0 deletions(-) | |
--- | |
diff --git a/notes/rss-title.txt b/notes/rss-title.txt | |
@@ -0,0 +1,43 @@ | |
+A note about HTML in titles | |
+--------------------------- | |
+ | |
+- RSS does not allow HTML in titles. | |
+- Atom does allow HTML in titles. | |
+- sfeed does not handle HTML in titles and will show them as plain-text. | |
+ "Atom Processors that display such content MAY use that markup to aid in its | |
+ display." | |
+ | |
+ | |
+For RSS: | |
+ | |
+HTML is not allowed in titles, it is allowed in descriptions: | |
+ https://www.rssboard.org/rss-specification | |
+ | |
+A news post of the RSS board addressing this question: | |
+ https://www.rssboard.org/news/128/html-titles-and-descriptions | |
+ | |
+Maybe the confusion comes from the fact that RSS must have either a title or a | |
+description. In some clients when there is no title the description is used | |
+and HTML is allowed in descriptions. | |
+ | |
+ | |
+For Atom: | |
+ | |
+In the Atom standard the title is not optional and it may contain HTML: | |
+ 4.2.14. The "atom:title" Element | |
+ https://datatracker.ietf.org/doc/html/rfc4287#section-4.2.14 | |
+ | |
+So an atomTextConstruct may have a HTML, XHTML or text type. The default is | |
+text. | |
+ 3.1. Text Constructs | |
+ https://datatracker.ietf.org/doc/html/rfc4287#section-3.1 | |
+ | |
+ | |
+For sfeed: | |
+ | |
+To support HTML in Atom titles this would open a rabbithole, because one should | |
+have an additional HTML parser that handles HTML, all named entities and it | |
+handle its quirks. | |
+ | |
+A foolproof work-around for broken RSS feed would not be possible since there … | |
+reliable way to tell if the item should have actual HTML or a text. | |
diff --git a/notes/specs.txt b/notes/specs.txt | |
@@ -0,0 +1,45 @@ | |
+https://www.rssboard.org/rss-specification | |
+ RSS 1.0 | |
+ RSS 0.9, 2.0 | |
+ | |
+ | |
+https://datatracker.ietf.org/doc/html/rfc4287 | |
+ Atom | |
+ | |
+ | |
+https://www.dublincore.org/specifications/dublin-core/dcmi-terms/ | |
+https://web.resource.org/rss/1.0/modules/dc/ | |
+ Dublin Core and RDF | |
+ | |
+ | |
+https://www.rssboard.org/media-rss | |
+ Media RSS (MRSS) | |
+ | |
+ | |
+Time formats: | |
+ | |
+RFC3339 Date and Time on the Internet: Timestamps: | |
+ https://www.rfc-editor.org/rfc/rfc3339 | |
+ | |
+RFC822: | |
+ https://www.rfc-editor.org/rfc/rfc822 | |
+ 5. Date and Time Specification | |
+ | |
+RFC822 obsoleted by RFC2822: | |
+ https://www.rfc-editor.org/rfc/rfc2822 | |
+ | |
+ISO 8601-1: | |
+ https://en.wikipedia.org/wiki/ISO_8601 | |
+ There might be some free and open resource someplace... | |
+ | |
+ | |
+OPML: | |
+ https://en.wikipedia.org/wiki/OPML | |
+ http://opml.org/ | |
+ | |
+ | |
+JSON Feed: | |
+ https://www.jsonfeed.org/ | |
+ | |
+ | |
+ |