Bug in latex export tutorial on worg ?

Bug in latex export tutorial on worg ?

[Robert Goldman]

There is the following code block there:

#+begin_src emacs-lisp :results silent
  (add-to-list 'org-export-latex-classes
          '("per-file-class"
             "\\documentclass{scrartcl}
             [NO-DEFAULT-PACKAGES]
             [EXTRA]"
             ("\\section{%s}" . "\\section*{%s}")
             ("\\subsection{%s}" . "\\subsection*{%s}")
             ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
             ("\\paragraph{%s}" . "\\paragraph*{%s}")
             ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
#+end_src

Is this still correct?  Or should this be :exports none instead of
:results silent?

Cheers,
r

Re: Bug in latex export tutorial on worg ?

[Nick Dokos]

Robert Goldman <rpgoldman@sift.info> wrote:

> There is the following code block there:
> 
> #+begin_src emacs-lisp :results silent
>   (add-to-list 'org-export-latex-classes
>           '("per-file-class"
>              "\\documentclass{scrartcl}
>              [NO-DEFAULT-PACKAGES]
>              [EXTRA]"
>              ("\\section{%s}" . "\\section*{%s}")
>              ("\\subsection{%s}" . "\\subsection*{%s}")
>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
> #+end_src
> 
> Is this still correct?  Or should this be :exports none instead of
> :results silent?
> 

``:results silent'' works for me and keeps the result from appearing in
the org buffer. I don't think :exports can do that - it can only affect
what's exported.

Nick

Re: Bug in latex export tutorial on worg ?

[Robert Goldman]

On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
> Robert Goldman <rpgoldman@sift.info> wrote:
> 
>> There is the following code block there:
>>
>> #+begin_src emacs-lisp :results silent
>>   (add-to-list 'org-export-latex-classes
>>           '("per-file-class"
>>              "\\documentclass{scrartcl}
>>              [NO-DEFAULT-PACKAGES]
>>              [EXTRA]"
>>              ("\\section{%s}" . "\\section*{%s}")
>>              ("\\subsection{%s}" . "\\subsection*{%s}")
>>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
>> #+end_src
>>
>> Is this still correct?  Or should this be :exports none instead of
>> :results silent?
>>
> 
> ``:results silent'' works for me and keeps the result from appearing in
> the org buffer. I don't think :exports can do that - it can only affect
> what's exported.
> 
> Nick

I must be doing something wrong then --- I had the :results silent and
found the source block in verbatim in my latex export file....  Changing
to :exports none made that go away for me.  Maybe that was a
coincidence.  I will have to investigate further, I guess.

best,
r

Re: Bug in latex export tutorial on worg ?

[Thomas S. Dye]

Robert Goldman <rpgoldman@sift.info> writes:

> On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
>> Robert Goldman <rpgoldman@sift.info> wrote:
>> 
>>> There is the following code block there:
>>>
>>> #+begin_src emacs-lisp :results silent
>>>   (add-to-list 'org-export-latex-classes
>>>           '("per-file-class"
>>>              "\\documentclass{scrartcl}
>>>              [NO-DEFAULT-PACKAGES]
>>>              [EXTRA]"
>>>              ("\\section{%s}" . "\\section*{%s}")
>>>              ("\\subsection{%s}" . "\\subsection*{%s}")
>>>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>>>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>>>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
>>> #+end_src
>>>
>>> Is this still correct?  Or should this be :exports none instead of
>>> :results silent?
>>>
>> 
>> ``:results silent'' works for me and keeps the result from appearing in
>> the org buffer. I don't think :exports can do that - it can only affect
>> what's exported.
>> 
>> Nick
>
> I must be doing something wrong then --- I had the :results silent and
> found the source block in verbatim in my latex export file....  Changing
> to :exports none made that go away for me.  Maybe that was a
> coincidence.  I will have to investigate further, I guess.
>
> best,
> r

Aloha Robert,

You can set both :results silent and :exports none.  The :results header
argument sets how the results of evaluation appear (or not) in the
Org-mode buffer, and the :exports argument determines what the exporter
does with the source code block.

hth,
Tom

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

Re: Bug in latex export tutorial on worg ?

[Nick Dokos]

Robert Goldman <rpgoldman@sift.info> wrote:

> On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
> > Robert Goldman <rpgoldman@sift.info> wrote:
> > 
> >> There is the following code block there:
> >>
> >> #+begin_src emacs-lisp :results silent
> >>   (add-to-list 'org-export-latex-classes
> >>           '("per-file-class"
> >>              "\\documentclass{scrartcl}
> >>              [NO-DEFAULT-PACKAGES]
> >>              [EXTRA]"
> >>              ("\\section{%s}" . "\\section*{%s}")
> >>              ("\\subsection{%s}" . "\\subsection*{%s}")
> >>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
> >>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
> >>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
> >> #+end_src
> >>
> >> Is this still correct?  Or should this be :exports none instead of
> >> :results silent?
> >>
> > 
> > ``:results silent'' works for me and keeps the result from appearing in
> > the org buffer. I don't think :exports can do that - it can only affect
> > what's exported.
> > 
> > Nick
> 
> I must be doing something wrong then --- I had the :results silent and
> found the source block in verbatim in my latex export file....  Changing
> to :exports none made that go away for me.  Maybe that was a
> coincidence.  I will have to investigate further, I guess.
> 

No, you are not doing anything wrong: the default :exports value is
"code", so the code ends up in your export. ``:exports none'' keeps it
(and any results) from being exported.

OTOH, try evaluating (C-c C-c) the code block, with and without
``:results silent''. There is a behavior difference and *that* difference
is not affected by how you set :exports.

Nick

Re: Bug in latex export tutorial on worg ?

[Robert Goldman]

On 5/9/11 May 9 -11:22 PM, Nick Dokos wrote:
> Robert Goldman <rpgoldman@sift.info> wrote:
> 
>> On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
>>> Robert Goldman <rpgoldman@sift.info> wrote:
>>>
>>>> There is the following code block there:
>>>>
>>>> #+begin_src emacs-lisp :results silent
>>>>   (add-to-list 'org-export-latex-classes
>>>>           '("per-file-class"
>>>>              "\\documentclass{scrartcl}
>>>>              [NO-DEFAULT-PACKAGES]
>>>>              [EXTRA]"
>>>>              ("\\section{%s}" . "\\section*{%s}")
>>>>              ("\\subsection{%s}" . "\\subsection*{%s}")
>>>>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>>>>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>>>>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
>>>> #+end_src
>>>>
>>>> Is this still correct?  Or should this be :exports none instead of
>>>> :results silent?
>>>>
>>>
>>> ``:results silent'' works for me and keeps the result from appearing in
>>> the org buffer. I don't think :exports can do that - it can only affect
>>> what's exported.
>>>
>>> Nick
>>
>> I must be doing something wrong then --- I had the :results silent and
>> found the source block in verbatim in my latex export file....  Changing
>> to :exports none made that go away for me.  Maybe that was a
>> coincidence.  I will have to investigate further, I guess.
>>
> 
> No, you are not doing anything wrong: the default :exports value is
> "code", so the code ends up in your export. ``:exports none'' keeps it
> (and any results) from being exported.
> 
> OTOH, try evaluating (C-c C-c) the code block, with and without
> ``:results silent''. There is a behavior difference and *that* difference
> is not affected by how you set :exports.
> 
> Nick

Ah.  I get it now.  But then surely the above IS a bug -- presumably
it's not usual for a person to wish their latex export configuration to
appear, in verbatim block, in their org-generated latex document!

Best,
Robert

Re: Bug in latex export tutorial on worg ?

[Nick Dokos]

Robert Goldman <rpgoldman@sift.info> wrote:

> Ah.  I get it now.  But then surely the above IS a bug -- presumably
> it's not usual for a person to wish their latex export configuration to
> appear, in verbatim block, in their org-generated latex document!
> 

Perhaps not in most cases, but a tutorial has to do exactly that: how
else is it going to show the reader what needs to be done? Certainly
not by omitting the code that the reader is supposed to use.

Nick

Re: Bug in latex export tutorial on worg ?

[Nick Dokos]

Nick Dokos <nicholas.dokos@hp.com> wrote:

> Robert Goldman <rpgoldman@sift.info> wrote:
> 
> > Ah.  I get it now.  But then surely the above IS a bug -- presumably
> > it's not usual for a person to wish their latex export configuration to
> > appear, in verbatim block, in their org-generated latex document!
> > 
> 
> Perhaps not in most cases, but a tutorial has to do exactly that: how
> else is it going to show the reader what needs to be done? Certainly
> not by omitting the code that the reader is supposed to use.
> 

After Tom's reply, I went and looked at the example and now I get it
too :-) Sorry for being dense before.

Nick

Re: Bug in latex export tutorial on worg ?

[Thomas S. Dye]

Nick Dokos <nicholas.dokos@hp.com> writes:

> Nick Dokos <nicholas.dokos@hp.com> wrote:
>
>> Robert Goldman <rpgoldman@sift.info> wrote:
>> 
>> > Ah.  I get it now.  But then surely the above IS a bug -- presumably
>> > it's not usual for a person to wish their latex export configuration to
>> > appear, in verbatim block, in their org-generated latex document!
>> > 
>> 
>> Perhaps not in most cases, but a tutorial has to do exactly that: how
>> else is it going to show the reader what needs to be done? Certainly
>> not by omitting the code that the reader is supposed to use.
>> 
>
> After Tom's reply, I went and looked at the example and now I get it
> too :-) Sorry for being dense before.
>
> Nick
>
>
Hi Nick,

Actually, your diagnosis was exactly right, as usual.  The "buggy" example
came from a document meant as a tutorial.

All the best,
Tom

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

Re: Bug in latex export tutorial on worg ?

[Thomas S. Dye]

Robert Goldman <rpgoldman@sift.info> writes:

> On 5/9/11 May 9 -11:22 PM, Nick Dokos wrote:
>> Robert Goldman <rpgoldman@sift.info> wrote:
>> 
>>> On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
>>>> Robert Goldman <rpgoldman@sift.info> wrote:
>>>>
>>>>> There is the following code block there:
>>>>>
>>>>> #+begin_src emacs-lisp :results silent
>>>>>   (add-to-list 'org-export-latex-classes
>>>>>           '("per-file-class"
>>>>>              "\\documentclass{scrartcl}
>>>>>              [NO-DEFAULT-PACKAGES]
>>>>>              [EXTRA]"
>>>>>              ("\\section{%s}" . "\\section*{%s}")
>>>>>              ("\\subsection{%s}" . "\\subsection*{%s}")
>>>>>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>>>>>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>>>>>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
>>>>> #+end_src
>>>>>
>>>>> Is this still correct?  Or should this be :exports none instead of
>>>>> :results silent?
>>>>>
>>>>
>>>> ``:results silent'' works for me and keeps the result from appearing in
>>>> the org buffer. I don't think :exports can do that - it can only affect
>>>> what's exported.
>>>>
>>>> Nick
>>>
>>> I must be doing something wrong then --- I had the :results silent and
>>> found the source block in verbatim in my latex export file....  Changing
>>> to :exports none made that go away for me.  Maybe that was a
>>> coincidence.  I will have to investigate further, I guess.
>>>
>> 
>> No, you are not doing anything wrong: the default :exports value is
>> "code", so the code ends up in your export. ``:exports none'' keeps it
>> (and any results) from being exported.
>> 
>> OTOH, try evaluating (C-c C-c) the code block, with and without
>> ``:results silent''. There is a behavior difference and *that* difference
>> is not affected by how you set :exports.
>> 
>> Nick
>
> Ah.  I get it now.  But then surely the above IS a bug -- presumably
> it's not usual for a person to wish their latex export configuration to
> appear, in verbatim block, in their org-generated latex document!
>
> Best,
> Robert
>
>
>

Aloha Robert,

I've added :exports none to the example, which came from a document
about how to export LaTeX documents from Org-mode.  Thanks for pointing
out that it could be used in a way that yields unexpected results.

In my usual setup I put this kind of configuration in a heading of its
own that is protected by a :noexport: tag.  This works for me because I
often have notes about why things are in there and what I think they
might be doing.

All the best,
Tom

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

Re: Bug in latex export tutorial on worg ?

[Robert Goldman]

On 5/10/11 May 10 -12:25 AM, Thomas S. Dye wrote:
> Robert Goldman <rpgoldman@sift.info> writes:
> 
>> On 5/9/11 May 9 -11:22 PM, Nick Dokos wrote:
>>> Robert Goldman <rpgoldman@sift.info> wrote:
>>>
>>>> On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
>>>>> Robert Goldman <rpgoldman@sift.info> wrote:
>>>>>
>>>>>> There is the following code block there:
>>>>>>
>>>>>> #+begin_src emacs-lisp :results silent
>>>>>>   (add-to-list 'org-export-latex-classes
>>>>>>           '("per-file-class"
>>>>>>              "\\documentclass{scrartcl}
>>>>>>              [NO-DEFAULT-PACKAGES]
>>>>>>              [EXTRA]"
>>>>>>              ("\\section{%s}" . "\\section*{%s}")
>>>>>>              ("\\subsection{%s}" . "\\subsection*{%s}")
>>>>>>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>>>>>>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>>>>>>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
>>>>>> #+end_src
>>>>>>
>>>>>> Is this still correct?  Or should this be :exports none instead of
>>>>>> :results silent?
>>>>>>
>>>>>
>>>>> ``:results silent'' works for me and keeps the result from appearing in
>>>>> the org buffer. I don't think :exports can do that - it can only affect
>>>>> what's exported.
>>>>>
>>>>> Nick
>>>>
>>>> I must be doing something wrong then --- I had the :results silent and
>>>> found the source block in verbatim in my latex export file....  Changing
>>>> to :exports none made that go away for me.  Maybe that was a
>>>> coincidence.  I will have to investigate further, I guess.
>>>>
>>>
>>> No, you are not doing anything wrong: the default :exports value is
>>> "code", so the code ends up in your export. ``:exports none'' keeps it
>>> (and any results) from being exported.
>>>
>>> OTOH, try evaluating (C-c C-c) the code block, with and without
>>> ``:results silent''. There is a behavior difference and *that* difference
>>> is not affected by how you set :exports.
>>>
>>> Nick
>>
>> Ah.  I get it now.  But then surely the above IS a bug -- presumably
>> it's not usual for a person to wish their latex export configuration to
>> appear, in verbatim block, in their org-generated latex document!
>>
>> Best,
>> Robert
>>
>>
>>
> 
> Aloha Robert,
> 
> I've added :exports none to the example, which came from a document
> about how to export LaTeX documents from Org-mode.  Thanks for pointing
> out that it could be used in a way that yields unexpected results.
> 
> In my usual setup I put this kind of configuration in a heading of its
> own that is protected by a :noexport: tag.  This works for me because I
> often have notes about why things are in there and what I think they
> might be doing.

Great!  Thanks.  Your tutorial has been very helpful to me.  I needed to
figure out how to set up a special-purpose format for my document and in
a moment I had just the solution I needed.

I suppose one could do...

(unless (find "per-file-class" org-export-latex-classes :key 'car
           :test 'equal)
  (add-to-list 'org-export-latex-classes
          '("per-file-class"
             "\\documentclass{scrartcl}
             [NO-DEFAULT-PACKAGES]
             [EXTRA]"
             ("\\section{%s}" . "\\section*{%s}")
             ("\\subsection{%s}" . "\\subsection*{%s}")
             ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
             ("\\paragraph{%s}" . "\\paragraph*{%s}")
             ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))))

since the add-to-list is a globally side-effecting action; it doesn't
need to be repeated on each export, right?  [I thought at first pushnew
could do the job, but now I don't think so.]

Best,
R

Re: Bug in latex export tutorial on worg ?

[Thomas S. Dye]

Robert Goldman <rpgoldman@sift.info> writes:

> On 5/10/11 May 10 -12:25 AM, Thomas S. Dye wrote:
>> Robert Goldman <rpgoldman@sift.info> writes:
>> 
>>> On 5/9/11 May 9 -11:22 PM, Nick Dokos wrote:
>>>> Robert Goldman <rpgoldman@sift.info> wrote:
>>>>
>>>>> On 5/9/11 May 9 -9:54 PM, Nick Dokos wrote:
>>>>>> Robert Goldman <rpgoldman@sift.info> wrote:
>>>>>>
>>>>>>> There is the following code block there:
>>>>>>>
>>>>>>> #+begin_src emacs-lisp :results silent
>>>>>>>   (add-to-list 'org-export-latex-classes
>>>>>>>           '("per-file-class"
>>>>>>>              "\\documentclass{scrartcl}
>>>>>>>              [NO-DEFAULT-PACKAGES]
>>>>>>>              [EXTRA]"
>>>>>>>              ("\\section{%s}" . "\\section*{%s}")
>>>>>>>              ("\\subsection{%s}" . "\\subsection*{%s}")
>>>>>>>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>>>>>>>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>>>>>>>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
>>>>>>> #+end_src
>>>>>>>
>>>>>>> Is this still correct?  Or should this be :exports none instead of
>>>>>>> :results silent?
>>>>>>>
>>>>>>
>>>>>> ``:results silent'' works for me and keeps the result from appearing in
>>>>>> the org buffer. I don't think :exports can do that - it can only affect
>>>>>> what's exported.
>>>>>>
>>>>>> Nick
>>>>>
>>>>> I must be doing something wrong then --- I had the :results silent and
>>>>> found the source block in verbatim in my latex export file....  Changing
>>>>> to :exports none made that go away for me.  Maybe that was a
>>>>> coincidence.  I will have to investigate further, I guess.
>>>>>
>>>>
>>>> No, you are not doing anything wrong: the default :exports value is
>>>> "code", so the code ends up in your export. ``:exports none'' keeps it
>>>> (and any results) from being exported.
>>>>
>>>> OTOH, try evaluating (C-c C-c) the code block, with and without
>>>> ``:results silent''. There is a behavior difference and *that* difference
>>>> is not affected by how you set :exports.
>>>>
>>>> Nick
>>>
>>> Ah.  I get it now.  But then surely the above IS a bug -- presumably
>>> it's not usual for a person to wish their latex export configuration to
>>> appear, in verbatim block, in their org-generated latex document!
>>>
>>> Best,
>>> Robert
>>>
>>>
>>>
>> 
>> Aloha Robert,
>> 
>> I've added :exports none to the example, which came from a document
>> about how to export LaTeX documents from Org-mode.  Thanks for pointing
>> out that it could be used in a way that yields unexpected results.
>> 
>> In my usual setup I put this kind of configuration in a heading of its
>> own that is protected by a :noexport: tag.  This works for me because I
>> often have notes about why things are in there and what I think they
>> might be doing.
>
> Great!  Thanks.  Your tutorial has been very helpful to me.  I needed to
> figure out how to set up a special-purpose format for my document and in
> a moment I had just the solution I needed.
>
> I suppose one could do...
>
> (unless (find "per-file-class" org-export-latex-classes :key 'car
>            :test 'equal)
>   (add-to-list 'org-export-latex-classes
>           '("per-file-class"
>              "\\documentclass{scrartcl}
>              [NO-DEFAULT-PACKAGES]
>              [EXTRA]"
>              ("\\section{%s}" . "\\section*{%s}")
>              ("\\subsection{%s}" . "\\subsection*{%s}")
>              ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
>              ("\\paragraph{%s}" . "\\paragraph*{%s}")
>              ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))))
>
> since the add-to-list is a globally side-effecting action; it doesn't
> need to be repeated on each export, right?  [I thought at first pushnew
> could do the job, but now I don't think so.]
>
> Best,
> R
>

Aloha Robert,

Many thanks for this improvement to the example code.  I've added it to
the tutorial (and to my own bits of setup code).

All the best,
Tom

-- 
T.S. Dye & Colleagues, Archaeologists
735 Bishop St, Suite 315, Honolulu, HI 96813
Tel: 808-529-0866, Fax: 808-529-0884
http://www.tsdye.com