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