Irreal

From Karl Voit we have this really useful piece of advice:

TIL: you can use "org" blocks to write #orgmode examples and org-edit-special resulting in correct escaping: https://t.co/oeIR1sccfZ

— Karl Voit (@n0v0id) August 30, 2016

If you follow the link to Stack Overflow you’ll discover the proper way to include Org markup as an example in an Org file. For a trivial example of this see yesterday’s post in which I included a small bit of Org markup.

The idea is that you put the example in an Org source block rather than, say, an Example block:

#+BEGIN_SRC org
* A heading
** Subhead
   With a bunch of other stuff
#+END_SRC

but that’s not quite enough. In my Org source file for this post the above was entered as:

#+BEGIN_SRC org
  ,#+BEGIN_SRC org
  ,* A heading
  ,** Subhead
     With a bunch of other stuff
  ,#+END_SRC
#+END_SRC

As you can see, the Org markup that you want to appear as the example (and not be acted on) is escaped by a comma. Although the Stack Overflow post does not make it clear, the easy way to do this is to insert the #+BEGIN_SRC org and #+END_SRC markers and then call org-edit-special, which is normally bound to 【Ctrl+c '】, and enter your Org example without worrying about escaping. When you finish by typing 【Ctrl+c '】 again, Org mode will automatically add the escaping for you.

I’m really glad to learn this trick. Trying to add Org mode markup in an example never worked well for me. Yesterday, I saw Voit’s tweet and, serendipitously, was able to use it immediately in my next post.

Rainer König has posted two new videos in his OrgMode Tutorial series. Unfortunately for him but fortunately for us it’s raining in Augsburg so König has had to forego gardening in favor of making more of his excellent Org Mode videos.

This time he discusses dynamic blocks and habit training. Unless you’re really an Org mode expert, there’s sure to be a lot of things you didn’t know in the videos.

The first video talks about dynamic blocks. You may be familiar with them for displaying clocking data but they turn out to be much more general. It’s easy to set one up: you just add

#+BEGIN: function <parameters>
#+END:

to your Org file. The function identifier on the #+BEGIN: line represents the name of the function to generate the dynamic block. You can add parameter name/value pairs if necessary.

There are two builtin functions—clocktable and columnview—to cover the common cases of building dynamic blocks of clocking data and columnview representations. These are useful since the clocking data and columnview representations are normally buffer overlays and there’s no way to capture or export them. By building a dynamic block you get normal text that you can process however you like. See the video for the details on how to generate these dynamic blocks. There are keyboard shortcuts so you don’t have to bother with adding the #+BEGIN:/#+END: markers.

The second video considers habit tracking. The idea is that you have some periodic task that you want to establish as a habit—practicing an instrument, say—so you tell Org mode that it’s a habit you want to track and how often you want to do it and Org mode will provide a nice graphic in your agenda tracking your performance. You handle them just as you would TODOs. When you complete a task you mark it complete and Org tracks it for you. König has an excellent demonstration of this with his own bass and guitar practicing.

As always, these are excellent and informative videos. The two video are 13:12 and 12:37 (min:sec) long so you should have no problem scheduling them. As I’ve said before, these videos are the best introduction to Org mode that I know of and I can’t recommend them enough.