Add support for BEAMER notes.
[org-mode.git] / lisp / org-latex.el
blob0e834221996d9467f14dee8a19bb49b27733036b
1 ;;; org-latex.el --- LaTeX exporter for org-mode
2 ;;
3 ;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
4 ;;
5 ;; Emacs Lisp Archive Entry
6 ;; Filename: org-latex.el
7 ;; Version: 6.33trans
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 latexp) ; dynamically scoped from org.el
77 (defvar re-quote) ; dynamically scoped from org.el
78 (defvar commentsp) ; dynamically scoped from org.el
80 ;;; User variables:
82 (defgroup org-export-latex nil
83 "Options for exporting Org-mode files to LaTeX."
84 :tag "Org Export LaTeX"
85 :group 'org-export)
87 (defcustom org-export-latex-default-class "article"
88 "The default LaTeX class."
89 :group 'org-export-latex
90 :type '(string :tag "LaTeX class"))
92 (defcustom org-export-latex-classes
93 '(("article"
94 "\\documentclass[11pt]{article}
95 \\usepackage[utf8]{inputenc}
96 \\usepackage[T1]{fontenc}
97 \\usepackage{graphicx}
98 \\usepackage{longtable}
99 \\usepackage{float}
100 \\usepackage{wrapfig}
101 \\usepackage{soul}
102 \\usepackage{amssymb}
103 \\usepackage{hyperref}"
104 ("\\section{%s}" . "\\section*{%s}")
105 ("\\subsection{%s}" . "\\subsection*{%s}")
106 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
107 ("\\paragraph{%s}" . "\\paragraph*{%s}")
108 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
109 ("report"
110 "\\documentclass[11pt]{report}
111 \\usepackage[utf8]{inputenc}
112 \\usepackage[T1]{fontenc}
113 \\usepackage{graphicx}
114 \\usepackage{longtable}
115 \\usepackage{float}
116 \\usepackage{wrapfig}
117 \\usepackage{soul}
118 \\usepackage{amssymb}
119 \\usepackage{hyperref}"
120 ("\\part{%s}" . "\\part*{%s}")
121 ("\\chapter{%s}" . "\\chapter*{%s}")
122 ("\\section{%s}" . "\\section*{%s}")
123 ("\\subsection{%s}" . "\\subsection*{%s}")
124 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
125 ("book"
126 "\\documentclass[11pt]{book}
127 \\usepackage[utf8]{inputenc}
128 \\usepackage[T1]{fontenc}
129 \\usepackage{graphicx}
130 \\usepackage{longtable}
131 \\usepackage{float}
132 \\usepackage{wrapfig}
133 \\usepackage{soul}
134 \\usepackage{amssymb}
135 \\usepackage{hyperref}"
136 ("\\part{%s}" . "\\part*{%s}")
137 ("\\chapter{%s}" . "\\chapter*{%s}")
138 ("\\section{%s}" . "\\section*{%s}")
139 ("\\subsection{%s}" . "\\subsection*{%s}")
140 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
141 ("beamer"
142 "\\documentclass{beamer}
143 \\usepackage[utf8]{inputenc}
144 \\usepackage[T1]{fontenc}
145 \\usepackage{graphicx}
146 \\usepackage{longtable}
147 \\usepackage{float}
148 \\usepackage{wrapfig}
149 \\usepackage{soul}
150 \\usepackage{amssymb}
151 \\usepackage{hyperref}"
152 org-beamer-sectioning
154 "Alist of LaTeX classes and associated header and structure.
155 If #+LaTeX_CLASS is set in the buffer, use its value and the
156 associated information. Here is the structure of each cell:
158 \(class-name
159 header-string
160 (numbered-section . unnumbered-section\)
161 ...\)
163 A %s formatter is mandatory in each section string and will be
164 replaced by the title of the section.
166 Instead of a cons cell (numbered . unnumbered), you can also provide a list
167 of 2-4 elements,
169 (numbered-open numbered-close)
173 (numbered-open numbered-close unnumbered-open unnumbered-close)
175 providing opening and closing strings for an environment that should
176 represent the document section. The opening clause should have a %s
177 to represent the section title.
179 Instead of a list of sectioning commands, you can also specify a
180 function name. that function will be called with two parameters,
181 the (reduced) level of the headline, and the headline text. The functions
182 returns a cons cell with the (possibly modified) headline text, and the
183 sectioning list in the cdr."
184 :group 'org-export-latex
185 :type '(repeat
186 (list (string :tag "LaTeX class")
187 (string :tag "LaTeX header")
188 (repeat :tag "Levels" :inline t
189 (choice
190 (cons :tag "Heading"
191 (string :tag " numbered")
192 (string :tag "unnumbered"))
193 (list :tag "Environment"
194 (string :tag "Opening (numbered)")
195 (string :tag "Closing (numbered)")
196 (string :tag "Opening (unnumbered)")
197 (string :tag "Closing (unnumbered)"))
198 (function :tag "Hook computing sectioning"))))))
200 (defcustom org-export-latex-emphasis-alist
201 '(("*" "\\textbf{%s}" nil)
202 ("/" "\\emph{%s}" nil)
203 ("_" "\\underline{%s}" nil)
204 ("+" "\\st{%s}" nil)
205 ("=" "\\verb" t)
206 ("~" "\\verb" t))
207 "Alist of LaTeX expressions to convert emphasis fontifiers.
208 Each element of the list is a list of three elements.
209 The first element is the character used as a marker for fontification.
210 The second element is a formatting string to wrap fontified text with.
211 If it is \"\\verb\", Org will automatically select a delimiter
212 character that is not in the string.
213 The third element decides whether to protect converted text from other
214 conversions."
215 :group 'org-export-latex
216 :type 'alist)
218 (defcustom org-export-latex-title-command "\\maketitle"
219 "The command used to insert the title just after \\begin{document}.
220 If this string contains the formatting specification \"%s\" then
221 it will be used as a formatting string, passing the title as an
222 argument."
223 :group 'org-export-latex
224 :type 'string)
226 (defcustom org-export-latex-import-inbuffer-stuff nil
227 "Non-nil means define TeX macros for Org's inbuffer definitions.
228 For example \orgTITLE for #+TITLE."
229 :group 'org-export-latex
230 :type 'boolean)
232 (defcustom org-export-latex-date-format
233 "%d %B %Y"
234 "Format string for \\date{...}."
235 :group 'org-export-latex
236 :type 'string)
238 (defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
239 "Markup for TODO keywords, as a printf format.
240 This can be a single format for all keywords, a cons cell with separate
241 formats for not-done and done states, or an association list with setup
242 for individual keywords. If a keyword shows up for which there is no
243 markup defined, the first one in the association list will be used."
244 :group 'org-export-latex
245 :type '(choice
246 (string :tag "Default")
247 (cons :tag "Distinguish undone and done"
248 (string :tag "Not-DONE states")
249 (string :tag "DONE states"))
250 (repeat :tag "Per keyword markup"
251 (cons
252 (string :tag "Keyword")
253 (string :tag "Markup")))))
255 (defcustom org-export-latex-timestamp-markup "\\textit{%s}"
256 "A printf format string to be applied to time stamps."
257 :group 'org-export-latex
258 :type 'string)
260 (defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
261 "A printf format string to be applied to time stamps."
262 :group 'org-export-latex
263 :type 'string)
265 (defcustom org-export-latex-tables-verbatim nil
266 "When non-nil, tables are exported verbatim."
267 :group 'org-export-latex
268 :type 'boolean)
270 (defcustom org-export-latex-tables-centered t
271 "When non-nil, tables are exported in a center environment."
272 :group 'org-export-latex
273 :type 'boolean)
275 (defcustom org-export-latex-tables-column-borders nil
276 "When non-nil, grouping columns can cause outer vertical lines in tables.
277 When nil, grouping causes only separation lines between groups."
278 :group 'org-export-latex
279 :type 'boolean)
281 (defcustom org-export-latex-low-levels 'itemize
282 "How to convert sections below the current level of sectioning.
283 This is specified by the `org-export-headline-levels' option or the
284 value of \"H:\" in Org's #+OPTION line.
286 This can be either nil (skip the sections), `description', `itemize',
287 or `enumerate' (convert the sections as the corresponding list type), or
288 a string to be used instead of \\section{%s}. In this latter case,
289 the %s stands here for the inserted headline and is mandatory.
291 It may also be a list of three string to define a user-defined environment
292 that should be used. The first string should be the like
293 \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
294 to two occurrences of %s for the title and a label, respectively. The third
295 string should be like \"\\end{itemize\"."
296 :group 'org-export-latex
297 :type '(choice (const :tag "Ignore" nil)
298 (const :tag "Convert as descriptive list" description)
299 (const :tag "Convert as itemized list" itemize)
300 (const :tag "Convert as enumerated list" enumerate)
301 (list :tag "User-defined environment"
302 :value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
303 (string :tag "Start")
304 (string :tag "End")
305 (string :tag "item"))
306 (string :tag "Use a section string" :value "\\subparagraph{%s}")))
308 (defcustom org-export-latex-list-parameters
309 '(:cbon "$\\boxtimes$" :cboff "$\\Box$")
310 "Parameters for the LaTeX list exporter.
311 These parameters will be passed on to `org-list-to-latex', which in turn
312 will pass them (combined with the LaTeX default list parameters) to
313 `org-list-to-generic'."
314 :group 'org-export-latex
315 :type 'plist)
317 (defcustom org-export-latex-verbatim-wrap
318 '("\\begin{verbatim}\n" . "\\end{verbatim}\n")
319 "Environment to be wrapped around a fixed-width section in LaTeX export.
320 This is a cons with two strings, to be added before and after the
321 fixed-with text.
323 Defaults to \\begin{verbatim} and \\end{verbatim}."
324 :group 'org-export-translation
325 :group 'org-export-latex
326 :type '(cons (string :tag "Open")
327 (string :tag "Close")))
329 (defcustom org-export-latex-listings nil
330 "Non-nil means, export source code using the listings package.
331 This package will fontify source code, possibly even with color.
332 If you want to use this, you also need to make LaTeX use the
333 listings package, and if you want to have color, the color
334 package. Just add these to `org-export-latex-packages-alist',
335 for example using customize, or with something like
337 (require 'org-latex)
338 (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
339 (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))"
340 :group 'org-export-latex
341 :type 'boolean)
343 (defcustom org-export-latex-listings-langs
344 '((emacs-lisp "Lisp") (lisp "Lisp")
345 (c "C") (cc "C++")
346 (fortran "fortran")
347 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
348 (html "HTML") (xml "XML")
349 (tex "TeX") (latex "TeX")
350 (shell-script "bash")
351 (gnuplot "Gnuplot")
352 (ocaml "Caml") (caml "Caml")
353 (sql "SQL"))
354 "Alist mapping languages to their listing language counterpart.
355 The key is a symbol, the major mode symbol without the \"-mode\".
356 The value is the string that should be inserted as the language parameter
357 for the listings package. If the mode name and the listings name are
358 the same, the language does not need an entry in this list - but it does not
359 hurt if it is present."
360 :group 'org-export-latex
361 :type '(repeat
362 (list
363 (symbol :tag "Major mode ")
364 (string :tag "Listings language"))))
366 (defcustom org-export-latex-remove-from-headlines
367 '(:todo nil :priority nil :tags nil)
368 "A plist of keywords to remove from headlines. OBSOLETE.
369 Non-nil means remove this keyword type from the headline.
371 Don't remove the keys, just change their values.
373 Obsolete, this variable is no longer used. Use the separate
374 variables `org-export-with-todo-keywords', `org-export-with-priority',
375 and `org-export-with-tags' instead."
376 :type 'plist
377 :group 'org-export-latex)
379 (defcustom org-export-latex-image-default-option "width=10em"
380 "Default option for images."
381 :group 'org-export-latex
382 :type 'string)
384 (defcustom org-export-latex-inline-image-extensions
385 '("pdf" "jpeg" "jpg" "png" "ps" "eps")
386 "Extensions of image files that can be inlined into LaTeX.
387 Note that the image extension *actually* allowed depend on the way the
388 LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
389 are OK. When processing through dvi to Postscript, only ps and eps are
390 allowed. The default we use here encompasses both."
391 :group 'org-export-latex
392 :type '(repeat (string :tag "Extension")))
394 (defcustom org-export-latex-coding-system nil
395 "Coding system for the exported LaTex file."
396 :group 'org-export-latex
397 :type 'coding-system)
399 (defgroup org-export-pdf nil
400 "Options for exporting Org-mode files to PDF, via LaTeX."
401 :tag "Org Export PDF"
402 :group 'org-export-latex
403 :group 'org-export)
405 (defcustom org-latex-to-pdf-process
406 '("pdflatex -interaction nonstopmode %s"
407 "pdflatex -interaction nonstopmode %s")
408 "Commands to process a LaTeX file to a PDF file.
409 This is a list of strings, each of them will be given to the shell
410 as a command. %s in the command will be replaced by the full file name, %b
411 by the file base name (i.e. without extension).
412 The reason why this is a list is that it usually takes several runs of
413 pdflatex, maybe mixed with a call to bibtex. Org does not have a clever
414 mechanism to detect which of these commands have to be run to get to a stable
415 result, and it also does not do any error checking.
417 Alternatively, this may be a Lisp function that does the processing, so you
418 could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
419 This function should accept the file name as its single argument."
420 :group 'org-export-pdf
421 :type '(choice (repeat :tag "Shell command sequence"
422 (string :tag "Shell command"))
423 (function)))
425 (defcustom org-export-pdf-logfiles
426 '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
427 "The list of file extensions to consider as LaTeX logfiles."
428 :group 'org-export-pdf
429 :type '(repeat (string :tag "Extension")))
431 (defcustom org-export-pdf-remove-logfiles t
432 "Non-nil means, remove the logfiles produced by PDF production.
433 These are the .aux, .log, .out, and .toc files."
434 :group 'org-export-pdf
435 :type 'boolean)
437 ;;; Hooks
439 (defvar org-export-latex-after-initial-vars-hook nil
440 "Hook run before LaTeX export.
441 The exact moment is after the initial variables like org-export-latex-class
442 have been determined from the environment.")
444 (defvar org-export-latex-after-blockquotes-hook nil
445 "Hook run during LaTeX export, after blockquote, verse, center are done.")
447 (defvar org-export-latex-final-hook nil
448 "Hook run in the finalized LaTeX buffer.")
450 ;;; Autoload functions:
452 ;;;###autoload
453 (defun org-export-as-latex-batch ()
454 "Call `org-export-as-latex', may be used in batch processing.
455 For example:
457 emacs --batch
458 --load=$HOME/lib/emacs/org.el
459 --eval \"(setq org-export-headline-levels 2)\"
460 --visit=MyFile --funcall org-export-as-latex-batch"
461 (org-export-as-latex org-export-headline-levels 'hidden))
463 ;;;###autoload
464 (defun org-export-as-latex-to-buffer (arg)
465 "Call `org-export-as-latex` with output to a temporary buffer.
466 No file is created. The prefix ARG is passed through to `org-export-as-latex'."
467 (interactive "P")
468 (org-export-as-latex arg nil nil "*Org LaTeX Export*")
469 (when org-export-show-temporary-export-buffer
470 (switch-to-buffer-other-window "*Org LaTeX Export*")))
472 ;;;###autoload
473 (defun org-replace-region-by-latex (beg end)
474 "Replace the region from BEG to END with its LaTeX export.
475 It assumes the region has `org-mode' syntax, and then convert it to
476 LaTeX. This can be used in any buffer. For example, you could
477 write an itemized list in `org-mode' syntax in an LaTeX buffer and
478 then use this command to convert it."
479 (interactive "r")
480 (let (reg latex buf)
481 (save-window-excursion
482 (if (org-mode-p)
483 (setq latex (org-export-region-as-latex
484 beg end t 'string))
485 (setq reg (buffer-substring beg end)
486 buf (get-buffer-create "*Org tmp*"))
487 (with-current-buffer buf
488 (erase-buffer)
489 (insert reg)
490 (org-mode)
491 (setq latex (org-export-region-as-latex
492 (point-min) (point-max) t 'string)))
493 (kill-buffer buf)))
494 (delete-region beg end)
495 (insert latex)))
497 ;;;###autoload
498 (defun org-export-region-as-latex (beg end &optional body-only buffer)
499 "Convert region from BEG to END in `org-mode' buffer to LaTeX.
500 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
501 contents, and only produce the region of converted text, useful for
502 cut-and-paste operations.
503 If BUFFER is a buffer or a string, use/create that buffer as a target
504 of the converted LaTeX. If BUFFER is the symbol `string', return the
505 produced LaTeX as a string and leave no buffer behind. For example,
506 a Lisp program could call this function in the following way:
508 (setq latex (org-export-region-as-latex beg end t 'string))
510 When called interactively, the output buffer is selected, and shown
511 in a window. A non-interactive call will only return the buffer."
512 (interactive "r\nP")
513 (when (interactive-p)
514 (setq buffer "*Org LaTeX Export*"))
515 (let ((transient-mark-mode t) (zmacs-regions t)
516 ext-plist rtn)
517 (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
518 (goto-char end)
519 (set-mark (point)) ;; to activate the region
520 (goto-char beg)
521 (setq rtn (org-export-as-latex
522 nil nil ext-plist
523 buffer body-only))
524 (if (fboundp 'deactivate-mark) (deactivate-mark))
525 (if (and (interactive-p) (bufferp rtn))
526 (switch-to-buffer-other-window rtn)
527 rtn)))
529 ;;;###autoload
530 (defun org-export-as-latex (arg &optional hidden ext-plist
531 to-buffer body-only pub-dir)
532 "Export current buffer to a LaTeX file.
533 If there is an active region, export only the region. The prefix
534 ARG specifies how many levels of the outline should become
535 headlines. The default is 3. Lower levels will be exported
536 depending on `org-export-latex-low-levels'. The default is to
537 convert them as description lists.
538 HIDDEN is obsolete and does nothing.
539 EXT-PLIST is a property list with
540 external parameters overriding org-mode's default settings, but
541 still inferior to file-local settings. When TO-BUFFER is
542 non-nil, create a buffer with that name and export to that
543 buffer. If TO-BUFFER is the symbol `string', don't leave any
544 buffer behind but just return the resulting LaTeX as a string.
545 When BODY-ONLY is set, don't produce the file header and footer,
546 simply return the content of \begin{document}...\end{document},
547 without even the \begin{document} and \end{document} commands.
548 when PUB-DIR is set, use this as the publishing directory."
549 (interactive "P")
550 (run-hooks 'org-export-first-hook)
552 ;; Make sure we have a file name when we need it.
553 (when (and (not (or to-buffer body-only))
554 (not buffer-file-name))
555 (if (buffer-base-buffer)
556 (org-set-local 'buffer-file-name
557 (with-current-buffer (buffer-base-buffer)
558 buffer-file-name))
559 (error "Need a file name to be able to export")))
561 (message "Exporting to LaTeX...")
562 (org-unmodified
563 (let ((inhibit-read-only t))
564 (remove-text-properties (point-min) (point-max)
565 '(:org-license-to-kill nil))))
566 (org-update-radio-target-regexp)
567 (org-export-latex-set-initial-vars ext-plist arg)
568 (setq org-export-opt-plist org-export-latex-options-plist)
569 (org-install-letbind)
570 (run-hooks 'org-export-latex-after-initial-vars-hook)
571 (let* ((wcf (current-window-configuration))
572 (opt-plist org-export-latex-options-plist)
573 (region-p (org-region-active-p))
574 (rbeg (and region-p (region-beginning)))
575 (rend (and region-p (region-end)))
576 (subtree-p
577 (if (plist-get opt-plist :ignore-subtree-p)
579 (when region-p
580 (save-excursion
581 (goto-char rbeg)
582 (and (org-at-heading-p)
583 (>= (org-end-of-subtree t t) rend))))))
584 (opt-plist (setq org-export-opt-plist
585 (if subtree-p
586 (org-export-add-subtree-options opt-plist rbeg)
587 opt-plist)))
588 ;; Make sure the variable contains the updated values.
589 (org-export-latex-options-plist (setq org-export-opt-plist opt-plist))
590 (title (or (and subtree-p (org-export-get-title-from-subtree))
591 (plist-get opt-plist :title)
592 (and (not
593 (plist-get opt-plist :skip-before-1st-heading))
594 (org-export-grab-title-from-buffer))
595 (file-name-sans-extension
596 (file-name-nondirectory buffer-file-name))))
597 (filename (concat (file-name-as-directory
598 (or pub-dir
599 (org-export-directory :LaTeX ext-plist)))
600 (file-name-sans-extension
601 (or (and subtree-p
602 (org-entry-get rbeg "EXPORT_FILE_NAME" t))
603 (file-name-nondirectory ;sans-extension
604 buffer-file-name)))
605 ".tex"))
606 (filename (if (equal (file-truename filename)
607 (file-truename buffer-file-name))
608 (concat filename ".tex")
609 filename))
610 (buffer (if to-buffer
611 (cond
612 ((eq to-buffer 'string) (get-buffer-create
613 "*Org LaTeX Export*"))
614 (t (get-buffer-create to-buffer)))
615 (find-file-noselect filename)))
616 (odd org-odd-levels-only)
617 (header (org-export-latex-make-header title opt-plist))
618 (skip (cond (subtree-p nil)
619 (region-p nil)
620 (t (plist-get opt-plist :skip-before-1st-heading))))
621 (text (plist-get opt-plist :text))
622 (org-export-preprocess-hook
623 (cons
624 `(lambda () (org-set-local 'org-complex-heading-regexp
625 ,org-export-latex-complex-heading-re))
626 org-export-preprocess-hook))
627 (first-lines (if skip "" (org-export-latex-first-lines
628 opt-plist
629 (if subtree-p
630 (save-excursion
631 (goto-char rbeg)
632 (point-at-bol 2))
633 rbeg)
634 (if region-p rend))))
635 (coding-system (and (boundp 'buffer-file-coding-system)
636 buffer-file-coding-system))
637 (coding-system-for-write (or org-export-latex-coding-system
638 coding-system))
639 (save-buffer-coding-system (or org-export-latex-coding-system
640 coding-system))
641 (region (buffer-substring
642 (if region-p (region-beginning) (point-min))
643 (if region-p (region-end) (point-max))))
644 (text
645 (and text (string-match "\\S-" text)
646 (org-export-preprocess-string
647 text
648 :emph-multiline t
649 :for-LaTeX t
650 :comments nil
651 :tags (plist-get opt-plist :tags)
652 :priority (plist-get opt-plist :priority)
653 :footnotes (plist-get opt-plist :footnotes)
654 :drawers (plist-get opt-plist :drawers)
655 :timestamps (plist-get opt-plist :timestamps)
656 :todo-keywords (plist-get opt-plist :todo-keywords)
657 :add-text nil
658 :skip-before-1st-heading skip
659 :select-tags nil
660 :exclude-tags nil
661 :LaTeX-fragments nil)))
662 (string-for-export
663 (org-export-preprocess-string
664 region
665 :emph-multiline t
666 :for-LaTeX t
667 :comments nil
668 :tags (plist-get opt-plist :tags)
669 :priority (plist-get opt-plist :priority)
670 :footnotes (plist-get opt-plist :footnotes)
671 :drawers (plist-get opt-plist :drawers)
672 :timestamps (plist-get opt-plist :timestamps)
673 :todo-keywords (plist-get opt-plist :todo-keywords)
674 :add-text (if (eq to-buffer 'string) nil text)
675 :skip-before-1st-heading skip
676 :select-tags (plist-get opt-plist :select-tags)
677 :exclude-tags (plist-get opt-plist :exclude-tags)
678 :LaTeX-fragments nil)))
680 (set-buffer buffer)
681 (erase-buffer)
682 (org-install-letbind)
684 (and (fboundp 'set-buffer-file-coding-system)
685 (set-buffer-file-coding-system coding-system-for-write))
687 ;; insert the header and initial document commands
688 (unless (or (eq to-buffer 'string) body-only)
689 (insert header))
691 ;; insert text found in #+TEXT
692 (when (and text (not (eq to-buffer 'string)))
693 (insert (org-export-latex-content
694 text '(lists tables fixed-width keywords))
695 "\n\n"))
697 ;; insert lines before the first headline
698 (unless skip
699 (insert first-lines))
701 ;; export the content of headlines
702 (org-export-latex-global
703 (with-temp-buffer
704 (insert string-for-export)
705 (goto-char (point-min))
706 (when (re-search-forward "^\\(\\*+\\) " nil t)
707 (let* ((asters (length (match-string 1)))
708 (level (if odd (- asters 2) (- asters 1))))
709 (setq org-export-latex-add-level
710 (if odd (1- (/ (1+ asters) 2)) (1- asters)))
711 (org-export-latex-parse-global level odd)))))
713 ;; finalization
714 (unless body-only (insert "\n\\end{document}"))
716 ;; Attach description terms to the \item macro
717 (goto-char (point-min))
718 (while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t)
719 (delete-region (match-beginning 1) (match-end 1)))
721 ;; Relocate the table of contents
722 (goto-char (point-min))
723 (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
724 (goto-char (point-min))
725 (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
726 (replace-match ""))
727 (goto-char (point-min))
728 (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
729 (replace-match "\\tableofcontents" t t)))
731 ;; Cleanup forced line ends in items where they are not needed
732 (goto-char (point-min))
733 (while (re-search-forward
734 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
735 nil t)
736 (delete-region (match-beginning 1) (match-end 1)))
737 (goto-char (point-min))
738 (while (re-search-forward
739 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
740 nil t)
741 (if (looking-at "[\n \t]+")
742 (replace-match "\n")))
744 (run-hooks 'org-export-latex-final-hook)
745 (or to-buffer (save-buffer))
746 (goto-char (point-min))
747 (or (org-export-push-to-kill-ring "LaTeX")
748 (message "Exporting to LaTeX...done"))
749 (prog1
750 (if (eq to-buffer 'string)
751 (prog1 (buffer-substring (point-min) (point-max))
752 (kill-buffer (current-buffer)))
753 (current-buffer))
754 (set-window-configuration wcf))))
756 ;;;###autoload
757 (defun org-export-as-pdf (arg &optional hidden ext-plist
758 to-buffer body-only pub-dir)
759 "Export as LaTeX, then process through to PDF."
760 (interactive "P")
761 (message "Exporting to PDF...")
762 (let* ((wconfig (current-window-configuration))
763 (lbuf (org-export-as-latex arg hidden ext-plist
764 to-buffer body-only pub-dir))
765 (file (buffer-file-name lbuf))
766 (base (file-name-sans-extension (buffer-file-name lbuf)))
767 (pdffile (concat base ".pdf"))
768 (cmds org-latex-to-pdf-process)
769 (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
770 (bibtex-p (with-current-buffer lbuf
771 (save-excursion
772 (goto-char (point-min))
773 (re-search-forward "\\\\bibliography{" nil t))))
774 cmd)
775 (with-current-buffer outbuf (erase-buffer))
776 (message "Processing LaTeX file...")
777 (if (and cmds (symbolp cmds))
778 (funcall cmds file)
779 (while cmds
780 (setq cmd (pop cmds))
781 (while (string-match "%b" cmd)
782 (setq cmd (replace-match
783 (save-match-data
784 (shell-quote-argument base))
785 t t cmd)))
786 (while (string-match "%s" cmd)
787 (setq cmd (replace-match
788 (save-match-data
789 (shell-quote-argument file))
790 t t cmd)))
791 (shell-command cmd outbuf outbuf)))
792 (message "Processing LaTeX file...done")
793 (if (not (file-exists-p pdffile))
794 (error "PDF file was not produced")
795 (set-window-configuration wconfig)
796 (when org-export-pdf-remove-logfiles
797 (dolist (ext org-export-pdf-logfiles)
798 (setq file (concat base "." ext))
799 (and (file-exists-p file) (delete-file file))))
800 (message "Exporting to PDF...done")
801 pdffile)))
803 ;;;###autoload
804 (defun org-export-as-pdf-and-open (arg)
805 "Export as LaTeX, then process through to PDF, and open."
806 (interactive "P")
807 (let ((pdffile (org-export-as-pdf arg)))
808 (if pdffile
809 (org-open-file pdffile)
810 (error "PDF file was not produced"))))
812 ;;; Parsing functions:
814 (defun org-export-latex-parse-global (level odd)
815 "Parse the current buffer recursively, starting at LEVEL.
816 If ODD is non-nil, assume the buffer only contains odd sections.
817 Return a list reflecting the document structure."
818 (save-excursion
819 (goto-char (point-min))
820 (let* ((cnt 0) output
821 (depth org-export-latex-sectioning-depth))
822 (while (org-re-search-forward-unprotected
823 (concat "^\\(\\(?:\\*\\)\\{"
824 (number-to-string (+ (if odd 2 1) level))
825 "\\}\\) \\(.*\\)$")
826 ;; make sure that there is no upper heading
827 (when (> level 0)
828 (save-excursion
829 (save-match-data
830 (org-re-search-forward-unprotected
831 (concat "^\\(\\(?:\\*\\)\\{"
832 (number-to-string level)
833 "\\}\\) \\(.*\\)$") nil t)))) t)
834 (setq cnt (1+ cnt))
835 (let* ((pos (match-beginning 0))
836 (heading (match-string 2))
837 (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
838 (save-excursion
839 (narrow-to-region
840 (point)
841 (save-match-data
842 (if (org-re-search-forward-unprotected
843 (concat "^\\(\\(?:\\*\\)\\{"
844 (number-to-string (+ (if odd 2 1) level))
845 "\\}\\) \\(.*\\)$") nil t)
846 (match-beginning 0)
847 (point-max))))
848 (goto-char (point-min))
849 (setq output
850 (append output
851 (list
852 (list
853 `(pos . ,pos)
854 `(level . ,nlevel)
855 `(occur . ,cnt)
856 `(heading . ,heading)
857 `(content . ,(org-export-latex-parse-content))
858 `(subcontent . ,(org-export-latex-parse-subcontent
859 level odd)))))))
860 (widen)))
861 (list output))))
863 (defun org-export-latex-parse-content ()
864 "Extract the content of a section."
865 (let ((beg (point))
866 (end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t)
867 (progn (beginning-of-line) (point))
868 (point-max))))
869 (buffer-substring beg end)))
871 (defun org-export-latex-parse-subcontent (level odd)
872 "Extract the subcontent of a section at LEVEL.
873 If ODD Is non-nil, assume subcontent only contains odd sections."
874 (if (not (org-re-search-forward-unprotected
875 (concat "^\\(\\(?:\\*\\)\\{"
876 (number-to-string (+ (if odd 4 2) level))
877 "\\}\\) \\(.*\\)$")
878 nil t))
879 nil ; subcontent is nil
880 (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
882 ;;; Rendering functions:
883 (defun org-export-latex-global (content)
884 "Export CONTENT to LaTeX.
885 CONTENT is an element of the list produced by
886 `org-export-latex-parse-global'."
887 (if (eq (car content) 'subcontent)
888 (mapc 'org-export-latex-sub (cdr content))
889 (org-export-latex-sub (car content))))
891 (defun org-export-latex-sub (subcontent)
892 "Export the list SUBCONTENT to LaTeX.
893 SUBCONTENT is an alist containing information about the headline
894 and its content."
895 (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
896 (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
898 (defun org-export-latex-subcontent (subcontent num)
899 "Export each cell of SUBCONTENT to LaTeX.
900 If NUM, export sections as numerical sections."
901 (let* ((heading (cdr (assoc 'heading subcontent)))
902 (level (- (cdr (assoc 'level subcontent))
903 org-export-latex-add-level))
904 (occur (number-to-string (cdr (assoc 'occur subcontent))))
905 (content (cdr (assoc 'content subcontent)))
906 (subcontent (cadr (assoc 'subcontent subcontent)))
907 (label (org-get-text-property-any 0 'target heading))
908 (label-list (cons label (cdr (assoc label
909 org-export-target-aliases))))
910 (sectioning org-export-latex-sectioning)
911 (depth org-export-latex-sectioning-depth)
912 main-heading sub-heading)
913 (when (symbolp (car sectioning))
914 (setq sectioning (funcall (car sectioning) level heading))
915 (when sectioning
916 (setq heading (car sectioning)
917 sectioning (cdr sectioning)
918 ;; target property migh have changed...
919 label (org-get-text-property-any 0 'target heading)
920 label-list (cons label (cdr (assoc label
921 org-export-target-aliases)))))
922 (if sectioning (setq sectioning (make-list 10 sectioning)))
923 (setq depth (if sectioning 10000 0)))
924 (if (string-match "[ \t]*\\\\\\\\[ \t]*" heading)
925 (setq main-heading (substring heading 0 (match-beginning 0))
926 sub-heading (substring heading (match-end 0))))
927 (setq heading (org-export-latex-fontify-headline heading)
928 sub-heading (and sub-heading
929 (org-export-latex-fontify-headline sub-heading))
930 main-heading (and main-heading
931 (org-export-latex-fontify-headline main-heading)))
932 (cond
933 ;; Normal conversion
934 ((<= level depth)
935 (let* ((sec (nth (1- level) sectioning))
936 start end)
937 (if (consp (cdr sec))
938 (setq start (nth (if num 0 2) sec)
939 end (nth (if num 1 3) sec))
940 (setq start (if num (car sec) (cdr sec))))
941 (insert (format start (if main-heading main-heading heading)
942 (or sub-heading "")))
943 (insert "\n")
944 (when label
945 (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
946 label-list "\n") "\n"))
947 (insert (org-export-latex-content content))
948 (cond ((stringp subcontent) (insert subcontent))
949 ((listp subcontent)
950 (while (org-looking-back "\n\n") (backward-delete-char 1))
951 (org-export-latex-sub subcontent)))
952 (when (and end (string-match "[^ \t]" end))
953 (let ((hook (org-get-text-property-any 0 'org-insert-hook end)))
954 (and (functionp hook) (funcall hook)))
955 (insert end "\n"))))
956 ;; At a level under the hl option: we can drop this subsection
957 ((> level depth)
958 (cond ((eq org-export-latex-low-levels 'description)
959 (if (string-match "% ends low level$"
960 (buffer-substring (point-at-bol 0) (point)))
961 (delete-region (point-at-bol 0) (point))
962 (insert "\\begin{description}\n"))
963 (insert (format "\n\\item[%s]%s~\n"
964 heading
965 (if label (format "\\label{%s}" label) "")))
966 (insert (org-export-latex-content content))
967 (cond ((stringp subcontent) (insert subcontent))
968 ((listp subcontent) (org-export-latex-sub subcontent)))
969 (insert "\\end{description} % ends low level\n"))
970 ((memq org-export-latex-low-levels '(itemize enumerate))
971 (if (string-match "% ends low level$"
972 (buffer-substring (point-at-bol 0) (point)))
973 (delete-region (point-at-bol 0) (point))
974 (insert (format "\\begin{%s}\n"
975 (symbol-name org-export-latex-low-levels))))
976 (insert (format "\n\\item %s\\\\\n%s%%"
977 heading
978 (if label (format "\\label{%s}" label) "")))
979 (insert (org-export-latex-content content))
980 (cond ((stringp subcontent) (insert subcontent))
981 ((listp subcontent) (org-export-latex-sub subcontent)))
982 (insert (format "\\end{%s} %% ends low level\n"
983 (symbol-name org-export-latex-low-levels))))
985 ((listp org-export-latex-low-levels)
986 (if (string-match "% ends low level$"
987 (buffer-substring (point-at-bol 0) (point)))
988 (delete-region (point-at-bol 0) (point))
989 (insert (car org-export-latex-low-levels) "\n"))
990 (insert (format (nth 2 org-export-latex-low-levels)
991 heading
992 (if label (format "\\label{%s}" label) "")))
993 (insert (org-export-latex-content content))
994 (cond ((stringp subcontent) (insert subcontent))
995 ((listp subcontent) (org-export-latex-sub subcontent)))
996 (insert (nth 1 org-export-latex-low-levels)
997 " %% ends low level\n"))
999 ((stringp org-export-latex-low-levels)
1000 (insert (format org-export-latex-low-levels heading) "\n")
1001 (when label (insert (format "\\label{%s}\n" label)))
1002 (insert (org-export-latex-content content))
1003 (cond ((stringp subcontent) (insert subcontent))
1004 ((listp subcontent) (org-export-latex-sub subcontent)))))))))
1006 ;;; Exporting internals:
1007 (defun org-export-latex-set-initial-vars (ext-plist level)
1008 "Store org local variables required for LaTeX export.
1009 EXT-PLIST is an optional additional plist.
1010 LEVEL indicates the default depth for export."
1011 (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
1012 org-export-latex-done-keywords org-done-keywords
1013 org-export-latex-not-done-keywords org-not-done-keywords
1014 org-export-latex-complex-heading-re org-complex-heading-regexp
1015 org-export-latex-display-custom-times org-display-custom-times
1016 org-export-latex-all-targets-re
1017 (org-make-target-link-regexp (org-all-targets))
1018 org-export-latex-options-plist
1019 (org-combine-plists (org-default-export-plist) ext-plist
1020 (org-infile-export-plist))
1021 org-export-latex-class
1022 (or (and (org-region-active-p)
1023 (save-excursion
1024 (goto-char (region-beginning))
1025 (and (looking-at org-complex-heading-regexp)
1026 (org-entry-get nil "LaTeX_CLASS" 'selective))))
1027 (save-excursion
1028 (save-restriction
1029 (widen)
1030 (goto-char (point-min))
1031 (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([a-zA-Z]+\\)" nil t)
1032 (match-string 1))))
1033 (plist-get org-export-latex-options-plist :latex-class)
1034 org-export-latex-default-class)
1035 org-export-latex-class-options
1036 (or (and (org-region-active-p)
1037 (save-excursion
1038 (goto-char (region-beginning))
1039 (and (looking-at org-complex-heading-regexp)
1040 (org-entry-get nil "LaTeX_CLASS_OPTIONS" 'selective))))
1041 (save-excursion
1042 (save-restriction
1043 (widen)
1044 (goto-char (point-min))
1045 (and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t)
1046 (match-string 1))))
1047 (plist-get org-export-latex-options-plist :latex-class-options))
1048 org-export-latex-class
1049 (or (car (assoc org-export-latex-class org-export-latex-classes))
1050 (error "No definition for class `%s' in `org-export-latex-classes'"
1051 org-export-latex-class))
1052 org-export-latex-header
1053 (cadr (assoc org-export-latex-class org-export-latex-classes))
1054 org-export-latex-sectioning
1055 (cddr (assoc org-export-latex-class org-export-latex-classes))
1056 org-export-latex-sectioning-depth
1057 (or level
1058 (let ((hl-levels
1059 (plist-get org-export-latex-options-plist :headline-levels))
1060 (sec-depth (length org-export-latex-sectioning)))
1061 (if (> hl-levels sec-depth) sec-depth hl-levels))))
1062 (when (and org-export-latex-class-options
1063 (string-match "\\S-" org-export-latex-class-options)
1064 (string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
1065 org-export-latex-header))
1066 (setq org-export-latex-header
1067 (concat (substring org-export-latex-header 0 (match-end 1))
1068 org-export-latex-class-options
1069 (substring org-export-latex-header (match-end 0))))))
1071 (defvar org-export-latex-format-toc-function
1072 'org-export-latex-format-toc-default
1073 "The function formatting returning the string to createthe table of contents.
1074 The function mus take one parameter, the depth of the table of contents.")
1076 (defun org-export-latex-make-header (title opt-plist)
1077 "Make the LaTeX header and return it as a string.
1078 TITLE is the current title from the buffer or region.
1079 OPT-PLIST is the options plist for current buffer."
1080 (let ((toc (plist-get opt-plist :table-of-contents))
1081 (author (plist-get opt-plist :author)))
1082 (concat
1083 (if (plist-get opt-plist :time-stamp-file)
1084 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1085 ;; insert LaTeX custom header
1086 (org-export-apply-macros-in-string org-export-latex-header)
1087 "\n"
1088 ;; insert information on LaTeX packages
1089 (when org-export-latex-packages-alist
1090 (concat
1091 (mapconcat (lambda(p)
1092 (if (equal "" (car p))
1093 (format "\\usepackage{%s}" (cadr p))
1094 (format "\\usepackage[%s]{%s}"
1095 (car p) (cadr p))))
1096 org-export-latex-packages-alist "\n")
1097 "\n"))
1098 ;; insert additional commands in the header
1099 (org-export-apply-macros-in-string
1100 (plist-get opt-plist :latex-header-extra))
1101 (org-export-apply-macros-in-string org-export-latex-append-header)
1102 ;; insert the title
1103 (format
1104 "\n\n\\title{%s}\n"
1105 ;; convert the title
1106 (org-export-latex-content
1107 title '(lists tables fixed-width keywords)))
1108 ;; insert author info
1109 (if (plist-get opt-plist :author-info)
1110 (format "\\author{%s}\n"
1111 (org-export-latex-fontify-headline (or author user-full-name)))
1112 (format "%%\\author{%s}\n"
1113 (or author user-full-name)))
1114 ;; insert the date
1115 (format "\\date{%s}\n"
1116 (format-time-string
1117 (or (plist-get opt-plist :date)
1118 org-export-latex-date-format)))
1119 ;; beginning of the document
1120 "\n\\begin{document}\n\n"
1121 ;; insert the title command
1122 (when (string-match "\\S-" title)
1123 (if (string-match "%s" org-export-latex-title-command)
1124 (format org-export-latex-title-command title)
1125 org-export-latex-title-command))
1126 "\n\n"
1127 ;; table of contents
1128 (when (and org-export-with-toc
1129 (plist-get opt-plist :section-numbers))
1130 (funcall org-export-latex-format-toc-function
1131 (cond ((numberp toc)
1132 (min toc (plist-get opt-plist :headline-levels)))
1133 (toc (plist-get opt-plist :headline-levels))))))))
1135 (defun org-export-latex-format-toc-default (depth)
1136 (when depth
1137 (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
1138 depth)))
1140 (defun org-export-latex-first-lines (opt-plist &optional beg end)
1141 "Export the first lines before first headline.
1142 If BEG is non-nil, it is the beginning of the region.
1143 If END is non-nil, it is the end of the region."
1144 (save-excursion
1145 (goto-char (or beg (point-min)))
1146 (let* ((pt (point))
1147 (end (if (re-search-forward "^\\*+ " end t)
1148 (goto-char (match-beginning 0))
1149 (goto-char (or end (point-max))))))
1150 (prog1
1151 (org-export-latex-content
1152 (org-export-preprocess-string
1153 (buffer-substring pt end)
1154 :for-LaTeX t
1155 :emph-multiline t
1156 :add-text nil
1157 :comments nil
1158 :skip-before-1st-heading nil
1159 :LaTeX-fragments nil
1160 :timestamps (plist-get opt-plist :timestamps)
1161 :footnotes (plist-get opt-plist :footnotes)))
1162 (org-unmodified
1163 (let ((inhibit-read-only t))
1164 (add-text-properties pt (max pt (1- end))
1165 '(:org-license-to-kill t))))))))
1167 (defvar org-export-latex-header-defs nil
1168 "The header definitions that might be used in the LaTeX body.")
1169 (defvar org-export-latex-header-defs-re nil
1170 "The header definitions that might be used in the LaTeX body.")
1172 (defun org-export-latex-content (content &optional exclude-list)
1173 "Convert CONTENT string to LaTeX.
1174 Don't perform conversions that are in EXCLUDE-LIST. Recognized
1175 conversion types are: quotation-marks, emphasis, sub-superscript,
1176 links, keywords, lists, tables, fixed-width"
1177 (with-temp-buffer
1178 (insert content)
1179 (unless (memq 'timestamps exclude-list)
1180 (org-export-latex-time-stamps))
1181 (unless (memq 'quotation-marks exclude-list)
1182 (org-export-latex-quotation-marks))
1183 (unless (memq 'emphasis exclude-list)
1184 (when (plist-get org-export-latex-options-plist :emphasize)
1185 (org-export-latex-fontify)))
1186 (unless (memq 'sub-superscript exclude-list)
1187 (org-export-latex-special-chars
1188 (plist-get org-export-latex-options-plist :sub-superscript)))
1189 (unless (memq 'links exclude-list)
1190 (org-export-latex-links))
1191 (unless (memq 'keywords exclude-list)
1192 (org-export-latex-keywords))
1193 (unless (memq 'lists exclude-list)
1194 (org-export-latex-lists))
1195 (unless (memq 'tables exclude-list)
1196 (org-export-latex-tables
1197 (plist-get org-export-latex-options-plist :tables)))
1198 (unless (memq 'fixed-width exclude-list)
1199 (org-export-latex-fixed-width
1200 (plist-get org-export-latex-options-plist :fixed-width)))
1201 ;; return string
1202 (buffer-substring (point-min) (point-max))))
1204 (defun org-export-latex-protect-string (s)
1205 "Add the org-protected property to string S."
1206 (add-text-properties 0 (length s) '(org-protected t) s) s)
1208 (defun org-export-latex-protect-char-in-string (char-list string)
1209 "Add org-protected text-property to char from CHAR-LIST in STRING."
1210 (with-temp-buffer
1211 (save-match-data
1212 (insert string)
1213 (goto-char (point-min))
1214 (while (re-search-forward (regexp-opt char-list) nil t)
1215 (add-text-properties (match-beginning 0)
1216 (match-end 0) '(org-protected t)))
1217 (buffer-string))))
1219 (defun org-export-latex-keywords-maybe (&optional remove-list)
1220 "Maybe remove keywords depending on rules in REMOVE-LIST."
1221 (goto-char (point-min))
1222 (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
1223 (case-fold-search nil)
1224 (todo-markup org-export-latex-todo-keyword-markup)
1225 fmt)
1226 ;; convert TODO keywords
1227 (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
1228 (if (plist-get remove-list :todo)
1229 (replace-match "")
1230 (setq fmt (cond
1231 ((stringp todo-markup) todo-markup)
1232 ((and (consp todo-markup) (stringp (car todo-markup)))
1233 (if (member (match-string 1) org-export-latex-done-keywords)
1234 (cdr todo-markup) (car todo-markup)))
1235 (t (cdr (or (assoc (match-string 1) todo-markup)
1236 (car todo-markup))))))
1237 (replace-match (format fmt (match-string 1)) t t)))
1238 ;; convert priority string
1239 (when (re-search-forward "\\[\\\\#.\\]" nil t)
1240 (if (plist-get remove-list :priority)
1241 (replace-match "")
1242 (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
1243 ;; convert tags
1244 (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t)
1245 (if (or (not org-export-with-tags)
1246 (plist-get remove-list :tags))
1247 (replace-match "")
1248 (replace-match
1249 (org-export-latex-protect-string
1250 (format "\\textbf{%s}"
1251 (save-match-data
1252 (replace-regexp-in-string
1253 "_" "\\\\_" (match-string 0)))))
1254 t t)))))
1256 (defun org-export-latex-fontify-headline (string)
1257 "Fontify special words in STRING."
1258 (with-temp-buffer
1259 ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
1260 ;; the beginning of the buffer - inserting "\n" is safe here though.
1261 (insert "\n" string)
1262 (goto-char (point-min))
1263 (let ((re (concat "\\\\[a-zA-Z]+\\(?:"
1264 "\\[.*\\]"
1265 "\\)?"
1266 (org-create-multibrace-regexp "{" "}" 3))))
1267 (while (re-search-forward re nil t)
1268 (unless (save-excursion (goto-char (match-beginning 0))
1269 (equal (char-after (point-at-bol)) ?#))
1270 (add-text-properties (match-beginning 0) (match-end 0)
1271 '(org-protected t)))))
1272 (when (plist-get org-export-latex-options-plist :emphasize)
1273 (org-export-latex-fontify))
1274 (org-export-latex-keywords-maybe)
1275 (org-export-latex-special-chars
1276 (plist-get org-export-latex-options-plist :sub-superscript))
1277 (org-export-latex-links)
1278 (org-trim (buffer-string))))
1280 (defun org-export-latex-time-stamps ()
1281 "Format time stamps."
1282 (goto-char (point-min))
1283 (let ((org-display-custom-times org-export-latex-display-custom-times))
1284 (while (re-search-forward org-ts-regexp-both nil t)
1285 (org-if-unprotected-at (1- (point))
1286 (replace-match
1287 (org-export-latex-protect-string
1288 (format org-export-latex-timestamp-markup
1289 (substring (org-translate-time (match-string 0)) 1 -1)))
1290 t t)))))
1292 (defun org-export-latex-quotation-marks ()
1293 "Export quotation marks depending on language conventions."
1294 (let* ((lang (plist-get org-export-latex-options-plist :language))
1295 (quote-rpl (if (equal lang "fr")
1296 '(("\\(\\s-\\)\"" "«~")
1297 ("\\(\\S-\\)\"" "~»")
1298 ("\\(\\s-\\)'" "`"))
1299 '(("\\(\\s-\\|[[(]\\)\"" "``")
1300 ("\\(\\S-\\)\"" "''")
1301 ("\\(\\s-\\|(\\)'" "`")))))
1302 (mapc (lambda(l) (goto-char (point-min))
1303 (while (re-search-forward (car l) nil t)
1304 (let ((rpl (concat (match-string 1)
1305 (org-export-latex-protect-string
1306 (copy-sequence (cadr l))))))
1307 (org-if-unprotected-1
1308 (replace-match rpl t t))))) quote-rpl)))
1310 (defun org-export-latex-special-chars (sub-superscript)
1311 "Export special characters to LaTeX.
1312 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
1313 See the `org-export-latex.el' code for a complete conversion table."
1314 (goto-char (point-min))
1315 (mapc (lambda(c)
1316 (goto-char (point-min))
1317 (while (re-search-forward c nil t)
1318 ;; Put the point where to check for org-protected
1319 (unless (get-text-property (match-beginning 2) 'org-protected)
1320 (cond ((member (match-string 2) '("\\$" "$"))
1321 (if (equal (match-string 2) "\\$")
1323 (replace-match "\\$" t t)))
1324 ((member (match-string 2) '("&" "%" "#"))
1325 (if (equal (match-string 1) "\\")
1326 (replace-match (match-string 2) t t)
1327 (replace-match (concat (match-string 1) "\\"
1328 (match-string 2)) t t)))
1329 ((equal (match-string 2) "...")
1330 (replace-match
1331 (concat (match-string 1)
1332 (org-export-latex-protect-string "\\ldots{}")) t t))
1333 ((equal (match-string 2) "~")
1334 (cond ((equal (match-string 1) "\\") nil)
1335 ((eq 'org-link (get-text-property 0 'face (match-string 2)))
1336 (replace-match (concat (match-string 1) "\\~") t t))
1337 (t (replace-match
1338 (org-export-latex-protect-string
1339 (concat (match-string 1) "\\~{}")) t t))))
1340 ((member (match-string 2) '("{" "}"))
1341 (unless (save-match-data (org-inside-latex-math-p))
1342 (if (equal (match-string 1) "\\")
1343 (replace-match (match-string 2) t t)
1344 (replace-match (concat (match-string 1) "\\"
1345 (match-string 2)) t t)))))
1346 (unless (save-match-data (org-inside-latex-math-p))
1347 (cond ((equal (match-string 2) "\\")
1348 (replace-match (or (save-match-data
1349 (org-export-latex-treat-backslash-char
1350 (match-string 1)
1351 (or (match-string 3) "")))
1352 "") t t))
1353 ((member (match-string 2) '("_" "^"))
1354 (replace-match (or (save-match-data
1355 (org-export-latex-treat-sub-super-char
1356 sub-superscript
1357 (match-string 2)
1358 (match-string 1)
1359 (match-string 3))) "") t t)
1360 (backward-char 1)))))))
1361 '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
1362 "\\(\\(\\\\?\\$\\)\\)"
1363 "\\([a-za-z0-9]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-za-z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-za-z0-9]+}\\|([a-za-z0-9]+)\\)"
1364 "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|[a-zA-Z&#%{}\"]+\\)"
1365 "\\(.\\|^\\)\\(&\\)"
1366 "\\(.\\|^\\)\\(#\\)"
1367 "\\(.\\|^\\)\\(%\\)"
1368 "\\(.\\|^\\)\\({\\)"
1369 "\\(.\\|^\\)\\(}\\)"
1370 "\\(.\\|^\\)\\(~\\)"
1371 "\\(.\\|^\\)\\(\\.\\.\\.\\)"
1372 ;; (?\< . "\\textless{}")
1373 ;; (?\> . "\\textgreater{}")
1376 (defun org-inside-latex-math-p ()
1377 (get-text-property (point) 'org-latex-math))
1379 (defun org-export-latex-treat-sub-super-char
1380 (subsup char string-before string-after)
1381 "Convert the \"_\" and \"^\" characters to LaTeX.
1382 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
1383 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
1384 (cond ((equal string-before "\\")
1385 (concat string-before char string-after))
1386 ((and (string-match "\\S-+" string-after))
1387 ;; this is part of a math formula
1388 (cond ((eq 'org-link (get-text-property 0 'face char))
1389 (concat string-before "\\" char string-after))
1390 ((save-match-data (org-inside-latex-math-p))
1391 (if subsup
1392 (cond ((eq 1 (length string-after))
1393 (concat string-before char string-after))
1394 ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
1395 (format "%s%s{%s}" string-before char
1396 (match-string 1 string-after))))))
1397 ((and (> (length string-after) 1)
1398 (or (eq subsup t)
1399 (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
1400 (string-match "[({]?\\([^)}]+\\)[)}]?" string-after))
1401 (org-export-latex-protect-string
1402 (format "%s$%s{%s}$" string-before char
1403 (if (and (> (match-end 1) (1+ (match-beginning 1)))
1404 (not (equal (substring string-after 0 2) "{\\")))
1405 (concat "\\mathrm{" (match-string 1 string-after) "}")
1406 (match-string 1 string-after)))))
1407 ((eq subsup t) (concat string-before "$" char string-after "$"))
1408 (t (org-export-latex-protect-string
1409 (concat string-before "\\" char "{}" string-after)))))
1410 (t (org-export-latex-protect-string
1411 (concat string-before "\\" char "{}" string-after)))))
1413 (defun org-export-latex-treat-backslash-char (string-before string-after)
1414 "Convert the \"$\" special character to LaTeX.
1415 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
1416 (cond ((member (list string-after) org-html-entities)
1417 ;; backslash is part of a special entity (like "\alpha")
1418 (concat string-before "$\\"
1419 (or (cdar (member (list string-after) org-html-entities))
1420 string-after) "$"))
1421 ((and (not (string-match "^[ \n\t]" string-after))
1422 (not (string-match "[ \t]\\'\\|^" string-before)))
1423 ;; backslash is inside a word
1424 (org-export-latex-protect-string
1425 (concat string-before "\\textbackslash{}" string-after)))
1426 ((not (or (equal string-after "")
1427 (string-match "^[ \t\n]" string-after)))
1428 ;; backslash might escape a character (like \#) or a user TeX
1429 ;; macro (like \setcounter)
1430 (org-export-latex-protect-string
1431 (concat string-before "\\" string-after)))
1432 ((and (string-match "^[ \t\n]" string-after)
1433 (string-match "[ \t\n]\\'" string-before))
1434 ;; backslash is alone, convert it to $\backslash$
1435 (org-export-latex-protect-string
1436 (concat string-before "\\textbackslash{}" string-after)))
1437 (t (org-export-latex-protect-string
1438 (concat string-before "\\textbackslash{}" string-after)))))
1440 (defun org-export-latex-keywords ()
1441 "Convert special keywords to LaTeX."
1442 (goto-char (point-min))
1443 (while (re-search-forward org-export-latex-special-keyword-regexp nil t)
1444 (replace-match (format org-export-latex-timestamp-keyword-markup
1445 (match-string 0)) t t)
1446 (save-excursion
1447 (beginning-of-line 1)
1448 (unless (looking-at ".*\\\\newline[ \t]*$")
1449 (end-of-line 1)
1450 (insert "\\newline")))))
1452 (defun org-export-latex-fixed-width (opt)
1453 "When OPT is non-nil convert fixed-width sections to LaTeX."
1454 (goto-char (point-min))
1455 (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
1456 (if opt
1457 (progn (goto-char (match-beginning 0))
1458 (insert "\\begin{verbatim}\n")
1459 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1460 (replace-match (concat (match-string 1)
1461 (match-string 2)) t t)
1462 (forward-line))
1463 (insert "\\end{verbatim}\n\n"))
1464 (progn (goto-char (match-beginning 0))
1465 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1466 (replace-match (concat "%" (match-string 1)
1467 (match-string 2)) t t)
1468 (forward-line))))))
1471 (defvar org-table-last-alignment) ; defined in org-table.el
1472 (defvar org-table-last-column-widths) ; defined in org-table.el
1473 (declare-function orgtbl-to-latex "org-table" (table params) t)
1474 (defun org-export-latex-tables (insert)
1475 "Convert tables to LaTeX and INSERT it."
1476 (goto-char (point-min))
1477 (while (re-search-forward "^\\([ \t]*\\)|" nil t)
1478 (org-if-unprotected-at (1- (point))
1479 (org-table-align)
1480 (let* ((beg (org-table-begin))
1481 (end (org-table-end))
1482 (raw-table (buffer-substring beg end))
1483 (org-table-last-alignment (copy-sequence org-table-last-alignment))
1484 (org-table-last-column-widths (copy-sequence
1485 org-table-last-column-widths))
1486 fnum fields line lines olines gr colgropen line-fmt align
1487 caption label attr floatp longtblp)
1488 (if org-export-latex-tables-verbatim
1489 (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1490 "\\end{verbatim}\n")))
1491 (apply 'delete-region (list beg end))
1492 (insert (org-export-latex-protect-string tbl)))
1493 (progn
1494 (setq caption (org-find-text-property-in-string
1495 'org-caption raw-table)
1496 attr (org-find-text-property-in-string
1497 'org-attributes raw-table)
1498 label (org-find-text-property-in-string
1499 'org-label raw-table)
1500 longtblp (and attr (stringp attr)
1501 (string-match "\\<longtable\\>" attr))
1502 align (and attr (stringp attr)
1503 (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
1504 (match-string 1 attr))
1505 floatp (or caption label))
1506 (setq lines (org-split-string raw-table "\n"))
1507 (apply 'delete-region (list beg end))
1508 (when org-export-table-remove-special-lines
1509 (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
1510 (when org-table-clean-did-remove-column
1511 (pop org-table-last-alignment)
1512 (pop org-table-last-column-widths))
1513 ;; make a formatting string to reflect alignment
1514 (setq olines lines)
1515 (while (and (not line-fmt) (setq line (pop olines)))
1516 (unless (string-match "^[ \t]*|-" line)
1517 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1518 (setq fnum (make-vector (length fields) 0))
1519 (setq line-fmt
1520 (mapconcat
1521 (lambda (x)
1522 (setq gr (pop org-table-colgroup-info))
1523 (format "%s%%s%s"
1524 (cond ((eq gr :start)
1525 (prog1 (if colgropen "|" "|")
1526 (setq colgropen t)))
1527 ((eq gr :startend)
1528 (prog1 (if colgropen "|" "|")
1529 (setq colgropen nil)))
1530 (t ""))
1531 (if (memq gr '(:end :startend))
1532 (progn (setq colgropen nil) "|")
1533 "")))
1534 fnum ""))))
1535 ;; fix double || in line-fmt
1536 (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
1537 ;; maybe remove the first and last "|"
1538 (when (and (not org-export-latex-tables-column-borders)
1539 (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
1540 (setq line-fmt (match-string 2 line-fmt)))
1541 ;; format alignment
1542 (unless align
1543 (setq align (apply 'format
1544 (cons line-fmt
1545 (mapcar (lambda (x) (if x "r" "l"))
1546 org-table-last-alignment)))))
1547 ;; prepare the table to send to orgtbl-to-latex
1548 (setq lines
1549 (mapcar
1550 (lambda(elem)
1551 (or (and (string-match "[ \t]*|-+" elem) 'hline)
1552 (org-split-string (org-trim elem) "|")))
1553 lines))
1554 (when insert
1555 (insert (org-export-latex-protect-string
1556 (concat
1557 (if longtblp
1558 (concat "\\begin{longtable}{" align "}\n")
1559 (if floatp "\\begin{table}[htb]\n"))
1560 (if floatp
1561 (format
1562 "\\caption{%s%s}"
1563 (if label (concat "\\\label{" label "}") "")
1564 (or caption "")))
1565 (if (and longtblp caption) "\\\\\n" "\n")
1566 (if (and org-export-latex-tables-centered (not longtblp))
1567 "\\begin{center}\n")
1568 (if (not longtblp) (concat "\\begin{tabular}{" align "}\n"))
1569 (orgtbl-to-latex
1570 lines
1571 `(:tstart nil :tend nil
1572 :hlend ,(if longtblp
1573 (format "\\\\
1574 \\hline
1575 \\endhead
1576 \\hline\\multicolumn{%d}{r}{Continued on next page}\\
1577 \\endfoot
1578 \\endlastfoot" (length org-table-last-alignment))
1579 nil)))
1580 (if (not longtblp) (concat "\n\\end{tabular}"))
1581 (if longtblp "\n" (if org-export-latex-tables-centered
1582 "\n\\end{center}\n" "\n"))
1583 (if longtblp
1584 "\\end{longtable}"
1585 (if floatp "\\end{table}"))))
1586 "\n\n"))))))))
1588 (defun org-export-latex-fontify ()
1589 "Convert fontification to LaTeX."
1590 (goto-char (point-min))
1591 (while (re-search-forward org-emph-re nil t)
1592 ;; The match goes one char after the *string*, except at the end of a line
1593 (let ((emph (assoc (match-string 3)
1594 org-export-latex-emphasis-alist))
1595 (beg (match-beginning 0))
1596 (end (match-end 0))
1597 rpl s)
1598 (unless emph
1599 (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
1600 (match-string 3)))
1601 (unless (or (and (get-text-property (- (point) 2) 'org-protected)
1602 (not (get-text-property
1603 (- (point) 2) 'org-verbatim-emph)))
1604 (save-excursion
1605 (goto-char (match-beginning 1))
1606 (save-match-data
1607 (and (org-at-table-p)
1608 (string-match
1609 "[|\n]" (buffer-substring beg end))))))
1610 (setq s (match-string 4))
1611 (setq rpl (concat (match-string 1)
1612 (org-export-latex-emph-format (cadr emph)
1613 (match-string 4))
1614 (match-string 5)))
1615 (if (caddr emph)
1616 (setq rpl (org-export-latex-protect-string rpl))
1617 (save-match-data
1618 (if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl)
1619 (progn
1620 (add-text-properties (match-beginning 1) (match-end 1)
1621 '(org-protected t) rpl)
1622 (add-text-properties (match-beginning 3) (match-end 3)
1623 '(org-protected t) rpl)))))
1624 (replace-match rpl t t)))
1625 (backward-char)))
1627 (defvar org-export-latex-use-verb nil)
1628 (defun org-export-latex-emph-format (format string)
1629 "Format an emphasis string and handle the \\verb special case."
1630 (when (equal format "\\verb")
1631 (save-match-data
1632 (if org-export-latex-use-verb
1633 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1634 (catch 'exit
1635 (loop for i from 0 to (1- (length ll)) do
1636 (if (not (string-match (regexp-quote (substring ll i (1+ i)))
1637 string))
1638 (progn
1639 (setq format (concat "\\verb" (substring ll i (1+ i))
1640 "%s" (substring ll i (1+ i))))
1641 (throw 'exit nil))))))
1642 (let ((start 0)
1643 (trans '(("\\" . "\\textbackslash{}")
1644 ("~" . "\\textasciitilde{}")
1645 ("^" . "\\textasciicircum{}")))
1646 (rtn "") char)
1647 (while (string-match "[\\{}$%&_#~^]" string)
1648 (setq char (match-string 0 string))
1649 (if (> (match-beginning 0) 0)
1650 (setq rtn (concat rtn (substring string
1651 0 (match-beginning 0)))))
1652 (setq string (substring string (1+ (match-beginning 0))))
1653 (setq char (or (cdr (assoc char trans)) (concat "\\" char))
1654 rtn (concat rtn char)))
1655 (setq string (concat rtn string) format "\\texttt{%s}")))))
1656 (format format string))
1658 (defun org-export-latex-links ()
1659 ;; Make sure to use the LaTeX hyperref and graphicx package
1660 ;; or send some warnings.
1661 "Convert links to LaTeX."
1662 (goto-char (point-min))
1663 (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
1664 (org-if-unprotected-1
1665 (goto-char (match-beginning 0))
1666 (let* ((re-radio org-export-latex-all-targets-re)
1667 (remove (list (match-beginning 0) (match-end 0)))
1668 (raw-path (org-extract-attributes (match-string 3)))
1669 (full-raw-path (concat (match-string 1) raw-path))
1670 (desc (match-string 5))
1671 (type (or (match-string 2)
1672 (if (or (file-name-absolute-p raw-path)
1673 (string-match "^\\.\\.?/" raw-path))
1674 "file")))
1675 (coderefp (equal type "coderef"))
1676 (caption (org-find-text-property-in-string 'org-caption raw-path))
1677 (attr (or (org-find-text-property-in-string 'org-attributes raw-path)
1678 (plist-get org-export-latex-options-plist :latex-image-options)))
1679 (label (org-find-text-property-in-string 'org-label raw-path))
1680 imgp radiop
1681 ;; define the path of the link
1682 (path (cond
1683 ((member type '("coderef"))
1684 raw-path)
1685 ((member type '("http" "https" "ftp"))
1686 (concat type ":" raw-path))
1687 ((and re-radio (string-match re-radio raw-path))
1688 (setq radiop t))
1689 ((equal type "mailto")
1690 (concat type ":" raw-path))
1691 ((equal type "file")
1692 (if (and (org-file-image-p
1693 (expand-file-name
1694 raw-path)
1695 org-export-latex-inline-image-extensions)
1696 (or (get-text-property 0 'org-no-description
1697 raw-path)
1698 (equal desc full-raw-path)))
1699 (setq imgp t)
1700 (progn (when (string-match "\\(.+\\)::.+" raw-path)
1701 (setq raw-path (match-string 1 raw-path)))
1702 (if (file-exists-p raw-path)
1703 (concat type "://" (expand-file-name raw-path))
1704 (concat type "://" (org-export-directory
1705 :LaTeX org-export-latex-options-plist)
1706 raw-path))))))))
1707 ;; process with link inserting
1708 (apply 'delete-region remove)
1709 (cond ((and imgp
1710 (plist-get org-export-latex-options-plist :inline-images))
1711 ;; OK, we need to inline an image
1712 (insert
1713 (org-export-latex-format-image raw-path caption label attr)))
1714 (coderefp
1715 (insert (format
1716 (org-export-get-coderef-format path desc)
1717 (cdr (assoc path org-export-code-refs)))))
1718 (radiop (insert (format "\\hyperref[%s]{%s}"
1719 (org-solidify-link-text raw-path) desc)))
1720 ((not type)
1721 (insert (format "\\hyperref[%s]{%s}"
1722 (org-remove-initial-hash
1723 (org-solidify-link-text raw-path))
1724 desc)))
1725 (path
1726 (when (org-at-table-p)
1727 ;; There is a strange problem when we have a link in a table,
1728 ;; ampersands then cause a problem. I think this must be
1729 ;; a LaTeX issue, but we here implement a work-around anyway.
1730 (setq path (org-export-latex-protect-amp path)
1731 desc (org-export-latex-protect-amp desc)))
1732 (insert (format "\\href{%s}{%s}" path desc)))
1733 (t (insert "\\texttt{" desc "}")))))))
1736 (defun org-export-latex-format-image (path caption label attr)
1737 "Format the image element, depending on user settings."
1738 (let (ind floatp wrapp placement figenv)
1739 (setq floatp (or caption label))
1740 (setq ind (org-get-text-property-any 0 'original-indentation path))
1741 (when (and attr (stringp attr))
1742 (if (string-match "[ \t]*\\<wrap\\>" attr)
1743 (setq wrapp t floatp nil attr (replace-match "" t t attr)))
1744 (if (string-match "[ \t]*\\<float\\>" attr)
1745 (setq wrapp nil floatp t attr (replace-match "" t t attr))))
1747 (setq placement
1748 (cond
1749 (wrapp "{l}{0.5\\textwidth}")
1750 (floatp "[htb]")
1751 (t "")))
1753 (when (and attr (stringp attr)
1754 (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
1755 (setq placement (match-string 1 attr)
1756 attr (replace-match "" t t attr)))
1757 (setq attr (and attr (org-trim attr)))
1758 (when (or (not attr) (= (length attr) 0))
1759 (setq attr (cond (floatp "width=0.7\\textwidth")
1760 (wrapp "width=0.48\\textwidth")
1761 (t attr))))
1762 (setq figenv
1763 (cond
1764 (wrapp "\\begin{wrapfigure}%placement
1765 \\centering
1766 \\includegraphics[%attr]{%path}
1767 \\caption{%labelcmd%caption}
1768 \\end{wrapfigure}")
1769 (floatp "\\begin{figure}%placement
1770 \\centering
1771 \\includegraphics[%attr]{%path}
1772 \\caption{%labelcmd%caption}
1773 \\end{figure}")
1774 (t "\\includegraphics[%attr]{%path}")))
1777 (setq figenv (mapconcat 'identity (split-string figenv "\n")
1778 (save-excursion (beginning-of-line 1)
1779 (looking-at "[ \t]*")
1780 (concat "\n" (match-string 0)))))
1782 (if (and (not label) (not caption)
1783 (string-match "^\\\\caption{.*\n" figenv))
1784 (setq figenv (replace-match "" t t figenv)))
1785 (org-add-props
1786 (org-fill-template
1787 figenv
1788 (list (cons "path"
1789 (if (file-name-absolute-p path)
1790 (expand-file-name path)
1791 path))
1792 (cons "attr" attr)
1793 (cons "labelcmd" (if label (format "\\label{%s}"
1794 label)""))
1795 (cons "caption" (or caption ""))
1796 (cons "placement" (or placement ""))))
1797 nil 'original-indentation ind)))
1799 (defun org-export-latex-protect-amp (s)
1800 (while (string-match "\\([^\\\\]\\)\\(&\\)" s)
1801 (setq s (replace-match (concat (match-string 1 s) "\\" (match-string 2 s))
1802 t t s)))
1805 (defun org-remove-initial-hash (s)
1806 (if (string-match "\\`#" s)
1807 (substring s 1)
1809 (defvar org-latex-entities) ; defined below
1810 (defvar org-latex-entities-regexp) ; defined below
1811 (defvar org-latex-entities-exceptions) ; defined below
1813 (defun org-export-latex-preprocess (parameters)
1814 "Clean stuff in the LaTeX export."
1815 ;; Preserve line breaks
1816 (goto-char (point-min))
1817 (while (re-search-forward "\\\\\\\\" nil t)
1818 (add-text-properties (match-beginning 0) (match-end 0)
1819 '(org-protected t)))
1821 ;; Preserve latex environments
1822 (goto-char (point-min))
1823 (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
1824 (let* ((start (progn (beginning-of-line) (point)))
1825 (end (and (re-search-forward
1826 (concat "^[ \t]*\\\\end{"
1827 (regexp-quote (match-string 1))
1828 "}") nil t)
1829 (point-at-eol))))
1830 (if end
1831 (add-text-properties start end '(org-protected t))
1832 (goto-char (point-at-eol)))))
1834 ;; Preserve math snippets
1836 (let* ((matchers (plist-get org-format-latex-options :matchers))
1837 (re-list org-latex-regexps)
1838 beg end re e m n block off)
1839 ;; Check the different regular expressions
1840 (while (setq e (pop re-list))
1841 (setq m (car e) re (nth 1 e) n (nth 2 e)
1842 block (if (nth 3 e) "\n\n" ""))
1843 (setq off (if (member m '("$" "$1")) 1 0))
1844 (when (and (member m matchers) (not (equal m "begin")))
1845 (goto-char (point-min))
1846 (while (re-search-forward re nil t)
1847 (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
1848 (add-text-properties beg end '(org-protected t org-latex-math t))))))
1850 ;; Convert LaTeX to \LaTeX{}
1851 (goto-char (point-min))
1852 (let ((case-fold-search nil))
1853 (while (re-search-forward "\\([^+_]\\)LaTeX" nil t)
1854 (org-if-unprotected
1855 (replace-match (org-export-latex-protect-string
1856 (concat (match-string 1) "\\LaTeX{}")) t t))))
1858 ;; Convert blockquotes
1859 (goto-char (point-min))
1860 (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
1861 (org-replace-match-keep-properties "\\begin{quote}" t t))
1862 (goto-char (point-min))
1863 (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
1864 (org-replace-match-keep-properties "\\end{quote}" t t))
1866 ;; Convert verse
1867 (goto-char (point-min))
1868 (while (search-forward "ORG-VERSE-START" nil t)
1869 (org-replace-match-keep-properties "\\begin{verse}" t t)
1870 (beginning-of-line 2)
1871 (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
1872 (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
1873 (goto-char (match-end 1))
1874 (org-replace-match-keep-properties
1875 (org-export-latex-protect-string
1876 (concat "\\hspace*{1cm}" (match-string 2))) t t)
1877 (beginning-of-line 1))
1878 (if (looking-at "[ \t]*$")
1879 (insert (org-export-latex-protect-string "\\vspace*{1em}"))
1880 (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
1881 (end-of-line 1)
1882 (insert "\\\\")))
1883 (beginning-of-line 2))
1884 (and (looking-at "[ \t]*ORG-VERSE-END.*")
1885 (org-replace-match-keep-properties "\\end{verse}" t t)))
1887 ;; Convert center
1888 (goto-char (point-min))
1889 (while (search-forward "ORG-CENTER-START" nil t)
1890 (org-replace-match-keep-properties "\\begin{center}" t t))
1891 (goto-char (point-min))
1892 (while (search-forward "ORG-CENTER-END" nil t)
1893 (org-replace-match-keep-properties "\\end{center}" t t))
1895 (run-hooks 'org-export-latex-after-blockquotes-hook)
1897 ;; Convert horizontal rules
1898 (goto-char (point-min))
1899 (while (re-search-forward "^----+.$" nil t)
1900 (org-if-unprotected
1901 (replace-match (org-export-latex-protect-string "\\hrule") t t)))
1903 ;; Protect LaTeX commands like \command[...]{...} or \command{...}
1904 (goto-char (point-min))
1905 (let ((re (concat
1906 "\\\\[a-zA-Z]+"
1907 "\\(?:\\[[^][\n]*?\\]\\)*"
1908 "\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
1909 (while (re-search-forward re nil t)
1910 (unless (save-excursion (goto-char (match-beginning 0))
1911 (equal (char-after (point-at-bol)) ?#))
1912 (add-text-properties (match-beginning 0) (match-end 0)
1913 '(org-protected t)))))
1915 ;; Protect LaTeX entities
1916 (goto-char (point-min))
1917 (let (a)
1918 (while (re-search-forward org-latex-entities-regexp nil t)
1919 (if (setq a (assoc (match-string 0) org-latex-entities-exceptions))
1920 (replace-match (org-add-props (nth 1 a) nil 'org-protected t)
1921 t t)
1922 (add-text-properties (match-beginning 0) (match-end 0)
1923 '(org-protected t)))))
1925 ;; Replace radio links
1926 (goto-char (point-min))
1927 (while (re-search-forward
1928 (concat "<<<?" org-export-latex-all-targets-re
1929 ">>>?\\((INVISIBLE)\\)?") nil t)
1930 (org-if-unprotected-at (+ (match-beginning 0) 2)
1931 (replace-match
1932 (concat
1933 (org-export-latex-protect-string
1934 (format "\\label{%s}" (save-match-data (org-solidify-link-text
1935 (match-string 1)))))
1936 (if (match-string 2) "" (match-string 1)))
1937 t t)))
1939 ;; Delete @<...> constructs
1940 ;; Thanks to Daniel Clemente for this regexp
1941 (goto-char (point-min))
1942 (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
1943 (org-if-unprotected
1944 (replace-match "")))
1946 ;; When converting to LaTeX, replace footnotes
1947 ;; FIXME: don't protect footnotes from conversion
1948 (when (plist-get org-export-latex-options-plist :footnotes)
1949 (goto-char (point-min))
1950 (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t)
1951 (org-if-unprotected
1952 (when (and (save-match-data
1953 (save-excursion (beginning-of-line)
1954 (looking-at "[^:|#]")))
1955 (not (org-in-verbatim-emphasis)))
1956 (let ((foot-beg (match-beginning 0))
1957 (foot-end (match-end 0))
1958 (foot-prefix (match-string 0))
1959 footnote footnote-rpl)
1960 (save-excursion
1961 (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix))
1962 nil t))
1963 (replace-match (org-export-latex-protect-string
1964 (concat "$^{" (match-string 1) "}$")))
1965 (replace-match "")
1966 (let ((end (save-excursion
1967 (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t)
1968 (match-beginning 0) (point-max)))))
1969 (setq footnote (concat (org-trim (buffer-substring (point) end))
1970 " ")) ; prevent last } being part of a link
1971 (delete-region (point) end))
1972 (goto-char foot-beg)
1973 (delete-region foot-beg foot-end)
1974 (unless (null footnote)
1975 (setq footnote-rpl (format "\\footnote{%s}" footnote))
1976 (add-text-properties 0 10 '(org-protected t) footnote-rpl)
1977 (add-text-properties (1- (length footnote-rpl))
1978 (length footnote-rpl)
1979 '(org-protected t) footnote-rpl)
1980 (insert footnote-rpl)))
1981 )))))
1983 ;; Remove footnote section tag for LaTeX
1984 (goto-char (point-min))
1985 (while (re-search-forward
1986 (concat "^" footnote-section-tag-regexp) nil t)
1987 (org-if-unprotected
1988 (replace-match "")))))
1990 ;;; List handling:
1992 (defun org-export-latex-lists ()
1993 "Convert plain text lists in current buffer into LaTeX lists."
1994 (goto-char (point-min))
1995 (while (re-search-forward org-list-beginning-re nil t)
1996 (org-if-unprotected
1997 (beginning-of-line)
1998 (insert (org-list-to-latex (org-list-parse-list t)
1999 org-export-latex-list-parameters))
2000 "\n")))
2002 (defconst org-latex-entities
2003 '("\\!"
2004 "\\'"
2005 "\\+"
2006 "\\,"
2007 "\\-"
2008 "\\:"
2009 "\\;"
2010 "\\<"
2011 "\\="
2012 "\\>"
2013 "\\Huge"
2014 "\\LARGE"
2015 "\\Large"
2016 "\\Styles"
2017 "\\\\"
2018 "\\`"
2019 "\\addcontentsline"
2020 "\\address"
2021 "\\addtocontents"
2022 "\\addtocounter"
2023 "\\addtolength"
2024 "\\addvspace"
2025 "\\alph"
2026 "\\appendix"
2027 "\\arabic"
2028 "\\author"
2029 "\\begin{array}"
2030 "\\begin{center}"
2031 "\\begin{description}"
2032 "\\begin{enumerate}"
2033 "\\begin{eqnarray}"
2034 "\\begin{equation}"
2035 "\\begin{figure}"
2036 "\\begin{flushleft}"
2037 "\\begin{flushright}"
2038 "\\begin{itemize}"
2039 "\\begin{list}"
2040 "\\begin{minipage}"
2041 "\\begin{picture}"
2042 "\\begin{quotation}"
2043 "\\begin{quote}"
2044 "\\begin{tabbing}"
2045 "\\begin{table}"
2046 "\\begin{tabular}"
2047 "\\begin{thebibliography}"
2048 "\\begin{theorem}"
2049 "\\begin{titlepage}"
2050 "\\begin{verbatim}"
2051 "\\begin{verse}"
2052 "\\bf"
2053 "\\bf"
2054 "\\bibitem"
2055 "\\bigskip"
2056 "\\cdots"
2057 "\\centering"
2058 "\\circle"
2059 "\\cite"
2060 "\\cleardoublepage"
2061 "\\clearpage"
2062 "\\cline"
2063 "\\closing"
2064 "\\dashbox"
2065 "\\date"
2066 "\\ddots"
2067 "\\dotfill"
2068 "\\em"
2069 "\\fbox"
2070 "\\flushbottom"
2071 "\\fnsymbol"
2072 "\\footnote"
2073 "\\footnotemark"
2074 "\\footnotesize"
2075 "\\footnotetext"
2076 "\\frac"
2077 "\\frame"
2078 "\\framebox"
2079 "\\hfill"
2080 "\\hline"
2081 "\\hrulespace"
2082 "\\hspace"
2083 "\\huge"
2084 "\\hyphenation"
2085 "\\include"
2086 "\\includeonly"
2087 "\\indent"
2088 "\\input"
2089 "\\it"
2090 "\\kill"
2091 "\\label"
2092 "\\large"
2093 "\\ldots"
2094 "\\line"
2095 "\\linebreak"
2096 "\\linethickness"
2097 "\\listoffigures"
2098 "\\listoftables"
2099 "\\location"
2100 "\\makebox"
2101 "\\maketitle"
2102 "\\mark"
2103 "\\mbox"
2104 "\\medskip"
2105 "\\multicolumn"
2106 "\\multiput"
2107 ("\\nbsp" "~")
2108 "\\newcommand"
2109 "\\newcounter"
2110 "\\newenvironment"
2111 "\\newfont"
2112 "\\newlength"
2113 "\\newline"
2114 "\\newpage"
2115 "\\newsavebox"
2116 "\\newtheorem"
2117 "\\nocite"
2118 "\\nofiles"
2119 "\\noindent"
2120 "\\nolinebreak"
2121 "\\nopagebreak"
2122 "\\normalsize"
2123 "\\onecolumn"
2124 "\\opening"
2125 "\\oval"
2126 "\\overbrace"
2127 "\\overline"
2128 "\\pagebreak"
2129 "\\pagenumbering"
2130 "\\pageref"
2131 "\\pagestyle"
2132 "\\par"
2133 "\\parbox"
2134 "\\put"
2135 "\\raggedbottom"
2136 "\\raggedleft"
2137 "\\raggedright"
2138 "\\raisebox"
2139 "\\ref"
2140 "\\rm"
2141 "\\roman"
2142 "\\rule"
2143 "\\savebox"
2144 "\\sc"
2145 "\\scriptsize"
2146 "\\setcounter"
2147 "\\setlength"
2148 "\\settowidth"
2149 "\\sf"
2150 "\\shortstack"
2151 "\\signature"
2152 "\\sl"
2153 "\\small"
2154 "\\smallskip"
2155 "\\sqrt"
2156 "\\tableofcontents"
2157 "\\telephone"
2158 "\\thanks"
2159 "\\thispagestyle"
2160 "\\tiny"
2161 "\\title"
2162 "\\tt"
2163 "\\twocolumn"
2164 "\\typein"
2165 "\\typeout"
2166 "\\underbrace"
2167 "\\underline"
2168 "\\usebox"
2169 "\\usecounter"
2170 "\\value"
2171 "\\vdots"
2172 "\\vector"
2173 "\\verb"
2174 "\\vfill"
2175 "\\vline"
2176 "\\vspace")
2177 "A list of LaTeX commands to be protected when performing conversion.")
2179 (defvar org-latex-entities-exceptions nil)
2181 (defconst org-latex-entities-regexp
2182 (let (names rest)
2183 (dolist (x org-latex-entities)
2184 (when (consp x)
2185 (add-to-list 'org-latex-entities-exceptions x)
2186 (setq x (car x)))
2187 (if (string-match "[a-zA-Z]$" x)
2188 (push x names)
2189 (push x rest)))
2190 (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
2191 "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
2193 (provide 'org-export-latex)
2194 (provide 'org-latex)
2196 ;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
2198 ;;; org-latex.el ends here