From 15e1bcefa082ffc6e610c770d470cb8fa8b2a30c Mon Sep 17 00:00:00 2001 From: Jonathan LaCour Date: Fri, 12 Jan 2018 12:35:14 -0800 Subject: [PATCH 1/2] Clarify relative references in on `img` tags --- pages/version/1.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pages/version/1.markdown b/pages/version/1.markdown index 1405c8a3..fcd2fb90 100644 --- a/pages/version/1.markdown +++ b/pages/version/1.markdown @@ -187,6 +187,8 @@ JSON Feeds should be encoded using UTF-8 — but any encoding that’s [legal JS Any publisher already publishing RSS and/or Atom should continue to do so. In fact, if you’re trying to decide which format (of RSS, Atom, and JSON Feed) to use, and you can do only one, pick RSS — it’s time-tested, popular, and good. +Publishers that include HTML content via the `content_html` property may include `` tags that reference images by relative path, though it is preferred to provide full URLs for referenced content. Relative paths should be based upon the associated item's `url` property. + ## Suggestions for Feed Readers If a feed is invalid JSON, then we strongly recommend not attempting to parse it or use partial data. You can’t rely on it. @@ -205,6 +207,8 @@ Feed readers are strongly advised to use [Conditional GET](https://fishbowl.past On the issue of which URL to use — `url` or `external_url` — when opening a web page: because an item’s `url` is always a permalink, the `url` should be the default. For linkblogs that include an `external_url`, feed readers may give users a choice which URL to open: perhaps by displaying the `external_url` prominently in the UI, perhaps by a preference to use these URLs when present, or by some other mechanism. +For feeds that include HTML content in an item via the `content_html` property, publishers may include `` tags that reference images by relative path. Consumers of JSON Feed should interpret those relative paths based upon the item's `url` property. + ### Discovery A web page should include a `link` tag that specifies the location of the JSON Feed. Like this: From 9883496f4a799424e9f97e4c9d860f6c69231ea9 Mon Sep 17 00:00:00 2001 From: Jonathan LaCour Date: Fri, 12 Jan 2018 14:24:58 -0800 Subject: [PATCH 2/2] Clarify for additional non-img elements. --- pages/version/1.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/version/1.markdown b/pages/version/1.markdown index fcd2fb90..7bed841b 100644 --- a/pages/version/1.markdown +++ b/pages/version/1.markdown @@ -187,7 +187,7 @@ JSON Feeds should be encoded using UTF-8 — but any encoding that’s [legal JS Any publisher already publishing RSS and/or Atom should continue to do so. In fact, if you’re trying to decide which format (of RSS, Atom, and JSON Feed) to use, and you can do only one, pick RSS — it’s time-tested, popular, and good. -Publishers that include HTML content via the `content_html` property may include `` tags that reference images by relative path, though it is preferred to provide full URLs for referenced content. Relative paths should be based upon the associated item's `url` property. +Publishers that include HTML content via the `content_html` property may include `` tags and other tags that reference resources by relative path, though it is preferred to provide full URLs for referenced content. Relative paths should be based upon the associated item's `url` property. ## Suggestions for Feed Readers @@ -207,7 +207,7 @@ Feed readers are strongly advised to use [Conditional GET](https://fishbowl.past On the issue of which URL to use — `url` or `external_url` — when opening a web page: because an item’s `url` is always a permalink, the `url` should be the default. For linkblogs that include an `external_url`, feed readers may give users a choice which URL to open: perhaps by displaying the `external_url` prominently in the UI, perhaps by a preference to use these URLs when present, or by some other mechanism. -For feeds that include HTML content in an item via the `content_html` property, publishers may include `` tags that reference images by relative path. Consumers of JSON Feed should interpret those relative paths based upon the item's `url` property. +For feeds that include HTML content in an item via the `content_html` property, publishers may include `` tags and other tags that reference resources by relative path. Consumers of JSON Feed should interpret those relative paths based upon the item's `url` property. ### Discovery