example-deck.md 4.97 KB
Newer Older
Henrik Tramberend's avatar
Henrik Tramberend committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
---
theme: htr-slides
author: Henrik Tramberend
transition: linear
title: Decker Slide Tool
date: 15.5.2016
subtitle: Tutorial and Examples
---

# Overview

-   Features
-   Installation
-   Usage
-   Development

# Features {.section}

# Markdown Syntax

## Pandoc-Markdown

-   Slides are basically [Pandoc-Markdown](http://pandoc.org) formatted text
-   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

- Level 1 header (`#`) starts new slide
- Level 2 header (`##`) starts a block on a slide
- Level 3 header (`###`) starts new column on a slide

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

## A long time ago ...

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

# Multicolumn slides

## The author

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

###

## Slide source

``` {.markdown} 
# Multicolumn slides

## The author

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

###

## Slide source

~~~ {.markdown}

~~~
```

# LaTeX Math

## Syntax

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


## Example

-   To $\infinity$ and beyond!

$$
e = mc^2
$$

# Compile Time Macros

## Macros

-   Appropriated link `[]()` and image `![]()` syntax
-   Example: embed a YouTube video

    ``` {.markdown}
    ## Video

    ![:youtube](Wji-BZ0oCwg)
    ```

###

## Video

![:youtube](Wji-BZ0oCwg)


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

###

## Block styles

- Other block styles include `definition` and `equation`

## Definition {.definition}

$e=mc^2$

## Equation {.equation}

$e=mc^2$

# Speaker Notes

## Slide level

- The slide content becomes part of the speaker notes
- Add `notes` class to slide header

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

    These are speaker notes.
    ```

###

## Block level

- Block content becomes part of the speaker notes
- Add `notes` class to level two header

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

    These are speaker notes too.
    ```

# These are just notes {.notes}

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.

# Cached Images

## Local image cache

Remote images can be cached locally

Cache directory is named `img/cached` and is located in the directory of the
referencing document

`decker cache` scans for and downloads all images

###

## Cached remote image

![Some piece of scene graph](http://mmi-rtr.dev/slides/02-jet-engine/img/cube-scene-graph.png)

# Meta Data

## Mustache template processor

- Markdown source is processed by [mustache]()
- Data is the union of all available YAML files

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


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

-   `*-deck.html` a *reveal.js* based HTML slide deck 
-   `*-deck.pdf` a PDF version of that deck
-   `*-handout.html` a HTML document containing only the speaker notes from the
    deck
-   `*-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`

-   Recursively scans the current directory for Markdown files ending in `.md`

## `decker clean`

## `decker example`

## `decker server`