Package Information
- Last Updated
- Authors
- Jian Wei Cheong
- Categories
- reportpaper
- Dependencies
- @preview/drafting:0.2.2
Preview
1. Get the package
Download the package using the TPIX CLI:
tpix get @preview/toffee-tufte:0.1.12. Initialize from template
Create a new project from this template:
typst init @preview/toffee-tufte:0.1.1toffee-tufte
This template was inspired by the style of Edward Tufte's handouts and books.
By keeping the large right margin for sidenotes, but changing the design language, this template aims to maintain the practicality of a sidenote-centric document, while having a more familiar look for scientific and engineering fields.
Usage
Refer to the usage guide for more information.
#import "@preview/toffee-tufte:0.1.1": *
#show: template.with(
title: [This is a title],
authors: "John Doe",
)
These are the 11 options and their default values:
title: content | none = none,authors: array | none | str = none,date: str =, abstract: none = none,toc: bool = false,full: bool | state = false,header: bool | true,footer: bool | true,header-content: none = none,footer-content: none = none,bib: [bib content] | none = none,
Full width mode
In addition to the default Tufte-style format as shown in this document, this template also provides the option to become a full width document by setting full: true.
Doing so will turn all contents placed in the right margin to footnotes automatically.
Sidenote
Places a sidenote at the right margin.
Iffulltemplate option is set totrue, becomes a footnote instead.
dy: auto | length = autoVertical offset.numbered: bool = trueInsert a superscript number.body: contentRequired. The content of the sidenote.
Sidenotes can be placed easily with
#sidenote[This is a sidenote content.]
Sidenote citation
Places a sidenote at the right margin.
Iffulltemplate option is set totrue, becomes a footnote instead.
Only display whenbibliographyis defined.
dy: auto | length = autoVertical offset.form: none | str = "normal"Form of in-text citation.style: [csl] | auto | bytes | str = autoCitation style.supplement: content | none = noneCitation supplement.key: cite-labelRequired. The citation key.
Sidenote citations can be placed easily with
#sidecite(<EinsteinEPR1935>)
Wideblock
Wrapped content will span the full width of the page.
content: content | noneRequired. The content to span the full width.
Wideblocks can be used with
#wideblock[This content spans the entire width of the document.]