Manually revert back to commit e85080.
[org-mode.git] / lisp / org-latex.el
blob8146ab104c262045f2f32e55e6c15e986fed9302
1 ;;; org-latex.el --- LaTeX exporter for org-mode
2 ;;
3 ;; Copyright (C) 2007-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Emacs Lisp Archive Entry
6 ;; Filename: org-latex.el
7 ;; Author: Bastien Guerry <bzg AT gnu DOT org>
8 ;; Maintainer: Carsten Dominik <carsten.dominik AT gmail DOT com>
9 ;; Keywords: org, wp, tex
10 ;; Description: Converts an org-mode buffer into LaTeX
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; This library implements a LaTeX exporter for org-mode.
31 ;; It is part of Org and will be autoloaded
33 ;; The interactive functions are similar to those of the HTML exporter:
35 ;; M-x `org-export-as-latex'
36 ;; M-x `org-export-as-pdf'
37 ;; M-x `org-export-as-pdf-and-open'
38 ;; M-x `org-export-as-latex-batch'
39 ;; M-x `org-export-as-latex-to-buffer'
40 ;; M-x `org-export-region-as-latex'
41 ;; M-x `org-replace-region-by-latex'
43 ;;; Code:
45 (eval-when-compile
46 (require 'cl))
48 (require 'footnote)
49 (require 'org)
50 (require 'org-exp)
51 (require 'org-macs)
52 (require 'org-beamer)
54 ;;; Variables:
55 (defvar org-export-latex-class nil)
56 (defvar org-export-latex-class-options nil)
57 (defvar org-export-latex-header nil)
58 (defvar org-export-latex-append-header nil)
59 (defvar org-export-latex-options-plist nil)
60 (defvar org-export-latex-todo-keywords-1 nil)
61 (defvar org-export-latex-complex-heading-re nil)
62 (defvar org-export-latex-not-done-keywords nil)
63 (defvar org-export-latex-done-keywords nil)
64 (defvar org-export-latex-display-custom-times nil)
65 (defvar org-export-latex-all-targets-re nil)
66 (defvar org-export-latex-add-level 0)
67 (defvar org-export-latex-footmark-seen nil
68 "List of footnotes markers seen so far by exporter.")
69 (defvar org-export-latex-sectioning "")
70 (defvar org-export-latex-sectioning-depth 0)
71 (defvar org-export-latex-special-keyword-regexp
72 (concat "\\<\\(" org-scheduled-string "\\|"
73 org-deadline-string "\\|"
74 org-closed-string"\\)")
75 "Regexp matching special time planning keywords plus the time after it.")
76 (defvar org-re-quote) ; dynamically scoped from org.el
77 (defvar org-commentsp) ; dynamically scoped from org.el
79 ;;; User variables:
81 (defgroup org-export-latex nil
82 "Options for exporting Org-mode files to LaTeX."
83 :tag "Org Export LaTeX"
84 :group 'org-export)
86 (defcustom org-export-latex-default-class "article"
87 "The default LaTeX class."
88 :group 'org-export-latex
89 :type '(string :tag "LaTeX class"))
91 (defcustom org-export-latex-classes
92 '(("article"
93 "\\documentclass[11pt]{article}"
94 ("\\section{%s}" . "\\section*{%s}")
95 ("\\subsection{%s}" . "\\subsection*{%s}")
96 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
97 ("\\paragraph{%s}" . "\\paragraph*{%s}")
98 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
99 ("report"
100 "\\documentclass[11pt]{report}"
101 ("\\part{%s}" . "\\part*{%s}")
102 ("\\chapter{%s}" . "\\chapter*{%s}")
103 ("\\section{%s}" . "\\section*{%s}")
104 ("\\subsection{%s}" . "\\subsection*{%s}")
105 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
106 ("book"
107 "\\documentclass[11pt]{book}"
108 ("\\part{%s}" . "\\part*{%s}")
109 ("\\chapter{%s}" . "\\chapter*{%s}")
110 ("\\section{%s}" . "\\section*{%s}")
111 ("\\subsection{%s}" . "\\subsection*{%s}")
112 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
113 ("beamer"
114 "\\documentclass{beamer}"
115 org-beamer-sectioning
117 "Alist of LaTeX classes and associated header and structure.
118 If #+LaTeX_CLASS is set in the buffer, use its value and the
119 associated information. Here is the structure of each cell:
121 \(class-name
122 header-string
123 (numbered-section . unnumbered-section\)
124 ...\)
126 The header string
127 -----------------
129 The HEADER-STRING is the header that will be inserted into the LaTeX file.
130 It should contain the \\documentclass macro, and anything else that is needed
131 for this setup. To this header, the following commands will be added:
133 - Calls to \\usepackage for all packages mentioned in the variables
134 `org-export-latex-default-packages-alist' and
135 `org-export-latex-packages-alist'. Thus, your header definitions should
136 avoid to also request these packages.
138 - Lines specified via \"#+LaTeX_HEADER:\"
140 If you need more control about the sequence in which the header is built
141 up, or if you want to exclude one of these building blocks for a particular
142 class, you can use the following macro-like placeholders.
144 [DEFAULT-PACKAGES] \\usepackage statements for default packages
145 [NO-DEFAULT-PACKAGES] do not include any of the default packages
146 [PACKAGES] \\usepackage statements for packages
147 [NO-PACKAGES] do not include the packages
148 [EXTRA] the stuff from #+LaTeX_HEADER
149 [NO-EXTRA] do not include #+LaTeX_HEADER stuff
150 [BEAMER-HEADER-EXTRA] the beamer extra headers
152 So a header like
154 \\documentclass{article}
155 [NO-DEFAULT-PACKAGES]
156 [EXTRA]
157 \\providecommand{\\alert}[1]{\\textbf{#1}}
158 [PACKAGES]
160 will omit the default packages, and will include the #+LaTeX_HEADER lines,
161 then have a call to \\providecommand, and then place \\usepackage commands
162 based on the content of `org-export-latex-packages-alist'.
164 If your header or `org-export-latex-default-packages-alist' inserts
165 \"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be replaced with
166 a coding system derived from `buffer-file-coding-system'. See also the
167 variable `org-export-latex-inputenc-alist' for a way to influence this
168 mechanism.
170 The sectioning structure
171 ------------------------
173 The sectioning structure of the class is given by the elements following
174 the header string. For each sectioning level, a number of strings is
175 specified. A %s formatter is mandatory in each section string and will
176 be replaced by the title of the section.
178 Instead of a cons cell (numbered . unnumbered), you can also provide a list
179 of 2 or 4 elements,
181 (numbered-open numbered-close)
185 (numbered-open numbered-close unnumbered-open unnumbered-close)
187 providing opening and closing strings for a LaTeX environment that should
188 represent the document section. The opening clause should have a %s
189 to represent the section title.
191 Instead of a list of sectioning commands, you can also specify a
192 function name. That function will be called with two parameters,
193 the (reduced) level of the headline, and the headline text. The function
194 must return a cons cell with the (possibly modified) headline text, and the
195 sectioning list in the cdr."
196 :group 'org-export-latex
197 :type '(repeat
198 (list (string :tag "LaTeX class")
199 (string :tag "LaTeX header")
200 (repeat :tag "Levels" :inline t
201 (choice
202 (cons :tag "Heading"
203 (string :tag " numbered")
204 (string :tag "unnumbered"))
205 (list :tag "Environment"
206 (string :tag "Opening (numbered)")
207 (string :tag "Closing (numbered)")
208 (string :tag "Opening (unnumbered)")
209 (string :tag "Closing (unnumbered)"))
210 (function :tag "Hook computing sectioning"))))))
212 (defcustom org-export-latex-inputenc-alist nil
213 "Alist of inputenc coding system names, and what should really be used.
214 For example, adding an entry
216 (\"utf8\" . \"utf8x\")
218 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
219 are written as utf8 files."
220 :group 'org-export-latex
221 :type '(repeat
222 (cons
223 (string :tag "Derived from buffer")
224 (string :tag "Use this instead"))))
227 (defcustom org-export-latex-emphasis-alist
228 '(("*" "\\textbf{%s}" nil)
229 ("/" "\\emph{%s}" nil)
230 ("_" "\\underline{%s}" nil)
231 ("+" "\\st{%s}" nil)
232 ("=" "\\protectedtexttt" t)
233 ("~" "\\verb" t))
234 "Alist of LaTeX expressions to convert emphasis fontifiers.
235 Each element of the list is a list of three elements.
236 The first element is the character used as a marker for fontification.
237 The second element is a formatting string to wrap fontified text with.
238 If it is \"\\verb\", Org will automatically select a delimiter
239 character that is not in the string. \"\\protectedtexttt\" will use \\texttt
240 to typeset and try to protect special characters.
241 The third element decides whether to protect converted text from other
242 conversions."
243 :group 'org-export-latex
244 :type 'alist)
246 (defcustom org-export-latex-title-command "\\maketitle"
247 "The command used to insert the title just after \\begin{document}.
248 If this string contains the formatting specification \"%s\" then
249 it will be used as a formatting string, passing the title as an
250 argument."
251 :group 'org-export-latex
252 :type 'string)
254 (defcustom org-export-latex-import-inbuffer-stuff nil
255 "Non-nil means define TeX macros for Org's inbuffer definitions.
256 For example \orgTITLE for #+TITLE."
257 :group 'org-export-latex
258 :type 'boolean)
260 (defcustom org-export-latex-date-format
261 "\\today"
262 "Format string for \\date{...}."
263 :group 'org-export-latex
264 :type 'string)
266 (defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
267 "Markup for TODO keywords, as a printf format.
268 This can be a single format for all keywords, a cons cell with separate
269 formats for not-done and done states, or an association list with setup
270 for individual keywords. If a keyword shows up for which there is no
271 markup defined, the first one in the association list will be used."
272 :group 'org-export-latex
273 :type '(choice
274 (string :tag "Default")
275 (cons :tag "Distinguish undone and done"
276 (string :tag "Not-DONE states")
277 (string :tag "DONE states"))
278 (repeat :tag "Per keyword markup"
279 (cons
280 (string :tag "Keyword")
281 (string :tag "Markup")))))
283 (defcustom org-export-latex-tag-markup "\\textbf{%s}"
284 "Markup for tags, as a printf format."
285 :group 'org-export-latex
286 :type 'string)
288 (defcustom org-export-latex-timestamp-markup "\\textit{%s}"
289 "A printf format string to be applied to time stamps."
290 :group 'org-export-latex
291 :type 'string)
293 (defcustom org-export-latex-timestamp-inactive-markup "\\textit{%s}"
294 "A printf format string to be applied to inactive time stamps."
295 :group 'org-export-latex
296 :type 'string)
298 (defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
299 "A printf format string to be applied to time stamps."
300 :group 'org-export-latex
301 :type 'string)
303 (defcustom org-export-latex-href-format "\\href{%s}{%s}"
304 "A printf format string to be applied to href links.
305 The format must contain either two %s instances or just one.
306 If it contains two %s instances, the first will be filled with
307 the link, the second with the link description. If it contains
308 only one, the %s will be filled with the link."
309 :group 'org-export-latex
310 :type 'string)
312 (defcustom org-export-latex-hyperref-format "\\hyperref[%s]{%s}"
313 "A printf format string to be applied to hyperref links.
314 The format must contain one or two %s instances. The first one
315 will be filled with the link, the second with its description."
316 :group 'org-export-latex
317 :type 'string)
319 (defcustom org-export-latex-footnote-separator "\\textsuperscript{,}\\,"
320 "Text used to separate footnotes."
321 :group 'org-export-latex
322 :type 'string)
324 (defcustom org-export-latex-quotes
325 '(("fr" ("\\(\\s-\\|[[(]\\)\"" . "«~") ("\\(\\S-\\)\"" . "~»") ("\\(\\s-\\|(\\)'" . "'"))
326 ("en" ("\\(\\s-\\|[[(]\\)\"" . "``") ("\\(\\S-\\)\"" . "''") ("\\(\\s-\\|(\\)'" . "`")))
327 "Alist for quotes to use when converting english double-quotes.
329 The CAR of each item in this alist is the language code.
330 The CDR of each item in this alist is a list of three CONS:
331 - the first CONS defines the opening quote;
332 - the second CONS defines the closing quote;
333 - the last CONS defines single quotes.
335 For each item in a CONS, the first string is a regexp
336 for allowed characters before/after the quote, the second
337 string defines the replacement string for this quote."
338 :group 'org-export-latex
339 :type '(list
340 (cons :tag "Opening quote"
341 (string :tag "Regexp for char before")
342 (string :tag "Replacement quote "))
343 (cons :tag "Closing quote"
344 (string :tag "Regexp for char after ")
345 (string :tag "Replacement quote "))
346 (cons :tag "Single quote"
347 (string :tag "Regexp for char before")
348 (string :tag "Replacement quote "))))
350 (defcustom org-export-latex-tables-verbatim nil
351 "When non-nil, tables are exported verbatim."
352 :group 'org-export-latex
353 :type 'boolean)
355 (defcustom org-export-latex-tables-centered t
356 "When non-nil, tables are exported in a center environment."
357 :group 'org-export-latex
358 :type 'boolean)
360 (defcustom org-export-latex-table-caption-above t
361 "When non-nil, the caption is set above the table. When nil,
362 the caption is set below the table."
363 :group 'org-export-latex
364 :type 'boolean)
366 (defcustom org-export-latex-tables-column-borders nil
367 "When non-nil, grouping columns can cause outer vertical lines in tables.
368 When nil, grouping causes only separation lines between groups."
369 :group 'org-export-latex
370 :type 'boolean)
372 (defcustom org-export-latex-low-levels 'itemize
373 "How to convert sections below the current level of sectioning.
374 This is specified by the `org-export-headline-levels' option or the
375 value of \"H:\" in Org's #+OPTION line.
377 This can be either nil (skip the sections), `description', `itemize',
378 or `enumerate' (convert the sections as the corresponding list type), or
379 a string to be used instead of \\section{%s}. In this latter case,
380 the %s stands here for the inserted headline and is mandatory.
382 It may also be a list of three string to define a user-defined environment
383 that should be used. The first string should be the like
384 \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
385 to two occurrences of %s for the title and a label, respectively. The third
386 string should be like \"\\end{itemize\"."
387 :group 'org-export-latex
388 :type '(choice (const :tag "Ignore" nil)
389 (const :tag "Convert as descriptive list" description)
390 (const :tag "Convert as itemized list" itemize)
391 (const :tag "Convert as enumerated list" enumerate)
392 (list :tag "User-defined environment"
393 :value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
394 (string :tag "Start")
395 (string :tag "End")
396 (string :tag "item"))
397 (string :tag "Use a section string" :value "\\subparagraph{%s}")))
399 (defcustom org-export-latex-list-parameters
400 '(:cbon "$\\boxtimes$" :cboff "$\\Box$" :cbtrans "$\\boxminus$")
401 "Parameters for the LaTeX list exporter.
402 These parameters will be passed on to `org-list-to-latex', which in turn
403 will pass them (combined with the LaTeX default list parameters) to
404 `org-list-to-generic'."
405 :group 'org-export-latex
406 :type 'plist)
408 (defcustom org-export-latex-verbatim-wrap
409 '("\\begin{verbatim}\n" . "\\end{verbatim}")
410 "Environment to be wrapped around a fixed-width section in LaTeX export.
411 This is a cons with two strings, to be added before and after the
412 fixed-with text.
414 Defaults to \\begin{verbatim} and \\end{verbatim}."
415 :group 'org-export-translation
416 :group 'org-export-latex
417 :type '(cons (string :tag "Open")
418 (string :tag "Close")))
420 (defcustom org-export-latex-listings nil
421 "Non-nil means export source code using the listings package.
422 This package will fontify source code, possibly even with color.
423 If you want to use this, you also need to make LaTeX use the
424 listings package, and if you want to have color, the color
425 package. Just add these to `org-export-latex-packages-alist',
426 for example using customize, or with something like
428 (require 'org-latex)
429 (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
430 (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))
432 Alternatively,
434 (setq org-export-latex-listings 'minted)
436 causes source code to be exported using the minted package as
437 opposed to listings. If you want to use minted, you need to add
438 the minted package to `org-export-latex-packages-alist', for
439 example using customize, or with
441 (require 'org-latex)
442 (add-to-list 'org-export-latex-packages-alist '(\"\" \"minted\"))
444 In addition, it is necessary to install
445 pygments (http://pygments.org), and to configure the variable
446 `org-latex-to-pdf-process' so that the -shell-escape option is
447 passed to pdflatex.
449 :group 'org-export-latex
450 :type 'boolean)
452 (defcustom org-export-latex-listings-langs
453 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
454 (c "C") (cc "C++")
455 (fortran "fortran")
456 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
457 (html "HTML") (xml "XML")
458 (tex "TeX") (latex "TeX")
459 (shell-script "bash")
460 (gnuplot "Gnuplot")
461 (ocaml "Caml") (caml "Caml")
462 (sql "SQL") (sqlite "sql"))
463 "Alist mapping languages to their listing language counterpart.
464 The key is a symbol, the major mode symbol without the \"-mode\".
465 The value is the string that should be inserted as the language parameter
466 for the listings package. If the mode name and the listings name are
467 the same, the language does not need an entry in this list - but it does not
468 hurt if it is present."
469 :group 'org-export-latex
470 :type '(repeat
471 (list
472 (symbol :tag "Major mode ")
473 (string :tag "Listings language"))))
475 (defcustom org-export-latex-listings-w-names t
476 "Non-nil means export names of named code blocks.
477 Code blocks exported with the listings package (controlled by the
478 `org-export-latex-listings' variable) can be named in the style
479 of noweb."
480 :group 'org-export-latex
481 :type 'boolean)
483 (defcustom org-export-latex-minted-langs
484 '((emacs-lisp "common-lisp")
485 (cc "c++")
486 (cperl "perl")
487 (shell-script "bash")
488 (caml "ocaml"))
489 "Alist mapping languages to their minted language counterpart.
490 The key is a symbol, the major mode symbol without the \"-mode\".
491 The value is the string that should be inserted as the language parameter
492 for the minted package. If the mode name and the listings name are
493 the same, the language does not need an entry in this list - but it does not
494 hurt if it is present.
496 Note that minted uses all lower case for language identifiers,
497 and that the full list of language identifiers can be obtained
498 with:
499 pygmentize -L lexers
501 :group 'org-export-latex
502 :type '(repeat
503 (list
504 (symbol :tag "Major mode ")
505 (string :tag "Listings language"))))
507 (defcustom org-export-latex-listings-options nil
508 "Association list of options for the latex listings package.
510 These options are supplied as a comma-separated list to the
511 \\lstset command. Each element of the association list should be
512 a list containing two strings: the name of the option, and the
513 value. For example,
515 (setq org-export-latex-listings-options
516 '((\"basicstyle\" \"\\small\")
517 (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
519 will typeset the code in a small size font with underlined, bold
520 black keywords.
522 Note that the same options will be applied to blocks of all
523 languages."
524 :group 'org-export-latex
525 :type '(repeat
526 (list
527 (string :tag "Listings option name ")
528 (string :tag "Listings option value"))))
530 (defcustom org-export-latex-minted-options nil
531 "Association list of options for the latex minted package.
533 These options are supplied within square brackets in
534 \\begin{minted} environments. Each element of the alist should be
535 a list containing two strings: the name of the option, and the
536 value. For example,
538 (setq org-export-latex-minted-options
539 '((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
541 will result in src blocks being exported with
543 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
545 as the start of the minted environment. Note that the same
546 options will be applied to blocks of all languages."
547 :group 'org-export-latex
548 :type '(repeat
549 (list
550 (string :tag "Minted option name ")
551 (string :tag "Minted option value"))))
553 (defvar org-export-latex-custom-lang-environments nil
554 "Association list mapping languages to language-specific latex
555 environments used during export of src blocks by the listings
556 and minted latex packages. For example,
558 (setq org-export-latex-custom-lang-environments
559 '((python \"pythoncode\")))
561 would have the effect that if org encounters begin_src python
562 during latex export it will output
564 \\begin{pythoncode}
565 <src block body>
566 \\end{pythoncode}")
568 (defcustom org-export-latex-remove-from-headlines
569 '(:todo nil :priority nil :tags nil)
570 "A plist of keywords to remove from headlines. OBSOLETE.
571 Non-nil means remove this keyword type from the headline.
573 Don't remove the keys, just change their values.
575 Obsolete, this variable is no longer used. Use the separate
576 variables `org-export-with-todo-keywords', `org-export-with-priority',
577 and `org-export-with-tags' instead."
578 :type 'plist
579 :group 'org-export-latex)
581 (defcustom org-export-latex-image-default-option "width=.9\\linewidth"
582 "Default option for images."
583 :group 'org-export-latex
584 :type 'string)
586 (defcustom org-latex-default-figure-position "htb"
587 "Default position for latex figures."
588 :group 'org-export-latex
589 :type 'string)
591 (defcustom org-export-latex-tabular-environment "tabular"
592 "Default environment used to build tables."
593 :group 'org-export-latex
594 :type 'string)
596 (defcustom org-export-latex-inline-image-extensions
597 '("pdf" "jpeg" "jpg" "png" "ps" "eps")
598 "Extensions of image files that can be inlined into LaTeX.
599 Note that the image extension *actually* allowed depend on the way the
600 LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
601 are OK. When processing through dvi to Postscript, only ps and eps are
602 allowed. The default we use here encompasses both."
603 :group 'org-export-latex
604 :type '(repeat (string :tag "Extension")))
606 (defcustom org-export-latex-coding-system nil
607 "Coding system for the exported LaTeX file."
608 :group 'org-export-latex
609 :type 'coding-system)
611 (defgroup org-export-pdf nil
612 "Options for exporting Org-mode files to PDF, via LaTeX."
613 :tag "Org Export PDF"
614 :group 'org-export-latex
615 :group 'org-export)
617 (defcustom org-latex-to-pdf-process
618 '("pdflatex -interaction nonstopmode -output-directory %o %f"
619 "pdflatex -interaction nonstopmode -output-directory %o %f"
620 "pdflatex -interaction nonstopmode -output-directory %o %f")
621 "Commands to process a LaTeX file to a PDF file.
622 This is a list of strings, each of them will be given to the shell
623 as a command. %f in the command will be replaced by the full file name, %b
624 by the file base name (i.e. without extension) and %o by the base directory
625 of the file.
627 The reason why this is a list is that it usually takes several runs of
628 `pdflatex', maybe mixed with a call to `bibtex'. Org does not have a clever
629 mechanism to detect which of these commands have to be run to get to a stable
630 result, and it also does not do any error checking.
632 By default, Org uses 3 runs of `pdflatex' to do the processing. If you
633 have texi2dvi on your system and if that does not cause the infamous
634 egrep/locale bug:
636 http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
638 then `texi2dvi' is the superior choice. Org does offer it as one
639 of the customize options.
641 Alternatively, this may be a Lisp function that does the processing, so you
642 could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
643 This function should accept the file name as its single argument."
644 :group 'org-export-pdf
645 :type '(choice
646 (repeat :tag "Shell command sequence"
647 (string :tag "Shell command"))
648 (const :tag "2 runs of pdflatex"
649 ("pdflatex -interaction nonstopmode -output-directory %o %f"
650 "pdflatex -interaction nonstopmode -output-directory %o %f"))
651 (const :tag "3 runs of pdflatex"
652 ("pdflatex -interaction nonstopmode -output-directory %o %f"
653 "pdflatex -interaction nonstopmode -output-directory %o %f"
654 "pdflatex -interaction nonstopmode -output-directory %o %f"))
655 (const :tag "pdflatex,bibtex,pdflatex,pdflatex"
656 ("pdflatex -interaction nonstopmode -output-directory %o %f"
657 "bibtex %b"
658 "pdflatex -interaction nonstopmode -output-directory %o %f"
659 "pdflatex -interaction nonstopmode -output-directory %o %f"))
660 (const :tag "texi2dvi"
661 ("texi2dvi -p -b -c -V %f"))
662 (const :tag "rubber"
663 ("rubber -d --into %o %f"))
664 (function)))
666 (defcustom org-export-pdf-logfiles
667 '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
668 "The list of file extensions to consider as LaTeX logfiles."
669 :group 'org-export-pdf
670 :type '(repeat (string :tag "Extension")))
672 (defcustom org-export-pdf-remove-logfiles t
673 "Non-nil means remove the logfiles produced by PDF production.
674 These are the .aux, .log, .out, and .toc files."
675 :group 'org-export-pdf
676 :type 'boolean)
678 ;;; Hooks
680 (defvar org-export-latex-after-initial-vars-hook nil
681 "Hook run before LaTeX export.
682 The exact moment is after the initial variables like org-export-latex-class
683 have been determined from the environment.")
685 (defvar org-export-latex-after-blockquotes-hook nil
686 "Hook run during LaTeX export, after blockquote, verse, center are done.")
688 (defvar org-export-latex-final-hook nil
689 "Hook run in the finalized LaTeX buffer.")
691 (defvar org-export-latex-after-save-hook nil
692 "Hook run in the finalized LaTeX buffer, after it has been saved.")
694 ;;; Autoload functions:
696 ;;;###autoload
697 (defun org-export-as-latex-batch ()
698 "Call `org-export-as-latex', may be used in batch processing.
699 For example:
701 emacs --batch
702 --load=$HOME/lib/emacs/org.el
703 --eval \"(setq org-export-headline-levels 2)\"
704 --visit=MyFile --funcall org-export-as-latex-batch"
705 (org-export-as-latex org-export-headline-levels 'hidden))
707 ;;;###autoload
708 (defun org-export-as-latex-to-buffer (arg)
709 "Call `org-export-as-latex` with output to a temporary buffer.
710 No file is created. The prefix ARG is passed through to `org-export-as-latex'."
711 (interactive "P")
712 (org-export-as-latex arg nil nil "*Org LaTeX Export*")
713 (when org-export-show-temporary-export-buffer
714 (switch-to-buffer-other-window "*Org LaTeX Export*")))
716 ;;;###autoload
717 (defun org-replace-region-by-latex (beg end)
718 "Replace the region from BEG to END with its LaTeX export.
719 It assumes the region has `org-mode' syntax, and then convert it to
720 LaTeX. This can be used in any buffer. For example, you could
721 write an itemized list in `org-mode' syntax in an LaTeX buffer and
722 then use this command to convert it."
723 (interactive "r")
724 (let (reg latex buf)
725 (save-window-excursion
726 (if (eq major-mode 'org-mode)
727 (setq latex (org-export-region-as-latex
728 beg end t 'string))
729 (setq reg (buffer-substring beg end)
730 buf (get-buffer-create "*Org tmp*"))
731 (with-current-buffer buf
732 (erase-buffer)
733 (insert reg)
734 (org-mode)
735 (setq latex (org-export-region-as-latex
736 (point-min) (point-max) t 'string)))
737 (kill-buffer buf)))
738 (delete-region beg end)
739 (insert latex)))
741 ;;;###autoload
742 (defun org-export-region-as-latex (beg end &optional body-only buffer)
743 "Convert region from BEG to END in `org-mode' buffer to LaTeX.
744 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
745 contents, and only produce the region of converted text, useful for
746 cut-and-paste operations.
747 If BUFFER is a buffer or a string, use/create that buffer as a target
748 of the converted LaTeX. If BUFFER is the symbol `string', return the
749 produced LaTeX as a string and leave no buffer behind. For example,
750 a Lisp program could call this function in the following way:
752 (setq latex (org-export-region-as-latex beg end t 'string))
754 When called interactively, the output buffer is selected, and shown
755 in a window. A non-interactive call will only return the buffer."
756 (interactive "r\nP")
757 (when (org-called-interactively-p 'any)
758 (setq buffer "*Org LaTeX Export*"))
759 (let ((transient-mark-mode t) (zmacs-regions t)
760 ext-plist rtn)
761 (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
762 (goto-char end)
763 (set-mark (point)) ;; to activate the region
764 (goto-char beg)
765 (setq rtn (org-export-as-latex
766 nil nil ext-plist
767 buffer body-only))
768 (if (fboundp 'deactivate-mark) (deactivate-mark))
769 (if (and (org-called-interactively-p 'any) (bufferp rtn))
770 (switch-to-buffer-other-window rtn)
771 rtn)))
773 ;;;###autoload
774 (defun org-export-as-latex (arg &optional hidden ext-plist
775 to-buffer body-only pub-dir)
776 "Export current buffer to a LaTeX file.
777 If there is an active region, export only the region. The prefix
778 ARG specifies how many levels of the outline should become
779 headlines. The default is 3. Lower levels will be exported
780 depending on `org-export-latex-low-levels'. The default is to
781 convert them as description lists.
782 HIDDEN is obsolete and does nothing.
783 EXT-PLIST is a property list with
784 external parameters overriding org-mode's default settings, but
785 still inferior to file-local settings. When TO-BUFFER is
786 non-nil, create a buffer with that name and export to that
787 buffer. If TO-BUFFER is the symbol `string', don't leave any
788 buffer behind but just return the resulting LaTeX as a string.
789 When BODY-ONLY is set, don't produce the file header and footer,
790 simply return the content of \\begin{document}...\\end{document},
791 without even the \\begin{document} and \\end{document} commands.
792 when PUB-DIR is set, use this as the publishing directory."
793 (interactive "P")
794 (when (and (not body-only) arg (listp arg)) (setq body-only t))
795 (run-hooks 'org-export-first-hook)
797 ;; Make sure we have a file name when we need it.
798 (when (and (not (or to-buffer body-only))
799 (not buffer-file-name))
800 (if (buffer-base-buffer)
801 (org-set-local 'buffer-file-name
802 (with-current-buffer (buffer-base-buffer)
803 buffer-file-name))
804 (error "Need a file name to be able to export")))
806 (message "Exporting to LaTeX...")
807 (org-unmodified
808 (let ((inhibit-read-only t))
809 (remove-text-properties (point-min) (point-max)
810 '(:org-license-to-kill nil))))
811 (org-update-radio-target-regexp)
812 (org-export-latex-set-initial-vars ext-plist arg)
813 (setq org-export-opt-plist org-export-latex-options-plist
814 org-export-footnotes-data (org-footnote-all-labels 'with-defs)
815 org-export-footnotes-seen nil
816 org-export-latex-footmark-seen nil)
817 (org-install-letbind)
818 (run-hooks 'org-export-latex-after-initial-vars-hook)
819 (let* ((wcf (current-window-configuration))
820 (opt-plist
821 (org-export-process-option-filters org-export-latex-options-plist))
822 (region-p (org-region-active-p))
823 (rbeg (and region-p (region-beginning)))
824 (rend (and region-p (region-end)))
825 (subtree-p
826 (if (plist-get opt-plist :ignore-subtree-p)
828 (when region-p
829 (save-excursion
830 (goto-char rbeg)
831 (and (org-at-heading-p)
832 (>= (org-end-of-subtree t t) rend))))))
833 (opt-plist (setq org-export-opt-plist
834 (if subtree-p
835 (org-export-add-subtree-options opt-plist rbeg)
836 opt-plist)))
837 ;; Make sure the variable contains the updated values.
838 (org-export-latex-options-plist (setq org-export-opt-plist opt-plist))
839 ;; The following two are dynamically scoped into other
840 ;; routines below.
841 (org-current-export-dir
842 (or pub-dir (org-export-directory :html opt-plist)))
843 (org-current-export-file buffer-file-name)
844 (title (or (and subtree-p (org-export-get-title-from-subtree))
845 (plist-get opt-plist :title)
846 (and (not
847 (plist-get opt-plist :skip-before-1st-heading))
848 (org-export-grab-title-from-buffer))
849 (and buffer-file-name
850 (file-name-sans-extension
851 (file-name-nondirectory buffer-file-name)))
852 "No Title"))
853 (filename
854 (and (not to-buffer)
855 (concat
856 (file-name-as-directory
857 (or pub-dir
858 (org-export-directory :LaTeX ext-plist)))
859 (file-name-sans-extension
860 (or (and subtree-p
861 (org-entry-get rbeg "EXPORT_FILE_NAME" t))
862 (file-name-nondirectory ;sans-extension
863 (or buffer-file-name
864 (error "Don't know which export file to use")))))
865 ".tex")))
866 (filename
867 (and filename
868 (if (equal (file-truename filename)
869 (file-truename (or buffer-file-name "dummy.org")))
870 (concat filename ".tex")
871 filename)))
872 (auto-insert nil); Avoid any auto-insert stuff for the new file
873 (TeX-master t) ; Avoid the Query for TeX master from AUCTeX
874 (buffer (if to-buffer
875 (cond
876 ((eq to-buffer 'string) (get-buffer-create
877 "*Org LaTeX Export*"))
878 (t (get-buffer-create to-buffer)))
879 (find-file-noselect filename)))
880 (odd org-odd-levels-only)
881 (header (org-export-latex-make-header title opt-plist))
882 (skip (cond (subtree-p nil)
883 (region-p nil)
884 (t (plist-get opt-plist :skip-before-1st-heading))))
885 (text (plist-get opt-plist :text))
886 (org-export-preprocess-hook
887 (cons
888 `(lambda () (org-set-local 'org-complex-heading-regexp
889 ,org-export-latex-complex-heading-re))
890 org-export-preprocess-hook))
891 (first-lines (if skip "" (org-export-latex-first-lines
892 opt-plist
893 (if subtree-p
894 (save-excursion
895 (goto-char rbeg)
896 (point-at-bol 2))
897 rbeg)
898 (if region-p rend))))
899 (coding-system (and (boundp 'buffer-file-coding-system)
900 buffer-file-coding-system))
901 (coding-system-for-write (or org-export-latex-coding-system
902 coding-system))
903 (save-buffer-coding-system (or org-export-latex-coding-system
904 coding-system))
905 (region (buffer-substring
906 (if region-p (region-beginning) (point-min))
907 (if region-p (region-end) (point-max))))
908 (text
909 (and text (string-match "\\S-" text)
910 (org-export-preprocess-string
911 text
912 :emph-multiline t
913 :for-backend 'latex
914 :comments nil
915 :tags (plist-get opt-plist :tags)
916 :priority (plist-get opt-plist :priority)
917 :footnotes (plist-get opt-plist :footnotes)
918 :drawers (plist-get opt-plist :drawers)
919 :timestamps (plist-get opt-plist :timestamps)
920 :todo-keywords (plist-get opt-plist :todo-keywords)
921 :tasks (plist-get opt-plist :tasks)
922 :add-text nil
923 :skip-before-1st-heading skip
924 :select-tags nil
925 :exclude-tags nil
926 :LaTeX-fragments nil)))
927 (string-for-export
928 (org-export-preprocess-string
929 region
930 :emph-multiline t
931 :for-backend 'latex
932 :comments nil
933 :tags (plist-get opt-plist :tags)
934 :priority (plist-get opt-plist :priority)
935 :footnotes (plist-get opt-plist :footnotes)
936 :drawers (plist-get opt-plist :drawers)
937 :timestamps (plist-get opt-plist :timestamps)
938 :todo-keywords (plist-get opt-plist :todo-keywords)
939 :tasks (plist-get opt-plist :tasks)
940 :add-text (if (eq to-buffer 'string) nil text)
941 :skip-before-1st-heading skip
942 :select-tags (plist-get opt-plist :select-tags)
943 :exclude-tags (plist-get opt-plist :exclude-tags)
944 :LaTeX-fragments nil)))
946 (set-buffer buffer)
947 (erase-buffer)
948 (org-install-letbind)
950 (and (fboundp 'set-buffer-file-coding-system)
951 (set-buffer-file-coding-system coding-system-for-write))
953 ;; insert the header and initial document commands
954 (unless (or (eq to-buffer 'string) body-only)
955 (insert header))
957 ;; insert text found in #+TEXT
958 (when (and text (not (eq to-buffer 'string)))
959 (insert (org-export-latex-content
960 text '(lists tables fixed-width keywords))
961 "\n\n"))
963 ;; insert lines before the first headline
964 (unless (or skip (string-match "^\\*" first-lines))
965 (insert first-lines))
967 ;; export the content of headlines
968 (org-export-latex-global
969 (with-temp-buffer
970 (insert string-for-export)
971 (goto-char (point-min))
972 (when (re-search-forward "^\\(\\*+\\) " nil t)
973 (let* ((asters (length (match-string 1)))
974 (level (if odd (- asters 2) (- asters 1))))
975 (setq org-export-latex-add-level
976 (if odd (1- (/ (1+ asters) 2)) (1- asters)))
977 (org-export-latex-parse-global level odd)))))
979 ;; finalization
980 (unless body-only (insert "\n\\end{document}"))
982 ;; Attach description terms to the \item macro
983 (goto-char (point-min))
984 (while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t)
985 (delete-region (match-beginning 1) (match-end 1)))
987 ;; Relocate the table of contents
988 (goto-char (point-min))
989 (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
990 (goto-char (point-min))
991 (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
992 (replace-match ""))
993 (goto-char (point-min))
994 (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
995 (replace-match "\\tableofcontents" t t)))
997 ;; Cleanup forced line ends in items where they are not needed
998 (goto-char (point-min))
999 (while (re-search-forward
1000 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
1001 nil t)
1002 (delete-region (match-beginning 1) (match-end 1)))
1003 (goto-char (point-min))
1004 (while (re-search-forward
1005 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
1006 nil t)
1007 (if (looking-at "[\n \t]+")
1008 (replace-match "\n")))
1010 (run-hooks 'org-export-latex-final-hook)
1011 (if to-buffer
1012 (unless (eq major-mode 'latex-mode) (latex-mode))
1013 (save-buffer))
1014 (org-export-latex-fix-inputenc)
1015 (run-hooks 'org-export-latex-after-save-hook)
1016 (goto-char (point-min))
1017 (or (org-export-push-to-kill-ring "LaTeX")
1018 (message "Exporting to LaTeX...done"))
1019 (prog1
1020 (if (eq to-buffer 'string)
1021 (prog1 (buffer-substring (point-min) (point-max))
1022 (kill-buffer (current-buffer)))
1023 (current-buffer))
1024 (set-window-configuration wcf))))
1026 ;;;###autoload
1027 (defun org-export-as-pdf (arg &optional hidden ext-plist
1028 to-buffer body-only pub-dir)
1029 "Export as LaTeX, then process through to PDF."
1030 (interactive "P")
1031 (message "Exporting to PDF...")
1032 (let* ((wconfig (current-window-configuration))
1033 (lbuf (org-export-as-latex arg hidden ext-plist
1034 to-buffer body-only pub-dir))
1035 (file (buffer-file-name lbuf))
1036 (base (file-name-sans-extension (buffer-file-name lbuf)))
1037 (pdffile (concat base ".pdf"))
1038 (cmds (if (eq org-export-latex-listings 'minted)
1039 ;; automatically add -shell-escape when needed
1040 (mapcar (lambda (cmd)
1041 (replace-regexp-in-string
1042 "pdflatex " "pdflatex -shell-escape " cmd))
1043 org-latex-to-pdf-process)
1044 org-latex-to-pdf-process))
1045 (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
1046 (bibtex-p (with-current-buffer lbuf
1047 (save-excursion
1048 (goto-char (point-min))
1049 (re-search-forward "\\\\bibliography{" nil t))))
1050 cmd output-dir errors)
1051 (with-current-buffer outbuf (erase-buffer))
1052 (message (concat "Processing LaTeX file " file "..."))
1053 (setq output-dir (file-name-directory file))
1054 (with-current-buffer lbuf
1055 (save-excursion
1056 (if (and cmds (symbolp cmds))
1057 (funcall cmds (shell-quote-argument file))
1058 (while cmds
1059 (setq cmd (pop cmds))
1060 (while (string-match "%b" cmd)
1061 (setq cmd (replace-match
1062 (save-match-data
1063 (shell-quote-argument base))
1064 t t cmd)))
1065 (while (string-match "%f" cmd)
1066 (setq cmd (replace-match
1067 (save-match-data
1068 (shell-quote-argument file))
1069 t t cmd)))
1070 (while (string-match "%o" cmd)
1071 (setq cmd (replace-match
1072 (save-match-data
1073 (shell-quote-argument output-dir))
1074 t t cmd)))
1075 (shell-command cmd outbuf)))))
1076 (message (concat "Processing LaTeX file " file "...done"))
1077 (setq errors (org-export-latex-get-error outbuf))
1078 (if (not (file-exists-p pdffile))
1079 (error (concat "PDF file " pdffile " was not produced"
1080 (if errors (concat ":" errors "") "")))
1081 (set-window-configuration wconfig)
1082 (when org-export-pdf-remove-logfiles
1083 (dolist (ext org-export-pdf-logfiles)
1084 (setq file (concat base "." ext))
1085 (and (file-exists-p file) (delete-file file))))
1086 (message (concat
1087 "Exporting to PDF...done"
1088 (if errors
1089 (concat ", with some errors:" errors)
1090 "")))
1091 pdffile)))
1093 (defun org-export-latex-get-error (buf)
1094 "Collect the kinds of errors that remain in pdflatex processing."
1095 (with-current-buffer buf
1096 (save-excursion
1097 (goto-char (point-max))
1098 (when (re-search-backward "^[ \t]*This is pdf.*?TeX.*?Version" nil t)
1099 ;; OK, we are at the location of the final run
1100 (let ((pos (point)) (errors "") (case-fold-search t))
1101 (if (re-search-forward "Reference.*?undefined" nil t)
1102 (setq errors (concat errors " [undefined reference]")))
1103 (goto-char pos)
1104 (if (re-search-forward "Citation.*?undefined" nil t)
1105 (setq errors (concat errors " [undefined citation]")))
1106 (goto-char pos)
1107 (if (re-search-forward "Undefined control sequence" nil t)
1108 (setq errors (concat errors " [undefined control sequence]")))
1109 (and (org-string-nw-p errors) errors))))))
1111 ;;;###autoload
1112 (defun org-export-as-pdf-and-open (arg)
1113 "Export as LaTeX, then process through to PDF, and open."
1114 (interactive "P")
1115 (let ((pdffile (org-export-as-pdf arg)))
1116 (if pdffile
1117 (progn
1118 (org-open-file pdffile)
1119 (when org-export-kill-product-buffer-when-displayed
1120 (kill-buffer (find-buffer-visiting
1121 (concat (file-name-sans-extension (buffer-file-name))
1122 ".tex")))))
1123 (error "PDF file was not produced"))))
1125 ;;; Parsing functions:
1127 (defun org-export-latex-parse-global (level odd)
1128 "Parse the current buffer recursively, starting at LEVEL.
1129 If ODD is non-nil, assume the buffer only contains odd sections.
1130 Return a list reflecting the document structure."
1131 (save-excursion
1132 (goto-char (point-min))
1133 (let* ((cnt 0) output
1134 (depth org-export-latex-sectioning-depth))
1135 (while (org-re-search-forward-unprotected
1136 (concat "^\\(\\(?:\\*\\)\\{"
1137 (number-to-string (+ (if odd 2 1) level))
1138 "\\}\\) \\(.*\\)$")
1139 ;; make sure that there is no upper heading
1140 (when (> level 0)
1141 (save-excursion
1142 (save-match-data
1143 (org-re-search-forward-unprotected
1144 (concat "^\\(\\(?:\\*\\)\\{"
1145 (number-to-string level)
1146 "\\}\\) \\(.*\\)$") nil t)))) t)
1147 (setq cnt (1+ cnt))
1148 (let* ((pos (match-beginning 0))
1149 (heading (match-string 2))
1150 (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
1151 (save-excursion
1152 (narrow-to-region
1153 (point)
1154 (save-match-data
1155 (if (org-re-search-forward-unprotected
1156 (concat "^\\(\\(?:\\*\\)\\{"
1157 (number-to-string (+ (if odd 2 1) level))
1158 "\\}\\) \\(.*\\)$") nil t)
1159 (match-beginning 0)
1160 (point-max))))
1161 (goto-char (point-min))
1162 (setq output
1163 (append output
1164 (list
1165 (list
1166 `(pos . ,pos)
1167 `(level . ,nlevel)
1168 `(occur . ,cnt)
1169 `(heading . ,heading)
1170 `(content . ,(org-export-latex-parse-content))
1171 `(subcontent . ,(org-export-latex-parse-subcontent
1172 level odd)))))))
1173 (widen)))
1174 (list output))))
1176 (defun org-export-latex-parse-content ()
1177 "Extract the content of a section."
1178 (let ((beg (point))
1179 (end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t)
1180 (progn (beginning-of-line) (point))
1181 (point-max))))
1182 (buffer-substring beg end)))
1184 (defun org-export-latex-parse-subcontent (level odd)
1185 "Extract the subcontent of a section at LEVEL.
1186 If ODD Is non-nil, assume subcontent only contains odd sections."
1187 (if (not (org-re-search-forward-unprotected
1188 (concat "^\\(\\(?:\\*\\)\\{"
1189 (number-to-string (+ (if odd 4 2) level))
1190 "\\}\\) \\(.*\\)$")
1191 nil t))
1192 nil ; subcontent is nil
1193 (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
1195 ;;; Rendering functions:
1196 (defun org-export-latex-global (content)
1197 "Export CONTENT to LaTeX.
1198 CONTENT is an element of the list produced by
1199 `org-export-latex-parse-global'."
1200 (if (eq (car content) 'subcontent)
1201 (mapc 'org-export-latex-sub (cdr content))
1202 (org-export-latex-sub (car content))))
1204 (defun org-export-latex-sub (subcontent)
1205 "Export the list SUBCONTENT to LaTeX.
1206 SUBCONTENT is an alist containing information about the headline
1207 and its content."
1208 (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
1209 (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
1211 (defun org-export-latex-subcontent (subcontent num)
1212 "Export each cell of SUBCONTENT to LaTeX.
1213 If NUM is non-nil export numbered sections, otherwise use unnumbered
1214 sections. If NUM is an integer, export the highest NUM levels as
1215 numbered sections and lower levels as unnumbered sections."
1216 (let* ((heading (cdr (assoc 'heading subcontent)))
1217 (level (- (cdr (assoc 'level subcontent))
1218 org-export-latex-add-level))
1219 (occur (number-to-string (cdr (assoc 'occur subcontent))))
1220 (content (cdr (assoc 'content subcontent)))
1221 (subcontent (cadr (assoc 'subcontent subcontent)))
1222 (label (org-get-text-property-any 0 'target heading))
1223 (label-list (cons label (cdr (assoc label
1224 org-export-target-aliases))))
1225 (sectioning org-export-latex-sectioning)
1226 (depth org-export-latex-sectioning-depth)
1227 main-heading sub-heading)
1228 (when (symbolp (car sectioning))
1229 (setq sectioning (funcall (car sectioning) level heading))
1230 (when sectioning
1231 (setq heading (car sectioning)
1232 sectioning (cdr sectioning)
1233 ;; target property migh have changed...
1234 label (org-get-text-property-any 0 'target heading)
1235 label-list (cons label (cdr (assoc label
1236 org-export-target-aliases)))))
1237 (if sectioning (setq sectioning (make-list 10 sectioning)))
1238 (setq depth (if sectioning 10000 0)))
1239 (if (string-match "[ \t]*\\\\\\\\[ \t]*" heading)
1240 (setq main-heading (substring heading 0 (match-beginning 0))
1241 sub-heading (substring heading (match-end 0))))
1242 (setq heading (org-export-latex-fontify-headline heading)
1243 sub-heading (and sub-heading
1244 (org-export-latex-fontify-headline sub-heading))
1245 main-heading (and main-heading
1246 (org-export-latex-fontify-headline main-heading)))
1247 (cond
1248 ;; Normal conversion
1249 ((<= level depth)
1250 (let* ((sec (nth (1- level) sectioning))
1251 (num (if (integerp num)
1252 (>= num level)
1253 num))
1254 start end)
1255 (if (consp (cdr sec))
1256 (setq start (nth (if num 0 2) sec)
1257 end (nth (if num 1 3) sec))
1258 (setq start (if num (car sec) (cdr sec))))
1259 (insert (format start (if main-heading main-heading heading)
1260 (or sub-heading "")))
1261 (insert "\n")
1262 (when label
1263 (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
1264 label-list "\n") "\n"))
1265 (insert (org-export-latex-content content))
1266 (cond ((stringp subcontent) (insert subcontent))
1267 ((listp subcontent)
1268 (while (org-looking-back "\n\n") (backward-delete-char 1))
1269 (org-export-latex-sub subcontent)))
1270 (when (and end (string-match "[^ \t]" end))
1271 (let ((hook (org-get-text-property-any 0 'org-insert-hook end)))
1272 (and (functionp hook) (funcall hook)))
1273 (insert end "\n"))))
1274 ;; At a level under the hl option: we can drop this subsection
1275 ((> level depth)
1276 (cond ((eq org-export-latex-low-levels 'description)
1277 (if (string-match "% ends low level$"
1278 (buffer-substring (point-at-bol 0) (point)))
1279 (delete-region (point-at-bol 0) (point))
1280 (insert "\\begin{description}\n"))
1281 (insert (format "\n\\item[%s]%s~\n"
1282 heading
1283 (if label (format "\\label{%s}" label) "")))
1284 (insert (org-export-latex-content content))
1285 (cond ((stringp subcontent) (insert subcontent))
1286 ((listp subcontent) (org-export-latex-sub subcontent)))
1287 (insert "\\end{description} % ends low level\n"))
1288 ((memq org-export-latex-low-levels '(itemize enumerate))
1289 (if (string-match "% ends low level$"
1290 (buffer-substring (point-at-bol 0) (point)))
1291 (delete-region (point-at-bol 0) (point))
1292 (insert (format "\\begin{%s}\n"
1293 (symbol-name org-export-latex-low-levels))))
1294 (insert (format "\n\\item %s\\\\\n%s%%"
1295 heading
1296 (if label (format "\\label{%s}" label) "")))
1297 (insert (org-export-latex-content content))
1298 (cond ((stringp subcontent) (insert subcontent))
1299 ((listp subcontent) (org-export-latex-sub subcontent)))
1300 (insert (format "\\end{%s} %% ends low level\n"
1301 (symbol-name org-export-latex-low-levels))))
1303 ((listp org-export-latex-low-levels)
1304 (if (string-match "% ends low level$"
1305 (buffer-substring (point-at-bol 0) (point)))
1306 (delete-region (point-at-bol 0) (point))
1307 (insert (car org-export-latex-low-levels) "\n"))
1308 (insert (format (nth 2 org-export-latex-low-levels)
1309 heading
1310 (if label (format "\\label{%s}" label) "")))
1311 (insert (org-export-latex-content content))
1312 (cond ((stringp subcontent) (insert subcontent))
1313 ((listp subcontent) (org-export-latex-sub subcontent)))
1314 (insert (nth 1 org-export-latex-low-levels)
1315 " %% ends low level\n"))
1317 ((stringp org-export-latex-low-levels)
1318 (insert (format org-export-latex-low-levels heading) "\n")
1319 (when label (insert (format "\\label{%s}\n" label)))
1320 (insert (org-export-latex-content content))
1321 (cond ((stringp subcontent) (insert subcontent))
1322 ((listp subcontent) (org-export-latex-sub subcontent)))))))))
1324 ;;; Exporting internals:
1325 (defun org-export-latex-set-initial-vars (ext-plist level)
1326 "Store org local variables required for LaTeX export.
1327 EXT-PLIST is an optional additional plist.
1328 LEVEL indicates the default depth for export."
1329 (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
1330 org-export-latex-done-keywords org-done-keywords
1331 org-export-latex-not-done-keywords org-not-done-keywords
1332 org-export-latex-complex-heading-re org-complex-heading-regexp
1333 org-export-latex-display-custom-times org-display-custom-times
1334 org-export-latex-all-targets-re
1335 (org-make-target-link-regexp (org-all-targets))
1336 org-export-latex-options-plist
1337 (org-combine-plists (org-default-export-plist) ext-plist
1338 (org-infile-export-plist))
1339 org-export-latex-class
1340 (or (and (org-region-active-p)
1341 (save-excursion
1342 (goto-char (region-beginning))
1343 (and (looking-at org-complex-heading-regexp)
1344 (org-entry-get nil "LaTeX_CLASS" 'selective))))
1345 (save-excursion
1346 (save-restriction
1347 (widen)
1348 (goto-char (point-min))
1349 (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([-/a-zA-Z]+\\)" nil t)
1350 (match-string 1))))
1351 (plist-get org-export-latex-options-plist :latex-class)
1352 org-export-latex-default-class)
1353 org-export-latex-class-options
1354 (or (and (org-region-active-p)
1355 (save-excursion
1356 (goto-char (region-beginning))
1357 (and (looking-at org-complex-heading-regexp)
1358 (org-entry-get nil "LaTeX_CLASS_OPTIONS" 'selective))))
1359 (save-excursion
1360 (save-restriction
1361 (widen)
1362 (goto-char (point-min))
1363 (and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t)
1364 (match-string 1))))
1365 (plist-get org-export-latex-options-plist :latex-class-options))
1366 org-export-latex-class
1367 (or (car (assoc org-export-latex-class org-export-latex-classes))
1368 (error "No definition for class `%s' in `org-export-latex-classes'"
1369 org-export-latex-class))
1370 org-export-latex-header
1371 (cadr (assoc org-export-latex-class org-export-latex-classes))
1372 org-export-latex-sectioning
1373 (cddr (assoc org-export-latex-class org-export-latex-classes))
1374 org-export-latex-sectioning-depth
1375 (or level
1376 (let ((hl-levels
1377 (plist-get org-export-latex-options-plist :headline-levels))
1378 (sec-depth (length org-export-latex-sectioning)))
1379 (if (> hl-levels sec-depth) sec-depth hl-levels))))
1380 (when (and org-export-latex-class-options
1381 (string-match "\\S-" org-export-latex-class-options)
1382 (string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
1383 org-export-latex-header))
1384 (setq org-export-latex-header
1385 (concat (substring org-export-latex-header 0 (match-end 1))
1386 org-export-latex-class-options
1387 (substring org-export-latex-header (match-end 0))))))
1389 (defvar org-export-latex-format-toc-function
1390 'org-export-latex-format-toc-default
1391 "The function formatting returning the string to create the table of contents.
1392 The function mus take one parameter, the depth of the table of contents.")
1394 (defun org-export-latex-make-header (title opt-plist)
1395 "Make the LaTeX header and return it as a string.
1396 TITLE is the current title from the buffer or region.
1397 OPT-PLIST is the options plist for current buffer."
1398 (let ((toc (plist-get opt-plist :table-of-contents))
1399 (author (org-export-apply-macros-in-string
1400 (plist-get opt-plist :author)))
1401 (email (replace-regexp-in-string
1402 "_" "\\\\_"
1403 (org-export-apply-macros-in-string
1404 (plist-get opt-plist :email))))
1405 (description (org-export-apply-macros-in-string
1406 (plist-get opt-plist :description)))
1407 (keywords (org-export-apply-macros-in-string
1408 (plist-get opt-plist :keywords))))
1409 (concat
1410 (if (plist-get opt-plist :time-stamp-file)
1411 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1412 ;; insert LaTeX custom header and packages from the list
1413 (org-splice-latex-header
1414 (org-export-apply-macros-in-string org-export-latex-header)
1415 org-export-latex-default-packages-alist
1416 org-export-latex-packages-alist nil
1417 (org-export-apply-macros-in-string
1418 (plist-get opt-plist :latex-header-extra)))
1419 ;; append another special variable
1420 (org-export-apply-macros-in-string org-export-latex-append-header)
1421 ;; define alert if not yet defined
1422 "\n\\providecommand{\\alert}[1]{\\textbf{#1}}"
1423 ;; insert the title
1424 (format
1425 "\n\n\\title{%s}\n"
1426 (org-export-latex-fontify-headline title))
1427 ;; insert author info
1428 (if (plist-get opt-plist :author-info)
1429 (format "\\author{%s%s}\n"
1430 (org-export-latex-fontify-headline (or author user-full-name))
1431 (if (and (plist-get opt-plist :email-info) email
1432 (string-match "\\S-" email))
1433 (format "\\thanks{%s}" email)
1434 ""))
1435 (format "%%\\author{%s}\n"
1436 (org-export-latex-fontify-headline (or author user-full-name))))
1437 ;; insert the date
1438 (format "\\date{%s}\n"
1439 (format-time-string
1440 (or (plist-get opt-plist :date)
1441 org-export-latex-date-format)))
1442 ;; add some hyperref options
1443 ;; FIXME: let's have a defcustom for this?
1444 (format "\\hypersetup{\n pdfkeywords={%s},\n pdfsubject={%s},\n pdfcreator={%s}}\n"
1445 (org-export-latex-fontify-headline keywords)
1446 (org-export-latex-fontify-headline description)
1447 (concat "Emacs Org-mode version " org-version))
1448 ;; beginning of the document
1449 "\n\\begin{document}\n\n"
1450 ;; insert the title command
1451 (when (string-match "\\S-" title)
1452 (if (string-match "%s" org-export-latex-title-command)
1453 (format org-export-latex-title-command title)
1454 org-export-latex-title-command))
1455 "\n\n"
1456 ;; table of contents
1457 (when (and org-export-with-toc
1458 (plist-get opt-plist :section-numbers))
1459 (funcall org-export-latex-format-toc-function
1460 (cond ((numberp toc)
1461 (min toc (plist-get opt-plist :headline-levels)))
1462 (toc (plist-get opt-plist :headline-levels))))))))
1464 (defun org-export-latex-format-toc-default (depth)
1465 (when depth
1466 (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
1467 depth)))
1469 (defun org-export-latex-first-lines (opt-plist &optional beg end)
1470 "Export the first lines before first headline.
1471 If BEG is non-nil, it is the beginning of the region.
1472 If END is non-nil, it is the end of the region."
1473 (save-excursion
1474 (goto-char (or beg (point-min)))
1475 (let* ((pt (point))
1476 (end (if (re-search-forward
1477 (concat "^" (org-get-limited-outline-regexp)) end t)
1478 (goto-char (match-beginning 0))
1479 (goto-char (or end (point-max))))))
1480 (prog1
1481 (org-export-latex-content
1482 (org-export-preprocess-string
1483 (buffer-substring pt end)
1484 :for-backend 'latex
1485 :emph-multiline t
1486 :add-text nil
1487 :comments nil
1488 :skip-before-1st-heading nil
1489 :LaTeX-fragments nil
1490 :timestamps (plist-get opt-plist :timestamps)
1491 :footnotes (plist-get opt-plist :footnotes)))
1492 (org-unmodified
1493 (let ((inhibit-read-only t)
1494 (limit (max pt (1- end))))
1495 (add-text-properties pt limit
1496 '(:org-license-to-kill t))
1497 (save-excursion
1498 (goto-char pt)
1499 (while (re-search-forward "^[ \t]*#\\+.*\n?" limit t)
1500 (let ((case-fold-search t))
1501 (unless (org-string-match-p
1502 "^[ \t]*#\\+\\(attr_\\|caption\\>\\|label\\>\\)"
1503 (match-string 0))
1504 (remove-text-properties (match-beginning 0) (match-end 0)
1505 '(:org-license-to-kill t))))))))))))
1508 (defvar org-export-latex-header-defs nil
1509 "The header definitions that might be used in the LaTeX body.")
1511 (defun org-export-latex-content (content &optional exclude-list)
1512 "Convert CONTENT string to LaTeX.
1513 Don't perform conversions that are in EXCLUDE-LIST. Recognized
1514 conversion types are: quotation-marks, emphasis, sub-superscript,
1515 links, keywords, lists, tables, fixed-width"
1516 (with-temp-buffer
1517 (org-install-letbind)
1518 (insert content)
1519 (unless (memq 'timestamps exclude-list)
1520 (org-export-latex-time-stamps))
1521 (unless (memq 'quotation-marks exclude-list)
1522 (org-export-latex-quotation-marks))
1523 (unless (memq 'emphasis exclude-list)
1524 (when (plist-get org-export-latex-options-plist :emphasize)
1525 (org-export-latex-fontify)))
1526 (unless (memq 'sub-superscript exclude-list)
1527 (org-export-latex-special-chars
1528 (plist-get org-export-latex-options-plist :sub-superscript)))
1529 (unless (memq 'links exclude-list)
1530 (org-export-latex-links))
1531 (unless (memq 'keywords exclude-list)
1532 (org-export-latex-keywords))
1533 (unless (memq 'lists exclude-list)
1534 (org-export-latex-lists))
1535 (unless (memq 'tables exclude-list)
1536 (org-export-latex-tables
1537 (plist-get org-export-latex-options-plist :tables)))
1538 (unless (memq 'fixed-width exclude-list)
1539 (org-export-latex-fixed-width
1540 (plist-get org-export-latex-options-plist :fixed-width)))
1541 ;; return string
1542 (buffer-substring (point-min) (point-max))))
1544 (defun org-export-latex-protect-string (s)
1545 "Add the org-protected property to string S."
1546 (add-text-properties 0 (length s) '(org-protected t) s) s)
1548 (defun org-export-latex-protect-char-in-string (char-list string)
1549 "Add org-protected text-property to char from CHAR-LIST in STRING."
1550 (with-temp-buffer
1551 (save-match-data
1552 (insert string)
1553 (goto-char (point-min))
1554 (while (re-search-forward (regexp-opt char-list) nil t)
1555 (add-text-properties (match-beginning 0)
1556 (match-end 0) '(org-protected t)))
1557 (buffer-string))))
1559 (defun org-export-latex-keywords-maybe (&optional remove-list)
1560 "Maybe remove keywords depending on rules in REMOVE-LIST."
1561 (goto-char (point-min))
1562 (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
1563 (case-fold-search nil)
1564 (todo-markup org-export-latex-todo-keyword-markup)
1565 fmt)
1566 ;; convert TODO keywords
1567 (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
1568 (if (plist-get remove-list :todo)
1569 (replace-match "")
1570 (setq fmt (cond
1571 ((stringp todo-markup) todo-markup)
1572 ((and (consp todo-markup) (stringp (car todo-markup)))
1573 (if (member (match-string 1) org-export-latex-done-keywords)
1574 (cdr todo-markup) (car todo-markup)))
1575 (t (cdr (or (assoc (match-string 1) todo-markup)
1576 (car todo-markup))))))
1577 (replace-match (org-export-latex-protect-string
1578 (format fmt (match-string 1))) t t)))
1579 ;; convert priority string
1580 (when (re-search-forward "\\[\\\\#.\\]" nil t)
1581 (if (plist-get remove-list :priority)
1582 (replace-match "")
1583 (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
1584 ;; convert tags
1585 (when (re-search-forward "\\(:[a-zA-Z0-9_@#%]+\\)+:" nil t)
1586 (if (or (not org-export-with-tags)
1587 (plist-get remove-list :tags))
1588 (replace-match "")
1589 (replace-match
1590 (org-export-latex-protect-string
1591 (format org-export-latex-tag-markup
1592 (save-match-data
1593 (replace-regexp-in-string
1594 "\\([_#]\\)" "\\\\\\1" (match-string 0)))))
1595 t t)))))
1597 (defun org-export-latex-fontify-headline (string)
1598 "Fontify special words in STRING."
1599 (with-temp-buffer
1600 ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
1601 ;; the beginning of the buffer - inserting "\n" is safe here though.
1602 (insert "\n" string)
1604 ;; Preserve math snippets
1606 (let* ((matchers (plist-get org-format-latex-options :matchers))
1607 (re-list org-latex-regexps)
1608 beg end re e m n block off)
1609 ;; Check the different regular expressions
1610 (while (setq e (pop re-list))
1611 (setq m (car e) re (nth 1 e) n (nth 2 e)
1612 block (if (nth 3 e) "\n\n" ""))
1613 (setq off (if (member m '("$" "$1")) 1 0))
1614 (when (and (member m matchers) (not (equal m "begin")))
1615 (goto-char (point-min))
1616 (while (re-search-forward re nil t)
1617 (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
1618 (add-text-properties beg end
1619 '(org-protected t org-latex-math t))))))
1621 ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
1622 (goto-char (point-min))
1623 (let ((case-fold-search nil))
1624 (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
1625 (unless (eq (char-before (match-beginning 1)) ?\\)
1626 (org-if-unprotected-1
1627 (replace-match (org-export-latex-protect-string
1628 (concat "\\" (match-string 1)
1629 "{}")) t t)))))
1630 (goto-char (point-min))
1631 (let ((re (concat "\\\\\\([a-zA-Z]+\\)"
1632 "\\(?:<[^<>\n]*>\\)*"
1633 "\\(?:\\[[^][\n]*?\\]\\)*"
1634 "\\(?:<[^<>\n]*>\\)*"
1635 "\\("
1636 (org-create-multibrace-regexp "{" "}" 3)
1637 "\\)\\{1,3\\}")))
1638 (while (re-search-forward re nil t)
1639 (unless (or
1640 ;; check for comment line
1641 (save-excursion (goto-char (match-beginning 0))
1642 (org-in-indented-comment-line))
1643 ;; Check if this is a defined entity, so that is may need conversion
1644 (org-entity-get (match-string 1)))
1645 (add-text-properties (match-beginning 0) (match-end 0)
1646 '(org-protected t)))))
1647 (when (plist-get org-export-latex-options-plist :emphasize)
1648 (org-export-latex-fontify))
1649 (org-export-latex-time-stamps)
1650 (org-export-latex-quotation-marks)
1651 (org-export-latex-keywords-maybe)
1652 (org-export-latex-special-chars
1653 (plist-get org-export-latex-options-plist :sub-superscript))
1654 (org-export-latex-links)
1655 (org-trim (buffer-string))))
1657 (defun org-export-latex-time-stamps ()
1658 "Format time stamps."
1659 (goto-char (point-min))
1660 (let ((org-display-custom-times org-export-latex-display-custom-times))
1661 (while (re-search-forward org-ts-regexp-both nil t)
1662 (org-if-unprotected-at (1- (point))
1663 (replace-match
1664 (org-export-latex-protect-string
1665 (format (if (string= "<" (substring (match-string 0) 0 1))
1666 org-export-latex-timestamp-markup
1667 org-export-latex-timestamp-inactive-markup)
1668 (substring (org-translate-time (match-string 0)) 1 -1)))
1669 t t)))))
1671 (defun org-export-latex-quotation-marks ()
1672 "Export quotation marks depending on language conventions."
1673 (mapc (lambda(l)
1674 (goto-char (point-min))
1675 (while (re-search-forward (car l) nil t)
1676 (let ((rpl (concat (match-string 1)
1677 (org-export-latex-protect-string
1678 (copy-sequence (cdr l))))))
1679 (org-if-unprotected-1
1680 (replace-match rpl t t)))))
1681 (cdr (or (assoc (plist-get org-export-latex-options-plist :language)
1682 org-export-latex-quotes)
1683 ;; falls back on english
1684 (assoc "en" org-export-latex-quotes)))))
1686 (defun org-export-latex-special-chars (sub-superscript)
1687 "Export special characters to LaTeX.
1688 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
1689 See the `org-export-latex.el' code for a complete conversion table."
1690 (goto-char (point-min))
1691 (mapc (lambda(c)
1692 (goto-char (point-min))
1693 (while (re-search-forward c nil t)
1694 ;; Put the point where to check for org-protected
1695 (unless (or (get-text-property (match-beginning 2) 'org-protected)
1696 (save-match-data (org-at-table.el-p)))
1697 (cond ((member (match-string 2) '("\\$" "$"))
1698 (if (equal (match-string 2) "\\$")
1700 (replace-match "\\$" t t)))
1701 ((member (match-string 2) '("&" "%" "#"))
1702 (if (equal (match-string 1) "\\")
1703 (replace-match (match-string 2) t t)
1704 (replace-match (concat (match-string 1) "\\"
1705 (match-string 2)) t t)
1706 (backward-char 1)))
1707 ((equal (match-string 2) "...")
1708 (replace-match
1709 (concat (match-string 1)
1710 (org-export-latex-protect-string "\\ldots{}")) t t))
1711 ((equal (match-string 2) "~")
1712 (cond ((equal (match-string 1) "\\") nil)
1713 ((eq 'org-link (get-text-property 0 'face (match-string 2)))
1714 (replace-match (concat (match-string 1) "\\~") t t))
1715 (t (replace-match
1716 (org-export-latex-protect-string
1717 (concat (match-string 1) "\\~{}")) t t))))
1718 ((member (match-string 2) '("{" "}"))
1719 (unless (save-match-data (org-inside-latex-math-p))
1720 (if (equal (match-string 1) "\\")
1721 (replace-match (match-string 2) t t)
1722 (replace-match (concat (match-string 1) "\\"
1723 (match-string 2)) t t)))))
1724 (unless (save-match-data (org-inside-latex-math-p))
1725 (cond ((equal (match-string 2) "\\")
1726 (replace-match (or (save-match-data
1727 (org-export-latex-treat-backslash-char
1728 (match-string 1)
1729 (or (match-string 3) "")))
1730 "") t t)
1731 (when (and (get-text-property (1- (point)) 'org-entity)
1732 (looking-at "{}"))
1733 ;; OK, this was an entity replacement, and the user
1734 ;; had terminated the entity with {}. Make sure
1735 ;; {} is protected as well, and remove the extra {}
1736 ;; inserted by the conversion.
1737 (put-text-property (point) (+ 2 (point)) 'org-protected t)
1738 (if (save-excursion (goto-char (max (- (point) 2) (point-min)))
1739 (looking-at "{}"))
1740 (replace-match ""))
1741 (forward-char 2))
1742 (backward-char 1))
1743 ((member (match-string 2) '("_" "^"))
1744 (replace-match (or (save-match-data
1745 (org-export-latex-treat-sub-super-char
1746 sub-superscript
1747 (match-string 2)
1748 (match-string 1)
1749 (match-string 3))) "") t t)
1750 (backward-char 1)))))))
1751 '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
1752 "\\(\\(\\\\?\\$\\)\\)"
1753 "\\([a-zA-Z0-9()]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-zA-Z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-zA-Z0-9]+}\\|([a-zA-Z0-9]+)\\)"
1754 "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|\\([&#%{}\"]\\|[a-zA-Z][a-zA-Z0-9]*\\)\\)"
1755 "\\(^\\|.\\)\\([&#%{}~]\\|\\.\\.\\.\\)"
1756 ;; (?\< . "\\textless{}")
1757 ;; (?\> . "\\textgreater{}")
1760 (defun org-inside-latex-math-p ()
1761 (get-text-property (point) 'org-latex-math))
1763 (defun org-export-latex-treat-sub-super-char
1764 (subsup char string-before string-after)
1765 "Convert the \"_\" and \"^\" characters to LaTeX.
1766 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
1767 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
1768 (cond ((equal string-before "\\")
1769 (concat string-before char string-after))
1770 ((and (string-match "\\S-+" string-after))
1771 ;; this is part of a math formula
1772 (cond ((eq 'org-link (get-text-property 0 'face char))
1773 (concat string-before "\\" char string-after))
1774 ((save-match-data (org-inside-latex-math-p))
1775 (if subsup
1776 (cond ((eq 1 (length string-after))
1777 (concat string-before char string-after))
1778 ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
1779 (format "%s%s{%s}" string-before char
1780 (match-string 1 string-after))))))
1781 ((and (> (length string-after) 1)
1782 (or (eq subsup t)
1783 (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
1784 (or (string-match "[{]?\\([^}]+\\)[}]?" string-after)
1785 (string-match "[(]?\\([^)]+\\)[)]?" string-after)))
1787 (org-export-latex-protect-string
1788 (format "%s$%s{%s}$" string-before char
1789 (if (and (> (match-end 1) (1+ (match-beginning 1)))
1790 (not (equal (substring string-after 0 2) "{\\")))
1791 (concat "\\mathrm{" (match-string 1 string-after) "}")
1792 (match-string 1 string-after)))))
1793 ((eq subsup t) (concat string-before "$" char string-after "$"))
1794 (t (org-export-latex-protect-string
1795 (concat string-before "\\" char "{}" string-after)))))
1796 (t (org-export-latex-protect-string
1797 (concat string-before "\\" char "{}" string-after)))))
1799 (defun org-export-latex-treat-backslash-char (string-before string-after)
1800 "Convert the \"$\" special character to LaTeX.
1801 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
1802 (let ((ass (org-entity-get string-after)))
1803 (cond
1804 (ass (org-add-props
1805 (if (nth 2 ass)
1806 (concat string-before
1807 (org-export-latex-protect-string
1808 (concat "$" (nth 1 ass) "$")))
1809 (concat string-before (org-export-latex-protect-string
1810 (nth 1 ass))))
1811 nil 'org-entity t))
1812 ((and (not (string-match "^[ \n\t]" string-after))
1813 (not (string-match "[ \t]\\'\\|^" string-before)))
1814 ;; backslash is inside a word
1815 (concat string-before
1816 (org-export-latex-protect-string
1817 (concat "\\textbackslash{}" string-after))))
1818 ((not (or (equal string-after "")
1819 (string-match "^[ \t\n]" string-after)))
1820 ;; backslash might escape a character (like \#) or a user TeX
1821 ;; macro (like \setcounter)
1822 (concat string-before
1823 (org-export-latex-protect-string (concat "\\" string-after))))
1824 ((and (string-match "^[ \t\n]" string-after)
1825 (string-match "[ \t\n]\\'" string-before))
1826 ;; backslash is alone, convert it to $\backslash$
1827 (org-export-latex-protect-string
1828 (concat string-before "\\textbackslash{}" string-after)))
1829 (t (org-export-latex-protect-string
1830 (concat string-before "\\textbackslash{}" string-after))))))
1832 (defun org-export-latex-keywords ()
1833 "Convert special keywords to LaTeX."
1834 (goto-char (point-min))
1835 (while (re-search-forward org-export-latex-special-keyword-regexp nil t)
1836 (replace-match (format org-export-latex-timestamp-keyword-markup
1837 (match-string 0)) t t)
1838 (save-excursion
1839 (beginning-of-line 1)
1840 (unless (looking-at ".*\n[ \t]*\n")
1841 (end-of-line 1)
1842 (insert "\n")))))
1844 (defun org-export-latex-fixed-width (opt)
1845 "When OPT is non-nil convert fixed-width sections to LaTeX."
1846 (goto-char (point-min))
1847 (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
1848 (unless (get-text-property (point) 'org-example)
1849 (if opt
1850 (progn (goto-char (match-beginning 0))
1851 (insert "\\begin{verbatim}\n")
1852 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1853 (replace-match (concat (match-string 1)
1854 (match-string 2)) t t)
1855 (forward-line))
1856 (insert "\\end{verbatim}\n"))
1857 (progn (goto-char (match-beginning 0))
1858 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1859 (replace-match (concat "%" (match-string 1)
1860 (match-string 2)) t t)
1861 (forward-line)))))))
1863 (defvar org-table-last-alignment) ; defined in org-table.el
1864 (defvar org-table-last-column-widths) ; defined in org-table.el
1865 (declare-function orgtbl-to-latex "org-table" (table params) t)
1866 (defun org-export-latex-tables (insert)
1867 "Convert tables to LaTeX and INSERT it."
1868 ;; First, get the table.el tables
1869 (goto-char (point-min))
1870 (while (re-search-forward "^[ \t]*\\(\\+-[-+]*\\+\\)[ \t]*\n[ \t]*|" nil t)
1871 (org-if-unprotected
1872 (require 'table)
1873 (org-export-latex-convert-table.el-table)))
1875 ;; And now the Org-mode tables
1876 (goto-char (point-min))
1877 (while (re-search-forward "^\\([ \t]*\\)|" nil t)
1878 (org-if-unprotected-at (1- (point))
1879 (org-table-align)
1880 (let* ((beg (org-table-begin))
1881 (end (org-table-end))
1882 (raw-table (buffer-substring beg end))
1883 (org-table-last-alignment (copy-sequence org-table-last-alignment))
1884 (org-table-last-column-widths (copy-sequence
1885 org-table-last-column-widths))
1886 fnum fields line lines olines gr colgropen line-fmt align
1887 caption width shortn label attr floatp placement
1888 longtblp tblenv tabular-env)
1889 (if org-export-latex-tables-verbatim
1890 (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1891 "\\end{verbatim}\n")))
1892 (apply 'delete-region (list beg end))
1893 (insert (org-export-latex-protect-string tbl)))
1894 (progn
1895 (setq caption (org-find-text-property-in-string
1896 'org-caption raw-table)
1897 shortn (org-find-text-property-in-string
1898 'org-caption-shortn raw-table)
1899 attr (org-find-text-property-in-string
1900 'org-attributes raw-table)
1901 label (org-find-text-property-in-string
1902 'org-label raw-table)
1903 longtblp (and attr (stringp attr)
1904 (string-match "\\<longtable\\>" attr))
1905 tblenv (if (and attr (stringp attr)
1906 (or (string-match (regexp-quote "table*") attr)
1907 (string-match "\\<multicolumn\\>" attr)))
1908 "table*" "table")
1909 tabular-env
1910 (if (and attr (stringp attr)
1911 (string-match "\\(tabular.\\)" attr))
1912 (match-string 1 attr)
1913 org-export-latex-tabular-environment)
1914 width (and attr (stringp attr)
1915 (string-match "\\<width=\\([^ \t\n\r]+\\)" attr)
1916 (match-string 1 attr))
1917 align (and attr (stringp attr)
1918 (string-match "\\<align=\\([^ \t\n\r]+\\)" attr)
1919 (match-string 1 attr))
1920 floatp (or caption label (string= "table*" tblenv))
1921 placement (if (and attr
1922 (stringp attr)
1923 (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
1924 (match-string 1 attr)
1925 (concat
1926 "[" org-latex-default-figure-position "]")))
1927 (setq caption (and caption (org-export-latex-fontify-headline caption)))
1928 (setq lines (org-split-string raw-table "\n"))
1929 (apply 'delete-region (list beg end))
1930 (when org-export-table-remove-special-lines
1931 (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
1932 (when org-table-clean-did-remove-column
1933 (pop org-table-last-alignment)
1934 (pop org-table-last-column-widths))
1935 ;; make a formatting string to reflect alignment
1936 (setq olines lines)
1937 (while (and (not line-fmt) (setq line (pop olines)))
1938 (unless (string-match "^[ \t]*|-" line)
1939 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1940 (setq fnum (make-vector (length fields) 0))
1941 (setq line-fmt
1942 (mapconcat
1943 (lambda (x)
1944 (setq gr (pop org-table-colgroup-info))
1945 (format "%s%%s%s"
1946 (cond ((eq gr :start)
1947 (prog1 (if colgropen "|" "|")
1948 (setq colgropen t)))
1949 ((eq gr :startend)
1950 (prog1 (if colgropen "|" "|")
1951 (setq colgropen nil)))
1952 (t ""))
1953 (if (memq gr '(:end :startend))
1954 (progn (setq colgropen nil) "|")
1955 "")))
1956 fnum ""))))
1957 ;; fix double || in line-fmt
1958 (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
1959 ;; maybe remove the first and last "|"
1960 (when (and (not org-export-latex-tables-column-borders)
1961 (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
1962 (setq line-fmt (match-string 2 line-fmt)))
1963 ;; format alignment
1964 (unless align
1965 (setq align (apply 'format
1966 (cons line-fmt
1967 (mapcar (lambda (x) (if x "r" "l"))
1968 org-table-last-alignment)))))
1969 ;; prepare the table to send to orgtbl-to-latex
1970 (setq lines
1971 (mapcar
1972 (lambda(elem)
1973 (or (and (string-match "[ \t]*|-+" elem) 'hline)
1974 (org-split-string
1975 (progn (set-text-properties 0 (length elem) nil elem)
1976 (org-trim elem)) "|")))
1977 lines))
1978 (when insert
1979 (insert (org-export-latex-protect-string
1980 (concat
1981 (if longtblp
1982 (concat "\\begin{longtable}{" align "}\n")
1983 (if floatp
1984 (format "\\begin{%s}%s\n" tblenv placement)))
1985 (if (and floatp org-export-latex-table-caption-above)
1986 (format
1987 "\\caption%s{%s} %s"
1988 (if shortn (concat "[" shortn "]") "")
1989 (or caption "")
1990 (if label (format "\\label{%s}" label) "")))
1991 (if (and longtblp caption org-export-latex-table-caption-above)
1992 "\\\\\n" "\n")
1993 (if (and org-export-latex-tables-centered (not longtblp))
1994 "\\begin{center}\n")
1995 (if (not longtblp)
1996 (format "\\begin{%s}%s{%s}\n"
1997 tabular-env
1998 (if width (format "{%s}" width) "")
1999 align))
2000 (orgtbl-to-latex
2001 lines
2002 `(:tstart nil :tend nil
2003 :hlend ,(if longtblp
2004 (format "\\\\
2005 \\hline
2006 \\endhead
2007 \\hline\\multicolumn{%d}{r}{Continued on next page}\\
2008 \\endfoot
2009 \\endlastfoot" (length org-table-last-alignment))
2010 nil)))
2011 (if (not longtblp) (format "\n\\end{%s}" tabular-env))
2012 (if longtblp "\n" (if org-export-latex-tables-centered
2013 "\n\\end{center}\n" "\n"))
2014 (if (and floatp (not org-export-latex-table-caption-above))
2015 (format
2016 "\\caption%s{%s} %s"
2017 (if shortn (concat "[" shortn "]") "")
2018 (or caption "")
2019 (if label (format "\\label{%s}" label) "")))
2020 (if longtblp
2021 "\\end{longtable}"
2022 (if floatp (format "\\end{%s}" tblenv)))))
2023 "\n\n"))))))))
2025 (defun org-export-latex-convert-table.el-table ()
2026 "Replace table.el table at point with LaTeX code."
2027 (let (tbl caption shortn label line floatp attr align rmlines)
2028 (setq line (buffer-substring (point-at-bol) (point-at-eol))
2029 label (org-get-text-property-any 0 'org-label line)
2030 caption (org-get-text-property-any 0 'org-caption line)
2031 shortn (org-get-text-property-any 0 'org-caption-shortn line)
2032 attr (org-get-text-property-any 0 'org-attributes line)
2033 align (and attr (stringp attr)
2034 (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
2035 (match-string 1 attr))
2036 rmlines (and attr (stringp attr)
2037 (string-match "\\<rmlines\\>" attr))
2038 floatp (or label caption))
2039 (and (get-buffer "*org-export-table*")
2040 (kill-buffer (get-buffer "*org-export-table*")))
2041 (table-generate-source 'latex "*org-export-table*" "caption")
2042 (setq tbl (with-current-buffer "*org-export-table*"
2043 (buffer-string)))
2044 (while (string-match "^%.*\n" tbl)
2045 (setq tbl (replace-match "" t t tbl)))
2046 ;; fix the hlines
2047 (when rmlines
2048 (let ((n 0) lines)
2049 (setq lines (mapcar (lambda (x)
2050 (if (string-match "^\\\\hline$" x)
2051 (progn
2052 (setq n (1+ n))
2053 (if (= n 2) x nil))
2055 (org-split-string tbl "\n")))
2056 (setq tbl (mapconcat 'identity (delq nil lines) "\n"))))
2057 (when (and align (string-match "\\\\begin{tabular}{.*}" tbl))
2058 (setq tbl (replace-match (concat "\\begin{tabular}{" align "}")
2059 t t tbl)))
2060 (and (get-buffer "*org-export-table*")
2061 (kill-buffer (get-buffer "*org-export-table*")))
2062 (beginning-of-line 0)
2063 (while (looking-at "[ \t]*\\(|\\|\\+-\\)")
2064 (delete-region (point) (1+ (point-at-eol))))
2065 (when org-export-latex-tables-centered
2066 (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
2067 (when floatp
2068 (setq tbl (concat "\\begin{table}\n"
2069 (if (not org-export-latex-table-caption-above) tbl)
2070 (format "\\caption%s{%s%s}\n"
2071 (if shortn (format "[%s]" shortn) "")
2072 (if label (format "\\label{%s}" label) "")
2073 (or caption ""))
2074 (if org-export-latex-table-caption-above tbl)
2075 "\n\\end{table}\n")))
2076 (insert (org-export-latex-protect-string tbl))))
2078 (defun org-export-latex-fontify ()
2079 "Convert fontification to LaTeX."
2080 (goto-char (point-min))
2081 (while (re-search-forward org-emph-re nil t)
2082 ;; The match goes one char after the *string*, except at the end of a line
2083 (let ((emph (assoc (match-string 3)
2084 org-export-latex-emphasis-alist))
2085 (beg (match-beginning 0))
2086 (end (match-end 0))
2087 rpl s)
2088 (unless emph
2089 (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
2090 (match-string 3)))
2091 (unless (or (and (get-text-property (- (point) 2) 'org-protected)
2092 (not (get-text-property
2093 (- (point) 2) 'org-verbatim-emph)))
2094 (equal (char-after (match-beginning 3))
2095 (char-after (1+ (match-beginning 3))))
2096 (save-excursion
2097 (goto-char (match-beginning 1))
2098 (save-match-data
2099 (and (org-at-table-p)
2100 (string-match
2101 "[|\n]" (buffer-substring beg end)))))
2102 (and (equal (match-string 3) "+")
2103 (save-match-data
2104 (string-match "\\`-+\\'" (match-string 4)))))
2105 (setq s (match-string 4))
2106 (setq rpl (concat (match-string 1)
2107 (org-export-latex-emph-format (cadr emph)
2108 (match-string 4))
2109 (match-string 5)))
2110 (if (caddr emph)
2111 (setq rpl (org-export-latex-protect-string rpl))
2112 (save-match-data
2113 (if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl)
2114 (progn
2115 (add-text-properties (match-beginning 1) (match-end 1)
2116 '(org-protected t) rpl)
2117 (add-text-properties (match-beginning 3) (match-end 3)
2118 '(org-protected t) rpl)))))
2119 (replace-match rpl t t)))
2120 (backward-char)))
2122 (defun org-export-latex-emph-format (format string)
2123 "Format an emphasis string and handle the \\verb special case."
2124 (when (member format '("\\verb" "\\protectedtexttt"))
2125 (save-match-data
2126 (if (equal format "\\verb")
2127 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
2128 (catch 'exit
2129 (loop for i from 0 to (1- (length ll)) do
2130 (if (not (string-match (regexp-quote (substring ll i (1+ i)))
2131 string))
2132 (progn
2133 (setq format (concat "\\verb" (substring ll i (1+ i))
2134 "%s" (substring ll i (1+ i))))
2135 (throw 'exit nil))))))
2136 (let ((start 0)
2137 (trans '(("\\" . "\\textbackslash{}")
2138 ("~" . "\\textasciitilde{}")
2139 ("^" . "\\textasciicircum{}")))
2140 (rtn "") char)
2141 (while (string-match "[\\{}$%&_#~^]" string)
2142 (setq char (match-string 0 string))
2143 (if (> (match-beginning 0) 0)
2144 (setq rtn (concat rtn (substring string
2145 0 (match-beginning 0)))))
2146 (setq string (substring string (1+ (match-beginning 0))))
2147 (setq char (or (cdr (assoc char trans)) (concat "\\" char))
2148 rtn (concat rtn char)))
2149 (setq string (concat rtn string) format "\\texttt{%s}")
2150 (while (string-match "--" string)
2151 (setq string (replace-match "-{}-" t t string)))))))
2152 (format format string))
2154 (defun org-export-latex-links ()
2155 ;; Make sure to use the LaTeX hyperref and graphicx package
2156 ;; or send some warnings.
2157 "Convert links to LaTeX."
2158 (goto-char (point-min))
2159 (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
2160 (org-if-unprotected-1
2161 (goto-char (match-beginning 0))
2162 (let* ((re-radio org-export-latex-all-targets-re)
2163 (remove (list (match-beginning 0) (match-end 0)))
2164 (raw-path (org-extract-attributes (match-string 3)))
2165 (full-raw-path (concat (match-string 1) raw-path))
2166 (desc (match-string 5))
2167 (type (or (match-string 2)
2168 (if (or (file-name-absolute-p raw-path)
2169 (string-match "^\\.\\.?/" raw-path))
2170 "file")))
2171 (coderefp (equal type "coderef"))
2172 (caption (org-find-text-property-in-string 'org-caption raw-path))
2173 (shortn (org-find-text-property-in-string 'org-caption-shortn raw-path))
2174 (attr (or (org-find-text-property-in-string 'org-attributes raw-path)
2175 (plist-get org-export-latex-options-plist :latex-image-options)))
2176 (label (org-find-text-property-in-string 'org-label raw-path))
2177 imgp radiop fnc
2178 ;; define the path of the link
2179 (path (cond
2180 ((member type '("coderef"))
2181 raw-path)
2182 ((member type '("http" "https" "ftp"))
2183 (concat type ":" raw-path))
2184 ((and re-radio (string-match re-radio raw-path))
2185 (setq radiop t))
2186 ((equal type "mailto")
2187 (concat type ":" raw-path))
2188 ((equal type "file")
2189 (if (and (org-file-image-p
2190 (expand-file-name
2191 raw-path)
2192 org-export-latex-inline-image-extensions)
2193 (or (get-text-property 0 'org-no-description
2194 raw-path)
2195 (equal desc full-raw-path)))
2196 (setq imgp t)
2197 (progn (when (string-match "\\(.+\\)::.+" raw-path)
2198 (setq raw-path (match-string 1 raw-path)))
2199 (if (file-exists-p raw-path)
2200 (concat type "://" (expand-file-name raw-path))
2201 (concat type "://" (org-export-directory
2202 :LaTeX org-export-latex-options-plist)
2203 raw-path))))))))
2204 ;; process with link inserting
2205 (apply 'delete-region remove)
2206 (setq caption (and caption (org-export-latex-fontify-headline caption)))
2207 (cond ((and imgp
2208 (plist-get org-export-latex-options-plist :inline-images))
2209 ;; OK, we need to inline an image
2210 (insert
2211 (org-export-latex-format-image raw-path caption label attr shortn)))
2212 (coderefp
2213 (insert (format
2214 (org-export-get-coderef-format path desc)
2215 (cdr (assoc path org-export-code-refs)))))
2216 (radiop (insert (format org-export-latex-hyperref-format
2217 (org-solidify-link-text raw-path) desc)))
2218 ((not type)
2219 (insert (format org-export-latex-hyperref-format
2220 (org-remove-initial-hash
2221 (org-solidify-link-text raw-path))
2222 desc)))
2223 (path
2224 (when (org-at-table-p)
2225 ;; There is a strange problem when we have a link in a table,
2226 ;; ampersands then cause a problem. I think this must be
2227 ;; a LaTeX issue, but we here implement a work-around anyway.
2228 (setq path (org-export-latex-protect-amp path)
2229 desc (org-export-latex-protect-amp desc)))
2230 (insert
2231 (if (string-match "%s.*%s" org-export-latex-href-format)
2232 (format org-export-latex-href-format path desc)
2233 (format org-export-latex-href-format path))))
2235 ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
2236 ;; The link protocol has a function for formatting the link
2237 (insert
2238 (save-match-data
2239 (funcall fnc (org-link-unescape raw-path) desc 'latex))))
2241 (t (insert "\\texttt{" desc "}")))))))
2244 (defun org-export-latex-format-image (path caption label attr &optional shortn)
2245 "Format the image element, depending on user settings."
2246 (let (ind floatp wrapp multicolumnp placement figenv)
2247 (setq floatp (or caption label))
2248 (setq ind (org-get-text-property-any 0 'original-indentation path))
2249 (when (and attr (stringp attr))
2250 (if (string-match "[ \t]*\\<wrap\\>" attr)
2251 (setq wrapp t floatp nil attr (replace-match "" t t attr)))
2252 (if (string-match "[ \t]*\\<float\\>" attr)
2253 (setq wrapp nil floatp t attr (replace-match "" t t attr)))
2254 (if (string-match "[ \t]*\\<multicolumn\\>" attr)
2255 (setq multicolumnp t attr (replace-match "" t t attr))))
2257 (setq placement
2258 (cond
2259 (wrapp "{l}{0.5\\textwidth}")
2260 (floatp (concat "[" org-latex-default-figure-position "]"))
2261 (t "")))
2263 (when (and attr (stringp attr)
2264 (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
2265 (setq placement (match-string 1 attr)
2266 attr (replace-match "" t t attr)))
2267 (setq attr (and attr (org-trim attr)))
2268 (when (or (not attr) (= (length attr) 0))
2269 (setq attr (cond (floatp "width=0.7\\textwidth")
2270 (wrapp "width=0.48\\textwidth")
2271 (t attr))))
2272 (setq figenv
2273 (cond
2274 (wrapp "\\begin{wrapfigure}%placement
2275 \\centering
2276 \\includegraphics[%attr]{%path}
2277 \\caption%shortn{%labelcmd%caption}
2278 \\end{wrapfigure}")
2279 (multicolumnp "\\begin{figure*}%placement
2280 \\centering
2281 \\includegraphics[%attr]{%path}
2282 \\caption%shortn{%labelcmd%caption}
2283 \\end{figure*}")
2284 (floatp "\\begin{figure}%placement
2285 \\centering
2286 \\includegraphics[%attr]{%path}
2287 \\caption%shortn{%labelcmd%caption}
2288 \\end{figure}")
2289 (t "\\includegraphics[%attr]{%path}")))
2292 (setq figenv (mapconcat 'identity (split-string figenv "\n")
2293 (save-excursion (beginning-of-line 1)
2294 (looking-at "[ \t]*")
2295 (concat "\n" (match-string 0)))))
2297 (if (and (not label) (not caption)
2298 (string-match "^\\\\caption{.*\n" figenv))
2299 (setq figenv (replace-match "" t t figenv)))
2300 (org-add-props
2301 (org-fill-template
2302 figenv
2303 (list (cons "path"
2304 (if (file-name-absolute-p path)
2305 (expand-file-name path)
2306 path))
2307 (cons "attr" attr)
2308 (cons "shortn" (if shortn (format "[%s]" shortn) ""))
2309 (cons "labelcmd" (if label (format "\\label{%s}"
2310 label)""))
2311 (cons "caption" (or caption ""))
2312 (cons "placement" (or placement ""))))
2313 nil 'original-indentation ind)))
2315 (defun org-export-latex-protect-amp (s)
2316 (while (string-match "\\([^\\\\]\\)\\(&\\)" s)
2317 (setq s (replace-match (concat (match-string 1 s) "\\" (match-string 2 s))
2318 t t s)))
2321 (defun org-remove-initial-hash (s)
2322 (if (string-match "\\`#" s)
2323 (substring s 1)
2325 (defvar org-latex-entities) ; defined below
2326 (defvar org-latex-entities-regexp) ; defined below
2328 (defun org-export-latex-preprocess (parameters)
2329 "Clean stuff in the LaTeX export."
2330 ;; Replace footnotes.
2331 (when (plist-get parameters :footnotes)
2332 (goto-char (point-min))
2333 (let (ref)
2334 (while (setq ref (org-footnote-get-next-reference))
2335 (let* ((beg (nth 1 ref))
2336 (lbl (car ref))
2337 (def (nth 1 (assoc (string-to-number lbl)
2338 (mapcar (lambda (e) (cdr e))
2339 org-export-footnotes-seen)))))
2340 ;; Fix body for footnotes ending on a link or a list and
2341 ;; remove definition from buffer.
2342 (setq def
2343 (concat def
2344 (if (string-match "ORG-LIST-END-MARKER\\'" def)
2345 "\n" " ")))
2346 (org-footnote-delete-definitions lbl)
2347 ;; Compute string to insert (FNOTE), and protect the outside
2348 ;; macro from further transformation. When footnote at
2349 ;; point is referring to a previously defined footnote, use
2350 ;; \footnotemark. Otherwise, use \footnote.
2351 (let ((fnote (if (member lbl org-export-latex-footmark-seen)
2352 (org-export-latex-protect-string
2353 (format "\\footnotemark[%s]" lbl))
2354 (push lbl org-export-latex-footmark-seen)
2355 (concat (org-export-latex-protect-string "\\footnote{")
2357 (org-export-latex-protect-string "}"))))
2358 ;; Check if another footnote is immediately following.
2359 ;; If so, add a separator in-between.
2360 (sep (org-export-latex-protect-string
2361 (if (save-excursion (goto-char (1- (nth 2 ref)))
2362 (let ((next (org-footnote-get-next-reference)))
2363 (and next (= (nth 1 next) (nth 2 ref)))))
2364 org-export-latex-footnote-separator ""))))
2365 (when (org-at-heading-p)
2366 (setq fnote (concat (org-export-latex-protect-string "\\protect")
2367 fnote)))
2368 ;; Ensure a footnote at column 0 cannot end a list
2369 ;; containing it.
2370 (put-text-property 0 (length fnote) 'original-indentation 1000 fnote)
2371 ;; Replace footnote reference with FNOTE and, maybe, SEP.
2372 ;; `save-excursion' is required if there are two footnotes
2373 ;; in a row. In that case, point would be left at the
2374 ;; beginning of the second one, and
2375 ;; `org-footnote-get-next-reference' would then skip it.
2376 (goto-char beg)
2377 (delete-region beg (nth 2 ref))
2378 (save-excursion (insert fnote sep)))))))
2380 ;; Remove footnote section tag for LaTeX
2381 (goto-char (point-min))
2382 (while (re-search-forward
2383 (concat "^" footnote-section-tag-regexp) nil t)
2384 (org-if-unprotected
2385 (replace-match "")))
2386 ;; Remove any left-over footnote definition.
2387 (mapc (lambda (fn) (org-footnote-delete-definitions (car fn)))
2388 org-export-footnotes-data)
2389 (mapc (lambda (fn) (org-footnote-delete-definitions fn))
2390 org-export-latex-footmark-seen)
2392 ;; Preserve line breaks
2393 (goto-char (point-min))
2394 (while (re-search-forward "\\\\\\\\" nil t)
2395 (add-text-properties (match-beginning 0) (match-end 0)
2396 '(org-protected t)))
2398 ;; Preserve latex environments
2399 (goto-char (point-min))
2400 (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
2401 (org-if-unprotected
2402 (let* ((start (progn (beginning-of-line) (point)))
2403 (end (and (re-search-forward
2404 (concat "^[ \t]*\\\\end{"
2405 (regexp-quote (match-string 1))
2406 "}") nil t)
2407 (point-at-eol))))
2408 (if end
2409 (add-text-properties start end '(org-protected t))
2410 (goto-char (point-at-eol))))))
2412 ;; Preserve math snippets
2413 (let* ((matchers (plist-get org-format-latex-options :matchers))
2414 (re-list org-latex-regexps)
2415 beg end re e m n block off)
2416 ;; Check the different regular expressions
2417 (while (setq e (pop re-list))
2418 (setq m (car e) re (nth 1 e) n (nth 2 e)
2419 block (if (nth 3 e) "\n\n" ""))
2420 (setq off (if (member m '("$" "$1")) 1 0))
2421 (when (and (member m matchers) (not (equal m "begin")))
2422 (goto-char (point-min))
2423 (while (re-search-forward re nil t)
2424 (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
2425 (add-text-properties beg end '(org-protected t org-latex-math t))))))
2427 ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
2428 (goto-char (point-min))
2429 (let ((case-fold-search nil))
2430 (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
2431 (unless (eq (char-before (match-beginning 1)) ?\\)
2432 (org-if-unprotected-1
2433 (replace-match (org-export-latex-protect-string
2434 (concat "\\" (match-string 1)
2435 "{}")) t t)))))
2437 ;; Convert blockquotes
2438 (goto-char (point-min))
2439 (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
2440 (org-replace-match-keep-properties "\\begin{quote}" t t))
2441 (goto-char (point-min))
2442 (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
2443 (org-replace-match-keep-properties "\\end{quote}" t t))
2445 ;; Convert verse
2446 (goto-char (point-min))
2447 (while (search-forward "ORG-VERSE-START" nil t)
2448 (org-replace-match-keep-properties "\\begin{verse}" t t)
2449 (beginning-of-line 2)
2450 (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
2451 (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
2452 (goto-char (match-end 1))
2453 (org-replace-match-keep-properties
2454 (org-export-latex-protect-string
2455 (concat "\\hspace*{1cm}" (match-string 2))) t t)
2456 (beginning-of-line 1))
2457 (if (looking-at "[ \t]*$")
2458 (insert (org-export-latex-protect-string "\\vspace*{1em}"))
2459 (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
2460 (end-of-line 1)
2461 (insert "\\\\")))
2462 (beginning-of-line 2))
2463 (and (looking-at "[ \t]*ORG-VERSE-END.*")
2464 (org-replace-match-keep-properties "\\end{verse}" t t)))
2466 ;; Convert #+INDEX to LaTeX \\index.
2467 (goto-char (point-min))
2468 (let ((case-fold-search t) entry)
2469 (while (re-search-forward
2470 "^[ \t]*#\\+index:[ \t]*\\([^ \t\r\n].*?\\)[ \t]*$"
2471 nil t)
2472 (setq entry
2473 (save-match-data
2474 (org-export-latex-protect-string
2475 (org-export-latex-fontify-headline (match-string 1)))))
2476 (replace-match (format "\\index{%s}" entry) t t)))
2478 ;; Convert center
2479 (goto-char (point-min))
2480 (while (search-forward "ORG-CENTER-START" nil t)
2481 (org-replace-match-keep-properties "\\begin{center}" t t))
2482 (goto-char (point-min))
2483 (while (search-forward "ORG-CENTER-END" nil t)
2484 (org-replace-match-keep-properties "\\end{center}" t t))
2486 (run-hooks 'org-export-latex-after-blockquotes-hook)
2488 ;; Convert horizontal rules
2489 (goto-char (point-min))
2490 (while (re-search-forward "^[ \t]*-\\{5,\\}[ \t]*$" nil t)
2491 (org-if-unprotected
2492 (replace-match (org-export-latex-protect-string "\\hrule") t t)))
2494 ;; Protect LaTeX commands like \command[...]{...} or \command{...}
2495 (goto-char (point-min))
2496 (let ((re (concat
2497 "\\\\\\([a-zA-Z]+\\*?\\)"
2498 "\\(?:<[^<>\n]*>\\)*"
2499 "\\(?:\\[[^][\n]*?\\]\\)*"
2500 "\\(?:<[^<>\n]*>\\)*"
2501 "\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
2502 (while (re-search-forward re nil t)
2503 (unless (or
2504 ;; Check for comment line.
2505 (save-excursion (goto-char (match-beginning 0))
2506 (org-in-indented-comment-line))
2507 ;; Check if this is a defined entity, so that is may
2508 ;; need conversion.
2509 (org-entity-get (match-string 1))
2510 ;; Do not protect interior of footnotes. Those have
2511 ;; already been taken care of earlier in the function.
2512 ;; Yet, keep looking inside them for more commands.
2513 (and (equal (match-string 1) "footnote")
2514 (goto-char (match-end 1))))
2515 (add-text-properties (match-beginning 0) (match-end 0)
2516 '(org-protected t)))))
2518 ;; Special case for \nbsp
2519 (goto-char (point-min))
2520 (while (re-search-forward "\\\\nbsp\\({}\\|\\>\\)" nil t)
2521 (org-if-unprotected
2522 (replace-match (org-export-latex-protect-string "~"))))
2524 ;; Protect LaTeX entities
2525 (goto-char (point-min))
2526 (while (re-search-forward org-latex-entities-regexp nil t)
2527 (org-if-unprotected
2528 (add-text-properties (match-beginning 0) (match-end 0)
2529 '(org-protected t))))
2531 ;; Replace radio links
2532 (goto-char (point-min))
2533 (while (re-search-forward
2534 (concat "<<<?" org-export-latex-all-targets-re
2535 ">>>?\\((INVISIBLE)\\)?") nil t)
2536 (org-if-unprotected-at (+ (match-beginning 0) 2)
2537 (replace-match
2538 (concat
2539 (org-export-latex-protect-string
2540 (format "\\label{%s}" (save-match-data (org-solidify-link-text
2541 (match-string 1)))))
2542 (if (match-string 2) "" (match-string 1)))
2543 t t)))
2545 ;; Delete @<...> constructs
2546 ;; Thanks to Daniel Clemente for this regexp
2547 (goto-char (point-min))
2548 (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
2549 (org-if-unprotected
2550 (replace-match ""))))
2552 (defun org-export-latex-fix-inputenc ()
2553 "Set the coding system in inputenc to what the buffer is."
2554 (let* ((cs buffer-file-coding-system)
2555 (opt (or (ignore-errors (latexenc-coding-system-to-inputenc cs))
2556 "utf8")))
2557 (when opt
2558 ;; Translate if that is requested
2559 (setq opt (or (cdr (assoc opt org-export-latex-inputenc-alist)) opt))
2560 ;; find the \usepackage statement and replace the option
2561 (goto-char (point-min))
2562 (while (re-search-forward "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
2563 nil t)
2564 (goto-char (match-beginning 1))
2565 (delete-region (match-beginning 1) (match-end 1))
2566 (insert opt))
2567 (and buffer-file-name
2568 (save-buffer)))))
2570 ;;; List handling:
2572 (defun org-export-latex-lists ()
2573 "Convert plain text lists in current buffer into LaTeX lists."
2574 ;; `org-list-end-re' output has changed since preprocess from
2575 ;; org-exp.el. Make sure it is taken into account.
2576 (let ((org-list-end-re "^ORG-LIST-END-MARKER\n"))
2577 (mapc
2578 (lambda (e)
2579 ;; For each type of context allowed for list export (E), find
2580 ;; every list, parse it, delete it and insert resulting
2581 ;; conversion to latex (RES), while keeping the same
2582 ;; `original-indentation' property.
2583 (let (res)
2584 (goto-char (point-min))
2585 (while (re-search-forward (org-item-beginning-re) nil t)
2586 (when (and (eq (get-text-property (point) 'list-context) e)
2587 (not (get-text-property (point) 'org-example)))
2588 (beginning-of-line)
2589 (setq res
2590 (org-list-to-latex
2591 ;; Narrowing is needed because we're converting
2592 ;; from inner functions to outer ones.
2593 (save-restriction
2594 (narrow-to-region (point) (point-max))
2595 (org-list-parse-list t))
2596 org-export-latex-list-parameters))
2597 ;; Extend previous value of original-indentation to the
2598 ;; whole string
2599 (insert (org-add-props res nil 'original-indentation
2600 (org-find-text-property-in-string
2601 'original-indentation res)))))))
2602 ;; List of allowed contexts for export, and the default one.
2603 (append org-list-export-context '(nil)))))
2605 (defconst org-latex-entities
2606 '("\\!"
2607 "\\'"
2608 "\\+"
2609 "\\,"
2610 "\\-"
2611 "\\:"
2612 "\\;"
2613 "\\<"
2614 "\\="
2615 "\\>"
2616 "\\Huge"
2617 "\\LARGE"
2618 "\\Large"
2619 "\\Styles"
2620 "\\\\"
2621 "\\`"
2622 "\\\""
2623 "\\addcontentsline"
2624 "\\address"
2625 "\\addtocontents"
2626 "\\addtocounter"
2627 "\\addtolength"
2628 "\\addvspace"
2629 "\\alph"
2630 "\\appendix"
2631 "\\arabic"
2632 "\\author"
2633 "\\begin{array}"
2634 "\\begin{center}"
2635 "\\begin{description}"
2636 "\\begin{enumerate}"
2637 "\\begin{eqnarray}"
2638 "\\begin{equation}"
2639 "\\begin{figure}"
2640 "\\begin{flushleft}"
2641 "\\begin{flushright}"
2642 "\\begin{itemize}"
2643 "\\begin{list}"
2644 "\\begin{minipage}"
2645 "\\begin{picture}"
2646 "\\begin{quotation}"
2647 "\\begin{quote}"
2648 "\\begin{tabbing}"
2649 "\\begin{table}"
2650 "\\begin{tabular}"
2651 "\\begin{thebibliography}"
2652 "\\begin{theorem}"
2653 "\\begin{titlepage}"
2654 "\\begin{verbatim}"
2655 "\\begin{verse}"
2656 "\\bf"
2657 "\\bf"
2658 "\\bibitem"
2659 "\\bigskip"
2660 "\\cdots"
2661 "\\centering"
2662 "\\circle"
2663 "\\cite"
2664 "\\cleardoublepage"
2665 "\\clearpage"
2666 "\\cline"
2667 "\\closing"
2668 "\\dashbox"
2669 "\\date"
2670 "\\ddots"
2671 "\\dotfill"
2672 "\\em"
2673 "\\fbox"
2674 "\\flushbottom"
2675 "\\fnsymbol"
2676 "\\footnote"
2677 "\\footnotemark"
2678 "\\footnotesize"
2679 "\\footnotetext"
2680 "\\frac"
2681 "\\frame"
2682 "\\framebox"
2683 "\\hfill"
2684 "\\hline"
2685 "\\hrulespace"
2686 "\\hspace"
2687 "\\huge"
2688 "\\hyphenation"
2689 "\\include"
2690 "\\includeonly"
2691 "\\indent"
2692 "\\input"
2693 "\\it"
2694 "\\kill"
2695 "\\label"
2696 "\\large"
2697 "\\ldots"
2698 "\\line"
2699 "\\linebreak"
2700 "\\linethickness"
2701 "\\listoffigures"
2702 "\\listoftables"
2703 "\\location"
2704 "\\makebox"
2705 "\\maketitle"
2706 "\\mark"
2707 "\\mbox"
2708 "\\medskip"
2709 "\\multicolumn"
2710 "\\multiput"
2711 "\\newcommand"
2712 "\\newcounter"
2713 "\\newenvironment"
2714 "\\newfont"
2715 "\\newlength"
2716 "\\newline"
2717 "\\newpage"
2718 "\\newsavebox"
2719 "\\newtheorem"
2720 "\\nocite"
2721 "\\nofiles"
2722 "\\noindent"
2723 "\\nolinebreak"
2724 "\\nopagebreak"
2725 "\\normalsize"
2726 "\\onecolumn"
2727 "\\opening"
2728 "\\oval"
2729 "\\overbrace"
2730 "\\overline"
2731 "\\pagebreak"
2732 "\\pagenumbering"
2733 "\\pageref"
2734 "\\pagestyle"
2735 "\\par"
2736 "\\parbox"
2737 "\\put"
2738 "\\raggedbottom"
2739 "\\raggedleft"
2740 "\\raggedright"
2741 "\\raisebox"
2742 "\\ref"
2743 "\\rm"
2744 "\\roman"
2745 "\\rule"
2746 "\\savebox"
2747 "\\sc"
2748 "\\scriptsize"
2749 "\\setcounter"
2750 "\\setlength"
2751 "\\settowidth"
2752 "\\sf"
2753 "\\shortstack"
2754 "\\signature"
2755 "\\sl"
2756 "\\small"
2757 "\\smallskip"
2758 "\\sqrt"
2759 "\\tableofcontents"
2760 "\\telephone"
2761 "\\thanks"
2762 "\\thispagestyle"
2763 "\\tiny"
2764 "\\title"
2765 "\\tt"
2766 "\\twocolumn"
2767 "\\typein"
2768 "\\typeout"
2769 "\\underbrace"
2770 "\\underline"
2771 "\\usebox"
2772 "\\usecounter"
2773 "\\value"
2774 "\\vdots"
2775 "\\vector"
2776 "\\verb"
2777 "\\vfill"
2778 "\\vline"
2779 "\\vspace")
2780 "A list of LaTeX commands to be protected when performing conversion.")
2782 (defconst org-latex-entities-regexp
2783 (let (names rest)
2784 (dolist (x org-latex-entities)
2785 (if (string-match "[a-zA-Z]$" x)
2786 (push x names)
2787 (push x rest)))
2788 (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
2789 "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
2791 (provide 'org-export-latex)
2792 (provide 'org-latex)
2794 ;;; org-latex.el ends here