|
| 1 | +# Inofficial VDE Template "charged-vde" |
| 2 | +This is an unofficial Typst template for a two-column paper from the proceedings |
| 3 | +of the german VDE. The word template can be found |
| 4 | +[here](https://www.vde-verlag.de/buecher/proceedings/schreibanleitungen.html). |
| 5 | + |
| 6 | +## Usage |
| 7 | +You can use this template in the Typst web app by clicking "Start from template" |
| 8 | +on the dashboard and searching for `charged-vde`. |
| 9 | + |
| 10 | +Alternatively, you can use the CLI to kick this project off using the command |
| 11 | +``` |
| 12 | +typst init @preview/charged-vde |
| 13 | +``` |
| 14 | + |
| 15 | +Typst will create a new directory with all the files needed to get you started. |
| 16 | + |
| 17 | +## Configuration |
| 18 | +This template exports the `vde` function with the following named arguments: |
| 19 | + |
| 20 | +- `title`: The paper's title as content. |
| 21 | +- `authors`: An array of author dictionaries. Each of the author dictionaries |
| 22 | + must have a `name` key and an affiliation id, |
| 23 | +- `affiliations`: Here the affiliations can be named. |
| 24 | +- `emails`: Here the emails of the corresponding author(s) can be listed |
| 25 | +- `lang`: Specify the language, either `en` for English or `de` for German. |
| 26 | +- `abstract`: The abstract of the paper will be pasted here. |
| 27 | + |
| 28 | +The body of the paper comes after the `#show` statement in normal typst syntax. |
| 29 | + |
| 30 | +```typ |
| 31 | +#import "@preview/charged-vde:1.0.0": charged-vde |
| 32 | +
|
| 33 | +#show: charged-vde.with( |
| 34 | + title: [Test], |
| 35 | + authors: ( |
| 36 | + (name: "Max Mustermann", affiliation: "1"), |
| 37 | + (name: "Erika Musterfrau", affiliation: "1,2") |
| 38 | + ), |
| 39 | + affiliations: ( |
| 40 | + (id: "1", name: "University"), |
| 41 | + (id: "2", name: "Company") |
| 42 | + ), |
| 43 | + email: [{max,erika}\@university.de, erika\@company.de], |
| 44 | + lang: "en", |
| 45 | + abstract: [#lorem(100)], |
| 46 | +) |
| 47 | +
|
| 48 | +// Your content goes below. |
| 49 | +
|
| 50 | += Introduction <intro> |
| 51 | +#lorem(150) |
| 52 | +
|
| 53 | +#bibliography("library.bib") |
| 54 | +
|
| 55 | +``` |
| 56 | + |
| 57 | +# License |
| 58 | +The Typst package and the example template, including `image.jpg`, are licensed |
| 59 | +under the "MIT No Attribution" (MIT-0) License. |
0 commit comments