Can't export LaTeX source code blocks

Can't export LaTeX source code blocks

[Sebastien Vauban]

Hello,

As shown by the following ECM, I can't export the LaTeX code blocks.

--8<---------------cut here---------------start------------->8---
#+TITLE:     ECM exports LaTeX code
#+Time-stamp: <2013-04-22 Mon 21:31>
#+LANGUAGE:  en

#+PROPERTY: exports both

* Context

My goal is to explain different LaTeX blocks which I use to construct a LaTeX
class. The document should be exportable to both LaTeX and HTML.

* TODO Documentation

Here is the LaTeX code:

#+name: doc-macro-a
#+begin_src latex
\DescribeMacro{\dummyMacro}
This macro does nothing.\index{doing nothing|usage} It is merely an
example.  If this were a real macro, you would put a paragraph here
describing \textbf{what} the macro is supposed to do, what its mandatory and
optional arguments are, and so forth.
#+end_src

followed by the LaTeX output:

#+results: doc-macro-a
#+BEGIN_LaTeX
\DescribeMacro{\dummyMacro}
This macro does nothing.\index{doing nothing|usage} It is merely an
example.  If this were a real macro, you would put a paragraph here
describing \textbf{what} the macro is supposed to do, what its mandatory and
optional arguments are, and so forth.
#+END_LaTeX

* Results

As you can see, the code block is NEVER exported. I don't understand why?

The results block is exported, but then (interpreted and) only visible in the
LaTeX back-end. The HTML document is completely empty...
--8<---------------cut here---------------end--------------->8---

Am I "besides my shoes" ;-) ?

Best regards,
  Seb

--
Sebastien Vauban

Re: Can't export LaTeX source code blocks

[Nicolas Goaziou]

Hello,

"Sebastien Vauban"
<wxhgmqzgwmuf-geNee64TY+gS+FvcfC7Uqw@public.gmane.org> writes:

> As shown by the following ECM, I can't export the LaTeX code blocks.
>
> #+TITLE:     ECM exports LaTeX code
> #+Time-stamp: <2013-04-22 Mon 21:31>
> #+LANGUAGE:  en
>
> #+PROPERTY: exports both
>
> * Context
>
> My goal is to explain different LaTeX blocks which I use to construct a LaTeX
> class. The document should be exportable to both LaTeX and HTML.
>
> * TODO Documentation
>
> Here is the LaTeX code:
>
> #+name: doc-macro-a
> #+begin_src latex
> \DescribeMacro{\dummyMacro}
> This macro does nothing.\index{doing nothing|usage} It is merely an
> example.  If this were a real macro, you would put a paragraph here
> describing \textbf{what} the macro is supposed to do, what its mandatory and
> optional arguments are, and so forth.
> #+end_src
>
> followed by the LaTeX output:
>
> #+results: doc-macro-a
> #+BEGIN_LaTeX
> \DescribeMacro{\dummyMacro}
> This macro does nothing.\index{doing nothing|usage} It is merely an
> example.  If this were a real macro, you would put a paragraph here
> describing \textbf{what} the macro is supposed to do, what its mandatory and
> optional arguments are, and so forth.
> #+END_LaTeX
>
> * Results
>
> As you can see, the code block is NEVER exported. I don't understand
> why?

I'm not sure either.

