-
Notifications
You must be signed in to change notification settings - Fork 15
/
emacs-conf-2020.html
1752 lines (1173 loc) · 64.3 KB
/
emacs-conf-2020.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>Powering-up Special Blocks</title>
<meta name="author" content="((link (:type https :path //alhassy.github.io/ :format bracket :raw-link https://alhassy.github.io/ :application nil :search-option nil :begin 1 :end 46 :contents-begin 31 :contents-end 44 :post-blank 0 :parent #0) Musa Al-hassy))"/>
<meta name="description" content="A modular interface for special blocks and links: defblock"/>
<style type="text/css">
.underline { text-decoration: underline; }
</style>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reveal.js/dist/reveal.css"/>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reveal.js/dist/theme/sky.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 = 'https://cdn.jsdelivr.net/npm/reveal.js/css/print/pdf.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
}
</script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<style>
.spoiler {color: pink; background-color:pink;}
.spoiler:hover {color: black; background-color:white;}
<style>
<style>
/* From: https://endlessparentheses.com/public/css/endless.css */
/* See also: https://meta.superuser.com/questions/4788/css-for-the-new-kbd-style */
kbd
{
-moz-border-radius: 6px;
-moz-box-shadow: 0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
-webkit-border-radius: 6px;
-webkit-box-shadow: 0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
background-color: #f7f7f7;
border: 1px solid #ccc;
border-radius: 6px;
box-shadow: 0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
color: #333;
display: inline-block;
font-family: 'Droid Sans Mono', monospace;
font-size: 80%;
font-weight: normal;
line-height: inherit;
margin: 0 .1em;
padding: .08em .4em;
text-shadow: 0 1px 0 #fff;
word-spacing: -4px;
box-shadow: 2px 2px 2px #222; /* MA: An extra I've added. */
}
</style>
<link rel="stylesheet" type="text/css" href="https://alhassy.github.io/org-special-block-extras/tooltipster/dist/css/tooltipster.bundle.min.css"/>
<link rel="stylesheet" type="text/css" href="https://alhassy.github.io/org-special-block-extras/tooltipster/dist/css/plugins/tooltipster/sideTip/themes/tooltipster-sideTip-punk.min.css" />
<script type="text/javascript">
if (typeof jQuery == 'undefined') {
document.write(unescape('%3Cscript src="https://code.jquery.com/jquery-1.10.0.min.js"%3E%3C/script%3E'));
}
</script>
<script type="text/javascript" src="https://alhassy.github.io/org-special-block-extras/tooltipster/dist/js/tooltipster.bundle.min.js"></script>
<script>
$(document).ready(function() {
$('.tooltip').tooltipster({
theme: 'tooltipster-punk',
contentAsHTML: true,
animation: 'grow',
delay: [100,500],
// trigger: 'click'
trigger: 'custom',
triggerOpen: {
mouseenter: true
},
triggerClose: {
originClick: true,
scroll: true
}
});
});
</script>
<style>
abbr {color: red;}
.tooltip { border-bottom: 1px dotted #000;
color:red;
text-decoration: none;}
</style>
<style>
/* From: https://endlessparentheses.com/public/css/endless.css */
/* See also: https://meta.superuser.com/questions/4788/css-for-the-new-kbd-style */
kbd
{
-moz-border-radius: 6px;
-moz-box-shadow: 0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
-webkit-border-radius: 6px;
-webkit-box-shadow: 0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
background-color: #f7f7f7;
border: 1px solid #ccc;
border-radius: 6px;
box-shadow: 0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
color: #333;
display: inline-block;
font-family: 'Droid Sans Mono', monospace;
font-size: 80%;
font-weight: normal;
line-height: inherit;
margin: 0 .1em;
padding: .08em .4em;
text-shadow: 0 1px 0 #fff;
word-spacing: -4px;
box-shadow: 2px 2px 2px #222; /* MA: An extra I've added. */
}
</style>
</head>
<body>
<div class="reveal">
<div class="slides">
<section id="sec-title-slide"><h2>Powering-up Special Blocks</h2>
<h3 style="color: green">A <em>modular</em> interface <br> for special blocks and links</h3>
<br><br>
<h4 style="color: rose"><emph>Emacs-Conf-2020</emph></h4>
<br>
<h><a href="https://alhassy.github.io/">Musa Al-hassy</a></h3>
<br>
<font size="1">
<a href="?print-pdf&showNotes=true">
⟪ <strong>Flattened View</strong> ; Press <code>?</code> for Help ⟫
</a>
</font>
<br>
<small>
<center>
<a href="https://www.gnu.org/software/emacs"><img src="https://img.shields.io/badge/Emacs-23%2F26%2F27%2F28-green?logo=gnu-emacs"></a>
<a href="https://orgmode.org"><img src="https://img.shields.io/badge/Org-9.4-blue?logo=gnu"></a>
<a href="https://github.com/alhassy/org-special-block-extras"><img src="https://img.shields.io/badge/org--special--block--extras-1.9-informational?logo=Gnu-Emacs"></a>
<br>
<a href="https://melpa.org/#/org-special-block-extras"><img alt="MELPA" src="https://melpa.org/packages/org-special-block-extras-badge.svg"/></a>
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img src="https://img.shields.io/badge/license-GNU_3-informational?logo=read-the-docs"></a>
<a href="https://github.com/alhassy/emacs.d#what-does-literate-programming-look-like"><img src="https://img.shields.io/badge/docs-literate-success?logo=read-the-docs"></a>
<br>
<a href="https://twitter.com/intent/tweet?text=This%20looks%20super%20neat%20%28%E2%80%A2%CC%80%E1%B4%97%E2%80%A2%CC%81%29%D9%88%3A:&url=https://github.com/alhassy/org-special-block-extras"><img src="https://img.shields.io/twitter/url?url=https://github.com/alhassy/org-special-block-extras"></a>
<a href="https://github.com/alhassy/org-special-block-extras/issues"><img src="https://img.shields.io/badge/contributions-welcome-green"></a>
<a href="https://alhassy.github.io/"><img src="https://img.shields.io/badge/author-musa_al--hassy-purple?logo=nintendo-3ds"></a>
<br>
<a href="https://www.buymeacoffee.com/alhassy"><img src="https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee"></a>
</center> </small>
</section>
<style>
.reveal .slide-number {
font-size: 34pt;
color: #ff2D00; }
.reveal .slides {
height: 100%;
width: 100% !important ;
top: 0;
margin-top: 0;
}
.reveal .slides>section {
min-height: 90%;
min-width: 90%;
}
.reveal .slides>section>section {
min-height: 100%;
}
.print-pdf .reveal .slides > section.present, .print-pdf .reveal .slides > section > section.present {
min-height: 770px !important;
position: relative !important;
}
.reveal table th, .reveal table td {
text-align: left;
border: none;
border-left: 1px solid transparent;
border-right: 1px solid transparent;
}
.reveal ul {
line-height: 200%
}
.reveal ol {
line-height: 200%
}
.reveal dl {
line-height: 200%
}
.reveal p {
line-height: 200%
}
.reveal pre {
font-size: 1em;
box-shadow:none;
}
</style>
<section>
<section id="slide-Overview">
<h2 id="Overview"><a href="#Overview">Overview</a></h2>
<p class="fragment (appear)">
With a bit of Lisp —and a lot of time— we obtain
</p>
<small>
<ol>
<li class="fragment appear"><p>
a uniform, and <b>practical</b>, syntax for both <i>special blocks</i> and <i>link types</i>
</p>
<br></li>
<li class="fragment appear"><p>
reusing the Org <code>src</code> interface —including arguments for blocks
and <b>global header arguments</b> for links
</p>
<br></li>
<li class="fragment appear"><p>
<b>“write once, generate many”</b>: Write markup in Org and have
it exported to other backends!
</p>
<br></li>
</ol>
<details class="code-details"
style ="padding: 1em;
background-color: #e5f5e5;
/* background-color: pink; */
border-radius: 15px;
color: hsl(157 75%);
font-size: 0.9em;
box-shadow: 0.05em 0.1em 5px 0.01em #00000057;">
<summary>
<strong>
<font face="Courier" size="3" color="green">
(•̀ᴗ•́) و
</font>
</strong>
</summary>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="org-left" />
<col class="org-left" />
<col class="org-left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="org-left">Idea</th>
<th scope="col" class="org-left">Documentation</th>
<th scope="col" class="org-left">Link only?</th>
</tr>
</thead>
<tbody>
<tr>
<td class="org-left">Colours</td>
<td class="org-left"><abbr class="tooltip" title="Declare but do not display the CONTENTS according to the BACKEND.<br><br>(fn BACKEND RAW-CONTENTS &optional MAIN-ARG &rest ## &key)">latex-definitions</abbr>, <abbr class="tooltip" title="Format text according to a given COLOR, which is black by default.<br><br>(fn BACKEND RAW-CONTENTS &optional COLOR &rest ## &key)">color</abbr></td>
<td class="org-left"> </td>
</tr>
<tr>
<td class="org-left">Parallel</td>
<td class="org-left"><abbr class="tooltip" title="Place ideas side-by-side, possibly with a seperator.<br><br>There are COLS many columns, and they may be seperated by black<br>solid vertical rules if BAR is a non-nil value.<br><br>Writing “#+begin_parallel 𝓃 :bar (any text except ‘nil’)”<br>will produce a parallel of 𝓃 many columns, possibly<br>seperated by solid rules, or a “bar”.<br><br>The contents of the block may contain ‘#+columnbreak:’ to request<br>a columnbreak. This has no effect on HTML export since HTML<br>describes how text should be formatted on a browser, which can<br>dynamically shrink and grow and thus it makes no sense to have<br>hard columnbreaks.<br><br>(fn BACKEND RAW-CONTENTS &optional COLS &rest ## &key (BAR nil))">parallel</abbr></td>
<td class="org-left"> </td>
</tr>
<tr>
<td class="org-left">Editorial Remarks</td>
<td class="org-left"><abbr class="tooltip" title="Format CONTENTS as an first-class editor comment according to BACKEND.<br><br>The CONTENTS string has an optional switch: If it contains a line<br>with having only ‘#+replacewith:’, then the text preceding this<br>clause should be replaced by the text after it; i.e., this is<br>what the EDITOR (the person editing) intends and so we fromat the<br>replacement instruction (to the authour) as such.<br><br>In Emacs, as links, editor remarks are shown with a bold red; but<br>the exported COLOR of a remark is black by default and it is not<br>STRONG ---i.e., bold---. There is an optional SIGNOFF message<br>that is appended to the remark.<br><br>(fn BACKEND RAW-CONTENTS &optional EDITOR &rest ## &key (COLOR ''black'') (SIGNOFF '''') (STRONG nil))">remark</abbr></td>
<td class="org-left"> </td>
</tr>
<tr>
<td class="org-left">Folded Details</td>
<td class="org-left"><abbr class="tooltip" title="Enclose contents in a folded up box, for HTML.<br><br>For LaTeX, this is just a boring, but centered, box.<br><br>By default, the TITLE of such blocks is “Details”<br>and its TITLE-COLOR is green.<br><br>In HTML, we show folded, details, regions with a nice greenish colour.<br><br>In the future ---i.e., when I have time---<br>it may be prudent to expose more aspects as arguments,<br>such as ‘background-color’.<br><br>(fn BACKEND RAW-CONTENTS &optional TITLE &rest ## &key (TITLE-COLOR ''green''))">details</abbr> , <abbr class="tooltip" title="Enclose text in a box, possibly with a title.<br><br>By default, the box’s COLOR is green for HTML and red for LaTeX,<br>and it has no TITLE.<br><br>The HTML export uses a padded div, whereas the LaTeX export<br>requires the tcolorbox pacakge.<br><br>In the future, I will likely expose more arguments.<br><br>(fn BACKEND RAW-CONTENTS &optional TITLE &rest ## &key (BACKGROUND-COLOR nil))">box</abbr></td>
<td class="org-left"> </td>
</tr>
<tr>
<td class="org-left">Keystrokes</td>
<td class="org-left"><kbd> C-c C-e </kbd></td>
<td class="org-left"><code>kbd</code></td>
</tr>
<tr>
<td class="org-left">OctoIcons & Link Here</td>
<td class="org-left"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M0 2a1 1 0 011-1h14a1 1 0 011 1v9a1 1 0 01-1 1H7l-4 4v-4H1a1 1 0 01-1-1V2zm1 0h14v9H6.5L4 13.5V11H1V2zm6 6h2v2H7V8zm0-5h2v4H7V3z"></path></svg> <a class="anchor" aria-hidden="true" id="Overview" href="#Overview"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16
16" width="16" height="16"><path fill-rule="evenodd"
d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69
3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10
5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0
2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5
0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55
13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a></td>
<td class="org-left"><code>octoicon</code>, <code>link-here</code></td>
</tr>
<tr>
<td class="org-left">Documentation-Glossary</td>
<td class="org-left"><abbr class="tooltip" title="Register the dictionary entries in CONTENTS to the dictionary variable.<br><br>The dictionary variable is ‘org-special-block-extras--docs’.<br><br>A documentation entry may have its LABEL, its primary identifier,<br>be:<br>1. Omitted<br>2. Given as a single symbol<br>3. Given as a many aliases ’(lbl₀ lbl₁ … lblₙ)<br><br>The third case is for when there is no canonical label to refer to<br>an entry, or it is convenient to use multiple labels for the same<br>entry.<br><br>In all of the above cases, two additional labels are included:<br>The entry name with spaces replaced by underscores, and again but<br>all lower case.<br><br>Documentation blocks are not shown upon export;<br>unless SHOW is non-nil, in which case they are shown<br>using the ‘box’ block, with the provided COLOR passed to it.<br><br>In the futture, it may be nice to have an option to render tooltips.<br>That’d require the ‘doc:𝒳’ link construction be refactored via a ‘defun’.<br><br>(fn BACKEND RAW-CONTENTS &optional NAME &rest ## &key (LABEL nil) (SHOW nil) (COLOR ''green''))">documentation</abbr></td>
<td class="org-left"><code>doc</code></td>
</tr>
</tbody>
</table>
<p>
Other fun stuff: <abbr class="tooltip" title="Show the answers to a problem, but with a reprimand in case no attempt was made.<br><br>(fn BACKEND RAW-CONTENTS &optional TITLE &rest ## &key (REPRIMAND ''Did you actually try? Maybe see the ‘hints’ above!'') (REALLY ''Solution, for real''))">solution</abbr>, <abbr class="tooltip" title="Output the CONTENTS of the block as both parsed Org and unparsed.<br><br>Label the source text by SOURCE and the result text by RESULT<br><br>finally, the source-result fragments can be shown in a STYLE<br>that is either “parallel” (default) or “sequential”.<br><br>(fn BACKEND RAW-CONTENTS &optional MAIN-ARG &rest ## &key (SOURCE ''Source'') (RESULT ''Result'') (SOURCE-COLOR ''cyan'') (RESULT-COLOR ''cyan'') (STYLE ''parallel''))">org-demo</abbr>, <abbr class="tooltip" title="Output the CONTENTS of the block REPS many times<br><br>(fn BACKEND RAW-CONTENTS &optional REPS &rest ## &key)">stutter</abbr>, <abbr class="tooltip" title="Perform the given LIST of substitutions on the text.<br>The LIST is a comma separated list of ‘to’ separated symbols.<br>In a link, no quotes are needed.<br><br>(fn BACKEND RAW-CONTENTS &optional LIST &rest ## &key)">rename</abbr>, <abbr class="tooltip" title="Hide text enclosed in double parens ((like this)) as if it were spoilers.<br>  LEFT and RIGHT may be other kinds of delimiters.<br><br>(fn BACKEND RAW-CONTENTS &optional MAIN-ARG &rest ## &key (LEFT ''(('') (RIGHT ''))''))">spoiler</abbr> (─‿‿─)
</p>
</details>
<div style="padding: 1em; background-color: #CCFFCC;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3>Incidentally</h3>
<p>
😂 The setup joyously works for org-reveal 😹
</p>
<p>
🥰 🍭 🦄 😆
</p>
</div>
</small>
</section>
</section>
<section>
<section id="slide-org1ec463c">
<h2 id="org1ec463c"><a href="#org1ec463c">Motivation</a></h2>
<p>
See an <b>
<span style="color:green;">
aesthetically pleasing style
</span>
</b> online and seek to reproduce it …
</p>
<br>
<p class="fragment (appear)">
⇄ The author wrote raw HTML
</p>
<p>
<span class="spoiler"> Obscures my source with styling information! </span>
</p>
<p class="fragment (appear)">
⇄ The author wraps the HTML in an <code>{{{Org-macro}}}</code>
</p>
<p>
<span class="spoiler"> Not useful if I want to export to PDF! </span>
</p>
<p class="fragment (appear)">
⇄
<span style="color:red;">
The author doesn't even provide the source!
</span>
</p>
<p>
<span class="spoiler"> Time to ‘View Page Source’ and do a lot of reading! </span>
</p>
<p class="fragment (appear)">
⇉ We want <b><b>
<span style="color:magenta;">
Org users
</span>
</b></b> to have <b>
<span style="color:green;">
numerous
</span>
</b> styles available
and an <b>
<span style="color:green;">
extensible
</span>
</b> mechanism to add more! ⇇
</p>
</section>
</section>
<section>
<section id="slide-Once-upon-a-time">
<h2 id="Once-upon-a-time"><a href="#Once-upon-a-time">Once upon a time</a></h2>
<p class="fragment (appear)">
Three friends ---
<span style="color:green;">
Amin
</span>
,
<span style="color:red;">
Sacha
</span>
, and
<span style="color:blue;">
Corwin
</span>
— were organising a conference
</p>
<p class="fragment (appear)">
… <b>
<span style="color:orange;">
EmacsConf2020
</span>
!</b>
</p>
<br>
<p class="fragment (appear)">
Sacha wrote an Org file and wanted some <b>feedback</b>
</p>
<br>
<details class="code-details"
style ="padding: 1em;
background-color: #e5f5e5;
/* background-color: pink; */
border-radius: 15px;
color: hsl(157 75%);
font-size: 0.9em;
box-shadow: 0.05em 0.1em 5px 0.01em #00000057;">
<summary>
<strong>
<font face="Courier" size="3" color="green">
Source for this slide!
</font>
</strong>
</summary>
<div class="org-src-container">
<pre class="src src-org"><code trim><span style="color: #35a69c;">#+ATTR_REVEAL: :frag (appear)</span>
Three friends ---<span style="color: #00ff00;"><a href="green:Amin">green:Amin</a></span>, <span style="color: #ff0000;"><a href="red:Sacha">red:Sacha</a></span>,
and <span style="color: #0000ff;"><a href="blue:Corwin">blue:Corwin</a></span>--- were organising a conference
<span style="color: #35a69c;">#+ATTR_REVEAL: :frag (appear)</span>
... <span style="color: #ffa500; font-weight: bold;"><a href="orange:EmacsConf2020">orange:EmacsConf2020</a></span><span style="font-weight: bold;">!</span>
<span style="color: #35a69c;">#+html: <br></span>
<span style="color: #35a69c;">#+ATTR_REVEAL: :frag (appear)</span>
Sacha wrote an Org file and wanted <span style="text-decoration: underline;">some</span> <span style="font-weight: bold;">feedback</span>
</code></pre>
</div>
</details>
</section>
</section>
<section>
<section id="slide-orga601991">
<h3 id="orga601991"><a href="#orga601991">What <i>kind</i> of feedback?</a></h3>
<ul>
<li class="fragment appear"><p>
top-level <abbr class="tooltip" title="Format CONTENTS as an first-class editor comment according to BACKEND.<br><br>The CONTENTS string has an optional switch: If it contains a line<br>with having only ‘#+replacewith:’, then the text preceding this<br>clause should be replaced by the text after it; i.e., this is<br>what the EDITOR (the person editing) intends and so we fromat the<br>replacement instruction (to the authour) as such.<br><br>In Emacs, as links, editor remarks are shown with a bold red; but<br>the exported COLOR of a remark is black by default and it is not<br>STRONG ---i.e., bold---. There is an optional SIGNOFF message<br>that is appended to the remark.<br><br>(fn BACKEND RAW-CONTENTS &optional EDITOR &rest ## &key (COLOR ''black'') (SIGNOFF '''') (STRONG nil))">remarks</abbr> <i>visible in the export</i>
</p>
<p class="fragment (appear)">
… suggest
<span style="color:red;">
replacement
</span>
text
</p>
<p class="fragment (appear)">
… this is not possible,
<span style="color:green;">
elegantly
</span>
, with raw HTML!
</p>
<br></li>
<li class="fragment appear"><p>
<abbr class="tooltip" title="Perform the given LIST of substitutions on the text.<br>The LIST is a comma separated list of ‘to’ separated symbols.<br>In a link, no quotes are needed.<br><br>(fn BACKEND RAW-CONTENTS &optional LIST &rest ## &key)">translate</abbr> in the export
</p>
<p class="fragment (appear)">
… everyone speaks different languages!
</p>
<p class="fragment (appear)">
… or suggest a rewrite, without altering the other person's
text
</p>
<p class="fragment (appear)">
… this is not possible with raw HTML
<span style="color:red;">
at all
</span>
!
</p></li>
</ul>
</section>
</section>
<section>
<section id="slide-orgd72a039">
<h3 id="orgd72a039"><a href="#orgd72a039">Example 💓 Text and Feedback</a></h3>
<p>
Sacha …
</p>
<div style="column-rule-style: none;column-count: 2;">
<div style="padding: 1em; background-color: cyan;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3>Writes</h3>
Let's begin at $\sqrt{3 + \sum_{i = 0}^{12} i}$ in the *morning*.\newline
</div>
<div style="padding: 1em; background-color: cyan;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3>Sees</h3>
<p>
Let's begin at \(\sqrt{3 + \sum_{i = 0}^{12} i}\) in the <b>morning</b>.
</p>
</div>
</div>
<p>
She gets feedback …
</p>
<div style="column-rule-style: none;column-count: 2;">
<small>
<p style="color: black;"><span style="border-width:1px;border-style:solid;padding:5px"><strong>[Amin:</strong></span>
<p>
How about
</p>
<p>
<code class="src src-emacs-lisp">(<span style="color: #b58900;">sqrt</span> (<span style="color: #b58900;">apply</span> '<span style="color: #b58900;">+</span> 3 (<span style="color: #b58900;">number-sequence</span> 0 12)))</code> ;-)
</p>
<span style="border-width:1px;border-style:solid;padding:5px"><strong>]</strong></span></p>
</small>
<hr>
<small>
<p style="color: black;"><span style="border-width:1px;border-style:solid;padding:5px"><strong>[Corwin:</strong></span>
<p>
C'mon guys, let's just say <b>9 am</b>!
</p>
<span style="border-width:1px;border-style:solid;padding:5px"><strong>]</strong></span></p>
</small>
</div>
</section>
</section>
<section>
<section id="slide-Amin-️-LaTeX">
<h3 id="Amin-️-LaTeX"><a href="#Amin-️-LaTeX">Amin ❤️ LaTeX</a></h3>
<div style="padding: 1em; background-color: #CCFFCC;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3></h3>
<p>
Amin likes to export to PDF, so he wrote top-level
remarks using LaTeX
</p>
</div>
<div class="org-src-container">
<pre class="fragment (appear)"><code trim><span style="color: #35a69c;">#+latex: {\color{green} \fbox{[Amin:}}</span>
Please change …
<span style="color: #35a69c;">#+latex: \fbox{]}</span>
</code></pre>
</div>
<p style="color: green;"><span style="border-width:1px;border-style:solid;padding:5px"><strong>[Amin:</strong></span>
<p>
Please change …
</p>
<span style="border-width:1px;border-style:solid;padding:5px"><strong>]</strong></span></p>
</section>
</section>
<section>
<section id="slide-Sacha-PDF">
<h3 id="Sacha-PDF"><a href="#Sacha-PDF">Sacha 💔 PDF</a></h3>
<div style="padding: 1em; background-color: #FFCCFF;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3></h3>
<p class="fragment (appear)">
But Sacha likes to look at the resulting
<span style="color:green;">
HTML
</span>
! … not PDFs!
</p>
</div>
<div style="padding: 1em; background-color: #CCFFFF;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3></h3>
<p class="fragment (appear)">
So, she <i>may</i>
<span style="color:red;">
not
</span>
see his top-level feedback
and she <i>may</i>
<span style="color:red;">
forgot
</span>
to look at the Org source
</p>
</div>
<div style="padding: 1em; background-color: #CCFFCC;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3></h3>
<p class="fragment (appear)">
Happily, she thinks things are
<span style="color:red;">
all
</span>
<span style="color:red;">
good
</span>
…!
</p>
</div>
</section>
</section>
<section>
<section id="slide-Amin-HTML">
<h3 id="Amin-HTML"><a href="#Amin-HTML">Amin 💢 HTML</a></h3>
<p class="fragment (appear)">
Sacha may write top-level feedback …
</p>
<div style="padding: 1em; background-color: #FFFFCC;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3></h3>
<div class="org-src-container">
<pre class="fragment (appear)"><code trim><span style="color: #35a69c;">#+html: <strong> [Sacha Speculates: </strong></span>
I think that maybe we could try …
<span style="color: #35a69c;">#+html: <strong> End of speculations] </strong></span>
</code></pre>
</div>
</div>
<p style="color: black;"><span style="border-width:1px;border-style:solid;padding:5px"><strong>[Sacha Speculates:</strong></span>
<p>
I think that maybe we could try …
</p>
<strong> End of speculations</strong> <span style="border-width:1px;border-style:solid;padding:5px"><strong>]</strong></span></p>
<div style="padding: 1em; background-color: #CCFFCC;border-radius: 15px; font-size: 0.9em; box-shadow: 0.05em 0.1em 5px 0.01em #00000057;"><h3></h3>
<p class="fragment (appear)">
Now Amin exports to PDF; take a quick glance and
not notice anything standing out; thinks
<span style="color:red;">
<i>it's all OK</i>
</span>
</p>
</div>
</section>
</section>
<section>
<section id="slide-">
<h3 id=""><a href="#">💥 😧 💭 📖</a></h3>
<p class="fragment (appear)">
Corwin
<span style="color:cyan;">
actually
</span>
reads an exported result, and is worried at what he sees.
</p>
<br>
<p class="fragment (appear)">
Amin & Sacha agree to read up and make <b>
<span style="color:green;">
a uniform Org interface that
exports to both HTML & PDF
</span>
</b>
</p>
<br>
<p class="fragment (appear)">
They use Org <i>“special blocks”</i>!
</p>
</section>
</section>
<section>
<section id="slide-How-to-set-up-special-blocks">
<h3 id="How-to-set-up-special-blocks"><a href="#How-to-set-up-special-blocks">How to set up special blocks?</a></h3>
<p class="fragment (appear)">
They agree to figure out the necessary
<span style="color:magenta;">
Lisp
</span>
,
</p>
<p class="fragment (appear)">
<span style="color:cyan;">
hooks
</span>
,
<span style="color:blue;">
advice
</span>
, and
<span style="color:violet;">
macros
</span>
needed to form a
</p>
<p class="fragment (appear)">
special custom block that outputs <b>both</b> HTML and PDF, <br>
<span style="color:green;">
but
</span>
uses Org as interface.
</p>
<p class="fragment (appear)">
So much work, but it's worth it!
</p>
<p class="fragment (appear)">
<span style="color:red;">
…!?
</span>
</p>
</section>
</section>
<section>
<section id="slide-Corwin-Terse">
<h3 id="Corwin-Terse"><a href="#Corwin-Terse">Corwin 🥶 🤔 🥊 <i>Terse!</i></a></h3>
<p class="fragment (appear)">
Corwin likes to provide
<span style="color:blue;">
terse
</span>
, <i>right to the point</i>, feedback
and thinks blocks are overkill.
</p>
<p class="fragment (appear)">
The team decides to incorporate an
<span style="color:red;">
Org-link
</span>
<span style="color:red;">
type
</span>
</p>
<p class="fragment (appear)">
and
<span style="color:green;">
—to avoid duplication of code!---
</span>
they have the link
type reuse the core code of the block type.
</p>
</section>
</section>
<section>
<section id="slide-How-to-setup-Org-links">
<h3 id="How-to-setup-Org-links"><a href="#How-to-setup-Org-links">How to setup Org links?</a></h3>
<p class="fragment (appear)">
They have their
<span style="color:pink;">
own interface
</span>
…!
</p>
<p class="fragment (appear)">
<span style="color:gray;">
Need
</span>
<span style="color:violet;">
to
</span>