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/>.
25 ;; See Org manual for details.
29 (eval-when-compile (require 'cl
))
33 (defvar org-latex-default-packages-alist
)
34 (defvar org-latex-packages-alist
)
35 (defvar orgtbl-exp-regexp
)
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
)
93 (latex-math-block . org-latex-math-block
))
94 :export-block
'("LATEX" "TEX")
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"
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
))
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
)
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")
152 ("bt-br" .
"brazilian")
158 ("de-at" .
"naustrian")
159 ("de-de" .
"ngerman")
162 ("en-au" .
"australian")
163 ("en-ca" .
"canadian")
164 ("en-gb" .
"british")
166 ("en-nz" .
"newzealand")
167 ("en-us" .
"american")
173 ("fr-ca" .
"canadien")
177 ("id" .
"indonesian")
187 ("pt" .
"portuguese")
191 ("sb" .
"uppersorbian")
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"
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
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}"))
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}"))
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:
255 \(numbered-section . unnumbered-section)
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
288 \\documentclass{article}
289 [NO-DEFAULT-PACKAGES]
291 \\providecommand{\\alert}[1]{\\textbf{#1}}
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}\"
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
339 (list (string :tag
"LaTeX class")
340 (string :tag
"LaTeX header")
341 (repeat :tag
"Levels" :inline t
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
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
372 :group
'org-export-latex
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
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:
389 %d for DESCRIPTION line
392 Set it to the empty string to ignore the command completely."
393 :group
'org-export-latex
395 :package-version
'(Org .
"8.3")
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
415 :package-version
'(Org .
"8.0")
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:
442 This is section [[#sec:foo]].
444 And this is still section \\ref{sec:foo}.
447 will be exported to LaTeX as:
449 \\subsection{Some section}
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
470 :package-version
'(Org .
"8.3"))
474 (defcustom org-latex-footnote-separator
"\\textsuperscript{,}\\,"
475 "Text used to separate footnotes."
476 :group
'org-export-latex
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
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
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
500 (defcustom org-latex-image-default-option
""
501 "Default option for images."
502 :group
'org-export-latex
504 :package-version
'(Org .
"8.0")
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
512 :package-version
'(Org .
"8.0")
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\"
520 :group
'org-export-latex
522 :package-version
'(Org .
"8.0")
525 (defcustom org-latex-default-figure-position
"htb"
526 "Default position for latex figures."
527 :group
'org-export-latex
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
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
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
557 (defcustom org-latex-default-table-environment
"tabular"
558 "Default environment used to build tables."
559 :group
'org-export-latex
561 :package-version
'(Org .
"8.0")
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
584 When modifying this variable, it may be useful to change
585 `org-latex-default-table-environment' accordingly."
586 :group
'org-export-latex
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
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
607 :group
'org-export-latex
609 :package-version
'(Org .
"8.0")
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
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
628 :package-version
'(Org .
"8.0")
630 (string :tag
"Format string")
631 (const :tag
"No formatting" nil
)))
635 (defcustom org-latex-text-markup-alist
'((bold .
"\\textbf{%s}")
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
655 :group
'org-export-latex
657 :options
'(bold code italic strike-through underline verbatim
))
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
675 :package-version
'(Org .
"8.3")
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
698 :package-version
'(Org .
"8.3"))
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:
713 \(add-to-list 'org-latex-packages-alist '(\"\" \"listings\"))
714 \(add-to-list 'org-latex-packages-alist '(\"\" \"color\"))
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
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
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
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")
749 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
750 (html "HTML") (xml "XML")
751 (tex "TeX") (latex "[LaTeX]TeX")
752 (shell-script "bash")
754 (ocaml "Caml") (caml "Caml")
755 (sql "SQL") (sqlite "sql")
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
765 :package-version
'(Org .
"8.3")
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
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
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
790 #+ATTR_LATEX: :options key1=value1,key2=value2
794 :group
'org-export-latex
797 (string :tag
"Listings option name ")
798 (string :tag
"Listings option value"))))
800 (defcustom org-latex-minted-langs
801 '((emacs-lisp "common-lisp")
804 (shell-script "bash")
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
817 pygmentize -L lexers"
818 :group
'org-export-latex
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
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
847 :group
'org-export-latex
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
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
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
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"
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"
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"))
936 ("rubber -d --into %o %f"))
937 (const :tag
"latexmk"
938 ("latexmk -g -pdf %f"))
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
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
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
971 :package-version
'(Org .
"8.3")
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
)))
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
)
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
)))
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
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
1044 (if (or (not (stringp language-code
))
1045 (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" 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.
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
))))
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
1075 (mapconcat (lambda (pair)
1076 (concat (first pair
)
1077 (when (> (length (second pair
)) 0)
1078 (concat "=" (second pair
)))))
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 "\\label{%s}\n" (org-export-solidify-link-text label
))
1091 (defun org-latex--text-markup (text markup info
)
1092 "Format TEXT depending on MARKUP text markup.
1093 INFO is a plist used as a communication channel. See
1094 `org-latex-text-markup-alist' for details."
1095 (let ((fmt (cdr (assq markup
(plist-get info
:latex-text-markup-alist
)))))
1097 ;; No format string: Return raw text.
1099 ;; Handle the `verb' special case: Find an appropriate separator
1100 ;; and use "\\verb" command.
1102 (let ((separator (org-latex--find-verb-separator text
)))
1103 (concat "\\verb" separator
1104 (replace-regexp-in-string "\n" " " text
)
1106 ;; Handle the `protectedtexttt' special case: Protect some
1107 ;; special chars and use "\texttt{%s}" format string.
1108 ((eq 'protectedtexttt fmt
)
1110 (trans '(("\\" .
"\\textbackslash{}")
1111 ("~" .
"\\textasciitilde{}")
1112 ("^" .
"\\textasciicircum{}")))
1115 (while (string-match "[\\{}$%&_#~^]" text
)
1116 (setq char
(match-string 0 text
))
1117 (if (> (match-beginning 0) 0)
1118 (setq rtn
(concat rtn
(substring text
0 (match-beginning 0)))))
1119 (setq text
(substring text
(1+ (match-beginning 0))))
1120 (setq char
(or (cdr (assoc char trans
)) (concat "\\" char
))
1121 rtn
(concat rtn char
)))
1122 (setq text
(concat rtn text
)
1124 (while (string-match "--" text
)
1125 (setq text
(replace-match "-{}-" t t text
)))
1127 ;; Else use format string.
1128 (t (format fmt text
)))))
1130 (defun org-latex--delayed-footnotes-definitions (element info
)
1131 "Return footnotes definitions in ELEMENT as a string.
1133 INFO is a plist used as a communication channel.
1135 Footnotes definitions are returned within \"\\footnotetxt{}\"
1138 This function is used within constructs that don't support
1139 \"\\footnote{}\" command (i.e. an item's tag). In that case,
1140 \"\\footnotemark\" is used within the construct and the function
1141 just outside of it."
1145 "\\footnotetext[%s]{%s}"
1146 (org-export-get-footnote-number ref info
)
1149 (org-export-get-footnote-definition ref info
) info
))))
1150 ;; Find every footnote reference in ELEMENT.
1152 search-refs
; For byte-compiler.
1156 ;; Return a list of all footnote references never seen
1158 (org-element-map data
'footnote-reference
1160 (when (org-export-footnote-first-reference-p ref info
)
1162 (when (eq (org-element-property :type ref
) 'standard
)
1163 (funcall search-refs
1164 (org-export-get-footnote-definition ref info
)))))
1166 (reverse all-refs
)))))
1167 (funcall search-refs element
))
1170 (defun org-latex--translate (s info
)
1171 "Translate string S according to specified language.
1172 INFO is a plist used as a communication channel."
1173 (org-export-translate s
:latex info
))
1179 (defun org-latex-template (contents info
)
1180 "Return complete document string after LaTeX conversion.
1181 CONTENTS is the transcoded contents string. INFO is a plist
1182 holding export options."
1183 (let ((title (org-export-data (plist-get info
:title
) info
)))
1186 (and (plist-get info
:time-stamp-file
)
1187 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1188 ;; Document class and packages.
1189 (let* ((class (plist-get info
:latex-class
))
1190 (class-options (plist-get info
:latex-class-options
))
1191 (header (nth 1 (assoc class
(plist-get info
:latex-classes
))))
1192 (document-class-string
1193 (and (stringp header
)
1194 (if (not class-options
) header
1195 (replace-regexp-in-string
1196 "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
1197 class-options header t nil
1)))))
1198 (if (not document-class-string
)
1199 (user-error "Unknown LaTeX class `%s'" class
)
1200 (org-latex-guess-babel-language
1201 (org-latex-guess-inputenc
1202 (org-element-normalize-string
1203 (org-splice-latex-header
1204 document-class-string
1205 org-latex-default-packages-alist
1206 org-latex-packages-alist nil
1207 (concat (org-element-normalize-string
1208 (plist-get info
:latex-header
))
1209 (plist-get info
:latex-header-extra
)))))
1211 ;; Possibly limit depth for headline numbering.
1212 (let ((sec-num (plist-get info
:section-numbers
)))
1213 (when (integerp sec-num
)
1214 (format "\\setcounter{secnumdepth}{%d}\n" sec-num
)))
1216 (let ((author (and (plist-get info
:with-author
)
1217 (let ((auth (plist-get info
:author
)))
1218 (and auth
(org-export-data auth info
)))))
1219 (email (and (plist-get info
:with-email
)
1220 (org-export-data (plist-get info
:email
) info
))))
1221 (cond ((and author email
(not (string= "" email
)))
1222 (format "\\author{%s\\thanks{%s}}\n" author email
))
1223 ((or author email
) (format "\\author{%s}\n" (or author email
)))))
1225 (let ((date (and (plist-get info
:with-date
) (org-export-get-date info
))))
1226 (format "\\date{%s}\n" (org-export-data date info
)))
1228 (format "\\title{%s}\n" title
)
1229 ;; Hyperref options.
1230 (format-spec (plist-get info
:latex-hyperref-template
)
1232 ?k
(or (plist-get info
:keywords
) "")
1233 ?d
(or (plist-get info
:description
)"")
1234 ?c
(if (plist-get info
:with-creator
)
1235 (plist-get info
:creator
)
1238 "\\begin{document}\n\n"
1240 (let ((command (plist-get info
:latex-title-command
)))
1241 (org-element-normalize-string
1242 (cond ((string= "" title
) nil
)
1243 ((not (stringp command
)) nil
)
1244 ((string-match "\\(?:[^%]\\|^\\)%s" command
)
1245 (format command title
))
1247 ;; Table of contents.
1248 (let ((depth (plist-get info
:with-toc
)))
1250 (concat (when (wholenump depth
)
1251 (format "\\setcounter{tocdepth}{%d}\n" depth
))
1252 (plist-get info
:latex-toc-command
))))
1256 (let ((creator-info (plist-get info
:with-creator
)))
1258 ((not creator-info
) "")
1259 ((eq creator-info
'comment
)
1260 (format "%% %s\n" (plist-get info
:creator
)))
1261 (t (concat (plist-get info
:creator
) "\n"))))
1263 "\\end{document}")))
1267 ;;; Transcode Functions
1271 (defun org-latex-bold (bold contents info
)
1272 "Transcode BOLD from Org to LaTeX.
1273 CONTENTS is the text with bold markup. INFO is a plist holding
1274 contextual information."
1275 (org-latex--text-markup contents
'bold info
))
1280 (defun org-latex-center-block (center-block contents info
)
1281 "Transcode a CENTER-BLOCK element from Org to LaTeX.
1282 CONTENTS holds the contents of the center block. INFO is a plist
1283 holding contextual information."
1284 (org-latex--wrap-label
1286 (format "\\begin{center}\n%s\\end{center}" contents
)))
1291 (defun org-latex-clock (clock contents info
)
1292 "Transcode a CLOCK element from Org to LaTeX.
1293 CONTENTS is nil. INFO is a plist holding contextual
1297 (format "\\textbf{%s} " org-clock-string
)
1298 (format (plist-get info
:latex-inactive-timestamp-format
)
1299 (concat (org-translate-time
1300 (org-element-property :raw-value
1301 (org-element-property :value clock
)))
1302 (let ((time (org-element-property :duration clock
)))
1303 (and time
(format " (%s)" time
)))))
1309 (defun org-latex-code (code contents info
)
1310 "Transcode a CODE object from Org to LaTeX.
1311 CONTENTS is nil. INFO is a plist used as a communication
1313 (org-latex--text-markup (org-element-property :value code
) 'code info
))
1318 (defun org-latex-drawer (drawer contents info
)
1319 "Transcode a DRAWER element from Org to LaTeX.
1320 CONTENTS holds the contents of the block. INFO is a plist
1321 holding contextual information."
1322 (let* ((name (org-element-property :drawer-name drawer
))
1323 (output (funcall (plist-get info
:latex-format-drawer-function
)
1325 (org-latex--wrap-label drawer output
)))
1330 (defun org-latex-dynamic-block (dynamic-block contents info
)
1331 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
1332 CONTENTS holds the contents of the block. INFO is a plist
1333 holding contextual information. See `org-export-data'."
1334 (org-latex--wrap-label dynamic-block contents
))
1339 (defun org-latex-entity (entity contents info
)
1340 "Transcode an ENTITY object from Org to LaTeX.
1341 CONTENTS are the definition itself. INFO is a plist holding
1342 contextual information."
1343 (org-element-property :latex entity
))
1348 (defun org-latex-example-block (example-block contents info
)
1349 "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
1350 CONTENTS is nil. INFO is a plist holding contextual
1352 (when (org-string-nw-p (org-element-property :value example-block
))
1353 (org-latex--wrap-label
1355 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1356 (org-export-format-code-default example-block info
)))))
1361 (defun org-latex-export-block (export-block contents info
)
1362 "Transcode a EXPORT-BLOCK element from Org to LaTeX.
1363 CONTENTS is nil. INFO is a plist holding contextual information."
1364 (when (member (org-element-property :type export-block
) '("LATEX" "TEX"))
1365 (org-remove-indentation (org-element-property :value export-block
))))
1370 (defun org-latex-export-snippet (export-snippet contents info
)
1371 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
1372 CONTENTS is nil. INFO is a plist holding contextual information."
1373 (when (eq (org-export-snippet-backend export-snippet
) 'latex
)
1374 (org-element-property :value export-snippet
)))
1379 (defun org-latex-fixed-width (fixed-width contents info
)
1380 "Transcode a FIXED-WIDTH element from Org to LaTeX.
1381 CONTENTS is nil. INFO is a plist holding contextual information."
1382 (org-latex--wrap-label
1384 (format "\\begin{verbatim}\n%s\\end{verbatim}"
1385 (org-remove-indentation
1386 (org-element-property :value fixed-width
)))))
1389 ;;;; Footnote Reference
1391 (defun org-latex-footnote-reference (footnote-reference contents info
)
1392 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1393 CONTENTS is nil. INFO is a plist holding contextual information."
1395 ;; Insert separator between two footnotes in a row.
1396 (let ((prev (org-export-get-previous-element footnote-reference info
)))
1397 (when (eq (org-element-type prev
) 'footnote-reference
)
1398 (plist-get info
:latex-footnote-separator
)))
1400 ;; Use \footnotemark if the footnote has already been defined.
1401 ((not (org-export-footnote-first-reference-p footnote-reference info
))
1402 (format "\\footnotemark[%s]{}"
1403 (org-export-get-footnote-number footnote-reference info
)))
1404 ;; Use \footnotemark if reference is within another footnote
1405 ;; reference, footnote definition or table cell.
1406 ((loop for parent in
(org-export-get-genealogy footnote-reference
)
1407 thereis
(memq (org-element-type parent
)
1408 '(footnote-reference footnote-definition table-cell
)))
1410 ;; Otherwise, define it with \footnote command.
1412 (let ((def (org-export-get-footnote-definition footnote-reference info
)))
1414 (format "\\footnote{%s}" (org-trim (org-export-data def info
)))
1415 ;; Retrieve all footnote references within the footnote and
1416 ;; add their definition after it, since LaTeX doesn't support
1418 (org-latex--delayed-footnotes-definitions def info
)))))))
1423 (defun org-latex-headline (headline contents info
)
1424 "Transcode a HEADLINE element from Org to LaTeX.
1425 CONTENTS holds the contents of the headline. INFO is a plist
1426 holding contextual information."
1427 (unless (org-element-property :footnote-section-p headline
)
1428 (let* ((class (plist-get info
:latex-class
))
1429 (level (org-export-get-relative-level headline info
))
1430 (numberedp (org-export-numbered-headline-p headline info
))
1431 (class-sectioning (assoc class
(plist-get info
:latex-classes
)))
1432 ;; Section formatting will set two placeholders: one for
1433 ;; the title and the other for the contents.
1435 (let ((sec (if (functionp (nth 2 class-sectioning
))
1436 (funcall (nth 2 class-sectioning
) level numberedp
)
1437 (nth (1+ level
) class-sectioning
))))
1439 ;; No section available for that LEVEL.
1441 ;; Section format directly returned by a function. Add
1442 ;; placeholder for contents.
1443 ((stringp sec
) (concat sec
"\n%s"))
1444 ;; (numbered-section . unnumbered-section)
1445 ((not (consp (cdr sec
)))
1446 (concat (funcall (if numberedp
#'car
#'cdr
) sec
) "\n%s"))
1447 ;; (numbered-open numbered-close)
1449 (when numberedp
(concat (car sec
) "\n%s" (nth 1 sec
))))
1450 ;; (num-in num-out no-num-in no-num-out)
1452 (if numberedp
(concat (car sec
) "\n%s" (nth 1 sec
))
1453 (concat (nth 2 sec
) "\n%s" (nth 3 sec
)))))))
1454 ;; Create a temporary export back-end that hard-codes
1455 ;; "\underline" within "\section" and alike.
1457 (org-export-create-backend
1460 '((underline .
(lambda (o c i
) (format "\\underline{%s}" c
))))))
1462 (org-export-data-with-backend
1463 (org-element-property :title headline
) section-back-end info
))
1465 (and (plist-get info
:with-todo-keywords
)
1466 (let ((todo (org-element-property :todo-keyword headline
)))
1467 (and todo
(org-export-data todo info
)))))
1468 (todo-type (and todo
(org-element-property :todo-type headline
)))
1469 (tags (and (plist-get info
:with-tags
)
1470 (org-export-get-tags headline info
)))
1471 (priority (and (plist-get info
:with-priority
)
1472 (org-element-property :priority headline
)))
1473 ;; Create the headline text along with a no-tag version.
1474 ;; The latter is required to remove tags from toc.
1475 (full-text (funcall (plist-get info
:latex-format-headline-function
)
1476 todo todo-type priority text tags info
))
1477 ;; Associate \label to the headline for internal links.
1480 (and (plist-get info
:latex-custom-id-labels
)
1481 (org-element-property :CUSTOM_ID headline
))))
1482 (if custom-label
(format "\\label{%s}\n" custom-label
)
1483 (format "\\label{sec-%s}\n"
1486 (org-export-get-headline-number headline info
)
1489 (make-string (org-element-property :pre-blank headline
) 10)))
1490 (if (or (not section-fmt
) (org-export-low-level-p headline info
))
1491 ;; This is a deep sub-tree: export it as a list item. Also
1492 ;; export as items headlines for which no section format has
1494 (let ((low-level-body
1496 ;; If headline is the first sibling, start a list.
1497 (when (org-export-first-sibling-p headline info
)
1498 (format "\\begin{%s}\n" (if numberedp
'enumerate
'itemize
)))
1501 (and full-text
(org-string-match-p "\\`[ \t]*\\[" full-text
)
1507 ;; If headline is not the last sibling simply return
1508 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
1510 (if (not (org-export-last-sibling-p headline info
)) low-level-body
1511 (replace-regexp-in-string
1513 (format "\n\\\\end{%s}" (if numberedp
'enumerate
'itemize
))
1515 ;; This is a standard headline. Export it as a section. Add
1516 ;; an alternative heading when possible, and when this is not
1517 ;; identical to the usual heading.
1519 (funcall (plist-get info
:latex-format-headline-function
)
1520 todo todo-type priority
1521 (org-export-data-with-backend
1522 (org-export-get-alt-title headline info
)
1523 section-back-end info
)
1524 (and (eq (plist-get info
:with-tags
) t
) tags
)
1526 (if (and numberedp opt-title
1527 (not (equal opt-title full-text
))
1528 (string-match "\\`\\\\\\(.*?[^*]\\){" section-fmt
))
1529 (format (replace-match "\\1[%s]" nil nil section-fmt
1)
1530 ;; Replace square brackets with parenthesis
1531 ;; since square brackets are not supported in
1532 ;; optional arguments.
1533 (replace-regexp-in-string
1534 "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title
))
1536 (concat headline-label pre-blanks contents
))
1537 ;; Impossible to add an alternative heading. Fallback to
1538 ;; regular sectioning format string.
1539 (format section-fmt full-text
1540 (concat headline-label pre-blanks contents
))))))))
1542 (defun org-latex-format-headline-default-function
1543 (todo todo-type priority text tags info
)
1544 "Default format function for a headline.
1545 See `org-latex-format-headline-function' for details."
1547 (and todo
(format "{\\bfseries\\sffamily %s} " todo
))
1548 (and priority
(format "\\framebox{\\#%c} " priority
))
1551 (format "\\hfill{}\\textsc{%s}"
1552 (mapconcat (lambda (tag) (org-latex-plain-text tag info
))
1556 ;;;; Horizontal Rule
1558 (defun org-latex-horizontal-rule (horizontal-rule contents info
)
1559 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
1560 CONTENTS is nil. INFO is a plist holding contextual information."
1561 (let ((attr (org-export-read-attribute :attr_latex horizontal-rule
))
1562 (prev (org-export-get-previous-element horizontal-rule info
)))
1564 ;; Make sure the rule doesn't start at the end of the current
1565 ;; line by separating it with a blank line from previous element.
1567 (let ((prev-blank (org-element-property :post-blank prev
)))
1568 (or (not prev-blank
) (zerop prev-blank
))))
1570 (org-latex--wrap-label
1572 (format "\\rule{%s}{%s}"
1573 (or (plist-get attr
:width
) "\\linewidth")
1574 (or (plist-get attr
:thickness
) "0.5pt"))))))
1577 ;;;; Inline Src Block
1579 (defun org-latex-inline-src-block (inline-src-block contents info
)
1580 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
1581 CONTENTS holds the contents of the item. INFO is a plist holding
1582 contextual information."
1583 (let* ((code (org-element-property :value inline-src-block
))
1584 (separator (org-latex--find-verb-separator code
)))
1585 (case (plist-get info
:latex-listings
)
1586 ;; Do not use a special package: transcode it verbatim.
1587 ((nil) (concat "\\verb" separator code separator
))
1588 ;; Use minted package.
1590 (let* ((org-lang (org-element-property :language inline-src-block
))
1591 (mint-lang (or (cadr (assq (intern org-lang
)
1592 (plist-get info
:latex-minted-langs
)))
1593 (downcase org-lang
)))
1594 (options (org-latex--make-option-string
1595 (plist-get info
:latex-minted-options
))))
1596 (concat (format "\\mint%s{%s}"
1597 (if (string= options
"") "" (format "[%s]" options
))
1599 separator code separator
)))
1600 ;; Use listings package.
1602 ;; Maybe translate language's name.
1603 (let* ((org-lang (org-element-property :language inline-src-block
))
1604 (lst-lang (or (cadr (assq (intern org-lang
)
1605 (plist-get info
:latex-listings-langs
)))
1607 (options (org-latex--make-option-string
1608 (append (plist-get info
:latex-listings-options
)
1609 `(("language" ,lst-lang
))))))
1610 (concat (format "\\lstinline[%s]" options
)
1611 separator code separator
))))))
1616 (defun org-latex-inlinetask (inlinetask contents info
)
1617 "Transcode an INLINETASK element from Org to LaTeX.
1618 CONTENTS holds the contents of the block. INFO is a plist
1619 holding contextual information."
1620 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
1621 (todo (and (plist-get info
:with-todo-keywords
)
1622 (let ((todo (org-element-property :todo-keyword inlinetask
)))
1623 (and todo
(org-export-data todo info
)))))
1624 (todo-type (org-element-property :todo-type inlinetask
))
1625 (tags (and (plist-get info
:with-tags
)
1626 (org-export-get-tags inlinetask info
)))
1627 (priority (and (plist-get info
:with-priority
)
1628 (org-element-property :priority inlinetask
)))
1630 (let ((label (org-element-property :CUSTOM_ID inlinetask
)))
1631 (and label
(format "\\label{%s}\n" label
)))
1633 (funcall (plist-get info
:latex-format-inlinetask-function
)
1634 todo todo-type priority title tags contents info
)))
1636 (defun org-latex-format-inlinetask-default-function
1637 (todo todo-type priority title tags contents info
)
1638 "Default format function for a inlinetasks.
1639 See `org-latex-format-inlinetask-function' for details."
1641 (concat (when todo
(format "\\textbf{\\textsf{\\textsc{%s}}} " todo
))
1642 (when priority
(format "\\framebox{\\#%c} " priority
))
1645 (format "\\hfill{}\\textsc{:%s:}"
1647 (lambda (tag) (org-latex-plain-text tag info
))
1649 (concat "\\begin{center}\n"
1651 "\\begin{minipage}[c]{.6\\textwidth}\n"
1653 (and (org-string-nw-p contents
)
1654 (concat "\\rule[.8em]{\\textwidth}{2pt}\n\n" contents
))
1662 (defun org-latex-italic (italic contents info
)
1663 "Transcode ITALIC from Org to LaTeX.
1664 CONTENTS is the text with italic markup. INFO is a plist holding
1665 contextual information."
1666 (org-latex--text-markup contents
'italic info
))
1671 (defun org-latex-item (item contents info
)
1672 "Transcode an ITEM element from Org to LaTeX.
1673 CONTENTS holds the contents of the item. INFO is a plist holding
1674 contextual information."
1676 (let ((count (org-element-property :counter item
))
1678 ;; Determine level of current item to determine the
1679 ;; correct LaTeX counter to use (enumi, enumii...).
1680 (let ((parent item
) (level 0))
1681 (while (memq (org-element-type
1682 (setq parent
(org-export-get-parent parent
)))
1684 (when (and (eq (org-element-type parent
) 'plain-list
)
1685 (eq (org-element-property :type parent
)
1691 (format "\\setcounter{enum%s}{%s}\n"
1692 (nth (1- level
) '("i" "ii" "iii" "iv"))
1694 (checkbox (case (org-element-property :checkbox item
)
1695 (on "$\\boxtimes$ ")
1697 (trans "$\\boxminus$ ")))
1698 (tag (let ((tag (org-element-property :tag item
)))
1699 ;; Check-boxes must belong to the tag.
1700 (and tag
(format "[{%s}] "
1702 (org-export-data tag info
)))))))
1707 (checkbox (concat " " checkbox
))
1708 ;; Without a tag or a check-box, if CONTENTS starts with
1709 ;; an opening square bracket, add "\relax" to "\item",
1710 ;; unless the brackets comes from an initial export
1711 ;; snippet (i.e. it is inserted willingly by the user).
1713 (org-string-match-p "\\`[ \t]*\\[" contents
)
1714 (not (let ((e (car (org-element-contents item
))))
1715 (and (eq (org-element-type e
) 'paragraph
)
1716 (let ((o (car (org-element-contents e
))))
1717 (and (eq (org-element-type o
) 'export-snippet
)
1718 (eq (org-export-snippet-backend o
)
1722 (and contents
(org-trim contents
))
1723 ;; If there are footnotes references in tag, be sure to
1724 ;; add their definition at the end of the item. This
1725 ;; workaround is necessary since "\footnote{}" command is
1726 ;; not supported in tags.
1728 (org-latex--delayed-footnotes-definitions
1729 (org-element-property :tag item
) info
)))))
1734 (defun org-latex-keyword (keyword contents info
)
1735 "Transcode a KEYWORD element from Org to LaTeX.
1736 CONTENTS is nil. INFO is a plist holding contextual information."
1737 (let ((key (org-element-property :key keyword
))
1738 (value (org-element-property :value keyword
)))
1740 ((string= key
"LATEX") value
)
1741 ((string= key
"INDEX") (format "\\index{%s}" value
))
1742 ((string= key
"TOC")
1743 (let ((value (downcase value
)))
1745 ((string-match "\\<headlines\\>" value
)
1746 (let ((depth (or (and (string-match "[0-9]+" value
)
1747 (string-to-number (match-string 0 value
)))
1748 (plist-get info
:with-toc
))))
1750 (when (wholenump depth
)
1751 (format "\\setcounter{tocdepth}{%s}\n" depth
))
1752 "\\tableofcontents")))
1753 ((string= "tables" value
) "\\listoftables")
1754 ((string= "listings" value
)
1755 (case (plist-get info
:latex-listings
)
1756 ((nil) "\\listoffigures")
1757 (minted "\\listoflistings")
1758 (otherwise "\\lstlistoflistings")))))))))
1761 ;;;; Latex Environment
1763 (defun org-latex-latex-environment (latex-environment contents info
)
1764 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
1765 CONTENTS is nil. INFO is a plist holding contextual information."
1766 (when (plist-get info
:with-latex
)
1767 (let ((label (org-element-property :name latex-environment
))
1768 (value (org-remove-indentation
1769 (org-element-property :value latex-environment
))))
1770 (if (not (org-string-nw-p label
)) value
1771 ;; Environment is labeled: label must be within the environment
1772 ;; (otherwise, a reference pointing to that element will count
1773 ;; the section instead).
1776 (goto-char (point-min))
1779 (format "\\label{%s}\n" (org-export-solidify-link-text label
)))
1780 (buffer-string))))))
1785 (defun org-latex-latex-fragment (latex-fragment contents info
)
1786 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
1787 CONTENTS is nil. INFO is a plist holding contextual information."
1788 (let ((value (org-element-property :value latex-fragment
)))
1789 ;; Trim math markers since the fragment is enclosed within
1790 ;; a latex-math-block object anyway.
1791 (cond ((string-match "\\`\\(\\$\\{1,2\\}\\)\\([^\000]*\\)\\1\\'" value
)
1792 (match-string 2 value
))
1793 ((string-match "\\`\\\\(\\([^\000]*\\)\\\\)\\'" value
)
1794 (match-string 1 value
))
1800 (defun org-latex-line-break (line-break contents info
)
1801 "Transcode a LINE-BREAK object from Org to LaTeX.
1802 CONTENTS is nil. INFO is a plist holding contextual information."
1808 (defun org-latex--inline-image (link info
)
1809 "Return LaTeX code for an inline image.
1810 LINK is the link pointing to the inline image. INFO is a plist
1811 used as a communication channel."
1812 (let* ((parent (org-export-get-parent-element link
))
1813 (path (let ((raw-path (org-element-property :path link
)))
1814 (if (not (file-name-absolute-p raw-path
)) raw-path
1815 (expand-file-name raw-path
))))
1816 (filetype (file-name-extension path
))
1817 (caption (org-latex--caption/label-string parent info
))
1818 ;; Retrieve latex attributes from the element around.
1819 (attr (org-export-read-attribute :attr_latex parent
))
1820 (float (let ((float (plist-get attr
:float
)))
1821 (cond ((and (not float
) (plist-member attr
:float
)) nil
)
1822 ((string= float
"wrap") 'wrap
)
1823 ((string= float
"sideways") 'sideways
)
1824 ((string= float
"multicolumn") 'multicolumn
)
1826 (org-element-property :caption parent
)
1827 (org-string-nw-p (plist-get attr
:caption
)))
1830 (let ((place (plist-get attr
:placement
)))
1832 (place (format "%s" place
))
1833 ((eq float
'wrap
) "{l}{0.5\\textwidth}")
1835 (format "[%s]" (plist-get info
:latex-default-figure-position
)))
1837 (comment-include (if (plist-get attr
:comment-include
) "%" ""))
1838 ;; It is possible to specify width and height in the
1839 ;; ATTR_LATEX line, and also via default variables.
1840 (width (cond ((plist-get attr
:width
))
1841 ((plist-get attr
:height
) "")
1842 ((eq float
'wrap
) "0.48\\textwidth")
1843 (t (plist-get info
:latex-image-default-width
))))
1844 (height (cond ((plist-get attr
:height
))
1845 ((or (plist-get attr
:width
)
1846 (memq float
'(figure wrap
))) "")
1847 (t (plist-get info
:latex-image-default-height
))))
1848 (options (let ((opt (or (plist-get attr
:options
)
1849 (plist-get info
:latex-image-default-option
))))
1850 (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt
)) opt
1851 (match-string 1 opt
))))
1853 (if (member filetype
'("tikz" "pgf"))
1855 ;; - use \input to read in image file.
1856 ;; - if options are present, wrap in a tikzpicture environment.
1857 ;; - if width or height are present, use \resizebox to change
1860 (setq image-code
(format "\\input{%s}" path
))
1861 (when (org-string-nw-p options
)
1863 (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
1866 (when (or (org-string-nw-p width
) (org-string-nw-p height
))
1867 (setq image-code
(format "\\resizebox{%s}{%s}{%s}"
1868 (if (org-string-nw-p width
) width
"!")
1869 (if (org-string-nw-p height
) height
"!")
1871 ;; For other images:
1872 ;; - add width and height to options.
1873 ;; - include the image with \includegraphics.
1874 (when (org-string-nw-p width
)
1875 (setq options
(concat options
",width=" width
)))
1876 (when (org-string-nw-p height
)
1877 (setq options
(concat options
",height=" height
)))
1878 (let ((search-option (org-element-property :search-option link
)))
1879 (when (and search-option
1880 (equal filetype
"pdf")
1881 (org-string-match-p "\\`[0-9]+\\'" search-option
)
1882 (not (org-string-match-p "page=" options
)))
1883 (setq options
(concat options
",page=" search-option
))))
1885 (format "\\includegraphics%s{%s}"
1886 (cond ((not (org-string-nw-p options
)) "")
1887 ((= (aref options
0) ?
,)
1888 (format "[%s]"(substring options
1)))
1889 (t (format "[%s]" options
)))
1891 (when (equal filetype
"svg")
1892 (setq image-code
(replace-regexp-in-string "^\\\\includegraphics"
1896 (setq image-code
(replace-regexp-in-string "\\.svg}"
1900 ;; Return proper string, depending on FLOAT.
1902 (wrap (format "\\begin{wrapfigure}%s
1905 %s\\end{wrapfigure}" placement comment-include image-code caption
))
1906 (sideways (format "\\begin{sidewaysfigure}
1909 %s\\end{sidewaysfigure}" comment-include image-code caption
))
1910 (multicolumn (format "\\begin{figure*}%s
1913 %s\\end{figure*}" placement comment-include image-code caption
))
1914 (figure (format "\\begin{figure}%s
1917 %s\\end{figure}" placement comment-include image-code caption
))
1918 (otherwise image-code
))))
1920 (defun org-latex-link (link desc info
)
1921 "Transcode a LINK object from Org to LaTeX.
1923 DESC is the description part of the link, or the empty string.
1924 INFO is a plist holding contextual information. See
1926 (let* ((type (org-element-property :type link
))
1927 (raw-path (replace-regexp-in-string
1928 "%" "\\%" (org-element-property :path link
) nil t
))
1929 ;; Ensure DESC really exists, or set it to nil.
1930 (desc (and (not (string= desc
"")) desc
))
1931 (imagep (org-export-inline-image-p
1932 link
(plist-get info
:latex-inline-image-rules
)))
1934 ((member type
'("http" "https" "ftp" "mailto"))
1935 (concat type
":" raw-path
))
1936 ((and (string= type
"file") (file-name-absolute-p raw-path
))
1937 (concat "file:" raw-path
))
1942 (imagep (org-latex--inline-image link info
))
1943 ;; Radio link: Transcode target's contents and use them as link's
1945 ((string= type
"radio")
1946 (let ((destination (org-export-resolve-radio-link link info
)))
1947 (if (not destination
) desc
1948 (format "\\hyperref[%s]{%s}"
1949 (org-export-solidify-link-text
1950 (org-element-property :value destination
))
1952 ;; Links pointing to a headline: Find destination and build
1953 ;; appropriate referencing command.
1954 ((member type
'("custom-id" "fuzzy" "id"))
1955 (let ((destination (if (string= type
"fuzzy")
1956 (org-export-resolve-fuzzy-link link info
)
1957 (org-export-resolve-id-link link info
))))
1958 (case (org-element-type destination
)
1959 ;; Id link points to an external file.
1961 (if desc
(format "\\href{%s}{%s}" destination desc
)
1962 (format "\\url{%s}" destination
)))
1963 ;; Fuzzy link points nowhere.
1965 (format (plist-get info
:latex-link-with-unknown-path-format
)
1968 (org-element-property :raw-link link
) info
))))
1969 ;; LINK points to a headline. If headlines are numbered
1970 ;; and the link has no description, display headline's
1971 ;; number. Otherwise, display description or headline's
1974 (let* ((custom-label
1975 (and (plist-get info
:latex-custom-id-labels
)
1976 (org-element-property :CUSTOM_ID destination
)))
1983 (org-export-get-headline-number destination info
)
1985 (if (and (plist-get info
:section-numbers
) (not desc
))
1986 (format "\\ref{%s}" label
)
1987 (format "\\hyperref[%s]{%s}" label
1990 (org-element-property :title destination
) info
))))))
1991 ;; Fuzzy link points to a target. Do as above.
1993 (let ((path (org-export-solidify-link-text path
)))
1994 (if (not desc
) (format "\\ref{%s}" path
)
1995 (format "\\hyperref[%s]{%s}" path desc
)))))))
1996 ;; Coderef: replace link with the reference name or the
1997 ;; equivalent line number.
1998 ((string= type
"coderef")
1999 (format (org-export-get-coderef-format path desc
)
2000 (org-export-resolve-coderef path info
)))
2001 ;; Link type is handled by a special function.
2002 ((functionp (setq protocol
(nth 2 (assoc type org-link-protocols
))))
2003 (funcall protocol
(org-link-unescape path
) desc
'latex
))
2004 ;; External link with a description part.
2005 ((and path desc
) (format "\\href{%s}{%s}" path desc
))
2006 ;; External link without a description part.
2007 (path (format "\\url{%s}" path
))
2008 ;; No path, only description. Try to do something useful.
2009 (t (format (plist-get info
:latex-link-with-unknown-path-format
) desc
)))))
2014 (defun org-latex-node-property (node-property contents info
)
2015 "Transcode a NODE-PROPERTY element from Org to LaTeX.
2016 CONTENTS is nil. INFO is a plist holding contextual
2019 (org-element-property :key node-property
)
2020 (let ((value (org-element-property :value node-property
)))
2021 (if value
(concat " " value
) ""))))
2026 (defun org-latex-paragraph (paragraph contents info
)
2027 "Transcode a PARAGRAPH element from Org to LaTeX.
2028 CONTENTS is the contents of the paragraph, as a string. INFO is
2029 the plist used as a communication channel."
2035 (defun org-latex-plain-list (plain-list contents info
)
2036 "Transcode a PLAIN-LIST element from Org to LaTeX.
2037 CONTENTS is the contents of the list. INFO is a plist holding
2038 contextual information."
2039 (let* ((type (org-element-property :type plain-list
))
2040 (attr (org-export-read-attribute :attr_latex plain-list
))
2041 (latex-type (let ((env (plist-get attr
:environment
)))
2042 (cond (env (format "%s" env
))
2043 ((eq type
'ordered
) "enumerate")
2044 ((eq type
'descriptive
) "description")
2046 (org-latex--wrap-label
2048 (format "\\begin{%s}%s\n%s\\end{%s}"
2050 (or (plist-get attr
:options
) "")
2057 (defun org-latex-plain-text (text info
)
2058 "Transcode a TEXT string from Org to LaTeX.
2059 TEXT is the string to transcode. INFO is a plist holding
2060 contextual information."
2061 (let* ((specialp (plist-get info
:with-special-strings
))
2063 ;; Turn LaTeX into \LaTeX{} and TeX into \TeX{}.
2064 (let ((case-fold-search nil
))
2065 (replace-regexp-in-string
2066 "\\<\\(?:La\\)?TeX\\>" "\\\\\\&{}"
2067 ;; Protect ^, ~, %, #, &, $, _, { and }. Also protect \.
2068 ;; However, if special strings are used, be careful not
2069 ;; to protect "\" in "\-" constructs.
2070 (replace-regexp-in-string
2071 (concat "[%$#&{}_~^]\\|\\\\" (and specialp
"\\(?:[^-]\\|$\\)"))
2074 (?
\\ "$\\\\backslash$")
2075 (?~
"\\\\textasciitilde{}")
2079 ;; Activate smart quotes. Be sure to provide original TEXT string
2080 ;; since OUTPUT may have been modified.
2081 (when (plist-get info
:with-smart-quotes
)
2082 (setq output
(org-export-activate-smart-quotes output
:latex info text
)))
2083 ;; Convert special strings.
2085 (setq output
(replace-regexp-in-string "\\.\\.\\." "\\\\ldots{}" output
)))
2086 ;; Handle break preservation if required.
2087 (when (plist-get info
:preserve-breaks
)
2088 (setq output
(replace-regexp-in-string
2089 "\\(?:[ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n" output nil t
)))
2096 (defun org-latex-planning (planning contents info
)
2097 "Transcode a PLANNING element from Org to LaTeX.
2098 CONTENTS is nil. INFO is a plist holding contextual
2106 (let ((closed (org-element-property :closed planning
)))
2109 (format "\\textbf{%s} " org-closed-string
)
2110 (format (plist-get info
:latex-inactive-timestamp-format
)
2112 (org-element-property :raw-value closed
))))))
2113 (let ((deadline (org-element-property :deadline planning
)))
2116 (format "\\textbf{%s} " org-deadline-string
)
2117 (format (plist-get info
:latex-active-timestamp-format
)
2119 (org-element-property :raw-value deadline
))))))
2120 (let ((scheduled (org-element-property :scheduled planning
)))
2123 (format "\\textbf{%s} " org-scheduled-string
)
2124 (format (plist-get info
:latex-active-timestamp-format
)
2126 (org-element-property :raw-value scheduled
))))))))
2131 ;;;; Property Drawer
2133 (defun org-latex-property-drawer (property-drawer contents info
)
2134 "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
2135 CONTENTS holds the contents of the drawer. INFO is a plist
2136 holding contextual information."
2137 (and (org-string-nw-p contents
)
2138 (format "\\begin{verbatim}\n%s\\end{verbatim}" contents
)))
2141 ;;;; Pseudo Object: LaTeX Math Block
2143 (defun org-latex--wrap-latex-math-block (data info
)
2144 "Merge contiguous math objects in a pseudo-object container.
2145 DATA is a parse tree or a secondary string. INFO is a plist
2146 containing export options. Modify DATA by side-effect and return it."
2147 (let ((valid-object-p
2149 ;; Non-nil when OBJ can be added to the latex math block.
2151 (case (org-element-type obj
)
2152 (entity (org-element-property :latex-math-p obj
))
2154 (let ((value (org-element-property :value obj
)))
2155 (or (org-string-match-p "\\`\\\\([^\000]*\\\\)\\'" value
)
2156 (org-string-match-p "\\`\\$[^\000]*\\$\\'" value
))))
2157 ((subscript superscript
) t
))))))
2158 (org-element-map data
'(entity latex-fragment subscript superscript
)
2160 ;; Skip objects already wrapped.
2161 (when (and (not (eq (org-element-type
2162 (org-element-property :parent object
))
2164 (funcall valid-object-p object
))
2165 (let ((math-block (list 'latex-math-block nil
))
2166 (next-elements (org-export-get-next-element object info t
))
2168 ;; Wrap MATH-BLOCK around OBJECT in DATA.
2169 (org-element-insert-before math-block object
)
2170 (org-element-extract-element object
)
2171 (org-element-adopt-elements math-block object
)
2172 (when (zerop (or (org-element-property :post-blank object
) 0))
2173 ;; MATH-BLOCK swallows consecutive math objects.
2175 (dolist (next next-elements
)
2176 (if (not (funcall valid-object-p next
)) (throw 'exit nil
)
2177 (org-element-extract-element next
)
2178 (org-element-adopt-elements math-block next
)
2179 ;; Eschew the case: \beta$x$ -> \(\betax\).
2180 (unless (memq (org-element-type next
)
2181 '(subscript superscript
))
2182 (org-element-put-property last
:post-blank
1))
2184 (when (> (or (org-element-property :post-blank next
) 0) 0)
2185 (throw 'exit nil
))))))
2186 (org-element-put-property
2187 math-block
:post-blank
(org-element-property :post-blank last
)))))
2188 info nil
'(subscript superscript latex-math-block
) t
)
2189 ;; Return updated DATA.
2192 (defun org-latex-math-block-tree-filter (tree backend info
)
2193 (org-latex--wrap-latex-math-block tree info
))
2195 (defun org-latex-math-block-options-filter (info backend
)
2196 (dolist (prop '(:author
:date
:title
) info
)
2197 (plist-put info prop
2198 (org-latex--wrap-latex-math-block (plist-get info prop
) info
))))
2200 (defun org-latex-math-block (math-block contents info
)
2201 "Transcode a MATH-BLOCK object from Org to LaTeX.
2202 CONTENTS is a string. INFO is a plist used as a communication
2204 (when (org-string-nw-p contents
)
2205 (format "\\(%s\\)" (org-trim contents
))))
2209 (defun org-latex-quote-block (quote-block contents info
)
2210 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
2211 CONTENTS holds the contents of the block. INFO is a plist
2212 holding contextual information."
2213 (org-latex--wrap-label
2215 (format "\\begin{quote}\n%s\\end{quote}" contents
)))
2220 (defun org-latex-radio-target (radio-target text info
)
2221 "Transcode a RADIO-TARGET object from Org to LaTeX.
2222 TEXT is the text of the target. INFO is a plist holding
2223 contextual information."
2224 (format "\\label{%s}%s"
2225 (org-export-solidify-link-text
2226 (org-element-property :value radio-target
))
2232 (defun org-latex-section (section contents info
)
2233 "Transcode a SECTION element from Org to LaTeX.
2234 CONTENTS holds the contents of the section. INFO is a plist
2235 holding contextual information."
2241 (defun org-latex-special-block (special-block contents info
)
2242 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
2243 CONTENTS holds the contents of the block. INFO is a plist
2244 holding contextual information."
2245 (let ((type (org-element-property :type special-block
))
2246 (opt (org-export-read-attribute :attr_latex special-block
:options
)))
2247 (concat (format "\\begin{%s}%s\n" type
(or opt
""))
2248 ;; Insert any label or caption within the block
2249 ;; (otherwise, a reference pointing to that element will
2250 ;; count the section instead).
2251 (org-latex--caption/label-string special-block info
)
2253 (format "\\end{%s}" type
))))
2258 (defun org-latex-src-block (src-block contents info
)
2259 "Transcode a SRC-BLOCK element from Org to LaTeX.
2260 CONTENTS holds the contents of the item. INFO is a plist holding
2261 contextual information."
2262 (when (org-string-nw-p (org-element-property :value src-block
))
2263 (let* ((lang (org-element-property :language src-block
))
2264 (caption (org-element-property :caption src-block
))
2265 (label (org-element-property :name src-block
))
2266 (custom-env (and lang
2267 (cadr (assq (intern lang
)
2268 org-latex-custom-lang-environments
))))
2269 (num-start (case (org-element-property :number-lines src-block
)
2270 (continued (org-export-get-loc src-block info
))
2272 (retain-labels (org-element-property :retain-labels src-block
))
2273 (attributes (org-export-read-attribute :attr_latex src-block
))
2274 (float (plist-get attributes
:float
))
2275 (listings (plist-get info
:latex-listings
)))
2277 ;; Case 1. No source fontification.
2279 (let* ((caption-str (org-latex--caption/label-string src-block info
))
2281 (cond ((and (not float
) (plist-member attributes
:float
)) "%s")
2282 ((string= "multicolumn" float
)
2283 (format "\\begin{figure*}[%s]\n%%s%s\n\\end{figure*}"
2284 (plist-get info
:latex-default-figure-position
)
2287 (format "\\begin{figure}[H]\n%%s%s\n\\end{figure}"
2292 (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
2293 (org-export-format-code-default src-block info
))))))
2294 ;; Case 2. Custom environment.
2295 (custom-env (format "\\begin{%s}\n%s\\end{%s}\n"
2297 (org-export-format-code-default src-block info
)
2299 ;; Case 3. Use minted package.
2300 ((eq listings
'minted
)
2301 (let* ((caption-str (org-latex--caption/label-string src-block info
))
2303 (cond ((and (not float
) (plist-member attributes
:float
)) "%s")
2304 ((string= "multicolumn" float
)
2305 (format "\\begin{listing*}\n%%s\n%s\\end{listing*}"
2308 (format "\\begin{listing}[H]\n%%s\n%s\\end{listing}"
2311 (options (plist-get info
:latex-minted-options
))
2314 "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2317 (org-latex--make-option-string
2318 (if (or (not num-start
) (assoc "linenos" options
))
2322 ("firstnumber" ,(number-to-string (1+ num-start
))))
2324 (let ((local-options (plist-get attributes
:options
)))
2325 (and local-options
(concat "," local-options
))))
2327 (or (cadr (assq (intern lang
)
2328 (plist-get info
:latex-minted-langs
)))
2331 (let* ((code-info (org-export-unravel-code src-block
))
2335 (org-split-string (car code-info
)
2337 (org-export-format-code
2339 (lambda (loc num ref
)
2343 ;; Ensure references are flushed to the right,
2344 ;; separated with 6 spaces from the widest line
2346 (concat (make-string (+ (- max-width
(length loc
)) 6)
2348 (format "(%s)" ref
)))))
2349 nil
(and retain-labels
(cdr code-info
)))))))
2351 (format float-env body
)))
2352 ;; Case 4. Use listings package.
2355 (or (cadr (assq (intern lang
)
2356 (plist-get info
:latex-listings-langs
)))
2360 (let ((main (org-export-get-caption src-block
))
2361 (secondary (org-export-get-caption src-block t
)))
2363 (format "{%s}" (org-export-data main info
))
2365 (org-export-data secondary info
)
2366 (org-export-data main info
))))))
2367 (lst-opt (plist-get info
:latex-listings-options
)))
2373 (org-latex--make-option-string
2377 ((and (not float
) (plist-member attributes
:float
)) nil
)
2378 ((string= "multicolumn" float
) '(("float" "*")))
2379 ((and float
(not (assoc "float" lst-opt
)))
2380 `(("float" ,(plist-get info
:latex-default-figure-position
)))))
2381 `(("language" ,lst-lang
))
2382 (if label
`(("label" ,label
)) '(("label" " ")))
2383 (if caption-str
`(("caption" ,caption-str
)) '(("caption" " ")))
2384 (cond ((assoc "numbers" lst-opt
) nil
)
2385 ((not num-start
) '(("numbers" "none")))
2386 ((zerop num-start
) '(("numbers" "left")))
2387 (t `(("numbers" "left")
2389 ,(number-to-string (1+ num-start
))))))))
2390 (let ((local-options (plist-get attributes
:options
)))
2391 (and local-options
(concat "," local-options
)))))
2394 "\\begin{lstlisting}\n%s\\end{lstlisting}"
2395 (let* ((code-info (org-export-unravel-code src-block
))
2399 (org-split-string (car code-info
) "\n")))))
2400 (org-export-format-code
2402 (lambda (loc num ref
)
2406 ;; Ensure references are flushed to the right,
2407 ;; separated with 6 spaces from the widest line of
2409 (concat (make-string (+ (- max-width
(length loc
)) 6) ?
)
2410 (format "(%s)" ref
)))))
2411 nil
(and retain-labels
(cdr code-info
))))))))))))
2414 ;;;; Statistics Cookie
2416 (defun org-latex-statistics-cookie (statistics-cookie contents info
)
2417 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
2418 CONTENTS is nil. INFO is a plist holding contextual information."
2419 (replace-regexp-in-string
2420 "%" "\\%" (org-element-property :value statistics-cookie
) nil t
))
2425 (defun org-latex-strike-through (strike-through contents info
)
2426 "Transcode STRIKE-THROUGH from Org to LaTeX.
2427 CONTENTS is the text with strike-through markup. INFO is a plist
2428 holding contextual information."
2429 (org-latex--text-markup contents
'strike-through info
))
2434 (defun org-latex--script-size (object info
)
2435 "Transcode a subscript or superscript object.
2436 OBJECT is an Org object. INFO is a plist used as a communication
2438 (let ((type (org-element-type object
))
2440 (org-element-map (org-element-contents object
)
2441 (cons 'plain-text org-element-all-objects
)
2443 (case (org-element-type obj
)
2444 ((entity latex-fragment
)
2445 (let ((data (org-trim (org-export-data obj info
))))
2447 "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
2451 (match-string 1 data
)
2452 (let ((blank (org-element-property :post-blank obj
)))
2453 (and blank
(> blank
0) "\\ "))))))
2456 (format "%s\\text{%s}" output
(org-export-data obj info
))))
2460 (org-export-data obj info
)
2461 (let ((blank (org-element-property :post-blank obj
)))
2462 (and blank
(> blank
0) "\\ ")))))))
2463 info nil org-element-recursive-objects
)
2464 ;; Result. Do not wrap into curly brackets if OUTPUT is a single
2466 (concat (if (eq (org-element-type object
) 'subscript
) "_" "^")
2467 (and (> (length output
) 1) "{")
2469 (and (> (length output
) 1) "}"))))
2471 (defun org-latex-subscript (subscript contents info
)
2472 "Transcode a SUBSCRIPT object from Org to LaTeX.
2473 CONTENTS is the contents of the object. INFO is a plist holding
2474 contextual information."
2475 (org-latex--script-size subscript info
))
2480 (defun org-latex-superscript (superscript contents info
)
2481 "Transcode a SUPERSCRIPT object from Org to LaTeX.
2482 CONTENTS is the contents of the object. INFO is a plist holding
2483 contextual information."
2484 (org-latex--script-size superscript info
))
2489 ;; `org-latex-table' is the entry point for table transcoding. It
2490 ;; takes care of tables with a "verbatim" mode. Otherwise, it
2491 ;; delegates the job to either `org-latex--table.el-table',
2492 ;; `org-latex--org-table' or `org-latex--math-table' functions,
2493 ;; depending of the type of the table and the mode requested.
2495 ;; `org-latex--align-string' is a subroutine used to build alignment
2496 ;; string for Org tables.
2498 (defun org-latex-table (table contents info
)
2499 "Transcode a TABLE element from Org to LaTeX.
2500 CONTENTS is the contents of the table. INFO is a plist holding
2501 contextual information."
2502 (if (eq (org-element-property :type table
) 'table.el
)
2503 ;; "table.el" table. Convert it using appropriate tools.
2504 (org-latex--table.el-table table info
)
2505 (let ((type (or (org-export-read-attribute :attr_latex table
:mode
)
2506 (plist-get info
:latex-default-table-mode
))))
2508 ;; Case 1: Verbatim table.
2509 ((string= type
"verbatim")
2510 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
2511 ;; Re-create table, without affiliated keywords.
2512 (org-trim (org-element-interpret-data
2513 `(table nil
,@(org-element-contents table
))
2514 org-latex-pseudo-objects
))))
2516 ((or (string= type
"math") (string= type
"inline-math"))
2517 (org-latex--math-table table info
))
2518 ;; Case 3: Standard table.
2519 (t (concat (org-latex--org-table table contents info
)
2520 ;; When there are footnote references within the
2521 ;; table, insert their definition just after it.
2522 (org-latex--delayed-footnotes-definitions table info
)))))))
2524 (defun org-latex--align-string (table info
)
2525 "Return an appropriate LaTeX alignment string.
2526 TABLE is the considered table. INFO is a plist used as
2527 a communication channel."
2528 (or (org-export-read-attribute :attr_latex table
:align
)
2530 ;; Extract column groups and alignment from first (non-rule)
2533 (org-element-map table
'table-row
2535 (and (eq (org-element-property :type row
) 'standard
) row
))
2539 (let ((borders (org-export-table-cell-borders cell info
)))
2540 ;; Check left border for the first cell only.
2541 (when (and (memq 'left borders
) (not align
))
2543 (push (case (org-export-table-cell-alignment cell info
)
2548 (when (memq 'right borders
) (push "|" align
))))
2550 (apply 'concat
(nreverse align
)))))
2552 (defun org-latex--org-table (table contents info
)
2553 "Return appropriate LaTeX code for an Org table.
2555 TABLE is the table type element to transcode. CONTENTS is its
2556 contents, as a string. INFO is a plist used as a communication
2559 This function assumes TABLE has `org' as its `:type' property and
2560 `table' as its `:mode' attribute."
2561 (let* ((caption (org-latex--caption/label-string table info
))
2562 (attr (org-export-read-attribute :attr_latex table
))
2563 ;; Determine alignment string.
2564 (alignment (org-latex--align-string table info
))
2565 ;; Determine environment for the table: longtable, tabular...
2566 (table-env (or (plist-get attr
:environment
)
2567 (plist-get info
:latex-default-table-environment
)))
2568 ;; If table is a float, determine environment: table, table*
2569 ;; or sidewaystable.
2570 (float-env (unless (member table-env
'("longtable" "longtabu"))
2571 (let ((float (plist-get attr
:float
)))
2573 ((and (not float
) (plist-member attr
:float
)) nil
)
2574 ((or (string= float
"sidewaystable")
2575 (string= float
"sideways")) "sidewaystable")
2576 ((string= float
"multicolumn") "table*")
2578 (org-element-property :caption table
)
2579 (org-string-nw-p (plist-get attr
:caption
)))
2581 ;; Extract others display options.
2582 (fontsize (let ((font (plist-get attr
:font
)))
2583 (and font
(concat font
"\n"))))
2584 (width (plist-get attr
:width
))
2585 (spreadp (plist-get attr
:spread
))
2587 (or (plist-get attr
:placement
)
2588 (format "[%s]" (plist-get info
:latex-default-figure-position
))))
2589 (centerp (if (plist-member attr
:center
) (plist-get attr
:center
)
2590 (plist-get info
:latex-tables-centered
)))
2591 (caption-above-p (plist-get info
:latex-table-caption-above
)))
2592 ;; Prepare the final format string for the table.
2595 ((equal "longtable" table-env
)
2596 (concat (and fontsize
(concat "{" fontsize
))
2597 (format "\\begin{longtable}{%s}\n" alignment
)
2598 (and caption-above-p
2599 (org-string-nw-p caption
)
2600 (concat caption
"\\\\\n"))
2602 (and (not caption-above-p
)
2603 (org-string-nw-p caption
)
2604 (concat caption
"\\\\\n"))
2605 "\\end{longtable}\n"
2606 (and fontsize
"}")))
2608 ((equal "longtabu" table-env
)
2609 (concat (and fontsize
(concat "{" fontsize
))
2610 (format "\\begin{longtabu}%s{%s}\n"
2613 (if spreadp
"spread" "to") width
) "")
2615 (and caption-above-p
2616 (org-string-nw-p caption
)
2617 (concat caption
"\\\\\n"))
2619 (and (not caption-above-p
)
2620 (org-string-nw-p caption
)
2621 (concat caption
"\\\\\n"))
2623 (and fontsize
"}")))
2627 (concat (format "\\begin{%s}%s\n" float-env placement
)
2628 (if caption-above-p caption
"")
2629 (when centerp
"\\centering\n")
2631 (centerp (concat "\\begin{center}\n" fontsize
))
2632 (fontsize (concat "{" fontsize
)))
2633 (cond ((equal "tabu" table-env
)
2634 (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
2636 (if spreadp
" spread %s " " to %s ")
2640 (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
2642 (if width
(format "{%s}" width
) "")
2648 (concat (if caption-above-p
"" caption
)
2649 (format "\n\\end{%s}" float-env
)))
2650 (centerp "\n\\end{center}")
2651 (fontsize "}")))))))
2653 (defun org-latex--table.el-table
(table info
)
2654 "Return appropriate LaTeX code for a table.el table.
2656 TABLE is the table type element to transcode. INFO is a plist
2657 used as a communication channel.
2659 This function assumes TABLE has `table.el' as its `:type'
2662 ;; Ensure "*org-export-table*" buffer is empty.
2663 (with-current-buffer (get-buffer-create "*org-export-table*")
2665 (let ((output (with-temp-buffer
2666 (insert (org-element-property :value table
))
2668 (re-search-forward "^[ \t]*|[^|]" nil t
)
2669 (table-generate-source 'latex
"*org-export-table*")
2670 (with-current-buffer "*org-export-table*"
2671 (org-trim (buffer-string))))))
2672 (kill-buffer (get-buffer "*org-export-table*"))
2673 ;; Remove left out comments.
2674 (while (string-match "^%.*\n" output
)
2675 (setq output
(replace-match "" t t output
)))
2676 (let ((attr (org-export-read-attribute :attr_latex table
)))
2677 (when (plist-get attr
:rmlines
)
2678 ;; When the "rmlines" attribute is provided, remove all hlines
2679 ;; but the the one separating heading from the table body.
2680 (let ((n 0) (pos 0))
2681 (while (and (< (length output
) pos
)
2682 (setq pos
(string-match "^\\\\hline\n?" output pos
)))
2684 (unless (= n
2) (setq output
(replace-match "" nil nil output
))))))
2685 (let ((centerp (if (plist-member attr
:center
) (plist-get attr
:center
)
2686 (plist-get info
:latex-tables-centered
))))
2687 (if (not centerp
) output
2688 (format "\\begin{center}\n%s\n\\end{center}" output
))))))
2690 (defun org-latex--math-table (table info
)
2691 "Return appropriate LaTeX code for a matrix.
2693 TABLE is the table type element to transcode. INFO is a plist
2694 used as a communication channel.
2696 This function assumes TABLE has `org' as its `:type' property and
2697 `inline-math' or `math' as its `:mode' attribute.."
2698 (let* ((caption (org-latex--caption/label-string table info
))
2699 (attr (org-export-read-attribute :attr_latex table
))
2700 (inlinep (equal (plist-get attr
:mode
) "inline-math"))
2701 (env (or (plist-get attr
:environment
)
2702 (plist-get info
:latex-default-table-environment
)))
2706 ;; Ignore horizontal rules.
2707 (when (eq (org-element-property :type row
) 'standard
)
2708 ;; Return each cell unmodified.
2713 (org-element-interpret-data cell org-latex-pseudo-objects
)
2715 (org-element-map row
'table-cell
'identity info
) "&")
2716 (or (cdr (assoc env org-latex-table-matrix-macros
)) "\\\\")
2718 (org-element-map table
'table-row
'identity info
) ""))
2719 ;; Variables related to math clusters (contiguous math tables
2720 ;; of the same type).
2721 (mode (org-export-read-attribute :attr_latex table
:mode
))
2722 (prev (org-export-get-previous-element table info
))
2723 (next (org-export-get-next-element table info
))
2726 ;; Non-nil when TABLE has the same mode as current table.
2727 (string= (or (org-export-read-attribute :attr_latex table
:mode
)
2728 (plist-get info
:latex-default-table-mode
))
2731 ;; Opening string. If TABLE is in the middle of a table cluster,
2732 ;; do not insert any.
2734 (eq (org-element-type prev
) 'table
)
2735 (memq (org-element-property :post-blank prev
) '(0 nil
))
2736 (funcall same-mode-p prev
))
2739 ((org-string-nw-p caption
) (concat "\\begin{equation}\n" caption
))
2742 (or (plist-get attr
:math-prefix
) "")
2743 ;; Environment. Also treat special cases.
2744 (cond ((equal env
"array")
2745 (let ((align (org-latex--align-string table info
)))
2746 (format "\\begin{array}{%s}\n%s\\end{array}" align contents
)))
2747 ((assoc env org-latex-table-matrix-macros
)
2748 (format "\\%s%s{\n%s}"
2750 (or (plist-get attr
:math-arguments
) "")
2752 (t (format "\\begin{%s}\n%s\\end{%s}" env contents env
)))
2754 (or (plist-get attr
:math-suffix
) "")
2755 ;; Closing string. If TABLE is in the middle of a table cluster,
2756 ;; do not insert any. If it closes such a cluster, be sure to
2757 ;; close the cluster with a string matching the opening string.
2759 (eq (org-element-type next
) 'table
)
2760 (memq (org-element-property :post-blank table
) '(0 nil
))
2761 (funcall same-mode-p next
))
2764 ;; Find cluster beginning to know which environment to use.
2765 ((let ((cluster-beg table
) prev
)
2766 (while (and (setq prev
(org-export-get-previous-element
2768 (memq (org-element-property :post-blank prev
)
2770 (funcall same-mode-p prev
))
2771 (setq cluster-beg prev
))
2772 (and (or (org-element-property :caption cluster-beg
)
2773 (org-element-property :name cluster-beg
))
2774 "\n\\end{equation}")))
2780 (defun org-latex-table-cell (table-cell contents info
)
2781 "Transcode a TABLE-CELL element from Org to LaTeX.
2782 CONTENTS is the cell contents. INFO is a plist used as
2783 a communication channel."
2785 (let ((scientific-format (plist-get info
:latex-table-scientific-notation
)))
2788 (string-match orgtbl-exp-regexp contents
))
2789 ;; Use appropriate format string for scientific
2791 (format scientific-format
2792 (match-string 1 contents
)
2793 (match-string 2 contents
))
2795 (when (org-export-get-next-element table-cell info
) " & ")))
2800 (defun org-latex-table-row (table-row contents info
)
2801 "Transcode a TABLE-ROW element from Org to LaTeX.
2802 CONTENTS is the contents of the row. INFO is a plist used as
2803 a communication channel."
2804 (let* ((attr (org-export-read-attribute :attr_latex
2805 (org-export-get-parent table-row
)))
2806 (booktabsp (if (plist-member attr
:booktabs
) (plist-get attr
:booktabs
)
2807 (plist-get info
:latex-tables-booktabs
)))
2809 (member (or (plist-get attr
:environment
)
2810 (plist-get info
:latex-default-table-environment
))
2811 '("longtable" "longtabu"))))
2812 (if (eq (org-element-property :type table-row
) 'rule
)
2814 ((not booktabsp
) "\\hline")
2815 ((not (org-export-get-previous-element table-row info
)) "\\toprule")
2816 ((not (org-export-get-next-element table-row info
)) "\\bottomrule")
2818 (org-export-table-row-ends-header-p
2819 (org-export-get-previous-element table-row info
) info
))
2823 ;; When BOOKTABS are activated enforce top-rule even when no
2824 ;; hline was specifically marked.
2825 (and booktabsp
(not (org-export-get-previous-element table-row info
))
2829 ;; Special case for long tables. Define header and footers.
2830 ((and longtablep
(org-export-table-row-ends-header-p table-row info
))
2831 (let ((columns (cdr (org-export-table-dimensions
2832 (org-export-get-parent-table table-row
) info
))))
2835 \\multicolumn{%d}{l}{%s} \\\\
2840 %s\\multicolumn{%d}{r}{%s} \\\\
2843 (if booktabsp
"\\midrule" "\\hline")
2845 (org-latex--translate "Continued from previous page" info
)
2847 ((not (org-export-table-row-starts-header-p table-row info
))
2849 (booktabsp "\\toprule\n")
2852 (if booktabsp
"\\midrule" "\\hline")
2853 (if booktabsp
"\\midrule" "\\hline")
2855 (org-latex--translate "Continued on next page" info
))))
2856 ;; When BOOKTABS are activated enforce bottom rule even when
2857 ;; no hline was specifically marked.
2858 ((and booktabsp
(not (org-export-get-next-element table-row info
)))
2859 "\\bottomrule"))))))
2864 (defun org-latex-target (target contents info
)
2865 "Transcode a TARGET object from Org to LaTeX.
2866 CONTENTS is nil. INFO is a plist holding contextual
2868 (format "\\label{%s}"
2869 (org-export-solidify-link-text (org-element-property :value target
))))
2874 (defun org-latex-timestamp (timestamp contents info
)
2875 "Transcode a TIMESTAMP object from Org to LaTeX.
2876 CONTENTS is nil. INFO is a plist holding contextual
2878 (let ((value (org-latex-plain-text (org-timestamp-translate timestamp
) info
)))
2881 (case (org-element-property :type timestamp
)
2882 ((active active-range
) :latex-active-timestamp-format
)
2883 ((inactive inactive-range
) :latex-inactive-timestamp-format
)
2884 (otherwise :latex-diary-timestamp-format
)))
2890 (defun org-latex-underline (underline contents info
)
2891 "Transcode UNDERLINE from Org to LaTeX.
2892 CONTENTS is the text with underline markup. INFO is a plist
2893 holding contextual information."
2894 (org-latex--text-markup contents
'underline info
))
2899 (defun org-latex-verbatim (verbatim contents info
)
2900 "Transcode a VERBATIM object from Org to LaTeX.
2901 CONTENTS is nil. INFO is a plist used as a communication
2903 (org-latex--text-markup
2904 (org-element-property :value verbatim
) 'verbatim info
))
2909 (defun org-latex-verse-block (verse-block contents info
)
2910 "Transcode a VERSE-BLOCK element from Org to LaTeX.
2911 CONTENTS is verse block contents. INFO is a plist holding
2912 contextual information."
2913 (org-latex--wrap-label
2915 ;; In a verse environment, add a line break to each newline
2916 ;; character and change each white space at beginning of a line
2917 ;; into a space of 1 em. Also change each blank line with
2918 ;; a vertical space of 1 em.
2919 (format "\\begin{verse}\n%s\\end{verse}"
2920 (replace-regexp-in-string
2921 "^[ \t]+" (lambda (m) (format "\\hspace*{%dem}" (length m
)))
2922 (replace-regexp-in-string
2923 "^[ \t]*\\\\\\\\$" "\\vspace*{1em}"
2924 (replace-regexp-in-string
2925 "\\([ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n"
2926 contents nil t
) nil t
) nil t
))))
2930 ;;; End-user functions
2933 (defun org-latex-export-as-latex
2934 (&optional async subtreep visible-only body-only ext-plist
)
2935 "Export current buffer as a LaTeX buffer.
2937 If narrowing is active in the current buffer, only export its
2940 If a region is active, export that region.
2942 A non-nil optional argument ASYNC means the process should happen
2943 asynchronously. The resulting buffer should be accessible
2944 through the `org-export-stack' interface.
2946 When optional argument SUBTREEP is non-nil, export the sub-tree
2947 at point, extracting information from the headline properties
2950 When optional argument VISIBLE-ONLY is non-nil, don't export
2951 contents of hidden elements.
2953 When optional argument BODY-ONLY is non-nil, only write code
2954 between \"\\begin{document}\" and \"\\end{document}\".
2956 EXT-PLIST, when provided, is a property list with external
2957 parameters overriding Org default settings, but still inferior to
2958 file-local settings.
2960 Export is done in a buffer named \"*Org LATEX Export*\", which
2961 will be displayed when `org-export-show-temporary-export-buffer'
2964 (org-export-to-buffer 'latex
"*Org LATEX Export*"
2965 async subtreep visible-only body-only ext-plist
(lambda () (LaTeX-mode))))
2968 (defun org-latex-convert-region-to-latex ()
2969 "Assume the current region has org-mode syntax, and convert it to LaTeX.
2970 This can be used in any buffer. For example, you can write an
2971 itemized list in org-mode syntax in an LaTeX buffer and use this
2972 command to convert it."
2974 (org-export-replace-region-by 'latex
))
2977 (defun org-latex-export-to-latex
2978 (&optional async subtreep visible-only body-only ext-plist
)
2979 "Export current buffer to a LaTeX file.
2981 If narrowing is active in the current buffer, only export its
2984 If a region is active, export that region.
2986 A non-nil optional argument ASYNC means the process should happen
2987 asynchronously. The resulting file should be accessible through
2988 the `org-export-stack' interface.
2990 When optional argument SUBTREEP is non-nil, export the sub-tree
2991 at point, extracting information from the headline properties
2994 When optional argument VISIBLE-ONLY is non-nil, don't export
2995 contents of hidden elements.
2997 When optional argument BODY-ONLY is non-nil, only write code
2998 between \"\\begin{document}\" and \"\\end{document}\".
3000 EXT-PLIST, when provided, is a property list with external
3001 parameters overriding Org default settings, but still inferior to
3002 file-local settings."
3004 (let ((outfile (org-export-output-file-name ".tex" subtreep
)))
3005 (org-export-to-file 'latex outfile
3006 async subtreep visible-only body-only ext-plist
)))
3009 (defun org-latex-export-to-pdf
3010 (&optional async subtreep visible-only body-only ext-plist
)
3011 "Export current buffer to LaTeX then process through to PDF.
3013 If narrowing is active in the current buffer, only export its
3016 If a region is active, export that region.
3018 A non-nil optional argument ASYNC means the process should happen
3019 asynchronously. The resulting file should be accessible through
3020 the `org-export-stack' interface.
3022 When optional argument SUBTREEP is non-nil, export the sub-tree
3023 at point, extracting information from the headline properties
3026 When optional argument VISIBLE-ONLY is non-nil, don't export
3027 contents of hidden elements.
3029 When optional argument BODY-ONLY is non-nil, only write code
3030 between \"\\begin{document}\" and \"\\end{document}\".
3032 EXT-PLIST, when provided, is a property list with external
3033 parameters overriding Org default settings, but still inferior to
3034 file-local settings.
3036 Return PDF file's name."
3038 (let ((outfile (org-export-output-file-name ".tex" subtreep
)))
3039 (org-export-to-file 'latex outfile
3040 async subtreep visible-only body-only ext-plist
3041 (lambda (file) (org-latex-compile file
)))))
3043 (defun org-latex-compile (texfile &optional snippet
)
3044 "Compile a TeX file.
3046 TEXFILE is the name of the file being compiled. Processing is
3047 done through the command specified in `org-latex-pdf-process'.
3049 When optional argument SNIPPET is non-nil, TEXFILE is a temporary
3050 file used to preview a LaTeX snippet. In this case, do not
3051 create a log buffer and do not bother removing log files.
3053 Return PDF file name or an error if it couldn't be produced."
3054 (let* ((base-name (file-name-sans-extension (file-name-nondirectory texfile
)))
3055 (full-name (file-truename texfile
))
3056 (out-dir (file-name-directory texfile
))
3057 ;; Properly set working directory for compilation.
3058 (default-directory (if (file-name-absolute-p texfile
)
3059 (file-name-directory full-name
)
3061 (time (current-time))
3063 (unless snippet
(message (format "Processing LaTeX file %s..." texfile
)))
3064 (save-window-excursion
3066 ;; A function is provided: Apply it.
3067 ((functionp org-latex-pdf-process
)
3068 (funcall org-latex-pdf-process
(shell-quote-argument texfile
)))
3069 ;; A list is provided: Replace %b, %f and %o with appropriate
3070 ;; values in each command before applying it. Output is
3071 ;; redirected to "*Org PDF LaTeX Output*" buffer.
3072 ((consp org-latex-pdf-process
)
3073 (let ((outbuf (and (not snippet
)
3074 (get-buffer-create "*Org PDF LaTeX Output*"))))
3075 (dolist (command org-latex-pdf-process
)
3077 (replace-regexp-in-string
3078 "%b" (shell-quote-argument base-name
)
3079 (replace-regexp-in-string
3080 "%f" (shell-quote-argument full-name
)
3081 (replace-regexp-in-string
3082 "%o" (shell-quote-argument out-dir
) command t t
) t t
) t t
)
3084 ;; Collect standard errors from output buffer.
3085 (setq warnings
(and (not snippet
)
3086 (org-latex--collect-warnings outbuf
)))))
3087 (t (error "No valid command to process to PDF")))
3088 (let ((pdffile (concat out-dir base-name
".pdf")))
3089 ;; Check for process failure. Provide collected errors if
3091 (if (or (not (file-exists-p pdffile
))
3092 (time-less-p (nth 5 (file-attributes pdffile
)) time
))
3093 (error (format "PDF file %s wasn't produced" pdffile
))
3094 ;; Else remove log files, when specified, and signal end of
3095 ;; process to user, along with any error encountered.
3096 (when (and (not snippet
) org-latex-remove-logfiles
)
3097 (dolist (file (directory-files
3099 (concat (regexp-quote base-name
)
3100 "\\(?:\\.[0-9]+\\)?"
3102 (regexp-opt org-latex-logfiles-extensions
))))
3103 (delete-file file
)))
3104 (message (concat "PDF file produced"
3106 ((eq warnings
'error
) " with errors.")
3107 (warnings (concat " with warnings: " warnings
))
3109 ;; Return output file name.
3112 (defun org-latex--collect-warnings (buffer)
3113 "Collect some warnings from \"pdflatex\" command output.
3114 BUFFER is the buffer containing output. Return collected
3115 warnings types as a string, `error' if a LaTeX error was
3116 encountered or nil if there was none."
3117 (with-current-buffer buffer
3119 (goto-char (point-max))
3120 (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t
)
3121 (if (re-search-forward "^!" nil t
) 'error
3122 (let ((case-fold-search t
)
3124 (dolist (warning org-latex-known-warnings
)
3125 (when (save-excursion (re-search-forward (car warning
) nil t
))
3126 (setq warnings
(concat warnings
" " (cdr warning
)))))
3127 (org-string-nw-p (org-trim warnings
))))))))
3130 (defun org-latex-publish-to-latex (plist filename pub-dir
)
3131 "Publish an Org file to LaTeX.
3133 FILENAME is the filename of the Org file to be published. PLIST
3134 is the property list for the given project. PUB-DIR is the
3135 publishing directory.
3137 Return output file name."
3138 (org-publish-org-to 'latex filename
".tex" plist pub-dir
))
3141 (defun org-latex-publish-to-pdf (plist filename pub-dir
)
3142 "Publish an Org file to PDF (via LaTeX).
3144 FILENAME is the filename of the Org file to be published. PLIST
3145 is the property list for the given project. PUB-DIR is the
3146 publishing directory.
3148 Return output file name."
3149 ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
3150 ;; in working directory and then moved to publishing directory.
3151 (org-publish-attachment
3155 'latex filename
".tex" plist
(file-name-directory filename
)))
3162 ;; generated-autoload-file: "org-loaddefs.el"
3165 ;;; ox-latex.el ends here