Export options processed in example block

Export options processed in example block

[Nicolas Quiniou]

Hi,

When I put #+TITLE in a block example and try to export an Org file in
HTML (with org-export), results are unexpected :

Org file
--
#+TITLE: Testing example block
#+begin_example
#+TITLE: My title
#+end_example

HTML file
--
[..]
<title>My title</title>
[..]

To obtain expected results, I found two solutions :
- prefix "#+TITLE: My title" with ';'
- put "#+TITLE: Testing example block" *after* "#+TITLE: My title"

To my mind, example is a protecting-block. Therefore, as mentionned in
org-protecting-blocks documentation, his content should not be
"processed as Org syntax".

Regards,
--
Emacs  : GNU Emacs 24.2.1 (x86_64-unknown-linux-gnu, GTK+ Version 3.4.4)
 of 2012-08-28 on shaun
Package: Org-mode version 7.9.2 (7.9.2-dist @
/usr/share/emacs/site-lisp/org/)

Value of org-exporting-blocks :
("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")

Tested with org-minimal.el.

Re: Export options processed in example block

[Suvayu Ali]

Hi Nicolas,

On Thu, Oct 18, 2012 at 11:33:33AM +0200, Nicolas Quiniou wrote:
> Hi,
> 
> When I put #+TITLE in a block example and try to export an Org file in
> HTML (with org-export), results are unexpected :
> 
> Org file
> --
> #+TITLE: Testing example block
> #+begin_example
> #+TITLE: My title
> #+end_example
> 

As far as I know org syntax in example blocks need to be protected by a
comma.  So something like this should work:

#+TITLE: Testing example block

#+begin_example
  ,#+TITLE: My title
#+end_example

Hope this helps,

-- 
Suvayu

Open source is the future. It sets us free.

Re: Export options processed in example block

[Nicolas Quiniou]

Le 18/10/2012 12:32, Suvayu Ali a écrit :
> So something like this should work:
> 
> #+TITLE: Testing example block
> 
> #+begin_example
>   ,#+TITLE: My title
> #+end_example

That's right. Thanks you.

Could we improve org-protecting-blocks documentation or Org manual on
that point ?

Re: Export options processed in example block

[Suvayu Ali]

Hi Nicolas,

On Thu, Oct 18, 2012 at 02:59:05PM +0200, Nicolas Quiniou wrote:
> Le 18/10/2012 12:32, Suvayu Ali a écrit :
> > So something like this should work:
> > 
> > #+TITLE: Testing example block
> > 
> > #+begin_example
> >   ,#+TITLE: My title
> > #+end_example
> 
> That's right. Thanks you.
> 
> Could we improve org-protecting-blocks documentation or Org manual on
> that point ?
> 

It is documented in the manual; see here: 

  [[info:org#Literal%20examples][info:org#Literal examples]]

If you edit the example block with C-c ', then Org mode takes care of
the comment characters.  However I'm not sure how to tell that what you
are entering is org source when all you have is a line with keywords or
comments.

If you feel the documentation could be clearer, please feel free to send
a patch.  One immediate improvement I could think of was to include that
little discussion and footnote in the manual index under comments.

Hope this helps.

-- 
Suvayu

Open source is the future. It sets us free.