Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avonmoll/ifacconf-typst
unofficial IFAC conference template for Typst
https://github.com/avonmoll/ifacconf-typst
Last synced: 6 days ago
JSON representation
unofficial IFAC conference template for Typst
- Host: GitHub
- URL: https://github.com/avonmoll/ifacconf-typst
- Owner: avonmoll
- License: mit-0
- Created: 2023-11-17T18:10:52.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-21T19:15:12.000Z (8 months ago)
- Last Synced: 2024-08-02T06:17:11.949Z (3 months ago)
- Language: Typst
- Homepage:
- Size: 436 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-typst - ifacconf-typst - A template for creating conference papers in the style of the International Federation of Automatic Control (Templates & Libraries / Physics)
README
# abiding-ifacconf
(unofficial) IFAC Conference Template for Typst
IFAC stands for [International Federation of Automatic Control](https://ifac-control.org/).
This repository is meant to be a port of the existing author tools for conference papers (e.g., for LaTeX, see [ifacconf_latex.zip](https://www.ifac-control.org/conferences/author-guide/copy_of_ifacconf_latex.zip/view)) for Typst.
## Usage
Running the following command will create a new directory with all the files that are needed:
```
typst init @preview/abiding-ifacconf
```
## Configuration
This template exports the `ifacconf` function with the following named arguments:
- `authors`: (default: ()) array of authors. For each author you can specify a name, email (optional), and affiliation. The affiliation must be an integer corresponding to an entry in the 1-indexed affiliations list (or 0 for no affiliation).
- `affiliations`: (default: ()) array of affiliations. For each affiliation you can specify a department, organization, and address. Everything is optional (i.e., an affiliation can be an empty array).
- `abstract`: (default: none) the paper's abstract. Can be omitted if you don't have one.
- `keywords`: (default: ()) array of keywords to display after the abstract
- `sponsor`: (default: none) acknowledgment of sponsor or financial support (appears as a footnote on the first page)
## Minimal Working Example
```typst
#import "@preview:abiding-ifacconf:0.1.0": *
#show: ifacconf-rules
#show: ifacconf.with(
title: "Minimal Working Example",
authors: (
(
name: "First A. Author",
email: "[email protected]",
affiliation: 1,
),
),
affiliations: (
(
department: "Engineering",
organization: "National Institute of Standards and Technology",
address: "Boulder, CO 80305 USA",
),
),
abstract: [
Abstract should be 50-100 words.
],
keywords: ("keyword1", "keyword2"),
sponsor: [
Sponsor information.
],
)
= Introduction
A minimum working example (with bibliography) @Abl56.
#lorem(80)
#lorem(80)
#bibliography("refs.bib")
```
## Full(er) Example
See [`main.typ`](https://github.com/avonmoll/ifacconf-typst/blob/main/template/main.typ).
## Dependencies
- typst 0.11.0
- ctheorems 1.1.0 (a Typst package for handling theorem-like environments)
## Notes, features, etc.
- the call to `#show: ifacconf-rules` is necessary for some show rules defined in `template.typ` to get activated
- `ifac-conference.csl` is a lightly modified version of `apa.csl` and is included in order to change the citation format from, e.g., `(Able 1956)` to `Able (1956)` in order to match `ifacconf_latex`
- Tables have formatting rules that get activated inside calls to `figure` with `kind: "table"`; a convenience function `tablefig` is provided which sets this automatically
- all theorem-like environments that were available in `ifacconf_latex` are defined in `template.typ`; simply call, for example, `#theorem[Content...] ... #proof[Proof...]`
- the LaTeX version does not include a QED symbol at the end of proofs, however one is included here (this is easy to change)
- Typst did not seem to like BibTeX citation keys containing colons (which was how they came from `ifacconf_latex`)
- alignment for linebreaks in long equations is somewhat manual (e.g., for equation (2) in `ifacconf.typ`) but probably there is a better way to handle this now or in the future
- the files `refs.bib` (essentially) and `bifurcation.jpg` come from `ifacconf_latex`
- the file `template/main.typ` is modeled directly after `ifacconf.tex` by Juan a. de la Puente
- the `citep` function renders citations like `(Keohane, 1958)` instead of the default style of `Keohane (1958)`
## License
This template is licensed according to the MIT No Attribution license (see `LICENSE.MD`).
The files in the `CSL` folder are licensed according to `CSL/LICENSE.md` (CC BY/SA 4.0) because it is a lightly modified version of `apa.csl` by Brenton M. Wiernik which is also licensed by a CC BY/SA license.