c68d931100
While example blocks do not render inline markup and are thus parsed raw in some way, their contents are not literal html and thus still need to be html escaped.
554 lines
13 KiB
HTML
554 lines
13 KiB
HTML
<h1 class="title">Misc</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>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#headline-31">Footnotes</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<h3 id="headline-1">
|
||
issues from goorgeous (free test cases, yay!)
|
||
</h3>
|
||
<h4 id="headline-2">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/19">#19</a>: Support #+HTML
|
||
</h4>
|
||
<p style="border: 1px dotted grey">neato!</p>
|
||
<h4 id="headline-3">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/29">#29:</a> Support verse block
|
||
</h4>
|
||
<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't it?
|
||
</p>
|
||
</div>
|
||
<h4 id="headline-4">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/30">#30</a>: Support #+SETUPFILE
|
||
</h4>
|
||
<p>
|
||
see <code class="verbatim">./headlines.org</code>
|
||
</p>
|
||
<h4 id="headline-5">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/31">#31</a>: Support #+INCLUDE
|
||
</h4>
|
||
<p>
|
||
Note that only src/example/export block inclusion is supported for now.
|
||
There'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'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 > [100%] <
|
||
(Org mode proper does the same)
|
||
* TODO [#B] Headline with todo status & 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 & priority :foo:bar:
|
||
Still outside the drawer
|
||
:DRAWERNAME:
|
||
This is inside the drawer
|
||
:END:
|
||
Still outside the drawer
|
||
* CUSTOM headline with custom status
|
||
it's possible to use =#+SETUPFILE= - in this case the setup file contains the following
|
||
|
||
#+INCLUDE: "setup_file_org" src org
|
||
* excluded headline :custom_noexport:
|
||
this headline and it'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'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">
|
||
language: go
|
||
go: "1.x"
|
||
script:
|
||
- make test
|
||
- make generate-gh-pages
|
||
deploy:
|
||
provider: pages
|
||
github-token: $GITHUB_TOKEN # From travis-ci.org repository settings
|
||
local-dir: gh-pages
|
||
target-branch: gh-pages
|
||
skip-cleanup: true
|
||
verbose: true
|
||
on:
|
||
branch: master
|
||
</pre>
|
||
</li>
|
||
</ul>
|
||
<h4 id="headline-6">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/33">#33</a>: Wrong output when mixing html with Org mode
|
||
</h4>
|
||
<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>
|
||
<h4 id="headline-7">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/41">#41</a>: Support Table Of Contents
|
||
</h4>
|
||
<h4 id="headline-8">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/46">#46</a>: Support for symbols like ndash and mdash
|
||
</h4>
|
||
<ul>
|
||
<li>
|
||
<p>
|
||
ndash –
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
mdash —
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
ellipsis …
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
acute Á and so on
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
note that —— is replaced with 2 mdashes and …. becomes ellipsis+. and so on - that's how org also does it
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id="headline-9">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/47">#47:</a> Consecutive <code>code</code> wrapped text gets joined
|
||
</h4>
|
||
<p>
|
||
either <code>this</code> or <code>that</code> foo.
|
||
either <code>this</code>
|
||
or <code>that</code> foo.
|
||
</p>
|
||
<h4 id="headline-10">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/50">#50</a>: LineBreaks in lists are preserved
|
||
</h4>
|
||
<ul>
|
||
<li>
|
||
<p>
|
||
this list item
|
||
has
|
||
multiple
|
||
linbreaks - but it's still just one paragraph (i.e. no line breaks are rendered)
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
foobar
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
<ol>
|
||
<li>
|
||
<p>
|
||
same
|
||
goes
|
||
for
|
||
ordered
|
||
lists
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
foo
|
||
</p>
|
||
</li>
|
||
</ol>
|
||
<h4 id="headline-11">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/68">#68</a>: Quote block with inline markup
|
||
</h4>
|
||
<blockquote>
|
||
<p>
|
||
<a href="https://www.example.com"><em>this</em> <strong>is</strong> <span style="text-decoration: underline;">markup</span>!</a>
|
||
</p>
|
||
</blockquote>
|
||
<h4 id="headline-12">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/72">#72</a>: Support for #+ATTR_HTML
|
||
</h4>
|
||
<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;"/>
|
||
<h4 id="headline-13">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/75">#75</a>: Not parsing nested lists correctly
|
||
</h4>
|
||
<ul>
|
||
<li>
|
||
<p>
|
||
bullet 1
|
||
</p>
|
||
<ul>
|
||
<li>
|
||
<p>
|
||
sub bullet
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h4 id="headline-14">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/77">#77</a>: Recognize <code class="verbatim">code</code>— as code plus dash
|
||
</h4>
|
||
<h4 id="headline-15">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/78">#78</a>: Emphasis at beginning of line
|
||
</h4>
|
||
<p>
|
||
<em>italics</em>
|
||
</p>
|
||
<p>
|
||
Text
|
||
<em>italics</em>
|
||
</p>
|
||
<h4 id="headline-16">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/82">#82</a>: Crash on empty headline
|
||
</h4>
|
||
<h5 id="headline-17">
|
||
|
||
</h5>
|
||
<p>
|
||
just a space as title…
|
||
</p>
|
||
<h4 id="headline-18">
|
||
<span class="todo">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>
|
||
<h5 id="headline-19">
|
||
Foo
|
||
</h5>
|
||
<p>
|
||
Foo paragraph.
|
||
</p>
|
||
<h5 id="headline-20">
|
||
Bar
|
||
</h5>
|
||
<p>
|
||
Bar paragraph
|
||
</p>
|
||
<h4 id="headline-21">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/86">#86</a>: Multiple hyphens not converted to dashes
|
||
</h4>
|
||
<p>
|
||
just like #46
|
||
</p>
|
||
<ul>
|
||
<li>
|
||
<p>
|
||
<code class="verbatim">--</code> -> – (en dash)
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
<code class="verbatim">---</code> -> — (em dash)
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
<p>
|
||
also, consecutive dashes inside
|
||
</p>
|
||
<ul>
|
||
<li>
|
||
<p>
|
||
inline code <code class="verbatim">--</code> <code class="verbatim">---</code> and verbatim <code>--</code> <code>---</code>
|
||
</p>
|
||
</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>
|
||
<h4 id="headline-22">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/87">#87</a>: Markup in footnotes is rendered literally
|
||
</h4>
|
||
<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>
|
||
<h4 id="headline-23">
|
||
<span class="todo">DONE</span>
|
||
<a href="https://github.com/chaseadamsio/goorgeous/issues/92">#92</a>: src blocks only render in caps
|
||
</h4>
|
||
<p>
|
||
The behaviour of Org mode <code class="verbatim"><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>
|
||
<h3 id="headline-24">
|
||
issues (wrongly) filed with hugo
|
||
</h3>
|
||
<h4 id="headline-25">
|
||
<a href="https://github.com/gohugoio/hugo/issues/3874">#3874</a> exporting images in org mode
|
||
</h4>
|
||
<p>
|
||
Hello, I'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't export the image.
|
||
</p>
|
||
<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 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>
|
||
<h3 id="headline-27">
|
||
misc fuzz / regression / edge case
|
||
</h3>
|
||
<h4 id="headline-28">
|
||
index out of range in headline priority parsing
|
||
</h4>
|
||
<h5 id="headline-29">
|
||
[#B
|
||
</h5>
|
||
<h4 id="headline-30">
|
||
index out of range in explicit line break parsing
|
||
</h4>
|
||
<p>
|
||
0\\
|
||
</p>
|
||
<h2 id="headline-31">
|
||
Footnotes
|
||
</h2>
|
||
<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>
|
||
<p>
|
||
and a <strong>list</strong>
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
because that's possible
|
||
</p>
|
||
</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>
|