BEAMER_HEADER in `org-latex-classes'

BEAMER_HEADER in `org-latex-classes'

[Sebastien Vauban]

Hello,

In the `org-latex-classes' documentation (and in the Org Beamer documentation),
I don't see how to include or exclude lines passed through the #+BEAMER_HEADER
keyword.

  ╭────
  │ The header string
  │ -----------------
  │ 
  │ The HEADER-STRING is the header that will be inserted into the
  │ LaTeX file.  It should contain the \documentclass macro, and
  │ anything else that is needed for this setup.  To this header, the
  │ following commands will be added:
  │ 
  │ - Calls to \usepackage for all packages mentioned in the
  │   variables `org-latex-default-packages-alist' and
  │   `org-latex-packages-alist'.  Thus, your header definitions
  │   should avoid to also request these packages.
  │ 
  │ - Lines specified via "#+LATEX_HEADER:" and
  │   "#+LATEX_HEADER_EXTRA:" keywords.
  │ 
  │ If you need more control about the sequence in which the header
  │ is built up, or if you want to exclude one of these building
  │ blocks for a particular class, you can use the following
  │ macro-like placeholders.
  │ 
  │  [DEFAULT-PACKAGES]      \usepackage statements for default packages
  │  [NO-DEFAULT-PACKAGES]   do not include any of the default packages
  │  [PACKAGES]              \usepackage statements for packages
  │  [NO-PACKAGES]           do not include the packages
  │  [EXTRA]                 the stuff from #+LATEX_HEADER(_EXTRA)
  │  [NO-EXTRA]              do not include #+LATEX_HEADER(_EXTRA) stuff
  ╰────

Is there a solution for those lines?

Best regards,
  Seb

-- 
Sebastien Vauban

Re: BEAMER_HEADER in `org-latex-classes'

[Nicolas Goaziou]

Hello,

"Sebastien Vauban" <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org>
writes:

> In the `org-latex-classes' documentation (and in the Org Beamer documentation),
> I don't see how to include or exclude lines passed through the #+BEAMER_HEADER
> keyword.

[...]

> Is there a solution for those lines?

These lines are included in [EXTRA] placeholder, like LATEX_HEADER.


Regards,

-- 
Nicolas Goaziou

Re: BEAMER_HEADER in `org-latex-classes'

[Sebastien Vauban]

Hello,

Nicolas Goaziou wrote:
> "Sebastien Vauban" <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org> writes:
>
>> In the `org-latex-classes' documentation (and in the Org Beamer documentation),
>> I don't see how to include or exclude lines passed through the #+BEAMER_HEADER
>> keyword.
>>
>> Is there a solution for those lines?
>
> These lines are included in [EXTRA] placeholder, like LATEX_HEADER.

True. Confirmed ;-)

I'd then propose the attached patch for the documentation.

BTW, what's the difference between #+LATEX_HEADER and #+LATEX_HEADER_EXTRA
lines, if both end up under the same umbrella ([EXTRA])?  Couldn't we suppress
the #+LATEX_HEADER_EXTRA keyword?

Best regards,
  Seb

From 6b6e9c06e1933820a0f0a1837dc1ea3e8a090c55 Mon Sep 17 00:00:00 2001
From: Sebastien Vauban <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org>
Date: Fri, 8 Nov 2013 10:27:57 +0100
Subject: [PATCH] Add #+BEAMER_HEADER keyword line in [EXTRA]

* ox-latex.el (org-latex-classes): Add BEAMER_HEADER in the documentation string.

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

diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index ae78260..cf53c38 100644
--- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -241,8 +241,8 @@ macro-like placeholders.
  [NO-DEFAULT-PACKAGES]   do not include any of the default packages
  [PACKAGES]              \\usepackage statements for packages
  [NO-PACKAGES]           do not include the packages
- [EXTRA]                 the stuff from #+LATEX_HEADER(_EXTRA)
- [NO-EXTRA]              do not include #+LATEX_HEADER(_EXTRA) stuff
+ [EXTRA]                 the stuff from #+LATEX/BEAMER_HEADER(_EXTRA)
+ [NO-EXTRA]              do not include #+LATEX/BEAMER_HEADER(_EXTRA) stuff
 
 So a header like
 
-- 
1.7.9

-- 
Sebastien Vauban

Re: BEAMER_HEADER in `org-latex-classes'

