example-deck.md 5.54 KB
Newer Older
Henrik Tramberend's avatar
Henrik Tramberend committed
1
2
---
author: Henrik Tramberend
3
date: '15.5.2016'
4
history: True
Henrik Tramberend's avatar
Henrik Tramberend committed
5
subtitle: Tutorial and Examples
6
7
8
theme: 'htr-slides'
title: Decker Slide Tool
transition: linear
Henrik Tramberend's avatar
Henrik Tramberend committed
9
10
ümläüte: Ümläüte
signs: © €
Henrik Tramberend's avatar
Henrik Tramberend committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
---

# Overview

-   Features
-   Installation
-   Usage
-   Development

# Features {.section}

# Markdown Syntax

## Pandoc-Markdown

26
-   Slides are basically [Pandoc-Markdown](http://pandoc.org) formatted text
Henrik Tramberend's avatar
Henrik Tramberend committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
-   Pandoc provides a Markdown variant with many extensions

## Some Pandoc extensions

-   Bibliographies
-   Footnotes
-   Tables
-   Figures with captions
-   Code blocks with syntax highlighting
-   LaTeX math typesetting

# Slides

## Markdown header

42
43
44
-   Level 1 header (`#`) starts new slide
-   Level 2 header (`##`) starts a block on a slide
-   Level 3 header (`###`) starts new column on a slide
Henrik Tramberend's avatar
Henrik Tramberend committed
45
46
47
48
49
50
51
52
53

``` {.markdown}
# Episode IV: A new Slide

## A long time ago ...

... in a galaxy far, far away.
```

Henrik Tramberend's avatar
Henrik Tramberend committed
54
55
56
57
58
59
# Includes

## Include markdown files

The following text ist included from file `/resource/realtive.md`:

60
[\#include](include/relative.md)
Henrik Tramberend's avatar
Henrik Tramberend committed
61

Henrik Tramberend's avatar
Henrik Tramberend committed
62
63
64
65
# Multicolumn slides

## The author

66
![](img/htr-beuth.jpg)
Henrik Tramberend's avatar
Henrik Tramberend committed
67

68
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
69
70
71

## Slide source

72
``` {.markdown}
Henrik Tramberend's avatar
Henrik Tramberend committed
73
74
75
76
77
78
79
80
81
82
83
# Multicolumn slides

## The author

![](img/htr-beuth.jpg)

###

## Slide source

~~~ {.markdown}
84
...
Henrik Tramberend's avatar
Henrik Tramberend committed
85
86
87
~~~
```

88
89
90
91
# Local Images

## Relative path

92
![](img/06-metal.png){width="75%"}
93

Henrik Tramberend's avatar
Henrik Tramberend committed
94
95
96
97
98
99
100
101
102
103
# LaTeX Math

## Syntax

-   Standard LaTeX syntax
-   Single \$ encloses inline math
-   Double \$\$ encloses a display math block

## Example

104
-   To $\infty$ and beyond!
Henrik Tramberend's avatar
Henrik Tramberend committed
105
106
107
108
109
110
111
112
113

$$
e = mc^2
$$

# Compile Time Macros

## Macros

Henrik Tramberend's avatar
Henrik Tramberend committed
114
-   Appropriated link `[Link text](Url)` and image `![Alt text](Url)` syntax
Henrik Tramberend's avatar
Henrik Tramberend committed
115
116
117
118
119
-   Example: embed a YouTube video

    ``` {.markdown}
    ## Video

120
    [:youtube](Wji-BZ0oCwg)
Henrik Tramberend's avatar
Henrik Tramberend committed
121
122
    ```

123
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
124
125
126

## Video

127
[:youtube](Wji-BZ0oCwg)
Henrik Tramberend's avatar
Henrik Tramberend committed
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

# Compile Time Templating

## Mustache templates

-   Markdown source code is processed with Mustache

    ``` {.markdown}
    {{=<% %>=}}
    The current semester is {{semester}}
    <%={{ }}=%>
    ```

-   Data is provided in YAML files

    ``` {.yaml}
    ---
    semester: Summer 2016
    ---
    ```

-   Results in

    ``` {.markdown}
    The current semester is Summer 2016
    ```

# Blocks

## Block markup

-   Level 2 headers start new block
-   Blocks can be marked with attributes

## Alert block {.alert}

-   This block is marked `alert`

``` {.markdown}
## Alert block {.alert}

- This block is marked `.alert`
```

172
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
173
174
175

## Block styles

176
-   Other block styles include `definition` and `equation`
Henrik Tramberend's avatar
Henrik Tramberend committed
177
178
179
180
181
182
183
184
185
186
187
188
189

## Definition {.definition}

$e=mc^2$

## Equation {.equation}

$e=mc^2$

# Speaker Notes

## Slide level

190
191
-   The slide content becomes part of the speaker notes
-   Add `notes` class to slide header
Henrik Tramberend's avatar
Henrik Tramberend committed
192
193
194
195
196
197
198

    ``` {.markdown}
    # Slide Level {.notes}

    These are speaker notes.
    ```

199
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
200
201
202

## Block level

203
204
-   Block content becomes part of the speaker notes
-   Add `notes` class to level two header
Henrik Tramberend's avatar
Henrik Tramberend committed
205
206
207
208
209
210
211
212
213

    ``` {.markdown}
    ## Block level {.notes}

    These are speaker notes too.
    ```

# These are just notes {.notes}

214
215
216
Slides with headers that are have the `.notes` class attribute are not included
in the presentation. They are only visible in the handout and probably are
available as presenter notes during slide presentation.
Henrik Tramberend's avatar
Henrik Tramberend committed
217
218
219
220
221
222
223

# Cached Images

## Local image cache

Remote images can be cached locally

224
225
Cache directory is named `img/cached` and is located in the directory of the
referencing document
Henrik Tramberend's avatar
Henrik Tramberend committed
226
227
228

`decker cache` scans for and downloads all images

229
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
230
231
232

## Cached remote image

233
234
![Some piece of scene
graph](https://tramberend.beuth-hochschule.de/img/cg1-banner.png)
Henrik Tramberend's avatar
Henrik Tramberend committed
235

236
237
238
239
## Not really!

- Caching is currently disabled

Henrik Tramberend's avatar
Henrik Tramberend committed
240
241
242
243
# Meta Data

## Mustache template processor

244
245
-   Markdown source is processed by [mustache]()
-   Data is the union of all available YAML files
Henrik Tramberend's avatar
Henrik Tramberend committed
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269

# Meta Data Example

## Markdown source

``` {.markdown}
Your total score is {\{total.score}}.
```

## YAML data

``` {.yaml}
---
total:
    score: 42
...
```

## Result

``` {.html}
Your total score is 42.
```

Henrik Tramberend's avatar
Henrik Tramberend committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# Encoding

## UTF-8 encoding for everything

- Markdown source files are assumed to be UTF-8 encoded
- YAML metadata also

## German Umlaute

- ÄÖÜäöüßß

## Substituted meta data

- Umlaute: {{ümläüte}}
- Signs: {{signs}}

Henrik Tramberend's avatar
Henrik Tramberend committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# `decker` Tool {.section}

# `decker` Tool

## Command line tool

-   Statically linked, no library dependencies
-   Easy to deploy, just copy the executable
-   Self-contained, no support or data files
-   Not configurable, conventions are key

## Implemented using

-   [Haskell](http://haskell.org)
-   [Pandoc](), [Shake](), [Mustache](), [reveal.js]()
-   [LaTeX](), [livereloadx](), [decktape.sh]()

# `decker` Targets

## Specialized build tool

-   `decker` is like `make` without the makefile
-   Operates on the current directory and below
-   Considers Markdown text files and YAML data files

## `decker` source files

-   `*-deck.md` is a slide deck
-   `*-page.md` is a one page document styled like an article
-   `*.md` is a general document without any semantic attached

# `decker` generated targets

## Generated from `*-deck.md`

321
-   `*-deck.html` a *reveal.js* based HTML slide deck
Henrik Tramberend's avatar
Henrik Tramberend committed
322
-   `*-deck.pdf` a PDF version of that deck
323
324
-   `*-handout.html` a HTML document containing only the speaker notes from the
    deck
Henrik Tramberend's avatar
Henrik Tramberend committed
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
-   `*-handout.pdf` a PDF version of that handout

## Generated from `*-page.md`

-   `*-page.hml` a HTML article page
-   `*-page.pdf` a PDF version of that article

# Slide Header

# Installation {.section}

# Usage {.section}

# Decker Commands

## `decker`

342
-   Recursively scans the current directory for Markdown files ending in `.md`
Henrik Tramberend's avatar
Henrik Tramberend committed
343
344
345
346
347
348

## `decker clean`

## `decker example`

## `decker server`