@airmark/quiver 0.28.0 → 0.29.0

package/quills/usaf_memo/0.3.0/packages/tonguetoquill-usaf-memo/src/primitives.typ

@@ -0,0 +1,462 @@
+// primitives.typ: Reusable rendering primitives for USAF memorandum sections
+//
+// This module implements the visual rendering functions that produce AFH 33-337
+// compliant formatting for all sections of a USAF memorandum. Each function
+// corresponds to specific placement and formatting requirements from Chapter 14.
+
+#import "config.typ": *
+#import "utils.typ": *
+
+// =============================================================================
+// LETTERHEAD RENDERING
+// =============================================================================
+// AFH 33-337 §1: "Use printed letterhead, computer-generated letterhead, or plain bond paper"
+// Letterhead placement is not explicitly specified in AFH 33-337, but follows
+// standard USAF memo formatting conventions
+
+#let render-letterhead(
+  title,
+  caption,
+  font,
+  letterhead-seal: none,
+  letterhead-seal-subtitle: none,
+  letterhead-emblem: none, // optional image placed opposite the seal (right side)
+  letterhead-emblem-height: 1in, // emblem fit-box height; reduce for shorter emblems
+) = {
+  font = ensure-array(font)
+  // `upper` lowers content as readily as `str`, so the letterhead's uppercasing
+  // survives the title/caption arriving as `plaintext` markup blocks.
+  title = upper(join-lines(title))
+  caption = upper(join-lines(caption))
+
+  // Letterhead corner geometry. The seal (left) and emblem (right) share one
+  // reference band so the corners stay in parity: both bleed `corner-overhang`
+  // past the page margin and center on the same axis (`band-center`). The
+  // emblem may be shorter than the band but stays centered on that axis.
+  let corner-overhang = 0.5in
+  let corner-width = 2in
+  let band-height = 1in // seal height; also the emblem's reference band
+  let band-top = -band-height / 2 // puts the band center at dy 0
+  let band-center = band-top + band-height / 2
+
+  // The centered title/caption is placed content (not width-constrained), so a
+  // long caption would otherwise render on one line and run underneath the seal.
+  // Bound the caption to the width that stays clear of the seal on both sides
+  // and auto-shrink it to fit: the seal reaches `band-height - corner-overhang`
+  // into the text area, so reserving that plus a gutter on each side keeps the
+  // centered caption from touching the seal. `layout` resolves the text-area
+  // width so the bound tracks the page/margins.
+  let caption-gutter = 0.25in
+  let caption-clear = (band-height - corner-overhang) + caption-gutter
+  place(
+    dy: 0.625in - spacing.margin,
+    box(
+      width: 100%,
+      fill: none,
+      stroke: none,
+      layout(size => place(
+        center + top,
+        align(center)[
+          #set text(12pt, font: font, fill: LETTERHEAD_COLOR, weight: "bold")
+          #title\
+          #v(1pt)
+          #if not falsey(caption) {
+            fit-to-width(
+              size.width - 2 * caption-clear,
+              alignment: center,
+              box(text(10.5pt)[#caption]),
+            )
+          }
+        ],
+      )),
+    ),
+  )
+
+  if letterhead-seal != none {
+    let seal-body = if falsey(letterhead-seal-subtitle) {
+      block[
+        #fit-box(width: corner-width, height: band-height)[#letterhead-seal]
+      ]
+    } else {
+      // Isolate seal column from document `font_size`: stack `em` spacing and subtitle
+      // must not scale with body text (see frontmatter `set text(size: font_size)`).
+      // Subtitle is wrapped in `box` so it stays on one line and may extend past
+      // the seal's 2in column rather than wrapping.
+      block[
+        #set text(9pt, font: font, fill: LETTERHEAD_COLOR, weight: "bold")
+        // Spacing applies between positional stack children only, not one `[…]` body.
+        #stack(
+          spacing: 0.5em,
+          fit-box(width: corner-width, height: band-height)[#letterhead-seal],
+          box(upper(join-lines(letterhead-seal-subtitle))),
+        )
+      ]
+    }
+    place(
+      left + top,
+      dx: -corner-overhang,
+      dy: band-top,
+      seal-body,
+    )
+  }
+
+  if letterhead-emblem != none {
+    // Mirror the seal: same overhang and width, centered on the seal's band
+    // axis. Placing the emblem's top at `band-center - height/2` keeps its
+    // center on `band-center` for any (possibly shorter) emblem height.
+    place(
+      right + top,
+      dx: corner-overhang,
+      dy: band-center - letterhead-emblem-height / 2,
+      block[
+        #fit-box(width: corner-width, height: letterhead-emblem-height, alignment: right + horizon)[#letterhead-emblem]
+      ],
+    )
+  }
+}
+
+// =============================================================================
+// HEADER SECTIONS
+// =============================================================================
+// AFH 33-337 "The Heading Section" specifies exact placement and format for:
+// - Date: 1 inch from right edge, 1.75 inches from top
+// - MEMORANDUM FOR: Second line below date
+// - FROM: Second line below MEMORANDUM FOR
+// - SUBJECT: Second line below FROM
+
+// AFH 33-337 "Date": "Place the date 1 inch from the right edge, 1.75 inches from the top"
+#let render-date-section(date, memo-style: "usaf") = {
+  align(right)[#display-date(date, memo-style: memo-style)]
+}
+
+// AFH 33-337 "MEMORANDUM FOR": "Place 'MEMORANDUM FOR' on the second line below the date"
+#let render-for-section(recipients, cols) = {
+  blank-line()
+  grid(
+    columns: (auto, auto, 1fr),
+    "MEMORANDUM FOR",
+    "  ",
+    align(left)[
+      #if type(recipients) == array {
+        create-auto-grid(recipients.map(upper), column-gutter: spacing.tab, cols: cols)
+      } else {
+        upper(recipients)
+      }
+    ],
+  )
+}
+
+// AFH 33-337 "FROM:": "Place 'FROM:' in uppercase, flush with the left margin,
+// on the second line below the last line of the MEMORANDUM FOR element"
+#let render-from-section(from-info) = {
+  blank-line()
+  from-info = join-lines(from-info)
+
+  grid(
+    columns: (auto, auto, 1fr),
+    "FROM:", "  ", align(left)[#from-info],
+  )
+}
+
+/// Whether a `references` entry carries no citation text.
+///
+/// Blank entries reach the template routinely: a template author leaves a
+/// stub `- ` under `references:` for the user to fill in, and the quillmark
+/// helper hands back `""` for an unset or whitespace-only markdown field.
+/// Such an entry must not count as a reference — otherwise a lone blank one
+/// satisfies the "exactly one reference" test below and renders as an empty
+/// `()` after the subject.
+///
+/// - entry (any): A single `references` element
+/// -> bool
+#let blank-reference(entry) = falsey(entry) or entry == []
+
+/// Drops `references` entries that carry no citation text and normalizes the
+/// result to an array, so blank placeholder entries neither render on their
+/// own nor affect the inline-vs-block decision.
+///
+/// - references (array | none): Raw reference entries
+/// -> array
+#let compact-references(references) = ensure-array(references).filter(entry => not blank-reference(entry))
+
+// AFH 33-337 "SUBJECT:": "In all uppercase letters place 'SUBJECT:', flush with the
+// left margin, on the second line below the last line of the FROM element"
+#let render-subject-section(subject-text, inline-reference: none) = {
+  blank-line()
+  let content = if not blank-reference(inline-reference) {
+    // `subject-text` is a content field, so it is boxed for the same reason the
+    // inline reference is: a markup block's edge newlines would otherwise read
+    // as a space, doubling the one before the parenthesis.
+    [#box(subject-text) (#box(inline-reference))]
+  } else {
+    [#subject-text]
+  }
+  grid(
+    columns: (auto, auto, 1fr),
+    "SUBJECT:", "  ", content,
+  )
+}
+
+// AFH 33-337: only render References block for two or more references.
+// A single reference is rendered inline after the SUBJECT text instead.
+#let render-references-section(references) = {
+  let references = compact-references(references)
+  if references.len() >= 2 {
+    blank-line()
+    grid(
+      columns: (auto, auto, 1fr),
+      // Each entry is markdown-converted content; spread them as enum items
+      // lettered "(a) (b) (c)" per AFH 33-337.
+      "References:", "  ", enum(..references, numbering: "(a) ", body-indent: 0pt),
+    )
+  }
+}
+
+// =============================================================================
+// SIGNATURE BLOCK
+// =============================================================================
+// AFH 33-337 "Signature Block": "Start the signature block on the fifth line below
+// the last line of text and 4.5 inches from the left edge of the page or three
+// spaces to the right of page center"
+// AFH 33-337 "Do not place the signature element on a continuation page by itself"
+// AFH 33-337 long-name example: "Signature block adjusted to the left" when a
+// long name would otherwise exceed the right margin.
+
+#let render-signature-block(signature-lines, signature-blank-lines: 4, signing-field: none) = {
+  signature-lines = ensure-array(signature-lines)
+  // AFH 33-337: "fifth line below" = 4 blank lines between text and signature block.
+  // breakable: false discourages orphaning the signature block onto a page by itself.
+  blank-lines(signature-blank-lines)
+  // AFH 33-337 allows two equivalent anchors: 4.5in from the left edge, or three
+  // spaces right of page center. On 8.5in stock these coincide (page center =
+  // 4.25in; three TNR-12pt spaces ≈ 0.25in), so we use 4.5in as the canonical
+  // anchor. pad() is relative to the text area, hence (4.5in - margin).
+  let default-pad = 4.5in - spacing.margin
+  context {
+    // Measure each line at its rendered settings to detect long-name overflow.
+    let body-width = page.width - 2 * spacing.margin
+    let widest = 0pt
+    for line in signature-lines {
+      let w = measure(text(hyphenate: false, line)).width
+      if w > widest { widest = w }
+    }
+    // If the widest line would overflow the right margin at the standard
+    // anchor, shift the block left just enough to fit. Clamp at 0 so the
+    // block never crosses the left margin.
+    let available = body-width - default-pad
+    let left-pad = if widest > available {
+      let shifted = body-width - widest
+      if shifted < 0pt { 0pt } else { shifted }
+    } else {
+      default-pad
+    }
+    block(breakable: false)[
+      #if signing-field != none {
+        let stride = {
+          let s = LINE_STRIDE.get()
+          if s == none {
+            let one-line = measure(par(spacing: 0pt)[x]).height
+            measure(par(spacing: 0pt)[x#linebreak()x]).height - one-line
+          } else { s }
+        }
+        place(
+          dx: left-pad,
+          dy: -(stride * signature-blank-lines),
+          box(width: body-width - left-pad, height: stride * signature-blank-lines, signing-field),
+        )
+      }
+      #align(left)[
+        #pad(left: left-pad)[
+          #text(hyphenate: false)[
+            #for line in signature-lines {
+              // AFH 33-337: "indent the next line to begin under the third character
+              // of the line above" — 2-character indent ≈ 1em in Times New Roman 12pt
+              par(hanging-indent: .5em, line)
+            }
+          ]
+        ]
+      ]
+    ]
+  }
+}
+
+// =============================================================================
+// ACTION LINE RENDERING
+// =============================================================================
+// Renders the decision line for indorsement memos — an "either / or" pair
+// where the endorser's choice is circled and the rejected option struck out.
+//
+// Two option pairs are supported, reflecting the two roles an indorsement
+// plays in a coordination chain: coordinating officials Concur / Nonconcur,
+// while the final approval authority Approves / Disapproves.
+//
+// Each pair also has an "undecided" form that renders both options plain, for
+// printing a memo the endorser circles by hand when signing.
+//
+// Empty/none suppression is handled by the caller before this is invoked.
+
+// Maps each `action` value to the option pair it renders and the index of the
+// selected option within that pair (`none` selects neither).
+#let ACTION_FORMS = (
+  "undecided": (("Approve", "Disapprove"), none),
+  "approve": (("Approve", "Disapprove"), 0),
+  "disapprove": (("Approve", "Disapprove"), 1),
+  "undecided_concur": (("Concur", "Nonconcur"), none),
+  "concur": (("Concur", "Nonconcur"), 0),
+  "nonconcur": (("Concur", "Nonconcur"), 1),
+)
+
+#let render-action-line(action, trailing-blank-line: true) = {
+  assert(
+    action in ACTION_FORMS,
+    message: "action must be one of " + ACTION_FORMS.keys().map(k => "\"" + k + "\"").join(", "),
+  )
+  let (options, selected) = ACTION_FORMS.at(action)
+  // Circle the selected option using a box with rounded corners; strike the
+  // one it was chosen over. When neither is selected both render plain.
+  // Use baseline parameter to maintain vertical text alignment.
+  let render-option(index) = {
+    let option = options.at(index)
+    if selected == none {
+      option
+    } else if selected == index {
+      box(stroke: 0.5pt + black, radius: 2pt, inset: 2pt, baseline: 2pt)[#option]
+    } else {
+      strike(option)
+    }
+  }
+  // No leading blank-line: the caller (indorsement.typ) already emits the
+  // header→content gap once. The action line's `block(sticky: true)`
+  // additionally inherits `block.above: spacing.line` so the visual gap
+  // above matches the gap above a body's first paragraph.
+  //
+  // Keep the action line with the following content (body or signature block)
+  // using the same sticky-block pattern that body.typ applies to the last
+  // paragraph, per AFH 33-337 §11 orphan-prevention rules.
+  block(sticky: true)[#render-option(0) / #render-option(1)]
+  // Trailing blank-line places the body's first paragraph one line below
+  // the action, mirroring the gap above it. Suppressed when the body is
+  // empty so the signature block's own 4-line gap lands on AFH 33-337's
+  // "fifth line below the last line of text" anchor.
+  if trailing-blank-line {
+    blank-line()
+  }
+}
+
+// =============================================================================
+// TABLE RENDERING
+// =============================================================================
+// AFH 33-337 does not specify table formatting, so we follow the general
+// aesthetic principles of the standard: plain black borders, no decorative
+// fills, and the body font inherited throughout.
+
+/// Renders a table with USAF memorandum–consistent formatting.
+///
+/// Applies simple 0.5pt black cell borders and standard padding to any
+/// Typst `table` element, keeping the visual style clean and formal.
+/// Font and size are inherited from the surrounding body text.
+///
+/// - it (content): The table element to style and render
+/// -> content
+#let render-memo-table(it) = {
+  // AFH 33-337 does not specify table formatting, so we follow the general
+  // aesthetic principles of the standard: bold headers for clarity.
+  show table.cell.where(y: 0): set text(weight: "bold")
+  set table(
+    stroke: 0.5pt + black,
+    inset: (x: 0.5em, y: 0.4em),
+  )
+  it
+}
+
+// =============================================================================
+// BACKMATTER SECTIONS
+// =============================================================================
+// AFH 33-337 "Attachment or Attachments": "Place 'Attachment:' (for a single attachment)
+// or '# Attachments:' (for two or more attachments) at the left margin, on the third
+// line below the signature element"
+// AFH 33-337 "Courtesy Copy Element": "place 'cc:' flush with the left margin, on the
+// second line below the attachment element"
+
+#let render-backmatter-section(
+  content,
+  section-label,
+  numbering-style: none,
+  continuation-label: none,
+) = {
+  let formatted-content = {
+    // Use text() wrapper to prevent section label from being treated as a paragraph
+    text()[#section-label]
+    linebreak()
+    if numbering-style != none {
+      let items = ensure-array(content)
+      enum(..items, numbering: numbering-style)
+    } else {
+      join-lines(content)
+    }
+  }
+
+  context {
+    let available-space = page.height - here().position().y - 1in
+    if measure(formatted-content).height > available-space {
+      // Attachments pass continuation-label ("… (listed on next page):" per AFH 33-337).
+      // cc: and DISTRIBUTION: use a neutral default — "listed" applies to attachment lists only.
+      let continuation-text = if continuation-label != none {
+        text()[#continuation-label]
+      } else {
+        text()[#(section-label + " (continued on next page)")]
+      }
+      continuation-text
+      pagebreak()
+    }
+    formatted-content
+  }
+}
+
+#let calculate-backmatter-spacing(is-first-section) = {
+  context {
+    let line_count = if is-first-section { 2 } else { 1 }
+    blank-lines(line_count)
+  }
+}
+
+#let render-backmatter-sections(
+  attachments: none,
+  cc: none,
+  distribution: none,
+  leading-pagebreak: false,
+) = {
+  let has-backmatter = (
+    (attachments != none and attachments.len() > 0)
+      or (cc != none and cc.len() > 0)
+      or (distribution != none and distribution.len() > 0)
+  )
+
+  if leading-pagebreak and has-backmatter {
+    pagebreak(weak: true)
+  }
+
+  if attachments != none and attachments.len() > 0 {
+    calculate-backmatter-spacing(true)
+    let attachment-count = attachments.len()
+    let section-label = if attachment-count == 1 { "Attachment:" } else { str(attachment-count) + " Attachments:" }
+    let continuation-label = (
+      (if attachment-count == 1 { "Attachment" } else { str(attachment-count) + " Attachments" })
+        + " (listed on next page):"
+    )
+    // AFH 33-337: a single attachment is not numbered; numbering applies to two or more.
+    let numbering-style = if attachment-count == 1 { none } else { "1." }
+    render-backmatter-section(attachments, section-label, numbering-style: numbering-style, continuation-label: continuation-label)
+  }
+
+  if cc != none and cc.len() > 0 {
+    calculate-backmatter-spacing(attachments == none or attachments.len() == 0)
+    render-backmatter-section(cc, "cc:")
+  }
+
+  if distribution != none and distribution.len() > 0 {
+    calculate-backmatter-spacing((attachments == none or attachments.len() == 0) and (cc == none or cc.len() == 0))
+    render-backmatter-section(distribution, "DISTRIBUTION:")
+  }
+}
+