1 ;;; org-latex.el --- LaTeX exporter for org-mode
3 ;; Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 ;; Emacs Lisp Archive Entry
6 ;; Filename: org-latex.el
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/>.
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'
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
82 (defgroup org-export-latex nil
83 "Options for exporting Org-mode files to LaTeX."
84 :tag
"Org Export LaTeX"
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
94 "\\documentclass[11pt]{article}"
95 ("\\section{%s}" .
"\\section*{%s}")
96 ("\\subsection{%s}" .
"\\subsection*{%s}")
97 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")
98 ("\\paragraph{%s}" .
"\\paragraph*{%s}")
99 ("\\subparagraph{%s}" .
"\\subparagraph*{%s}"))
101 "\\documentclass[11pt]{report}"
102 ("\\part{%s}" .
"\\part*{%s}")
103 ("\\chapter{%s}" .
"\\chapter*{%s}")
104 ("\\section{%s}" .
"\\section*{%s}")
105 ("\\subsection{%s}" .
"\\subsection*{%s}")
106 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}"))
108 "\\documentclass[11pt]{book}"
109 ("\\part{%s}" .
"\\part*{%s}")
110 ("\\chapter{%s}" .
"\\chapter*{%s}")
111 ("\\section{%s}" .
"\\section*{%s}")
112 ("\\subsection{%s}" .
"\\subsection*{%s}")
113 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}"))
115 "\\documentclass{beamer}"
116 org-beamer-sectioning
118 "Alist of LaTeX classes and associated header and structure.
119 If #+LaTeX_CLASS is set in the buffer, use its value and the
120 associated information. Here is the structure of each cell:
124 (numbered-section . unnumbered-section\)
130 The HEADER-STRING is the header that will be inserted into the LaTeX file.
131 It should contain the \\documentclass macro, and anything else that is needed
132 for this setup. To this header, the following commands will be added:
134 - Calls to \\usepackage for all packages mentioned in the variables
135 `org-export-latex-default-packages-alist' and
136 `org-export-latex-packages-alist'. Thus, your header definitions should
137 avoid to also request these packages.
139 - Lines specified via \"#+LaTeX_HEADER:\"
141 If you need more control about the sequence in which the header is built
142 up, or if you want to exclude one of these building blocks for a particular
143 class, you can use the following macro-like placeholders.
145 [DEFAULT-PACKAGES] \\usepackage statements for default packages
146 [NO-DEFAULT-PACKAGES] do not include any of the default packages
147 [PACKAGES] \\usepackage statements for packages
148 [NO-PACKAGES] do not include the packages
149 [EXTRA] the stuff from #+LaTeX_HEADER
150 [NO-EXTRA] do not include #+LaTeX_HEADER stuff
151 [BEAMER-HEADER-EXTRA] the beamer extra headers
155 \\documentclass{article}
156 [NO-DEFAULT-PACKAGES]
158 \\providecommand{\\alert}[1]{\\textbf{#1}}
161 will omit the default packages, and will include the #+LaTeX_HEADER lines,
162 then have a call to \\providecommand, and then place \\usepackage commands
163 based on the content of `org-export-latex-packages-alist'.
165 If your header or `org-export-latex-default-packages-alist' inserts
166 \"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be replaced with
167 a coding system derived from `buffer-file-coding-system'. See also the
168 variable `org-export-latex-inputenc-alist' for a way to influence this
171 The sectioning structure
172 ------------------------
174 The sectioning structure of the class is given by the elements following
175 the header string. For each sectioning level, a number of strings is
176 specified. A %s formatter is mandatory in each section string and will
177 be replaced by the title of the section.
179 Instead of a cons cell (numbered . unnumbered), you can also provide a list
182 (numbered-open numbered-close)
186 (numbered-open numbered-close unnumbered-open unnumbered-close)
188 providing opening and closing strings for a LaTeX environment that should
189 represent the document section. The opening clause should have a %s
190 to represent the section title.
192 Instead of a list of sectioning commands, you can also specify a
193 function name. That function will be called with two parameters,
194 the (reduced) level of the headline, and the headline text. The function
195 must return a cons cell with the (possibly modified) headline text, and the
196 sectioning list in the cdr."
197 :group
'org-export-latex
199 (list (string :tag
"LaTeX class")
200 (string :tag
"LaTeX header")
201 (repeat :tag
"Levels" :inline t
204 (string :tag
" numbered")
205 (string :tag
"unnumbered"))
206 (list :tag
"Environment"
207 (string :tag
"Opening (numbered)")
208 (string :tag
"Closing (numbered)")
209 (string :tag
"Opening (unnumbered)")
210 (string :tag
"Closing (unnumbered)"))
211 (function :tag
"Hook computing sectioning"))))))
213 (defcustom org-export-latex-inputenc-alist nil
214 "Alist of inputenc coding system names, and what should really be used.
215 For example, adding an entry
217 (\"utf8\" . \"utf8x\")
219 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
220 are written as utf8 files."
221 :group
'org-export-latex
224 (string :tag
"Derived from buffer")
225 (string :tag
"Use this instead"))))
228 (defcustom org-export-latex-emphasis-alist
229 '(("*" "\\textbf{%s}" nil
)
230 ("/" "\\emph{%s}" nil
)
231 ("_" "\\underline{%s}" nil
)
235 "Alist of LaTeX expressions to convert emphasis fontifiers.
236 Each element of the list is a list of three elements.
237 The first element is the character used as a marker for fontification.
238 The second element is a formatting string to wrap fontified text with.
239 If it is \"\\verb\", Org will automatically select a delimiter
240 character that is not in the string.
241 The third element decides whether to protect converted text from other
243 :group
'org-export-latex
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
251 :group
'org-export-latex
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
260 (defcustom org-export-latex-date-format
262 "Format string for \\date{...}."
263 :group
'org-export-latex
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
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"
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
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
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
298 (defcustom org-export-latex-hyperref-format
"\\href{%s}{%s}"
299 "A printf format string to be applied to hyperref 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
305 (defcustom org-export-latex-tables-verbatim nil
306 "When non-nil, tables are exported verbatim."
307 :group
'org-export-latex
310 (defcustom org-export-latex-tables-centered t
311 "When non-nil, tables are exported in a center environment."
312 :group
'org-export-latex
315 (defcustom org-export-latex-tables-column-borders nil
316 "When non-nil, grouping columns can cause outer vertical lines in tables.
317 When nil, grouping causes only separation lines between groups."
318 :group
'org-export-latex
321 (defcustom org-export-latex-low-levels
'itemize
322 "How to convert sections below the current level of sectioning.
323 This is specified by the `org-export-headline-levels' option or the
324 value of \"H:\" in Org's #+OPTION line.
326 This can be either nil (skip the sections), `description', `itemize',
327 or `enumerate' (convert the sections as the corresponding list type), or
328 a string to be used instead of \\section{%s}. In this latter case,
329 the %s stands here for the inserted headline and is mandatory.
331 It may also be a list of three string to define a user-defined environment
332 that should be used. The first string should be the like
333 \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
334 to two occurrences of %s for the title and a label, respectively. The third
335 string should be like \"\\end{itemize\"."
336 :group
'org-export-latex
337 :type
'(choice (const :tag
"Ignore" nil
)
338 (const :tag
"Convert as descriptive list" description
)
339 (const :tag
"Convert as itemized list" itemize
)
340 (const :tag
"Convert as enumerated list" enumerate
)
341 (list :tag
"User-defined environment"
342 :value
("\\begin{itemize}" "\\end{itemize}" "\\item %s")
343 (string :tag
"Start")
345 (string :tag
"item"))
346 (string :tag
"Use a section string" :value
"\\subparagraph{%s}")))
348 (defcustom org-export-latex-list-parameters
349 '(:cbon
"$\\boxtimes$" :cboff
"$\\Box$")
350 "Parameters for the LaTeX list exporter.
351 These parameters will be passed on to `org-list-to-latex', which in turn
352 will pass them (combined with the LaTeX default list parameters) to
353 `org-list-to-generic'."
354 :group
'org-export-latex
357 (defcustom org-export-latex-verbatim-wrap
358 '("\\begin{verbatim}\n" .
"\\end{verbatim}\n")
359 "Environment to be wrapped around a fixed-width section in LaTeX export.
360 This is a cons with two strings, to be added before and after the
363 Defaults to \\begin{verbatim} and \\end{verbatim}."
364 :group
'org-export-translation
365 :group
'org-export-latex
366 :type
'(cons (string :tag
"Open")
367 (string :tag
"Close")))
369 (defcustom org-export-latex-listings nil
370 "Non-nil means export source code using the listings package.
371 This package will fontify source code, possibly even with color.
372 If you want to use this, you also need to make LaTeX use the
373 listings package, and if you want to have color, the color
374 package. Just add these to `org-export-latex-packages-alist',
375 for example using customize, or with something like
378 (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
379 (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))"
380 :group
'org-export-latex
383 (defcustom org-export-latex-listings-langs
384 '((emacs-lisp "Lisp") (lisp "Lisp")
387 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
388 (html "HTML") (xml "XML")
389 (tex "TeX") (latex "TeX")
390 (shell-script "bash")
392 (ocaml "Caml") (caml "Caml")
393 (sql "SQL") (sqlite "sql"))
394 "Alist mapping languages to their listing language counterpart.
395 The key is a symbol, the major mode symbol without the \"-mode\".
396 The value is the string that should be inserted as the language parameter
397 for the listings package. If the mode name and the listings name are
398 the same, the language does not need an entry in this list - but it does not
399 hurt if it is present."
400 :group
'org-export-latex
403 (symbol :tag
"Major mode ")
404 (string :tag
"Listings language"))))
406 (defcustom org-export-latex-listings-w-names t
407 "Non-nil means export names of named code blocks.
408 Code blocks exported with the listings package (controlled by the
409 `org-export-latex-listings' variable) can be named in the style
411 :group
'org-export-latex
414 (defcustom org-export-latex-remove-from-headlines
415 '(:todo nil
:priority nil
:tags nil
)
416 "A plist of keywords to remove from headlines. OBSOLETE.
417 Non-nil means remove this keyword type from the headline.
419 Don't remove the keys, just change their values.
421 Obsolete, this variable is no longer used. Use the separate
422 variables `org-export-with-todo-keywords', `org-export-with-priority',
423 and `org-export-with-tags' instead."
425 :group
'org-export-latex
)
427 (defcustom org-export-latex-image-default-option
"width=10em"
428 "Default option for images."
429 :group
'org-export-latex
432 (defcustom org-export-latex-tabular-environment
"tabular"
433 "Default environment used to build tables."
434 :group
'org-export-latex
437 (defcustom org-export-latex-inline-image-extensions
438 '("pdf" "jpeg" "jpg" "png" "ps" "eps")
439 "Extensions of image files that can be inlined into LaTeX.
440 Note that the image extension *actually* allowed depend on the way the
441 LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
442 are OK. When processing through dvi to Postscript, only ps and eps are
443 allowed. The default we use here encompasses both."
444 :group
'org-export-latex
445 :type
'(repeat (string :tag
"Extension")))
447 (defcustom org-export-latex-coding-system nil
448 "Coding system for the exported LaTeX file."
449 :group
'org-export-latex
450 :type
'coding-system
)
452 (defgroup org-export-pdf nil
453 "Options for exporting Org-mode files to PDF, via LaTeX."
454 :tag
"Org Export PDF"
455 :group
'org-export-latex
458 (defcustom org-latex-to-pdf-process
459 '("pdflatex -interaction nonstopmode -output-directory %o %f"
460 "pdflatex -interaction nonstopmode -output-directory %o %f")
461 "Commands to process a LaTeX file to a PDF file.
462 This is a list of strings, each of them will be given to the shell
463 as a command. %f in the command will be replaced by the full file name, %b
464 by the file base name (i.e. without extension) and %o by the base directory
466 The reason why this is a list is that it usually takes several runs of
467 pdflatex, maybe mixed with a call to bibtex. Org does not have a clever
468 mechanism to detect which of these commands have to be run to get to a stable
469 result, and it also does not do any error checking.
471 Alternatively, this may be a Lisp function that does the processing, so you
472 could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
473 This function should accept the file name as its single argument."
474 :group
'org-export-pdf
475 :type
'(choice (repeat :tag
"Shell command sequence"
476 (string :tag
"Shell command"))
479 (defcustom org-export-pdf-logfiles
480 '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
481 "The list of file extensions to consider as LaTeX logfiles."
482 :group
'org-export-pdf
483 :type
'(repeat (string :tag
"Extension")))
485 (defcustom org-export-pdf-remove-logfiles t
486 "Non-nil means remove the logfiles produced by PDF production.
487 These are the .aux, .log, .out, and .toc files."
488 :group
'org-export-pdf
493 (defvar org-export-latex-after-initial-vars-hook nil
494 "Hook run before LaTeX export.
495 The exact moment is after the initial variables like org-export-latex-class
496 have been determined from the environment.")
498 (defvar org-export-latex-after-blockquotes-hook nil
499 "Hook run during LaTeX export, after blockquote, verse, center are done.")
501 (defvar org-export-latex-final-hook nil
502 "Hook run in the finalized LaTeX buffer.")
504 (defvar org-export-latex-after-save-hook nil
505 "Hook run in the finalized LaTeX buffer, after it has been saved.")
507 ;;; Autoload functions:
510 (defun org-export-as-latex-batch ()
511 "Call `org-export-as-latex', may be used in batch processing.
515 --load=$HOME/lib/emacs/org.el
516 --eval \"(setq org-export-headline-levels 2)\"
517 --visit=MyFile --funcall org-export-as-latex-batch"
518 (org-export-as-latex org-export-headline-levels
'hidden
))
521 (defun org-export-as-latex-to-buffer (arg)
522 "Call `org-export-as-latex` with output to a temporary buffer.
523 No file is created. The prefix ARG is passed through to `org-export-as-latex'."
525 (org-export-as-latex arg nil nil
"*Org LaTeX Export*")
526 (when org-export-show-temporary-export-buffer
527 (switch-to-buffer-other-window "*Org LaTeX Export*")))
530 (defun org-replace-region-by-latex (beg end
)
531 "Replace the region from BEG to END with its LaTeX export.
532 It assumes the region has `org-mode' syntax, and then convert it to
533 LaTeX. This can be used in any buffer. For example, you could
534 write an itemized list in `org-mode' syntax in an LaTeX buffer and
535 then use this command to convert it."
538 (save-window-excursion
540 (setq latex
(org-export-region-as-latex
542 (setq reg
(buffer-substring beg end
)
543 buf
(get-buffer-create "*Org tmp*"))
544 (with-current-buffer buf
548 (setq latex
(org-export-region-as-latex
549 (point-min) (point-max) t
'string
)))
551 (delete-region beg end
)
555 (defun org-export-region-as-latex (beg end
&optional body-only buffer
)
556 "Convert region from BEG to END in `org-mode' buffer to LaTeX.
557 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
558 contents, and only produce the region of converted text, useful for
559 cut-and-paste operations.
560 If BUFFER is a buffer or a string, use/create that buffer as a target
561 of the converted LaTeX. If BUFFER is the symbol `string', return the
562 produced LaTeX as a string and leave no buffer behind. For example,
563 a Lisp program could call this function in the following way:
565 (setq latex (org-export-region-as-latex beg end t 'string))
567 When called interactively, the output buffer is selected, and shown
568 in a window. A non-interactive call will only return the buffer."
570 (when (interactive-p)
571 (setq buffer
"*Org LaTeX Export*"))
572 (let ((transient-mark-mode t
) (zmacs-regions t
)
574 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
576 (set-mark (point)) ;; to activate the region
578 (setq rtn
(org-export-as-latex
581 (if (fboundp 'deactivate-mark
) (deactivate-mark))
582 (if (and (interactive-p) (bufferp rtn
))
583 (switch-to-buffer-other-window rtn
)
587 (defun org-export-as-latex (arg &optional hidden ext-plist
588 to-buffer body-only pub-dir
)
589 "Export current buffer to a LaTeX file.
590 If there is an active region, export only the region. The prefix
591 ARG specifies how many levels of the outline should become
592 headlines. The default is 3. Lower levels will be exported
593 depending on `org-export-latex-low-levels'. The default is to
594 convert them as description lists.
595 HIDDEN is obsolete and does nothing.
596 EXT-PLIST is a property list with
597 external parameters overriding org-mode's default settings, but
598 still inferior to file-local settings. When TO-BUFFER is
599 non-nil, create a buffer with that name and export to that
600 buffer. If TO-BUFFER is the symbol `string', don't leave any
601 buffer behind but just return the resulting LaTeX as a string.
602 When BODY-ONLY is set, don't produce the file header and footer,
603 simply return the content of \\begin{document}...\\end{document},
604 without even the \\begin{document} and \\end{document} commands.
605 when PUB-DIR is set, use this as the publishing directory."
607 (when (and (not body-only
) arg
(listp arg
)) (setq body-only t
))
608 (run-hooks 'org-export-first-hook
)
610 ;; Make sure we have a file name when we need it.
611 (when (and (not (or to-buffer body-only
))
612 (not buffer-file-name
))
613 (if (buffer-base-buffer)
614 (org-set-local 'buffer-file-name
615 (with-current-buffer (buffer-base-buffer)
617 (error "Need a file name to be able to export")))
619 (message "Exporting to LaTeX...")
621 (let ((inhibit-read-only t
))
622 (remove-text-properties (point-min) (point-max)
623 '(:org-license-to-kill nil
))))
624 (org-update-radio-target-regexp)
625 (org-export-latex-set-initial-vars ext-plist arg
)
626 (setq org-export-opt-plist org-export-latex-options-plist
)
627 (org-install-letbind)
628 (run-hooks 'org-export-latex-after-initial-vars-hook
)
629 (let* ((wcf (current-window-configuration))
630 (opt-plist org-export-latex-options-plist
)
631 (region-p (org-region-active-p))
632 (rbeg (and region-p
(region-beginning)))
633 (rend (and region-p
(region-end)))
635 (if (plist-get opt-plist
:ignore-subtree-p
)
640 (and (org-at-heading-p)
641 (>= (org-end-of-subtree t t
) rend
))))))
642 (opt-plist (setq org-export-opt-plist
644 (org-export-add-subtree-options opt-plist rbeg
)
646 ;; Make sure the variable contains the updated values.
647 (org-export-latex-options-plist (setq org-export-opt-plist opt-plist
))
648 ;; The following two are dynamically scoped into other
650 (org-current-export-dir
651 (or pub-dir
(org-export-directory :html opt-plist
)))
652 (org-current-export-file buffer-file-name
)
653 (title (or (and subtree-p
(org-export-get-title-from-subtree))
654 (plist-get opt-plist
:title
)
656 (plist-get opt-plist
:skip-before-1st-heading
))
657 (org-export-grab-title-from-buffer))
658 (and buffer-file-name
659 (file-name-sans-extension
660 (file-name-nondirectory buffer-file-name
)))
665 (file-name-as-directory
667 (org-export-directory :LaTeX ext-plist
)))
668 (file-name-sans-extension
670 (org-entry-get rbeg
"EXPORT_FILE_NAME" t
))
671 (file-name-nondirectory ;sans-extension
673 (error "Don't know which export file to use")))))
677 (if (equal (file-truename filename
)
678 (file-truename (or buffer-file-name
"dummy.org")))
679 (concat filename
".tex")
681 (buffer (if to-buffer
683 ((eq to-buffer
'string
) (get-buffer-create
684 "*Org LaTeX Export*"))
685 (t (get-buffer-create to-buffer
)))
686 (find-file-noselect filename
)))
687 (odd org-odd-levels-only
)
688 (header (org-export-latex-make-header title opt-plist
))
689 (skip (cond (subtree-p nil
)
691 (t (plist-get opt-plist
:skip-before-1st-heading
))))
692 (text (plist-get opt-plist
:text
))
693 (org-export-preprocess-hook
695 `(lambda () (org-set-local 'org-complex-heading-regexp
696 ,org-export-latex-complex-heading-re
))
697 org-export-preprocess-hook
))
698 (first-lines (if skip
"" (org-export-latex-first-lines
705 (if region-p rend
))))
706 (coding-system (and (boundp 'buffer-file-coding-system
)
707 buffer-file-coding-system
))
708 (coding-system-for-write (or org-export-latex-coding-system
710 (save-buffer-coding-system (or org-export-latex-coding-system
712 (region (buffer-substring
713 (if region-p
(region-beginning) (point-min))
714 (if region-p
(region-end) (point-max))))
716 (and text
(string-match "\\S-" text
)
717 (org-export-preprocess-string
722 :tags
(plist-get opt-plist
:tags
)
723 :priority
(plist-get opt-plist
:priority
)
724 :footnotes
(plist-get opt-plist
:footnotes
)
725 :drawers
(plist-get opt-plist
:drawers
)
726 :timestamps
(plist-get opt-plist
:timestamps
)
727 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
729 :skip-before-1st-heading skip
732 :LaTeX-fragments nil
)))
734 (org-export-preprocess-string
739 :tags
(plist-get opt-plist
:tags
)
740 :priority
(plist-get opt-plist
:priority
)
741 :footnotes
(plist-get opt-plist
:footnotes
)
742 :drawers
(plist-get opt-plist
:drawers
)
743 :timestamps
(plist-get opt-plist
:timestamps
)
744 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
745 :add-text
(if (eq to-buffer
'string
) nil text
)
746 :skip-before-1st-heading skip
747 :select-tags
(plist-get opt-plist
:select-tags
)
748 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
749 :LaTeX-fragments nil
)))
753 (org-install-letbind)
755 (and (fboundp 'set-buffer-file-coding-system
)
756 (set-buffer-file-coding-system coding-system-for-write
))
758 ;; insert the header and initial document commands
759 (unless (or (eq to-buffer
'string
) body-only
)
762 ;; insert text found in #+TEXT
763 (when (and text
(not (eq to-buffer
'string
)))
764 (insert (org-export-latex-content
765 text
'(lists tables fixed-width keywords
))
768 ;; insert lines before the first headline
770 (insert first-lines
))
772 ;; export the content of headlines
773 (org-export-latex-global
775 (insert string-for-export
)
776 (goto-char (point-min))
777 (when (re-search-forward "^\\(\\*+\\) " nil t
)
778 (let* ((asters (length (match-string 1)))
779 (level (if odd
(- asters
2) (- asters
1))))
780 (setq org-export-latex-add-level
781 (if odd
(1- (/ (1+ asters
) 2)) (1- asters
)))
782 (org-export-latex-parse-global level odd
)))))
785 (unless body-only
(insert "\n\\end{document}"))
787 ;; Attach description terms to the \item macro
788 (goto-char (point-min))
789 (while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t
)
790 (delete-region (match-beginning 1) (match-end 1)))
792 ;; Relocate the table of contents
793 (goto-char (point-min))
794 (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t
)
795 (goto-char (point-min))
796 (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t
)
798 (goto-char (point-min))
799 (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t
)
800 (replace-match "\\tableofcontents" t t
)))
802 ;; Cleanup forced line ends in items where they are not needed
803 (goto-char (point-min))
804 (while (re-search-forward
805 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
807 (delete-region (match-beginning 1) (match-end 1)))
808 (goto-char (point-min))
809 (while (re-search-forward
810 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
812 (if (looking-at "[\n \t]+")
813 (replace-match "\n")))
815 (run-hooks 'org-export-latex-final-hook
)
817 (unless (eq major-mode
'latex-mode
) (latex-mode))
819 (org-export-latex-fix-inputenc)
820 (run-hooks 'org-export-latex-after-save-hook
)
821 (goto-char (point-min))
822 (or (org-export-push-to-kill-ring "LaTeX")
823 (message "Exporting to LaTeX...done"))
825 (if (eq to-buffer
'string
)
826 (prog1 (buffer-substring (point-min) (point-max))
827 (kill-buffer (current-buffer)))
829 (set-window-configuration wcf
))))
832 (defun org-export-as-pdf (arg &optional hidden ext-plist
833 to-buffer body-only pub-dir
)
834 "Export as LaTeX, then process through to PDF."
836 (message "Exporting to PDF...")
837 (let* ((wconfig (current-window-configuration))
838 (lbuf (org-export-as-latex arg hidden ext-plist
839 to-buffer body-only pub-dir
))
840 (file (buffer-file-name lbuf
))
841 (base (file-name-sans-extension (buffer-file-name lbuf
)))
842 (pdffile (concat base
".pdf"))
843 (cmds org-latex-to-pdf-process
)
844 (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
845 (bibtex-p (with-current-buffer lbuf
847 (goto-char (point-min))
848 (re-search-forward "\\\\bibliography{" nil t
))))
850 (with-current-buffer outbuf
(erase-buffer))
851 (message (concat "Processing LaTeX file " file
"..."))
852 (setq output-dir
(file-name-directory file
))
853 (if (and cmds
(symbolp cmds
))
854 (funcall cmds
(shell-quote-argument file
))
856 (setq cmd
(pop cmds
))
857 (while (string-match "%b" cmd
)
858 (setq cmd
(replace-match
860 (shell-quote-argument base
))
862 (while (string-match "%f" cmd
)
863 (setq cmd
(replace-match
865 (shell-quote-argument file
))
867 (while (string-match "%o" cmd
)
868 (setq cmd
(replace-match
870 (shell-quote-argument output-dir
))
872 (shell-command cmd outbuf outbuf
)))
873 (message (concat "Processing LaTeX file " file
"...done"))
874 (if (not (file-exists-p pdffile
))
875 (error (concat "PDF file " pdffile
" was not produced"))
876 (set-window-configuration wconfig
)
877 (when org-export-pdf-remove-logfiles
878 (dolist (ext org-export-pdf-logfiles
)
879 (setq file
(concat base
"." ext
))
880 (and (file-exists-p file
) (delete-file file
))))
881 (message "Exporting to PDF...done")
885 (defun org-export-as-pdf-and-open (arg)
886 "Export as LaTeX, then process through to PDF, and open."
888 (let ((pdffile (org-export-as-pdf arg
)))
891 (org-open-file pdffile
)
892 (when org-export-kill-product-buffer-when-displayed
893 (kill-buffer (find-buffer-visiting
894 (concat (file-name-sans-extension (buffer-file-name))
896 (error "PDF file was not produced"))))
898 ;;; Parsing functions:
900 (defun org-export-latex-parse-global (level odd
)
901 "Parse the current buffer recursively, starting at LEVEL.
902 If ODD is non-nil, assume the buffer only contains odd sections.
903 Return a list reflecting the document structure."
905 (goto-char (point-min))
906 (let* ((cnt 0) output
907 (depth org-export-latex-sectioning-depth
))
908 (while (org-re-search-forward-unprotected
909 (concat "^\\(\\(?:\\*\\)\\{"
910 (number-to-string (+ (if odd
2 1) level
))
912 ;; make sure that there is no upper heading
916 (org-re-search-forward-unprotected
917 (concat "^\\(\\(?:\\*\\)\\{"
918 (number-to-string level
)
919 "\\}\\) \\(.*\\)$") nil t
)))) t
)
921 (let* ((pos (match-beginning 0))
922 (heading (match-string 2))
923 (nlevel (if odd
(/ (+ 3 level
) 2) (1+ level
))))
928 (if (org-re-search-forward-unprotected
929 (concat "^\\(\\(?:\\*\\)\\{"
930 (number-to-string (+ (if odd
2 1) level
))
931 "\\}\\) \\(.*\\)$") nil t
)
934 (goto-char (point-min))
942 `(heading .
,heading
)
943 `(content .
,(org-export-latex-parse-content))
944 `(subcontent .
,(org-export-latex-parse-subcontent
949 (defun org-export-latex-parse-content ()
950 "Extract the content of a section."
952 (end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t
)
953 (progn (beginning-of-line) (point))
955 (buffer-substring beg end
)))
957 (defun org-export-latex-parse-subcontent (level odd
)
958 "Extract the subcontent of a section at LEVEL.
959 If ODD Is non-nil, assume subcontent only contains odd sections."
960 (if (not (org-re-search-forward-unprotected
961 (concat "^\\(\\(?:\\*\\)\\{"
962 (number-to-string (+ (if odd
4 2) level
))
965 nil
; subcontent is nil
966 (org-export-latex-parse-global (+ (if odd
2 1) level
) odd
)))
968 ;;; Rendering functions:
969 (defun org-export-latex-global (content)
970 "Export CONTENT to LaTeX.
971 CONTENT is an element of the list produced by
972 `org-export-latex-parse-global'."
973 (if (eq (car content
) 'subcontent
)
974 (mapc 'org-export-latex-sub
(cdr content
))
975 (org-export-latex-sub (car content
))))
977 (defun org-export-latex-sub (subcontent)
978 "Export the list SUBCONTENT to LaTeX.
979 SUBCONTENT is an alist containing information about the headline
981 (let ((num (plist-get org-export-latex-options-plist
:section-numbers
)))
982 (mapc (lambda(x) (org-export-latex-subcontent x num
)) subcontent
)))
984 (defun org-export-latex-subcontent (subcontent num
)
985 "Export each cell of SUBCONTENT to LaTeX.
986 If NUM, export sections as numerical sections."
987 (let* ((heading (cdr (assoc 'heading subcontent
)))
988 (level (- (cdr (assoc 'level subcontent
))
989 org-export-latex-add-level
))
990 (occur (number-to-string (cdr (assoc 'occur subcontent
))))
991 (content (cdr (assoc 'content subcontent
)))
992 (subcontent (cadr (assoc 'subcontent subcontent
)))
993 (label (org-get-text-property-any 0 'target heading
))
994 (label-list (cons label
(cdr (assoc label
995 org-export-target-aliases
))))
996 (sectioning org-export-latex-sectioning
)
997 (depth org-export-latex-sectioning-depth
)
998 main-heading sub-heading
)
999 (when (symbolp (car sectioning
))
1000 (setq sectioning
(funcall (car sectioning
) level heading
))
1002 (setq heading
(car sectioning
)
1003 sectioning
(cdr sectioning
)
1004 ;; target property migh have changed...
1005 label
(org-get-text-property-any 0 'target heading
)
1006 label-list
(cons label
(cdr (assoc label
1007 org-export-target-aliases
)))))
1008 (if sectioning
(setq sectioning
(make-list 10 sectioning
)))
1009 (setq depth
(if sectioning
10000 0)))
1010 (if (string-match "[ \t]*\\\\\\\\[ \t]*" heading
)
1011 (setq main-heading
(substring heading
0 (match-beginning 0))
1012 sub-heading
(substring heading
(match-end 0))))
1013 (setq heading
(org-export-latex-fontify-headline heading
)
1014 sub-heading
(and sub-heading
1015 (org-export-latex-fontify-headline sub-heading
))
1016 main-heading
(and main-heading
1017 (org-export-latex-fontify-headline main-heading
)))
1019 ;; Normal conversion
1021 (let* ((sec (nth (1- level
) sectioning
))
1023 (if (consp (cdr sec
))
1024 (setq start
(nth (if num
0 2) sec
)
1025 end
(nth (if num
1 3) sec
))
1026 (setq start
(if num
(car sec
) (cdr sec
))))
1027 (insert (format start
(if main-heading main-heading heading
)
1028 (or sub-heading
"")))
1031 (insert (mapconcat (lambda (l) (format "\\label{%s}" l
))
1032 label-list
"\n") "\n"))
1033 (insert (org-export-latex-content content
))
1034 (cond ((stringp subcontent
) (insert subcontent
))
1036 (while (org-looking-back "\n\n") (backward-delete-char 1))
1037 (org-export-latex-sub subcontent
)))
1038 (when (and end
(string-match "[^ \t]" end
))
1039 (let ((hook (org-get-text-property-any 0 'org-insert-hook end
)))
1040 (and (functionp hook
) (funcall hook
)))
1041 (insert end
"\n"))))
1042 ;; At a level under the hl option: we can drop this subsection
1044 (cond ((eq org-export-latex-low-levels
'description
)
1045 (if (string-match "% ends low level$"
1046 (buffer-substring (point-at-bol 0) (point)))
1047 (delete-region (point-at-bol 0) (point))
1048 (insert "\\begin{description}\n"))
1049 (insert (format "\n\\item[%s]%s~\n"
1051 (if label
(format "\\label{%s}" label
) "")))
1052 (insert (org-export-latex-content content
))
1053 (cond ((stringp subcontent
) (insert subcontent
))
1054 ((listp subcontent
) (org-export-latex-sub subcontent
)))
1055 (insert "\\end{description} % ends low level\n"))
1056 ((memq org-export-latex-low-levels
'(itemize enumerate
))
1057 (if (string-match "% ends low level$"
1058 (buffer-substring (point-at-bol 0) (point)))
1059 (delete-region (point-at-bol 0) (point))
1060 (insert (format "\\begin{%s}\n"
1061 (symbol-name org-export-latex-low-levels
))))
1062 (insert (format "\n\\item %s\\\\\n%s%%"
1064 (if label
(format "\\label{%s}" label
) "")))
1065 (insert (org-export-latex-content content
))
1066 (cond ((stringp subcontent
) (insert subcontent
))
1067 ((listp subcontent
) (org-export-latex-sub subcontent
)))
1068 (insert (format "\\end{%s} %% ends low level\n"
1069 (symbol-name org-export-latex-low-levels
))))
1071 ((listp org-export-latex-low-levels
)
1072 (if (string-match "% ends low level$"
1073 (buffer-substring (point-at-bol 0) (point)))
1074 (delete-region (point-at-bol 0) (point))
1075 (insert (car org-export-latex-low-levels
) "\n"))
1076 (insert (format (nth 2 org-export-latex-low-levels
)
1078 (if label
(format "\\label{%s}" label
) "")))
1079 (insert (org-export-latex-content content
))
1080 (cond ((stringp subcontent
) (insert subcontent
))
1081 ((listp subcontent
) (org-export-latex-sub subcontent
)))
1082 (insert (nth 1 org-export-latex-low-levels
)
1083 " %% ends low level\n"))
1085 ((stringp org-export-latex-low-levels
)
1086 (insert (format org-export-latex-low-levels heading
) "\n")
1087 (when label
(insert (format "\\label{%s}\n" label
)))
1088 (insert (org-export-latex-content content
))
1089 (cond ((stringp subcontent
) (insert subcontent
))
1090 ((listp subcontent
) (org-export-latex-sub subcontent
)))))))))
1092 ;;; Exporting internals:
1093 (defun org-export-latex-set-initial-vars (ext-plist level
)
1094 "Store org local variables required for LaTeX export.
1095 EXT-PLIST is an optional additional plist.
1096 LEVEL indicates the default depth for export."
1097 (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
1098 org-export-latex-done-keywords org-done-keywords
1099 org-export-latex-not-done-keywords org-not-done-keywords
1100 org-export-latex-complex-heading-re org-complex-heading-regexp
1101 org-export-latex-display-custom-times org-display-custom-times
1102 org-export-latex-all-targets-re
1103 (org-make-target-link-regexp (org-all-targets))
1104 org-export-latex-options-plist
1105 (org-combine-plists (org-default-export-plist) ext-plist
1106 (org-infile-export-plist))
1107 org-export-latex-class
1108 (or (and (org-region-active-p)
1110 (goto-char (region-beginning))
1111 (and (looking-at org-complex-heading-regexp
)
1112 (org-entry-get nil
"LaTeX_CLASS" 'selective
))))
1116 (goto-char (point-min))
1117 (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\(-[a-zA-Z]+\\)" nil t
)
1119 (plist-get org-export-latex-options-plist
:latex-class
)
1120 org-export-latex-default-class
)
1121 org-export-latex-class-options
1122 (or (and (org-region-active-p)
1124 (goto-char (region-beginning))
1125 (and (looking-at org-complex-heading-regexp
)
1126 (org-entry-get nil
"LaTeX_CLASS_OPTIONS" 'selective
))))
1130 (goto-char (point-min))
1131 (and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t
)
1133 (plist-get org-export-latex-options-plist
:latex-class-options
))
1134 org-export-latex-class
1135 (or (car (assoc org-export-latex-class org-export-latex-classes
))
1136 (error "No definition for class `%s' in `org-export-latex-classes'"
1137 org-export-latex-class
))
1138 org-export-latex-header
1139 (cadr (assoc org-export-latex-class org-export-latex-classes
))
1140 org-export-latex-sectioning
1141 (cddr (assoc org-export-latex-class org-export-latex-classes
))
1142 org-export-latex-sectioning-depth
1145 (plist-get org-export-latex-options-plist
:headline-levels
))
1146 (sec-depth (length org-export-latex-sectioning
)))
1147 (if (> hl-levels sec-depth
) sec-depth hl-levels
))))
1148 (when (and org-export-latex-class-options
1149 (string-match "\\S-" org-export-latex-class-options
)
1150 (string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
1151 org-export-latex-header
))
1152 (setq org-export-latex-header
1153 (concat (substring org-export-latex-header
0 (match-end 1))
1154 org-export-latex-class-options
1155 (substring org-export-latex-header
(match-end 0))))))
1157 (defvar org-export-latex-format-toc-function
1158 'org-export-latex-format-toc-default
1159 "The function formatting returning the string to create the table of contents.
1160 The function mus take one parameter, the depth of the table of contents.")
1162 (defun org-export-latex-make-header (title opt-plist
)
1163 "Make the LaTeX header and return it as a string.
1164 TITLE is the current title from the buffer or region.
1165 OPT-PLIST is the options plist for current buffer."
1166 (let ((toc (plist-get opt-plist
:table-of-contents
))
1167 (author (org-export-apply-macros-in-string
1168 (plist-get opt-plist
:author
))))
1170 (if (plist-get opt-plist
:time-stamp-file
)
1171 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1172 ;; insert LaTeX custom header and packages from the list
1173 (org-splice-latex-header
1174 (org-export-apply-macros-in-string org-export-latex-header
)
1175 org-export-latex-default-packages-alist
1176 org-export-latex-packages-alist nil
1177 (org-export-apply-macros-in-string
1178 (plist-get opt-plist
:latex-header-extra
)))
1179 ;; append another special variable
1180 (org-export-apply-macros-in-string org-export-latex-append-header
)
1181 ;; define align if not yet defined
1182 "\n\\providecommand{\\alert}[1]{\\textbf{#1}}"
1186 ;; convert the title
1187 (org-export-latex-content
1188 title
'(lists tables fixed-width keywords
)))
1189 ;; insert author info
1190 (if (plist-get opt-plist
:author-info
)
1191 (format "\\author{%s}\n"
1192 (org-export-latex-fontify-headline (or author user-full-name
)))
1193 (format "%%\\author{%s}\n"
1194 (org-export-latex-fontify-headline (or author user-full-name
))))
1196 (format "\\date{%s}\n"
1198 (or (plist-get opt-plist
:date
)
1199 org-export-latex-date-format
)))
1200 ;; beginning of the document
1201 "\n\\begin{document}\n\n"
1202 ;; insert the title command
1203 (when (string-match "\\S-" title
)
1204 (if (string-match "%s" org-export-latex-title-command
)
1205 (format org-export-latex-title-command title
)
1206 org-export-latex-title-command
))
1208 ;; table of contents
1209 (when (and org-export-with-toc
1210 (plist-get opt-plist
:section-numbers
))
1211 (funcall org-export-latex-format-toc-function
1212 (cond ((numberp toc
)
1213 (min toc
(plist-get opt-plist
:headline-levels
)))
1214 (toc (plist-get opt-plist
:headline-levels
))))))))
1216 (defun org-export-latex-format-toc-default (depth)
1218 (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
1221 (defun org-export-latex-first-lines (opt-plist &optional beg end
)
1222 "Export the first lines before first headline.
1223 If BEG is non-nil, it is the beginning of the region.
1224 If END is non-nil, it is the end of the region."
1226 (goto-char (or beg
(point-min)))
1228 (end (if (re-search-forward "^\\*+ " end t
)
1229 (goto-char (match-beginning 0))
1230 (goto-char (or end
(point-max))))))
1232 (org-export-latex-content
1233 (org-export-preprocess-string
1234 (buffer-substring pt end
)
1239 :skip-before-1st-heading nil
1240 :LaTeX-fragments nil
1241 :timestamps
(plist-get opt-plist
:timestamps
)
1242 :footnotes
(plist-get opt-plist
:footnotes
)))
1244 (let ((inhibit-read-only t
)
1245 (limit (max pt
(1- end
))))
1246 (add-text-properties pt limit
1247 '(:org-license-to-kill t
))
1250 (while (re-search-forward "^[ \t]*#\\+.*\n?" limit t
)
1251 (let ((case-fold-search t
))
1252 (unless (org-string-match-p
1253 "^[ \t]*#\\+\\(attr_\\|caption\\>\\|label\\>\\)"
1255 (remove-text-properties (match-beginning 0) (match-end 0)
1256 '(:org-license-to-kill t
))))))))))))
1259 (defvar org-export-latex-header-defs nil
1260 "The header definitions that might be used in the LaTeX body.")
1261 (defvar org-export-latex-header-defs-re nil
1262 "The header definitions that might be used in the LaTeX body.")
1264 (defun org-export-latex-content (content &optional exclude-list
)
1265 "Convert CONTENT string to LaTeX.
1266 Don't perform conversions that are in EXCLUDE-LIST. Recognized
1267 conversion types are: quotation-marks, emphasis, sub-superscript,
1268 links, keywords, lists, tables, fixed-width"
1271 (unless (memq 'timestamps exclude-list
)
1272 (org-export-latex-time-stamps))
1273 (unless (memq 'quotation-marks exclude-list
)
1274 (org-export-latex-quotation-marks))
1275 (unless (memq 'emphasis exclude-list
)
1276 (when (plist-get org-export-latex-options-plist
:emphasize
)
1277 (org-export-latex-fontify)))
1278 (unless (memq 'sub-superscript exclude-list
)
1279 (org-export-latex-special-chars
1280 (plist-get org-export-latex-options-plist
:sub-superscript
)))
1281 (unless (memq 'links exclude-list
)
1282 (org-export-latex-links))
1283 (unless (memq 'keywords exclude-list
)
1284 (org-export-latex-keywords))
1285 (unless (memq 'lists exclude-list
)
1286 (org-export-latex-lists))
1287 (unless (memq 'tables exclude-list
)
1288 (org-export-latex-tables
1289 (plist-get org-export-latex-options-plist
:tables
)))
1290 (unless (memq 'fixed-width exclude-list
)
1291 (org-export-latex-fixed-width
1292 (plist-get org-export-latex-options-plist
:fixed-width
)))
1294 (buffer-substring (point-min) (point-max))))
1296 (defun org-export-latex-protect-string (s)
1297 "Add the org-protected property to string S."
1298 (add-text-properties 0 (length s
) '(org-protected t
) s
) s
)
1300 (defun org-export-latex-protect-char-in-string (char-list string
)
1301 "Add org-protected text-property to char from CHAR-LIST in STRING."
1305 (goto-char (point-min))
1306 (while (re-search-forward (regexp-opt char-list
) nil t
)
1307 (add-text-properties (match-beginning 0)
1308 (match-end 0) '(org-protected t
)))
1311 (defun org-export-latex-keywords-maybe (&optional remove-list
)
1312 "Maybe remove keywords depending on rules in REMOVE-LIST."
1313 (goto-char (point-min))
1314 (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1
"\\|"))
1315 (case-fold-search nil
)
1316 (todo-markup org-export-latex-todo-keyword-markup
)
1318 ;; convert TODO keywords
1319 (when (re-search-forward (concat "^\\(" re-todo
"\\)") nil t
)
1320 (if (plist-get remove-list
:todo
)
1323 ((stringp todo-markup
) todo-markup
)
1324 ((and (consp todo-markup
) (stringp (car todo-markup
)))
1325 (if (member (match-string 1) org-export-latex-done-keywords
)
1326 (cdr todo-markup
) (car todo-markup
)))
1327 (t (cdr (or (assoc (match-string 1) todo-markup
)
1328 (car todo-markup
))))))
1329 (replace-match (org-export-latex-protect-string
1330 (format fmt
(match-string 1))) t t
)))
1331 ;; convert priority string
1332 (when (re-search-forward "\\[\\\\#.\\]" nil t
)
1333 (if (plist-get remove-list
:priority
)
1335 (replace-match (format "\\textbf{%s}" (match-string 0)) t t
)))
1337 (when (re-search-forward "\\(:[a-zA-Z0-9_@#%]+\\)+:" nil t
)
1338 (if (or (not org-export-with-tags
)
1339 (plist-get remove-list
:tags
))
1342 (org-export-latex-protect-string
1343 (format org-export-latex-tag-markup
1345 (replace-regexp-in-string
1346 "_" "\\\\_" (match-string 0)))))
1349 (defun org-export-latex-fontify-headline (string)
1350 "Fontify special words in STRING."
1352 ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
1353 ;; the beginning of the buffer - inserting "\n" is safe here though.
1354 (insert "\n" string
)
1355 (goto-char (point-min))
1356 (let ((re (concat "\\\\\\([a-zA-Z]+\\)"
1357 "\\(?:<[^<>\n]*>\\)*"
1358 "\\(?:\\[[^][\n]*?\\]\\)*"
1359 "\\(?:<[^<>\n]*>\\)*"
1361 (org-create-multibrace-regexp "{" "}" 3)
1363 (while (re-search-forward re nil t
)
1365 ;; check for comment line
1366 (save-excursion (goto-char (match-beginning 0))
1367 (org-in-indented-comment-line))
1368 ;; Check if this is a defined entity, so that is may need conversion
1369 (org-entity-get (match-string 1)))
1370 (add-text-properties (match-beginning 0) (match-end 0)
1371 '(org-protected t
)))))
1372 (when (plist-get org-export-latex-options-plist
:emphasize
)
1373 (org-export-latex-fontify))
1374 (org-export-latex-keywords-maybe)
1375 (org-export-latex-special-chars
1376 (plist-get org-export-latex-options-plist
:sub-superscript
))
1377 (org-export-latex-links)
1378 (org-trim (buffer-string))))
1380 (defun org-export-latex-time-stamps ()
1381 "Format time stamps."
1382 (goto-char (point-min))
1383 (let ((org-display-custom-times org-export-latex-display-custom-times
))
1384 (while (re-search-forward org-ts-regexp-both nil t
)
1385 (org-if-unprotected-at (1- (point))
1387 (org-export-latex-protect-string
1388 (format org-export-latex-timestamp-markup
1389 (substring (org-translate-time (match-string 0)) 1 -
1)))
1392 (defun org-export-latex-quotation-marks ()
1393 "Export quotation marks depending on language conventions."
1394 (let* ((lang (plist-get org-export-latex-options-plist
:language
))
1395 (quote-rpl (if (equal lang
"fr")
1396 '(("\\(\\s-\\)\"" "«~")
1397 ("\\(\\S-\\)\"" "~»")
1398 ("\\(\\s-\\)'" "`"))
1399 '(("\\(\\s-\\|[[(]\\)\"" "``")
1400 ("\\(\\S-\\)\"" "''")
1401 ("\\(\\s-\\|(\\)'" "`")))))
1402 (mapc (lambda(l) (goto-char (point-min))
1403 (while (re-search-forward (car l
) nil t
)
1404 (let ((rpl (concat (match-string 1)
1405 (org-export-latex-protect-string
1406 (copy-sequence (cadr l
))))))
1407 (org-if-unprotected-1
1408 (replace-match rpl t t
))))) quote-rpl
)))
1410 (defun org-export-latex-special-chars (sub-superscript)
1411 "Export special characters to LaTeX.
1412 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
1413 See the `org-export-latex.el' code for a complete conversion table."
1414 (goto-char (point-min))
1416 (goto-char (point-min))
1417 (while (re-search-forward c nil t
)
1418 ;; Put the point where to check for org-protected
1419 (unless (get-text-property (match-beginning 2) 'org-protected
)
1420 (cond ((member (match-string 2) '("\\$" "$"))
1421 (if (equal (match-string 2) "\\$")
1423 (replace-match "\\$" t t
)))
1424 ((member (match-string 2) '("&" "%" "#"))
1425 (if (equal (match-string 1) "\\")
1426 (replace-match (match-string 2) t t
)
1427 (replace-match (concat (match-string 1) "\\"
1428 (match-string 2)) t t
)
1430 ((equal (match-string 2) "...")
1432 (concat (match-string 1)
1433 (org-export-latex-protect-string "\\ldots{}")) t t
))
1434 ((equal (match-string 2) "~")
1435 (cond ((equal (match-string 1) "\\") nil
)
1436 ((eq 'org-link
(get-text-property 0 'face
(match-string 2)))
1437 (replace-match (concat (match-string 1) "\\~") t t
))
1439 (org-export-latex-protect-string
1440 (concat (match-string 1) "\\~{}")) t t
))))
1441 ((member (match-string 2) '("{" "}"))
1442 (unless (save-match-data (org-inside-latex-math-p))
1443 (if (equal (match-string 1) "\\")
1444 (replace-match (match-string 2) t t
)
1445 (replace-match (concat (match-string 1) "\\"
1446 (match-string 2)) t t
)))))
1447 (unless (save-match-data (org-inside-latex-math-p))
1448 (cond ((equal (match-string 2) "\\")
1449 (replace-match (or (save-match-data
1450 (org-export-latex-treat-backslash-char
1452 (or (match-string 3) "")))
1454 (when (and (get-text-property (1- (point)) 'org-entity
)
1456 ;; OK, this was an entity replacement, and the user
1457 ;; had terminated the entity with {}. Make sure
1458 ;; {} is protected as well, and remove the extra {}
1459 ;; inserted by the conversion.
1460 (put-text-property (point) (+ 2 (point)) 'org-protected t
)
1461 (if (save-excursion (goto-char (max (- (point) 2) (point-min)))
1466 ((member (match-string 2) '("_" "^"))
1467 (replace-match (or (save-match-data
1468 (org-export-latex-treat-sub-super-char
1472 (match-string 3))) "") t t
)
1473 (backward-char 1)))))))
1474 '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
1475 "\\(\\(\\\\?\\$\\)\\)"
1476 "\\([a-zA-Z0-9()]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-zA-Z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-zA-Z0-9]+}\\|([a-zA-Z0-9]+)\\)"
1477 "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|\\([&#%{}\"]\\|[a-zA-Z][a-zA-Z0-9]*\\)\\)"
1478 "\\(.\\|^\\)\\(&\\)"
1479 "\\(.\\|^\\)\\(#\\)"
1480 "\\(.\\|^\\)\\(%\\)"
1481 "\\(.\\|^\\)\\({\\)"
1482 "\\(.\\|^\\)\\(}\\)"
1483 "\\(.\\|^\\)\\(~\\)"
1484 "\\(.\\|^\\)\\(\\.\\.\\.\\)"
1485 ;; (?\< . "\\textless{}")
1486 ;; (?\> . "\\textgreater{}")
1489 (defun org-inside-latex-math-p ()
1490 (get-text-property (point) 'org-latex-math
))
1492 (defun org-export-latex-treat-sub-super-char
1493 (subsup char string-before string-after
)
1494 "Convert the \"_\" and \"^\" characters to LaTeX.
1495 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
1496 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
1497 (cond ((equal string-before
"\\")
1498 (concat string-before char string-after
))
1499 ((and (string-match "\\S-+" string-after
))
1500 ;; this is part of a math formula
1501 (cond ((eq 'org-link
(get-text-property 0 'face char
))
1502 (concat string-before
"\\" char string-after
))
1503 ((save-match-data (org-inside-latex-math-p))
1505 (cond ((eq 1 (length string-after
))
1506 (concat string-before char string-after
))
1507 ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after
)
1508 (format "%s%s{%s}" string-before char
1509 (match-string 1 string-after
))))))
1510 ((and (> (length string-after
) 1)
1512 (and (equal subsup
'{}) (eq (string-to-char string-after
) ?\
{)))
1513 (or (string-match "[{]?\\([^}]+\\)[}]?" string-after
)
1514 (string-match "[(]?\\([^)]+\\)[)]?" string-after
)))
1516 (org-export-latex-protect-string
1517 (format "%s$%s{%s}$" string-before char
1518 (if (and (> (match-end 1) (1+ (match-beginning 1)))
1519 (not (equal (substring string-after
0 2) "{\\")))
1520 (concat "\\mathrm{" (match-string 1 string-after
) "}")
1521 (match-string 1 string-after
)))))
1522 ((eq subsup t
) (concat string-before
"$" char string-after
"$"))
1523 (t (org-export-latex-protect-string
1524 (concat string-before
"\\" char
"{}" string-after
)))))
1525 (t (org-export-latex-protect-string
1526 (concat string-before
"\\" char
"{}" string-after
)))))
1528 (defun org-export-latex-treat-backslash-char (string-before string-after
)
1529 "Convert the \"$\" special character to LaTeX.
1530 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
1531 (let ((ass (org-entity-get string-after
)))
1535 (concat string-before
1536 (org-export-latex-protect-string
1537 (concat "$" (nth 1 ass
) "$")))
1538 (concat string-before
(org-export-latex-protect-string
1541 ((and (not (string-match "^[ \n\t]" string-after
))
1542 (not (string-match "[ \t]\\'\\|^" string-before
)))
1543 ;; backslash is inside a word
1544 (concat string-before
1545 (org-export-latex-protect-string
1546 (concat "\\textbackslash{}" string-after
))))
1547 ((not (or (equal string-after
"")
1548 (string-match "^[ \t\n]" string-after
)))
1549 ;; backslash might escape a character (like \#) or a user TeX
1550 ;; macro (like \setcounter)
1551 (concat string-before
1552 (org-export-latex-protect-string (concat "\\" string-after
))))
1553 ((and (string-match "^[ \t\n]" string-after
)
1554 (string-match "[ \t\n]\\'" string-before
))
1555 ;; backslash is alone, convert it to $\backslash$
1556 (org-export-latex-protect-string
1557 (concat string-before
"\\textbackslash{}" string-after
)))
1558 (t (org-export-latex-protect-string
1559 (concat string-before
"\\textbackslash{}" string-after
))))))
1561 (defun org-export-latex-keywords ()
1562 "Convert special keywords to LaTeX."
1563 (goto-char (point-min))
1564 (while (re-search-forward org-export-latex-special-keyword-regexp nil t
)
1565 (replace-match (format org-export-latex-timestamp-keyword-markup
1566 (match-string 0)) t t
)
1568 (beginning-of-line 1)
1569 (unless (looking-at ".*\n[ \t]*\n")
1573 (defun org-export-latex-fixed-width (opt)
1574 "When OPT is non-nil convert fixed-width sections to LaTeX."
1575 (goto-char (point-min))
1576 (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t
)
1577 (unless (get-text-property (point) 'org-example
)
1579 (progn (goto-char (match-beginning 0))
1580 (insert "\\begin{verbatim}\n")
1581 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1582 (replace-match (concat (match-string 1)
1583 (match-string 2)) t t
)
1585 (insert "\\end{verbatim}\n\n"))
1586 (progn (goto-char (match-beginning 0))
1587 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1588 (replace-match (concat "%" (match-string 1)
1589 (match-string 2)) t t
)
1590 (forward-line)))))))
1592 (defvar org-table-last-alignment
) ; defined in org-table.el
1593 (defvar org-table-last-column-widths
) ; defined in org-table.el
1594 (declare-function orgtbl-to-latex
"org-table" (table params
) t
)
1595 (defun org-export-latex-tables (insert)
1596 "Convert tables to LaTeX and INSERT it."
1597 ;; First, get the table.el tables
1598 (goto-char (point-min))
1599 (while (re-search-forward "^[ \t]*\\(\\+-[-+]*\\+\\)[ \t]*\n[ \t]*|" nil t
)
1602 (org-export-latex-convert-table.el-table
)))
1604 ;; And now the Org-mode tables
1605 (goto-char (point-min))
1606 (while (re-search-forward "^\\([ \t]*\\)|" nil t
)
1607 (org-if-unprotected-at (1- (point))
1609 (let* ((beg (org-table-begin))
1610 (end (org-table-end))
1611 (raw-table (buffer-substring beg end
))
1612 (org-table-last-alignment (copy-sequence org-table-last-alignment
))
1613 (org-table-last-column-widths (copy-sequence
1614 org-table-last-column-widths
))
1615 fnum fields line lines olines gr colgropen line-fmt align
1616 caption shortn label attr floatp placement longtblp
)
1617 (if org-export-latex-tables-verbatim
1618 (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1619 "\\end{verbatim}\n")))
1620 (apply 'delete-region
(list beg end
))
1621 (insert (org-export-latex-protect-string tbl
)))
1623 (setq caption
(org-find-text-property-in-string
1624 'org-caption raw-table
)
1625 shortn
(org-find-text-property-in-string
1626 'org-caption-shortn raw-table
)
1627 attr
(org-find-text-property-in-string
1628 'org-attributes raw-table
)
1629 label
(org-find-text-property-in-string
1630 'org-label raw-table
)
1631 longtblp
(and attr
(stringp attr
)
1632 (string-match "\\<longtable\\>" attr
))
1633 align
(and attr
(stringp attr
)
1634 (string-match "\\<align=\\([^ \t\n\r]+\\)" attr
)
1635 (match-string 1 attr
))
1636 floatp
(or caption label
)
1637 placement
(if (and attr
1639 (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr
))
1640 (match-string 1 attr
)
1642 (setq caption
(and caption
(org-export-latex-fontify-headline caption
)))
1643 (setq lines
(org-split-string raw-table
"\n"))
1644 (apply 'delete-region
(list beg end
))
1645 (when org-export-table-remove-special-lines
1646 (setq lines
(org-table-clean-before-export lines
'maybe-quoted
)))
1647 (when org-table-clean-did-remove-column
1648 (pop org-table-last-alignment
)
1649 (pop org-table-last-column-widths
))
1650 ;; make a formatting string to reflect alignment
1652 (while (and (not line-fmt
) (setq line
(pop olines
)))
1653 (unless (string-match "^[ \t]*|-" line
)
1654 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1655 (setq fnum
(make-vector (length fields
) 0))
1659 (setq gr
(pop org-table-colgroup-info
))
1661 (cond ((eq gr
:start
)
1662 (prog1 (if colgropen
"|" "|")
1663 (setq colgropen t
)))
1665 (prog1 (if colgropen
"|" "|")
1666 (setq colgropen nil
)))
1668 (if (memq gr
'(:end
:startend
))
1669 (progn (setq colgropen nil
) "|")
1672 ;; fix double || in line-fmt
1673 (setq line-fmt
(replace-regexp-in-string "||" "|" line-fmt
))
1674 ;; maybe remove the first and last "|"
1675 (when (and (not org-export-latex-tables-column-borders
)
1676 (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt
))
1677 (setq line-fmt
(match-string 2 line-fmt
)))
1680 (setq align
(apply 'format
1682 (mapcar (lambda (x) (if x
"r" "l"))
1683 org-table-last-alignment
)))))
1684 ;; prepare the table to send to orgtbl-to-latex
1688 (or (and (string-match "[ \t]*|-+" elem
) 'hline
)
1689 (org-split-string (org-trim elem
) "|")))
1692 (insert (org-export-latex-protect-string
1695 (concat "\\begin{longtable}{" align
"}\n")
1696 (if floatp
(format "\\begin{table}%s\n" placement
)))
1699 "\\caption%s{%s} %s"
1700 (if shortn
(concat "[" shortn
"]") "")
1702 (if label
(format "\\label{%s}" label
) "")))
1703 (if (and longtblp caption
) "\\\\\n" "\n")
1704 (if (and org-export-latex-tables-centered
(not longtblp
))
1705 "\\begin{center}\n")
1707 (format "\\begin{%s}{%s}\n"
1708 org-export-latex-tabular-environment align
))
1711 `(:tstart nil
:tend nil
1712 :hlend
,(if longtblp
1716 \\hline\\multicolumn{%d}{r}{Continued on next page}\\
1718 \\endlastfoot" (length org-table-last-alignment
))
1721 (format "\n\\end{%s}"
1722 org-export-latex-tabular-environment
))
1723 (if longtblp
"\n" (if org-export-latex-tables-centered
1724 "\n\\end{center}\n" "\n"))
1727 (if floatp
"\\end{table}"))))
1730 (defun org-export-latex-convert-table.el-table
()
1731 "Replace table.el table at point with LaTeX code."
1732 (let (tbl caption shortn label line floatp attr align rmlines
)
1733 (setq line
(buffer-substring (point-at-bol) (point-at-eol))
1734 label
(org-get-text-property-any 0 'org-label line
)
1735 caption
(org-get-text-property-any 0 'org-caption line
)
1736 shortn
(org-get-text-property-any 0 'org-caption-shortn line
)
1737 attr
(org-get-text-property-any 0 'org-attributes line
)
1738 align
(and attr
(stringp attr
)
1739 (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr
)
1740 (match-string 1 attr
))
1741 rmlines
(and attr
(stringp attr
)
1742 (string-match "\\<rmlines\\>" attr
))
1743 floatp
(or label caption
))
1744 (and (get-buffer "*org-export-table*")
1745 (kill-buffer (get-buffer "*org-export-table*")))
1746 (table-generate-source 'latex
"*org-export-table*" "caption")
1747 (setq tbl
(with-current-buffer "*org-export-table*"
1749 (while (string-match "^%.*\n" tbl
)
1750 (setq tbl
(replace-match "" t t tbl
)))
1754 (setq lines
(mapcar (lambda (x)
1755 (if (string-match "^\\\\hline$" x
)
1760 (org-split-string tbl
"\n")))
1761 (setq tbl
(mapconcat 'identity
(delq nil lines
) "\n"))))
1762 (when (and align
(string-match "\\\\begin{tabular}{.*}" tbl
))
1763 (setq tbl
(replace-match (concat "\\begin{tabular}{" align
"}")
1765 (and (get-buffer "*org-export-table*")
1766 (kill-buffer (get-buffer "*org-export-table*")))
1767 (beginning-of-line 0)
1768 (while (looking-at "[ \t]*\\(|\\|\\+-\\)")
1769 (delete-region (point) (1+ (point-at-eol))))
1770 (when org-export-latex-tables-centered
1771 (setq tbl
(concat "\\begin{center}\n" tbl
"\\end{center}")))
1773 (setq tbl
(concat "\\begin{table}\n"
1774 (format "\\caption%s{%s}%s\n"
1775 (if shortn
(format "[%s]" shortn
) "")
1776 (if label
(format "\\label{%s}" label
) "")
1779 "\n\\end{table}\n")))
1780 (insert (org-export-latex-protect-string tbl
))))
1782 (defun org-export-latex-fontify ()
1783 "Convert fontification to LaTeX."
1784 (goto-char (point-min))
1785 (while (re-search-forward org-emph-re nil t
)
1786 ;; The match goes one char after the *string*, except at the end of a line
1787 (let ((emph (assoc (match-string 3)
1788 org-export-latex-emphasis-alist
))
1789 (beg (match-beginning 0))
1793 (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
1795 (unless (or (and (get-text-property (- (point) 2) 'org-protected
)
1796 (not (get-text-property
1797 (- (point) 2) 'org-verbatim-emph
)))
1798 (equal (char-after (match-beginning 3))
1799 (char-after (1+ (match-beginning 3))))
1801 (goto-char (match-beginning 1))
1803 (and (org-at-table-p)
1805 "[|\n]" (buffer-substring beg end
)))))
1806 (and (equal (match-string 3) "+")
1808 (string-match "\\`-+\\'" (match-string 4)))))
1809 (setq s
(match-string 4))
1810 (setq rpl
(concat (match-string 1)
1811 (org-export-latex-emph-format (cadr emph
)
1815 (setq rpl
(org-export-latex-protect-string rpl
))
1817 (if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl
)
1819 (add-text-properties (match-beginning 1) (match-end 1)
1820 '(org-protected t
) rpl
)
1821 (add-text-properties (match-beginning 3) (match-end 3)
1822 '(org-protected t
) rpl
)))))
1823 (replace-match rpl t t
)))
1826 (defvar org-export-latex-use-verb nil
)
1827 (defun org-export-latex-emph-format (format string
)
1828 "Format an emphasis string and handle the \\verb special case."
1829 (when (equal format
"\\verb")
1831 (if org-export-latex-use-verb
1832 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1834 (loop for i from
0 to
(1- (length ll
)) do
1835 (if (not (string-match (regexp-quote (substring ll i
(1+ i
)))
1838 (setq format
(concat "\\verb" (substring ll i
(1+ i
))
1839 "%s" (substring ll i
(1+ i
))))
1840 (throw 'exit nil
))))))
1842 (trans '(("\\" .
"\\textbackslash{}")
1843 ("~" .
"\\textasciitilde{}")
1844 ("^" .
"\\textasciicircum{}")))
1846 (while (string-match "[\\{}$%&_#~^]" string
)
1847 (setq char
(match-string 0 string
))
1848 (if (> (match-beginning 0) 0)
1849 (setq rtn
(concat rtn
(substring string
1850 0 (match-beginning 0)))))
1851 (setq string
(substring string
(1+ (match-beginning 0))))
1852 (setq char
(or (cdr (assoc char trans
)) (concat "\\" char
))
1853 rtn
(concat rtn char
)))
1854 (setq string
(concat rtn string
) format
"\\texttt{%s}")))))
1855 (format format string
))
1857 (defun org-export-latex-links ()
1858 ;; Make sure to use the LaTeX hyperref and graphicx package
1859 ;; or send some warnings.
1860 "Convert links to LaTeX."
1861 (goto-char (point-min))
1862 (while (re-search-forward org-bracket-link-analytic-regexp
++ nil t
)
1863 (org-if-unprotected-1
1864 (goto-char (match-beginning 0))
1865 (let* ((re-radio org-export-latex-all-targets-re
)
1866 (remove (list (match-beginning 0) (match-end 0)))
1867 (raw-path (org-extract-attributes (match-string 3)))
1868 (full-raw-path (concat (match-string 1) raw-path
))
1869 (desc (match-string 5))
1870 (type (or (match-string 2)
1871 (if (or (file-name-absolute-p raw-path
)
1872 (string-match "^\\.\\.?/" raw-path
))
1874 (coderefp (equal type
"coderef"))
1875 (caption (org-find-text-property-in-string 'org-caption raw-path
))
1876 (shortn (org-find-text-property-in-string 'org-caption-shortn raw-path
))
1877 (attr (or (org-find-text-property-in-string 'org-attributes raw-path
)
1878 (plist-get org-export-latex-options-plist
:latex-image-options
)))
1879 (label (org-find-text-property-in-string 'org-label raw-path
))
1881 ;; define the path of the link
1883 ((member type
'("coderef"))
1885 ((member type
'("http" "https" "ftp"))
1886 (concat type
":" raw-path
))
1887 ((and re-radio
(string-match re-radio raw-path
))
1889 ((equal type
"mailto")
1890 (concat type
":" raw-path
))
1891 ((equal type
"file")
1892 (if (and (org-file-image-p
1895 org-export-latex-inline-image-extensions
)
1896 (or (get-text-property 0 'org-no-description
1898 (equal desc full-raw-path
)))
1900 (progn (when (string-match "\\(.+\\)::.+" raw-path
)
1901 (setq raw-path
(match-string 1 raw-path
)))
1902 (if (file-exists-p raw-path
)
1903 (concat type
"://" (expand-file-name raw-path
))
1904 (concat type
"://" (org-export-directory
1905 :LaTeX org-export-latex-options-plist
)
1907 ;; process with link inserting
1908 (apply 'delete-region remove
)
1909 (setq caption
(and caption
(org-export-latex-fontify-headline caption
)))
1911 (plist-get org-export-latex-options-plist
:inline-images
))
1912 ;; OK, we need to inline an image
1914 (org-export-latex-format-image raw-path caption label attr shortn
)))
1917 (org-export-get-coderef-format path desc
)
1918 (cdr (assoc path org-export-code-refs
)))))
1919 (radiop (insert (format "\\hyperref[%s]{%s}"
1920 (org-solidify-link-text raw-path
) desc
)))
1922 (insert (format "\\hyperref[%s]{%s}"
1923 (org-remove-initial-hash
1924 (org-solidify-link-text raw-path
))
1927 (when (org-at-table-p)
1928 ;; There is a strange problem when we have a link in a table,
1929 ;; ampersands then cause a problem. I think this must be
1930 ;; a LaTeX issue, but we here implement a work-around anyway.
1931 (setq path
(org-export-latex-protect-amp path
)
1932 desc
(org-export-latex-protect-amp desc
)))
1933 (insert (format org-export-latex-hyperref-format path desc
)))
1935 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
1936 ;; The link protocol has a function for formatting the link
1939 (funcall fnc
(org-link-unescape raw-path
) desc
'latex
))))
1941 (t (insert "\\texttt{" desc
"}")))))))
1944 (defun org-export-latex-format-image (path caption label attr
&optional shortn
)
1945 "Format the image element, depending on user settings."
1946 (let (ind floatp wrapp multicolumnp placement figenv
)
1947 (setq floatp
(or caption label
))
1948 (setq ind
(org-get-text-property-any 0 'original-indentation path
))
1949 (when (and attr
(stringp attr
))
1950 (if (string-match "[ \t]*\\<wrap\\>" attr
)
1951 (setq wrapp t floatp nil attr
(replace-match "" t t attr
)))
1952 (if (string-match "[ \t]*\\<float\\>" attr
)
1953 (setq wrapp nil floatp t attr
(replace-match "" t t attr
)))
1954 (if (string-match "[ \t]*\\<multicolumn\\>" attr
)
1955 (setq multicolumnp t attr
(replace-match "" t t attr
))))
1959 (wrapp "{l}{0.5\\textwidth}")
1963 (when (and attr
(stringp attr
)
1964 (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr
))
1965 (setq placement
(match-string 1 attr
)
1966 attr
(replace-match "" t t attr
)))
1967 (setq attr
(and attr
(org-trim attr
)))
1968 (when (or (not attr
) (= (length attr
) 0))
1969 (setq attr
(cond (floatp "width=0.7\\textwidth")
1970 (wrapp "width=0.48\\textwidth")
1974 (wrapp "\\begin{wrapfigure}%placement
1976 \\includegraphics[%attr]{%path}
1977 \\caption%shortn{%labelcmd%caption}
1979 (multicolumnp "\\begin{figure*}%placement
1981 \\includegraphics[%attr]{%path}
1982 \\caption{%labelcmd%caption}
1984 (floatp "\\begin{figure}%placement
1986 \\includegraphics[%attr]{%path}
1987 \\caption{%labelcmd%caption}
1989 (t "\\includegraphics[%attr]{%path}")))
1992 (setq figenv
(mapconcat 'identity
(split-string figenv
"\n")
1993 (save-excursion (beginning-of-line 1)
1994 (looking-at "[ \t]*")
1995 (concat "\n" (match-string 0)))))
1997 (if (and (not label
) (not caption
)
1998 (string-match "^\\\\caption{.*\n" figenv
))
1999 (setq figenv
(replace-match "" t t figenv
)))
2004 (if (file-name-absolute-p path
)
2005 (expand-file-name path
)
2008 (cons "shortn" (if shortn
(format "[%s]" shortn
) ""))
2009 (cons "labelcmd" (if label
(format "\\label{%s}"
2011 (cons "caption" (or caption
""))
2012 (cons "placement" (or placement
""))))
2013 nil
'original-indentation ind
)))
2015 (defun org-export-latex-protect-amp (s)
2016 (while (string-match "\\([^\\\\]\\)\\(&\\)" s
)
2017 (setq s
(replace-match (concat (match-string 1 s
) "\\" (match-string 2 s
))
2021 (defun org-remove-initial-hash (s)
2022 (if (string-match "\\`#" s
)
2025 (defvar org-latex-entities
) ; defined below
2026 (defvar org-latex-entities-regexp
) ; defined below
2028 (defun org-export-latex-preprocess (parameters)
2029 "Clean stuff in the LaTeX export."
2030 ;; Preserve line breaks
2031 (goto-char (point-min))
2032 (while (re-search-forward "\\\\\\\\" nil t
)
2033 (add-text-properties (match-beginning 0) (match-end 0)
2034 '(org-protected t
)))
2036 ;; Preserve latex environments
2037 (goto-char (point-min))
2038 (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t
)
2040 (let* ((start (progn (beginning-of-line) (point)))
2041 (end (and (re-search-forward
2042 (concat "^[ \t]*\\\\end{"
2043 (regexp-quote (match-string 1))
2047 (add-text-properties start end
'(org-protected t
))
2048 (goto-char (point-at-eol))))))
2050 ;; Preserve math snippets
2052 (let* ((matchers (plist-get org-format-latex-options
:matchers
))
2053 (re-list org-latex-regexps
)
2054 beg end re e m n block off
)
2055 ;; Check the different regular expressions
2056 (while (setq e
(pop re-list
))
2057 (setq m
(car e
) re
(nth 1 e
) n
(nth 2 e
)
2058 block
(if (nth 3 e
) "\n\n" ""))
2059 (setq off
(if (member m
'("$" "$1")) 1 0))
2060 (when (and (member m matchers
) (not (equal m
"begin")))
2061 (goto-char (point-min))
2062 (while (re-search-forward re nil t
)
2063 (setq beg
(+ (match-beginning 0) off
) end
(- (match-end 0) 0))
2064 (add-text-properties beg end
'(org-protected t org-latex-math t
))))))
2066 ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
2067 (goto-char (point-min))
2068 (let ((case-fold-search nil
))
2069 (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t
)
2070 (unless (eq (char-before (match-beginning 1)) ?
\\)
2071 (org-if-unprotected-1
2072 (replace-match (org-export-latex-protect-string
2073 (concat "\\" (match-string 1)
2076 ;; Convert blockquotes
2077 (goto-char (point-min))
2078 (while (search-forward "ORG-BLOCKQUOTE-START" nil t
)
2079 (org-replace-match-keep-properties "\\begin{quote}" t t
))
2080 (goto-char (point-min))
2081 (while (search-forward "ORG-BLOCKQUOTE-END" nil t
)
2082 (org-replace-match-keep-properties "\\end{quote}" t t
))
2085 (goto-char (point-min))
2086 (while (search-forward "ORG-VERSE-START" nil t
)
2087 (org-replace-match-keep-properties "\\begin{verse}" t t
)
2088 (beginning-of-line 2)
2089 (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
2090 (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
2091 (goto-char (match-end 1))
2092 (org-replace-match-keep-properties
2093 (org-export-latex-protect-string
2094 (concat "\\hspace*{1cm}" (match-string 2))) t t
)
2095 (beginning-of-line 1))
2096 (if (looking-at "[ \t]*$")
2097 (insert (org-export-latex-protect-string "\\vspace*{1em}"))
2098 (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
2101 (beginning-of-line 2))
2102 (and (looking-at "[ \t]*ORG-VERSE-END.*")
2103 (org-replace-match-keep-properties "\\end{verse}" t t
)))
2106 (goto-char (point-min))
2107 (while (search-forward "ORG-CENTER-START" nil t
)
2108 (org-replace-match-keep-properties "\\begin{center}" t t
))
2109 (goto-char (point-min))
2110 (while (search-forward "ORG-CENTER-END" nil t
)
2111 (org-replace-match-keep-properties "\\end{center}" t t
))
2113 (run-hooks 'org-export-latex-after-blockquotes-hook
)
2115 ;; Convert horizontal rules
2116 (goto-char (point-min))
2117 (while (re-search-forward "^----+.$" nil t
)
2119 (replace-match (org-export-latex-protect-string "\\hrule") t t
)))
2121 ;; Protect LaTeX commands like \command[...]{...} or \command{...}
2122 (goto-char (point-min))
2124 "\\\\\\([a-zA-Z]+\\)"
2125 "\\(?:<[^<>\n]*>\\)*"
2126 "\\(?:\\[[^][\n]*?\\]\\)*"
2127 "\\(?:<[^<>\n]*>\\)*"
2128 "\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
2129 (while (re-search-forward re nil t
)
2131 ;; check for comment line
2132 (save-excursion (goto-char (match-beginning 0))
2133 (org-in-indented-comment-line))
2134 ;; Check if this is a defined entity, so that is may need conversion
2135 (org-entity-get (match-string 1))
2137 (add-text-properties (match-beginning 0) (match-end 0)
2138 '(org-protected t
)))))
2140 ;; Special case for \nbsp
2141 (goto-char (point-min))
2142 (while (re-search-forward "\\\\nbsp\\({}\\|\\>\\)" nil t
)
2144 (replace-match (org-export-latex-protect-string "~"))))
2146 ;; Protect LaTeX entities
2147 (goto-char (point-min))
2148 (while (re-search-forward org-latex-entities-regexp nil t
)
2150 (add-text-properties (match-beginning 0) (match-end 0)
2151 '(org-protected t
))))
2153 ;; Replace radio links
2154 (goto-char (point-min))
2155 (while (re-search-forward
2156 (concat "<<<?" org-export-latex-all-targets-re
2157 ">>>?\\((INVISIBLE)\\)?") nil t
)
2158 (org-if-unprotected-at (+ (match-beginning 0) 2)
2161 (org-export-latex-protect-string
2162 (format "\\label{%s}" (save-match-data (org-solidify-link-text
2163 (match-string 1)))))
2164 (if (match-string 2) "" (match-string 1)))
2167 ;; Delete @<...> constructs
2168 ;; Thanks to Daniel Clemente for this regexp
2169 (goto-char (point-min))
2170 (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t
)
2172 (replace-match "")))
2174 ;; When converting to LaTeX, replace footnotes
2175 ;; FIXME: don't protect footnotes from conversion
2176 (when (plist-get org-export-latex-options-plist
:footnotes
)
2177 (goto-char (point-min))
2178 (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t
)
2180 (when (and (save-match-data
2181 (save-excursion (beginning-of-line)
2182 (looking-at "[^:|#]")))
2183 (not (org-in-verbatim-emphasis)))
2184 (let ((foot-beg (match-beginning 0))
2185 (foot-end (match-end 0))
2186 (foot-prefix (match-string 0))
2187 footnote footnote-rpl
)
2189 (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix
))
2191 (replace-match (org-export-latex-protect-string
2192 (concat "$^{" (match-string 1) "}$")))
2194 (let ((end (save-excursion
2195 (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t
)
2196 (match-beginning 0) (point-max)))))
2197 (setq footnote
(concat (org-trim (buffer-substring (point) end
))
2198 " ")) ; prevent last } being part of a link
2199 (delete-region (point) end
))
2200 (goto-char foot-beg
)
2201 (delete-region foot-beg foot-end
)
2202 (unless (null footnote
)
2203 (setq footnote-rpl
(format "\\footnote{%s}" footnote
))
2204 (add-text-properties 0 10 '(org-protected t
) footnote-rpl
)
2205 (add-text-properties (1- (length footnote-rpl
))
2206 (length footnote-rpl
)
2207 '(org-protected t
) footnote-rpl
)
2208 (if (org-on-heading-p)
2210 (concat (org-export-latex-protect-string "\\protect")
2212 (insert footnote-rpl
)))
2215 ;; Remove footnote section tag for LaTeX
2216 (goto-char (point-min))
2217 (while (re-search-forward
2218 (concat "^" footnote-section-tag-regexp
) nil t
)
2220 (replace-match "")))))
2222 (defun org-export-latex-fix-inputenc ()
2223 "Set the coding system in inputenc to what the buffer is."
2224 (let* ((cs buffer-file-coding-system
)
2225 (opt (or (ignore-errors (latexenc-coding-system-to-inputenc cs
))
2228 ;; Translate if that is requested
2229 (setq opt
(or (cdr (assoc opt org-export-latex-inputenc-alist
)) opt
))
2230 ;; find the \usepackage statement and replace the option
2231 (goto-char (point-min))
2232 (while (re-search-forward "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
2234 (goto-char (match-beginning 1))
2235 (delete-region (match-beginning 1) (match-end 1))
2237 (and buffer-file-name
2242 (defun org-export-latex-lists ()
2243 "Convert plain text lists in current buffer into LaTeX lists."
2245 (goto-char (point-min))
2246 (while (org-search-forward-unenclosed org-item-beginning-re nil t
)
2248 (setq res
(org-list-to-latex (org-list-parse-list t
)
2249 org-export-latex-list-parameters
))
2250 (while (string-match "^\\(\\\\item[ \t]+\\)\\[@\\(?:start:\\)?\\([0-9]+\\)\\]"
2252 (setq res
(replace-match
2253 (concat (format "\\setcounter{enumi}{%d}"
2254 (1- (string-to-number
2255 (match-string 2 res
))))
2257 (match-string 1 res
))
2259 (insert res
"\n"))))
2261 (defconst org-latex-entities
2290 "\\begin{description}"
2291 "\\begin{enumerate}"
2295 "\\begin{flushleft}"
2296 "\\begin{flushright}"
2301 "\\begin{quotation}"
2306 "\\begin{thebibliography}"
2308 "\\begin{titlepage}"
2435 "A list of LaTeX commands to be protected when performing conversion.")
2437 (defconst org-latex-entities-regexp
2439 (dolist (x org-latex-entities
)
2440 (if (string-match "[a-zA-Z]$" x
)
2443 (concat "\\(" (regexp-opt (nreverse names
)) "\\>\\)"
2444 "\\|\\(" (regexp-opt (nreverse rest
)) "\\)")))
2446 (provide 'org-export-latex
)
2447 (provide 'org-latex
)
2449 ;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
2451 ;;; org-latex.el ends here
