org-eww: Fix docstrings
[org-mode/org-tableheadings.git] / lisp / ox-latex.el
blob01bc8ddb6cf25cbf2c493bd5e82e782c640b9234
1 ;;; ox-latex.el --- LaTeX Back-End for Org Export Engine -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2011-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; See Org manual for details.
27 ;;; Code:
29 (require 'cl-lib)
30 (require 'ox)
31 (require 'ox-publish)
33 (defvar org-latex-default-packages-alist)
34 (defvar org-latex-packages-alist)
35 (defvar orgtbl-exp-regexp)
39 ;;; Define Back-End
41 (org-export-define-backend 'latex
42 '((bold . org-latex-bold)
43 (center-block . org-latex-center-block)
44 (clock . org-latex-clock)
45 (code . org-latex-code)
46 (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 (node-property . org-latex-node-property)
67 (paragraph . org-latex-paragraph)
68 (plain-list . org-latex-plain-list)
69 (plain-text . org-latex-plain-text)
70 (planning . org-latex-planning)
71 (property-drawer . org-latex-property-drawer)
72 (quote-block . org-latex-quote-block)
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 ;; Pseudo objects and elements.
91 (latex-math-block . org-latex-math-block)
92 (latex-matrices . org-latex-matrices))
93 :menu-entry
94 '(?l "Export to LaTeX"
95 ((?L "As LaTeX buffer" org-latex-export-as-latex)
96 (?l "As LaTeX file" org-latex-export-to-latex)
97 (?p "As PDF file" org-latex-export-to-pdf)
98 (?o "As PDF file and open"
99 (lambda (a s v b)
100 (if a (org-latex-export-to-pdf t s v b)
101 (org-open-file (org-latex-export-to-pdf nil s v b)))))))
102 :filters-alist '((:filter-options . org-latex-math-block-options-filter)
103 (:filter-parse-tree org-latex-math-block-tree-filter
104 org-latex-matrices-tree-filter))
105 :options-alist
106 '((:latex-class "LATEX_CLASS" nil org-latex-default-class t)
107 (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t)
108 (:latex-header "LATEX_HEADER" nil nil newline)
109 (:latex-header-extra "LATEX_HEADER_EXTRA" nil nil newline)
110 (:description "DESCRIPTION" nil nil parse)
111 (:keywords "KEYWORDS" nil nil parse)
112 (:subtitle "SUBTITLE" nil nil parse)
113 ;; Other variables.
114 (:latex-active-timestamp-format nil nil org-latex-active-timestamp-format)
115 (:latex-caption-above nil nil org-latex-caption-above)
116 (:latex-classes nil nil org-latex-classes)
117 (:latex-default-figure-position nil nil org-latex-default-figure-position)
118 (:latex-default-table-environment nil nil org-latex-default-table-environment)
119 (:latex-default-table-mode nil nil org-latex-default-table-mode)
120 (:latex-diary-timestamp-format nil nil org-latex-diary-timestamp-format)
121 (:latex-footnote-defined-format nil nil org-latex-footnote-defined-format)
122 (:latex-footnote-separator nil nil org-latex-footnote-separator)
123 (:latex-format-drawer-function nil nil org-latex-format-drawer-function)
124 (:latex-format-headline-function nil nil org-latex-format-headline-function)
125 (:latex-format-inlinetask-function nil nil org-latex-format-inlinetask-function)
126 (:latex-hyperref-template nil nil org-latex-hyperref-template t)
127 (:latex-image-default-height nil nil org-latex-image-default-height)
128 (:latex-image-default-option nil nil org-latex-image-default-option)
129 (:latex-image-default-width nil nil org-latex-image-default-width)
130 (:latex-images-centered nil nil org-latex-images-centered)
131 (:latex-inactive-timestamp-format nil nil org-latex-inactive-timestamp-format)
132 (:latex-inline-image-rules nil nil org-latex-inline-image-rules)
133 (:latex-link-with-unknown-path-format nil nil org-latex-link-with-unknown-path-format)
134 (:latex-listings nil nil org-latex-listings)
135 (:latex-listings-langs nil nil org-latex-listings-langs)
136 (:latex-listings-options nil nil org-latex-listings-options)
137 (:latex-minted-langs nil nil org-latex-minted-langs)
138 (:latex-minted-options nil nil org-latex-minted-options)
139 (:latex-prefer-user-labels nil nil org-latex-prefer-user-labels)
140 (:latex-subtitle-format nil nil org-latex-subtitle-format)
141 (:latex-subtitle-separate nil nil org-latex-subtitle-separate)
142 (:latex-table-scientific-notation nil nil org-latex-table-scientific-notation)
143 (:latex-tables-booktabs nil nil org-latex-tables-booktabs)
144 (:latex-tables-centered nil nil org-latex-tables-centered)
145 (:latex-text-markup-alist nil nil org-latex-text-markup-alist)
146 (:latex-title-command nil nil org-latex-title-command)
147 (:latex-toc-command nil nil org-latex-toc-command)
148 (:latex-compiler "LATEX_COMPILER" nil org-latex-compiler)
149 ;; Redefine regular options.
150 (:date "DATE" nil "\\today" parse)))
154 ;;; Internal Variables
156 (defconst org-latex-babel-language-alist
157 '(("af" . "afrikaans")
158 ("bg" . "bulgarian")
159 ("bt-br" . "brazilian")
160 ("ca" . "catalan")
161 ("cs" . "czech")
162 ("cy" . "welsh")
163 ("da" . "danish")
164 ("de" . "germanb")
165 ("de-at" . "naustrian")
166 ("de-de" . "ngerman")
167 ("el" . "greek")
168 ("en" . "english")
169 ("en-au" . "australian")
170 ("en-ca" . "canadian")
171 ("en-gb" . "british")
172 ("en-ie" . "irish")
173 ("en-nz" . "newzealand")
174 ("en-us" . "american")
175 ("es" . "spanish")
176 ("et" . "estonian")
177 ("eu" . "basque")
178 ("fi" . "finnish")
179 ("fr" . "frenchb")
180 ("fr-ca" . "canadien")
181 ("gl" . "galician")
182 ("hr" . "croatian")
183 ("hu" . "hungarian")
184 ("id" . "indonesian")
185 ("is" . "icelandic")
186 ("it" . "italian")
187 ("la" . "latin")
188 ("ms" . "malay")
189 ("nl" . "dutch")
190 ("nb" . "norsk")
191 ("nn" . "nynorsk")
192 ("no" . "norsk")
193 ("pl" . "polish")
194 ("pt" . "portuguese")
195 ("ro" . "romanian")
196 ("ru" . "russian")
197 ("sa" . "sanskrit")
198 ("sb" . "uppersorbian")
199 ("sk" . "slovak")
200 ("sl" . "slovene")
201 ("sq" . "albanian")
202 ("sr" . "serbian")
203 ("sv" . "swedish")
204 ("ta" . "tamil")
205 ("tr" . "turkish")
206 ("uk" . "ukrainian"))
207 "Alist between language code and corresponding Babel option.")
209 (defconst org-latex-polyglossia-language-alist
210 '(("am" "amharic")
211 ("ast" "asturian")
212 ("ar" "arabic")
213 ("bo" "tibetan")
214 ("bn" "bengali")
215 ("bg" "bulgarian")
216 ("br" "breton")
217 ("bt-br" "brazilian")
218 ("ca" "catalan")
219 ("cop" "coptic")
220 ("cs" "czech")
221 ("cy" "welsh")
222 ("da" "danish")
223 ("de" "german" "german")
224 ("de-at" "german" "austrian")
225 ("de-de" "german" "german")
226 ("dv" "divehi")
227 ("el" "greek")
228 ("en" "english" "usmax")
229 ("en-au" "english" "australian")
230 ("en-gb" "english" "uk")
231 ("en-nz" "english" "newzealand")
232 ("en-us" "english" "usmax")
233 ("eo" "esperanto")
234 ("es" "spanish")
235 ("et" "estonian")
236 ("eu" "basque")
237 ("fa" "farsi")
238 ("fi" "finnish")
239 ("fr" "french")
240 ("fu" "friulan")
241 ("ga" "irish")
242 ("gd" "scottish")
243 ("gl" "galician")
244 ("he" "hebrew")
245 ("hi" "hindi")
246 ("hr" "croatian")
247 ("hu" "magyar")
248 ("hy" "armenian")
249 ("id" "bahasai")
250 ("ia" "interlingua")
251 ("is" "icelandic")
252 ("it" "italian")
253 ("kn" "kannada")
254 ("la" "latin" "modern")
255 ("la-modern" "latin" "modern")
256 ("la-classic" "latin" "classic")
257 ("la-medieval" "latin" "medieval")
258 ("lo" "lao")
259 ("lt" "lithuanian")
260 ("lv" "latvian")
261 ("mr" "maranthi")
262 ("ml" "malayalam")
263 ("nl" "dutch")
264 ("nb" "norsk")
265 ("nn" "nynorsk")
266 ("nko" "nko")
267 ("no" "norsk")
268 ("oc" "occitan")
269 ("pl" "polish")
270 ("pms" "piedmontese")
271 ("pt" "portuges")
272 ("rm" "romansh")
273 ("ro" "romanian")
274 ("ru" "russian")
275 ("sa" "sanskrit")
276 ("hsb" "usorbian")
277 ("dsb" "lsorbian")
278 ("sk" "slovak")
279 ("sl" "slovenian")
280 ("se" "samin")
281 ("sq" "albanian")
282 ("sr" "serbian")
283 ("sv" "swedish")
284 ("syr" "syriac")
285 ("ta" "tamil")
286 ("te" "telugu")
287 ("th" "thai")
288 ("tk" "turkmen")
289 ("tr" "turkish")
290 ("uk" "ukrainian")
291 ("ur" "urdu")
292 ("vi" "vietnamese"))
293 "Alist between language code and corresponding Polyglossia option")
297 (defconst org-latex-table-matrix-macros '(("bordermatrix" . "\\cr")
298 ("qbordermatrix" . "\\cr")
299 ("kbordermatrix" . "\\\\"))
300 "Alist between matrix macros and their row ending.")
302 (defconst org-latex-math-environments-re
303 (format
304 "\\`[ \t]*\\\\begin{%s\\*?}"
305 (regexp-opt
306 '("equation" "eqnarray" "math" "displaymath"
307 "align" "gather" "multline" "flalign" "alignat"
308 "xalignat" "xxalignat"
309 "subequations"
310 ;; breqn
311 "dmath" "dseries" "dgroup" "darray"
312 ;; empheq
313 "empheq")))
314 "Regexp of LaTeX math environments.")
317 ;;; User Configurable Variables
319 (defgroup org-export-latex nil
320 "Options for exporting Org mode files to LaTeX."
321 :tag "Org Export LaTeX"
322 :group 'org-export)
324 ;;;; Generic
326 (defcustom org-latex-caption-above '(table)
327 "When non-nil, place caption string at the beginning of elements.
328 Otherwise, place it near the end. When value is a list of
329 symbols, put caption above selected elements only. Allowed
330 symbols are: `image', `table', `src-block' and `special-block'."
331 :group 'org-export-latex
332 :version "25.1"
333 :package-version '(Org . "8.3")
334 :type '(choice
335 (const :tag "For all elements" t)
336 (const :tag "For no element" nil)
337 (set :tag "For the following elements only" :greedy t
338 (const :tag "Images" image)
339 (const :tag "Tables" table)
340 (const :tag "Source code" src-block)
341 (const :tag "Special blocks" special-block))))
343 (defcustom org-latex-prefer-user-labels nil
344 "Use user-provided labels instead of internal ones when non-nil.
346 When this variable is non-nil, Org will use the value of
347 CUSTOM_ID property, NAME keyword or Org target as the key for the
348 \\label commands generated.
350 By default, Org generates its own internal labels during LaTeX
351 export. This process ensures that the \\label keys are unique
352 and valid, but it means the keys are not available in advance of
353 the export process.
355 Setting this variable gives you control over how Org generates
356 labels during LaTeX export, so that you may know their keys in
357 advance. One reason to do this is that it allows you to refer to
358 various elements using a single label both in Org's link syntax
359 and in embedded LaTeX code.
361 For example, when this variable is non-nil, a headline like this:
363 ** Some section
364 :PROPERTIES:
365 :CUSTOM_ID: sec:foo
366 :END:
367 This is section [[#sec:foo]].
368 #+BEGIN_EXPORT latex
369 And this is still section \\ref{sec:foo}.
370 #+END_EXPORT
372 will be exported to LaTeX as:
374 \\subsection{Some section}
375 \\label{sec:foo}
376 This is section \\ref{sec:foo}.
377 And this is still section \\ref{sec:foo}.
379 Note, however, that setting this variable introduces a limitation
380 on the possible values for CUSTOM_ID and NAME. When this
381 variable is non-nil, Org passes their value to \\label unchanged.
382 You are responsible for ensuring that the value is a valid LaTeX
383 \\label key, and that no other \\label commands with the same key
384 appear elsewhere in your document. (Keys may contain letters,
385 numbers, and the following punctuation: '_' '.' '-' ':'.) There
386 are no such limitations on CUSTOM_ID and NAME when this variable
387 is nil.
389 For headlines that do not define the CUSTOM_ID property or
390 elements without a NAME, Org will continue to use its default
391 labeling scheme to generate labels and resolve links into proper
392 references."
393 :group 'org-export-latex
394 :type 'boolean
395 :version "25.1"
396 :package-version '(Org . "8.3"))
398 ;;;; Preamble
400 (defcustom org-latex-default-class "article"
401 "The default LaTeX class."
402 :group 'org-export-latex
403 :type '(string :tag "LaTeX class"))
405 (defcustom org-latex-classes
406 '(("article"
407 "\\documentclass[11pt]{article}"
408 ("\\section{%s}" . "\\section*{%s}")
409 ("\\subsection{%s}" . "\\subsection*{%s}")
410 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
411 ("\\paragraph{%s}" . "\\paragraph*{%s}")
412 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
413 ("report"
414 "\\documentclass[11pt]{report}"
415 ("\\part{%s}" . "\\part*{%s}")
416 ("\\chapter{%s}" . "\\chapter*{%s}")
417 ("\\section{%s}" . "\\section*{%s}")
418 ("\\subsection{%s}" . "\\subsection*{%s}")
419 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
420 ("book"
421 "\\documentclass[11pt]{book}"
422 ("\\part{%s}" . "\\part*{%s}")
423 ("\\chapter{%s}" . "\\chapter*{%s}")
424 ("\\section{%s}" . "\\section*{%s}")
425 ("\\subsection{%s}" . "\\subsection*{%s}")
426 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
427 "Alist of LaTeX classes and associated header and structure.
428 If #+LATEX_CLASS is set in the buffer, use its value and the
429 associated information. Here is the structure of each cell:
431 (class-name
432 header-string
433 (numbered-section . unnumbered-section)
434 ...)
436 The header string
437 -----------------
439 The HEADER-STRING is the header that will be inserted into the
440 LaTeX file. It should contain the \\documentclass macro, and
441 anything else that is needed for this setup. To this header, the
442 following commands will be added:
444 - Calls to \\usepackage for all packages mentioned in the
445 variables `org-latex-default-packages-alist' and
446 `org-latex-packages-alist'. Thus, your header definitions
447 should avoid to also request these packages.
449 - Lines specified via \"#+LATEX_HEADER:\" and
450 \"#+LATEX_HEADER_EXTRA:\" keywords.
452 If you need more control about the sequence in which the header
453 is built up, or if you want to exclude one of these building
454 blocks for a particular class, you can use the following
455 macro-like placeholders.
457 [DEFAULT-PACKAGES] \\usepackage statements for default packages
458 [NO-DEFAULT-PACKAGES] do not include any of the default packages
459 [PACKAGES] \\usepackage statements for packages
460 [NO-PACKAGES] do not include the packages
461 [EXTRA] the stuff from #+LATEX_HEADER(_EXTRA)
462 [NO-EXTRA] do not include #+LATEX_HEADER(_EXTRA) stuff
464 So a header like
466 \\documentclass{article}
467 [NO-DEFAULT-PACKAGES]
468 [EXTRA]
469 \\providecommand{\\alert}[1]{\\textbf{#1}}
470 [PACKAGES]
472 will omit the default packages, and will include the
473 #+LATEX_HEADER and #+LATEX_HEADER_EXTRA lines, then have a call
474 to \\providecommand, and then place \\usepackage commands based
475 on the content of `org-latex-packages-alist'.
477 If your header, `org-latex-default-packages-alist' or
478 `org-latex-packages-alist' inserts \"\\usepackage[AUTO]{inputenc}\",
479 AUTO will automatically be replaced with a coding system derived
480 from `buffer-file-coding-system'. See also the variable
481 `org-latex-inputenc-alist' for a way to influence this mechanism.
483 Likewise, if your header contains \"\\usepackage[AUTO]{babel}\"
484 or \"\\usepackage[AUTO]{polyglossia}\", AUTO will be replaced
485 with the language related to the language code specified by
486 `org-export-default-language'. Note that constructions such as
487 \"\\usepackage[french,AUTO,english]{babel}\" are permitted. For
488 Polyglossia the language will be set via the macros
489 \"\\setmainlanguage\" and \"\\setotherlanguage\". See also
490 `org-latex-guess-babel-language' and
491 `org-latex-guess-polyglossia-language'.
493 The sectioning structure
494 ------------------------
496 The sectioning structure of the class is given by the elements
497 following the header string. For each sectioning level, a number
498 of strings is specified. A %s formatter is mandatory in each
499 section string and will be replaced by the title of the section.
501 Instead of a cons cell (numbered . unnumbered), you can also
502 provide a list of 2 or 4 elements,
504 (numbered-open numbered-close)
508 (numbered-open numbered-close unnumbered-open unnumbered-close)
510 providing opening and closing strings for a LaTeX environment
511 that should represent the document section. The opening clause
512 should have a %s to represent the section title.
514 Instead of a list of sectioning commands, you can also specify
515 a function name. That function will be called with two
516 parameters, the (reduced) level of the headline, and a predicate
517 non-nil when the headline should be numbered. It must return
518 a format string in which the section title will be added."
519 :group 'org-export-latex
520 :type '(repeat
521 (list (string :tag "LaTeX class")
522 (string :tag "LaTeX header")
523 (repeat :tag "Levels" :inline t
524 (choice
525 (cons :tag "Heading"
526 (string :tag " numbered")
527 (string :tag "unnumbered"))
528 (list :tag "Environment"
529 (string :tag "Opening (numbered)")
530 (string :tag "Closing (numbered)")
531 (string :tag "Opening (unnumbered)")
532 (string :tag "Closing (unnumbered)"))
533 (function :tag "Hook computing sectioning"))))))
535 (defcustom org-latex-inputenc-alist nil
536 "Alist of inputenc coding system names, and what should really be used.
537 For example, adding an entry
539 (\"utf8\" . \"utf8x\")
541 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
542 are written as utf8 files."
543 :group 'org-export-latex
544 :type '(repeat
545 (cons
546 (string :tag "Derived from buffer")
547 (string :tag "Use this instead"))))
549 (defcustom org-latex-title-command "\\maketitle"
550 "The command used to insert the title just after \\begin{document}.
552 This format string may contain these elements:
554 %a for AUTHOR keyword
555 %t for TITLE keyword
556 %s for SUBTITLE keyword
557 %k for KEYWORDS line
558 %d for DESCRIPTION line
559 %c for CREATOR line
560 %l for Language keyword
561 %L for capitalized language keyword
562 %D for DATE keyword
564 If you need to use a \"%\" character, you need to escape it
565 like that: \"%%\".
567 Setting :latex-title-command in publishing projects will take
568 precedence over this variable."
569 :group 'org-export-latex
570 :type '(string :tag "Format string"))
572 (defcustom org-latex-subtitle-format "\\\\\\medskip\n\\large %s"
573 "Format string used for transcoded subtitle.
574 The format string should have at most one \"%s\"-expression,
575 which is replaced with the subtitle."
576 :group 'org-export-latex
577 :version "25.1"
578 :package-version '(Org . "8.3")
579 :type '(string :tag "Format string"))
581 (defcustom org-latex-subtitle-separate nil
582 "Non-nil means the subtitle is not typeset as part of title."
583 :group 'org-export-latex
584 :version "25.1"
585 :package-version '(Org . "8.3")
586 :type 'boolean)
588 (defcustom org-latex-toc-command "\\tableofcontents\n\n"
589 "LaTeX command to set the table of contents, list of figures, etc.
590 This command only applies to the table of contents generated with
591 the toc:nil option, not to those generated with #+TOC keyword."
592 :group 'org-export-latex
593 :type 'string)
595 (defcustom org-latex-hyperref-template
596 "\\hypersetup{\n pdfauthor={%a},\n pdftitle={%t},\n pdfkeywords={%k},
597 pdfsubject={%d},\n pdfcreator={%c}, \n pdflang={%L}}\n"
598 "Template for hyperref package options.
600 This format string may contain these elements:
602 %a for AUTHOR keyword
603 %t for TITLE keyword
604 %s for SUBTITLE keyword
605 %k for KEYWORDS line
606 %d for DESCRIPTION line
607 %c for CREATOR line
608 %l for Language keyword
609 %L for capitalized language keyword
610 %D for DATE keyword
612 If you need to use a \"%\" character, you need to escape it
613 like that: \"%%\".
615 As a special case, a nil value prevents template from being
616 inserted.
618 Setting :latex-hyperref-template in publishing projects will take
619 precedence over this variable."
620 :group 'org-export-latex
621 :version "25.1"
622 :package-version '(Org . "8.3")
623 :type '(choice (const :tag "No template" nil)
624 (string :tag "Format string")))
626 ;;;; Headline
628 (defcustom org-latex-format-headline-function
629 'org-latex-format-headline-default-function
630 "Function for formatting the headline's text.
632 This function will be called with six arguments:
633 TODO the todo keyword (string or nil)
634 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
635 PRIORITY the priority of the headline (integer or nil)
636 TEXT the main headline text (string)
637 TAGS the tags (list of strings or nil)
638 INFO the export options (plist)
640 The function result will be used in the section format string."
641 :group 'org-export-latex
642 :version "24.4"
643 :package-version '(Org . "8.0")
644 :type 'function)
647 ;;;; Footnotes
649 (defcustom org-latex-footnote-separator "\\textsuperscript{,}\\,"
650 "Text used to separate footnotes."
651 :group 'org-export-latex
652 :type 'string)
654 (defcustom org-latex-footnote-defined-format "\\textsuperscript{\\ref{%s}}"
655 "Format string used to format reference to footnote already defined.
656 %s will be replaced by the label of the referred footnote."
657 :group 'org-export-latex
658 :type '(choice
659 (const :tag "Use plain superscript (default)" "\\textsuperscript{\\ref{%s}}")
660 (const :tag "Use Memoir/KOMA-Script footref" "\\footref{%s}")
661 (string :tag "Other format string"))
662 :version "25.2"
663 :package-version '(Org . "9.0"))
665 ;;;; Timestamps
667 (defcustom org-latex-active-timestamp-format "\\textit{%s}"
668 "A printf format string to be applied to active timestamps."
669 :group 'org-export-latex
670 :type 'string)
672 (defcustom org-latex-inactive-timestamp-format "\\textit{%s}"
673 "A printf format string to be applied to inactive timestamps."
674 :group 'org-export-latex
675 :type 'string)
677 (defcustom org-latex-diary-timestamp-format "\\textit{%s}"
678 "A printf format string to be applied to diary timestamps."
679 :group 'org-export-latex
680 :type 'string)
683 ;;;; Links
685 (defcustom org-latex-images-centered t
686 "When non-nil, images are centered."
687 :group 'org-export-latex
688 :version "25.1"
689 :package-version '(Org . "9.0")
690 :type 'boolean
691 :safe #'booleanp)
693 (defcustom org-latex-image-default-option ""
694 "Default option for images."
695 :group 'org-export-latex
696 :version "24.4"
697 :package-version '(Org . "8.0")
698 :type 'string)
700 (defcustom org-latex-image-default-width ".9\\linewidth"
701 "Default width for images.
702 This value will not be used if a height is provided."
703 :group 'org-export-latex
704 :version "24.4"
705 :package-version '(Org . "8.0")
706 :type 'string)
708 (defcustom org-latex-image-default-height ""
709 "Default height for images.
710 This value will not be used if a width is provided, or if the
711 image is wrapped within a \"figure\" or \"wrapfigure\"
712 environment."
713 :group 'org-export-latex
714 :version "24.4"
715 :package-version '(Org . "8.0")
716 :type 'string)
718 (defcustom org-latex-default-figure-position "htb"
719 "Default position for latex figures."
720 :group 'org-export-latex
721 :type 'string)
723 (defcustom org-latex-inline-image-rules
724 '(("file" . "\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\|tikz\\|pgf\\|svg\\)\\'"))
725 "Rules characterizing image files that can be inlined into LaTeX.
727 A rule consists in an association whose key is the type of link
728 to consider, and value is a regexp that will be matched against
729 link's path.
731 Note that, by default, the image extension *actually* allowed
732 depend on the way the LaTeX file is processed. When used with
733 pdflatex, pdf, jpg and png images are OK. When processing
734 through dvi to Postscript, only ps and eps are allowed. The
735 default we use here encompasses both."
736 :group 'org-export-latex
737 :version "24.4"
738 :package-version '(Org . "8.0")
739 :type '(alist :key-type (string :tag "Type")
740 :value-type (regexp :tag "Path")))
742 (defcustom org-latex-link-with-unknown-path-format "\\texttt{%s}"
743 "Format string for links with unknown path type."
744 :group 'org-export-latex
745 :type 'string)
748 ;;;; Tables
750 (defcustom org-latex-default-table-environment "tabular"
751 "Default environment used to build tables."
752 :group 'org-export-latex
753 :version "24.4"
754 :package-version '(Org . "8.0")
755 :type 'string)
757 (defcustom org-latex-default-table-mode 'table
758 "Default mode for tables.
760 Value can be a symbol among:
762 `table' Regular LaTeX table.
764 `math' In this mode, every cell is considered as being in math
765 mode and the complete table will be wrapped within a math
766 environment. It is particularly useful to write matrices.
768 `inline-math' This mode is almost the same as `math', but the
769 math environment will be inlined.
771 `verbatim' The table is exported as it appears in the Org
772 buffer, within a verbatim environment.
774 This value can be overridden locally with, i.e. \":mode math\" in
775 LaTeX attributes.
777 When modifying this variable, it may be useful to change
778 `org-latex-default-table-environment' accordingly."
779 :group 'org-export-latex
780 :version "24.4"
781 :package-version '(Org . "8.0")
782 :type '(choice (const :tag "Table" table)
783 (const :tag "Matrix" math)
784 (const :tag "Inline matrix" inline-math)
785 (const :tag "Verbatim" verbatim))
786 :safe (lambda (s) (memq s '(table math inline-math verbatim))))
788 (defcustom org-latex-tables-centered t
789 "When non-nil, tables are exported in a center environment."
790 :group 'org-export-latex
791 :type 'boolean
792 :safe #'booleanp)
794 (defcustom org-latex-tables-booktabs nil
795 "When non-nil, display tables in a formal \"booktabs\" style.
796 This option assumes that the \"booktabs\" package is properly
797 loaded in the header of the document. This value can be ignored
798 locally with \":booktabs t\" and \":booktabs nil\" LaTeX
799 attributes."
800 :group 'org-export-latex
801 :version "24.4"
802 :package-version '(Org . "8.0")
803 :type 'boolean
804 :safe #'booleanp)
806 (defcustom org-latex-table-scientific-notation "%s\\,(%s)"
807 "Format string to display numbers in scientific notation.
808 The format should have \"%s\" twice, for mantissa and exponent
809 \(i.e., \"%s\\\\times10^{%s}\").
811 When nil, no transformation is made."
812 :group 'org-export-latex
813 :version "24.4"
814 :package-version '(Org . "8.0")
815 :type '(choice
816 (string :tag "Format string")
817 (const :tag "No formatting" nil)))
819 ;;;; Text markup
821 (defcustom org-latex-text-markup-alist '((bold . "\\textbf{%s}")
822 (code . protectedtexttt)
823 (italic . "\\emph{%s}")
824 (strike-through . "\\sout{%s}")
825 (underline . "\\uline{%s}")
826 (verbatim . protectedtexttt))
827 "Alist of LaTeX expressions to convert text markup.
829 The key must be a symbol among `bold', `code', `italic',
830 `strike-through', `underline' and `verbatim'. The value is
831 a formatting string to wrap fontified text with.
833 Value can also be set to the following symbols: `verb' and
834 `protectedtexttt'. For the former, Org will use \"\\verb\" to
835 create a format string and select a delimiter character that
836 isn't in the string. For the latter, Org will use \"\\texttt\"
837 to typeset and try to protect special characters.
839 If no association can be found for a given markup, text will be
840 returned as-is."
841 :group 'org-export-latex
842 :version "25.1"
843 :package-version '(Org . "8.3")
844 :type 'alist
845 :options '(bold code italic strike-through underline verbatim))
848 ;;;; Drawers
850 (defcustom org-latex-format-drawer-function (lambda (_ contents) contents)
851 "Function called to format a drawer in LaTeX code.
853 The function must accept two parameters:
854 NAME the drawer name, like \"LOGBOOK\"
855 CONTENTS the contents of the drawer.
857 The function should return the string to be exported.
859 The default function simply returns the value of CONTENTS."
860 :group 'org-export-latex
861 :version "24.4"
862 :package-version '(Org . "8.3")
863 :type 'function)
866 ;;;; Inlinetasks
868 (defcustom org-latex-format-inlinetask-function
869 'org-latex-format-inlinetask-default-function
870 "Function called to format an inlinetask in LaTeX code.
872 The function must accept seven parameters:
873 TODO the todo keyword (string or nil)
874 TODO-TYPE the todo type (symbol: `todo', `done', nil)
875 PRIORITY the inlinetask priority (integer or nil)
876 NAME the inlinetask name (string)
877 TAGS the inlinetask tags (list of strings or nil)
878 CONTENTS the contents of the inlinetask (string or nil)
879 INFO the export options (plist)
881 The function should return the string to be exported."
882 :group 'org-export-latex
883 :type 'function
884 :version "25.1"
885 :package-version '(Org . "8.3"))
888 ;; Src blocks
890 (defcustom org-latex-listings nil
891 "Non-nil means export source code using the listings package.
893 This package will fontify source code, possibly even with color.
894 If you want to use this, you also need to make LaTeX use the
895 listings package, and if you want to have color, the color
896 package. Just add these to `org-latex-packages-alist', for
897 example using customize, or with something like:
899 (require \\='ox-latex)
900 (add-to-list \\='org-latex-packages-alist \\='(\"\" \"listings\"))
901 (add-to-list \\='org-latex-packages-alist \\='(\"\" \"color\"))
903 Alternatively,
905 (setq org-latex-listings \\='minted)
907 causes source code to be exported using the minted package as
908 opposed to listings. If you want to use minted, you need to add
909 the minted package to `org-latex-packages-alist', for example
910 using customize, or with
912 (require \\='ox-latex)
913 (add-to-list \\='org-latex-packages-alist \\='(\"newfloat\" \"minted\"))
915 In addition, it is necessary to install pygments
916 \(http://pygments.org), and to configure the variable
917 `org-latex-pdf-process' so that the -shell-escape option is
918 passed to pdflatex.
920 The minted choice has possible repercussions on the preview of
921 latex fragments (see `org-preview-latex-fragment'). If you run
922 into previewing problems, please consult
924 http://orgmode.org/worg/org-tutorials/org-latex-preview.html"
925 :group 'org-export-latex
926 :type '(choice
927 (const :tag "Use listings" t)
928 (const :tag "Use minted" minted)
929 (const :tag "Export verbatim" nil))
930 :safe (lambda (s) (memq s '(t nil minted))))
932 (defcustom org-latex-listings-langs
933 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
934 (c "C") (cc "C++")
935 (fortran "fortran")
936 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
937 (html "HTML") (xml "XML")
938 (tex "TeX") (latex "[LaTeX]TeX")
939 (shell-script "bash")
940 (gnuplot "Gnuplot")
941 (ocaml "Caml") (caml "Caml")
942 (sql "SQL") (sqlite "sql")
943 (makefile "make")
944 (R "r"))
945 "Alist mapping languages to their listing language counterpart.
946 The key is a symbol, the major mode symbol without the \"-mode\".
947 The value is the string that should be inserted as the language
948 parameter for the listings package. If the mode name and the
949 listings name are the same, the language does not need an entry
950 in this list - but it does not hurt if it is present."
951 :group 'org-export-latex
952 :version "24.4"
953 :package-version '(Org . "8.3")
954 :type '(repeat
955 (list
956 (symbol :tag "Major mode ")
957 (string :tag "Listings language"))))
959 (defcustom org-latex-listings-options nil
960 "Association list of options for the latex listings package.
962 These options are supplied as a comma-separated list to the
963 \\lstset command. Each element of the association list should be
964 a list containing two strings: the name of the option, and the
965 value. For example,
967 (setq org-latex-listings-options
968 \\='((\"basicstyle\" \"\\\\small\")
969 (\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
971 will typeset the code in a small size font with underlined, bold
972 black keywords.
974 Note that the same options will be applied to blocks of all
975 languages. If you need block-specific options, you may use the
976 following syntax:
978 #+ATTR_LATEX: :options key1=value1,key2=value2
979 #+BEGIN_SRC <LANG>
981 #+END_SRC"
982 :group 'org-export-latex
983 :type '(repeat
984 (list
985 (string :tag "Listings option name ")
986 (string :tag "Listings option value"))))
988 (defcustom org-latex-minted-langs
989 '((emacs-lisp "common-lisp")
990 (cc "c++")
991 (cperl "perl")
992 (shell-script "bash")
993 (caml "ocaml"))
994 "Alist mapping languages to their minted language counterpart.
995 The key is a symbol, the major mode symbol without the \"-mode\".
996 The value is the string that should be inserted as the language
997 parameter for the minted package. If the mode name and the
998 listings name are the same, the language does not need an entry
999 in this list - but it does not hurt if it is present.
1001 Note that minted uses all lower case for language identifiers,
1002 and that the full list of language identifiers can be obtained
1003 with:
1005 pygmentize -L lexers"
1006 :group 'org-export-latex
1007 :type '(repeat
1008 (list
1009 (symbol :tag "Major mode ")
1010 (string :tag "Minted language"))))
1012 (defcustom org-latex-minted-options nil
1013 "Association list of options for the latex minted package.
1015 These options are supplied within square brackets in
1016 \\begin{minted} environments. Each element of the alist should
1017 be a list containing two strings: the name of the option, and the
1018 value. For example,
1020 (setq org-latex-minted-options
1021 '((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
1023 will result in src blocks being exported with
1025 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
1027 as the start of the minted environment. Note that the same
1028 options will be applied to blocks of all languages. If you need
1029 block-specific options, you may use the following syntax:
1031 #+ATTR_LATEX: :options key1=value1,key2=value2
1032 #+BEGIN_SRC <LANG>
1034 #+END_SRC"
1035 :group 'org-export-latex
1036 :type '(repeat
1037 (list
1038 (string :tag "Minted option name ")
1039 (string :tag "Minted option value"))))
1041 (defcustom org-latex-custom-lang-environments nil
1042 "Alist mapping languages to language-specific LaTeX environments.
1044 It is used during export of src blocks by the listings and minted
1045 latex packages. The environment may be a simple string, composed of
1046 only letters and numbers. In this case, the string is directly the
1047 name of the latex environment to use. The environment may also be
1048 a format string. In this case the format string will be directly
1049 exported. This format string may contain these elements:
1051 %s for the formatted source
1052 %c for the caption
1053 %f for the float attribute
1054 %l for an appropriate label
1055 %o for the LaTeX attributes
1057 For example,
1059 (setq org-latex-custom-lang-environments
1060 '((python \"pythoncode\")
1061 (ocaml \"\\\\begin{listing}
1062 \\\\begin{minted}[%o]{ocaml}
1063 %s\\\\end{minted}
1064 \\\\caption{%c}
1065 \\\\label{%l}\")))
1067 would have the effect that if Org encounters a Python source block
1068 during LaTeX export it will produce
1070 \\begin{pythoncode}
1071 <src block body>
1072 \\end{pythoncode}
1074 and if Org encounters an Ocaml source block during LaTeX export it
1075 will produce
1077 \\begin{listing}
1078 \\begin{minted}[<attr_latex options>]{ocaml}
1079 <src block body>
1080 \\end{minted}
1081 \\caption{<caption>}
1082 \\label{<label>}
1083 \\end{listing}"
1084 :group 'org-export-latex
1085 :type '(repeat
1086 (list
1087 (symbol :tag "Language name ")
1088 (string :tag "Environment name or format string")))
1089 :version "25.1"
1090 :package-version '(Org . "9.0"))
1093 ;;;; Compilation
1095 (defcustom org-latex-compiler-file-string "%% Intended LaTeX compiler: %s\n"
1096 "LaTeX compiler format-string.
1097 See also `org-latex-compiler'."
1098 :group 'org-export-latex
1099 :type '(choice
1100 (const :tag "Comment" "%% Intended LaTeX compiler: %s\n")
1101 (const :tag "latex-mode file variable" "%% -*- latex-run-command: %s -*-\n")
1102 (const :tag "AUCTeX file variable" "%% -*- LaTeX-command: %s -*-\n")
1103 (string :tag "custom format" "%% %s"))
1104 :version "25.1"
1105 :package-version '(Org . "9.0"))
1107 (defcustom org-latex-compiler "pdflatex"
1108 "LaTeX compiler to use.
1110 Must be an element in `org-latex-compilers' or the empty quote.
1111 Can also be set in buffers via #+LATEX_COMPILER. See also
1112 `org-latex-compiler-file-string'."
1113 :group 'org-export-latex
1114 :type '(choice
1115 (const :tag "pdfLaTeX" "pdflatex")
1116 (const :tag "XeLaTeX" "xelatex")
1117 (const :tag "LuaLaTeX" "lualatex")
1118 (const :tag "Unset" ""))
1119 :version "25.1"
1120 :package-version '(Org . "9.0"))
1122 (defconst org-latex-compilers '("pdflatex" "xelatex" "lualatex")
1123 "Known LaTeX compilers.
1124 See also `org-latex-compiler'.")
1126 (defcustom org-latex-bib-compiler "bibtex"
1127 "Command to process a LaTeX file's bibliography.
1129 The shorthand %bib in `org-latex-pdf-process' is replaced with
1130 this value.
1132 A better approach is to use a compiler suit such as `latexmk'."
1133 :group 'org-export-latex
1134 :type '(choice (const :tag "BibTeX" "bibtex")
1135 (const :tag "Biber" "biber")
1136 (string :tag "Other process"))
1137 :version "25.1"
1138 :package-version '(Org . "9.0"))
1140 (defcustom org-latex-pdf-process
1141 '("%latex -interaction nonstopmode -output-directory %o %f"
1142 "%latex -interaction nonstopmode -output-directory %o %f"
1143 "%latex -interaction nonstopmode -output-directory %o %f")
1144 "Commands to process a LaTeX file to a PDF file.
1145 This is a list of strings, each of them will be given to the
1146 shell as a command. %f in the command will be replaced by the
1147 full file name, %b by the file base name (i.e. without directory
1148 and extension parts), %o by the base directory of the file,
1149 %latex is the LaTeX compiler (see `org-latex-compiler'), and %bib
1150 is the BibTeX-like compiler (see `org-latex-bib-compiler').
1152 The reason why this is a list is that it usually takes several
1153 runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
1154 does not have a clever mechanism to detect which of these
1155 commands have to be run to get to a stable result, and it also
1156 does not do any error checking.
1158 Consider a smart LaTeX compiler such as `texi2dvi' or `latexmk',
1159 which calls the \"correct\" combinations of auxiliary programs.
1161 Alternatively, this may be a Lisp function that does the
1162 processing, so you could use this to apply the machinery of
1163 AUCTeX or the Emacs LaTeX mode. This function should accept the
1164 file name as its single argument."
1165 :group 'org-export-pdf
1166 :type '(choice
1167 (repeat :tag "Shell command sequence"
1168 (string :tag "Shell command"))
1169 (const :tag "2 runs of latex"
1170 ("%latex -interaction nonstopmode -output-directory %o %f"
1171 "%latex -interaction nonstopmode -output-directory %o %f"))
1172 (const :tag "3 runs of latex"
1173 ("%latex -interaction nonstopmode -output-directory %o %f"
1174 "%latex -interaction nonstopmode -output-directory %o %f"
1175 "%latex -interaction nonstopmode -output-directory %o %f"))
1176 (const :tag "latex,bibtex,latex,latex"
1177 ("%latex -interaction nonstopmode -output-directory %o %f"
1178 "%bib %b"
1179 "%latex -interaction nonstopmode -output-directory %o %f"
1180 "%latex -interaction nonstopmode -output-directory %o %f"))
1181 (const :tag "texi2dvi"
1182 ("LATEX=\"%latex\" texi2dvi -p -b -V %f"))
1183 (const :tag "latexmk"
1184 ("latexmk -g -pdflatex=\"%latex\" %f"))
1185 (function)))
1187 (defcustom org-latex-logfiles-extensions
1188 '("aux" "bcf" "blg" "fdb_latexmk" "fls" "figlist" "idx" "log" "nav" "out"
1189 "ptc" "run.xml" "snm" "toc" "vrb" "xdv")
1190 "The list of file extensions to consider as LaTeX logfiles.
1191 The logfiles will be removed if `org-latex-remove-logfiles' is
1192 non-nil."
1193 :group 'org-export-latex
1194 :version "25.1"
1195 :package-version '(Org . "8.3")
1196 :type '(repeat (string :tag "Extension")))
1198 (defcustom org-latex-remove-logfiles t
1199 "Non-nil means remove the logfiles produced by PDF production.
1200 By default, logfiles are files with these extensions: .aux, .idx,
1201 .log, .out, .toc, .nav, .snm and .vrb. To define the set of
1202 logfiles to remove, set `org-latex-logfiles-extensions'."
1203 :group 'org-export-latex
1204 :type 'boolean)
1206 (defcustom org-latex-known-warnings
1207 '(("Reference.*?undefined" . "[undefined reference]")
1208 ("Runaway argument" . "[runaway argument]")
1209 ("Underfull \\hbox" . "[underfull hbox]")
1210 ("Overfull \\hbox" . "[overfull hbox]")
1211 ("Citation.*?undefined" . "[undefined citation]")
1212 ("Undefined control sequence" . "[undefined control sequence]"))
1213 "Alist of regular expressions and associated messages for the user.
1214 The regular expressions are used to find possible warnings in the
1215 log of a latex-run. These warnings will be reported after
1216 calling `org-latex-compile'."
1217 :group 'org-export-latex
1218 :version "25.1"
1219 :package-version '(Org . "8.3")
1220 :type '(repeat
1221 (cons
1222 (string :tag "Regexp")
1223 (string :tag "Message"))))
1227 ;;; Internal Functions
1229 (defun org-latex--caption-above-p (element info)
1230 "Non nil when caption is expected to be located above ELEMENT.
1231 INFO is a plist holding contextual information."
1232 (let ((above (plist-get info :latex-caption-above)))
1233 (if (symbolp above) above
1234 (let ((type (org-element-type element)))
1235 (memq (if (eq type 'link) 'image type) above)))))
1237 (defun org-latex--label (datum info &optional force full)
1238 "Return an appropriate label for DATUM.
1239 DATUM is an element or a `target' type object. INFO is the
1240 current export state, as a plist.
1242 Return nil if element DATUM has no NAME or VALUE affiliated
1243 keyword or no CUSTOM_ID property, unless FORCE is non-nil. In
1244 this case always return a unique label.
1246 Eventually, if FULL is non-nil, wrap label within \"\\label{}\"."
1247 (let* ((type (org-element-type datum))
1248 (user-label
1249 (org-element-property
1250 (cl-case type
1251 ((headline inlinetask) :CUSTOM_ID)
1252 (target :value)
1253 (otherwise :name))
1254 datum))
1255 (label
1256 (and (or user-label force)
1257 (if (and user-label (plist-get info :latex-prefer-user-labels))
1258 user-label
1259 (concat (cl-case type
1260 (headline "sec:")
1261 (table "tab:")
1262 (latex-environment
1263 (and (string-match-p
1264 org-latex-math-environments-re
1265 (org-element-property :value datum))
1266 "eq:"))
1267 (paragraph
1268 (and (org-element-property :caption datum)
1269 "fig:")))
1270 (org-export-get-reference datum info))))))
1271 (cond ((not full) label)
1272 (label (format "\\label{%s}%s"
1273 label
1274 (if (eq type 'target) "" "\n")))
1275 (t ""))))
1277 (defun org-latex--caption/label-string (element info)
1278 "Return caption and label LaTeX string for ELEMENT.
1280 INFO is a plist holding contextual information. If there's no
1281 caption nor label, return the empty string.
1283 For non-floats, see `org-latex--wrap-label'."
1284 (let* ((label (org-latex--label element info nil t))
1285 (main (org-export-get-caption element))
1286 (attr (org-export-read-attribute :attr_latex element))
1287 (type (org-element-type element))
1288 (nonfloat (or (and (plist-member attr :float)
1289 (not (plist-get attr :float))
1290 main)
1291 (and (eq type 'src-block)
1292 (not (plist-get attr :float))
1293 (memq (plist-get info :latex-listings)
1294 '(nil minted)))))
1295 (short (org-export-get-caption element t))
1296 (caption-from-attr-latex (plist-get attr :caption)))
1297 (cond
1298 ((org-string-nw-p caption-from-attr-latex)
1299 (concat caption-from-attr-latex "\n"))
1300 ((and (not main) (equal label "")) "")
1301 ((not main) label)
1302 ;; Option caption format with short name.
1304 (format (if nonfloat "\\captionof{%s}%s{%s%s}\n"
1305 "\\caption%s%s{%s%s}\n")
1306 (if nonfloat
1307 (cl-case type
1308 (paragraph "figure")
1309 (src-block (if (plist-get info :latex-listings)
1310 "listing"
1311 "figure"))
1312 (t (symbol-name type)))
1314 (if short (format "[%s]" (org-export-data short info)) "")
1315 label
1316 (org-export-data main info))))))
1318 (defun org-latex-guess-inputenc (header)
1319 "Set the coding system in inputenc to what the buffer is.
1321 HEADER is the LaTeX header string. This function only applies
1322 when specified inputenc option is \"AUTO\".
1324 Return the new header, as a string."
1325 (let* ((cs (or (ignore-errors
1326 (latexenc-coding-system-to-inputenc
1327 (or org-export-coding-system buffer-file-coding-system)))
1328 "utf8")))
1329 (if (not cs) header
1330 ;; First translate if that is requested.
1331 (setq cs (or (cdr (assoc cs org-latex-inputenc-alist)) cs))
1332 ;; Then find the \usepackage statement and replace the option.
1333 (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
1334 cs header t nil 1))))
1336 (defun org-latex-guess-babel-language (header info)
1337 "Set Babel's language according to LANGUAGE keyword.
1339 HEADER is the LaTeX header string. INFO is the plist used as
1340 a communication channel.
1342 Insertion of guessed language only happens when Babel package has
1343 explicitly been loaded. Then it is added to the rest of
1344 package's options.
1346 The argument to Babel may be \"AUTO\" which is then replaced with
1347 the language of the document or `org-export-default-language'
1348 unless language in question is already loaded.
1350 Return the new header."
1351 (let ((language-code (plist-get info :language)))
1352 ;; If no language is set or Babel package is not loaded, return
1353 ;; HEADER as-is.
1354 (if (or (not (stringp language-code))
1355 (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" header)))
1356 header
1357 (let ((options (save-match-data
1358 (org-split-string (match-string 1 header) ",[ \t]*")))
1359 (language (cdr (assoc-string language-code
1360 org-latex-babel-language-alist t))))
1361 ;; If LANGUAGE is already loaded, return header without AUTO.
1362 ;; Otherwise, replace AUTO with language or append language if
1363 ;; AUTO is not present.
1364 (replace-match
1365 (mapconcat (lambda (option) (if (equal "AUTO" option) language option))
1366 (cond ((member language options) (delete "AUTO" options))
1367 ((member "AUTO" options) options)
1368 (t (append options (list language))))
1369 ", ")
1370 t nil header 1)))))
1372 (defun org-latex-guess-polyglossia-language (header info)
1373 "Set the Polyglossia language according to the LANGUAGE keyword.
1375 HEADER is the LaTeX header string. INFO is the plist used as
1376 a communication channel.
1378 Insertion of guessed language only happens when the Polyglossia
1379 package has been explicitly loaded.
1381 The argument to Polyglossia may be \"AUTO\" which is then
1382 replaced with the language of the document or
1383 `org-export-default-language'. Note, the language is really set
1384 using \setdefaultlanguage and not as an option to the package.
1386 Return the new header."
1387 (let ((language (plist-get info :language)))
1388 ;; If no language is set or Polyglossia is not loaded, return
1389 ;; HEADER as-is.
1390 (if (or (not (stringp language))
1391 (not (string-match
1392 "\\\\usepackage\\(?:\\[\\([^]]+?\\)\\]\\){polyglossia}\n"
1393 header)))
1394 header
1395 (let* ((options (org-string-nw-p (match-string 1 header)))
1396 (languages (and options
1397 ;; Reverse as the last loaded language is
1398 ;; the main language.
1399 (nreverse
1400 (delete-dups
1401 (save-match-data
1402 (org-split-string
1403 (replace-regexp-in-string
1404 "AUTO" language options t)
1405 ",[ \t]*"))))))
1406 (main-language-set
1407 (string-match-p "\\\\setmainlanguage{.*?}" header)))
1408 (replace-match
1409 (concat "\\usepackage{polyglossia}\n"
1410 (mapconcat
1411 (lambda (l)
1412 (let ((l (or (assoc l org-latex-polyglossia-language-alist)
1413 l)))
1414 (format (if main-language-set "\\setotherlanguage%s{%s}\n"
1415 (setq main-language-set t)
1416 "\\setmainlanguage%s{%s}\n")
1417 (if (and (consp l) (= (length l) 3))
1418 (format "[variant=%s]" (nth 2 l))
1420 (nth 1 l))))
1421 languages
1422 ""))
1423 t t header 0)))))
1425 (defun org-latex--remove-packages (pkg-alist info)
1426 "Remove packages based on the current LaTeX compiler.
1428 If the fourth argument of an element is set in pkg-alist, and it
1429 is not a member of the LaTeX compiler of the document, the packages
1430 is removed. See also `org-latex-compiler'.
1432 Return modified pkg-alist."
1433 (let ((compiler (or (plist-get info :latex-compiler) "")))
1434 (if (member-ignore-case compiler org-latex-compilers)
1435 (delq nil
1436 (mapcar
1437 (lambda (pkg)
1438 (unless (and
1439 (listp pkg)
1440 (let ((third (nth 3 pkg)))
1441 (and third
1442 (not (member-ignore-case
1443 compiler
1444 (if (listp third) third (list third)))))))
1445 pkg))
1446 pkg-alist))
1447 pkg-alist)))
1449 (defun org-latex--find-verb-separator (s)
1450 "Return a character not used in string S.
1451 This is used to choose a separator for constructs like \\verb."
1452 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1453 (cl-loop for c across ll
1454 when (not (string-match (regexp-quote (char-to-string c)) s))
1455 return (char-to-string c))))
1457 (defun org-latex--make-option-string (options)
1458 "Return a comma separated string of keywords and values.
1459 OPTIONS is an alist where the key is the options keyword as
1460 a string, and the value a list containing the keyword value, or
1461 nil."
1462 (mapconcat (lambda (pair)
1463 (pcase-let ((`(,keyword ,value) pair))
1464 (concat keyword
1465 (and (> (length value) 0)
1466 (concat "=" value)))))
1467 options
1468 ","))
1470 (defun org-latex--wrap-label (element output info)
1471 "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
1472 INFO is the current export state, as a plist. This function
1473 should not be used for floats. See
1474 `org-latex--caption/label-string'."
1475 (if (not (and (org-string-nw-p output) (org-element-property :name element)))
1476 output
1477 (concat (format "\\phantomsection\n\\label{%s}\n"
1478 (org-latex--label element info))
1479 output)))
1481 (defun org-latex--protect-text (text)
1482 "Protect special characters in string TEXT and return it."
1483 (replace-regexp-in-string
1484 "--\\|[\\{}$%&_#~^]"
1485 (lambda (m)
1486 (cond ((equal m "--") "-{}-")
1487 ((equal m "\\") "\\textbackslash{}")
1488 ((equal m "~") "\\textasciitilde{}")
1489 ((equal m "^") "\\textasciicircum{}")
1490 (t (concat "\\" m))))
1491 text nil t))
1493 (defun org-latex--text-markup (text markup info)
1494 "Format TEXT depending on MARKUP text markup.
1495 INFO is a plist used as a communication channel. See
1496 `org-latex-text-markup-alist' for details."
1497 (let ((fmt (cdr (assq markup (plist-get info :latex-text-markup-alist)))))
1498 (cl-case fmt
1499 ;; No format string: Return raw text.
1500 ((nil) text)
1501 ;; Handle the `verb' special case: Find an appropriate separator
1502 ;; and use "\\verb" command.
1503 (verb
1504 (let ((separator (org-latex--find-verb-separator text)))
1505 (concat "\\verb" separator
1506 (replace-regexp-in-string "\n" " " text)
1507 separator)))
1508 ;; Handle the `protectedtexttt' special case: Protect some
1509 ;; special chars and use "\texttt{%s}" format string.
1510 (protectedtexttt
1511 (format "\\texttt{%s}" (org-latex--protect-text text)))
1512 ;; Else use format string.
1513 (t (format fmt text)))))
1515 (defun org-latex--delayed-footnotes-definitions (element info)
1516 "Return footnotes definitions in ELEMENT as a string.
1518 INFO is a plist used as a communication channel.
1520 Footnotes definitions are returned within \"\\footnotetext{}\"
1521 commands.
1523 This function is used within constructs that don't support
1524 \"\\footnote{}\" command (i.e. an item's tag). In that case,
1525 \"\\footnotemark\" is used within the construct and the function
1526 just outside of it."
1527 (mapconcat
1528 (lambda (ref)
1529 (format
1530 "\\footnotetext[%s]{%s}"
1531 (org-export-get-footnote-number ref info)
1532 (org-trim
1533 (org-export-data
1534 (org-export-get-footnote-definition ref info) info))))
1535 ;; Find every footnote reference in ELEMENT.
1536 (letrec ((all-refs nil)
1537 (search-refs
1538 (lambda (data)
1539 ;; Return a list of all footnote references never seen
1540 ;; before in DATA.
1541 (org-element-map data 'footnote-reference
1542 (lambda (ref)
1543 (when (org-export-footnote-first-reference-p ref info)
1544 (push ref all-refs)
1545 (when (eq (org-element-property :type ref) 'standard)
1546 (funcall search-refs
1547 (org-export-get-footnote-definition ref info)))))
1548 info)
1549 (reverse all-refs))))
1550 (funcall search-refs element))
1551 ""))
1553 (defun org-latex--translate (s info)
1554 "Translate string S according to specified language.
1555 INFO is a plist used as a communication channel."
1556 (org-export-translate s :latex info))
1558 (defun org-latex--format-spec (info)
1559 "Create a format-spec for document meta-data.
1560 INFO is a plist used as a communication channel."
1561 (let ((language (let ((lang (plist-get info :language)))
1562 (or (cdr (assoc-string lang org-latex-babel-language-alist t))
1563 (nth 1 (assoc-string lang org-latex-polyglossia-language-alist t))
1564 lang))))
1565 `((?a . ,(org-export-data (plist-get info :author) info))
1566 (?t . ,(org-export-data (plist-get info :title) info))
1567 (?k . ,(org-export-data (org-latex--wrap-latex-math-block
1568 (plist-get info :keywords) info)
1569 info))
1570 (?d . ,(org-export-data (org-latex--wrap-latex-math-block
1571 (plist-get info :description) info)
1572 info))
1573 (?c . ,(plist-get info :creator))
1574 (?l . ,language)
1575 (?L . ,(capitalize language))
1576 (?D . ,(org-export-get-date info)))))
1578 (defun org-latex--make-preamble (info)
1579 "Return a formatted LaTeX preamble.
1580 INFO is a plist used as a communication channel."
1581 (let* ((class (plist-get info :latex-class))
1582 (class-options (plist-get info :latex-class-options))
1583 (header (nth 1 (assoc class (plist-get info :latex-classes))))
1584 (document-class-string
1585 (and (stringp header)
1586 (if (not class-options) header
1587 (replace-regexp-in-string
1588 "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
1589 class-options header t nil 1)))))
1590 (if (not document-class-string)
1591 (user-error "Unknown LaTeX class `%s'" class)
1592 (org-latex-guess-polyglossia-language
1593 (org-latex-guess-babel-language
1594 (org-latex-guess-inputenc
1595 (org-element-normalize-string
1596 (org-splice-latex-header
1597 document-class-string
1598 (org-latex--remove-packages
1599 org-latex-default-packages-alist info)
1600 (org-latex--remove-packages
1601 org-latex-packages-alist info)
1603 (mapconcat 'org-element-normalize-string
1604 (list (plist-get info :latex-header)
1605 (plist-get info :latex-header-extra)) ""))))
1606 info)
1607 info))))
1609 (defun org-latex--insert-compiler (info)
1610 "Insert LaTeX_compiler info into the document.
1611 INFO is a plist used as a communication channel."
1612 (let ((compiler (plist-get info :latex-compiler)))
1613 (and (org-string-nw-p org-latex-compiler-file-string)
1614 (string-match-p (regexp-opt org-latex-compilers) (or compiler ""))
1615 (format org-latex-compiler-file-string compiler))))
1618 ;;; Template
1620 (defun org-latex-template (contents info)
1621 "Return complete document string after LaTeX conversion.
1622 CONTENTS is the transcoded contents string. INFO is a plist
1623 holding export options."
1624 (let ((title (org-export-data (plist-get info :title) info))
1625 (spec (org-latex--format-spec info)))
1626 (concat
1627 ;; Time-stamp.
1628 (and (plist-get info :time-stamp-file)
1629 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1630 ;; LaTeX compiler.
1631 (org-latex--insert-compiler info)
1632 ;; Document class and packages.
1633 (org-latex--make-preamble info)
1634 ;; Possibly limit depth for headline numbering.
1635 (let ((sec-num (plist-get info :section-numbers)))
1636 (when (integerp sec-num)
1637 (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
1638 ;; Author.
1639 (let ((author (and (plist-get info :with-author)
1640 (let ((auth (plist-get info :author)))
1641 (and auth (org-export-data auth info)))))
1642 (email (and (plist-get info :with-email)
1643 (org-export-data (plist-get info :email) info))))
1644 (cond ((and author email (not (string= "" email)))
1645 (format "\\author{%s\\thanks{%s}}\n" author email))
1646 ((or author email) (format "\\author{%s}\n" (or author email)))))
1647 ;; Date.
1648 (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
1649 (format "\\date{%s}\n" (org-export-data date info)))
1650 ;; Title and subtitle.
1651 (let* ((subtitle (plist-get info :subtitle))
1652 (formatted-subtitle
1653 (when subtitle
1654 (format (plist-get info :latex-subtitle-format)
1655 (org-export-data subtitle info))))
1656 (separate (plist-get info :latex-subtitle-separate)))
1657 (concat
1658 (format "\\title{%s%s}\n" title
1659 (if separate "" (or formatted-subtitle "")))
1660 (when (and separate subtitle)
1661 (concat formatted-subtitle "\n"))))
1662 ;; Hyperref options.
1663 (let ((template (plist-get info :latex-hyperref-template)))
1664 (and (stringp template)
1665 (format-spec template spec)))
1666 ;; Document start.
1667 "\\begin{document}\n\n"
1668 ;; Title command.
1669 (let* ((title-command (plist-get info :latex-title-command))
1670 (command (and (stringp title-command)
1671 (format-spec title-command spec))))
1672 (org-element-normalize-string
1673 (cond ((not (plist-get info :with-title)) nil)
1674 ((string= "" title) nil)
1675 ((not (stringp command)) nil)
1676 ((string-match "\\(?:[^%]\\|^\\)%s" command)
1677 (format command title))
1678 (t command))))
1679 ;; Table of contents.
1680 (let ((depth (plist-get info :with-toc)))
1681 (when depth
1682 (concat (when (wholenump depth)
1683 (format "\\setcounter{tocdepth}{%d}\n" depth))
1684 (plist-get info :latex-toc-command))))
1685 ;; Document's body.
1686 contents
1687 ;; Creator.
1688 (and (plist-get info :with-creator)
1689 (concat (plist-get info :creator) "\n"))
1690 ;; Document end.
1691 "\\end{document}")))
1695 ;;; Transcode Functions
1697 ;;;; Bold
1699 (defun org-latex-bold (_bold contents info)
1700 "Transcode BOLD from Org to LaTeX.
1701 CONTENTS is the text with bold markup. INFO is a plist holding
1702 contextual information."
1703 (org-latex--text-markup contents 'bold info))
1706 ;;;; Center Block
1708 (defun org-latex-center-block (center-block contents info)
1709 "Transcode a CENTER-BLOCK element from Org to LaTeX.
1710 CONTENTS holds the contents of the center block. INFO is a plist
1711 holding contextual information."
1712 (org-latex--wrap-label
1713 center-block (format "\\begin{center}\n%s\\end{center}" contents) info))
1716 ;;;; Clock
1718 (defun org-latex-clock (clock _contents info)
1719 "Transcode a CLOCK element from Org to LaTeX.
1720 CONTENTS is nil. INFO is a plist holding contextual
1721 information."
1722 (concat
1723 "\\noindent"
1724 (format "\\textbf{%s} " org-clock-string)
1725 (format (plist-get info :latex-inactive-timestamp-format)
1726 (concat (org-timestamp-translate (org-element-property :value clock))
1727 (let ((time (org-element-property :duration clock)))
1728 (and time (format " (%s)" time)))))
1729 "\\\\"))
1732 ;;;; Code
1734 (defun org-latex-code (code _contents info)
1735 "Transcode a CODE object from Org to LaTeX.
1736 CONTENTS is nil. INFO is a plist used as a communication
1737 channel."
1738 (org-latex--text-markup (org-element-property :value code) 'code info))
1741 ;;;; Drawer
1743 (defun org-latex-drawer (drawer contents info)
1744 "Transcode a DRAWER element from Org to LaTeX.
1745 CONTENTS holds the contents of the block. INFO is a plist
1746 holding contextual information."
1747 (let* ((name (org-element-property :drawer-name drawer))
1748 (output (funcall (plist-get info :latex-format-drawer-function)
1749 name contents)))
1750 (org-latex--wrap-label drawer output info)))
1753 ;;;; Dynamic Block
1755 (defun org-latex-dynamic-block (dynamic-block contents info)
1756 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
1757 CONTENTS holds the contents of the block. INFO is a plist
1758 holding contextual information. See `org-export-data'."
1759 (org-latex--wrap-label dynamic-block contents info))
1762 ;;;; Entity
1764 (defun org-latex-entity (entity _contents _info)
1765 "Transcode an ENTITY object from Org to LaTeX.
1766 CONTENTS are the definition itself. INFO is a plist holding
1767 contextual information."
1768 (org-element-property :latex entity))
1771 ;;;; Example Block
1773 (defun org-latex-example-block (example-block _contents info)
1774 "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
1775 CONTENTS is nil. INFO is a plist holding contextual
1776 information."
1777 (when (org-string-nw-p (org-element-property :value example-block))
1778 (let ((environment (or (org-export-read-attribute
1779 :attr_latex example-block :environment)
1780 "verbatim")))
1781 (org-latex--wrap-label
1782 example-block
1783 (format "\\begin{%s}\n%s\\end{%s}"
1784 environment
1785 (org-export-format-code-default example-block info)
1786 environment)
1787 info))))
1790 ;;;; Export Block
1792 (defun org-latex-export-block (export-block _contents _info)
1793 "Transcode a EXPORT-BLOCK element from Org to LaTeX.
1794 CONTENTS is nil. INFO is a plist holding contextual information."
1795 (when (member (org-element-property :type export-block) '("LATEX" "TEX"))
1796 (org-remove-indentation (org-element-property :value export-block))))
1799 ;;;; Export Snippet
1801 (defun org-latex-export-snippet (export-snippet _contents _info)
1802 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
1803 CONTENTS is nil. INFO is a plist holding contextual information."
1804 (when (eq (org-export-snippet-backend export-snippet) 'latex)
1805 (org-element-property :value export-snippet)))
1808 ;;;; Fixed Width
1810 (defun org-latex-fixed-width (fixed-width _contents info)
1811 "Transcode a FIXED-WIDTH element from Org to LaTeX.
1812 CONTENTS is nil. INFO is a plist holding contextual information."
1813 (org-latex--wrap-label
1814 fixed-width
1815 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1816 (org-remove-indentation
1817 (org-element-property :value fixed-width)))
1818 info))
1821 ;;;; Footnote Reference
1823 (defun org-latex-footnote-reference (footnote-reference _contents info)
1824 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1825 CONTENTS is nil. INFO is a plist holding contextual information."
1826 (let ((label (org-element-property :label footnote-reference)))
1827 (concat
1828 ;; Insert separator between two footnotes in a row.
1829 (let ((prev (org-export-get-previous-element footnote-reference info)))
1830 (when (eq (org-element-type prev) 'footnote-reference)
1831 (plist-get info :latex-footnote-separator)))
1832 (cond
1833 ;; Use `:latex-footnote-defined-format' if the footnote has
1834 ;; already been defined.
1835 ((not (org-export-footnote-first-reference-p footnote-reference info))
1836 (format (plist-get info :latex-footnote-defined-format)
1837 (org-latex--label
1838 (org-export-get-footnote-definition footnote-reference info)
1839 info t)))
1840 ;; Use \footnotemark if reference is within another footnote
1841 ;; reference, footnote definition or table cell.
1842 ((org-element-lineage footnote-reference
1843 '(footnote-reference footnote-definition table-cell))
1844 "\\footnotemark")
1845 ;; Otherwise, define it with \footnote command.
1847 (let ((def (org-export-get-footnote-definition footnote-reference info)))
1848 (concat
1849 (format "\\footnote{%s%s}" (org-trim (org-export-data def info))
1850 ;; Only insert a \label if there exist another
1851 ;; reference to def.
1852 (cond ((not label) "")
1853 ((org-element-map (plist-get info :parse-tree) 'footnote-reference
1854 (lambda (f)
1855 (and (not (eq f footnote-reference))
1856 (equal (org-element-property :label f) label)
1857 (org-trim (org-latex--label def info t t))))
1858 info t))
1859 (t "")))
1860 ;; Retrieve all footnote references within the footnote and
1861 ;; add their definition after it, since LaTeX doesn't support
1862 ;; them inside.
1863 (org-latex--delayed-footnotes-definitions def info))))))))
1866 ;;;; Headline
1868 (defun org-latex-headline (headline contents info)
1869 "Transcode a HEADLINE element from Org to LaTeX.
1870 CONTENTS holds the contents of the headline. INFO is a plist
1871 holding contextual information."
1872 (unless (org-element-property :footnote-section-p headline)
1873 (let* ((class (plist-get info :latex-class))
1874 (level (org-export-get-relative-level headline info))
1875 (numberedp (org-export-numbered-headline-p headline info))
1876 (class-sectioning (assoc class (plist-get info :latex-classes)))
1877 ;; Section formatting will set two placeholders: one for
1878 ;; the title and the other for the contents.
1879 (section-fmt
1880 (let ((sec (if (functionp (nth 2 class-sectioning))
1881 (funcall (nth 2 class-sectioning) level numberedp)
1882 (nth (1+ level) class-sectioning))))
1883 (cond
1884 ;; No section available for that LEVEL.
1885 ((not sec) nil)
1886 ;; Section format directly returned by a function. Add
1887 ;; placeholder for contents.
1888 ((stringp sec) (concat sec "\n%s"))
1889 ;; (numbered-section . unnumbered-section)
1890 ((not (consp (cdr sec)))
1891 (concat (funcall (if numberedp #'car #'cdr) sec) "\n%s"))
1892 ;; (numbered-open numbered-close)
1893 ((= (length sec) 2)
1894 (when numberedp (concat (car sec) "\n%s" (nth 1 sec))))
1895 ;; (num-in num-out no-num-in no-num-out)
1896 ((= (length sec) 4)
1897 (if numberedp (concat (car sec) "\n%s" (nth 1 sec))
1898 (concat (nth 2 sec) "\n%s" (nth 3 sec)))))))
1899 ;; Create a temporary export back-end that hard-codes
1900 ;; "\underline" within "\section" and alike.
1901 (section-back-end
1902 (org-export-create-backend
1903 :parent 'latex
1904 :transcoders
1905 '((underline . (lambda (o c i) (format "\\underline{%s}" c))))))
1906 (text
1907 (org-export-data-with-backend
1908 (org-element-property :title headline) section-back-end info))
1909 (todo
1910 (and (plist-get info :with-todo-keywords)
1911 (let ((todo (org-element-property :todo-keyword headline)))
1912 (and todo (org-export-data todo info)))))
1913 (todo-type (and todo (org-element-property :todo-type headline)))
1914 (tags (and (plist-get info :with-tags)
1915 (org-export-get-tags headline info)))
1916 (priority (and (plist-get info :with-priority)
1917 (org-element-property :priority headline)))
1918 ;; Create the headline text along with a no-tag version.
1919 ;; The latter is required to remove tags from toc.
1920 (full-text (funcall (plist-get info :latex-format-headline-function)
1921 todo todo-type priority text tags info))
1922 ;; Associate \label to the headline for internal links.
1923 (headline-label (org-latex--label headline info t t))
1924 (pre-blanks
1925 (make-string (org-element-property :pre-blank headline) ?\n)))
1926 (if (or (not section-fmt) (org-export-low-level-p headline info))
1927 ;; This is a deep sub-tree: export it as a list item. Also
1928 ;; export as items headlines for which no section format has
1929 ;; been found.
1930 (let ((low-level-body
1931 (concat
1932 ;; If headline is the first sibling, start a list.
1933 (when (org-export-first-sibling-p headline info)
1934 (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize)))
1935 ;; Itemize headline
1936 "\\item"
1937 (and full-text
1938 (string-match-p "\\`[ \t]*\\[" full-text)
1939 "\\relax")
1940 " " full-text "\n"
1941 headline-label
1942 pre-blanks
1943 contents)))
1944 ;; If headline is not the last sibling simply return
1945 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
1946 ;; any blank line.
1947 (if (not (org-export-last-sibling-p headline info)) low-level-body
1948 (replace-regexp-in-string
1949 "[ \t\n]*\\'"
1950 (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize))
1951 low-level-body)))
1952 ;; This is a standard headline. Export it as a section. Add
1953 ;; an alternative heading when possible, and when this is not
1954 ;; identical to the usual heading.
1955 (let ((opt-title
1956 (funcall (plist-get info :latex-format-headline-function)
1957 todo todo-type priority
1958 (org-export-data-with-backend
1959 (org-export-get-alt-title headline info)
1960 section-back-end info)
1961 (and (eq (plist-get info :with-tags) t) tags)
1962 info))
1963 ;; Maybe end local TOC (see `org-latex-keyword').
1964 (contents
1965 (concat
1966 contents
1967 (let ((case-fold-search t)
1968 (section
1969 (let ((first (car (org-element-contents headline))))
1970 (and (eq (org-element-type first) 'section) first))))
1971 (org-element-map section 'keyword
1972 (lambda (k)
1973 (and (equal (org-element-property :key k) "TOC")
1974 (let ((v (org-element-property :value k)))
1975 (and (string-match-p "\\<headlines\\>" v)
1976 (string-match-p "\\<local\\>" v)
1977 (format "\\stopcontents[level-%d]" level)))))
1978 info t)))))
1979 (if (and opt-title
1980 (not (equal opt-title full-text))
1981 (string-match "\\`\\\\\\(.+?\\){" section-fmt))
1982 (format (replace-match "\\1[%s]" nil nil section-fmt 1)
1983 ;; Replace square brackets with parenthesis
1984 ;; since square brackets are not supported in
1985 ;; optional arguments.
1986 (replace-regexp-in-string
1987 "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title))
1988 full-text
1989 (concat headline-label pre-blanks contents))
1990 ;; Impossible to add an alternative heading. Fallback to
1991 ;; regular sectioning format string.
1992 (format section-fmt full-text
1993 (concat headline-label pre-blanks contents))))))))
1995 (defun org-latex-format-headline-default-function
1996 (todo _todo-type priority text tags info)
1997 "Default format function for a headline.
1998 See `org-latex-format-headline-function' for details."
1999 (concat
2000 (and todo (format "{\\bfseries\\sffamily %s} " todo))
2001 (and priority (format "\\framebox{\\#%c} " priority))
2002 text
2003 (and tags
2004 (format "\\hfill{}\\textsc{%s}"
2005 (mapconcat (lambda (tag) (org-latex-plain-text tag info))
2006 tags ":")))))
2009 ;;;; Horizontal Rule
2011 (defun org-latex-horizontal-rule (horizontal-rule _contents info)
2012 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
2013 CONTENTS is nil. INFO is a plist holding contextual information."
2014 (let ((attr (org-export-read-attribute :attr_latex horizontal-rule))
2015 (prev (org-export-get-previous-element horizontal-rule info)))
2016 (concat
2017 ;; Make sure the rule doesn't start at the end of the current
2018 ;; line by separating it with a blank line from previous element.
2019 (when (and prev
2020 (let ((prev-blank (org-element-property :post-blank prev)))
2021 (or (not prev-blank) (zerop prev-blank))))
2022 "\n")
2023 (org-latex--wrap-label
2024 horizontal-rule
2025 (format "\\rule{%s}{%s}"
2026 (or (plist-get attr :width) "\\linewidth")
2027 (or (plist-get attr :thickness) "0.5pt"))
2028 info))))
2031 ;;;; Inline Src Block
2033 (defun org-latex-inline-src-block (inline-src-block _contents info)
2034 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
2035 CONTENTS holds the contents of the item. INFO is a plist holding
2036 contextual information."
2037 (let* ((code (org-element-property :value inline-src-block))
2038 (separator (org-latex--find-verb-separator code)))
2039 (cl-case (plist-get info :latex-listings)
2040 ;; Do not use a special package: transcode it verbatim.
2041 ((nil) (format "\\texttt{%s}" (org-latex--protect-text code)))
2042 ;; Use minted package.
2043 (minted
2044 (let* ((org-lang (org-element-property :language inline-src-block))
2045 (mint-lang (or (cadr (assq (intern org-lang)
2046 (plist-get info :latex-minted-langs)))
2047 (downcase org-lang)))
2048 (options (org-latex--make-option-string
2049 (plist-get info :latex-minted-options))))
2050 (format "\\mintinline%s{%s}{%s}"
2051 (if (string= options "") "" (format "[%s]" options))
2052 mint-lang
2053 code)))
2054 ;; Use listings package.
2055 (otherwise
2056 ;; Maybe translate language's name.
2057 (let* ((org-lang (org-element-property :language inline-src-block))
2058 (lst-lang (or (cadr (assq (intern org-lang)
2059 (plist-get info :latex-listings-langs)))
2060 org-lang))
2061 (options (org-latex--make-option-string
2062 (append (plist-get info :latex-listings-options)
2063 `(("language" ,lst-lang))))))
2064 (concat (format "\\lstinline[%s]" options)
2065 separator code separator))))))
2068 ;;;; Inlinetask
2070 (defun org-latex-inlinetask (inlinetask contents info)
2071 "Transcode an INLINETASK element from Org to LaTeX.
2072 CONTENTS holds the contents of the block. INFO is a plist
2073 holding contextual information."
2074 (let ((title (org-export-data (org-element-property :title inlinetask) info))
2075 (todo (and (plist-get info :with-todo-keywords)
2076 (let ((todo (org-element-property :todo-keyword inlinetask)))
2077 (and todo (org-export-data todo info)))))
2078 (todo-type (org-element-property :todo-type inlinetask))
2079 (tags (and (plist-get info :with-tags)
2080 (org-export-get-tags inlinetask info)))
2081 (priority (and (plist-get info :with-priority)
2082 (org-element-property :priority inlinetask)))
2083 (contents (concat (org-latex--label inlinetask info) contents)))
2084 (funcall (plist-get info :latex-format-inlinetask-function)
2085 todo todo-type priority title tags contents info)))
2087 (defun org-latex-format-inlinetask-default-function
2088 (todo _todo-type priority title tags contents info)
2089 "Default format function for a inlinetasks.
2090 See `org-latex-format-inlinetask-function' for details."
2091 (let ((full-title
2092 (concat (when todo (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
2093 (when priority (format "\\framebox{\\#%c} " priority))
2094 title
2095 (when tags
2096 (format "\\hfill{}\\textsc{:%s:}"
2097 (mapconcat
2098 (lambda (tag) (org-latex-plain-text tag info))
2099 tags ":"))))))
2100 (concat "\\begin{center}\n"
2101 "\\fbox{\n"
2102 "\\begin{minipage}[c]{.6\\textwidth}\n"
2103 full-title "\n\n"
2104 (and (org-string-nw-p contents)
2105 (concat "\\rule[.8em]{\\textwidth}{2pt}\n\n" contents))
2106 "\\end{minipage}\n"
2107 "}\n"
2108 "\\end{center}")))
2111 ;;;; Italic
2113 (defun org-latex-italic (_italic contents info)
2114 "Transcode ITALIC from Org to LaTeX.
2115 CONTENTS is the text with italic markup. INFO is a plist holding
2116 contextual information."
2117 (org-latex--text-markup contents 'italic info))
2120 ;;;; Item
2122 (defun org-latex-item (item contents info)
2123 "Transcode an ITEM element from Org to LaTeX.
2124 CONTENTS holds the contents of the item. INFO is a plist holding
2125 contextual information."
2126 (let* ((counter
2127 (let ((count (org-element-property :counter item))
2128 (level
2129 ;; Determine level of current item to determine the
2130 ;; correct LaTeX counter to use (enumi, enumii...).
2131 (let ((parent item) (level 0))
2132 (while (memq (org-element-type
2133 (setq parent (org-export-get-parent parent)))
2134 '(plain-list item))
2135 (when (and (eq (org-element-type parent) 'plain-list)
2136 (eq (org-element-property :type parent)
2137 'ordered))
2138 (cl-incf level)))
2139 level)))
2140 (and count
2141 (< level 5)
2142 (format "\\setcounter{enum%s}{%s}\n"
2143 (nth (1- level) '("i" "ii" "iii" "iv"))
2144 (1- count)))))
2145 (checkbox (cl-case (org-element-property :checkbox item)
2146 (on "$\\boxtimes$ ")
2147 (off "$\\square$ ")
2148 (trans "$\\boxminus$ ")))
2149 (tag (let ((tag (org-element-property :tag item)))
2150 ;; Check-boxes must belong to the tag.
2151 (and tag (format "[{%s}] "
2152 (concat checkbox
2153 (org-export-data tag info)))))))
2154 (concat counter
2155 "\\item"
2156 (cond
2157 (tag)
2158 (checkbox (concat " " checkbox))
2159 ;; Without a tag or a check-box, if CONTENTS starts with
2160 ;; an opening square bracket, add "\relax" to "\item",
2161 ;; unless the brackets comes from an initial export
2162 ;; snippet (i.e. it is inserted willingly by the user).
2163 ((and contents
2164 (string-match-p "\\`[ \t]*\\[" contents)
2165 (not (let ((e (car (org-element-contents item))))
2166 (and (eq (org-element-type e) 'paragraph)
2167 (let ((o (car (org-element-contents e))))
2168 (and (eq (org-element-type o) 'export-snippet)
2169 (eq (org-export-snippet-backend o)
2170 'latex)))))))
2171 "\\relax ")
2172 (t " "))
2173 (and contents (org-trim contents))
2174 ;; If there are footnotes references in tag, be sure to
2175 ;; add their definition at the end of the item. This
2176 ;; workaround is necessary since "\footnote{}" command is
2177 ;; not supported in tags.
2178 (and tag
2179 (org-latex--delayed-footnotes-definitions
2180 (org-element-property :tag item) info)))))
2183 ;;;; Keyword
2185 (defun org-latex-keyword (keyword _contents info)
2186 "Transcode a KEYWORD element from Org to LaTeX.
2187 CONTENTS is nil. INFO is a plist holding contextual information."
2188 (let ((key (org-element-property :key keyword))
2189 (value (org-element-property :value keyword)))
2190 (cond
2191 ((string= key "LATEX") value)
2192 ((string= key "INDEX") (format "\\index{%s}" value))
2193 ((string= key "TOC")
2194 (let ((case-fold-search t))
2195 (cond
2196 ((string-match-p "\\<headlines\\>" value)
2197 (let* ((localp (string-match-p "\\<local\\>" value))
2198 (parent (org-element-lineage keyword '(headline)))
2199 (level (if (not (and localp parent)) 0
2200 (org-export-get-relative-level parent info)))
2201 (depth
2202 (and (string-match "\\<[0-9]+\\>" value)
2203 (format
2204 "\\setcounter{tocdepth}{%d}"
2205 (+ (string-to-number (match-string 0 value)) level)))))
2206 (if (and localp parent)
2207 ;; Start local TOC, assuming package "titletoc" is
2208 ;; required.
2209 (format "\\startcontents[level-%d]
2210 \\printcontents[level-%d]{}{0}{%s}"
2211 level level (or depth ""))
2212 (concat depth (and depth "\n") "\\tableofcontents"))))
2213 ((string-match-p "\\<tables\\>" value) "\\listoftables")
2214 ((string-match-p "\\<listings\\>" value)
2215 (cl-case (plist-get info :latex-listings)
2216 ((nil) "\\listoffigures")
2217 (minted "\\listoflistings")
2218 (otherwise "\\lstlistoflistings")))))))))
2221 ;;;; Latex Environment
2223 (defun org-latex-latex-environment (latex-environment _contents info)
2224 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
2225 CONTENTS is nil. INFO is a plist holding contextual information."
2226 (when (plist-get info :with-latex)
2227 (let ((value (org-remove-indentation
2228 (org-element-property :value latex-environment))))
2229 (if (not (org-element-property :name latex-environment)) value
2230 ;; Environment is labeled: label must be within the environment
2231 ;; (otherwise, a reference pointing to that element will count
2232 ;; the section instead).
2233 (with-temp-buffer
2234 (insert value)
2235 (goto-char (point-min))
2236 (forward-line)
2237 (insert (org-latex--label latex-environment info nil t))
2238 (buffer-string))))))
2241 ;;;; Latex Fragment
2243 (defun org-latex-latex-fragment (latex-fragment _contents _info)
2244 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
2245 CONTENTS is nil. INFO is a plist holding contextual information."
2246 (let ((value (org-element-property :value latex-fragment)))
2247 ;; Trim math markers since the fragment is enclosed within
2248 ;; a latex-math-block object anyway.
2249 (cond ((string-match-p "\\`\\$[^$]" value) (substring value 1 -1))
2250 ((string-prefix-p "\\(" value) (substring value 2 -2))
2251 (t value))))
2254 ;;;; Line Break
2256 (defun org-latex-line-break (_line-break _contents _info)
2257 "Transcode a LINE-BREAK object from Org to LaTeX.
2258 CONTENTS is nil. INFO is a plist holding contextual information."
2259 "\\\\\n")
2262 ;;;; Link
2264 (defun org-latex--inline-image (link info)
2265 "Return LaTeX code for an inline image.
2266 LINK is the link pointing to the inline image. INFO is a plist
2267 used as a communication channel."
2268 (let* ((parent (org-export-get-parent-element link))
2269 (path (let ((raw-path (org-element-property :path link)))
2270 (if (not (file-name-absolute-p raw-path)) raw-path
2271 (expand-file-name raw-path))))
2272 (filetype (file-name-extension path))
2273 (caption (org-latex--caption/label-string parent info))
2274 (caption-above-p (org-latex--caption-above-p link info))
2275 ;; Retrieve latex attributes from the element around.
2276 (attr (org-export-read-attribute :attr_latex parent))
2277 (float (let ((float (plist-get attr :float)))
2278 (cond ((string= float "wrap") 'wrap)
2279 ((string= float "sideways") 'sideways)
2280 ((string= float "multicolumn") 'multicolumn)
2281 ((and (plist-member attr :float) (not float)) 'nonfloat)
2282 ((or float
2283 (org-element-property :caption parent)
2284 (org-string-nw-p (plist-get attr :caption)))
2285 'figure)
2286 (t 'nonfloat))))
2287 (placement
2288 (let ((place (plist-get attr :placement)))
2289 (cond
2290 (place (format "%s" place))
2291 ((eq float 'wrap) "{l}{0.5\\textwidth}")
2292 ((eq float 'figure)
2293 (format "[%s]" (plist-get info :latex-default-figure-position)))
2294 (t ""))))
2295 (center
2296 (if (plist-member attr :center) (plist-get attr :center)
2297 (plist-get info :latex-images-centered)))
2298 (comment-include (if (plist-get attr :comment-include) "%" ""))
2299 ;; It is possible to specify width and height in the
2300 ;; ATTR_LATEX line, and also via default variables.
2301 (width (cond ((plist-get attr :width))
2302 ((plist-get attr :height) "")
2303 ((eq float 'wrap) "0.48\\textwidth")
2304 (t (plist-get info :latex-image-default-width))))
2305 (height (cond ((plist-get attr :height))
2306 ((or (plist-get attr :width)
2307 (memq float '(figure wrap))) "")
2308 (t (plist-get info :latex-image-default-height))))
2309 (options (let ((opt (or (plist-get attr :options)
2310 (plist-get info :latex-image-default-option))))
2311 (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt)) opt
2312 (match-string 1 opt))))
2313 image-code)
2314 (if (member filetype '("tikz" "pgf"))
2315 ;; For tikz images:
2316 ;; - use \input to read in image file.
2317 ;; - if options are present, wrap in a tikzpicture environment.
2318 ;; - if width or height are present, use \resizebox to change
2319 ;; the image size.
2320 (progn
2321 (setq image-code (format "\\input{%s}" path))
2322 (when (org-string-nw-p options)
2323 (setq image-code
2324 (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
2325 options
2326 image-code)))
2327 (when (or (org-string-nw-p width) (org-string-nw-p height))
2328 (setq image-code (format "\\resizebox{%s}{%s}{%s}"
2329 (if (org-string-nw-p width) width "!")
2330 (if (org-string-nw-p height) height "!")
2331 image-code))))
2332 ;; For other images:
2333 ;; - add width and height to options.
2334 ;; - include the image with \includegraphics.
2335 (when (org-string-nw-p width)
2336 (setq options (concat options ",width=" width)))
2337 (when (org-string-nw-p height)
2338 (setq options (concat options ",height=" height)))
2339 (let ((search-option (org-element-property :search-option link)))
2340 (when (and search-option
2341 (equal filetype "pdf")
2342 (string-match-p "\\`[0-9]+\\'" search-option)
2343 (not (string-match-p "page=" options)))
2344 (setq options (concat options ",page=" search-option))))
2345 (setq image-code
2346 (format "\\includegraphics%s{%s}"
2347 (cond ((not (org-string-nw-p options)) "")
2348 ((string-prefix-p "," options)
2349 (format "[%s]" (substring options 1)))
2350 (t (format "[%s]" options)))
2351 path))
2352 (when (equal filetype "svg")
2353 (setq image-code (replace-regexp-in-string "^\\\\includegraphics"
2354 "\\includesvg"
2355 image-code
2356 nil t))
2357 (setq image-code (replace-regexp-in-string "\\.svg}"
2359 image-code
2360 nil t))))
2361 ;; Return proper string, depending on FLOAT.
2362 (pcase float
2363 (`wrap (format "\\begin{wrapfigure}%s
2364 %s%s
2365 %s%s
2366 %s\\end{wrapfigure}"
2367 placement
2368 (if caption-above-p caption "")
2369 (if center "\\centering" "")
2370 comment-include image-code
2371 (if caption-above-p "" caption)))
2372 (`sideways (format "\\begin{sidewaysfigure}
2373 %s%s
2374 %s%s
2375 %s\\end{sidewaysfigure}"
2376 (if caption-above-p caption "")
2377 (if center "\\centering" "")
2378 comment-include image-code
2379 (if caption-above-p "" caption)))
2380 (`multicolumn (format "\\begin{figure*}%s
2381 %s%s
2382 %s%s
2383 %s\\end{figure*}"
2384 placement
2385 (if caption-above-p caption "")
2386 (if center "\\centering" "")
2387 comment-include image-code
2388 (if caption-above-p "" caption)))
2389 (`figure (format "\\begin{figure}%s
2390 %s%s
2391 %s%s
2392 %s\\end{figure}"
2393 placement
2394 (if caption-above-p caption "")
2395 (if center "\\centering" "")
2396 comment-include image-code
2397 (if caption-above-p "" caption)))
2398 ((guard center)
2399 (format "\\begin{center}
2400 %s%s
2401 %s\\end{center}"
2402 (if caption-above-p caption "")
2403 image-code
2404 (if caption-above-p "" caption)))
2406 (concat (if caption-above-p caption "")
2407 image-code
2408 (if caption-above-p caption ""))))))
2410 (defun org-latex-link (link desc info)
2411 "Transcode a LINK object from Org to LaTeX.
2413 DESC is the description part of the link, or the empty string.
2414 INFO is a plist holding contextual information. See
2415 `org-export-data'."
2416 (let* ((type (org-element-property :type link))
2417 (raw-path (replace-regexp-in-string
2418 "%" "\\%" (org-element-property :path link) nil t))
2419 ;; Ensure DESC really exists, or set it to nil.
2420 (desc (and (not (string= desc "")) desc))
2421 (imagep (org-export-inline-image-p
2422 link (plist-get info :latex-inline-image-rules)))
2423 (path (cond
2424 ((member type '("http" "https" "ftp" "mailto" "doi"))
2425 (concat type ":" raw-path))
2426 ((string= type "file") (org-export-file-uri raw-path))
2427 (t raw-path))))
2428 (cond
2429 ;; Link type is handled by a special function.
2430 ((org-export-custom-protocol-maybe link desc 'latex))
2431 ;; Image file.
2432 (imagep (org-latex--inline-image link info))
2433 ;; Radio link: Transcode target's contents and use them as link's
2434 ;; description.
2435 ((string= type "radio")
2436 (let ((destination (org-export-resolve-radio-link link info)))
2437 (if (not destination) desc
2438 (format "\\hyperref[%s]{%s}"
2439 (org-export-get-reference destination info)
2440 desc))))
2441 ;; Links pointing to a headline: Find destination and build
2442 ;; appropriate referencing command.
2443 ((member type '("custom-id" "fuzzy" "id"))
2444 (let ((destination (if (string= type "fuzzy")
2445 (org-export-resolve-fuzzy-link link info)
2446 (org-export-resolve-id-link link info))))
2447 (cl-case (org-element-type destination)
2448 ;; Id link points to an external file.
2449 (plain-text
2450 (if desc (format "\\href{%s}{%s}" destination desc)
2451 (format "\\url{%s}" destination)))
2452 ;; Fuzzy link points nowhere.
2453 ((nil)
2454 (format (plist-get info :latex-link-with-unknown-path-format)
2455 (or desc
2456 (org-export-data
2457 (org-element-property :raw-link link) info))))
2458 ;; LINK points to a headline. If headlines are numbered
2459 ;; and the link has no description, display headline's
2460 ;; number. Otherwise, display description or headline's
2461 ;; title.
2462 (headline
2463 (let ((label (org-latex--label destination info t)))
2464 (if (and (not desc)
2465 (org-export-numbered-headline-p destination info))
2466 (format "\\ref{%s}" label)
2467 (format "\\hyperref[%s]{%s}" label
2468 (or desc
2469 (org-export-data
2470 (org-element-property :title destination) info))))))
2471 ;; Fuzzy link points to a target. Do as above.
2472 (otherwise
2473 (let ((ref (org-latex--label destination info t)))
2474 (if (not desc) (format "\\ref{%s}" ref)
2475 (format "\\hyperref[%s]{%s}" ref desc)))))))
2476 ;; Coderef: replace link with the reference name or the
2477 ;; equivalent line number.
2478 ((string= type "coderef")
2479 (format (org-export-get-coderef-format path desc)
2480 (org-export-resolve-coderef path info)))
2481 ;; External link with a description part.
2482 ((and path desc) (format "\\href{%s}{%s}" path desc))
2483 ;; External link without a description part.
2484 (path (format "\\url{%s}" path))
2485 ;; No path, only description. Try to do something useful.
2486 (t (format (plist-get info :latex-link-with-unknown-path-format) desc)))))
2489 ;;;; Node Property
2491 (defun org-latex-node-property (node-property _contents _info)
2492 "Transcode a NODE-PROPERTY element from Org to LaTeX.
2493 CONTENTS is nil. INFO is a plist holding contextual
2494 information."
2495 (format "%s:%s"
2496 (org-element-property :key node-property)
2497 (let ((value (org-element-property :value node-property)))
2498 (if value (concat " " value) ""))))
2501 ;;;; Paragraph
2503 (defun org-latex-paragraph (_paragraph contents _info)
2504 "Transcode a PARAGRAPH element from Org to LaTeX.
2505 CONTENTS is the contents of the paragraph, as a string. INFO is
2506 the plist used as a communication channel."
2507 contents)
2510 ;;;; Plain List
2512 (defun org-latex-plain-list (plain-list contents info)
2513 "Transcode a PLAIN-LIST element from Org to LaTeX.
2514 CONTENTS is the contents of the list. INFO is a plist holding
2515 contextual information."
2516 (let* ((type (org-element-property :type plain-list))
2517 (attr (org-export-read-attribute :attr_latex plain-list))
2518 (latex-type (let ((env (plist-get attr :environment)))
2519 (cond (env (format "%s" env))
2520 ((eq type 'ordered) "enumerate")
2521 ((eq type 'descriptive) "description")
2522 (t "itemize")))))
2523 (org-latex--wrap-label
2524 plain-list
2525 (format "\\begin{%s}%s\n%s\\end{%s}"
2526 latex-type
2527 (or (plist-get attr :options) "")
2528 contents
2529 latex-type)
2530 info)))
2533 ;;;; Plain Text
2535 (defun org-latex-plain-text (text info)
2536 "Transcode a TEXT string from Org to LaTeX.
2537 TEXT is the string to transcode. INFO is a plist holding
2538 contextual information."
2539 (let* ((specialp (plist-get info :with-special-strings))
2540 (output
2541 ;; Turn LaTeX into \LaTeX{} and TeX into \TeX{}.
2542 (let ((case-fold-search nil))
2543 (replace-regexp-in-string
2544 "\\<\\(?:La\\)?TeX\\>" "\\\\\\&{}"
2545 ;; Protect ^, ~, %, #, &, $, _, { and }. Also protect \.
2546 ;; However, if special strings are used, be careful not
2547 ;; to protect "\" in "\-" constructs.
2548 (replace-regexp-in-string
2549 (concat "[%$#&{}_~^]\\|\\\\" (and specialp "\\([^-]\\|$\\)"))
2550 (lambda (m)
2551 (cl-case (string-to-char m)
2552 (?\\ "$\\\\backslash$\\1")
2553 (?~ "\\\\textasciitilde{}")
2554 (?^ "\\\\^{}")
2555 (t "\\\\\\&")))
2556 text)))))
2557 ;; Activate smart quotes. Be sure to provide original TEXT string
2558 ;; since OUTPUT may have been modified.
2559 (when (plist-get info :with-smart-quotes)
2560 (setq output (org-export-activate-smart-quotes output :latex info text)))
2561 ;; Convert special strings.
2562 (when specialp
2563 (setq output (replace-regexp-in-string "\\.\\.\\." "\\\\ldots{}" output)))
2564 ;; Handle break preservation if required.
2565 (when (plist-get info :preserve-breaks)
2566 (setq output (replace-regexp-in-string
2567 "\\(?:[ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n" output nil t)))
2568 ;; Return value.
2569 output))
2572 ;;;; Planning
2574 (defun org-latex-planning (planning _contents info)
2575 "Transcode a PLANNING element from Org to LaTeX.
2576 CONTENTS is nil. INFO is a plist holding contextual
2577 information."
2578 (concat
2579 "\\noindent"
2580 (mapconcat
2581 'identity
2582 (delq nil
2583 (list
2584 (let ((closed (org-element-property :closed planning)))
2585 (when closed
2586 (concat
2587 (format "\\textbf{%s} " org-closed-string)
2588 (format (plist-get info :latex-inactive-timestamp-format)
2589 (org-timestamp-translate closed)))))
2590 (let ((deadline (org-element-property :deadline planning)))
2591 (when deadline
2592 (concat
2593 (format "\\textbf{%s} " org-deadline-string)
2594 (format (plist-get info :latex-active-timestamp-format)
2595 (org-timestamp-translate deadline)))))
2596 (let ((scheduled (org-element-property :scheduled planning)))
2597 (when scheduled
2598 (concat
2599 (format "\\textbf{%s} " org-scheduled-string)
2600 (format (plist-get info :latex-active-timestamp-format)
2601 (org-timestamp-translate scheduled)))))))
2602 " ")
2603 "\\\\"))
2606 ;;;; Property Drawer
2608 (defun org-latex-property-drawer (_property-drawer contents _info)
2609 "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
2610 CONTENTS holds the contents of the drawer. INFO is a plist
2611 holding contextual information."
2612 (and (org-string-nw-p contents)
2613 (format "\\begin{verbatim}\n%s\\end{verbatim}" contents)))
2616 ;;;; Pseudo Element: LaTeX Matrices
2618 ;; `latex-matrices' elements have the following properties:
2619 ;; `:caption', `:post-blank' and `:markup' (`inline', `equation' or
2620 ;; `math').
2622 (defun org-latex--wrap-latex-matrices (data info)
2623 "Merge contiguous tables with the same mode within a pseudo-element.
2624 DATA is a parse tree or a secondary string. INFO is a plist
2625 containing export options. Modify DATA by side-effect and return
2626 it."
2627 (org-element-map data 'table
2628 (lambda (table)
2629 (when (eq (org-element-property :type table) 'org)
2630 (let ((mode (or (org-export-read-attribute :attr_latex table :mode)
2631 (plist-get info :latex-default-table-mode))))
2632 (when (and (member mode '("inline-math" "math"))
2633 ;; Do not wrap twice the same table.
2634 (not (eq (org-element-type
2635 (org-element-property :parent table))
2636 'latex-matrices)))
2637 (let* ((caption (and (not (string= mode "inline-math"))
2638 (org-element-property :caption table)))
2639 (matrices
2640 (list 'latex-matrices
2641 (list :caption caption
2642 :markup
2643 (cond ((string= mode "inline-math") 'inline)
2644 (caption 'equation)
2645 (t 'math)))))
2646 (previous table)
2647 (next (org-export-get-next-element table info)))
2648 (org-element-insert-before matrices table)
2649 ;; Swallow all contiguous tables sharing the same mode.
2650 (while (and
2651 (zerop (or (org-element-property :post-blank previous) 0))
2652 (setq next (org-export-get-next-element previous info))
2653 (eq (org-element-type next) 'table)
2654 (eq (org-element-property :type next) 'org)
2655 (string= (or (org-export-read-attribute
2656 :attr_latex next :mode)
2657 (plist-get info :latex-default-table-mode))
2658 mode))
2659 (org-element-extract-element previous)
2660 (org-element-adopt-elements matrices previous)
2661 (setq previous next))
2662 (org-element-put-property
2663 matrices :post-blank (org-element-property :post-blank previous))
2664 (org-element-extract-element previous)
2665 (org-element-adopt-elements matrices previous))))))
2666 info)
2667 data)
2669 (defun org-latex-matrices (matrices contents _info)
2670 "Transcode a MATRICES element from Org to LaTeX.
2671 CONTENTS is a string. INFO is a plist used as a communication
2672 channel."
2673 (format (cl-case (org-element-property :markup matrices)
2674 (inline "\\(%s\\)")
2675 (equation "\\begin{equation}\n%s\\end{equation}")
2676 (t "\\[\n%s\\]"))
2677 contents))
2679 (defun org-latex-matrices-tree-filter (tree _backend info)
2680 (org-latex--wrap-latex-matrices tree info))
2682 ;;;; Pseudo Object: LaTeX Math Block
2684 ;; `latex-math-block' objects have the following property:
2685 ;; `:post-blank'.
2687 (defun org-latex--wrap-latex-math-block (data info)
2688 "Merge contiguous math objects in a pseudo-object container.
2689 DATA is a parse tree or a secondary string. INFO is a plist
2690 containing export options. Modify DATA by side-effect and return it."
2691 (let ((valid-object-p
2692 ;; Non-nil when OBJ can be added to the latex math block.
2693 (lambda (obj)
2694 (pcase (org-element-type obj)
2695 (`entity (org-element-property :latex-math-p obj))
2696 (`latex-fragment
2697 (let ((value (org-element-property :value obj)))
2698 (or (string-prefix-p "\\(" value)
2699 (string-match-p "\\`\\$[^$]" value))))
2700 ((or `subscript `superscript) t)))))
2701 (org-element-map data '(entity latex-fragment subscript superscript)
2702 (lambda (object)
2703 ;; Skip objects already wrapped.
2704 (when (and (not (eq (org-element-type
2705 (org-element-property :parent object))
2706 'latex-math-block))
2707 (funcall valid-object-p object))
2708 (let ((math-block (list 'latex-math-block nil))
2709 (next-elements (org-export-get-next-element object info t))
2710 (last object))
2711 ;; Wrap MATH-BLOCK around OBJECT in DATA.
2712 (org-element-insert-before math-block object)
2713 (org-element-extract-element object)
2714 (org-element-adopt-elements math-block object)
2715 (when (zerop (or (org-element-property :post-blank object) 0))
2716 ;; MATH-BLOCK swallows consecutive math objects.
2717 (catch 'exit
2718 (dolist (next next-elements)
2719 (if (not (funcall valid-object-p next)) (throw 'exit nil)
2720 (org-element-extract-element next)
2721 (org-element-adopt-elements math-block next)
2722 ;; Eschew the case: \beta$x$ -> \(\betax\).
2723 (unless (memq (org-element-type next)
2724 '(subscript superscript))
2725 (org-element-put-property last :post-blank 1))
2726 (setq last next)
2727 (when (> (or (org-element-property :post-blank next) 0) 0)
2728 (throw 'exit nil))))))
2729 (org-element-put-property
2730 math-block :post-blank (org-element-property :post-blank last)))))
2731 info nil '(subscript superscript latex-math-block) t)
2732 ;; Return updated DATA.
2733 data))
2735 (defun org-latex-math-block-tree-filter (tree _backend info)
2736 (org-latex--wrap-latex-math-block tree info))
2738 (defun org-latex-math-block-options-filter (info _backend)
2739 (dolist (prop '(:author :date :title) info)
2740 (plist-put info prop
2741 (org-latex--wrap-latex-math-block (plist-get info prop) info))))
2743 (defun org-latex-math-block (_math-block contents _info)
2744 "Transcode a MATH-BLOCK object from Org to LaTeX.
2745 CONTENTS is a string. INFO is a plist used as a communication
2746 channel."
2747 (when (org-string-nw-p contents)
2748 (format "\\(%s\\)" (org-trim contents))))
2750 ;;;; Quote Block
2752 (defun org-latex-quote-block (quote-block contents info)
2753 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
2754 CONTENTS holds the contents of the block. INFO is a plist
2755 holding contextual information."
2756 (org-latex--wrap-label
2757 quote-block (format "\\begin{quote}\n%s\\end{quote}" contents) info))
2760 ;;;; Radio Target
2762 (defun org-latex-radio-target (radio-target text info)
2763 "Transcode a RADIO-TARGET object from Org to LaTeX.
2764 TEXT is the text of the target. INFO is a plist holding
2765 contextual information."
2766 (format "\\label{%s}%s" (org-export-get-reference radio-target info) text))
2769 ;;;; Section
2771 (defun org-latex-section (_section contents _info)
2772 "Transcode a SECTION element from Org to LaTeX.
2773 CONTENTS holds the contents of the section. INFO is a plist
2774 holding contextual information."
2775 contents)
2778 ;;;; Special Block
2780 (defun org-latex-special-block (special-block contents info)
2781 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
2782 CONTENTS holds the contents of the block. INFO is a plist
2783 holding contextual information."
2784 (let ((type (org-element-property :type special-block))
2785 (opt (org-export-read-attribute :attr_latex special-block :options))
2786 (caption (org-latex--caption/label-string special-block info))
2787 (caption-above-p (org-latex--caption-above-p special-block info)))
2788 (concat (format "\\begin{%s}%s\n" type (or opt ""))
2789 (and caption-above-p caption)
2790 contents
2791 (and (not caption-above-p) caption)
2792 (format "\\end{%s}" type))))
2795 ;;;; Src Block
2797 (defun org-latex-src-block (src-block _contents info)
2798 "Transcode a SRC-BLOCK element from Org to LaTeX.
2799 CONTENTS holds the contents of the item. INFO is a plist holding
2800 contextual information."
2801 (when (org-string-nw-p (org-element-property :value src-block))
2802 (let* ((lang (org-element-property :language src-block))
2803 (caption (org-element-property :caption src-block))
2804 (caption-above-p (org-latex--caption-above-p src-block info))
2805 (label (org-element-property :name src-block))
2806 (custom-env (and lang
2807 (cadr (assq (intern lang)
2808 org-latex-custom-lang-environments))))
2809 (num-start (org-export-get-loc src-block info))
2810 (retain-labels (org-element-property :retain-labels src-block))
2811 (attributes (org-export-read-attribute :attr_latex src-block))
2812 (float (plist-get attributes :float))
2813 (listings (plist-get info :latex-listings)))
2814 (cond
2815 ;; Case 1. No source fontification.
2816 ((not listings)
2817 (let* ((caption-str (org-latex--caption/label-string src-block info))
2818 (float-env
2819 (cond ((string= "multicolumn" float)
2820 (format "\\begin{figure*}[%s]\n%s%%s\n%s\\end{figure*}"
2821 (plist-get info :latex-default-figure-position)
2822 (if caption-above-p caption-str "")
2823 (if caption-above-p "" caption-str)))
2824 (caption (concat
2825 (if caption-above-p caption-str "")
2826 "%s"
2827 (if caption-above-p "" (concat "\n" caption-str))))
2828 (t "%s"))))
2829 (format
2830 float-env
2831 (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
2832 (org-export-format-code-default src-block info))))))
2833 ;; Case 2. Custom environment.
2834 (custom-env
2835 (let ((caption-str (org-latex--caption/label-string src-block info))
2836 (formatted-src (org-export-format-code-default src-block info)))
2837 (if (string-match-p "\\`[a-zA-Z0-9]+\\'" custom-env)
2838 (format "\\begin{%s}\n%s\\end{%s}\n"
2839 custom-env
2840 (concat (and caption-above-p caption-str)
2841 formatted-src
2842 (and (not caption-above-p) caption-str))
2843 custom-env)
2844 (format-spec custom-env
2845 `((?s . ,formatted-src)
2846 (?c . ,caption)
2847 (?f . ,float)
2848 (?l . ,(org-latex--label src-block info))
2849 (?o . ,(or (plist-get attributes :options) "")))))))
2850 ;; Case 3. Use minted package.
2851 ((eq listings 'minted)
2852 (let* ((caption-str (org-latex--caption/label-string src-block info))
2853 (float-env
2854 (cond
2855 ((string= "multicolumn" float)
2856 (format "\\begin{listing*}\n%s%%s\n%s\\end{listing*}"
2857 (if caption-above-p caption-str "")
2858 (if caption-above-p "" caption-str)))
2859 (caption
2860 (concat (if caption-above-p caption-str "")
2861 "%s"
2862 (if caption-above-p "" (concat "\n" caption-str))))
2863 (t "%s")))
2864 (options (plist-get info :latex-minted-options))
2865 (body
2866 (format
2867 "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2868 ;; Options.
2869 (concat
2870 (org-latex--make-option-string
2871 (if (or (not num-start) (assoc "linenos" options))
2872 options
2873 (append
2874 `(("linenos")
2875 ("firstnumber" ,(number-to-string (1+ num-start))))
2876 options)))
2877 (let ((local-options (plist-get attributes :options)))
2878 (and local-options (concat "," local-options))))
2879 ;; Language.
2880 (or (cadr (assq (intern lang)
2881 (plist-get info :latex-minted-langs)))
2882 (downcase lang))
2883 ;; Source code.
2884 (let* ((code-info (org-export-unravel-code src-block))
2885 (max-width
2886 (apply 'max
2887 (mapcar 'length
2888 (org-split-string (car code-info)
2889 "\n")))))
2890 (org-export-format-code
2891 (car code-info)
2892 (lambda (loc _num ref)
2893 (concat
2895 (when ref
2896 ;; Ensure references are flushed to the right,
2897 ;; separated with 6 spaces from the widest line
2898 ;; of code.
2899 (concat (make-string (+ (- max-width (length loc)) 6)
2900 ?\s)
2901 (format "(%s)" ref)))))
2902 nil (and retain-labels (cdr code-info)))))))
2903 ;; Return value.
2904 (format float-env body)))
2905 ;; Case 4. Use listings package.
2907 (let ((lst-lang
2908 (or (cadr (assq (intern lang)
2909 (plist-get info :latex-listings-langs)))
2910 lang))
2911 (caption-str
2912 (when caption
2913 (let ((main (org-export-get-caption src-block))
2914 (secondary (org-export-get-caption src-block t)))
2915 (if (not secondary)
2916 (format "{%s}" (org-export-data main info))
2917 (format "{[%s]%s}"
2918 (org-export-data secondary info)
2919 (org-export-data main info))))))
2920 (lst-opt (plist-get info :latex-listings-options)))
2921 (concat
2922 ;; Options.
2923 (format
2924 "\\lstset{%s}\n"
2925 (concat
2926 (org-latex--make-option-string
2927 (append
2928 lst-opt
2929 (cond
2930 ((and (not float) (plist-member attributes :float)) nil)
2931 ((string= "multicolumn" float) '(("float" "*")))
2932 ((and float (not (assoc "float" lst-opt)))
2933 `(("float" ,(plist-get info :latex-default-figure-position)))))
2934 `(("language" ,lst-lang))
2935 (if label `(("label" ,label)) '(("label" " ")))
2936 (if caption-str `(("caption" ,caption-str)) '(("caption" " ")))
2937 `(("captionpos" ,(if caption-above-p "t" "b")))
2938 (cond ((assoc "numbers" lst-opt) nil)
2939 ((not num-start) '(("numbers" "none")))
2940 (t `(("firstnumber" ,(number-to-string (1+ num-start)))
2941 ("numbers" "left"))))))
2942 (let ((local-options (plist-get attributes :options)))
2943 (and local-options (concat "," local-options)))))
2944 ;; Source code.
2945 (format
2946 "\\begin{lstlisting}\n%s\\end{lstlisting}"
2947 (let* ((code-info (org-export-unravel-code src-block))
2948 (max-width
2949 (apply 'max
2950 (mapcar 'length
2951 (org-split-string (car code-info) "\n")))))
2952 (org-export-format-code
2953 (car code-info)
2954 (lambda (loc _num ref)
2955 (concat
2957 (when ref
2958 ;; Ensure references are flushed to the right,
2959 ;; separated with 6 spaces from the widest line of
2960 ;; code
2961 (concat (make-string (+ (- max-width (length loc)) 6) ?\s)
2962 (format "(%s)" ref)))))
2963 nil (and retain-labels (cdr code-info))))))))))))
2966 ;;;; Statistics Cookie
2968 (defun org-latex-statistics-cookie (statistics-cookie _contents _info)
2969 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
2970 CONTENTS is nil. INFO is a plist holding contextual information."
2971 (replace-regexp-in-string
2972 "%" "\\%" (org-element-property :value statistics-cookie) nil t))
2975 ;;;; Strike-Through
2977 (defun org-latex-strike-through (_strike-through contents info)
2978 "Transcode STRIKE-THROUGH from Org to LaTeX.
2979 CONTENTS is the text with strike-through markup. INFO is a plist
2980 holding contextual information."
2981 (org-latex--text-markup contents 'strike-through info))
2984 ;;;; Subscript
2986 (defun org-latex--script-size (object info)
2987 "Transcode a subscript or superscript object.
2988 OBJECT is an Org object. INFO is a plist used as a communication
2989 channel."
2990 (let ((output ""))
2991 (org-element-map (org-element-contents object)
2992 (cons 'plain-text org-element-all-objects)
2993 (lambda (obj)
2994 (cl-case (org-element-type obj)
2995 ((entity latex-fragment)
2996 (let ((data (org-trim (org-export-data obj info))))
2997 (string-match
2998 "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
2999 data)
3000 (setq output
3001 (concat output
3002 (match-string 1 data)
3003 (let ((blank (org-element-property :post-blank obj)))
3004 (and blank (> blank 0) "\\ "))))))
3005 (plain-text
3006 (setq output
3007 (format "%s\\text{%s}" output (org-export-data obj info))))
3008 (otherwise
3009 (setq output
3010 (concat output
3011 (org-export-data obj info)
3012 (let ((blank (org-element-property :post-blank obj)))
3013 (and blank (> blank 0) "\\ ")))))))
3014 info nil org-element-recursive-objects)
3015 ;; Result. Do not wrap into curly brackets if OUTPUT is a single
3016 ;; character.
3017 (concat (if (eq (org-element-type object) 'subscript) "_" "^")
3018 (and (> (length output) 1) "{")
3019 output
3020 (and (> (length output) 1) "}"))))
3022 (defun org-latex-subscript (subscript _contents info)
3023 "Transcode a SUBSCRIPT object from Org to LaTeX.
3024 CONTENTS is the contents of the object. INFO is a plist holding
3025 contextual information."
3026 (org-latex--script-size subscript info))
3029 ;;;; Superscript
3031 (defun org-latex-superscript (superscript _contents info)
3032 "Transcode a SUPERSCRIPT object from Org to LaTeX.
3033 CONTENTS is the contents of the object. INFO is a plist holding
3034 contextual information."
3035 (org-latex--script-size superscript info))
3038 ;;;; Table
3040 ;; `org-latex-table' is the entry point for table transcoding. It
3041 ;; takes care of tables with a "verbatim" mode. Otherwise, it
3042 ;; delegates the job to either `org-latex--table.el-table',
3043 ;; `org-latex--org-table' or `org-latex--math-table' functions,
3044 ;; depending of the type of the table and the mode requested.
3046 ;; `org-latex--align-string' is a subroutine used to build alignment
3047 ;; string for Org tables.
3049 (defun org-latex-table (table contents info)
3050 "Transcode a TABLE element from Org to LaTeX.
3051 CONTENTS is the contents of the table. INFO is a plist holding
3052 contextual information."
3053 (if (eq (org-element-property :type table) 'table.el)
3054 ;; "table.el" table. Convert it using appropriate tools.
3055 (org-latex--table.el-table table info)
3056 (let ((type (or (org-export-read-attribute :attr_latex table :mode)
3057 (plist-get info :latex-default-table-mode))))
3058 (cond
3059 ;; Case 1: Verbatim table.
3060 ((string= type "verbatim")
3061 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
3062 ;; Re-create table, without affiliated keywords.
3063 (org-trim (org-element-interpret-data
3064 `(table nil ,@(org-element-contents table))))))
3065 ;; Case 2: Matrix.
3066 ((or (string= type "math") (string= type "inline-math"))
3067 (org-latex--math-table table info))
3068 ;; Case 3: Standard table.
3069 (t (concat (org-latex--org-table table contents info)
3070 ;; When there are footnote references within the
3071 ;; table, insert their definition just after it.
3072 (org-latex--delayed-footnotes-definitions table info)))))))
3074 (defun org-latex--align-string (table info)
3075 "Return an appropriate LaTeX alignment string.
3076 TABLE is the considered table. INFO is a plist used as
3077 a communication channel."
3078 (or (org-export-read-attribute :attr_latex table :align)
3079 (let (align)
3080 ;; Extract column groups and alignment from first (non-rule)
3081 ;; row.
3082 (org-element-map
3083 (org-element-map table 'table-row
3084 (lambda (row)
3085 (and (eq (org-element-property :type row) 'standard) row))
3086 info 'first-match)
3087 'table-cell
3088 (lambda (cell)
3089 (let ((borders (org-export-table-cell-borders cell info)))
3090 ;; Check left border for the first cell only.
3091 (when (and (memq 'left borders) (not align))
3092 (push "|" align))
3093 (push (cl-case (org-export-table-cell-alignment cell info)
3094 (left "l")
3095 (right "r")
3096 (center "c"))
3097 align)
3098 (when (memq 'right borders) (push "|" align))))
3099 info)
3100 (apply 'concat (nreverse align)))))
3102 (defun org-latex--org-table (table contents info)
3103 "Return appropriate LaTeX code for an Org table.
3105 TABLE is the table type element to transcode. CONTENTS is its
3106 contents, as a string. INFO is a plist used as a communication
3107 channel.
3109 This function assumes TABLE has `org' as its `:type' property and
3110 `table' as its `:mode' attribute."
3111 (let* ((caption (org-latex--caption/label-string table info))
3112 (attr (org-export-read-attribute :attr_latex table))
3113 ;; Determine alignment string.
3114 (alignment (org-latex--align-string table info))
3115 ;; Determine environment for the table: longtable, tabular...
3116 (table-env (or (plist-get attr :environment)
3117 (plist-get info :latex-default-table-environment)))
3118 ;; If table is a float, determine environment: table, table*
3119 ;; or sidewaystable.
3120 (float-env (unless (member table-env '("longtable" "longtabu"))
3121 (let ((float (plist-get attr :float)))
3122 (cond
3123 ((and (not float) (plist-member attr :float)) nil)
3124 ((or (string= float "sidewaystable")
3125 (string= float "sideways")) "sidewaystable")
3126 ((string= float "multicolumn") "table*")
3127 ((or float
3128 (org-element-property :caption table)
3129 (org-string-nw-p (plist-get attr :caption)))
3130 "table")))))
3131 ;; Extract others display options.
3132 (fontsize (let ((font (plist-get attr :font)))
3133 (and font (concat font "\n"))))
3134 ;; "tabular" environment doesn't allow to define a width.
3135 (width (and (not (equal table-env "tabular")) (plist-get attr :width)))
3136 (spreadp (plist-get attr :spread))
3137 (placement
3138 (or (plist-get attr :placement)
3139 (format "[%s]" (plist-get info :latex-default-figure-position))))
3140 (centerp (if (plist-member attr :center) (plist-get attr :center)
3141 (plist-get info :latex-tables-centered)))
3142 (caption-above-p (org-latex--caption-above-p table info)))
3143 ;; Prepare the final format string for the table.
3144 (cond
3145 ;; Longtable.
3146 ((equal "longtable" table-env)
3147 (concat (and fontsize (concat "{" fontsize))
3148 (format "\\begin{longtable}{%s}\n" alignment)
3149 (and caption-above-p
3150 (org-string-nw-p caption)
3151 (concat caption "\\\\\n"))
3152 contents
3153 (and (not caption-above-p)
3154 (org-string-nw-p caption)
3155 (concat caption "\\\\\n"))
3156 "\\end{longtable}\n"
3157 (and fontsize "}")))
3158 ;; Longtabu
3159 ((equal "longtabu" table-env)
3160 (concat (and fontsize (concat "{" fontsize))
3161 (format "\\begin{longtabu}%s{%s}\n"
3162 (if width
3163 (format " %s %s "
3164 (if spreadp "spread" "to") width) "")
3165 alignment)
3166 (and caption-above-p
3167 (org-string-nw-p caption)
3168 (concat caption "\\\\\n"))
3169 contents
3170 (and (not caption-above-p)
3171 (org-string-nw-p caption)
3172 (concat caption "\\\\\n"))
3173 "\\end{longtabu}\n"
3174 (and fontsize "}")))
3175 ;; Others.
3176 (t (concat (cond
3177 (float-env
3178 (concat (format "\\begin{%s}%s\n" float-env placement)
3179 (if caption-above-p caption "")
3180 (when centerp "\\centering\n")
3181 fontsize))
3182 ((and (not float-env) caption)
3183 (concat
3184 (and centerp "\\begin{center}\n" )
3185 (if caption-above-p caption "")
3186 (cond ((and fontsize centerp) fontsize)
3187 (fontsize (concat "{" fontsize)))))
3188 (centerp (concat "\\begin{center}\n" fontsize))
3189 (fontsize (concat "{" fontsize)))
3190 (cond ((equal "tabu" table-env)
3191 (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
3192 (if width (format
3193 (if spreadp " spread %s " " to %s ")
3194 width) "")
3195 alignment
3196 contents))
3197 (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
3198 table-env
3199 (if width (format "{%s}" width) "")
3200 alignment
3201 contents
3202 table-env)))
3203 (cond
3204 (float-env
3205 (concat (if caption-above-p "" (concat "\n" caption))
3206 (format "\n\\end{%s}" float-env)))
3207 ((and (not float-env) caption)
3208 (concat
3209 (if caption-above-p "" (concat "\n" caption))
3210 (and centerp "\n\\end{center}")
3211 (and fontsize (not centerp) "}")))
3212 (centerp "\n\\end{center}")
3213 (fontsize "}")))))))
3215 (defun org-latex--table.el-table (table info)
3216 "Return appropriate LaTeX code for a table.el table.
3218 TABLE is the table type element to transcode. INFO is a plist
3219 used as a communication channel.
3221 This function assumes TABLE has `table.el' as its `:type'
3222 property."
3223 (require 'table)
3224 ;; Ensure "*org-export-table*" buffer is empty.
3225 (with-current-buffer (get-buffer-create "*org-export-table*")
3226 (erase-buffer))
3227 (let ((output (with-temp-buffer
3228 (insert (org-element-property :value table))
3229 (goto-char 1)
3230 (re-search-forward "^[ \t]*|[^|]" nil t)
3231 (table-generate-source 'latex "*org-export-table*")
3232 (with-current-buffer "*org-export-table*"
3233 (org-trim (buffer-string))))))
3234 (kill-buffer (get-buffer "*org-export-table*"))
3235 ;; Remove left out comments.
3236 (while (string-match "^%.*\n" output)
3237 (setq output (replace-match "" t t output)))
3238 (let ((attr (org-export-read-attribute :attr_latex table)))
3239 (when (plist-get attr :rmlines)
3240 ;; When the "rmlines" attribute is provided, remove all hlines
3241 ;; but the the one separating heading from the table body.
3242 (let ((n 0) (pos 0))
3243 (while (and (< (length output) pos)
3244 (setq pos (string-match "^\\\\hline\n?" output pos)))
3245 (cl-incf n)
3246 (unless (= n 2) (setq output (replace-match "" nil nil output))))))
3247 (let ((centerp (if (plist-member attr :center) (plist-get attr :center)
3248 (plist-get info :latex-tables-centered))))
3249 (if (not centerp) output
3250 (format "\\begin{center}\n%s\n\\end{center}" output))))))
3252 (defun org-latex--math-table (table info)
3253 "Return appropriate LaTeX code for a matrix.
3255 TABLE is the table type element to transcode. INFO is a plist
3256 used as a communication channel.
3258 This function assumes TABLE has `org' as its `:type' property and
3259 `inline-math' or `math' as its `:mode' attribute."
3260 (let* ((attr (org-export-read-attribute :attr_latex table))
3261 (env (or (plist-get attr :environment)
3262 (plist-get info :latex-default-table-environment)))
3263 (contents
3264 (mapconcat
3265 (lambda (row)
3266 ;; Ignore horizontal rules.
3267 (when (eq (org-element-property :type row) 'standard)
3268 ;; Return each cell unmodified.
3269 (concat
3270 (mapconcat
3271 (lambda (cell)
3272 (substring (org-element-interpret-data cell) 0 -1))
3273 (org-element-map row 'table-cell #'identity info) "&")
3274 (or (cdr (assoc env org-latex-table-matrix-macros)) "\\\\")
3275 "\n")))
3276 (org-element-map table 'table-row #'identity info) "")))
3277 (concat
3278 ;; Prefix.
3279 (plist-get attr :math-prefix)
3280 ;; Environment. Also treat special cases.
3281 (cond ((member env '("array" "tabular"))
3282 (let ((align (make-string
3283 (cdr (org-export-table-dimensions table info)) ?c)))
3284 (format "\\begin{%s}{%s}\n%s\\end{%s}" env align contents env)))
3285 ((assoc env org-latex-table-matrix-macros)
3286 (format "\\%s%s{\n%s}"
3288 (or (plist-get attr :math-arguments) "")
3289 contents))
3290 (t (format "\\begin{%s}\n%s\\end{%s}" env contents env)))
3291 ;; Suffix.
3292 (plist-get attr :math-suffix))))
3295 ;;;; Table Cell
3297 (defun org-latex-table-cell (table-cell contents info)
3298 "Transcode a TABLE-CELL element from Org to LaTeX.
3299 CONTENTS is the cell contents. INFO is a plist used as
3300 a communication channel."
3301 (concat
3302 (let ((scientific-format (plist-get info :latex-table-scientific-notation)))
3303 (if (and contents
3304 scientific-format
3305 (string-match orgtbl-exp-regexp contents))
3306 ;; Use appropriate format string for scientific
3307 ;; notation.
3308 (format scientific-format
3309 (match-string 1 contents)
3310 (match-string 2 contents))
3311 contents))
3312 (when (org-export-get-next-element table-cell info) " & ")))
3315 ;;;; Table Row
3317 (defun org-latex-table-row (table-row contents info)
3318 "Transcode a TABLE-ROW element from Org to LaTeX.
3319 CONTENTS is the contents of the row. INFO is a plist used as
3320 a communication channel."
3321 (let* ((attr (org-export-read-attribute :attr_latex
3322 (org-export-get-parent table-row)))
3323 (booktabsp (if (plist-member attr :booktabs) (plist-get attr :booktabs)
3324 (plist-get info :latex-tables-booktabs)))
3325 (longtablep
3326 (member (or (plist-get attr :environment)
3327 (plist-get info :latex-default-table-environment))
3328 '("longtable" "longtabu"))))
3329 (if (eq (org-element-property :type table-row) 'rule)
3330 (cond
3331 ((not booktabsp) "\\hline")
3332 ((not (org-export-get-previous-element table-row info)) "\\toprule")
3333 ((not (org-export-get-next-element table-row info)) "\\bottomrule")
3334 ((and longtablep
3335 (org-export-table-row-ends-header-p
3336 (org-export-get-previous-element table-row info) info))
3338 (t "\\midrule"))
3339 (concat
3340 ;; When BOOKTABS are activated enforce top-rule even when no
3341 ;; hline was specifically marked.
3342 (and booktabsp (not (org-export-get-previous-element table-row info))
3343 "\\toprule\n")
3344 contents "\\\\\n"
3345 (cond
3346 ;; Special case for long tables. Define header and footers.
3347 ((and longtablep (org-export-table-row-ends-header-p table-row info))
3348 (let ((columns (cdr (org-export-table-dimensions
3349 (org-export-get-parent-table table-row) info))))
3350 (format "%s
3351 \\endfirsthead
3352 \\multicolumn{%d}{l}{%s} \\\\
3354 %s \\\\\n
3356 \\endhead
3357 %s\\multicolumn{%d}{r}{%s} \\\\
3358 \\endfoot
3359 \\endlastfoot"
3360 (if booktabsp "\\midrule" "\\hline")
3361 columns
3362 (org-latex--translate "Continued from previous page" info)
3363 (cond
3364 ((not (org-export-table-row-starts-header-p table-row info))
3366 (booktabsp "\\toprule\n")
3367 (t "\\hline\n"))
3368 contents
3369 (if booktabsp "\\midrule" "\\hline")
3370 (if booktabsp "\\midrule" "\\hline")
3371 columns
3372 (org-latex--translate "Continued on next page" info))))
3373 ;; When BOOKTABS are activated enforce bottom rule even when
3374 ;; no hline was specifically marked.
3375 ((and booktabsp (not (org-export-get-next-element table-row info)))
3376 "\\bottomrule"))))))
3379 ;;;; Target
3381 (defun org-latex-target (target _contents info)
3382 "Transcode a TARGET object from Org to LaTeX.
3383 CONTENTS is nil. INFO is a plist holding contextual
3384 information."
3385 (format "\\label{%s}" (org-latex--label target info)))
3388 ;;;; Timestamp
3390 (defun org-latex-timestamp (timestamp _contents info)
3391 "Transcode a TIMESTAMP object from Org to LaTeX.
3392 CONTENTS is nil. INFO is a plist holding contextual
3393 information."
3394 (let ((value (org-latex-plain-text (org-timestamp-translate timestamp) info)))
3395 (format
3396 (plist-get info
3397 (cl-case (org-element-property :type timestamp)
3398 ((active active-range) :latex-active-timestamp-format)
3399 ((inactive inactive-range) :latex-inactive-timestamp-format)
3400 (otherwise :latex-diary-timestamp-format)))
3401 value)))
3404 ;;;; Underline
3406 (defun org-latex-underline (_underline contents info)
3407 "Transcode UNDERLINE from Org to LaTeX.
3408 CONTENTS is the text with underline markup. INFO is a plist
3409 holding contextual information."
3410 (org-latex--text-markup contents 'underline info))
3413 ;;;; Verbatim
3415 (defun org-latex-verbatim (verbatim _contents info)
3416 "Transcode a VERBATIM object from Org to LaTeX.
3417 CONTENTS is nil. INFO is a plist used as a communication
3418 channel."
3419 (org-latex--text-markup
3420 (org-element-property :value verbatim) 'verbatim info))
3423 ;;;; Verse Block
3425 (defun org-latex-verse-block (verse-block contents info)
3426 "Transcode a VERSE-BLOCK element from Org to LaTeX.
3427 CONTENTS is verse block contents. INFO is a plist holding
3428 contextual information."
3429 (org-latex--wrap-label
3430 verse-block
3431 ;; In a verse environment, add a line break to each newline
3432 ;; character and change each white space at beginning of a line
3433 ;; into a space of 1 em. Also change each blank line with
3434 ;; a vertical space of 1 em.
3435 (format "\\begin{verse}\n%s\\end{verse}"
3436 (replace-regexp-in-string
3437 "^[ \t]+" (lambda (m) (format "\\hspace*{%dem}" (length m)))
3438 (replace-regexp-in-string
3439 "^[ \t]*\\\\\\\\$" "\\vspace*{1em}"
3440 (replace-regexp-in-string
3441 "\\([ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n"
3442 contents nil t) nil t) nil t))
3443 info))
3447 ;;; End-user functions
3449 ;;;###autoload
3450 (defun org-latex-export-as-latex
3451 (&optional async subtreep visible-only body-only ext-plist)
3452 "Export current buffer as a LaTeX buffer.
3454 If narrowing is active in the current buffer, only export its
3455 narrowed part.
3457 If a region is active, export that region.
3459 A non-nil optional argument ASYNC means the process should happen
3460 asynchronously. The resulting buffer should be accessible
3461 through the `org-export-stack' interface.
3463 When optional argument SUBTREEP is non-nil, export the sub-tree
3464 at point, extracting information from the headline properties
3465 first.
3467 When optional argument VISIBLE-ONLY is non-nil, don't export
3468 contents of hidden elements.
3470 When optional argument BODY-ONLY is non-nil, only write code
3471 between \"\\begin{document}\" and \"\\end{document}\".
3473 EXT-PLIST, when provided, is a property list with external
3474 parameters overriding Org default settings, but still inferior to
3475 file-local settings.
3477 Export is done in a buffer named \"*Org LATEX Export*\", which
3478 will be displayed when `org-export-show-temporary-export-buffer'
3479 is non-nil."
3480 (interactive)
3481 (org-export-to-buffer 'latex "*Org LATEX Export*"
3482 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
3484 ;;;###autoload
3485 (defun org-latex-convert-region-to-latex ()
3486 "Assume the current region has org-mode syntax, and convert it to LaTeX.
3487 This can be used in any buffer. For example, you can write an
3488 itemized list in org-mode syntax in an LaTeX buffer and use this
3489 command to convert it."
3490 (interactive)
3491 (org-export-replace-region-by 'latex))
3493 ;;;###autoload
3494 (defun org-latex-export-to-latex
3495 (&optional async subtreep visible-only body-only ext-plist)
3496 "Export current buffer to a LaTeX file.
3498 If narrowing is active in the current buffer, only export its
3499 narrowed part.
3501 If a region is active, export that region.
3503 A non-nil optional argument ASYNC means the process should happen
3504 asynchronously. The resulting file should be accessible through
3505 the `org-export-stack' interface.
3507 When optional argument SUBTREEP is non-nil, export the sub-tree
3508 at point, extracting information from the headline properties
3509 first.
3511 When optional argument VISIBLE-ONLY is non-nil, don't export
3512 contents of hidden elements.
3514 When optional argument BODY-ONLY is non-nil, only write code
3515 between \"\\begin{document}\" and \"\\end{document}\".
3517 EXT-PLIST, when provided, is a property list with external
3518 parameters overriding Org default settings, but still inferior to
3519 file-local settings."
3520 (interactive)
3521 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
3522 (org-export-to-file 'latex outfile
3523 async subtreep visible-only body-only ext-plist)))
3525 ;;;###autoload
3526 (defun org-latex-export-to-pdf
3527 (&optional async subtreep visible-only body-only ext-plist)
3528 "Export current buffer to LaTeX then process through to PDF.
3530 If narrowing is active in the current buffer, only export its
3531 narrowed part.
3533 If a region is active, export that region.
3535 A non-nil optional argument ASYNC means the process should happen
3536 asynchronously. The resulting file should be accessible through
3537 the `org-export-stack' interface.
3539 When optional argument SUBTREEP is non-nil, export the sub-tree
3540 at point, extracting information from the headline properties
3541 first.
3543 When optional argument VISIBLE-ONLY is non-nil, don't export
3544 contents of hidden elements.
3546 When optional argument BODY-ONLY is non-nil, only write code
3547 between \"\\begin{document}\" and \"\\end{document}\".
3549 EXT-PLIST, when provided, is a property list with external
3550 parameters overriding Org default settings, but still inferior to
3551 file-local settings.
3553 Return PDF file's name."
3554 (interactive)
3555 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
3556 (org-export-to-file 'latex outfile
3557 async subtreep visible-only body-only ext-plist
3558 (lambda (file) (org-latex-compile file)))))
3560 (defun org-latex-compile (texfile &optional snippet)
3561 "Compile a TeX file.
3563 TEXFILE is the name of the file being compiled. Processing is
3564 done through the command specified in `org-latex-pdf-process',
3565 which see. Output is redirected to \"*Org PDF LaTeX Output*\"
3566 buffer.
3568 When optional argument SNIPPET is non-nil, TEXFILE is a temporary
3569 file used to preview a LaTeX snippet. In this case, do not
3570 create a log buffer and do not remove log files.
3572 Return PDF file name or raise an error if it couldn't be
3573 produced."
3574 (unless snippet (message "Processing LaTeX file %s..." texfile))
3575 (let* ((compiler
3576 (or (with-temp-buffer
3577 (save-excursion (insert-file-contents texfile))
3578 (and (search-forward-regexp (regexp-opt org-latex-compilers)
3579 (line-end-position 2)
3581 (progn (beginning-of-line) (looking-at-p "%"))
3582 (match-string 0)))
3583 "pdflatex"))
3584 (process (if (functionp org-latex-pdf-process) org-latex-pdf-process
3585 ;; Replace "%latex" and "%bibtex" with,
3586 ;; respectively, "%L" and "%B" so as to adhere to
3587 ;; `format-spec' specifications.
3588 (mapcar (lambda (command)
3589 (replace-regexp-in-string
3590 "%\\(?:bib\\|la\\)tex\\>"
3591 (lambda (m) (upcase (substring m 0 2)))
3592 command))
3593 org-latex-pdf-process)))
3594 (spec `((?B . ,(shell-quote-argument org-latex-bib-compiler))
3595 (?L . ,(shell-quote-argument compiler))))
3596 (log-buf-name "*Org PDF LaTeX Output*")
3597 (log-buf (and (not snippet) (get-buffer-create log-buf-name)))
3598 (outfile (org-compile-file texfile process "pdf"
3599 (format "See %S for details" log-buf-name)
3600 log-buf spec)))
3601 (unless snippet
3602 (when org-latex-remove-logfiles
3603 (mapc #'delete-file
3604 (directory-files
3605 (file-name-directory texfile) t
3606 (concat (regexp-quote (file-name-base outfile))
3607 "\\(?:\\.[0-9]+\\)?\\."
3608 (regexp-opt org-latex-logfiles-extensions)))))
3609 (let ((warnings (org-latex--collect-warnings log-buf)))
3610 (message (concat "PDF file produced"
3611 (cond
3612 ((eq warnings 'error) " with errors.")
3613 (warnings (concat " with warnings: " warnings))
3614 (t "."))))))
3615 ;; Return output file name.
3616 outfile))
3618 (defun org-latex--collect-warnings (buffer)
3619 "Collect some warnings from \"pdflatex\" command output.
3620 BUFFER is the buffer containing output. Return collected
3621 warnings types as a string, `error' if a LaTeX error was
3622 encountered or nil if there was none."
3623 (with-current-buffer buffer
3624 (save-excursion
3625 (goto-char (point-max))
3626 (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t)
3627 (if (re-search-forward "^!" nil t) 'error
3628 (let ((case-fold-search t)
3629 (warnings ""))
3630 (dolist (warning org-latex-known-warnings)
3631 (when (save-excursion (re-search-forward (car warning) nil t))
3632 (setq warnings (concat warnings " " (cdr warning)))))
3633 (org-string-nw-p (org-trim warnings))))))))
3635 ;;;###autoload
3636 (defun org-latex-publish-to-latex (plist filename pub-dir)
3637 "Publish an Org file to LaTeX.
3639 FILENAME is the filename of the Org file to be published. PLIST
3640 is the property list for the given project. PUB-DIR is the
3641 publishing directory.
3643 Return output file name."
3644 (org-publish-org-to 'latex filename ".tex" plist pub-dir))
3646 ;;;###autoload
3647 (defun org-latex-publish-to-pdf (plist filename pub-dir)
3648 "Publish an Org file to PDF (via LaTeX).
3650 FILENAME is the filename of the Org file to be published. PLIST
3651 is the property list for the given project. PUB-DIR is the
3652 publishing directory.
3654 Return output file name."
3655 ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
3656 ;; in working directory and then moved to publishing directory.
3657 (org-publish-attachment
3658 plist
3659 (org-latex-compile
3660 (org-publish-org-to
3661 'latex filename ".tex" plist (file-name-directory filename)))
3662 pub-dir))
3665 (provide 'ox-latex)
3667 ;; Local variables:
3668 ;; generated-autoload-file: "org-loaddefs.el"
3669 ;; End:
3671 ;;; ox-latex.el ends here