refactor: backport changes from noatu's fork

feat(style)!: remove reference styling & fix figure numbering for appendices
feat!: swap appending on 'none' being the first position in ..sink
feat: add chapters to pz-lb()
feat: add asserts
fix: better control flow

img() function now requires `none` to be the first position in ..sink,
e.g. `#img("/fig/1.png", "Caption", none)` to get "Caption (рисунок виконано самостійно)" caption.

Use `@some_label[див. рис.]` to get a "див. рис. 42" link.

Signed-off-by: unexplrd <unexplrd@linerds.us>

README.md

@@ -1,4 +1,5 @@
 # Typst Template for NURE Works
+![pz-lb title page](assets/pz-lb_title_page.png)
 
 ## General Info
 
@@ -6,12 +7,12 @@ This project contains two template functions and some utilities for writing NURE
 
 ### Templates
 
-#### `pz-lb-template` - For Laboratory and Practical Works
+#### `pz-lb` - For Practice and Laboratory Works
 This template:
 - Sets up document styles;
 - Formats the title page according to NURE/DSTU guidelines.
 
-#### `cw-template` - For Course Works
+#### `coursework` - For Course Works
 This template:
 - Sets up document styles;
 - Formats the title, task, calendar plan, and abstract pages;
@@ -46,15 +47,19 @@ Copy `lib.typ` to your project's root directory.
 // ...or by importing a lib.typ directly
 // #import "/lib.typ": *
 
-// Setup the document
-#show: pz-lb-template.with(
-    title: "Some title",
-    // etc: "and so on",
-    // ...
+// 1. Setup the document
+// by setting values directly...
+#show: pz-lb.with(
+  title: "Some title",
+  // etc: "and so on",
+  // ...
 )
+// ...or using a config/doc.yaml file
+#show: pz-lb.with(..yaml("config/doc.yaml"))
+
 // this template automatically inserts a `=title`
 
-// Write your content...
+// Write your content
 #v(-spacing) // remove spacing between headings
 == Purpose
 Some text
@@ -65,10 +70,23 @@ Some text
 #include "src/chapter2.typ"
 // NOTE: if you want to use variables or utils provided by the package,
 // you have to import the package or a lib.typ inside a module.
+
+
+// If you ever need appendices in pz-lb template use the show rule
+// WARNING: when using coursework template use its own argument,
+// so it can put bibliography before appendices
+#show: appendices-style
+
+= Quote
+#link("https://youtu.be/bJQj1uKtnus")[
+  The art isn't the art, the art is never the art,
+  the art is the thing that happens inside you when you make it and the feeling in the heart of the beholder.
+]
 ```
 
 ### Notes:
 1. Use `#v(-spacing)` to remove vertical spacing between titles (this cannot be automatically handled by the template). Variable `spacing` used here is imported from the template.
