docs(README): fix installation instructions

- added typst.toml
- moved templates to "template" folder
- renamed files according to convention

README.md

@@ -1,14 +1,5 @@
 # Typst Template for NURE Works
 
-> [!WARNING]
-> This branch is using the Typst v0.13.0-rc1. To install it use the following command:
-> ```bash
-> cargo install --git https://github.com/typst/typst --branch 0.13 --locked typst-cli
-> ```
-
-## TODO
-- Add more information about the template.
-
 ## General Info
 
 This project contains two template functions and some utilities for writing NURE works. All functions include documentation comments inside them, so you can explore all possibilities using LSP.
@@ -35,19 +26,31 @@ This template:
 
 ## Usage
 
-To use the template, include it in your project and utilize the provided functions:
+### As a local typst package
+1. Clone this repository into ~/.local/share/typst/packages/:
+```bash
+git clone https://gitea.linerds.us/pencelheimer/typst_nure_template.git ~/.local/share/typst/packages/local/nure/0.0.0
+```
+2. Init your project with Typst:
+```bash
+typst init @local/nure:0.0.0 project-name
+```
+
+### As a file in your project
+Include lib.typ in your project and utilize the provided functions:
 
 ```typst
 // Import the template
-#import "path/to/template.typ": *
+#import "lib.typ": *
 
 // Setup the document
-#show: pz-lb-template.with(
+#show: lab-pz-template.with(
     title: "Some title",
 )
+// this template automatically inserts a `=title`
 
 // Write your content
-#v(-spacing)
+#v(-spacing) // remove spacing between headings
 == Purpose
 Some text
 ```

lib.typ

@@ -1,4 +1,26 @@
 
+// Academic aliases {{{1
+
+/// subject abbreviations to full names
+#let subjects = (
+  "БД": "Бази даних",
+  "ОПНJ": "Основи програмування на Java",
+  "ОС": "Операційні системи",
+  "ПП": "Проектний практикум",
+  "СПМ": "Скриптові мови програмування",
+  "Ф": "Філософія",
+)
+
+/// education program abbreviations to name & number
+#let edu_programs = (
+  "ПЗПІ": (
+    name: "Інженерія програмного забезпечення",
+    number: 121, // TODO: ПЗПІ is "F2" now
+  ),
+)
+
+// Template formatting functions {{{1
+
 /// numberless heading
 #let nheading(title) = heading(depth: 1, numbering: none, title)
 
@@ -15,47 +37,7 @@
 /// bold text
 #let bold(content) = text(weight: "bold")[#content]
 
-/// captioned image with label derived from path:
+/// month name from its number
-/// - `image.png` = @image
-/// - `img/image.png` = @image
-/// - `img/foo/image.png` = @foo_image
-/// - `img/foo/foo_image.png` = @foo_image
-/// if source is specified, it will be appended to the caption as " (за даними `source`)"
-/// otherwise " (рисунок виконано самостійно)" will be appended to the caption
-#let img(path, caption, source: none) = {
-  let parts = path.split(".").first().split("/")
-
-  let label_string = if parts.len() <= 2 or parts.at(-1).starts-with(parts.at(-2)) {
-    // ("image",), (_, "image") and (.., "img", "img_image")
-    parts.last()
-  } else {
-    // (.., "img", "image") = "img_image"
-    parts.at(-2) + "_" + parts.at(-1)
-  }.replace(" ", "_")
-
-  caption = [#caption #if source != none [(за даними #source)] else [(рисунок виконано самостійно)]]
-
-  [#figure(image(path), caption: caption) #label(label_string)]
-}
-
-/// subjects list
-#let subjects = (
-  "БД": "Бази даних",
-  "ОПНJ": "Основи програмування на Java",
-  "ОС": "Операційні системи",
-  "ПП": "Проектний практикум",
-  "СПМ": "Скриптові мови програмування",
-  "Ф": "Філософія",
-)
-
-/// education programs list
-#let edu_programs = (
-  "ПЗПІ": (
-    name: "Інженерія програмного забезпечення",
-    number: 121,
-  ),
-)
-
 #let month_gen(month) = (
   "січня",
   "лютого",
@@ -71,7 +53,46 @@
   "грудня",
 ).at(month - 1)
 
