https://github.com/artomweb/quick-sip-typst-template
A Typst template for aviation style checklists like Quick Reference Handbooks.
https://github.com/artomweb/quick-sip-typst-template
typst typst-package typst-template typst-templates
Last synced: 5 months ago
JSON representation
A Typst template for aviation style checklists like Quick Reference Handbooks.
- Host: GitHub
- URL: https://github.com/artomweb/quick-sip-typst-template
- Owner: artomweb
- License: mit
- Created: 2024-10-15T10:45:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-25T19:30:58.000Z (12 months ago)
- Last Synced: 2025-06-25T20:29:11.346Z (12 months ago)
- Topics: typst, typst-package, typst-template, typst-templates
- Language: Typst
- Homepage: https://typst.app/universe/package/quick-sip/
- Size: 386 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick Sip - Typst QRH Template
Creates aviation style checklists like Quick Reference Handbooks.
### Features:
- Index
- Section
- Conditions
- Objective
- Step (When/If)
- Sub Step
- Caution
- Note
- Choose One
- Go to step
- End section now
## Start with
```typst
#import "@preview/quick-sip:0.1.2": *
#show: QRH.with(title: "Cup of Tea")
```
Then add a section:
```typst
#section("Cup of Tea preparation")[
#step("KETTLE", "Filled to 1 CUP")
#step([*When* KETTLE boiled:], "")
#step([*If* sugar required], "")
//.. Rest of section goes here
]
```
#### Index
An index with an entry for each section in the document.
```typst
#index()
```
#### Section
A section title, forces capitalisation.
```typst
#section("Cup of Tea preparation")[
//.. Rest of section goes here
]
```
#### Conditions
Conditionals for this section.
```typst
#condition[
- Dehydration
- Fatigue
- Inability to Concentrate
]
```
#### Objective
An objective for this section (optional).
```typst
#objective[To replenish fluids.]
```
#### Step
A numbered step in the checklist. The first parameter is to the left of the dotted line, the second is to the right. If the second parameter is omitted then there is no dotted line. Can be followed by a tag which is referenced by `goto()`.
```typst
#step("KETTLE", "Filled to 1 CUP")
#step([*When* KETTLE boiled:])
#step([*If* sugar required])
```
#### Substep
A non-numbered step with a left indentation. Similarly to a step, the first parameter is to the left of the dotted line, the second is to the right.
```typst
#substep("MUG", "Fill")
#substep([Sugar (one #linebreak() teaspoon at a time)], "Add to MUG")
```
#### Tab
Indents contents by one tab.
```typst
#tab(goto("9"))
#tab(tab("Large mugs may require more water."))
```
#### Caution
Adds a caution element.
```typst
#caution([HOT WATER #linebreak()Adult supervision required.])
```
#### Note
Adds a note.
```typst
#note("Stir after each step")
```
#### Choose One
A numbered step with options.
```typst
#choose-one[
#option[Black tea *required:*]
#option[Tea with MILK *required:*]
]
```
#### Go to step
Two right facing arrow heads followed by Go to step `step number`. Links to step in pdf. The parameter is the name of a tag next to a step.
```typst
#step("KETTLE", "Filled to 1 CUP")
#goto("fillKettle")
```
#### End
Ends the section here with 4 dots.
```typst
#end()
```
#### Wait
Long small dotted line for waiting for a task to complete.
```typst
#wait()
```