How can I get my custom typst template implement the _brand yaml arguments given in the yaml at the top of my qmd document?

[torven-schalk]

Description

I've used _brand yaml options at the top of my qmd document. but my custom typst template doesn't really want to implement these. Any help on how to solve this would be much appreciated. thanks!
E.g.:

---
title: bla
subtitle: bla bla
author: bla bla bla
format:
  my_own_template-typst:
    papersize: a4
brand:
  color:
    primary: "#2C2568"
    secondary: "#107383"
    tertiary: "#37B0A8"
    warning: "#FF4F2D"
  typography:
    fonts:
      - family: Arial
    base:
      family: Arial
      size: "11px"
    link:
      color: secondary
    headings:
      family: Arial
      color: primary
---

the headings are correct In Arial and the correct color but the title and normal text are i think the default font.

my typst-template.typ looks like this:

#let article(
  title: none,
  subtitle: none,
  authors: none,
  date: none,
  abstract: none,
  abstract-title: none,
  cols: 1,
  margin: (x: 1.25in, y: 1.25in),
  paper: "us-letter",
  lang: "en",
  region: "US",
  font: (),
  fontsize: 11pt,
  sectionnumbering: none,
  toc: false,
  toc_title: none,
  toc_depth: none,
  toc_indent: 1.5em,
  doc,
) = {
  set page(paper: paper, margin: margin)
  set text(font: font, size: fontsize)
  align(horizon + center)[
    #text(size: 24pt, weight: "bold")[#title]\
    
    #text(size: 18pt, weight: "bold")[#subtitle]
    
  ]
  
  align(bottom + left)[#datetime.today().display()]
  pagebreak()
  set page(
    paper: paper,
    margin: margin,
    numbering: "1",
  )
  set par(justify: true)
  set text(lang: lang,
           region: region,
           font: font,
           size: fontsize)
  set heading(numbering: sectionnumbering)

  if title != none {
    align(center)[#block(inset: 2em)[
      #text(weight: "bold", size: 1.5em)[#title]
    ]]
  }

  if authors != none {
    let count = authors.len()
    let ncols = calc.min(count, 3)
    grid(
      columns: (1fr,) * ncols,
      row-gutter: 1.5em,
      ..authors.map(author =>
          align(center)[
            #author.name \
            #author.affiliation \
            #author.email
          ]
      )
    )
  }

  if date != none {
    align(center)[#block(inset: 1em)[
      #date
    ]]
  }

  if abstract != none {
    block(inset: 2em)[
    #text(weight: "semibold")[#abstract-title] #h(1em) #abstract
    ]
  }

  if toc {
    let title = if toc_title == none {
      auto
    } else {
      toc_title
    }
    block(above: 0em, below: 2em)[
    #outline(
      title: toc_title,
      depth: toc_depth,
      indent: toc_indent
    );
    ]
  }

  if cols == 1 {
    doc
  } else {
    columns(cols, doc)
  }
}

#set table(
  inset: 6pt,
  stroke: none
)

my typst-show.typ looks like this

#show: doc => article(
$if(title)$
  title: [$title$],
  subtitle: [$subtitle$],
$endif$
$if(by-author)$
  authors: (
$for(by-author)$
$if(it.name.literal)$
    ( name: [$it.name.literal$],
      affiliation: [$for(it.affiliations)$$it.name$$sep$, $endfor$],
      email: [$it.email$] ),
$endif$
$endfor$
    ),
$endif$
$if(date)$
  date: [$date$],
$endif$
$if(lang)$
  lang: "$lang$",
$endif$
$if(region)$
  region: "$region$",
$endif$
$if(abstract)$
  abstract: [$abstract$],
  abstract-title: "$labels.abstract$",
$endif$
$if(margin)$
  margin: ($for(margin/pairs)$$margin.key$: $margin.value$,$endfor$),
$endif$
$if(papersize)$
  paper: "$papersize$",
$endif$
$if(mainfont)$
  font: ("$mainfont$",),
$endif$
$if(fontsize)$
  fontsize: $fontsize$,
$endif$
$if(section-numbering)$
  sectionnumbering: "$section-numbering$",
$endif$
$if(toc)$
  toc: $toc$,
$endif$
$if(toc-title)$
  toc_title: [$toc-title$],
$endif$
$if(toc-indent)$
  toc_indent: $toc-indent$,
$endif$
  toc_depth: $toc-depth$,
  cols: $if(columns)$$columns$$else$1$endif$,
  doc,
)

[mcanouil]

Did you look at how it's implemented for the default template?

• https://quarto.org/docs/journals/templates.html#typst-partials

[cderv]

the headings are correct In Arial and the correct color but the title and normal text are i think the default font.

This does seems like an issue or current limitation if the font brand setting does not apply yet anywhere 🤔

