OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
go-org-orgwiki/org/testdata/example.org

5 KiB
Raw Blame History

Example org mode file

Motivation

To validate the parser we'll try printing the AST back to org-mode source - if that works we can be kind of sure that the parsing worked. At least I hope so - I would like to get around writing tests for the individual parsing functions…

Paragraphs

Empty lines separate paragraphs.

Right?

They do!

Headlines with TODO status, priority & tags

TODO [B] Headline with todo status & priority

DONE Headline with TODO status

[A] Headline with tags & priority   foo bar

this one is cheating a little as tags are ALWAYS printed right aligned to a given column number…

Lists

  • unordered list item 1

  • unordered list item 2 - with inline markup

    1. ordered sublist item 1

      1. ordered sublist item 1
      2. ordered sublist item 2
      3. ordered sublist item 3
    2. ordered sublist item 2

  • unordered list item 3 - and a link and some lines of text

    1. and another subitem

      echo with a block

    2. and another one with a table

      a b c
      1 2 3

      and text with an empty line in between as well!

  • unordered list item 4

Inline

  • emphasis and a hard line break
    see?
  • .emphasis with dot border chars.
  • emphasis with a slash/inside
  • emphasis followed by raw text with slash /
  • ->/not an emphasis/<-
  • links with slashes do not become emphasis: https://somelinkshouldntrenderaccidentalemphasis.com/ emphasis
  • underlined bold verbatim code strikethrough
  • bold string with an *asterisk inside

  • links

    1. regular link https://example.com link without description
    2. regular link example.com link with description
    3. regular link to a file (image) /OrgWiki/go-org-orgwiki/media/commit/043095e6728288d466c7528b40f5ff223e9ba6a7/org/testdata/my-img.png
    4. regular link to a file (video)
    5. regular link to http (image) http://www.example.com/my-img.png
    6. regular link to https (image) https://www.example.com/my-img.png
    7. auto link, i.e. not inside \[[square brackets]\] https://www.example.com

Captions

Anything can be captioned. Also captions are not real, correct captions but just a paragraph below the element (bothe wrapped into a div)

echo "i have a caption!"
captioned soure block

note that only that one line is captioned, not the whole paragraph

captioned link (video in this case)

also, normal text lines can't be captioned

not happening!

blocks 

echo a bash source block
bleck! 
a source block without a language
and a second line
and a third one
an example block
with multiple lines

Mongodb is very webscale

and quote blocks can contain multiple paragraphs

issues from goorgeous (free test cases, yay!)

DONE #29: Support verse block

This is verse

or even a totally custom kind of block crazy ain't it?

DONE #47: Consecutive code wrapped text gets joined

either this or that foo. either this or that foo.

DONE #68: Quote block with inline markup

this is markup!

DONE #77: Recognize code— as code plus dash

DONE #75: Not parsing nested lists correctly

  • bullet 1

    • sub bullet

DONE #78: Emphasis at beginning of line

italics

Text italics

DONE #82: Crash on empty headline

just a space as title…

DONE #84: Paragraphs that are not followed by an empty line are not parsed correctly

Foo

Foo paragraph.

Bar

Bar paragraph

Footnotes

  • normal footnote reference 1 2
  • further references to the same footnote should not 1 render duplicates in the footnote list
  • inline footnotes are also supported via 3.

Footnotes

1

https://www.example.com

  • footnotes can contain markup

  • and other elements

    • like blocks

      other non-plain

    • and tables

      1 a
      2 b
      3 c
2

Footnotes break after two consecutive empty lines - just like paragraphs - see https://orgmode.org/worg/dev/org-syntax.html. This shouldn't happen when the definition line and the line after that are empty.

3

the inline footnote definition