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