Merge branch 'maint'
[org-mode.git] / lisp / ox-latex.el
blob900cd550b37f844703321b9565c0e0e56bfb0e78
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.2"
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.2"
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.2"
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.2"
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.2"
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.2"
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 "htbp"
719 "Default position for LaTeX figures."
720 :group 'org-export-latex
721 :type 'string
722 :version "25.2"
723 :package-version '(Org . "9.0")
724 :safe #'stringp)
726 (defcustom org-latex-inline-image-rules
727 '(("file" . "\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\|tikz\\|pgf\\|svg\\)\\'"))
728 "Rules characterizing image files that can be inlined into LaTeX.
730 A rule consists in an association whose key is the type of link
731 to consider, and value is a regexp that will be matched against
732 link's path.
734 Note that, by default, the image extension *actually* allowed
735 depend on the way the LaTeX file is processed. When used with
736 pdflatex, pdf, jpg and png images are OK. When processing
737 through dvi to Postscript, only ps and eps are allowed. The
738 default we use here encompasses both."
739 :group 'org-export-latex
740 :version "24.4"
741 :package-version '(Org . "8.0")
742 :type '(alist :key-type (string :tag "Type")
743 :value-type (regexp :tag "Path")))
745 (defcustom org-latex-link-with-unknown-path-format "\\texttt{%s}"
746 "Format string for links with unknown path type."
747 :group 'org-export-latex
748 :type 'string)
751 ;;;; Tables
753 (defcustom org-latex-default-table-environment "tabular"
754 "Default environment used to build tables."
755 :group 'org-export-latex
756 :version "24.4"
757 :package-version '(Org . "8.0")
758 :type 'string)
760 (defcustom org-latex-default-table-mode 'table
761 "Default mode for tables.
763 Value can be a symbol among:
765 `table' Regular LaTeX table.
767 `math' In this mode, every cell is considered as being in math
768 mode and the complete table will be wrapped within a math
769 environment. It is particularly useful to write matrices.
771 `inline-math' This mode is almost the same as `math', but the
772 math environment will be inlined.
774 `verbatim' The table is exported as it appears in the Org
775 buffer, within a verbatim environment.
777 This value can be overridden locally with, i.e. \":mode math\" in
778 LaTeX attributes.
780 When modifying this variable, it may be useful to change
781 `org-latex-default-table-environment' accordingly."
782 :group 'org-export-latex
783 :version "24.4"
784 :package-version '(Org . "8.0")
785 :type '(choice (const :tag "Table" table)
786 (const :tag "Matrix" math)
787 (const :tag "Inline matrix" inline-math)
788 (const :tag "Verbatim" verbatim))
789 :safe (lambda (s) (memq s '(table math inline-math verbatim))))
791 (defcustom org-latex-tables-centered t
792 "When non-nil, tables are exported in a center environment."
793 :group 'org-export-latex
794 :type 'boolean
795 :safe #'booleanp)
797 (defcustom org-latex-tables-booktabs nil
798 "When non-nil, display tables in a formal \"booktabs\" style.
799 This option assumes that the \"booktabs\" package is properly
800 loaded in the header of the document. This value can be ignored
801 locally with \":booktabs t\" and \":booktabs nil\" LaTeX
802 attributes."
803 :group 'org-export-latex
804 :version "24.4"
805 :package-version '(Org . "8.0")
806 :type 'boolean
807 :safe #'booleanp)
809 (defcustom org-latex-table-scientific-notation "%s\\,(%s)"
810 "Format string to display numbers in scientific notation.
811 The format should have \"%s\" twice, for mantissa and exponent
812 \(i.e., \"%s\\\\times10^{%s}\").
814 When nil, no transformation is made."
815 :group 'org-export-latex
816 :version "24.4"
817 :package-version '(Org . "8.0")
818 :type '(choice
819 (string :tag "Format string")
820 (const :tag "No formatting" nil)))
822 ;;;; Text markup
824 (defcustom org-latex-text-markup-alist '((bold . "\\textbf{%s}")
825 (code . protectedtexttt)
826 (italic . "\\emph{%s}")
827 (strike-through . "\\sout{%s}")
828 (underline . "\\uline{%s}")
829 (verbatim . protectedtexttt))
830 "Alist of LaTeX expressions to convert text markup.
832 The key must be a symbol among `bold', `code', `italic',
833 `strike-through', `underline' and `verbatim'. The value is
834 a formatting string to wrap fontified text with.
836 Value can also be set to the following symbols: `verb' and
837 `protectedtexttt'. For the former, Org will use \"\\verb\" to
838 create a format string and select a delimiter character that
839 isn't in the string. For the latter, Org will use \"\\texttt\"
840 to typeset and try to protect special characters.
842 If no association can be found for a given markup, text will be
843 returned as-is."
844 :group 'org-export-latex
845 :version "25.2"
846 :package-version '(Org . "8.3")
847 :type 'alist
848 :options '(bold code italic strike-through underline verbatim))
851 ;;;; Drawers
853 (defcustom org-latex-format-drawer-function (lambda (_ contents) contents)
854 "Function called to format a drawer in LaTeX code.
856 The function must accept two parameters:
857 NAME the drawer name, like \"LOGBOOK\"
858 CONTENTS the contents of the drawer.
860 The function should return the string to be exported.
862 The default function simply returns the value of CONTENTS."
863 :group 'org-export-latex
864 :version "24.4"
865 :package-version '(Org . "8.3")
866 :type 'function)
869 ;;;; Inlinetasks
871 (defcustom org-latex-format-inlinetask-function
872 'org-latex-format-inlinetask-default-function
873 "Function called to format an inlinetask in LaTeX code.
875 The function must accept seven parameters:
876 TODO the todo keyword (string or nil)
877 TODO-TYPE the todo type (symbol: `todo', `done', nil)
878 PRIORITY the inlinetask priority (integer or nil)
879 NAME the inlinetask name (string)
880 TAGS the inlinetask tags (list of strings or nil)
881 CONTENTS the contents of the inlinetask (string or nil)
882 INFO the export options (plist)
884 The function should return the string to be exported."
885 :group 'org-export-latex
886 :type 'function
887 :version "25.2"
888 :package-version '(Org . "8.3"))
891 ;; Src blocks
893 (defcustom org-latex-listings nil
894 "Non-nil means export source code using the listings package.
896 This package will fontify source code, possibly even with color.
897 If you want to use this, you also need to make LaTeX use the
898 listings package, and if you want to have color, the color
899 package. Just add these to `org-latex-packages-alist', for
900 example using customize, or with something like:
902 (require \\='ox-latex)
903 (add-to-list \\='org-latex-packages-alist \\='(\"\" \"listings\"))
904 (add-to-list \\='org-latex-packages-alist \\='(\"\" \"color\"))
906 Alternatively,
908 (setq org-latex-listings \\='minted)
910 causes source code to be exported using the minted package as
911 opposed to listings. If you want to use minted, you need to add
912 the minted package to `org-latex-packages-alist', for example
913 using customize, or with
915 (require \\='ox-latex)
916 (add-to-list \\='org-latex-packages-alist \\='(\"newfloat\" \"minted\"))
918 In addition, it is necessary to install pygments
919 \(http://pygments.org), and to configure the variable
920 `org-latex-pdf-process' so that the -shell-escape option is
921 passed to pdflatex.
923 The minted choice has possible repercussions on the preview of
924 latex fragments (see `org-preview-latex-fragment'). If you run
925 into previewing problems, please consult
927 http://orgmode.org/worg/org-tutorials/org-latex-preview.html"
928 :group 'org-export-latex
929 :type '(choice
930 (const :tag "Use listings" t)
931 (const :tag "Use minted" minted)
932 (const :tag "Export verbatim" nil))
933 :safe (lambda (s) (memq s '(t nil minted))))
935 (defcustom org-latex-listings-langs
936 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
937 (c "C") (cc "C++")
938 (fortran "fortran")
939 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
940 (html "HTML") (xml "XML")
941 (tex "TeX") (latex "[LaTeX]TeX")
942 (shell-script "bash")
943 (gnuplot "Gnuplot")
944 (ocaml "Caml") (caml "Caml")
945 (sql "SQL") (sqlite "sql")
946 (makefile "make")
947 (R "r"))
948 "Alist mapping languages to their listing language counterpart.
949 The key is a symbol, the major mode symbol without the \"-mode\".
950 The value is the string that should be inserted as the language
951 parameter for the listings package. If the mode name and the
952 listings name are the same, the language does not need an entry
953 in this list - but it does not hurt if it is present."
954 :group 'org-export-latex
955 :version "24.4"
956 :package-version '(Org . "8.3")
957 :type '(repeat
958 (list
959 (symbol :tag "Major mode ")
960 (string :tag "Listings language"))))
962 (defcustom org-latex-listings-options nil
963 "Association list of options for the latex listings package.
965 These options are supplied as a comma-separated list to the
966 \\lstset command. Each element of the association list should be
967 a list containing two strings: the name of the option, and the
968 value. For example,
970 (setq org-latex-listings-options
971 \\='((\"basicstyle\" \"\\\\small\")
972 (\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
974 will typeset the code in a small size font with underlined, bold
975 black keywords.
977 Note that the same options will be applied to blocks of all
978 languages. If you need block-specific options, you may use the
979 following syntax:
981 #+ATTR_LATEX: :options key1=value1,key2=value2
982 #+BEGIN_SRC <LANG>
984 #+END_SRC"
985 :group 'org-export-latex
986 :type '(repeat
987 (list
988 (string :tag "Listings option name ")
989 (string :tag "Listings option value"))))
991 (defcustom org-latex-minted-langs
992 '((emacs-lisp "common-lisp")
993 (cc "c++")
994 (cperl "perl")
995 (shell-script "bash")
996 (caml "ocaml"))
997 "Alist mapping languages to their minted language counterpart.
998 The key is a symbol, the major mode symbol without the \"-mode\".
999 The value is the string that should be inserted as the language
1000 parameter for the minted package. If the mode name and the
1001 listings name are the same, the language does not need an entry
1002 in this list - but it does not hurt if it is present.
1004 Note that minted uses all lower case for language identifiers,
1005 and that the full list of language identifiers can be obtained
1006 with:
1008 pygmentize -L lexers"
1009 :group 'org-export-latex
1010 :type '(repeat
1011 (list
1012 (symbol :tag "Major mode ")
1013 (string :tag "Minted language"))))
1015 (defcustom org-latex-minted-options nil
1016 "Association list of options for the latex minted package.
1018 These options are supplied within square brackets in
1019 \\begin{minted} environments. Each element of the alist should
1020 be a list containing two strings: the name of the option, and the
1021 value. For example,
1023 (setq org-latex-minted-options
1024 \\='((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
1026 will result in src blocks being exported with
1028 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
1030 as the start of the minted environment. Note that the same
1031 options will be applied to blocks of all languages. If you need
1032 block-specific options, you may use the following syntax:
1034 #+ATTR_LATEX: :options key1=value1,key2=value2
1035 #+BEGIN_SRC <LANG>
1037 #+END_SRC"
1038 :group 'org-export-latex
1039 :type '(repeat
1040 (list
1041 (string :tag "Minted option name ")
1042 (string :tag "Minted option value"))))
1044 (defcustom org-latex-custom-lang-environments nil
1045 "Alist mapping languages to language-specific LaTeX environments.
1047 It is used during export of src blocks by the listings and minted
1048 latex packages. The environment may be a simple string, composed of
1049 only letters and numbers. In this case, the string is directly the
1050 name of the latex environment to use. The environment may also be
1051 a format string. In this case the format string will be directly
1052 exported. This format string may contain these elements:
1054 %s for the formatted source
1055 %c for the caption
1056 %f for the float attribute
1057 %l for an appropriate label
1058 %o for the LaTeX attributes
1060 For example,
1062 (setq org-latex-custom-lang-environments
1063 \\='((python \"pythoncode\")
1064 (ocaml \"\\\\begin{listing}
1065 \\\\begin{minted}[%o]{ocaml}
1066 %s\\\\end{minted}
1067 \\\\caption{%c}
1068 \\\\label{%l}\")))
1070 would have the effect that if Org encounters a Python source block
1071 during LaTeX export it will produce
1073 \\begin{pythoncode}
1074 <src block body>
1075 \\end{pythoncode}
1077 and if Org encounters an Ocaml source block during LaTeX export it
1078 will produce
1080 \\begin{listing}
1081 \\begin{minted}[<attr_latex options>]{ocaml}
1082 <src block body>
1083 \\end{minted}
1084 \\caption{<caption>}
1085 \\label{<label>}
1086 \\end{listing}"
1087 :group 'org-export-latex
1088 :type '(repeat
1089 (list
1090 (symbol :tag "Language name ")
1091 (string :tag "Environment name or format string")))
1092 :version "25.2"
1093 :package-version '(Org . "9.0"))
1096 ;;;; Compilation
1098 (defcustom org-latex-compiler-file-string "%% Intended LaTeX compiler: %s\n"
1099 "LaTeX compiler format-string.
1100 See also `org-latex-compiler'."
1101 :group 'org-export-latex
1102 :type '(choice
1103 (const :tag "Comment" "%% Intended LaTeX compiler: %s\n")
1104 (const :tag "latex-mode file variable" "%% -*- latex-run-command: %s -*-\n")
1105 (const :tag "AUCTeX file variable" "%% -*- LaTeX-command: %s -*-\n")
1106 (string :tag "custom format" "%% %s"))
1107 :version "25.2"
1108 :package-version '(Org . "9.0"))
1110 (defcustom org-latex-compiler "pdflatex"
1111 "LaTeX compiler to use.
1113 Must be an element in `org-latex-compilers' or the empty quote.
1114 Can also be set in buffers via #+LATEX_COMPILER. See also
1115 `org-latex-compiler-file-string'."
1116 :group 'org-export-latex
1117 :type '(choice
1118 (const :tag "pdfLaTeX" "pdflatex")
1119 (const :tag "XeLaTeX" "xelatex")
1120 (const :tag "LuaLaTeX" "lualatex")
1121 (const :tag "Unset" ""))
1122 :version "25.2"
1123 :package-version '(Org . "9.0"))
1125 (defconst org-latex-compilers '("pdflatex" "xelatex" "lualatex")
1126 "Known LaTeX compilers.
1127 See also `org-latex-compiler'.")
1129 (defcustom org-latex-bib-compiler "bibtex"
1130 "Command to process a LaTeX file's bibliography.
1132 The shorthand %bib in `org-latex-pdf-process' is replaced with
1133 this value.
1135 A better approach is to use a compiler suit such as `latexmk'."
1136 :group 'org-export-latex
1137 :type '(choice (const :tag "BibTeX" "bibtex")
1138 (const :tag "Biber" "biber")
1139 (string :tag "Other process"))
1140 :version "25.2"
1141 :package-version '(Org . "9.0"))
1143 (defcustom org-latex-pdf-process
1144 '("%latex -interaction nonstopmode -output-directory %o %f"
1145 "%latex -interaction nonstopmode -output-directory %o %f"
1146 "%latex -interaction nonstopmode -output-directory %o %f")
1147 "Commands to process a LaTeX file to a PDF file.
1149 This is a list of strings, each of them will be given to the
1150 shell as a command. %f in the command will be replaced by the
1151 relative file name, %F by the absolute file name, %b by the file
1152 base name (i.e. without directory and extension parts), %o by the
1153 base directory of the file, %O by the absolute file name of the
1154 output file, %latex is the LaTeX compiler (see
1155 `org-latex-compiler'), and %bib is the BibTeX-like compiler (see
1156 `org-latex-bib-compiler').
1158 The reason why this is a list is that it usually takes several
1159 runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
1160 does not have a clever mechanism to detect which of these
1161 commands have to be run to get to a stable result, and it also
1162 does not do any error checking.
1164 Consider a smart LaTeX compiler such as `texi2dvi' or `latexmk',
1165 which calls the \"correct\" combinations of auxiliary programs.
1167 Alternatively, this may be a Lisp function that does the
1168 processing, so you could use this to apply the machinery of
1169 AUCTeX or the Emacs LaTeX mode. This function should accept the
1170 file name as its single argument."
1171 :group 'org-export-pdf
1172 :type '(choice
1173 (repeat :tag "Shell command sequence"
1174 (string :tag "Shell command"))
1175 (const :tag "2 runs of latex"
1176 ("%latex -interaction nonstopmode -output-directory %o %f"
1177 "%latex -interaction nonstopmode -output-directory %o %f"))
1178 (const :tag "3 runs of latex"
1179 ("%latex -interaction nonstopmode -output-directory %o %f"
1180 "%latex -interaction nonstopmode -output-directory %o %f"
1181 "%latex -interaction nonstopmode -output-directory %o %f"))
1182 (const :tag "latex,bibtex,latex,latex"
1183 ("%latex -interaction nonstopmode -output-directory %o %f"
1184 "%bib %b"
1185 "%latex -interaction nonstopmode -output-directory %o %f"
1186 "%latex -interaction nonstopmode -output-directory %o %f"))
1187 (const :tag "texi2dvi"
1188 ("cd %o; LATEX=\"%latex\" texi2dvi -p -b -V %b.tex"))
1189 (const :tag "latexmk"
1190 ("latexmk -g -pdf -pdflatex=\"%latex\" -outdir=%o %f"))
1191 (function)))
1193 (defcustom org-latex-logfiles-extensions
1194 '("aux" "bcf" "blg" "fdb_latexmk" "fls" "figlist" "idx" "log" "nav" "out"
1195 "ptc" "run.xml" "snm" "toc" "vrb" "xdv")
1196 "The list of file extensions to consider as LaTeX logfiles.
1197 The logfiles will be removed if `org-latex-remove-logfiles' is
1198 non-nil."
1199 :group 'org-export-latex
1200 :version "25.2"
1201 :package-version '(Org . "8.3")
1202 :type '(repeat (string :tag "Extension")))
1204 (defcustom org-latex-remove-logfiles t
1205 "Non-nil means remove the logfiles produced by PDF production.
1206 By default, logfiles are files with these extensions: .aux, .idx,
1207 .log, .out, .toc, .nav, .snm and .vrb. To define the set of
1208 logfiles to remove, set `org-latex-logfiles-extensions'."
1209 :group 'org-export-latex
1210 :type 'boolean)
1212 (defcustom org-latex-known-warnings
1213 '(("Reference.*?undefined" . "[undefined reference]")
1214 ("Runaway argument" . "[runaway argument]")
1215 ("Underfull \\hbox" . "[underfull hbox]")
1216 ("Overfull \\hbox" . "[overfull hbox]")
1217 ("Citation.*?undefined" . "[undefined citation]")
1218 ("Undefined control sequence" . "[undefined control sequence]"))
1219 "Alist of regular expressions and associated messages for the user.
1220 The regular expressions are used to find possible warnings in the
1221 log of a latex-run. These warnings will be reported after
1222 calling `org-latex-compile'."
1223 :group 'org-export-latex
1224 :version "25.2"
1225 :package-version '(Org . "8.3")
1226 :type '(repeat
1227 (cons
1228 (string :tag "Regexp")
1229 (string :tag "Message"))))
1233 ;;; Internal Functions
1235 (defun org-latex--caption-above-p (element info)
1236 "Non nil when caption is expected to be located above ELEMENT.
1237 INFO is a plist holding contextual information."
1238 (let ((above (plist-get info :latex-caption-above)))
1239 (if (symbolp above) above
1240 (let ((type (org-element-type element)))
1241 (memq (if (eq type 'link) 'image type) above)))))
1243 (defun org-latex--label (datum info &optional force full)
1244 "Return an appropriate label for DATUM.
1245 DATUM is an element or a `target' type object. INFO is the
1246 current export state, as a plist.
1248 Return nil if element DATUM has no NAME or VALUE affiliated
1249 keyword or no CUSTOM_ID property, unless FORCE is non-nil. In
1250 this case always return a unique label.
1252 Eventually, if FULL is non-nil, wrap label within \"\\label{}\"."
1253 (let* ((type (org-element-type datum))
1254 (user-label
1255 (org-element-property
1256 (cl-case type
1257 ((headline inlinetask) :CUSTOM_ID)
1258 (target :value)
1259 (otherwise :name))
1260 datum))
1261 (label
1262 (and (or user-label force)
1263 (if (and user-label (plist-get info :latex-prefer-user-labels))
1264 user-label
1265 (concat (cl-case type
1266 (headline "sec:")
1267 (table "tab:")
1268 (latex-environment
1269 (and (string-match-p
1270 org-latex-math-environments-re
1271 (org-element-property :value datum))
1272 "eq:"))
1273 (paragraph
1274 (and (org-element-property :caption datum)
1275 "fig:")))
1276 (org-export-get-reference datum info))))))
1277 (cond ((not full) label)
1278 (label (format "\\label{%s}%s"
1279 label
1280 (if (eq type 'target) "" "\n")))
1281 (t ""))))
1283 (defun org-latex--caption/label-string (element info)
1284 "Return caption and label LaTeX string for ELEMENT.
1286 INFO is a plist holding contextual information. If there's no
1287 caption nor label, return the empty string.
1289 For non-floats, see `org-latex--wrap-label'."
1290 (let* ((label (org-latex--label element info nil t))
1291 (main (org-export-get-caption element))
1292 (attr (org-export-read-attribute :attr_latex element))
1293 (type (org-element-type element))
1294 (nonfloat (or (and (plist-member attr :float)
1295 (not (plist-get attr :float))
1296 main)
1297 (and (eq type 'src-block)
1298 (not (plist-get attr :float))
1299 (memq (plist-get info :latex-listings)
1300 '(nil minted)))))
1301 (short (org-export-get-caption element t))
1302 (caption-from-attr-latex (plist-get attr :caption)))
1303 (cond
1304 ((org-string-nw-p caption-from-attr-latex)
1305 (concat caption-from-attr-latex "\n"))
1306 ((and (not main) (equal label "")) "")
1307 ((not main) label)
1308 ;; Option caption format with short name.
1310 (format (if nonfloat "\\captionof{%s}%s{%s%s}\n"
1311 "\\caption%s%s{%s%s}\n")
1312 (if nonfloat
1313 (cl-case type
1314 (paragraph "figure")
1315 (src-block (if (plist-get info :latex-listings)
1316 "listing"
1317 "figure"))
1318 (t (symbol-name type)))
1320 (if short (format "[%s]" (org-export-data short info)) "")
1321 label
1322 (org-export-data main info))))))
1324 (defun org-latex-guess-inputenc (header)
1325 "Set the coding system in inputenc to what the buffer is.
1327 HEADER is the LaTeX header string. This function only applies
1328 when specified inputenc option is \"AUTO\".
1330 Return the new header, as a string."
1331 (let* ((cs (or (ignore-errors
1332 (latexenc-coding-system-to-inputenc
1333 (or org-export-coding-system buffer-file-coding-system)))
1334 "utf8")))
1335 (if (not cs) header
1336 ;; First translate if that is requested.
1337 (setq cs (or (cdr (assoc cs org-latex-inputenc-alist)) cs))
1338 ;; Then find the \usepackage statement and replace the option.
1339 (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
1340 cs header t nil 1))))
1342 (defun org-latex-guess-babel-language (header info)
1343 "Set Babel's language according to LANGUAGE keyword.
1345 HEADER is the LaTeX header string. INFO is the plist used as
1346 a communication channel.
1348 Insertion of guessed language only happens when Babel package has
1349 explicitly been loaded. Then it is added to the rest of
1350 package's options.
1352 The argument to Babel may be \"AUTO\" which is then replaced with
1353 the language of the document or `org-export-default-language'
1354 unless language in question is already loaded.
1356 Return the new header."
1357 (let ((language-code (plist-get info :language)))
1358 ;; If no language is set or Babel package is not loaded, return
1359 ;; HEADER as-is.
1360 (if (or (not (stringp language-code))
1361 (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" header)))
1362 header
1363 (let ((options (save-match-data
1364 (org-split-string (match-string 1 header) ",[ \t]*")))
1365 (language (cdr (assoc-string language-code
1366 org-latex-babel-language-alist t))))
1367 ;; If LANGUAGE is already loaded, return header without AUTO.
1368 ;; Otherwise, replace AUTO with language or append language if
1369 ;; AUTO is not present.
1370 (replace-match
1371 (mapconcat (lambda (option) (if (equal "AUTO" option) language option))
1372 (cond ((member language options) (delete "AUTO" options))
1373 ((member "AUTO" options) options)
1374 (t (append options (list language))))
1375 ", ")
1376 t nil header 1)))))
1378 (defun org-latex-guess-polyglossia-language (header info)
1379 "Set the Polyglossia language according to the LANGUAGE keyword.
1381 HEADER is the LaTeX header string. INFO is the plist used as
1382 a communication channel.
1384 Insertion of guessed language only happens when the Polyglossia
1385 package has been explicitly loaded.
1387 The argument to Polyglossia may be \"AUTO\" which is then
1388 replaced with the language of the document or
1389 `org-export-default-language'. Note, the language is really set
1390 using \setdefaultlanguage and not as an option to the package.
1392 Return the new header."
1393 (let ((language (plist-get info :language)))
1394 ;; If no language is set or Polyglossia is not loaded, return
1395 ;; HEADER as-is.
1396 (if (or (not (stringp language))
1397 (not (string-match
1398 "\\\\usepackage\\(?:\\[\\([^]]+?\\)\\]\\){polyglossia}\n"
1399 header)))
1400 header
1401 (let* ((options (org-string-nw-p (match-string 1 header)))
1402 (languages (and options
1403 ;; Reverse as the last loaded language is
1404 ;; the main language.
1405 (nreverse
1406 (delete-dups
1407 (save-match-data
1408 (org-split-string
1409 (replace-regexp-in-string
1410 "AUTO" language options t)
1411 ",[ \t]*"))))))
1412 (main-language-set
1413 (string-match-p "\\\\setmainlanguage{.*?}" header)))
1414 (replace-match
1415 (concat "\\usepackage{polyglossia}\n"
1416 (mapconcat
1417 (lambda (l)
1418 (let ((l (or (assoc l org-latex-polyglossia-language-alist)
1419 l)))
1420 (format (if main-language-set "\\setotherlanguage%s{%s}\n"
1421 (setq main-language-set t)
1422 "\\setmainlanguage%s{%s}\n")
1423 (if (and (consp l) (= (length l) 3))
1424 (format "[variant=%s]" (nth 2 l))
1426 (nth 1 l))))
1427 languages
1428 ""))
1429 t t header 0)))))
1431 (defun org-latex--remove-packages (pkg-alist info)
1432 "Remove packages based on the current LaTeX compiler.
1434 If the fourth argument of an element is set in pkg-alist, and it
1435 is not a member of the LaTeX compiler of the document, the packages
1436 is removed. See also `org-latex-compiler'.
1438 Return modified pkg-alist."
1439 (let ((compiler (or (plist-get info :latex-compiler) "")))
1440 (if (member-ignore-case compiler org-latex-compilers)
1441 (delq nil
1442 (mapcar
1443 (lambda (pkg)
1444 (unless (and
1445 (listp pkg)
1446 (let ((third (nth 3 pkg)))
1447 (and third
1448 (not (member-ignore-case
1449 compiler
1450 (if (listp third) third (list third)))))))
1451 pkg))
1452 pkg-alist))
1453 pkg-alist)))
1455 (defun org-latex--find-verb-separator (s)
1456 "Return a character not used in string S.
1457 This is used to choose a separator for constructs like \\verb."
1458 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1459 (cl-loop for c across ll
1460 when (not (string-match (regexp-quote (char-to-string c)) s))
1461 return (char-to-string c))))
1463 (defun org-latex--make-option-string (options)
1464 "Return a comma separated string of keywords and values.
1465 OPTIONS is an alist where the key is the options keyword as
1466 a string, and the value a list containing the keyword value, or
1467 nil."
1468 (mapconcat (lambda (pair)
1469 (pcase-let ((`(,keyword ,value) pair))
1470 (concat keyword
1471 (and (> (length value) 0)
1472 (concat "=" value)))))
1473 options
1474 ","))
1476 (defun org-latex--wrap-label (element output info)
1477 "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
1478 INFO is the current export state, as a plist. This function
1479 should not be used for floats. See
1480 `org-latex--caption/label-string'."
1481 (if (not (and (org-string-nw-p output) (org-element-property :name element)))
1482 output
1483 (concat (format "\\phantomsection\n\\label{%s}\n"
1484 (org-latex--label element info))
1485 output)))
1487 (defun org-latex--protect-text (text)
1488 "Protect special characters in string TEXT and return it."
1489 (replace-regexp-in-string
1490 "--\\|[\\{}$%&_#~^]"
1491 (lambda (m)
1492 (cond ((equal m "--") "-{}-")
1493 ((equal m "\\") "\\textbackslash{}")
1494 ((equal m "~") "\\textasciitilde{}")
1495 ((equal m "^") "\\textasciicircum{}")
1496 (t (concat "\\" m))))
1497 text nil t))
1499 (defun org-latex--text-markup (text markup info)
1500 "Format TEXT depending on MARKUP text markup.
1501 INFO is a plist used as a communication channel. See
1502 `org-latex-text-markup-alist' for details."
1503 (let ((fmt (cdr (assq markup (plist-get info :latex-text-markup-alist)))))
1504 (cl-case fmt
1505 ;; No format string: Return raw text.
1506 ((nil) text)
1507 ;; Handle the `verb' special case: Find an appropriate separator
1508 ;; and use "\\verb" command.
1509 (verb
1510 (let ((separator (org-latex--find-verb-separator text)))
1511 (concat "\\verb" separator
1512 (replace-regexp-in-string "\n" " " text)
1513 separator)))
1514 ;; Handle the `protectedtexttt' special case: Protect some
1515 ;; special chars and use "\texttt{%s}" format string.
1516 (protectedtexttt
1517 (format "\\texttt{%s}" (org-latex--protect-text text)))
1518 ;; Else use format string.
1519 (t (format fmt text)))))
1521 (defun org-latex--delayed-footnotes-definitions (element info)
1522 "Return footnotes definitions in ELEMENT as a string.
1524 INFO is a plist used as a communication channel.
1526 Footnotes definitions are returned within \"\\footnotetext{}\"
1527 commands.
1529 This function is used within constructs that don't support
1530 \"\\footnote{}\" command (e.g., an item tag). In that case,
1531 \"\\footnotemark\" is used within the construct and the function
1532 just outside of it."
1533 (mapconcat
1534 (lambda (ref)
1535 (let ((def (org-export-get-footnote-definition ref info)))
1536 (format "\\footnotetext[%d]{%s%s}"
1537 (org-export-get-footnote-number ref info)
1538 (org-trim (org-latex--label def info t t))
1539 (org-trim (org-export-data def info)))))
1540 ;; Find every footnote reference in ELEMENT.
1541 (letrec ((all-refs nil)
1542 (search-refs
1543 (lambda (data)
1544 ;; Return a list of all footnote references never seen
1545 ;; before in DATA.
1546 (org-element-map data 'footnote-reference
1547 (lambda (ref)
1548 (when (org-export-footnote-first-reference-p ref info)
1549 (push ref all-refs)
1550 (when (eq (org-element-property :type ref) 'standard)
1551 (funcall search-refs
1552 (org-export-get-footnote-definition ref info)))))
1553 info)
1554 (reverse all-refs))))
1555 (funcall search-refs element))
1556 ""))
1558 (defun org-latex--translate (s info)
1559 "Translate string S according to specified language.
1560 INFO is a plist used as a communication channel."
1561 (org-export-translate s :latex info))
1563 (defun org-latex--format-spec (info)
1564 "Create a format-spec for document meta-data.
1565 INFO is a plist used as a communication channel."
1566 (let ((language (let ((lang (plist-get info :language)))
1567 (or (cdr (assoc-string lang org-latex-babel-language-alist t))
1568 (nth 1 (assoc-string lang org-latex-polyglossia-language-alist t))
1569 lang))))
1570 `((?a . ,(org-export-data (plist-get info :author) info))
1571 (?t . ,(org-export-data (plist-get info :title) info))
1572 (?k . ,(org-export-data (org-latex--wrap-latex-math-block
1573 (plist-get info :keywords) info)
1574 info))
1575 (?d . ,(org-export-data (org-latex--wrap-latex-math-block
1576 (plist-get info :description) info)
1577 info))
1578 (?c . ,(plist-get info :creator))
1579 (?l . ,language)
1580 (?L . ,(capitalize language))
1581 (?D . ,(org-export-get-date info)))))
1583 (defun org-latex--make-preamble (info)
1584 "Return a formatted LaTeX preamble.
1585 INFO is a plist used as a communication channel."
1586 (let* ((class (plist-get info :latex-class))
1587 (class-options (plist-get info :latex-class-options))
1588 (header (nth 1 (assoc class (plist-get info :latex-classes))))
1589 (document-class-string
1590 (and (stringp header)
1591 (if (not class-options) header
1592 (replace-regexp-in-string
1593 "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
1594 class-options header t nil 1)))))
1595 (if (not document-class-string)
1596 (user-error "Unknown LaTeX class `%s'" class)
1597 (org-latex-guess-polyglossia-language
1598 (org-latex-guess-babel-language
1599 (org-latex-guess-inputenc
1600 (org-element-normalize-string
1601 (org-splice-latex-header
1602 document-class-string
1603 (org-latex--remove-packages
1604 org-latex-default-packages-alist info)
1605 (org-latex--remove-packages
1606 org-latex-packages-alist info)
1608 (mapconcat 'org-element-normalize-string
1609 (list (plist-get info :latex-header)
1610 (plist-get info :latex-header-extra)) ""))))
1611 info)
1612 info))))
1614 (defun org-latex--insert-compiler (info)
1615 "Insert LaTeX_compiler info into the document.
1616 INFO is a plist used as a communication channel."
1617 (let ((compiler (plist-get info :latex-compiler)))
1618 (and (org-string-nw-p org-latex-compiler-file-string)
1619 (member (or compiler "") org-latex-compilers)
1620 (format org-latex-compiler-file-string compiler))))
1623 ;;; Template
1625 (defun org-latex-template (contents info)
1626 "Return complete document string after LaTeX conversion.
1627 CONTENTS is the transcoded contents string. INFO is a plist
1628 holding export options."
1629 (let ((title (org-export-data (plist-get info :title) info))
1630 (spec (org-latex--format-spec info)))
1631 (concat
1632 ;; Time-stamp.
1633 (and (plist-get info :time-stamp-file)
1634 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1635 ;; LaTeX compiler.
1636 (org-latex--insert-compiler info)
1637 ;; Document class and packages.
1638 (org-latex--make-preamble info)
1639 ;; Possibly limit depth for headline numbering.
1640 (let ((sec-num (plist-get info :section-numbers)))
1641 (when (integerp sec-num)
1642 (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
1643 ;; Author.
1644 (let ((author (and (plist-get info :with-author)
1645 (let ((auth (plist-get info :author)))
1646 (and auth (org-export-data auth info)))))
1647 (email (and (plist-get info :with-email)
1648 (org-export-data (plist-get info :email) info))))
1649 (cond ((and author email (not (string= "" email)))
1650 (format "\\author{%s\\thanks{%s}}\n" author email))
1651 ((or author email) (format "\\author{%s}\n" (or author email)))))
1652 ;; Date.
1653 (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
1654 (format "\\date{%s}\n" (org-export-data date info)))
1655 ;; Title and subtitle.
1656 (let* ((subtitle (plist-get info :subtitle))
1657 (formatted-subtitle
1658 (when subtitle
1659 (format (plist-get info :latex-subtitle-format)
1660 (org-export-data subtitle info))))
1661 (separate (plist-get info :latex-subtitle-separate)))
1662 (concat
1663 (format "\\title{%s%s}\n" title
1664 (if separate "" (or formatted-subtitle "")))
1665 (when (and separate subtitle)
1666 (concat formatted-subtitle "\n"))))
1667 ;; Hyperref options.
1668 (let ((template (plist-get info :latex-hyperref-template)))
1669 (and (stringp template)
1670 (format-spec template spec)))
1671 ;; Document start.
1672 "\\begin{document}\n\n"
1673 ;; Title command.
1674 (let* ((title-command (plist-get info :latex-title-command))
1675 (command (and (stringp title-command)
1676 (format-spec title-command spec))))
1677 (org-element-normalize-string
1678 (cond ((not (plist-get info :with-title)) nil)
1679 ((string= "" title) nil)
1680 ((not (stringp command)) nil)
1681 ((string-match "\\(?:[^%]\\|^\\)%s" command)
1682 (format command title))
1683 (t command))))
1684 ;; Table of contents.
1685 (let ((depth (plist-get info :with-toc)))
1686 (when depth
1687 (concat (when (wholenump depth)
1688 (format "\\setcounter{tocdepth}{%d}\n" depth))
1689 (plist-get info :latex-toc-command))))
1690 ;; Document's body.
1691 contents
1692 ;; Creator.
1693 (and (plist-get info :with-creator)
1694 (concat (plist-get info :creator) "\n"))
1695 ;; Document end.
1696 "\\end{document}")))
1700 ;;; Transcode Functions
1702 ;;;; Bold
1704 (defun org-latex-bold (_bold contents info)
1705 "Transcode BOLD from Org to LaTeX.
1706 CONTENTS is the text with bold markup. INFO is a plist holding
1707 contextual information."
1708 (org-latex--text-markup contents 'bold info))
1711 ;;;; Center Block
1713 (defun org-latex-center-block (center-block contents info)
1714 "Transcode a CENTER-BLOCK element from Org to LaTeX.
1715 CONTENTS holds the contents of the center block. INFO is a plist
1716 holding contextual information."
1717 (org-latex--wrap-label
1718 center-block (format "\\begin{center}\n%s\\end{center}" contents) info))
1721 ;;;; Clock
1723 (defun org-latex-clock (clock _contents info)
1724 "Transcode a CLOCK element from Org to LaTeX.
1725 CONTENTS is nil. INFO is a plist holding contextual
1726 information."
1727 (concat
1728 "\\noindent"
1729 (format "\\textbf{%s} " org-clock-string)
1730 (format (plist-get info :latex-inactive-timestamp-format)
1731 (concat (org-timestamp-translate (org-element-property :value clock))
1732 (let ((time (org-element-property :duration clock)))
1733 (and time (format " (%s)" time)))))
1734 "\\\\"))
1737 ;;;; Code
1739 (defun org-latex-code (code _contents info)
1740 "Transcode a CODE object from Org to LaTeX.
1741 CONTENTS is nil. INFO is a plist used as a communication
1742 channel."
1743 (org-latex--text-markup (org-element-property :value code) 'code info))
1746 ;;;; Drawer
1748 (defun org-latex-drawer (drawer contents info)
1749 "Transcode a DRAWER element from Org to LaTeX.
1750 CONTENTS holds the contents of the block. INFO is a plist
1751 holding contextual information."
1752 (let* ((name (org-element-property :drawer-name drawer))
1753 (output (funcall (plist-get info :latex-format-drawer-function)
1754 name contents)))
1755 (org-latex--wrap-label drawer output info)))
1758 ;;;; Dynamic Block
1760 (defun org-latex-dynamic-block (dynamic-block contents info)
1761 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
1762 CONTENTS holds the contents of the block. INFO is a plist
1763 holding contextual information. See `org-export-data'."
1764 (org-latex--wrap-label dynamic-block contents info))
1767 ;;;; Entity
1769 (defun org-latex-entity (entity _contents _info)
1770 "Transcode an ENTITY object from Org to LaTeX.
1771 CONTENTS are the definition itself. INFO is a plist holding
1772 contextual information."
1773 (org-element-property :latex entity))
1776 ;;;; Example Block
1778 (defun org-latex-example-block (example-block _contents info)
1779 "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
1780 CONTENTS is nil. INFO is a plist holding contextual
1781 information."
1782 (when (org-string-nw-p (org-element-property :value example-block))
1783 (let ((environment (or (org-export-read-attribute
1784 :attr_latex example-block :environment)
1785 "verbatim")))
1786 (org-latex--wrap-label
1787 example-block
1788 (format "\\begin{%s}\n%s\\end{%s}"
1789 environment
1790 (org-export-format-code-default example-block info)
1791 environment)
1792 info))))
1795 ;;;; Export Block
1797 (defun org-latex-export-block (export-block _contents _info)
1798 "Transcode a EXPORT-BLOCK element from Org to LaTeX.
1799 CONTENTS is nil. INFO is a plist holding contextual information."
1800 (when (member (org-element-property :type export-block) '("LATEX" "TEX"))
1801 (org-remove-indentation (org-element-property :value export-block))))
1804 ;;;; Export Snippet
1806 (defun org-latex-export-snippet (export-snippet _contents _info)
1807 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
1808 CONTENTS is nil. INFO is a plist holding contextual information."
1809 (when (eq (org-export-snippet-backend export-snippet) 'latex)
1810 (org-element-property :value export-snippet)))
1813 ;;;; Fixed Width
1815 (defun org-latex-fixed-width (fixed-width _contents info)
1816 "Transcode a FIXED-WIDTH element from Org to LaTeX.
1817 CONTENTS is nil. INFO is a plist holding contextual information."
1818 (org-latex--wrap-label
1819 fixed-width
1820 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1821 (org-remove-indentation
1822 (org-element-property :value fixed-width)))
1823 info))
1826 ;;;; Footnote Reference
1828 (defun org-latex-footnote-reference (footnote-reference _contents info)
1829 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1830 CONTENTS is nil. INFO is a plist holding contextual information."
1831 (let ((label (org-element-property :label footnote-reference)))
1832 (concat
1833 ;; Insert separator between two footnotes in a row.
1834 (let ((prev (org-export-get-previous-element footnote-reference info)))
1835 (when (eq (org-element-type prev) 'footnote-reference)
1836 (plist-get info :latex-footnote-separator)))
1837 (cond
1838 ;; Use `:latex-footnote-defined-format' if the footnote has
1839 ;; already been defined.
1840 ((not (org-export-footnote-first-reference-p footnote-reference info))
1841 (format (plist-get info :latex-footnote-defined-format)
1842 (org-latex--label
1843 (org-export-get-footnote-definition footnote-reference info)
1844 info t)))
1845 ;; Use \footnotemark if reference is within another footnote
1846 ;; reference, footnote definition or table cell.
1847 ((org-element-lineage footnote-reference
1848 '(footnote-reference footnote-definition table-cell))
1849 "\\footnotemark")
1850 ;; Otherwise, define it with \footnote command.
1852 (let ((def (org-export-get-footnote-definition footnote-reference info)))
1853 (concat
1854 (format "\\footnote{%s%s}" (org-trim (org-export-data def info))
1855 ;; Only insert a \label if there exist another
1856 ;; reference to def.
1857 (cond ((not label) "")
1858 ((org-element-map (plist-get info :parse-tree) 'footnote-reference
1859 (lambda (f)
1860 (and (not (eq f footnote-reference))
1861 (equal (org-element-property :label f) label)
1862 (org-trim (org-latex--label def info t t))))
1863 info t))
1864 (t "")))
1865 ;; Retrieve all footnote references within the footnote and
1866 ;; add their definition after it, since LaTeX doesn't support
1867 ;; them inside.
1868 (org-latex--delayed-footnotes-definitions def info))))))))
1871 ;;;; Headline
1873 (defun org-latex-headline (headline contents info)
1874 "Transcode a HEADLINE element from Org to LaTeX.
1875 CONTENTS holds the contents of the headline. INFO is a plist
1876 holding contextual information."
1877 (unless (org-element-property :footnote-section-p headline)
1878 (let* ((class (plist-get info :latex-class))
1879 (level (org-export-get-relative-level headline info))
1880 (numberedp (org-export-numbered-headline-p headline info))
1881 (class-sectioning (assoc class (plist-get info :latex-classes)))
1882 ;; Section formatting will set two placeholders: one for
1883 ;; the title and the other for the contents.
1884 (section-fmt
1885 (let ((sec (if (functionp (nth 2 class-sectioning))
1886 (funcall (nth 2 class-sectioning) level numberedp)
1887 (nth (1+ level) class-sectioning))))
1888 (cond
1889 ;; No section available for that LEVEL.
1890 ((not sec) nil)
1891 ;; Section format directly returned by a function. Add
1892 ;; placeholder for contents.
1893 ((stringp sec) (concat sec "\n%s"))
1894 ;; (numbered-section . unnumbered-section)
1895 ((not (consp (cdr sec)))
1896 (concat (funcall (if numberedp #'car #'cdr) sec) "\n%s"))
1897 ;; (numbered-open numbered-close)
1898 ((= (length sec) 2)
1899 (when numberedp (concat (car sec) "\n%s" (nth 1 sec))))
1900 ;; (num-in num-out no-num-in no-num-out)
1901 ((= (length sec) 4)
1902 (if numberedp (concat (car sec) "\n%s" (nth 1 sec))
1903 (concat (nth 2 sec) "\n%s" (nth 3 sec)))))))
1904 ;; Create a temporary export back-end that hard-codes
1905 ;; "\underline" within "\section" and alike.
1906 (section-back-end
1907 (org-export-create-backend
1908 :parent 'latex
1909 :transcoders
1910 '((underline . (lambda (o c i) (format "\\underline{%s}" c))))))
1911 (text
1912 (org-export-data-with-backend
1913 (org-element-property :title headline) section-back-end info))
1914 (todo
1915 (and (plist-get info :with-todo-keywords)
1916 (let ((todo (org-element-property :todo-keyword headline)))
1917 (and todo (org-export-data todo info)))))
1918 (todo-type (and todo (org-element-property :todo-type headline)))
1919 (tags (and (plist-get info :with-tags)
1920 (org-export-get-tags headline info)))
1921 (priority (and (plist-get info :with-priority)
1922 (org-element-property :priority headline)))
1923 ;; Create the headline text along with a no-tag version.
1924 ;; The latter is required to remove tags from toc.
1925 (full-text (funcall (plist-get info :latex-format-headline-function)
1926 todo todo-type priority text tags info))
1927 ;; Associate \label to the headline for internal links.
1928 (headline-label (org-latex--label headline info t t))
1929 (pre-blanks
1930 (make-string (org-element-property :pre-blank headline) ?\n)))
1931 (if (or (not section-fmt) (org-export-low-level-p headline info))
1932 ;; This is a deep sub-tree: export it as a list item. Also
1933 ;; export as items headlines for which no section format has
1934 ;; been found.
1935 (let ((low-level-body
1936 (concat
1937 ;; If headline is the first sibling, start a list.
1938 (when (org-export-first-sibling-p headline info)
1939 (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize)))
1940 ;; Itemize headline
1941 "\\item"
1942 (and full-text
1943 (string-match-p "\\`[ \t]*\\[" full-text)
1944 "\\relax")
1945 " " full-text "\n"
1946 headline-label
1947 pre-blanks
1948 contents)))
1949 ;; If headline is not the last sibling simply return
1950 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
1951 ;; any blank line.
1952 (if (not (org-export-last-sibling-p headline info)) low-level-body
1953 (replace-regexp-in-string
1954 "[ \t\n]*\\'"
1955 (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize))
1956 low-level-body)))
1957 ;; This is a standard headline. Export it as a section. Add
1958 ;; an alternative heading when possible, and when this is not
1959 ;; identical to the usual heading.
1960 (let ((opt-title
1961 (funcall (plist-get info :latex-format-headline-function)
1962 todo todo-type priority
1963 (org-export-data-with-backend
1964 (org-export-get-alt-title headline info)
1965 section-back-end info)
1966 (and (eq (plist-get info :with-tags) t) tags)
1967 info))
1968 ;; Maybe end local TOC (see `org-latex-keyword').
1969 (contents
1970 (concat
1971 contents
1972 (let ((case-fold-search t)
1973 (section
1974 (let ((first (car (org-element-contents headline))))
1975 (and (eq (org-element-type first) 'section) first))))
1976 (org-element-map section 'keyword
1977 (lambda (k)
1978 (and (equal (org-element-property :key k) "TOC")
1979 (let ((v (org-element-property :value k)))
1980 (and (string-match-p "\\<headlines\\>" v)
1981 (string-match-p "\\<local\\>" v)
1982 (format "\\stopcontents[level-%d]" level)))))
1983 info t)))))
1984 (if (and opt-title
1985 (not (equal opt-title full-text))
1986 (string-match "\\`\\\\\\(.+?\\){" section-fmt))
1987 (format (replace-match "\\1[%s]" nil nil section-fmt 1)
1988 ;; Replace square brackets with parenthesis
1989 ;; since square brackets are not supported in
1990 ;; optional arguments.
1991 (replace-regexp-in-string
1992 "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title))
1993 full-text
1994 (concat headline-label pre-blanks contents))
1995 ;; Impossible to add an alternative heading. Fallback to
1996 ;; regular sectioning format string.
1997 (format section-fmt full-text
1998 (concat headline-label pre-blanks contents))))))))
2000 (defun org-latex-format-headline-default-function
2001 (todo _todo-type priority text tags info)
2002 "Default format function for a headline.
2003 See `org-latex-format-headline-function' for details."
2004 (concat
2005 (and todo (format "{\\bfseries\\sffamily %s} " todo))
2006 (and priority (format "\\framebox{\\#%c} " priority))
2007 text
2008 (and tags
2009 (format "\\hfill{}\\textsc{%s}"
2010 (mapconcat (lambda (tag) (org-latex-plain-text tag info))
2011 tags ":")))))
2014 ;;;; Horizontal Rule
2016 (defun org-latex-horizontal-rule (horizontal-rule _contents info)
2017 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
2018 CONTENTS is nil. INFO is a plist holding contextual information."
2019 (let ((attr (org-export-read-attribute :attr_latex horizontal-rule))
2020 (prev (org-export-get-previous-element horizontal-rule info)))
2021 (concat
2022 ;; Make sure the rule doesn't start at the end of the current
2023 ;; line by separating it with a blank line from previous element.
2024 (when (and prev
2025 (let ((prev-blank (org-element-property :post-blank prev)))
2026 (or (not prev-blank) (zerop prev-blank))))
2027 "\n")
2028 (org-latex--wrap-label
2029 horizontal-rule
2030 (format "\\rule{%s}{%s}"
2031 (or (plist-get attr :width) "\\linewidth")
2032 (or (plist-get attr :thickness) "0.5pt"))
2033 info))))
2036 ;;;; Inline Src Block
2038 (defun org-latex-inline-src-block (inline-src-block _contents info)
2039 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
2040 CONTENTS holds the contents of the item. INFO is a plist holding
2041 contextual information."
2042 (let* ((code (org-element-property :value inline-src-block))
2043 (separator (org-latex--find-verb-separator code)))
2044 (cl-case (plist-get info :latex-listings)
2045 ;; Do not use a special package: transcode it verbatim.
2046 ((nil) (format "\\texttt{%s}" (org-latex--protect-text code)))
2047 ;; Use minted package.
2048 (minted
2049 (let* ((org-lang (org-element-property :language inline-src-block))
2050 (mint-lang (or (cadr (assq (intern org-lang)
2051 (plist-get info :latex-minted-langs)))
2052 (downcase org-lang)))
2053 (options (org-latex--make-option-string
2054 (plist-get info :latex-minted-options))))
2055 (format "\\mintinline%s{%s}{%s}"
2056 (if (string= options "") "" (format "[%s]" options))
2057 mint-lang
2058 code)))
2059 ;; Use listings package.
2060 (otherwise
2061 ;; Maybe translate language's name.
2062 (let* ((org-lang (org-element-property :language inline-src-block))
2063 (lst-lang (or (cadr (assq (intern org-lang)
2064 (plist-get info :latex-listings-langs)))
2065 org-lang))
2066 (options (org-latex--make-option-string
2067 (append (plist-get info :latex-listings-options)
2068 `(("language" ,lst-lang))))))
2069 (concat (format "\\lstinline[%s]" options)
2070 separator code separator))))))
2073 ;;;; Inlinetask
2075 (defun org-latex-inlinetask (inlinetask contents info)
2076 "Transcode an INLINETASK element from Org to LaTeX.
2077 CONTENTS holds the contents of the block. INFO is a plist
2078 holding contextual information."
2079 (let ((title (org-export-data (org-element-property :title inlinetask) info))
2080 (todo (and (plist-get info :with-todo-keywords)
2081 (let ((todo (org-element-property :todo-keyword inlinetask)))
2082 (and todo (org-export-data todo info)))))
2083 (todo-type (org-element-property :todo-type inlinetask))
2084 (tags (and (plist-get info :with-tags)
2085 (org-export-get-tags inlinetask info)))
2086 (priority (and (plist-get info :with-priority)
2087 (org-element-property :priority inlinetask)))
2088 (contents (concat (org-latex--label inlinetask info) contents)))
2089 (funcall (plist-get info :latex-format-inlinetask-function)
2090 todo todo-type priority title tags contents info)))
2092 (defun org-latex-format-inlinetask-default-function
2093 (todo _todo-type priority title tags contents info)
2094 "Default format function for a inlinetasks.
2095 See `org-latex-format-inlinetask-function' for details."
2096 (let ((full-title
2097 (concat (when todo (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
2098 (when priority (format "\\framebox{\\#%c} " priority))
2099 title
2100 (when tags
2101 (format "\\hfill{}\\textsc{:%s:}"
2102 (mapconcat
2103 (lambda (tag) (org-latex-plain-text tag info))
2104 tags ":"))))))
2105 (concat "\\begin{center}\n"
2106 "\\fbox{\n"
2107 "\\begin{minipage}[c]{.6\\textwidth}\n"
2108 full-title "\n\n"
2109 (and (org-string-nw-p contents)
2110 (concat "\\rule[.8em]{\\textwidth}{2pt}\n\n" contents))
2111 "\\end{minipage}\n"
2112 "}\n"
2113 "\\end{center}")))
2116 ;;;; Italic
2118 (defun org-latex-italic (_italic contents info)
2119 "Transcode ITALIC from Org to LaTeX.
2120 CONTENTS is the text with italic markup. INFO is a plist holding
2121 contextual information."
2122 (org-latex--text-markup contents 'italic info))
2125 ;;;; Item
2127 (defun org-latex-item (item contents info)
2128 "Transcode an ITEM element from Org to LaTeX.
2129 CONTENTS holds the contents of the item. INFO is a plist holding
2130 contextual information."
2131 (let* ((counter
2132 (let ((count (org-element-property :counter item))
2133 (level
2134 ;; Determine level of current item to determine the
2135 ;; correct LaTeX counter to use (enumi, enumii...).
2136 (let ((parent item) (level 0))
2137 (while (memq (org-element-type
2138 (setq parent (org-export-get-parent parent)))
2139 '(plain-list item))
2140 (when (and (eq (org-element-type parent) 'plain-list)
2141 (eq (org-element-property :type parent)
2142 'ordered))
2143 (cl-incf level)))
2144 level)))
2145 (and count
2146 (< level 5)
2147 (format "\\setcounter{enum%s}{%s}\n"
2148 (nth (1- level) '("i" "ii" "iii" "iv"))
2149 (1- count)))))
2150 (checkbox (cl-case (org-element-property :checkbox item)
2151 (on "$\\boxtimes$ ")
2152 (off "$\\square$ ")
2153 (trans "$\\boxminus$ ")))
2154 (tag (let ((tag (org-element-property :tag item)))
2155 ;; Check-boxes must belong to the tag.
2156 (and tag (format "[{%s}] "
2157 (concat checkbox
2158 (org-export-data tag info)))))))
2159 (concat counter
2160 "\\item"
2161 (cond
2162 (tag)
2163 (checkbox (concat " " checkbox))
2164 ;; Without a tag or a check-box, if CONTENTS starts with
2165 ;; an opening square bracket, add "\relax" to "\item",
2166 ;; unless the brackets comes from an initial export
2167 ;; snippet (i.e. it is inserted willingly by the user).
2168 ((and contents
2169 (string-match-p "\\`[ \t]*\\[" contents)
2170 (not (let ((e (car (org-element-contents item))))
2171 (and (eq (org-element-type e) 'paragraph)
2172 (let ((o (car (org-element-contents e))))
2173 (and (eq (org-element-type o) 'export-snippet)
2174 (eq (org-export-snippet-backend o)
2175 'latex)))))))
2176 "\\relax ")
2177 (t " "))
2178 (and contents (org-trim contents))
2179 ;; If there are footnotes references in tag, be sure to
2180 ;; add their definition at the end of the item. This
2181 ;; workaround is necessary since "\footnote{}" command is
2182 ;; not supported in tags.
2183 (and tag
2184 (org-latex--delayed-footnotes-definitions
2185 (org-element-property :tag item) info)))))
2188 ;;;; Keyword
2190 (defun org-latex-keyword (keyword _contents info)
2191 "Transcode a KEYWORD element from Org to LaTeX.
2192 CONTENTS is nil. INFO is a plist holding contextual information."
2193 (let ((key (org-element-property :key keyword))
2194 (value (org-element-property :value keyword)))
2195 (cond
2196 ((string= key "LATEX") value)
2197 ((string= key "INDEX") (format "\\index{%s}" value))
2198 ((string= key "TOC")
2199 (let ((case-fold-search t))
2200 (cond
2201 ((string-match-p "\\<headlines\\>" value)
2202 (let* ((localp (string-match-p "\\<local\\>" value))
2203 (parent (org-element-lineage keyword '(headline)))
2204 (level (if (not (and localp parent)) 0
2205 (org-export-get-relative-level parent info)))
2206 (depth
2207 (and (string-match "\\<[0-9]+\\>" value)
2208 (format
2209 "\\setcounter{tocdepth}{%d}"
2210 (+ (string-to-number (match-string 0 value)) level)))))
2211 (if (and localp parent)
2212 ;; Start local TOC, assuming package "titletoc" is
2213 ;; required.
2214 (format "\\startcontents[level-%d]
2215 \\printcontents[level-%d]{}{0}{%s}"
2216 level level (or depth ""))
2217 (concat depth (and depth "\n") "\\tableofcontents"))))
2218 ((string-match-p "\\<tables\\>" value) "\\listoftables")
2219 ((string-match-p "\\<listings\\>" value)
2220 (cl-case (plist-get info :latex-listings)
2221 ((nil) "\\listoffigures")
2222 (minted "\\listoflistings")
2223 (otherwise "\\lstlistoflistings")))))))))
2226 ;;;; Latex Environment
2228 (defun org-latex-latex-environment (latex-environment _contents info)
2229 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
2230 CONTENTS is nil. INFO is a plist holding contextual information."
2231 (when (plist-get info :with-latex)
2232 (let ((value (org-remove-indentation
2233 (org-element-property :value latex-environment))))
2234 (if (not (org-element-property :name latex-environment)) value
2235 ;; Environment is labeled: label must be within the environment
2236 ;; (otherwise, a reference pointing to that element will count
2237 ;; the section instead).
2238 (with-temp-buffer
2239 (insert value)
2240 (goto-char (point-min))
2241 (forward-line)
2242 (insert (org-latex--label latex-environment info nil t))
2243 (buffer-string))))))
2246 ;;;; Latex Fragment
2248 (defun org-latex-latex-fragment (latex-fragment _contents _info)
2249 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
2250 CONTENTS is nil. INFO is a plist holding contextual information."
2251 (let ((value (org-element-property :value latex-fragment)))
2252 ;; Trim math markers since the fragment is enclosed within
2253 ;; a latex-math-block object anyway.
2254 (cond ((string-match-p "\\`\\$[^$]" value) (substring value 1 -1))
2255 ((string-prefix-p "\\(" value) (substring value 2 -2))
2256 (t value))))
2259 ;;;; Line Break
2261 (defun org-latex-line-break (_line-break _contents _info)
2262 "Transcode a LINE-BREAK object from Org to LaTeX.
2263 CONTENTS is nil. INFO is a plist holding contextual information."
2264 "\\\\\n")
2267 ;;;; Link
2269 (defun org-latex--inline-image (link info)
2270 "Return LaTeX code for an inline image.
2271 LINK is the link pointing to the inline image. INFO is a plist
2272 used as a communication channel."
2273 (let* ((parent (org-export-get-parent-element link))
2274 (path (let ((raw-path (org-element-property :path link)))
2275 (if (not (file-name-absolute-p raw-path)) raw-path
2276 (expand-file-name raw-path))))
2277 (filetype (file-name-extension path))
2278 (caption (org-latex--caption/label-string parent info))
2279 (caption-above-p (org-latex--caption-above-p link info))
2280 ;; Retrieve latex attributes from the element around.
2281 (attr (org-export-read-attribute :attr_latex parent))
2282 (float (let ((float (plist-get attr :float)))
2283 (cond ((string= float "wrap") 'wrap)
2284 ((string= float "sideways") 'sideways)
2285 ((string= float "multicolumn") 'multicolumn)
2286 ((and (plist-member attr :float) (not float)) 'nonfloat)
2287 ((or float
2288 (org-element-property :caption parent)
2289 (org-string-nw-p (plist-get attr :caption)))
2290 'figure)
2291 (t 'nonfloat))))
2292 (placement
2293 (let ((place (plist-get attr :placement)))
2294 (cond
2295 (place (format "%s" place))
2296 ((eq float 'wrap) "{l}{0.5\\textwidth}")
2297 ((eq float 'figure)
2298 (format "[%s]" (plist-get info :latex-default-figure-position)))
2299 (t ""))))
2300 (center
2301 (if (plist-member attr :center) (plist-get attr :center)
2302 (plist-get info :latex-images-centered)))
2303 (comment-include (if (plist-get attr :comment-include) "%" ""))
2304 ;; It is possible to specify width and height in the
2305 ;; ATTR_LATEX line, and also via default variables.
2306 (width (cond ((plist-get attr :width))
2307 ((plist-get attr :height) "")
2308 ((eq float 'wrap) "0.48\\textwidth")
2309 (t (plist-get info :latex-image-default-width))))
2310 (height (cond ((plist-get attr :height))
2311 ((or (plist-get attr :width)
2312 (memq float '(figure wrap))) "")
2313 (t (plist-get info :latex-image-default-height))))
2314 (options (let ((opt (or (plist-get attr :options)
2315 (plist-get info :latex-image-default-option))))
2316 (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt)) opt
2317 (match-string 1 opt))))
2318 image-code)
2319 (if (member filetype '("tikz" "pgf"))
2320 ;; For tikz images:
2321 ;; - use \input to read in image file.
2322 ;; - if options are present, wrap in a tikzpicture environment.
2323 ;; - if width or height are present, use \resizebox to change
2324 ;; the image size.
2325 (progn
2326 (setq image-code (format "\\input{%s}" path))
2327 (when (org-string-nw-p options)
2328 (setq image-code
2329 (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
2330 options
2331 image-code)))
2332 (when (or (org-string-nw-p width) (org-string-nw-p height))
2333 (setq image-code (format "\\resizebox{%s}{%s}{%s}"
2334 (if (org-string-nw-p width) width "!")
2335 (if (org-string-nw-p height) height "!")
2336 image-code))))
2337 ;; For other images:
2338 ;; - add width and height to options.
2339 ;; - include the image with \includegraphics.
2340 (when (org-string-nw-p width)
2341 (setq options (concat options ",width=" width)))
2342 (when (org-string-nw-p height)
2343 (setq options (concat options ",height=" height)))
2344 (let ((search-option (org-element-property :search-option link)))
2345 (when (and search-option
2346 (equal filetype "pdf")
2347 (string-match-p "\\`[0-9]+\\'" search-option)
2348 (not (string-match-p "page=" options)))
2349 (setq options (concat options ",page=" search-option))))
2350 (setq image-code
2351 (format "\\includegraphics%s{%s}"
2352 (cond ((not (org-string-nw-p options)) "")
2353 ((string-prefix-p "," options)
2354 (format "[%s]" (substring options 1)))
2355 (t (format "[%s]" options)))
2356 path))
2357 (when (equal filetype "svg")
2358 (setq image-code (replace-regexp-in-string "^\\\\includegraphics"
2359 "\\includesvg"
2360 image-code
2361 nil t))
2362 (setq image-code (replace-regexp-in-string "\\.svg}"
2364 image-code
2365 nil t))))
2366 ;; Return proper string, depending on FLOAT.
2367 (pcase float
2368 (`wrap (format "\\begin{wrapfigure}%s
2369 %s%s
2370 %s%s
2371 %s\\end{wrapfigure}"
2372 placement
2373 (if caption-above-p caption "")
2374 (if center "\\centering" "")
2375 comment-include image-code
2376 (if caption-above-p "" caption)))
2377 (`sideways (format "\\begin{sidewaysfigure}
2378 %s%s
2379 %s%s
2380 %s\\end{sidewaysfigure}"
2381 (if caption-above-p caption "")
2382 (if center "\\centering" "")
2383 comment-include image-code
2384 (if caption-above-p "" caption)))
2385 (`multicolumn (format "\\begin{figure*}%s
2386 %s%s
2387 %s%s
2388 %s\\end{figure*}"
2389 placement
2390 (if caption-above-p caption "")
2391 (if center "\\centering" "")
2392 comment-include image-code
2393 (if caption-above-p "" caption)))
2394 (`figure (format "\\begin{figure}%s
2395 %s%s
2396 %s%s
2397 %s\\end{figure}"
2398 placement
2399 (if caption-above-p caption "")
2400 (if center "\\centering" "")
2401 comment-include image-code
2402 (if caption-above-p "" caption)))
2403 ((guard center)
2404 (format "\\begin{center}
2405 %s%s
2406 %s\\end{center}"
2407 (if caption-above-p caption "")
2408 image-code
2409 (if caption-above-p "" caption)))
2411 (concat (if caption-above-p caption "")
2412 image-code
2413 (if caption-above-p caption ""))))))
2415 (defun org-latex-link (link desc info)
2416 "Transcode a LINK object from Org to LaTeX.
2418 DESC is the description part of the link, or the empty string.
2419 INFO is a plist holding contextual information. See
2420 `org-export-data'."
2421 (let* ((type (org-element-property :type link))
2422 (raw-path (replace-regexp-in-string
2423 "%" "\\%" (org-element-property :path link) nil t))
2424 ;; Ensure DESC really exists, or set it to nil.
2425 (desc (and (not (string= desc "")) desc))
2426 (imagep (org-export-inline-image-p
2427 link (plist-get info :latex-inline-image-rules)))
2428 (path (cond
2429 ((member type '("http" "https" "ftp" "mailto" "doi"))
2430 (concat type ":" raw-path))
2431 ((string= type "file") (org-export-file-uri raw-path))
2432 (t raw-path))))
2433 (cond
2434 ;; Link type is handled by a special function.
2435 ((org-export-custom-protocol-maybe link desc 'latex))
2436 ;; Image file.
2437 (imagep (org-latex--inline-image link info))
2438 ;; Radio link: Transcode target's contents and use them as link's
2439 ;; description.
2440 ((string= type "radio")
2441 (let ((destination (org-export-resolve-radio-link link info)))
2442 (if (not destination) desc
2443 (format "\\hyperref[%s]{%s}"
2444 (org-export-get-reference destination info)
2445 desc))))
2446 ;; Links pointing to a headline: Find destination and build
2447 ;; appropriate referencing command.
2448 ((member type '("custom-id" "fuzzy" "id"))
2449 (let ((destination (if (string= type "fuzzy")
2450 (org-export-resolve-fuzzy-link link info)
2451 (org-export-resolve-id-link link info))))
2452 (cl-case (org-element-type destination)
2453 ;; Id link points to an external file.
2454 (plain-text
2455 (if desc (format "\\href{%s}{%s}" destination desc)
2456 (format "\\url{%s}" destination)))
2457 ;; Fuzzy link points nowhere.
2458 ((nil)
2459 (format (plist-get info :latex-link-with-unknown-path-format)
2460 (or desc
2461 (org-export-data
2462 (org-element-property :raw-link link) info))))
2463 ;; LINK points to a headline. If headlines are numbered
2464 ;; and the link has no description, display headline's
2465 ;; number. Otherwise, display description or headline's
2466 ;; title.
2467 (headline
2468 (let ((label (org-latex--label destination info t)))
2469 (if (and (not desc)
2470 (org-export-numbered-headline-p destination info))
2471 (format "\\ref{%s}" label)
2472 (format "\\hyperref[%s]{%s}" label
2473 (or desc
2474 (org-export-data
2475 (org-element-property :title destination) info))))))
2476 ;; Fuzzy link points to a target. Do as above.
2477 (otherwise
2478 (let ((ref (org-latex--label destination info t)))
2479 (if (not desc) (format "\\ref{%s}" ref)
2480 (format "\\hyperref[%s]{%s}" ref desc)))))))
2481 ;; Coderef: replace link with the reference name or the
2482 ;; equivalent line number.
2483 ((string= type "coderef")
2484 (format (org-export-get-coderef-format path desc)
2485 (org-export-resolve-coderef path info)))
2486 ;; External link with a description part.
2487 ((and path desc) (format "\\href{%s}{%s}" path desc))
2488 ;; External link without a description part.
2489 (path (format "\\url{%s}" path))
2490 ;; No path, only description. Try to do something useful.
2491 (t (format (plist-get info :latex-link-with-unknown-path-format) desc)))))
2494 ;;;; Node Property
2496 (defun org-latex-node-property (node-property _contents _info)
2497 "Transcode a NODE-PROPERTY element from Org to LaTeX.
2498 CONTENTS is nil. INFO is a plist holding contextual
2499 information."
2500 (format "%s:%s"
2501 (org-element-property :key node-property)
2502 (let ((value (org-element-property :value node-property)))
2503 (if value (concat " " value) ""))))
2506 ;;;; Paragraph
2508 (defun org-latex-paragraph (_paragraph contents _info)
2509 "Transcode a PARAGRAPH element from Org to LaTeX.
2510 CONTENTS is the contents of the paragraph, as a string. INFO is
2511 the plist used as a communication channel."
2512 contents)
2515 ;;;; Plain List
2517 (defun org-latex-plain-list (plain-list contents info)
2518 "Transcode a PLAIN-LIST element from Org to LaTeX.
2519 CONTENTS is the contents of the list. INFO is a plist holding
2520 contextual information."
2521 (let* ((type (org-element-property :type plain-list))
2522 (attr (org-export-read-attribute :attr_latex plain-list))
2523 (latex-type (let ((env (plist-get attr :environment)))
2524 (cond (env (format "%s" env))
2525 ((eq type 'ordered) "enumerate")
2526 ((eq type 'descriptive) "description")
2527 (t "itemize")))))
2528 (org-latex--wrap-label
2529 plain-list
2530 (format "\\begin{%s}%s\n%s\\end{%s}"
2531 latex-type
2532 (or (plist-get attr :options) "")
2533 contents
2534 latex-type)
2535 info)))
2538 ;;;; Plain Text
2540 (defun org-latex-plain-text (text info)
2541 "Transcode a TEXT string from Org to LaTeX.
2542 TEXT is the string to transcode. INFO is a plist holding
2543 contextual information."
2544 (let* ((specialp (plist-get info :with-special-strings))
2545 (output
2546 ;; Turn LaTeX into \LaTeX{} and TeX into \TeX{}.
2547 (let ((case-fold-search nil))
2548 (replace-regexp-in-string
2549 "\\<\\(?:La\\)?TeX\\>" "\\\\\\&{}"
2550 ;; Protect ^, ~, %, #, &, $, _, { and }. Also protect \.
2551 ;; However, if special strings are used, be careful not
2552 ;; to protect "\" in "\-" constructs.
2553 (replace-regexp-in-string
2554 (concat "[%$#&{}_~^]\\|\\\\" (and specialp "\\([^-]\\|$\\)"))
2555 (lambda (m)
2556 (cl-case (string-to-char m)
2557 (?\\ "$\\\\backslash$\\1")
2558 (?~ "\\\\textasciitilde{}")
2559 (?^ "\\\\^{}")
2560 (t "\\\\\\&")))
2561 text)))))
2562 ;; Activate smart quotes. Be sure to provide original TEXT string
2563 ;; since OUTPUT may have been modified.
2564 (when (plist-get info :with-smart-quotes)
2565 (setq output (org-export-activate-smart-quotes output :latex info text)))
2566 ;; Convert special strings.
2567 (when specialp
2568 (setq output (replace-regexp-in-string "\\.\\.\\." "\\\\ldots{}" output)))
2569 ;; Handle break preservation if required.
2570 (when (plist-get info :preserve-breaks)
2571 (setq output (replace-regexp-in-string
2572 "\\(?:[ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n" output nil t)))
2573 ;; Return value.
2574 output))
2577 ;;;; Planning
2579 (defun org-latex-planning (planning _contents info)
2580 "Transcode a PLANNING element from Org to LaTeX.
2581 CONTENTS is nil. INFO is a plist holding contextual
2582 information."
2583 (concat
2584 "\\noindent"
2585 (mapconcat
2586 'identity
2587 (delq nil
2588 (list
2589 (let ((closed (org-element-property :closed planning)))
2590 (when closed
2591 (concat
2592 (format "\\textbf{%s} " org-closed-string)
2593 (format (plist-get info :latex-inactive-timestamp-format)
2594 (org-timestamp-translate closed)))))
2595 (let ((deadline (org-element-property :deadline planning)))
2596 (when deadline
2597 (concat
2598 (format "\\textbf{%s} " org-deadline-string)
2599 (format (plist-get info :latex-active-timestamp-format)
2600 (org-timestamp-translate deadline)))))
2601 (let ((scheduled (org-element-property :scheduled planning)))
2602 (when scheduled
2603 (concat
2604 (format "\\textbf{%s} " org-scheduled-string)
2605 (format (plist-get info :latex-active-timestamp-format)
2606 (org-timestamp-translate scheduled)))))))
2607 " ")
2608 "\\\\"))
2611 ;;;; Property Drawer
2613 (defun org-latex-property-drawer (_property-drawer contents _info)
2614 "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
2615 CONTENTS holds the contents of the drawer. INFO is a plist
2616 holding contextual information."
2617 (and (org-string-nw-p contents)
2618 (format "\\begin{verbatim}\n%s\\end{verbatim}" contents)))
2621 ;;;; Pseudo Element: LaTeX Matrices
2623 ;; `latex-matrices' elements have the following properties:
2624 ;; `:caption', `:post-blank' and `:markup' (`inline', `equation' or
2625 ;; `math').
2627 (defun org-latex--wrap-latex-matrices (data info)
2628 "Merge contiguous tables with the same mode within a pseudo-element.
2629 DATA is a parse tree or a secondary string. INFO is a plist
2630 containing export options. Modify DATA by side-effect and return
2631 it."
2632 (org-element-map data 'table
2633 (lambda (table)
2634 (when (eq (org-element-property :type table) 'org)
2635 (let ((mode (or (org-export-read-attribute :attr_latex table :mode)
2636 (plist-get info :latex-default-table-mode))))
2637 (when (and (member mode '("inline-math" "math"))
2638 ;; Do not wrap twice the same table.
2639 (not (eq (org-element-type
2640 (org-element-property :parent table))
2641 'latex-matrices)))
2642 (let* ((caption (and (not (string= mode "inline-math"))
2643 (org-element-property :caption table)))
2644 (matrices
2645 (list 'latex-matrices
2646 (list :caption caption
2647 :markup
2648 (cond ((string= mode "inline-math") 'inline)
2649 (caption 'equation)
2650 (t 'math)))))
2651 (previous table)
2652 (next (org-export-get-next-element table info)))
2653 (org-element-insert-before matrices table)
2654 ;; Swallow all contiguous tables sharing the same mode.
2655 (while (and
2656 (zerop (or (org-element-property :post-blank previous) 0))
2657 (setq next (org-export-get-next-element previous info))
2658 (eq (org-element-type next) 'table)
2659 (eq (org-element-property :type next) 'org)
2660 (string= (or (org-export-read-attribute
2661 :attr_latex next :mode)
2662 (plist-get info :latex-default-table-mode))
2663 mode))
2664 (org-element-extract-element previous)
2665 (org-element-adopt-elements matrices previous)
2666 (setq previous next))
2667 ;; Inherit `:post-blank' from the value of the last
2668 ;; swallowed table. Set the latter's `:post-blank'
2669 ;; value to 0 so as to not duplicate empty lines.
2670 (org-element-put-property
2671 matrices :post-blank (org-element-property :post-blank previous))
2672 (org-element-put-property previous :post-blank 0)
2673 (org-element-extract-element previous)
2674 (org-element-adopt-elements matrices previous))))))
2675 info)
2676 data)
2678 (defun org-latex-matrices (matrices contents _info)
2679 "Transcode a MATRICES element from Org to LaTeX.
2680 CONTENTS is a string. INFO is a plist used as a communication
2681 channel."
2682 (format (cl-case (org-element-property :markup matrices)
2683 (inline "\\(%s\\)")
2684 (equation "\\begin{equation}\n%s\\end{equation}")
2685 (t "\\[\n%s\\]"))
2686 contents))
2688 (defun org-latex-matrices-tree-filter (tree _backend info)
2689 (org-latex--wrap-latex-matrices tree info))
2691 ;;;; Pseudo Object: LaTeX Math Block
2693 ;; `latex-math-block' objects have the following property:
2694 ;; `:post-blank'.
2696 (defun org-latex--wrap-latex-math-block (data info)
2697 "Merge contiguous math objects in a pseudo-object container.
2698 DATA is a parse tree or a secondary string. INFO is a plist
2699 containing export options. Modify DATA by side-effect and return it."
2700 (let ((valid-object-p
2701 ;; Non-nil when OBJ can be added to the latex math block B.
2702 (lambda (obj b)
2703 (pcase (org-element-type obj)
2704 (`entity (org-element-property :latex-math-p obj))
2705 (`latex-fragment
2706 (let ((value (org-element-property :value obj)))
2707 (or (string-prefix-p "\\(" value)
2708 (string-match-p "\\`\\$[^$]" value))))
2709 ((and type (or `subscript `superscript))
2710 (not (org-element-map b type #'identity info t)))))))
2711 (org-element-map data '(entity latex-fragment subscript superscript)
2712 (lambda (object)
2713 ;; Skip objects already wrapped.
2714 (when (and (not (eq (org-element-type
2715 (org-element-property :parent object))
2716 'latex-math-block))
2717 (funcall valid-object-p object nil))
2718 (let ((math-block (list 'latex-math-block nil))
2719 (next-elements (org-export-get-next-element object info t))
2720 (last object))
2721 ;; Wrap MATH-BLOCK around OBJECT in DATA.
2722 (org-element-insert-before math-block object)
2723 (org-element-extract-element object)
2724 (org-element-adopt-elements math-block object)
2725 (when (zerop (or (org-element-property :post-blank object) 0))
2726 ;; MATH-BLOCK swallows consecutive math objects.
2727 (catch 'exit
2728 (dolist (next next-elements)
2729 (unless (funcall valid-object-p next math-block)
2730 (throw 'exit nil))
2731 (org-element-extract-element next)
2732 (org-element-adopt-elements math-block next)
2733 ;; Eschew the case: \beta$x$ -> \(\betax\).
2734 (unless (memq (org-element-type next)
2735 '(subscript superscript))
2736 (org-element-put-property last :post-blank 1))
2737 (setq last next)
2738 (when (> (or (org-element-property :post-blank next) 0) 0)
2739 (throw 'exit nil)))))
2740 (org-element-put-property
2741 math-block :post-blank (org-element-property :post-blank last)))))
2742 info nil '(subscript superscript latex-math-block) t)
2743 ;; Return updated DATA.
2744 data))
2746 (defun org-latex-math-block-tree-filter (tree _backend info)
2747 (org-latex--wrap-latex-math-block tree info))
2749 (defun org-latex-math-block-options-filter (info _backend)
2750 (dolist (prop '(:author :date :title) info)
2751 (plist-put info prop
2752 (org-latex--wrap-latex-math-block (plist-get info prop) info))))
2754 (defun org-latex-math-block (_math-block contents _info)
2755 "Transcode a MATH-BLOCK object from Org to LaTeX.
2756 CONTENTS is a string. INFO is a plist used as a communication
2757 channel."
2758 (when (org-string-nw-p contents)
2759 (format "\\(%s\\)" (org-trim contents))))
2761 ;;;; Quote Block
2763 (defun org-latex-quote-block (quote-block contents info)
2764 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
2765 CONTENTS holds the contents of the block. INFO is a plist
2766 holding contextual information."
2767 (org-latex--wrap-label
2768 quote-block (format "\\begin{quote}\n%s\\end{quote}" contents) info))
2771 ;;;; Radio Target
2773 (defun org-latex-radio-target (radio-target text info)
2774 "Transcode a RADIO-TARGET object from Org to LaTeX.
2775 TEXT is the text of the target. INFO is a plist holding
2776 contextual information."
2777 (format "\\label{%s}%s" (org-export-get-reference radio-target info) text))
2780 ;;;; Section
2782 (defun org-latex-section (_section contents _info)
2783 "Transcode a SECTION element from Org to LaTeX.
2784 CONTENTS holds the contents of the section. INFO is a plist
2785 holding contextual information."
2786 contents)
2789 ;;;; Special Block
2791 (defun org-latex-special-block (special-block contents info)
2792 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
2793 CONTENTS holds the contents of the block. INFO is a plist
2794 holding contextual information."
2795 (let ((type (org-element-property :type special-block))
2796 (opt (org-export-read-attribute :attr_latex special-block :options))
2797 (caption (org-latex--caption/label-string special-block info))
2798 (caption-above-p (org-latex--caption-above-p special-block info)))
2799 (concat (format "\\begin{%s}%s\n" type (or opt ""))
2800 (and caption-above-p caption)
2801 contents
2802 (and (not caption-above-p) caption)
2803 (format "\\end{%s}" type))))
2806 ;;;; Src Block
2808 (defun org-latex-src-block (src-block _contents info)
2809 "Transcode a SRC-BLOCK element from Org to LaTeX.
2810 CONTENTS holds the contents of the item. INFO is a plist holding
2811 contextual information."
2812 (when (org-string-nw-p (org-element-property :value src-block))
2813 (let* ((lang (org-element-property :language src-block))
2814 (caption (org-element-property :caption src-block))
2815 (caption-above-p (org-latex--caption-above-p src-block info))
2816 (label (org-element-property :name src-block))
2817 (custom-env (and lang
2818 (cadr (assq (intern lang)
2819 org-latex-custom-lang-environments))))
2820 (num-start (org-export-get-loc src-block info))
2821 (retain-labels (org-element-property :retain-labels src-block))
2822 (attributes (org-export-read-attribute :attr_latex src-block))
2823 (float (plist-get attributes :float))
2824 (listings (plist-get info :latex-listings)))
2825 (cond
2826 ;; Case 1. No source fontification.
2827 ((not listings)
2828 (let* ((caption-str (org-latex--caption/label-string src-block info))
2829 (float-env
2830 (cond ((string= "multicolumn" float)
2831 (format "\\begin{figure*}[%s]\n%s%%s\n%s\\end{figure*}"
2832 (plist-get info :latex-default-figure-position)
2833 (if caption-above-p caption-str "")
2834 (if caption-above-p "" caption-str)))
2835 (caption (concat
2836 (if caption-above-p caption-str "")
2837 "%s"
2838 (if caption-above-p "" (concat "\n" caption-str))))
2839 (t "%s"))))
2840 (format
2841 float-env
2842 (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
2843 (org-export-format-code-default src-block info))))))
2844 ;; Case 2. Custom environment.
2845 (custom-env
2846 (let ((caption-str (org-latex--caption/label-string src-block info))
2847 (formatted-src (org-export-format-code-default src-block info)))
2848 (if (string-match-p "\\`[a-zA-Z0-9]+\\'" custom-env)
2849 (format "\\begin{%s}\n%s\\end{%s}\n"
2850 custom-env
2851 (concat (and caption-above-p caption-str)
2852 formatted-src
2853 (and (not caption-above-p) caption-str))
2854 custom-env)
2855 (format-spec custom-env
2856 `((?s . ,formatted-src)
2857 (?c . ,caption)
2858 (?f . ,float)
2859 (?l . ,(org-latex--label src-block info))
2860 (?o . ,(or (plist-get attributes :options) "")))))))
2861 ;; Case 3. Use minted package.
2862 ((eq listings 'minted)
2863 (let* ((caption-str (org-latex--caption/label-string src-block info))
2864 (float-env
2865 (cond
2866 ((string= "multicolumn" float)
2867 (format "\\begin{listing*}\n%s%%s\n%s\\end{listing*}"
2868 (if caption-above-p caption-str "")
2869 (if caption-above-p "" caption-str)))
2870 (caption
2871 (concat (if caption-above-p caption-str "")
2872 "%s"
2873 (if caption-above-p "" (concat "\n" caption-str))))
2874 (t "%s")))
2875 (options (plist-get info :latex-minted-options))
2876 (body
2877 (format
2878 "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2879 ;; Options.
2880 (concat
2881 (org-latex--make-option-string
2882 (if (or (not num-start) (assoc "linenos" options))
2883 options
2884 (append
2885 `(("linenos")
2886 ("firstnumber" ,(number-to-string (1+ num-start))))
2887 options)))
2888 (let ((local-options (plist-get attributes :options)))
2889 (and local-options (concat "," local-options))))
2890 ;; Language.
2891 (or (cadr (assq (intern lang)
2892 (plist-get info :latex-minted-langs)))
2893 (downcase lang))
2894 ;; Source code.
2895 (let* ((code-info (org-export-unravel-code src-block))
2896 (max-width
2897 (apply 'max
2898 (mapcar 'length
2899 (org-split-string (car code-info)
2900 "\n")))))
2901 (org-export-format-code
2902 (car code-info)
2903 (lambda (loc _num ref)
2904 (concat
2906 (when ref
2907 ;; Ensure references are flushed to the right,
2908 ;; separated with 6 spaces from the widest line
2909 ;; of code.
2910 (concat (make-string (+ (- max-width (length loc)) 6)
2911 ?\s)
2912 (format "(%s)" ref)))))
2913 nil (and retain-labels (cdr code-info)))))))
2914 ;; Return value.
2915 (format float-env body)))
2916 ;; Case 4. Use listings package.
2918 (let ((lst-lang
2919 (or (cadr (assq (intern lang)
2920 (plist-get info :latex-listings-langs)))
2921 lang))
2922 (caption-str
2923 (when caption
2924 (let ((main (org-export-get-caption src-block))
2925 (secondary (org-export-get-caption src-block t)))
2926 (if (not secondary)
2927 (format "{%s}" (org-export-data main info))
2928 (format "{[%s]%s}"
2929 (org-export-data secondary info)
2930 (org-export-data main info))))))
2931 (lst-opt (plist-get info :latex-listings-options)))
2932 (concat
2933 ;; Options.
2934 (format
2935 "\\lstset{%s}\n"
2936 (concat
2937 (org-latex--make-option-string
2938 (append
2939 lst-opt
2940 (cond
2941 ((and (not float) (plist-member attributes :float)) nil)
2942 ((string= "multicolumn" float) '(("float" "*")))
2943 ((and float (not (assoc "float" lst-opt)))
2944 `(("float" ,(plist-get info :latex-default-figure-position)))))
2945 `(("language" ,lst-lang))
2946 (if label
2947 `(("label" ,(org-latex--label src-block info)))
2948 '(("label" " ")))
2949 (if caption-str `(("caption" ,caption-str)) '(("caption" " ")))
2950 `(("captionpos" ,(if caption-above-p "t" "b")))
2951 (cond ((assoc "numbers" lst-opt) nil)
2952 ((not num-start) '(("numbers" "none")))
2953 (t `(("firstnumber" ,(number-to-string (1+ num-start)))
2954 ("numbers" "left"))))))
2955 (let ((local-options (plist-get attributes :options)))
2956 (and local-options (concat "," local-options)))))
2957 ;; Source code.
2958 (format
2959 "\\begin{lstlisting}\n%s\\end{lstlisting}"
2960 (let* ((code-info (org-export-unravel-code src-block))
2961 (max-width
2962 (apply 'max
2963 (mapcar 'length
2964 (org-split-string (car code-info) "\n")))))
2965 (org-export-format-code
2966 (car code-info)
2967 (lambda (loc _num ref)
2968 (concat
2970 (when ref
2971 ;; Ensure references are flushed to the right,
2972 ;; separated with 6 spaces from the widest line of
2973 ;; code
2974 (concat (make-string (+ (- max-width (length loc)) 6) ?\s)
2975 (format "(%s)" ref)))))
2976 nil (and retain-labels (cdr code-info))))))))))))
2979 ;;;; Statistics Cookie
2981 (defun org-latex-statistics-cookie (statistics-cookie _contents _info)
2982 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
2983 CONTENTS is nil. INFO is a plist holding contextual information."
2984 (replace-regexp-in-string
2985 "%" "\\%" (org-element-property :value statistics-cookie) nil t))
2988 ;;;; Strike-Through
2990 (defun org-latex-strike-through (_strike-through contents info)
2991 "Transcode STRIKE-THROUGH from Org to LaTeX.
2992 CONTENTS is the text with strike-through markup. INFO is a plist
2993 holding contextual information."
2994 (org-latex--text-markup contents 'strike-through info))
2997 ;;;; Subscript
2999 (defun org-latex--script-size (object info)
3000 "Transcode a subscript or superscript object.
3001 OBJECT is an Org object. INFO is a plist used as a communication
3002 channel."
3003 (let ((output ""))
3004 (org-element-map (org-element-contents object)
3005 (cons 'plain-text org-element-all-objects)
3006 (lambda (obj)
3007 (cl-case (org-element-type obj)
3008 ((entity latex-fragment)
3009 (let ((data (org-trim (org-export-data obj info))))
3010 (string-match
3011 "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
3012 data)
3013 (setq output
3014 (concat output
3015 (match-string 1 data)
3016 (let ((blank (org-element-property :post-blank obj)))
3017 (and blank (> blank 0) "\\ "))))))
3018 (plain-text
3019 (setq output
3020 (format "%s\\text{%s}" output (org-export-data obj info))))
3021 (otherwise
3022 (setq output
3023 (concat output
3024 (org-export-data obj info)
3025 (let ((blank (org-element-property :post-blank obj)))
3026 (and blank (> blank 0) "\\ ")))))))
3027 info nil org-element-recursive-objects)
3028 ;; Result. Do not wrap into curly brackets if OUTPUT is a single
3029 ;; character.
3030 (concat (if (eq (org-element-type object) 'subscript) "_" "^")
3031 (and (> (length output) 1) "{")
3032 output
3033 (and (> (length output) 1) "}"))))
3035 (defun org-latex-subscript (subscript _contents info)
3036 "Transcode a SUBSCRIPT object from Org to LaTeX.
3037 CONTENTS is the contents of the object. INFO is a plist holding
3038 contextual information."
3039 (org-latex--script-size subscript info))
3042 ;;;; Superscript
3044 (defun org-latex-superscript (superscript _contents info)
3045 "Transcode a SUPERSCRIPT object from Org to LaTeX.
3046 CONTENTS is the contents of the object. INFO is a plist holding
3047 contextual information."
3048 (org-latex--script-size superscript info))
3051 ;;;; Table
3053 ;; `org-latex-table' is the entry point for table transcoding. It
3054 ;; takes care of tables with a "verbatim" mode. Otherwise, it
3055 ;; delegates the job to either `org-latex--table.el-table',
3056 ;; `org-latex--org-table' or `org-latex--math-table' functions,
3057 ;; depending of the type of the table and the mode requested.
3059 ;; `org-latex--align-string' is a subroutine used to build alignment
3060 ;; string for Org tables.
3062 (defun org-latex-table (table contents info)
3063 "Transcode a TABLE element from Org to LaTeX.
3064 CONTENTS is the contents of the table. INFO is a plist holding
3065 contextual information."
3066 (if (eq (org-element-property :type table) 'table.el)
3067 ;; "table.el" table. Convert it using appropriate tools.
3068 (org-latex--table.el-table table info)
3069 (let ((type (or (org-export-read-attribute :attr_latex table :mode)
3070 (plist-get info :latex-default-table-mode))))
3071 (cond
3072 ;; Case 1: Verbatim table.
3073 ((string= type "verbatim")
3074 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
3075 ;; Re-create table, without affiliated keywords.
3076 (org-trim (org-element-interpret-data
3077 `(table nil ,@(org-element-contents table))))))
3078 ;; Case 2: Matrix.
3079 ((or (string= type "math") (string= type "inline-math"))
3080 (org-latex--math-table table info))
3081 ;; Case 3: Standard table.
3082 (t (concat (org-latex--org-table table contents info)
3083 ;; When there are footnote references within the
3084 ;; table, insert their definition just after it.
3085 (org-latex--delayed-footnotes-definitions table info)))))))
3087 (defun org-latex--align-string (table info)
3088 "Return an appropriate LaTeX alignment string.
3089 TABLE is the considered table. INFO is a plist used as
3090 a communication channel."
3091 (or (org-export-read-attribute :attr_latex table :align)
3092 (let (align)
3093 ;; Extract column groups and alignment from first (non-rule)
3094 ;; row.
3095 (org-element-map
3096 (org-element-map table 'table-row
3097 (lambda (row)
3098 (and (eq (org-element-property :type row) 'standard) row))
3099 info 'first-match)
3100 'table-cell
3101 (lambda (cell)
3102 (let ((borders (org-export-table-cell-borders cell info)))
3103 ;; Check left border for the first cell only.
3104 (when (and (memq 'left borders) (not align))
3105 (push "|" align))
3106 (push (cl-case (org-export-table-cell-alignment cell info)
3107 (left "l")
3108 (right "r")
3109 (center "c"))
3110 align)
3111 (when (memq 'right borders) (push "|" align))))
3112 info)
3113 (apply 'concat (nreverse align)))))
3115 (defun org-latex--org-table (table contents info)
3116 "Return appropriate LaTeX code for an Org table.
3118 TABLE is the table type element to transcode. CONTENTS is its
3119 contents, as a string. INFO is a plist used as a communication
3120 channel.
3122 This function assumes TABLE has `org' as its `:type' property and
3123 `table' as its `:mode' attribute."
3124 (let* ((caption (org-latex--caption/label-string table info))
3125 (attr (org-export-read-attribute :attr_latex table))
3126 ;; Determine alignment string.
3127 (alignment (org-latex--align-string table info))
3128 ;; Determine environment for the table: longtable, tabular...
3129 (table-env (or (plist-get attr :environment)
3130 (plist-get info :latex-default-table-environment)))
3131 ;; If table is a float, determine environment: table, table*
3132 ;; or sidewaystable.
3133 (float-env (unless (member table-env '("longtable" "longtabu"))
3134 (let ((float (plist-get attr :float)))
3135 (cond
3136 ((and (not float) (plist-member attr :float)) nil)
3137 ((or (string= float "sidewaystable")
3138 (string= float "sideways")) "sidewaystable")
3139 ((string= float "multicolumn") "table*")
3140 ((or float
3141 (org-element-property :caption table)
3142 (org-string-nw-p (plist-get attr :caption)))
3143 "table")))))
3144 ;; Extract others display options.
3145 (fontsize (let ((font (plist-get attr :font)))
3146 (and font (concat font "\n"))))
3147 ;; "tabular" environment doesn't allow to define a width.
3148 (width (and (not (equal table-env "tabular")) (plist-get attr :width)))
3149 (spreadp (plist-get attr :spread))
3150 (placement
3151 (or (plist-get attr :placement)
3152 (format "[%s]" (plist-get info :latex-default-figure-position))))
3153 (centerp (if (plist-member attr :center) (plist-get attr :center)
3154 (plist-get info :latex-tables-centered)))
3155 (caption-above-p (org-latex--caption-above-p table info)))
3156 ;; Prepare the final format string for the table.
3157 (cond
3158 ;; Longtable.
3159 ((equal "longtable" table-env)
3160 (concat (and fontsize (concat "{" fontsize))
3161 (format "\\begin{longtable}{%s}\n" alignment)
3162 (and caption-above-p
3163 (org-string-nw-p caption)
3164 (concat caption "\\\\\n"))
3165 contents
3166 (and (not caption-above-p)
3167 (org-string-nw-p caption)
3168 (concat caption "\\\\\n"))
3169 "\\end{longtable}\n"
3170 (and fontsize "}")))
3171 ;; Longtabu
3172 ((equal "longtabu" table-env)
3173 (concat (and fontsize (concat "{" fontsize))
3174 (format "\\begin{longtabu}%s{%s}\n"
3175 (if width
3176 (format " %s %s "
3177 (if spreadp "spread" "to") width) "")
3178 alignment)
3179 (and caption-above-p
3180 (org-string-nw-p caption)
3181 (concat caption "\\\\\n"))
3182 contents
3183 (and (not caption-above-p)
3184 (org-string-nw-p caption)
3185 (concat caption "\\\\\n"))
3186 "\\end{longtabu}\n"
3187 (and fontsize "}")))
3188 ;; Others.
3189 (t (concat (cond
3190 (float-env
3191 (concat (format "\\begin{%s}%s\n" float-env placement)
3192 (if caption-above-p caption "")
3193 (when centerp "\\centering\n")
3194 fontsize))
3195 ((and (not float-env) caption)
3196 (concat
3197 (and centerp "\\begin{center}\n" )
3198 (if caption-above-p caption "")
3199 (cond ((and fontsize centerp) fontsize)
3200 (fontsize (concat "{" fontsize)))))
3201 (centerp (concat "\\begin{center}\n" fontsize))
3202 (fontsize (concat "{" fontsize)))
3203 (cond ((equal "tabu" table-env)
3204 (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
3205 (if width (format
3206 (if spreadp " spread %s " " to %s ")
3207 width) "")
3208 alignment
3209 contents))
3210 (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
3211 table-env
3212 (if width (format "{%s}" width) "")
3213 alignment
3214 contents
3215 table-env)))
3216 (cond
3217 (float-env
3218 (concat (if caption-above-p "" (concat "\n" caption))
3219 (format "\n\\end{%s}" float-env)))
3220 ((and (not float-env) caption)
3221 (concat
3222 (if caption-above-p "" (concat "\n" caption))
3223 (and centerp "\n\\end{center}")
3224 (and fontsize (not centerp) "}")))
3225 (centerp "\n\\end{center}")
3226 (fontsize "}")))))))
3228 (defun org-latex--table.el-table (table info)
3229 "Return appropriate LaTeX code for a table.el table.
3231 TABLE is the table type element to transcode. INFO is a plist
3232 used as a communication channel.
3234 This function assumes TABLE has `table.el' as its `:type'
3235 property."
3236 (require 'table)
3237 ;; Ensure "*org-export-table*" buffer is empty.
3238 (with-current-buffer (get-buffer-create "*org-export-table*")
3239 (erase-buffer))
3240 (let ((output (with-temp-buffer
3241 (insert (org-element-property :value table))
3242 (goto-char 1)
3243 (re-search-forward "^[ \t]*|[^|]" nil t)
3244 (table-generate-source 'latex "*org-export-table*")
3245 (with-current-buffer "*org-export-table*"
3246 (org-trim (buffer-string))))))
3247 (kill-buffer (get-buffer "*org-export-table*"))
3248 ;; Remove left out comments.
3249 (while (string-match "^%.*\n" output)
3250 (setq output (replace-match "" t t output)))
3251 (let ((attr (org-export-read-attribute :attr_latex table)))
3252 (when (plist-get attr :rmlines)
3253 ;; When the "rmlines" attribute is provided, remove all hlines
3254 ;; but the the one separating heading from the table body.
3255 (let ((n 0) (pos 0))
3256 (while (and (< (length output) pos)
3257 (setq pos (string-match "^\\\\hline\n?" output pos)))
3258 (cl-incf n)
3259 (unless (= n 2) (setq output (replace-match "" nil nil output))))))
3260 (let ((centerp (if (plist-member attr :center) (plist-get attr :center)
3261 (plist-get info :latex-tables-centered))))
3262 (if (not centerp) output
3263 (format "\\begin{center}\n%s\n\\end{center}" output))))))
3265 (defun org-latex--math-table (table info)
3266 "Return appropriate LaTeX code for a matrix.
3268 TABLE is the table type element to transcode. INFO is a plist
3269 used as a communication channel.
3271 This function assumes TABLE has `org' as its `:type' property and
3272 `inline-math' or `math' as its `:mode' attribute."
3273 (let* ((attr (org-export-read-attribute :attr_latex table))
3274 (env (or (plist-get attr :environment)
3275 (plist-get info :latex-default-table-environment)))
3276 (contents
3277 (mapconcat
3278 (lambda (row)
3279 (if (eq (org-element-property :type row) 'rule) "\\hline"
3280 ;; Return each cell unmodified.
3281 (concat
3282 (mapconcat
3283 (lambda (cell)
3284 (substring (org-element-interpret-data cell) 0 -1))
3285 (org-element-map row 'table-cell #'identity info) "&")
3286 (or (cdr (assoc env org-latex-table-matrix-macros)) "\\\\")
3287 "\n")))
3288 (org-element-map table 'table-row #'identity info) "")))
3289 (concat
3290 ;; Prefix.
3291 (plist-get attr :math-prefix)
3292 ;; Environment. Also treat special cases.
3293 (cond ((member env '("array" "tabular"))
3294 ;; Make sure cells are always centered while preserving
3295 ;; vertical separators.
3296 (let ((align (replace-regexp-in-string
3297 "[lr]" "c" (org-latex--align-string table info))))
3298 (format "\\begin{%s}{%s}\n%s\\end{%s}" env align contents env)))
3299 ((assoc env org-latex-table-matrix-macros)
3300 (format "\\%s%s{\n%s}"
3302 (or (plist-get attr :math-arguments) "")
3303 contents))
3304 (t (format "\\begin{%s}\n%s\\end{%s}" env contents env)))
3305 ;; Suffix.
3306 (plist-get attr :math-suffix))))
3309 ;;;; Table Cell
3311 (defun org-latex-table-cell (table-cell contents info)
3312 "Transcode a TABLE-CELL element from Org to LaTeX.
3313 CONTENTS is the cell contents. INFO is a plist used as
3314 a communication channel."
3315 (concat
3316 (let ((scientific-format (plist-get info :latex-table-scientific-notation)))
3317 (if (and contents
3318 scientific-format
3319 (string-match orgtbl-exp-regexp contents))
3320 ;; Use appropriate format string for scientific
3321 ;; notation.
3322 (format scientific-format
3323 (match-string 1 contents)
3324 (match-string 2 contents))
3325 contents))
3326 (when (org-export-get-next-element table-cell info) " & ")))
3329 ;;;; Table Row
3331 (defun org-latex-table-row (table-row contents info)
3332 "Transcode a TABLE-ROW element from Org to LaTeX.
3333 CONTENTS is the contents of the row. INFO is a plist used as
3334 a communication channel."
3335 (let* ((attr (org-export-read-attribute :attr_latex
3336 (org-export-get-parent table-row)))
3337 (booktabsp (if (plist-member attr :booktabs) (plist-get attr :booktabs)
3338 (plist-get info :latex-tables-booktabs)))
3339 (longtablep
3340 (member (or (plist-get attr :environment)
3341 (plist-get info :latex-default-table-environment))
3342 '("longtable" "longtabu"))))
3343 (if (eq (org-element-property :type table-row) 'rule)
3344 (cond
3345 ((not booktabsp) "\\hline")
3346 ((not (org-export-get-previous-element table-row info)) "\\toprule")
3347 ((not (org-export-get-next-element table-row info)) "\\bottomrule")
3348 ((and longtablep
3349 (org-export-table-row-ends-header-p
3350 (org-export-get-previous-element table-row info) info))
3352 (t "\\midrule"))
3353 (concat
3354 ;; When BOOKTABS are activated enforce top-rule even when no
3355 ;; hline was specifically marked.
3356 (and booktabsp (not (org-export-get-previous-element table-row info))
3357 "\\toprule\n")
3358 contents "\\\\\n"
3359 (cond
3360 ;; Special case for long tables. Define header and footers.
3361 ((and longtablep (org-export-table-row-ends-header-p table-row info))
3362 (let ((columns (cdr (org-export-table-dimensions
3363 (org-export-get-parent-table table-row) info))))
3364 (format "%s
3365 \\endfirsthead
3366 \\multicolumn{%d}{l}{%s} \\\\
3368 %s \\\\\n
3370 \\endhead
3371 %s\\multicolumn{%d}{r}{%s} \\\\
3372 \\endfoot
3373 \\endlastfoot"
3374 (if booktabsp "\\midrule" "\\hline")
3375 columns
3376 (org-latex--translate "Continued from previous page" info)
3377 (cond
3378 ((not (org-export-table-row-starts-header-p table-row info))
3380 (booktabsp "\\toprule\n")
3381 (t "\\hline\n"))
3382 contents
3383 (if booktabsp "\\midrule" "\\hline")
3384 (if booktabsp "\\midrule" "\\hline")
3385 columns
3386 (org-latex--translate "Continued on next page" info))))
3387 ;; When BOOKTABS are activated enforce bottom rule even when
3388 ;; no hline was specifically marked.
3389 ((and booktabsp (not (org-export-get-next-element table-row info)))
3390 "\\bottomrule"))))))
3393 ;;;; Target
3395 (defun org-latex-target (target _contents info)
3396 "Transcode a TARGET object from Org to LaTeX.
3397 CONTENTS is nil. INFO is a plist holding contextual
3398 information."
3399 (format "\\label{%s}" (org-latex--label target info)))
3402 ;;;; Timestamp
3404 (defun org-latex-timestamp (timestamp _contents info)
3405 "Transcode a TIMESTAMP object from Org to LaTeX.
3406 CONTENTS is nil. INFO is a plist holding contextual
3407 information."
3408 (let ((value (org-latex-plain-text (org-timestamp-translate timestamp) info)))
3409 (format
3410 (plist-get info
3411 (cl-case (org-element-property :type timestamp)
3412 ((active active-range) :latex-active-timestamp-format)
3413 ((inactive inactive-range) :latex-inactive-timestamp-format)
3414 (otherwise :latex-diary-timestamp-format)))
3415 value)))
3418 ;;;; Underline
3420 (defun org-latex-underline (_underline contents info)
3421 "Transcode UNDERLINE from Org to LaTeX.
3422 CONTENTS is the text with underline markup. INFO is a plist
3423 holding contextual information."
3424 (org-latex--text-markup contents 'underline info))
3427 ;;;; Verbatim
3429 (defun org-latex-verbatim (verbatim _contents info)
3430 "Transcode a VERBATIM object from Org to LaTeX.
3431 CONTENTS is nil. INFO is a plist used as a communication
3432 channel."
3433 (org-latex--text-markup
3434 (org-element-property :value verbatim) 'verbatim info))
3437 ;;;; Verse Block
3439 (defun org-latex-verse-block (verse-block contents info)
3440 "Transcode a VERSE-BLOCK element from Org to LaTeX.
3441 CONTENTS is verse block contents. INFO is a plist holding
3442 contextual information."
3443 (org-latex--wrap-label
3444 verse-block
3445 ;; In a verse environment, add a line break to each newline
3446 ;; character and change each white space at beginning of a line
3447 ;; into a space of 1 em. Also change each blank line with
3448 ;; a vertical space of 1 em.
3449 (format "\\begin{verse}\n%s\\end{verse}"
3450 (replace-regexp-in-string
3451 "^[ \t]+" (lambda (m) (format "\\hspace*{%dem}" (length m)))
3452 (replace-regexp-in-string
3453 "^[ \t]*\\\\\\\\$" "\\vspace*{1em}"
3454 (replace-regexp-in-string
3455 "\\([ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n"
3456 contents nil t) nil t) nil t))
3457 info))
3461 ;;; End-user functions
3463 ;;;###autoload
3464 (defun org-latex-export-as-latex
3465 (&optional async subtreep visible-only body-only ext-plist)
3466 "Export current buffer as a LaTeX buffer.
3468 If narrowing is active in the current buffer, only export its
3469 narrowed part.
3471 If a region is active, export that region.
3473 A non-nil optional argument ASYNC means the process should happen
3474 asynchronously. The resulting buffer should be accessible
3475 through the `org-export-stack' interface.
3477 When optional argument SUBTREEP is non-nil, export the sub-tree
3478 at point, extracting information from the headline properties
3479 first.
3481 When optional argument VISIBLE-ONLY is non-nil, don't export
3482 contents of hidden elements.
3484 When optional argument BODY-ONLY is non-nil, only write code
3485 between \"\\begin{document}\" and \"\\end{document}\".
3487 EXT-PLIST, when provided, is a property list with external
3488 parameters overriding Org default settings, but still inferior to
3489 file-local settings.
3491 Export is done in a buffer named \"*Org LATEX Export*\", which
3492 will be displayed when `org-export-show-temporary-export-buffer'
3493 is non-nil."
3494 (interactive)
3495 (org-export-to-buffer 'latex "*Org LATEX Export*"
3496 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
3498 ;;;###autoload
3499 (defun org-latex-convert-region-to-latex ()
3500 "Assume the current region has Org syntax, and convert it to LaTeX.
3501 This can be used in any buffer. For example, you can write an
3502 itemized list in Org syntax in an LaTeX buffer and use this
3503 command to convert it."
3504 (interactive)
3505 (org-export-replace-region-by 'latex))
3507 ;;;###autoload
3508 (defun org-latex-export-to-latex
3509 (&optional async subtreep visible-only body-only ext-plist)
3510 "Export current buffer to a LaTeX file.
3512 If narrowing is active in the current buffer, only export its
3513 narrowed part.
3515 If a region is active, export that region.
3517 A non-nil optional argument ASYNC means the process should happen
3518 asynchronously. The resulting file should be accessible through
3519 the `org-export-stack' interface.
3521 When optional argument SUBTREEP is non-nil, export the sub-tree
3522 at point, extracting information from the headline properties
3523 first.
3525 When optional argument VISIBLE-ONLY is non-nil, don't export
3526 contents of hidden elements.
3528 When optional argument BODY-ONLY is non-nil, only write code
3529 between \"\\begin{document}\" and \"\\end{document}\".
3531 EXT-PLIST, when provided, is a property list with external
3532 parameters overriding Org default settings, but still inferior to
3533 file-local settings."
3534 (interactive)
3535 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
3536 (org-export-to-file 'latex outfile
3537 async subtreep visible-only body-only ext-plist)))
3539 ;;;###autoload
3540 (defun org-latex-export-to-pdf
3541 (&optional async subtreep visible-only body-only ext-plist)
3542 "Export current buffer to LaTeX then process through to PDF.
3544 If narrowing is active in the current buffer, only export its
3545 narrowed part.
3547 If a region is active, export that region.
3549 A non-nil optional argument ASYNC means the process should happen
3550 asynchronously. The resulting file should be accessible through
3551 the `org-export-stack' interface.
3553 When optional argument SUBTREEP is non-nil, export the sub-tree
3554 at point, extracting information from the headline properties
3555 first.
3557 When optional argument VISIBLE-ONLY is non-nil, don't export
3558 contents of hidden elements.
3560 When optional argument BODY-ONLY is non-nil, only write code
3561 between \"\\begin{document}\" and \"\\end{document}\".
3563 EXT-PLIST, when provided, is a property list with external
3564 parameters overriding Org default settings, but still inferior to
3565 file-local settings.
3567 Return PDF file's name."
3568 (interactive)
3569 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
3570 (org-export-to-file 'latex outfile
3571 async subtreep visible-only body-only ext-plist
3572 (lambda (file) (org-latex-compile file)))))
3574 (defun org-latex-compile (texfile &optional snippet)
3575 "Compile a TeX file.
3577 TEXFILE is the name of the file being compiled. Processing is
3578 done through the command specified in `org-latex-pdf-process',
3579 which see. Output is redirected to \"*Org PDF LaTeX Output*\"
3580 buffer.
3582 When optional argument SNIPPET is non-nil, TEXFILE is a temporary
3583 file used to preview a LaTeX snippet. In this case, do not
3584 create a log buffer and do not remove log files.
3586 Return PDF file name or raise an error if it couldn't be
3587 produced."
3588 (unless snippet (message "Processing LaTeX file %s..." texfile))
3589 (let* ((compiler
3590 (or (with-temp-buffer
3591 (save-excursion (insert-file-contents texfile))
3592 (and (search-forward-regexp (regexp-opt org-latex-compilers)
3593 (line-end-position 2)
3595 (progn (beginning-of-line) (looking-at-p "%"))
3596 (match-string 0)))
3597 "pdflatex"))
3598 (process (if (functionp org-latex-pdf-process) org-latex-pdf-process
3599 ;; Replace "%latex" and "%bibtex" with,
3600 ;; respectively, "%L" and "%B" so as to adhere to
3601 ;; `format-spec' specifications.
3602 (mapcar (lambda (command)
3603 (replace-regexp-in-string
3604 "%\\(?:bib\\|la\\)tex\\>"
3605 (lambda (m) (upcase (substring m 0 2)))
3606 command))
3607 org-latex-pdf-process)))
3608 (spec `((?B . ,(shell-quote-argument org-latex-bib-compiler))
3609 (?L . ,(shell-quote-argument compiler))))
3610 (log-buf-name "*Org PDF LaTeX Output*")
3611 (log-buf (and (not snippet) (get-buffer-create log-buf-name)))
3612 (outfile (org-compile-file texfile process "pdf"
3613 (format "See %S for details" log-buf-name)
3614 log-buf spec)))
3615 (unless snippet
3616 (when org-latex-remove-logfiles
3617 (mapc #'delete-file
3618 (directory-files
3619 (file-name-directory outfile)
3621 (concat (regexp-quote (file-name-base outfile))
3622 "\\(?:\\.[0-9]+\\)?\\."
3623 (regexp-opt org-latex-logfiles-extensions))
3624 t)))
3625 (let ((warnings (org-latex--collect-warnings log-buf)))
3626 (message (concat "PDF file produced"
3627 (cond
3628 ((eq warnings 'error) " with errors.")
3629 (warnings (concat " with warnings: " warnings))
3630 (t "."))))))
3631 ;; Return output file name.
3632 outfile))
3634 (defun org-latex--collect-warnings (buffer)
3635 "Collect some warnings from \"pdflatex\" command output.
3636 BUFFER is the buffer containing output. Return collected
3637 warnings types as a string, `error' if a LaTeX error was
3638 encountered or nil if there was none."
3639 (with-current-buffer buffer
3640 (save-excursion
3641 (goto-char (point-max))
3642 (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t)
3643 (if (re-search-forward "^!" nil t) 'error
3644 (let ((case-fold-search t)
3645 (warnings ""))
3646 (dolist (warning org-latex-known-warnings)
3647 (when (save-excursion (re-search-forward (car warning) nil t))
3648 (setq warnings (concat warnings " " (cdr warning)))))
3649 (org-string-nw-p (org-trim warnings))))))))
3651 ;;;###autoload
3652 (defun org-latex-publish-to-latex (plist filename pub-dir)
3653 "Publish an Org file to LaTeX.
3655 FILENAME is the filename of the Org file to be published. PLIST
3656 is the property list for the given project. PUB-DIR is the
3657 publishing directory.
3659 Return output file name."
3660 (org-publish-org-to 'latex filename ".tex" plist pub-dir))
3662 ;;;###autoload
3663 (defun org-latex-publish-to-pdf (plist filename pub-dir)
3664 "Publish an Org file to PDF (via LaTeX).
3666 FILENAME is the filename of the Org file to be published. PLIST
3667 is the property list for the given project. PUB-DIR is the
3668 publishing directory.
3670 Return output file name."
3671 ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
3672 ;; in working directory and then moved to publishing directory.
3673 (org-publish-attachment
3674 plist
3675 (org-latex-compile
3676 (org-publish-org-to
3677 'latex filename ".tex" plist (file-name-directory filename)))
3678 pub-dir))
3681 (provide 'ox-latex)
3683 ;; Local variables:
3684 ;; generated-autoload-file: "org-loaddefs.el"
3685 ;; End:
3687 ;;; ox-latex.el ends here