merge

Author: cscheid

news/changelog-1.8.md

@@ -33,6 +33,8 @@ All changes included in 1.8:
 
 ### `revealjs`
 
+- ([#10933](https://github.com/quarto-dev/quarto-cli/issues/10933)): Revealjs supports alt text on logo, as well as customization of light and dark logos at the document level, consistent with other formats.
+- ([#12550](https://github.com/quarto-dev/quarto-cli/issues/12550)): Revealjs supports `brand-mode`, allowing to select either the light or the dark brand.
 - ([#12598](https://github.com/quarto-dev/quarto-cli/pull/12598)): Ensure `.fragment` on an image with caption applies to whole figure.
 - ([#12716](https://github.com/quarto-dev/quarto-cli/issues/12716)): Correctly resolve `"brand"` set in `theme` configuration for document in subdirectory from project root.
 - Use `cdn.jsdelivr.net` for mathjax dependencies to ensure consistent CDN usage across formats. Previously, `cdnjs.cloudflare.com` was used for `revealjs` mathjax dependencies, while `cdn.jsdelivr.net` was used for html format.
@@ -43,12 +45,13 @@ All changes included in 1.8:
 
 ### `typst`
 
-- ([#12180](https://github.com/quarto-dev/quarto-cli/issues/12180): Typst schema / autocomplete for `logo` option has `path` and `alt`.
+- ([#12180](https://github.com/quarto-dev/quarto-cli/issues/12180)): Typst schema / autocomplete for `logo` option has `path` and `alt`.
 - ([#12554](https://github.com/quarto-dev/quarto-cli/pull/12554)): CSS properties `font-weight` and `font-style` are translated to Typst `text` properties.
 - ([#12695](https://github.com/quarto-dev/quarto-cli/issues/12695)): Resolve Typst `font-paths` that start with `/` relative to project root.
 - ([#12739](https://github.com/quarto-dev/quarto-cli/pull/12739)): Remove unused variable `heading-background-color` and `heading-decoration` from Typst's templates. They are leftover from previous change, and not part of Brand.yml schema for typography of headings.
 - ([#12815](https://github.com/quarto-dev/quarto-cli/issues/12815)): Do not crash when floats have no content.
 - ([#13119](https://github.com/quarto-dev/quarto-cli/pull/13119)): Expose `brand.logo` metadata as Typst dictionaries.
+- ([#13133](https://github.com/quarto-dev/quarto-cli/pull/13133)): Allow customization of light and dark logos at document level, consistent with other formats.
 
 ### `beamer`
 
@@ -76,6 +79,7 @@ All changes included in 1.8:
 - ([#12727](https://github.com/quarto-dev/quarto-cli/issues/12727)): Do not crash in the presence of malformed tabset contents.
 - ([#12806](https://github.com/quarto-dev/quarto-cli/pull/12806)): Use pandoc APIs to handle codepage conversion on Windows.
 - ([#12811](https://github.com/quarto-dev/quarto-cli/pull/12811)): Add support for YouTube Shorts in `video` shortcode.
+- ([#13128](https://github.com/quarto-dev/quarto-cli/issues/13128)): Meta shortcode could crash on bad input.
 
 ## Commands
 

src/core/brand/brand.ts

@@ -33,6 +33,12 @@ import { join, relative } from "../../deno_ral/path.ts";
 import { warnOnce } from "../log.ts";
 import { isCssColorName } from "../css/color-names.ts";
 import { assert } from "testing/asserts";
+import {
+  LogoLightDarkSpecifierPathOptional,
+  LogoOptionsPathOptional,
+  LogoSpecifier,
+  LogoSpecifierPathOptional,
+} from "../../resources/types/schema-types.ts";
 
 type ProcessedBrandData = {
   color: Record<string, string>;
@@ -379,6 +385,62 @@ export function resolveLogo(
   };
 }
 
+// this a typst workaround but might as well write it as a proper function
+export function fillLogoPaths(
+  brand: LightDarkBrand | undefined,
+  spec: LogoLightDarkSpecifierPathOptional | undefined,
+  order: BrandNamedLogo[],
+): LogoLightDarkSpecifier | undefined {
+  function findLogoSize(
+    mode: "light" | "dark",
+  ): string | undefined {
+    if (brand?.[mode]) {
+      for (const size of order) {
+        if (brand[mode].processedData.logo[size]) {
+          return size;
+        }
+      }
+    }
+    return undefined;
+  }
+  function resolveMode(
+    mode: "light" | "dark",
+    spec: LogoSpecifierPathOptional | undefined,
+  ): LogoSpecifier | undefined {
+    if (!spec) {
+      return undefined;
+    }
+    if (!spec || typeof spec === "string") {
+      return spec;
+    } else if (spec.path) {
+      return spec as LogoOptions;
+    } else {
+      const size = findLogoSize(mode) ||
+        findLogoSize(mode === "light" ? "dark" : "light");
+      if (size) {
+        return {
+          path: size,
+          ...spec,
+        };
+      }
+    }
+    return undefined;
+  }
+  if (!spec || typeof spec === "string") {
+    return spec;
+  }
+  if ("light" in spec || "dark" in spec) {
+    return {
+      light: resolveMode("light", spec.light),
+      dark: resolveMode("dark", spec.dark),
+    };
+  }
+  return {
+    light: resolveMode("light", spec as LogoOptionsPathOptional),
+    dark: resolveMode("dark", spec as LogoOptionsPathOptional),
+  };
+}
+
 function splitColorLightDark(
   bcld: BrandColorLightDark,
 ): LightDarkColor {

src/core/lib/yaml-schema/common.ts

@@ -281,7 +281,7 @@ export function objectSchema(params: {
       );
       console.error("This is a bug in quarto's schemas.");
       console.error(
-        "Note that we don't throw in order to allow build-js to finish, but the generated schemas will be invalid.",
+        "Note that we don't throw in order to allow build-artifacts to finish, but the generated schemas will be invalid.",
       );
     }
 

src/core/lib/yaml-schema/definitions.ts

@@ -32,7 +32,7 @@ export function defineCached(
   let schema: ConcreteSchema;
 
   return async () => {
-    // when running on the CLI outside of quarto build-js, these
+    // when running on the CLI outside of quarto dev-call build-artifacts, these
     // definitions will already exist.
     if (hasSchemaDefinition(schemaId)) {
       schema = getSchemaDefinition(schemaId);

src/core/lib/yaml-validation/state.ts

@@ -43,7 +43,7 @@ export async function initState() {
 // many entry points. In addition, the CLI itself can have a number
 // of different initializers depending on the command being called:
 //
-// - quarto build-js uses an initializer that skips precompiled modules
+// - quarto dev-call build-artifacts uses an initializer that skips precompiled modules
 //
 // - Some of the test suite uses an initializer with precompiled
 //   modules and includes tree-sitter (so the behavior is as close to

src/core/sass/brand.ts

@@ -24,6 +24,7 @@ import {
 } from "../../resources/types/zod/schema-types.ts";
 import { Brand } from "../brand/brand.ts";
 import { darkModeDefault } from "../../format/html/format-html-info.ts";
+import { kBrandMode } from "../../config/constants.ts";
 
 const defaultColorNameMap: Record<string, string> = {
   "link-color": "link",
@@ -634,14 +635,18 @@ export async function brandBootstrapSassLayers(
 
 export async function brandRevealSassLayers(
   input: string | undefined,
-  _format: Format,
+  format: Format,
   project: ProjectContext,
 ): Promise<SassLayer[]> {
+  let brandMode: "light" | "dark" = "light";
+  if (format.metadata[kBrandMode] === "dark") {
+    brandMode = "dark";
+  }
   return (await brandSassLayers(
     input,
     project,
     defaultColorNameMap,
-  )).light;
+  ))[brandMode];
 }
 
 export async function brandSassFormatExtras(

src/core/schema/yaml-schema.ts

@@ -1,11 +1,10 @@
 /*
-* yaml-schema.ts
-*
-* Copyright (C) 2022 Posit Software, PBC
-*
-*/
+ * yaml-schema.ts
+ *
+ * Copyright (C) 2022 Posit Software, PBC
+ */
 
-// FIXME needs refactoring. This is mostly only used at build-js time,
+// FIXME needs refactoring. This is mostly only used at build-artifacts time,
 // except for "parseAndValidate".
 
 import { YAMLSchema } from "../lib/yaml-validation/yaml-schema.ts";

src/format/reveal/format-reveal.ts

@@ -7,6 +7,7 @@ import { join } from "../../deno_ral/path.ts";
 
 import { Document, Element, NodeType } from "../../core/deno-dom.ts";
 import {
+  kBrandMode,
   kCodeLineNumbers,
   kFrom,
   kHtmlMathMethod,
@@ -78,6 +79,7 @@ import { ProjectContext } from "../../project/types.ts";
 import { titleSlidePartial } from "./format-reveal-title.ts";
 import { registerWriterFormatHandler } from "../format-handlers.ts";
 import { pandocNativeStr } from "../../core/pandoc/codegen.ts";
+import { resolveLogo } from "../../core/brand/brand.ts";
 
 export function revealResolveFormat(format: Format) {
   format.metadata = revealMetadataFilter(format.metadata);
@@ -376,45 +378,25 @@ export function revealjsFormat() {
   );
 }
 
-const determineRevealLogo = (format: Format): string | undefined => {
-  const brandData = format.render.brand?.light?.processedData;
-  if (brandData?.logo) {
-    // add slide logo if we have one
-    for (const size of Zod.BrandNamedLogo.options) {
-      const logoInfo = brandData.logo[size];
-      if (!logoInfo) {
-        continue;
-      }
-      if (logoInfo) {
-        return logoInfo.path;
-      }
-    }
-  }
-};
-
 function revealMarkdownAfterBody(format: Format) {
+  let brandMode: "light" | "dark" = "light";
+  if (format.metadata[kBrandMode] === "dark") {
+    brandMode = "dark";
+  }
   const lines: string[] = [];
   lines.push("::: {.quarto-auto-generated-content style='display: none;'}\n");
-  let revealLogo = format
+  const revealLogo = format
     .metadata[kSlideLogo] as (string | { path: string } | undefined);
-  if (revealLogo) {
-    if (typeof revealLogo === "object") {
-      revealLogo = revealLogo.path;
-    }
-    if (Zod.BrandNamedLogo.options.includes(revealLogo as BrandNamedLogo)) {
-      const brandData = format.render.brand?.light?.processedData;
-      const logoInfo = brandData?.logo
-        ?.[revealLogo as BrandNamedLogo];
-      if (logoInfo) {
-        revealLogo = logoInfo.path;
-      }
-    }
-  } else {
-    revealLogo = determineRevealLogo(format);
-  }
-  if (revealLogo) {
+  const logo = resolveLogo(format.render.brand, revealLogo, [
+    "small",
+    "medium",
+    "large",
+  ]);
+  if (logo && logo[brandMode]) {
+    const modeLogo = logo[brandMode]!;
+    const altText = modeLogo.alt ? `alt="${modeLogo.alt}" ` : "";
     lines.push(
-      `<img src="${revealLogo}" class="slide-logo" />`,
+      `<img src="${modeLogo.path}" ${altText}class="slide-logo" />`,
     );
     lines.push("\n");
   }

src/format/typst/format-typst.ts

@@ -14,6 +14,7 @@ import {
   kFigFormat,
   kFigHeight,
   kFigWidth,
+  kLogo,
   kNumberSections,
   kSectionNumbering,
   kShiftHeadingLevelBy,
@@ -30,6 +31,12 @@ import {
 import { formatResourcePath } from "../../core/resources.ts";
 import { createFormat } from "../formats-shared.ts";
 import { hasLevelOneHeadings as hasL1Headings } from "../../core/lib/markdown-analysis/level-one-headings.ts";
+import {
+  BrandNamedLogo,
+  LogoLightDarkSpecifier,
+} from "../../resources/types/schema-types.ts";
+import { fillLogoPaths, resolveLogo } from "../../core/brand/brand.ts";
+import { LogoLightDarkSpecifierPathOptional } from "../../resources/types/zod/schema-types.ts";
 
 export function typstFormat(): Format {
   return createFormat("Typst", "pdf", {
@@ -78,6 +85,19 @@ export function typstFormat(): Format {
         pandoc[kShiftHeadingLevelBy] = -1;
       }
 
+      const brand = format.render.brand;
+      const logoSpec = format
+        .metadata[kLogo] as LogoLightDarkSpecifierPathOptional;
+      const sizeOrder: BrandNamedLogo[] = [
+        "small",
+        "medium",
+        "large",
+      ];
+      // temporary: if document logo has object or light/dark objects
+      // without path, do our own findLogo to add the path
+      // typst is the exception not needing path but we'll probably deprecate this
+      const logo = fillLogoPaths(brand, logoSpec, sizeOrder);
+      format.metadata[kLogo] = resolveLogo(brand, logo, sizeOrder);
       // force columns to wrap and move any 'columns' setting to metadata
       const columns = format.pandoc[kColumns];
       if (columns) {