Just
Jotta sinun, opiskelijan, ei tarvitse muistaa suurta määrää erilaisia komentoja, yleisimmät ovat koottu yhtee Justfile-tiedostoon. Tämän tiedoston avulla voit suorittaa komentoja yksinkertaisesti kirjoittamalla just <komento> terminaaliin. Typst package repositoryn säännöt estävät Justfile-tiedoston julkaisemisen Typst Universeen, joten sen sisältö ylläpidetään tässä ohjeessa. Kopioi sisältö omaan projektiisi, mikäli haluat hyötyä lyhennetyistä komennoista.
Asennus
Just:n oletus on, että järjestelmästä löytyy sh (eli UNIX Shell yhteensopiva komentotulkki). Linux ja macOS käyttöjärjestelmistä tämä löytyy hyvinkin natiivisti. Windowsissa se pitää asentaa, mutta se asentuu Git for Windowsin mukana. Kunhan kutsut just-komentoa Git Bash terminaalissa, sinulla on siis kaikki hyvin.
Asennusohjeet löytyvät Just Manuaalista tai Just GitHub-sivulta.
Justfile
Tiedoston sisältö
# Variables
ENTRY_FILE := "thesis.typ"
OUT_DIR := "build"
OUT_FILE := OUT_DIR + "/thesis.pdf"
# Draft will be written to build/thesis-draft-YYYY-MM-DD.pdf and use the PDF/UA-1 standard.
OUT_DRAFT_FILE := OUT_DIR + "/thesis-draft-" + datetime("%Y-%m-%d") + ".pdf"
# Default recipe: list all available recipes
default:
@just --list
# Render a update-on-save preview of the thesis PDF.
watch:
mkdir -p {{OUT_DIR}}
typst watch --root . {{ENTRY_FILE}} {{OUT_FILE}}
# Render a date-versioned one-off build of the thesis PDF (PDF/UA-1 compliant)
draft:
mkdir -p {{OUT_DIR}}
typst compile --root . --pdf-standard ua-1 {{ENTRY_FILE}} {{OUT_DRAFT_FILE}}
@echo "Draft build successful: {{OUT_DRAFT_FILE}}"
Kopioi yllä oleva sisältö oman projektisi juureen, samaan hakemistoon, missä thesis.typ sijaitsee. Tämän jälkeen voit ajaa komentoja alla neuvotulla tavalla.
Komentojan ajaminen
Käyttö on helppoa kuin heinänteko. Kirjoita siinä hakemistossa, missä tämän projektin Justfile sijaitsee, terminaaliin:
Komento listaa kaikki käytettävissä olevat komennot. Komentoja voi ajaa yksinkertaisesti kirjoittamalla:
Tärkeimmät komennot
Tyypilliset komennot, joita opiskelija tarvitsee, ovat:
just watch- Komento, joka päivittää PDF-tiedostoa aina kun lähdetiedostoja muokataan. Tätä käytät opinnäytetyötä kirjoittaessasi.just draft- Komento, joka luo versionumeroidun PDF/UA-1 standardin mukaisen PDF-tiedoston. Tätä käytät, kun haluat lähettää opinnäytetyösi tarkastettavaksi.
Omien komentojen lisääminen
On täysin sallittua lisätä sinulle hyödyllisiä komentoja Justfile-tiedostoon. Alla on ehdotus komennosta, joka voi olla hyödyllinen:
# Open in Skim (macOS)
skim:
open -a Skim {{OUT_FILE}}
# Open in Ubuntu default Document Viewer
dc:
gio open {{OUT_FILE}} > /dev/null 2>&1
Alla toinen, josta voi olla hyötyä, jos haluat varmistaa että kaikki PNG-kuvat ovat maksimissaan x pikseliä pidemmältä sivultaan: