Orgmode format render test

This page originates in an org-mode written document and has been written to create a reference of things that are (im-)possible using the direct org to html conversion. This text would be ignored by jekyll if the option skip:t was specified as an option. ( CHECK : is the content available as excerpt then? )

The frontmatter is parsed by jekyll, obviously

Header level 1

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct.

Header level 2

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct.

Header level 3

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct.

Header level 4

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct.

Header level 5

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct

Header level 6

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct

Header level 7

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct

Header level 8

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct

Header level 9

This page contains org-mode constructs as a test to see how they get rendered to html. It's the visual last test to see if I have gotten the css stuff right. The page will be updated each time a css change is made so it can be checked without having to hunt for content which uses a special construct

Blockquotes

This paragraph was started with a begin_quote construct

Pull quotes

Pull quotes are provided by a plugins and thus require a liquid template construct. This only works when you surround the complete paragraph in an begin_html / end_html construct.

{% pullquote %} Surround your paragraph with the pull quote tags. {" Then when you come to the text you want to pull, surround it like this "} and that's all there is to it. {% endpullquote %}

Footnotes

The documentation of org-ruby mentions support of footnotes, but the one1 I created here does not render very nicely I think. I would have expected there to be a link.

Orgmode can do inline footnotes 2

Lists

  • Level 1

    • Level 2

      • Level 3

  • Level 4

    • Level 5

      • Level 6

    • orgmode has checkbox like list items

      • but these don't do anything special

    • term1 :: defined;

    • term2 :: defined;

    • term3 :: defined with http://example.com link

Code blocks

Code blocks can be produced in the usual way with #+BEGIN_SRC blocks in org-mode. Highlighting is automatic when a pygments lexer is available.

1def foo
2  puts 'foo'
3end

Same construct with the -n switch, which should turn on line numbers:

1def foo
2  puts 'foo'
3end

and the same construct with the +n switch, which should continue the linenumbering from the previous snippet

1def foo
2  puts 'foo'
3end

Other code related embedding is for githubs gist facility

{% gist 5555251 result.md %}

Rules

In orgmode a line on its own with nothing else but at least 5 dashes is considered a rule.


So, when we use 4 we should just get 4 dashes: —-

Verse

Orgmode has a verse construct, but that does not give output (at the time of writing):

Great clouds overhead Tiny black birds rise and fall Snow covers Emacs

– AlexSchroeder

Centered

The center construct gets a text-align:center attribute, so this should work, given correct CSS.

Everything should be made as simple as possible,
but not any simpler

Examples

The example block format from orgmode

  Some example from a text file.

LaTeX

Orgmode has extensive support for LaTeX fragments, but this doesn't transfer well with the exporter in use.

\begin{equation} x=\sqrt{b} \end{equation}

If $a^2=b$ and \( b=2 \), then the solution must be either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].

\begin{equation} x=\sqrt{b} \end{equation}

If $a^2=b$ and \( b=2 \), then the solution must be either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].

Test

In orgmode export this would be in a div with class test

Links

description

http link with description

http://example.com

../Examples - internal link to header

<<Orgmode>> - the text 'Orgmode' would link to here from everyhwere (radio target) in Orgmode

Orgmode has a way to define linkword, which I have done for this file linkword 'google' used

Images

Image links are just normal links in orgmode, which just happen to link to an image.

/assets/css/images/calendar.gif

link is to image, this is the description

Typically my images will be hosted at either a site like flickr or at my own media-site running mediagoblin, so let's take an image from there.

http://media.mrblog.nl/m/media_entries/168/IMG_20130823_105214.medium.jpg

Just linking to an image source will produce an image tag, unstyled. Typically in blog posts a more or less standard set of image types are needed:

  1. Things that liven up the text, typically pull-left or pull-right in my blog. Images will not be that large;

  2. Photographs which are the subject or part of the subject of the content. Typically larger and detailed, there may be a need to be able to zoom into these pictures

  3. Pictorial elements, part of the theme, perhaps a one-off solution.

Strategies for getting images into a blog, given that we use org-mode our options are rather limited. I'd want to stay away as much as possible from using specific jekyll constructs, that is if we want the blog posting to be useful outside of jekyll.

The price for that is that we then cannot use liquid tags, unless wrapped in an html block and the only way we would make distinctly different images would be using a #+ATTR_HTML: construct.

How I want it to look:

<figure class="shadowed"> <img src="http://media.mrblog.nl/m/media_entries/168/IMG_20130823_105214.medium.jpg" class="img-thumbnail"/> <figcaption>Caption goes here</figcaption> </figure>

Doing the same image in an orgmode way is cumbersome, so I'm using a plugin to do this. The goal is to have all media on media.mrblog.nl, which is probably too strict a limitation, but it allows to have very concise image definitions with a short liquid tag.

Here's how the tag looks:

1{%raw%}
2{% gmg shadowed 168 %}
3{%endraw%}

The plugin does a request (on building) to the media site and retrieves some json data which we could use. (For the caption for example)

Result:

{% gmg shadowed 168 %}

Emphasis

single asterisks: bold

single underscores: underline

single forward slashes: italic

single equal signs: code

single plus signs: strike-through

single tildes: verbatim

Use of liquid tags

Jekyll uses a template langed called liquid. This section is to see examples of tags and use of other liquid constructs

1{% raw %}
2Sitename taken from the variable site.name :: {{site.name}}
3{{'this will be upcased by a filter' | upcase }}
4{% endraw %}

will render as:

1Sitename taken from the variable site.name :: {{site.name}}
2
3{{'this will be upcased by a filter' | upcase }}
TODO This is a to-do item

If nothing specific is configured, the TODO items is just treated as a header, and rendered without the TODO keyword. If a todo:t snippet is present in the #+OPTIONS than the TODO keyword will be shown. The keyword as such will be just part of the header, not rendered specially. There is however extra HTML generated, so the CSS can take care of the extra rendering if needed.


1

This is a footnote

2

Like this