-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathorg-reveal_Readme.html
1290 lines (1093 loc) · 36.6 KB
/
org-reveal_Readme.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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Introduction to Org-Reveal</title>
<meta name="author" content="(Yujie Wen)"/>
<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/moon.css" id="theme"/>
<link rel="stylesheet" href="./local.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>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<meta name="description" content="Org-Reveal Introduction.">
</head>
<body>
<div class="reveal">
<div class="slides">
<section id="sec-title-slide"><h1 class="title">Introduction to Org-Reveal</h1><h2 class="author">Yujie Wen</h2><p class="date">Created: 2018-04-24 Tue 11:57</p>
</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-org26f1578">Reveal.js and Org-Reveal</a></li>
<li><a href="#/slide-orgc40ddc8">Requirements and Installation</a></li>
<li><a href="#/slide-orgf2283de">Configuration</a></li>
<li><a href="#/slide-org6e0620c">Tips</a></li>
<li><a href="#/slide-orgf879219">Thanks</a></li>
</ul>
</div>
</div>
</section>
<p>
<a href="http://melpa.org/#/ox-reveal"><object type="image/svg+xml" data="http://melpa.org/packages/ox-reveal-badge.svg" class="org-svg">
Sorry, your browser does not support SVG.</object></a>
<a href="http://www.gnu.org/licenses/gpl-3.0.html"><object type="image/svg+xml" data="http://img.shields.io/:license-gpl3-blue.svg" class="org-svg">
Sorry, your browser does not support SVG.</object></a>
</p>
<section>
<section id="slide-org26f1578">
<h2 id="org26f1578">Reveal.js and Org-Reveal</h2>
<ul>
<li><b>Reveal.js</b> is a tool for creating good-looking HTML presentations,
authored by <a href="http://hakim.se/">Hakim El Hattab</a>. <br />
For an example of a reveal.js presentation, see <a href="http://lab.hakim.se/reveal-js/#/">here</a>.</li>
<li><b>Org-Reveal</b> exports your <a href="http://orgmode.org/">Org</a> documents to reveal.js
presentations.<br />
With Org-reveal, you can create beautiful presentations with 3D
effects from simple but powerful Org contents.</li>
</ul>
</section>
</section>
<section>
<section id="slide-orgc40ddc8">
<h2 id="orgc40ddc8">Requirements and Installation</h2>
<ul>
<li>Reveal.js.</li>
<li>Org-mode.</li>
<li>ox-reveal.el.</li>
<li>htmlize.el (optional, for syntax highlighting).</li>
<li>And, of course, emacs.</li>
</ul>
</section>
</section>
<section>
<section id="slide-org5bd4e5f">
<h3 id="org5bd4e5f">Install Reveal.js</h3>
<p>
Download Reveal.js packages from <a href="https://github.com/hakimel/reveal.js/">here</a>.
</p>
<p>
Extract Reveal.js folders from the downloaded zip file.
</p>
<p>
If you do not wish to download reveal.js yourself and would rather get a copy from a CDN,
see the section <a href="https://github.com/yjwen/org-reveal#set-the-location-of-revealjs">Set the location of Reveal.js</a>
</p>
</section>
</section>
<section>
<section id="slide-orgc2d1c48">
<h3 id="orgc2d1c48">Install org-reveal from MELPA</h3>
<p>
The easiest way to install org-reveal is to install package
ox-reveal from MELPA.
</p>
<p>
Please refer to <a href="http://melpa.org/#/getting-started">http://melpa.org/#/getting-started</a> for using MELPA.
</p>
<p>
<b>Note</b>: It is suggested to use the <a href="http://orgmode.org/elpa.html">Org ELPA</a> archive in pair
with the ox-reveal packages. Emacs builtin Org-mode package may be
out of date for MELPA's ox-reveal.
</p>
</section>
</section>
<section>
<section id="slide-orgd58d23c">
<h3 id="orgd58d23c">Install org-reveal from GitHub</h3>
<p>
You can also install the latest developing version of org-reveal directly
from GitHub.
</p>
<p>
Please download the latest Org-reveal package from <a href="https://github.com/yjwen/org-reveal">the Org-reveal
GitHub page</a>. Or clone the GitHub repository:
</p>
<div class="org-src-container">
<pre class="src src-sh">git clone https://github.com/yjwen/org-reveal.git
</pre>
</div>
<p>
Copy <code>ox-reveal.el</code> to one of your Emacs's <code>load-path</code>, and add the
following statement to your <code>.emacs</code> file.
</p>
<div class="org-src-container">
<pre class="src src-lisp">(<span style="color: #cdcd00;">require</span> '<span style="color: #ff00ff;">ox-reveal</span>)
</pre>
</div>
<p>
<b>Note</b>: It is suggested to use the Org-mode git repository in pair
with the GitHub org-reveal. Please get the Org-mode git repository
by:
</p>
<div class="org-src-container">
<pre class="src src-sh">$ git clone git://orgmode.org/org-mode.git
</pre>
</div>
<p>
Follow the <a href="http://orgmode.org/worg/dev/org-build-system.html">online instruction</a> for building and installing Org-mode.
</p>
</section>
</section>
<section>
<section id="slide-orgf2283de">
<h2 id="orgf2283de">Configuration</h2>
<div class="outline-text-2" id="text-orgf2283de">
</div>
</section>
</section>
<section>
<section id="slide-org5d3bd49">
<h3 id="org5d3bd49">Set the location of Reveal.js</h3>
<p>
Org-reveal must know where Reveal.js is on your computer before
exporting Org contents. The location of Reveal.js is the path to
the top directory of the Reveal.js packages, the directory which contains
file <b>README.md</b>, but <b>not</b> the one that contains the file reveal.js.
</p>
<p>
The default location is <code>./reveal.js</code>, relative to the Org file.
</p>
<p>
Changing <code>org-reveal-root</code> 's value will change the location
globally. For example, add the following statement to your .emacs
file:
</p>
<div class="org-src-container">
<pre class="src src-lisp">(setq org-reveal-root <span style="color: #add8e6;">"file:///d:/reveal.js"</span>)
</pre>
</div>
<p>
<b>IMPORTANT</b>: the absolute path to Reveal.js should be in URL form,
"<a href="file:///path_to_reveal.js">file:///path_to_reveal.js</a>", as illustrated above. By setting
option <code>REVEAL_ROOT</code>, the location is only affected within the Org
file.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+REVEAL_ROOT: <a href="file:///d:/reveal.js">file:///d:/reveal.js</a></span>
</pre>
</div>
<p>
Set your <code>REVEAL_ROOT</code> to the following URL to download reveal.js from
a CDN instead of downloading a local copy.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+REVEAL_ROOT: <a href="http://cdn.jsdelivr.net/reveal.js/3.0.0/">http://cdn.jsdelivr.net/reveal.js/3.0.0/</a></span>
</pre>
</div>
</section>
<section id="slide-org32895ea">
<h4 id="org32895ea">Url form for file location</h4>
<p>
For example if you cloned this repository to your home directory,
this file in Mac OS X would be referred to as
"<a href="file:///Users/username/org-reveal/readme.html">file:///Users/username/org-reveal/readme.html</a>". This file in
Ubuntu would be "<a href="file:///home/username/org-reveal/readme.html">file:///home/username/org-reveal/readme.html</a>" and
in Windows this file would be
"<a href="c:/Users/username/org-reveal/readme.html">c:/Users/username/org-reveal/readme.html</a>". For more
detail on this standard please refer to
<a href="http://en.wikipedia.org/wiki/File_URI_scheme">http://en.wikipedia.org/wiki/File_URI_scheme</a>
</p>
</section>
</section>
<section>
<section id="slide-org2961bc6">
<h3 id="org2961bc6">First Try</h3>
<p>
To load Org-reveal, type "M-x load-library", then type
"ox-reveal".
</p>
<p>
Now you can export this manual into Reveal.js presentation by
typing "C-c C-e R R".
</p>
<p>
Open the generated "Readme.html" in your browser and enjoy the
cool slides.
</p>
</section>
</section>
<section>
<section id="slide-orgecc1101">
<h3 id="orgecc1101">The HLevel</h3>
<p>
Org-reveal maps each heading and its contents to one Reveal.js
slide. Since Reveal.js arranges slides into a 2-dimensional matrix,
Org-reveal use a <b>HLevel</b> value to decide whether to map headings to horizontal
or vertical slides.
</p>
<ul>
<li>Headings of level less than or equal to <b>HLevel</b> are mapped to horizontal
slides.</li>
<li>Headings with a deeper level are mapped to vertical slides.</li>
</ul>
<p>
HLevel's default value is 1, means only level 1 headings are arranged
horizontally. Deeper headings are mapped to vertical slides below their
parent level 1 heading.
</p>
</section>
<section id="slide-orgb954b6b">
<h4 id="orgb954b6b">HLevel's Effects on Slides Layout</h4>
<p>
Assume we have a simple Org file as below:
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #0000ff; font-weight: bold;">* H1</span>
<span style="color: #0000ff; font-weight: bold;">* H2</span>
<span style="color: #00ffff; font-weight: bold;">** H2.1</span>
<span style="color: #cdcd00;">*** H2.1.1</span>
<span style="color: #0000ff; font-weight: bold;">* H3</span>
</pre>
</div>
<p>
If HLevel is 1, the default value, headings H2.1 and H2.1.1 will
be mapped to vertical slides below the slides of heading H2.
</p>
<div class="figure">
<p><img src="./images/hlevel.png" alt="hlevel.png" />
</p>
</div>
<p>
If HLevel is changed to 2, slides of heading H2.1 will be changed
to the main horizontal queue, and slides of heading H2.1.1 will be
a vertical slide below it.
</p>
<div class="figure">
<p><img src="./images/hlevel2.png" alt="hlevel2.png" />
</p>
</div>
</section>
<section id="slide-orgc02a243">
<h4 id="orgc02a243">Configure HLevel's Value</h4>
<ul>
<li>Change variable <code>org-reveal-hlevel</code>'s value to set HLevel globally.<br />
For example, add the following statement to your <code>.emacs</code> file.</li>
</ul>
<div class="org-src-container">
<pre class="src src-lisp">(setq org-reveal-hlevel 2)
</pre>
</div>
<ul>
<li>Setting Org files local HLevel to option <code>REVEAL_HLEVEL</code>.</li>
</ul>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+REVEAL_HLEVEL: 2</span>
</pre>
</div>
</section>
</section>
<section>
<section id="slide-org75c1358">
<h3 id="org75c1358">Force Split</h3>
<p>
If one heading has too many things to fit into one slide, you can
split the contents into multiple vertical slides manually, by inserting
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+REVEAL: split</span>
</pre>
</div>
</section>
<section >
<p>
Now a new slide begins after <code>#+REVEAL</code> keyword.
</p>
</section>
</section>
<section>
<section id="slide-orge544908">
<h3 id="orge544908">Select Theme and Transition</h3>
<p>
Themes and transition styles are set globally throughout the whole
file by setting options <code>REVEAL_THEME</code>, <code>REVEAL_TRANS</code>, and <code>REVEAL_SPEED</code>.
</p>
<p>
For an example, please check the heading part of this document.
</p>
<p>
Available themes can be found in "css/theme/" in the reveal.js directory.
</p>
<p>
Available transitions are: default|cube|page|concave|zoom|linear|fade|none.
</p>
</section>
</section>
<section>
<section id="slide-org6dcc0d2">
<h3 id="org6dcc0d2">Set The Title Slide</h3>
<p>
By default, Org-reveal generates a title slide displaying the
title, the author, the Email, the date and the time-stamp of the
Org document, controlled by Org's <a href="http://orgmode.org/org.html#Export-settings">export settings</a>.
</p>
<p>
To avoid a title slide, please set variable
<code>org-reveal-title-slide</code> to <code>nil</code>, or add <code>reveal_title_slide:nil</code> to
<code>#+OPTIONS:</code> line.
</p>
<p>
To restore the default title slide, please set variable
<code>org-reveal-title-slide</code> to <code>'auto</code>.
</p>
</section>
<section id="slide-org443eeac">
<h4 id="org443eeac">Customize the Title Slide</h4>
<p>
To customize the title slide, please set <code>org-reveal-title-slide</code>
to a string of HTML markups. The following escaping character can
be used to retrieve document information:
</p>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="org-left" />
<col class="org-left" />
</colgroup>
<tbody>
<tr>
<td class="org-left"><code>%t</code></td>
<td class="org-left">Title</td>
</tr>
<tr>
<td class="org-left"><code>%a</code></td>
<td class="org-left">Author</td>
</tr>
<tr>
<td class="org-left"><code>%e</code></td>
<td class="org-left">Email</td>
</tr>
<tr>
<td class="org-left"><code>%d</code></td>
<td class="org-left">Date</td>
</tr>
<tr>
<td class="org-left"><code>%%</code></td>
<td class="org-left">Literal %</td>
</tr>
</tbody>
</table>
</section>
</section>
<section>
<section id="slide-org11c974f">
<h3 id="org11c974f">Set Slide Background</h3>
<p>
Slide background can be set to a color, an image or a repeating image
array by setting heading properties.
</p>
</section>
<section id="slide-orgd00f1b5" data-background="#543210">
<h4 id="orgd00f1b5">Single Colored Background</h4>
<p>
Set property <code>reveal_background</code> to either an RGB color value, or any
supported CSS color format.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #cdcd00;">*** Single Colored Background</span>
<span style="color: #cdcd00;"> :PROPERTIES:</span>
<span style="color: #cdcd00;">:reveal_background:</span> #123456
<span style="color: #cdcd00;"> :END:</span>
</pre>
</div>
</section>
<section id="slide-org8c97b7e" data-background="./images/whale.jpg" data-background-transition="slide">
<h4 id="org8c97b7e">Single Image Background</h4>
<p>
Set property <code>reveal_background</code> to an URL of background image.
Set property <code>reveal_background_trans</code> to <code>slide</code> to make background image
sliding rather than fading.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #cdcd00;">*** Single Image Background</span>
<span style="color: #cdcd00;"> :PROPERTIES:</span>
<span style="color: #cdcd00;">:reveal_background:</span> ./images/whale.jpg
<span style="color: #cdcd00;">:reveal_background_trans:</span> slide
<span style="color: #cdcd00;"> :END:</span>
</pre>
</div>
</section>
<section id="slide-org74b708a" data-background="./images/whale.jpg" data-background-size="200px" data-background-repeat="repeat">
<h4 id="org74b708a">Repeating Image Background</h4>
<p>
Resize background image by setting property
<code>reveal_background_size</code> to a number.
</p>
<p>
Set property <code>reveal_background_repeat</code> to <code>repeat</code> to repeat
image on the background.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #cdcd00;">*** Repeating Image Background</span>
<span style="color: #cdcd00;"> :PROPERTIES:</span>
<span style="color: #cdcd00;">:reveal_background:</span> ./images/whale.jpg
<span style="color: #cdcd00;">:reveal_background_size:</span> 200px
<span style="color: #cdcd00;">:reveal_background_repeat:</span> repeat
<span style="color: #cdcd00;"> :END:</span>
</pre>
</div>
</section>
<section id="slide-org10db924">
<h4 id="org10db924">Title Slide Background Image</h4>
<p>
To set the title slide's background image, please specify the
following options:
</p>
<ul>
<li><code>REVEAL_TITLE_SLIDE_BACKGROUND</code>: A URL to the background image.</li>
<li><code>REVEAL_TITLE_SLIDE_BACKGROUND_SIZE</code>: HTML size specification, e.g. <code>200px</code>.</li>
<li><code>REVEAL_TITLE_SLIDE_BACKGROUND_REPEAT</code>: set to <code>repeat</code> to repeat the image.</li>
</ul>
</section>
</section>
<section>
<section id="slide-orgee68de3">
<h3 id="orgee68de3">Slide Size</h3>
<p>
Reveal.js scales slides to best fit the display resolution, but you can
also specify the desired size by settings the option tags <code>width</code> and <code>height</code>.
</p>
<p>
The scaling behavior can also be constrained by setting following
options:
</p>
<dl>
<dt><code>#+REVEAL_MARGIN:</code></dt><dd>a float number, the factor of empty area
surrounding slide contents.</dd>
<dt><code>#+REVEAL_MIN_SCALE:</code></dt><dd>a float number, the minimum scaling down
ratio.</dd>
<dt><code>#+REVEAL_MAX_SCALE:</code></dt><dd>a float number, the maximum scaling up
ratio.</dd>
</dl>
</section>
</section>
<section>
<section id="slide-orge694e34">
<h3 id="orge694e34">Slide Numbering</h3>
<p>
By default, a flatten slide number is showed at the lower-right corner of each slide.
</p>
<p>
To disable slide numbering, please add <code>reveal_slide_number:nil</code> to
<code>#+OPTIONS:</code> line.
</p>
<p>
From Reveal.js 3.1.0, slide numbering can have several custom
formats. To choose one format, please set <code>reveal_slide_number</code> to
its proper string. For example, <code>reveal_slide_number:h/v</code>.
</p>
<p>
Supported format string can be found in <a href="https://github.com/hakimel/reveal.js/#slide-number">Reveal.js manual</a>.
</p>
</section>
</section>
<section>
<section id="slide-orgef3fe7e">
<h3 id="orgef3fe7e">Slide Header/Footer</h3>
<p>
Specify Slide header/footer by <code>#+REVEAL_SLIDE_HEADER:</code> and
<code>#+REVEAL_SLIDE_FOOTER:</code>. The option content will be put into
divisions of class <code>slide-header</code> and <code>slide-footer</code>, so you can
control their appearance in custom CSS file(see <a href="#/slide-org6aa8279">Extra Stylesheets</a>).
By default header/footer content will only display on content
slides. To show them also on the title and toc slide you can add
<code>reveal_global_header:t</code> and <code>reveal_global_footer:t</code> to
<code>#+OPTIONS:</code> line.
</p>
</section>
</section>
<section>
<section id="slide-org947b71d">
<h3 id="org947b71d">Fragmented Contents</h3>
<p>
Make contents fragmented (show up one-by-one) by setting option
<code>ATTR_REVEAL</code> with property ":frag frag-style", as illustrated
below.
</p>
<p class="fragment roll-in">
Paragraphs can be fragmented.
</p>
<ul class="fragment roll-in">
<li>Lists can</li>
<li>be fragmented.</li>
</ul>
<p class="fragment roll-in">
Pictures, tables and many other HTML elements can be fragmented.
</p>
</section>
<section id="slide-orgcd44ea2">
<h4 id="orgcd44ea2">Fragment Styles</h4>
<p>
Available fragment styles are:
</p>
<ul class="fragment">
<li>grow</li>
<li>shrink</li>
<li>roll-in</li>
<li>fade-out</li>
<li>highlight-red</li>
<li>highlight-green</li>
<li>highlight-blue</li>
<li>appear</li>
</ul>
<p>
Setting <code>:frag t</code> will use Reveal.js default fragment style, which
can be overridden by local option <code>#+REVEAL_DEFAULT_FRAG_STYLE</code> or
global variable <code>org-reveal-default-frag-style</code>.
</p>
</section>
<section id="slide-org6692c88">
<h4 id="org6692c88">Fragment Index</h4>
<p>
Fragment sequence can be changed by assigning adding <code>:frag_idx</code>
property to each fragmented element.
</p>
<p data-fragment-index="3" class="fragment">
And, this paragraph shows at last.
</p>
<p data-fragment-index="2" class="fragment">
This paragraph shows secondly.
</p>
<p data-fragment-index="1" class="fragment">
This paragraph shows at first.
</p>
</section>
<section id="slide-org3337d7a">
<h4 id="org3337d7a">List Fragments</h4>
<p>
<code>#+ATTR_REVEAL: :frag frag-style</code> above a list defines fragment
style for the list as a whole.
</p>
<ol class="fragment grow">
<li>All items grow.</li>
<li>As a whole.</li>
</ol>
<p>
To define fragment styles for every list item, please enumerate
each item's style in a lisp list.
</p>
<p>
<code>none</code> in the style list will disable fragment for the
corresponding list item.
</p>
<p>
Custom fragment sequence should also be enumerated for each list
item.
</p>
</section>
<section >
<p>
An example:
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+ATTR_REVEAL: :frag (grow shrink roll-in fade-out none) :frag_idx (4 3 2 1 -)</span>
* I will grow.
* I will shrink.
* I rolled in.
* I will fade out.
* I don't fragment.
</pre>
</div>
<ul>
<li>I will grow.</li>
<li>I will shrink.</li>
<li>I rolled in.</li>
<li>I will fade out.</li>
<li>I don't fragment.</li>
</ul>
</section>
<section >
<p>
When there is <code>:frag_idx</code> specified, insufficient fragment style
list will be extended by its last element. So a <code>:frag (appear)</code>
assigns each item of a list the <code>appear</code> fragment style.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+ATTR_REVEAL: :frag (appear)</span>
* I appear.
* I appear.
* I appear.
</pre>
</div>
<ul>
<li class="fragment appear">I appear.</li>
<li class="fragment appear">I appear.</li>
<li class="fragment appear">I appear.</li>
</ul>
</section>
</section>
<section>
<section id="slide-org71e7c7d" data-state="alert">
<h3 id="org71e7c7d">Data State</h3>
<p>
Set property <code>reveal_data_state</code> to headings to change this slide's
display style, as illustrated above.
</p>
<p>
Available data states are: alert|blackout|soothe.
</p>
</section>
</section>
<section>
<section id="slide-org71fab88">
<h3 id="org71fab88">Plug-ins</h3>
<p>
Reveal.js provides several plug-in functions.
</p>
<ul>
<li>reveal-control : Show/hide browsing control pad.</li>
<li>reveal-progress : Show/hide progress bar.</li>
<li>reveal-history : Enable/disable slide history track.</li>
<li>reveal-center : Enable/disable slide centering.</li>
<li>multiplex : Enable audience to view presentation on secondary devices.</li>
</ul>
</section>
<section id="slide-orgd250e7d">
<h4 id="orgd250e7d">Configure Plug-ins</h4>
<p>
Each plugin can be toggled on/off by adding <code>#+OPTIONS</code> tags or
by setting custom variables.
</p>
<ul>
<li><code>#+OPTIONS</code> tags:<br />
<code>reveal_control</code>, <code>reveal_progress</code>, <code>reveal_history</code>,
<code>reveal_center</code>, <code>reveal_rolling_links</code>, <code>reveal_keyboard</code>, <code>reveal_overview</code></li>
<li>Custom variables:<br />
<code>org-reveal-control</code>, <code>org-reveal-progress</code>,
<code>org-reveal-history</code>, <code>org-reveal-center</code>, <code>org-reveal-rolling-links</code>, <code>org-reveal-keyboard</code>, <code>org-reveal-overview</code></li>
</ul>
<p>
For an example, please refer to the heading part of this document.
</p>
</section>
</section>
<section>
<section id="slide-org760c0bf">
<h3 id="org760c0bf">Third-Party Plugins</h3>
<p>
Reveal.js is also extensible through third-party plugins. Org-reveal now includes a mechanism to load these as well. It's a little more complicated, because we need to store the specific javascript loading code in a defcustom.
</p>
<p>
Store the names and loading instructions for each plugin in the defcustom <code>org-reveal-external-plugins</code>. This defcustom is an associative list. The first element of each Assoc cell is a symbol – the name of the plugin – and the second is a string that will be expanded by the <code>format</code> function when the plugin is loaded. So, this second element should have the form ~" {src: \"%srelative/path/toplugin/from/reveal/root.js\"}'. If you need the async or callback parameters, include those too. Ox-reveal will add the plugin to the dependencies parameter when Reveal is initialized.
</p>
</section>
</section>
<section>
<section id="slide-org88056fe">
<h3 id="org88056fe">Highlight Source Code</h3>
<p>
There are two ways to highlight source code.
</p>
<ol>
<li>Use your Emacs theme</li>
<li>Use highlight.js</li>
</ol>
<p>
To Use your Emacs theme, please make sure <code>htmlize.el</code> is
installed. Then no more setup is necessary.
</p>
<p>
Below is an example. Codes are copied from <a href="http://www.haskell.org/haskellwiki/The_Fibonacci_sequence">Haskell Wiki</a>.
</p>
<div class="org-src-container">
<pre class="src src-haskell">fibs = 0 : 1 : next fibs
where next (a : t@(b:_)) = (a+b) : next t
</pre>
</div>
<p>
If you saw odd indentation, please set variable <code>org-html-indent</code>
to <code>nil</code> and export again.
</p>
</section>
<section id="slide-orgcf9266f">
<h4 id="orgcf9266f">Using highlight.js</h4>
<p>
You can also use <a href="https://highlightjs.org">highlight.js</a>, by adding <code>highlight</code> to the Reveal.js
plugin list.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #333300; font-weight: bold;">#+REVEAL_PLUGINS: (highlight)</span>
</pre>
</div>
<p>
The default highlighting theme is <code>zenburn.css</code> brought with
Reveal.js. To use other themes, please specify the CSS file name by
<code>#+REVEAL_HIGHLIGHT_CSS</code> or the variable <code>org-reveal-highlight-css</code>.
</p>
<p>
The "%r" in the given CSS file name will be replaced by Reveal.js'
URL.
</p>
</section>
</section>
<section>
<section id="slide-my-heading">
<h3 id="my-heading"><a id="org486f391"></a>MathJax</h3>
<p>
\({n! \over k!(n-k)!} = {n \choose k}\)
</p>
<p>
LateX equation are rendered in native HTML5 contents.
</p>
<p>
<b>IMPORTANT</b>: Displaying equations requires internet connection to
<a href="http://mathjax.org/">mathjax.org</a> or local MathJax installation. For local MathJax
installation, set option <code>REVEAL_MATHJAX_URL</code> to the URL pointing
to the local MathJax location.
</p>
<p>
<b>Note</b>: Option <code>reveal_mathjax</code> is obsolete now. Org-reveal
exports necessary MathJax configurations when there is Latex
equation found.
</p>
</section>
</section>
<section>
<section id="slide-org9928dc9">
<h3 id="org9928dc9">Preamble and Postamble</h3>
<p>
You can define preamble and postamble contents which will not be
shown as slides, but will be exported into the body part of the
generated HTML file, at just before and after the slide contents.
</p>
<p>
Change preamble and postamble contents globally by setting variable
<code>org-reveal-preamble</code> and <code>org-reveal-postamble</code>.
</p>
<p>
Change preamble and postamble contents locally by setting options
<code>REVEAL_PREAMBLE</code> and <code>REVEAL_POSTAMBLE</code>, as illustrated at the
heading part of this document.
</p>
<p>
To add custom contents into HTML <code><head></code> parts, set contents to
variable <code>org-reveal-head-preamble</code> or option
<code>REVEAL_HEAD_PREAMBLE</code>.
</p>
</section>
<section id="slide-orgb4524e4">
<h4 id="orgb4524e4">Generating Pre/Postamble by Emacs-Lisp Functions</h4>
<p>
If the contents of pre/postamble is the name of an evaluated
Emacs-Lisp function, which must accept an argument of Org-mode
info and return a string, the returned string will be taken
as pre/postamble contents.
</p>
<p>
So you can embed the Emacs-Lisp function as an Org-Babel source
block and mark it to be evaluated when exporting the document.
</p>
</section>
</section>
<section>
<section id="slide-org6f56283">
<h3 id="org6f56283">Raw HTML in Slides</h3>
<p>
Besides the Org contents, you can embed raw HTML contents
into slides by placing a <code>#+REVEAL_HTML</code> keyword.
</p>
<p>
The famous cat jump fail:
</p>
<iframe width="420" height="315" src="https://www.youtube.com/embed/Awf45u6zrP0" frameborder="0" allowfullscreen></iframe>
</section>
</section>
<section>
<section id="slide-orgd18596a">
<h3 id="orgd18596a">Speaker Notes</h3>
<p>
Reveal.js supports speaker notes, which are displayed in a separate
browser window. Pressing 's' on slide's windows will pop up a window
displaying the current slide, the next slide and the speaker notes on the current
slide.
</p>
<p>
Org-reveal recognize texts between <code>#+BEGIN_NOTES</code> and <code>#+END_NOTES</code>
as speaker notes. See the example below.
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #0000ff; font-weight: bold;">* Heading 1</span>
Some contents.
<span style="color: #333300; font-weight: bold;">#+BEGIN_NOTES</span>
Enter speaker notes here.
<span style="color: #333300; font-weight: bold;">#+END_NOTES</span>
</pre>
</div>
</section>
<section >
<p>
Speaker notes requires the <code>notes</code> plug-in. If you changed default
plug-in setting by specifying <code>#+REVEAL_PLUGINS</code> or by setting
variable <code>org-reveal-plugins</code>, please make sure <code>notes</code> is in the
plug-in list to enable speaker notes.
</p>
</section>
<section >
<p>
Due to a bug in Reveal.js, sometimes the speaker notes window
shows only blank screens. A workaround to this issue is to put