org.texi: Improve documentation for LaTeX export
This commit is contained in:
parent
57fa03b2da
commit
c7bb15aaff
136
doc/org.texi
136
doc/org.texi
|
@ -605,8 +605,7 @@ HTML export
|
||||||
* @LaTeX{}/PDF export commands::
|
* @LaTeX{}/PDF export commands::
|
||||||
* Header and sectioning:: Setting up the export file structure
|
* Header and sectioning:: Setting up the export file structure
|
||||||
* Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
|
* Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
|
||||||
* Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
|
* @LaTeX{} specific attributes:: Controlling @LaTeX{} output
|
||||||
* Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
|
|
||||||
* Beamer class export:: Turning the file into a presentation
|
* Beamer class export:: Turning the file into a presentation
|
||||||
|
|
||||||
OpenDocument Text export
|
OpenDocument Text export
|
||||||
|
@ -9550,8 +9549,8 @@ with a line like
|
||||||
#+OPTIONS: toc:nil (no TOC at all)
|
#+OPTIONS: toc:nil (no TOC at all)
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
The same @code{TOC} keyword can also generate a list of all tables (resp. all
|
The same @code{TOC} keyword can also generate a list of all tables (resp.@:
|
||||||
listings) with a caption in the buffer.
|
all listings) with a caption in the buffer.
|
||||||
|
|
||||||
@example
|
@example
|
||||||
#+TOC: listings (build a list of listings)
|
#+TOC: listings (build a list of listings)
|
||||||
|
@ -11023,16 +11022,20 @@ possibly @code{luatex}. See the variables
|
||||||
@code{org-latex-default-packages-alist} and
|
@code{org-latex-default-packages-alist} and
|
||||||
@code{org-latex-packages-alist}.}, this back-end is also used to produce PDF
|
@code{org-latex-packages-alist}.}, this back-end is also used to produce PDF
|
||||||
output. Since the @LaTeX{} output uses @file{hyperref} to implement links
|
output. Since the @LaTeX{} output uses @file{hyperref} to implement links
|
||||||
and cross references, the PDF output file will be fully linked. Beware of
|
and cross references, the PDF output file will be fully linked.
|
||||||
the fact that your @code{org} file has to be properly structured in order to
|
|
||||||
be correctly exported: respect the hierarchy of sections.
|
As is @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
|
||||||
|
will not be started if two contiguous syntactical elements are not separated
|
||||||
|
by an empty line.
|
||||||
|
|
||||||
|
This back-end also offers enhanced support for footnotes. Thus, it handles
|
||||||
|
nested footnotes, footnotes in tables and footnotes in items' description.
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* @LaTeX{}/PDF export commands::
|
* @LaTeX{}/PDF export commands::
|
||||||
* Header and sectioning:: Setting up the export file structure
|
* Header and sectioning:: Setting up the export file structure
|
||||||
* Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
|
* Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
|
||||||
* Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
|
* @LaTeX{} specific attributes:: Controlling @LaTeX{} output
|
||||||
* Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
|
|
||||||
* Beamer class export:: Turning the file into a presentation
|
* Beamer class export:: Turning the file into a presentation
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
|
@ -11112,7 +11115,7 @@ An example is shown below.
|
||||||
some text
|
some text
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
@node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
|
@node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export
|
||||||
@subsection Quoting @LaTeX{} code
|
@subsection Quoting @LaTeX{} code
|
||||||
|
|
||||||
Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
|
Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
|
||||||
|
@ -11140,15 +11143,19 @@ All lines between these markers are exported literally
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
|
|
||||||
@node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
|
@node @LaTeX{} specific attributes, Beamer class export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
|
||||||
@subsection Tables in @LaTeX{} export
|
@subsection @LaTeX{} specific attributes
|
||||||
|
@cindex #+ATTR_LATEX
|
||||||
|
|
||||||
|
@LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
|
||||||
|
affect tables, images, plain lists, special blocks and source blocks.
|
||||||
|
|
||||||
|
@subsubsection Tables in @LaTeX{} export
|
||||||
@cindex tables, in @LaTeX{} export
|
@cindex tables, in @LaTeX{} export
|
||||||
|
|
||||||
For @LaTeX{} export of a table, you can specify a label and a caption
|
For @LaTeX{} export of a table, you can specify a label and a caption
|
||||||
(@pxref{Images and tables}).
|
(@pxref{Images and tables}). You can also use attributes to control table
|
||||||
|
layout and contents. Valid properties are:
|
||||||
You can also use the @code{ATTR_LATEX} line to control table layout and
|
|
||||||
contents. Valid attributes are:
|
|
||||||
|
|
||||||
@table @code
|
@table @code
|
||||||
@item :mode
|
@item :mode
|
||||||
|
@ -11171,7 +11178,9 @@ Float environment for the table. Possible values are @code{sidewaystable},
|
||||||
@code{multicolumn} and @code{table}. If unspecified, a table with a caption
|
@code{multicolumn} and @code{table}. If unspecified, a table with a caption
|
||||||
will have a @code{table} environment. Moreover, @code{:placement} attribute
|
will have a @code{table} environment. Moreover, @code{:placement} attribute
|
||||||
can specify the positioning of the float.
|
can specify the positioning of the float.
|
||||||
@item :align, :font, :width
|
@item :align
|
||||||
|
@itemx :font
|
||||||
|
@itemx :width
|
||||||
set, respectively, the alignment string of the table, its font size and its
|
set, respectively, the alignment string of the table, its font size and its
|
||||||
width. They only apply on regular tables.
|
width. They only apply on regular tables.
|
||||||
@item :spread
|
@item :spread
|
||||||
|
@ -11179,15 +11188,19 @@ Boolean specific to the @code{tabu} and @code{longtabu} environments, and
|
||||||
only takes effect when used in conjunction with the @code{:width} attribute.
|
only takes effect when used in conjunction with the @code{:width} attribute.
|
||||||
When @code{:spread} is non-nil, the table will be spread or shrunk by the
|
When @code{:spread} is non-nil, the table will be spread or shrunk by the
|
||||||
value of @code{:width}.
|
value of @code{:width}.
|
||||||
@item :booktabs, :center, :rmlines
|
@item :booktabs
|
||||||
|
@itemx :center
|
||||||
|
@itemx :rmlines
|
||||||
@vindex org-latex-tables-booktabs
|
@vindex org-latex-tables-booktabs
|
||||||
@vindex org-latex-tables-centered
|
@vindex org-latex-tables-centered
|
||||||
They toggle, respectively, @code{booktabs} usage (assuming the package is
|
They toggle, respectively, @code{booktabs} usage (assuming the package is
|
||||||
properly loaded), table centering and removal of every horizontal rule but
|
properly loaded), table centering and removal of every horizontal rule but
|
||||||
the first one (in a "table.el" table only). In particular,
|
the first one (in a "table.el" table only). In particular,
|
||||||
@var{org-latex-tables-booktabs} (resp. @var{org-latex-tables-centered})
|
@var{org-latex-tables-booktabs} (resp.@: @var{org-latex-tables-centered})
|
||||||
activates the first (resp. second) attribute globally.
|
activates the first (resp.@: second) attribute globally.
|
||||||
@item :math-prefix, :math-suffix, :math-arguments
|
@item :math-prefix
|
||||||
|
@itemx :math-suffix
|
||||||
|
@itemx :math-arguments
|
||||||
string which will be inserted, respectively, before the table within the math
|
string which will be inserted, respectively, before the table within the math
|
||||||
environment, after the table within the math environment, and between the
|
environment, after the table within the math environment, and between the
|
||||||
macro name and the contents of the table. The latter attribute is necessary
|
macro name and the contents of the table. The latter attribute is necessary
|
||||||
|
@ -11212,8 +11225,7 @@ a table that will span over multiple pages, or a matrix product:
|
||||||
| 3 | 4 |
|
| 3 | 4 |
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
@node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
|
@subsubsection Images in @LaTeX{} export
|
||||||
@subsection Images in @LaTeX{} export
|
|
||||||
@cindex images, inline in @LaTeX{}
|
@cindex images, inline in @LaTeX{}
|
||||||
@cindex inlining images in @LaTeX{}
|
@cindex inlining images in @LaTeX{}
|
||||||
|
|
||||||
|
@ -11222,13 +11234,13 @@ Images that are linked to without a description part in the link, like
|
||||||
output file resulting from @LaTeX{} processing. Org will use an
|
output file resulting from @LaTeX{} processing. Org will use an
|
||||||
@code{\includegraphics} macro to insert the image@footnote{In the case of
|
@code{\includegraphics} macro to insert the image@footnote{In the case of
|
||||||
TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
|
TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
|
||||||
@code{\input} macro wrapped within a @code{tikzpicture} environment.}. You
|
@code{\input} macro wrapped within a @code{tikzpicture} environment.}.
|
||||||
can use an @code{#+ATTR_LATEX:} line to specify its width or height, with,
|
|
||||||
respectively, @code{:width} and @code{:height} attributes. It is also
|
You can specify specify image width or height with, respectively,
|
||||||
possible to specify any other option with the @code{:options} attribute, as
|
@code{:width} and @code{:height} attributes. It is also possible to add any
|
||||||
shown in the following example:
|
other option with the @code{:options} attribute, as shown in the following
|
||||||
|
example:
|
||||||
|
|
||||||
@cindex #+ATTR_LATEX
|
|
||||||
@example
|
@example
|
||||||
#+ATTR_LATEX: :width 5cm :options angle=90
|
#+ATTR_LATEX: :width 5cm :options angle=90
|
||||||
[[./img/sed-hr4049.pdf]]
|
[[./img/sed-hr4049.pdf]]
|
||||||
|
@ -11237,8 +11249,8 @@ shown in the following example:
|
||||||
If you have specified a caption as described in @ref{Images and tables}, the
|
If you have specified a caption as described in @ref{Images and tables}, the
|
||||||
picture will be wrapped into a @code{figure} environment and thus become
|
picture will be wrapped into a @code{figure} environment and thus become
|
||||||
a floating element. You can also ask Org to export an image as a float
|
a floating element. You can also ask Org to export an image as a float
|
||||||
without specifying caption by setting the @code{:float} attribute to
|
without specifying caption by setting the @code{:float} attribute. You may
|
||||||
@code{figure} value in @code{#+ATTR_LATEX:} line. You may also set it to:
|
also set it to:
|
||||||
@itemize @minus
|
@itemize @minus
|
||||||
@item
|
@item
|
||||||
@code{wrap}: if you would like to let text flow around the image. It will
|
@code{wrap}: if you would like to let text flow around the image. It will
|
||||||
|
@ -11252,7 +11264,6 @@ environment.
|
||||||
To modify the placement option of any floating environment, set the
|
To modify the placement option of any floating environment, set the
|
||||||
@code{placement} attribute.
|
@code{placement} attribute.
|
||||||
|
|
||||||
@cindex #+ATTR_LATEX
|
|
||||||
@example
|
@example
|
||||||
#+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
|
#+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
|
||||||
[[./img/hst.png]]
|
[[./img/hst.png]]
|
||||||
|
@ -11261,12 +11272,65 @@ To modify the placement option of any floating environment, set the
|
||||||
Eventually, in the @code{:comment-include} attributes has a non-nil value,
|
Eventually, in the @code{:comment-include} attributes has a non-nil value,
|
||||||
the code actually including the image will be commented out.
|
the code actually including the image will be commented out.
|
||||||
|
|
||||||
@node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
|
@subsubsection Plain lists in @LaTeX{} export
|
||||||
|
@cindex plain lists, in @LaTeX{} export
|
||||||
|
|
||||||
|
Plain lists accept two optional attributes: @code{:environment} and
|
||||||
|
@code{:options}. The first one allows to use a non-standard environment
|
||||||
|
(e.g., @samp{inparaenum}). The second one allows to specify optional
|
||||||
|
arguments for that environment (square brackets may be omitted).
|
||||||
|
|
||||||
|
@example
|
||||||
|
#+ATTR_LATEX: :environment compactitem :options $\circ$
|
||||||
|
- you need ``paralist'' package to reproduce this example.
|
||||||
|
@end example
|
||||||
|
|
||||||
|
@subsubsection Source blocks in @LaTeX{} export
|
||||||
|
@cindex source blocks, in @LaTeX{} export
|
||||||
|
|
||||||
|
In addition to syntax defined in @ref{Literal examples}, names and captions
|
||||||
|
(@pxref{Images and tables}), source blocks also accept @code{:long-listing}
|
||||||
|
attribute, which prevents the block to become a float when non nil.
|
||||||
|
|
||||||
|
@example
|
||||||
|
#+ATTR_LATEX: :long-listing t
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
Code that may not fit in a single page.
|
||||||
|
#+END_SRC
|
||||||
|
@end example
|
||||||
|
|
||||||
|
@subsubsection Special blocks in @LaTeX{} export
|
||||||
|
@cindex special blocks, in @LaTeX{} export
|
||||||
|
|
||||||
|
In @LaTeX{} back-end, special blocks become environments of the same name.
|
||||||
|
Value of @code{:options} attribute will be appended as-is to that
|
||||||
|
environment's opening string. For example:
|
||||||
|
|
||||||
|
@example
|
||||||
|
#+ATTR_LATEX: :options [Proof of important theorem]
|
||||||
|
#+BEGIN_PROOF
|
||||||
|
...
|
||||||
|
Therefore, any natural number above 4 is the sum of two primes.
|
||||||
|
#+END_PROOF
|
||||||
|
@end example
|
||||||
|
|
||||||
|
@noindent
|
||||||
|
becomes
|
||||||
|
|
||||||
|
@example
|
||||||
|
\begin@{proof@}[Proof of important theorem]
|
||||||
|
...
|
||||||
|
Therefore, any natural number above 4 is the sum of two primes.
|
||||||
|
\end@{proof@}
|
||||||
|
@end example
|
||||||
|
|
||||||
|
@node Beamer class export, , @LaTeX{} specific attributes, @LaTeX{} and PDF export
|
||||||
@subsection Beamer class export
|
@subsection Beamer class export
|
||||||
|
|
||||||
The @LaTeX{} class @file{beamer} allows production of high quality presentations
|
The @LaTeX{} class @file{beamer} allows production of high quality
|
||||||
using @LaTeX{} and pdf processing. Org mode has special support for turning an
|
presentations using @LaTeX{} and pdf processing. Org mode has special
|
||||||
Org mode file or tree into a @file{beamer} presentation.
|
support for turning an Org mode file or tree into a @file{beamer}
|
||||||
|
presentation.
|
||||||
|
|
||||||
When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
|
When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
|
||||||
beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
|
beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
|
||||||
|
|
Loading…
Reference in New Issue