ox: add Japanese translations for figures and tables
[org-mode.git] / lisp / ox-latex.el
blob09928a4167d2cf66e6816f1aa4f2f4dc04c92ded
1 ;;; ox-latex.el --- LaTeX Back-End for Org Export Engine
3 ;; Copyright (C) 2011-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
23 ;; See Org manual for details.
25 ;;; Code:
27 (eval-when-compile (require 'cl))
28 (require 'ox)
29 (require 'ox-publish)
31 (defvar org-latex-default-packages-alist)
32 (defvar org-latex-packages-alist)
33 (defvar orgtbl-exp-regexp)
37 ;;; Define Back-End
39 (org-export-define-backend 'latex
40 '((bold . org-latex-bold)
41 (center-block . org-latex-center-block)
42 (clock . org-latex-clock)
43 (code . org-latex-code)
44 (comment . (lambda (&rest args) ""))
45 (comment-block . (lambda (&rest args) ""))
46 (drawer . org-latex-drawer)
47 (dynamic-block . org-latex-dynamic-block)
48 (entity . org-latex-entity)
49 (example-block . org-latex-example-block)
50 (export-block . org-latex-export-block)
51 (export-snippet . org-latex-export-snippet)
52 (fixed-width . org-latex-fixed-width)
53 (footnote-definition . org-latex-footnote-definition)
54 (footnote-reference . org-latex-footnote-reference)
55 (headline . org-latex-headline)
56 (horizontal-rule . org-latex-horizontal-rule)
57 (inline-src-block . org-latex-inline-src-block)
58 (inlinetask . org-latex-inlinetask)
59 (italic . org-latex-italic)
60 (item . org-latex-item)
61 (keyword . org-latex-keyword)
62 (latex-environment . org-latex-latex-environment)
63 (latex-fragment . org-latex-latex-fragment)
64 (line-break . org-latex-line-break)
65 (link . org-latex-link)
66 (paragraph . org-latex-paragraph)
67 (plain-list . org-latex-plain-list)
68 (plain-text . org-latex-plain-text)
69 (planning . org-latex-planning)
70 (property-drawer . (lambda (&rest args) ""))
71 (quote-block . org-latex-quote-block)
72 (quote-section . org-latex-quote-section)
73 (radio-target . org-latex-radio-target)
74 (section . org-latex-section)
75 (special-block . org-latex-special-block)
76 (src-block . org-latex-src-block)
77 (statistics-cookie . org-latex-statistics-cookie)
78 (strike-through . org-latex-strike-through)
79 (subscript . org-latex-subscript)
80 (superscript . org-latex-superscript)
81 (table . org-latex-table)
82 (table-cell . org-latex-table-cell)
83 (table-row . org-latex-table-row)
84 (target . org-latex-target)
85 (template . org-latex-template)
86 (timestamp . org-latex-timestamp)
87 (underline . org-latex-underline)
88 (verbatim . org-latex-verbatim)
89 (verse-block . org-latex-verse-block))
90 :export-block '("LATEX" "TEX")
91 :menu-entry
92 '(?l "Export to LaTeX"
93 ((?L "As LaTeX buffer" org-latex-export-as-latex)
94 (?l "As LaTeX file" org-latex-export-to-latex)
95 (?p "As PDF file" org-latex-export-to-pdf)
96 (?o "As PDF file and open"
97 (lambda (a s v b)
98 (if a (org-latex-export-to-pdf t s v b)
99 (org-open-file (org-latex-export-to-pdf nil s v b)))))))
100 :options-alist '((:latex-class "LATEX_CLASS" nil org-latex-default-class t)
101 (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t)
102 (:latex-header "LATEX_HEADER" nil nil newline)
103 (:latex-header-extra "LATEX_HEADER_EXTRA" nil nil newline)
104 (:latex-hyperref-p nil "texht" org-latex-with-hyperref t)
105 ;; Redefine regular options.
106 (:date "DATE" nil "\\today" t)))
110 ;;; Internal Variables
112 (defconst org-latex-babel-language-alist
113 '(("af" . "afrikaans")
114 ("bg" . "bulgarian")
115 ("bt-br" . "brazilian")
116 ("ca" . "catalan")
117 ("cs" . "czech")
118 ("cy" . "welsh")
119 ("da" . "danish")
120 ("de" . "germanb")
121 ("de-at" . "naustrian")
122 ("de-de" . "ngerman")
123 ("el" . "greek")
124 ("en" . "english")
125 ("en-au" . "australian")
126 ("en-ca" . "canadian")
127 ("en-gb" . "british")
128 ("en-ie" . "irish")
129 ("en-nz" . "newzealand")
130 ("en-us" . "american")
131 ("es" . "spanish")
132 ("et" . "estonian")
133 ("eu" . "basque")
134 ("fi" . "finnish")
135 ("fr" . "frenchb")
136 ("fr-ca" . "canadien")
137 ("gl" . "galician")
138 ("hr" . "croatian")
139 ("hu" . "hungarian")
140 ("id" . "indonesian")
141 ("is" . "icelandic")
142 ("it" . "italian")
143 ("la" . "latin")
144 ("ms" . "malay")
145 ("nl" . "dutch")
146 ("no-no" . "nynorsk")
147 ("pl" . "polish")
148 ("pt" . "portuguese")
149 ("ro" . "romanian")
150 ("ru" . "russian")
151 ("sa" . "sanskrit")
152 ("sb" . "uppersorbian")
153 ("sk" . "slovak")
154 ("sl" . "slovene")
155 ("sq" . "albanian")
156 ("sr" . "serbian")
157 ("sv" . "swedish")
158 ("ta" . "tamil")
159 ("tr" . "turkish")
160 ("uk" . "ukrainian"))
161 "Alist between language code and corresponding Babel option.")
163 (defconst org-latex-table-matrix-macros '(("bordermatrix" . "\\cr")
164 ("qbordermatrix" . "\\cr")
165 ("kbordermatrix" . "\\\\"))
166 "Alist between matrix macros and their row ending.")
170 ;;; User Configurable Variables
172 (defgroup org-export-latex nil
173 "Options for exporting Org mode files to LaTeX."
174 :tag "Org Export LaTeX"
175 :group 'org-export)
178 ;;;; Preamble
180 (defcustom org-latex-default-class "article"
181 "The default LaTeX class."
182 :group 'org-export-latex
183 :type '(string :tag "LaTeX class"))
185 (defcustom org-latex-classes
186 '(("article"
187 "\\documentclass[11pt]{article}"
188 ("\\section{%s}" . "\\section*{%s}")
189 ("\\subsection{%s}" . "\\subsection*{%s}")
190 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
191 ("\\paragraph{%s}" . "\\paragraph*{%s}")
192 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
193 ("report"
194 "\\documentclass[11pt]{report}"
195 ("\\part{%s}" . "\\part*{%s}")
196 ("\\chapter{%s}" . "\\chapter*{%s}")
197 ("\\section{%s}" . "\\section*{%s}")
198 ("\\subsection{%s}" . "\\subsection*{%s}")
199 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
200 ("book"
201 "\\documentclass[11pt]{book}"
202 ("\\part{%s}" . "\\part*{%s}")
203 ("\\chapter{%s}" . "\\chapter*{%s}")
204 ("\\section{%s}" . "\\section*{%s}")
205 ("\\subsection{%s}" . "\\subsection*{%s}")
206 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
207 "Alist of LaTeX classes and associated header and structure.
208 If #+LATEX_CLASS is set in the buffer, use its value and the
209 associated information. Here is the structure of each cell:
211 \(class-name
212 header-string
213 \(numbered-section . unnumbered-section)
214 ...)
216 The header string
217 -----------------
219 The HEADER-STRING is the header that will be inserted into the
220 LaTeX file. It should contain the \\documentclass macro, and
221 anything else that is needed for this setup. To this header, the
222 following commands will be added:
224 - Calls to \\usepackage for all packages mentioned in the
225 variables `org-latex-default-packages-alist' and
226 `org-latex-packages-alist'. Thus, your header definitions
227 should avoid to also request these packages.
229 - Lines specified via \"#+LATEX_HEADER:\" and
230 \"#+LATEX_HEADER_EXTRA:\" keywords.
232 If you need more control about the sequence in which the header
233 is built up, or if you want to exclude one of these building
234 blocks for a particular class, you can use the following
235 macro-like placeholders.
237 [DEFAULT-PACKAGES] \\usepackage statements for default packages
238 [NO-DEFAULT-PACKAGES] do not include any of the default packages
239 [PACKAGES] \\usepackage statements for packages
240 [NO-PACKAGES] do not include the packages
241 [EXTRA] the stuff from #+LATEX_HEADER(_EXTRA)
242 [NO-EXTRA] do not include #+LATEX_HEADER(_EXTRA) stuff
244 So a header like
246 \\documentclass{article}
247 [NO-DEFAULT-PACKAGES]
248 [EXTRA]
249 \\providecommand{\\alert}[1]{\\textbf{#1}}
250 [PACKAGES]
252 will omit the default packages, and will include the
253 #+LATEX_HEADER and #+LATEX_HEADER_EXTRA lines, then have a call
254 to \\providecommand, and then place \\usepackage commands based
255 on the content of `org-latex-packages-alist'.
257 If your header, `org-latex-default-packages-alist' or
258 `org-latex-packages-alist' inserts \"\\usepackage[AUTO]{inputenc}\",
259 AUTO will automatically be replaced with a coding system derived
260 from `buffer-file-coding-system'. See also the variable
261 `org-latex-inputenc-alist' for a way to influence this mechanism.
263 Likewise, if your header contains \"\\usepackage[AUTO]{babel}\",
264 AUTO will be replaced with the language related to the language
265 code specified by `org-export-default-language', which see. Note
266 that constructions such as \"\\usepackage[french,AUTO,english]{babel}\"
267 are permitted.
269 The sectioning structure
270 ------------------------
272 The sectioning structure of the class is given by the elements
273 following the header string. For each sectioning level, a number
274 of strings is specified. A %s formatter is mandatory in each
275 section string and will be replaced by the title of the section.
277 Instead of a cons cell (numbered . unnumbered), you can also
278 provide a list of 2 or 4 elements,
280 \(numbered-open numbered-close)
284 \(numbered-open numbered-close unnumbered-open unnumbered-close)
286 providing opening and closing strings for a LaTeX environment
287 that should represent the document section. The opening clause
288 should have a %s to represent the section title.
290 Instead of a list of sectioning commands, you can also specify
291 a function name. That function will be called with two
292 parameters, the (reduced) level of the headline, and a predicate
293 non-nil when the headline should be numbered. It must return
294 a format string in which the section title will be added."
295 :group 'org-export-latex
296 :type '(repeat
297 (list (string :tag "LaTeX class")
298 (string :tag "LaTeX header")
299 (repeat :tag "Levels" :inline t
300 (choice
301 (cons :tag "Heading"
302 (string :tag " numbered")
303 (string :tag "unnumbered"))
304 (list :tag "Environment"
305 (string :tag "Opening (numbered)")
306 (string :tag "Closing (numbered)")
307 (string :tag "Opening (unnumbered)")
308 (string :tag "Closing (unnumbered)"))
309 (function :tag "Hook computing sectioning"))))))
311 (defcustom org-latex-inputenc-alist nil
312 "Alist of inputenc coding system names, and what should really be used.
313 For example, adding an entry
315 (\"utf8\" . \"utf8x\")
317 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
318 are written as utf8 files."
319 :group 'org-export-latex
320 :type '(repeat
321 (cons
322 (string :tag "Derived from buffer")
323 (string :tag "Use this instead"))))
325 (defcustom org-latex-title-command "\\maketitle"
326 "The command used to insert the title just after \\begin{document}.
327 If this string contains the formatting specification \"%s\" then
328 it will be used as a formatting string, passing the title as an
329 argument."
330 :group 'org-export-latex
331 :type 'string)
333 (defcustom org-latex-toc-command "\\tableofcontents\n\n"
334 "LaTeX command to set the table of contents, list of figures, etc.
335 This command only applies to the table of contents generated with
336 the toc:nil option, not to those generated with #+TOC keyword."
337 :group 'org-export-latex
338 :type 'string)
340 (defcustom org-latex-with-hyperref t
341 "Toggle insertion of \\hypersetup{...} in the preamble."
342 :group 'org-export-latex
343 :type 'boolean)
346 ;;;; Headline
348 (defcustom org-latex-format-headline-function
349 'org-latex-format-headline-default-function
350 "Function for formatting the headline's text.
352 This function will be called with 5 arguments:
353 TODO the todo keyword (string or nil).
354 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
355 PRIORITY the priority of the headline (integer or nil)
356 TEXT the main headline text (string).
357 TAGS the tags as a list of strings (list of strings or nil).
359 The function result will be used in the section format string.
361 Use `org-latex-format-headline-default-function' by default,
362 which format headlines like for Org version prior to 8.0."
363 :group 'org-export-latex
364 :version "24.4"
365 :package-version '(Org . "8.0")
366 :type 'function)
369 ;;;; Footnotes
371 (defcustom org-latex-footnote-separator "\\textsuperscript{,}\\,"
372 "Text used to separate footnotes."
373 :group 'org-export-latex
374 :type 'string)
377 ;;;; Timestamps
379 (defcustom org-latex-active-timestamp-format "\\textit{%s}"
380 "A printf format string to be applied to active timestamps."
381 :group 'org-export-latex
382 :type 'string)
384 (defcustom org-latex-inactive-timestamp-format "\\textit{%s}"
385 "A printf format string to be applied to inactive timestamps."
386 :group 'org-export-latex
387 :type 'string)
389 (defcustom org-latex-diary-timestamp-format "\\textit{%s}"
390 "A printf format string to be applied to diary timestamps."
391 :group 'org-export-latex
392 :type 'string)
395 ;;;; Links
397 (defcustom org-latex-image-default-option ""
398 "Default option for images."
399 :group 'org-export-latex
400 :version "24.4"
401 :package-version '(Org . "8.0")
402 :type 'string)
404 (defcustom org-latex-image-default-width ".9\\linewidth"
405 "Default width for images.
406 This value will not be used if a height is provided."
407 :group 'org-export-latex
408 :version "24.4"
409 :package-version '(Org . "8.0")
410 :type 'string)
412 (defcustom org-latex-image-default-height ""
413 "Default height for images.
414 This value will not be used if a width is provided, or if the
415 image is wrapped within a \"figure\" or \"wrapfigure\"
416 environment."
417 :group 'org-export-latex
418 :version "24.4"
419 :package-version '(Org . "8.0")
420 :type 'string)
422 (defcustom org-latex-default-figure-position "htb"
423 "Default position for latex figures."
424 :group 'org-export-latex
425 :type 'string)
427 (defcustom org-latex-inline-image-rules
428 '(("file" . "\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\|tikz\\|pgf\\)\\'"))
429 "Rules characterizing image files that can be inlined into LaTeX.
431 A rule consists in an association whose key is the type of link
432 to consider, and value is a regexp that will be matched against
433 link's path.
435 Note that, by default, the image extension *actually* allowed
436 depend on the way the LaTeX file is processed. When used with
437 pdflatex, pdf, jpg and png images are OK. When processing
438 through dvi to Postscript, only ps and eps are allowed. The
439 default we use here encompasses both."
440 :group 'org-export-latex
441 :version "24.4"
442 :package-version '(Org . "8.0")
443 :type '(alist :key-type (string :tag "Type")
444 :value-type (regexp :tag "Path")))
446 (defcustom org-latex-link-with-unknown-path-format "\\texttt{%s}"
447 "Format string for links with unknown path type."
448 :group 'org-export-latex
449 :type 'string)
452 ;;;; Tables
454 (defcustom org-latex-default-table-environment "tabular"
455 "Default environment used to build tables."
456 :group 'org-export-latex
457 :version "24.4"
458 :package-version '(Org . "8.0")
459 :type 'string)
461 (defcustom org-latex-default-table-mode 'table
462 "Default mode for tables.
464 Value can be a symbol among:
466 `table' Regular LaTeX table.
468 `math' In this mode, every cell is considered as being in math
469 mode and the complete table will be wrapped within a math
470 environment. It is particularly useful to write matrices.
472 `inline-math' This mode is almost the same as `math', but the
473 math environment will be inlined.
475 `verbatim' The table is exported as it appears in the Org
476 buffer, within a verbatim environment.
478 This value can be overridden locally with, i.e. \":mode math\" in
479 LaTeX attributes.
481 When modifying this variable, it may be useful to change
482 `org-latex-default-table-environment' accordingly."
483 :group 'org-export-latex
484 :version "24.4"
485 :package-version '(Org . "8.0")
486 :type '(choice (const :tag "Table" table)
487 (const :tag "Matrix" math)
488 (const :tag "Inline matrix" inline-math)
489 (const :tag "Verbatim" verbatim)))
491 (defcustom org-latex-tables-centered t
492 "When non-nil, tables are exported in a center environment."
493 :group 'org-export-latex
494 :type 'boolean)
496 (defcustom org-latex-tables-booktabs nil
497 "When non-nil, display tables in a formal \"booktabs\" style.
498 This option assumes that the \"booktabs\" package is properly
499 loaded in the header of the document. This value can be ignored
500 locally with \":booktabs t\" and \":booktabs nil\" LaTeX
501 attributes."
502 :group 'org-export-latex
503 :version "24.4"
504 :package-version '(Org . "8.0")
505 :type 'boolean)
507 (defcustom org-latex-table-caption-above t
508 "When non-nil, place caption string at the beginning of the table.
509 Otherwise, place it near the end."
510 :group 'org-export-latex
511 :type 'boolean)
513 (defcustom org-latex-table-scientific-notation "%s\\,(%s)"
514 "Format string to display numbers in scientific notation.
515 The format should have \"%s\" twice, for mantissa and exponent
516 \(i.e., \"%s\\\\times10^{%s}\").
518 When nil, no transformation is made."
519 :group 'org-export-latex
520 :version "24.4"
521 :package-version '(Org . "8.0")
522 :type '(choice
523 (string :tag "Format string")
524 (const :tag "No formatting")))
527 ;;;; Text markup
529 (defcustom org-latex-text-markup-alist '((bold . "\\textbf{%s}")
530 (code . verb)
531 (italic . "\\emph{%s}")
532 (strike-through . "\\sout{%s}")
533 (underline . "\\uline{%s}")
534 (verbatim . protectedtexttt))
535 "Alist of LaTeX expressions to convert text markup.
537 The key must be a symbol among `bold', `code', `italic',
538 `strike-through', `underline' and `verbatim'. The value is
539 a formatting string to wrap fontified text with.
541 Value can also be set to the following symbols: `verb' and
542 `protectedtexttt'. For the former, Org will use \"\\verb\" to
543 create a format string and select a delimiter character that
544 isn't in the string. For the latter, Org will use \"\\texttt\"
545 to typeset and try to protect special characters.
547 If no association can be found for a given markup, text will be
548 returned as-is."
549 :group 'org-export-latex
550 :type 'alist
551 :options '(bold code italic strike-through underline verbatim))
554 ;;;; Drawers
556 (defcustom org-latex-format-drawer-function nil
557 "Function called to format a drawer in LaTeX code.
559 The function must accept two parameters:
560 NAME the drawer name, like \"LOGBOOK\"
561 CONTENTS the contents of the drawer.
563 The function should return the string to be exported.
565 For example, the variable could be set to the following function
566 in order to mimic default behaviour:
568 \(defun org-latex-format-drawer-default \(name contents\)
569 \"Format a drawer element for LaTeX export.\"
570 contents\)"
571 :group 'org-export-latex
572 :type 'function)
575 ;;;; Inlinetasks
577 (defcustom org-latex-format-inlinetask-function nil
578 "Function called to format an inlinetask in LaTeX code.
580 The function must accept six parameters:
581 TODO the todo keyword, as a string
582 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
583 PRIORITY the inlinetask priority, as a string
584 NAME the inlinetask name, as a string.
585 TAGS the inlinetask tags, as a list of strings.
586 CONTENTS the contents of the inlinetask, as a string.
588 The function should return the string to be exported.
590 For example, the variable could be set to the following function
591 in order to mimic default behaviour:
593 \(defun org-latex-format-inlinetask \(todo type priority name tags contents\)
594 \"Format an inline task element for LaTeX export.\"
595 \(let ((full-title
596 \(concat
597 \(when todo
598 \(format \"\\\\textbf{\\\\textsf{\\\\textsc{%s}}} \" todo))
599 \(when priority (format \"\\\\framebox{\\\\#%c} \" priority))
600 title
601 \(when tags
602 \(format \"\\\\hfill{}\\\\textsc{:%s:}\"
603 \(mapconcat 'identity tags \":\")))))
604 \(format (concat \"\\\\begin{center}\\n\"
605 \"\\\\fbox{\\n\"
606 \"\\\\begin{minipage}[c]{.6\\\\textwidth}\\n\"
607 \"%s\\n\\n\"
608 \"\\\\rule[.8em]{\\\\textwidth}{2pt}\\n\\n\"
609 \"%s\"
610 \"\\\\end{minipage}}\"
611 \"\\\\end{center}\")
612 full-title contents))"
613 :group 'org-export-latex
614 :type 'function)
617 ;; Src blocks
619 (defcustom org-latex-listings nil
620 "Non-nil means export source code using the listings package.
621 This package will fontify source code, possibly even with color.
622 If you want to use this, you also need to make LaTeX use the
623 listings package, and if you want to have color, the color
624 package. Just add these to `org-latex-packages-alist', for
625 example using customize, or with something like:
627 \(require 'ox-latex)
628 \(add-to-list 'org-latex-packages-alist '\(\"\" \"listings\"))
629 \(add-to-list 'org-latex-packages-alist '\(\"\" \"color\"))
631 Alternatively,
633 \(setq org-latex-listings 'minted)
635 causes source code to be exported using the minted package as
636 opposed to listings. If you want to use minted, you need to add
637 the minted package to `org-latex-packages-alist', for example
638 using customize, or with
640 \(require 'ox-latex)
641 \(add-to-list 'org-latex-packages-alist '\(\"\" \"minted\"))
643 In addition, it is necessary to install pygments
644 \(http://pygments.org), and to configure the variable
645 `org-latex-pdf-process' so that the -shell-escape option is
646 passed to pdflatex."
647 :group 'org-export-latex
648 :type '(choice
649 (const :tag "Use listings" t)
650 (const :tag "Use minted" 'minted)
651 (const :tag "Export verbatim" nil)))
653 (defcustom org-latex-listings-langs
654 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
655 (c "C") (cc "C++")
656 (fortran "fortran")
657 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
658 (html "HTML") (xml "XML")
659 (tex "TeX") (latex "[LaTeX]TeX")
660 (shell-script "bash")
661 (gnuplot "Gnuplot")
662 (ocaml "Caml") (caml "Caml")
663 (sql "SQL") (sqlite "sql"))
664 "Alist mapping languages to their listing language counterpart.
665 The key is a symbol, the major mode symbol without the \"-mode\".
666 The value is the string that should be inserted as the language
667 parameter for the listings package. If the mode name and the
668 listings name are the same, the language does not need an entry
669 in this list - but it does not hurt if it is present."
670 :group 'org-export-latex
671 :type '(repeat
672 (list
673 (symbol :tag "Major mode ")
674 (string :tag "Listings language"))))
676 (defcustom org-latex-listings-options nil
677 "Association list of options for the latex listings package.
679 These options are supplied as a comma-separated list to the
680 \\lstset command. Each element of the association list should be
681 a list containing two strings: the name of the option, and the
682 value. For example,
684 (setq org-latex-listings-options
685 '((\"basicstyle\" \"\\small\")
686 (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
688 will typeset the code in a small size font with underlined, bold
689 black keywords.
691 Note that the same options will be applied to blocks of all
692 languages."
693 :group 'org-export-latex
694 :type '(repeat
695 (list
696 (string :tag "Listings option name ")
697 (string :tag "Listings option value"))))
699 (defcustom org-latex-minted-langs
700 '((emacs-lisp "common-lisp")
701 (cc "c++")
702 (cperl "perl")
703 (shell-script "bash")
704 (caml "ocaml"))
705 "Alist mapping languages to their minted language counterpart.
706 The key is a symbol, the major mode symbol without the \"-mode\".
707 The value is the string that should be inserted as the language
708 parameter for the minted package. If the mode name and the
709 listings name are the same, the language does not need an entry
710 in this list - but it does not hurt if it is present.
712 Note that minted uses all lower case for language identifiers,
713 and that the full list of language identifiers can be obtained
714 with:
716 pygmentize -L lexers"
717 :group 'org-export-latex
718 :type '(repeat
719 (list
720 (symbol :tag "Major mode ")
721 (string :tag "Minted language"))))
723 (defcustom org-latex-minted-options nil
724 "Association list of options for the latex minted package.
726 These options are supplied within square brackets in
727 \\begin{minted} environments. Each element of the alist should
728 be a list containing two strings: the name of the option, and the
729 value. For example,
731 \(setq org-latex-minted-options
732 '\((\"bgcolor\" \"bg\") \(\"frame\" \"lines\")))
734 will result in src blocks being exported with
736 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
738 as the start of the minted environment. Note that the same
739 options will be applied to blocks of all languages."
740 :group 'org-export-latex
741 :type '(repeat
742 (list
743 (string :tag "Minted option name ")
744 (string :tag "Minted option value"))))
746 (defvar org-latex-custom-lang-environments nil
747 "Alist mapping languages to language-specific LaTeX environments.
749 It is used during export of src blocks by the listings and minted
750 latex packages. For example,
752 \(setq org-latex-custom-lang-environments
753 '\(\(python \"pythoncode\"\)\)\)
755 would have the effect that if org encounters begin_src python
756 during latex export it will output
758 \\begin{pythoncode}
759 <src block body>
760 \\end{pythoncode}")
763 ;;;; Compilation
765 (defcustom org-latex-pdf-process
766 '("pdflatex -interaction nonstopmode -output-directory %o %f"
767 "pdflatex -interaction nonstopmode -output-directory %o %f"
768 "pdflatex -interaction nonstopmode -output-directory %o %f")
769 "Commands to process a LaTeX file to a PDF file.
770 This is a list of strings, each of them will be given to the
771 shell as a command. %f in the command will be replaced by the
772 full file name, %b by the file base name (i.e. without directory
773 and extension parts) and %o by the base directory of the file.
775 The reason why this is a list is that it usually takes several
776 runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
777 does not have a clever mechanism to detect which of these
778 commands have to be run to get to a stable result, and it also
779 does not do any error checking.
781 By default, Org uses 3 runs of `pdflatex' to do the processing.
782 If you have texi2dvi on your system and if that does not cause
783 the infamous egrep/locale bug:
785 http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
787 then `texi2dvi' is the superior choice as it automates the LaTeX
788 build process by calling the \"correct\" combinations of
789 auxiliary programs. Org does offer `texi2dvi' as one of the
790 customize options. Alternatively, `rubber' and `latexmk' also
791 provide similar functionality. The latter supports `biber' out
792 of the box.
794 Alternatively, this may be a Lisp function that does the
795 processing, so you could use this to apply the machinery of
796 AUCTeX or the Emacs LaTeX mode. This function should accept the
797 file name as its single argument."
798 :group 'org-export-pdf
799 :type '(choice
800 (repeat :tag "Shell command sequence"
801 (string :tag "Shell command"))
802 (const :tag "2 runs of pdflatex"
803 ("pdflatex -interaction nonstopmode -output-directory %o %f"
804 "pdflatex -interaction nonstopmode -output-directory %o %f"))
805 (const :tag "3 runs of pdflatex"
806 ("pdflatex -interaction nonstopmode -output-directory %o %f"
807 "pdflatex -interaction nonstopmode -output-directory %o %f"
808 "pdflatex -interaction nonstopmode -output-directory %o %f"))
809 (const :tag "pdflatex,bibtex,pdflatex,pdflatex"
810 ("pdflatex -interaction nonstopmode -output-directory %o %f"
811 "bibtex %b"
812 "pdflatex -interaction nonstopmode -output-directory %o %f"
813 "pdflatex -interaction nonstopmode -output-directory %o %f"))
814 (const :tag "2 runs of xelatex"
815 ("xelatex -interaction nonstopmode -output-directory %o %f"
816 "xelatex -interaction nonstopmode -output-directory %o %f"))
817 (const :tag "3 runs of xelatex"
818 ("xelatex -interaction nonstopmode -output-directory %o %f"
819 "xelatex -interaction nonstopmode -output-directory %o %f"
820 "xelatex -interaction nonstopmode -output-directory %o %f"))
821 (const :tag "xelatex,bibtex,xelatex,xelatex"
822 ("xelatex -interaction nonstopmode -output-directory %o %f"
823 "bibtex %b"
824 "xelatex -interaction nonstopmode -output-directory %o %f"
825 "xelatex -interaction nonstopmode -output-directory %o %f"))
826 (const :tag "texi2dvi"
827 ("texi2dvi -p -b -V %f"))
828 (const :tag "rubber"
829 ("rubber -d --into %o %f"))
830 (const :tag "latexmk"
831 ("latexmk -g -pdf %f"))
832 (function)))
834 (defcustom org-latex-logfiles-extensions
835 '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
836 "The list of file extensions to consider as LaTeX logfiles.
837 The logfiles will be remove if `org-latex-remove-logfiles' is
838 non-nil."
839 :group 'org-export-latex
840 :type '(repeat (string :tag "Extension")))
842 (defcustom org-latex-remove-logfiles t
843 "Non-nil means remove the logfiles produced by PDF production.
844 By default, logfiles are files with these extensions: .aux, .idx,
845 .log, .out, .toc, .nav, .snm and .vrb. To define the set of
846 logfiles to remove, set `org-latex-logfiles-extensions'."
847 :group 'org-export-latex
848 :type 'boolean)
850 (defcustom org-latex-known-errors
851 '(("Reference.*?undefined" . "[undefined reference]")
852 ("Citation.*?undefined" . "[undefined citation]")
853 ("Undefined control sequence" . "[undefined control sequence]")
854 ("^! LaTeX.*?Error" . "[LaTeX error]")
855 ("^! Package.*?Error" . "[package error]")
856 ("Runaway argument" . "Runaway argument"))
857 "Alist of regular expressions and associated messages for the user.
858 The regular expressions are used to find possible errors in the
859 log of a latex-run."
860 :group 'org-export-latex
861 :version "24.4"
862 :package-version '(Org . "8.0")
863 :type '(repeat
864 (cons
865 (string :tag "Regexp")
866 (string :tag "Message"))))
870 ;;; Internal Functions
872 (defun org-latex--caption/label-string (element info)
873 "Return caption and label LaTeX string for ELEMENT.
875 INFO is a plist holding contextual information. If there's no
876 caption nor label, return the empty string.
878 For non-floats, see `org-latex--wrap-label'."
879 (let* ((label (org-element-property :name element))
880 (label-str (if (not (org-string-nw-p label)) ""
881 (format "\\label{%s}"
882 (org-export-solidify-link-text label))))
883 (main (org-export-get-caption element))
884 (short (org-export-get-caption element t)))
885 (cond
886 ((and (not main) (equal label-str "")) "")
887 ((not main) (concat label-str "\n"))
888 ;; Option caption format with short name.
889 (short (format "\\caption[%s]{%s%s}\n"
890 (org-export-data short info)
891 label-str
892 (org-export-data main info)))
893 ;; Standard caption format.
894 (t (format "\\caption{%s%s}\n" label-str (org-export-data main info))))))
896 (defun org-latex-guess-inputenc (header)
897 "Set the coding system in inputenc to what the buffer is.
899 HEADER is the LaTeX header string. This function only applies
900 when specified inputenc option is \"AUTO\".
902 Return the new header, as a string."
903 (let* ((cs (or (ignore-errors
904 (latexenc-coding-system-to-inputenc
905 (or org-export-coding-system buffer-file-coding-system)))
906 "utf8")))
907 (if (not cs) header
908 ;; First translate if that is requested.
909 (setq cs (or (cdr (assoc cs org-latex-inputenc-alist)) cs))
910 ;; Then find the \usepackage statement and replace the option.
911 (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
912 cs header t nil 1))))
914 (defun org-latex-guess-babel-language (header info)
915 "Set Babel's language according to LANGUAGE keyword.
917 HEADER is the LaTeX header string. INFO is the plist used as
918 a communication channel.
920 Insertion of guessed language only happens when Babel package has
921 explicitly been loaded. Then it is added to the rest of
922 package's options.
924 The argument to Babel may be \"AUTO\" which is then replaced with
925 the language of the document or `org-export-default-language'
926 unless language in question is already loaded.
928 Return the new header."
929 (let ((language-code (plist-get info :language)))
930 ;; If no language is set or Babel package is not loaded, return
931 ;; HEADER as-is.
932 (if (or (not (stringp language-code))
933 (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" header)))
934 header
935 (let ((options (save-match-data
936 (org-split-string (match-string 1 header) ",[ \t]*")))
937 (language (cdr (assoc language-code
938 org-latex-babel-language-alist))))
939 ;; If LANGUAGE is already loaded, return header without AUTO.
940 ;; Otherwise, replace AUTO with language or append language if
941 ;; AUTO is not present.
942 (replace-match
943 (mapconcat (lambda (option) (if (equal "AUTO" option) language option))
944 (cond ((member language options) (delete "AUTO" options))
945 ((member "AUTO" options) options)
946 (t (append options (list language))))
947 ", ")
948 t nil header 1)))))
950 (defun org-latex--find-verb-separator (s)
951 "Return a character not used in string S.
952 This is used to choose a separator for constructs like \\verb."
953 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
954 (loop for c across ll
955 when (not (string-match (regexp-quote (char-to-string c)) s))
956 return (char-to-string c))))
958 (defun org-latex--make-option-string (options)
959 "Return a comma separated string of keywords and values.
960 OPTIONS is an alist where the key is the options keyword as
961 a string, and the value a list containing the keyword value, or
962 nil."
963 (mapconcat (lambda (pair)
964 (concat (first pair)
965 (when (> (length (second pair)) 0)
966 (concat "=" (second pair)))))
967 options
968 ","))
970 (defun org-latex--wrap-label (element output)
971 "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
972 This function shouldn't be used for floats. See
973 `org-latex--caption/label-string'."
974 (let ((label (org-element-property :name element)))
975 (if (not (and (org-string-nw-p output) (org-string-nw-p label))) output
976 (concat (format "\\label{%s}\n" (org-export-solidify-link-text label))
977 output))))
979 (defun org-latex--text-markup (text markup)
980 "Format TEXT depending on MARKUP text markup.
981 See `org-latex-text-markup-alist' for details."
982 (let ((fmt (cdr (assq markup org-latex-text-markup-alist))))
983 (cond
984 ;; No format string: Return raw text.
985 ((not fmt) text)
986 ;; Handle the `verb' special case: Find and appropriate separator
987 ;; and use "\\verb" command.
988 ((eq 'verb fmt)
989 (let ((separator (org-latex--find-verb-separator text)))
990 (concat "\\verb" separator text separator)))
991 ;; Handle the `protectedtexttt' special case: Protect some
992 ;; special chars and use "\texttt{%s}" format string.
993 ((eq 'protectedtexttt fmt)
994 (let ((start 0)
995 (trans '(("\\" . "\\textbackslash{}")
996 ("~" . "\\textasciitilde{}")
997 ("^" . "\\textasciicircum{}")))
998 (rtn "")
999 char)
1000 (while (string-match "[\\{}$%&_#~^]" text)
1001 (setq char (match-string 0 text))
1002 (if (> (match-beginning 0) 0)
1003 (setq rtn (concat rtn (substring text 0 (match-beginning 0)))))
1004 (setq text (substring text (1+ (match-beginning 0))))
1005 (setq char (or (cdr (assoc char trans)) (concat "\\" char))
1006 rtn (concat rtn char)))
1007 (setq text (concat rtn text)
1008 fmt "\\texttt{%s}")
1009 (while (string-match "--" text)
1010 (setq text (replace-match "-{}-" t t text)))
1011 (format fmt text)))
1012 ;; Else use format string.
1013 (t (format fmt text)))))
1015 (defun org-latex--delayed-footnotes-definitions (element info)
1016 "Return footnotes definitions in ELEMENT as a string.
1018 INFO is a plist used as a communication channel.
1020 Footnotes definitions are returned within \"\\footnotetxt{}\"
1021 commands.
1023 This function is used within constructs that don't support
1024 \"\\footnote{}\" command (i.e. an item's tag). In that case,
1025 \"\\footnotemark\" is used within the construct and the function
1026 just outside of it."
1027 (mapconcat
1028 (lambda (ref)
1029 (format
1030 "\\footnotetext[%s]{%s}"
1031 (org-export-get-footnote-number ref info)
1032 (org-trim
1033 (org-export-data
1034 (org-export-get-footnote-definition ref info) info))))
1035 ;; Find every footnote reference in ELEMENT.
1036 (let* (all-refs
1037 search-refs ; For byte-compiler.
1038 (search-refs
1039 (function
1040 (lambda (data)
1041 ;; Return a list of all footnote references never seen
1042 ;; before in DATA.
1043 (org-element-map data 'footnote-reference
1044 (lambda (ref)
1045 (when (org-export-footnote-first-reference-p ref info)
1046 (push ref all-refs)
1047 (when (eq (org-element-property :type ref) 'standard)
1048 (funcall search-refs
1049 (org-export-get-footnote-definition ref info)))))
1050 info)
1051 (reverse all-refs)))))
1052 (funcall search-refs element))
1053 ""))
1057 ;;; Template
1059 (defun org-latex-template (contents info)
1060 "Return complete document string after LaTeX conversion.
1061 CONTENTS is the transcoded contents string. INFO is a plist
1062 holding export options."
1063 (let ((title (org-export-data (plist-get info :title) info)))
1064 (concat
1065 ;; Time-stamp.
1066 (and (plist-get info :time-stamp-file)
1067 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1068 ;; Document class and packages.
1069 (let ((class (plist-get info :latex-class))
1070 (class-options (plist-get info :latex-class-options)))
1071 (org-element-normalize-string
1072 (let* ((header (nth 1 (assoc class org-latex-classes)))
1073 (document-class-string
1074 (and (stringp header)
1075 (if (not class-options) header
1076 (replace-regexp-in-string
1077 "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
1078 class-options header t nil 1)))))
1079 (if (not document-class-string)
1080 (user-error "Unknown LaTeX class `%s'" class)
1081 (org-latex-guess-babel-language
1082 (org-latex-guess-inputenc
1083 (org-splice-latex-header
1084 document-class-string
1085 org-latex-default-packages-alist
1086 org-latex-packages-alist nil
1087 (concat (plist-get info :latex-header)
1088 (plist-get info :latex-header-extra))))
1089 info)))))
1090 ;; Possibly limit depth for headline numbering.
1091 (let ((sec-num (plist-get info :section-numbers)))
1092 (when (integerp sec-num)
1093 (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
1094 ;; Author.
1095 (let ((author (and (plist-get info :with-author)
1096 (let ((auth (plist-get info :author)))
1097 (and auth (org-export-data auth info)))))
1098 (email (and (plist-get info :with-email)
1099 (org-export-data (plist-get info :email) info))))
1100 (cond ((and author email (not (string= "" email)))
1101 (format "\\author{%s\\thanks{%s}}\n" author email))
1102 ((or author email) (format "\\author{%s}\n" (or author email)))))
1103 ;; Date.
1104 (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
1105 (format "\\date{%s}\n" (org-export-data date info)))
1106 ;; Title
1107 (format "\\title{%s}\n" title)
1108 ;; Hyperref options.
1109 (when (plist-get info :latex-hyperref-p)
1110 (format "\\hypersetup{\n pdfkeywords={%s},\n pdfsubject={%s},\n pdfcreator={%s}}\n"
1111 (or (plist-get info :keywords) "")
1112 (or (plist-get info :description) "")
1113 (if (not (plist-get info :with-creator)) ""
1114 (plist-get info :creator))))
1115 ;; Document start.
1116 "\\begin{document}\n\n"
1117 ;; Title command.
1118 (org-element-normalize-string
1119 (cond ((string= "" title) nil)
1120 ((not (stringp org-latex-title-command)) nil)
1121 ((string-match "\\(?:[^%]\\|^\\)%s"
1122 org-latex-title-command)
1123 (format org-latex-title-command title))
1124 (t org-latex-title-command)))
1125 ;; Table of contents.
1126 (let ((depth (plist-get info :with-toc)))
1127 (when depth
1128 (concat (when (wholenump depth)
1129 (format "\\setcounter{tocdepth}{%d}\n" depth))
1130 org-latex-toc-command)))
1131 ;; Document's body.
1132 contents
1133 ;; Creator.
1134 (let ((creator-info (plist-get info :with-creator)))
1135 (cond
1136 ((not creator-info) "")
1137 ((eq creator-info 'comment)
1138 (format "%% %s\n" (plist-get info :creator)))
1139 (t (concat (plist-get info :creator) "\n"))))
1140 ;; Document end.
1141 "\\end{document}")))
1145 ;;; Transcode Functions
1147 ;;;; Bold
1149 (defun org-latex-bold (bold contents info)
1150 "Transcode BOLD from Org to LaTeX.
1151 CONTENTS is the text with bold markup. INFO is a plist holding
1152 contextual information."
1153 (org-latex--text-markup contents 'bold))
1156 ;;;; Center Block
1158 (defun org-latex-center-block (center-block contents info)
1159 "Transcode a CENTER-BLOCK element from Org to LaTeX.
1160 CONTENTS holds the contents of the center block. INFO is a plist
1161 holding contextual information."
1162 (org-latex--wrap-label
1163 center-block
1164 (format "\\begin{center}\n%s\\end{center}" contents)))
1167 ;;;; Clock
1169 (defun org-latex-clock (clock contents info)
1170 "Transcode a CLOCK element from Org to LaTeX.
1171 CONTENTS is nil. INFO is a plist holding contextual
1172 information."
1173 (concat
1174 "\\noindent"
1175 (format "\\textbf{%s} " org-clock-string)
1176 (format org-latex-inactive-timestamp-format
1177 (concat (org-translate-time
1178 (org-element-property :raw-value
1179 (org-element-property :value clock)))
1180 (let ((time (org-element-property :duration clock)))
1181 (and time (format " (%s)" time)))))
1182 "\\\\"))
1185 ;;;; Code
1187 (defun org-latex-code (code contents info)
1188 "Transcode a CODE object from Org to LaTeX.
1189 CONTENTS is nil. INFO is a plist used as a communication
1190 channel."
1191 (org-latex--text-markup (org-element-property :value code) 'code))
1194 ;;;; Drawer
1196 (defun org-latex-drawer (drawer contents info)
1197 "Transcode a DRAWER element from Org to LaTeX.
1198 CONTENTS holds the contents of the block. INFO is a plist
1199 holding contextual information."
1200 (let* ((name (org-element-property :drawer-name drawer))
1201 (output (if (functionp org-latex-format-drawer-function)
1202 (funcall org-latex-format-drawer-function
1203 name contents)
1204 ;; If there's no user defined function: simply
1205 ;; display contents of the drawer.
1206 contents)))
1207 (org-latex--wrap-label drawer output)))
1210 ;;;; Dynamic Block
1212 (defun org-latex-dynamic-block (dynamic-block contents info)
1213 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
1214 CONTENTS holds the contents of the block. INFO is a plist
1215 holding contextual information. See `org-export-data'."
1216 (org-latex--wrap-label dynamic-block contents))
1219 ;;;; Entity
1221 (defun org-latex-entity (entity contents info)
1222 "Transcode an ENTITY object from Org to LaTeX.
1223 CONTENTS are the definition itself. INFO is a plist holding
1224 contextual information."
1225 (let ((ent (org-element-property :latex entity)))
1226 (if (org-element-property :latex-math-p entity) (format "$%s$" ent) ent)))
1229 ;;;; Example Block
1231 (defun org-latex-example-block (example-block contents info)
1232 "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
1233 CONTENTS is nil. INFO is a plist holding contextual
1234 information."
1235 (when (org-string-nw-p (org-element-property :value example-block))
1236 (org-latex--wrap-label
1237 example-block
1238 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1239 (org-export-format-code-default example-block info)))))
1242 ;;;; Export Block
1244 (defun org-latex-export-block (export-block contents info)
1245 "Transcode a EXPORT-BLOCK element from Org to LaTeX.
1246 CONTENTS is nil. INFO is a plist holding contextual information."
1247 (when (member (org-element-property :type export-block) '("LATEX" "TEX"))
1248 (org-remove-indentation (org-element-property :value export-block))))
1251 ;;;; Export Snippet
1253 (defun org-latex-export-snippet (export-snippet contents info)
1254 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
1255 CONTENTS is nil. INFO is a plist holding contextual information."
1256 (when (eq (org-export-snippet-backend export-snippet) 'latex)
1257 (org-element-property :value export-snippet)))
1260 ;;;; Fixed Width
1262 (defun org-latex-fixed-width (fixed-width contents info)
1263 "Transcode a FIXED-WIDTH element from Org to LaTeX.
1264 CONTENTS is nil. INFO is a plist holding contextual information."
1265 (org-latex--wrap-label
1266 fixed-width
1267 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1268 (org-remove-indentation
1269 (org-element-property :value fixed-width)))))
1272 ;;;; Footnote Reference
1274 (defun org-latex-footnote-reference (footnote-reference contents info)
1275 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1276 CONTENTS is nil. INFO is a plist holding contextual information."
1277 (concat
1278 ;; Insert separator between two footnotes in a row.
1279 (let ((prev (org-export-get-previous-element footnote-reference info)))
1280 (when (eq (org-element-type prev) 'footnote-reference)
1281 org-latex-footnote-separator))
1282 (cond
1283 ;; Use \footnotemark if the footnote has already been defined.
1284 ((not (org-export-footnote-first-reference-p footnote-reference info))
1285 (format "\\footnotemark[%s]{}"
1286 (org-export-get-footnote-number footnote-reference info)))
1287 ;; Use \footnotemark if reference is within another footnote
1288 ;; reference, footnote definition or table cell.
1289 ((loop for parent in (org-export-get-genealogy footnote-reference)
1290 thereis (memq (org-element-type parent)
1291 '(footnote-reference footnote-definition table-cell)))
1292 "\\footnotemark")
1293 ;; Otherwise, define it with \footnote command.
1295 (let ((def (org-export-get-footnote-definition footnote-reference info)))
1296 (concat
1297 (format "\\footnote{%s}" (org-trim (org-export-data def info)))
1298 ;; Retrieve all footnote references within the footnote and
1299 ;; add their definition after it, since LaTeX doesn't support
1300 ;; them inside.
1301 (org-latex--delayed-footnotes-definitions def info)))))))
1304 ;;;; Headline
1306 (defun org-latex-headline (headline contents info)
1307 "Transcode a HEADLINE element from Org to LaTeX.
1308 CONTENTS holds the contents of the headline. INFO is a plist
1309 holding contextual information."
1310 (unless (org-element-property :footnote-section-p headline)
1311 (let* ((class (plist-get info :latex-class))
1312 (level (org-export-get-relative-level headline info))
1313 (numberedp (org-export-numbered-headline-p headline info))
1314 (class-sectionning (assoc class org-latex-classes))
1315 ;; Section formatting will set two placeholders: one for
1316 ;; the title and the other for the contents.
1317 (section-fmt
1318 (let ((sec (if (functionp (nth 2 class-sectionning))
1319 (funcall (nth 2 class-sectionning) level numberedp)
1320 (nth (1+ level) class-sectionning))))
1321 (cond
1322 ;; No section available for that LEVEL.
1323 ((not sec) nil)
1324 ;; Section format directly returned by a function. Add
1325 ;; placeholder for contents.
1326 ((stringp sec) (concat sec "\n%s"))
1327 ;; (numbered-section . unnumbered-section)
1328 ((not (consp (cdr sec)))
1329 (concat (funcall (if numberedp #'car #'cdr) sec) "\n%s"))
1330 ;; (numbered-open numbered-close)
1331 ((= (length sec) 2)
1332 (when numberedp (concat (car sec) "\n%s" (nth 1 sec))))
1333 ;; (num-in num-out no-num-in no-num-out)
1334 ((= (length sec) 4)
1335 (if numberedp (concat (car sec) "\n%s" (nth 1 sec))
1336 (concat (nth 2 sec) "\n%s" (nth 3 sec)))))))
1337 (text (org-export-data (org-element-property :title headline) info))
1338 (todo
1339 (and (plist-get info :with-todo-keywords)
1340 (let ((todo (org-element-property :todo-keyword headline)))
1341 (and todo (org-export-data todo info)))))
1342 (todo-type (and todo (org-element-property :todo-type headline)))
1343 (tags (and (plist-get info :with-tags)
1344 (org-export-get-tags headline info)))
1345 (priority (and (plist-get info :with-priority)
1346 (org-element-property :priority headline)))
1347 ;; Create the headline text along with a no-tag version.
1348 ;; The latter is required to remove tags from toc.
1349 (full-text (funcall org-latex-format-headline-function
1350 todo todo-type priority text tags))
1351 ;; Associate \label to the headline for internal links.
1352 (headline-label
1353 (format "\\label{sec-%s}\n"
1354 (mapconcat 'number-to-string
1355 (org-export-get-headline-number headline info)
1356 "-")))
1357 (pre-blanks
1358 (make-string (org-element-property :pre-blank headline) 10)))
1359 (if (or (not section-fmt) (org-export-low-level-p headline info))
1360 ;; This is a deep sub-tree: export it as a list item. Also
1361 ;; export as items headlines for which no section format has
1362 ;; been found.
1363 (let ((low-level-body
1364 (concat
1365 ;; If headline is the first sibling, start a list.
1366 (when (org-export-first-sibling-p headline info)
1367 (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize)))
1368 ;; Itemize headline
1369 "\\item " full-text "\n" headline-label pre-blanks contents)))
1370 ;; If headline is not the last sibling simply return
1371 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
1372 ;; any blank line.
1373 (if (not (org-export-last-sibling-p headline info)) low-level-body
1374 (replace-regexp-in-string
1375 "[ \t\n]*\\'"
1376 (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize))
1377 low-level-body)))
1378 ;; This is a standard headline. Export it as a section. Add
1379 ;; an alternative heading when possible, and when this is not
1380 ;; identical to the usual heading.
1381 (let ((opt-title
1382 (funcall org-latex-format-headline-function
1383 todo todo-type priority
1384 (org-export-data
1385 (org-export-get-alt-title headline info) info)
1386 (and (eq (plist-get info :with-tags) t) tags))))
1387 (if (and numberedp opt-title
1388 (not (equal opt-title full-text))
1389 (string-match "\\`\\\\\\(.*?[^*]\\){" section-fmt))
1390 (format (replace-match "\\1[%s]" nil nil section-fmt 1)
1391 ;; Replace square brackets with parenthesis
1392 ;; since square brackets are not supported in
1393 ;; optional arguments.
1394 (replace-regexp-in-string
1395 "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title))
1396 full-text
1397 (concat headline-label pre-blanks contents))
1398 ;; Impossible to add an alternative heading. Fallback to
1399 ;; regular sectioning format string.
1400 (format section-fmt full-text
1401 (concat headline-label pre-blanks contents))))))))
1403 (defun org-latex-format-headline-default-function
1404 (todo todo-type priority text tags)
1405 "Default format function for a headline.
1406 See `org-latex-format-headline-function' for details."
1407 (concat
1408 (and todo (format "{\\bfseries\\sffamily %s} " todo))
1409 (and priority (format "\\framebox{\\#%c} " priority))
1410 text
1411 (and tags
1412 (format "\\hfill{}\\textsc{%s}" (mapconcat 'identity tags ":")))))
1415 ;;;; Horizontal Rule
1417 (defun org-latex-horizontal-rule (horizontal-rule contents info)
1418 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
1419 CONTENTS is nil. INFO is a plist holding contextual information."
1420 (let ((attr (org-export-read-attribute :attr_latex horizontal-rule))
1421 (prev (org-export-get-previous-element horizontal-rule info)))
1422 (concat
1423 ;; Make sure the rule doesn't start at the end of the current
1424 ;; line by separating it with a blank line from previous element.
1425 (when (and prev
1426 (let ((prev-blank (org-element-property :post-blank prev)))
1427 (or (not prev-blank) (zerop prev-blank))))
1428 "\n")
1429 (org-latex--wrap-label
1430 horizontal-rule
1431 (format "\\rule{%s}{%s}"
1432 (or (plist-get attr :width) "\\linewidth")
1433 (or (plist-get attr :thickness) "0.5pt"))))))
1436 ;;;; Inline Src Block
1438 (defun org-latex-inline-src-block (inline-src-block contents info)
1439 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
1440 CONTENTS holds the contents of the item. INFO is a plist holding
1441 contextual information."
1442 (let* ((code (org-element-property :value inline-src-block))
1443 (separator (org-latex--find-verb-separator code)))
1444 (cond
1445 ;; Do not use a special package: transcode it verbatim.
1446 ((not org-latex-listings)
1447 (concat "\\verb" separator code separator))
1448 ;; Use minted package.
1449 ((eq org-latex-listings 'minted)
1450 (let* ((org-lang (org-element-property :language inline-src-block))
1451 (mint-lang (or (cadr (assq (intern org-lang)
1452 org-latex-minted-langs))
1453 org-lang))
1454 (options (org-latex--make-option-string
1455 org-latex-minted-options)))
1456 (concat (format "\\mint%s{%s}"
1457 (if (string= options "") "" (format "[%s]" options))
1458 mint-lang)
1459 separator code separator)))
1460 ;; Use listings package.
1462 ;; Maybe translate language's name.
1463 (let* ((org-lang (org-element-property :language inline-src-block))
1464 (lst-lang (or (cadr (assq (intern org-lang)
1465 org-latex-listings-langs))
1466 org-lang))
1467 (options (org-latex--make-option-string
1468 (append org-latex-listings-options
1469 `(("language" ,lst-lang))))))
1470 (concat (format "\\lstinline[%s]" options)
1471 separator code separator))))))
1474 ;;;; Inlinetask
1476 (defun org-latex-inlinetask (inlinetask contents info)
1477 "Transcode an INLINETASK element from Org to LaTeX.
1478 CONTENTS holds the contents of the block. INFO is a plist
1479 holding contextual information."
1480 (let ((title (org-export-data (org-element-property :title inlinetask) info))
1481 (todo (and (plist-get info :with-todo-keywords)
1482 (let ((todo (org-element-property :todo-keyword inlinetask)))
1483 (and todo (org-export-data todo info)))))
1484 (todo-type (org-element-property :todo-type inlinetask))
1485 (tags (and (plist-get info :with-tags)
1486 (org-export-get-tags inlinetask info)))
1487 (priority (and (plist-get info :with-priority)
1488 (org-element-property :priority inlinetask))))
1489 ;; If `org-latex-format-inlinetask-function' is provided, call it
1490 ;; with appropriate arguments.
1491 (if (functionp org-latex-format-inlinetask-function)
1492 (funcall org-latex-format-inlinetask-function
1493 todo todo-type priority title tags contents)
1494 ;; Otherwise, use a default template.
1495 (org-latex--wrap-label
1496 inlinetask
1497 (let ((full-title
1498 (concat
1499 (when todo (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
1500 (when priority (format "\\framebox{\\#%c} " priority))
1501 title
1502 (when tags (format "\\hfill{}\\textsc{:%s:}"
1503 (mapconcat 'identity tags ":"))))))
1504 (format (concat "\\begin{center}\n"
1505 "\\fbox{\n"
1506 "\\begin{minipage}[c]{.6\\textwidth}\n"
1507 "%s\n\n"
1508 "\\rule[.8em]{\\textwidth}{2pt}\n\n"
1509 "%s"
1510 "\\end{minipage}\n"
1511 "}\n"
1512 "\\end{center}")
1513 full-title contents))))))
1516 ;;;; Italic
1518 (defun org-latex-italic (italic contents info)
1519 "Transcode ITALIC from Org to LaTeX.
1520 CONTENTS is the text with italic markup. INFO is a plist holding
1521 contextual information."
1522 (org-latex--text-markup contents 'italic))
1525 ;;;; Item
1527 (defun org-latex-item (item contents info)
1528 "Transcode an ITEM element from Org to LaTeX.
1529 CONTENTS holds the contents of the item. INFO is a plist holding
1530 contextual information."
1531 (let* ((counter
1532 (let ((count (org-element-property :counter item))
1533 (level
1534 ;; Determine level of current item to determine the
1535 ;; correct LaTeX counter to use (enumi, enumii...).
1536 (let ((parent item) (level 0))
1537 (while (memq (org-element-type
1538 (setq parent (org-export-get-parent parent)))
1539 '(plain-list item))
1540 (when (and (eq (org-element-type parent) 'plain-list)
1541 (eq (org-element-property :type parent)
1542 'ordered))
1543 (incf level)))
1544 level)))
1545 (and count
1546 (< level 5)
1547 (format "\\setcounter{enum%s}{%s}\n"
1548 (nth (1- level) '("i" "ii" "iii" "iv"))
1549 (1- count)))))
1550 (checkbox (case (org-element-property :checkbox item)
1551 (on "$\\boxtimes$ ")
1552 (off "$\\Box$ ")
1553 (trans "$\\boxminus$ ")))
1554 (tag (let ((tag (org-element-property :tag item)))
1555 ;; Check-boxes must belong to the tag.
1556 (and tag (format "[{%s}] "
1557 (concat checkbox
1558 (org-export-data tag info)))))))
1559 (concat counter "\\item" (or tag (concat " " checkbox))
1560 (and contents (org-trim contents))
1561 ;; If there are footnotes references in tag, be sure to
1562 ;; add their definition at the end of the item. This
1563 ;; workaround is necessary since "\footnote{}" command is
1564 ;; not supported in tags.
1565 (and tag
1566 (org-latex--delayed-footnotes-definitions
1567 (org-element-property :tag item) info)))))
1570 ;;;; Keyword
1572 (defun org-latex-keyword (keyword contents info)
1573 "Transcode a KEYWORD element from Org to LaTeX.
1574 CONTENTS is nil. INFO is a plist holding contextual information."
1575 (let ((key (org-element-property :key keyword))
1576 (value (org-element-property :value keyword)))
1577 (cond
1578 ((string= key "LATEX") value)
1579 ((string= key "INDEX") (format "\\index{%s}" value))
1580 ((string= key "TOC")
1581 (let ((value (downcase value)))
1582 (cond
1583 ((string-match "\\<headlines\\>" value)
1584 (let ((depth (or (and (string-match "[0-9]+" value)
1585 (string-to-number (match-string 0 value)))
1586 (plist-get info :with-toc))))
1587 (concat
1588 (when (wholenump depth)
1589 (format "\\setcounter{tocdepth}{%s}\n" depth))
1590 "\\tableofcontents")))
1591 ((string= "tables" value) "\\listoftables")
1592 ((string= "listings" value)
1593 (cond
1594 ((eq org-latex-listings 'minted) "\\listoflistings")
1595 (org-latex-listings "\\lstlistoflistings")
1596 ;; At the moment, src blocks with a caption are wrapped
1597 ;; into a figure environment.
1598 (t "\\listoffigures")))))))))
1601 ;;;; Latex Environment
1603 (defun org-latex-latex-environment (latex-environment contents info)
1604 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
1605 CONTENTS is nil. INFO is a plist holding contextual information."
1606 (when (plist-get info :with-latex)
1607 (let ((label (org-element-property :name latex-environment))
1608 (value (org-remove-indentation
1609 (org-element-property :value latex-environment))))
1610 (if (not (org-string-nw-p label)) value
1611 ;; Environment is labelled: label must be within the environment
1612 ;; (otherwise, a reference pointing to that element will count
1613 ;; the section instead).
1614 (with-temp-buffer
1615 (insert value)
1616 (goto-char (point-min))
1617 (forward-line)
1618 (insert
1619 (format "\\label{%s}\n" (org-export-solidify-link-text label)))
1620 (buffer-string))))))
1623 ;;;; Latex Fragment
1625 (defun org-latex-latex-fragment (latex-fragment contents info)
1626 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
1627 CONTENTS is nil. INFO is a plist holding contextual information."
1628 (when (plist-get info :with-latex)
1629 (org-element-property :value latex-fragment)))
1632 ;;;; Line Break
1634 (defun org-latex-line-break (line-break contents info)
1635 "Transcode a LINE-BREAK object from Org to LaTeX.
1636 CONTENTS is nil. INFO is a plist holding contextual information."
1637 "\\\\\n")
1640 ;;;; Link
1642 (defun org-latex--inline-image (link info)
1643 "Return LaTeX code for an inline image.
1644 LINK is the link pointing to the inline image. INFO is a plist
1645 used as a communication channel."
1646 (let* ((parent (org-export-get-parent-element link))
1647 (path (let ((raw-path (org-element-property :path link)))
1648 (if (not (file-name-absolute-p raw-path)) raw-path
1649 (expand-file-name raw-path))))
1650 (filetype (file-name-extension path))
1651 (caption (org-latex--caption/label-string parent info))
1652 ;; Retrieve latex attributes from the element around.
1653 (attr (org-export-read-attribute :attr_latex parent))
1654 (float (let ((float (plist-get attr :float)))
1655 (cond ((and (not float) (plist-member attr :float)) nil)
1656 ((string= float "wrap") 'wrap)
1657 ((string= float "multicolumn") 'multicolumn)
1658 ((or float (org-element-property :caption parent))
1659 'figure))))
1660 (placement
1661 (let ((place (plist-get attr :placement)))
1662 (cond (place (format "%s" place))
1663 ((eq float 'wrap) "{l}{0.5\\textwidth}")
1664 ((eq float 'figure)
1665 (format "[%s]" org-latex-default-figure-position))
1666 (t ""))))
1667 (comment-include (if (plist-get attr :comment-include) "%" ""))
1668 ;; It is possible to specify width and height in the
1669 ;; ATTR_LATEX line, and also via default variables.
1670 (width (cond ((plist-get attr :width))
1671 ((plist-get attr :height) "")
1672 ((eq float 'wrap) "0.48\\textwidth")
1673 (t org-latex-image-default-width)))
1674 (height (cond ((plist-get attr :height))
1675 ((or (plist-get attr :width)
1676 (memq float '(figure wrap))) "")
1677 (t org-latex-image-default-height)))
1678 (options (let ((opt (or (plist-get attr :options)
1679 org-latex-image-default-option)))
1680 (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt)) opt
1681 (match-string 1 opt))))
1682 image-code)
1683 (if (member filetype '("tikz" "pgf"))
1684 ;; For tikz images:
1685 ;; - use \input to read in image file.
1686 ;; - if options are present, wrap in a tikzpicture environment.
1687 ;; - if width or height are present, use \resizebox to change
1688 ;; the image size.
1689 (progn
1690 (setq image-code (format "\\input{%s}" path))
1691 (when (org-string-nw-p options)
1692 (setq image-code
1693 (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
1694 options
1695 image-code)))
1696 (when (or (org-string-nw-p width) (org-string-nw-p height))
1697 (setq image-code (format "\\resizebox{%s}{%s}{%s}"
1698 (if (org-string-nw-p width) width "!")
1699 (if (org-string-nw-p height) height "!")
1700 image-code))))
1701 ;; For other images:
1702 ;; - add width and height to options.
1703 ;; - include the image with \includegraphics.
1704 (when (org-string-nw-p width)
1705 (setq options (concat options ",width=" width)))
1706 (when (org-string-nw-p height)
1707 (setq options (concat options ",height=" height)))
1708 (setq image-code
1709 (format "\\includegraphics%s{%s}"
1710 (cond ((not (org-string-nw-p options)) "")
1711 ((= (aref options 0) ?,)
1712 (format "[%s]"(substring options 1)))
1713 (t (format "[%s]" options)))
1714 path)))
1715 ;; Return proper string, depending on FLOAT.
1716 (case float
1717 (wrap (format "\\begin{wrapfigure}%s
1718 \\centering
1719 %s%s
1720 %s\\end{wrapfigure}" placement comment-include image-code caption))
1721 (multicolumn (format "\\begin{figure*}%s
1722 \\centering
1723 %s%s
1724 %s\\end{figure*}" placement comment-include image-code caption))
1725 (figure (format "\\begin{figure}%s
1726 \\centering
1727 %s%s
1728 %s\\end{figure}" placement comment-include image-code caption))
1729 (otherwise image-code))))
1731 (defun org-latex-link (link desc info)
1732 "Transcode a LINK object from Org to LaTeX.
1734 DESC is the description part of the link, or the empty string.
1735 INFO is a plist holding contextual information. See
1736 `org-export-data'."
1737 (let* ((type (org-element-property :type link))
1738 (raw-path (org-element-property :path link))
1739 ;; Ensure DESC really exists, or set it to nil.
1740 (desc (and (not (string= desc "")) desc))
1741 (imagep (org-export-inline-image-p
1742 link org-latex-inline-image-rules))
1743 (path (cond
1744 ((member type '("http" "https" "ftp" "mailto"))
1745 (concat type ":" raw-path))
1746 ((string= type "file")
1747 (if (not (file-name-absolute-p raw-path)) raw-path
1748 (concat "file://" (expand-file-name raw-path))))
1749 (t raw-path)))
1750 protocol)
1751 (cond
1752 ;; Image file.
1753 (imagep (org-latex--inline-image link info))
1754 ;; Radio link: Transcode target's contents and use them as link's
1755 ;; description.
1756 ((string= type "radio")
1757 (let ((destination (org-export-resolve-radio-link link info)))
1758 (when destination
1759 (format "\\hyperref[%s]{%s}"
1760 (org-export-solidify-link-text path)
1761 (org-export-data (org-element-contents destination) info)))))
1762 ;; Links pointing to a headline: Find destination and build
1763 ;; appropriate referencing command.
1764 ((member type '("custom-id" "fuzzy" "id"))
1765 (let ((destination (if (string= type "fuzzy")
1766 (org-export-resolve-fuzzy-link link info)
1767 (org-export-resolve-id-link link info))))
1768 (case (org-element-type destination)
1769 ;; Id link points to an external file.
1770 (plain-text
1771 (if desc (format "\\href{%s}{%s}" destination desc)
1772 (format "\\url{%s}" destination)))
1773 ;; Fuzzy link points nowhere.
1774 ('nil
1775 (format org-latex-link-with-unknown-path-format
1776 (or desc
1777 (org-export-data
1778 (org-element-property :raw-link link) info))))
1779 ;; LINK points to a headline. If headlines are numbered
1780 ;; and the link has no description, display headline's
1781 ;; number. Otherwise, display description or headline's
1782 ;; title.
1783 (headline
1784 (let ((label
1785 (format "sec-%s"
1786 (mapconcat
1787 'number-to-string
1788 (org-export-get-headline-number destination info)
1789 "-"))))
1790 (if (and (plist-get info :section-numbers) (not desc))
1791 (format "\\ref{%s}" label)
1792 (format "\\hyperref[%s]{%s}" label
1793 (or desc
1794 (org-export-data
1795 (org-element-property :title destination) info))))))
1796 ;; Fuzzy link points to a target. Do as above.
1797 (otherwise
1798 (let ((path (org-export-solidify-link-text path)))
1799 (if (not desc) (format "\\ref{%s}" path)
1800 (format "\\hyperref[%s]{%s}" path desc)))))))
1801 ;; Coderef: replace link with the reference name or the
1802 ;; equivalent line number.
1803 ((string= type "coderef")
1804 (format (org-export-get-coderef-format path desc)
1805 (org-export-resolve-coderef path info)))
1806 ;; Link type is handled by a special function.
1807 ((functionp (setq protocol (nth 2 (assoc type org-link-protocols))))
1808 (funcall protocol (org-link-unescape path) desc 'latex))
1809 ;; External link with a description part.
1810 ((and path desc) (format "\\href{%s}{%s}" path desc))
1811 ;; External link without a description part.
1812 (path (format "\\url{%s}" path))
1813 ;; No path, only description. Try to do something useful.
1814 (t (format org-latex-link-with-unknown-path-format desc)))))
1817 ;;;; Paragraph
1819 (defun org-latex-paragraph (paragraph contents info)
1820 "Transcode a PARAGRAPH element from Org to LaTeX.
1821 CONTENTS is the contents of the paragraph, as a string. INFO is
1822 the plist used as a communication channel."
1823 contents)
1826 ;;;; Plain List
1828 (defun org-latex-plain-list (plain-list contents info)
1829 "Transcode a PLAIN-LIST element from Org to LaTeX.
1830 CONTENTS is the contents of the list. INFO is a plist holding
1831 contextual information."
1832 (let* ((type (org-element-property :type plain-list))
1833 (attr (org-export-read-attribute :attr_latex plain-list))
1834 (latex-type (let ((env (plist-get attr :environment)))
1835 (cond (env (format "%s" env))
1836 ((eq type 'ordered) "enumerate")
1837 ((eq type 'unordered) "itemize")
1838 ((eq type 'descriptive) "description")))))
1839 (org-latex--wrap-label
1840 plain-list
1841 (format "\\begin{%s}%s\n%s\\end{%s}"
1842 latex-type
1843 ;; Put optional arguments, if any inside square brackets
1844 ;; when necessary.
1845 (let ((options (format "%s" (or (plist-get attr :options) ""))))
1846 (cond ((equal options "") "")
1847 ((string-match "\\`\\[.*\\]\\'" options) options)
1848 (t (format "[%s]" options))))
1849 contents
1850 latex-type))))
1853 ;;;; Plain Text
1855 (defun org-latex-plain-text (text info)
1856 "Transcode a TEXT string from Org to LaTeX.
1857 TEXT is the string to transcode. INFO is a plist holding
1858 contextual information."
1859 (let ((specialp (plist-get info :with-special-strings))
1860 (output text))
1861 ;; Protect %, #, &, $, _, { and }.
1862 (while (string-match "\\([^\\]\\|^\\)\\([%$#&{}_]\\)" output)
1863 (setq output
1864 (replace-match
1865 (format "\\%s" (match-string 2 output)) nil t output 2)))
1866 ;; Protect ^.
1867 (setq output
1868 (replace-regexp-in-string
1869 "\\([^\\]\\|^\\)\\(\\^\\)" "\\\\^{}" output nil nil 2))
1870 ;; Protect \. If special strings are used, be careful not to
1871 ;; protect "\" in "\-" constructs.
1872 (let ((symbols (if specialp "-%$#&{}^_\\" "%$#&{}^_\\")))
1873 (setq output
1874 (replace-regexp-in-string
1875 (format "\\(?:[^\\]\\|^\\)\\(\\\\\\)\\(?:[^%s]\\|$\\)" symbols)
1876 "$\\backslash$" output nil t 1)))
1877 ;; Protect ~.
1878 (setq output
1879 (replace-regexp-in-string
1880 "\\([^\\]\\|^\\)\\(~\\)" "\\textasciitilde{}" output nil t 2))
1881 ;; Activate smart quotes. Be sure to provide original TEXT string
1882 ;; since OUTPUT may have been modified.
1883 (when (plist-get info :with-smart-quotes)
1884 (setq output (org-export-activate-smart-quotes output :latex info text)))
1885 ;; LaTeX into \LaTeX{} and TeX into \TeX{}.
1886 (let ((case-fold-search nil)
1887 (start 0))
1888 (while (string-match "\\<\\(\\(?:La\\)?TeX\\)\\>" output start)
1889 (setq output (replace-match
1890 (format "\\%s{}" (match-string 1 output)) nil t output)
1891 start (match-end 0))))
1892 ;; Convert special strings.
1893 (when specialp
1894 (setq output
1895 (replace-regexp-in-string "\\.\\.\\." "\\ldots{}" output nil t)))
1896 ;; Handle break preservation if required.
1897 (when (plist-get info :preserve-breaks)
1898 (setq output (replace-regexp-in-string
1899 "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n" output)))
1900 ;; Return value.
1901 output))
1904 ;;;; Planning
1906 (defun org-latex-planning (planning contents info)
1907 "Transcode a PLANNING element from Org to LaTeX.
1908 CONTENTS is nil. INFO is a plist holding contextual
1909 information."
1910 (concat
1911 "\\noindent"
1912 (mapconcat
1913 'identity
1914 (delq nil
1915 (list
1916 (let ((closed (org-element-property :closed planning)))
1917 (when closed
1918 (concat
1919 (format "\\textbf{%s} " org-closed-string)
1920 (format org-latex-inactive-timestamp-format
1921 (org-translate-time
1922 (org-element-property :raw-value closed))))))
1923 (let ((deadline (org-element-property :deadline planning)))
1924 (when deadline
1925 (concat
1926 (format "\\textbf{%s} " org-deadline-string)
1927 (format org-latex-active-timestamp-format
1928 (org-translate-time
1929 (org-element-property :raw-value deadline))))))
1930 (let ((scheduled (org-element-property :scheduled planning)))
1931 (when scheduled
1932 (concat
1933 (format "\\textbf{%s} " org-scheduled-string)
1934 (format org-latex-active-timestamp-format
1935 (org-translate-time
1936 (org-element-property :raw-value scheduled))))))))
1937 " ")
1938 "\\\\"))
1941 ;;;; Quote Block
1943 (defun org-latex-quote-block (quote-block contents info)
1944 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
1945 CONTENTS holds the contents of the block. INFO is a plist
1946 holding contextual information."
1947 (org-latex--wrap-label
1948 quote-block
1949 (format "\\begin{quote}\n%s\\end{quote}" contents)))
1952 ;;;; Quote Section
1954 (defun org-latex-quote-section (quote-section contents info)
1955 "Transcode a QUOTE-SECTION element from Org to LaTeX.
1956 CONTENTS is nil. INFO is a plist holding contextual information."
1957 (let ((value (org-remove-indentation
1958 (org-element-property :value quote-section))))
1959 (when value (format "\\begin{verbatim}\n%s\\end{verbatim}" value))))
1962 ;;;; Radio Target
1964 (defun org-latex-radio-target (radio-target text info)
1965 "Transcode a RADIO-TARGET object from Org to LaTeX.
1966 TEXT is the text of the target. INFO is a plist holding
1967 contextual information."
1968 (format "\\label{%s}%s"
1969 (org-export-solidify-link-text
1970 (org-element-property :value radio-target))
1971 text))
1974 ;;;; Section
1976 (defun org-latex-section (section contents info)
1977 "Transcode a SECTION element from Org to LaTeX.
1978 CONTENTS holds the contents of the section. INFO is a plist
1979 holding contextual information."
1980 contents)
1983 ;;;; Special Block
1985 (defun org-latex-special-block (special-block contents info)
1986 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
1987 CONTENTS holds the contents of the block. INFO is a plist
1988 holding contextual information."
1989 (let ((type (downcase (org-element-property :type special-block)))
1990 (opt (org-export-read-attribute :attr_latex special-block :options)))
1991 (concat (format "\\begin{%s}%s\n" type (or opt ""))
1992 ;; Insert any label or caption within the block
1993 ;; (otherwise, a reference pointing to that element will
1994 ;; count the section instead).
1995 (org-latex--caption/label-string special-block info)
1996 contents
1997 (format "\\end{%s}" type))))
2000 ;;;; Src Block
2002 (defun org-latex-src-block (src-block contents info)
2003 "Transcode a SRC-BLOCK element from Org to LaTeX.
2004 CONTENTS holds the contents of the item. INFO is a plist holding
2005 contextual information."
2006 (when (org-string-nw-p (org-element-property :value src-block))
2007 (let* ((lang (org-element-property :language src-block))
2008 (caption (org-element-property :caption src-block))
2009 (label (org-element-property :name src-block))
2010 (custom-env (and lang
2011 (cadr (assq (intern lang)
2012 org-latex-custom-lang-environments))))
2013 (num-start (case (org-element-property :number-lines src-block)
2014 (continued (org-export-get-loc src-block info))
2015 (new 0)))
2016 (retain-labels (org-element-property :retain-labels src-block))
2017 (attributes (org-export-read-attribute :attr_latex src-block))
2018 (float (plist-get attributes :float)))
2019 (cond
2020 ;; Case 1. No source fontification.
2021 ((not org-latex-listings)
2022 (let* ((caption-str (org-latex--caption/label-string src-block info))
2023 (float-env
2024 (cond ((and (not float) (plist-member attributes :float)) "%s")
2025 ((string= "multicolumn" float)
2026 (format "\\begin{figure*}[%s]\n%s%%s\n\\end{figure*}"
2027 org-latex-default-figure-position
2028 caption-str))
2029 ((or caption float)
2030 (format "\\begin{figure}[H]\n%s%%s\n\\end{figure}"
2031 caption-str))
2032 (t "%s"))))
2033 (format
2034 float-env
2035 (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
2036 (org-export-format-code-default src-block info))))))
2037 ;; Case 2. Custom environment.
2038 (custom-env (format "\\begin{%s}\n%s\\end{%s}\n"
2039 custom-env
2040 (org-export-format-code-default src-block info)
2041 custom-env))
2042 ;; Case 3. Use minted package.
2043 ((eq org-latex-listings 'minted)
2044 (let* ((caption-str (org-latex--caption/label-string src-block info))
2045 (float-env
2046 (cond ((and (not float) (plist-member attributes :float)) "%s")
2047 ((string= "multicolumn" float)
2048 (format "\\begin{listing*}\n%%s\n%s\\end{listing*}"
2049 caption-str))
2050 ((or caption float)
2051 (format "\\begin{listing}[H]\n%%s\n%s\\end{listing}"
2052 caption-str))
2053 (t "%s")))
2054 (body
2055 (format
2056 "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2057 ;; Options.
2058 (org-latex--make-option-string
2059 (if (or (not num-start)
2060 (assoc "linenos" org-latex-minted-options))
2061 org-latex-minted-options
2062 (append
2063 `(("linenos")
2064 ("firstnumber" ,(number-to-string (1+ num-start))))
2065 org-latex-minted-options)))
2066 ;; Language.
2067 (or (cadr (assq (intern lang) org-latex-minted-langs)) lang)
2068 ;; Source code.
2069 (let* ((code-info (org-export-unravel-code src-block))
2070 (max-width
2071 (apply 'max
2072 (mapcar 'length
2073 (org-split-string (car code-info)
2074 "\n")))))
2075 (org-export-format-code
2076 (car code-info)
2077 (lambda (loc num ref)
2078 (concat
2080 (when ref
2081 ;; Ensure references are flushed to the right,
2082 ;; separated with 6 spaces from the widest line
2083 ;; of code.
2084 (concat (make-string (+ (- max-width (length loc)) 6)
2085 ?\s)
2086 (format "(%s)" ref)))))
2087 nil (and retain-labels (cdr code-info)))))))
2088 ;; Return value.
2089 (format float-env body)))
2090 ;; Case 4. Use listings package.
2092 (let ((lst-lang
2093 (or (cadr (assq (intern lang) org-latex-listings-langs)) lang))
2094 (caption-str
2095 (when caption
2096 (let ((main (org-export-get-caption src-block))
2097 (secondary (org-export-get-caption src-block t)))
2098 (if (not secondary)
2099 (format "{%s}" (org-export-data main info))
2100 (format "{[%s]%s}"
2101 (org-export-data secondary info)
2102 (org-export-data main info)))))))
2103 (concat
2104 ;; Options.
2105 (format
2106 "\\lstset{%s}\n"
2107 (org-latex--make-option-string
2108 (append
2109 org-latex-listings-options
2110 (cond
2111 ((and (not float) (plist-member attributes :float)) nil)
2112 ((string= "multicolumn" float) '(("float" "*")))
2113 ((and float (not (assoc "float" org-latex-listings-options)))
2114 `(("float" ,org-latex-default-figure-position))))
2115 `(("language" ,lst-lang))
2116 (when label `(("label" ,label)))
2117 (when caption-str `(("caption" ,caption-str)))
2118 (cond ((assoc "numbers" org-latex-listings-options) nil)
2119 ((not num-start) '(("numbers" "none")))
2120 ((zerop num-start) '(("numbers" "left")))
2121 (t `(("numbers" "left")
2122 ("firstnumber"
2123 ,(number-to-string (1+ num-start)))))))))
2124 ;; Source code.
2125 (format
2126 "\\begin{lstlisting}\n%s\\end{lstlisting}"
2127 (let* ((code-info (org-export-unravel-code src-block))
2128 (max-width
2129 (apply 'max
2130 (mapcar 'length
2131 (org-split-string (car code-info) "\n")))))
2132 (org-export-format-code
2133 (car code-info)
2134 (lambda (loc num ref)
2135 (concat
2137 (when ref
2138 ;; Ensure references are flushed to the right,
2139 ;; separated with 6 spaces from the widest line of
2140 ;; code
2141 (concat (make-string (+ (- max-width (length loc)) 6) ? )
2142 (format "(%s)" ref)))))
2143 nil (and retain-labels (cdr code-info))))))))))))
2146 ;;;; Statistics Cookie
2148 (defun org-latex-statistics-cookie (statistics-cookie contents info)
2149 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
2150 CONTENTS is nil. INFO is a plist holding contextual information."
2151 (replace-regexp-in-string
2152 "%" "\\%" (org-element-property :value statistics-cookie) nil t))
2155 ;;;; Strike-Through
2157 (defun org-latex-strike-through (strike-through contents info)
2158 "Transcode STRIKE-THROUGH from Org to LaTeX.
2159 CONTENTS is the text with strike-through markup. INFO is a plist
2160 holding contextual information."
2161 (org-latex--text-markup contents 'strike-through))
2164 ;;;; Subscript
2166 (defun org-latex--script-size (object info)
2167 "Transcode a subscript or superscript object.
2168 OBJECT is an Org object. INFO is a plist used as a communication
2169 channel."
2170 (let ((in-script-p
2171 ;; Non-nil if object is already in a sub/superscript.
2172 (let ((parent object))
2173 (catch 'exit
2174 (while (setq parent (org-export-get-parent parent))
2175 (let ((type (org-element-type parent)))
2176 (cond ((memq type '(subscript superscript))
2177 (throw 'exit t))
2178 ((memq type org-element-all-elements)
2179 (throw 'exit nil))))))))
2180 (type (org-element-type object))
2181 (output ""))
2182 (org-element-map (org-element-contents object)
2183 (cons 'plain-text org-element-all-objects)
2184 (lambda (obj)
2185 (case (org-element-type obj)
2186 ((entity latex-fragment)
2187 (let ((data (org-trim (org-export-data obj info))))
2188 (string-match
2189 "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
2190 data)
2191 (setq output
2192 (concat output
2193 (match-string 1 data)
2194 (let ((blank (org-element-property :post-blank obj)))
2195 (and blank (> blank 0) "\\ "))))))
2196 (plain-text
2197 (setq output
2198 (format "%s\\text{%s}" output (org-export-data obj info))))
2199 (otherwise
2200 (setq output
2201 (concat output
2202 (org-export-data obj info)
2203 (let ((blank (org-element-property :post-blank obj)))
2204 (and blank (> blank 0) "\\ ")))))))
2205 info nil org-element-recursive-objects)
2206 ;; Result. Do not wrap into math mode if already in a subscript
2207 ;; or superscript. Do not wrap into curly brackets if OUTPUT is
2208 ;; a single character. Also merge consecutive subscript and
2209 ;; superscript into the same math snippet.
2210 (concat (and (not in-script-p)
2211 (let ((prev (org-export-get-previous-element object info)))
2212 (or (not prev)
2213 (not (eq (org-element-type prev)
2214 (if (eq type 'subscript) 'superscript
2215 'subscript)))
2216 (let ((blank (org-element-property :post-blank prev)))
2217 (and blank (> blank 0)))))
2218 "$")
2219 (if (eq (org-element-type object) 'subscript) "_" "^")
2220 (and (> (length output) 1) "{")
2221 output
2222 (and (> (length output) 1) "}")
2223 (and (not in-script-p)
2224 (or (let ((blank (org-element-property :post-blank object)))
2225 (and blank (> blank 0)))
2226 (not (eq (org-element-type
2227 (org-export-get-next-element object info))
2228 (if (eq type 'subscript) 'superscript
2229 'subscript))))
2230 "$"))))
2232 (defun org-latex-subscript (subscript contents info)
2233 "Transcode a SUBSCRIPT object from Org to LaTeX.
2234 CONTENTS is the contents of the object. INFO is a plist holding
2235 contextual information."
2236 (org-latex--script-size subscript info))
2239 ;;;; Superscript
2241 (defun org-latex-superscript (superscript contents info)
2242 "Transcode a SUPERSCRIPT object from Org to LaTeX.
2243 CONTENTS is the contents of the object. INFO is a plist holding
2244 contextual information."
2245 (org-latex--script-size superscript info))
2248 ;;;; Table
2250 ;; `org-latex-table' is the entry point for table transcoding. It
2251 ;; takes care of tables with a "verbatim" mode. Otherwise, it
2252 ;; delegates the job to either `org-latex--table.el-table',
2253 ;; `org-latex--org-table' or `org-latex--math-table' functions,
2254 ;; depending of the type of the table and the mode requested.
2256 ;; `org-latex--align-string' is a subroutine used to build alignment
2257 ;; string for Org tables.
2259 (defun org-latex-table (table contents info)
2260 "Transcode a TABLE element from Org to LaTeX.
2261 CONTENTS is the contents of the table. INFO is a plist holding
2262 contextual information."
2263 (if (eq (org-element-property :type table) 'table.el)
2264 ;; "table.el" table. Convert it using appropriate tools.
2265 (org-latex--table.el-table table info)
2266 (let ((type (or (org-export-read-attribute :attr_latex table :mode)
2267 org-latex-default-table-mode)))
2268 (cond
2269 ;; Case 1: Verbatim table.
2270 ((string= type "verbatim")
2271 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
2272 ;; Re-create table, without affiliated keywords.
2273 (org-trim (org-element-interpret-data
2274 `(table nil ,@(org-element-contents table))))))
2275 ;; Case 2: Matrix.
2276 ((or (string= type "math") (string= type "inline-math"))
2277 (org-latex--math-table table info))
2278 ;; Case 3: Standard table.
2279 (t (concat (org-latex--org-table table contents info)
2280 ;; When there are footnote references within the
2281 ;; table, insert their definition just after it.
2282 (org-latex--delayed-footnotes-definitions table info)))))))
2284 (defun org-latex--align-string (table info)
2285 "Return an appropriate LaTeX alignment string.
2286 TABLE is the considered table. INFO is a plist used as
2287 a communication channel."
2288 (or (org-export-read-attribute :attr_latex table :align)
2289 (let (align)
2290 ;; Extract column groups and alignment from first (non-rule)
2291 ;; row.
2292 (org-element-map
2293 (org-element-map table 'table-row
2294 (lambda (row)
2295 (and (eq (org-element-property :type row) 'standard) row))
2296 info 'first-match)
2297 'table-cell
2298 (lambda (cell)
2299 (let ((borders (org-export-table-cell-borders cell info)))
2300 ;; Check left border for the first cell only.
2301 (when (and (memq 'left borders) (not align))
2302 (push "|" align))
2303 (push (case (org-export-table-cell-alignment cell info)
2304 (left "l")
2305 (right "r")
2306 (center "c"))
2307 align)
2308 (when (memq 'right borders) (push "|" align))))
2309 info)
2310 (apply 'concat (nreverse align)))))
2312 (defun org-latex--org-table (table contents info)
2313 "Return appropriate LaTeX code for an Org table.
2315 TABLE is the table type element to transcode. CONTENTS is its
2316 contents, as a string. INFO is a plist used as a communication
2317 channel.
2319 This function assumes TABLE has `org' as its `:type' property and
2320 `table' as its `:mode' attribute."
2321 (let* ((caption (org-latex--caption/label-string table info))
2322 (attr (org-export-read-attribute :attr_latex table))
2323 ;; Determine alignment string.
2324 (alignment (org-latex--align-string table info))
2325 ;; Determine environment for the table: longtable, tabular...
2326 (table-env (or (plist-get attr :environment)
2327 org-latex-default-table-environment))
2328 ;; If table is a float, determine environment: table, table*
2329 ;; or sidewaystable.
2330 (float-env (unless (member table-env '("longtable" "longtabu"))
2331 (let ((float (plist-get attr :float)))
2332 (cond
2333 ((and (not float) (plist-member attr :float)) nil)
2334 ((string= float "sidewaystable") "sidewaystable")
2335 ((string= float "multicolumn") "table*")
2336 ((or float (org-element-property :caption table))
2337 "table")))))
2338 ;; Extract others display options.
2339 (fontsize (let ((font (plist-get attr :font)))
2340 (and font (concat font "\n"))))
2341 (width (plist-get attr :width))
2342 (spreadp (plist-get attr :spread))
2343 (placement (or (plist-get attr :placement)
2344 (format "[%s]" org-latex-default-figure-position)))
2345 (centerp (if (plist-member attr :center) (plist-get attr :center)
2346 org-latex-tables-centered)))
2347 ;; Prepare the final format string for the table.
2348 (cond
2349 ;; Longtable.
2350 ((equal "longtable" table-env)
2351 (concat (and fontsize (concat "{" fontsize))
2352 (format "\\begin{longtable}{%s}\n" alignment)
2353 (and org-latex-table-caption-above
2354 (org-string-nw-p caption)
2355 (concat caption "\\\\\n"))
2356 contents
2357 (and (not org-latex-table-caption-above)
2358 (org-string-nw-p caption)
2359 (concat caption "\\\\\n"))
2360 "\\end{longtable}\n"
2361 (and fontsize "}")))
2362 ;; Longtabu
2363 ((equal "longtabu" table-env)
2364 (concat (and fontsize (concat "{" fontsize))
2365 (format "\\begin{longtabu}%s{%s}\n"
2366 (if width
2367 (format " %s %s "
2368 (if spreadp "spread" "to") width) "")
2369 alignment)
2370 (and org-latex-table-caption-above
2371 (org-string-nw-p caption)
2372 (concat caption "\\\\\n"))
2373 contents
2374 (and (not org-latex-table-caption-above)
2375 (org-string-nw-p caption)
2376 (concat caption "\\\\\n"))
2377 "\\end{longtabu}\n"
2378 (and fontsize "}")))
2379 ;; Others.
2380 (t (concat (cond
2381 (float-env
2382 (concat (format "\\begin{%s}%s\n" float-env placement)
2383 (if org-latex-table-caption-above caption "")
2384 (when centerp "\\centering\n")
2385 fontsize))
2386 (centerp (concat "\\begin{center}\n" fontsize))
2387 (fontsize (concat "{" fontsize)))
2388 (cond ((equal "tabu" table-env)
2389 (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
2390 (if width (format
2391 (if spreadp " spread %s " " to %s ")
2392 width) "")
2393 alignment
2394 contents))
2395 (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
2396 table-env
2397 (if width (format "{%s}" width) "")
2398 alignment
2399 contents
2400 table-env)))
2401 (cond
2402 (float-env
2403 (concat (if org-latex-table-caption-above "" caption)
2404 (format "\n\\end{%s}" float-env)))
2405 (centerp "\n\\end{center}")
2406 (fontsize "}")))))))
2408 (defun org-latex--table.el-table (table info)
2409 "Return appropriate LaTeX code for a table.el table.
2411 TABLE is the table type element to transcode. INFO is a plist
2412 used as a communication channel.
2414 This function assumes TABLE has `table.el' as its `:type'
2415 property."
2416 (require 'table)
2417 ;; Ensure "*org-export-table*" buffer is empty.
2418 (with-current-buffer (get-buffer-create "*org-export-table*")
2419 (erase-buffer))
2420 (let ((output (with-temp-buffer
2421 (insert (org-element-property :value table))
2422 (goto-char 1)
2423 (re-search-forward "^[ \t]*|[^|]" nil t)
2424 (table-generate-source 'latex "*org-export-table*")
2425 (with-current-buffer "*org-export-table*"
2426 (org-trim (buffer-string))))))
2427 (kill-buffer (get-buffer "*org-export-table*"))
2428 ;; Remove left out comments.
2429 (while (string-match "^%.*\n" output)
2430 (setq output (replace-match "" t t output)))
2431 (let ((attr (org-export-read-attribute :attr_latex table)))
2432 (when (plist-get attr :rmlines)
2433 ;; When the "rmlines" attribute is provided, remove all hlines
2434 ;; but the the one separating heading from the table body.
2435 (let ((n 0) (pos 0))
2436 (while (and (< (length output) pos)
2437 (setq pos (string-match "^\\\\hline\n?" output pos)))
2438 (incf n)
2439 (unless (= n 2) (setq output (replace-match "" nil nil output))))))
2440 (let ((centerp (if (plist-member attr :center) (plist-get attr :center)
2441 org-latex-tables-centered)))
2442 (if (not centerp) output
2443 (format "\\begin{center}\n%s\n\\end{center}" output))))))
2445 (defun org-latex--math-table (table info)
2446 "Return appropriate LaTeX code for a matrix.
2448 TABLE is the table type element to transcode. INFO is a plist
2449 used as a communication channel.
2451 This function assumes TABLE has `org' as its `:type' property and
2452 `inline-math' or `math' as its `:mode' attribute.."
2453 (let* ((caption (org-latex--caption/label-string table info))
2454 (attr (org-export-read-attribute :attr_latex table))
2455 (inlinep (equal (plist-get attr :mode) "inline-math"))
2456 (env (or (plist-get attr :environment)
2457 org-latex-default-table-environment))
2458 (contents
2459 (mapconcat
2460 (lambda (row)
2461 ;; Ignore horizontal rules.
2462 (when (eq (org-element-property :type row) 'standard)
2463 ;; Return each cell unmodified.
2464 (concat
2465 (mapconcat
2466 (lambda (cell)
2467 (substring (org-element-interpret-data cell) 0 -1))
2468 (org-element-map row 'table-cell 'identity info) "&")
2469 (or (cdr (assoc env org-latex-table-matrix-macros)) "\\\\")
2470 "\n")))
2471 (org-element-map table 'table-row 'identity info) ""))
2472 ;; Variables related to math clusters (contiguous math tables
2473 ;; of the same type).
2474 (mode (org-export-read-attribute :attr_latex table :mode))
2475 (prev (org-export-get-previous-element table info))
2476 (next (org-export-get-next-element table info))
2477 (same-mode-p
2478 (lambda (table)
2479 ;; Non-nil when TABLE has the same mode as current table.
2480 (string= (or (org-export-read-attribute :attr_latex table :mode)
2481 org-latex-default-table-mode)
2482 mode))))
2483 (concat
2484 ;; Opening string. If TABLE is in the middle of a table cluster,
2485 ;; do not insert any.
2486 (cond ((and prev
2487 (eq (org-element-type prev) 'table)
2488 (memq (org-element-property :post-blank prev) '(0 nil))
2489 (funcall same-mode-p prev))
2490 nil)
2491 (inlinep "\\(")
2492 ((org-string-nw-p caption) (concat "\\begin{equation}\n" caption))
2493 (t "\\["))
2494 ;; Prefix.
2495 (or (plist-get attr :math-prefix) "")
2496 ;; Environment. Also treat special cases.
2497 (cond ((equal env "array")
2498 (let ((align (org-latex--align-string table info)))
2499 (format "\\begin{array}{%s}\n%s\\end{array}" align contents)))
2500 ((assoc env org-latex-table-matrix-macros)
2501 (format "\\%s%s{\n%s}"
2503 (or (plist-get attr :math-arguments) "")
2504 contents))
2505 (t (format "\\begin{%s}\n%s\\end{%s}" env contents env)))
2506 ;; Suffix.
2507 (or (plist-get attr :math-suffix) "")
2508 ;; Closing string. If TABLE is in the middle of a table cluster,
2509 ;; do not insert any. If it closes such a cluster, be sure to
2510 ;; close the cluster with a string matching the opening string.
2511 (cond ((and next
2512 (eq (org-element-type next) 'table)
2513 (memq (org-element-property :post-blank table) '(0 nil))
2514 (funcall same-mode-p next))
2515 nil)
2516 (inlinep "\\)")
2517 ;; Find cluster beginning to know which environment to use.
2518 ((let ((cluster-beg table) prev)
2519 (while (and (setq prev (org-export-get-previous-element
2520 cluster-beg info))
2521 (memq (org-element-property :post-blank prev)
2522 '(0 nil))
2523 (funcall same-mode-p prev))
2524 (setq cluster-beg prev))
2525 (and (or (org-element-property :caption cluster-beg)
2526 (org-element-property :name cluster-beg))
2527 "\n\\end{equation}")))
2528 (t "\\]")))))
2531 ;;;; Table Cell
2533 (defun org-latex-table-cell (table-cell contents info)
2534 "Transcode a TABLE-CELL element from Org to LaTeX.
2535 CONTENTS is the cell contents. INFO is a plist used as
2536 a communication channel."
2537 (concat (if (and contents
2538 org-latex-table-scientific-notation
2539 (string-match orgtbl-exp-regexp contents))
2540 ;; Use appropriate format string for scientific
2541 ;; notation.
2542 (format org-latex-table-scientific-notation
2543 (match-string 1 contents)
2544 (match-string 2 contents))
2545 contents)
2546 (when (org-export-get-next-element table-cell info) " & ")))
2549 ;;;; Table Row
2551 (defun org-latex-table-row (table-row contents info)
2552 "Transcode a TABLE-ROW element from Org to LaTeX.
2553 CONTENTS is the contents of the row. INFO is a plist used as
2554 a communication channel."
2555 ;; Rules are ignored since table separators are deduced from
2556 ;; borders of the current row.
2557 (when (eq (org-element-property :type table-row) 'standard)
2558 (let* ((attr (org-export-read-attribute :attr_latex
2559 (org-export-get-parent table-row)))
2560 (longtablep (member (or (plist-get attr :environment)
2561 org-latex-default-table-environment)
2562 '("longtable" "longtabu")))
2563 (booktabsp (if (plist-member attr :booktabs)
2564 (plist-get attr :booktabs)
2565 org-latex-tables-booktabs))
2566 ;; TABLE-ROW's borders are extracted from its first cell.
2567 (borders (org-export-table-cell-borders
2568 (car (org-element-contents table-row)) info)))
2569 (concat
2570 ;; When BOOKTABS are activated enforce top-rule even when no
2571 ;; hline was specifically marked.
2572 (cond ((and booktabsp (memq 'top borders)) "\\toprule\n")
2573 ((and (memq 'top borders) (memq 'above borders)) "\\hline\n"))
2574 contents "\\\\\n"
2575 (cond
2576 ;; Special case for long tables. Define header and footers.
2577 ((and longtablep (org-export-table-row-ends-header-p table-row info))
2578 (format "%s
2579 \\endhead
2580 %s\\multicolumn{%d}{r}{Continued on next page} \\\\
2581 \\endfoot
2582 \\endlastfoot"
2583 (if booktabsp "\\midrule" "\\hline")
2584 (if booktabsp "\\midrule" "\\hline")
2585 ;; Number of columns.
2586 (cdr (org-export-table-dimensions
2587 (org-export-get-parent-table table-row) info))))
2588 ;; When BOOKTABS are activated enforce bottom rule even when
2589 ;; no hline was specifically marked.
2590 ((and booktabsp (memq 'bottom borders)) "\\bottomrule")
2591 ((and (memq 'bottom borders) (memq 'below borders)) "\\hline")
2592 ((memq 'below borders) (if booktabsp "\\midrule" "\\hline")))))))
2595 ;;;; Target
2597 (defun org-latex-target (target contents info)
2598 "Transcode a TARGET object from Org to LaTeX.
2599 CONTENTS is nil. INFO is a plist holding contextual
2600 information."
2601 (format "\\label{%s}"
2602 (org-export-solidify-link-text (org-element-property :value target))))
2605 ;;;; Timestamp
2607 (defun org-latex-timestamp (timestamp contents info)
2608 "Transcode a TIMESTAMP object from Org to LaTeX.
2609 CONTENTS is nil. INFO is a plist holding contextual
2610 information."
2611 (let ((value (org-latex-plain-text
2612 (org-timestamp-translate timestamp) info)))
2613 (case (org-element-property :type timestamp)
2614 ((active active-range) (format org-latex-active-timestamp-format value))
2615 ((inactive inactive-range)
2616 (format org-latex-inactive-timestamp-format value))
2617 (otherwise (format org-latex-diary-timestamp-format value)))))
2620 ;;;; Underline
2622 (defun org-latex-underline (underline contents info)
2623 "Transcode UNDERLINE from Org to LaTeX.
2624 CONTENTS is the text with underline markup. INFO is a plist
2625 holding contextual information."
2626 (org-latex--text-markup contents 'underline))
2629 ;;;; Verbatim
2631 (defun org-latex-verbatim (verbatim contents info)
2632 "Transcode a VERBATIM object from Org to LaTeX.
2633 CONTENTS is nil. INFO is a plist used as a communication
2634 channel."
2635 (org-latex--text-markup (org-element-property :value verbatim) 'verbatim))
2638 ;;;; Verse Block
2640 (defun org-latex-verse-block (verse-block contents info)
2641 "Transcode a VERSE-BLOCK element from Org to LaTeX.
2642 CONTENTS is verse block contents. INFO is a plist holding
2643 contextual information."
2644 (org-latex--wrap-label
2645 verse-block
2646 ;; In a verse environment, add a line break to each newline
2647 ;; character and change each white space at beginning of a line
2648 ;; into a space of 1 em. Also change each blank line with
2649 ;; a vertical space of 1 em.
2650 (progn
2651 (setq contents (replace-regexp-in-string
2652 "^ *\\\\\\\\$" "\\\\vspace*{1em}"
2653 (replace-regexp-in-string
2654 "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n" contents)))
2655 (while (string-match "^[ \t]+" contents)
2656 (let ((new-str (format "\\hspace*{%dem}"
2657 (length (match-string 0 contents)))))
2658 (setq contents (replace-match new-str nil t contents))))
2659 (format "\\begin{verse}\n%s\\end{verse}" contents))))
2663 ;;; End-user functions
2665 ;;;###autoload
2666 (defun org-latex-export-as-latex
2667 (&optional async subtreep visible-only body-only ext-plist)
2668 "Export current buffer as a LaTeX buffer.
2670 If narrowing is active in the current buffer, only export its
2671 narrowed part.
2673 If a region is active, export that region.
2675 A non-nil optional argument ASYNC means the process should happen
2676 asynchronously. The resulting buffer should be accessible
2677 through the `org-export-stack' interface.
2679 When optional argument SUBTREEP is non-nil, export the sub-tree
2680 at point, extracting information from the headline properties
2681 first.
2683 When optional argument VISIBLE-ONLY is non-nil, don't export
2684 contents of hidden elements.
2686 When optional argument BODY-ONLY is non-nil, only write code
2687 between \"\\begin{document}\" and \"\\end{document}\".
2689 EXT-PLIST, when provided, is a property list with external
2690 parameters overriding Org default settings, but still inferior to
2691 file-local settings.
2693 Export is done in a buffer named \"*Org LATEX Export*\", which
2694 will be displayed when `org-export-show-temporary-export-buffer'
2695 is non-nil."
2696 (interactive)
2697 (if async
2698 (org-export-async-start
2699 (lambda (output)
2700 (with-current-buffer (get-buffer-create "*Org LATEX Export*")
2701 (erase-buffer)
2702 (insert output)
2703 (goto-char (point-min))
2704 (LaTeX-mode)
2705 (org-export-add-to-stack (current-buffer) 'latex)))
2706 `(org-export-as 'latex ,subtreep ,visible-only ,body-only
2707 ',ext-plist))
2708 (let ((outbuf
2709 (org-export-to-buffer 'latex "*Org LATEX Export*"
2710 subtreep visible-only body-only ext-plist)))
2711 (with-current-buffer outbuf (LaTeX-mode))
2712 (when org-export-show-temporary-export-buffer
2713 (switch-to-buffer-other-window outbuf)))))
2715 ;;;###autoload
2716 (defun org-latex-convert-region-to-latex ()
2717 "Assume the current region has org-mode syntax, and convert it to LaTeX.
2718 This can be used in any buffer. For example, you can write an
2719 itemized list in org-mode syntax in an LaTeX buffer and use this
2720 command to convert it."
2721 (interactive)
2722 (org-export-replace-region-by 'latex))
2724 ;;;###autoload
2725 (defun org-latex-export-to-latex
2726 (&optional async subtreep visible-only body-only ext-plist)
2727 "Export current buffer to a LaTeX file.
2729 If narrowing is active in the current buffer, only export its
2730 narrowed part.
2732 If a region is active, export that region.
2734 A non-nil optional argument ASYNC means the process should happen
2735 asynchronously. The resulting file should be accessible through
2736 the `org-export-stack' interface.
2738 When optional argument SUBTREEP is non-nil, export the sub-tree
2739 at point, extracting information from the headline properties
2740 first.
2742 When optional argument VISIBLE-ONLY is non-nil, don't export
2743 contents of hidden elements.
2745 When optional argument BODY-ONLY is non-nil, only write code
2746 between \"\\begin{document}\" and \"\\end{document}\".
2748 EXT-PLIST, when provided, is a property list with external
2749 parameters overriding Org default settings, but still inferior to
2750 file-local settings.
2752 Return output file's name."
2753 (interactive)
2754 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
2755 (if async
2756 (org-export-async-start
2757 (lambda (f) (org-export-add-to-stack f 'latex))
2758 `(expand-file-name
2759 (org-export-to-file
2760 'latex ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))
2761 (org-export-to-file
2762 'latex outfile subtreep visible-only body-only ext-plist))))
2764 ;;;###autoload
2765 (defun org-latex-export-to-pdf
2766 (&optional async subtreep visible-only body-only ext-plist)
2767 "Export current buffer to LaTeX then process through to PDF.
2769 If narrowing is active in the current buffer, only export its
2770 narrowed part.
2772 If a region is active, export that region.
2774 A non-nil optional argument ASYNC means the process should happen
2775 asynchronously. The resulting file should be accessible through
2776 the `org-export-stack' interface.
2778 When optional argument SUBTREEP is non-nil, export the sub-tree
2779 at point, extracting information from the headline properties
2780 first.
2782 When optional argument VISIBLE-ONLY is non-nil, don't export
2783 contents of hidden elements.
2785 When optional argument BODY-ONLY is non-nil, only write code
2786 between \"\\begin{document}\" and \"\\end{document}\".
2788 EXT-PLIST, when provided, is a property list with external
2789 parameters overriding Org default settings, but still inferior to
2790 file-local settings.
2792 Return PDF file's name."
2793 (interactive)
2794 (if async
2795 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
2796 (org-export-async-start
2797 (lambda (f) (org-export-add-to-stack f 'latex))
2798 `(expand-file-name
2799 (org-latex-compile
2800 (org-export-to-file
2801 'latex ,outfile ,subtreep ,visible-only ,body-only
2802 ',ext-plist)))))
2803 (org-latex-compile
2804 (org-latex-export-to-latex
2805 nil subtreep visible-only body-only ext-plist))))
2807 (defun org-latex-compile (texfile &optional snippet)
2808 "Compile a TeX file.
2810 TEXFILE is the name of the file being compiled. Processing is
2811 done through the command specified in `org-latex-pdf-process'.
2813 When optional argument SNIPPET is non-nil, TEXFILE is a temporary
2814 file used to preview a LaTeX snippet. In this case, do not
2815 create a log buffer and do not bother removing log files.
2817 Return PDF file name or an error if it couldn't be produced."
2818 (let* ((base-name (file-name-sans-extension (file-name-nondirectory texfile)))
2819 (full-name (file-truename texfile))
2820 (out-dir (file-name-directory texfile))
2821 ;; Properly set working directory for compilation.
2822 (default-directory (if (file-name-absolute-p texfile)
2823 (file-name-directory full-name)
2824 default-directory))
2825 errors)
2826 (unless snippet (message (format "Processing LaTeX file %s..." texfile)))
2827 (save-window-excursion
2828 (cond
2829 ;; A function is provided: Apply it.
2830 ((functionp org-latex-pdf-process)
2831 (funcall org-latex-pdf-process (shell-quote-argument texfile)))
2832 ;; A list is provided: Replace %b, %f and %o with appropriate
2833 ;; values in each command before applying it. Output is
2834 ;; redirected to "*Org PDF LaTeX Output*" buffer.
2835 ((consp org-latex-pdf-process)
2836 (let ((outbuf (and (not snippet)
2837 (get-buffer-create "*Org PDF LaTeX Output*"))))
2838 (mapc
2839 (lambda (command)
2840 (shell-command
2841 (replace-regexp-in-string
2842 "%b" (shell-quote-argument base-name)
2843 (replace-regexp-in-string
2844 "%f" (shell-quote-argument full-name)
2845 (replace-regexp-in-string
2846 "%o" (shell-quote-argument out-dir) command t t) t t) t t)
2847 outbuf))
2848 org-latex-pdf-process)
2849 ;; Collect standard errors from output buffer.
2850 (setq errors (and (not snippet) (org-latex--collect-errors outbuf)))))
2851 (t (error "No valid command to process to PDF")))
2852 (let ((pdffile (concat out-dir base-name ".pdf")))
2853 ;; Check for process failure. Provide collected errors if
2854 ;; possible.
2855 (if (not (file-exists-p pdffile))
2856 (error (concat (format "PDF file %s wasn't produced" pdffile)
2857 (when errors (concat ": " errors))))
2858 ;; Else remove log files, when specified, and signal end of
2859 ;; process to user, along with any error encountered.
2860 (when (and (not snippet) org-latex-remove-logfiles)
2861 (dolist (ext org-latex-logfiles-extensions)
2862 (let ((file (concat out-dir base-name "." ext)))
2863 (when (file-exists-p file) (delete-file file)))))
2864 (message (concat "Process completed"
2865 (if (not errors) "."
2866 (concat " with errors: " errors)))))
2867 ;; Return output file name.
2868 pdffile))))
2870 (defun org-latex--collect-errors (buffer)
2871 "Collect some kind of errors from \"pdflatex\" command output.
2873 BUFFER is the buffer containing output.
2875 Return collected error types as a string, or nil if there was
2876 none."
2877 (with-current-buffer buffer
2878 (save-excursion
2879 (goto-char (point-max))
2880 (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t)
2881 (let ((case-fold-search t)
2882 (errors ""))
2883 (dolist (latex-error org-latex-known-errors)
2884 (when (save-excursion (re-search-forward (car latex-error) nil t))
2885 (setq errors (concat errors " " (cdr latex-error)))))
2886 (and (org-string-nw-p errors) (org-trim errors)))))))
2888 ;;;###autoload
2889 (defun org-latex-publish-to-latex (plist filename pub-dir)
2890 "Publish an Org file to LaTeX.
2892 FILENAME is the filename of the Org file to be published. PLIST
2893 is the property list for the given project. PUB-DIR is the
2894 publishing directory.
2896 Return output file name."
2897 (org-publish-org-to 'latex filename ".tex" plist pub-dir))
2899 ;;;###autoload
2900 (defun org-latex-publish-to-pdf (plist filename pub-dir)
2901 "Publish an Org file to PDF (via LaTeX).
2903 FILENAME is the filename of the Org file to be published. PLIST
2904 is the property list for the given project. PUB-DIR is the
2905 publishing directory.
2907 Return output file name."
2908 ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
2909 ;; in working directory and then moved to publishing directory.
2910 (org-publish-attachment
2911 plist
2912 (org-latex-compile (org-publish-org-to 'latex filename ".tex" plist))
2913 pub-dir))
2916 (provide 'ox-latex)
2918 ;; Local variables:
2919 ;; generated-autoload-file: "org-loaddefs.el"
2920 ;; End:
2922 ;;; ox-latex.el ends here