Skip to content

Commit

Permalink
readme updates with new/changed block features
Browse files Browse the repository at this point in the history
  • Loading branch information
cr0ybot committed Mar 24, 2023
1 parent 59c5563 commit f32f2ab
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 5 deletions.
40 changes: 35 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,58 @@ Inside the Feed Item Template block, you can add the blocks below to display par

### Feed Item Title

The Feed Item Title block is used to display the title of a feed item. It is similar to the Post Title block, but instead of displaying the title of a post, it displays the title of a feed item.
The Feed Item Title block is used to display the title of a feed item. It is similar to the Post Title block.

You can also choose to display the contents of a custom tag instead of the default title.

The title can optionally link to the feed item's URL, and includes other typography settings.

### Feed Item Content

The Feed Item Content block is used to display the content of a feed item. It is similar to the Post Content block, but instead of displaying the content of a post, it displays the content of a feed item.
The Feed Item Content block is used to display the content of a feed item. It is similar to the Post Content block.

You can also choose to display the contents of a custom tag instead of the default content.

The content can be displayed as HTML, HTML with images removed, and plain text, and also includes other typography settings.

### Feed Item Summary

The Feed Item Summary block is used to display the summary of a feed item. It is similar to the Post Excerpt block, but instead of displaying the excerpt of a post, it displays the summary of a feed item.
The Feed Item Summary block is used to display the summary of a feed item. It is similar to the Post Excerpt block.

You can also choose to display the contents of a custom tag instead of the default content.

The summary can be limited to a certain number of words, and can optionally include a "read more" link.It also includes other typography settings.

### Feed Item Image

The Feed Item Image block is used to display the primary image of a feed item. It is similar to the Post Featured Image block.

The image can come from either an `itunes:image` tag (in the case of a podcast feed) or the first HTML `img` tag in the primary content, in that order. You can also choose a different tag that includes an HTML `img` tag, though tags with `src` or `href` attributes are not yet supported.

The image can optionally link to the feed item's URL, and includes other settings such as an optional overlay, aspect ratio, and border options.

### Feed Item Date

The Feed Item Date block is used to display the date of a feed item. It is similar to the Post Date block.

The date can be formatted using PHP date format strings, and includes other typography settings.

You can choose to display the published or modified date (if available), or the contents of a custom tag. When displaying a custom tag, additional input format options are available to read the date from the tag's contents.

### Feed Item Link

The Feed Item Link block is used to display a link to a feed item. It is similar to the Read More block.

The link can be styled with background and border options, and includes other typography settings.

It does not currently support displaying the contents of a custom tag, nor can it pull a URL from anywhere other than the feed item's main URL.

### Feed Loop - No Results

The Feed Loop - No Results block is used to display text or other blocks when no feed items are found. It is similar to the No Results block used by the Query Loop block.

## To Do

* [ ] Prevent users without `unfiltered_html` capability from using HTML format in the Feed Item Content block, or otherwise filter the HTML.
* [ ] Add support for displaying top-level feed attributes, such as title, description, icon, and authors.
* [ ] Add support for choosing custom feed tags for any of the blocks within a Feed Item Template, instead of one all-encompasing Custom Feed Item.
* [ ] Add support for getting the image source from tag attributes.
* [ ] Add support for displaying enclosure media (audio/video).
12 changes: 12 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ Make sure your user account has the `unfiltered_html` capability, often reserved

== Changelog ==

= 2023-03-23 0.4.0 =
* Breaking Change: Removed Custom Feed Item block in favor of pulling custom tag content into each available block
* Feature: Custom content in Feed Item Title block
* Feature: Custom content in Feed Item Summary block
* Feature: Custom content in Feed Item Content block
* Feature: Custom content in Feed Item Image block
* Feature: Feed Item Date block
* Feature: Feed Item Link block
* Feature: itunes:image tag checked for default image
* Fix: Feed items with links not inheriting Feed block context for rel/target values
* Fix: Better escaped output

= 2023-03-17 0.3.0 =
* Rename again to feed-block
* Feature: No Results block
Expand Down

0 comments on commit f32f2ab

Please sign in to comment.