Listing support template-params

Author: dragonstyle

news/changelog-1.3.md

@@ -1,8 +1,13 @@
 
+
 ## Article Layout
 
 - Improve the performance of extremely large documents with margin elements by improving the efficiency of positioning the elements.
 
+## Listings
+
+- Listings now support `template-params`, which will be passed to custom EJS templates when a listing is rendered.
+
 ## Miscellaneous
 
-- ensure `video` shortcode works with `embed-resources` and `self-contained` ([#3310](https://github.com/quarto-dev/quarto-cli/issues/3310))
+- ensure `video` shortcode works with `embed-resources` and `self-contained` ([#3310](https://github.com/quarto-dev/quarto-cli/issues/3310))

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

@@ -150,6 +150,7 @@ export function templateMarkdownHandler(
       ejsParams.listing = reshapedListing;
     } else {
       ejsParams["metadataAttrs"] = reshapedListing.utilities.metadataAttrs;
+      ejsParams["template-params"] = reshapedListing["template-params"];
     }
     return ejsParams;
   };

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

@@ -10139,6 +10139,10 @@ var require_yaml_intelligence_resources = __commonJS({
                   }
                 }
               },
+              "template-params": {
+                schema: "object",
+                description: "Parameters that are passed to the custom template."
+              },
               fields: {
                 arrayOf: "string",
                 description: {

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

@@ -3115,6 +3115,10 @@
               }
             }
           },
+          "template-params": {
+            "schema": "object",
+            "description": "Parameters that are passed to the custom template."
+          },
           "fields": {
             "arrayOf": "string",
             "description": {

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

@@ -485,7 +485,7 @@
       args:
         string:
           description: Additional command line arguments for preview command.
-      env: 
+      env:
         object:
           description: Environment variables to set for preview command.
       ready:
@@ -1405,6 +1405,9 @@
             short: "The path to a custom listing template."
             long: |
               The path to a custom listing template.
+      template-params:
+        schema: object
+        description: "Parameters that are passed to the custom template."
       fields:
         arrayOf: string
         description:

src/resources/schema/definitions.yml

@@ -731,6 +731,7 @@ Defaults to `false`. */;
   "table-hover"?:
     boolean /* In table type listings, highlight rows of the table when the user hovers the mouse over them.
 Defaults to false. */;
+  "template-params"?: SchemaObject;
   "field-display-names"?:
     SchemaObject /* A mapping that provides display names for specific fields. For example, to display the title column as ‘Report’ in a table listing you would write: