Typst Template for NURE Works

Warning

This branch is using the Typst v0.13.0-rc1. To install it use the following command:
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.

Templates

`pz-lb-template` - For Laboratory and Practical Works

This template:

Sets up document styles;
Formats the title page according to NURE guidelines.

`cw-template` - 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.

Usage

To use the template, include it in your project and utilize the provided functions:

// Import the template
#import "path/to/template.typ": *

// Setup the document
#show: pz-lb-template.with(
    title: "Some title",
)

// Write your content
#v(-spacing)
== Purpose
Some text

Notes:

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.

Example Project Structure

project-folder/
├── main.typ
├── template.typ
├── images/
│   ├── figure1.png
│   ├── figure2.png
│   ├── ...
├── ...

2.0 KiB Raw Blame History