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.

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

feeds: (json feeds) Add more specific item fields #43

Open
davidsneighbour opened this issue Dec 22, 2021 · 0 comments
Open

feeds: (json feeds) Add more specific item fields #43

davidsneighbour opened this issue Dec 22, 2021 · 0 comments
Assignees
Labels
module:feeds state:confirmed This issue is confirmed. type:enhancement New enhancements and features.

Comments

@davidsneighbour
Copy link
Owner

  • external_url (very optional, string) is the URL of a page elsewhere. This is especially useful for linkblogs. If url links to where you’re talking about a thing, then external_url links to the thing you’re talking about.
  • summary (optional, string) is a plain text sentence or two describing the item. This might be presented in a timeline, for instance, where a detail view would display all of content_html or content_text.
  • image (optional, string) is the URL of the main image for the item. This image may also appear in the content_html — if so, it’s a hint to the feed reader that this is the main, featured image. Feed readers may use the image as a preview (probably resized as a thumbnail and placed in a timeline).
  • banner_image (optional, string) is the URL of an image to use as a banner. Some blogging systems (such as Medium) display a different banner image chosen to go with each post, but that image wouldn’t otherwise appear in the content_html. A feed reader with a detail view may choose to show this banner image at the top of the detail view, possibly with the title overlaid.
  • authors
  • tags (optional, array of strings) can have any plain text values you want. Tags tend to be just one word, but they may be anything. Note: they are not the equivalent of Twitter hashtags. Some blogging systems and other feed formats call these categories.
  • language (optional, string) is the language for this item, using the same format as the top-level language field. The value can be different than the primary language for the feed when a specific item is written in a different language than other items in the feed.
  • attachments (optional, array) lists related resources. Podcasts, for instance, would include an attachment that’s an audio or video file. Each attachment has several members:
    • url (required, string) specifies the location of the attachment.
    • mime_type (required, string) specifies the type of the attachment, such as “audio/mpeg.”
    • title (optional, string) is a name for the attachment. Important: if there are multiple attachments, and two or more have the exact same title (when title is present), then they are considered as alternate representations of the same thing. In this way a podcaster, for instance, might provide an audio recording in different formats.
    • size_in_bytes (optional, number) specifies how large the file is.
    • duration_in_seconds (optional, number) specifies how long it takes to listen to or watch, when played at normal speed.
@davidsneighbour davidsneighbour self-assigned this Dec 22, 2021
@davidsneighbour davidsneighbour changed the title JSON Feed: Add more specific item fields hugo-feeds: (json feeds) Add more specific item fields Apr 3, 2023
@davidsneighbour davidsneighbour transferred this issue from davidsneighbour/hugo-feeds Apr 3, 2023
@davidsneighbour davidsneighbour changed the title hugo-feeds: (json feeds) Add more specific item fields feeds: (json feeds) Add more specific item fields Mar 3, 2024
@davidsneighbour davidsneighbour added state:unconfirmed This issue needs to be reproduced. module:feeds state:confirmed This issue is confirmed. type:enhancement New enhancements and features. and removed state:unconfirmed This issue needs to be reproduced. labels Aug 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module:feeds state:confirmed This issue is confirmed. type:enhancement New enhancements and features.
Projects
None yet
Development

No branches or pull requests

1 participant