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