1 ;;; ox-latex.el --- LaTeX Back-End for Org Export Engine
3 ;; Copyright (C) 2011-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; See Org manual for details.
29 (eval-when-compile (require 'cl
))
33 (defvar org-latex-default-packages-alist
)
34 (defvar org-latex-packages-alist
)
35 (defvar orgtbl-exp-regexp
)
41 (org-export-define-backend 'latex
42 '((bold . org-latex-bold
)
43 (center-block . org-latex-center-block
)
44 (clock . org-latex-clock
)
45 (code . org-latex-code
)
46 (comment .
(lambda (&rest args
) ""))
47 (comment-block .
(lambda (&rest args
) ""))
48 (drawer . org-latex-drawer
)
49 (dynamic-block . org-latex-dynamic-block
)
50 (entity . org-latex-entity
)
51 (example-block . org-latex-example-block
)
52 (export-snippet . org-latex-export-snippet
)
53 (fixed-width . org-latex-fixed-width
)
54 (footnote-definition . org-latex-footnote-definition
)
55 (footnote-reference . org-latex-footnote-reference
)
56 (headline . org-latex-headline
)
57 (horizontal-rule . org-latex-horizontal-rule
)
58 (inline-src-block . org-latex-inline-src-block
)
59 (inlinetask . org-latex-inlinetask
)
60 (italic . org-latex-italic
)
61 (item . org-latex-item
)
62 (keyword . org-latex-keyword
)
63 (latex-environment . org-latex-latex-environment
)
64 (latex-fragment . org-latex-latex-fragment
)
65 (line-break . org-latex-line-break
)
66 (link . org-latex-link
)
67 (node-property . org-latex-node-property
)
68 (paragraph . org-latex-paragraph
)
69 (plain-list . org-latex-plain-list
)
70 (plain-text . org-latex-plain-text
)
71 (planning . org-latex-planning
)
72 (property-drawer . org-latex-property-drawer
)
73 (quote-block . org-latex-quote-block
)
74 (radio-target . org-latex-radio-target
)
75 (section . org-latex-section
)
76 (special-block . org-latex-special-block
)
77 (src-block . org-latex-src-block
)
78 (statistics-cookie . org-latex-statistics-cookie
)
79 (strike-through . org-latex-strike-through
)
80 (subscript . org-latex-subscript
)
81 (superscript . org-latex-superscript
)
82 (table . org-latex-table
)
83 (table-cell . org-latex-table-cell
)
84 (table-row . org-latex-table-row
)
85 (target . org-latex-target
)
86 (template . org-latex-template
)
87 (timestamp . org-latex-timestamp
)
88 (underline . org-latex-underline
)
89 (verbatim . org-latex-verbatim
)
90 (verse-block . org-latex-verse-block
)
92 (latex-math-block . org-latex-math-block
))
93 :export-block
'("LATEX" "TEX")
95 '(?l
"Export to LaTeX"
96 ((?L
"As LaTeX buffer" org-latex-export-as-latex
)
97 (?l
"As LaTeX file" org-latex-export-to-latex
)
98 (?p
"As PDF file" org-latex-export-to-pdf
)
99 (?o
"As PDF file and open"
101 (if a
(org-latex-export-to-pdf t s v b
)
102 (org-open-file (org-latex-export-to-pdf nil s v b
)))))))
103 :filters-alist
'((:filter-options . org-latex-math-block-options-filter
)
104 (:filter-parse-tree . org-latex-math-block-tree-filter
))
106 '((:latex-class
"LATEX_CLASS" nil org-latex-default-class t
)
107 (:latex-class-options
"LATEX_CLASS_OPTIONS" nil nil t
)
108 (:latex-header
"LATEX_HEADER" nil nil newline
)
109 (:latex-header-extra
"LATEX_HEADER_EXTRA" nil nil newline
)
111 (:latex-active-timestamp-format nil nil org-latex-active-timestamp-format
)
112 (:latex-classes nil nil org-latex-classes
)
113 (:latex-default-figure-position nil nil org-latex-default-figure-position
)
114 (:latex-default-table-environment nil nil org-latex-default-table-environment
)
115 (:latex-default-table-mode nil nil org-latex-default-table-mode
)
116 (:latex-diary-timestamp-format nil nil org-latex-diary-timestamp-format
)
117 (:latex-footnote-separator nil nil org-latex-footnote-separator
)
118 (:latex-format-drawer-function nil nil org-latex-format-drawer-function
)
119 (:latex-format-headline-function nil nil org-latex-format-headline-function
)
120 (:latex-format-inlinetask-function nil nil org-latex-format-inlinetask-function
)
121 (:latex-hyperref-template nil nil org-latex-hyperref-template t
)
122 (:latex-image-default-height nil nil org-latex-image-default-height
)
123 (:latex-image-default-option nil nil org-latex-image-default-option
)
124 (:latex-image-default-width nil nil org-latex-image-default-width
)
125 (:latex-inactive-timestamp-format nil nil org-latex-inactive-timestamp-format
)
126 (:latex-inline-image-rules nil nil org-latex-inline-image-rules
)
127 (:latex-link-with-unknown-path-format nil nil org-latex-link-with-unknown-path-format
)
128 (:latex-listings nil nil org-latex-listings
)
129 (:latex-listings-langs nil nil org-latex-listings-langs
)
130 (:latex-listings-options nil nil org-latex-listings-options
)
131 (:latex-minted-langs nil nil org-latex-minted-langs
)
132 (:latex-minted-options nil nil org-latex-minted-options
)
133 (:latex-table-caption-above nil nil org-latex-table-caption-above
)
134 (:latex-table-scientific-notation nil nil org-latex-table-scientific-notation
)
135 (:latex-tables-booktabs nil nil org-latex-tables-booktabs
)
136 (:latex-tables-centered nil nil org-latex-tables-centered
)
137 (:latex-text-markup-alist nil nil org-latex-text-markup-alist
)
138 (:latex-title-command nil nil org-latex-title-command
)
139 (:latex-toc-command nil nil org-latex-toc-command
)
140 ;; Redefine regular options.
141 (:date
"DATE" nil
"\\today" t
)))
145 ;;; Internal Variables
147 (defconst org-latex-babel-language-alist
148 '(("af" .
"afrikaans")
150 ("bt-br" .
"brazilian")
156 ("de-at" .
"naustrian")
157 ("de-de" .
"ngerman")
160 ("en-au" .
"australian")
161 ("en-ca" .
"canadian")
162 ("en-gb" .
"british")
164 ("en-nz" .
"newzealand")
165 ("en-us" .
"american")
171 ("fr-ca" .
"canadien")
175 ("id" .
"indonesian")
185 ("pt" .
"portuguese")
189 ("sb" .
"uppersorbian")
197 ("uk" .
"ukrainian"))
198 "Alist between language code and corresponding Babel option.")
200 (defconst org-latex-table-matrix-macros
'(("bordermatrix" .
"\\cr")
201 ("qbordermatrix" .
"\\cr")
202 ("kbordermatrix" .
"\\\\"))
203 "Alist between matrix macros and their row ending.")
205 (defconst org-latex-pseudo-objects
'(latex-math-block)
206 "List of pseudo-object types introduced in the back-end.")
210 ;;; User Configurable Variables
212 (defgroup org-export-latex nil
213 "Options for exporting Org mode files to LaTeX."
214 :tag
"Org Export LaTeX"
220 (defcustom org-latex-default-class
"article"
221 "The default LaTeX class."
222 :group
'org-export-latex
223 :type
'(string :tag
"LaTeX class"))
225 (defcustom org-latex-classes
227 "\\documentclass[11pt]{article}"
228 ("\\section{%s}" .
"\\section*{%s}")
229 ("\\subsection{%s}" .
"\\subsection*{%s}")
230 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")
231 ("\\paragraph{%s}" .
"\\paragraph*{%s}")
232 ("\\subparagraph{%s}" .
"\\subparagraph*{%s}"))
234 "\\documentclass[11pt]{report}"
235 ("\\part{%s}" .
"\\part*{%s}")
236 ("\\chapter{%s}" .
"\\chapter*{%s}")
237 ("\\section{%s}" .
"\\section*{%s}")
238 ("\\subsection{%s}" .
"\\subsection*{%s}")
239 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}"))
241 "\\documentclass[11pt]{book}"
242 ("\\part{%s}" .
"\\part*{%s}")
243 ("\\chapter{%s}" .
"\\chapter*{%s}")
244 ("\\section{%s}" .
"\\section*{%s}")
245 ("\\subsection{%s}" .
"\\subsection*{%s}")
246 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")))
247 "Alist of LaTeX classes and associated header and structure.
248 If #+LATEX_CLASS is set in the buffer, use its value and the
249 associated information. Here is the structure of each cell:
253 \(numbered-section . unnumbered-section)
259 The HEADER-STRING is the header that will be inserted into the
260 LaTeX file. It should contain the \\documentclass macro, and
261 anything else that is needed for this setup. To this header, the
262 following commands will be added:
264 - Calls to \\usepackage for all packages mentioned in the
265 variables `org-latex-default-packages-alist' and
266 `org-latex-packages-alist'. Thus, your header definitions
267 should avoid to also request these packages.
269 - Lines specified via \"#+LATEX_HEADER:\" and
270 \"#+LATEX_HEADER_EXTRA:\" keywords.
272 If you need more control about the sequence in which the header
273 is built up, or if you want to exclude one of these building
274 blocks for a particular class, you can use the following
275 macro-like placeholders.
277 [DEFAULT-PACKAGES] \\usepackage statements for default packages
278 [NO-DEFAULT-PACKAGES] do not include any of the default packages
279 [PACKAGES] \\usepackage statements for packages
280 [NO-PACKAGES] do not include the packages
281 [EXTRA] the stuff from #+LATEX_HEADER(_EXTRA)
282 [NO-EXTRA] do not include #+LATEX_HEADER(_EXTRA) stuff
286 \\documentclass{article}
287 [NO-DEFAULT-PACKAGES]
289 \\providecommand{\\alert}[1]{\\textbf{#1}}
292 will omit the default packages, and will include the
293 #+LATEX_HEADER and #+LATEX_HEADER_EXTRA lines, then have a call
294 to \\providecommand, and then place \\usepackage commands based
295 on the content of `org-latex-packages-alist'.
297 If your header, `org-latex-default-packages-alist' or
298 `org-latex-packages-alist' inserts \"\\usepackage[AUTO]{inputenc}\",
299 AUTO will automatically be replaced with a coding system derived
300 from `buffer-file-coding-system'. See also the variable
301 `org-latex-inputenc-alist' for a way to influence this mechanism.
303 Likewise, if your header contains \"\\usepackage[AUTO]{babel}\",
304 AUTO will be replaced with the language related to the language
305 code specified by `org-export-default-language', which see. Note
306 that constructions such as \"\\usepackage[french,AUTO,english]{babel}\"
309 The sectioning structure
310 ------------------------
312 The sectioning structure of the class is given by the elements
313 following the header string. For each sectioning level, a number
314 of strings is specified. A %s formatter is mandatory in each
315 section string and will be replaced by the title of the section.
317 Instead of a cons cell (numbered . unnumbered), you can also
318 provide a list of 2 or 4 elements,
320 \(numbered-open numbered-close)
324 \(numbered-open numbered-close unnumbered-open unnumbered-close)
326 providing opening and closing strings for a LaTeX environment
327 that should represent the document section. The opening clause
328 should have a %s to represent the section title.
330 Instead of a list of sectioning commands, you can also specify
331 a function name. That function will be called with two
332 parameters, the (reduced) level of the headline, and a predicate
333 non-nil when the headline should be numbered. It must return
334 a format string in which the section title will be added."
335 :group
'org-export-latex
337 (list (string :tag
"LaTeX class")
338 (string :tag
"LaTeX header")
339 (repeat :tag
"Levels" :inline t
342 (string :tag
" numbered")
343 (string :tag
"unnumbered"))
344 (list :tag
"Environment"
345 (string :tag
"Opening (numbered)")
346 (string :tag
"Closing (numbered)")
347 (string :tag
"Opening (unnumbered)")
348 (string :tag
"Closing (unnumbered)"))
349 (function :tag
"Hook computing sectioning"))))))
351 (defcustom org-latex-inputenc-alist nil
352 "Alist of inputenc coding system names, and what should really be used.
353 For example, adding an entry
355 (\"utf8\" . \"utf8x\")
357 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
358 are written as utf8 files."
359 :group
'org-export-latex
362 (string :tag
"Derived from buffer")
363 (string :tag
"Use this instead"))))
365 (defcustom org-latex-title-command
"\\maketitle"
366 "The command used to insert the title just after \\begin{document}.
367 If this string contains the formatting specification \"%s\" then
368 it will be used as a formatting string, passing the title as an
370 :group
'org-export-latex
373 (defcustom org-latex-toc-command
"\\tableofcontents\n\n"
374 "LaTeX command to set the table of contents, list of figures, etc.
375 This command only applies to the table of contents generated with
376 the toc:nil option, not to those generated with #+TOC keyword."
377 :group
'org-export-latex
380 (defcustom org-latex-hyperref-template
381 "\\hypersetup{\n pdfkeywords={%k},\n pdfsubject={%d},\n pdfcreator={%c}}\n"
382 "Template for hyperref package options.
384 Value is a format string, which can contain the following placeholders:
387 %d for DESCRIPTION line
390 Set it to the empty string to ignore the command completely."
391 :group
'org-export-latex
393 :package-version
'(Org .
"8.3")
398 (defcustom org-latex-format-headline-function
399 'org-latex-format-headline-default-function
400 "Function for formatting the headline's text.
402 This function will be called with 5 arguments:
403 TODO the todo keyword (string or nil).
404 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
405 PRIORITY the priority of the headline (integer or nil)
406 TEXT the main headline text (string).
407 TAGS the tags as a list of strings (list of strings or nil).
409 The function result will be used in the section format string.
411 Use `org-latex-format-headline-default-function' by default,
412 which format headlines like for Org version prior to 8.0."
413 :group
'org-export-latex
415 :package-version
'(Org .
"8.0")
418 (defcustom org-latex-custom-id-as-label nil
419 "Toggle use of CUSTOM_ID properties for generating section labels.
421 When this variable is non-nil, Org will use the value of a
422 headline's CUSTOM_ID property as the key for the \\label command
423 for the LaTeX section corresponding to the headline.
425 By default, Org generates its own internal section labels for all
426 headlines during LaTeX export. This process ensures that the
427 \\label keys are unique and valid, but it means the keys are not
428 available in advance of the export process.
430 Setting this variable gives you control over how Org generates
431 labels for sections during LaTeX export, so that you may know
432 their keys in advance. One reason to do this is that it allows
433 you to refer to headlines using a single label both in Org's link
434 syntax and in embedded LaTeX code.
436 For example, when this variable is non-nil, a headline like this:
442 This is section [[#sec:foo]].
444 And this is still section \\ref{sec:foo}.
447 will be exported to LaTeX as:
449 \\subsection{Some section}
451 This is section \\ref{sec:foo}.
452 And this is still section \\ref{sec:foo}.
454 Note, however, that setting this variable introduces a limitation
455 on the possible values for CUSTOM_ID. When this variable is
456 non-nil and a headline defines a CUSTOM_ID value, Org simply
457 passes this value to \\label unchanged. You are responsible for
458 ensuring that the value is a valid LaTeX \\label key, and that no
459 other \\label commands with the same key appear elsewhere in your
460 document. (Keys may contain letters, numbers, and the following
461 punctuation: '_' '.' '-' ':'.) There are no such limitations on
462 CUSTOM_ID when this variable is nil.
464 For headlines that do not define the CUSTOM_ID property, Org will
465 continue to use its default labeling scheme to generate labels
466 and resolve links into section references."
467 :group
'org-export-latex
470 :package-version
'(Org .
"8.3"))
474 (defcustom org-latex-footnote-separator
"\\textsuperscript{,}\\,"
475 "Text used to separate footnotes."
476 :group
'org-export-latex
482 (defcustom org-latex-active-timestamp-format
"\\textit{%s}"
483 "A printf format string to be applied to active timestamps."
484 :group
'org-export-latex
487 (defcustom org-latex-inactive-timestamp-format
"\\textit{%s}"
488 "A printf format string to be applied to inactive timestamps."
489 :group
'org-export-latex
492 (defcustom org-latex-diary-timestamp-format
"\\textit{%s}"
493 "A printf format string to be applied to diary timestamps."
494 :group
'org-export-latex
500 (defcustom org-latex-image-default-option
""
501 "Default option for images."
502 :group
'org-export-latex
504 :package-version
'(Org .
"8.0")
507 (defcustom org-latex-image-default-width
".9\\linewidth"
508 "Default width for images.
509 This value will not be used if a height is provided."
510 :group
'org-export-latex
512 :package-version
'(Org .
"8.0")
515 (defcustom org-latex-image-default-height
""
516 "Default height for images.
517 This value will not be used if a width is provided, or if the
518 image is wrapped within a \"figure\" or \"wrapfigure\"
520 :group
'org-export-latex
522 :package-version
'(Org .
"8.0")
525 (defcustom org-latex-default-figure-position
"htb"
526 "Default position for latex figures."
527 :group
'org-export-latex
530 (defcustom org-latex-inline-image-rules
531 '(("file" .
"\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\|tikz\\|pgf\\|svg\\)\\'"))
532 "Rules characterizing image files that can be inlined into LaTeX.
534 A rule consists in an association whose key is the type of link
535 to consider, and value is a regexp that will be matched against
538 Note that, by default, the image extension *actually* allowed
539 depend on the way the LaTeX file is processed. When used with
540 pdflatex, pdf, jpg and png images are OK. When processing
541 through dvi to Postscript, only ps and eps are allowed. The
542 default we use here encompasses both."
543 :group
'org-export-latex
545 :package-version
'(Org .
"8.0")
546 :type
'(alist :key-type
(string :tag
"Type")
547 :value-type
(regexp :tag
"Path")))
549 (defcustom org-latex-link-with-unknown-path-format
"\\texttt{%s}"
550 "Format string for links with unknown path type."
551 :group
'org-export-latex
557 (defcustom org-latex-default-table-environment
"tabular"
558 "Default environment used to build tables."
559 :group
'org-export-latex
561 :package-version
'(Org .
"8.0")
564 (defcustom org-latex-default-table-mode
'table
565 "Default mode for tables.
567 Value can be a symbol among:
569 `table' Regular LaTeX table.
571 `math' In this mode, every cell is considered as being in math
572 mode and the complete table will be wrapped within a math
573 environment. It is particularly useful to write matrices.
575 `inline-math' This mode is almost the same as `math', but the
576 math environment will be inlined.
578 `verbatim' The table is exported as it appears in the Org
579 buffer, within a verbatim environment.
581 This value can be overridden locally with, i.e. \":mode math\" in
584 When modifying this variable, it may be useful to change
585 `org-latex-default-table-environment' accordingly."
586 :group
'org-export-latex
588 :package-version
'(Org .
"8.0")
589 :type
'(choice (const :tag
"Table" table
)
590 (const :tag
"Matrix" math
)
591 (const :tag
"Inline matrix" inline-math
)
592 (const :tag
"Verbatim" verbatim
))
593 :safe
(lambda (s) (memq s
'(table math inline-math verbatim
))))
595 (defcustom org-latex-tables-centered t
596 "When non-nil, tables are exported in a center environment."
597 :group
'org-export-latex
601 (defcustom org-latex-tables-booktabs nil
602 "When non-nil, display tables in a formal \"booktabs\" style.
603 This option assumes that the \"booktabs\" package is properly
604 loaded in the header of the document. This value can be ignored
605 locally with \":booktabs t\" and \":booktabs nil\" LaTeX
607 :group
'org-export-latex
609 :package-version
'(Org .
"8.0")
613 (defcustom org-latex-table-caption-above t
614 "When non-nil, place caption string at the beginning of the table.
615 Otherwise, place it near the end."
616 :group
'org-export-latex
620 (defcustom org-latex-table-scientific-notation
"%s\\,(%s)"
621 "Format string to display numbers in scientific notation.
622 The format should have \"%s\" twice, for mantissa and exponent
623 \(i.e., \"%s\\\\times10^{%s}\").
625 When nil, no transformation is made."
626 :group
'org-export-latex
628 :package-version
'(Org .
"8.0")
630 (string :tag
"Format string")
631 (const :tag
"No formatting" nil
)))
635 (defcustom org-latex-text-markup-alist
'((bold .
"\\textbf{%s}")
637 (italic .
"\\emph{%s}")
638 (strike-through .
"\\sout{%s}")
639 (underline .
"\\uline{%s}")
640 (verbatim . protectedtexttt
))
641 "Alist of LaTeX expressions to convert text markup.
643 The key must be a symbol among `bold', `code', `italic',
644 `strike-through', `underline' and `verbatim'. The value is
645 a formatting string to wrap fontified text with.
647 Value can also be set to the following symbols: `verb' and
648 `protectedtexttt'. For the former, Org will use \"\\verb\" to
649 create a format string and select a delimiter character that
650 isn't in the string. For the latter, Org will use \"\\texttt\"
651 to typeset and try to protect special characters.
653 If no association can be found for a given markup, text will be
655 :group
'org-export-latex
657 :options
'(bold code italic strike-through underline verbatim
))
662 (defcustom org-latex-format-drawer-function
663 (lambda (name contents
) contents
)
664 "Function called to format a drawer in LaTeX code.
666 The function must accept two parameters:
667 NAME the drawer name, like \"LOGBOOK\"
668 CONTENTS the contents of the drawer.
670 The function should return the string to be exported.
672 The default function simply returns the value of CONTENTS."
673 :group
'org-export-latex
675 :package-version
'(Org .
"8.3")
681 (defcustom org-latex-format-inlinetask-function
682 'org-latex-format-inlinetask-default-function
683 "Function called to format an inlinetask in LaTeX code.
685 The function must accept six parameters:
686 TODO the todo keyword, as a string
687 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
688 PRIORITY the inlinetask priority, as a string
689 NAME the inlinetask name, as a string.
690 TAGS the inlinetask tags, as a list of strings.
691 CONTENTS the contents of the inlinetask, as a string.
693 The function should return the string to be exported.
695 Use `org-latex-format-headline-default-function' by default."
696 :group
'org-export-latex
699 :package-version
'(Org .
"8.3"))
704 (defcustom org-latex-listings nil
705 "Non-nil means export source code using the listings package.
707 This package will fontify source code, possibly even with color.
708 If you want to use this, you also need to make LaTeX use the
709 listings package, and if you want to have color, the color
710 package. Just add these to `org-latex-packages-alist', for
711 example using customize, or with something like:
714 \(add-to-list 'org-latex-packages-alist '(\"\" \"listings\"))
715 \(add-to-list 'org-latex-packages-alist '(\"\" \"color\"))
719 \(setq org-latex-listings 'minted)
721 causes source code to be exported using the minted package as
722 opposed to listings. If you want to use minted, you need to add
723 the minted package to `org-latex-packages-alist', for example
724 using customize, or with
727 \(add-to-list 'org-latex-packages-alist '(\"\" \"minted\"))
729 In addition, it is necessary to install pygments
730 \(http://pygments.org), and to configure the variable
731 `org-latex-pdf-process' so that the -shell-escape option is
734 The minted choice has possible repercussions on the preview of
735 latex fragments (see `org-preview-latex-fragment'). If you run
736 into previewing problems, please consult
738 http://orgmode.org/worg/org-tutorials/org-latex-preview.html"
739 :group
'org-export-latex
741 (const :tag
"Use listings" t
)
742 (const :tag
"Use minted" minted
)
743 (const :tag
"Export verbatim" nil
))
744 :safe
(lambda (s) (memq s
'(t nil minted
))))
746 (defcustom org-latex-listings-langs
747 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
750 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
751 (html "HTML") (xml "XML")
752 (tex "TeX") (latex "[LaTeX]TeX")
753 (shell-script "bash")
755 (ocaml "Caml") (caml "Caml")
756 (sql "SQL") (sqlite "sql")
758 "Alist mapping languages to their listing language counterpart.
759 The key is a symbol, the major mode symbol without the \"-mode\".
760 The value is the string that should be inserted as the language
761 parameter for the listings package. If the mode name and the
762 listings name are the same, the language does not need an entry
763 in this list - but it does not hurt if it is present."
764 :group
'org-export-latex
766 :package-version
'(Org .
"8.3")
769 (symbol :tag
"Major mode ")
770 (string :tag
"Listings language"))))
772 (defcustom org-latex-listings-options nil
773 "Association list of options for the latex listings package.
775 These options are supplied as a comma-separated list to the
776 \\lstset command. Each element of the association list should be
777 a list containing two strings: the name of the option, and the
780 \(setq org-latex-listings-options
781 '((\"basicstyle\" \"\\\\small\")
782 \(\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
784 will typeset the code in a small size font with underlined, bold
787 Note that the same options will be applied to blocks of all
788 languages. If you need block-specific options, you may use the
791 #+ATTR_LATEX: :options key1=value1,key2=value2
795 :group
'org-export-latex
798 (string :tag
"Listings option name ")
799 (string :tag
"Listings option value"))))
801 (defcustom org-latex-minted-langs
802 '((emacs-lisp "common-lisp")
805 (shell-script "bash")
807 "Alist mapping languages to their minted language counterpart.
808 The key is a symbol, the major mode symbol without the \"-mode\".
809 The value is the string that should be inserted as the language
810 parameter for the minted package. If the mode name and the
811 listings name are the same, the language does not need an entry
812 in this list - but it does not hurt if it is present.
814 Note that minted uses all lower case for language identifiers,
815 and that the full list of language identifiers can be obtained
818 pygmentize -L lexers"
819 :group
'org-export-latex
822 (symbol :tag
"Major mode ")
823 (string :tag
"Minted language"))))
825 (defcustom org-latex-minted-options nil
826 "Association list of options for the latex minted package.
828 These options are supplied within square brackets in
829 \\begin{minted} environments. Each element of the alist should
830 be a list containing two strings: the name of the option, and the
833 \(setq org-latex-minted-options
834 '\((\"bgcolor\" \"bg\") \(\"frame\" \"lines\")))
836 will result in src blocks being exported with
838 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
840 as the start of the minted environment. Note that the same
841 options will be applied to blocks of all languages. If you need
842 block-specific options, you may use the following syntax:
844 #+ATTR_LATEX: :options key1=value1,key2=value2
848 :group
'org-export-latex
851 (string :tag
"Minted option name ")
852 (string :tag
"Minted option value"))))
854 (defvar org-latex-custom-lang-environments nil
855 "Alist mapping languages to language-specific LaTeX environments.
857 It is used during export of src blocks by the listings and minted
858 latex packages. For example,
860 \(setq org-latex-custom-lang-environments
861 '\(\(python \"pythoncode\"\)\)\)
863 would have the effect that if org encounters begin_src python
864 during latex export it will output
873 (defcustom org-latex-pdf-process
874 '("pdflatex -interaction nonstopmode -output-directory %o %f"
875 "pdflatex -interaction nonstopmode -output-directory %o %f"
876 "pdflatex -interaction nonstopmode -output-directory %o %f")
877 "Commands to process a LaTeX file to a PDF file.
878 This is a list of strings, each of them will be given to the
879 shell as a command. %f in the command will be replaced by the
880 full file name, %b by the file base name (i.e. without directory
881 and extension parts) and %o by the base directory of the file.
883 The reason why this is a list is that it usually takes several
884 runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
885 does not have a clever mechanism to detect which of these
886 commands have to be run to get to a stable result, and it also
887 does not do any error checking.
889 By default, Org uses 3 runs of `pdflatex' to do the processing.
890 If you have texi2dvi on your system and if that does not cause
891 the infamous egrep/locale bug:
893 http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
895 then `texi2dvi' is the superior choice as it automates the LaTeX
896 build process by calling the \"correct\" combinations of
897 auxiliary programs. Org does offer `texi2dvi' as one of the
898 customize options. Alternatively, `rubber' and `latexmk' also
899 provide similar functionality. The latter supports `biber' out
902 Alternatively, this may be a Lisp function that does the
903 processing, so you could use this to apply the machinery of
904 AUCTeX or the Emacs LaTeX mode. This function should accept the
905 file name as its single argument."
906 :group
'org-export-pdf
908 (repeat :tag
"Shell command sequence"
909 (string :tag
"Shell command"))
910 (const :tag
"2 runs of pdflatex"
911 ("pdflatex -interaction nonstopmode -output-directory %o %f"
912 "pdflatex -interaction nonstopmode -output-directory %o %f"))
913 (const :tag
"3 runs of pdflatex"
914 ("pdflatex -interaction nonstopmode -output-directory %o %f"
915 "pdflatex -interaction nonstopmode -output-directory %o %f"
916 "pdflatex -interaction nonstopmode -output-directory %o %f"))
917 (const :tag
"pdflatex,bibtex,pdflatex,pdflatex"
918 ("pdflatex -interaction nonstopmode -output-directory %o %f"
920 "pdflatex -interaction nonstopmode -output-directory %o %f"
921 "pdflatex -interaction nonstopmode -output-directory %o %f"))
922 (const :tag
"2 runs of xelatex"
923 ("xelatex -interaction nonstopmode -output-directory %o %f"
924 "xelatex -interaction nonstopmode -output-directory %o %f"))
925 (const :tag
"3 runs of xelatex"
926 ("xelatex -interaction nonstopmode -output-directory %o %f"
927 "xelatex -interaction nonstopmode -output-directory %o %f"
928 "xelatex -interaction nonstopmode -output-directory %o %f"))
929 (const :tag
"xelatex,bibtex,xelatex,xelatex"
930 ("xelatex -interaction nonstopmode -output-directory %o %f"
932 "xelatex -interaction nonstopmode -output-directory %o %f"
933 "xelatex -interaction nonstopmode -output-directory %o %f"))
934 (const :tag
"texi2dvi"
935 ("texi2dvi -p -b -V %f"))
937 ("rubber -d --into %o %f"))
938 (const :tag
"latexmk"
939 ("latexmk -g -pdf %f"))
942 (defcustom org-latex-logfiles-extensions
943 '("aux" "bcf" "blg" "fdb_latexmk" "fls" "figlist" "idx" "log" "nav" "out"
944 "run.xml" "snm" "toc" "vrb" "xdv")
945 "The list of file extensions to consider as LaTeX logfiles.
946 The logfiles will be remove if `org-latex-remove-logfiles' is
948 :group
'org-export-latex
949 :type
'(repeat (string :tag
"Extension")))
951 (defcustom org-latex-remove-logfiles t
952 "Non-nil means remove the logfiles produced by PDF production.
953 By default, logfiles are files with these extensions: .aux, .idx,
954 .log, .out, .toc, .nav, .snm and .vrb. To define the set of
955 logfiles to remove, set `org-latex-logfiles-extensions'."
956 :group
'org-export-latex
959 (defcustom org-latex-known-warnings
960 '(("Reference.*?undefined" .
"[undefined reference]")
961 ("Runaway argument" .
"[runaway argument]")
962 ("Underfull \\hbox" .
"[underfull hbox]")
963 ("Overfull \\hbox" .
"[overfull hbox]")
964 ("Citation.*?undefined" .
"[undefined citation]")
965 ("Undefined control sequence" .
"[undefined control sequence]"))
966 "Alist of regular expressions and associated messages for the user.
967 The regular expressions are used to find possible warnings in the
968 log of a latex-run. These warnings will be reported after
969 calling `org-latex-compile'."
970 :group
'org-export-latex
972 :package-version
'(Org .
"8.3")
975 (string :tag
"Regexp")
976 (string :tag
"Message"))))
980 ;;; Internal Functions
982 (defun org-latex--caption/label-string
(element info
)
983 "Return caption and label LaTeX string for ELEMENT.
985 INFO is a plist holding contextual information. If there's no
986 caption nor label, return the empty string.
988 For non-floats, see `org-latex--wrap-label'."
989 (let* ((label (org-element-property :name element
))
990 (label-str (if (not (org-string-nw-p label
)) ""
991 (format "\\label{%s}"
992 (org-export-solidify-link-text label
))))
993 (main (org-export-get-caption element
))
994 (short (org-export-get-caption element t
))
995 (caption-from-attr-latex (org-export-read-attribute :attr_latex element
:caption
)))
997 ((org-string-nw-p caption-from-attr-latex
)
998 (concat caption-from-attr-latex
"\n"))
999 ((and (not main
) (equal label-str
"")) "")
1000 ((not main
) (concat label-str
"\n"))
1001 ;; Option caption format with short name.
1002 (short (format "\\caption[%s]{%s%s}\n"
1003 (org-export-data short info
)
1005 (org-export-data main info
)))
1006 ;; Standard caption format.
1007 (t (format "\\caption{%s%s}\n" label-str
(org-export-data main info
))))))
1009 (defun org-latex-guess-inputenc (header)
1010 "Set the coding system in inputenc to what the buffer is.
1012 HEADER is the LaTeX header string. This function only applies
1013 when specified inputenc option is \"AUTO\".
1015 Return the new header, as a string."
1016 (let* ((cs (or (ignore-errors
1017 (latexenc-coding-system-to-inputenc
1018 (or org-export-coding-system buffer-file-coding-system
)))
1021 ;; First translate if that is requested.
1022 (setq cs
(or (cdr (assoc cs org-latex-inputenc-alist
)) cs
))
1023 ;; Then find the \usepackage statement and replace the option.
1024 (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
1025 cs header t nil
1))))
1027 (defun org-latex-guess-babel-language (header info
)
1028 "Set Babel's language according to LANGUAGE keyword.
1030 HEADER is the LaTeX header string. INFO is the plist used as
1031 a communication channel.
1033 Insertion of guessed language only happens when Babel package has
1034 explicitly been loaded. Then it is added to the rest of
1037 The argument to Babel may be \"AUTO\" which is then replaced with
1038 the language of the document or `org-export-default-language'
1039 unless language in question is already loaded.
1041 Return the new header."
1042 (let ((language-code (plist-get info
:language
)))
1043 ;; If no language is set or Babel package is not loaded, return
1045 (if (or (not (stringp language-code
))
1046 (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" header
)))
1048 (let ((options (save-match-data
1049 (org-split-string (match-string 1 header
) ",[ \t]*")))
1050 (language (cdr (assoc language-code
1051 org-latex-babel-language-alist
))))
1052 ;; If LANGUAGE is already loaded, return header without AUTO.
1053 ;; Otherwise, replace AUTO with language or append language if
1054 ;; AUTO is not present.
1056 (mapconcat (lambda (option) (if (equal "AUTO" option
) language option
))
1057 (cond ((member language options
) (delete "AUTO" options
))
1058 ((member "AUTO" options
) options
)
1059 (t (append options
(list language
))))
1063 (defun org-latex--find-verb-separator (s)
1064 "Return a character not used in string S.
1065 This is used to choose a separator for constructs like \\verb."
1066 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1067 (loop for c across ll
1068 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
1069 return
(char-to-string c
))))
1071 (defun org-latex--make-option-string (options)
1072 "Return a comma separated string of keywords and values.
1073 OPTIONS is an alist where the key is the options keyword as
1074 a string, and the value a list containing the keyword value, or
1076 (mapconcat (lambda (pair)
1077 (concat (first pair
)
1078 (when (> (length (second pair
)) 0)
1079 (concat "=" (second pair
)))))
1083 (defun org-latex--wrap-label (element output
)
1084 "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
1085 This function shouldn't be used for floats. See
1086 `org-latex--caption/label-string'."
1087 (let ((label (org-element-property :name element
)))
1088 (if (not (and (org-string-nw-p output
) (org-string-nw-p label
))) output
1089 (concat (format "\\label{%s}\n" (org-export-solidify-link-text label
))
1092 (defun org-latex--text-markup (text markup info
)
1093 "Format TEXT depending on MARKUP text markup.
1094 INFO is a plist used as a communication channel. See
1095 `org-latex-text-markup-alist' for details."
1096 (let ((fmt (cdr (assq markup
(plist-get info
:latex-text-markup-alist
)))))
1098 ;; No format string: Return raw text.
1100 ;; Handle the `verb' special case: Find an appropriate separator
1101 ;; and use "\\verb" command.
1103 (let ((separator (org-latex--find-verb-separator text
)))
1104 (concat "\\verb" separator
1105 (replace-regexp-in-string "\n" " " text
)
1107 ;; Handle the `protectedtexttt' special case: Protect some
1108 ;; special chars and use "\texttt{%s}" format string.
1109 ((eq 'protectedtexttt fmt
)
1111 (trans '(("\\" .
"\\textbackslash{}")
1112 ("~" .
"\\textasciitilde{}")
1113 ("^" .
"\\textasciicircum{}")))
1116 (while (string-match "[\\{}$%&_#~^]" text
)
1117 (setq char
(match-string 0 text
))
1118 (if (> (match-beginning 0) 0)
1119 (setq rtn
(concat rtn
(substring text
0 (match-beginning 0)))))
1120 (setq text
(substring text
(1+ (match-beginning 0))))
1121 (setq char
(or (cdr (assoc char trans
)) (concat "\\" char
))
1122 rtn
(concat rtn char
)))
1123 (setq text
(concat rtn text
)
1125 (while (string-match "--" text
)
1126 (setq text
(replace-match "-{}-" t t text
)))
1128 ;; Else use format string.
1129 (t (format fmt text
)))))
1131 (defun org-latex--delayed-footnotes-definitions (element info
)
1132 "Return footnotes definitions in ELEMENT as a string.
1134 INFO is a plist used as a communication channel.
1136 Footnotes definitions are returned within \"\\footnotetxt{}\"
1139 This function is used within constructs that don't support
1140 \"\\footnote{}\" command (i.e. an item's tag). In that case,
1141 \"\\footnotemark\" is used within the construct and the function
1142 just outside of it."
1146 "\\footnotetext[%s]{%s}"
1147 (org-export-get-footnote-number ref info
)
1150 (org-export-get-footnote-definition ref info
) info
))))
1151 ;; Find every footnote reference in ELEMENT.
1153 search-refs
; For byte-compiler.
1157 ;; Return a list of all footnote references never seen
1159 (org-element-map data
'footnote-reference
1161 (when (org-export-footnote-first-reference-p ref info
)
1163 (when (eq (org-element-property :type ref
) 'standard
)
1164 (funcall search-refs
1165 (org-export-get-footnote-definition ref info
)))))
1167 (reverse all-refs
)))))
1168 (funcall search-refs element
))
1171 (defun org-latex--translate (s info
)
1172 "Translate string S according to specified language.
1173 INFO is a plist used as a communication channel."
1174 (org-export-translate s
:latex info
))
1180 (defun org-latex-template (contents info
)
1181 "Return complete document string after LaTeX conversion.
1182 CONTENTS is the transcoded contents string. INFO is a plist
1183 holding export options."
1184 (let ((title (org-export-data (plist-get info
:title
) info
)))
1187 (and (plist-get info
:time-stamp-file
)
1188 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1189 ;; Document class and packages.
1190 (let* ((class (plist-get info
:latex-class
))
1191 (class-options (plist-get info
:latex-class-options
))
1192 (header (nth 1 (assoc class
(plist-get info
:latex-classes
))))
1193 (document-class-string
1194 (and (stringp header
)
1195 (if (not class-options
) header
1196 (replace-regexp-in-string
1197 "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
1198 class-options header t nil
1)))))
1199 (if (not document-class-string
)
1200 (user-error "Unknown LaTeX class `%s'" class
)
1201 (org-latex-guess-babel-language
1202 (org-latex-guess-inputenc
1203 (org-element-normalize-string
1204 (org-splice-latex-header
1205 document-class-string
1206 org-latex-default-packages-alist
1207 org-latex-packages-alist nil
1208 (concat (org-element-normalize-string
1209 (plist-get info
:latex-header
))
1210 (plist-get info
:latex-header-extra
)))))
1212 ;; Possibly limit depth for headline numbering.
1213 (let ((sec-num (plist-get info
:section-numbers
)))
1214 (when (integerp sec-num
)
1215 (format "\\setcounter{secnumdepth}{%d}\n" sec-num
)))
1217 (let ((author (and (plist-get info
:with-author
)
1218 (let ((auth (plist-get info
:author
)))
1219 (and auth
(org-export-data auth info
)))))
1220 (email (and (plist-get info
:with-email
)
1221 (org-export-data (plist-get info
:email
) info
))))
1222 (cond ((and author email
(not (string= "" email
)))
1223 (format "\\author{%s\\thanks{%s}}\n" author email
))
1224 ((or author email
) (format "\\author{%s}\n" (or author email
)))))
1226 (let ((date (and (plist-get info
:with-date
) (org-export-get-date info
))))
1227 (format "\\date{%s}\n" (org-export-data date info
)))
1229 (format "\\title{%s}\n" title
)
1230 ;; Hyperref options.
1231 (format-spec (plist-get info
:latex-hyperref-template
)
1233 ?k
(or (plist-get info
:keywords
) "")
1234 ?d
(or (plist-get info
:description
)"")
1235 ?c
(if (plist-get info
:with-creator
)
1236 (plist-get info
:creator
)
1239 "\\begin{document}\n\n"
1241 (let ((command (plist-get info
:latex-title-command
)))
1242 (org-element-normalize-string
1243 (cond ((string= "" title
) nil
)
1244 ((not (stringp command
)) nil
)
1245 ((string-match "\\(?:[^%]\\|^\\)%s" command
)
1246 (format command title
))
1248 ;; Table of contents.
1249 (let ((depth (plist-get info
:with-toc
)))
1251 (concat (when (wholenump depth
)
1252 (format "\\setcounter{tocdepth}{%d}\n" depth
))
1253 (plist-get info
:latex-toc-command
))))
1257 (let ((creator-info (plist-get info
:with-creator
)))
1259 ((not creator-info
) "")
1260 ((eq creator-info
'comment
)
1261 (format "%% %s\n" (plist-get info
:creator
)))
1262 (t (concat (plist-get info
:creator
) "\n"))))
1264 "\\end{document}")))
1268 ;;; Transcode Functions
1272 (defun org-latex-bold (bold contents info
)
1273 "Transcode BOLD from Org to LaTeX.
1274 CONTENTS is the text with bold markup. INFO is a plist holding
1275 contextual information."
1276 (org-latex--text-markup contents
'bold info
))
1281 (defun org-latex-center-block (center-block contents info
)
1282 "Transcode a CENTER-BLOCK element from Org to LaTeX.
1283 CONTENTS holds the contents of the center block. INFO is a plist
1284 holding contextual information."
1285 (org-latex--wrap-label
1287 (format "\\begin{center}\n%s\\end{center}" contents
)))
1292 (defun org-latex-clock (clock contents info
)
1293 "Transcode a CLOCK element from Org to LaTeX.
1294 CONTENTS is nil. INFO is a plist holding contextual
1298 (format "\\textbf{%s} " org-clock-string
)
1299 (format (plist-get info
:latex-inactive-timestamp-format
)
1300 (concat (org-translate-time
1301 (org-element-property :raw-value
1302 (org-element-property :value clock
)))
1303 (let ((time (org-element-property :duration clock
)))
1304 (and time
(format " (%s)" time
)))))
1310 (defun org-latex-code (code contents info
)
1311 "Transcode a CODE object from Org to LaTeX.
1312 CONTENTS is nil. INFO is a plist used as a communication
1314 (org-latex--text-markup (org-element-property :value code
) 'code info
))
1319 (defun org-latex-drawer (drawer contents info
)
1320 "Transcode a DRAWER element from Org to LaTeX.
1321 CONTENTS holds the contents of the block. INFO is a plist
1322 holding contextual information."
1323 (let* ((name (org-element-property :drawer-name drawer
))
1324 (output (funcall (plist-get info
:latex-format-drawer-function
)
1326 (org-latex--wrap-label drawer output
)))
1331 (defun org-latex-dynamic-block (dynamic-block contents info
)
1332 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
1333 CONTENTS holds the contents of the block. INFO is a plist
1334 holding contextual information. See `org-export-data'."
1335 (org-latex--wrap-label dynamic-block contents
))
1340 (defun org-latex-entity (entity contents info
)
1341 "Transcode an ENTITY object from Org to LaTeX.
1342 CONTENTS are the definition itself. INFO is a plist holding
1343 contextual information."
1344 (org-element-property :latex entity
))
1349 (defun org-latex-example-block (example-block contents info
)
1350 "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
1351 CONTENTS is nil. INFO is a plist holding contextual
1353 (when (org-string-nw-p (org-element-property :value example-block
))
1354 (org-latex--wrap-label
1356 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1357 (org-export-format-code-default example-block info
)))))
1362 (defun org-latex-export-snippet (export-snippet contents info
)
1363 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
1364 CONTENTS is nil. INFO is a plist holding contextual information."
1365 (when (eq (org-export-snippet-backend export-snippet
) 'latex
)
1366 (org-element-property :value export-snippet
)))
1371 (defun org-latex-fixed-width (fixed-width contents info
)
1372 "Transcode a FIXED-WIDTH element from Org to LaTeX.
1373 CONTENTS is nil. INFO is a plist holding contextual information."
1374 (org-latex--wrap-label
1376 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1377 (org-remove-indentation
1378 (org-element-property :value fixed-width
)))))
1381 ;;;; Footnote Reference
1383 (defun org-latex-footnote-reference (footnote-reference contents info
)
1384 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1385 CONTENTS is nil. INFO is a plist holding contextual information."
1387 ;; Insert separator between two footnotes in a row.
1388 (let ((prev (org-export-get-previous-element footnote-reference info
)))
1389 (when (eq (org-element-type prev
) 'footnote-reference
)
1390 (plist-get info
:latex-footnote-separator
)))
1392 ;; Use \footnotemark if the footnote has already been defined.
1393 ((not (org-export-footnote-first-reference-p footnote-reference info
))
1394 (format "\\footnotemark[%s]{}"
1395 (org-export-get-footnote-number footnote-reference info
)))
1396 ;; Use \footnotemark if reference is within another footnote
1397 ;; reference, footnote definition or table cell.
1398 ((loop for parent in
(org-export-get-genealogy footnote-reference
)
1399 thereis
(memq (org-element-type parent
)
1400 '(footnote-reference footnote-definition table-cell
)))
1402 ;; Otherwise, define it with \footnote command.
1404 (let ((def (org-export-get-footnote-definition footnote-reference info
)))
1406 (format "\\footnote{%s}" (org-trim (org-export-data def info
)))
1407 ;; Retrieve all footnote references within the footnote and
1408 ;; add their definition after it, since LaTeX doesn't support
1410 (org-latex--delayed-footnotes-definitions def info
)))))))
1415 (defun org-latex-headline (headline contents info
)
1416 "Transcode a HEADLINE element from Org to LaTeX.
1417 CONTENTS holds the contents of the headline. INFO is a plist
1418 holding contextual information."
1419 (unless (org-element-property :footnote-section-p headline
)
1420 (let* ((class (plist-get info
:latex-class
))
1421 (level (org-export-get-relative-level headline info
))
1422 (numberedp (org-export-numbered-headline-p headline info
))
1423 (class-sectioning (assoc class
(plist-get info
:latex-classes
)))
1424 ;; Section formatting will set two placeholders: one for
1425 ;; the title and the other for the contents.
1427 (let ((sec (if (functionp (nth 2 class-sectioning
))
1428 (funcall (nth 2 class-sectioning
) level numberedp
)
1429 (nth (1+ level
) class-sectioning
))))
1431 ;; No section available for that LEVEL.
1433 ;; Section format directly returned by a function. Add
1434 ;; placeholder for contents.
1435 ((stringp sec
) (concat sec
"\n%s"))
1436 ;; (numbered-section . unnumbered-section)
1437 ((not (consp (cdr sec
)))
1438 (concat (funcall (if numberedp
#'car
#'cdr
) sec
) "\n%s"))
1439 ;; (numbered-open numbered-close)
1441 (when numberedp
(concat (car sec
) "\n%s" (nth 1 sec
))))
1442 ;; (num-in num-out no-num-in no-num-out)
1444 (if numberedp
(concat (car sec
) "\n%s" (nth 1 sec
))
1445 (concat (nth 2 sec
) "\n%s" (nth 3 sec
)))))))
1446 ;; Create a temporary export back-end that hard-codes
1447 ;; "\underline" within "\section" and alike.
1449 (org-export-create-backend
1452 '((underline .
(lambda (o c i
) (format "\\underline{%s}" c
))))))
1454 (org-export-data-with-backend
1455 (org-element-property :title headline
) section-back-end info
))
1457 (and (plist-get info
:with-todo-keywords
)
1458 (let ((todo (org-element-property :todo-keyword headline
)))
1459 (and todo
(org-export-data todo info
)))))
1460 (todo-type (and todo
(org-element-property :todo-type headline
)))
1461 (tags (and (plist-get info
:with-tags
)
1462 (org-export-get-tags headline info
)))
1463 (priority (and (plist-get info
:with-priority
)
1464 (org-element-property :priority headline
)))
1465 ;; Create the headline text along with a no-tag version.
1466 ;; The latter is required to remove tags from toc.
1467 (full-text (funcall (plist-get info
:latex-format-headline-function
)
1468 todo todo-type priority text tags
))
1469 ;; Associate \label to the headline for internal links.
1472 (and (plist-get info
:latex-custom-id-labels
)
1473 (org-element-property :CUSTOM_ID headline
))))
1474 (if custom-label
(format "\\label{%s}\n" custom-label
)
1475 (format "\\label{sec-%s}\n"
1478 (org-export-get-headline-number headline info
)
1481 (make-string (org-element-property :pre-blank headline
) 10)))
1482 (if (or (not section-fmt
) (org-export-low-level-p headline info
))
1483 ;; This is a deep sub-tree: export it as a list item. Also
1484 ;; export as items headlines for which no section format has
1486 (let ((low-level-body
1488 ;; If headline is the first sibling, start a list.
1489 (when (org-export-first-sibling-p headline info
)
1490 (format "\\begin{%s}\n" (if numberedp
'enumerate
'itemize
)))
1493 (and full-text
(org-string-match-p "\\`[ \t]*\\[" full-text
)
1499 ;; If headline is not the last sibling simply return
1500 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
1502 (if (not (org-export-last-sibling-p headline info
)) low-level-body
1503 (replace-regexp-in-string
1505 (format "\n\\\\end{%s}" (if numberedp
'enumerate
'itemize
))
1507 ;; This is a standard headline. Export it as a section. Add
1508 ;; an alternative heading when possible, and when this is not
1509 ;; identical to the usual heading.
1511 (funcall (plist-get info
:latex-format-headline-function
)
1512 todo todo-type priority
1513 (org-export-data-with-backend
1514 (org-export-get-alt-title headline info
)
1515 section-back-end info
)
1516 (and (eq (plist-get info
:with-tags
) t
) tags
))))
1517 (if (and numberedp opt-title
1518 (not (equal opt-title full-text
))
1519 (string-match "\\`\\\\\\(.*?[^*]\\){" section-fmt
))
1520 (format (replace-match "\\1[%s]" nil nil section-fmt
1)
1521 ;; Replace square brackets with parenthesis
1522 ;; since square brackets are not supported in
1523 ;; optional arguments.
1524 (replace-regexp-in-string
1525 "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title
))
1527 (concat headline-label pre-blanks contents
))
1528 ;; Impossible to add an alternative heading. Fallback to
1529 ;; regular sectioning format string.
1530 (format section-fmt full-text
1531 (concat headline-label pre-blanks contents
))))))))
1533 (defun org-latex-format-headline-default-function
1534 (todo todo-type priority text tags
)
1535 "Default format function for a headline.
1536 See `org-latex-format-headline-function' for details."
1538 (and todo
(format "{\\bfseries\\sffamily %s} " todo
))
1539 (and priority
(format "\\framebox{\\#%c} " priority
))
1542 (format "\\hfill{}\\textsc{%s}" (mapconcat 'identity tags
":")))))
1545 ;;;; Horizontal Rule
1547 (defun org-latex-horizontal-rule (horizontal-rule contents info
)
1548 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
1549 CONTENTS is nil. INFO is a plist holding contextual information."
1550 (let ((attr (org-export-read-attribute :attr_latex horizontal-rule
))
1551 (prev (org-export-get-previous-element horizontal-rule info
)))
1553 ;; Make sure the rule doesn't start at the end of the current
1554 ;; line by separating it with a blank line from previous element.
1556 (let ((prev-blank (org-element-property :post-blank prev
)))
1557 (or (not prev-blank
) (zerop prev-blank
))))
1559 (org-latex--wrap-label
1561 (format "\\rule{%s}{%s}"
1562 (or (plist-get attr
:width
) "\\linewidth")
1563 (or (plist-get attr
:thickness
) "0.5pt"))))))
1566 ;;;; Inline Src Block
1568 (defun org-latex-inline-src-block (inline-src-block contents info
)
1569 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
1570 CONTENTS holds the contents of the item. INFO is a plist holding
1571 contextual information."
1572 (let* ((code (org-element-property :value inline-src-block
))
1573 (separator (org-latex--find-verb-separator code
)))
1574 (case (plist-get info
:latex-listings
)
1575 ;; Do not use a special package: transcode it verbatim.
1576 ((nil) (concat "\\verb" separator code separator
))
1577 ;; Use minted package.
1579 (let* ((org-lang (org-element-property :language inline-src-block
))
1580 (mint-lang (or (cadr (assq (intern org-lang
)
1581 (plist-get info
:latex-minted-langs
)))
1582 (downcase org-lang
)))
1583 (options (org-latex--make-option-string
1584 (plist-get info
:latex-minted-options
))))
1585 (concat (format "\\mint%s{%s}"
1586 (if (string= options
"") "" (format "[%s]" options
))
1588 separator code separator
)))
1589 ;; Use listings package.
1591 ;; Maybe translate language's name.
1592 (let* ((org-lang (org-element-property :language inline-src-block
))
1593 (lst-lang (or (cadr (assq (intern org-lang
)
1594 (plist-get info
:latex-listings-langs
)))
1596 (options (org-latex--make-option-string
1597 (append (plist-get info
:latex-listings-options
)
1598 `(("language" ,lst-lang
))))))
1599 (concat (format "\\lstinline[%s]" options
)
1600 separator code separator
))))))
1605 (defun org-latex-inlinetask (inlinetask contents info
)
1606 "Transcode an INLINETASK element from Org to LaTeX.
1607 CONTENTS holds the contents of the block. INFO is a plist
1608 holding contextual information."
1609 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
1610 (todo (and (plist-get info
:with-todo-keywords
)
1611 (let ((todo (org-element-property :todo-keyword inlinetask
)))
1612 (and todo
(org-export-data todo info
)))))
1613 (todo-type (org-element-property :todo-type inlinetask
))
1614 (tags (and (plist-get info
:with-tags
)
1615 (org-export-get-tags inlinetask info
)))
1616 (priority (and (plist-get info
:with-priority
)
1617 (org-element-property :priority inlinetask
)))
1619 (let ((label (org-element-property :CUSTOM_ID inlinetask
)))
1620 (and label
(format "\\label{%s}\n" label
)))
1622 (funcall (plist-get info
:latex-format-inlinetask-function
)
1623 todo todo-type priority title tags contents
)))
1625 (defun org-latex-format-inlinetask-default-function
1626 (todo todo-type priority title tags contents
)
1627 "Default format function for a inlinetasks.
1628 See `org-latex-format-inlinetask-function' for details."
1630 (concat (when todo
(format "\\textbf{\\textsf{\\textsc{%s}}} " todo
))
1631 (when priority
(format "\\framebox{\\#%c} " priority
))
1633 (when tags
(format "\\hfill{}\\textsc{:%s:}"
1634 (mapconcat #'identity tags
":"))))))
1635 (concat "\\begin{center}\n"
1637 "\\begin{minipage}[c]{.6\\textwidth}\n"
1639 (and (org-string-nw-p contents
)
1640 (concat "\\rule[.8em]{\\textwidth}{2pt}\n\n" contents
))
1648 (defun org-latex-italic (italic contents info
)
1649 "Transcode ITALIC from Org to LaTeX.
1650 CONTENTS is the text with italic markup. INFO is a plist holding
1651 contextual information."
1652 (org-latex--text-markup contents
'italic info
))
1657 (defun org-latex-item (item contents info
)
1658 "Transcode an ITEM element from Org to LaTeX.
1659 CONTENTS holds the contents of the item. INFO is a plist holding
1660 contextual information."
1662 (let ((count (org-element-property :counter item
))
1664 ;; Determine level of current item to determine the
1665 ;; correct LaTeX counter to use (enumi, enumii...).
1666 (let ((parent item
) (level 0))
1667 (while (memq (org-element-type
1668 (setq parent
(org-export-get-parent parent
)))
1670 (when (and (eq (org-element-type parent
) 'plain-list
)
1671 (eq (org-element-property :type parent
)
1677 (format "\\setcounter{enum%s}{%s}\n"
1678 (nth (1- level
) '("i" "ii" "iii" "iv"))
1680 (checkbox (case (org-element-property :checkbox item
)
1681 (on "$\\boxtimes$ ")
1683 (trans "$\\boxminus$ ")))
1684 (tag (let ((tag (org-element-property :tag item
)))
1685 ;; Check-boxes must belong to the tag.
1686 (and tag
(format "[{%s}] "
1688 (org-export-data tag info
)))))))
1693 (checkbox (concat " " checkbox
))
1694 ;; Without a tag or a check-box, if CONTENTS starts with
1695 ;; an opening square bracket, add "\relax" to "\item",
1696 ;; unless the brackets comes from an initial export
1697 ;; snippet (i.e. it is inserted willingly by the user).
1699 (org-string-match-p "\\`[ \t]*\\[" contents
)
1700 (not (let ((e (car (org-element-contents item
))))
1701 (and (eq (org-element-type e
) 'paragraph
)
1702 (let ((o (car (org-element-contents e
))))
1703 (and (eq (org-element-type o
) 'export-snippet
)
1704 (eq (org-export-snippet-backend o
)
1708 (and contents
(org-trim contents
))
1709 ;; If there are footnotes references in tag, be sure to
1710 ;; add their definition at the end of the item. This
1711 ;; workaround is necessary since "\footnote{}" command is
1712 ;; not supported in tags.
1714 (org-latex--delayed-footnotes-definitions
1715 (org-element-property :tag item
) info
)))))
1720 (defun org-latex-keyword (keyword contents info
)
1721 "Transcode a KEYWORD element from Org to LaTeX.
1722 CONTENTS is nil. INFO is a plist holding contextual information."
1723 (let ((key (org-element-property :key keyword
))
1724 (value (org-element-property :value keyword
)))
1726 ((string= key
"LATEX") value
)
1727 ((string= key
"INDEX") (format "\\index{%s}" value
))
1728 ((string= key
"TOC")
1729 (let ((value (downcase value
)))
1731 ((string-match "\\<headlines\\>" value
)
1732 (let ((depth (or (and (string-match "[0-9]+" value
)
1733 (string-to-number (match-string 0 value
)))
1734 (plist-get info
:with-toc
))))
1736 (when (wholenump depth
)
1737 (format "\\setcounter{tocdepth}{%s}\n" depth
))
1738 "\\tableofcontents")))
1739 ((string= "tables" value
) "\\listoftables")
1740 ((string= "listings" value
)
1741 (case (plist-get info
:latex-listings
)
1742 ((nil) "\\listoffigures")
1743 (minted "\\listoflistings")
1744 (otherwise "\\lstlistoflistings")))))))))
1747 ;;;; Latex Environment
1749 (defun org-latex-latex-environment (latex-environment contents info
)
1750 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
1751 CONTENTS is nil. INFO is a plist holding contextual information."
1752 (when (plist-get info
:with-latex
)
1753 (let ((label (org-element-property :name latex-environment
))
1754 (value (org-remove-indentation
1755 (org-element-property :value latex-environment
))))
1756 (if (not (org-string-nw-p label
)) value
1757 ;; Environment is labeled: label must be within the environment
1758 ;; (otherwise, a reference pointing to that element will count
1759 ;; the section instead).
1762 (goto-char (point-min))
1765 (format "\\label{%s}\n" (org-export-solidify-link-text label
)))
1766 (buffer-string))))))
1771 (defun org-latex-latex-fragment (latex-fragment contents info
)
1772 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
1773 CONTENTS is nil. INFO is a plist holding contextual information."
1774 (let ((value (org-element-property :value latex-fragment
)))
1775 ;; Trim math markers since the fragment is enclosed within
1776 ;; a latex-math-block object anyway.
1777 (cond ((string-match "\\`\\(\\$\\{1,2\\}\\)\\([^\000]*\\)\\1\\'" value
)
1778 (match-string 2 value
))
1779 ((string-match "\\`\\\\(\\([^\000]*\\)\\\\)\\'" value
)
1780 (match-string 1 value
))
1786 (defun org-latex-line-break (line-break contents info
)
1787 "Transcode a LINE-BREAK object from Org to LaTeX.
1788 CONTENTS is nil. INFO is a plist holding contextual information."
1794 (defun org-latex--inline-image (link info
)
1795 "Return LaTeX code for an inline image.
1796 LINK is the link pointing to the inline image. INFO is a plist
1797 used as a communication channel."
1798 (let* ((parent (org-export-get-parent-element link
))
1799 (path (let ((raw-path (org-element-property :path link
)))
1800 (if (not (file-name-absolute-p raw-path
)) raw-path
1801 (expand-file-name raw-path
))))
1802 (filetype (file-name-extension path
))
1803 (caption (org-latex--caption/label-string parent info
))
1804 ;; Retrieve latex attributes from the element around.
1805 (attr (org-export-read-attribute :attr_latex parent
))
1806 (float (let ((float (plist-get attr
:float
)))
1807 (cond ((and (not float
) (plist-member attr
:float
)) nil
)
1808 ((string= float
"wrap") 'wrap
)
1809 ((string= float
"sideways") 'sideways
)
1810 ((string= float
"multicolumn") 'multicolumn
)
1812 (org-element-property :caption parent
)
1813 (org-string-nw-p (plist-get attr
:caption
)))
1816 (let ((place (plist-get attr
:placement
)))
1818 (place (format "%s" place
))
1819 ((eq float
'wrap
) "{l}{0.5\\textwidth}")
1821 (format "[%s]" (plist-get info
:latex-default-figure-position
)))
1823 (comment-include (if (plist-get attr
:comment-include
) "%" ""))
1824 ;; It is possible to specify width and height in the
1825 ;; ATTR_LATEX line, and also via default variables.
1826 (width (cond ((plist-get attr
:width
))
1827 ((plist-get attr
:height
) "")
1828 ((eq float
'wrap
) "0.48\\textwidth")
1829 (t (plist-get info
:latex-image-default-width
))))
1830 (height (cond ((plist-get attr
:height
))
1831 ((or (plist-get attr
:width
)
1832 (memq float
'(figure wrap
))) "")
1833 (t (plist-get info
:latex-image-default-height
))))
1834 (options (let ((opt (or (plist-get attr
:options
)
1835 (plist-get info
:latex-image-default-option
))))
1836 (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt
)) opt
1837 (match-string 1 opt
))))
1839 (if (member filetype
'("tikz" "pgf"))
1841 ;; - use \input to read in image file.
1842 ;; - if options are present, wrap in a tikzpicture environment.
1843 ;; - if width or height are present, use \resizebox to change
1846 (setq image-code
(format "\\input{%s}" path
))
1847 (when (org-string-nw-p options
)
1849 (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
1852 (when (or (org-string-nw-p width
) (org-string-nw-p height
))
1853 (setq image-code
(format "\\resizebox{%s}{%s}{%s}"
1854 (if (org-string-nw-p width
) width
"!")
1855 (if (org-string-nw-p height
) height
"!")
1857 ;; For other images:
1858 ;; - add width and height to options.
1859 ;; - include the image with \includegraphics.
1860 (when (org-string-nw-p width
)
1861 (setq options
(concat options
",width=" width
)))
1862 (when (org-string-nw-p height
)
1863 (setq options
(concat options
",height=" height
)))
1864 (let ((search-option (org-element-property :search-option link
)))
1865 (when (and search-option
1866 (equal filetype
"pdf")
1867 (org-string-match-p "\\`[0-9]+\\'" search-option
)
1868 (not (org-string-match-p "page=" options
)))
1869 (setq options
(concat options
",page=" search-option
))))
1871 (format "\\includegraphics%s{%s}"
1872 (cond ((not (org-string-nw-p options
)) "")
1873 ((= (aref options
0) ?
,)
1874 (format "[%s]"(substring options
1)))
1875 (t (format "[%s]" options
)))
1877 (when (equal filetype
"svg")
1878 (setq image-code
(replace-regexp-in-string "^\\\\includegraphics"
1882 (setq image-code
(replace-regexp-in-string "\\.svg}"
1886 ;; Return proper string, depending on FLOAT.
1888 (wrap (format "\\begin{wrapfigure}%s
1891 %s\\end{wrapfigure}" placement comment-include image-code caption
))
1892 (sideways (format "\\begin{sidewaysfigure}
1895 %s\\end{sidewaysfigure}" comment-include image-code caption
))
1896 (multicolumn (format "\\begin{figure*}%s
1899 %s\\end{figure*}" placement comment-include image-code caption
))
1900 (figure (format "\\begin{figure}%s
1903 %s\\end{figure}" placement comment-include image-code caption
))
1904 (otherwise image-code
))))
1906 (defun org-latex-link (link desc info
)
1907 "Transcode a LINK object from Org to LaTeX.
1909 DESC is the description part of the link, or the empty string.
1910 INFO is a plist holding contextual information. See
1912 (let* ((type (org-element-property :type link
))
1913 (raw-path (replace-regexp-in-string
1914 "%" "\\%" (org-element-property :path link
) nil t
))
1915 ;; Ensure DESC really exists, or set it to nil.
1916 (desc (and (not (string= desc
"")) desc
))
1917 (imagep (org-export-inline-image-p
1918 link
(plist-get info
:latex-inline-image-rules
)))
1920 ((member type
'("http" "https" "ftp" "mailto"))
1921 (concat type
":" raw-path
))
1922 ((and (string= type
"file") (file-name-absolute-p raw-path
))
1923 (concat "file:" raw-path
))
1928 (imagep (org-latex--inline-image link info
))
1929 ;; Radio link: Transcode target's contents and use them as link's
1931 ((string= type
"radio")
1932 (let ((destination (org-export-resolve-radio-link link info
)))
1934 (format "\\hyperref[%s]{%s}"
1935 (org-export-solidify-link-text
1936 (org-element-property :value destination
))
1938 ;; Links pointing to a headline: Find destination and build
1939 ;; appropriate referencing command.
1940 ((member type
'("custom-id" "fuzzy" "id"))
1941 (let ((destination (if (string= type
"fuzzy")
1942 (org-export-resolve-fuzzy-link link info
)
1943 (org-export-resolve-id-link link info
))))
1944 (case (org-element-type destination
)
1945 ;; Id link points to an external file.
1947 (if desc
(format "\\href{%s}{%s}" destination desc
)
1948 (format "\\url{%s}" destination
)))
1949 ;; Fuzzy link points nowhere.
1951 (format (plist-get info
:latex-link-with-unknown-path-format
)
1954 (org-element-property :raw-link link
) info
))))
1955 ;; LINK points to a headline. If headlines are numbered
1956 ;; and the link has no description, display headline's
1957 ;; number. Otherwise, display description or headline's
1960 (let* ((custom-label
1961 (and (plist-get info
:latex-custom-id-labels
)
1962 (org-element-property :CUSTOM_ID destination
)))
1969 (org-export-get-headline-number destination info
)
1971 (if (and (plist-get info
:section-numbers
) (not desc
))
1972 (format "\\ref{%s}" label
)
1973 (format "\\hyperref[%s]{%s}" label
1976 (org-element-property :title destination
) info
))))))
1977 ;; Fuzzy link points to a target. Do as above.
1979 (let ((path (org-export-solidify-link-text path
)))
1980 (if (not desc
) (format "\\ref{%s}" path
)
1981 (format "\\hyperref[%s]{%s}" path desc
)))))))
1982 ;; Coderef: replace link with the reference name or the
1983 ;; equivalent line number.
1984 ((string= type
"coderef")
1985 (format (org-export-get-coderef-format path desc
)
1986 (org-export-resolve-coderef path info
)))
1987 ;; Link type is handled by a special function.
1988 ((functionp (setq protocol
(nth 2 (assoc type org-link-protocols
))))
1989 (funcall protocol
(org-link-unescape path
) desc
'latex
))
1990 ;; External link with a description part.
1991 ((and path desc
) (format "\\href{%s}{%s}" path desc
))
1992 ;; External link without a description part.
1993 (path (format "\\url{%s}" path
))
1994 ;; No path, only description. Try to do something useful.
1995 (t (format (plist-get info
:latex-link-with-unknown-path-format
) desc
)))))
2000 (defun org-latex-node-property (node-property contents info
)
2001 "Transcode a NODE-PROPERTY element from Org to LaTeX.
2002 CONTENTS is nil. INFO is a plist holding contextual
2005 (org-element-property :key node-property
)
2006 (let ((value (org-element-property :value node-property
)))
2007 (if value
(concat " " value
) ""))))
2012 (defun org-latex-paragraph (paragraph contents info
)
2013 "Transcode a PARAGRAPH element from Org to LaTeX.
2014 CONTENTS is the contents of the paragraph, as a string. INFO is
2015 the plist used as a communication channel."
2021 (defun org-latex-plain-list (plain-list contents info
)
2022 "Transcode a PLAIN-LIST element from Org to LaTeX.
2023 CONTENTS is the contents of the list. INFO is a plist holding
2024 contextual information."
2025 (let* ((type (org-element-property :type plain-list
))
2026 (attr (org-export-read-attribute :attr_latex plain-list
))
2027 (latex-type (let ((env (plist-get attr
:environment
)))
2028 (cond (env (format "%s" env
))
2029 ((eq type
'ordered
) "enumerate")
2030 ((eq type
'descriptive
) "description")
2032 (org-latex--wrap-label
2034 (format "\\begin{%s}%s\n%s\\end{%s}"
2036 (or (plist-get attr
:options
) "")
2043 (defun org-latex-plain-text (text info
)
2044 "Transcode a TEXT string from Org to LaTeX.
2045 TEXT is the string to transcode. INFO is a plist holding
2046 contextual information."
2047 (let ((specialp (plist-get info
:with-special-strings
))
2049 ;; Protect %, #, &, $, _, { and }.
2050 (while (string-match "\\([^\\]\\|^\\)\\([%$#&{}_]\\)" output
)
2053 (format "\\%s" (match-string 2 output
)) nil t output
2)))
2056 (replace-regexp-in-string
2057 "\\([^\\]\\|^\\)\\(\\^\\)" "\\\\^{}" output nil nil
2))
2058 ;; Protect \. If special strings are used, be careful not to
2059 ;; protect "\" in "\-" constructs.
2060 (let ((symbols (if specialp
"-%$#&{}^_\\" "%$#&{}^_\\")))
2062 (replace-regexp-in-string
2063 (format "\\(?:[^\\]\\|^\\)\\(\\\\\\)\\(?:[^%s]\\|$\\)" symbols
)
2064 "$\\backslash$" output nil t
1)))
2067 (replace-regexp-in-string
2068 "\\([^\\]\\|^\\)\\(~\\)" "\\textasciitilde{}" output nil t
2))
2069 ;; Activate smart quotes. Be sure to provide original TEXT string
2070 ;; since OUTPUT may have been modified.
2071 (when (plist-get info
:with-smart-quotes
)
2072 (setq output
(org-export-activate-smart-quotes output
:latex info text
)))
2073 ;; LaTeX into \LaTeX{} and TeX into \TeX{}.
2074 (let ((case-fold-search nil
)
2076 (while (string-match "\\<\\(\\(?:La\\)?TeX\\)\\>" output start
)
2077 (setq output
(replace-match
2078 (format "\\%s{}" (match-string 1 output
)) nil t output
)
2079 start
(match-end 0))))
2080 ;; Convert special strings.
2083 (replace-regexp-in-string "\\.\\.\\." "\\ldots{}" output nil t
)))
2084 ;; Handle break preservation if required.
2085 (when (plist-get info
:preserve-breaks
)
2086 (setq output
(replace-regexp-in-string
2087 "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n" output
)))
2094 (defun org-latex-planning (planning contents info
)
2095 "Transcode a PLANNING element from Org to LaTeX.
2096 CONTENTS is nil. INFO is a plist holding contextual
2104 (let ((closed (org-element-property :closed planning
)))
2107 (format "\\textbf{%s} " org-closed-string
)
2108 (format (plist-get info
:latex-inactive-timestamp-format
)
2110 (org-element-property :raw-value closed
))))))
2111 (let ((deadline (org-element-property :deadline planning
)))
2114 (format "\\textbf{%s} " org-deadline-string
)
2115 (format (plist-get info
:latex-active-timestamp-format
)
2117 (org-element-property :raw-value deadline
))))))
2118 (let ((scheduled (org-element-property :scheduled planning
)))
2121 (format "\\textbf{%s} " org-scheduled-string
)
2122 (format (plist-get info
:latex-active-timestamp-format
)
2124 (org-element-property :raw-value scheduled
))))))))
2129 ;;;; Property Drawer
2131 (defun org-latex-property-drawer (property-drawer contents info
)
2132 "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
2133 CONTENTS holds the contents of the drawer. INFO is a plist
2134 holding contextual information."
2135 (and (org-string-nw-p contents
)
2136 (format "\\begin{verbatim}\n%s\\end{verbatim}" contents
)))
2139 ;;;; Pseudo Object: LaTeX Math Block
2141 (defun org-latex--wrap-latex-math-block (data info
)
2142 "Merge contiguous math objects in a pseudo-object container.
2143 DATA is a parse tree or a secondary string. INFO is a plist
2144 containing export options. Modify DATA by side-effect and return it."
2145 (let ((valid-object-p
2147 ;; Non-nil when OBJ can be added to the latex math block.
2149 (case (org-element-type obj
)
2150 (entity (org-element-property :latex-math-p obj
))
2152 (let ((value (org-element-property :value obj
)))
2153 (or (org-string-match-p "\\`\\\\([^\000]*\\\\)\\'" value
)
2154 (org-string-match-p "\\`\\$[^\000]*\\$\\'" value
))))
2155 ((subscript superscript
) t
))))))
2156 (org-element-map data
'(entity latex-fragment subscript superscript
)
2158 ;; Skip objects already wrapped.
2159 (when (and (not (eq (org-element-type
2160 (org-element-property :parent object
))
2162 (funcall valid-object-p object
))
2163 (let ((math-block (list 'latex-math-block nil
))
2164 (next-elements (org-export-get-next-element object info t
))
2166 ;; Wrap MATH-BLOCK around OBJECT in DATA.
2167 (org-element-insert-before math-block object
)
2168 (org-element-extract-element object
)
2169 (org-element-adopt-elements math-block object
)
2170 (when (zerop (or (org-element-property :post-blank object
) 0))
2171 ;; MATH-BLOCK swallows consecutive math objects.
2173 (dolist (next next-elements
)
2174 (if (not (funcall valid-object-p next
)) (throw 'exit nil
)
2175 (org-element-extract-element next
)
2176 (org-element-adopt-elements math-block next
)
2177 ;; Eschew the case: \beta$x$ -> \(\betax\).
2178 (unless (memq (org-element-type next
)
2179 '(subscript superscript
))
2180 (org-element-put-property last
:post-blank
1))
2182 (when (> (or (org-element-property :post-blank next
) 0) 0)
2183 (throw 'exit nil
))))))
2184 (org-element-put-property
2185 math-block
:post-blank
(org-element-property :post-blank last
)))))
2186 info nil
'(subscript superscript latex-math-block
) t
)
2187 ;; Return updated DATA.
2190 (defun org-latex-math-block-tree-filter (tree backend info
)
2191 (org-latex--wrap-latex-math-block tree info
))
2193 (defun org-latex-math-block-options-filter (info backend
)
2194 (dolist (prop '(:author
:date
:title
) info
)
2195 (plist-put info prop
2196 (org-latex--wrap-latex-math-block (plist-get info prop
) info
))))
2198 (defun org-latex-math-block (math-block contents info
)
2199 "Transcode a MATH-BLOCK object from Org to LaTeX.
2200 CONTENTS is a string. INFO is a plist used as a communication
2202 (when (org-string-nw-p contents
)
2203 (format "\\(%s\\)" (org-trim contents
))))
2207 (defun org-latex-quote-block (quote-block contents info
)
2208 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
2209 CONTENTS holds the contents of the block. INFO is a plist
2210 holding contextual information."
2211 (org-latex--wrap-label
2213 (format "\\begin{quote}\n%s\\end{quote}" contents
)))
2218 (defun org-latex-radio-target (radio-target text info
)
2219 "Transcode a RADIO-TARGET object from Org to LaTeX.
2220 TEXT is the text of the target. INFO is a plist holding
2221 contextual information."
2222 (format "\\label{%s}%s"
2223 (org-export-solidify-link-text
2224 (org-element-property :value radio-target
))
2230 (defun org-latex-section (section contents info
)
2231 "Transcode a SECTION element from Org to LaTeX.
2232 CONTENTS holds the contents of the section. INFO is a plist
2233 holding contextual information."
2239 (defun org-latex-special-block (special-block contents info
)
2240 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
2241 CONTENTS holds the contents of the block. INFO is a plist
2242 holding contextual information."
2243 (if (org-export-raw-special-block-p special-block info
)
2244 (org-remove-indentation (org-element-property :raw-value special-block
))
2245 (let ((type (downcase (org-element-property :type special-block
)))
2246 (opt (org-export-read-attribute :attr_latex special-block
:options
)))
2247 (concat (format "\\begin{%s}%s\n" type
(or opt
""))
2248 ;; Insert any label or caption within the block
2249 ;; (otherwise, a reference pointing to that element will
2250 ;; count the section instead).
2251 (org-latex--caption/label-string special-block info
)
2253 (format "\\end{%s}" type
)))))
2258 (defun org-latex-src-block (src-block contents info
)
2259 "Transcode a SRC-BLOCK element from Org to LaTeX.
2260 CONTENTS holds the contents of the item. INFO is a plist holding
2261 contextual information."
2262 (when (org-string-nw-p (org-element-property :value src-block
))
2263 (let* ((lang (org-element-property :language src-block
))
2264 (caption (org-element-property :caption src-block
))
2265 (label (org-element-property :name src-block
))
2266 (custom-env (and lang
2267 (cadr (assq (intern lang
)
2268 org-latex-custom-lang-environments
))))
2269 (num-start (case (org-element-property :number-lines src-block
)
2270 (continued (org-export-get-loc src-block info
))
2272 (retain-labels (org-element-property :retain-labels src-block
))
2273 (attributes (org-export-read-attribute :attr_latex src-block
))
2274 (float (plist-get attributes
:float
))
2275 (listings (plist-get info
:latex-listings
)))
2277 ;; Case 1. No source fontification.
2279 (let* ((caption-str (org-latex--caption/label-string src-block info
))
2281 (cond ((and (not float
) (plist-member attributes
:float
)) "%s")
2282 ((string= "multicolumn" float
)
2283 (format "\\begin{figure*}[%s]\n%%s%s\n\\end{figure*}"
2284 (plist-get info
:latex-default-figure-position
)
2287 (format "\\begin{figure}[H]\n%%s%s\n\\end{figure}"
2292 (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
2293 (org-export-format-code-default src-block info
))))))
2294 ;; Case 2. Custom environment.
2295 (custom-env (format "\\begin{%s}\n%s\\end{%s}\n"
2297 (org-export-format-code-default src-block info
)
2299 ;; Case 3. Use minted package.
2300 ((eq listings
'minted
)
2301 (let* ((caption-str (org-latex--caption/label-string src-block info
))
2303 (cond ((and (not float
) (plist-member attributes
:float
)) "%s")
2304 ((string= "multicolumn" float
)
2305 (format "\\begin{listing*}\n%%s\n%s\\end{listing*}"
2308 (format "\\begin{listing}[H]\n%%s\n%s\\end{listing}"
2311 (options (plist-get info
:latex-minted-options
))
2314 "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2317 (org-latex--make-option-string
2318 (if (or (not num-start
) (assoc "linenos" options
))
2322 ("firstnumber" ,(number-to-string (1+ num-start
))))
2324 (let ((local-options (plist-get attributes
:options
)))
2325 (and local-options
(concat "," local-options
))))
2327 (or (cadr (assq (intern lang
)
2328 (plist-get info
:latex-minted-langs
)))
2331 (let* ((code-info (org-export-unravel-code src-block
))
2335 (org-split-string (car code-info
)
2337 (org-export-format-code
2339 (lambda (loc num ref
)
2343 ;; Ensure references are flushed to the right,
2344 ;; separated with 6 spaces from the widest line
2346 (concat (make-string (+ (- max-width
(length loc
)) 6)
2348 (format "(%s)" ref
)))))
2349 nil
(and retain-labels
(cdr code-info
)))))))
2351 (format float-env body
)))
2352 ;; Case 4. Use listings package.
2355 (or (cadr (assq (intern lang
)
2356 (plist-get info
:latex-listings-langs
)))
2360 (let ((main (org-export-get-caption src-block
))
2361 (secondary (org-export-get-caption src-block t
)))
2363 (format "{%s}" (org-export-data main info
))
2365 (org-export-data secondary info
)
2366 (org-export-data main info
))))))
2367 (lst-opt (plist-get info
:latex-listings-options
)))
2373 (org-latex--make-option-string
2377 ((and (not float
) (plist-member attributes
:float
)) nil
)
2378 ((string= "multicolumn" float
) '(("float" "*")))
2379 ((and float
(not (assoc "float" lst-opt
)))
2380 `(("float" ,(plist-get info
:latex-default-figure-position
)))))
2381 `(("language" ,lst-lang
))
2382 (if label
`(("label" ,label
)) '(("label" " ")))
2383 (if caption-str
`(("caption" ,caption-str
)) '(("caption" " ")))
2384 (cond ((assoc "numbers" lst-opt
) nil
)
2385 ((not num-start
) '(("numbers" "none")))
2386 ((zerop num-start
) '(("numbers" "left")))
2387 (t `(("numbers" "left")
2389 ,(number-to-string (1+ num-start
))))))))
2390 (let ((local-options (plist-get attributes
:options
)))
2391 (and local-options
(concat "," local-options
)))))
2394 "\\begin{lstlisting}\n%s\\end{lstlisting}"
2395 (let* ((code-info (org-export-unravel-code src-block
))
2399 (org-split-string (car code-info
) "\n")))))
2400 (org-export-format-code
2402 (lambda (loc num ref
)
2406 ;; Ensure references are flushed to the right,
2407 ;; separated with 6 spaces from the widest line of
2409 (concat (make-string (+ (- max-width
(length loc
)) 6) ?
)
2410 (format "(%s)" ref
)))))
2411 nil
(and retain-labels
(cdr code-info
))))))))))))
2414 ;;;; Statistics Cookie
2416 (defun org-latex-statistics-cookie (statistics-cookie contents info
)
2417 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
2418 CONTENTS is nil. INFO is a plist holding contextual information."
2419 (replace-regexp-in-string
2420 "%" "\\%" (org-element-property :value statistics-cookie
) nil t
))
2425 (defun org-latex-strike-through (strike-through contents info
)
2426 "Transcode STRIKE-THROUGH from Org to LaTeX.
2427 CONTENTS is the text with strike-through markup. INFO is a plist
2428 holding contextual information."
2429 (org-latex--text-markup contents
'strike-through info
))
2434 (defun org-latex--script-size (object info
)
2435 "Transcode a subscript or superscript object.
2436 OBJECT is an Org object. INFO is a plist used as a communication
2438 (let ((type (org-element-type object
))
2440 (org-element-map (org-element-contents object
)
2441 (cons 'plain-text org-element-all-objects
)
2443 (case (org-element-type obj
)
2444 ((entity latex-fragment
)
2445 (let ((data (org-trim (org-export-data obj info
))))
2447 "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
2451 (match-string 1 data
)
2452 (let ((blank (org-element-property :post-blank obj
)))
2453 (and blank
(> blank
0) "\\ "))))))
2456 (format "%s\\text{%s}" output
(org-export-data obj info
))))
2460 (org-export-data obj info
)
2461 (let ((blank (org-element-property :post-blank obj
)))
2462 (and blank
(> blank
0) "\\ ")))))))
2463 info nil org-element-recursive-objects
)
2464 ;; Result. Do not wrap into curly brackets if OUTPUT is a single
2466 (concat (if (eq (org-element-type object
) 'subscript
) "_" "^")
2467 (and (> (length output
) 1) "{")
2469 (and (> (length output
) 1) "}"))))
2471 (defun org-latex-subscript (subscript contents info
)
2472 "Transcode a SUBSCRIPT object from Org to LaTeX.
2473 CONTENTS is the contents of the object. INFO is a plist holding
2474 contextual information."
2475 (org-latex--script-size subscript info
))
2480 (defun org-latex-superscript (superscript contents info
)
2481 "Transcode a SUPERSCRIPT object from Org to LaTeX.
2482 CONTENTS is the contents of the object. INFO is a plist holding
2483 contextual information."
2484 (org-latex--script-size superscript info
))
2489 ;; `org-latex-table' is the entry point for table transcoding. It
2490 ;; takes care of tables with a "verbatim" mode. Otherwise, it
2491 ;; delegates the job to either `org-latex--table.el-table',
2492 ;; `org-latex--org-table' or `org-latex--math-table' functions,
2493 ;; depending of the type of the table and the mode requested.
2495 ;; `org-latex--align-string' is a subroutine used to build alignment
2496 ;; string for Org tables.
2498 (defun org-latex-table (table contents info
)
2499 "Transcode a TABLE element from Org to LaTeX.
2500 CONTENTS is the contents of the table. INFO is a plist holding
2501 contextual information."
2502 (if (eq (org-element-property :type table
) 'table.el
)
2503 ;; "table.el" table. Convert it using appropriate tools.
2504 (org-latex--table.el-table table info
)
2505 (let ((type (or (org-export-read-attribute :attr_latex table
:mode
)
2506 (plist-get info
:latex-default-table-mode
))))
2508 ;; Case 1: Verbatim table.
2509 ((string= type
"verbatim")
2510 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
2511 ;; Re-create table, without affiliated keywords.
2512 (org-trim (org-element-interpret-data
2513 `(table nil
,@(org-element-contents table
))
2514 org-latex-pseudo-objects
))))
2516 ((or (string= type
"math") (string= type
"inline-math"))
2517 (org-latex--math-table table info
))
2518 ;; Case 3: Standard table.
2519 (t (concat (org-latex--org-table table contents info
)
2520 ;; When there are footnote references within the
2521 ;; table, insert their definition just after it.
2522 (org-latex--delayed-footnotes-definitions table info
)))))))
2524 (defun org-latex--align-string (table info
)
2525 "Return an appropriate LaTeX alignment string.
2526 TABLE is the considered table. INFO is a plist used as
2527 a communication channel."
2528 (or (org-export-read-attribute :attr_latex table
:align
)
2530 ;; Extract column groups and alignment from first (non-rule)
2533 (org-element-map table
'table-row
2535 (and (eq (org-element-property :type row
) 'standard
) row
))
2539 (let ((borders (org-export-table-cell-borders cell info
)))
2540 ;; Check left border for the first cell only.
2541 (when (and (memq 'left borders
) (not align
))
2543 (push (case (org-export-table-cell-alignment cell info
)
2548 (when (memq 'right borders
) (push "|" align
))))
2550 (apply 'concat
(nreverse align
)))))
2552 (defun org-latex--org-table (table contents info
)
2553 "Return appropriate LaTeX code for an Org table.
2555 TABLE is the table type element to transcode. CONTENTS is its
2556 contents, as a string. INFO is a plist used as a communication
2559 This function assumes TABLE has `org' as its `:type' property and
2560 `table' as its `:mode' attribute."
2561 (let* ((caption (org-latex--caption/label-string table info
))
2562 (attr (org-export-read-attribute :attr_latex table
))
2563 ;; Determine alignment string.
2564 (alignment (org-latex--align-string table info
))
2565 ;; Determine environment for the table: longtable, tabular...
2566 (table-env (or (plist-get attr
:environment
)
2567 (plist-get info
:latex-default-table-environment
)))
2568 ;; If table is a float, determine environment: table, table*
2569 ;; or sidewaystable.
2570 (float-env (unless (member table-env
'("longtable" "longtabu"))
2571 (let ((float (plist-get attr
:float
)))
2573 ((and (not float
) (plist-member attr
:float
)) nil
)
2574 ((or (string= float
"sidewaystable")
2575 (string= float
"sideways")) "sidewaystable")
2576 ((string= float
"multicolumn") "table*")
2578 (org-element-property :caption table
)
2579 (org-string-nw-p (plist-get attr
:caption
)))
2581 ;; Extract others display options.
2582 (fontsize (let ((font (plist-get attr
:font
)))
2583 (and font
(concat font
"\n"))))
2584 (width (plist-get attr
:width
))
2585 (spreadp (plist-get attr
:spread
))
2587 (or (plist-get attr
:placement
)
2588 (format "[%s]" (plist-get info
:latex-default-figure-position
))))
2589 (centerp (if (plist-member attr
:center
) (plist-get attr
:center
)
2590 (plist-get info
:latex-tables-centered
)))
2591 (caption-above-p (plist-get info
:latex-table-caption-above
)))
2592 ;; Prepare the final format string for the table.
2595 ((equal "longtable" table-env
)
2596 (concat (and fontsize
(concat "{" fontsize
))
2597 (format "\\begin{longtable}{%s}\n" alignment
)
2598 (and caption-above-p
2599 (org-string-nw-p caption
)
2600 (concat caption
"\\\\\n"))
2602 (and (not caption-above-p
)
2603 (org-string-nw-p caption
)
2604 (concat caption
"\\\\\n"))
2605 "\\end{longtable}\n"
2606 (and fontsize
"}")))
2608 ((equal "longtabu" table-env
)
2609 (concat (and fontsize
(concat "{" fontsize
))
2610 (format "\\begin{longtabu}%s{%s}\n"
2613 (if spreadp
"spread" "to") width
) "")
2615 (and caption-above-p
2616 (org-string-nw-p caption
)
2617 (concat caption
"\\\\\n"))
2619 (and (not caption-above-p
)
2620 (org-string-nw-p caption
)
2621 (concat caption
"\\\\\n"))
2623 (and fontsize
"}")))
2627 (concat (format "\\begin{%s}%s\n" float-env placement
)
2628 (if caption-above-p caption
"")
2629 (when centerp
"\\centering\n")
2631 (centerp (concat "\\begin{center}\n" fontsize
))
2632 (fontsize (concat "{" fontsize
)))
2633 (cond ((equal "tabu" table-env
)
2634 (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
2636 (if spreadp
" spread %s " " to %s ")
2640 (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
2642 (if width
(format "{%s}" width
) "")
2648 (concat (if caption-above-p
"" caption
)
2649 (format "\n\\end{%s}" float-env
)))
2650 (centerp "\n\\end{center}")
2651 (fontsize "}")))))))
2653 (defun org-latex--table.el-table
(table info
)
2654 "Return appropriate LaTeX code for a table.el table.
2656 TABLE is the table type element to transcode. INFO is a plist
2657 used as a communication channel.
2659 This function assumes TABLE has `table.el' as its `:type'
2662 ;; Ensure "*org-export-table*" buffer is empty.
2663 (with-current-buffer (get-buffer-create "*org-export-table*")
2665 (let ((output (with-temp-buffer
2666 (insert (org-element-property :value table
))
2668 (re-search-forward "^[ \t]*|[^|]" nil t
)
2669 (table-generate-source 'latex
"*org-export-table*")
2670 (with-current-buffer "*org-export-table*"
2671 (org-trim (buffer-string))))))
2672 (kill-buffer (get-buffer "*org-export-table*"))
2673 ;; Remove left out comments.
2674 (while (string-match "^%.*\n" output
)
2675 (setq output
(replace-match "" t t output
)))
2676 (let ((attr (org-export-read-attribute :attr_latex table
)))
2677 (when (plist-get attr
:rmlines
)
2678 ;; When the "rmlines" attribute is provided, remove all hlines
2679 ;; but the the one separating heading from the table body.
2680 (let ((n 0) (pos 0))
2681 (while (and (< (length output
) pos
)
2682 (setq pos
(string-match "^\\\\hline\n?" output pos
)))
2684 (unless (= n
2) (setq output
(replace-match "" nil nil output
))))))
2685 (let ((centerp (if (plist-member attr
:center
) (plist-get attr
:center
)
2686 (plist-get info
:latex-tables-centered
))))
2687 (if (not centerp
) output
2688 (format "\\begin{center}\n%s\n\\end{center}" output
))))))
2690 (defun org-latex--math-table (table info
)
2691 "Return appropriate LaTeX code for a matrix.
2693 TABLE is the table type element to transcode. INFO is a plist
2694 used as a communication channel.
2696 This function assumes TABLE has `org' as its `:type' property and
2697 `inline-math' or `math' as its `:mode' attribute.."
2698 (let* ((caption (org-latex--caption/label-string table info
))
2699 (attr (org-export-read-attribute :attr_latex table
))
2700 (inlinep (equal (plist-get attr
:mode
) "inline-math"))
2701 (env (or (plist-get attr
:environment
)
2702 (plist-get info
:latex-default-table-environment
)))
2706 ;; Ignore horizontal rules.
2707 (when (eq (org-element-property :type row
) 'standard
)
2708 ;; Return each cell unmodified.
2713 (org-element-interpret-data cell org-latex-pseudo-objects
)
2715 (org-element-map row
'table-cell
'identity info
) "&")
2716 (or (cdr (assoc env org-latex-table-matrix-macros
)) "\\\\")
2718 (org-element-map table
'table-row
'identity info
) ""))
2719 ;; Variables related to math clusters (contiguous math tables
2720 ;; of the same type).
2721 (mode (org-export-read-attribute :attr_latex table
:mode
))
2722 (prev (org-export-get-previous-element table info
))
2723 (next (org-export-get-next-element table info
))
2726 ;; Non-nil when TABLE has the same mode as current table.
2727 (string= (or (org-export-read-attribute :attr_latex table
:mode
)
2728 (plist-get info
:latex-default-table-mode
))
2731 ;; Opening string. If TABLE is in the middle of a table cluster,
2732 ;; do not insert any.
2734 (eq (org-element-type prev
) 'table
)
2735 (memq (org-element-property :post-blank prev
) '(0 nil
))
2736 (funcall same-mode-p prev
))
2739 ((org-string-nw-p caption
) (concat "\\begin{equation}\n" caption
))
2742 (or (plist-get attr
:math-prefix
) "")
2743 ;; Environment. Also treat special cases.
2744 (cond ((equal env
"array")
2745 (let ((align (org-latex--align-string table info
)))
2746 (format "\\begin{array}{%s}\n%s\\end{array}" align contents
)))
2747 ((assoc env org-latex-table-matrix-macros
)
2748 (format "\\%s%s{\n%s}"
2750 (or (plist-get attr
:math-arguments
) "")
2752 (t (format "\\begin{%s}\n%s\\end{%s}" env contents env
)))
2754 (or (plist-get attr
:math-suffix
) "")
2755 ;; Closing string. If TABLE is in the middle of a table cluster,
2756 ;; do not insert any. If it closes such a cluster, be sure to
2757 ;; close the cluster with a string matching the opening string.
2759 (eq (org-element-type next
) 'table
)
2760 (memq (org-element-property :post-blank table
) '(0 nil
))
2761 (funcall same-mode-p next
))
2764 ;; Find cluster beginning to know which environment to use.
2765 ((let ((cluster-beg table
) prev
)
2766 (while (and (setq prev
(org-export-get-previous-element
2768 (memq (org-element-property :post-blank prev
)
2770 (funcall same-mode-p prev
))
2771 (setq cluster-beg prev
))
2772 (and (or (org-element-property :caption cluster-beg
)
2773 (org-element-property :name cluster-beg
))
2774 "\n\\end{equation}")))
2780 (defun org-latex-table-cell (table-cell contents info
)
2781 "Transcode a TABLE-CELL element from Org to LaTeX.
2782 CONTENTS is the cell contents. INFO is a plist used as
2783 a communication channel."
2785 (let ((scientific-format (plist-get info
:latex-table-scientific-notation
)))
2788 (string-match orgtbl-exp-regexp contents
))
2789 ;; Use appropriate format string for scientific
2791 (format scientific-format
2792 (match-string 1 contents
)
2793 (match-string 2 contents
))
2795 (when (org-export-get-next-element table-cell info
) " & ")))
2800 (defun org-latex-table-row (table-row contents info
)
2801 "Transcode a TABLE-ROW element from Org to LaTeX.
2802 CONTENTS is the contents of the row. INFO is a plist used as
2803 a communication channel."
2804 ;; Rules are ignored since table separators are deduced from
2805 ;; borders of the current row.
2806 (when (eq (org-element-property :type table-row
) 'standard
)
2807 (let* ((attr (org-export-read-attribute :attr_latex
2808 (org-export-get-parent table-row
)))
2810 (member (or (plist-get attr
:environment
)
2811 (plist-get info
:latex-default-table-environment
))
2812 '("longtable" "longtabu")))
2813 (booktabsp (if (plist-member attr
:booktabs
)
2814 (plist-get attr
:booktabs
)
2815 (plist-get info
:latex-tables-booktabs
)))
2816 ;; TABLE-ROW's borders are extracted from its first cell.
2817 (borders (org-export-table-cell-borders
2818 (car (org-element-contents table-row
)) info
)))
2820 ;; When BOOKTABS are activated enforce top-rule even when no
2821 ;; hline was specifically marked.
2822 (cond ((and booktabsp
(memq 'top borders
)) "\\toprule\n")
2823 ((and (memq 'top borders
) (memq 'above borders
)) "\\hline\n"))
2826 ;; Special case for long tables. Define header and footers.
2827 ((and longtablep
(org-export-table-row-ends-header-p table-row info
))
2830 \\multicolumn{%d}{l}{%s} \\\\
2835 %s\\multicolumn{%d}{r}{%s} \\\\
2838 (if booktabsp
"\\midrule" "\\hline")
2839 (cdr (org-export-table-dimensions
2840 (org-export-get-parent-table table-row
) info
))
2841 (org-latex--translate "Continued from previous page" info
)
2842 (cond ((and booktabsp
(memq 'top borders
)) "\\toprule\n")
2843 ((and (memq 'top borders
)
2844 (memq 'above borders
)) "\\hline\n")
2847 (if booktabsp
"\\midrule" "\\hline")
2848 (if booktabsp
"\\midrule" "\\hline")
2849 ;; Number of columns.
2850 (cdr (org-export-table-dimensions
2851 (org-export-get-parent-table table-row
) info
))
2852 (org-latex--translate "Continued on next page" info
)))
2853 ;; When BOOKTABS are activated enforce bottom rule even when
2854 ;; no hline was specifically marked.
2855 ((and booktabsp
(memq 'bottom borders
)) "\\bottomrule")
2856 ((and (memq 'bottom borders
) (memq 'below borders
)) "\\hline")
2857 ((memq 'below borders
) (if booktabsp
"\\midrule" "\\hline")))))))
2862 (defun org-latex-target (target contents info
)
2863 "Transcode a TARGET object from Org to LaTeX.
2864 CONTENTS is nil. INFO is a plist holding contextual
2866 (format "\\label{%s}"
2867 (org-export-solidify-link-text (org-element-property :value target
))))
2872 (defun org-latex-timestamp (timestamp contents info
)
2873 "Transcode a TIMESTAMP object from Org to LaTeX.
2874 CONTENTS is nil. INFO is a plist holding contextual
2876 (let ((value (org-latex-plain-text
2877 (org-timestamp-translate timestamp
) info
)))
2878 (case (org-element-property :type timestamp
)
2879 ((active active-range
)
2880 (format (plist-get info
:latex-active-timestamp-format
) value
))
2881 ((inactive inactive-range
)
2882 (format (plist-get info
:latex-inactive-timestamp-format
) value
))
2884 (format (plist-get info
:latex-diary-timestamp-format
) value
)))))
2889 (defun org-latex-underline (underline contents info
)
2890 "Transcode UNDERLINE from Org to LaTeX.
2891 CONTENTS is the text with underline markup. INFO is a plist
2892 holding contextual information."
2893 (org-latex--text-markup contents
'underline info
))
2898 (defun org-latex-verbatim (verbatim contents info
)
2899 "Transcode a VERBATIM object from Org to LaTeX.
2900 CONTENTS is nil. INFO is a plist used as a communication
2902 (org-latex--text-markup
2903 (org-element-property :value verbatim
) 'verbatim info
))
2908 (defun org-latex-verse-block (verse-block contents info
)
2909 "Transcode a VERSE-BLOCK element from Org to LaTeX.
2910 CONTENTS is verse block contents. INFO is a plist holding
2911 contextual information."
2912 (org-latex--wrap-label
2914 ;; In a verse environment, add a line break to each newline
2915 ;; character and change each white space at beginning of a line
2916 ;; into a space of 1 em. Also change each blank line with
2917 ;; a vertical space of 1 em.
2919 (setq contents
(replace-regexp-in-string
2920 "^ *\\\\\\\\$" "\\\\vspace*{1em}"
2921 (replace-regexp-in-string
2922 "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n" contents
)))
2923 (while (string-match "^[ \t]+" contents
)
2924 (let ((new-str (format "\\hspace*{%dem}"
2925 (length (match-string 0 contents
)))))
2926 (setq contents
(replace-match new-str nil t contents
))))
2927 (format "\\begin{verse}\n%s\\end{verse}" contents
))))
2931 ;;; End-user functions
2934 (defun org-latex-export-as-latex
2935 (&optional async subtreep visible-only body-only ext-plist
)
2936 "Export current buffer as a LaTeX buffer.
2938 If narrowing is active in the current buffer, only export its
2941 If a region is active, export that region.
2943 A non-nil optional argument ASYNC means the process should happen
2944 asynchronously. The resulting buffer should be accessible
2945 through the `org-export-stack' interface.
2947 When optional argument SUBTREEP is non-nil, export the sub-tree
2948 at point, extracting information from the headline properties
2951 When optional argument VISIBLE-ONLY is non-nil, don't export
2952 contents of hidden elements.
2954 When optional argument BODY-ONLY is non-nil, only write code
2955 between \"\\begin{document}\" and \"\\end{document}\".
2957 EXT-PLIST, when provided, is a property list with external
2958 parameters overriding Org default settings, but still inferior to
2959 file-local settings.
2961 Export is done in a buffer named \"*Org LATEX Export*\", which
2962 will be displayed when `org-export-show-temporary-export-buffer'
2965 (org-export-to-buffer 'latex
"*Org LATEX Export*"
2966 async subtreep visible-only body-only ext-plist
(lambda () (LaTeX-mode))))
2969 (defun org-latex-convert-region-to-latex ()
2970 "Assume the current region has org-mode syntax, and convert it to LaTeX.
2971 This can be used in any buffer. For example, you can write an
2972 itemized list in org-mode syntax in an LaTeX buffer and use this
2973 command to convert it."
2975 (org-export-replace-region-by 'latex
))
2978 (defun org-latex-export-to-latex
2979 (&optional async subtreep visible-only body-only ext-plist
)
2980 "Export current buffer to a LaTeX file.
2982 If narrowing is active in the current buffer, only export its
2985 If a region is active, export that region.
2987 A non-nil optional argument ASYNC means the process should happen
2988 asynchronously. The resulting file should be accessible through
2989 the `org-export-stack' interface.
2991 When optional argument SUBTREEP is non-nil, export the sub-tree
2992 at point, extracting information from the headline properties
2995 When optional argument VISIBLE-ONLY is non-nil, don't export
2996 contents of hidden elements.
2998 When optional argument BODY-ONLY is non-nil, only write code
2999 between \"\\begin{document}\" and \"\\end{document}\".
3001 EXT-PLIST, when provided, is a property list with external
3002 parameters overriding Org default settings, but still inferior to
3003 file-local settings."
3005 (let ((outfile (org-export-output-file-name ".tex" subtreep
)))
3006 (org-export-to-file 'latex outfile
3007 async subtreep visible-only body-only ext-plist
)))
3010 (defun org-latex-export-to-pdf
3011 (&optional async subtreep visible-only body-only ext-plist
)
3012 "Export current buffer to LaTeX then process through to PDF.
3014 If narrowing is active in the current buffer, only export its
3017 If a region is active, export that region.
3019 A non-nil optional argument ASYNC means the process should happen
3020 asynchronously. The resulting file should be accessible through
3021 the `org-export-stack' interface.
3023 When optional argument SUBTREEP is non-nil, export the sub-tree
3024 at point, extracting information from the headline properties
3027 When optional argument VISIBLE-ONLY is non-nil, don't export
3028 contents of hidden elements.
3030 When optional argument BODY-ONLY is non-nil, only write code
3031 between \"\\begin{document}\" and \"\\end{document}\".
3033 EXT-PLIST, when provided, is a property list with external
3034 parameters overriding Org default settings, but still inferior to
3035 file-local settings.
3037 Return PDF file's name."
3039 (let ((outfile (org-export-output-file-name ".tex" subtreep
)))
3040 (org-export-to-file 'latex outfile
3041 async subtreep visible-only body-only ext-plist
3042 (lambda (file) (org-latex-compile file
)))))
3044 (defun org-latex-compile (texfile &optional snippet
)
3045 "Compile a TeX file.
3047 TEXFILE is the name of the file being compiled. Processing is
3048 done through the command specified in `org-latex-pdf-process'.
3050 When optional argument SNIPPET is non-nil, TEXFILE is a temporary
3051 file used to preview a LaTeX snippet. In this case, do not
3052 create a log buffer and do not bother removing log files.
3054 Return PDF file name or an error if it couldn't be produced."
3055 (let* ((base-name (file-name-sans-extension (file-name-nondirectory texfile
)))
3056 (full-name (file-truename texfile
))
3057 (out-dir (file-name-directory texfile
))
3058 ;; Properly set working directory for compilation.
3059 (default-directory (if (file-name-absolute-p texfile
)
3060 (file-name-directory full-name
)
3062 (time (current-time))
3064 (unless snippet
(message (format "Processing LaTeX file %s..." texfile
)))
3065 (save-window-excursion
3067 ;; A function is provided: Apply it.
3068 ((functionp org-latex-pdf-process
)
3069 (funcall org-latex-pdf-process
(shell-quote-argument texfile
)))
3070 ;; A list is provided: Replace %b, %f and %o with appropriate
3071 ;; values in each command before applying it. Output is
3072 ;; redirected to "*Org PDF LaTeX Output*" buffer.
3073 ((consp org-latex-pdf-process
)
3074 (let ((outbuf (and (not snippet
)
3075 (get-buffer-create "*Org PDF LaTeX Output*"))))
3079 (replace-regexp-in-string
3080 "%b" (shell-quote-argument base-name
)
3081 (replace-regexp-in-string
3082 "%f" (shell-quote-argument full-name
)
3083 (replace-regexp-in-string
3084 "%o" (shell-quote-argument out-dir
) command t t
) t t
) t t
)
3086 org-latex-pdf-process
)
3087 ;; Collect standard errors from output buffer.
3088 (setq warnings
(and (not snippet
)
3089 (org-latex--collect-warnings outbuf
)))))
3090 (t (error "No valid command to process to PDF")))
3091 (let ((pdffile (concat out-dir base-name
".pdf")))
3092 ;; Check for process failure. Provide collected errors if
3094 (if (or (not (file-exists-p pdffile
))
3095 (time-less-p (nth 5 (file-attributes pdffile
)) time
))
3096 (error (format "PDF file %s wasn't produced" pdffile
))
3097 ;; Else remove log files, when specified, and signal end of
3098 ;; process to user, along with any error encountered.
3099 (when (and (not snippet
) org-latex-remove-logfiles
)
3100 (dolist (file (directory-files
3102 (concat (regexp-quote base-name
)
3103 "\\(?:\\.[0-9]+\\)?"
3105 (regexp-opt org-latex-logfiles-extensions
))))
3106 (delete-file file
)))
3107 (message (concat "PDF file produced"
3109 ((eq warnings
'error
) " with errors.")
3110 (warnings (concat " with warnings: " warnings
))
3112 ;; Return output file name.
3115 (defun org-latex--collect-warnings (buffer)
3116 "Collect some warnings from \"pdflatex\" command output.
3117 BUFFER is the buffer containing output. Return collected
3118 warnings types as a string, `error' if a LaTeX error was
3119 encountered or nil if there was none."
3120 (with-current-buffer buffer
3122 (goto-char (point-max))
3123 (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t
)
3124 (if (re-search-forward "^!" nil t
) 'error
3125 (let ((case-fold-search t
)
3127 (dolist (warning org-latex-known-warnings
)
3129 (when (save-excursion (re-search-forward (car warning
) nil t
))
3130 (setq warnings
(concat warnings
" " (cdr warning
))))))
3131 (and (org-string-nw-p warnings
) (org-trim warnings
))))))))
3134 (defun org-latex-publish-to-latex (plist filename pub-dir
)
3135 "Publish an Org file to LaTeX.
3137 FILENAME is the filename of the Org file to be published. PLIST
3138 is the property list for the given project. PUB-DIR is the
3139 publishing directory.
3141 Return output file name."
3142 (org-publish-org-to 'latex filename
".tex" plist pub-dir
))
3145 (defun org-latex-publish-to-pdf (plist filename pub-dir
)
3146 "Publish an Org file to PDF (via LaTeX).
3148 FILENAME is the filename of the Org file to be published. PLIST
3149 is the property list for the given project. PUB-DIR is the
3150 publishing directory.
3152 Return output file name."
3153 ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
3154 ;; in working directory and then moved to publishing directory.
3155 (org-publish-attachment
3159 'latex filename
".tex" plist
(file-name-directory filename
)))
3166 ;; generated-autoload-file: "org-loaddefs.el"
3169 ;;; ox-latex.el ends here