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