forked from pencelheimer/typst_nure_template
150 lines
5.0 KiB
Markdown
150 lines
5.0 KiB
Markdown
# Typst Template for NURE Works
|
||
<img src="assets/pz-lb_title_page.png" alt="pz-lb title page" width=250>
|
||
|
||
## 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.
|
||
|
||
### Templates
|
||
|
||
#### `pz-lb` - For Practice and Laboratory Works
|
||
This template:
|
||
- Sets up document styles;
|
||
- Formats the title page according to NURE/DSTU guidelines.
|
||
|
||
#### `coursework` - For Course Works
|
||
This template:
|
||
- Sets up document styles;
|
||
- Formats the title, task, calendar plan, and abstract pages;
|
||
- Typesets the bibliography, outline, and appendices according to standard requirements.
|
||
|
||
### Utilities
|
||
- `nheading` - For unnumbered headings, such as "Introduction" and "Conclusion".
|
||
- `hfill` - Fills horizontal space with a filled box instead of just empty space; useful for creating underlines.
|
||
- `uline` - Creates underlined fields that need to be filled, such as the name field on the task list.
|
||
- `bold` - Inserts bold text inside functional environments.
|
||
- `img` - Inserts images with a caption, automatically deriving the label from the image file name.
|
||
|
||
**Note:** `img()` is provided in `utils.typ` in project's root directory for compatibility, until [path() type](https://github.com/typst/typst/pull/7555) is released.
|
||
|
||
## Usage
|
||
|
||
### As a local typst package
|
||
1. Clone this repository into ~/.local/share/typst/packages/:
|
||
```bash
|
||
git clone -b 0.1.0 https://gitea.linerds.us/pencelheimer/typst_nure_template.git ~/.local/share/typst/packages/local/nure/0.1.0
|
||
```
|
||
2. Init your project with Typst:
|
||
```bash
|
||
typst init @local/nure:0.1.0 project-name
|
||
```
|
||
|
||
### As a standalone file
|
||
Copy `src/` to your project's root directory, optionally renaming `src/` to `lib/`.
|
||
|
||
### In your project
|
||
```typst
|
||
// Import the template either from a local package...
|
||
#import "@local/nure:0.1.0": *
|
||
// ...or by importing a lib.typ directly
|
||
// #import "/lib/lib.typ": *
|
||
|
||
// 1. Setup the document
|
||
// by setting values directly...
|
||
#show: pz-lb.with(
|
||
title: "Some title",
|
||
// etc: "and so on",
|
||
// ...
|
||
)
|
||
// ...or using a yaml/toml file
|
||
#show: pz-lb.with(..toml("/doc.toml"))
|
||
|
||
// this template automatically inserts a `=title`
|
||
|
||
// Write your content
|
||
#v(-spacing) // remove spacing between headings
|
||
== Purpose
|
||
Some text
|
||
|
||
// ...or include your modules
|
||
#include "chapters/intro.typ"
|
||
#include "chapters/chapter1.typ"
|
||
#include "chapters/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: style.appendices
|
||
|
||
= 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.
|
||
]
|
||
```
|
||
|
||
And a TOML file would look like this:
|
||
```toml
|
||
# university = "ХНУРЕ" # "ХНУРЕ" is the default
|
||
# edu_program = "ПЗПІ" # can be null, sourced from authors.first() by default
|
||
|
||
subject = "СМП"
|
||
doctype = "ЛБ"
|
||
worknumber = 2
|
||
title = "Потiк керування та алгоритмічні структури Bash"
|
||
|
||
[[mentors]]
|
||
name = "Шевченко Т. Г."
|
||
degree = "Доцент кафедри ПІ"
|
||
gender = "m"
|
||
|
||
[[mentors]]
|
||
name = "Франко І. Я."
|
||
degree = "Асистент кафедри ПІ"
|
||
gender = "m"
|
||
|
||
[[authors]]
|
||
name = "Косач Л. П."
|
||
edu_program = "ПЗПІ"
|
||
group = "23-2"
|
||
gender = "f"
|
||
variant = 8
|
||
# For coursework
|
||
full_name_gen = "Косач Лариси Петрівни"
|
||
course = 2
|
||
semester = 4
|
||
```
|
||
|
||
### 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
|
||
```
|
||
project/
|
||
├── doc.toml -- for things that don't change across works, i.e. author and mentor metadata
|
||
├── main.typ -- for boilerplate code and importing everything
|
||
├── utils.typ -- for helper functions
|
||
├── chapters/
|
||
│ ├── intro.typ
|
||
│ ├── chapter1.typ
|
||
│ ├── chapter2.typ
|
||
│ └── ...
|
||
├── figures/
|
||
│ ├── chapter1/
|
||
│ │ ├── figure1.png
|
||
│ │ ├── figure2.png
|
||
│ │ ├── figure3.png
|
||
│ │ └── ...
|
||
│ ├── chapter2/
|
||
│ │ ├── figure1.png
|
||
│ │ ├── figure2.png
|
||
│ │ ├── figure3.png
|
||
│ │ └── ...
|
||
│ └── ...
|
||
└── ...
|
||
```
|