Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify relative references in on img tags #116

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarify relative references in on img tags #116

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15e1bce
Clarify relative references in on `img` tags
cleverdevil Jan 12, 2018
9883496
Clarify for additional non-img elements.
cleverdevil Jan 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pages/version/1.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<img>` 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 <a name="suggestions-for-feed-readers"></a>

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.
Expand All @@ -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 `<img>` 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 <a name="discovery"></a>

A web page should include a `link` tag that specifies the location of the JSON Feed. Like this:
Expand Down