quick-sip:0.1.1

packages/preview/quick-sip/0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Archie Webster
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/quick-sip/0.1.1/README.md

@@ -0,0 +1,145 @@
+# Quick Sip - Typst QRH Template
+
+Creates aviation style checklists like Quick Reference Handbooks.
+
+<img src="thumbnail.png" width="300">
+
+### 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.1": *
+#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 `""` then there is no dotted line.
+
+```typst
+#step("KETTLE", "Filled to 1 CUP")
+#step([*When* KETTLE boiled:], "")
+#step([*If* sugar required], "")
+```
+
+#### 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.
+
+```typst
+#goto(9)
+```
+
+#### End
+
+Ends the section here with 4 dots.
+
+```typst
+#end()
+```
+
+#### Wait
+
+Long small dotted line for waiting for a task to complete.
+
+```typst
+#wait()
+```