Fix 464cd96
[org-mode.git] / lisp / ox-latex.el
blobee48d1936d98fe1a49b6ab1fef3c9fc71c72f093
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 (node-property . org-latex-node-property)
69 (paragraph . org-latex-paragraph)
70 (plain-list . org-latex-plain-list)
71 (plain-text . org-latex-plain-text)
72 (planning . org-latex-planning)
73 (property-drawer . org-latex-property-drawer)
74 (quote-block . org-latex-quote-block)
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 ;; Pseudo objects.
93 (latex-math-block . org-latex-math-block))
94 :export-block '("LATEX" "TEX")
95 :menu-entry
96 '(?l "Export to LaTeX"
97 ((?L "As LaTeX buffer" org-latex-export-as-latex)
98 (?l "As LaTeX file" org-latex-export-to-latex)
99 (?p "As PDF file" org-latex-export-to-pdf)
100 (?o "As PDF file and open"
101 (lambda (a s v b)
102 (if a (org-latex-export-to-pdf t s v b)
103 (org-open-file (org-latex-export-to-pdf nil s v b)))))))
104 :filters-alist '((:filter-options . org-latex-math-block-options-filter)
105 (:filter-parse-tree . org-latex-math-block-tree-filter))
106 :options-alist
107 '((:latex-class "LATEX_CLASS" nil org-latex-default-class t)
108 (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t)
109 (:latex-header "LATEX_HEADER" nil nil newline)
110 (:latex-header-extra "LATEX_HEADER_EXTRA" nil nil newline)
111 ;; Other variables.
112 (:latex-active-timestamp-format nil nil org-latex-active-timestamp-format)
113 (:latex-classes nil nil org-latex-classes)
114 (:latex-custom-id-labels nil nil org-latex-custom-id-as-label)
115 (:latex-default-figure-position nil nil org-latex-default-figure-position)
116 (:latex-default-table-environment nil nil org-latex-default-table-environment)
117 (:latex-default-table-mode nil nil org-latex-default-table-mode)
118 (:latex-diary-timestamp-format nil nil org-latex-diary-timestamp-format)
119 (:latex-footnote-separator nil nil org-latex-footnote-separator)
120 (:latex-format-drawer-function nil nil org-latex-format-drawer-function)
121 (:latex-format-headline-function nil nil org-latex-format-headline-function)
122 (:latex-format-inlinetask-function nil nil org-latex-format-inlinetask-function)
123 (:latex-hyperref-template nil nil org-latex-hyperref-template t)
124 (:latex-image-default-height nil nil org-latex-image-default-height)
125 (:latex-image-default-option nil nil org-latex-image-default-option)
126 (:latex-image-default-width nil nil org-latex-image-default-width)
127 (:latex-inactive-timestamp-format nil nil org-latex-inactive-timestamp-format)
128 (:latex-inline-image-rules nil nil org-latex-inline-image-rules)
129 (:latex-link-with-unknown-path-format nil nil org-latex-link-with-unknown-path-format)
130 (:latex-listings nil nil org-latex-listings)
131 (:latex-listings-langs nil nil org-latex-listings-langs)
132 (:latex-listings-options nil nil org-latex-listings-options)
133 (:latex-minted-langs nil nil org-latex-minted-langs)
134 (:latex-minted-options nil nil org-latex-minted-options)
135 (:latex-table-caption-above nil nil org-latex-table-caption-above)
136 (:latex-table-scientific-notation nil nil org-latex-table-scientific-notation)
137 (:latex-tables-booktabs nil nil org-latex-tables-booktabs)
138 (:latex-tables-centered nil nil org-latex-tables-centered)
139 (:latex-text-markup-alist nil nil org-latex-text-markup-alist)
140 (:latex-title-command nil nil org-latex-title-command)
141 (:latex-toc-command nil nil org-latex-toc-command)
142 ;; Redefine regular options.
143 (:date "DATE" nil "\\today" t)))
147 ;;; Internal Variables
149 (defconst org-latex-babel-language-alist
150 '(("af" . "afrikaans")
151 ("bg" . "bulgarian")
152 ("bt-br" . "brazilian")
153 ("ca" . "catalan")
154 ("cs" . "czech")
155 ("cy" . "welsh")
156 ("da" . "danish")
157 ("de" . "germanb")
158 ("de-at" . "naustrian")
159 ("de-de" . "ngerman")
160 ("el" . "greek")
161 ("en" . "english")
162 ("en-au" . "australian")
163 ("en-ca" . "canadian")
164 ("en-gb" . "british")
165 ("en-ie" . "irish")
166 ("en-nz" . "newzealand")
167 ("en-us" . "american")
168 ("es" . "spanish")
169 ("et" . "estonian")
170 ("eu" . "basque")
171 ("fi" . "finnish")
172 ("fr" . "frenchb")
173 ("fr-ca" . "canadien")
174 ("gl" . "galician")
175 ("hr" . "croatian")
176 ("hu" . "hungarian")
177 ("id" . "indonesian")
178 ("is" . "icelandic")
179 ("it" . "italian")
180 ("la" . "latin")
181 ("ms" . "malay")
182 ("nl" . "dutch")
183 ("nb" . "norsk")
184 ("nn" . "nynorsk")
185 ("no" . "norsk")
186 ("pl" . "polish")
187 ("pt" . "portuguese")
188 ("ro" . "romanian")
189 ("ru" . "russian")
190 ("sa" . "sanskrit")
191 ("sb" . "uppersorbian")
192 ("sk" . "slovak")
193 ("sl" . "slovene")
194 ("sq" . "albanian")
195 ("sr" . "serbian")
196 ("sv" . "swedish")
197 ("ta" . "tamil")
198 ("tr" . "turkish")
199 ("uk" . "ukrainian"))
200 "Alist between language code and corresponding Babel option.")
202 (defconst org-latex-table-matrix-macros '(("bordermatrix" . "\\cr")
203 ("qbordermatrix" . "\\cr")
204 ("kbordermatrix" . "\\\\"))
205 "Alist between matrix macros and their row ending.")
207 (defconst org-latex-pseudo-objects '(latex-math-block)
208 "List of pseudo-object types introduced in the back-end.")
212 ;;; User Configurable Variables
214 (defgroup org-export-latex nil
215 "Options for exporting Org mode files to LaTeX."
216 :tag "Org Export LaTeX"
217 :group 'org-export)
220 ;;;; Preamble
222 (defcustom org-latex-default-class "article"
223 "The default LaTeX class."
224 :group 'org-export-latex
225 :type '(string :tag "LaTeX class"))
227 (defcustom org-latex-classes
228 '(("article"
229 "\\documentclass[11pt]{article}"
230 ("\\section{%s}" . "\\section*{%s}")
231 ("\\subsection{%s}" . "\\subsection*{%s}")
232 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
233 ("\\paragraph{%s}" . "\\paragraph*{%s}")
234 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
235 ("report"
236 "\\documentclass[11pt]{report}"
237 ("\\part{%s}" . "\\part*{%s}")
238 ("\\chapter{%s}" . "\\chapter*{%s}")
239 ("\\section{%s}" . "\\section*{%s}")
240 ("\\subsection{%s}" . "\\subsection*{%s}")
241 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
242 ("book"
243 "\\documentclass[11pt]{book}"
244 ("\\part{%s}" . "\\part*{%s}")
245 ("\\chapter{%s}" . "\\chapter*{%s}")
246 ("\\section{%s}" . "\\section*{%s}")
247 ("\\subsection{%s}" . "\\subsection*{%s}")
248 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
249 "Alist of LaTeX classes and associated header and structure.
250 If #+LATEX_CLASS is set in the buffer, use its value and the
251 associated information. Here is the structure of each cell:
253 \(class-name
254 header-string
255 \(numbered-section . unnumbered-section)
256 ...)
258 The header string
259 -----------------
261 The HEADER-STRING is the header that will be inserted into the
262 LaTeX file. It should contain the \\documentclass macro, and
263 anything else that is needed for this setup. To this header, the
264 following commands will be added:
266 - Calls to \\usepackage for all packages mentioned in the
267 variables `org-latex-default-packages-alist' and
268 `org-latex-packages-alist'. Thus, your header definitions
269 should avoid to also request these packages.
271 - Lines specified via \"#+LATEX_HEADER:\" and
272 \"#+LATEX_HEADER_EXTRA:\" keywords.
274 If you need more control about the sequence in which the header
275 is built up, or if you want to exclude one of these building
276 blocks for a particular class, you can use the following
277 macro-like placeholders.
279 [DEFAULT-PACKAGES] \\usepackage statements for default packages
280 [NO-DEFAULT-PACKAGES] do not include any of the default packages
281 [PACKAGES] \\usepackage statements for packages
282 [NO-PACKAGES] do not include the packages
283 [EXTRA] the stuff from #+LATEX_HEADER(_EXTRA)
284 [NO-EXTRA] do not include #+LATEX_HEADER(_EXTRA) stuff
286 So a header like
288 \\documentclass{article}
289 [NO-DEFAULT-PACKAGES]
290 [EXTRA]
291 \\providecommand{\\alert}[1]{\\textbf{#1}}
292 [PACKAGES]
294 will omit the default packages, and will include the
295 #+LATEX_HEADER and #+LATEX_HEADER_EXTRA lines, then have a call
296 to \\providecommand, and then place \\usepackage commands based
297 on the content of `org-latex-packages-alist'.
299 If your header, `org-latex-default-packages-alist' or
300 `org-latex-packages-alist' inserts \"\\usepackage[AUTO]{inputenc}\",
301 AUTO will automatically be replaced with a coding system derived
302 from `buffer-file-coding-system'. See also the variable
303 `org-latex-inputenc-alist' for a way to influence this mechanism.
305 Likewise, if your header contains \"\\usepackage[AUTO]{babel}\",
306 AUTO will be replaced with the language related to the language
307 code specified by `org-export-default-language', which see. Note
308 that constructions such as \"\\usepackage[french,AUTO,english]{babel}\"
309 are permitted.
311 The sectioning structure
312 ------------------------
314 The sectioning structure of the class is given by the elements
315 following the header string. For each sectioning level, a number
316 of strings is specified. A %s formatter is mandatory in each
317 section string and will be replaced by the title of the section.
319 Instead of a cons cell (numbered . unnumbered), you can also
320 provide a list of 2 or 4 elements,
322 \(numbered-open numbered-close)
326 \(numbered-open numbered-close unnumbered-open unnumbered-close)
328 providing opening and closing strings for a LaTeX environment
329 that should represent the document section. The opening clause
330 should have a %s to represent the section title.
332 Instead of a list of sectioning commands, you can also specify
333 a function name. That function will be called with two
334 parameters, the (reduced) level of the headline, and a predicate
335 non-nil when the headline should be numbered. It must return
336 a format string in which the section title will be added."
337 :group 'org-export-latex
338 :type '(repeat
339 (list (string :tag "LaTeX class")
340 (string :tag "LaTeX header")
341 (repeat :tag "Levels" :inline t
342 (choice
343 (cons :tag "Heading"
344 (string :tag " numbered")
345 (string :tag "unnumbered"))
346 (list :tag "Environment"
347 (string :tag "Opening (numbered)")
348 (string :tag "Closing (numbered)")
349 (string :tag "Opening (unnumbered)")
350 (string :tag "Closing (unnumbered)"))
351 (function :tag "Hook computing sectioning"))))))
353 (defcustom org-latex-inputenc-alist nil
354 "Alist of inputenc coding system names, and what should really be used.
355 For example, adding an entry
357 (\"utf8\" . \"utf8x\")
359 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
360 are written as utf8 files."
361 :group 'org-export-latex
362 :type '(repeat
363 (cons
364 (string :tag "Derived from buffer")
365 (string :tag "Use this instead"))))
367 (defcustom org-latex-title-command "\\maketitle"
368 "The command used to insert the title just after \\begin{document}.
369 If this string contains the formatting specification \"%s\" then
370 it will be used as a formatting string, passing the title as an
371 argument."
372 :group 'org-export-latex
373 :type 'string)
375 (defcustom org-latex-toc-command "\\tableofcontents\n\n"
376 "LaTeX command to set the table of contents, list of figures, etc.
377 This command only applies to the table of contents generated with
378 the toc:nil option, not to those generated with #+TOC keyword."
379 :group 'org-export-latex
380 :type 'string)
382 (defcustom org-latex-hyperref-template
383 "\\hypersetup{\n pdfkeywords={%k},\n pdfsubject={%d},\n pdfcreator={%c}}\n"
384 "Template for hyperref package options.
386 Value is a format string, which can contain the following placeholders:
388 %k for KEYWORDS line
389 %d for DESCRIPTION line
390 %c for CREATOR line
392 Set it to the empty string to ignore the command completely."
393 :group 'org-export-latex
394 :version "24.5"
395 :package-version '(Org . "8.3")
396 :type 'string)
398 ;;;; Headline
400 (defcustom org-latex-format-headline-function
401 'org-latex-format-headline-default-function
402 "Function for formatting the headline's text.
404 This function will be called with six arguments:
405 TODO the todo keyword (string or nil)
406 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
407 PRIORITY the priority of the headline (integer or nil)
408 TEXT the main headline text (string)
409 TAGS the tags (list of strings or nil)
410 INFO the export options (plist)
412 The function result will be used in the section format string."
413 :group 'org-export-latex
414 :version "24.4"
415 :package-version '(Org . "8.0")
416 :type 'function)
418 (defcustom org-latex-custom-id-as-label nil
419 "Toggle use of CUSTOM_ID properties for generating section labels.
421 When this variable is non-nil, Org will use the value of a
422 headline's CUSTOM_ID property as the key for the \\label command
423 for the LaTeX section corresponding to the headline.
425 By default, Org generates its own internal section labels for all
426 headlines during LaTeX export. This process ensures that the
427 \\label keys are unique and valid, but it means the keys are not
428 available in advance of the export process.
430 Setting this variable gives you control over how Org generates
431 labels for sections during LaTeX export, so that you may know
432 their keys in advance. One reason to do this is that it allows
433 you to refer to headlines using a single label both in Org's link
434 syntax and in embedded LaTeX code.
436 For example, when this variable is non-nil, a headline like this:
438 ** Some section
439 :PROPERTIES:
440 :CUSTOM_ID: sec:foo
441 :END:
442 This is section [[#sec:foo]].
443 #+BEGIN_LATEX
444 And this is still section \\ref{sec:foo}.
445 #+END_LATEX
447 will be exported to LaTeX as:
449 \\subsection{Some section}
450 \\label{sec:foo}
451 This is section \\ref{sec:foo}.
452 And this is still section \\ref{sec:foo}.
454 Note, however, that setting this variable introduces a limitation
455 on the possible values for CUSTOM_ID. When this variable is
456 non-nil and a headline defines a CUSTOM_ID value, Org simply
457 passes this value to \\label unchanged. You are responsible for
458 ensuring that the value is a valid LaTeX \\label key, and that no
459 other \\label commands with the same key appear elsewhere in your
460 document. (Keys may contain letters, numbers, and the following
461 punctuation: '_' '.' '-' ':'.) There are no such limitations on
462 CUSTOM_ID when this variable is nil.
464 For headlines that do not define the CUSTOM_ID property, Org will
465 continue to use its default labeling scheme to generate labels
466 and resolve links into section references."
467 :group 'org-export-latex
468 :type 'boolean
469 :version "24.5"
470 :package-version '(Org . "8.3"))
472 ;;;; Footnotes
474 (defcustom org-latex-footnote-separator "\\textsuperscript{,}\\,"
475 "Text used to separate footnotes."
476 :group 'org-export-latex
477 :type 'string)
480 ;;;; Timestamps
482 (defcustom org-latex-active-timestamp-format "\\textit{%s}"
483 "A printf format string to be applied to active timestamps."
484 :group 'org-export-latex
485 :type 'string)
487 (defcustom org-latex-inactive-timestamp-format "\\textit{%s}"
488 "A printf format string to be applied to inactive timestamps."
489 :group 'org-export-latex
490 :type 'string)
492 (defcustom org-latex-diary-timestamp-format "\\textit{%s}"
493 "A printf format string to be applied to diary timestamps."
494 :group 'org-export-latex
495 :type 'string)
498 ;;;; Links
500 (defcustom org-latex-image-default-option ""
501 "Default option for images."
502 :group 'org-export-latex
503 :version "24.4"
504 :package-version '(Org . "8.0")
505 :type 'string)
507 (defcustom org-latex-image-default-width ".9\\linewidth"
508 "Default width for images.
509 This value will not be used if a height is provided."
510 :group 'org-export-latex
511 :version "24.4"
512 :package-version '(Org . "8.0")
513 :type 'string)
515 (defcustom org-latex-image-default-height ""
516 "Default height for images.
517 This value will not be used if a width is provided, or if the
518 image is wrapped within a \"figure\" or \"wrapfigure\"
519 environment."
520 :group 'org-export-latex
521 :version "24.4"
522 :package-version '(Org . "8.0")
523 :type 'string)
525 (defcustom org-latex-default-figure-position "htb"
526 "Default position for latex figures."
527 :group 'org-export-latex
528 :type 'string)
530 (defcustom org-latex-inline-image-rules
531 '(("file" . "\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\|tikz\\|pgf\\|svg\\)\\'"))
532 "Rules characterizing image files that can be inlined into LaTeX.
534 A rule consists in an association whose key is the type of link
535 to consider, and value is a regexp that will be matched against
536 link's path.
538 Note that, by default, the image extension *actually* allowed
539 depend on the way the LaTeX file is processed. When used with
540 pdflatex, pdf, jpg and png images are OK. When processing
541 through dvi to Postscript, only ps and eps are allowed. The
542 default we use here encompasses both."
543 :group 'org-export-latex
544 :version "24.4"
545 :package-version '(Org . "8.0")
546 :type '(alist :key-type (string :tag "Type")
547 :value-type (regexp :tag "Path")))
549 (defcustom org-latex-link-with-unknown-path-format "\\texttt{%s}"
550 "Format string for links with unknown path type."
551 :group 'org-export-latex
552 :type 'string)
555 ;;;; Tables
557 (defcustom org-latex-default-table-environment "tabular"
558 "Default environment used to build tables."
559 :group 'org-export-latex
560 :version "24.4"
561 :package-version '(Org . "8.0")
562 :type 'string)
564 (defcustom org-latex-default-table-mode 'table
565 "Default mode for tables.
567 Value can be a symbol among:
569 `table' Regular LaTeX table.
571 `math' In this mode, every cell is considered as being in math
572 mode and the complete table will be wrapped within a math
573 environment. It is particularly useful to write matrices.
575 `inline-math' This mode is almost the same as `math', but the
576 math environment will be inlined.
578 `verbatim' The table is exported as it appears in the Org
579 buffer, within a verbatim environment.
581 This value can be overridden locally with, i.e. \":mode math\" in
582 LaTeX attributes.
584 When modifying this variable, it may be useful to change
585 `org-latex-default-table-environment' accordingly."
586 :group 'org-export-latex
587 :version "24.4"
588 :package-version '(Org . "8.0")
589 :type '(choice (const :tag "Table" table)
590 (const :tag "Matrix" math)
591 (const :tag "Inline matrix" inline-math)
592 (const :tag "Verbatim" verbatim))
593 :safe (lambda (s) (memq s '(table math inline-math verbatim))))
595 (defcustom org-latex-tables-centered t
596 "When non-nil, tables are exported in a center environment."
597 :group 'org-export-latex
598 :type 'boolean
599 :safe #'booleanp)
601 (defcustom org-latex-tables-booktabs nil
602 "When non-nil, display tables in a formal \"booktabs\" style.
603 This option assumes that the \"booktabs\" package is properly
604 loaded in the header of the document. This value can be ignored
605 locally with \":booktabs t\" and \":booktabs nil\" LaTeX
606 attributes."
607 :group 'org-export-latex
608 :version "24.4"
609 :package-version '(Org . "8.0")
610 :type 'boolean
611 :safe #'booleanp)
613 (defcustom org-latex-table-caption-above t
614 "When non-nil, place caption string at the beginning of the table.
615 Otherwise, place it near the end."
616 :group 'org-export-latex
617 :type 'boolean
618 :safe #'booleanp)
620 (defcustom org-latex-table-scientific-notation "%s\\,(%s)"
621 "Format string to display numbers in scientific notation.
622 The format should have \"%s\" twice, for mantissa and exponent
623 \(i.e., \"%s\\\\times10^{%s}\").
625 When nil, no transformation is made."
626 :group 'org-export-latex
627 :version "24.4"
628 :package-version '(Org . "8.0")
629 :type '(choice
630 (string :tag "Format string")
631 (const :tag "No formatting" nil)))
633 ;;;; Text markup
635 (defcustom org-latex-text-markup-alist '((bold . "\\textbf{%s}")
636 (code . verb)
637 (italic . "\\emph{%s}")
638 (strike-through . "\\sout{%s}")
639 (underline . "\\uline{%s}")
640 (verbatim . protectedtexttt))
641 "Alist of LaTeX expressions to convert text markup.
643 The key must be a symbol among `bold', `code', `italic',
644 `strike-through', `underline' and `verbatim'. The value is
645 a formatting string to wrap fontified text with.
647 Value can also be set to the following symbols: `verb' and
648 `protectedtexttt'. For the former, Org will use \"\\verb\" to
649 create a format string and select a delimiter character that
650 isn't in the string. For the latter, Org will use \"\\texttt\"
651 to typeset and try to protect special characters.
653 If no association can be found for a given markup, text will be
654 returned as-is."
655 :group 'org-export-latex
656 :type 'alist
657 :options '(bold code italic strike-through underline verbatim))
660 ;;;; Drawers
662 (defcustom org-latex-format-drawer-function
663 (lambda (name contents) contents)
664 "Function called to format a drawer in LaTeX code.
666 The function must accept two parameters:
667 NAME the drawer name, like \"LOGBOOK\"
668 CONTENTS the contents of the drawer.
670 The function should return the string to be exported.
672 The default function simply returns the value of CONTENTS."
673 :group 'org-export-latex
674 :version "24.4"
675 :package-version '(Org . "8.3")
676 :type 'function)
679 ;;;; Inlinetasks
681 (defcustom org-latex-format-inlinetask-function
682 'org-latex-format-inlinetask-default-function
683 "Function called to format an inlinetask in LaTeX code.
685 The function must accept seven parameters:
686 TODO the todo keyword (string or nil)
687 TODO-TYPE the todo type (symbol: `todo', `done', nil)
688 PRIORITY the inlinetask priority (integer or nil)
689 NAME the inlinetask name (string)
690 TAGS the inlinetask tags (list of strings or nil)
691 CONTENTS the contents of the inlinetask (string or nil)
692 INFO the export options (plist)
694 The function should return the string to be exported."
695 :group 'org-export-latex
696 :type 'function
697 :version "24.5"
698 :package-version '(Org . "8.3"))
701 ;; Src blocks
703 (defcustom org-latex-listings nil
704 "Non-nil means export source code using the listings package.
706 This package will fontify source code, possibly even with color.
707 If you want to use this, you also need to make LaTeX use the
708 listings package, and if you want to have color, the color
709 package. Just add these to `org-latex-packages-alist', for
710 example using customize, or with something like:
712 \(require 'ox-latex)
713 \(add-to-list 'org-latex-packages-alist '(\"\" \"listings\"))
714 \(add-to-list 'org-latex-packages-alist '(\"\" \"color\"))
716 Alternatively,
718 \(setq org-latex-listings 'minted)
720 causes source code to be exported using the minted package as
721 opposed to listings. If you want to use minted, you need to add
722 the minted package to `org-latex-packages-alist', for example
723 using customize, or with
725 \(require 'ox-latex)
726 \(add-to-list 'org-latex-packages-alist '(\"\" \"minted\"))
728 In addition, it is necessary to install pygments
729 \(http://pygments.org), and to configure the variable
730 `org-latex-pdf-process' so that the -shell-escape option is
731 passed to pdflatex.
733 The minted choice has possible repercussions on the preview of
734 latex fragments (see `org-preview-latex-fragment'). If you run
735 into previewing problems, please consult
737 http://orgmode.org/worg/org-tutorials/org-latex-preview.html"
738 :group 'org-export-latex
739 :type '(choice
740 (const :tag "Use listings" t)
741 (const :tag "Use minted" minted)
742 (const :tag "Export verbatim" nil))
743 :safe (lambda (s) (memq s '(t nil minted))))
745 (defcustom org-latex-listings-langs
746 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
747 (c "C") (cc "C++")
748 (fortran "fortran")
749 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
750 (html "HTML") (xml "XML")
751 (tex "TeX") (latex "[LaTeX]TeX")
752 (shell-script "bash")
753 (gnuplot "Gnuplot")
754 (ocaml "Caml") (caml "Caml")
755 (sql "SQL") (sqlite "sql")
756 (makefile "make"))
757 "Alist mapping languages to their listing language counterpart.
758 The key is a symbol, the major mode symbol without the \"-mode\".
759 The value is the string that should be inserted as the language
760 parameter for the listings package. If the mode name and the
761 listings name are the same, the language does not need an entry
762 in this list - but it does not hurt if it is present."
763 :group 'org-export-latex
764 :version "24.4"
765 :package-version '(Org . "8.3")
766 :type '(repeat
767 (list
768 (symbol :tag "Major mode ")
769 (string :tag "Listings language"))))
771 (defcustom org-latex-listings-options nil
772 "Association list of options for the latex listings package.
774 These options are supplied as a comma-separated list to the
775 \\lstset command. Each element of the association list should be
776 a list containing two strings: the name of the option, and the
777 value. For example,
779 \(setq org-latex-listings-options
780 '((\"basicstyle\" \"\\\\small\")
781 \(\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
783 will typeset the code in a small size font with underlined, bold
784 black keywords.
786 Note that the same options will be applied to blocks of all
787 languages. If you need block-specific options, you may use the
788 following syntax:
790 #+ATTR_LATEX: :options key1=value1,key2=value2
791 #+BEGIN_SRC <LANG>
793 #+END_SRC"
794 :group 'org-export-latex
795 :type '(repeat
796 (list
797 (string :tag "Listings option name ")
798 (string :tag "Listings option value"))))
800 (defcustom org-latex-minted-langs
801 '((emacs-lisp "common-lisp")
802 (cc "c++")
803 (cperl "perl")
804 (shell-script "bash")
805 (caml "ocaml"))
806 "Alist mapping languages to their minted language counterpart.
807 The key is a symbol, the major mode symbol without the \"-mode\".
808 The value is the string that should be inserted as the language
809 parameter for the minted package. If the mode name and the
810 listings name are the same, the language does not need an entry
811 in this list - but it does not hurt if it is present.
813 Note that minted uses all lower case for language identifiers,
814 and that the full list of language identifiers can be obtained
815 with:
817 pygmentize -L lexers"
818 :group 'org-export-latex
819 :type '(repeat
820 (list
821 (symbol :tag "Major mode ")
822 (string :tag "Minted language"))))
824 (defcustom org-latex-minted-options nil
825 "Association list of options for the latex minted package.
827 These options are supplied within square brackets in
828 \\begin{minted} environments. Each element of the alist should
829 be a list containing two strings: the name of the option, and the
830 value. For example,
832 \(setq org-latex-minted-options
833 '\((\"bgcolor\" \"bg\") \(\"frame\" \"lines\")))
835 will result in src blocks being exported with
837 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
839 as the start of the minted environment. Note that the same
840 options will be applied to blocks of all languages. If you need
841 block-specific options, you may use the following syntax:
843 #+ATTR_LATEX: :options key1=value1,key2=value2
844 #+BEGIN_SRC <LANG>
846 #+END_SRC"
847 :group 'org-export-latex
848 :type '(repeat
849 (list
850 (string :tag "Minted option name ")
851 (string :tag "Minted option value"))))
853 (defvar org-latex-custom-lang-environments nil
854 "Alist mapping languages to language-specific LaTeX environments.
856 It is used during export of src blocks by the listings and minted
857 latex packages. For example,
859 \(setq org-latex-custom-lang-environments
860 '\(\(python \"pythoncode\"\)\)\)
862 would have the effect that if org encounters begin_src python
863 during latex export it will output
865 \\begin{pythoncode}
866 <src block body>
867 \\end{pythoncode}")
870 ;;;; Compilation
872 (defcustom org-latex-pdf-process
873 '("pdflatex -interaction nonstopmode -output-directory %o %f"
874 "pdflatex -interaction nonstopmode -output-directory %o %f"
875 "pdflatex -interaction nonstopmode -output-directory %o %f")
876 "Commands to process a LaTeX file to a PDF file.
877 This is a list of strings, each of them will be given to the
878 shell as a command. %f in the command will be replaced by the
879 full file name, %b by the file base name (i.e. without directory
880 and extension parts) and %o by the base directory of the file.
882 The reason why this is a list is that it usually takes several
883 runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
884 does not have a clever mechanism to detect which of these
885 commands have to be run to get to a stable result, and it also
886 does not do any error checking.
888 By default, Org uses 3 runs of `pdflatex' to do the processing.
889 If you have texi2dvi on your system and if that does not cause
890 the infamous egrep/locale bug:
892 http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
894 then `texi2dvi' is the superior choice as it automates the LaTeX
895 build process by calling the \"correct\" combinations of
896 auxiliary programs. Org does offer `texi2dvi' as one of the
897 customize options. Alternatively, `rubber' and `latexmk' also
898 provide similar functionality. The latter supports `biber' out
899 of the box.
901 Alternatively, this may be a Lisp function that does the
902 processing, so you could use this to apply the machinery of
903 AUCTeX or the Emacs LaTeX mode. This function should accept the
904 file name as its single argument."
905 :group 'org-export-pdf
906 :type '(choice
907 (repeat :tag "Shell command sequence"
908 (string :tag "Shell command"))
909 (const :tag "2 runs of pdflatex"
910 ("pdflatex -interaction nonstopmode -output-directory %o %f"
911 "pdflatex -interaction nonstopmode -output-directory %o %f"))
912 (const :tag "3 runs of pdflatex"
913 ("pdflatex -interaction nonstopmode -output-directory %o %f"
914 "pdflatex -interaction nonstopmode -output-directory %o %f"
915 "pdflatex -interaction nonstopmode -output-directory %o %f"))
916 (const :tag "pdflatex,bibtex,pdflatex,pdflatex"
917 ("pdflatex -interaction nonstopmode -output-directory %o %f"
918 "bibtex %b"
919 "pdflatex -interaction nonstopmode -output-directory %o %f"
920 "pdflatex -interaction nonstopmode -output-directory %o %f"))
921 (const :tag "2 runs of xelatex"
922 ("xelatex -interaction nonstopmode -output-directory %o %f"
923 "xelatex -interaction nonstopmode -output-directory %o %f"))
924 (const :tag "3 runs of xelatex"
925 ("xelatex -interaction nonstopmode -output-directory %o %f"
926 "xelatex -interaction nonstopmode -output-directory %o %f"
927 "xelatex -interaction nonstopmode -output-directory %o %f"))
928 (const :tag "xelatex,bibtex,xelatex,xelatex"
929 ("xelatex -interaction nonstopmode -output-directory %o %f"
930 "bibtex %b"
931 "xelatex -interaction nonstopmode -output-directory %o %f"
932 "xelatex -interaction nonstopmode -output-directory %o %f"))
933 (const :tag "texi2dvi"
934 ("texi2dvi -p -b -V %f"))
935 (const :tag "rubber"
936 ("rubber -d --into %o %f"))
937 (const :tag "latexmk"
938 ("latexmk -g -pdf %f"))
939 (function)))
941 (defcustom org-latex-logfiles-extensions
942 '("aux" "bcf" "blg" "fdb_latexmk" "fls" "figlist" "idx" "log" "nav" "out"
943 "run.xml" "snm" "toc" "vrb" "xdv")
944 "The list of file extensions to consider as LaTeX logfiles.
945 The logfiles will be remove if `org-latex-remove-logfiles' is
946 non-nil."
947 :group 'org-export-latex
948 :type '(repeat (string :tag "Extension")))
950 (defcustom org-latex-remove-logfiles t
951 "Non-nil means remove the logfiles produced by PDF production.
952 By default, logfiles are files with these extensions: .aux, .idx,
953 .log, .out, .toc, .nav, .snm and .vrb. To define the set of
954 logfiles to remove, set `org-latex-logfiles-extensions'."
955 :group 'org-export-latex
956 :type 'boolean)
958 (defcustom org-latex-known-warnings
959 '(("Reference.*?undefined" . "[undefined reference]")
960 ("Runaway argument" . "[runaway argument]")
961 ("Underfull \\hbox" . "[underfull hbox]")
962 ("Overfull \\hbox" . "[overfull hbox]")
963 ("Citation.*?undefined" . "[undefined citation]")
964 ("Undefined control sequence" . "[undefined control sequence]"))
965 "Alist of regular expressions and associated messages for the user.
966 The regular expressions are used to find possible warnings in the
967 log of a latex-run. These warnings will be reported after
968 calling `org-latex-compile'."
969 :group 'org-export-latex
970 :version "24.5"
971 :package-version '(Org . "8.3")
972 :type '(repeat
973 (cons
974 (string :tag "Regexp")
975 (string :tag "Message"))))
979 ;;; Internal Functions
981 (defun org-latex--caption/label-string (element info)
982 "Return caption and label LaTeX string for ELEMENT.
984 INFO is a plist holding contextual information. If there's no
985 caption nor label, return the empty string.
987 For non-floats, see `org-latex--wrap-label'."
988 (let* ((label (org-element-property :name element))
989 (label-str (if (not (org-string-nw-p label)) ""
990 (format "\\label{%s}"
991 (org-export-solidify-link-text label))))
992 (main (org-export-get-caption element))
993 (short (org-export-get-caption element t))
994 (caption-from-attr-latex (org-export-read-attribute :attr_latex element :caption)))
995 (cond
996 ((org-string-nw-p caption-from-attr-latex)
997 (concat caption-from-attr-latex "\n"))
998 ((and (not main) (equal label-str "")) "")
999 ((not main) (concat label-str "\n"))
1000 ;; Option caption format with short name.
1001 (short (format "\\caption[%s]{%s%s}\n"
1002 (org-export-data short info)
1003 label-str
1004 (org-export-data main info)))
1005 ;; Standard caption format.
1006 (t (format "\\caption{%s%s}\n" label-str (org-export-data main info))))))
1008 (defun org-latex-guess-inputenc (header)
1009 "Set the coding system in inputenc to what the buffer is.
1011 HEADER is the LaTeX header string. This function only applies
1012 when specified inputenc option is \"AUTO\".
1014 Return the new header, as a string."
1015 (let* ((cs (or (ignore-errors
1016 (latexenc-coding-system-to-inputenc
1017 (or org-export-coding-system buffer-file-coding-system)))
1018 "utf8")))
1019 (if (not cs) header
1020 ;; First translate if that is requested.
1021 (setq cs (or (cdr (assoc cs org-latex-inputenc-alist)) cs))
1022 ;; Then find the \usepackage statement and replace the option.
1023 (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
1024 cs header t nil 1))))
1026 (defun org-latex-guess-babel-language (header info)
1027 "Set Babel's language according to LANGUAGE keyword.
1029 HEADER is the LaTeX header string. INFO is the plist used as
1030 a communication channel.
1032 Insertion of guessed language only happens when Babel package has
1033 explicitly been loaded. Then it is added to the rest of
1034 package's options.
1036 The argument to Babel may be \"AUTO\" which is then replaced with
1037 the language of the document or `org-export-default-language'
1038 unless language in question is already loaded.
1040 Return the new header."
1041 (let ((language-code (plist-get info :language)))
1042 ;; If no language is set or Babel package is not loaded, return
1043 ;; HEADER as-is.
1044 (if (or (not (stringp language-code))
1045 (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" header)))
1046 header
1047 (let ((options (save-match-data
1048 (org-split-string (match-string 1 header) ",[ \t]*")))
1049 (language (cdr (assoc language-code
1050 org-latex-babel-language-alist))))
1051 ;; If LANGUAGE is already loaded, return header without AUTO.
1052 ;; Otherwise, replace AUTO with language or append language if
1053 ;; AUTO is not present.
1054 (replace-match
1055 (mapconcat (lambda (option) (if (equal "AUTO" option) language option))
1056 (cond ((member language options) (delete "AUTO" options))
1057 ((member "AUTO" options) options)
1058 (t (append options (list language))))
1059 ", ")
1060 t nil header 1)))))
1062 (defun org-latex--find-verb-separator (s)
1063 "Return a character not used in string S.
1064 This is used to choose a separator for constructs like \\verb."
1065 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1066 (loop for c across ll
1067 when (not (string-match (regexp-quote (char-to-string c)) s))
1068 return (char-to-string c))))
1070 (defun org-latex--make-option-string (options)
1071 "Return a comma separated string of keywords and values.
1072 OPTIONS is an alist where the key is the options keyword as
1073 a string, and the value a list containing the keyword value, or
1074 nil."
1075 (mapconcat (lambda (pair)
1076 (concat (first pair)
1077 (when (> (length (second pair)) 0)
1078 (concat "=" (second pair)))))
1079 options
1080 ","))
1082 (defun org-latex--wrap-label (element output)
1083 "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
1084 This function shouldn't be used for floats. See
1085 `org-latex--caption/label-string'."
1086 (let ((label (org-element-property :name element)))
1087 (if (not (and (org-string-nw-p output) (org-string-nw-p label))) output
1088 (concat (format "\\phantomsection\n\\label{%s}\n"
1089 (org-export-solidify-link-text label))
1090 output))))
1092 (defun org-latex--text-markup (text markup info)
1093 "Format TEXT depending on MARKUP text markup.
1094 INFO is a plist used as a communication channel. See
1095 `org-latex-text-markup-alist' for details."
1096 (let ((fmt (cdr (assq markup (plist-get info :latex-text-markup-alist)))))
1097 (cond
1098 ;; No format string: Return raw text.
1099 ((not fmt) text)
1100 ;; Handle the `verb' special case: Find an appropriate separator
1101 ;; and use "\\verb" command.
1102 ((eq 'verb fmt)
1103 (let ((separator (org-latex--find-verb-separator text)))
1104 (concat "\\verb" separator
1105 (replace-regexp-in-string "\n" " " text)
1106 separator)))
1107 ;; Handle the `protectedtexttt' special case: Protect some
1108 ;; special chars and use "\texttt{%s}" format string.
1109 ((eq 'protectedtexttt fmt)
1110 (let ((start 0)
1111 (trans '(("\\" . "\\textbackslash{}")
1112 ("~" . "\\textasciitilde{}")
1113 ("^" . "\\textasciicircum{}")))
1114 (rtn "")
1115 char)
1116 (while (string-match "[\\{}$%&_#~^]" text)
1117 (setq char (match-string 0 text))
1118 (if (> (match-beginning 0) 0)
1119 (setq rtn (concat rtn (substring text 0 (match-beginning 0)))))
1120 (setq text (substring text (1+ (match-beginning 0))))
1121 (setq char (or (cdr (assoc char trans)) (concat "\\" char))
1122 rtn (concat rtn char)))
1123 (setq text (concat rtn text)
1124 fmt "\\texttt{%s}")
1125 (while (string-match "--" text)
1126 (setq text (replace-match "-{}-" t t text)))
1127 (format fmt text)))
1128 ;; Else use format string.
1129 (t (format fmt text)))))
1131 (defun org-latex--delayed-footnotes-definitions (element info)
1132 "Return footnotes definitions in ELEMENT as a string.
1134 INFO is a plist used as a communication channel.
1136 Footnotes definitions are returned within \"\\footnotetxt{}\"
1137 commands.
1139 This function is used within constructs that don't support
1140 \"\\footnote{}\" command (i.e. an item's tag). In that case,
1141 \"\\footnotemark\" is used within the construct and the function
1142 just outside of it."
1143 (mapconcat
1144 (lambda (ref)
1145 (format
1146 "\\footnotetext[%s]{%s}"
1147 (org-export-get-footnote-number ref info)
1148 (org-trim
1149 (org-export-data
1150 (org-export-get-footnote-definition ref info) info))))
1151 ;; Find every footnote reference in ELEMENT.
1152 (let* (all-refs
1153 search-refs ; For byte-compiler.
1154 (search-refs
1155 (function
1156 (lambda (data)
1157 ;; Return a list of all footnote references never seen
1158 ;; before in DATA.
1159 (org-element-map data 'footnote-reference
1160 (lambda (ref)
1161 (when (org-export-footnote-first-reference-p ref info)
1162 (push ref all-refs)
1163 (when (eq (org-element-property :type ref) 'standard)
1164 (funcall search-refs
1165 (org-export-get-footnote-definition ref info)))))
1166 info)
1167 (reverse all-refs)))))
1168 (funcall search-refs element))
1169 ""))
1171 (defun org-latex--translate (s info)
1172 "Translate string S according to specified language.
1173 INFO is a plist used as a communication channel."
1174 (org-export-translate s :latex info))
1178 ;;; Template
1180 (defun org-latex-template (contents info)
1181 "Return complete document string after LaTeX conversion.
1182 CONTENTS is the transcoded contents string. INFO is a plist
1183 holding export options."
1184 (let ((title (org-export-data (plist-get info :title) info)))
1185 (concat
1186 ;; Time-stamp.
1187 (and (plist-get info :time-stamp-file)
1188 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1189 ;; Document class and packages.
1190 (let* ((class (plist-get info :latex-class))
1191 (class-options (plist-get info :latex-class-options))
1192 (header (nth 1 (assoc class (plist-get info :latex-classes))))
1193 (document-class-string
1194 (and (stringp header)
1195 (if (not class-options) header
1196 (replace-regexp-in-string
1197 "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
1198 class-options header t nil 1)))))
1199 (if (not document-class-string)
1200 (user-error "Unknown LaTeX class `%s'" class)
1201 (org-latex-guess-babel-language
1202 (org-latex-guess-inputenc
1203 (org-element-normalize-string
1204 (org-splice-latex-header
1205 document-class-string
1206 org-latex-default-packages-alist
1207 org-latex-packages-alist nil
1208 (concat (org-element-normalize-string
1209 (plist-get info :latex-header))
1210 (plist-get info :latex-header-extra)))))
1211 info)))
1212 ;; Possibly limit depth for headline numbering.
1213 (let ((sec-num (plist-get info :section-numbers)))
1214 (when (integerp sec-num)
1215 (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
1216 ;; Author.
1217 (let ((author (and (plist-get info :with-author)
1218 (let ((auth (plist-get info :author)))
1219 (and auth (org-export-data auth info)))))
1220 (email (and (plist-get info :with-email)
1221 (org-export-data (plist-get info :email) info))))
1222 (cond ((and author email (not (string= "" email)))
1223 (format "\\author{%s\\thanks{%s}}\n" author email))
1224 ((or author email) (format "\\author{%s}\n" (or author email)))))
1225 ;; Date.
1226 (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
1227 (format "\\date{%s}\n" (org-export-data date info)))
1228 ;; Title
1229 (format "\\title{%s}\n" title)
1230 ;; Hyperref options.
1231 (format-spec (plist-get info :latex-hyperref-template)
1232 (format-spec-make
1233 ?k (or (plist-get info :keywords) "")
1234 ?d (or (plist-get info :description)"")
1235 ?c (if (plist-get info :with-creator)
1236 (plist-get info :creator)
1237 "")))
1238 ;; Document start.
1239 "\\begin{document}\n\n"
1240 ;; Title command.
1241 (let ((command (plist-get info :latex-title-command)))
1242 (org-element-normalize-string
1243 (cond ((string= "" title) nil)
1244 ((not (stringp command)) nil)
1245 ((string-match "\\(?:[^%]\\|^\\)%s" command)
1246 (format command title))
1247 (t command))))
1248 ;; Table of contents.
1249 (let ((depth (plist-get info :with-toc)))
1250 (when depth
1251 (concat (when (wholenump depth)
1252 (format "\\setcounter{tocdepth}{%d}\n" depth))
1253 (plist-get info :latex-toc-command))))
1254 ;; Document's body.
1255 contents
1256 ;; Creator.
1257 (let ((creator-info (plist-get info :with-creator)))
1258 (cond
1259 ((not creator-info) "")
1260 ((eq creator-info 'comment)
1261 (format "%% %s\n" (plist-get info :creator)))
1262 (t (concat (plist-get info :creator) "\n"))))
1263 ;; Document end.
1264 "\\end{document}")))
1268 ;;; Transcode Functions
1270 ;;;; Bold
1272 (defun org-latex-bold (bold contents info)
1273 "Transcode BOLD from Org to LaTeX.
1274 CONTENTS is the text with bold markup. INFO is a plist holding
1275 contextual information."
1276 (org-latex--text-markup contents 'bold info))
1279 ;;;; Center Block
1281 (defun org-latex-center-block (center-block contents info)
1282 "Transcode a CENTER-BLOCK element from Org to LaTeX.
1283 CONTENTS holds the contents of the center block. INFO is a plist
1284 holding contextual information."
1285 (org-latex--wrap-label
1286 center-block
1287 (format "\\begin{center}\n%s\\end{center}" contents)))
1290 ;;;; Clock
1292 (defun org-latex-clock (clock contents info)
1293 "Transcode a CLOCK element from Org to LaTeX.
1294 CONTENTS is nil. INFO is a plist holding contextual
1295 information."
1296 (concat
1297 "\\noindent"
1298 (format "\\textbf{%s} " org-clock-string)
1299 (format (plist-get info :latex-inactive-timestamp-format)
1300 (concat (org-translate-time
1301 (org-element-property :raw-value
1302 (org-element-property :value clock)))
1303 (let ((time (org-element-property :duration clock)))
1304 (and time (format " (%s)" time)))))
1305 "\\\\"))
1308 ;;;; Code
1310 (defun org-latex-code (code contents info)
1311 "Transcode a CODE object from Org to LaTeX.
1312 CONTENTS is nil. INFO is a plist used as a communication
1313 channel."
1314 (org-latex--text-markup (org-element-property :value code) 'code info))
1317 ;;;; Drawer
1319 (defun org-latex-drawer (drawer contents info)
1320 "Transcode a DRAWER element from Org to LaTeX.
1321 CONTENTS holds the contents of the block. INFO is a plist
1322 holding contextual information."
1323 (let* ((name (org-element-property :drawer-name drawer))
1324 (output (funcall (plist-get info :latex-format-drawer-function)
1325 name contents)))
1326 (org-latex--wrap-label drawer output)))
1329 ;;;; Dynamic Block
1331 (defun org-latex-dynamic-block (dynamic-block contents info)
1332 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
1333 CONTENTS holds the contents of the block. INFO is a plist
1334 holding contextual information. See `org-export-data'."
1335 (org-latex--wrap-label dynamic-block contents))
1338 ;;;; Entity
1340 (defun org-latex-entity (entity contents info)
1341 "Transcode an ENTITY object from Org to LaTeX.
1342 CONTENTS are the definition itself. INFO is a plist holding
1343 contextual information."
1344 (org-element-property :latex entity))
1347 ;;;; Example Block
1349 (defun org-latex-example-block (example-block contents info)
1350 "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
1351 CONTENTS is nil. INFO is a plist holding contextual
1352 information."
1353 (when (org-string-nw-p (org-element-property :value example-block))
1354 (org-latex--wrap-label
1355 example-block
1356 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1357 (org-export-format-code-default example-block info)))))
1360 ;;;; Export Block
1362 (defun org-latex-export-block (export-block contents info)
1363 "Transcode a EXPORT-BLOCK element from Org to LaTeX.
1364 CONTENTS is nil. INFO is a plist holding contextual information."
1365 (when (member (org-element-property :type export-block) '("LATEX" "TEX"))
1366 (org-remove-indentation (org-element-property :value export-block))))
1369 ;;;; Export Snippet
1371 (defun org-latex-export-snippet (export-snippet contents info)
1372 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
1373 CONTENTS is nil. INFO is a plist holding contextual information."
1374 (when (eq (org-export-snippet-backend export-snippet) 'latex)
1375 (org-element-property :value export-snippet)))
1378 ;;;; Fixed Width
1380 (defun org-latex-fixed-width (fixed-width contents info)
1381 "Transcode a FIXED-WIDTH element from Org to LaTeX.
1382 CONTENTS is nil. INFO is a plist holding contextual information."
1383 (org-latex--wrap-label
1384 fixed-width
1385 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1386 (org-remove-indentation
1387 (org-element-property :value fixed-width)))))
1390 ;;;; Footnote Reference
1392 (defun org-latex-footnote-reference (footnote-reference contents info)
1393 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1394 CONTENTS is nil. INFO is a plist holding contextual information."
1395 (concat
1396 ;; Insert separator between two footnotes in a row.
1397 (let ((prev (org-export-get-previous-element footnote-reference info)))
1398 (when (eq (org-element-type prev) 'footnote-reference)
1399 (plist-get info :latex-footnote-separator)))
1400 (cond
1401 ;; Use \footnotemark if the footnote has already been defined.
1402 ((not (org-export-footnote-first-reference-p footnote-reference info))
1403 (format "\\footnotemark[%s]{}"
1404 (org-export-get-footnote-number footnote-reference info)))
1405 ;; Use \footnotemark if reference is within another footnote
1406 ;; reference, footnote definition or table cell.
1407 ((loop for parent in (org-export-get-genealogy footnote-reference)
1408 thereis (memq (org-element-type parent)
1409 '(footnote-reference footnote-definition table-cell)))
1410 "\\footnotemark")
1411 ;; Otherwise, define it with \footnote command.
1413 (let ((def (org-export-get-footnote-definition footnote-reference info)))
1414 (concat
1415 (format "\\footnote{%s}" (org-trim (org-export-data def info)))
1416 ;; Retrieve all footnote references within the footnote and
1417 ;; add their definition after it, since LaTeX doesn't support
1418 ;; them inside.
1419 (org-latex--delayed-footnotes-definitions def info)))))))
1422 ;;;; Headline
1424 (defun org-latex-headline (headline contents info)
1425 "Transcode a HEADLINE element from Org to LaTeX.
1426 CONTENTS holds the contents of the headline. INFO is a plist
1427 holding contextual information."
1428 (unless (org-element-property :footnote-section-p headline)
1429 (let* ((class (plist-get info :latex-class))
1430 (level (org-export-get-relative-level headline info))
1431 (numberedp (org-export-numbered-headline-p headline info))
1432 (class-sectioning (assoc class (plist-get info :latex-classes)))
1433 ;; Section formatting will set two placeholders: one for
1434 ;; the title and the other for the contents.
1435 (section-fmt
1436 (let ((sec (if (functionp (nth 2 class-sectioning))
1437 (funcall (nth 2 class-sectioning) level numberedp)
1438 (nth (1+ level) class-sectioning))))
1439 (cond
1440 ;; No section available for that LEVEL.
1441 ((not sec) nil)
1442 ;; Section format directly returned by a function. Add
1443 ;; placeholder for contents.
1444 ((stringp sec) (concat sec "\n%s"))
1445 ;; (numbered-section . unnumbered-section)
1446 ((not (consp (cdr sec)))
1447 (concat (funcall (if numberedp #'car #'cdr) sec) "\n%s"))
1448 ;; (numbered-open numbered-close)
1449 ((= (length sec) 2)
1450 (when numberedp (concat (car sec) "\n%s" (nth 1 sec))))
1451 ;; (num-in num-out no-num-in no-num-out)
1452 ((= (length sec) 4)
1453 (if numberedp (concat (car sec) "\n%s" (nth 1 sec))
1454 (concat (nth 2 sec) "\n%s" (nth 3 sec)))))))
1455 ;; Create a temporary export back-end that hard-codes
1456 ;; "\underline" within "\section" and alike.
1457 (section-back-end
1458 (org-export-create-backend
1459 :parent 'latex
1460 :transcoders
1461 '((underline . (lambda (o c i) (format "\\underline{%s}" c))))))
1462 (text
1463 (org-export-data-with-backend
1464 (org-element-property :title headline) section-back-end info))
1465 (todo
1466 (and (plist-get info :with-todo-keywords)
1467 (let ((todo (org-element-property :todo-keyword headline)))
1468 (and todo (org-export-data todo info)))))
1469 (todo-type (and todo (org-element-property :todo-type headline)))
1470 (tags (and (plist-get info :with-tags)
1471 (org-export-get-tags headline info)))
1472 (priority (and (plist-get info :with-priority)
1473 (org-element-property :priority headline)))
1474 ;; Create the headline text along with a no-tag version.
1475 ;; The latter is required to remove tags from toc.
1476 (full-text (funcall (plist-get info :latex-format-headline-function)
1477 todo todo-type priority text tags info))
1478 ;; Associate \label to the headline for internal links.
1479 (headline-label
1480 (format "\\label{%s}\n"
1481 (or (and (plist-get info :latex-custom-id-labels)
1482 (org-element-property :CUSTOM_ID headline))
1483 (org-export-get-headline-id headline info))))
1484 (pre-blanks
1485 (make-string (org-element-property :pre-blank headline) 10)))
1486 (if (or (not section-fmt) (org-export-low-level-p headline info))
1487 ;; This is a deep sub-tree: export it as a list item. Also
1488 ;; export as items headlines for which no section format has
1489 ;; been found.
1490 (let ((low-level-body
1491 (concat
1492 ;; If headline is the first sibling, start a list.
1493 (when (org-export-first-sibling-p headline info)
1494 (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize)))
1495 ;; Itemize headline
1496 "\\item"
1497 (and full-text (org-string-match-p "\\`[ \t]*\\[" full-text)
1498 "\\relax")
1499 " " full-text "\n"
1500 headline-label
1501 pre-blanks
1502 contents)))
1503 ;; If headline is not the last sibling simply return
1504 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
1505 ;; any blank line.
1506 (if (not (org-export-last-sibling-p headline info)) low-level-body
1507 (replace-regexp-in-string
1508 "[ \t\n]*\\'"
1509 (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize))
1510 low-level-body)))
1511 ;; This is a standard headline. Export it as a section. Add
1512 ;; an alternative heading when possible, and when this is not
1513 ;; identical to the usual heading.
1514 (let ((opt-title
1515 (funcall (plist-get info :latex-format-headline-function)
1516 todo todo-type priority
1517 (org-export-data-with-backend
1518 (org-export-get-alt-title headline info)
1519 section-back-end info)
1520 (and (eq (plist-get info :with-tags) t) tags)
1521 info)))
1522 (if (and numberedp opt-title
1523 (not (equal opt-title full-text))
1524 (string-match "\\`\\\\\\(.*?[^*]\\){" section-fmt))
1525 (format (replace-match "\\1[%s]" nil nil section-fmt 1)
1526 ;; Replace square brackets with parenthesis
1527 ;; since square brackets are not supported in
1528 ;; optional arguments.
1529 (replace-regexp-in-string
1530 "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title))
1531 full-text
1532 (concat headline-label pre-blanks contents))
1533 ;; Impossible to add an alternative heading. Fallback to
1534 ;; regular sectioning format string.
1535 (format section-fmt full-text
1536 (concat headline-label pre-blanks contents))))))))
1538 (defun org-latex-format-headline-default-function
1539 (todo todo-type priority text tags info)
1540 "Default format function for a headline.
1541 See `org-latex-format-headline-function' for details."
1542 (concat
1543 (and todo (format "{\\bfseries\\sffamily %s} " todo))
1544 (and priority (format "\\framebox{\\#%c} " priority))
1545 text
1546 (and tags
1547 (format "\\hfill{}\\textsc{%s}"
1548 (mapconcat (lambda (tag) (org-latex-plain-text tag info))
1549 tags ":")))))
1552 ;;;; Horizontal Rule
1554 (defun org-latex-horizontal-rule (horizontal-rule contents info)
1555 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
1556 CONTENTS is nil. INFO is a plist holding contextual information."
1557 (let ((attr (org-export-read-attribute :attr_latex horizontal-rule))
1558 (prev (org-export-get-previous-element horizontal-rule info)))
1559 (concat
1560 ;; Make sure the rule doesn't start at the end of the current
1561 ;; line by separating it with a blank line from previous element.
1562 (when (and prev
1563 (let ((prev-blank (org-element-property :post-blank prev)))
1564 (or (not prev-blank) (zerop prev-blank))))
1565 "\n")
1566 (org-latex--wrap-label
1567 horizontal-rule
1568 (format "\\rule{%s}{%s}"
1569 (or (plist-get attr :width) "\\linewidth")
1570 (or (plist-get attr :thickness) "0.5pt"))))))
1573 ;;;; Inline Src Block
1575 (defun org-latex-inline-src-block (inline-src-block contents info)
1576 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
1577 CONTENTS holds the contents of the item. INFO is a plist holding
1578 contextual information."
1579 (let* ((code (org-element-property :value inline-src-block))
1580 (separator (org-latex--find-verb-separator code)))
1581 (case (plist-get info :latex-listings)
1582 ;; Do not use a special package: transcode it verbatim.
1583 ((nil) (concat "\\verb" separator code separator))
1584 ;; Use minted package.
1585 (minted
1586 (let* ((org-lang (org-element-property :language inline-src-block))
1587 (mint-lang (or (cadr (assq (intern org-lang)
1588 (plist-get info :latex-minted-langs)))
1589 (downcase org-lang)))
1590 (options (org-latex--make-option-string
1591 (plist-get info :latex-minted-options))))
1592 (concat (format "\\mint%s{%s}"
1593 (if (string= options "") "" (format "[%s]" options))
1594 mint-lang)
1595 separator code separator)))
1596 ;; Use listings package.
1597 (otherwise
1598 ;; Maybe translate language's name.
1599 (let* ((org-lang (org-element-property :language inline-src-block))
1600 (lst-lang (or (cadr (assq (intern org-lang)
1601 (plist-get info :latex-listings-langs)))
1602 org-lang))
1603 (options (org-latex--make-option-string
1604 (append (plist-get info :latex-listings-options)
1605 `(("language" ,lst-lang))))))
1606 (concat (format "\\lstinline[%s]" options)
1607 separator code separator))))))
1610 ;;;; Inlinetask
1612 (defun org-latex-inlinetask (inlinetask contents info)
1613 "Transcode an INLINETASK element from Org to LaTeX.
1614 CONTENTS holds the contents of the block. INFO is a plist
1615 holding contextual information."
1616 (let ((title (org-export-data (org-element-property :title inlinetask) info))
1617 (todo (and (plist-get info :with-todo-keywords)
1618 (let ((todo (org-element-property :todo-keyword inlinetask)))
1619 (and todo (org-export-data todo info)))))
1620 (todo-type (org-element-property :todo-type inlinetask))
1621 (tags (and (plist-get info :with-tags)
1622 (org-export-get-tags inlinetask info)))
1623 (priority (and (plist-get info :with-priority)
1624 (org-element-property :priority inlinetask)))
1625 (contents (concat
1626 (let ((label (org-element-property :CUSTOM_ID inlinetask)))
1627 (and label (format "\\label{%s}\n" label)))
1628 contents)))
1629 (funcall (plist-get info :latex-format-inlinetask-function)
1630 todo todo-type priority title tags contents info)))
1632 (defun org-latex-format-inlinetask-default-function
1633 (todo todo-type priority title tags contents info)
1634 "Default format function for a inlinetasks.
1635 See `org-latex-format-inlinetask-function' for details."
1636 (let ((full-title
1637 (concat (when todo (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
1638 (when priority (format "\\framebox{\\#%c} " priority))
1639 title
1640 (when tags
1641 (format "\\hfill{}\\textsc{:%s:}"
1642 (mapconcat
1643 (lambda (tag) (org-latex-plain-text tag info))
1644 tags ":"))))))
1645 (concat "\\begin{center}\n"
1646 "\\fbox{\n"
1647 "\\begin{minipage}[c]{.6\\textwidth}\n"
1648 full-title "\n\n"
1649 (and (org-string-nw-p contents)
1650 (concat "\\rule[.8em]{\\textwidth}{2pt}\n\n" contents))
1651 "\\end{minipage}\n"
1652 "}\n"
1653 "\\end{center}")))
1656 ;;;; Italic
1658 (defun org-latex-italic (italic contents info)
1659 "Transcode ITALIC from Org to LaTeX.
1660 CONTENTS is the text with italic markup. INFO is a plist holding
1661 contextual information."
1662 (org-latex--text-markup contents 'italic info))
1665 ;;;; Item
1667 (defun org-latex-item (item contents info)
1668 "Transcode an ITEM element from Org to LaTeX.
1669 CONTENTS holds the contents of the item. INFO is a plist holding
1670 contextual information."
1671 (let* ((counter
1672 (let ((count (org-element-property :counter item))
1673 (level
1674 ;; Determine level of current item to determine the
1675 ;; correct LaTeX counter to use (enumi, enumii...).
1676 (let ((parent item) (level 0))
1677 (while (memq (org-element-type
1678 (setq parent (org-export-get-parent parent)))
1679 '(plain-list item))
1680 (when (and (eq (org-element-type parent) 'plain-list)
1681 (eq (org-element-property :type parent)
1682 'ordered))
1683 (incf level)))
1684 level)))
1685 (and count
1686 (< level 5)
1687 (format "\\setcounter{enum%s}{%s}\n"
1688 (nth (1- level) '("i" "ii" "iii" "iv"))
1689 (1- count)))))
1690 (checkbox (case (org-element-property :checkbox item)
1691 (on "$\\boxtimes$ ")
1692 (off "$\\square$ ")
1693 (trans "$\\boxminus$ ")))
1694 (tag (let ((tag (org-element-property :tag item)))
1695 ;; Check-boxes must belong to the tag.
1696 (and tag (format "[{%s}] "
1697 (concat checkbox
1698 (org-export-data tag info)))))))
1699 (concat counter
1700 "\\item"
1701 (cond
1702 (tag)
1703 (checkbox (concat " " checkbox))
1704 ;; Without a tag or a check-box, if CONTENTS starts with
1705 ;; an opening square bracket, add "\relax" to "\item",
1706 ;; unless the brackets comes from an initial export
1707 ;; snippet (i.e. it is inserted willingly by the user).
1708 ((and contents
1709 (org-string-match-p "\\`[ \t]*\\[" contents)
1710 (not (let ((e (car (org-element-contents item))))
1711 (and (eq (org-element-type e) 'paragraph)
1712 (let ((o (car (org-element-contents e))))
1713 (and (eq (org-element-type o) 'export-snippet)
1714 (eq (org-export-snippet-backend o)
1715 'latex)))))))
1716 "\\relax ")
1717 (t " "))
1718 (and contents (org-trim contents))
1719 ;; If there are footnotes references in tag, be sure to
1720 ;; add their definition at the end of the item. This
1721 ;; workaround is necessary since "\footnote{}" command is
1722 ;; not supported in tags.
1723 (and tag
1724 (org-latex--delayed-footnotes-definitions
1725 (org-element-property :tag item) info)))))
1728 ;;;; Keyword
1730 (defun org-latex-keyword (keyword contents info)
1731 "Transcode a KEYWORD element from Org to LaTeX.
1732 CONTENTS is nil. INFO is a plist holding contextual information."
1733 (let ((key (org-element-property :key keyword))
1734 (value (org-element-property :value keyword)))
1735 (cond
1736 ((string= key "LATEX") value)
1737 ((string= key "INDEX") (format "\\index{%s}" value))
1738 ((string= key "TOC")
1739 (let ((value (downcase value)))
1740 (cond
1741 ((string-match "\\<headlines\\>" value)
1742 (let ((depth (or (and (string-match "[0-9]+" value)
1743 (string-to-number (match-string 0 value)))
1744 (plist-get info :with-toc))))
1745 (concat
1746 (when (wholenump depth)
1747 (format "\\setcounter{tocdepth}{%s}\n" depth))
1748 "\\tableofcontents")))
1749 ((string= "tables" value) "\\listoftables")
1750 ((string= "listings" value)
1751 (case (plist-get info :latex-listings)
1752 ((nil) "\\listoffigures")
1753 (minted "\\listoflistings")
1754 (otherwise "\\lstlistoflistings")))))))))
1757 ;;;; Latex Environment
1759 (defun org-latex-latex-environment (latex-environment contents info)
1760 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
1761 CONTENTS is nil. INFO is a plist holding contextual information."
1762 (when (plist-get info :with-latex)
1763 (let ((label (org-element-property :name latex-environment))
1764 (value (org-remove-indentation
1765 (org-element-property :value latex-environment))))
1766 (if (not (org-string-nw-p label)) value
1767 ;; Environment is labeled: label must be within the environment
1768 ;; (otherwise, a reference pointing to that element will count
1769 ;; the section instead).
1770 (with-temp-buffer
1771 (insert value)
1772 (goto-char (point-min))
1773 (forward-line)
1774 (insert
1775 (format "\\label{%s}\n" (org-export-solidify-link-text label)))
1776 (buffer-string))))))
1779 ;;;; Latex Fragment
1781 (defun org-latex-latex-fragment (latex-fragment contents info)
1782 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
1783 CONTENTS is nil. INFO is a plist holding contextual information."
1784 (let ((value (org-element-property :value latex-fragment)))
1785 ;; Trim math markers since the fragment is enclosed within
1786 ;; a latex-math-block object anyway.
1787 (cond ((string-match "\\`\\(\\$\\{1,2\\}\\)\\([^\000]*\\)\\1\\'" value)
1788 (match-string 2 value))
1789 ((string-match "\\`\\\\(\\([^\000]*\\)\\\\)\\'" value)
1790 (match-string 1 value))
1791 (t value))))
1794 ;;;; Line Break
1796 (defun org-latex-line-break (line-break contents info)
1797 "Transcode a LINE-BREAK object from Org to LaTeX.
1798 CONTENTS is nil. INFO is a plist holding contextual information."
1799 "\\\\\n")
1802 ;;;; Link
1804 (defun org-latex--inline-image (link info)
1805 "Return LaTeX code for an inline image.
1806 LINK is the link pointing to the inline image. INFO is a plist
1807 used as a communication channel."
1808 (let* ((parent (org-export-get-parent-element link))
1809 (path (let ((raw-path (org-element-property :path link)))
1810 (if (not (file-name-absolute-p raw-path)) raw-path
1811 (expand-file-name raw-path))))
1812 (filetype (file-name-extension path))
1813 (caption (org-latex--caption/label-string parent info))
1814 ;; Retrieve latex attributes from the element around.
1815 (attr (org-export-read-attribute :attr_latex parent))
1816 (float (let ((float (plist-get attr :float)))
1817 (cond ((and (not float) (plist-member attr :float)) nil)
1818 ((string= float "wrap") 'wrap)
1819 ((string= float "sideways") 'sideways)
1820 ((string= float "multicolumn") 'multicolumn)
1821 ((or float
1822 (org-element-property :caption parent)
1823 (org-string-nw-p (plist-get attr :caption)))
1824 'figure))))
1825 (placement
1826 (let ((place (plist-get attr :placement)))
1827 (cond
1828 (place (format "%s" place))
1829 ((eq float 'wrap) "{l}{0.5\\textwidth}")
1830 ((eq float 'figure)
1831 (format "[%s]" (plist-get info :latex-default-figure-position)))
1832 (t ""))))
1833 (comment-include (if (plist-get attr :comment-include) "%" ""))
1834 ;; It is possible to specify width and height in the
1835 ;; ATTR_LATEX line, and also via default variables.
1836 (width (cond ((plist-get attr :width))
1837 ((plist-get attr :height) "")
1838 ((eq float 'wrap) "0.48\\textwidth")
1839 (t (plist-get info :latex-image-default-width))))
1840 (height (cond ((plist-get attr :height))
1841 ((or (plist-get attr :width)
1842 (memq float '(figure wrap))) "")
1843 (t (plist-get info :latex-image-default-height))))
1844 (options (let ((opt (or (plist-get attr :options)
1845 (plist-get info :latex-image-default-option))))
1846 (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt)) opt
1847 (match-string 1 opt))))
1848 image-code)
1849 (if (member filetype '("tikz" "pgf"))
1850 ;; For tikz images:
1851 ;; - use \input to read in image file.
1852 ;; - if options are present, wrap in a tikzpicture environment.
1853 ;; - if width or height are present, use \resizebox to change
1854 ;; the image size.
1855 (progn
1856 (setq image-code (format "\\input{%s}" path))
1857 (when (org-string-nw-p options)
1858 (setq image-code
1859 (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
1860 options
1861 image-code)))
1862 (when (or (org-string-nw-p width) (org-string-nw-p height))
1863 (setq image-code (format "\\resizebox{%s}{%s}{%s}"
1864 (if (org-string-nw-p width) width "!")
1865 (if (org-string-nw-p height) height "!")
1866 image-code))))
1867 ;; For other images:
1868 ;; - add width and height to options.
1869 ;; - include the image with \includegraphics.
1870 (when (org-string-nw-p width)
1871 (setq options (concat options ",width=" width)))
1872 (when (org-string-nw-p height)
1873 (setq options (concat options ",height=" height)))
1874 (let ((search-option (org-element-property :search-option link)))
1875 (when (and search-option
1876 (equal filetype "pdf")
1877 (org-string-match-p "\\`[0-9]+\\'" search-option)
1878 (not (org-string-match-p "page=" options)))
1879 (setq options (concat options ",page=" search-option))))
1880 (setq image-code
1881 (format "\\includegraphics%s{%s}"
1882 (cond ((not (org-string-nw-p options)) "")
1883 ((= (aref options 0) ?,)
1884 (format "[%s]"(substring options 1)))
1885 (t (format "[%s]" options)))
1886 path))
1887 (when (equal filetype "svg")
1888 (setq image-code (replace-regexp-in-string "^\\\\includegraphics"
1889 "\\includesvg"
1890 image-code
1891 nil t))
1892 (setq image-code (replace-regexp-in-string "\\.svg}"
1894 image-code
1895 nil t))))
1896 ;; Return proper string, depending on FLOAT.
1897 (case float
1898 (wrap (format "\\begin{wrapfigure}%s
1899 \\centering
1900 %s%s
1901 %s\\end{wrapfigure}" placement comment-include image-code caption))
1902 (sideways (format "\\begin{sidewaysfigure}
1903 \\centering
1904 %s%s
1905 %s\\end{sidewaysfigure}" comment-include image-code caption))
1906 (multicolumn (format "\\begin{figure*}%s
1907 \\centering
1908 %s%s
1909 %s\\end{figure*}" placement comment-include image-code caption))
1910 (figure (format "\\begin{figure}%s
1911 \\centering
1912 %s%s
1913 %s\\end{figure}" placement comment-include image-code caption))
1914 (otherwise image-code))))
1916 (defun org-latex-link (link desc info)
1917 "Transcode a LINK object from Org to LaTeX.
1919 DESC is the description part of the link, or the empty string.
1920 INFO is a plist holding contextual information. See
1921 `org-export-data'."
1922 (let* ((type (org-element-property :type link))
1923 (raw-path (replace-regexp-in-string
1924 "%" "\\%" (org-element-property :path link) nil t))
1925 ;; Ensure DESC really exists, or set it to nil.
1926 (desc (and (not (string= desc "")) desc))
1927 (imagep (org-export-inline-image-p
1928 link (plist-get info :latex-inline-image-rules)))
1929 (path (cond
1930 ((member type '("http" "https" "ftp" "mailto"))
1931 (concat type ":" raw-path))
1932 ((and (string= type "file") (file-name-absolute-p raw-path))
1933 (concat "file:" raw-path))
1934 (t raw-path)))
1935 protocol)
1936 (cond
1937 ;; Image file.
1938 (imagep (org-latex--inline-image link info))
1939 ;; Radio link: Transcode target's contents and use them as link's
1940 ;; description.
1941 ((string= type "radio")
1942 (let ((destination (org-export-resolve-radio-link link info)))
1943 (if (not destination) desc
1944 (format "\\hyperref[%s]{%s}"
1945 (org-export-solidify-link-text
1946 (org-element-property :value destination))
1947 desc))))
1948 ;; Links pointing to a headline: Find destination and build
1949 ;; appropriate referencing command.
1950 ((member type '("custom-id" "fuzzy" "id"))
1951 (let ((destination (if (string= type "fuzzy")
1952 (org-export-resolve-fuzzy-link link info)
1953 (org-export-resolve-id-link link info))))
1954 (case (org-element-type destination)
1955 ;; Id link points to an external file.
1956 (plain-text
1957 (if desc (format "\\href{%s}{%s}" destination desc)
1958 (format "\\url{%s}" destination)))
1959 ;; Fuzzy link points nowhere.
1960 ('nil
1961 (format (plist-get info :latex-link-with-unknown-path-format)
1962 (or desc
1963 (org-export-data
1964 (org-element-property :raw-link link) info))))
1965 ;; LINK points to a headline. If headlines are numbered
1966 ;; and the link has no description, display headline's
1967 ;; number. Otherwise, display description or headline's
1968 ;; title.
1969 (headline
1970 (let* ((custom-label
1971 (and (plist-get info :latex-custom-id-labels)
1972 (org-element-property :CUSTOM_ID destination)))
1973 (label (or custom-label
1974 (org-export-get-headline-id destination info))))
1975 (if (and (not desc)
1976 (org-export-numbered-headline-p destination info))
1977 (format "\\ref{%s}" label)
1978 (format "\\hyperref[%s]{%s}" label
1979 (or desc
1980 (org-export-data
1981 (org-element-property :title destination) info))))))
1982 ;; Fuzzy link points to a target. Do as above.
1983 (otherwise
1984 (let ((path (org-export-solidify-link-text path)))
1985 (if (not desc) (format "\\ref{%s}" path)
1986 (format "\\hyperref[%s]{%s}" path desc)))))))
1987 ;; Coderef: replace link with the reference name or the
1988 ;; equivalent line number.
1989 ((string= type "coderef")
1990 (format (org-export-get-coderef-format path desc)
1991 (org-export-resolve-coderef path info)))
1992 ;; Link type is handled by a special function.
1993 ((functionp (setq protocol (nth 2 (assoc type org-link-protocols))))
1994 (funcall protocol (org-link-unescape path) desc 'latex))
1995 ;; External link with a description part.
1996 ((and path desc) (format "\\href{%s}{%s}" path desc))
1997 ;; External link without a description part.
1998 (path (format "\\url{%s}" path))
1999 ;; No path, only description. Try to do something useful.
2000 (t (format (plist-get info :latex-link-with-unknown-path-format) desc)))))
2003 ;;;; Node Property
2005 (defun org-latex-node-property (node-property contents info)
2006 "Transcode a NODE-PROPERTY element from Org to LaTeX.
2007 CONTENTS is nil. INFO is a plist holding contextual
2008 information."
2009 (format "%s:%s"
2010 (org-element-property :key node-property)
2011 (let ((value (org-element-property :value node-property)))
2012 (if value (concat " " value) ""))))
2015 ;;;; Paragraph
2017 (defun org-latex-paragraph (paragraph contents info)
2018 "Transcode a PARAGRAPH element from Org to LaTeX.
2019 CONTENTS is the contents of the paragraph, as a string. INFO is
2020 the plist used as a communication channel."
2021 contents)
2024 ;;;; Plain List
2026 (defun org-latex-plain-list (plain-list contents info)
2027 "Transcode a PLAIN-LIST element from Org to LaTeX.
2028 CONTENTS is the contents of the list. INFO is a plist holding
2029 contextual information."
2030 (let* ((type (org-element-property :type plain-list))
2031 (attr (org-export-read-attribute :attr_latex plain-list))
2032 (latex-type (let ((env (plist-get attr :environment)))
2033 (cond (env (format "%s" env))
2034 ((eq type 'ordered) "enumerate")
2035 ((eq type 'descriptive) "description")
2036 (t "itemize")))))
2037 (org-latex--wrap-label
2038 plain-list
2039 (format "\\begin{%s}%s\n%s\\end{%s}"
2040 latex-type
2041 (or (plist-get attr :options) "")
2042 contents
2043 latex-type))))
2046 ;;;; Plain Text
2048 (defun org-latex-plain-text (text info)
2049 "Transcode a TEXT string from Org to LaTeX.
2050 TEXT is the string to transcode. INFO is a plist holding
2051 contextual information."
2052 (let* ((specialp (plist-get info :with-special-strings))
2053 (output
2054 ;; Turn LaTeX into \LaTeX{} and TeX into \TeX{}.
2055 (let ((case-fold-search nil))
2056 (replace-regexp-in-string
2057 "\\<\\(?:La\\)?TeX\\>" "\\\\\\&{}"
2058 ;; Protect ^, ~, %, #, &, $, _, { and }. Also protect \.
2059 ;; However, if special strings are used, be careful not
2060 ;; to protect "\" in "\-" constructs.
2061 (replace-regexp-in-string
2062 (concat "[%$#&{}_~^]\\|\\\\" (and specialp "\\(?:[^-]\\|$\\)"))
2063 (lambda (m)
2064 (case (aref m 0)
2065 (?\\ "$\\\\backslash$")
2066 (?~ "\\\\textasciitilde{}")
2067 (?^ "\\\\^{}")
2068 (t "\\\\\\&")))
2069 text)))))
2070 ;; Activate smart quotes. Be sure to provide original TEXT string
2071 ;; since OUTPUT may have been modified.
2072 (when (plist-get info :with-smart-quotes)
2073 (setq output (org-export-activate-smart-quotes output :latex info text)))
2074 ;; Convert special strings.
2075 (when specialp
2076 (setq output (replace-regexp-in-string "\\.\\.\\." "\\\\ldots{}" output)))
2077 ;; Handle break preservation if required.
2078 (when (plist-get info :preserve-breaks)
2079 (setq output (replace-regexp-in-string
2080 "\\(?:[ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n" output nil t)))
2081 ;; Return value.
2082 output))
2085 ;;;; Planning
2087 (defun org-latex-planning (planning contents info)
2088 "Transcode a PLANNING element from Org to LaTeX.
2089 CONTENTS is nil. INFO is a plist holding contextual
2090 information."
2091 (concat
2092 "\\noindent"
2093 (mapconcat
2094 'identity
2095 (delq nil
2096 (list
2097 (let ((closed (org-element-property :closed planning)))
2098 (when closed
2099 (concat
2100 (format "\\textbf{%s} " org-closed-string)
2101 (format (plist-get info :latex-inactive-timestamp-format)
2102 (org-translate-time
2103 (org-element-property :raw-value closed))))))
2104 (let ((deadline (org-element-property :deadline planning)))
2105 (when deadline
2106 (concat
2107 (format "\\textbf{%s} " org-deadline-string)
2108 (format (plist-get info :latex-active-timestamp-format)
2109 (org-translate-time
2110 (org-element-property :raw-value deadline))))))
2111 (let ((scheduled (org-element-property :scheduled planning)))
2112 (when scheduled
2113 (concat
2114 (format "\\textbf{%s} " org-scheduled-string)
2115 (format (plist-get info :latex-active-timestamp-format)
2116 (org-translate-time
2117 (org-element-property :raw-value scheduled))))))))
2118 " ")
2119 "\\\\"))
2122 ;;;; Property Drawer
2124 (defun org-latex-property-drawer (property-drawer contents info)
2125 "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
2126 CONTENTS holds the contents of the drawer. INFO is a plist
2127 holding contextual information."
2128 (and (org-string-nw-p contents)
2129 (format "\\begin{verbatim}\n%s\\end{verbatim}" contents)))
2132 ;;;; Pseudo Object: LaTeX Math Block
2134 (defun org-latex--wrap-latex-math-block (data info)
2135 "Merge contiguous math objects in a pseudo-object container.
2136 DATA is a parse tree or a secondary string. INFO is a plist
2137 containing export options. Modify DATA by side-effect and return it."
2138 (let ((valid-object-p
2139 (function
2140 ;; Non-nil when OBJ can be added to the latex math block.
2141 (lambda (obj)
2142 (case (org-element-type obj)
2143 (entity (org-element-property :latex-math-p obj))
2144 (latex-fragment
2145 (let ((value (org-element-property :value obj)))
2146 (or (org-string-match-p "\\`\\\\([^\000]*\\\\)\\'" value)
2147 (org-string-match-p "\\`\\$[^\000]*\\$\\'" value))))
2148 ((subscript superscript) t))))))
2149 (org-element-map data '(entity latex-fragment subscript superscript)
2150 (lambda (object)
2151 ;; Skip objects already wrapped.
2152 (when (and (not (eq (org-element-type
2153 (org-element-property :parent object))
2154 'latex-math-block))
2155 (funcall valid-object-p object))
2156 (let ((math-block (list 'latex-math-block nil))
2157 (next-elements (org-export-get-next-element object info t))
2158 (last object))
2159 ;; Wrap MATH-BLOCK around OBJECT in DATA.
2160 (org-element-insert-before math-block object)
2161 (org-element-extract-element object)
2162 (org-element-adopt-elements math-block object)
2163 (when (zerop (or (org-element-property :post-blank object) 0))
2164 ;; MATH-BLOCK swallows consecutive math objects.
2165 (catch 'exit
2166 (dolist (next next-elements)
2167 (if (not (funcall valid-object-p next)) (throw 'exit nil)
2168 (org-element-extract-element next)
2169 (org-element-adopt-elements math-block next)
2170 ;; Eschew the case: \beta$x$ -> \(\betax\).
2171 (unless (memq (org-element-type next)
2172 '(subscript superscript))
2173 (org-element-put-property last :post-blank 1))
2174 (setq last next)
2175 (when (> (or (org-element-property :post-blank next) 0) 0)
2176 (throw 'exit nil))))))
2177 (org-element-put-property
2178 math-block :post-blank (org-element-property :post-blank last)))))
2179 info nil '(subscript superscript latex-math-block) t)
2180 ;; Return updated DATA.
2181 data))
2183 (defun org-latex-math-block-tree-filter (tree backend info)
2184 (org-latex--wrap-latex-math-block tree info))
2186 (defun org-latex-math-block-options-filter (info backend)
2187 (dolist (prop '(:author :date :title) info)
2188 (plist-put info prop
2189 (org-latex--wrap-latex-math-block (plist-get info prop) info))))
2191 (defun org-latex-math-block (math-block contents info)
2192 "Transcode a MATH-BLOCK object from Org to LaTeX.
2193 CONTENTS is a string. INFO is a plist used as a communication
2194 channel."
2195 (when (org-string-nw-p contents)
2196 (format "\\(%s\\)" (org-trim contents))))
2198 ;;;; Quote Block
2200 (defun org-latex-quote-block (quote-block contents info)
2201 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
2202 CONTENTS holds the contents of the block. INFO is a plist
2203 holding contextual information."
2204 (org-latex--wrap-label
2205 quote-block
2206 (format "\\begin{quote}\n%s\\end{quote}" contents)))
2209 ;;;; Radio Target
2211 (defun org-latex-radio-target (radio-target text info)
2212 "Transcode a RADIO-TARGET object from Org to LaTeX.
2213 TEXT is the text of the target. INFO is a plist holding
2214 contextual information."
2215 (format "\\label{%s}%s"
2216 (org-export-solidify-link-text
2217 (org-element-property :value radio-target))
2218 text))
2221 ;;;; Section
2223 (defun org-latex-section (section contents info)
2224 "Transcode a SECTION element from Org to LaTeX.
2225 CONTENTS holds the contents of the section. INFO is a plist
2226 holding contextual information."
2227 contents)
2230 ;;;; Special Block
2232 (defun org-latex-special-block (special-block contents info)
2233 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
2234 CONTENTS holds the contents of the block. INFO is a plist
2235 holding contextual information."
2236 (let ((type (org-element-property :type special-block))
2237 (opt (org-export-read-attribute :attr_latex special-block :options)))
2238 (concat (format "\\begin{%s}%s\n" type (or opt ""))
2239 ;; Insert any label or caption within the block
2240 ;; (otherwise, a reference pointing to that element will
2241 ;; count the section instead).
2242 (org-latex--caption/label-string special-block info)
2243 contents
2244 (format "\\end{%s}" type))))
2247 ;;;; Src Block
2249 (defun org-latex-src-block (src-block contents info)
2250 "Transcode a SRC-BLOCK element from Org to LaTeX.
2251 CONTENTS holds the contents of the item. INFO is a plist holding
2252 contextual information."
2253 (when (org-string-nw-p (org-element-property :value src-block))
2254 (let* ((lang (org-element-property :language src-block))
2255 (caption (org-element-property :caption src-block))
2256 (label (org-element-property :name src-block))
2257 (custom-env (and lang
2258 (cadr (assq (intern lang)
2259 org-latex-custom-lang-environments))))
2260 (num-start (case (org-element-property :number-lines src-block)
2261 (continued (org-export-get-loc src-block info))
2262 (new 0)))
2263 (retain-labels (org-element-property :retain-labels src-block))
2264 (attributes (org-export-read-attribute :attr_latex src-block))
2265 (float (plist-get attributes :float))
2266 (listings (plist-get info :latex-listings)))
2267 (cond
2268 ;; Case 1. No source fontification.
2269 ((not listings)
2270 (let* ((caption-str (org-latex--caption/label-string src-block info))
2271 (float-env
2272 (cond ((and (not float) (plist-member attributes :float)) "%s")
2273 ((string= "multicolumn" float)
2274 (format "\\begin{figure*}[%s]\n%%s%s\n\\end{figure*}"
2275 (plist-get info :latex-default-figure-position)
2276 caption-str))
2277 ((or caption float)
2278 (format "\\begin{figure}[H]\n%%s%s\n\\end{figure}"
2279 caption-str))
2280 (t "%s"))))
2281 (format
2282 float-env
2283 (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
2284 (org-export-format-code-default src-block info))))))
2285 ;; Case 2. Custom environment.
2286 (custom-env (format "\\begin{%s}\n%s\\end{%s}\n"
2287 custom-env
2288 (org-export-format-code-default src-block info)
2289 custom-env))
2290 ;; Case 3. Use minted package.
2291 ((eq listings 'minted)
2292 (let* ((caption-str (org-latex--caption/label-string src-block info))
2293 (float-env
2294 (cond ((and (not float) (plist-member attributes :float) caption)
2295 (format "%%s\n%s" (replace-regexp-in-string
2296 "\\\\caption" "\\captionof{listing}"
2297 caption-str t t)))
2298 ((and (not float) (plist-member attributes :float)) "%s")
2299 ((string= "multicolumn" float)
2300 (format "\\begin{listing*}\n%%s\n%s\\end{listing*}"
2301 caption-str))
2302 ((or caption float)
2303 (format "\\begin{listing}[H]\n%%s\n%s\\end{listing}"
2304 caption-str))
2305 (t "%s")))
2306 (options (plist-get info :latex-minted-options))
2307 (body
2308 (format
2309 "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2310 ;; Options.
2311 (concat
2312 (org-latex--make-option-string
2313 (if (or (not num-start) (assoc "linenos" options))
2314 options
2315 (append
2316 `(("linenos")
2317 ("firstnumber" ,(number-to-string (1+ num-start))))
2318 options)))
2319 (let ((local-options (plist-get attributes :options)))
2320 (and local-options (concat "," local-options))))
2321 ;; Language.
2322 (or (cadr (assq (intern lang)
2323 (plist-get info :latex-minted-langs)))
2324 (downcase lang))
2325 ;; Source code.
2326 (let* ((code-info (org-export-unravel-code src-block))
2327 (max-width
2328 (apply 'max
2329 (mapcar 'length
2330 (org-split-string (car code-info)
2331 "\n")))))
2332 (org-export-format-code
2333 (car code-info)
2334 (lambda (loc num ref)
2335 (concat
2337 (when ref
2338 ;; Ensure references are flushed to the right,
2339 ;; separated with 6 spaces from the widest line
2340 ;; of code.
2341 (concat (make-string (+ (- max-width (length loc)) 6)
2342 ?\s)
2343 (format "(%s)" ref)))))
2344 nil (and retain-labels (cdr code-info)))))))
2345 ;; Return value.
2346 (format float-env body)))
2347 ;; Case 4. Use listings package.
2349 (let ((lst-lang
2350 (or (cadr (assq (intern lang)
2351 (plist-get info :latex-listings-langs)))
2352 lang))
2353 (caption-str
2354 (when caption
2355 (let ((main (org-export-get-caption src-block))
2356 (secondary (org-export-get-caption src-block t)))
2357 (if (not secondary)
2358 (format "{%s}" (org-export-data main info))
2359 (format "{[%s]%s}"
2360 (org-export-data secondary info)
2361 (org-export-data main info))))))
2362 (lst-opt (plist-get info :latex-listings-options)))
2363 (concat
2364 ;; Options.
2365 (format
2366 "\\lstset{%s}\n"
2367 (concat
2368 (org-latex--make-option-string
2369 (append
2370 lst-opt
2371 (cond
2372 ((and (not float) (plist-member attributes :float)) nil)
2373 ((string= "multicolumn" float) '(("float" "*")))
2374 ((and float (not (assoc "float" lst-opt)))
2375 `(("float" ,(plist-get info :latex-default-figure-position)))))
2376 `(("language" ,lst-lang))
2377 (if label `(("label" ,label)) '(("label" " ")))
2378 (if caption-str `(("caption" ,caption-str)) '(("caption" " ")))
2379 (cond ((assoc "numbers" lst-opt) nil)
2380 ((not num-start) '(("numbers" "none")))
2381 ((zerop num-start) '(("numbers" "left")))
2382 (t `(("numbers" "left")
2383 ("firstnumber"
2384 ,(number-to-string (1+ num-start))))))))
2385 (let ((local-options (plist-get attributes :options)))
2386 (and local-options (concat "," local-options)))))
2387 ;; Source code.
2388 (format
2389 "\\begin{lstlisting}\n%s\\end{lstlisting}"
2390 (let* ((code-info (org-export-unravel-code src-block))
2391 (max-width
2392 (apply 'max
2393 (mapcar 'length
2394 (org-split-string (car code-info) "\n")))))
2395 (org-export-format-code
2396 (car code-info)
2397 (lambda (loc num ref)
2398 (concat
2400 (when ref
2401 ;; Ensure references are flushed to the right,
2402 ;; separated with 6 spaces from the widest line of
2403 ;; code
2404 (concat (make-string (+ (- max-width (length loc)) 6) ? )
2405 (format "(%s)" ref)))))
2406 nil (and retain-labels (cdr code-info))))))))))))
2409 ;;;; Statistics Cookie
2411 (defun org-latex-statistics-cookie (statistics-cookie contents info)
2412 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
2413 CONTENTS is nil. INFO is a plist holding contextual information."
2414 (replace-regexp-in-string
2415 "%" "\\%" (org-element-property :value statistics-cookie) nil t))
2418 ;;;; Strike-Through
2420 (defun org-latex-strike-through (strike-through contents info)
2421 "Transcode STRIKE-THROUGH from Org to LaTeX.
2422 CONTENTS is the text with strike-through markup. INFO is a plist
2423 holding contextual information."
2424 (org-latex--text-markup contents 'strike-through info))
2427 ;;;; Subscript
2429 (defun org-latex--script-size (object info)
2430 "Transcode a subscript or superscript object.
2431 OBJECT is an Org object. INFO is a plist used as a communication
2432 channel."
2433 (let ((type (org-element-type object))
2434 (output ""))
2435 (org-element-map (org-element-contents object)
2436 (cons 'plain-text org-element-all-objects)
2437 (lambda (obj)
2438 (case (org-element-type obj)
2439 ((entity latex-fragment)
2440 (let ((data (org-trim (org-export-data obj info))))
2441 (string-match
2442 "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
2443 data)
2444 (setq output
2445 (concat output
2446 (match-string 1 data)
2447 (let ((blank (org-element-property :post-blank obj)))
2448 (and blank (> blank 0) "\\ "))))))
2449 (plain-text
2450 (setq output
2451 (format "%s\\text{%s}" output (org-export-data obj info))))
2452 (otherwise
2453 (setq output
2454 (concat output
2455 (org-export-data obj info)
2456 (let ((blank (org-element-property :post-blank obj)))
2457 (and blank (> blank 0) "\\ ")))))))
2458 info nil org-element-recursive-objects)
2459 ;; Result. Do not wrap into curly brackets if OUTPUT is a single
2460 ;; character.
2461 (concat (if (eq (org-element-type object) 'subscript) "_" "^")
2462 (and (> (length output) 1) "{")
2463 output
2464 (and (> (length output) 1) "}"))))
2466 (defun org-latex-subscript (subscript contents info)
2467 "Transcode a SUBSCRIPT object from Org to LaTeX.
2468 CONTENTS is the contents of the object. INFO is a plist holding
2469 contextual information."
2470 (org-latex--script-size subscript info))
2473 ;;;; Superscript
2475 (defun org-latex-superscript (superscript contents info)
2476 "Transcode a SUPERSCRIPT object from Org to LaTeX.
2477 CONTENTS is the contents of the object. INFO is a plist holding
2478 contextual information."
2479 (org-latex--script-size superscript info))
2482 ;;;; Table
2484 ;; `org-latex-table' is the entry point for table transcoding. It
2485 ;; takes care of tables with a "verbatim" mode. Otherwise, it
2486 ;; delegates the job to either `org-latex--table.el-table',
2487 ;; `org-latex--org-table' or `org-latex--math-table' functions,
2488 ;; depending of the type of the table and the mode requested.
2490 ;; `org-latex--align-string' is a subroutine used to build alignment
2491 ;; string for Org tables.
2493 (defun org-latex-table (table contents info)
2494 "Transcode a TABLE element from Org to LaTeX.
2495 CONTENTS is the contents of the table. INFO is a plist holding
2496 contextual information."
2497 (if (eq (org-element-property :type table) 'table.el)
2498 ;; "table.el" table. Convert it using appropriate tools.
2499 (org-latex--table.el-table table info)
2500 (let ((type (or (org-export-read-attribute :attr_latex table :mode)
2501 (plist-get info :latex-default-table-mode))))
2502 (cond
2503 ;; Case 1: Verbatim table.
2504 ((string= type "verbatim")
2505 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
2506 ;; Re-create table, without affiliated keywords.
2507 (org-trim (org-element-interpret-data
2508 `(table nil ,@(org-element-contents table))
2509 org-latex-pseudo-objects))))
2510 ;; Case 2: Matrix.
2511 ((or (string= type "math") (string= type "inline-math"))
2512 (org-latex--math-table table info))
2513 ;; Case 3: Standard table.
2514 (t (concat (org-latex--org-table table contents info)
2515 ;; When there are footnote references within the
2516 ;; table, insert their definition just after it.
2517 (org-latex--delayed-footnotes-definitions table info)))))))
2519 (defun org-latex--align-string (table info)
2520 "Return an appropriate LaTeX alignment string.
2521 TABLE is the considered table. INFO is a plist used as
2522 a communication channel."
2523 (or (org-export-read-attribute :attr_latex table :align)
2524 (let (align)
2525 ;; Extract column groups and alignment from first (non-rule)
2526 ;; row.
2527 (org-element-map
2528 (org-element-map table 'table-row
2529 (lambda (row)
2530 (and (eq (org-element-property :type row) 'standard) row))
2531 info 'first-match)
2532 'table-cell
2533 (lambda (cell)
2534 (let ((borders (org-export-table-cell-borders cell info)))
2535 ;; Check left border for the first cell only.
2536 (when (and (memq 'left borders) (not align))
2537 (push "|" align))
2538 (push (case (org-export-table-cell-alignment cell info)
2539 (left "l")
2540 (right "r")
2541 (center "c"))
2542 align)
2543 (when (memq 'right borders) (push "|" align))))
2544 info)
2545 (apply 'concat (nreverse align)))))
2547 (defun org-latex--org-table (table contents info)
2548 "Return appropriate LaTeX code for an Org table.
2550 TABLE is the table type element to transcode. CONTENTS is its
2551 contents, as a string. INFO is a plist used as a communication
2552 channel.
2554 This function assumes TABLE has `org' as its `:type' property and
2555 `table' as its `:mode' attribute."
2556 (let* ((caption (org-latex--caption/label-string table info))
2557 (attr (org-export-read-attribute :attr_latex table))
2558 ;; Determine alignment string.
2559 (alignment (org-latex--align-string table info))
2560 ;; Determine environment for the table: longtable, tabular...
2561 (table-env (or (plist-get attr :environment)
2562 (plist-get info :latex-default-table-environment)))
2563 ;; If table is a float, determine environment: table, table*
2564 ;; or sidewaystable.
2565 (float-env (unless (member table-env '("longtable" "longtabu"))
2566 (let ((float (plist-get attr :float)))
2567 (cond
2568 ((and (not float) (plist-member attr :float)) nil)
2569 ((or (string= float "sidewaystable")
2570 (string= float "sideways")) "sidewaystable")
2571 ((string= float "multicolumn") "table*")
2572 ((or float
2573 (org-element-property :caption table)
2574 (org-string-nw-p (plist-get attr :caption)))
2575 "table")))))
2576 ;; Extract others display options.
2577 (fontsize (let ((font (plist-get attr :font)))
2578 (and font (concat font "\n"))))
2579 (width (plist-get attr :width))
2580 (spreadp (plist-get attr :spread))
2581 (placement
2582 (or (plist-get attr :placement)
2583 (format "[%s]" (plist-get info :latex-default-figure-position))))
2584 (centerp (if (plist-member attr :center) (plist-get attr :center)
2585 (plist-get info :latex-tables-centered)))
2586 (caption-above-p (plist-get info :latex-table-caption-above)))
2587 ;; Prepare the final format string for the table.
2588 (cond
2589 ;; Longtable.
2590 ((equal "longtable" table-env)
2591 (concat (and fontsize (concat "{" fontsize))
2592 (format "\\begin{longtable}{%s}\n" alignment)
2593 (and caption-above-p
2594 (org-string-nw-p caption)
2595 (concat caption "\\\\\n"))
2596 contents
2597 (and (not caption-above-p)
2598 (org-string-nw-p caption)
2599 (concat caption "\\\\\n"))
2600 "\\end{longtable}\n"
2601 (and fontsize "}")))
2602 ;; Longtabu
2603 ((equal "longtabu" table-env)
2604 (concat (and fontsize (concat "{" fontsize))
2605 (format "\\begin{longtabu}%s{%s}\n"
2606 (if width
2607 (format " %s %s "
2608 (if spreadp "spread" "to") width) "")
2609 alignment)
2610 (and caption-above-p
2611 (org-string-nw-p caption)
2612 (concat caption "\\\\\n"))
2613 contents
2614 (and (not caption-above-p)
2615 (org-string-nw-p caption)
2616 (concat caption "\\\\\n"))
2617 "\\end{longtabu}\n"
2618 (and fontsize "}")))
2619 ;; Others.
2620 (t (concat (cond
2621 (float-env
2622 (concat (format "\\begin{%s}%s\n" float-env placement)
2623 (if caption-above-p caption "")
2624 (when centerp "\\centering\n")
2625 fontsize))
2626 (centerp (concat "\\begin{center}\n" fontsize))
2627 (fontsize (concat "{" fontsize)))
2628 (cond ((equal "tabu" table-env)
2629 (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
2630 (if width (format
2631 (if spreadp " spread %s " " to %s ")
2632 width) "")
2633 alignment
2634 contents))
2635 (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
2636 table-env
2637 (if width (format "{%s}" width) "")
2638 alignment
2639 contents
2640 table-env)))
2641 (cond
2642 (float-env
2643 (concat (if caption-above-p "" caption)
2644 (format "\n\\end{%s}" float-env)))
2645 (centerp "\n\\end{center}")
2646 (fontsize "}")))))))
2648 (defun org-latex--table.el-table (table info)
2649 "Return appropriate LaTeX code for a table.el table.
2651 TABLE is the table type element to transcode. INFO is a plist
2652 used as a communication channel.
2654 This function assumes TABLE has `table.el' as its `:type'
2655 property."
2656 (require 'table)
2657 ;; Ensure "*org-export-table*" buffer is empty.
2658 (with-current-buffer (get-buffer-create "*org-export-table*")
2659 (erase-buffer))
2660 (let ((output (with-temp-buffer
2661 (insert (org-element-property :value table))
2662 (goto-char 1)
2663 (re-search-forward "^[ \t]*|[^|]" nil t)
2664 (table-generate-source 'latex "*org-export-table*")
2665 (with-current-buffer "*org-export-table*"
2666 (org-trim (buffer-string))))))
2667 (kill-buffer (get-buffer "*org-export-table*"))
2668 ;; Remove left out comments.
2669 (while (string-match "^%.*\n" output)
2670 (setq output (replace-match "" t t output)))
2671 (let ((attr (org-export-read-attribute :attr_latex table)))
2672 (when (plist-get attr :rmlines)
2673 ;; When the "rmlines" attribute is provided, remove all hlines
2674 ;; but the the one separating heading from the table body.
2675 (let ((n 0) (pos 0))
2676 (while (and (< (length output) pos)
2677 (setq pos (string-match "^\\\\hline\n?" output pos)))
2678 (incf n)
2679 (unless (= n 2) (setq output (replace-match "" nil nil output))))))
2680 (let ((centerp (if (plist-member attr :center) (plist-get attr :center)
2681 (plist-get info :latex-tables-centered))))
2682 (if (not centerp) output
2683 (format "\\begin{center}\n%s\n\\end{center}" output))))))
2685 (defun org-latex--math-table (table info)
2686 "Return appropriate LaTeX code for a matrix.
2688 TABLE is the table type element to transcode. INFO is a plist
2689 used as a communication channel.
2691 This function assumes TABLE has `org' as its `:type' property and
2692 `inline-math' or `math' as its `:mode' attribute.."
2693 (let* ((caption (org-latex--caption/label-string table info))
2694 (attr (org-export-read-attribute :attr_latex table))
2695 (inlinep (equal (plist-get attr :mode) "inline-math"))
2696 (env (or (plist-get attr :environment)
2697 (plist-get info :latex-default-table-environment)))
2698 (contents
2699 (mapconcat
2700 (lambda (row)
2701 ;; Ignore horizontal rules.
2702 (when (eq (org-element-property :type row) 'standard)
2703 ;; Return each cell unmodified.
2704 (concat
2705 (mapconcat
2706 (lambda (cell)
2707 (substring
2708 (org-element-interpret-data cell org-latex-pseudo-objects)
2709 0 -1))
2710 (org-element-map row 'table-cell 'identity info) "&")
2711 (or (cdr (assoc env org-latex-table-matrix-macros)) "\\\\")
2712 "\n")))
2713 (org-element-map table 'table-row 'identity info) ""))
2714 ;; Variables related to math clusters (contiguous math tables
2715 ;; of the same type).
2716 (mode (org-export-read-attribute :attr_latex table :mode))
2717 (prev (org-export-get-previous-element table info))
2718 (next (org-export-get-next-element table info))
2719 (same-mode-p
2720 (lambda (table)
2721 ;; Non-nil when TABLE has the same mode as current table.
2722 (string= (or (org-export-read-attribute :attr_latex table :mode)
2723 (plist-get info :latex-default-table-mode))
2724 mode))))
2725 (concat
2726 ;; Opening string. If TABLE is in the middle of a table cluster,
2727 ;; do not insert any.
2728 (cond ((and prev
2729 (eq (org-element-type prev) 'table)
2730 (memq (org-element-property :post-blank prev) '(0 nil))
2731 (funcall same-mode-p prev))
2732 nil)
2733 (inlinep "\\(")
2734 ((org-string-nw-p caption) (concat "\\begin{equation}\n" caption))
2735 (t "\\["))
2736 ;; Prefix.
2737 (or (plist-get attr :math-prefix) "")
2738 ;; Environment. Also treat special cases.
2739 (cond ((equal env "array")
2740 (let ((align (org-latex--align-string table info)))
2741 (format "\\begin{array}{%s}\n%s\\end{array}" align contents)))
2742 ((assoc env org-latex-table-matrix-macros)
2743 (format "\\%s%s{\n%s}"
2745 (or (plist-get attr :math-arguments) "")
2746 contents))
2747 (t (format "\\begin{%s}\n%s\\end{%s}" env contents env)))
2748 ;; Suffix.
2749 (or (plist-get attr :math-suffix) "")
2750 ;; Closing string. If TABLE is in the middle of a table cluster,
2751 ;; do not insert any. If it closes such a cluster, be sure to
2752 ;; close the cluster with a string matching the opening string.
2753 (cond ((and next
2754 (eq (org-element-type next) 'table)
2755 (memq (org-element-property :post-blank table) '(0 nil))
2756 (funcall same-mode-p next))
2757 nil)
2758 (inlinep "\\)")
2759 ;; Find cluster beginning to know which environment to use.
2760 ((let ((cluster-beg table) prev)
2761 (while (and (setq prev (org-export-get-previous-element
2762 cluster-beg info))
2763 (memq (org-element-property :post-blank prev)
2764 '(0 nil))
2765 (funcall same-mode-p prev))
2766 (setq cluster-beg prev))
2767 (and (or (org-element-property :caption cluster-beg)
2768 (org-element-property :name cluster-beg))
2769 "\n\\end{equation}")))
2770 (t "\\]")))))
2773 ;;;; Table Cell
2775 (defun org-latex-table-cell (table-cell contents info)
2776 "Transcode a TABLE-CELL element from Org to LaTeX.
2777 CONTENTS is the cell contents. INFO is a plist used as
2778 a communication channel."
2779 (concat
2780 (let ((scientific-format (plist-get info :latex-table-scientific-notation)))
2781 (if (and contents
2782 scientific-format
2783 (string-match orgtbl-exp-regexp contents))
2784 ;; Use appropriate format string for scientific
2785 ;; notation.
2786 (format scientific-format
2787 (match-string 1 contents)
2788 (match-string 2 contents))
2789 contents))
2790 (when (org-export-get-next-element table-cell info) " & ")))
2793 ;;;; Table Row
2795 (defun org-latex-table-row (table-row contents info)
2796 "Transcode a TABLE-ROW element from Org to LaTeX.
2797 CONTENTS is the contents of the row. INFO is a plist used as
2798 a communication channel."
2799 (let* ((attr (org-export-read-attribute :attr_latex
2800 (org-export-get-parent table-row)))
2801 (booktabsp (if (plist-member attr :booktabs) (plist-get attr :booktabs)
2802 (plist-get info :latex-tables-booktabs)))
2803 (longtablep
2804 (member (or (plist-get attr :environment)
2805 (plist-get info :latex-default-table-environment))
2806 '("longtable" "longtabu"))))
2807 (if (eq (org-element-property :type table-row) 'rule)
2808 (cond
2809 ((not booktabsp) "\\hline")
2810 ((not (org-export-get-previous-element table-row info)) "\\toprule")
2811 ((not (org-export-get-next-element table-row info)) "\\bottomrule")
2812 ((and longtablep
2813 (org-export-table-row-ends-header-p
2814 (org-export-get-previous-element table-row info) info))
2816 (t "\\midrule"))
2817 (concat
2818 ;; When BOOKTABS are activated enforce top-rule even when no
2819 ;; hline was specifically marked.
2820 (and booktabsp (not (org-export-get-previous-element table-row info))
2821 "\\toprule\n")
2822 contents "\\\\\n"
2823 (cond
2824 ;; Special case for long tables. Define header and footers.
2825 ((and longtablep (org-export-table-row-ends-header-p table-row info))
2826 (let ((columns (cdr (org-export-table-dimensions
2827 (org-export-get-parent-table table-row) info))))
2828 (format "%s
2829 \\endfirsthead
2830 \\multicolumn{%d}{l}{%s} \\\\
2832 %s \\\\\n
2834 \\endhead
2835 %s\\multicolumn{%d}{r}{%s} \\\\
2836 \\endfoot
2837 \\endlastfoot"
2838 (if booktabsp "\\midrule" "\\hline")
2839 columns
2840 (org-latex--translate "Continued from previous page" info)
2841 (cond
2842 ((not (org-export-table-row-starts-header-p table-row info))
2844 (booktabsp "\\toprule\n")
2845 (t "\\hline\n"))
2846 contents
2847 (if booktabsp "\\midrule" "\\hline")
2848 (if booktabsp "\\midrule" "\\hline")
2849 columns
2850 (org-latex--translate "Continued on next page" info))))
2851 ;; When BOOKTABS are activated enforce bottom rule even when
2852 ;; no hline was specifically marked.
2853 ((and booktabsp (not (org-export-get-next-element table-row info)))
2854 "\\bottomrule"))))))
2857 ;;;; Target
2859 (defun org-latex-target (target contents info)
2860 "Transcode a TARGET object from Org to LaTeX.
2861 CONTENTS is nil. INFO is a plist holding contextual
2862 information."
2863 (format "\\label{%s}"
2864 (org-export-solidify-link-text (org-element-property :value target))))
2867 ;;;; Timestamp
2869 (defun org-latex-timestamp (timestamp contents info)
2870 "Transcode a TIMESTAMP object from Org to LaTeX.
2871 CONTENTS is nil. INFO is a plist holding contextual
2872 information."
2873 (let ((value (org-latex-plain-text (org-timestamp-translate timestamp) info)))
2874 (format
2875 (plist-get info
2876 (case (org-element-property :type timestamp)
2877 ((active active-range) :latex-active-timestamp-format)
2878 ((inactive inactive-range) :latex-inactive-timestamp-format)
2879 (otherwise :latex-diary-timestamp-format)))
2880 value)))
2883 ;;;; Underline
2885 (defun org-latex-underline (underline contents info)
2886 "Transcode UNDERLINE from Org to LaTeX.
2887 CONTENTS is the text with underline markup. INFO is a plist
2888 holding contextual information."
2889 (org-latex--text-markup contents 'underline info))
2892 ;;;; Verbatim
2894 (defun org-latex-verbatim (verbatim contents info)
2895 "Transcode a VERBATIM object from Org to LaTeX.
2896 CONTENTS is nil. INFO is a plist used as a communication
2897 channel."
2898 (org-latex--text-markup
2899 (org-element-property :value verbatim) 'verbatim info))
2902 ;;;; Verse Block
2904 (defun org-latex-verse-block (verse-block contents info)
2905 "Transcode a VERSE-BLOCK element from Org to LaTeX.
2906 CONTENTS is verse block contents. INFO is a plist holding
2907 contextual information."
2908 (org-latex--wrap-label
2909 verse-block
2910 ;; In a verse environment, add a line break to each newline
2911 ;; character and change each white space at beginning of a line
2912 ;; into a space of 1 em. Also change each blank line with
2913 ;; a vertical space of 1 em.
2914 (format "\\begin{verse}\n%s\\end{verse}"
2915 (replace-regexp-in-string
2916 "^[ \t]+" (lambda (m) (format "\\hspace*{%dem}" (length m)))
2917 (replace-regexp-in-string
2918 "^[ \t]*\\\\\\\\$" "\\vspace*{1em}"
2919 (replace-regexp-in-string
2920 "\\([ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n"
2921 contents nil t) nil t) nil t))))
2925 ;;; End-user functions
2927 ;;;###autoload
2928 (defun org-latex-export-as-latex
2929 (&optional async subtreep visible-only body-only ext-plist)
2930 "Export current buffer as a LaTeX buffer.
2932 If narrowing is active in the current buffer, only export its
2933 narrowed part.
2935 If a region is active, export that region.
2937 A non-nil optional argument ASYNC means the process should happen
2938 asynchronously. The resulting buffer should be accessible
2939 through the `org-export-stack' interface.
2941 When optional argument SUBTREEP is non-nil, export the sub-tree
2942 at point, extracting information from the headline properties
2943 first.
2945 When optional argument VISIBLE-ONLY is non-nil, don't export
2946 contents of hidden elements.
2948 When optional argument BODY-ONLY is non-nil, only write code
2949 between \"\\begin{document}\" and \"\\end{document}\".
2951 EXT-PLIST, when provided, is a property list with external
2952 parameters overriding Org default settings, but still inferior to
2953 file-local settings.
2955 Export is done in a buffer named \"*Org LATEX Export*\", which
2956 will be displayed when `org-export-show-temporary-export-buffer'
2957 is non-nil."
2958 (interactive)
2959 (org-export-to-buffer 'latex "*Org LATEX Export*"
2960 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
2962 ;;;###autoload
2963 (defun org-latex-convert-region-to-latex ()
2964 "Assume the current region has org-mode syntax, and convert it to LaTeX.
2965 This can be used in any buffer. For example, you can write an
2966 itemized list in org-mode syntax in an LaTeX buffer and use this
2967 command to convert it."
2968 (interactive)
2969 (org-export-replace-region-by 'latex))
2971 ;;;###autoload
2972 (defun org-latex-export-to-latex
2973 (&optional async subtreep visible-only body-only ext-plist)
2974 "Export current buffer to a LaTeX file.
2976 If narrowing is active in the current buffer, only export its
2977 narrowed part.
2979 If a region is active, export that region.
2981 A non-nil optional argument ASYNC means the process should happen
2982 asynchronously. The resulting file should be accessible through
2983 the `org-export-stack' interface.
2985 When optional argument SUBTREEP is non-nil, export the sub-tree
2986 at point, extracting information from the headline properties
2987 first.
2989 When optional argument VISIBLE-ONLY is non-nil, don't export
2990 contents of hidden elements.
2992 When optional argument BODY-ONLY is non-nil, only write code
2993 between \"\\begin{document}\" and \"\\end{document}\".
2995 EXT-PLIST, when provided, is a property list with external
2996 parameters overriding Org default settings, but still inferior to
2997 file-local settings."
2998 (interactive)
2999 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
3000 (org-export-to-file 'latex outfile
3001 async subtreep visible-only body-only ext-plist)))
3003 ;;;###autoload
3004 (defun org-latex-export-to-pdf
3005 (&optional async subtreep visible-only body-only ext-plist)
3006 "Export current buffer to LaTeX then process through to PDF.
3008 If narrowing is active in the current buffer, only export its
3009 narrowed part.
3011 If a region is active, export that region.
3013 A non-nil optional argument ASYNC means the process should happen
3014 asynchronously. The resulting file should be accessible through
3015 the `org-export-stack' interface.
3017 When optional argument SUBTREEP is non-nil, export the sub-tree
3018 at point, extracting information from the headline properties
3019 first.
3021 When optional argument VISIBLE-ONLY is non-nil, don't export
3022 contents of hidden elements.
3024 When optional argument BODY-ONLY is non-nil, only write code
3025 between \"\\begin{document}\" and \"\\end{document}\".
3027 EXT-PLIST, when provided, is a property list with external
3028 parameters overriding Org default settings, but still inferior to
3029 file-local settings.
3031 Return PDF file's name."
3032 (interactive)
3033 (let ((outfile (org-export-output-file-name ".tex" subtreep)))
3034 (org-export-to-file 'latex outfile
3035 async subtreep visible-only body-only ext-plist
3036 (lambda (file) (org-latex-compile file)))))
3038 (defun org-latex-compile (texfile &optional snippet)
3039 "Compile a TeX file.
3041 TEXFILE is the name of the file being compiled. Processing is
3042 done through the command specified in `org-latex-pdf-process'.
3044 When optional argument SNIPPET is non-nil, TEXFILE is a temporary
3045 file used to preview a LaTeX snippet. In this case, do not
3046 create a log buffer and do not bother removing log files.
3048 Return PDF file name or an error if it couldn't be produced."
3049 (let* ((base-name (file-name-sans-extension (file-name-nondirectory texfile)))
3050 (full-name (file-truename texfile))
3051 (out-dir (file-name-directory texfile))
3052 ;; Properly set working directory for compilation.
3053 (default-directory (if (file-name-absolute-p texfile)
3054 (file-name-directory full-name)
3055 default-directory))
3056 (time (current-time))
3057 warnings)
3058 (unless snippet (message (format "Processing LaTeX file %s..." texfile)))
3059 (save-window-excursion
3060 (cond
3061 ;; A function is provided: Apply it.
3062 ((functionp org-latex-pdf-process)
3063 (funcall org-latex-pdf-process (shell-quote-argument texfile)))
3064 ;; A list is provided: Replace %b, %f and %o with appropriate
3065 ;; values in each command before applying it. Output is
3066 ;; redirected to "*Org PDF LaTeX Output*" buffer.
3067 ((consp org-latex-pdf-process)
3068 (let ((outbuf (and (not snippet)
3069 (get-buffer-create "*Org PDF LaTeX Output*"))))
3070 (dolist (command org-latex-pdf-process)
3071 (shell-command
3072 (replace-regexp-in-string
3073 "%b" (shell-quote-argument base-name)
3074 (replace-regexp-in-string
3075 "%f" (shell-quote-argument full-name)
3076 (replace-regexp-in-string
3077 "%o" (shell-quote-argument out-dir) command t t) t t) t t)
3078 outbuf))
3079 ;; Collect standard errors from output buffer.
3080 (setq warnings (and (not snippet)
3081 (org-latex--collect-warnings outbuf)))))
3082 (t (error "No valid command to process to PDF")))
3083 (let ((pdffile (concat out-dir base-name ".pdf")))
3084 ;; Check for process failure. Provide collected errors if
3085 ;; possible.
3086 (if (or (not (file-exists-p pdffile))
3087 (time-less-p (nth 5 (file-attributes pdffile)) time))
3088 (error (format "PDF file %s wasn't produced" pdffile))
3089 ;; Else remove log files, when specified, and signal end of
3090 ;; process to user, along with any error encountered.
3091 (when (and (not snippet) org-latex-remove-logfiles)
3092 (dolist (file (directory-files
3093 out-dir t
3094 (concat (regexp-quote base-name)
3095 "\\(?:\\.[0-9]+\\)?"
3096 "\\."
3097 (regexp-opt org-latex-logfiles-extensions))))
3098 (delete-file file)))
3099 (message (concat "PDF file produced"
3100 (cond
3101 ((eq warnings 'error) " with errors.")
3102 (warnings (concat " with warnings: " warnings))
3103 (t ".")))))
3104 ;; Return output file name.
3105 pdffile))))
3107 (defun org-latex--collect-warnings (buffer)
3108 "Collect some warnings from \"pdflatex\" command output.
3109 BUFFER is the buffer containing output. Return collected
3110 warnings types as a string, `error' if a LaTeX error was
3111 encountered or nil if there was none."
3112 (with-current-buffer buffer
3113 (save-excursion
3114 (goto-char (point-max))
3115 (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t)
3116 (if (re-search-forward "^!" nil t) 'error
3117 (let ((case-fold-search t)
3118 (warnings ""))
3119 (dolist (warning org-latex-known-warnings)
3120 (when (save-excursion (re-search-forward (car warning) nil t))
3121 (setq warnings (concat warnings " " (cdr warning)))))
3122 (org-string-nw-p (org-trim warnings))))))))
3124 ;;;###autoload
3125 (defun org-latex-publish-to-latex (plist filename pub-dir)
3126 "Publish an Org file to LaTeX.
3128 FILENAME is the filename of the Org file to be published. PLIST
3129 is the property list for the given project. PUB-DIR is the
3130 publishing directory.
3132 Return output file name."
3133 (org-publish-org-to 'latex filename ".tex" plist pub-dir))
3135 ;;;###autoload
3136 (defun org-latex-publish-to-pdf (plist filename pub-dir)
3137 "Publish an Org file to PDF (via LaTeX).
3139 FILENAME is the filename of the Org file to be published. PLIST
3140 is the property list for the given project. PUB-DIR is the
3141 publishing directory.
3143 Return output file name."
3144 ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
3145 ;; in working directory and then moved to publishing directory.
3146 (org-publish-attachment
3147 plist
3148 (org-latex-compile
3149 (org-publish-org-to
3150 'latex filename ".tex" plist (file-name-directory filename)))
3151 pub-dir))
3154 (provide 'ox-latex)
3156 ;; Local variables:
3157 ;; generated-autoload-file: "org-loaddefs.el"
3158 ;; End:
3160 ;;; ox-latex.el ends here