Suvayu Ali <fatkasuvayu+li...@gmail.com> wrote:
> Hello everyone,
>
> On Wed, 1 Jun 2011 12:08:25 -0700
> Suvayu Ali <fatkasuvayu+li...@gmail.com> wrote:
>
> > On Wed, 01 Jun 2011 14:50:34 -0400
> > Nick Dokos <nicholas.do...@hp.com> wrote:
> >
> > > <soapbox> I've tried to keep a neutral tone in (most of) the rest of
> > > the mail, but I have to say that I think clever hacks like this are
> > > too clever for their own good - they are at best an accident of
> > > implementation. The fact that the trick uses the placement option in
> > > order to change the font testifies to that.
> >
> > After the very clear description above, I agree 100%. I will remove my
> > addition to the manual and instead try to improve the #+ATTR_LaTeX:
> > documentation based on your code commentary. At the moment I am
> > facing a very important deadline for the 8th of June, I will submit a
> > revised patch after that.
> >
>
> I have attached a patch removing the hack from the manual and making
> some other small improvements to the latex export of images. However I
> did leave in one sentence regarding the placement option which alludes
> that a hack is possible.
>
> Please let me know if this is an improvement.
>
> > > They should certainly be documented as hacks on Worg, but I'm not
> > > sure they should be documented in the manual. Of course, it may
> > > happen that a really good hack (by some definition of "really
> > > good") should be elevated to a standard and documented in the
> > > manual, but IMO this one does not qualify. </soapbox>
> > >
> >
> > Along with the revisions for the manual, I will document my hack on
> > Worg.
>
> I made an account with repo.or.cz. I will soon push the changes
> documenting the hack on Worg.
>
> --
> Suvayu
>
> Open source is the future. It sets us free.
> >From 7f66dba736136fc1a2ee8e2d4fbce47e07db3ca6 Mon Sep 17 00:00:00 2001
> From: Suvayu Ali (ThinkPad) <fatkasuvayu+li...@gmail.com>
> Date: Fri, 10 Jun 2011 14:57:48 -0700
> Subject: [PATCH] Improve "Images in LaTeX export" documentation
>
> * Mention use of keywords like multicolumn and float
> * Remove previous mention of hack with placement option
> as per comments on the mailing list. Hack better
> suited for Worg.
> ---
> doc/org.texi | 30 ++++++++++++------------------
> 1 files changed, 12 insertions(+), 18 deletions(-)
>
> diff --git a/doc/org.texi b/doc/org.texi
> index 92343de..c98bd53 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -10207,24 +10207,14 @@ output file resulting from @LaTeX{} processing.
> Org will use an
> @code{\includegraphics} macro to insert the image. If you have specified a
> caption and/or a label as described in @ref{Images and tables}, the figure
> will be wrapped into a @code{figure} environment and thus become a floating
> -element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
> -options that can be used in the optional argument of the
> -@code{\includegraphics} macro. To modify the placement option of the
> -@code{figure} environment, add something like @samp{placement=[h!]} to the
> -Attributes. It is to be noted this option can be used with tables as well.
> -The options are passed as the placement option to floating environments like
> -@code{figure} or @code{table}. One can pass other compatible options as well.
> -For example the @code{#+ATTR_LaTeX:} line below is exported as the
> -@code{figure} environment below it.
> -
> -@cindex #+ATTR_LaTeX
> -@example
> -#+ATTR_LaTeX: placement=[<options>]\footnotesize
> -
> -\begin@{figure@}[<options>]\footnotesize
> -...
> -\end@{figure@}
> -@end example
> +element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
> +options. You can ask org to export an image as a float without specifying
> +a label or a caption by using the keyword @code{float} in this line. Various
> +optional arguments to the @code{\includegraphics} macro can also be specified
> +in this fashion. To modify the placement option of the floating environment,
> +add something like @samp{placement=[h!]} to the attributes. It is to be
> noted
> +this option can be used with tables as well. One can also pass other
> +compatible options.
>
The question here is: what does "compatible" mean? Compatible with what?
Now that you added the hack to Worg, it might be better to say:
"One can also take advantage of this option to pass other, unrelated options
into the figure or table environment (see
[[http://orgmode.org/worg/org-hacks.html#sec-1_6_1][here]] for an example.)"
or something like that.
> If you would like to let text flow around the image, add the word @samp{wrap}
> to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
> @@ -10246,6 +10236,10 @@ for @code{\includegraphics} and @code{wrapfigure}.
> [[./img/hst.png]]
> @end example
>
> +If you wish to include an image which spans multiple columns in a page,
> +you can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX}
> +line. This will export the image wrapped in a @code{figure*} environment.
> +
> If you need references to a label created in this way, write
> @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
Otherwise, this looks good to me.
Thanks,
Nick