-/// spacing between lines
+// Helper functions {{{1
+
+/// captioned image with label derived from path:
+/// - "image.png" = @image
+/// - "img/image.png" = @image
+/// - "img/foo/image.png" = @foo_image
+/// - "img/foo/foo_image.png" = @foo_image
+/// the caption will be modified based on a conditional positional value:
+/// - `none`: no change
+/// - some value: "`caption` (за даними `value`)"
+/// - no value: "`caption` (рисунок виконано самостійно)"
+/// additional named arguments will be passed to original `image` function
+#let img(path, caption, ..sink) = {
+  let parts = path.split(".").first().split("/")
+
+  let label_string = if parts.len() <= 2 or parts.at(-1).starts-with(parts.at(-2)) {
+    // ("image",), (_, "image") and (.., "img", "img_image")
+    parts.last()
+  } else {
+    // (.., "img", "image") = "img_image"
+    parts.at(-2) + "_" + parts.at(-1)
+  }.replace(" ", "_")
+
+  let caption = if sink.pos().len() == 0 {
+    caption + " (рисунок виконано самостійно)"
+  } else if sink.pos().first() == none {
+    caption
+  } else {
+    [#caption (за даними #sink.pos().first())]
+  }
+
+  [#figure(image(path, ..sink.named()), caption: caption) #label(label_string)]
+}
+
+// Styling {{{1
+/// NOTE: may be wrong
+#let ua_alpha_numbering = "абвгдежиклмнпрстуфхцшщюя".split("") // 0 = "", 1 = "а"
+
+// general outlook {{{2
+// spacing between lines
 #let spacing = 0.95em
 
 #let style(it) = {
@@ -95,17 +116,8 @@
   set par(spacing: spacing)
   set par(leading: spacing)
 
-  // enums and lists
+  // enums and lists {{{2
-  let ua_alph_numbering() = {
+  set enum(numbering: i => { ua_alpha_numbering.at(i) + ")" }, indent: 1.25cm, body-indent: 0.5cm)
-    // INFO: This alphabet is not full, maybe it should be extended or maybe not.
-    //       I cant remember nor find proper formatting rules.
-    //       "абвгґдеєжзиіїйклмнопрстуфхцчшщьюя" (full alphabet)
-
-    let alphabet = "абвгдежиклмнпрстуфхцшщюя".split("")
-    i => { alphabet.at(i) + ")" }
-  }
-
-  set enum(numbering: ua_alph_numbering(), indent: 1.25cm, body-indent: 0.5cm)
   show enum: it => {
     set enum(indent: 0em, numbering: "1)")
     it
@@ -113,7 +125,7 @@
 
   set list(indent: 1.35cm, body-indent: 0.5cm, marker: [--])
 
-  // figures
+  // figures {{{2
   show figure: it => {
     v(spacing * 2, weak: true)
     it
@@ -135,7 +147,7 @@
   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()))
 
-  // appearance of references to images and tables
+  // appearance of references to images and tables {{{2
   set ref(
     supplement: it => {
       if it == none or not it.has("kind") {
@@ -162,7 +174,7 @@
     [(#it)]
   }
 
-  // headings
+  // headings {{{2
   set heading(numbering: "1.1")
 
   show heading.where(level: 1): it => {
@@ -185,7 +197,19 @@
     v(spacing * 2, weak: true)
   }
 
-  // listings
+  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
   show raw: it => {
     let new_spacing = 0.5em
     set block(spacing: new_spacing)
@@ -203,6 +227,8 @@
   it
 }
 
+// Coursework template {{{1
+
 /// DSTU 3008:2015 Template for NURE
 /// -> content
 /// - doc (content): Content to apply the template to.
@@ -216,7 +242,7 @@
 /// - calendar_plan ( plan_table: (content | str), approval_date: datetime): Calendar plan object.
 /// - abstract (keywords: (str, ), text: (content | str)): Abstract object.
 /// - bib_path path: Path to the bibliography yaml file.
-/// - appendices ((title: str, content: content, ): List of appendices objects.
+/// - appendices (content): Content with appendices.
 #let cw-template(
   doc,
   title: "NONE",
@@ -249,7 +275,7 @@
   let head_mentor = mentors.at(0)
   let edu_program = edu_programs.at(edu_program_shorthand)
 
-  // page 1
+  // page 1 {{{2
   [
     #set align(center)
     МІНІСТЕРСТВО ОСВІТИ І НАУКИ УКРАЇНИ
@@ -316,22 +342,21 @@
 
     #pagebreak()
   ]
-  //
 
-  // page 2
+  // page 2 {{{2
   {
-    uline([Харківський національний університет радіоелектроніки])
+    uline[Харківський національний університет радіоелектроніки]
 
     linebreak()
     linebreak()
 
     grid(
       columns: (100pt, 1fr),
-      bold([
+      bold[
         Кафедра
         Дисципліна
         Спеціальність
-      ]),
+      ],
       {
         uline(align: left, department_gen)
         linebreak()
@@ -343,7 +368,7 @@
     grid(
       columns: (1fr, 1fr, 1fr),
       gutter: 0.3fr,
-      [#bold("Курс") #uline(2)], [#bold("Група") #uline(author.group)], [#bold("Семестр") #uline(3)],
+      [#bold[Курс] #uline(2)], [#bold[Група] #uline(author.group)], [#bold[Семестр] #uline(3)],
     )
 
     linebreak()
@@ -396,9 +421,10 @@
     pagebreak()
   }
 
-  // page 3
+  // page 3 {{{2
   {
     align(center, bold[КАЛЕНДАРНИЙ ПЛАН])
+    set par(first-line-indent: 0pt)
 
     linebreak()
 
@@ -436,23 +462,25 @@
     pagebreak()
   }
 
-  // page 4 {{{
+  // page 4 {{{2
   [
-    #align(center, bold([РЕФЕРАТ])) \
+    #align(center, bold[РЕФЕРАТ]) \
 
     #context [
       #let pages = counter(page).final().at(0)
-      #let tables = counter(figure.where(kind: table)).final().at(0)
+      #let images = query(figure.where(kind: image)).len()
-      // alternative: query(figure.where(kind: image)).len()
+      #let tables = query(figure.where(kind: table)).len()
-      #let images = counter(figure.where(kind: image)).final().at(0)
       #let bibs = bib-count.final().dedup().len()
+      /* TODO: why this stopped working?
+      #let tables = counter(figure.where(kind: table)).final().at(0)
+      #let images = counter(figure.where(kind: image)).final().at(0)*/
 
       #let counters = ()
 
-      #if pages != 0 { counters.push([#pages с.]) }
+      #if pages != 0 { counters.push[#pages с.] }
-      #if tables != 0 { counters.push([#tables табл.]) }
+      #if tables != 0 { counters.push[#tables табл.] }
-      #if images != 0 { counters.push([#images рис.]) }
+      #if images != 0 { counters.push[#images рис.] }
-      #if bibs != 0 { counters.push([#bibs джерел]) }
+      #if bibs != 0 { counters.push[#bibs джерел] }
 
       Пояснювальна записка до курсової роботи: #counters.join(", ").
     ]
@@ -484,9 +512,8 @@
 
     #abstract.text
   ]
-  // }}}
 
-  // page 5
+  // page 5 {{{2
   outline(
     title: [
       ЗМІСТ
@@ -498,7 +525,7 @@
 
   doc
 
-  // bibliography
+  // bibliography {{{2
   {
     heading(depth: 1, numbering: none)[Перелік джерел посилання]
 
@@ -521,7 +548,7 @@
         )
         [
           #citation.title.
-          _#{citation.author}_. // TODO: remove italic case, issue #7
+          #citation.author.
           URL: #citation.url.value (дата звернення: #date.display("[day].[month].[year]")).
         ]
       } else if citation.type == "Book" [
@@ -536,6 +563,7 @@
     }
 
     show enum.item: it => {
+      set par(first-line-indent: 0pt)
       box(width: 1.25cm)
       box(width: 1em + 0.5cm)[#it.number.]
       it.body
@@ -552,33 +580,48 @@
     }
   }
 
-  // appendices
+  // appendices {{{2
   {
     counter(heading).update(0)
 
-    for (i, appendix) in appendices.enumerate() [
+    set heading(
-      #set heading(
+      numbering: (i, ..nums) => {
-        numbering: i => [
+        let char = upper(ua_alpha_numbering.at(i))
-          Додаток #"АБВГДЕЖИКЛМНПРСТУФХЦШЩЮЯ".split("").at(i)
+        if nums.pos().len() == 0 { char } else {
-        ],
+          char + "." + nums.pos().map(str).join(".")
+        }
+      },
     )
 
-      #show heading: it => {
+    show heading.where(level: 1): it => {
       set align(center)
       set text(size: 14pt, weight: "regular")
 
       pagebreak(weak: true)
-        bold(upper(counter(heading).display(it.numbering)))
+      bold[ДОДАТОК #counter(heading).display(it.numbering)]
       linebreak()
       it.body
       v(spacing * 2, weak: true)
     }
-      #heading(appendix.title)
+
-      #appendix.content
+    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
   }
 }
 
+// Laboratory work template {{{1
+
 /// DSTU 3008:2015 Template for NURE
 /// -> content
 /// - doc (content): Content to apply the template to.
@@ -605,6 +648,7 @@
 
   context counter(heading).update(worknumber - 1)
 
+  // page 1 {{{2
   align(center)[
     МІНІСТЕРСТВО ОСВІТИ І НАУКИ УКРАЇНИ \
     ХАРКІВСЬКИЙ НАЦІОНАЛЬНИЙ УНІВЕРСИТЕТ РАДІОЕЛЕКТРОНІКИ
@@ -626,14 +670,16 @@
 
     #columns(2)[
       #set align(left)
-
+      #set par(first-line-indent: 0pt)
-      #if authors.len() == 1 [
+      #if authors.len() == 1 {
-        #let author = authors.at(0)
+        let author = authors.at(0)
-        #if author.gender == "m" { [Виконав:\ ] } else { [Виконала:\ ] }
+        if author.gender == "m" [Виконав:\ ] else [Виконала:\ ]
+        [
           ст. гр. #author.group\
           #author.name\
-        #if author.variant != none { [Варіант: №#author.variant] }
+        ]
-      ] else [
+        if author.variant != none [Варіант: №#author.variant]
+      } else [
         Виконали:\
         ст. гр. #authors.at(0).group\
         #authors.map(a => [ #a.name\ ])
@@ -658,4 +704,4 @@
   doc
 }
 
-// vim:sts=2:sw=2
+// vim:sts=2:sw=2:fdl=0:fdm=marker:cms=/*%s*/

template/coursework.typ

@@ -1,4 +1,4 @@
-#import "template.typ": *
+#import "@local/nure:0.0.0": *
 
 #let author = (
   name: "Ситник Є. С.",
@@ -77,20 +77,20 @@
   ],
 )
 
-#let appendices = (
+#let appendices = [
-  (
+  = Приклад звіту 1
-    title: "Приклад звіту 1",
+  #v(-spacing)
-    content: [test],
+  == Частина 1
-  ),
+  #lorem(100)
-  (
+  == Частина2
-    title: "Приклад звіту 2",
+  #lorem(200)
-    content: [test],
+
-  ),
+  = Приклад звіту 2
-  (
+  #lorem(200)
-    title: "Приклад звіту 3",
+
-    content: [test],
+  = Приклад звіту 3
-  ),
+  #lorem(200)
-)
+]
 
 #show: cw-template.with(
   title: "Інформаційна система «Помічник класного керівника». Керування класом",
@@ -105,3 +105,16 @@
   bib_path: "bibl.yml",
   appendices: appendices,
 )
+
+= Моделювання
+#lorem(250)
+
+= Імплементація
+#v(-spacing)
+== Підоготовка
+#lorem(200)
+== Процес
+#lorem(500)
+
+= Тестування
+#lorem(300)

template/lab.typ

@@ -1,5 +1,4 @@
-#import "template.typ": *
+#import "@local/nure:0.0.0": *
-#import "@preview/indenta:0.0.3": fix-indent
 
 #show: lab-pz-template.with(
   doctype: "ЛБ",
@@ -23,17 +22,30 @@
   worknumber: 1,
 )
 
-#show: fix-indent()
-
 #v(-spacing)
 
 == Мета роботи
-Супер важлива мета
+#lorem(100)
-
-== Висновки
-Супер важливий висновок
 
 == Хід роботи
+#v(-spacing)
+=== Підготовка
+#lorem(150)
+
+=== Виконання дослідження
+#lorem(300)
+
+=== Підрахунок результатів
+#lorem(250)
+
+== Висновки
+#lorem(100)
 
 == Контрольні запитання
-Супер важливі контрольні запитання
+#lorem(100):
+- #lorem(20);
+- #lorem(30);
+- #lorem(15);
+- #lorem(25);
+- #lorem(42);
+- #lorem(27).

typst.toml

@@ -0,0 +1,11 @@
+[package]
+name = "nure"
+version = "0.0.0"
+entrypoint = "lib.typ"
+authors = ["linerds"]
+license = "GPL-3.0"
+description = "Typst NURE package"
+
+[template]
+path = "template"
+entrypoint = "lab.typ"