|
Download src/boardroom/guide.md from zal-analytics-core/znote-data: direct link, hf CLI and curl.
- Browser
- Download file 3.76 kB
-
https://huggingface.co/datasets/zal-analytics-core/znote-data/resolve/main/src/boardroom/guide.md
- Command line
-
hf download hf://datasets/zal-analytics-core/znote-data/src/boardroom/guide.md
-
curl -L -o guide.md https://huggingface.co/datasets/zal-analytics-core/znote-data/resolve/main/src/boardroom/guide.md
3.76 kB
| # Boardroom templates | |
| Corporate business documents: reports, memos, letters and 16:9 slide decks. Sans-serif text, navy | |
| headings and accents, light grey-blue rules. | |
| ## Templates | |
| - **Report** (`report`): longer business reports. Parameters: `title` (default `"Title"`), | |
| `subtitle` (`none`), `author` (`none`), `date` (today, e.g. "5 March 2026"). Prints a title block | |
| (navy bar, title, subtitle, author · date) on page 1; from page 2 a header with title and date. | |
| Footer "page / total". Headings are numbered `1.1`. | |
| - **Memo** (`memo`): short internal messages. Parameters: `to` (`"Recipient"`), `from` | |
| (`"Sender"`), `subject` (`"Subject"`), `date` (today). Prints "MEMO" and a To / From / Date / | |
| Subject block with a navy rule under it. Headings are not numbered. | |
| - **Letter** (`letter`): formal letters. Parameters: `sender` (`[Your name \ Street 1 \ City]`), | |
| `recipient` (`[Recipient \ Street 2 \ City]`), `subject` (`"Subject"`), `date` (today), | |
| `closing` (`"Kind regards,"`), `name` (`"Your name"`). Prints sender (right), recipient, date, | |
| bold subject, then the body, then the closing and the name. | |
| - **Slide deck** (`slides`): 16:9 presentations. Parameters: `title` (`"Title"`), `subtitle` | |
| (`none`), `author` (`none`), `date` (today). The first slide is a navy title slide made from these | |
| parameters. Every slide has a footer with the title and the slide number. | |
| ## Writing a page | |
| The template already sets: page size and margins, font and size, justified paragraphs (not in | |
| slides), navy headings with spacing, tables with thin grey-blue borders and a bold first row, and | |
| the title block, memo header or letter frame. | |
| Report: use `=` for chapters, `==` and `===` below them; numbering is automatic. | |
| Memo: write the message directly; use `==` or `=` only if the memo needs sections. | |
| Letter: write only the letter text, starting with the salutation ("Dear ...,"). The date, subject, | |
| closing and name come from the parameters. | |
| Slide deck: | |
| - Each `= Heading` starts a new slide; the heading is the slide title (30pt, navy). | |
| - `== Heading` is a smaller subheading inside the current slide. | |
| - Content after a `=` heading belongs to that slide until the next `=`. Text that does not fit | |
| flows onto an extra page without a title, so keep each slide to a few bullets. | |
| - Do not create a title slide; it is generated from the parameters. | |
| ```typ | |
| = Agenda | |
| - Results for Q3 | |
| - Plans for Q4 | |
| = Results for Q3 | |
| == Revenue | |
| Revenue grew by 12 % year on year. | |
| ``` | |
| Plain markup works everywhere: paragraphs, `-` lists, `+` numbered lists, `*bold*`, `_italic_`, | |
| `#table(...)` (first row is the header, bolded automatically), `#figure(..., caption: [...])`, | |
| `#image(...)`. | |
| ## Helpers | |
| This add-on has no content helpers; use plain Typst markup. | |
| Values a page may use: | |
| - `today`: today's date as text, e.g. "5 March 2026". | |
| - Colours, only when something must be coloured: `brand` (navy, headings and accents), `ink` (body | |
| text), `quiet` (grey secondary text), `soft` (light grey-blue lines). `sans` is the font list. | |
| ```typ | |
| #text(fill: brand)[*Decision:*] approve the Q4 budget. | |
| ``` | |
| ## Do not | |
| - Do not add `#set page`, `#set text`, `#set par` or font changes; the template sets them. | |
| - Do not use your own colours (`rgb(...)`, `blue`, ...); use `brand`, `quiet`, `ink` or `soft` | |
| only when something must be coloured. | |
| - Do not build your own boxes, banners or callouts with `block`, `rect` or `box`. | |
| - Do not remove or edit the template header between `// znote:template` and `// znote:end`. | |
| - Do not write the title, subtitle, author, date, memo fields, addresses, closing or signature | |
| name in the body; they come from the parameters. | |
| - Do not number headings by hand. In slides do not use `#pagebreak()` to start slides; use `=`. | |