Improve RSS Feed Behavior

- `partial` now prefers an explicitly provided description if available
- new `type` `metadata` will only use document metadata rather than infering descriptions

Fixes #7290

Author: dragonstyle

news/changelog-1.4.md

@@ -124,6 +124,7 @@
 - ([#7634](https://github.com/quarto-dev/quarto-cli/issues/7634)): Use an explicit width to ensure default listing layout doesn't grow outside its desired boundss
 - ([#7345](https://github.com/quarto-dev/quarto-cli/issues/7345)): Improve display of categories in a table style listing
 - ([#7699](https://github.com/quarto-dev/quarto-cli/issues/7699)): Properly ignore non-HTML output for listings when project level renders render HTML and other formats (for example, a book of both HTML and PDF format)
+- ([#7290](https://github.com/quarto-dev/quarto-cli/issues/7290)): Add support for `feed:type` of `metadata`, which will use only explicitly provided description metadata when generating an RSS feed. Additionally, note that `partial` feed types will prefer to use an explicit description over the first paragraph, when a description is available.
 
 ## Websites
 

src/project/types/website/listing/website-listing-feed.ts

@@ -181,7 +181,7 @@ export async function createFeed(
   // The core feed file is generated 'staged' with placeholders for
   // content that should be replaced with rendered version of the content
   // from fully rendered documents.
-  const stagedPath = feedPath(dir, stem, options.type === "full");
+  const stagedPath = feedPath(dir, stem, options.type);
 
   const feedFiles: string[] = [];
 
@@ -220,7 +220,7 @@ export async function createFeed(
       file: feedPath(
         dir,
         `${stem}-${category.toLocaleLowerCase()}`,
-        options.type === "full",
+        options.type,
       ),
       finalFile: finalRelPath,
       feedLink: absoluteUrl(siteUrl, finalRelPath),
@@ -293,7 +293,11 @@ export function completeStagedFeeds(
 
           try {
             // Whether the staged file should be filled with full contents of the file
-            const fullContents = feedFile.endsWith(kFullStagedExt);
+            const type = feedFile.endsWith(kFullStagedExt)
+              ? "full"
+              : feedFile.endsWith(kPartialStagedExt)
+              ? "partial"
+              : "metadata";
 
             // Read the staged file contents and replace any
             // content with the rendered version from the document
@@ -314,10 +318,14 @@ export function completeStagedFeeds(
                 tag: "description",
                 regex: kDescRegex,
                 replaceValue: (rendered: RenderedContents) => {
-                  if (fullContents) {
+                  if (type === "full") {
                     return `<![CDATA[ ${rendered.fullContents} ]]>`;
+                  } else if (type === "partial") {
+                    return `<![CDATA[ ${
+                      rendered.description || rendered.firstPara
+                    } ]]>`;
                   } else {
-                    return `<![CDATA[ ${rendered.firstPara} ]]>`;
+                    return `<![CDATA[ ${rendered.description || ""} ]]>`;
                   }
                 },
               },
@@ -577,7 +585,8 @@ function addLinkTagToDocument(doc: Document, feed: FeedMetadata, path: string) {
 }
 
 const kFullStagedExt = "feed-full-staged";
-const kPartialStageExt = "feed-partial-staged";
+const kPartialStagedExt = "feed-partial-staged";
+const kMetadataStagedExt = "feed-metadata-staged";
 const kFinalExt = "xml";
 const kStagedFileGlob = "*.feed-*-staged";
 
@@ -597,8 +606,16 @@ function tagplaceholderRegex(tag: string) {
   return new RegExp(`<${tag}>{B4F502887207\:(.*?)}<\/${tag}>`, "gm");
 }
 
-function feedPath(dir: string, stem: string, full: boolean) {
-  const ext = full ? kFullStagedExt : kPartialStageExt;
+function feedPath(
+  dir: string,
+  stem: string,
+  type: "full" | "partial" | "metadata",
+) {
+  const ext = type === "full"
+    ? kFullStagedExt
+    : type === "partial"
+    ? kPartialStagedExt
+    : kMetadataStagedExt;
   const file = `${stem}.${ext}`;
   return join(dir, file);
 }

src/project/types/website/listing/website-listing-shared.ts

@@ -141,7 +141,7 @@ export type CategoryStyle =
 export interface ListingFeedOptions {
   [kTitle]?: string;
   [kItems]?: number;
-  [kType]: "summary" | "full";
+  [kType]: "partial" | "full" | "metadata";
   [kDescription]?: string;
   [kFieldCategories]?: string | string[];
   [kImage]?: string;
@@ -219,6 +219,7 @@ export interface ListingItem extends Record<string, unknown> {
 
 export interface RenderedContents {
   title: string | undefined;
+  description: string | undefined;
   firstPara: string | undefined;
   fullContents: string | undefined;
   previewImage: PreviewImage | undefined;
@@ -323,6 +324,16 @@ export function readRenderedContents(
     titleEl.remove();
   }
 
+  // Read the explicit description, if present
+  let description = "";
+  const descEl = doc.querySelector("meta[name='description']");
+  if (descEl) {
+    const descAttrVal = descEl.getAttribute("content");
+    if (descAttrVal !== null) {
+      description = descAttrVal;
+    }
+  }
+
   // Remove any navigation elements from the content region
   const navEls = doc.querySelectorAll("nav");
   if (navEls) {
@@ -573,6 +584,7 @@ export function readRenderedContents(
 
   return {
     title: titleText,
+    description,
     fullContents,
     firstPara,
     previewImage: computePreviewImage(),

src/resources/editor/tools/vs-code.mjs

@@ -10317,11 +10317,12 @@ var require_yaml_intelligence_resources = __commonJS({
                         type: {
                           enum: [
                             "full",
-                            "partial"
+                            "partial",
+                            "metadata"
                           ],
                           description: {
                             short: "Whether to include full or partial content in the feed.",
-                            long: "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n"
+                            long: "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n- `metadata`: Use only the title, description, and other document metadata in the feed.\n"
                           }
                         },
                         title: {
@@ -15239,7 +15240,7 @@ var require_yaml_intelligence_resources = __commonJS({
           description: "Options for controlling the display and behavior of Notebook previews."
         },
         {
-          "canonical-url": null,
+          name: "canonical-url",
           tags: {
             formats: [
               "$html-doc"
@@ -21283,6 +21284,10 @@ var require_yaml_intelligence_resources = __commonJS({
         "The style of document to render. Setting this to\n<code>notebook</code> will create additional notebook style\naffordances.",
         "Options for controlling the display and behavior of Notebook\npreviews.",
         "Whether to show a back button in the notebook preview.",
+        {
+          short: "Include a canonical link tag in website pages",
+          long: "Include a canonical link tag in website pages. You may pass either\n<code>true</code> to automatically generate a canonical link, or pass a\ncanonical url that you\u2019d like to have placed in the <code>href</code>\nattribute of the tag.\nCanonical links can only be generated for websites with a known\n<code>site-url</code>."
+        },
         "Automatically generate the contents of a page from a list of Quarto\ndocuments or other custom data.",
         "Mermaid diagram options",
         "The mermaid built-in theme to use.",
@@ -22352,11 +22357,7 @@ var require_yaml_intelligence_resources = __commonJS({
         },
         "Disambiguating year suffix in author-date styles (e.g.&nbsp;\u201Ca\u201D in \u201CDoe,\n1999a\u201D).",
         "Manuscript configuration",
-        "internal-schema-hack",
-        {
-          short: "Include a canonical link tag in website pages",
-          long: "Include a canonical link tag in website pages. You may pass either\n<code>true</code> to automatically generate a canonical link, or pass a\ncanonical url that you\u2019d like to have placed in the <code>href</code>\nattribute of the tag.\nCanonical links can only be generated for websites with a known\n<code>site-url</code>."
-        }
+        "internal-schema-hack"
       ],
       "schema/external-schemas.yml": [
         {
@@ -22580,12 +22581,12 @@ var require_yaml_intelligence_resources = __commonJS({
         mermaid: "%%"
       },
       "handlers/mermaid/schema.yml": {
-        _internalId: 180143,
+        _internalId: 180637,
         type: "object",
         description: "be an object",
         properties: {
           "mermaid-format": {
-            _internalId: 180135,
+            _internalId: 180629,
             type: "enum",
             enum: [
               "png",
@@ -22601,7 +22602,7 @@ var require_yaml_intelligence_resources = __commonJS({
             exhaustiveCompletions: true
           },
           theme: {
-            _internalId: 180142,
+            _internalId: 180636,
             type: "anyOf",
             anyOf: [
               {

src/resources/editor/tools/yaml/web-worker.js

@@ -3289,11 +3289,12 @@
                     "type": {
                       "enum": [
                         "full",
-                        "partial"
+                        "partial",
+                        "metadata"
                       ],
                       "description": {
                         "short": "Whether to include full or partial content in the feed.",
-                        "long": "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n"
+                        "long": "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n- `metadata`: Use only the title, description, and other document metadata in the feed.\n"
                       }
                     },
                     "title": {
@@ -8211,7 +8212,7 @@
       "description": "Options for controlling the display and behavior of Notebook previews."
     },
     {
-      "canonical-url": null,
+      "name": "canonical-url",
       "tags": {
         "formats": [
           "$html-doc"
@@ -14255,6 +14256,10 @@
     "The style of document to render. Setting this to\n<code>notebook</code> will create additional notebook style\naffordances.",
     "Options for controlling the display and behavior of Notebook\npreviews.",
     "Whether to show a back button in the notebook preview.",
+    {
+      "short": "Include a canonical link tag in website pages",
+      "long": "Include a canonical link tag in website pages. You may pass either\n<code>true</code> to automatically generate a canonical link, or pass a\ncanonical url that you’d like to have placed in the <code>href</code>\nattribute of the tag.\nCanonical links can only be generated for websites with a known\n<code>site-url</code>."
+    },
     "Automatically generate the contents of a page from a list of Quarto\ndocuments or other custom data.",
     "Mermaid diagram options",
     "The mermaid built-in theme to use.",
@@ -15324,11 +15329,7 @@
     },
     "Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
     "Manuscript configuration",
-    "internal-schema-hack",
-    {
-      "short": "Include a canonical link tag in website pages",
-      "long": "Include a canonical link tag in website pages. You may pass either\n<code>true</code> to automatically generate a canonical link, or pass a\ncanonical url that you’d like to have placed in the <code>href</code>\nattribute of the tag.\nCanonical links can only be generated for websites with a known\n<code>site-url</code>."
-    }
+    "internal-schema-hack"
   ],
   "schema/external-schemas.yml": [
     {
@@ -15552,12 +15553,12 @@
     "mermaid": "%%"
   },
   "handlers/mermaid/schema.yml": {
-    "_internalId": 180143,
+    "_internalId": 180637,
     "type": "object",
     "description": "be an object",
     "properties": {
       "mermaid-format": {
-        "_internalId": 180135,
+        "_internalId": 180629,
         "type": "enum",
         "enum": [
           "png",
@@ -15573,7 +15574,7 @@
         "exhaustiveCompletions": true
       },
       "theme": {
-        "_internalId": 180142,
+        "_internalId": 180636,
         "type": "anyOf",
         "anyOf": [
           {

src/resources/editor/tools/yaml/yaml-intelligence-resources.json

@@ -1406,14 +1406,15 @@
                     description: |
                       The number of items to include in your feed. Defaults to 20.
                 type:
-                  enum: [full, partial]
+                  enum: [full, partial, metadata]
                   description:
                     short: Whether to include full or partial content in the feed.
                     long: |
                       Whether to include full or partial content in the feed.
 
                       - `full` (default): Include the complete content of the document in the feed.
                       - `partial`: Include only the first paragraph of the document in the feed.
+                      - `metadata`: Use only the title, description, and other document metadata in the feed.
                 title:
                   string:
                     description:

src/resources/schema/definitions.yml

@@ -833,10 +833,12 @@ See [https://www.rssboard.org/rss-language-codes](https://www.rssboard.org/rss-l
 for a list of valid language codes. */;
     type?:
       | "full"
-      | "partial" /* Whether to include full or partial content in the feed.
+      | "partial"
+      | "metadata" /* Whether to include full or partial content in the feed.
 
 - `full` (default): Include the complete content of the document in the feed.
-- `partial`: Include only the first paragraph of the document in the feed. */;
+- `partial`: Include only the first paragraph of the document in the feed.
+- `metadata`: Use only the title, description, and other document metadata in the feed. */;
     title?:
       string; /* The title for this feed. Defaults to the site title provided the Quarto project. */
   } /* Enables an RSS feed for the listing. */;