sgh-thesis:0.1.2

packages/preview/sgh-thesis/0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Piotr Kuszewski
+
+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/sgh-thesis/0.1.2/README.md

@@ -0,0 +1,92 @@
+# sgh-thesis
+
+A diploma thesis template (bachelor's and master's) compliant with the editorial
+requirements of the SGH Warsaw School of Economics (Szkoła Główna Handlowa
+w Warszawie). The template is bilingual — it supports Polish and English.
+
+The default font used for typesetting theses is New Computer Modern, which ships
+with every Typst installation, so no additional configuration is required to use
+the template.
+
+The full manual, a complete example thesis, and the matching SGH presentation
+template are available in the project repository:
+<https://github.com/piotr-m-kuszewski/Szablony_Typst_SGH>.
+
+![Title page of the example thesis produced with the template](thumbnail.png)
+
+## Usage
+
+```typst
+#import "@preview/sgh-thesis:0.1.2": *
+
+#show: sgh.with(
+  author: "Ijon Tichy",
+  student_id: "112358",
+  title: "Taksonomia i morfologia bytów nieistniejących zamieszkujących mgławice ciemne",
+  advisor: "prof. Astrala Sternu Tarantogi", // inflected for the phrase "pod kierunkiem naukowym..."
+  advisor_department: "Katedra Astrognozji i Porównawczego Badania Nicości",
+  year: "2025",
+  studies: "mgr",       // "mgr" (master's) or "lic" (bachelor's)
+  program: "Kosmologia Paradoksalna",
+  language: "pl",       // "pl" or "en"
+)
+
+#sgh-summary[
+  Abstract text.
+]
+
+#table-of-contents()
+
+= Introduction
+
+Body of the thesis...
+
+#list-of-sources(read("sources.bib", encoding: none))
+#list-of-figures()
+#list-of-tables()
+```
+
+## Generating the bibliography
+
+There are two ways to produce the bibliography:
+
+1. **`list-of-sources`** (template procedure — adds a page break and the Harvard
+   style by default). Because the call to `bibliography` lives *inside* the package,
+   a plain path string would be resolved relative to the package, not your document.
+   Read the file with `read(..., encoding: none)` in your own document and pass the
+   resulting bytes:
+
+   ```typst
+   #list-of-sources(read("sources.bib", encoding: none))
+   // optionally choose a style:
+   #list-of-sources(read("sources.bib", encoding: none), styl: "ieee")
+   ```
+
+2. **Built-in `bibliography`** — called directly in your document, so a path string
+   works as usual and you get full control over title and style:
+
+   ```typst
+   #pagebreak()
+   #bibliography("sources.bib", title: [Bibliografia], style: "harvard-cite-them-right")
+   ```
+
+## Available procedures
+
+- `sgh(...)` — the main template procedure; generates the title page and configures
+  document formatting (used with `#show: sgh.with(...)`).
+- `sgh-summary[...]` — the thesis abstract.
+- `table-of-contents()` — table of contents.
+- `list-of-figures()` — list of figures.
+- `list-of-tables()` — list of tables.
+- `list-of-sources(plik, styl: "harvard-cite-them-right")` — bibliography; `plik`
+  must be the file contents read with `read(..., encoding: none)` (bytes), not a path.
+- `sgh-figure(caption:, source:, placement:, body)` — a figure with a caption and
+  source; included in the list of figures.
+- `sgh-table(caption:, source:, placement:, body)` — a table with a caption and
+  source; included in the list of tables.
+- `sgh-stripped-tables` — formats tables with alternating shaded rows
+  (used with `#show: sgh-stripped-tables`).
+
+## License
+
+MIT — see the [LICENSE](LICENSE) file.