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