Suggestion: provide more detailed example of :options for LaTeX special blocks

Suggestion: provide more detailed example of :options for LaTeX special blocks

[Olivier Berger]

Hi.

May I suggest to improve the docs of
[[http://orgmode.org/manual/Special-blocks-in-LaTeX-export.html][Special
blocks in LaTeX export]] to make it more explicit that the special
blocks :options can contain both options or arguments of the LaTeX environment.

Here's an example:

#+ATTR_LATEX: :options [logo=\bcattention]{The warning}
#+BEGIN_bclogo
Attention, this is a warning
#+END_bclogo

This requires or course:
#+LaTeX_HEADER: \usepackage[tikz]{bclogo}


I've been struggling with trying to do this, until I read the sources of
ox-latex and noticed that it wasn't limited to the '[...]'
options... and much later re-read the manual to finally notice the
"appends as-is to that environment's opening string" ;-)

Maybe providing an example that uses both the '[...]' and the '{...}'
would save others' time.

Unfortunately, I'm not fluent enough in LaTeX to suggest a more
"generic" environment than bclogo, readily available in an article, for a
direct patch proposal to the manual sources.

Hope this helps.

Thanks in advance.

Best regards,
-- 
Olivier BERGER 
http://www-public.telecom-sudparis.eu/~berger_o/ - OpenPGP-Id: 2048R/5819D7E8
Ingenieur Recherche - Dept INF
Institut Mines-Telecom, Telecom SudParis, Evry (France)

Re: Suggestion: provide more detailed example of :options for LaTeX special blocks

[Nicolas Goaziou]

Hello,

Olivier Berger <olivier.berger@telecom-sudparis.eu> writes:

> May I suggest to improve the docs of
> [[http://orgmode.org/manual/Special-blocks-in-LaTeX-export.html][Special
> blocks in LaTeX export]] to make it more explicit that the special
> blocks :options can contain both options or arguments of the LaTeX environment.
>
> Here's an example:
>
> #+ATTR_LATEX: :options [logo=\bcattention]{The warning}
>
> #+BEGIN_bclogo
> Attention, this is a warning
> #+END_bclogo
>
> This requires or course:
> #+LaTeX_HEADER: \usepackage[tikz]{bclogo}
>
>
> I've been struggling with trying to do this, until I read the sources of
> ox-latex and noticed that it wasn't limited to the '[...]'
> options... and much later re-read the manual to finally notice the
> "appends as-is to that environment's opening string" ;-)
>
> Maybe providing an example that uses both the '[...]' and the '{...}'
> would save others' time.
>
> Unfortunately, I'm not fluent enough in LaTeX to suggest a more
> "generic" environment than bclogo, readily available in an article, for a
> direct patch proposal to the manual sources.

I think minipage environment fits the bill. Would the following example,
used to put two pictures side by side, clear enough?

  #+ATTR_LATEX: :options [t]{.5\textwidth}
  #+BEGIN_minipage
  [[file:left-image.pdf]]
  #+END_minipage
  #+ATTR_LATEX: :options [t]{.5\textwidth}
  #+BEGIN_minipage
  [[file:right-image.pdf]]
  #+END_minipage
  
Regards,

-- 
Nicolas Goaziou