-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
550 lines (511 loc) · 20.2 KB
/
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
<?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>
<!-- 2019-07-08 Mon 14:15 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Supporting management of teaching material with org-mode</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Olivier Berger" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2019 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">Supporting management of teaching material with org-mode</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgcbcd70e">1. Goal</a></li>
<li><a href="#org7d95a19">2. Home of the project</a></li>
<li><a href="#orgb7efb8f">3. Testing it</a>
<ul>
<li><a href="#orga0d03d5">3.1. Documentation and example teaching materials</a></li>
<li><a href="#org979448c">3.2. Rebuilding the docs</a></li>
</ul>
</li>
<li><a href="#orge4a6121">4. Features</a>
<ul>
<li><a href="#org881ce3e">4.1. Single source</a></li>
<li><a href="#org43b90ee">4.2. Teaching to the audience with a slides deck</a></li>
<li><a href="#org2ca69fe">4.3. Providing a reference handbook to students</a></li>
<li><a href="#org233c4c7">4.4. Providing additional material to teachers</a></li>
</ul>
</li>
<li><a href="#org55cd6f8">5. Changelog</a></li>
<li><a href="#org5a58751">6. History</a></li>
<li><a href="#orga8ef9c8">7. Copyright & license</a></li>
</ul>
</div>
</div>
<p>
This file is <code>README.org</code> and is best viewed in org-mode in Emacs… go git clone, or <a href="https://olberger.gitlab.io/org-teaching/README.html">read it online</a> ;-)
</p>
<div id="outline-container-orgcbcd70e" class="outline-2">
<h2 id="orgcbcd70e"><span class="section-number-2">1</span> Goal</h2>
<div class="outline-text-2" id="text-1">
<p>
This repository contains an example of how to manage some source files
of teaching material, using <a href="http://orgmode.org/">org-mode</a> in
Emacs.
</p>
<p>
It uses <a href="https://github.com/yjwen/org-reveal/">org-reveal</a> in
addition to the standard LaTeX exporter.
</p>
</div>
</div>
<div id="outline-container-org7d95a19" class="outline-2">
<h2 id="org7d95a19"><span class="section-number-2">2</span> Home of the project</h2>
<div class="outline-text-2" id="text-2">
<p>
The project sources are available in
<a href="https://gitlab.com/olberger/org-teaching">https://gitlab.com/olberger/org-teaching</a>.
</p>
<p>
See its generated documentation at the
<a href="https://olberger.gitlab.io/">Gitlab pages</a>, either:
</p>
<ul class="org-ul">
<li>as <a href="https://olberger.gitlab.io/org-teaching/slides.html">a slides deck</a>,</li>
<li>or a printable A4 <a href="https://olberger.gitlab.io/org-teaching/handbook.pdf">PDF handbook</a> variant of the above (including presenter notes),</li>
<li>or a printable <a href="https://olberger.gitlab.io/org-teaching/teacher-handbook.pdf">PDF handbook</a> enhanced with remarks for the advanced users</li>
</ul>
<p>
These documentes serve as an example of its use, in addition of the
frameworks' documentation.
</p>
<p>
<del>A more or less up to date snapshot may be found at
<a href="http://www-public.tem-tsp.eu/~berger_o/org-teaching/slides.html">http://www-public.tem-tsp.eu/~berger<sub>o</sub>/org-teaching/</a></del>
</p>
</div>
</div>
<div id="outline-container-orgb7efb8f" class="outline-2">
<h2 id="orgb7efb8f"><span class="section-number-2">3</span> Testing it</h2>
<div class="outline-text-2" id="text-3">
</div>
<div id="outline-container-orga0d03d5" class="outline-3">
<h3 id="orga0d03d5"><span class="section-number-3">3.1</span> Documentation and example teaching materials</h3>
<div class="outline-text-3" id="text-3-1">
<p>
Read the documentation first. See the contents of the provided HTML
and PDF files, or directly <code>lesson.org</code> under Emacs, equipped
with org-mode (org-mode should be there by default in recent Emacs
distributions).
</p>
<p>
These files represent the standard set of teaching materials in
<i>org-teaching</i>, used for documenting the project, and as an example
(<i>note that these links may be best viewed in Emacs from a local clone
of the Git repo, as Gitlab may not provide the best experience</i>):
</p>
<ul class="org-ul">
<li><b>slides</b> in: <a href="./slides.html">./slides.html</a> (an additional variant is a regular
HTML export in <a href="./lesson.html">./lesson.html</a>; another is <a href="./slides.pdf">"printed slides" in PDF</a>)</li>
<li>the <b>handbook for the students</b>: <a href="./handbook.pdf">./handbook.pdf</a></li>
<li>the <b>handbook for the teachers</b>: <a href="./teacher-handbook.pdf">./teacher-handbook.pdf</a>
(this one has more details for this <i>org-teaching</i> documentation)</li>
</ul>
<p>
All these are generated from the corresponding <code>.org</code> files, which all
include the common lesson content from <code>lesson.org</code>. You may
prefer to read this file directly with Emacs.
</p>
</div>
</div>
<div id="outline-container-org979448c" class="outline-3">
<h3 id="org979448c"><span class="section-number-3">3.2</span> Rebuilding the docs</h3>
<div class="outline-text-3" id="text-3-2">
<p>
The provided <a href="Makefile">Makefile</a> can be used to regenerate the
documentation from its source, drinking its own champaign.
</p>
<p>
It uses the tools from the <a href="docker/">docker/</a> subdir for the Docker
container powering the org-mode exporters (see docs at
<a href="https://gitlab.com/olberger/docker-org-teaching-export/">https://gitlab.com/olberger/docker-org-teaching-export/</a>).
</p>
<p>
In order to use it, pay attention to the
<a href="https://git-scm.com/book/en/v2/Git-Tools-Submodules">git
submodules</a> that need to be retrieved : <a href="elisp/org-reveal">elisp/org-reveal</a>,
<a href="reveal.js">reveal.js</a> and <a href="docker/">docker/</a>.
</p>
<div class="org-src-container">
<pre class="src src-sh">git submodule init
git submodule update
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-orge4a6121" class="outline-2">
<h2 id="orge4a6121"><span class="section-number-2">4</span> Features</h2>
<div class="outline-text-2" id="text-4">
<p>
The following features are provided:
</p>
</div>
<div id="outline-container-org881ce3e" class="outline-3">
<h3 id="org881ce3e"><span class="section-number-3">4.1</span> Single source</h3>
<div class="outline-text-3" id="text-4-1">
<p>
A single org-mode source file contains the core of the lesson
including listings and/or executable bits managed with org-babel or
other classical org-mode features. In the provided example, this is
<code>lesson.org</code>.
</p>
<p>
This single file is meant for editing, and the rest of the files
provide the framework for generating the different outputs described below.
</p>
</div>
</div>
<div id="outline-container-org43b90ee" class="outline-3">
<h3 id="org43b90ee"><span class="section-number-3">4.2</span> Teaching to the audience with a slides deck</h3>
<div class="outline-text-3" id="text-4-2">
<p>
We deliver the course by presenting a slides deck for each lesson,
using <a href="http://lab.hakim.se/reveal-js/">reveal.js</a>. In the provided
example, this is <code>slides.html</code>.
</p>
<p>
Reveal.js displays slides as Web pages (using the Web browser in
fullscreen mode) with a 2-dimensional structure of slides allowing the
presentation of a main track of slides (horizontal ones), and
additional slides (vertical ones), if need is, to dive into more
details on a specific section of the lesson (typically for Q/A).
Reveal.js also offers support for a "presentation mode" allowing the
use of multiple displays so that the presenter can read additional
notes. I've chose to "tune down" reveal.js to avoid fancy 3D
animations, and stick to a more sober display, but YMMV.
</p>
</div>
</div>
<div id="outline-container-org2ca69fe" class="outline-3">
<h3 id="org2ca69fe"><span class="section-number-3">4.3</span> Providing a reference handbook to students</h3>
<div class="outline-text-3" id="text-4-3">
<p>
The content of the presentation is also rendered as a handbook which
is provided to the students. It contains the same things as the slides
deck, including presenter notes, which are embedded in the
document. In the provided example, this is <code>handbook.pdf</code>.
</p>
<p>
This handbook is rendered with LaTeX as an "article" A4 PDF.
</p>
</div>
</div>
<div id="outline-container-org233c4c7" class="outline-3">
<h3 id="org233c4c7"><span class="section-number-3">4.4</span> Providing additional material to teachers</h3>
<div class="outline-text-3" id="text-4-4">
<p>
An additional document is produced which contains the same stuff as
the students handbook, but also embeds additional sections meant to be
read only by the teachers. In the provided example, this is
<code>teacher-handbook.pdf</code>.
</p>
</div>
</div>
</div>
<div id="outline-container-org55cd6f8" class="outline-2">
<h2 id="org55cd6f8"><span class="section-number-2">5</span> Changelog</h2>
<div class="outline-text-2" id="text-5">
<ul class="org-ul">
<li>2019/07 Update to docker-org-teaching-export 1.2</li>
</ul>
</div>
</div>
<div id="outline-container-org5a58751" class="outline-2">
<h2 id="org5a58751"><span class="section-number-2">6</span> History</h2>
<div class="outline-text-2" id="text-6">
<p>
I've been teaching a course on Web architecture and applications
(CSC4101) at Telecom SudParis and wanted to manage the sources for the
different teaching materials using org-mode.
</p>
<p>
Org-mode allows me to save the sources of documents in a revision
control system (typically Git), as it's based on plain text.
</p>
<p>
It also allow the generation of different documents for different uses
or audiances from a single source.
</p>
<p>
As I was teaching Web stuff, I also wanted to drink my own champagne
using as much Web as I could (i.e. HTML).
</p>
</div>
</div>
<div id="outline-container-orga8ef9c8" class="outline-2">
<h2 id="orga8ef9c8"><span class="section-number-2">7</span> Copyright & license</h2>
<div class="outline-text-2" id="text-7">
<p>
This content is provided under the clauses of the MIT License, unless
otherwise specified (in particular, copies of org-reveal and reveal.js
are provided under their respective terms).
</p>
<p>
Copyright (c) 2016-2018 Olivier Berger and Institut Mines Telecom
</p>
<p>
[See also the LICENSE file].
</p>
<p>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
</p>
<p>
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
</p>
<p>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
</p>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Olivier Berger</p>
<p class="date">Created: 2019-07-08 Mon 14:15</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>