-
Notifications
You must be signed in to change notification settings - Fork 0
/
slides.html
849 lines (708 loc) · 24.9 KB
/
slides.html
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>How to teach using org-mode for fun and profit</title>
<meta name="author" content="(Olivier Berger)"/>
<meta name="description" content="Olivier Berger's org-mode framework for teaching"/>
<style type="text/css">
.underline { text-decoration: underline; }
</style>
<link rel="stylesheet" href="./reveal.js/css/reveal.css"/>
<link rel="stylesheet" href="./reveal.js/css/theme/simple.css" id="theme"/>
<link rel="stylesheet" href="./presentation.css"/>
<!-- If the query includes 'print-pdf', include the PDF print sheet -->
<script>
if( window.location.search.match( /print-pdf/gi ) ) {
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = './reveal.js/css/print/pdf.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
}
</script>
<meta name="copyright" content="Teaching with org-mode / org-reveal for fun and profit -- Olivier Berger -- 2016-2018" />
</head>
<body>
<div class="reveal">
<div class="slides">
<section id="sec-title-slide"><h1 class="title">Example lesson<h1><h2>How to teach using org-mode for fun and profit</h2><h2></h2><h3>Olivier Berger<h3><h3 class="date">2018-04-23</h3>
</section>
<section id="table-of-contents">
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#/slide-orgb11ee1a">Introduction</a></li>
<li><a href="#/slide-org8d697fb">This is a HTML slides deck</a></li>
<li><a href="#/slide-org58e5d24">Org-mode powa</a></li>
<li><a href="#/slide-orgbe8241c">About this slides deck</a></li>
<li><a href="#/slide-orgec55b2f">Features</a></li>
<li><a href="#/slide-org3aa1c8f">Authoring</a></li>
<li><a href="#/slide-orgb25cb7c">How it works / Installation</a></li>
<li><a href="#/slide-org4e6d2ef">Annex</a></li>
</ul>
</div>
</div>
</section>
<section>
<section id="slide-orgb11ee1a">
<h2 id="orgb11ee1a">Introduction</h2>
<p>
This is a demo document about the
<a href="http://www-public.tem-tsp.eu/~berger_o/org-teaching/">codename <code>org-teaching</code></a>
framework, which aims at managing teaching material using Org-mode.
</p>
</section>
</section>
<section>
<section id="slide-org8d697fb">
<h2 id="org8d697fb">This is a HTML slides deck</h2>
<ul>
<li class="fragment appear"><i>You're viewing a <a href="http://lab.hakim.se/reveal-js/">reveal.js</a> Web slides deck. You may press 's' to view presenter notes.</i></li>
</ul>
<aside class="notes">
<p>
You'll find the source code at Gitlab : <a href="https://gitlab.com/olberger/org-teaching">https://gitlab.com/olberger/org-teaching</a>
</p>
<p>
I mention <i>codename</i> <code>org-teaching</code> because it really hasn't yet a proper name, and may never have. This is far from a full fledged product.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org58e5d24">
<h2 id="org58e5d24">Org-mode powa</h2>
<p>
Attention, this framework heavily relies on:
</p>
<ul>
<li><a href="http://orgmode.org/">org-mode</a> (version 9 at the time of writing)</li>
<li>and the <a href="https://github.com/yjwen/org-reveal/">org-reveal</a> exporter for <code>reveal.js</code>.</li>
</ul>
<aside class="notes">
<p>
Since Org-mode is plain text, you may be able to edit contents without
Emacs and org-mode, but I'd recommend learning org-mode for serious
work ;-)
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orgbe8241c">
<h2 id="orgbe8241c">About this slides deck</h2>
<p>
These slides are one variant of the same teaching material, also
available <a href="./handbook.pdf">as a PDF handbook</a>.
</p>
<p>
You may prefer to view them in your Web browser in full-screen (<code>F11</code>
for instance). Should <code>Reveal-JS</code> fail on displaying slides, an
alternate format would be the <a href="./slides.pdf">printed PDF</a> (but
you're gonna lose the ability to display speaker notes).
</p>
<aside class="notes">
<p>
This section is displayed only in the slides variant, but not in the <i>handbook</i> variant, which contains, in turn, a section that is different.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orgec55b2f" data-background="#dbdbed" class="center">
<h2 id="orgec55b2f">Features</h2>
</section>
</section>
<section>
<section id="slide-org5621d25">
<h3 id="org5621d25">Writing teaching material in org-mode</h3>
<p>
The goal is to be able to edit a single file (namely <code>lesson.org</code>)
which will contain, in a <b>single source</b>, all the content of a lesson,
written with org-mode syntax.
</p>
<p>
From this single source, several documents are generated :
</p>
<ul>
<li><b>slides</b> (as a dynamic Web document) for overhead presentation</li>
<li>a <b>handbook</b> that contains the same information (or more) and can be
handed to the <span class="underline">students</span> for work outside the classroom (a <a href="handbook.pdf">PDF file</a>)</li>
</ul>
</section>
<section id="slide-org5621d25-split">
<ul>
<li>optionaly, another version of the <b>handbook</b> for the <span class="underline">teaching team</span>, to provide additional instructions (also a <a href="teacher-handbook.pdf">PDF file</a>)</li>
</ul>
<aside class="notes">
<p>
The student handbook's LaTeX formatting has a summarized content table and nice looking (in principle) title page. Customize at will.
</p>
<p>
The teachers handbook contains a less nice-looking format, includes a detailed table of contents, and has a watermark. Again, customize at will and submit improvements.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orgaf9e513">
<h3 id="orgaf9e513">Frugal org-reveal/reveal.js slides</h3>
<p>
Pretty much all features of <code>reveal.js</code>, supported by the org-mode reveal.js exporter (<a href="https://github.com/yjwen/org-reveal/">org-reveal</a>), should be supported too.
</p>
<p>
If you're already familiar with reveal.js, you may have noticed that
the current settings adopted for our slides generation are quite
frugal: no fancy 3D effects and likes.
</p>
<aside class="notes">
<p>
It's a matter of taste : I didn't want to show off, and prefer to give
students a clear content on the projector behind me.
</p>
<p>
An example <code>org-reveal</code> document is <a href="elisp/org-reveal/Readme.html">available here</a> for inspiration (it's the export of org-reveal's <code>README.org</code>, actually).
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org140ad5e">
<h3 id="org140ad5e">Structure of the sections / slides</h3>
<p>
I'm using the 3 levels of outlining / sectioning so that the content can be sectioned in the same way in <code>lesson.org</code> and appear appropriately in the slides and handbook, with these principles:
</p>
<ol>
<li>First level outlines define main sections of the document.</li>
<li>Second level outlines are the main "horizontal" slides that will be played with page up/down</li>
<li>Third level outlines may be used for additional content ("vertical" slides) that may be skipped for the presentation, but is still accessible with cursor keys.</li>
</ol>
<aside class="notes">
<p>
The first level outlines can be rendered as a "separating" slides which may get a different <code>reveal_background</code> and <code>class="center"</code> slide layout, but that isn't automatic. See <a href="#/slide-org9da6ee6">Section separators</a>.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orgf881db6">
<h3 id="orgf881db6">Presenter notes / content for the handbook</h3>
<p>
<a href="https://github.com/yjwen/org-reveal/#speaker-notes">org-reveal's <i>Speaker notes</i></a> may be added to the slides (and will only appear on
dual-screen presentation after having pressed '<i>s</i>': standard reveal.js
feature).
</p>
<p>
They will be masked for the audience, but will, by default, appear in the handbook given to the students.
</p>
<p>
The syntax in the org-mode source is:
</p>
<div class="org-src-container">
<pre class="src src-org"><code trim><span style="color: #b22222;">#+BEGIN_NOTES</span>
This is a note
<span style="color: #b22222;">#+END_NOTES</span>
</code></pre>
</div>
<aside class="notes">
<p>
This is a note
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org6d21429">
<h3 id="org6d21429">Masking content for some audiences</h3>
<p>
I've implemented some "easy ways" to preserve some of the content of the same <code>lesson.org</code> source for certain outputs (using org exporter's standard <code>EXCLUDE_TAGS</code>):
</p>
<dl>
<dt><i>Slides only</i> material</dt><dd>that won't be embedded in the handbook : surprise stuff for live audience, or HTML-only hacks;</dd>
<dt><i>Teachers only</i> material</dt><dd>secret knowledge that only adults need
to know (for instance), which won't be exported;</dd>
</dl>
</section>
<section id="slide-org6d21429-split">
<dl>
<dt><i>Handbook only</i> material</dt><dd>stuff that only fits in the handbook, and/or only exports as LaTeX and not HTML.</dd>
</dl>
<aside class="notes">
<p>
The choice to reveal or not some details to the students is quite arbitrary and depends on your pedagogical approach. I'm not advisable in this matter. YMMV.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orgc13ee31">
<h3 id="orgc13ee31">Stuff only meant for presentation</h3>
<p>
Tagging a section/slide with <code>:slidesonly:</code> means it isn't exported in the handbooks.
</p>
<p>
Below is an example (or not)…
</p>
</section>
<section id="slide-orgb7ed440">
<h4 id="orgb7ed440">Regular slide (no tag on heading line)</h4>
<p>
There should be no "Only in the slides" after this section, in the
handbooks, as it has been tagged with <code>slidesonly</code>.
</p>
</section>
<section id="slide-org5a55b71">
<h4 id="org5a55b71">Only in the slides</h4>
<p>
On the contrary, in the slides view, this appears, as there's a <code>:slidesonly:</code> tag on the current head line.
</p>
</section>
</section>
<section>
<section id="slide-org96f99b9">
<h3 id="org96f99b9">Stuff only meant for teachers</h3>
<p>
Tagging a section/slide with <code>:teachersonly:</code> means it isn't exported in the students handbook (nor in the slides).
</p>
<p>
Below is an example…
</p>
</section>
<section id="slide-org43854fd">
<h4 id="org43854fd">Regular slide (no tag on heading line)</h4>
<p>
There should be no "Only for teachers" after this section, in the slides or in the
students handbook, as it has been tagged with <code>teachersonly</code>.
</p>
</section>
</section>
<section>
<section id="slide-org2e4d937">
<h3 id="org2e4d937">Notes only for the teachers</h3>
<p>
This slide/section contains notes, but only part of it is displayed in
the presentation notes included in the handbook. Special notes and are
kept only for the teachers handbook.
</p>
<p>
We use an org-mode drawer for that (additional benefit is that the content is folded by default in emacs, as it may be verbose and/or "sensitive") :
</p>
<div class="org-src-container">
<pre class="src src-org"><code trim><span style="color: #b22222;">#+BEGIN_NOTES</span>
This part of the note can be viewed by the students in the handbook.
<span style="color: #a020f0;">:TEACHERSONLY:</span>
Not this one
<span style="color: #a020f0;">:END:</span>
<span style="color: #b22222;">#+END_NOTES</span>
</code></pre>
</div>
<aside class="notes">
<p>
</p>
<p>
This part of the note can be viewed by the students in the handbook,
but not the rest.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orgd0516a8">
<h3 id="orgd0516a8">Stuff only in the handbooks</h3>
<p>
Just like sections are for slides only, others can be for the handbook
only, using the <code>handbookonly</code> tag. This may be useful for <b>Annex</b>
sections for instance, or for stuff that the HTML exporter won't like, with inline LaTeX.
</p>
</section>
</section>
<section>
<section id="slide-orgcbc5b8f">
<h3 id="orgcbc5b8f">Code colorization</h3>
<p>
Code is colorized / highlighted in the slides :-)
</p>
<aside class="notes">
<p>
Nice when like me, you're teaching Computer Science stuff
</p>
<p>
Depending of whether you export from Emacs (in X, with a particular
theme,…) or with the Docker container, you'd get different results,
which depend on how htmlize is used, AFAIU.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-orge14ba93">
<h3 id="orge14ba93">Misc org-mode</h3>
<div class="outline-text-3" id="text-orge14ba93">
</div>
</section>
<section id="slide-orga6406b2">
<h4 id="orga6406b2">Babel powa</h4>
<p>
As you're using org-mode, its <code>babel</code> components are available, to embed source code in the same <code>lesson.org</code> source, and manage executable code and teaching material at once.
</p>
<p>
Look for <i>literate programing</i> instructions in the <a href="http://orgmode.org/manual/Working-with-source-code.html">org-mode docs</a> to know more.
</p>
</section>
<section id="slide-org1f565b0">
<h4 id="org1f565b0">Jumping to slide number</h4>
<p>
Included is the use of the
<a href="https://github.com/SethosII/reveal.js-jump-plugin">reveal.js jump
plugin</a> to allow jumping directly to slides # by entering a number
and hitting RETURN. Quite handy while writing and testing slides.
</p>
</section>
</section>
<section>
<section id="slide-org2b13e79">
<h3 id="org2b13e79">Missing features ?</h3>
<p>
Please try and talk to me to suggest new stuff and/or provide patches ;)
</p>
<aside class="notes">
<p>
See the teacher's handbook for some ideas
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org3aa1c8f" data-background="#dbdbed" class="center">
<h2 id="org3aa1c8f">Authoring</h2>
</section>
</section>
<section>
<section id="slide-org551a902">
<h3 id="org551a902">Modify only the lesson.org</h3>
<p>
<b>Only one file should be edited for writing the lesson's material : <code>lesson.org</code></b>
</p>
<p>
Only exception is modification of some configurations for title pages
and other bits that shouldn't change much in time (see section <a href="#/slide-orgd07d380">Configuration of layout</a>).
</p>
</section>
</section>
<section>
<section id="slide-orga7c91fe">
<h3 id="orga7c91fe">Use Emacs org-mode exporters or the Docker container</h3>
<p>
You have 2 options to generate the different formats:
</p>
<ul>
<li>either manualy use the standard org-mode exporters from inside Emacs</li>
<li>or use the Docker container for automation / reproducibility</li>
</ul>
</section>
</section>
<section>
<section id="slide-org9487b83">
<h3 id="org9487b83">Manual export for final documents</h3>
<p>
We're using the standard exporters so each output format will be exported from its corresponding umbrella <code>.org</code> source.
</p>
</section>
<section id="slide-org9487b83-split">
<p>
Open the corresponding org-mode source and export :
</p>
<dl>
<dt>slides</dt><dd>open <code>slides.org</code>, then <code>C-c C-e R ...</code> for <code>org-reveal</code> export (to <code>slides.html</code>), provided that you have loaded org-reveal in Emacs</dd>
<dt>handbook</dt><dd>open <code>handbook.org</code>, then <code>C-c C-e l ...</code> for LaTeX export (to <code>handbook.pdf</code>)</dd>
<dt>teacher handbook</dt><dd>open <code>teacher-handbook.org</code>, then <code>C-c C-e l ...</code> for LaTeX export (to <code>teacher-handbook.pdf</code>)</dd>
</dl>
<aside class="notes">
<p>
You're welcome to suggest improvements. But I'm not an Elisp hacker,
so I may not be able to maintain them. At the moment, the intent is to
rely on the original org-reveal only, as much as possible.
</p>
</aside>
</section>
<section id="slide-orgc9c622e">
<h4 id="orgc9c622e">Exporting slides to HTML with org-reveal</h4>
<p>
Depending on how you installed org-reveal (<a href="#/slide-orgbd94c7b">Git submodules</a> or otherwise), <code>org-reveal</code> may already be available.
</p>
<p>
If not yet, load it with <code>M-x load-file</code> from the location of its Git submodule (<code>elisp/org-reveal/ox-reveal.el</code> by default).
</p>
<aside class="notes">
<p>
I'm not sure which solution is better : org-reveal from Git (hence the Git submodule) or from an Emacs package. Please report.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org8d3d714">
<h3 id="org8d3d714">Use the docker container exporter</h3>
<p>
You may use the <code>olberger/docker-org-export</code> docker container image
I've prepared, to make org-mode exports. Or you may rebuild it
yourself (see below).
</p>
</section>
<section id="slide-org2f66366">
<h4 id="org2f66366">Build the Docker container image</h4>
<p>
This is recommended to avoid man in the middle, IMHO:
</p>
<div class="org-src-container">
<pre class="src src-sh"><code trim><span style="color: #483d8b;">cd</span> docker
docker build -t obergixlocal/docker-org-export .
</code></pre>
</div>
</section>
<section id="slide-orgf6626e9">
<h4 id="orgf6626e9">Run the container</h4>
<p>
Use the provided <code>docker/docker-org-export</code> script, which relies on
the <code>olberger/docker-org-export</code> container image. See how <a href="Makefile">Makefile</a> does it.
</p>
</section>
</section>
<section>
<section id="slide-orgd07d380">
<h3 id="orgd07d380">Configuration of layout</h3>
<p>
Each <code>lesson.org</code> needs some configuration :
</p>
<ul>
<li>Configure <code>org-reveal-title-slide</code> in <code>slides.org</code>.</li>
<li><p>
Configure in the headers elements like:
</p>
<ul>
<li><i>header</i> (<code>\lhead{...}</code> and <code>\rhead{...}</code>)</li>
<li>and <i>footer</i> (<code>\lfoot{...}</code> and <code>\rfoot{...}</code>)</li>
</ul>
<p>
ex: <code>#+LaTeX_HEADER: \rhead{...}</code> in <code>handbook.org</code> and
<code>teacher-handbook.org</code>.
</p></li>
</ul>
<aside class="notes">
<p>
These may be better handled, but some limitations of the exporters or
my lack of knowledge/time have prevented a better result so
far. Improvements much welcome.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org6502e02">
<h3 id="org6502e02">Printing slides</h3>
<p>
I've tested <a href="https://github.com/astefanutti/decktape">DeckTape</a> using a Docker container containing <code>PhantomJS</code> and
<code>decktape</code> to convert the slides to a <a href="slides.pdf">single PDF document</a>.
</p>
<p>
See the provided <a href="bin/decktape.sh">decktape.sh</a> script that runs the container, bind-mounting the
working dir into the container, so that input and output files can be
found.
</p>
<p>
Note that I used a rebuilt Docker image, reusing the <a href="https://raw.githubusercontent.com/astefanutti/decktape/master/Dockerfile">DeckTape
Dockerfile</a>, rebuilding with something alongside:
</p>
<div class="org-src-container">
<pre class="src src-sh"><code trim>docker build -t obergixlocal/decktape .
</code></pre>
</div>
</section>
</section>
<section>
<section id="slide-org9408416">
<h3 id="org9408416">Known Issues</h3>
<div class="outline-text-3" id="text-org9408416">
</div>
</section>
<section id="slide-org06a5713">
<h4 id="org06a5713">Firefox issues ?</h4>
<p>
We have experienced issues with presentations made on some versions of Firefox, which are known by reveal.js maintainer… maybe best viewed in chrome.
</p>
<p>
You may prefer to have a PDF variant of the slides (see <a href="#/slide-org6502e02">Printing slides</a>) in case.
</p>
</section>
</section>
<section>
<section id="slide-orgb25cb7c" data-background="#dbdbed" class="center">
<h2 id="orgb25cb7c">How it works / Installation</h2>
</section>
</section>
<section>
<section id="slide-orgf7ab926">
<h3 id="orgf7ab926">Use the source (Luke)</h3>
<p>
See the contents of the files… but be wary that it's sometimes messy and incrementally obtained.
</p>
<p>
Emacs is your buddy.
</p>
<p>
Git clone from <code>https://gitlab.com/olberger/org-teaching.git</code> (see the <a href="https://gitlab.com/olberger/org-teaching">Gitlab project</a>)
</p>
</section>
<section id="slide-orgbd94c7b">
<h4 id="orgbd94c7b">Git submodules</h4>
<p>
The repository contains Git submodules for :
</p>
<ul>
<li><code>reveal.js/</code></li>
<li><code>elisp/org-reveal</code></li>
<li>reveal.js's jump plugin (<code>reveal.js-jump-plugin/</code>)</li>
</ul>
<p>
So :
</p>
<div class="org-src-container">
<pre class="src src-sh"><code trim>git submodule init
git submodule update
</code></pre>
</div>
<p>
You may prefer to install them another way (ELPA repo, CDN, etc.)
</p>
<aside class="notes">
<p>
Refer to <a href="https://github.com/yjwen/org-reveal/#requirements-and-installation">org-reveal's documentation</a> for more details.
</p>
</aside>
</section>
</section>
<section>
<section id="slide-org847d399">
<h3 id="org847d399">Customize slides appearance</h3>
<div class="outline-text-3" id="text-org847d399">
</div>
</section>
<section id="slide-org7527257">
<h4 id="org7527257">Reveal.js settings</h4>
<p>
See the org-reveal settings set in the sources and the docs for a detailed explanation.
</p>
<p>
I'm using the following for a "frugal" look close to what
powerpoint or beamer (?) could look like :
</p>
<div class="org-src-container">
<pre class="src src-org"><code trim><span style="color: #b22222;">#+REVEAL_HLEVEL: 2</span>
<span style="color: #b22222;">#+REVEAL_THEME: simple</span>
<span style="color: #b22222;">#+REVEAL_TRANS: fade</span>
<span style="color: #b22222;">#+REVEAL_SPEED: fast</span>
<span style="color: #b22222;">#+REVEAL_MARGIN: 0.0</span>
<span style="color: #b22222;">#+REVEAL_EXTRA_CSS: ./presentation.css</span>
<span style="color: #b22222;">#+REVEAL_ROOT: ./reveal.js</span>
<span style="color: #b22222;">#+OPTIONS: reveal_center:nil </span>
</code></pre>
</div>
</section>
<section id="slide-org9da6ee6">
<h4 id="org9da6ee6">Section separators</h4>
<p>
The highest level sections include the following properties below the heading line, to customize the look of the slide.
</p>
<div class="org-src-container">
<pre class="src src-org"><code trim><span style="color: #a020f0;">:PROPERTIES:</span>
<span style="color: #a020f0;">:REVEAL_EXTRA_ATTR:</span> class="center"
<span style="color: #a020f0;">:reveal_background:</span> #dbdbed
<span style="color: #a020f0;">:END:</span>
</code></pre>
</div>
<p>
This is intended to provide some visual sense of the transitions between sections. Please adapt and report.
</p>
</section>
<section id="slide-orgfd82683">
<h4 id="orgfd82683">Title screen picture (logos, etc.)</h4>
<p>
I'm not yet sure how much may be achieved with HTML and CSS for the
title page of the slides deck, so I've relied on the embedding of a
background image that will contain the logos and additional graphics.
</p>
<div class="org-src-container">
<pre class="src src-org"><code trim><span style="color: #b22222;">#+REVEAL_TITLE_SLIDE_BACKGROUND: ./media/title-slide-background.png</span>
</code></pre>
</div>
<p>
I'm quite sure this could be improved.
</p>
</section>
</section>
<section>
<section id="slide-org4e6d2ef">
<h2 id="org4e6d2ef">Annex</h2>
<div class="outline-text-2" id="text-org4e6d2ef">
</div>
</section>
</section>
<section>
<section id="slide-org454e0cd">
<h3 id="org454e0cd">Thanks</h3>
<ul>
<li>All contributors to org-mode (special kudos to Carsten Dominik and Bastien Guerry)</li>
<li>Yujie Wen for <code>org-reveal</code></li>
<li>Hakim El Hattab for <code>reveal.js</code></li>
<li>My colleagues at Telecom SudParis who had to teach with this tool without much rehersal</li>
<li>Our students who endured it for a brand new course (and included bugs)</li>
<li>Alexey Lebedeff for his
<a href="https://github.com/binarin/docker-org-export">docker-org-export</a>
Docker container</li>
</ul>
</section>
</section>
<section>
<section id="slide-org176eba6">
<h3 id="org176eba6">Feedback</h3>
<p>
I may be contacted from <a href="http://www-public.tem-tsp.eu/~berger_o/#sec-3">my Web page</a> or via <a href="https://gitlab.com/olberger/org-teaching">the Gitlab project</a>.
</p>
</div>
</div>
<script src="./reveal.js/js/reveal.js"></script>
<script>
// Full list of configuration options available here:
// https://github.com/hakimel/reveal.js#configuration
Reveal.initialize({
controls: true,
progress: true,
history: false,
center: false,
slideNumber: 'c',
rollingLinks: false,
keyboard: true,
overview: true,
margin: 0.00,
theme: Reveal.getQueryHash().theme, // available themes are in /css/theme
transition: Reveal.getQueryHash().transition || 'fade', // default/cube/page/concave/zoom/linear/fade/none
transitionSpeed: 'fast',
multiplex: {
secret: '', // null if client
id: '', // id, obtained from socket.io server
url: '' // Location of socket.io server
},
// Optional libraries used to extend on reveal.js
dependencies: [
{ src: './reveal.js-jump-plugin/jump/jump.js', async: true },
{ src: './reveal.js/lib/js/classList.js', condition: function() { return !document.body.classList; } },
{ src: './reveal.js/plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: './reveal.js/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: './reveal.js/plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },
{ src: './reveal.js/plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }]
});
</script>
</body>
</html>