File: misc.html

package info (click to toggle)
golang-github-niklasfasching-go-org 1.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 788 kB
  • sloc: sh: 142; makefile: 42
file content (596 lines) | stat: -rw-r--r-- 18,521 bytes parent folder | download
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
<h1 class="title">Misc title <b>with an inline html export</b></h1>
<nav>
<ul>
<li><a href="#headline-1">issues from goorgeous (free test cases, yay!)</a>
<ul>
<li><a href="#headline-2">#19: Support #+HTML</a>
</li>
<li><a href="#headline-3">#29: Support verse block</a>
</li>
<li><a href="#headline-4">#30: Support #+SETUPFILE</a>
</li>
<li><a href="#headline-5">#31: Support #+INCLUDE</a>
</li>
<li><a href="#headline-6">#33: Wrong output when mixing html with Org mode</a>
</li>
<li><a href="#headline-7">#41: Support Table Of Contents</a>
</li>
<li><a href="#headline-8">#46: Support for symbols like ndash and mdash</a>
</li>
<li><a href="#headline-9">#47: Consecutive <code>code</code> wrapped text gets joined</a>
</li>
<li><a href="#headline-10">#50: LineBreaks in lists are preserved</a>
</li>
<li><a href="#headline-11">#68: Quote block with inline markup</a>
</li>
<li><a href="#headline-12">#72: Support for #+ATTR_HTML</a>
</li>
<li><a href="#headline-13">#75: Not parsing nested lists correctly</a>
</li>
<li><a href="#headline-14">#77: Recognize <code class="verbatim">code</code>— as code plus dash</a>
</li>
<li><a href="#headline-15">#78: Emphasis at beginning of line</a>
</li>
<li><a href="#headline-16">#82: Crash on empty headline</a>
<ul>
<li><a href="#headline-17"></a>
</li>
</ul>
</li>
<li><a href="#headline-18">#84: Paragraphs that are not followed by an empty line are not parsed correctly</a>
<ul>
<li><a href="#headline-19">Foo</a>
</li>
<li><a href="#headline-20">Bar</a>
</li>
</ul>
</li>
<li><a href="#headline-21">#86: Multiple hyphens not converted to dashes</a>
</li>
<li><a href="#headline-22">#87: Markup in footnotes is rendered literally</a>
</li>
<li><a href="#headline-23">#92: src blocks only render in caps</a>
</li>
</ul>
</li>
<li><a href="#headline-24">issues (wrongly) filed with hugo</a>
<ul>
<li><a href="#headline-25">#3874 exporting images in org mode</a>
</li>
<li><a href="#headline-26">#4006 source code blocks in org not rendered correctly</a>
</li>
</ul>
</li>
<li><a href="#headline-27">misc fuzz / regression / edge case</a>
<ul>
<li><a href="#headline-28">index out of range in headline priority parsing</a>
<ul>
<li><a href="#headline-29">[#B</a>
</li>
</ul>
</li>
<li><a href="#headline-30">index out of range in explicit line break parsing</a>
</li>
<li><a href="#headline-31">list items don&#39;t end on child headline</a>
<ul>
<li><a href="#headline-32">followed by a child headline</a>
</li>
</ul>
</li>
</ul>
</li>
<li><a href="#headline-33">Footnotes</a>
</li>
</ul>
</nav>
<div id="outline-container-headline-1" class="outline-3">
<h3 id="headline-1">
issues from goorgeous (free test cases, yay!)
</h3>
<div id="outline-text-headline-1" class="outline-text-3">
<div id="outline-container-headline-2" class="outline-4">
<h4 id="headline-2">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/19">#19</a>: Support #+HTML
</h4>
<div id="outline-text-headline-2" class="outline-text-4">
<p style="border: 1px dotted grey">neato!</p>
</div>
</div>
<div id="outline-container-headline-3" class="outline-4">
<h4 id="headline-3">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/29">#29:</a> Support verse block
</h4>
<div id="outline-text-headline-3" class="outline-text-4">
<div class="verse-block">
<p>This
<strong>is</strong>
verse</p>
</div>
<div class="custom-block">
<p>or even a <strong>totally</strong> <em>custom</em> kind of block
crazy ain&#39;t it?</p>
</div>
</div>
</div>
<div id="outline-container-headline-4" class="outline-4">
<h4 id="headline-4">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/30">#30</a>: Support #+SETUPFILE
</h4>
<div id="outline-text-headline-4" class="outline-text-4">
<p>see <code class="verbatim">./headlines.org</code></p>
</div>
</div>
<div id="outline-container-headline-5" class="outline-4">
<h4 id="headline-5">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/31">#31</a>: Support #+INCLUDE
</h4>
<div id="outline-text-headline-5" class="outline-text-4">
<p>Note that only src/example/export block inclusion is supported for now.
There&#39;s quite a lot more to include (see the <a href="https://orgmode.org/manual/Include-files.html">org manual for include files</a>) but I
don&#39;t have a use case for this yet and stuff like namespacing footnotes of included files
adds quite a bit of complexity.</p>
<p>
for now files can be included as:</p>
<ul>
<li>
<p>src block</p>
<div class="src src-org">
<div class="highlight">
<pre>
#+SETUPFILE: setup_file_org
#+OPTIONS: toc:1
* Simple Headline [1/2]
- [X] checked
- [ ] unchecked
- note that statistic tokens are marked up anywhere
  not just where they are actually meant to be - even here &gt; [100%] &lt;
  (Org mode proper does the same)
* TODO [#B] Headline with todo status &amp; priority
* DONE Headline with TODO status
:PROPERTIES:
:custom_id: this-will-be-the-id-of-the-headline
:note: property drawers are not exported as html like other drawers
:END:

we can link to headlines that define a custom_id: [[#this-will-be-the-id-of-the-headline]]
* [#A] Headline with tags &amp; priority                                :foo:bar:
Still outside the drawer
:DRAWERNAME:
This is inside the drawer
:end:
Still outside the drawer
* CUSTOM headline with custom status
it&#39;s possible to use =#+SETUPFILE= - in this case the setup file contains the following

#+INCLUDE: &#34;setup_file_org&#34; src org
* excluded headline                                                :custom_noexport:
this headline and it&#39;s content are not exported as it is marked with an =EXCLUDE_TAGS= tag.
By default =EXCLUDE_TAGS= is just =:noexport:=.

* malformed property drawer
:PROPERTIES:
not a property
:END:
* level limit for headlines to be included in the table of contents
The toc option allows setting a [[https://orgmode.org/manual/Export-settings.html][level limit]]. For this file we set it to 1 - which means that the following headlines
won&#39;t be included in the table of contents.
** headline 2 not in toc
*** headline 3 not in toc
** anoter headline 2 not in toc
you get the gist...
</pre>
</div>
</div>
</li>
<li>
<p>export block</p>
<p>Paragraphs are the default element.</p>
<p>
Empty lines and other elements end paragraphs - but paragraphs
can
obviously
span
multiple
lines.</p>
<p>
Paragraphs can contain inline markup like <em>emphasis</em> <strong>strong</strong>  and links <a href="https://www.example.com">example.com</a> and stuff.</p>
</li>
<li>
<p>example block</p>
<pre class="example">
name: CI

on:
  push:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: git
      run: |
        git clone --depth 1 &#34;https://x-access-token:${{secrets.GITHUB_TOKEN}}@github.com/${GITHUB_REPOSITORY}&#34; .
        git config user.name &#34;GitHub Action&#34;
        git config user.email &#34;action@github.com&#34;
        git log -1 --format=&#34;%H&#34;
    - name: go
      run: sudo snap install go --classic
    - name: test
      run: make test
    - name: gh-pages
      run: |
        git checkout --orphan gh-pages &amp;&amp; git reset
        make generate-gh-pages
        git add -f docs/ &amp;&amp; git commit -m deploy
        git push -f origin gh-pages
    - name: notify
      if: ${{ failure() }}
      run: |
        text=&#34;https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID} failed&#34;
        curl --silent --output /dev/null ${{secrets.TELEGRAM_URL}} -d &#34;chat_id=${{secrets.TELEGRAM_CHAT_ID}}&amp;text=${text}&#34;
</pre>
</li>
</ul>
</div>
</div>
<div id="outline-container-headline-6" class="outline-4">
<h4 id="headline-6">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/33">#33</a>: Wrong output when mixing html with Org mode
</h4>
<div id="outline-text-headline-6" class="outline-text-4">
<div class="outline-2" id="meta" style="color: green;">
<table>
<tbody>
<tr>
<td><strong>foo</strong></td>
<td>foo</td>
</tr>
<tr>
<td><strong>bar</strong></td>
<td>bar</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="outline-container-headline-7" class="outline-4">
<h4 id="headline-7">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/41">#41</a>: Support Table Of Contents
</h4>
</div>
<div id="outline-container-headline-8" class="outline-4">
<h4 id="headline-8">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/46">#46</a>: Support for symbols like ndash and mdash
</h4>
<div id="outline-text-headline-8" class="outline-text-4">
<ul>
<li>ndash –</li>
<li>mdash —</li>
<li>ellipsis …</li>
<li>acute Á and so on</li>
<li>note that —— is replaced with 2 mdashes and …. becomes ellipsis+. and so on - that&#39;s how org also does it</li>
</ul>
</div>
</div>
<div id="outline-container-headline-9" class="outline-4">
<h4 id="headline-9">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/47">#47:</a> Consecutive <code>code</code> wrapped text gets joined
</h4>
<div id="outline-text-headline-9" class="outline-text-4">
<p>either <code>this</code> or <code>that</code> foo.
either <code>this</code>
or <code>that</code> foo.</p>
</div>
</div>
<div id="outline-container-headline-10" class="outline-4">
<h4 id="headline-10">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/50">#50</a>: LineBreaks in lists are preserved
</h4>
<div id="outline-text-headline-10" class="outline-text-4">
<ul>
<li>this list item
has
multiple
linbreaks - but it&#39;s still just one paragraph (i.e. no line breaks are rendered)</li>
<li>foobar</li>
</ul>
<ol>
<li>same
goes
for
ordered
lists</li>
<li>foo</li>
</ol>
</div>
</div>
<div id="outline-container-headline-11" class="outline-4">
<h4 id="headline-11">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/68">#68</a>: Quote block with inline markup
</h4>
<div id="outline-text-headline-11" class="outline-text-4">
<blockquote>
<p><a href="https://www.example.com"><em>this</em> <strong>is</strong> <span style="text-decoration: underline;">markup</span>!</a></p>
</blockquote>
</div>
</div>
<div id="outline-container-headline-12" class="outline-4">
<h4 id="headline-12">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/72">#72</a>: Support for #+ATTR_HTML
</h4>
<div id="outline-text-headline-12" class="outline-text-4">
<img src="https://golang.org/doc/gopher/pkg.png" alt="Go is fine though." title="https://golang.org/doc/gopher/pkg.png" id="gopher-image" width="300" style="border:2px solid black;"/>
</div>
</div>
<div id="outline-container-headline-13" class="outline-4">
<h4 id="headline-13">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/75">#75</a>: Not parsing nested lists correctly
</h4>
<div id="outline-text-headline-13" class="outline-text-4">
<ul>
<li>
<p>bullet 1</p>
<ul>
<li>sub bullet</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-headline-14" class="outline-4">
<h4 id="headline-14">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/77">#77</a>: Recognize <code class="verbatim">code</code>— as code plus dash
</h4>
</div>
<div id="outline-container-headline-15" class="outline-4">
<h4 id="headline-15">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/78">#78</a>: Emphasis at beginning of line
</h4>
<div id="outline-text-headline-15" class="outline-text-4">
<p><em>italics</em></p>
<p>
Text
<em>italics</em></p>
</div>
</div>
<div id="outline-container-headline-16" class="outline-4">
<h4 id="headline-16">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/82">#82</a>: Crash on empty headline
</h4>
<div id="outline-text-headline-16" class="outline-text-4">
<div id="outline-container-headline-17" class="outline-5">
<h5 id="headline-17">

</h5>
<div id="outline-text-headline-17" class="outline-text-5">
<p>just a space as title…</p>
</div>
</div>
</div>
</div>
<div id="outline-container-headline-18" class="outline-4">
<h4 id="headline-18">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/84">#84</a>: Paragraphs that are not followed by an empty line are not parsed correctly
</h4>
<div id="outline-text-headline-18" class="outline-text-4">
<div id="outline-container-headline-19" class="outline-5">
<h5 id="headline-19">
Foo
</h5>
<div id="outline-text-headline-19" class="outline-text-5">
<p>Foo paragraph.</p>
</div>
</div>
<div id="outline-container-headline-20" class="outline-5">
<h5 id="headline-20">
Bar
</h5>
<div id="outline-text-headline-20" class="outline-text-5">
<p>Bar paragraph</p>
</div>
</div>
</div>
</div>
<div id="outline-container-headline-21" class="outline-4">
<h4 id="headline-21">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/86">#86</a>: Multiple hyphens not converted to dashes
</h4>
<div id="outline-text-headline-21" class="outline-text-4">
<p>just like #46</p>
<ul>
<li><code class="verbatim">--</code> -&gt; – (en dash)</li>
<li><code class="verbatim">---</code> -&gt; — (em dash)</li>
</ul>
<p>also, consecutive dashes inside</p>
<ul>
<li>inline code <code class="verbatim">--</code> <code class="verbatim">---</code> and verbatim <code>--</code> <code>---</code></li>
<li>
<p>src/example/export blocks should not be converted!</p>
<div class="src src-sh">
<div class="highlight">
<pre>
--, ---
</pre>
</div>
</div>
<pre class="example">
--, ---
</pre>
--, ---
<pre class="example">
--, ---
</pre>
</li>
</ul>
</div>
</div>
<div id="outline-container-headline-22" class="outline-4">
<h4 id="headline-22">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/87">#87</a>: Markup in footnotes is rendered literally
</h4>
<div id="outline-text-headline-22" class="outline-text-4">
<p>footnotes can contain <strong>markup</strong> - and other elements and stuff <sup class="footnote-reference"><a id="footnote-reference-1" href="#footnote-1">1</a></sup> <sup class="footnote-reference"><a id="footnote-reference-2" href="#footnote-2">2</a></sup></p>
</div>
</div>
<div id="outline-container-headline-23" class="outline-4">
<h4 id="headline-23">
<span class="todo status-done">DONE</span>
<a href="https://github.com/chaseadamsio/goorgeous/issues/92">#92</a>: src blocks only render in caps
</h4>
<div id="outline-text-headline-23" class="outline-text-4">
<p>The behaviour of Org mode <code class="verbatim">&lt;s TAB</code> changed and it now inserts lowercased src blocks (go-org already handled this one)</p>
<ul>
<li>
<p>lowercased:</p>
<div class="src src-bash">
<div class="highlight">
<pre>
uname -a
</pre>
</div>
</div>
</li>
<li>
<p>uppercased</p>
<div class="src src-bash">
<div class="highlight">
<pre>
uname -a
</pre>
</div>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="outline-container-headline-24" class="outline-3">
<h3 id="headline-24">
issues (wrongly) filed with hugo
</h3>
<div id="outline-text-headline-24" class="outline-text-3">
<div id="outline-container-headline-25" class="outline-4">
<h4 id="headline-25">
<a href="https://github.com/gohugoio/hugo/issues/3874">#3874</a> exporting images in org mode
</h4>
<div id="outline-text-headline-25" class="outline-text-4">
<p>Hello, I&#39;m writing hugo blogs using org-mode.</p>
<p>
When inserting an image link like <img src="/home/amos/Pictures/Screenshots/img-2017-09-11-165647.png" alt="/home/amos/Pictures/Screenshots/img-2017-09-11-165647.png" title="/home/amos/Pictures/Screenshots/img-2017-09-11-165647.png" />, hugo doesn&#39;t export the image.</p>
</div>
</div>
<div id="outline-container-headline-26" class="outline-4">
<h4 id="headline-26">
<a href="https://github.com/gohugoio/hugo/issues/4006">#4006</a> source code blocks in org not rendered correctly
</h4>
<div id="outline-text-headline-26" class="outline-text-4">
<div class="src src-emacs-lisp">
<div class="highlight">
<pre>
(defun small-shell ()
  (interactive)
  (split-window-vertically)
  (other-window 1)
  (shrink-window (- (window-height) 12))
  (ansi-term))
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="outline-container-headline-27" class="outline-3">
<h3 id="headline-27">
misc fuzz / regression / edge case
</h3>
<div id="outline-text-headline-27" class="outline-text-3">
<div id="outline-container-headline-28" class="outline-4">
<h4 id="headline-28">
index out of range in headline priority parsing
</h4>
<div id="outline-text-headline-28" class="outline-text-4">
<div id="outline-container-headline-29" class="outline-5">
<h5 id="headline-29">
[#B
</h5>
</div>
</div>
</div>
<div id="outline-container-headline-30" class="outline-4">
<h4 id="headline-30">
index out of range in explicit line break parsing
</h4>
<div id="outline-text-headline-30" class="outline-text-4">
<p>0\\ </p>
</div>
</div>
<div id="outline-container-headline-31" class="outline-4">
<h4 id="headline-31">
list items don&#39;t end on child headline
</h4>
<div id="outline-text-headline-31" class="outline-text-4">
<ul>
<li>a list item</li>
</ul>
<div id="outline-container-headline-32" class="outline-5">
<h5 id="headline-32">
followed by a child headline
</h5>
<div id="outline-text-headline-32" class="outline-text-5">
<ul>
<li>followed by another list item</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="outline-container-headline-33" class="outline-2">
<h2 id="headline-33">
Footnotes
</h2>
</div>
<div class="footnotes">
<hr class="footnotes-separatator">
<div class="footnote-definitions">
<div class="footnote-definition">
<sup id="footnote-1"><a href="#footnote-reference-1">1</a></sup>
<div class="footnote-body">
<p>a footnote <em>with</em> <strong>markup</strong></p>
<ul>
<li>and a <strong>list</strong></li>
<li>because that&#39;s possible</li>
</ul>
</div>
</div>
<div class="footnote-definition">
<sup id="footnote-2"><a href="#footnote-reference-2">2</a></sup>
<div class="footnote-body">
<p>that also goes for <strong>inline</strong> footnote <em>definitions</em></p>
</div>
</div>
</div>
</div>