Add itemTitle parameter to atomFeed for per-entry title policy#53
Draft
deverman wants to merge 1 commit into
Draft
Add itemTitle parameter to atomFeed for per-entry title policy#53deverman wants to merge 1 commit into
deverman wants to merge 1 commit into
Conversation
Entry titles were always item.title, which carries the raw parsed title (including Markdown emphasis markers from readers that keep them) and prevents sites from applying an SEO-title policy to feed entries. itemTitle is an optional closure in the same style as the existing summary: and image: parameters, defaulting to the item's title so existing call sites are unaffected. Adds the first atomFeed test, covering both the default and the override.
Member
|
This looks great! Is there a reason it's marked as draft? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
atomFeedalready acceptssummary:,image:, anddateKeyPath:closures, but entry titles are alwaysitem.title— the raw parsed title. That blocks two real cases: readers that keep Markdown emphasis markers in extracted titles (# A _great_ titleships with literal underscores), and sites whose feed titles follow an SEO-title policy from front matter rather than the visible H1.This adds an optional
itemTitle: (Item<M>) -> Stringclosure in the same style as the existing parameters. When omitted, behavior is unchanged, so existing call sites are unaffected. Also adds the first test coverage foratomFeed(default and override) and updates the symbol reference in the Custom Feed Formats guide.Context: deverman.org currently maintains a near-copy of
atomFeedsolely to apply its title policy; with this parameter that copy gets deleted.