This is not a problem from the exporter as
`org-export-execute-babel-code' on your ECM makes the src block
disappear.

> The results block is exported, but then (interpreted and) only visible in the
> LaTeX back-end. The HTML document is completely empty...

I can answer that one: "#+begin_BACKEND" means "export this block when
using export BACKEND, otherwise ignore it". Therefore, html back-end
ignores the results.


Regards,

-- 
Nicolas Goaziou

Re: Can't export LaTeX source code blocks

[Sebastien Vauban]

Hello Nicolas,

Nicolas Goaziou wrote:
> "Sebastien Vauban" writes:
>
>> As shown by the following ECM, I can't export the LaTeX code blocks.
>>
>> #+TITLE:     ECM exports LaTeX code
>> #+Time-stamp: <2013-04-22 Mon 21:31>
>> #+LANGUAGE:  en
>>
>> #+PROPERTY: exports both
>>
>> * Context
>>
>> My goal is to explain different LaTeX blocks which I use to construct a LaTeX
>> class. The document should be exportable to both LaTeX and HTML.
>>
>> * TODO Documentation
>>
>> Here is the LaTeX code:
>>
>> #+name: doc-macro-a
>> #+begin_src latex
>> \DescribeMacro{\dummyMacro}
>> This macro does nothing.\index{doing nothing|usage} It is merely an
>> example.  If this were a real macro, you would put a paragraph here
>> describing \textbf{what} the macro is supposed to do, what its mandatory and
>> optional arguments are, and so forth.
>> #+end_src
>>
>> followed by the LaTeX output:
>>
>> #+results: doc-macro-a
>> #+BEGIN_LaTeX
>> \DescribeMacro{\dummyMacro}
>> This macro does nothing.\index{doing nothing|usage} It is merely an
>> example.  If this were a real macro, you would put a paragraph here
>> describing \textbf{what} the macro is supposed to do, what its mandatory and
>> optional arguments are, and so forth.
>> #+END_LaTeX
>>
>> * Results
>>
>> As you can see, the code block is NEVER exported. I don't understand
>> why?
>
> I'm not sure either.
>
> This is not a problem from the exporter as
> `org-export-execute-babel-code' on your ECM makes the src block
> disappear.
>
>> The results block is exported, but then (interpreted and) only visible in the
>> LaTeX back-end. The HTML document is completely empty...
>
> I can answer that one: "#+begin_BACKEND" means "export this block when
> using export BACKEND, otherwise ignore it". Therefore, html back-end
> ignores the results.

Yes, I agree: that second behavior is logical. I just emphasized it as,
consequently, we can't export anything (not even the results -- though, that
does not make much sense) to HTML, as exposed by the ECM.

The only buggy behavior is the first one: the fact that the "code" block
disappears, as you say.

Best regards,
  Seb

-- 
Sebastien Vauban

Re: Can't export LaTeX source code blocks

[Thomas S. Dye]

Aloha Seb,

"Sebastien Vauban"
<wxhgmqzgwmuf-geNee64TY+gS+FvcfC7Uqw@public.gmane.org> writes:

>>> * TODO Documentation
>>>
>>> Here is the LaTeX code:
>>>
>>> #+name: doc-macro-a
>>> #+begin_src latex
>>> \DescribeMacro{\dummyMacro}
>>> This macro does nothing.\index{doing nothing|usage} It is merely an
>>> example.  If this were a real macro, you would put a paragraph here
>>> describing \textbf{what} the macro is supposed to do, what its mandatory and
>>> optional arguments are, and so forth.
>>> #+end_src
>>>
>>> followed by the LaTeX output:
>>>
>>> #+results: doc-macro-a
>>> #+BEGIN_LaTeX
>>> \DescribeMacro{\dummyMacro}
>>> This macro does nothing.\index{doing nothing|usage} It is merely an
>>> example.  If this were a real macro, you would put a paragraph here
>>> describing \textbf{what} the macro is supposed to do, what its mandatory and
>>> optional arguments are, and so forth.
>>> #+END_LaTeX
>>>
>>> * Results
>>>
>>> As you can see, the code block is NEVER exported. I don't understand
>>> why?
>>
>> I'm not sure either.
>>
>> This is not a problem from the exporter as
>> `org-export-execute-babel-code' on your ECM makes the src block
>> disappear.
>>
>>> The results block is exported, but then (interpreted and) only visible in the
>>> LaTeX back-end. The HTML document is completely empty...
>>
>> I can answer that one: "#+begin_BACKEND" means "export this block when
>> using export BACKEND, otherwise ignore it". Therefore, html back-end
>> ignores the results.
>
> Yes, I agree: that second behavior is logical. I just emphasized it as,
> consequently, we can't export anything (not even the results -- though, that
> does not make much sense) to HTML, as exposed by the ECM.
>
> The only buggy behavior is the first one: the fact that the "code" block
> disappears, as you say.

I took a quick look at ob-latex.el. The code there sets `:exports
results' and then, IIUC, goes on its way without checking if :exports
has been set in the buffer.

