forked from relevance/org-html-slideshow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample.html
More file actions
502 lines (371 loc) · 12.7 KB
/
example.html
File metadata and controls
502 lines (371 loc) · 12.7 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Example Presentation</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
<meta name="title" content="Example Presentation"/>
<meta name="generator" content="Org-mode"/>
<meta name="generated" content="2012-03-12 19:11:09 EDT"/>
<meta name="author" content="Stuart Sierra"/>
<meta name="description" content=""/>
<meta name="keywords" content=""/>
<link rel="stylesheet" type="text/css" href="src/css/common.css" />
<link rel="stylesheet" type="text/css" href="src/css/screen.css" media="screen" />
<link rel="stylesheet" type="text/css" href="src/css/projection.css" media="projection" />
<link rel="stylesheet" type="text/css" href="src/css/presenter.css" media="presenter" />
</head>
<body>
<div id="preamble">
</div>
<div id="content">
<h1 class="title">Example Presentation</h1>
<p>Type <strong>T</strong> to begin the slide show.</p>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1 Org-HTML-Slideshow</a>
<ul>
<li><a href="#sec-1-1">1.1 Making Slides</a></li>
<li><a href="#sec-1-2">1.2 Headlines Don't Have to be Slides</a></li>
<li><a href="#sec-1-3">1.3 Use Lists For Bullets</a></li>
<li><a href="#sec-1-4">1.4 Or Low-Level Headings</a></li>
<li><a href="#sec-1-5">1.5 Slides Can Be Nested</a>
<ul>
<li><a href="#sec-1-5-1">1.5.1 Slide Headings Can Be Nested</a></li>
</ul></li>
</ul>
</li>
<li><a href="#sec-2">2 Presenter Notes</a>
<ul>
<li><a href="#sec-2-1">2.1 A Slide with Notes</a>
<ul>
<li><a href="#sec-2-1-1">2.1.1 Notes</a></li>
</ul></li>
</ul>
</li>
<li><a href="#sec-3">3 Source Code</a>
<ul>
<li><a href="#sec-3-1">3.1 Syntax Highlighting</a></li>
<li><a href="#sec-3-2">3.2 Syntax Highlighting with CSS Classes</a></li>
</ul>
</li>
<li><a href="#sec-4">4 Images</a>
<ul>
<li><a href="#sec-4-1">4.1 Slide with Image</a></li>
</ul>
</li>
<li><a href="#sec-5">5 Styling</a>
<ul>
<li><a href="#sec-5-1">5.1 Org-Mode Tag as CSS Class</a></li>
</ul>
</li>
<li><a href="#sec-6">6 Placing Stylesheets/JavaScript</a>
<ul>
<li><a href="#sec-6-1">6.1 Warning About Hidden Headlines</a></li>
<li><a href="#sec-6-2">6.2 The End</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Org-HTML-Slideshow <span class="tag"><span class="slide">slide</span></span></h2>
<div class="outline-text-2" id="text-1">
<p>
Make slides from Emacs Org-Mode!
</p>
</div>
<div id="outline-container-1-1" class="outline-3">
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Making Slides <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-1-1">
<p>
Org-Mode headlines with the <code>:slide:</code> tag will become slides.
</p>
</div>
</div>
<div id="outline-container-1-2" class="outline-3">
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> Headlines Don't Have to be Slides</h3>
<div class="outline-text-3" id="text-1-2">
<p>
This section doesn't have a <code>:slide:</code> tag, so it will <b>not</b> become a slide, although it is still part of the exported HTML document.
</p>
</div>
</div>
<div id="outline-container-1-3" class="outline-3">
<h3 id="sec-1-3"><span class="section-number-3">1.3</span> Use Lists For Bullets <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-1-3">
<ul>
<li>Use Org-Mode lists for bullet points
</li>
<li>You can make nested bullet lists
<ul>
<li>With sub-lists
</li>
<li>Like this
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-1-4" class="outline-3">
<h3 id="sec-1-4"><span class="section-number-3">1.4</span> Or Low-Level Headings <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-1-4">
<ul>
<li id="sec-1-4-1">By default<br/>
<ul>
<li id="sec-1-4-1-1">Org-Mode headings below level 3<br/>
<ul>
<li id="sec-1-4-1-1-1">Become bullets<br/>
</li>
</ul>
<ul>
<li id="sec-1-4-1-1-2">Meaning they <b>cannot</b> be slides<br/>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li id="sec-1-4-2">This is configurable<br/>
<ul>
<li id="sec-1-4-2-1">See <a href="http://orgmode.org/manual/Export-options.html">Export Options in the Org-Mode manual</a><br/>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-1-5" class="outline-3">
<h3 id="sec-1-5"><span class="section-number-3">1.5</span> Slides Can Be Nested <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-1-5">
<p>
You can use the structure of the Org-Mode document to group your slides.
</p>
<p>
For example, this slide is a <b>level-2</b> Org-Mode heading.
</p>
</div>
<div id="outline-container-1-5-1" class="outline-4">
<h4 id="sec-1-5-1"><span class="section-number-4">1.5.1</span> Slide Headings Can Be Nested <span class="tag"><span class="slide">slide</span></span></h4>
<div class="outline-text-4" id="text-1-5-1">
<p>
This slide is a <b>level-3</b> Org-Mode heading, inside the previous one.
</p>
</div>
</div>
</div>
</div>
<div id="outline-container-2" class="outline-2">
<h2 id="sec-2"><span class="section-number-2">2</span> Presenter Notes <span class="tag"><span class="slide">slide</span></span></h2>
<div class="outline-text-2" id="text-2">
<ul>
<li>Slides can have presenter notes
</li>
<li>Add a sub-heading with the <code>:notes:</code> tag
</li>
</ul>
</div>
<div id="outline-container-2-1" class="outline-3">
<h3 id="sec-2-1"><span class="section-number-3">2.1</span> A Slide with Notes <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-2-1">
<ul>
<li>This slide has notes
</li>
<li>Notes are only visible to presenter
</li>
</ul>
</div>
<div id="outline-container-2-1-1" class="outline-4">
<h4 id="sec-2-1-1"><span class="section-number-4">2.1.1</span> Notes <span class="tag"><span class="notes">notes</span></span></h4>
<div class="outline-text-4" id="text-2-1-1">
<ul>
<li>Presenter notes for this slide
</li>
<li>Not displayed as part of the slide
</li>
<li>Displayed in Presenter Preview window
</li>
<li>Only one <code>:notes:</code> section per slide allowed
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="outline-container-3" class="outline-2">
<h2 id="sec-3"><span class="section-number-2">3</span> Source Code <span class="tag"><span class="slide">slide</span></span></h2>
<div class="outline-text-2" id="text-3">
<p>
Use <code>begin_src/end_src</code> blocks to include source code.
</p>
<pre class="src src-clojure">(<span style="color: #CDA869;">defn</span> <span style="color: #9B703F;">example</span> []
(<span style="color: #7587A6;">println</span> <span style="color: #8F9D6A;">"This is sample source code."</span>))
</pre>
</div>
<div id="outline-container-3-1" class="outline-3">
<h3 id="sec-3-1"><span class="section-number-3">3.1</span> Syntax Highlighting <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-3-1">
<ul>
<li>Org-Mode HTML export uses <a href="http://www.emacswiki.org/emacs/Htmlize">htmlize.el</a>
</li>
<li>Code in exported HTML will match your current Emacs theme
<ul>
<li>Choose a theme that looks good on a projector!
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-3-2" class="outline-3">
<h3 id="sec-3-2"><span class="section-number-3">3.2</span> Syntax Highlighting with CSS Classes <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-3-2">
<ul>
<li>Set the Emacs variable
<ul>
<li><code>org-export-htmlize-output-type</code>
</li>
<li>to the symbol <code>css</code>
</li>
<li>(Does not work as a buffer-local variable)
</li>
</ul>
</li>
<li>Htmlize.el will add SPAN tags with CSS classes
<ul>
<li>Named for each font face, e.g. <code>org-comment</code>
</li>
</ul>
</li>
<li>Examine HTML output to see class names
</li>
<li>Add CSS styles to set colors
</li>
</ul>
</div>
</div>
</div>
<div id="outline-container-4" class="outline-2">
<h2 id="sec-4"><span class="section-number-2">4</span> Images <span class="tag"><span class="slide">slide</span></span></h2>
<div class="outline-text-2" id="text-4">
<ul>
<li>Slides can contain images
<ul>
<li>Any file type a browser can display
</li>
</ul>
</li>
<li>See also these Emacs variables:
<ul>
<li><code>org-export-html-inline-images</code>
</li>
<li><code>org-export-html-inline-image-extensions</code>
<ul>
<li>Controls which file types get exported
</li>
</ul>
</li>
</ul>
</li>
<li>See <a href="http://orgmode.org/manual/Images-in-HTML-export.html">Images in HTML Export in the Org-Mode manual</a>.
</li>
</ul>
</div>
<div id="outline-container-4-1" class="outline-3">
<h3 id="sec-4-1"><span class="section-number-3">4.1</span> Slide with Image <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-4-1">
<p>
Make a <code>file:</code> link with the path to the image and no link text.
</p>
<p>
<img src="example-image.svg" alt="example-image.svg" />
</p>
<p>
This example image is public-domain <a href="http://openclipart.org/detail/165554/geodesic_dome-by-yoderj">clip art by Josiah / yoderj</a>.
</p>
</div>
</div>
</div>
<div id="outline-container-5" class="outline-2">
<h2 id="sec-5"><span class="section-number-2">5</span> Styling <span class="tag"><span class="slide">slide</span></span></h2>
<div class="outline-text-2" id="text-5">
<ul>
<li>Use CSS styles to control appearance of slides
</li>
<li>Extra tags on a slide become extra CSS classes on its HTML
</li>
</ul>
</div>
<div id="outline-container-5-1" class="outline-3">
<h3 id="sec-5-1"><span class="section-number-3">5.1</span> Org-Mode Tag as CSS Class <span class="tag"><span class="slide">slide</span> <span class="blue_background">blue_background</span></span></h3>
<div class="outline-text-3" id="text-5-1">
<ul>
<li>This slide has the <code>:blue_background:</code> tag
<ul>
<li>Which is a class defined in <code>projection.css</code>
</li>
</ul>
</li>
<li>Make up your own tags
<ul>
<li>Add them to the CSS file
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="outline-container-6" class="outline-2">
<h2 id="sec-6"><span class="section-number-2">6</span> Placing Stylesheets/JavaScript <span class="tag"><span class="slide">slide</span></span></h2>
<div class="outline-text-2" id="text-6">
<p>
Include the stylesheets and JavaScript at the <b>bottom</b> of your Org-Mode file.
</p>
<p>
They must go at the bottom because the Google Closure Library does not support an on-DOM-ready event. See the <a href="http://groups.google.com/group/closure-library-discuss/browse_thread/thread/1beecbb5d6afcb41/075c536259653946">Closure mailing list discussion</a> for an explanation.
</p>
</div>
<div id="outline-container-6-1" class="outline-3">
<h3 id="sec-6-1"><span class="section-number-3">6.1</span> Warning About Hidden Headlines <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-6-1">
<p>
Stylesheets and JavaScript will <b>not</b> be loaded if the <b>last</b> headline in your Org-Mode file is hidden by any of:
</p>
<ul>
<li><code>COMMENT</code> at the start of the heading
</li>
<li><code>#+COMMENT</code> at the start of the line
</li>
<li><code>:noexport:</code> tag, or missing <code>:export:</code> tag
</li>
</ul>
<p>
See <a href="http://orgmode.org/manual/Comment-lines.html">Comment lines</a> and <a href="http://orgmode.org/manual/Selective-export.html">Selective export</a> in the Org-Mode manual for details.
</p>
</div>
</div>
<div id="outline-container-6-2" class="outline-3">
<h3 id="sec-6-2"><span class="section-number-3">6.2</span> The End <span class="tag"><span class="slide">slide</span></span></h3>
<div class="outline-text-3" id="text-6-2">
<p>
Sometimes it's safest to add an "empty" heading at the end of your document to make sure the stylesheets and JavaScript are included.
</p>
<script type="text/javascript" src="production/org-html-slideshow.js"></script>
</div>
</div>
</div>
</div>
<div id="postamble">
<p class="date">Date: 2012-03-12 19:11:09 EDT</p>
<p class="author">Author: Stuart Sierra</p>
<p class="creator">Org version 7.8.02 with Emacs version 23</p>
<a href="http://validator.w3.org/check?uri=referer">Validate XHTML 1.0</a>
</div>
</body>
</html>