[Nicolas Goaziou]

Hello,

"Sebastien Vauban" <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org>
writes:

> I'd then propose the attached patch for the documentation.

Thank you for the patch.

> BTW, what's the difference between #+LATEX_HEADER and #+LATEX_HEADER_EXTRA
> lines, if both end up under the same umbrella ([EXTRA])?  Couldn't we suppress
> the #+LATEX_HEADER_EXTRA keyword?

According to section 12.7.2 in manual, LATEX_HEADER_EXTRA will not be
loaded when previewing LaTeX snippets, unlike to LATEX_HEADER.

> * ox-latex.el (org-latex-classes): Add BEAMER_HEADER in the
> documentation string.

`beamer' is a different back-end than `latex', or to put it differently,
`latex' back-end is not supposed to know about `beamer'. That's why no
reference to `beamer' appears in `org-latex-classes'.

If documentation is needed, I think it should go in the manual, as
a footnote close to the reference to BEAMER_HEADER.


Regards,

-- 
Nicolas Goaziou

Re: BEAMER_HEADER in `org-latex-classes'

[Sebastien Vauban]

Hello,

Nicolas Goaziou wrote:
> "Sebastien Vauban" <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org> writes:
>
>> I'd then propose the attached patch for the documentation.
>
> Thank you for the patch.
>
>> BTW, what's the difference between #+LATEX_HEADER and #+LATEX_HEADER_EXTRA
>> lines, if both end up under the same umbrella ([EXTRA])?  Couldn't we suppress
>> the #+LATEX_HEADER_EXTRA keyword?
>
> According to section 12.7.2 in manual, LATEX_HEADER_EXTRA will not be
> loaded when previewing LaTeX snippets, unlike to LATEX_HEADER.

Shouldn't the similar principle be applied to BEAMER_HEADER, that is have a
BEAMER_HEADER_EXTRA keyword as well?

>> * ox-latex.el (org-latex-classes): Add BEAMER_HEADER in the
>> documentation string.
>
> `beamer' is a different back-end than `latex', or to put it differently,
> `latex' back-end is not supposed to know about `beamer'.

I understand.

> That's why no reference to `beamer' appears in `org-latex-classes'.

Though, this is only true as long as ox-beamer is not loaded. Because ox-beamer
does add "beamer" to `org-latex-classes' (which is right IMO).

> If documentation is needed, I think it should go in the manual, as
> a footnote close to the reference to BEAMER_HEADER.

OK.

Best regards,
  Seb

-- 
Sebastien Vauban

Re: BEAMER_HEADER in `org-latex-classes'

[Nicolas Goaziou]

"Sebastien Vauban" <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org>
writes:

> Shouldn't the similar principle be applied to BEAMER_HEADER, that is have a
> BEAMER_HEADER_EXTRA keyword as well?

Snippets previewing calls `latex' back-end (class used in
`org-format-latex-header' is "article", not "beamer).
Therefore #+BEAMER_HEADER will not be applied to the generated document
and BEAMER_HEADER_EXTRA doesn't make much sense.

>> That's why no reference to `beamer' appears in `org-latex-classes'.
>
> Though, this is only true as long as ox-beamer is not loaded. Because ox-beamer
> does add "beamer" to `org-latex-classes' (which is right IMO).

I meant that no reference appears in `org-latex-classes' docstring.


Regards,

-- 
Nicolas Goaziou

Re: BEAMER_HEADER in `org-latex-classes'

[Sebastien Vauban]

Nicolas Goaziou wrote:
> "Sebastien Vauban" writes:
>
>> Shouldn't the similar principle be applied to BEAMER_HEADER, that is have a
>> BEAMER_HEADER_EXTRA keyword as well?
>
> Snippets previewing calls `latex' back-end (class used in
> `org-format-latex-header' is "article", not "beamer).
> Therefore #+BEAMER_HEADER will not be applied to the generated document
> and BEAMER_HEADER_EXTRA doesn't make much sense.

Understood, now...

>>> That's why no reference to `beamer' appears in `org-latex-classes'.
>>
>> Though, this is only true as long as ox-beamer is not loaded. Because ox-beamer
>> does add "beamer" to `org-latex-classes' (which is right IMO).
>
> I meant that no reference appears in `org-latex-classes' docstring.

Clear. Thanks.

Best regards,
  Seb

-- 
Sebastien Vauban