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