Allow format-links to control linked formats

Author: dragonstyle

src/command/render/render-contexts.ts

@@ -31,7 +31,6 @@ import {
   kBibliography,
   kCache,
   kCss,
-  kDisplayName,
   kEcho,
   kEngine,
   kExecuteDaemon,
@@ -50,6 +49,7 @@ import {
   kOutputExt,
   kOutputFile,
   kServer,
+  kTargetFormat,
   kTheme,
 } from "../../config/constants.ts";
 import { resolveLanguageMetadata } from "../../core/language.ts";
@@ -159,7 +159,6 @@ export async function resolveFormatsFromMetadata(
 
     // apply any metadata filter
     const defaultFormat = defaultWriterFormat(to);
-    config[kDisplayName] = config[kDisplayName] || defaultFormat[kDisplayName];
     const resolveFormat = defaultFormat.resolveFormat;
     if (resolveFormat) {
       resolveFormat(config);
@@ -543,6 +542,9 @@ async function resolveFormats(
         : {},
       userFormat,
     );
+    // Insist that the target format reflect the correct value.
+    mergedFormats[format].identifier[kTargetFormat] = format;
+
     //deno-lint-ignore no-explicit-any
     mergedFormats[format].mergeAdditionalFormats = (...configs: any[]) => {
       return mergeFormatMetadata(

src/config/constants.ts

@@ -9,6 +9,8 @@ export const kMetadataFormat = "format";
 
 export const kDisplayName = "display-name";
 export const kExtensionName = "extension-name";
+export const kTargetFormat = "target-format";
+export const kIdentifierDefaults = "indentifier";
 export const kRenderDefaults = "render";
 export const kExecuteDefaults = "execute";
 export const kPandocDefaults = "pandoc";
@@ -95,6 +97,12 @@ export const kLinkExternalFilter = "link-external-filter";
 export const kQuartoVersion = "quarto-version";
 export const kQuartoRequired = "quarto-required";
 
+export const kIdentifierDefaultsKeys = [
+  kTargetFormat,
+  kDisplayName,
+  kExtensionName,
+];
+
 export const kExecuteDefaultsKeys = [
   kFigWidth,
   kFigHeight,

src/config/metadata.ts

@@ -16,12 +16,12 @@ import { mergeArrayCustomizer } from "../core/config.ts";
 import { Schema } from "../core/lib/yaml-schema/types.ts";
 
 import {
-  kDisplayName,
   kExecuteDefaults,
   kExecuteDefaultsKeys,
   kExecuteEnabled,
-  kExtensionName,
   kHeaderIncludes,
+  kIdentifierDefaults,
+  kIdentifierDefaultsKeys,
   kIncludeAfter,
   kIncludeBefore,
   kIpynbFilter,
@@ -95,6 +95,7 @@ export function formatFromMetadata(
 ): Format {
   // user format options (allow any b/c this is just untyped yaml)
   const typedFormat: Format = {
+    identifier: {},
     render: {},
     execute: {},
     pandoc: {},
@@ -159,6 +160,7 @@ export function isIncludeMetadata(key: string) {
 
 export function metadataAsFormat(metadata: Metadata): Format {
   const typedFormat: Format = {
+    identifier: {},
     render: {},
     execute: {},
     pandoc: {},
@@ -171,8 +173,7 @@ export function metadataAsFormat(metadata: Metadata): Format {
     // allow stuff already sorted into a top level key through unmodified
     if (
       [
-        kDisplayName,
-        kExtensionName,
+        kIdentifierDefaults,
         kRenderDefaults,
         kExecuteDefaults,
         kPandocDefaults,
@@ -182,9 +183,7 @@ export function metadataAsFormat(metadata: Metadata): Format {
         .includes(key)
     ) {
       // special case for 'execute' as boolean
-      if ([kDisplayName, kExtensionName].includes(key)) {
-        format[key] = metadata[key];
-      } else if (typeof (metadata[key]) == "boolean") {
+      if (typeof (metadata[key]) == "boolean") {
         if (key === kExecuteDefaults) {
           format[key] = format[key] || {};
           format[kExecuteDefaults][kExecuteEnabled] = metadata[key];
@@ -194,7 +193,9 @@ export function metadataAsFormat(metadata: Metadata): Format {
       }
     } else {
       // move the key into the appropriate top level key
-      if (kRenderDefaultsKeys.includes(key)) {
+      if (kIdentifierDefaultsKeys.includes(key)) {
+        format.identifier[key] = metadata[key];
+      } else if (kRenderDefaultsKeys.includes(key)) {
         format.render[key] = metadata[key];
       } else if (kExecuteDefaultsKeys.includes(key)) {
         format.execute[key] = metadata[key];

src/config/types.ts

@@ -169,6 +169,7 @@ import {
   kStandalone,
   kSyntaxDefinitions,
   kTableOfContents,
+  kTargetFormat,
   kTblColwidths,
   kTemplate,
   kTitleBlockAffiliationPlural,
@@ -309,10 +310,15 @@ export interface FormatExtras {
   };
 }
 
-// pandoc output format
-export interface Format {
+export interface FormatIdentifier {
+  [kTargetFormat]?: string;
   [kDisplayName]?: string;
   [kExtensionName]?: string;
+}
+
+// pandoc output format
+export interface Format {
+  identifier: FormatIdentifier;
   render: FormatRender;
   execute: FormatExecute;
   pandoc: FormatPandoc;
@@ -389,7 +395,7 @@ export interface FormatRender {
   [kLinkExternalFilter]?: string;
   [kSelfContainedMath]?: boolean;
   [kFormatResources]?: string[];
-  [kFormatLinks]?: boolean;
+  [kFormatLinks]?: boolean | string[];
 }
 
 export interface FormatExecute {

src/format/formats-shared.ts

@@ -189,7 +189,9 @@ export function plaintextFormat(displayName: string, ext: string): Format {
 
 function defaultFormat(displayName: string): Format {
   return {
-    [kDisplayName]: displayName,
+    identifier: {
+      [kDisplayName]: displayName,
+    },
     execute: {
       [kFigWidth]: 7,
       [kFigHeight]: 5,

src/format/formats.ts

@@ -12,6 +12,7 @@ import {
   kFigWidth,
   kOutputDivs,
   kPageWidth,
+  kTargetFormat,
   kWarning,
 } from "../config/constants.ts";
 
@@ -260,6 +261,9 @@ export function defaultWriterFormat(to: string): Format {
     writerFormat.pandoc.to = pandocTo;
   }
 
+  // Set the originating to
+  writerFormat.identifier[kTargetFormat] = to;
+
   // return the createFormat
   return writerFormat;
 }

src/format/html/format-html-bootstrap.ts

@@ -24,6 +24,7 @@ import {
   kRelatedNotebooksTitle,
   kSectionDivs,
   kSourceNotebookPrefix,
+  kTargetFormat,
   kTocDepth,
   kTocLocation,
 } from "../../config/constants.ts";
@@ -469,7 +470,29 @@ function processAlternateFormatLinks(
 
       const formatList = doc.createElement("ul");
 
-      for (const renderedFormat of options.renderedFormats) {
+      const formats = Array.isArray(format.render[kFormatLinks])
+        ? format.render[kFormatLinks]
+        : undefined;
+
+      const displayFormats = formats
+        ? options.renderedFormats.filter((renderedFormat) => {
+          const name = renderedFormat.format.identifier[kTargetFormat];
+          return !formats || (name && formats.includes(name));
+        }).sort((a, b) => {
+          if (
+            a.format.identifier[kTargetFormat] &&
+            b.format.identifier[kTargetFormat]
+          ) {
+            const aIdx = formats.indexOf(a.format.identifier[kTargetFormat]);
+            const bIdx = formats.indexOf(b.format.identifier[kTargetFormat]);
+            return aIdx - bIdx;
+          } else {
+            return 0;
+          }
+        })
+        : options.renderedFormats;
+
+      for (const renderedFormat of displayFormats) {
         if (!isHtmlOutput(renderedFormat.format.pandoc, true)) {
           const li = doc.createElement("li");
 
@@ -490,11 +513,11 @@ function processAlternateFormatLinks(
           link.appendChild(
             doc.createTextNode(
               `${
-                renderedFormat.format[kDisplayName] ||
+                renderedFormat.format.identifier[kDisplayName] ||
                 renderedFormat.format.pandoc.to
               }${
-                renderedFormat.format[kExtensionName]
-                  ? ` (${renderedFormat.format[kExtensionName]})`
+                renderedFormat.format.identifier[kExtensionName]
+                  ? ` (${renderedFormat.format.identifier[kExtensionName]})`
                   : ""
               }`,
             ),

src/resources/schema/document-links.yml

@@ -28,6 +28,14 @@
 - name: format-links
   tags:
     formats: [$html-doc]
-  schema: boolean
+  schema:
+    anyOf:
+      - boolean
+      - arrayOf: string
   description:
-    short: "Controls whether links to other rendered formats are displayed in HTML output"
+    short: "Controls whether links to other rendered formats are displayed in HTML output."
+    long: |
+      Controls whether links to other rendered formats are displayed in HTML output.
+
+      Pass `false` to disable the display of format lengths or pass a list of format names for which you'd
+      like links to be shown.