Universe

Create project in app

Briefs is a simple Typst template for letters (German: Briefe). It is inspired by DIN 5008 and targets A4 paper. The address box fits the window of a DIN lang envelope.

Example

#import "@preview/briefs:0.1.0": letter

#set text(lang: "de", font: "TeX Gyre Heros")
#show: letter.with(
  sender: (
    [Hilfsorganisation e.V.],
    [Spendengasse 12],
    [12345 Helfershausen]
  ),
  recipient: [
    Frau\
    Erika Mustermann\
    Rathausplatz 37\
    67890 Waldhausen
  ],
  location: "Helfershausen",
  subject: [*Vielen Dank für Ihre Spende*]
)

Sehr geehrte Frau Mustermann,

wir bedanken uns herzlich für Ihre großzügige Spende an unseren Verein.
Durch Ihre Unterstützung können wir weiterhin wichtige soziale Projekte
durchführen und Menschen in Not helfen.

Vielen Dank für Ihr Vertrauen und Ihre Mithilfe!

#v(0.5cm)
Mit freundlichen Grüßen

Hilfsorganisation e.V.

example

For more examples check out the folder tests.

Reference

Document Structure

The image below shows the basic document structure. The address box contains sender and recipient. The information box contains additional information – the default is sender, location and date. structure

API

letter(
  sender: (),
  sender-font-size: 8pt,
  sender-separator: ", ",
  recipient: [],
  information: auto,
  information-box: (125mm, 25mm, 75mm, 65mm),
  date: auto,
  date-format: auto,
  location: none,
  location-date-separator: ", ",
  subject: none,
  folding-marks: true,
  hole-punch-mark: true,
  background: [],
  show-boxes: false,
  ..page-args,
  body
)

Arguments

  • sender   array of content   Default: ()

    Sender’s name and address. This address is shown in the address box with font size sender-font-size and concatenated with separator sender-separator. If information is auto, this address is also shown at the top of the information box.

  • sender-font-size   length   Default: 8pt

    Font size of the sender’s name and address in the address box.

  • sender-separator   content   Default: ", "

    Separator between sender’s address parts in address box.

  • recipient   content   Default: []

    The recipient’s name and address. Add line breaks manually.

  • information   auto | content   Default: auto

    Content of the information box. If this is auto, the sender, location, and date are shown as a default.

  • information-box   array of length   Default: (125mm, 25mm, 75mm, 65mm)

    Absolute position and size of the information box: (x, y, width, height).

  • date   auto | datetime | content   Default: auto

    The date (only used, if information is auto). If this is auto, the current date is shown. If auto or a value of type datetime is provided, the date will be formatted with date-format.

  • date-format   auto | str   Default: auto

    The date format which is applied if date is auto or of type datetime. If date-format is a string, it is directly passed to Typst’s datetime.display() function. If date-format is auto and text.lang is "de", the format [day].[month].[year] is used. If a different language is set, auto is passed to datetime.display().

  • location   none | content   Default: none

    The location (only used, if information is auto).

  • location-date-separator   content   Default: ", "

    The separator between location and date

  • subject   none | content   Default: none

    The subject

  • folding-marks   bool   Default: true

    Whether folding marks are shown

  • hole-punch-mark   bool   Default: true

    Whether a hole punch mark is shown

  • background   content   Default: []

    Content for the page background. The folding marks and the hole punch mark are placed on the page’s background. If you want to add additional content to the background, provide it here.

  • show-boxes   bool   Default: false

    Whether address box and information box are framed. This is mainly for debugging.

  • page-args   any (variadic)

    Additional arguments for Typst’s page() function.
    Default arguments are:
    margin: (left: 25mm, rest: 20mm)
    number-align: bottom + right
    numbering: (i, t) => text(10pt, context (localized().page-number)(i, t))
    However, those values can be overwritten.

  • body   content

    The letter content