go-org-orgwiki/org/testdata/blocks.org
Niklas Fasching b61e49eb85 Preserve whitespace (indentation) inside paragraphs
We want original whitespace to be rendered in some cases (e.g. verse
blocks). This requires information about the original whitespace to be
preserved during paragraph parsing. As html ignores (collapses) whitespace by
default we don't have to adapt the html writer and can just selectively enable
rendering of the preseverved whitespace wherever we want it using
css (white-space: pre).

To differentiate meaningful whitespace from document structure based
indentation (i.e. list item base indentation) we need to introduce
document.baseLvl. A paragraph by itself does not have enough information to
differentiate both kinds of whitespace and needs this information as context
[0].

As we're already touching list indentation i went along and improved (fixed?)
descriptive list item indentation rendering in the org writer (it should match
emacs tab behavior - i.e. indent subsequent lines up to the `:: `).

[0] e.g. list items can contain blank lines - a paragraph starting with a blank
line would not know that it is part of a list item / has a base indentation -
the blank line would suggest a baseLvl of 0.
2019-12-22 14:17:14 +01:00

112 lines
2.4 KiB
Org Mode

#+CAPTION: block caption
#+BEGIN_SRC bash :results raw
echo "a bash source block"
function hello {
echo Hello World!
}
hello
#+END_SRC
#+BEGIN_SRC
a source block without a language
#+END_SRC
#+BEGIN_EXAMPLE foo bar baz
an example block with
multiple lines including
empty lines!
it also has multiple parameters
src, example & export blocks treat their content as raw text
/inline/ *markup* is ignored
and whitespace is honored and not removed
#+END_EXAMPLE
: examples like this
: are also supported
:
: note that /inline/ *markup* ignored
#+BEGIN_QUOTE
Mongodb is *webscale*. (source: [[http://www.mongodb-is-web-scale.com/][mongodb-is-web-scale]])
blocks like the quote block parse their content and can contain
- lists
- inline /markup/
- tables
| foo |
| bar |
| baz |
- paragraphs
- ...
whitespace is honored and not removed (but is not displayed because that's how html works by default)
it can be made visible using css (e.g. =white-space: pre=).
#+END_QUOTE
#+BEGIN_EXPORT html
<script>
console.log("Hello World!")
</script>
#+END_EXPORT
- list item 1
blocks can contain unindented lines that would normally end a list item
#+BEGIN_EXAMPLE
this line is not indented - if it was outside of a block the list item would end
#+END_EXAMPLE
#+BEGIN_QUOTE
this line is not indented - if it was outside of a block the list item would end
#+END_QUOTE
now we're outside the block again and the following unindented line will be outside of the list item
this unindented line is outside of the list item
- list item 2
#+BEGIN_SRC
#+BEGIN_EXAMPLE
#+END_SRC
#+END_EXAMPLE
#+BEGIN_QUOTE
#+BEGIN_EXAMPLE
#+END_QUOTE
#+END_EXAMPLE
#+END_QUOTE
- verse blocks
- emacs / ox-hugo rendering
#+BEGIN_EXPORT html
<p class="verse">
Great clouds overhead<br />
Tiny black birds rise and fall<br />
Snow covers Emacs<br />
<br />
&nbsp;&nbsp;&nbsp;---AlexSchroeder<br />
</p>
#+END_EXPORT
- go-org rendering
#+BEGIN_SRC html
<style>
.verse-block p { white-space: pre; }
.verse-block p + p { margin: 0; }
</style>
#+END_SRC
#+BEGIN_EXPORT html
<style>
.verse-block p { white-space: pre; }
.verse-block p + p { margin: 0; }
</style>
#+END_EXPORT
#+BEGIN_VERSE
Great clouds overhead
Tiny black birds rise and fall
Snow covers Emacs
---AlexSchroeder
#+END_VERSE