Skip to content

Commit 303e84b

Browse files
mewmewmewmew
committed
uni-report:0.1.0
1 parent e11dc53 commit 303e84b

File tree

9 files changed

+304
-0
lines changed

9 files changed

+304
-0
lines changed

‎packages/preview/uni-report/0.1.0/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.pdf
2+
*.txt

‎packages/preview/uni-report/0.1.0/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Lab report, essay and exam template for Uni
2+
3+
## Example document
4+
5+
```bash
6+
# Generate new report based on template.
7+
typst init @preview/uni-report
8+
```
9+
10+
![Example lab report](inc/thumbnail.png)
11+
12+
## Logo
13+
14+
The default logo used the template is the [Stockholm University logotype](https://medarbetare.su.se/en/our-su/communicate-su/graphic-profile/logotype). It is goverened by copyright. Replace it with the logo of your University.

‎packages/preview/uni-report/0.1.0/inc/default_logo.png‎

24.2 KB
Loading

‎packages/preview/uni-report/0.1.0/inc/thumbnail.png‎

197 KB
Loading

‎packages/preview/uni-report/0.1.0/src/lib.typ‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
#import "@preview/latex-lookalike:0.1.4"
2+
3+
#import "@preview/nth:1.0.1": nth
4+
5+
// This function gets your whole document as its `body` and formats it as a lab
6+
// report.
7+
#let template(
8+
logo: image("/inc/default_logo.png", width: 4.3cm),
9+
title: "Lab report",
10+
sub-title: none,
11+
short-title: none,
12+
course-name: none,
13+
course-code: none,
14+
course-part: none,
15+
lab-name: none,
16+
author: none,
17+
lab-partners: none,
18+
lab-supervisor: none,
19+
lab-group: none,
20+
lab-date: none,
21+
22+
// Report contents.
23+
body,
24+
) = {
25+
// Set document metadata.
26+
set document(title: title)
27+
28+
// Set page size and margins.
29+
set page(
30+
paper: "a4",
31+
margin: (x: 2.5cm, top: 3.1cm, bottom: 3.55cm),
32+
header: {
33+
grid(
34+
columns: (2fr, 1fr, 2fr),
35+
align: (left, center, right),
36+
inset: (bottom: 5pt),
37+
// left
38+
course-code,
39+
// middle
40+
short-title,
41+
//right
42+
author,
43+
grid.hline(stroke: 0.4pt),
44+
)
45+
},
46+
)
47+
48+
// Set default font.
49+
set text(font: "New Computer Modern")
50+
51+
set text(size: 1.05em)
52+
53+
set par(justify: true)
54+
55+
// Use arabic numbering of headings.
56+
set heading(numbering: "1.1")
57+
58+
// Style outline as LaTeX "Table of contents".
59+
show outline: latex-lookalike.style-outline
60+
61+
// Style headings with "1.1" numbering and increased spacing.
62+
show heading: latex-lookalike.style-heading
63+
64+
// Style links and citations.
65+
let linkblue = rgb(66, 93, 178)
66+
show link: it => {
67+
set text(fill: linkblue) if type(it.dest) == str // style external links
68+
it
69+
}
70+
show cite: set text(fill: linkblue)
71+
72+
// raw figures
73+
show figure.where(kind: raw): set figure.caption(position: top)
74+
75+
show figure: outer => {
76+
let alignment = left
77+
if outer.kind == table or outer.kind == raw {
78+
alignment = center
79+
}
80+
show figure.caption: it => align(
81+
alignment,
82+
[
83+
#strong[#it.supplement #context it.counter.display(it.numbering)#it.separator]
84+
#it.body
85+
]
86+
)
87+
outer
88+
}
89+
90+
set bibliography(title: "References")
91+
92+
// === [ Front matter ] =====================================================
93+
94+
// --- [ Front page ] -------------------------------------------------------
95+
96+
page(
97+
numbering: none,
98+
header: none,
99+
margin: (x: 1.55cm, top: 3.1cm, bottom: 3.55cm),
100+
)[
101+
#grid(
102+
columns: (5.10cm, 1fr),
103+
gutter: 3pt,
104+
grid.vline(x: 1, stroke: 0.4pt + black),
105+
// left cell (logo)
106+
logo,
107+
// right cell (title)
108+
block(height: 100%, inset: 2.1em)[
109+
#v(6.1cm)
110+
#if course-name != none { text(size: 1.2em)[ #course-name \ ] }
111+
#if course-code != none { text(size: 1.2em)[ (#course-code) ] }
112+
113+
// title
114+
#text(size: 2.1em, weight: "bold", title)
115+
116+
// subtitle
117+
#if sub-title != none { v(-1.5em) + text(size: 1.5em, weight: "bold", sub-title) }
118+
119+
// date
120+
#text(size: 1.2em, {
121+
let today = datetime.today()
122+
nth(today.display("[day padding:none]"))
123+
today.display(" [month repr:long] [year]")
124+
})
125+
126+
#v(1fr)
127+
128+
#let cells = ()
129+
#if course-name != none {
130+
cells.push([Course:])
131+
cells.push([#course-name])
132+
}
133+
#if course-part != none {
134+
cells.push([Course part:])
135+
cells.push([#course-part])
136+
}
137+
#if lab-name != none {
138+
cells.push([Lab:])
139+
cells.push([#lab-name])
140+
}
141+
#if author != none {
142+
cells.push([Author:])
143+
cells.push([#author])
144+
}
145+
#if lab-partners != none {
146+
cells.push([Lab partner(s):])
147+
cells.push([#lab-partners.join(", ", last: " and ")])
148+
}
149+
#if lab-supervisor != none {
150+
cells.push([Lab supervisor:])
151+
cells.push([#lab-supervisor])
152+
}
153+
#if lab-group != none {
154+
cells.push([Lab group:])
155+
cells.push([#lab-group])
156+
}
157+
#if lab-date != none {
158+
cells.push([Lab date:])
159+
cells.push([#lab-date])
160+
}
161+
#block(inset: 0.4em)[
162+
#grid(
163+
columns: (auto, 1fr),
164+
gutter: 10pt,
165+
..cells,
166+
)
167+
]
168+
],
169+
)
170+
]
171+
172+
pagebreak(weak: true)
173+
174+
// --- [ Table of contents ] ------------------------------------------------
175+
176+
set page(numbering: "i")
177+
counter(page).update(1)
178+
179+
outline()
180+
pagebreak(weak: true)
181+
182+
183+
// --- [ Main matter ] ------------------------------------------------------
184+
185+
set page(numbering: "1")
186+
counter(page).update(1)
187+
188+
body
189+
}

‎packages/preview/uni-report/0.1.0/template/inc/logo.png‎

24.2 KB
Loading

‎packages/preview/uni-report/0.1.0/template/references.bib‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@book{2020_molecular_biology_principles_of_genome_function_craig,
2+
title={Molecular biology: principles of genome function},
3+
author={Craig, Nancy and Green, Rachel and Cohen-Fix, Orna and Greider, Carol and Storz, Gisela and Wolberger, Cynthia},
4+
year={2020},
5+
publisher={Oxford University Press}
6+
}

‎packages/preview/uni-report/0.1.0/template/report.typ‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
#import "@preview/uni-report:0.1.0"
2+
3+
#show: uni-report.template.with(
4+
logo: image("inc/logo.png", width: 4.3cm),
5+
title: highlight[Lab 1 -- Experiment],
6+
short-title: highlight("Lab 1"),
7+
course-name: highlight("Course Name"),
8+
course-code: highlight("AA1234"),
9+
//course-part: "",
10+
lab-name: highlight("Experiment"),
11+
author: highlight("Jane Rue"),
12+
lab-partners: (highlight("John Doe"),),
13+
//lab-supervisor: "",
14+
lab-group: highlight("Group 1"),
15+
lab-date: datetime.today().display(), // "2025-06-29"
16+
)
17+
18+
// === [ quote ] ===============================================================
19+
20+
#quote(
21+
block: true,
22+
attribution: [anonymous],
23+
)[
24+
#emph["Chemistry is all around us."]
25+
]
26+
27+
// === [ Introduction ] ========================================================
28+
29+
= Introduction
30+
31+
This lab covers #highlight([foo])
32+
33+
== Purpose
34+
35+
#lorem(10)
36+
37+
== Theory
38+
39+
#lorem(10) @2020_molecular_biology_principles_of_genome_function_craig
40+
41+
$ "H" + "O" #sym.arrow.not "H"_(2)"O" $
42+
43+
$ 2"H"_2 + 2"O" #sym.arrow 2"H"_(2)"O" $
44+
45+
== Equations used in the lab
46+
47+
#lorem(10)
48+
49+
#pagebreak(weak: true)
50+
51+
// === [ Methods ] =============================================================
52+
53+
= Methods
54+
55+
#lorem(10)
56+
57+
#pagebreak(weak: true)
58+
59+
// === [ Results ] =============================================================
60+
61+
= Results
62+
63+
#lorem(10)
64+
65+
#pagebreak(weak: true)
66+
67+
// === [ Discussion ] ==========================================================
68+
69+
= Discussion
70+
71+
#lorem(10)
72+
73+
#pagebreak(weak: true)
74+
75+
// === [ Bibliography ] ========================================================
76+
77+
#bibliography("references.bib")
78+
79+
#pagebreak(weak: true)

‎packages/preview/uni-report/0.1.0/typst.toml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[package]
2+
name = "uni-report"
3+
version = "0.1.0"
4+
entrypoint = "src/lib.typ"
5+
authors = ["Robin Eklind"]
6+
license = "0BSD"
7+
description = "Lab report, essay and exam template for Uni."
8+
exclude = ["inc"]
9+
repository = "https://github.com/mewmew/uni-report-typ"
10+
11+
[template]
12+
path = "template"
13+
entrypoint = "report.typ"
14+
thumbnail = "inc/thumbnail.png"

0 commit comments

Comments
 (0)