example-deck.md 5.7 KB
Newer Older
Henrik Tramberend's avatar
Henrik Tramberend committed
1
2
---
author: Henrik Tramberend
3
date: '15.5.2016'
4
history: True
5
signs: © €
Henrik Tramberend's avatar
Henrik Tramberend committed
6
subtitle: Tutorial and Examples
7
8
9
theme: 'htr-slides'
title: Decker Slide Tool
transition: linear
Henrik Tramberend's avatar
Henrik Tramberend committed
10
ümläüte: Ümläüte
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
# Includes

## Include markdown files

58
The following text is included from file `/resource/realtive.md`:
Henrik Tramberend's avatar
Henrik Tramberend committed
59

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
67
68
![](img/htr-beuth.jpg){width="50%"}![](https://tramberend.beuth-hochschule.de/img/htr-beuth.jpg){width="50%"}

[Deck markdown source](example-deck.md)
Henrik Tramberend's avatar
Henrik Tramberend committed
69

70
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
71
72
73

## Slide source

74
``` {.markdown}
Henrik Tramberend's avatar
Henrik Tramberend committed
75
76
77
78
# Multicolumn slides

## The author

79
![](img/htr-beuth.jpg){data-src="img/htr-beuth.jpg"}
Henrik Tramberend's avatar
Henrik Tramberend committed
80
81
82
83
84
85

###

## Slide source

~~~ {.markdown}
86
...
Henrik Tramberend's avatar
Henrik Tramberend committed
87
88
89
~~~
```

90
91
92
93
# Local Images

## Relative path

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

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

## Syntax

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

## Example

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

$$
e = mc^2
$$

# Compile Time Macros

## Macros

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

    ``` {.markdown}
    ## Video

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

125
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
126
127
128

## Video

129
[:youtube](Wji-BZ0oCwg)
Henrik Tramberend's avatar
Henrik Tramberend committed
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
172
173

# 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`
```

174
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
175
176
177

## Block styles

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

## Definition {.definition}

$e=mc^2$

## Equation {.equation}

$e=mc^2$

# Speaker Notes

## Slide level

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

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

    These are speaker notes.
    ```

201
### 
Henrik Tramberend's avatar
Henrik Tramberend committed
202
203
204

## Block level

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

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

    These are speaker notes too.
    ```

# These are just notes {.notes}

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
Cache directory is named `img/cached` and is located in the directory of the referencing document
Henrik Tramberend's avatar
Henrik Tramberend committed
225
226
227

`decker cache` scans for and downloads all images

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

## Cached remote image

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

234
235
## Not really!

236
-   Caching is currently disabled
237

Henrik Tramberend's avatar
Henrik Tramberend committed
238
239
240
241
# Meta Data

## Mustache template processor

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

# 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
268
269
270
271
# Encoding

## UTF-8 encoding for everything

272
273
-   Markdown source files are assumed to be UTF-8 encoded
-   YAML metadata also
Henrik Tramberend's avatar
Henrik Tramberend committed
274
275
276

## German Umlaute

277
-   ÄÖÜäöüßß
Henrik Tramberend's avatar
Henrik Tramberend committed
278
279
280

## Substituted meta data

281
282
-   Umlaute: {{ümläüte}}
-   Signs: {{signs}}
Henrik Tramberend's avatar
Henrik Tramberend committed
283

Henrik Tramberend's avatar
Henrik Tramberend committed
284
285
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
# `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`

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

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

## `decker clean`

## `decker example`

## `decker server`