[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] seeking good practices for writing about org using org

From: Charles C. Berry
Subject: Re: [O] seeking good practices for writing about org using org
Date: Wed, 3 Aug 2016 19:15:52 -0700
User-agent: Alpine 2.20 (OSX 67 2015-01-07)

On Wed, 3 Aug 2016, Cook, Malcolm wrote:


I am seeking good practices for writing about org using , erhm, well, org itself. (doh!)

I'd use these practices, for example, when writing examples of using org, or lessons in using org, or bug reports about org.

I reached of ob-org thinking this is what it was for, and wrote the following

--------------------------------------- (beginning of example)
Here is simple org book structure with chapters and a table of
contents at the end:

#+BEGIN_SRC org :exports both :results value

* chapter one

Fa la la

* chapter two

La di di

* table of contents


--------------------------------------- (end of example)

My dashed expectations were that when executed and exported, this would produce a block of the org source, appropriately quoted, followed be the RESULTS, being, well, the rendered org.

Are your expectations the same as mine?

No. Run `M-x org-lint RET' and you will see that this is malformed. The org code needs to be escaped.

What do YOU do in such cases?

Edit the src block in an edit buffer. You'll need to kill the contents of that src block first, then C-c ' to open the src edit buffer, then yank, then C-c ' again. The resulting buffer will be properly escaped.

See (info "(org) Literal examples"), especially footnote 4.


Then specify `:results replace' to override `:results silent' which
`org-babel-default-header-args:org' sets.


Then the export should be what you expect.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]