Format Display Names

Formats now have display names which are used in the HTML format.

Author: dragonstyle

src/command/render/render-contexts.ts

@@ -31,12 +31,14 @@ import {
   kBibliography,
   kCache,
   kCss,
+  kDisplayName,
   kEcho,
   kEngine,
   kExecuteDaemon,
   kExecuteDaemonRestart,
   kExecuteDebug,
   kExecuteEnabled,
+  kExtensionName,
   kHeaderIncludes,
   kIncludeAfter,
   kIncludeAfterBody,
@@ -156,7 +158,9 @@ export async function resolveFormatsFromMetadata(
     const config = mergeFormatMetadata(baseFormat, format);
 
     // apply any metadata filter
-    const resolveFormat = defaultWriterFormat(to).resolveFormat;
+    const defaultFormat = defaultWriterFormat(to);
+    config[kDisplayName] = config[kDisplayName] || defaultFormat[kDisplayName];
+    const resolveFormat = defaultFormat.resolveFormat;
     if (resolveFormat) {
       resolveFormat(config);
     }
@@ -638,6 +642,8 @@ const readExtensionFormat = async (
     if (extensionFormat) {
       const extensionMetadata =
         (extensionFormat[formatDesc.baseFormat] || {}) as Metadata;
+      extensionMetadata[kExtensionName] = extensionMetadata[kExtensionName] ||
+        formatDesc.extension;
 
       const formats = await resolveFormatsFromMetadata(
         extensionMetadata,

src/config/constants.ts

@@ -7,6 +7,8 @@
 
 export const kMetadataFormat = "format";
 
+export const kDisplayName = "display-name";
+export const kExtensionName = "extension-name";
 export const kRenderDefaults = "render";
 export const kExecuteDefaults = "execute";
 export const kPandocDefaults = "pandoc";

src/config/metadata.ts

@@ -16,9 +16,11 @@ import { mergeArrayCustomizer } from "../core/config.ts";
 import { Schema } from "../core/lib/yaml-schema/types.ts";
 
 import {
+  kDisplayName,
   kExecuteDefaults,
   kExecuteDefaultsKeys,
   kExecuteEnabled,
+  kExtensionName,
   kHeaderIncludes,
   kIncludeAfter,
   kIncludeBefore,
@@ -169,6 +171,8 @@ export function metadataAsFormat(metadata: Metadata): Format {
     // allow stuff already sorted into a top level key through unmodified
     if (
       [
+        kDisplayName,
+        kExtensionName,
         kRenderDefaults,
         kExecuteDefaults,
         kPandocDefaults,
@@ -178,7 +182,9 @@ export function metadataAsFormat(metadata: Metadata): Format {
         .includes(key)
     ) {
       // special case for 'execute' as boolean
-      if (typeof (metadata[key]) == "boolean") {
+      if ([kDisplayName, kExtensionName].includes(key)) {
+        format[key] = metadata[key];
+      } else if (typeof (metadata[key]) == "boolean") {
         if (key === kExecuteDefaults) {
           format[key] = format[key] || {};
           format[kExecuteDefaults][kExecuteEnabled] = metadata[key];

src/config/types.ts

@@ -48,6 +48,7 @@ import {
   kCrossrefThmTitle,
   kCss,
   kDfPrint,
+  kDisplayName,
   kEcho,
   kEmbedResources,
   kEngine,
@@ -62,6 +63,7 @@ import {
   kExecuteDebug,
   kExecuteEnabled,
   kExecuteIpynb,
+  kExtensionName,
   kFigAlign,
   kFigDpi,
   kFigEnv,
@@ -307,6 +309,8 @@ export interface FormatExtras {
 
 // pandoc output format
 export interface Format {
+  [kDisplayName]?: string;
+  [kExtensionName]?: string;
   render: FormatRender;
   execute: FormatExecute;
   pandoc: FormatPandoc;

src/format/docx/format-docx.ts

@@ -19,7 +19,7 @@ const kIconWarning = "icon-warning";
 
 export function docxFormat(): Format {
   return mergeConfigs(
-    createWordprocessorFormat("docx"),
+    createWordprocessorFormat("MS Word", "docx"),
     {
       formatExtras: () => {
         return {

src/format/epub/format-epub.ts

@@ -20,7 +20,7 @@ import { createEbookFormat } from "../formats-shared.ts";
 
 export function epubFormat(): Format {
   return mergeConfigs(
-    createEbookFormat("epub"),
+    createEbookFormat("ePub", "epub"),
     {
       extensions: {
         book: epubBookExtension,

src/format/formats-shared.ts

@@ -16,6 +16,7 @@ import {
   kCodeTools,
   kDefaultImageExtension,
   kDfPrint,
+  kDisplayName,
   kEcho,
   kError,
   kEval,
@@ -74,9 +75,13 @@ import { Format } from "../config/types.ts";
 import { formatResourcePath } from "../core/resources.ts";
 import { quartoConfig } from "../core/quarto.ts";
 
-export function createFormat(ext: string, ...formats: Array<unknown>): Format {
+export function createFormat(
+  displayName: string,
+  ext: string,
+  ...formats: Array<unknown>
+): Format {
   return mergeConfigs(
-    defaultFormat(),
+    defaultFormat(displayName),
     ...formats,
     {
       render: {
@@ -87,10 +92,11 @@ export function createFormat(ext: string, ...formats: Array<unknown>): Format {
 }
 
 export function createHtmlFormat(
+  displayName: string,
   figwidth: number,
   figheight: number,
 ) {
-  return createFormat("html", {
+  return createFormat(displayName, "html", {
     metadata: {
       [kLang]: "en",
       [kFigResponsive]: true,
@@ -113,11 +119,12 @@ export function createHtmlFormat(
 }
 
 export function createHtmlPresentationFormat(
+  displayName: string,
   figwidth: number,
   figheight: number,
 ): Format {
   return mergeConfigs(
-    createHtmlFormat(figwidth, figheight),
+    createHtmlFormat(displayName, figwidth, figheight),
     {
       metadata: {
         [kFigResponsive]: false,
@@ -130,8 +137,8 @@ export function createHtmlPresentationFormat(
   );
 }
 
-export function createEbookFormat(ext: string): Format {
-  return createFormat(ext, {
+export function createEbookFormat(displayName: string, ext: string): Format {
+  return createFormat(displayName, ext, {
     formatExtras: () => {
       return {
         [kIncludeInHeader]: [
@@ -153,8 +160,11 @@ export function createEbookFormat(ext: string): Format {
   });
 }
 
-export function createWordprocessorFormat(ext: string): Format {
-  return createFormat(ext, {
+export function createWordprocessorFormat(
+  displayName: string,
+  ext: string,
+): Format {
+  return createFormat(displayName, ext, {
     render: {
       [kPageWidth]: 6.5,
     },
@@ -168,17 +178,18 @@ export function createWordprocessorFormat(ext: string): Format {
   });
 }
 
-export function plaintextFormat(ext: string): Format {
-  return createFormat(ext, {
+export function plaintextFormat(displayName: string, ext: string): Format {
+  return createFormat(displayName, ext, {
     pandoc: {
       standalone: true,
       [kDefaultImageExtension]: "png",
     },
   });
 }
 
-function defaultFormat(): Format {
+function defaultFormat(displayName: string): Format {
   return {
+    [kDisplayName]: displayName,
     execute: {
       [kFigWidth]: 7,
       [kFigHeight]: 5,