+2. When importing `@local/nure:0.1.0` and specifying file paths in functions handled by the package, the path will relative to package's root directory, e.g. setting `#show: coursework.with(bib_path: "bibl.yml")` will evaluate to `~/.local/share/typst/packages/local/nure/0.1.0/bibl.yml`, the same is for `#img` function, which makes it quite annoying and forces one to import `lib.typ` file. Please open an issue or contact us in any other way if you have any advice.
 
 ### Example Project Structure
 ```

config/universities.yaml

@@ -1,24 +1,58 @@
 ХНУРЕ:
-  name: "Харківський національний університет радіоелектроніки"
+  name: Харківський національний університет радіоелектроніки
   edu_programs:
     ПЗПІ:
-      name_long: "Інженерія програмного забезпечення"
-      department_gen: "Програмної інженерії"
-      code: 121  # TODO = ПЗПІ is "F2" now
+      name_long: Інженерія програмного забезпечення
+      department_gen: Програмної інженерії
+      code: 121  # TODO: change to F2?
     КУІБ:
-      name_long: "Управління інформаційною безпекою"
-      department_gen: "Інфокомунікацій"
+      name_long: Управління інформаційною безпекою
+      department_gen: Інфокомунікаційної інженерії ім. В. В. Поповського
       code: 125
+    КНТ:
+      name_long: Комп'ютерні науки та технології
+      department_gen: Системотехніки
+      code: 122
   subjects:
-    БД: "Бази даних"
-    БЖД: "Безпека життєдіяльності"
-    ОІМ: "Основи IP-мереж"
-    "ОПНJ": "Основи програмування на Java"
-    ОС: "Операційні системи"
-    ОТК: "Основи теорії кіл"
-    ПП: "Проектний практикум"
-    ПРОГ: "Програмування"
-    СПМ: "Скриптові мови програмування"
-    УФМ: "Українське фахове мовлення"
-    Ф: "Філософія"
-    ФІЗ: "Фізика"
+    ODS: Основи Dаtа Sсіеnсе # NOTE: Eng O here
+    ІМ: Іноземна мова
+    АКтаК: Архітектура комп'ютера та комп'ютерних мереж
+    АТСД: Алгоритми та структури даних
+    БД: Бази даних
+    БЖД: Безпека життєдіяльності
+    ВДІТБ: Введення до ІТ-бізнесу # NOTE: all in UA
+    ВМ: Вища математика
+    ГТГ: Гіпертекст та гіпермедіа
+    ДМ: Дискретна математика
+    КДМА: Комп'ютерна дискретна математика
+    КМ: Комп`ютерні мережі
+    КЗВШ: Креативність з використанням штучного інтелекту
+    ЛМВ: Людино-машинна взаємодія
+    МОТДО: Методи оптимізаціі та дослідження операцій
+    МС: Моделювання систем
+    ОІМ: Основи IP-мереж
+    ООП: Об'єктно-орієнтоване програмування
+    ОП: Основи права
+    ОПІ: Основи програмноі інженеріі
+    ОПНJ: Основи програмування на Java
+    ОПр: Основи програмування
+    ОС: Операційні системи
+    ОТК: Основи теорії кіл
+    ПНП: Програмування на платформі .NЕТ
+    ПП: Проектний практикум
+    ПРОГ: Програмування
+    СМП: Скриптові мови програмування
+    ТЙтаМ: Теорія ймовірностей та математична # TODO: what?
+    ТКП: Технології комп`ютерного проєктування
+    УФМ: Українське фахове мовлення
+    ФІЗ: Фізика
+    ФІЛ: Філософія
+    ФВС: Фізичне виховання та спорт
+    # Oleksii 6th semester
+    ХТ: Хмарні технології
+    ООАПС: Об'єктно-орієнтований аналіз в проектуванні систем
+    СА: Системний аналіз
+    МППС: Методології проектування програмних систем
+    ТЗІ: Технології захисту інформації
+    АДан: Аналітика даних
+    DMT: Decision making theory

lib.typ

@@ -66,9 +66,9 @@
   }.replace(" ", "_")
 
   let caption = if sink.pos().len() == 0 {
-    caption + " (рисунок виконано самостійно)"
-  } else if sink.pos().first() == none {
     caption
+  } else if sink.pos().first() == none {
+    caption + " (рисунок виконано самостійно)"
   } else {
     [#caption (за даними #sink.pos().first())]
   }
@@ -79,54 +79,62 @@
     ) #label(label_string)]
 }
 
-// Styling {{{1
-/// NOTE: may be wrong
-#let ua_alpha_numbering = "абвгдежиклмнпрстуфхцшщюя".split("") // 0 = "", 1 = "а"
+#let spacing = 0.95em // spacing between lines
+#let num-to-alpha = "абвгдежиклмнпрстуфхцшщюя".split("") // 0 = "", 1 = "а"
 
-// general outlook {{{2
-// spacing between lines
-#let spacing = 0.95em
-
-#let style(it) = {
+/// DSTU 3008:2015 Style
+/// -> content
+/// - it (content): Content to apply the style to.
+/// - skip (int): Do not show page number for this number of pages.
+/// - offset (int): Adjust all page numbers by this amount.
+#let dstu-style(
+  it,
+  skip: 0,
+  offset: 0,
+) = {
+  // General Styling {{{1
   set page(
     paper: "a4",
-    margin: (top: 20mm, right: 10mm, bottom: 20mm, left: 25mm),
     number-align: top + right,
-    numbering: (..numbers) => {
-      if numbers.pos().at(0) != 1 {
-        numbering("1", numbers.pos().at(0))
-      }
-    },
+    margin: (top: 20mm, right: 10mm, bottom: 20mm, left: 25mm),
+    numbering: (i, ..) => if i > skip { numbering("1", i + offset) },
   )
 
   set text(
-    font: ("Times New Roman", "Liberation Serif"),
+    lang: "uk",
     size: 14pt,
     hyphenate: false,
-    lang: "uk",
+    font: ("Times New Roman", "Liberation Serif"),
   )
-  set par(justify: true, first-line-indent: (amount: 1.25cm, all: true))
+
+  set par(
+    justify: true,
+    spacing: spacing,
+    leading: spacing,
+    first-line-indent: (amount: 1.25cm, all: true),
+  )
+
+  set block(spacing: spacing)
   set underline(evade: false)
 
-  // set 1.5 line spacing
-  set block(spacing: spacing)
-  set par(spacing: spacing)
-  set par(leading: spacing)
-
-  // enums and lists {{{2
+  // Enums & Lists {{{1
+  // First level
   set enum(
-    numbering: i => { ua_alpha_numbering.at(i) + ")" },
     indent: 1.25cm,
     body-indent: 0.5cm,
+    numbering: i => { num-to-alpha.at(i) + ")" },
   )
+
+  // Second level and further nesting
   show enum: it => {
     set enum(indent: 0em, numbering: "1)")
     it
   }
 
+  // Lists are not intended for multiple levels, use `enum`
   set list(indent: 1.35cm, body-indent: 0.5cm, marker: [--])
 
-  // figures {{{2
+  // Figures {{{1
   show figure: it => {
     v(spacing * 2, weak: true)
     it
@@ -137,103 +145,52 @@
   show figure.where(kind: table): set figure.caption(position: top)
   show figure.caption.where(kind: table): set align(left)
 
-  // figure numbering
+  // Numbering {{{1
   show heading.where(level: 1): it => {
     counter(math.equation).update(0)
+    counter(figure.where(kind: raw)).update(0)
     counter(figure.where(kind: image)).update(0)
     counter(figure.where(kind: table)).update(0)
-    counter(figure.where(kind: raw)).update(0)
     it
   }
-  set math.equation(
-    numbering: (..num) => numbering(
-      "(1.1)",
-      counter(heading).get().at(0),
-      num.pos().first(),
-    ),
-  )
-  set figure(
-    numbering: (..num) => numbering(
-      "1.1",
-      counter(heading).get().at(0),
-      num.pos().first(),
-    ),
-  )
+  set figure(numbering: i => numbering("1.1", counter(heading).get().at(0), i))
+  set math.equation(numbering: i => numbering(
+    "(1.1)",
+    counter(heading).get().at(0),
+    i,
+  ))
 
-  // appearance of references to images and tables {{{2
-  set ref(
-    supplement: it => {
-      if it == none or not it.has("kind") {
-        it
-      } else if it.kind == image {
-        "див. рис."
-      } else if it.kind == table {
-        "див. таблицю"
-      } else {
-        it
-      }
-    },
-  )
-  show ref: it => {
-    let el = it.element
-
-    if el == none or not el.has("kind") {
-      return it
-    }
-    if el.kind != image and el.kind != table {
-      return it
-    }
-
-    [(#it)]
-  }
-
-  // headings {{{2
+  // Headings {{{1
   set heading(numbering: "1.1")
 
-  show heading.where(level: 1): it => {
+  show heading: it => if it.level == 1 {
     set align(center)
     set text(size: 14pt, weight: "semibold")
 
     pagebreak(weak: true)
     upper(it)
     v(spacing * 2, weak: true)
-  }
-  show heading.where(level: 2): it => {
+  } else {
     set text(size: 14pt, weight: "regular")
 
     v(spacing * 2, weak: true)
     block(width: 100%, spacing: 0em)[
       #h(1.25cm)
-      #counter(heading).display(it.numbering)
+      #counter(heading).display(auto)
       #it.body
     ]
     v(spacing * 2, weak: true)
   }
 
-  show heading.where(level: 3): it => {
-    set text(size: 14pt, weight: "regular")
-
-    v(spacing * 2, weak: true)
-    block(width: 100%, spacing: 0em)[
-      #h(1.25cm)
-      #counter(heading).display(it.numbering)
-      #it.body
-    ]
-    v(spacing * 2, weak: true)
-  }
-
-  // listings {{{2
+  // Listings {{{1
   show raw: it => {
-    let new_spacing = 0.5em
-    set block(spacing: new_spacing)
-    set par(
-      spacing: new_spacing,
-      leading: new_spacing,
-    )
+    let raw-spacing = 0.5em
+    set block(spacing: raw-spacing)
+    set par(spacing: raw-spacing, leading: raw-spacing)
     set text(
       size: 11pt,
-      font: ("Iosevka NFM", "Courier New"),
       weight: "semibold",
+      font: ("Courier New", "Liberation Mono"),
     )
 
     v(spacing * 2.5, weak: true)
@@ -242,8 +199,47 @@
   }
 
   it
+  // }}}
 }
 
+/// DSTU 3008:2015 Appendices Style
+/// -> content
+/// - it (content): Content to apply the style to.
+#let appendices-style(it) = /* {{{ */ {
+  // Numbering
+  counter(heading).update(0)
+  set heading(numbering: (i, ..n) => (
+    upper(num-to-alpha.at(i)) + numbering(".1.1", ..n)
+  ))
+  set figure(numbering: i => [#upper(num-to-alpha.at(counter(heading).get().at(0))).#i])
+  set math.equation(numbering: i => [(#upper(num-to-alpha.at(counter(heading).get().at(0))).#i)])
+
+  // Headings
+  show heading: it => if it.level == 1 {
+    set align(center)
+    set text(size: 14pt, weight: "regular")
+
+    pagebreak(weak: true)
+    text(weight: "bold")[ДОДАТОК #counter(heading).display(auto)]
+    linebreak()
+    it.body
+    v(spacing * 2, weak: true)
+  } else {
+    set text(size: 14pt, weight: "regular")
+
+    v(spacing * 2, weak: true)
+    block(width: 100%, spacing: 0em)[
+      #h(1.25cm)
+      #counter(heading).display(auto)
+      #it.body
+    ]
+    v(spacing * 2, weak: true)
+  }
+
+  it
+} // }}}
+
+
 // Coursework template {{{1
 
 /// DSTU 3008:2015 Template for NURE
@@ -259,7 +255,7 @@
 /// - abstract (keywords: (str, ), text: (content | str)): Abstract object.
 /// - bib_path path: Path to the bibliography yaml file.
 /// - appendices (content): Content with appendices.
-#let cw-template(
+#let coursework(
   doc,
   title: none,
   subject: none,
@@ -275,7 +271,7 @@
 ) = {
   set document(title: title, author: author.name)
 
-  show: style
+  show: dstu-style.with(skip: 1)
 
   let bib-count = state("citation-counter", ())
   show cite: it => {
@@ -381,9 +377,7 @@
     grid(
       columns: (1fr, 1fr, 1fr),
       gutter: 0.3fr,
-      [#bold[Курс] #uline(author.course)],
-      [#bold[Група] #uline([#edu_program\-#author.group])],
-      [#bold[Семестр] #uline(author.semester)],
+      [#bold[Курс] #uline(author.course)], [#bold[Група] #uline([#edu_program\-#author.group])], [#bold[Семестр] #uline(author.semester)],
     )
 
     linebreak()
@@ -600,72 +594,41 @@
     }
   }
 
-  // appendices {{{2
-  {
-    counter(heading).update(0)
-
-    set heading(
-      numbering: (i, ..nums) => {
-        let char = upper(ua_alpha_numbering.at(i))
-        if nums.pos().len() == 0 { char } else {
-          char + "." + nums.pos().map(str).join(".")
-        }
-      },
-    )
-
-    show heading.where(level: 1): it => {
-      set align(center)
-      set text(size: 14pt, weight: "regular")
-
-      pagebreak(weak: true)
-      bold[ДОДАТОК #counter(heading).display(it.numbering)]
-      linebreak()
-      it.body
-      v(spacing * 2, weak: true)
-    }
-
-    show heading.where(level: 2): it => {
-      set text(size: 14pt, weight: "regular")
-
-      v(spacing * 2, weak: true)
-      block(width: 100%, spacing: 0em)[
-        #h(1.25cm)
-        #counter(heading).display(it.numbering)
-        #it.body
-      ]
-      v(spacing * 2, weak: true)
-    }
-
-    appendices
-  }
+  appendices-style(appendices)
 }
 
-// Laboratory work template {{{1
+// Practice and Laboratory works template {{{1
 
 /// DSTU 3008:2015 Template for NURE
 /// -> content
 /// - doc (content): Content to apply the template to.
-/// - doctype ("ЛБ" | "ПЗ"): Document type.
 /// - edu_program (str): Education program shorthand.
-/// - title (str): Title of the document.
+/// - doctype ("ЛБ" | "ПЗ" | str): Document type.
+/// - title (str or none): Title of the document. Optional.
 /// - subject (str): Subject shorthand.
-/// - authors ((name: str, full_name_gen: str, group: str, gender: str, variant: int or none),): List of authors.
-/// - mentors ((name: str, degree: str, gender: str or none),): List of mentors.
 /// - worknumber (int or none): Number of the work. Optional.
-#let pz-lb-template(
+/// - authors ((name: str, full_name_gen: str, group: str, gender: str, variant: int or none),): List of authors.
+/// - mentors ((name: str, degree: str, gender: str or none),): List of mentors. Optional.
+/// - chapters (): List of file names in chapters/ subdirectory. Optional.
+#let pz-lb(
   doc,
-  doctype: none,
   university: "ХНУРЕ",
   edu_program: none,
+  doctype: none,
   title: none,
   subject: none,
   worknumber: none,
   authors: (),
   mentors: (),
+  chapters: (),
 ) = {
+  assert.ne(edu_program, none, message: "Missing argument: \"edu_program\"")
+  assert.ne(doctype, none, message: "Missing argument: \"doctype\"")
+  assert.ne(subject, none, message: "Missing argument: \"subject\"")
+
   set document(title: title, author: authors.at(0).name)
 
-  show: style
+  show: dstu-style.with(skip: 1)
 
   let uni = universities.at(university)
   let edu_prog = uni.edu_programs.at(edu_program)
@@ -678,17 +641,21 @@
     Кафедра #edu_prog.department_gen
 
     \ \ \
-    Звіт \
-    з
-    #if doctype == "ЛБ" [лабораторної роботи] else [практичної роботи]
+    #if doctype == "ЛБ" [Звіт \ з лабораторної роботи] else if (
+      doctype == "ПЗ"
+    ) [Звіт \ з практичної роботи] else [#doctype]
     #if worknumber != none {
-      context counter(heading).update(worknumber - 1)
+      context counter(heading).update(
+        worknumber - if title == none { 0 } else { 1 },
+      )
       [№#worknumber]
+    } else if title != none and worknumber != none {
+      context counter(heading).update(1)
     }
 
-    з дисципліни: "#uni.subjects.at(subject, default: "UNKNOWN SUBJECT, PLEASE OPEN AN ISSUE")"
+    з дисципліни: "#uni.subjects.at(subject)"
 
-    з теми: "#title"
+    #if title != none [з теми: "#title"]
 
     \ \ \ \
 
@@ -702,8 +669,10 @@
           ст. гр. #edu_program\-#author.group\
           #author.name\
         ]
-        if author.variant != none [Варіант: №#author.variant]
-      } else [
+        if (
+          "variant" in author.keys() and author.variant != none
+        ) [Варіант: №#author.variant]
+      } else if authors.len() > 1 [
         Виконали:\
         ст. гр. #edu_program\-#authors.at(0).group\
         #for author in authors [#author.name\ ]
@@ -712,24 +681,28 @@
       #colbreak()
       #set align(right)
 
-      #if mentors.len() == 1 {
-        let mentor = mentors.at(0)
-        if mentor.gender == none [Перевірили:\ ] else if (
-          mentor.gender == "m"
-        ) [Перевірив:\ ] else [Перевірилa:\ ]
-        [
-          #mentor.degree\
-          #mentor.name\
+      #if type(mentors) == array {
+        if mentors.len() == 1 {
+          let mentor = mentors.at(0)
+          if "gender" in mentor.keys() {
+            if mentor.gender == "m" [Перевірив:\ ] else if (
+              mentor.gender == "f"
+            ) [Перевірила:\ ]
+          } else [Перевірили:\ ]
+          if (
+            "degree" in mentor.keys() and mentor.degree != none
+          ) [#mentor.degree\ ]
+          [#mentor.name\ ]
+        } else if mentors.len() > 1 [
+          Перевірили:\
+          #for mentor in mentors {
+            [
+              #mentor.degree\
+              #mentor.name\
+            ]
+          }
         ]
-      } else [
-        Перевірили:\
-        #for mentor in mentors {
-          [
-            #mentor.degree\
-            #mentor.name\
-          ]
-        }
-      ]
+      }
     ]
 
     #v(1fr)
@@ -739,8 +712,10 @@
 
   pagebreak(weak: true)
 
-  heading(title)
+  if title != none [#heading(title)]
+
   doc
+  chapters.map(chapter => include "/chapters/" + str(chapter) + ".typ").join()
 }
 
 // vim:sts=2:sw=2:fdl=0:fdm=marker:cms=/*%s*/

template/config/doc.yaml

@@ -1,5 +1,5 @@
 title: Потiк керування та алгоритмічні структури Bash
-subject: СПМ
+subject: СМП
 doctype: ЛБ
 worknumber: 2
 mentors:

template/coursework.typ

@@ -97,16 +97,16 @@
   #lorem(200)
 ]
 
-#show: cw-template.with(
+#show: coursework.with(
   title: "Інформаційна система «Помічник класного керівника». Керування класом",
-  subject_short: "БД",
-  edu_program_short: "ПЗПІ",
+  subject: "БД",
+  edu_program: "ПЗПІ",
   author: author,
   mentors: mentors,
   task_list: task_list,
   calendar_plan: calendar_plan,
   abstract: abstract,
-  bib_path: "bibl.yml",
+  bib_path: bytes("bibl.yml"), // NOTE: use `bytes` as typst looks in template dir when using just filename
   appendices: appendices,
 )
 

template/lab.typ

@@ -1,6 +1,6 @@
 #import "@local/nure:0.1.0": *
 
-#show: pz-lb-template.with(..yaml("config/doc.yaml"))
+#show: pz-lb.with(..yaml("config/doc.yaml"))
 
 #v(-spacing)
 
@@ -29,3 +29,25 @@
 - #lorem(25);
 - #lorem(42);
 - #lorem(27).
+
+#show: appendices-style
+
+= Quote
+#link("https://youtu.be/bJQj1uKtnus")[
+  The art isn't the art, the art is never the art,
+  the art is the thing that happens inside you when you make it and the feeling in the heart of the beholder.
+]
+
+
+= Приклад звіту 1
+#v(-spacing)
+== Частина 1
+#lorem(100)
+== Частина2
+#lorem(200)
+
+= Приклад звіту 2
+#lorem(200)
+
+= Приклад звіту 3
+#lorem(200)