Sync templates from znote
Browse files- index.json +21 -21
- src/blueprint/guide.md +83 -0
- src/blueprint/theme.json +4 -4
- src/blueprint/typst/typst.toml +1 -1
- src/boardroom/guide.md +75 -0
- src/boardroom/theme.json +5 -5
- src/boardroom/typst/typst.toml +1 -1
- src/books/guide.md +133 -0
- src/books/theme.json +1 -1
- src/classroom/guide.md +103 -0
- src/classroom/theme.json +5 -5
- src/classroom/typst/typst.toml +1 -1
- src/papers/guide.md +144 -0
- src/papers/theme.json +1 -1
- src/resume/guide.md +120 -0
- src/resume/theme.json +1 -1
- src/zal-analytics/guide.md +93 -0
- src/zal-analytics/theme.json +4 -4
- src/zal-analytics/typst/typst.toml +1 -1
- themes/blueprint.znx +0 -0
- themes/boardroom.znx +0 -0
- themes/books.znx +0 -0
- themes/classroom.znx +0 -0
- themes/papers.znx +0 -0
- themes/resume.znx +0 -0
- themes/zal-analytics.znx +2 -2
index.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
| 3 |
"format": 1,
|
| 4 |
"id": "blueprint",
|
| 5 |
"name": "Blueprint",
|
| 6 |
-
"version": "1.0.
|
| 7 |
"description": "An engineering look with templates for specifications, design documents and test reports.",
|
| 8 |
"category": "Technical",
|
| 9 |
"tags": [
|
|
@@ -16,17 +16,17 @@
|
|
| 16 |
{
|
| 17 |
"label": "Specification",
|
| 18 |
"kind": "document",
|
| 19 |
-
"snippet": "#import \"@themes/blueprint:1.0.
|
| 20 |
},
|
| 21 |
{
|
| 22 |
"label": "Design document",
|
| 23 |
"kind": "document",
|
| 24 |
-
"snippet": "#import \"@themes/blueprint:1.0.
|
| 25 |
},
|
| 26 |
{
|
| 27 |
"label": "Test report",
|
| 28 |
"kind": "document",
|
| 29 |
-
"snippet": "#import \"@themes/blueprint:1.0.
|
| 30 |
}
|
| 31 |
]
|
| 32 |
}
|
|
@@ -35,7 +35,7 @@
|
|
| 35 |
"format": 1,
|
| 36 |
"id": "boardroom",
|
| 37 |
"name": "Boardroom",
|
| 38 |
-
"version": "1.0.
|
| 39 |
"description": "A navy corporate look with templates for reports, memos, letters and slide decks.",
|
| 40 |
"category": "Business",
|
| 41 |
"tags": [
|
|
@@ -48,22 +48,22 @@
|
|
| 48 |
{
|
| 49 |
"label": "Report",
|
| 50 |
"kind": "document",
|
| 51 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 52 |
},
|
| 53 |
{
|
| 54 |
"label": "Memo",
|
| 55 |
"kind": "document",
|
| 56 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 57 |
},
|
| 58 |
{
|
| 59 |
"label": "Letter",
|
| 60 |
"kind": "document",
|
| 61 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 62 |
},
|
| 63 |
{
|
| 64 |
"label": "Slide deck",
|
| 65 |
"kind": "slides",
|
| 66 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 67 |
}
|
| 68 |
]
|
| 69 |
}
|
|
@@ -72,7 +72,7 @@
|
|
| 72 |
"format": 1,
|
| 73 |
"id": "books",
|
| 74 |
"name": "Books and newsletters",
|
| 75 |
-
"version": "1.0.
|
| 76 |
"description": "Templates for long books, novels and a department newsletter, built on packages from Typst Universe.",
|
| 77 |
"category": "Creative",
|
| 78 |
"tags": [
|
|
@@ -104,7 +104,7 @@
|
|
| 104 |
"format": 1,
|
| 105 |
"id": "classroom",
|
| 106 |
"name": "Classroom",
|
| 107 |
-
"version": "1.0.
|
| 108 |
"description": "A friendly look with templates for lecture notes, worksheets, exams and lecture slides.",
|
| 109 |
"category": "Education",
|
| 110 |
"tags": [
|
|
@@ -117,22 +117,22 @@
|
|
| 117 |
{
|
| 118 |
"label": "Lecture notes",
|
| 119 |
"kind": "document",
|
| 120 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 121 |
},
|
| 122 |
{
|
| 123 |
"label": "Worksheet",
|
| 124 |
"kind": "document",
|
| 125 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 126 |
},
|
| 127 |
{
|
| 128 |
"label": "Exam",
|
| 129 |
"kind": "document",
|
| 130 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 131 |
},
|
| 132 |
{
|
| 133 |
"label": "Lecture slides",
|
| 134 |
"kind": "slides",
|
| 135 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 136 |
}
|
| 137 |
]
|
| 138 |
}
|
|
@@ -141,7 +141,7 @@
|
|
| 141 |
"format": 1,
|
| 142 |
"id": "papers",
|
| 143 |
"name": "Research papers",
|
| 144 |
-
"version": "1.0.
|
| 145 |
"description": "Templates for journal-style papers and preprints, built on packages from Typst Universe.",
|
| 146 |
"category": "Academic",
|
| 147 |
"tags": [
|
|
@@ -174,7 +174,7 @@
|
|
| 174 |
"format": 1,
|
| 175 |
"id": "resume",
|
| 176 |
"name": "Resume",
|
| 177 |
-
"version": "1.0.
|
| 178 |
"description": "A clean one-page resume, built on a package from Typst Universe.",
|
| 179 |
"category": "Personal",
|
| 180 |
"tags": [
|
|
@@ -196,7 +196,7 @@
|
|
| 196 |
"format": 1,
|
| 197 |
"id": "zal-analytics",
|
| 198 |
"name": "ZAL Analytics",
|
| 199 |
-
"version": "1.0.
|
| 200 |
"description": "The monochrome, code-first look of zal-analytics.nl: sharp corners, monospace headings and a rosewood accent.",
|
| 201 |
"category": "Technical",
|
| 202 |
"tags": [
|
|
@@ -210,17 +210,17 @@
|
|
| 210 |
{
|
| 211 |
"label": "Documentation",
|
| 212 |
"kind": "document",
|
| 213 |
-
"snippet": "#import \"@themes/zal-analytics:1.0.
|
| 214 |
},
|
| 215 |
{
|
| 216 |
"label": "Note",
|
| 217 |
"kind": "document",
|
| 218 |
-
"snippet": "#import \"@themes/zal-analytics:1.0.
|
| 219 |
},
|
| 220 |
{
|
| 221 |
"label": "Slides",
|
| 222 |
"kind": "slides",
|
| 223 |
-
"snippet": "#import \"@themes/zal-analytics:1.0.
|
| 224 |
}
|
| 225 |
]
|
| 226 |
}
|
|
|
|
| 3 |
"format": 1,
|
| 4 |
"id": "blueprint",
|
| 5 |
"name": "Blueprint",
|
| 6 |
+
"version": "1.0.1",
|
| 7 |
"description": "An engineering look with templates for specifications, design documents and test reports.",
|
| 8 |
"category": "Technical",
|
| 9 |
"tags": [
|
|
|
|
| 16 |
{
|
| 17 |
"label": "Specification",
|
| 18 |
"kind": "document",
|
| 19 |
+
"snippet": "#import \"@themes/blueprint:1.0.1\": *\n#show: specification.with(title: \"Title\", number: \"DOC-0001\", revision: \"A\", status: \"Draft\", author: \"Your name\")\n"
|
| 20 |
},
|
| 21 |
{
|
| 22 |
"label": "Design document",
|
| 23 |
"kind": "document",
|
| 24 |
+
"snippet": "#import \"@themes/blueprint:1.0.1\": *\n#show: design.with(title: \"Title\", author: \"Your name\", status: \"Draft\", reviewers: \"Reviewer names\")\n"
|
| 25 |
},
|
| 26 |
{
|
| 27 |
"label": "Test report",
|
| 28 |
"kind": "document",
|
| 29 |
+
"snippet": "#import \"@themes/blueprint:1.0.1\": *\n#show: test-report.with(title: \"Title\", number: \"TR-0001\", tester: \"Your name\")\n"
|
| 30 |
}
|
| 31 |
]
|
| 32 |
}
|
|
|
|
| 35 |
"format": 1,
|
| 36 |
"id": "boardroom",
|
| 37 |
"name": "Boardroom",
|
| 38 |
+
"version": "1.0.1",
|
| 39 |
"description": "A navy corporate look with templates for reports, memos, letters and slide decks.",
|
| 40 |
"category": "Business",
|
| 41 |
"tags": [
|
|
|
|
| 48 |
{
|
| 49 |
"label": "Report",
|
| 50 |
"kind": "document",
|
| 51 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: report.with(title: \"Title\", subtitle: \"Subtitle\", author: \"Your name\")\n"
|
| 52 |
},
|
| 53 |
{
|
| 54 |
"label": "Memo",
|
| 55 |
"kind": "document",
|
| 56 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: memo.with(to: \"Recipient\", from: \"Your name\", subject: \"Subject\")\n"
|
| 57 |
},
|
| 58 |
{
|
| 59 |
"label": "Letter",
|
| 60 |
"kind": "document",
|
| 61 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: letter.with(sender: [Your name \\ Street 1 \\ City], recipient: [Recipient \\ Street 2 \\ City], subject: \"Subject\", name: \"Your name\")\n"
|
| 62 |
},
|
| 63 |
{
|
| 64 |
"label": "Slide deck",
|
| 65 |
"kind": "slides",
|
| 66 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: slides.with(title: \"Title\", subtitle: \"Subtitle\", author: \"Your name\")\n"
|
| 67 |
}
|
| 68 |
]
|
| 69 |
}
|
|
|
|
| 72 |
"format": 1,
|
| 73 |
"id": "books",
|
| 74 |
"name": "Books and newsletters",
|
| 75 |
+
"version": "1.0.1",
|
| 76 |
"description": "Templates for long books, novels and a department newsletter, built on packages from Typst Universe.",
|
| 77 |
"category": "Creative",
|
| 78 |
"tags": [
|
|
|
|
| 104 |
"format": 1,
|
| 105 |
"id": "classroom",
|
| 106 |
"name": "Classroom",
|
| 107 |
+
"version": "1.0.1",
|
| 108 |
"description": "A friendly look with templates for lecture notes, worksheets, exams and lecture slides.",
|
| 109 |
"category": "Education",
|
| 110 |
"tags": [
|
|
|
|
| 117 |
{
|
| 118 |
"label": "Lecture notes",
|
| 119 |
"kind": "document",
|
| 120 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: notes.with(title: \"Title\", course: \"Course name\", lecturer: \"Your name\")\n"
|
| 121 |
},
|
| 122 |
{
|
| 123 |
"label": "Worksheet",
|
| 124 |
"kind": "document",
|
| 125 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: worksheet.with(title: \"Title\", course: \"Course name\")\n"
|
| 126 |
},
|
| 127 |
{
|
| 128 |
"label": "Exam",
|
| 129 |
"kind": "document",
|
| 130 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: exam.with(title: \"Title\", course: \"Course name\", duration: \"90 minutes\")\n"
|
| 131 |
},
|
| 132 |
{
|
| 133 |
"label": "Lecture slides",
|
| 134 |
"kind": "slides",
|
| 135 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: slides.with(title: \"Title\", course: \"Course name\", lecturer: \"Your name\")\n"
|
| 136 |
}
|
| 137 |
]
|
| 138 |
}
|
|
|
|
| 141 |
"format": 1,
|
| 142 |
"id": "papers",
|
| 143 |
"name": "Research papers",
|
| 144 |
+
"version": "1.0.1",
|
| 145 |
"description": "Templates for journal-style papers and preprints, built on packages from Typst Universe.",
|
| 146 |
"category": "Academic",
|
| 147 |
"tags": [
|
|
|
|
| 174 |
"format": 1,
|
| 175 |
"id": "resume",
|
| 176 |
"name": "Resume",
|
| 177 |
+
"version": "1.0.1",
|
| 178 |
"description": "A clean one-page resume, built on a package from Typst Universe.",
|
| 179 |
"category": "Personal",
|
| 180 |
"tags": [
|
|
|
|
| 196 |
"format": 1,
|
| 197 |
"id": "zal-analytics",
|
| 198 |
"name": "ZAL Analytics",
|
| 199 |
+
"version": "1.0.1",
|
| 200 |
"description": "The monochrome, code-first look of zal-analytics.nl: sharp corners, monospace headings and a rosewood accent.",
|
| 201 |
"category": "Technical",
|
| 202 |
"tags": [
|
|
|
|
| 210 |
{
|
| 211 |
"label": "Documentation",
|
| 212 |
"kind": "document",
|
| 213 |
+
"snippet": "#import \"@themes/zal-analytics:1.0.1\": *\n#show: documentation.with(title: \"Title\", summary: [One sentence about this document.], author: \"Your name\", version: \"v0.1.0\")\n"
|
| 214 |
},
|
| 215 |
{
|
| 216 |
"label": "Note",
|
| 217 |
"kind": "document",
|
| 218 |
+
"snippet": "#import \"@themes/zal-analytics:1.0.1\": *\n#show: note.with(title: \"Title\", topic: \"Engineering note\", author: \"Your name\")\n"
|
| 219 |
},
|
| 220 |
{
|
| 221 |
"label": "Slides",
|
| 222 |
"kind": "slides",
|
| 223 |
+
"snippet": "#import \"@themes/zal-analytics:1.0.1\": *\n#show: slides.with(title: \"Title\", subtitle: \"Subtitle\", author: \"Your name\")\n"
|
| 224 |
}
|
| 225 |
]
|
| 226 |
}
|
src/blueprint/guide.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Blueprint templates
|
| 2 |
+
|
| 3 |
+
Engineering documents: specifications, design documents and test reports. A4, sans-serif body,
|
| 4 |
+
teal headings, thin grey rules, a boxed title block and a monospace header and footer.
|
| 5 |
+
|
| 6 |
+
## Templates
|
| 7 |
+
- **Specification** (`specification`): formal, numbered requirement documents. Parameters:
|
| 8 |
+
`title` (default `"Title"`), `number` (document number, `"DOC-0001"`), `revision` (`"A"`),
|
| 9 |
+
`status` (`"Draft"`), `author` (`none`), `date` (today as `YYYY-MM-DD`). Prints a title block
|
| 10 |
+
with all fields, then a table of contents (`outline(depth: 2)`).
|
| 11 |
+
- **Design document** (`design`): describing a design for review. Parameters: `title`
|
| 12 |
+
(`"Title"`), `author` (`none`), `status` (`"Draft"`), `reviewers` (`none`), `date` (today).
|
| 13 |
+
Title block, no table of contents.
|
| 14 |
+
- **Test report** (`test-report`): recording test runs and their results. Parameters: `title`
|
| 15 |
+
(`"Title"`), `number` (`"TR-0001"`), `tester` (`none`), `date` (today). Title block, no table of
|
| 16 |
+
contents.
|
| 17 |
+
|
| 18 |
+
## Writing a page
|
| 19 |
+
The template already sets: A4 page and margins, font and size (10pt), justified paragraphs, a
|
| 20 |
+
header (document number or kind on the left, title on the right) and a footer with "page of
|
| 21 |
+
total", teal headings numbered `1.1`, tables with thin grey borders and a bold first row,
|
| 22 |
+
monospace code. The title block is printed from the show-rule parameters; do not write the title
|
| 23 |
+
again.
|
| 24 |
+
|
| 25 |
+
- Start with `=` sections; use `==` and `===` below them. Numbering is automatic: do not type
|
| 26 |
+
numbers into headings. In a specification only `=` and `==` appear in the contents.
|
| 27 |
+
- Use plain markup for the rest: paragraphs, `-` lists, `+` numbered lists, `*bold*`, `_italic_`,
|
| 28 |
+
`` `code` `` and ```` ``` ```` code blocks, `$...$` maths.
|
| 29 |
+
- Put tabular data in `#table(...)`; the first row is the header and is bolded automatically.
|
| 30 |
+
Wrap it in `#figure(..., caption: [...])` when it needs a caption.
|
| 31 |
+
|
| 32 |
+
## Helpers
|
| 33 |
+
|
| 34 |
+
`requirement(id, body)`: one requirement with its identifier, marked by a teal left bar. Use one
|
| 35 |
+
per requirement in specifications.
|
| 36 |
+
```typ
|
| 37 |
+
#requirement("REQ-001")[The pump shall start within 2 s of the start command.]
|
| 38 |
+
#requirement("REQ-002")[The controller shall log every fault with a timestamp.]
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
`note(body)`: a light grey boxed note for remarks, assumptions or warnings.
|
| 42 |
+
```typ
|
| 43 |
+
#note[Values in this section assume an ambient temperature of 20 °C.]
|
| 44 |
+
```
|
| 45 |
+
|
| 46 |
+
`result(status)`: a small coloured status badge. Pass a string: `"pass"` is green, `"fail"` is
|
| 47 |
+
red, anything else (for example `"blocked"`) is amber. The text is printed in upper case.
|
| 48 |
+
```typ
|
| 49 |
+
#table(
|
| 50 |
+
columns: (auto, 1fr, auto),
|
| 51 |
+
[ID], [Test], [Result],
|
| 52 |
+
[T-01], [Start-up time], result("pass"),
|
| 53 |
+
[T-02], [Fault logging], result("fail"),
|
| 54 |
+
[T-03], [Remote stop], result("blocked"),
|
| 55 |
+
)
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
`tag(body)`: small grey upper-case monospace label, as used in the header and title block. Use it
|
| 59 |
+
for short labels, not for running text.
|
| 60 |
+
```typ
|
| 61 |
+
#tag[Measured] 2.1 s
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
`today`: today's date as a `YYYY-MM-DD` string.
|
| 65 |
+
|
| 66 |
+
Colour and font constants, for the rare case something must be coloured or set in the template's
|
| 67 |
+
font: `ink` (body text), `accent` (teal, headings and requirement bars), `rule` (grey lines),
|
| 68 |
+
`quiet` (grey secondary text), `sans` (body font list), `mono` (code font list).
|
| 69 |
+
```typ
|
| 70 |
+
#text(fill: accent)[Critical path]
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
## Do not
|
| 74 |
+
- Do not add `#set page`, `#set text`, `#set par` or font changes; the template sets them.
|
| 75 |
+
- Do not use your own colours (`rgb(...)`, `red`, ...); use the constants above only when
|
| 76 |
+
something must be coloured.
|
| 77 |
+
- Do not build your own boxes, callouts or badges with `block`/`rect`/`box`; use `requirement`,
|
| 78 |
+
`note` and `result`.
|
| 79 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 80 |
+
- Do not write a title, title block, document number, date or table of contents; the template
|
| 81 |
+
prints them from its parameters.
|
| 82 |
+
- Do not number headings by hand or change `heading` numbering.
|
| 83 |
+
- Do not pass content to `result` (`result[pass]`); pass a string so the colour is picked.
|
src/blueprint/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "blueprint",
|
| 4 |
"name": "Blueprint",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "An engineering look with templates for specifications, design documents and test reports.",
|
| 7 |
"category": "Technical",
|
| 8 |
"tags": [
|
|
@@ -15,17 +15,17 @@
|
|
| 15 |
{
|
| 16 |
"label": "Specification",
|
| 17 |
"kind": "document",
|
| 18 |
-
"snippet": "#import \"@themes/blueprint:1.0.
|
| 19 |
},
|
| 20 |
{
|
| 21 |
"label": "Design document",
|
| 22 |
"kind": "document",
|
| 23 |
-
"snippet": "#import \"@themes/blueprint:1.0.
|
| 24 |
},
|
| 25 |
{
|
| 26 |
"label": "Test report",
|
| 27 |
"kind": "document",
|
| 28 |
-
"snippet": "#import \"@themes/blueprint:1.0.
|
| 29 |
}
|
| 30 |
]
|
| 31 |
}
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "blueprint",
|
| 4 |
"name": "Blueprint",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "An engineering look with templates for specifications, design documents and test reports.",
|
| 7 |
"category": "Technical",
|
| 8 |
"tags": [
|
|
|
|
| 15 |
{
|
| 16 |
"label": "Specification",
|
| 17 |
"kind": "document",
|
| 18 |
+
"snippet": "#import \"@themes/blueprint:1.0.1\": *\n#show: specification.with(title: \"Title\", number: \"DOC-0001\", revision: \"A\", status: \"Draft\", author: \"Your name\")\n"
|
| 19 |
},
|
| 20 |
{
|
| 21 |
"label": "Design document",
|
| 22 |
"kind": "document",
|
| 23 |
+
"snippet": "#import \"@themes/blueprint:1.0.1\": *\n#show: design.with(title: \"Title\", author: \"Your name\", status: \"Draft\", reviewers: \"Reviewer names\")\n"
|
| 24 |
},
|
| 25 |
{
|
| 26 |
"label": "Test report",
|
| 27 |
"kind": "document",
|
| 28 |
+
"snippet": "#import \"@themes/blueprint:1.0.1\": *\n#show: test-report.with(title: \"Title\", number: \"TR-0001\", tester: \"Your name\")\n"
|
| 29 |
}
|
| 30 |
]
|
| 31 |
}
|
src/blueprint/typst/typst.toml
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
[package]
|
| 2 |
name = "blueprint"
|
| 3 |
-
version = "1.0.
|
| 4 |
entrypoint = "lib.typ"
|
|
|
|
| 1 |
[package]
|
| 2 |
name = "blueprint"
|
| 3 |
+
version = "1.0.1"
|
| 4 |
entrypoint = "lib.typ"
|
src/boardroom/guide.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Boardroom templates
|
| 2 |
+
|
| 3 |
+
Corporate business documents: reports, memos, letters and 16:9 slide decks. Sans-serif text, navy
|
| 4 |
+
headings and accents, light grey-blue rules.
|
| 5 |
+
|
| 6 |
+
## Templates
|
| 7 |
+
- **Report** (`report`): longer business reports. Parameters: `title` (default `"Title"`),
|
| 8 |
+
`subtitle` (`none`), `author` (`none`), `date` (today, e.g. "5 March 2026"). Prints a title block
|
| 9 |
+
(navy bar, title, subtitle, author · date) on page 1; from page 2 a header with title and date.
|
| 10 |
+
Footer "page / total". Headings are numbered `1.1`.
|
| 11 |
+
- **Memo** (`memo`): short internal messages. Parameters: `to` (`"Recipient"`), `from`
|
| 12 |
+
(`"Sender"`), `subject` (`"Subject"`), `date` (today). Prints "MEMO" and a To / From / Date /
|
| 13 |
+
Subject block with a navy rule under it. Headings are not numbered.
|
| 14 |
+
- **Letter** (`letter`): formal letters. Parameters: `sender` (`[Your name \ Street 1 \ City]`),
|
| 15 |
+
`recipient` (`[Recipient \ Street 2 \ City]`), `subject` (`"Subject"`), `date` (today),
|
| 16 |
+
`closing` (`"Kind regards,"`), `name` (`"Your name"`). Prints sender (right), recipient, date,
|
| 17 |
+
bold subject, then the body, then the closing and the name.
|
| 18 |
+
- **Slide deck** (`slides`): 16:9 presentations. Parameters: `title` (`"Title"`), `subtitle`
|
| 19 |
+
(`none`), `author` (`none`), `date` (today). The first slide is a navy title slide made from these
|
| 20 |
+
parameters. Every slide has a footer with the title and the slide number.
|
| 21 |
+
|
| 22 |
+
## Writing a page
|
| 23 |
+
The template already sets: page size and margins, font and size, justified paragraphs (not in
|
| 24 |
+
slides), navy headings with spacing, tables with thin grey-blue borders and a bold first row, and
|
| 25 |
+
the title block, memo header or letter frame.
|
| 26 |
+
|
| 27 |
+
Report: use `=` for chapters, `==` and `===` below them; numbering is automatic.
|
| 28 |
+
|
| 29 |
+
Memo: write the message directly; use `==` or `=` only if the memo needs sections.
|
| 30 |
+
|
| 31 |
+
Letter: write only the letter text, starting with the salutation ("Dear ...,"). The date, subject,
|
| 32 |
+
closing and name come from the parameters.
|
| 33 |
+
|
| 34 |
+
Slide deck:
|
| 35 |
+
- Each `= Heading` starts a new slide; the heading is the slide title (30pt, navy).
|
| 36 |
+
- `== Heading` is a smaller subheading inside the current slide.
|
| 37 |
+
- Content after a `=` heading belongs to that slide until the next `=`. Text that does not fit
|
| 38 |
+
flows onto an extra page without a title, so keep each slide to a few bullets.
|
| 39 |
+
- Do not create a title slide; it is generated from the parameters.
|
| 40 |
+
|
| 41 |
+
```typ
|
| 42 |
+
= Agenda
|
| 43 |
+
- Results for Q3
|
| 44 |
+
- Plans for Q4
|
| 45 |
+
|
| 46 |
+
= Results for Q3
|
| 47 |
+
== Revenue
|
| 48 |
+
Revenue grew by 12 % year on year.
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
Plain markup works everywhere: paragraphs, `-` lists, `+` numbered lists, `*bold*`, `_italic_`,
|
| 52 |
+
`#table(...)` (first row is the header, bolded automatically), `#figure(..., caption: [...])`,
|
| 53 |
+
`#image(...)`.
|
| 54 |
+
|
| 55 |
+
## Helpers
|
| 56 |
+
This add-on has no content helpers; use plain Typst markup.
|
| 57 |
+
|
| 58 |
+
Values a page may use:
|
| 59 |
+
- `today`: today's date as text, e.g. "5 March 2026".
|
| 60 |
+
- Colours, only when something must be coloured: `brand` (navy, headings and accents), `ink` (body
|
| 61 |
+
text), `quiet` (grey secondary text), `soft` (light grey-blue lines). `sans` is the font list.
|
| 62 |
+
|
| 63 |
+
```typ
|
| 64 |
+
#text(fill: brand)[*Decision:*] approve the Q4 budget.
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
## Do not
|
| 68 |
+
- Do not add `#set page`, `#set text`, `#set par` or font changes; the template sets them.
|
| 69 |
+
- Do not use your own colours (`rgb(...)`, `blue`, ...); use `brand`, `quiet`, `ink` or `soft`
|
| 70 |
+
only when something must be coloured.
|
| 71 |
+
- Do not build your own boxes, banners or callouts with `block`, `rect` or `box`.
|
| 72 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 73 |
+
- Do not write the title, subtitle, author, date, memo fields, addresses, closing or signature
|
| 74 |
+
name in the body; they come from the parameters.
|
| 75 |
+
- Do not number headings by hand. In slides do not use `#pagebreak()` to start slides; use `=`.
|
src/boardroom/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "boardroom",
|
| 4 |
"name": "Boardroom",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "A navy corporate look with templates for reports, memos, letters and slide decks.",
|
| 7 |
"category": "Business",
|
| 8 |
"tags": [
|
|
@@ -15,22 +15,22 @@
|
|
| 15 |
{
|
| 16 |
"label": "Report",
|
| 17 |
"kind": "document",
|
| 18 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 19 |
},
|
| 20 |
{
|
| 21 |
"label": "Memo",
|
| 22 |
"kind": "document",
|
| 23 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 24 |
},
|
| 25 |
{
|
| 26 |
"label": "Letter",
|
| 27 |
"kind": "document",
|
| 28 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 29 |
},
|
| 30 |
{
|
| 31 |
"label": "Slide deck",
|
| 32 |
"kind": "slides",
|
| 33 |
-
"snippet": "#import \"@themes/boardroom:1.0.
|
| 34 |
}
|
| 35 |
]
|
| 36 |
}
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "boardroom",
|
| 4 |
"name": "Boardroom",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "A navy corporate look with templates for reports, memos, letters and slide decks.",
|
| 7 |
"category": "Business",
|
| 8 |
"tags": [
|
|
|
|
| 15 |
{
|
| 16 |
"label": "Report",
|
| 17 |
"kind": "document",
|
| 18 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: report.with(title: \"Title\", subtitle: \"Subtitle\", author: \"Your name\")\n"
|
| 19 |
},
|
| 20 |
{
|
| 21 |
"label": "Memo",
|
| 22 |
"kind": "document",
|
| 23 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: memo.with(to: \"Recipient\", from: \"Your name\", subject: \"Subject\")\n"
|
| 24 |
},
|
| 25 |
{
|
| 26 |
"label": "Letter",
|
| 27 |
"kind": "document",
|
| 28 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: letter.with(sender: [Your name \\ Street 1 \\ City], recipient: [Recipient \\ Street 2 \\ City], subject: \"Subject\", name: \"Your name\")\n"
|
| 29 |
},
|
| 30 |
{
|
| 31 |
"label": "Slide deck",
|
| 32 |
"kind": "slides",
|
| 33 |
+
"snippet": "#import \"@themes/boardroom:1.0.1\": *\n#show: slides.with(title: \"Title\", subtitle: \"Subtitle\", author: \"Your name\")\n"
|
| 34 |
}
|
| 35 |
]
|
| 36 |
}
|
src/boardroom/typst/typst.toml
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
[package]
|
| 2 |
name = "boardroom"
|
| 3 |
-
version = "1.0.
|
| 4 |
entrypoint = "lib.typ"
|
|
|
|
| 1 |
[package]
|
| 2 |
name = "boardroom"
|
| 3 |
+
version = "1.0.1"
|
| 4 |
entrypoint = "lib.typ"
|
src/books/guide.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Books and newsletters templates
|
| 2 |
+
|
| 3 |
+
Three templates for long-form writing: a non-fiction book (`ilm`), a novel (`wonderous-book`) and a
|
| 4 |
+
one-page department newsletter (`dashing-dept-news`). A page uses one of them; check its header to see
|
| 5 |
+
which, and use only that template's section below.
|
| 6 |
+
|
| 7 |
+
## Templates
|
| 8 |
+
|
| 9 |
+
### Book
|
| 10 |
+
`ilm` 2.1.1. Use for manuals, reports and non-fiction books with chapters. Parameters of `ilm`:
|
| 11 |
+
- `title` (`[Your Title]`), `authors` (`"Author"`, a string or an array of strings), `date`
|
| 12 |
+
(`datetime.today()`), `date-format` (`"[month repr:long] [day padding:zero], [year repr:full]"`),
|
| 13 |
+
`abstract` (`none`): shown on the cover page.
|
| 14 |
+
- `cover-page` (`"use-ilm-default"`; `none` skips it, content replaces it).
|
| 15 |
+
- `preface` (`none`): content on its own page after the cover.
|
| 16 |
+
- `table-of-contents` (`outline()`; `none` disables it).
|
| 17 |
+
- `appendix` (`(enabled: false, title: "", heading-numbering-format: "", body: none)`).
|
| 18 |
+
- `bibliography` (`none`; the result of `bibliography("file.bib")`).
|
| 19 |
+
- `chapter-pagebreak` (`true`): each `=` heading starts a new page.
|
| 20 |
+
- `external-link-circle` (`true`): small circle after external links.
|
| 21 |
+
- `footer` (`"page-number-alternate-with-chapter"`), `paper-size` (`"a4"`), `raw-text`
|
| 22 |
+
(`(font: ("Iosevka", "DejaVu Sans Mono"), size: 9pt)`).
|
| 23 |
+
- `figure-index`, `table-index`, `listing-index` (`(enabled: false, title: "")`): lists at the end.
|
| 24 |
+
|
| 25 |
+
### Novel
|
| 26 |
+
`wonderous-book` 0.1.2. Use for fiction. Parameters of `book`: `title` (`[Book title]`), `author`
|
| 27 |
+
(`"Author"`), `paper-size` (`"iso-b5"`), `dedication` (`none`, shown on the third page),
|
| 28 |
+
`publishing-info` (`none`, shown at the bottom of the second page).
|
| 29 |
+
|
| 30 |
+
### Newsletter
|
| 31 |
+
`dashing-dept-news` 0.1.1. Use for a short newsletter with a main column and a red sidebar.
|
| 32 |
+
Parameters of `newsletter`: `title` (`[Newsletter title]`, printed in capitals), `edition` (`none`,
|
| 33 |
+
top of the sidebar), `hero-image` (`none`; a dictionary with keys `image` and `caption`),
|
| 34 |
+
`publication-info` (`none`, small print at the end of the main column).
|
| 35 |
+
|
| 36 |
+
These values live in the header. Write the page body below it.
|
| 37 |
+
|
| 38 |
+
## Writing a page
|
| 39 |
+
|
| 40 |
+
### Book
|
| 41 |
+
- `=` is a chapter: numbered `1.`, starts a new page, and its name appears in the footer next to
|
| 42 |
+
the page number. `==` and `===` are numbered sections (`1.1.`, `1.1.1.`).
|
| 43 |
+
- The cover, preface and table of contents are generated; do not write your own title or contents.
|
| 44 |
+
- Body text is 12pt, justified. Equations in `$ ... $` blocks are numbered `(1)`.
|
| 45 |
+
- Tables get thin grey lines and a small-caps header row; wrap them in `#figure(..., caption: [...])`
|
| 46 |
+
and use `table.header`. Long tables break across pages.
|
| 47 |
+
- Inline code gets a light grey box; code blocks use the monospace font set by the template.
|
| 48 |
+
- For an unnumbered heading use `#heading(numbering: none)[Title]`.
|
| 49 |
+
- Cite with `@key` only if the user has a bibliography file set in the header.
|
| 50 |
+
|
| 51 |
+
### Novel
|
| 52 |
+
- The template prints the title page, publishing info, dedication and a "Chapters" outline itself.
|
| 53 |
+
- `=` is a chapter: it starts on a right-hand (odd) page with a large bold title. Chapters are not
|
| 54 |
+
numbered; put the number in the title if wanted (`= Chapter One: Mondays`).
|
| 55 |
+
- Avoid `==` and deeper: they render like body text and still appear in the outline.
|
| 56 |
+
- Write plain paragraphs separated by blank lines; the template indents first lines and justifies.
|
| 57 |
+
- Running headers (title on odd pages, author on even pages) and page numbers are automatic.
|
| 58 |
+
- Use `_italics_` for thoughts or emphasis. A scene break can be a centred line:
|
| 59 |
+
`#align(center)[\* \* \*]`.
|
| 60 |
+
|
| 61 |
+
### Newsletter
|
| 62 |
+
- Everything written directly in the page goes into the main (left) column.
|
| 63 |
+
- `=` is a story headline, `==` a sub-heading. Headings use the template's display font.
|
| 64 |
+
- `#quote(block: true, attribution: [Name])[...]` becomes a large pull quote with a rule.
|
| 65 |
+
- `#figure(..., caption: [...])` gets a coloured backdrop and a centred `-- caption --` line.
|
| 66 |
+
- Links are underlined automatically.
|
| 67 |
+
- Short side stories go in the sidebar with `article` (see Helpers).
|
| 68 |
+
|
| 69 |
+
## Helpers
|
| 70 |
+
|
| 71 |
+
### Book
|
| 72 |
+
The header imports everything from `ilm`.
|
| 73 |
+
|
| 74 |
+
`blockquote`: a quotation set off in a light block with thin rules above and below.
|
| 75 |
+
```typ
|
| 76 |
+
#blockquote[
|
| 77 |
+
Knowledge is the life of the mind.
|
| 78 |
+
--- Abu Bakr
|
| 79 |
+
]
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
`smallcaps` and `upper`: the template's versions with wider letter spacing. Use them instead of
|
| 83 |
+
Typst's own; `std-smallcaps` and `std-upper` give the plain Typst versions.
|
| 84 |
+
```typ
|
| 85 |
+
The #smallcaps[Board] approved it. Read the #upper[warning] first.
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
### Novel
|
| 89 |
+
The header imports only `book`. There are no helpers; use plain markup.
|
| 90 |
+
```typ
|
| 91 |
+
= Mondays
|
| 92 |
+
Liam hated Mondays. He hated waking up to the sound of the old car outside.
|
| 93 |
+
|
| 94 |
+
He got off the bus and made his way to his locker.
|
| 95 |
+
|
| 96 |
+
#align(center)[\* \* \*]
|
| 97 |
+
|
| 98 |
+
That evening, everything changed.
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
### Newsletter
|
| 102 |
+
The header imports `newsletter` and `article`.
|
| 103 |
+
|
| 104 |
+
`article`: puts its content in the sidebar (white text on red). Can be written anywhere in the page;
|
| 105 |
+
all articles are collected in order. Start each with a `=` heading and keep it short.
|
| 106 |
+
```typ
|
| 107 |
+
#article[
|
| 108 |
+
= Safety first
|
| 109 |
+
Next Tuesday there is a lab safety training. *Attendance is mandatory.*
|
| 110 |
+
]
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
Main column story with a pull quote:
|
| 114 |
+
```typ
|
| 115 |
+
= The award goes to our department
|
| 116 |
+
We are proud to announce the award for excellence in research.
|
| 117 |
+
|
| 118 |
+
#quote(block: true, attribution: [Prof. Herzog])[
|
| 119 |
+
Our lab has done remarkable work this year.
|
| 120 |
+
]
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
## Do not
|
| 124 |
+
- Do not add `#set page`, `#set text`, `#set par` or font changes; the template sets them.
|
| 125 |
+
- Do not pick your own colours (`fill:`, `rgb(...)`, `text(fill: ...)`); the Newsletter sidebar is
|
| 126 |
+
already white on red.
|
| 127 |
+
- Do not draw your own boxes, rectangles or quote blocks: use `blockquote` (Book), `#quote(block: true)`
|
| 128 |
+
(Newsletter) or `article` (Newsletter sidebar).
|
| 129 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 130 |
+
- Do not use helpers from another template: `blockquote` exists only in Book, `article` only in
|
| 131 |
+
Newsletter.
|
| 132 |
+
- Book and Novel: do not write a title page, table of contents or manual `#pagebreak()` before chapters.
|
| 133 |
+
- Newsletter: do not put `=` page titles in the body for the newsletter name; it comes from `title`.
|
src/books/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "books",
|
| 4 |
"name": "Books and newsletters",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "Templates for long books, novels and a department newsletter, built on packages from Typst Universe.",
|
| 7 |
"category": "Creative",
|
| 8 |
"tags": [
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "books",
|
| 4 |
"name": "Books and newsletters",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "Templates for long books, novels and a department newsletter, built on packages from Typst Universe.",
|
| 7 |
"category": "Creative",
|
| 8 |
"tags": [
|
src/classroom/guide.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Classroom templates
|
| 2 |
+
|
| 3 |
+
Teaching material: lecture notes, worksheets, exams and 16:9 lecture slides. Friendly sans-serif
|
| 4 |
+
look with teal headings and coloured boxes for definitions, examples and notes.
|
| 5 |
+
|
| 6 |
+
## Templates
|
| 7 |
+
- **Lecture notes** (`notes`): course notes and handouts. Parameters: `title` (default
|
| 8 |
+
`"Title"`), `course` (`none`), `lecturer` (`none`), `date` (today, e.g. "5 March 2026"). Prints
|
| 9 |
+
the title with course · lecturer · date. Justified text, headings numbered `1.1`.
|
| 10 |
+
- **Worksheet** (`worksheet`): exercises for students. Parameters: `title` (`"Title"`), `course`
|
| 11 |
+
(`none`). Prints the title and blank "Name:" and "Date:" lines. Headings are not numbered.
|
| 12 |
+
- **Exam** (`exam`): tests with points. Parameters: `title` (`"Title"`), `course` (`none`),
|
| 13 |
+
`duration` (`none`, shown as "Time: ..."), `date` (today). Prints a centred title and a box with
|
| 14 |
+
Name, Time and "Points: ___ / total". The total is the sum of all `question(points: ...)` values.
|
| 15 |
+
- **Lecture slides** (`slides`): 16:9 slides. Parameters: `title` (`"Title"`), `course`
|
| 16 |
+
(`none`), `lecturer` (`none`), `date` (today). The first slide is a title slide made from these
|
| 17 |
+
parameters. Footer: course and slide number.
|
| 18 |
+
|
| 19 |
+
## Writing a page
|
| 20 |
+
The template already sets: A4 page and margins (or 16:9 for slides), font and size, teal headings
|
| 21 |
+
with spacing, a header with course and title and a centred page number (notes, worksheet, exam).
|
| 22 |
+
|
| 23 |
+
Notes: use `=` for main sections, `==` and `===` below them; numbering is automatic.
|
| 24 |
+
|
| 25 |
+
Worksheet and exam: write each task with `question`; use `=` headings only to group parts
|
| 26 |
+
("Part A"). Add `answer-lines` where students write.
|
| 27 |
+
|
| 28 |
+
Slides:
|
| 29 |
+
- Each `= Heading` starts a new slide; the heading is the slide title (teal, orange underline).
|
| 30 |
+
- `== Heading` is a smaller subheading inside the current slide.
|
| 31 |
+
- Content after a `=` heading belongs to that slide until the next `=`. Text that does not fit
|
| 32 |
+
flows onto an extra page without a title, so keep slides short.
|
| 33 |
+
- Do not create a title slide; it is generated from the parameters.
|
| 34 |
+
|
| 35 |
+
```typ
|
| 36 |
+
= What is a derivative?
|
| 37 |
+
#definition(title: "Derivative")[The rate of change of $f$ at $x$.]
|
| 38 |
+
|
| 39 |
+
= Rules
|
| 40 |
+
== Power rule
|
| 41 |
+
$ d/(d x) x^n = n x^(n-1) $
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
Plain markup works well: paragraphs, `-` lists, `+` numbered lists, `*bold*`, `_italic_`, `$...$`
|
| 45 |
+
maths, `#table(...)`, `#figure(..., caption: [...])`, `#image(...)`.
|
| 46 |
+
|
| 47 |
+
## Helpers
|
| 48 |
+
|
| 49 |
+
`definition(title: none, body)`: teal box labelled "Definition" (or "Definition: title").
|
| 50 |
+
```typ
|
| 51 |
+
#definition(title: "Prime number")[A natural number greater than 1 with no divisors other than 1 and itself.]
|
| 52 |
+
```
|
| 53 |
+
|
| 54 |
+
`example(title: none, body)`: blue box labelled "Example".
|
| 55 |
+
```typ
|
| 56 |
+
#example(title: "Small primes")[2, 3, 5, 7 and 11 are prime; 9 is not.]
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
`remark(title: none, body)`: orange box labelled "Note", for tips, warnings and side remarks.
|
| 60 |
+
```typ
|
| 61 |
+
#remark[1 is not a prime number.]
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
`question(points: none, body)`: a numbered question (1., 2., ... counted automatically). With
|
| 65 |
+
`points`, shows "(n points)" on the right and adds n to the exam total. Use for worksheets and
|
| 66 |
+
exams.
|
| 67 |
+
```typ
|
| 68 |
+
#question(points: 2)[Is 51 a prime number? Explain.]
|
| 69 |
+
#answer-lines(3)
|
| 70 |
+
|
| 71 |
+
#question[List all primes below 20.]
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
`answer-lines(count)`: `count` ruled lines for handwritten answers.
|
| 75 |
+
```typ
|
| 76 |
+
#answer-lines(4)
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
`callout(colour, label, title, body)`: the generic box behind the three above (all positional).
|
| 80 |
+
Use it only for a box kind that has no helper, with a template colour; pass `none` for no title.
|
| 81 |
+
```typ
|
| 82 |
+
#callout(teal, "Theorem", "Euclid")[There are infinitely many primes.]
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
`today`: today's date as text.
|
| 86 |
+
|
| 87 |
+
Colours, only when something must be coloured: `teal` (headings, definitions), `blue` (examples),
|
| 88 |
+
`orange` (notes, slide accents), `ink` (body text), `quiet` (grey secondary text). `sans` is the
|
| 89 |
+
font list.
|
| 90 |
+
|
| 91 |
+
## Do not
|
| 92 |
+
- Do not add `#set page`, `#set text`, `#set par` or font changes; the template sets them.
|
| 93 |
+
- Do not use your own colours (`rgb(...)`, `red`, ...); use the constants above only when
|
| 94 |
+
something must be coloured.
|
| 95 |
+
- Do not build your own boxes with `block`, `rect` or `box`; use `definition`, `example`,
|
| 96 |
+
`remark` (or `callout` for other kinds).
|
| 97 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 98 |
+
- Do not write the title, course, lecturer, date, name/date lines or the points box; the template
|
| 99 |
+
prints them.
|
| 100 |
+
- Do not number questions or headings by hand, and do not write the total points; `question`
|
| 101 |
+
counts and sums them.
|
| 102 |
+
- Do not draw answer lines with `#line`; use `answer-lines`.
|
| 103 |
+
- In slides do not use `#pagebreak()` to start slides; use `=`.
|
src/classroom/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "classroom",
|
| 4 |
"name": "Classroom",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "A friendly look with templates for lecture notes, worksheets, exams and lecture slides.",
|
| 7 |
"category": "Education",
|
| 8 |
"tags": [
|
|
@@ -15,22 +15,22 @@
|
|
| 15 |
{
|
| 16 |
"label": "Lecture notes",
|
| 17 |
"kind": "document",
|
| 18 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 19 |
},
|
| 20 |
{
|
| 21 |
"label": "Worksheet",
|
| 22 |
"kind": "document",
|
| 23 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 24 |
},
|
| 25 |
{
|
| 26 |
"label": "Exam",
|
| 27 |
"kind": "document",
|
| 28 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 29 |
},
|
| 30 |
{
|
| 31 |
"label": "Lecture slides",
|
| 32 |
"kind": "slides",
|
| 33 |
-
"snippet": "#import \"@themes/classroom:1.0.
|
| 34 |
}
|
| 35 |
]
|
| 36 |
}
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "classroom",
|
| 4 |
"name": "Classroom",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "A friendly look with templates for lecture notes, worksheets, exams and lecture slides.",
|
| 7 |
"category": "Education",
|
| 8 |
"tags": [
|
|
|
|
| 15 |
{
|
| 16 |
"label": "Lecture notes",
|
| 17 |
"kind": "document",
|
| 18 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: notes.with(title: \"Title\", course: \"Course name\", lecturer: \"Your name\")\n"
|
| 19 |
},
|
| 20 |
{
|
| 21 |
"label": "Worksheet",
|
| 22 |
"kind": "document",
|
| 23 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: worksheet.with(title: \"Title\", course: \"Course name\")\n"
|
| 24 |
},
|
| 25 |
{
|
| 26 |
"label": "Exam",
|
| 27 |
"kind": "document",
|
| 28 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: exam.with(title: \"Title\", course: \"Course name\", duration: \"90 minutes\")\n"
|
| 29 |
},
|
| 30 |
{
|
| 31 |
"label": "Lecture slides",
|
| 32 |
"kind": "slides",
|
| 33 |
+
"snippet": "#import \"@themes/classroom:1.0.1\": *\n#show: slides.with(title: \"Title\", course: \"Course name\", lecturer: \"Your name\")\n"
|
| 34 |
}
|
| 35 |
]
|
| 36 |
}
|
src/classroom/typst/typst.toml
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
[package]
|
| 2 |
name = "classroom"
|
| 3 |
-
version = "1.0.
|
| 4 |
entrypoint = "lib.typ"
|
|
|
|
| 1 |
[package]
|
| 2 |
name = "classroom"
|
| 3 |
+
version = "1.0.1"
|
| 4 |
entrypoint = "lib.typ"
|
src/papers/guide.md
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Research papers templates
|
| 2 |
+
|
| 3 |
+
Three templates for scholarly papers: an IEEE conference paper (`charged-ieee`), an AMS mathematics
|
| 4 |
+
article (`unequivocal-ams`) and an arXiv-style preprint (`arkheion`). A page uses one of them; check
|
| 5 |
+
its header to see which, and use only that template's section below.
|
| 6 |
+
|
| 7 |
+
## Templates
|
| 8 |
+
|
| 9 |
+
### IEEE paper
|
| 10 |
+
`charged-ieee` 0.1.4. Two-column IEEE layout. Parameters of `ieee`:
|
| 11 |
+
- `title` (`[Paper Title]`), `abstract` (`none`), `index-terms` (`()`, shown after the abstract).
|
| 12 |
+
- `authors` (`()`): dictionaries with `name` and optional `department`, `organization`, `location`,
|
| 13 |
+
`email`.
|
| 14 |
+
- `paper-size` (`"us-letter"`), `bibliography` (`none`), `figure-supplement` (`[Fig.]`, the word
|
| 15 |
+
used when referring to image figures).
|
| 16 |
+
|
| 17 |
+
### AMS article
|
| 18 |
+
`unequivocal-ams` 0.1.2. One-column American Mathematical Society style. Parameters of
|
| 19 |
+
`ams-article`:
|
| 20 |
+
- `title` (`[Paper title]`), `abstract` (`none`), `paper-size` (`"us-letter"`), `bibliography` (`none`).
|
| 21 |
+
- `authors` (`()`): dictionaries with `name` and optional `department`, `organization`, `location`,
|
| 22 |
+
`email`, `url`. Affiliations and emails are printed at the end of the article.
|
| 23 |
+
|
| 24 |
+
### Preprint
|
| 25 |
+
`arkheion` 0.1.2. One-column arXiv-style preprint. Parameters of `arkheion`:
|
| 26 |
+
- `title` (`""`), `abstract` (`none`), `keywords` (`()`), `date` (`none`).
|
| 27 |
+
- `authors` (`()`): dictionaries with `name`, `email`, `affiliation` and optional `orcid`.
|
| 28 |
+
- `custom-authors` (`none`): content that replaces the author block.
|
| 29 |
+
|
| 30 |
+
These values live in the header. Write the page body below it.
|
| 31 |
+
|
| 32 |
+
## Writing a page
|
| 33 |
+
|
| 34 |
+
All three print the title, authors and abstract from the header. Do not repeat them in the body.
|
| 35 |
+
Label things with `<name>` and refer to them with `@name`.
|
| 36 |
+
|
| 37 |
+
### IEEE paper
|
| 38 |
+
- `=` is a section: centred small caps, numbered `I.`, `II.`. A section titled `Acknowledgment`
|
| 39 |
+
(or `Acknowledgement(s)`) is not numbered.
|
| 40 |
+
- `==` is a subsection: italic, numbered `A.`. `===` is a run-in italic heading numbered `a)`.
|
| 41 |
+
- Text is two columns, 10pt, justified. Numbered lists use `1)`, `a)`, `i)`.
|
| 42 |
+
- Block equations are numbered `(1)`; `@eq` prints just `(1)`.
|
| 43 |
+
- Image figures are captioned `Fig. 1.`; table figures `TABLE I` with the caption above.
|
| 44 |
+
- A figure can float with `placement: top` or `bottom`; add `scope: "parent"` to span both columns.
|
| 45 |
+
- References use the IEEE style with the title "References". The bibliography appears only if a
|
| 46 |
+
`.bib` file is set in the header or written as `#bibliography("file.bib")` at the end of the body.
|
| 47 |
+
|
| 48 |
+
### AMS article
|
| 49 |
+
- `=` is a section: centred small caps, numbered `1.`. `==` is a bold run-in heading (`1.1. Title.`),
|
| 50 |
+
`===` an italic run-in heading.
|
| 51 |
+
- Block equations are not numbered.
|
| 52 |
+
- Figure captions read `Figure 1. Caption`, tables `Table 1. Caption`, with small-caps labels.
|
| 53 |
+
- Use `theorem` and `proof` (see Helpers) for results. Theorem numbering restarts at every `=`.
|
| 54 |
+
- References use the `springer-mathphys` style with the title "References".
|
| 55 |
+
|
| 56 |
+
### Preprint
|
| 57 |
+
- Headings are numbered `1`, `1.1`, `1.1.1`. `====` and deeper become bold run-in paragraph
|
| 58 |
+
headings without a number.
|
| 59 |
+
- Block equations are numbered `(1)`. For one unnumbered equation use
|
| 60 |
+
`#math.equation(block: true, numbering: none, $ ... $)`.
|
| 61 |
+
- Page numbers are centred at the bottom.
|
| 62 |
+
- Use plain `#figure(table(...), caption: [...])` and `#figure(image(...), caption: [...])`.
|
| 63 |
+
- Appendices go at the very end with `arkheion-appendices` (see Helpers).
|
| 64 |
+
|
| 65 |
+
## Helpers
|
| 66 |
+
|
| 67 |
+
### IEEE paper
|
| 68 |
+
The header imports only `ieee`. There are no helpers; use plain markup.
|
| 69 |
+
```typ
|
| 70 |
+
= Introduction
|
| 71 |
+
Typesetting slows researchers down.
|
| 72 |
+
|
| 73 |
+
== Overview
|
| 74 |
+
We measure the effect in @tab:times and derive @eq:speed.
|
| 75 |
+
|
| 76 |
+
$ v = d / t $ <eq:speed>
|
| 77 |
+
|
| 78 |
+
#figure(
|
| 79 |
+
table(
|
| 80 |
+
columns: 2,
|
| 81 |
+
table.header[System][Time (s)],
|
| 82 |
+
[A], [12],
|
| 83 |
+
[B], [7],
|
| 84 |
+
),
|
| 85 |
+
caption: [Compile times],
|
| 86 |
+
) <tab:times>
|
| 87 |
+
|
| 88 |
+
= Acknowledgment
|
| 89 |
+
We thank our colleagues.
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
### AMS article
|
| 93 |
+
The header imports `ams-article`, `theorem` and `proof`.
|
| 94 |
+
|
| 95 |
+
`theorem(body, numbered: true)`: a numbered theorem with a bold "Theorem" label and italic text.
|
| 96 |
+
Pass `numbered: false` for no number. Label it to refer to it.
|
| 97 |
+
```typ
|
| 98 |
+
= Results
|
| 99 |
+
#theorem[
|
| 100 |
+
The square of any real number is non-negative.
|
| 101 |
+
] <thm:square>
|
| 102 |
+
|
| 103 |
+
#theorem(numbered: false)[Every bounded monotone sequence converges.]
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
`proof(body)`: an italic "Proof." label and the body, ending with a square at the right margin.
|
| 107 |
+
```typ
|
| 108 |
+
#proof[
|
| 109 |
+
If $x >= 0$ then $x^2 = x x >= 0$. If $x < 0$ then $x^2 = (-x)^2 > 0$.
|
| 110 |
+
]
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
There are no lemma or definition helpers. Write those as a normal paragraph, e.g.
|
| 114 |
+
`*Definition.* A set is ...`.
|
| 115 |
+
|
| 116 |
+
### Preprint
|
| 117 |
+
The header imports `arkheion` and `arkheion-appendices`.
|
| 118 |
+
|
| 119 |
+
`arkheion-appendices`: apply as a show rule after the main text. It starts a new page and renumbers
|
| 120 |
+
headings: `=` becomes `APPENDIX A`, `B`, ... and `==` becomes `A.1`. Everything after it is appendix,
|
| 121 |
+
so put it last.
|
| 122 |
+
```typ
|
| 123 |
+
= Conclusion
|
| 124 |
+
The method works.
|
| 125 |
+
|
| 126 |
+
#show: arkheion-appendices
|
| 127 |
+
= Proofs
|
| 128 |
+
== Proof of the main lemma
|
| 129 |
+
The argument follows.
|
| 130 |
+
```
|
| 131 |
+
|
| 132 |
+
## Do not
|
| 133 |
+
- Do not add `#set page`, `#set text`, `#set par`, `#set heading` or font changes; the template sets
|
| 134 |
+
them.
|
| 135 |
+
- Do not pick your own colours (`fill:`, `rgb(...)`, `text(fill: ...)`).
|
| 136 |
+
- Do not draw your own boxes or blocks for theorems, proofs, abstracts or keywords: the header prints
|
| 137 |
+
the abstract, and AMS has `theorem` and `proof`.
|
| 138 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 139 |
+
- Do not write the title, author names or abstract again in the body.
|
| 140 |
+
- Do not number headings by hand (`= 1. Introduction`); numbering is automatic.
|
| 141 |
+
- Do not use helpers from another template: `theorem` and `proof` exist only in AMS article,
|
| 142 |
+
`arkheion-appendices` only in Preprint.
|
| 143 |
+
- Do not add `#bibliography(...)` or `@citations` unless the user has a `.bib` file.
|
| 144 |
+
- Preprint: use `#show: arkheion-appendices` at most once.
|
src/papers/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "papers",
|
| 4 |
"name": "Research papers",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "Templates for journal-style papers and preprints, built on packages from Typst Universe.",
|
| 7 |
"category": "Academic",
|
| 8 |
"tags": [
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "papers",
|
| 4 |
"name": "Research papers",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "Templates for journal-style papers and preprints, built on packages from Typst Universe.",
|
| 7 |
"category": "Academic",
|
| 8 |
"tags": [
|
src/resume/guide.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Resume templates
|
| 2 |
+
|
| 3 |
+
A clean one-page resume (`basic-resume` 0.2.9) designed to be read well by applicant tracking
|
| 4 |
+
systems. It prints the name and contact line itself; the page holds the sections.
|
| 5 |
+
|
| 6 |
+
## Templates
|
| 7 |
+
|
| 8 |
+
### Resume
|
| 9 |
+
Use for a CV or resume. Parameters of `resume`:
|
| 10 |
+
- `author` (`""`): the name, printed as a large bold title.
|
| 11 |
+
- `author-position` (`left`), `personal-info-position` (`left`): alignment of name and contact line.
|
| 12 |
+
- Contact fields, each shown only when not `""`, joined with `|`: `pronouns`, `phone`, `location`,
|
| 13 |
+
`email` (mailto link), `github`, `linkedin`, `personal-site` (written without `https://`, the
|
| 14 |
+
link adds it), `orcid` (the ID only).
|
| 15 |
+
- `accent-color` (`"#000000"`): colour of headings and links, as a hex string.
|
| 16 |
+
- `font` (`"New Computer Modern"`), `font-size` (`10pt`), `author-font-size` (`20pt`),
|
| 17 |
+
`paper` (`"us-letter"`), `lang` (`"en"`).
|
| 18 |
+
|
| 19 |
+
These values live in the header. Write the page body below it.
|
| 20 |
+
|
| 21 |
+
## Writing a page
|
| 22 |
+
- The name and contact line come from the header. Do not write them again, and do not use `=`
|
| 23 |
+
headings (level 1 is reserved for the name).
|
| 24 |
+
- `==` is a section title (Education, Experience, Projects, Skills): small caps in the accent colour
|
| 25 |
+
with a rule underneath.
|
| 26 |
+
- Inside a section, write one helper call per entry (`edu`, `work`, `project`, ...) followed by a
|
| 27 |
+
`-` bullet list of achievements. Nested bullets (indent two spaces) work.
|
| 28 |
+
- For a skills section use bullets with a bold label: `- *Languages*: Python, Rust`.
|
| 29 |
+
- Text is justified. Links are underlined in the accent colour.
|
| 30 |
+
- Ligatures are off on purpose; build date ranges with `dates-helper` rather than typing dashes.
|
| 31 |
+
- Escape special characters in text: `\$`, `\#`, `\@`.
|
| 32 |
+
|
| 33 |
+
## Helpers
|
| 34 |
+
The header imports everything from the package.
|
| 35 |
+
|
| 36 |
+
`dates-helper(start-date: "", end-date: "")`: a date range joined by an em dash. Use it for every
|
| 37 |
+
`dates` argument.
|
| 38 |
+
```typ
|
| 39 |
+
#dates-helper(start-date: "Jan 2022", end-date: "Present")
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
`edu(institution: "", dates: "", degree: "", gpa: "", location: "", consistent: false)`: an
|
| 43 |
+
education entry. Bold institution with location on the right, then italic degree with italic dates
|
| 44 |
+
on the right. `consistent: true` puts dates top right and location bottom right like `work`. `gpa` is
|
| 45 |
+
accepted but not printed in this version; put a GPA in a bullet instead.
|
| 46 |
+
```typ
|
| 47 |
+
== Education
|
| 48 |
+
#edu(
|
| 49 |
+
institution: "Example University",
|
| 50 |
+
location: "Utrecht, Netherlands",
|
| 51 |
+
dates: dates-helper(start-date: "Sep 2018", end-date: "Jul 2022"),
|
| 52 |
+
degree: "BSc Computer Science",
|
| 53 |
+
)
|
| 54 |
+
- GPA: 3.8/4.0, graduated cum laude
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
`work(title: "", dates: "", company: "", location: "")`: a job. Bold title with dates on the right,
|
| 58 |
+
company with italic location below.
|
| 59 |
+
```typ
|
| 60 |
+
== Experience
|
| 61 |
+
#work(
|
| 62 |
+
title: "Software Engineer",
|
| 63 |
+
company: "Example Systems",
|
| 64 |
+
location: "Amsterdam, Netherlands",
|
| 65 |
+
dates: dates-helper(start-date: "Aug 2022", end-date: "Present"),
|
| 66 |
+
)
|
| 67 |
+
- Cut build times by 40% by caching dependencies
|
| 68 |
+
- Led a team of three on the reporting service
|
| 69 |
+
```
|
| 70 |
+
|
| 71 |
+
`project(role: "", name: "", url: "", dates: "")`: a project on one line. With `role` it reads
|
| 72 |
+
"**Role**, Name". `url` is written without `https://`; it is shown in brackets after the name when
|
| 73 |
+
`dates` is also given, otherwise on the right instead of dates.
|
| 74 |
+
```typ
|
| 75 |
+
== Projects
|
| 76 |
+
#project(
|
| 77 |
+
name: "Scheduler",
|
| 78 |
+
role: "Maintainer",
|
| 79 |
+
url: "example.org",
|
| 80 |
+
dates: dates-helper(start-date: "Nov 2023", end-date: "Present"),
|
| 81 |
+
)
|
| 82 |
+
- Open-source scheduler used by 7000+ students
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
`certificates(name: "", issuer: "", url: "", date: "")`: "**Name**, Issuer" with an optional link
|
| 86 |
+
(without `https://`) and the date on the right.
|
| 87 |
+
```typ
|
| 88 |
+
== Certificates
|
| 89 |
+
#certificates(name: "AWS Solutions Architect", issuer: "Amazon", date: "Oct 2024")
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
`extracurriculars(activity: "", dates: "")`: bold activity with dates on the right.
|
| 93 |
+
```typ
|
| 94 |
+
== Activities
|
| 95 |
+
#extracurriculars(
|
| 96 |
+
activity: "Chess club captain",
|
| 97 |
+
dates: dates-helper(start-date: "2020", end-date: "2022"),
|
| 98 |
+
)
|
| 99 |
+
- Organised a regional tournament with 120 players
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
`generic-two-by-two(top-left: "", top-right: "", bottom-left: "", bottom-right: "")` and
|
| 103 |
+
`generic-one-by-two(left: "", right: "")`: unformatted two-line or one-line rows with content pushed
|
| 104 |
+
left and right. Use them only for an entry no other helper fits.
|
| 105 |
+
```typ
|
| 106 |
+
#generic-one-by-two(left: [*Volunteer, Food Bank*], right: "2021")
|
| 107 |
+
```
|
| 108 |
+
|
| 109 |
+
## Do not
|
| 110 |
+
- Do not add `#set page`, `#set text`, `#set par` or font changes; size, font and margins come from
|
| 111 |
+
the header.
|
| 112 |
+
- Do not pick your own colours (`fill:`, `rgb(...)`, `text(fill: ...)`); headings and links already
|
| 113 |
+
use the accent colour.
|
| 114 |
+
- Do not build your own grids, tables, boxes or `#h(1fr)` rows for entries; use `edu`, `work`,
|
| 115 |
+
`project`, `certificates`, `extracurriculars` or the generic helpers.
|
| 116 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 117 |
+
- Do not write the name or contact details in the body, and do not use `=` headings.
|
| 118 |
+
- Do not add icons, images, columns or a photo; the layout is a single plain column for applicant
|
| 119 |
+
tracking systems.
|
| 120 |
+
- Keep it to one page unless the user asks for more.
|
src/resume/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "resume",
|
| 4 |
"name": "Resume",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "A clean one-page resume, built on a package from Typst Universe.",
|
| 7 |
"category": "Personal",
|
| 8 |
"tags": [
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "resume",
|
| 4 |
"name": "Resume",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "A clean one-page resume, built on a package from Typst Universe.",
|
| 7 |
"category": "Personal",
|
| 8 |
"tags": [
|
src/zal-analytics/guide.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ZAL Analytics templates
|
| 2 |
+
|
| 3 |
+
Code-first technical writing: documentation, short engineering notes and 16:9 slides. Monochrome,
|
| 4 |
+
sharp corners, monospace headings and labels, with a rosewood accent used sparingly.
|
| 5 |
+
|
| 6 |
+
## Templates
|
| 7 |
+
- **Documentation** (`documentation`): longer technical documents. Parameters: `title` (default
|
| 8 |
+
`"Title"`), `summary` (`none`, a short line under the title), `author` (`none`), `version`
|
| 9 |
+
(`none`), `date` (today as `YYYY-MM-DD`). Prints author · version · date, the title and the
|
| 10 |
+
summary, then a table of contents (`outline(depth: 2)`). Header: title left, version · date
|
| 11 |
+
right. Footer: "page / total". Headings are numbered `1.1`.
|
| 12 |
+
- **Note** (`note`): short engineering notes. Parameters: `title` (`"Title"`), `topic`
|
| 13 |
+
(`"Note"`, a small label top left), `author` (`none`), `date` (today). Prints topic, author ·
|
| 14 |
+
date and the title over a black rule. Footer: page number. Headings are not numbered.
|
| 15 |
+
- **Slides** (`slides`): 16:9 presentations. Parameters: `title` (`"Title"`), `subtitle` (`none`),
|
| 16 |
+
`author` (`none`), `date` (today). The first slide is a dark dotted title slide made from these
|
| 17 |
+
parameters. Footer: title and slide number.
|
| 18 |
+
|
| 19 |
+
## Writing a page
|
| 20 |
+
The template already styles: page size and margins, font and size, monospace bold headings with
|
| 21 |
+
spacing, a thin rule under every `==` heading, `—` list markers, tables with thin grey borders and
|
| 22 |
+
a small upper-case monospace header row, code blocks in a light grey bordered box, inline code on
|
| 23 |
+
a grey background, and underlined links.
|
| 24 |
+
|
| 25 |
+
Documentation: use `=` for sections, `==` and `===` below; numbering is automatic. Only `=` and
|
| 26 |
+
`==` appear in the contents.
|
| 27 |
+
|
| 28 |
+
Note: write directly; use `==` (with its rule) for sections.
|
| 29 |
+
|
| 30 |
+
Slides:
|
| 31 |
+
- Each `= Heading` starts a new slide; the heading is the slide title (28pt).
|
| 32 |
+
- `== Heading` is a smaller subheading inside the current slide.
|
| 33 |
+
- Content after a `=` heading belongs to that slide until the next `=`. Text that does not fit
|
| 34 |
+
flows onto an extra page without a title, so keep slides short.
|
| 35 |
+
- Do not create a title slide; it is generated from the parameters.
|
| 36 |
+
|
| 37 |
+
````typ
|
| 38 |
+
= Build
|
| 39 |
+
== Steps
|
| 40 |
+
- Install the toolchain
|
| 41 |
+
- Run the build
|
| 42 |
+
|
| 43 |
+
```sh
|
| 44 |
+
cargo build --release
|
| 45 |
+
```
|
| 46 |
+
````
|
| 47 |
+
|
| 48 |
+
Code is the main content type: use fenced code blocks with a language tag (` ```rust `,
|
| 49 |
+
` ```sh `) and `` `inline code` ``. Use `#table(...)` for structured data; the first row becomes
|
| 50 |
+
the label-style header automatically.
|
| 51 |
+
|
| 52 |
+
## Helpers
|
| 53 |
+
|
| 54 |
+
`callout(title: "Note", body)`: a bordered box with a rosewood left bar and a small upper-case
|
| 55 |
+
title. Use for notes, warnings and tips.
|
| 56 |
+
```typ
|
| 57 |
+
#callout[The API is unstable before version 1.0.]
|
| 58 |
+
#callout(title: "Warning")[This command deletes the cache.]
|
| 59 |
+
```
|
| 60 |
+
|
| 61 |
+
`label(body)`: small grey upper-case monospace text with wide letter spacing, as in the header
|
| 62 |
+
and table headers. Use it for short labels or metadata.
|
| 63 |
+
```typ
|
| 64 |
+
#label[Status] Stable
|
| 65 |
+
```
|
| 66 |
+
Note: this `label` replaces Typst's built-in `label` function. To mark something for a reference,
|
| 67 |
+
use the `<name>` syntax (`= Install <install>` then `@install`), never `label("name")`. Heading
|
| 68 |
+
references need numbered headings, so they work in Documentation only.
|
| 69 |
+
|
| 70 |
+
`today`: today's date as a `YYYY-MM-DD` string.
|
| 71 |
+
|
| 72 |
+
Colours, only when something must be coloured: `ink` (body text), `coal` (dark title-slide
|
| 73 |
+
background), `quiet` (grey labels), `rule` (light grey lines), `rosewood` (the one accent; use
|
| 74 |
+
sparingly). `sans` and `mono` are the font lists; `dots` is the title-slide background pattern.
|
| 75 |
+
```typ
|
| 76 |
+
#text(fill: rosewood)[deprecated]
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
## Do not
|
| 80 |
+
- Do not add `#set page`, `#set text`, `#set par`, `#set list` or font changes; the template sets
|
| 81 |
+
them.
|
| 82 |
+
- Do not use your own colours (`rgb(...)`, `blue`, ...); the look is monochrome. Use `rosewood`
|
| 83 |
+
or `quiet` only when something must stand out.
|
| 84 |
+
- Do not build your own boxes with `block`, `rect` or `box`, and do not wrap code in boxes; use
|
| 85 |
+
`callout`, and plain code blocks (they are already boxed).
|
| 86 |
+
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
|
| 87 |
+
- Do not write the title, summary, author, version, date or a table of contents; the template
|
| 88 |
+
prints them.
|
| 89 |
+
- Do not call `note(...)` inside a page: it is the Note template's show rule, not a box. Use
|
| 90 |
+
`callout`.
|
| 91 |
+
- Do not use `label(...)` to create reference labels (see above), and do not number headings by
|
| 92 |
+
hand.
|
| 93 |
+
- In slides do not use `#pagebreak()` to start slides; use `=`.
|
src/zal-analytics/theme.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "zal-analytics",
|
| 4 |
"name": "ZAL Analytics",
|
| 5 |
-
"version": "1.0.
|
| 6 |
"description": "The monochrome, code-first look of zal-analytics.nl: sharp corners, monospace headings and a rosewood accent.",
|
| 7 |
"category": "Technical",
|
| 8 |
"tags": [
|
|
@@ -16,17 +16,17 @@
|
|
| 16 |
{
|
| 17 |
"label": "Documentation",
|
| 18 |
"kind": "document",
|
| 19 |
-
"snippet": "#import \"@themes/zal-analytics:1.0.
|
| 20 |
},
|
| 21 |
{
|
| 22 |
"label": "Note",
|
| 23 |
"kind": "document",
|
| 24 |
-
"snippet": "#import \"@themes/zal-analytics:1.0.
|
| 25 |
},
|
| 26 |
{
|
| 27 |
"label": "Slides",
|
| 28 |
"kind": "slides",
|
| 29 |
-
"snippet": "#import \"@themes/zal-analytics:1.0.
|
| 30 |
}
|
| 31 |
]
|
| 32 |
}
|
|
|
|
| 2 |
"format": 1,
|
| 3 |
"id": "zal-analytics",
|
| 4 |
"name": "ZAL Analytics",
|
| 5 |
+
"version": "1.0.1",
|
| 6 |
"description": "The monochrome, code-first look of zal-analytics.nl: sharp corners, monospace headings and a rosewood accent.",
|
| 7 |
"category": "Technical",
|
| 8 |
"tags": [
|
|
|
|
| 16 |
{
|
| 17 |
"label": "Documentation",
|
| 18 |
"kind": "document",
|
| 19 |
+
"snippet": "#import \"@themes/zal-analytics:1.0.1\": *\n#show: documentation.with(title: \"Title\", summary: [One sentence about this document.], author: \"Your name\", version: \"v0.1.0\")\n"
|
| 20 |
},
|
| 21 |
{
|
| 22 |
"label": "Note",
|
| 23 |
"kind": "document",
|
| 24 |
+
"snippet": "#import \"@themes/zal-analytics:1.0.1\": *\n#show: note.with(title: \"Title\", topic: \"Engineering note\", author: \"Your name\")\n"
|
| 25 |
},
|
| 26 |
{
|
| 27 |
"label": "Slides",
|
| 28 |
"kind": "slides",
|
| 29 |
+
"snippet": "#import \"@themes/zal-analytics:1.0.1\": *\n#show: slides.with(title: \"Title\", subtitle: \"Subtitle\", author: \"Your name\")\n"
|
| 30 |
}
|
| 31 |
]
|
| 32 |
}
|
src/zal-analytics/typst/typst.toml
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
[package]
|
| 2 |
name = "zal-analytics"
|
| 3 |
-
version = "1.0.
|
| 4 |
entrypoint = "lib.typ"
|
|
|
|
| 1 |
[package]
|
| 2 |
name = "zal-analytics"
|
| 3 |
+
version = "1.0.1"
|
| 4 |
entrypoint = "lib.typ"
|
themes/blueprint.znx
CHANGED
|
Binary files a/themes/blueprint.znx and b/themes/blueprint.znx differ
|
|
|
themes/boardroom.znx
CHANGED
|
Binary files a/themes/boardroom.znx and b/themes/boardroom.znx differ
|
|
|
themes/books.znx
CHANGED
|
Binary files a/themes/books.znx and b/themes/books.znx differ
|
|
|
themes/classroom.znx
CHANGED
|
Binary files a/themes/classroom.znx and b/themes/classroom.znx differ
|
|
|
themes/papers.znx
CHANGED
|
Binary files a/themes/papers.znx and b/themes/papers.znx differ
|
|
|
themes/resume.znx
CHANGED
|
Binary files a/themes/resume.znx and b/themes/resume.znx differ
|
|
|
themes/zal-analytics.znx
CHANGED
|
@@ -1,3 +1,3 @@
|
|
| 1 |
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:
|
| 3 |
-
size
|
|
|
|
| 1 |
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:a6a264e9d1214252185ecc2a349ea15a44f0182c1b3758ac12a77c79dcbffa46
|
| 3 |
+
size 1022490
|