|
| 1 | +Unofficial template for creating presentations with [Polylux](https://typst.app/universe/package/polylux) in the style of the Faculty of Mathematics at Otto-von-Guericke-University Magdeburg. Some documentation and an introduction to Polylux can be found [here](https://polylux.dev/book/). |
| 2 | + |
| 3 | +The template can be used via: |
| 4 | +```pwsh |
| 5 | +typst init @preview/modern-ovgu-fma-polylux:1.0.0 |
| 6 | +``` |
| 7 | + |
| 8 | +You can also use the template via: |
| 9 | +```typ |
| 10 | +#import "@preview/modern-ovgu-fma-polylux:1.0.0": * |
| 11 | +``` |
| 12 | +and then initialize it with: |
| 13 | +```typ |
| 14 | +#show: ovgu-fma-theme.with( |
| 15 | + author: [Firstname Lastname], |
| 16 | + title: [Presentation Title], |
| 17 | + date: ez-today.today(), |
| 18 | + text-lang: "en", |
| 19 | +) |
| 20 | +``` |
| 21 | +Additional parameters allow further customization. The first three parameters will be passed to the ```#text()``` function. |
| 22 | +```typ |
| 23 | +#show: ovgu-fma-theme.with( |
| 24 | + text-font: "Liberation Sans", |
| 25 | + text-lang: "de", |
| 26 | + text-size: 20pt, |
| 27 | + author: [], |
| 28 | + title: [], |
| 29 | + date: [], |
| 30 | +) |
| 31 | +``` |
| 32 | +The author, title, and date will later be used for the header and footer of the slides. They will be also used for the title slide, if no other parameters are given there. |
| 33 | + |
| 34 | +# Slide Types |
| 35 | +## Title Slide |
| 36 | + |
| 37 | +```typ |
| 38 | +#title-slide( |
| 39 | + author: none, |
| 40 | + date: none, |
| 41 | + title: none, |
| 42 | + subtitle: none, |
| 43 | + max-width: 75%, |
| 44 | + body |
| 45 | +) |
| 46 | +``` |
| 47 | +The values for author, date or title aren't set here, they will be used from the show-rule from the beginning. If you want this values to be empty, then set them to ```[]```. The max-with argument sets the maximal width which the title takes from the page. |
| 48 | + |
| 49 | +## Base Slide |
| 50 | +```typ |
| 51 | +#slide-base( |
| 52 | + heading: none, |
| 53 | + show-section: true, |
| 54 | + block-height: none, |
| 55 | +)[] |
| 56 | +``` |
| 57 | +This is the foundation for all slide types, except the title slide. |
| 58 | +- `heading: content`: serves as the slide title. |
| 59 | +- `show-section: bool`: if true, the current section title is displayed in the footer. |
| 60 | +- `block-height: relative`: if set, it will be used as the height of the main content block. If footnotes are used, you have manually to adjust this to not cause some unwanted page breaks. A good starting value for adjusting is 85%. |
| 61 | + |
| 62 | +Further you could find the different kinds of slides based on this slide-type. |
| 63 | + |
| 64 | +## Outline Slide |
| 65 | + |
| 66 | +```typ |
| 67 | +#let outline-slide( |
| 68 | + heading:none, |
| 69 | +)[] |
| 70 | +``` |
| 71 | +The heading argument will be used for the title in the outline-slide. If set to none some language specific default will be used. (Currently the two supported languages are German and English) |
| 72 | + |
| 73 | +## Header Slide |
| 74 | + |
| 75 | +```typ |
| 76 | +#header-slide()[Examples for content] |
| 77 | +``` |
| 78 | +Headings created with this type of slide will be displayed in the outline slide. To include additional headings in the outline slide, they must be registered manually using: |
| 79 | +```typ |
| 80 | +#toolbox.register-section(head) |
| 81 | +``` |
| 82 | + |
| 83 | + |
| 84 | +## Slide |
| 85 | +This is probably the slide you will use most often. Below are some examples with this slide, which use different kinds of content. |
| 86 | +### Multi-Column Layout |
| 87 | + |
| 88 | +```typ |
| 89 | +#slide( |
| 90 | + heading: [Multi-Column-Folien], |
| 91 | +)[ |
| 92 | + #toolbox.side-by-side()[#lorem(39)][#lorem(30)][#lorem(35)] |
| 93 | +] |
| 94 | +``` |
| 95 | + |
| 96 | +### Using Mathematical Environments |
| 97 | + |
| 98 | +```typ |
| 99 | +#folie( |
| 100 | + heading: [How to use equations], |
| 101 | +)[ |
| 102 | + You could define Equations like this: |
| 103 | + $ a/b = c/d $ |
| 104 | + This equations will be numbered, if you put a lable on it: |
| 105 | + $ a^2 + b^2 = c^2 $ <pythagoras> |
| 106 | + The @pythagoras describes Pythagoras theorem. A proof you could find in @gerwig2021satz. |
| 107 | +] |
| 108 | +``` |
| 109 | + |
| 110 | +### Using an Image |
| 111 | + |
| 112 | +```typ |
| 113 | +#folie( |
| 114 | + block-height: 85%, |
| 115 | +)[ |
| 116 | + #figure( |
| 117 | + caption: [Exampleimage#footnote([Thanks to Malte for creating this image])], |
| 118 | + )[#image("example-image.jpg", height: 70%)] |
| 119 | + You could also use footnotes and images. In the case of Footnotes you have to change the block-height to not cause a pagebreak. |
| 120 | +] |
| 121 | +``` |
| 122 | + |
| 123 | +# Additional Features |
| 124 | +## Numbering Equations |
| 125 | + |
| 126 | +With the show-rule: |
| 127 | + |
| 128 | +```typ |
| 129 | +#show: document => conf-equations(document) |
| 130 | +``` |
| 131 | + |
| 132 | +Only equations with labels will be numbered. To use this feature, add this command at the beginning of your presentation. |
| 133 | + |
| 134 | +# Hints for usage |
| 135 | +## Mathematical Symbols |
| 136 | + |
| 137 | +If you don't know the command for a mathematical symbol, the website [detypify](https://detypify.quarticcat.com/) is very helpful. You can simply draw the symbol there, and the corresponding command will be suggested. |
| 138 | + |
| 139 | +## Animations |
| 140 | + |
| 141 | +Polylux offers a feature to gradually reveal content on a slide using the command: |
| 142 | + |
| 143 | +```typ |
| 144 | +#show: later |
| 145 | +``` |
| 146 | + |
| 147 | +There are several additional commands for animations, all of which can be found in the [Polylux book](https://polylux.dev/book/dynamic/helper.html#higher-level-helper-functions). |
| 148 | + |
| 149 | +## Creating a Handout from the Presentation |
| 150 | + |
| 151 | +If the following command is placed at the beginning of the code: |
| 152 | + |
| 153 | +```typ |
| 154 | +#enable-handout-mode(true) |
| 155 | +``` |
| 156 | + |
| 157 | +Animations will be ignored, and the presentation will be printed as a handout. |
| 158 | + |
0 commit comments