IIRC, the main uses of LaTeX code blocks were for tangling .tex
documents, and for preview snippets. This seems to be supported by the
documentation, which says "LaTeX source code blocks can be used to
tangle a LaTeX source file, or to create bitmap images or pdf snippets
of arbitrary LaTeX code."

It looks to me like ob-latex.el would need to be revised to work with
your use case (a document about LaTeX authoring?).

hth,
Tom

-- 
Thomas S. Dye
http://www.tsdye.com

Re: Can't export LaTeX source code blocks

[Sebastien Vauban]

Hello Thomas,

Thomas S. Dye wrote:
> "Sebastien Vauban"
>>>> #+begin_src latex
>>>> \DescribeMacro{\dummyMacro}
>>>> This macro does nothing.\index{doing nothing|usage} It is merely an
>>>> example.  If this were a real macro, you would put a paragraph here
>>>> describing \textbf{what} the macro is supposed to do, what its mandatory and
>>>> optional arguments are, and so forth.
>>>> #+end_src
>>>>
>>>> As you can see, the code block is NEVER exported. I don't understand
>>>> why?
>>>
>>> I'm not sure either.
>>>
>> The only buggy behavior is the first one: the fact that the "code" block
>> disappears, as you say.
>
> I took a quick look at ob-latex.el. The code there sets `:exports results'
> and then, IIUC, goes on its way without checking if :exports has been set in
> the buffer.

Thanks for giving a look at the right place, and putting me on good tracks.

> IIRC, the main uses of LaTeX code blocks were for tangling .tex documents,
> and for preview snippets. This seems to be supported by the documentation,
> which says "LaTeX source code blocks can be used to tangle a LaTeX source
> file, or to create bitmap images or pdf snippets of arbitrary LaTeX code."
>
> It looks to me like ob-latex.el would need to be revised to work with your
> use case (a document about LaTeX authoring?).

Yes, I want to document (in the LP [1] spirit) the LaTeX classes we've written
at work.

Best regards,
  Seb

[1] Literate Programming

-- 
Sebastien Vauban

Re: Can't export LaTeX source code blocks

[Sebastien Vauban]

Hello Thomas,

Thomas S. Dye wrote:
> "Sebastien Vauban" writes:
>
>>>> The code block is NEVER exported. I don't understand why?
>>>
>>> I'm not sure either.
>>>
>>> This is not a problem from the exporter as `org-export-execute-babel-code'
>>> on your ECM makes the src block disappear.
>>
>> The only buggy behavior is the first one: the fact that the "code" block
>> disappears, as you say.
>
> I took a quick look at ob-latex.el. The code there sets `:exports
> results' and then, IIUC, goes on its way without checking if :exports
> has been set in the buffer.
>
> It looks to me like ob-latex.el would need to be revised.

I don't have the impression that the error lies in `ob-latex' as the other
`ob-LANG' files don't either make any special check -- while all graphics-only
languages do, as well, have the default of "results" for ":exports".

I have the impression the problem is to search in `ob-core'
(`org-babel-execute-src-block') or `ob-exp'... But that's not yet clear to me
where that could be.

FYI, I have collected extra information about the problem: it is the file-wide
property which is not taken into account (only in the case of the LaTeX code
blocks, though).

If we put the header argument ":exports both" on the code block itself, I get
the expected result...

--8<---------------cut here---------------start------------->8---
#+TITLE:     ECM skeleton.org
#+PROPERTY: tangle skeleton.cls
#+PROPERTY: exports both

* ECM LaTeX KO

Code block:

#+name: ecm-code-block-1
#+begin_src latex
\DescribeMacro{\dummyMacro}
This macro does nothing.\index{doing nothing|usage}
#+end_src

Results block:

#+results: ecm-code-block-1
#+BEGIN_LaTeX
\DescribeMacro{\dummyMacro}
This macro does nothing.\index{doing nothing|usage}
#+END_LaTeX

* ECM LaTeX okay

#+name: ecm-code-block-2
#+begin_src latex :exports both
\DescribeMacro{\dummyMacro}
This macro does nothing.\index{doing nothing|usage}
#+end_src

Results block:

#+results: ecm-code-block-2
#+BEGIN_LaTeX
\DescribeMacro{\dummyMacro}
This macro does nothing.\index{doing nothing|usage}
#+END_LaTeX
--8<---------------cut here---------------end--------------->8---

Best regards,
  Seb

-- 
Sebastien Vauban

[PATCH] Re: Can't export LaTeX source code blocks

[Sebastien Vauban]

"Sebastien Vauban" wrote:
> Thomas S. Dye wrote:
>> "Sebastien Vauban" writes:
>>
>>>>> The code block is NEVER exported. I don't understand why?
>>>>
>>>> I'm not sure either.
>>
>> I took a quick look at ob-latex.el. The code there sets `:exports
>> results' and then, IIUC, goes on its way without checking if :exports
>> has been set in the buffer.
>>
>> It looks to me like ob-latex.el would need to be revised.
>
> I don't have the impression that the error lies in `ob-latex' as the other
> `ob-LANG' files don't either make any special check -- while all graphics-only
> languages do, as well, have the default of "results" for ":exports".
>
> I have the impression the problem is to search in `ob-core'
> (`org-babel-execute-src-block') or `ob-exp'... But that's not yet clear to me
> where that could be.

I think I found it. That was a priority order problem for implementing the
hierarchy of header arguments inheritage in `ob-core'.

Best regards,
  Seb

From 3339c0f7d296fc68a206b0f69270da3a91025840 Mon Sep 17 00:00:00 2001
From: Sebastien Vauban <sva-news-4+nxiYgPiI0PTC0C9HXcdqsb+IOhx+da@public.gmane.org>
Date: Sat, 27 Apr 2013 11:40:25 +0200
Subject: [PATCH 2/2] Fix priority order for inheriting header arguments

* ob-core.el (org-babel-parse-src-block-match): Fix order of list of header
arguments.

---
 lisp/ob-core.el |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index 9baff0c..73dca8f 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -1,6 +1,6 @@
 ;;; ob-core.el --- working with code blocks in org-mode
 
-;; Copyright (C) 2009-2012  Free Software Foundation, Inc.
+;; Copyright (C) 2009-2013  Free Software Foundation, Inc.
 
 ;; Authors: Eric Schulte
 ;;	Dan Davison
@@ -1323,8 +1323,8 @@ may be specified in the properties of the current outline entry."
               (buffer-string)))
 	  (org-babel-merge-params
 	   org-babel-default-header-args
-           (org-babel-params-from-properties lang)
 	   (if (boundp lang-headers) (eval lang-headers) nil)
+           (org-babel-params-from-properties lang)
 	   (org-babel-parse-header-arguments
             (org-no-properties (or (match-string 4) ""))))
 	  switches
-- 
1.7.9

-- 
Sebastien Vauban

Re: [PATCH] Re: Can't export LaTeX source code blocks

[Sebastien Vauban]

Hi Eric,

Could you look at this patch, fixing the priority hierarchy of Babel header
arguments, and apply it, if judged OK?

Best regards,
  Seb

"Sebastien Vauban" wrote:
> "Sebastien Vauban" wrote:
>> Thomas S. Dye wrote:
>>> "Sebastien Vauban" writes:
>>>
>>>>>> The code block is NEVER exported. I don't understand why?
>>>>>
>>>>> I'm not sure either.
>>>
>>> I took a quick look at ob-latex.el. The code there sets `:exports
>>> results' and then, IIUC, goes on its way without checking if :exports
>>> has been set in the buffer.
>>>
>>> It looks to me like ob-latex.el would need to be revised.
>>
>> I don't have the impression that the error lies in `ob-latex' as the other
>> `ob-LANG' files don't either make any special check -- while all graphics-only
>> languages do, as well, have the default of "results" for ":exports".
>>
>> I have the impression the problem is to search in `ob-core'
>> (`org-babel-execute-src-block') or `ob-exp'... But that's not yet clear to me
>> where that could be.
>
> I think I found it. That was a priority order problem for implementing the
> hierarchy of header arguments inheritage in `ob-core'.
>
> Best regards,
>   Seb
>
> From 3339c0f7d296fc68a206b0f69270da3a91025840 Mon Sep 17 00:00:00 2001
> From: Sebastien Vauban <sva-news-4+nxiYgPiI0PTC0C9HXcdqsb+IOhx+da@public.gmane.org>
> Date: Sat, 27 Apr 2013 11:40:25 +0200
> Subject: [PATCH 2/2] Fix priority order for inheriting header arguments
>
> * ob-core.el (org-babel-parse-src-block-match): Fix order of list of header
> arguments.
>
> ---
>  lisp/ob-core.el |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/lisp/ob-core.el b/lisp/ob-core.el
> index 9baff0c..73dca8f 100644
> --- a/lisp/ob-core.el
> +++ b/lisp/ob-core.el
> @@ -1,6 +1,6 @@
>  ;;; ob-core.el --- working with code blocks in org-mode
>  
> -;; Copyright (C) 2009-2012  Free Software Foundation, Inc.
> +;; Copyright (C) 2009-2013  Free Software Foundation, Inc.
>  
>  ;; Authors: Eric Schulte
>  ;;	Dan Davison
> @@ -1323,8 +1323,8 @@ may be specified in the properties of the current outline entry."
>                (buffer-string)))
>  	  (org-babel-merge-params
>  	   org-babel-default-header-args
> -           (org-babel-params-from-properties lang)
>  	   (if (boundp lang-headers) (eval lang-headers) nil)
> +           (org-babel-params-from-properties lang)
>  	   (org-babel-parse-header-arguments
>              (org-no-properties (or (match-string 4) ""))))
>  	  switches
> -- 
> 1.7.9

-- 
Sebastien Vauban

Re: [PATCH] Re: Can't export LaTeX source code blocks

[Eric Schulte]

"Sebastien Vauban" <sva-news@mygooglest.com> writes:

> "Sebastien Vauban" wrote:
>> Thomas S. Dye wrote:
>>> "Sebastien Vauban" writes:
>>>
>>>>>> The code block is NEVER exported. I don't understand why?
>>>>>
>>>>> I'm not sure either.
>>>
>>> I took a quick look at ob-latex.el. The code there sets `:exports
>>> results' and then, IIUC, goes on its way without checking if :exports
>>> has been set in the buffer.
>>>
>>> It looks to me like ob-latex.el would need to be revised.
>>
>> I don't have the impression that the error lies in `ob-latex' as the other
>> `ob-LANG' files don't either make any special check -- while all graphics-only
>> languages do, as well, have the default of "results" for ":exports".
>>
>> I have the impression the problem is to search in `ob-core'
>> (`org-babel-execute-src-block') or `ob-exp'... But that's not yet clear to me
>> where that could be.
>
> I think I found it. That was a priority order problem for implementing the
> hierarchy of header arguments inheritage in `ob-core'.
>

Applied, Thanks!

>
> Best regards,
>   Seb
>
> From 3339c0f7d296fc68a206b0f69270da3a91025840 Mon Sep 17 00:00:00 2001
> From: Sebastien Vauban <sva-news@invalid.mygooglest.com>
> Date: Sat, 27 Apr 2013 11:40:25 +0200
> Subject: [PATCH 2/2] Fix priority order for inheriting header arguments
>
> * ob-core.el (org-babel-parse-src-block-match): Fix order of list of header
> arguments.
>
> ---
>  lisp/ob-core.el |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/lisp/ob-core.el b/lisp/ob-core.el
> index 9baff0c..73dca8f 100644
> --- a/lisp/ob-core.el
> +++ b/lisp/ob-core.el
> @@ -1,6 +1,6 @@
>  ;;; ob-core.el --- working with code blocks in org-mode
>  
> -;; Copyright (C) 2009-2012  Free Software Foundation, Inc.
> +;; Copyright (C) 2009-2013  Free Software Foundation, Inc.
>  
>  ;; Authors: Eric Schulte
>  ;;	Dan Davison
> @@ -1323,8 +1323,8 @@ may be specified in the properties of the current outline entry."
>                (buffer-string)))
>  	  (org-babel-merge-params
>  	   org-babel-default-header-args
> -           (org-babel-params-from-properties lang)
>  	   (if (boundp lang-headers) (eval lang-headers) nil)
> +           (org-babel-params-from-properties lang)
>  	   (org-babel-parse-header-arguments
>              (org-no-properties (or (match-string 4) ""))))
>  	  switches
> -- 
> 1.7.9

-- 
Eric Schulte
http://cs.unm.edu/~eschulte