Control other formats with format-links

Author: dragonstyle

src/config/constants.ts

@@ -36,6 +36,8 @@ export const kInclude = "include";
 export const kResources = "resources";
 export const kFormatResources = "format-resources";
 
+export const kFormatLinks = "format-links";
+
 export const kKeepHidden = "keep-hidden";
 
 export const kExecuteEnabled = "enabled";
@@ -155,6 +157,7 @@ export const kRenderDefaultsKeys = [
   kLinkExternalNewwindow,
   kLinkExternalFilter,
   kFormatResources,
+  kFormatLinks,
 ];
 
 // language fields

src/config/types.ts

@@ -73,6 +73,7 @@ import {
   kFigWidth,
   kFilterParams,
   kFilters,
+  kFormatLinks,
   kFormatResources,
   kFreeze,
   kGladtex,
@@ -387,6 +388,7 @@ export interface FormatRender {
   [kLinkExternalFilter]?: string;
   [kSelfContainedMath]?: boolean;
   [kFormatResources]?: string[];
+  [kFormatLinks]?: boolean;
 }
 
 export interface FormatExecute {

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

@@ -15,6 +15,7 @@ import { findParent } from "../../core/html.ts";
 import {
   kDisplayName,
   kExtensionName,
+  kFormatLinks,
   kHtmlMathMethod,
   kIncludeInHeader,
   kLinkCitations,
@@ -319,7 +320,9 @@ function bootstrapHtmlPostprocessor(
 
     // Inject links to other formats if there is another
     // format that of this file that has been rendered
-    processAlternateFormatLinks(options, doc, format, resources);
+    if (format.render[kFormatLinks] !== false) {
+      processAlternateFormatLinks(options, doc, format, resources);
+    }
 
     // Look for included / embedded notebooks and include those
     processNotebookEmbeds(doc, format, resources);
@@ -451,9 +454,8 @@ function processAlternateFormatLinks(
   if (options.renderedFormats.length > 1) {
     let dlLinkTarget = doc.querySelector(`nav[role="doc-toc"]`);
     if (dlLinkTarget === null) {
-      dlLinkTarget = doc.querySelector("#quarto-margin-sidebar");
+      dlLinkTarget = doc.querySelector(kMarginSidebarId);
     }
-
     if (dlLinkTarget) {
       const containerEl = doc.createElement("div");
       containerEl.classList.add("quarto-alternate-formats");

src/resources/schema/document-links.yml

@@ -24,3 +24,10 @@
       ```
       ^(?:http:|https:)\/\/www\.quarto\.org\/custom
       ```
+
+- name: format-links
+  tags:
+    formats: [$html-doc]
+  schema: boolean
+  description:
+    short: "Controls whether links to other rendered formats are displayed in HTML output"