The feature is quite new, and it would not the first limitation (e.g. #11278)

@gordonwoodhull any insight about font and typst here so that we open the right enhancement if necessary ?

Thanks !

[cscheid]

FWIW, I agree with all points that @gordonwoodhull's making here.

[alinacherkas]

Hi,

I am facing a similar issue with a custom Typst format. I am following the documentation and typst-show.typ which uses brand.typography in several places. But it seems that other properties of brand are not available. My goal is to grab a logo from _brand.yml, if it is defined there, and use it in my template. But here's a much simpler MRE that illustrates the problem:

# brand.yml
meta:
  name:
    full: Long Name
    short: Short Name
typography:
  fonts:
    - family: Noto Sans
      source: google
  base:
    family: Noto Sans

In typist-show.typ, I can replace this

$if(title)$
  title: [$title$],
$endif$

with:

// typst-show.typ
title: [$brand.typography.base.family$],

The template will then display ("Noto Sans",) as the title. But using this won't display "Long Name":

title: [$brand.meta.name.full$],

@gordonwoodhull , is this what you mean by:

In this case it’s using the brand.yml metadata format, but it’s only the base/headings typography part of the brand.yml data that needs to be passed as parameters intypst-show.typ, not all of it. It may look like a general facility but currently it is not. 😔

I am not sure if I am missing anything or it is only typography property that is exposed in typst for now. If so, I would be interested to know how to use other properties too.

[gordonwoodhull]

Hi @alinacherkas, you are understanding correctly. We do not currently have any general facilities for accessing brand metadata in templates.

Given that templates are the same level of abstraction as brands, it would make sense to expose brand metadata directly to templates.

But currently you can only access the entire brand metadata from Lua or via the brand shortcode, neither of which help you with templates.

The background logo with positioning that we currently support in Typst

https://quarto.org/docs/authoring/brand.html#document-logo-customization

is implemented in this Lua filter:

quarto-cli/src/resources/filters/quarto-post/typst-brand-yaml.lua

Lines 217 to 305 in bf03850

	local logo = param('logo')
	local logoOptions = {}
	local foundLogo = null
	if logo then
	if type(logo) == 'string' then
	foundLogo = _quarto.modules.brand.get_logo(brandMode, logo) or {path=logo}
	elseif type(logo) == 'table' then
	for k, v in pairs(logo) do
	logoOptions[k] = v
	end
	if logo.path then
	foundLogo = _quarto.modules.brand.get_logo(brandMode, logo.path) or {path=logo}
	end
	end
	end
	if not foundLogo and brand.processedData.logo then
	local tries = {'large', 'small', 'medium'} -- low to high priority
	foundLogo = _quarto.modules.brand.get_logo(brandMode, 'medium')
	or _quarto.modules.brand.get_logo(brandMode, 'small')
	or _quarto.modules.brand.get_logo(brandMode, 'large')
	end
	if foundLogo then
	logoOptions.path = foundLogo.path
	logoOptions.alt = foundLogo.alt
	local pads = {}
	for k, v in _quarto.utils.table.sortedPairs(logoOptions) do
	if k == 'padding' then
	local widths = {}
	_quarto.modules.typst.css.parse_multiple(v, 5, function(s, start)
	local width, newstart = _quarto.modules.typst.css.consume_width(s, start)
	table.insert(widths, width)
	return newstart
	end)
	local sides = _quarto.modules.typst.css.expand_side_shorthand(
	widths,
	'widths in padding list: ' .. v)
	pads.top = sides.top
	pads.right = sides.right
	pads.bottom = sides.bottom
	pads.left = sides.left
	elseif k:find '^padding-' then
	local _, ndash = k:gsub('-', '')
	if ndash == 1 then
	local side = k:match('^padding--(%a+)')
	local padding_sides = {'left', 'top', 'right', 'bottom'}
	if tcontains(padding_sides, side) then
	pads[side] = _quarto.modules.typst.css.translate_length(v)
	else
	quarto.log.warning('invalid padding key ' .. k)
	end
	else
	quarto.log.warning('invalid padding key ' .. k)
	end
	end
	end
	local inset = nil
	if next(pads) then
	if pads.top == pads.right and
	pads.right == pads.bottom and
	pads.bottom == pads.left
	then
	inset = pads.top
	elseif pads.top == pads.bottom and pads.left == pads.right then
	inset = _quarto.modules.typst.as_typst_dictionary({x = pads.left, y = pads.top})
	else
	inset = _quarto.modules.typst.as_typst_dictionary(pads)
	end
	else
	inset = '0.75in'
	end
	logoOptions.width = _quarto.modules.typst.css.translate_length(logoOptions.width or '1.5in')
	logoOptions.location = logoOptions.location and
	location_to_typst_align(logoOptions.location) or 'left+top'
	quarto.log.debug('logo options', logoOptions)
	local altProp = logoOptions.alt and (', alt: "' .. logoOptions.alt .. '"') or ''
	local imageFilename = logoOptions.path
	if _quarto.modules.mediabag.should_mediabag(imageFilename) then
	imageFilename = _quarto.modules.mediabag.resolved_url_cache[logoOptions.path] or _quarto.modules.mediabag.fetch_and_store_image(logoOptions.path)
	imageFilename = _quarto.modules.mediabag.write_mediabag_entry(imageFilename) or imageFilename
	else
	-- backslashes need to be doubled for Windows
	imageFilename = string.gsub(imageFilename, '\\', '\\\\')
	end
	quarto.doc.include_text('in-header',
	'#set page(background: align(' .. logoOptions.location .. ', box(inset: ' .. inset .. ', image("' .. imageFilename .. '", width: ' .. logoOptions.width .. altProp .. '))))')
	end
	end
	end,

We have discussed separately that the logo should be implemented as a partial instead of this Lua filter directly generating the

#set page(background: ...)

Exposing brand metadata to templates would be a similar effort, but more general, because it would expose all of the brand logos to the template, not just the chosen one.

It could be done either through definition of more constants in Typst as is done for colors, or through more metadata exposed to the template as the Typst brand.typography metadata discussed here.

[gordonwoodhull]

Created #13107 to track this.

[gordonwoodhull]

We now have brand.logo metadata available as global dictionaries in the Typst output (#13119), and the document logo resolved with brand logo metadata becomes Pandoc metadata interpreted by a new Typst page partial (#13120).

The brand typography data is available through other Pandoc metadata, as shown above.

So I think, except for brand.meta, all brand data should be available to Typst templates now. Please comment or open another discussion if this is incorrect.