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