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-timestamp-markup
"\\textit{%s}"
284 "A printf format string to be applied to time stamps."
285 :group
'org-export-latex
288 (defcustom org-export-latex-timestamp-keyword-markup
"\\texttt{%s}"
289 "A printf format string to be applied to time stamps."
290 :group
'org-export-latex
293 (defcustom org-export-latex-hyperref-format
"\\href{%s}{%s}"
294 "A printf format string to be applied to hyperref links.
295 The format must contain two %s instances. The first will be filled with
296 the link, the second with the link description."
297 :group
'org-export-latex
300 (defcustom org-export-latex-tables-verbatim nil
301 "When non-nil, tables are exported verbatim."
302 :group
'org-export-latex
305 (defcustom org-export-latex-tables-centered t
306 "When non-nil, tables are exported in a center environment."
307 :group
'org-export-latex
310 (defcustom org-export-latex-tables-column-borders nil
311 "When non-nil, grouping columns can cause outer vertical lines in tables.
312 When nil, grouping causes only separation lines between groups."
313 :group
'org-export-latex
316 (defcustom org-export-latex-low-levels
'itemize
317 "How to convert sections below the current level of sectioning.
318 This is specified by the `org-export-headline-levels' option or the
319 value of \"H:\" in Org's #+OPTION line.
321 This can be either nil (skip the sections), `description', `itemize',
322 or `enumerate' (convert the sections as the corresponding list type), or
323 a string to be used instead of \\section{%s}. In this latter case,
324 the %s stands here for the inserted headline and is mandatory.
326 It may also be a list of three string to define a user-defined environment
327 that should be used. The first string should be the like
328 \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
329 to two occurrences of %s for the title and a label, respectively. The third
330 string should be like \"\\end{itemize\"."
331 :group
'org-export-latex
332 :type
'(choice (const :tag
"Ignore" nil
)
333 (const :tag
"Convert as descriptive list" description
)
334 (const :tag
"Convert as itemized list" itemize
)
335 (const :tag
"Convert as enumerated list" enumerate
)
336 (list :tag
"User-defined environment"
337 :value
("\\begin{itemize}" "\\end{itemize}" "\\item %s")
338 (string :tag
"Start")
340 (string :tag
"item"))
341 (string :tag
"Use a section string" :value
"\\subparagraph{%s}")))
343 (defcustom org-export-latex-list-parameters
344 '(:cbon
"$\\boxtimes$" :cboff
"$\\Box$")
345 "Parameters for the LaTeX list exporter.
346 These parameters will be passed on to `org-list-to-latex', which in turn
347 will pass them (combined with the LaTeX default list parameters) to
348 `org-list-to-generic'."
349 :group
'org-export-latex
352 (defcustom org-export-latex-verbatim-wrap
353 '("\\begin{verbatim}\n" .
"\\end{verbatim}\n")
354 "Environment to be wrapped around a fixed-width section in LaTeX export.
355 This is a cons with two strings, to be added before and after the
358 Defaults to \\begin{verbatim} and \\end{verbatim}."
359 :group
'org-export-translation
360 :group
'org-export-latex
361 :type
'(cons (string :tag
"Open")
362 (string :tag
"Close")))
364 (defcustom org-export-latex-listings nil
365 "Non-nil means export source code using the listings package.
366 This package will fontify source code, possibly even with color.
367 If you want to use this, you also need to make LaTeX use the
368 listings package, and if you want to have color, the color
369 package. Just add these to `org-export-latex-packages-alist',
370 for example using customize, or with something like
373 (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
374 (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))"
375 :group
'org-export-latex
378 (defcustom org-export-latex-listings-langs
379 '((emacs-lisp "Lisp") (lisp "Lisp")
382 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
383 (html "HTML") (xml "XML")
384 (tex "TeX") (latex "TeX")
385 (shell-script "bash")
387 (ocaml "Caml") (caml "Caml")
388 (sql "SQL") (sqlite "sql"))
389 "Alist mapping languages to their listing language counterpart.
390 The key is a symbol, the major mode symbol without the \"-mode\".
391 The value is the string that should be inserted as the language parameter
392 for the listings package. If the mode name and the listings name are
393 the same, the language does not need an entry in this list - but it does not
394 hurt if it is present."
395 :group
'org-export-latex
398 (symbol :tag
"Major mode ")
399 (string :tag
"Listings language"))))
401 (defcustom org-export-latex-listings-w-names t
402 "Non-nil means export names of named code blocks.
403 Code blocks exported with the listings package (controlled by the
404 `org-export-latex-listings' variable) can be named in the style
406 :group
'org-export-latex
409 (defcustom org-export-latex-remove-from-headlines
410 '(:todo nil
:priority nil
:tags nil
)
411 "A plist of keywords to remove from headlines. OBSOLETE.
412 Non-nil means remove this keyword type from the headline.
414 Don't remove the keys, just change their values.
416 Obsolete, this variable is no longer used. Use the separate
417 variables `org-export-with-todo-keywords', `org-export-with-priority',
418 and `org-export-with-tags' instead."
420 :group
'org-export-latex
)
422 (defcustom org-export-latex-image-default-option
"width=10em"
423 "Default option for images."
424 :group
'org-export-latex
427 (defcustom org-export-latex-tabular-environment
"tabular"
428 "Default environment used to build tables."
429 :group
'org-export-latex
432 (defcustom org-export-latex-inline-image-extensions
433 '("pdf" "jpeg" "jpg" "png" "ps" "eps")
434 "Extensions of image files that can be inlined into LaTeX.
435 Note that the image extension *actually* allowed depend on the way the
436 LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
437 are OK. When processing through dvi to Postscript, only ps and eps are
438 allowed. The default we use here encompasses both."
439 :group
'org-export-latex
440 :type
'(repeat (string :tag
"Extension")))
442 (defcustom org-export-latex-coding-system nil
443 "Coding system for the exported LaTeX file."
444 :group
'org-export-latex
445 :type
'coding-system
)
447 (defgroup org-export-pdf nil
448 "Options for exporting Org-mode files to PDF, via LaTeX."
449 :tag
"Org Export PDF"
450 :group
'org-export-latex
453 (defcustom org-latex-to-pdf-process
454 '("pdflatex -interaction nonstopmode %s"
455 "pdflatex -interaction nonstopmode %s")
456 "Commands to process a LaTeX file to a PDF file.
457 This is a list of strings, each of them will be given to the shell
458 as a command. %s in the command will be replaced by the full file name, %b
459 by the file base name (i.e. without extension).
460 The reason why this is a list is that it usually takes several runs of
461 pdflatex, maybe mixed with a call to bibtex. Org does not have a clever
462 mechanism to detect which of these commands have to be run to get to a stable
463 result, and it also does not do any error checking.
465 Alternatively, this may be a Lisp function that does the processing, so you
466 could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
467 This function should accept the file name as its single argument."
468 :group
'org-export-pdf
469 :type
'(choice (repeat :tag
"Shell command sequence"
470 (string :tag
"Shell command"))
473 (defcustom org-export-pdf-logfiles
474 '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
475 "The list of file extensions to consider as LaTeX logfiles."
476 :group
'org-export-pdf
477 :type
'(repeat (string :tag
"Extension")))
479 (defcustom org-export-pdf-remove-logfiles t
480 "Non-nil means remove the logfiles produced by PDF production.
481 These are the .aux, .log, .out, and .toc files."
482 :group
'org-export-pdf
487 (defvar org-export-latex-after-initial-vars-hook nil
488 "Hook run before LaTeX export.
489 The exact moment is after the initial variables like org-export-latex-class
490 have been determined from the environment.")
492 (defvar org-export-latex-after-blockquotes-hook nil
493 "Hook run during LaTeX export, after blockquote, verse, center are done.")
495 (defvar org-export-latex-final-hook nil
496 "Hook run in the finalized LaTeX buffer.")
498 (defvar org-export-latex-after-save-hook nil
499 "Hook run in the finalized LaTeX buffer, after it has been saved.")
501 ;;; Autoload functions:
504 (defun org-export-as-latex-batch ()
505 "Call `org-export-as-latex', may be used in batch processing.
509 --load=$HOME/lib/emacs/org.el
510 --eval \"(setq org-export-headline-levels 2)\"
511 --visit=MyFile --funcall org-export-as-latex-batch"
512 (org-export-as-latex org-export-headline-levels
'hidden
))
515 (defun org-export-as-latex-to-buffer (arg)
516 "Call `org-export-as-latex` with output to a temporary buffer.
517 No file is created. The prefix ARG is passed through to `org-export-as-latex'."
519 (org-export-as-latex arg nil nil
"*Org LaTeX Export*")
520 (when org-export-show-temporary-export-buffer
521 (switch-to-buffer-other-window "*Org LaTeX Export*")))
524 (defun org-replace-region-by-latex (beg end
)
525 "Replace the region from BEG to END with its LaTeX export.
526 It assumes the region has `org-mode' syntax, and then convert it to
527 LaTeX. This can be used in any buffer. For example, you could
528 write an itemized list in `org-mode' syntax in an LaTeX buffer and
529 then use this command to convert it."
532 (save-window-excursion
534 (setq latex
(org-export-region-as-latex
536 (setq reg
(buffer-substring beg end
)
537 buf
(get-buffer-create "*Org tmp*"))
538 (with-current-buffer buf
542 (setq latex
(org-export-region-as-latex
543 (point-min) (point-max) t
'string
)))
545 (delete-region beg end
)
549 (defun org-export-region-as-latex (beg end
&optional body-only buffer
)
550 "Convert region from BEG to END in `org-mode' buffer to LaTeX.
551 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
552 contents, and only produce the region of converted text, useful for
553 cut-and-paste operations.
554 If BUFFER is a buffer or a string, use/create that buffer as a target
555 of the converted LaTeX. If BUFFER is the symbol `string', return the
556 produced LaTeX as a string and leave no buffer behind. For example,
557 a Lisp program could call this function in the following way:
559 (setq latex (org-export-region-as-latex beg end t 'string))
561 When called interactively, the output buffer is selected, and shown
562 in a window. A non-interactive call will only return the buffer."
564 (when (interactive-p)
565 (setq buffer
"*Org LaTeX Export*"))
566 (let ((transient-mark-mode t
) (zmacs-regions t
)
568 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
570 (set-mark (point)) ;; to activate the region
572 (setq rtn
(org-export-as-latex
575 (if (fboundp 'deactivate-mark
) (deactivate-mark))
576 (if (and (interactive-p) (bufferp rtn
))
577 (switch-to-buffer-other-window rtn
)
581 (defun org-export-as-latex (arg &optional hidden ext-plist
582 to-buffer body-only pub-dir
)
583 "Export current buffer to a LaTeX file.
584 If there is an active region, export only the region. The prefix
585 ARG specifies how many levels of the outline should become
586 headlines. The default is 3. Lower levels will be exported
587 depending on `org-export-latex-low-levels'. The default is to
588 convert them as description lists.
589 HIDDEN is obsolete and does nothing.
590 EXT-PLIST is a property list with
591 external parameters overriding org-mode's default settings, but
592 still inferior to file-local settings. When TO-BUFFER is
593 non-nil, create a buffer with that name and export to that
594 buffer. If TO-BUFFER is the symbol `string', don't leave any
595 buffer behind but just return the resulting LaTeX as a string.
596 When BODY-ONLY is set, don't produce the file header and footer,
597 simply return the content of \\begin{document}...\\end{document},
598 without even the \\begin{document} and \\end{document} commands.
599 when PUB-DIR is set, use this as the publishing directory."
601 (when (and (not body-only
) arg
(listp arg
)) (setq body-only t
))
602 (run-hooks 'org-export-first-hook
)
604 ;; Make sure we have a file name when we need it.
605 (when (and (not (or to-buffer body-only
))
606 (not buffer-file-name
))
607 (if (buffer-base-buffer)
608 (org-set-local 'buffer-file-name
609 (with-current-buffer (buffer-base-buffer)
611 (error "Need a file name to be able to export")))
613 (message "Exporting to LaTeX...")
615 (let ((inhibit-read-only t
))
616 (remove-text-properties (point-min) (point-max)
617 '(:org-license-to-kill nil
))))
618 (org-update-radio-target-regexp)
619 (org-export-latex-set-initial-vars ext-plist arg
)
620 (setq org-export-opt-plist org-export-latex-options-plist
)
621 (org-install-letbind)
622 (run-hooks 'org-export-latex-after-initial-vars-hook
)
623 (let* ((wcf (current-window-configuration))
624 (opt-plist org-export-latex-options-plist
)
625 (region-p (org-region-active-p))
626 (rbeg (and region-p
(region-beginning)))
627 (rend (and region-p
(region-end)))
629 (if (plist-get opt-plist
:ignore-subtree-p
)
634 (and (org-at-heading-p)
635 (>= (org-end-of-subtree t t
) rend
))))))
636 (opt-plist (setq org-export-opt-plist
638 (org-export-add-subtree-options opt-plist rbeg
)
640 ;; Make sure the variable contains the updated values.
641 (org-export-latex-options-plist (setq org-export-opt-plist opt-plist
))
642 ;; The following two are dynamically scoped into other
644 (org-current-export-dir
645 (or pub-dir
(org-export-directory :html opt-plist
)))
646 (org-current-export-file buffer-file-name
)
647 (title (or (and subtree-p
(org-export-get-title-from-subtree))
648 (plist-get opt-plist
:title
)
650 (plist-get opt-plist
:skip-before-1st-heading
))
651 (org-export-grab-title-from-buffer))
652 (and buffer-file-name
653 (file-name-sans-extension
654 (file-name-nondirectory buffer-file-name
)))
659 (file-name-as-directory
661 (org-export-directory :LaTeX ext-plist
)))
662 (file-name-sans-extension
664 (org-entry-get rbeg
"EXPORT_FILE_NAME" t
))
665 (file-name-nondirectory ;sans-extension
667 (error "Don't know which export file to use")))))
671 (if (equal (file-truename filename
)
672 (file-truename (or buffer-file-name
"dummy.org")))
673 (concat filename
".tex")
675 (buffer (if to-buffer
677 ((eq to-buffer
'string
) (get-buffer-create
678 "*Org LaTeX Export*"))
679 (t (get-buffer-create to-buffer
)))
680 (find-file-noselect filename
)))
681 (odd org-odd-levels-only
)
682 (header (org-export-latex-make-header title opt-plist
))
683 (skip (cond (subtree-p nil
)
685 (t (plist-get opt-plist
:skip-before-1st-heading
))))
686 (text (plist-get opt-plist
:text
))
687 (org-export-preprocess-hook
689 `(lambda () (org-set-local 'org-complex-heading-regexp
690 ,org-export-latex-complex-heading-re
))
691 org-export-preprocess-hook
))
692 (first-lines (if skip
"" (org-export-latex-first-lines
699 (if region-p rend
))))
700 (coding-system (and (boundp 'buffer-file-coding-system
)
701 buffer-file-coding-system
))
702 (coding-system-for-write (or org-export-latex-coding-system
704 (save-buffer-coding-system (or org-export-latex-coding-system
706 (region (buffer-substring
707 (if region-p
(region-beginning) (point-min))
708 (if region-p
(region-end) (point-max))))
710 (and text
(string-match "\\S-" text
)
711 (org-export-preprocess-string
716 :tags
(plist-get opt-plist
:tags
)
717 :priority
(plist-get opt-plist
:priority
)
718 :footnotes
(plist-get opt-plist
:footnotes
)
719 :drawers
(plist-get opt-plist
:drawers
)
720 :timestamps
(plist-get opt-plist
:timestamps
)
721 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
723 :skip-before-1st-heading skip
726 :LaTeX-fragments nil
)))
728 (org-export-preprocess-string
733 :tags
(plist-get opt-plist
:tags
)
734 :priority
(plist-get opt-plist
:priority
)
735 :footnotes
(plist-get opt-plist
:footnotes
)
736 :drawers
(plist-get opt-plist
:drawers
)
737 :timestamps
(plist-get opt-plist
:timestamps
)
738 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
739 :add-text
(if (eq to-buffer
'string
) nil text
)
740 :skip-before-1st-heading skip
741 :select-tags
(plist-get opt-plist
:select-tags
)
742 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
743 :LaTeX-fragments nil
)))
747 (org-install-letbind)
749 (and (fboundp 'set-buffer-file-coding-system
)
750 (set-buffer-file-coding-system coding-system-for-write
))
752 ;; insert the header and initial document commands
753 (unless (or (eq to-buffer
'string
) body-only
)
756 ;; insert text found in #+TEXT
757 (when (and text
(not (eq to-buffer
'string
)))
758 (insert (org-export-latex-content
759 text
'(lists tables fixed-width keywords
))
762 ;; insert lines before the first headline
764 (insert first-lines
))
766 ;; export the content of headlines
767 (org-export-latex-global
769 (insert string-for-export
)
770 (goto-char (point-min))
771 (when (re-search-forward "^\\(\\*+\\) " nil t
)
772 (let* ((asters (length (match-string 1)))
773 (level (if odd
(- asters
2) (- asters
1))))
774 (setq org-export-latex-add-level
775 (if odd
(1- (/ (1+ asters
) 2)) (1- asters
)))
776 (org-export-latex-parse-global level odd
)))))
779 (unless body-only
(insert "\n\\end{document}"))
781 ;; Attach description terms to the \item macro
782 (goto-char (point-min))
783 (while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t
)
784 (delete-region (match-beginning 1) (match-end 1)))
786 ;; Relocate the table of contents
787 (goto-char (point-min))
788 (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t
)
789 (goto-char (point-min))
790 (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t
)
792 (goto-char (point-min))
793 (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t
)
794 (replace-match "\\tableofcontents" t t
)))
796 ;; Cleanup forced line ends in items where they are not needed
797 (goto-char (point-min))
798 (while (re-search-forward
799 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
801 (delete-region (match-beginning 1) (match-end 1)))
802 (goto-char (point-min))
803 (while (re-search-forward
804 "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
806 (if (looking-at "[\n \t]+")
807 (replace-match "\n")))
809 (run-hooks 'org-export-latex-final-hook
)
811 (unless (eq major-mode
'latex-mode
) (latex-mode))
813 (org-export-latex-fix-inputenc)
814 (run-hooks 'org-export-latex-after-save-hook
)
815 (goto-char (point-min))
816 (or (org-export-push-to-kill-ring "LaTeX")
817 (message "Exporting to LaTeX...done"))
819 (if (eq to-buffer
'string
)
820 (prog1 (buffer-substring (point-min) (point-max))
821 (kill-buffer (current-buffer)))
823 (set-window-configuration wcf
))))
826 (defun org-export-as-pdf (arg &optional hidden ext-plist
827 to-buffer body-only pub-dir
)
828 "Export as LaTeX, then process through to PDF."
830 (message "Exporting to PDF...")
831 (let* ((wconfig (current-window-configuration))
832 (lbuf (org-export-as-latex arg hidden ext-plist
833 to-buffer body-only pub-dir
))
834 (file (buffer-file-name lbuf
))
835 (base (file-name-sans-extension (buffer-file-name lbuf
)))
836 (pdffile (concat base
".pdf"))
837 (cmds org-latex-to-pdf-process
)
838 (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
839 (bibtex-p (with-current-buffer lbuf
841 (goto-char (point-min))
842 (re-search-forward "\\\\bibliography{" nil t
))))
844 (with-current-buffer outbuf
(erase-buffer))
845 (message "Processing LaTeX file...")
846 (if (and cmds
(symbolp cmds
))
847 (funcall cmds
(shell-quote-argument file
))
849 (setq cmd
(pop cmds
))
850 (while (string-match "%b" cmd
)
851 (setq cmd
(replace-match
853 (shell-quote-argument base
))
855 (while (string-match "%s" cmd
)
856 (setq cmd
(replace-match
858 (shell-quote-argument file
))
860 (shell-command cmd outbuf outbuf
)))
861 (message "Processing LaTeX file...done")
862 (if (not (file-exists-p pdffile
))
863 (error "PDF file was not produced")
864 (set-window-configuration wconfig
)
865 (when org-export-pdf-remove-logfiles
866 (dolist (ext org-export-pdf-logfiles
)
867 (setq file
(concat base
"." ext
))
868 (and (file-exists-p file
) (delete-file file
))))
869 (message "Exporting to PDF...done")
873 (defun org-export-as-pdf-and-open (arg)
874 "Export as LaTeX, then process through to PDF, and open."
876 (let ((pdffile (org-export-as-pdf arg
)))
879 (org-open-file pdffile
)
880 (when org-export-kill-product-buffer-when-displayed
881 (kill-buffer (find-buffer-visiting
882 (concat (file-name-sans-extension (buffer-file-name))
884 (error "PDF file was not produced"))))
886 ;;; Parsing functions:
888 (defun org-export-latex-parse-global (level odd
)
889 "Parse the current buffer recursively, starting at LEVEL.
890 If ODD is non-nil, assume the buffer only contains odd sections.
891 Return a list reflecting the document structure."
893 (goto-char (point-min))
894 (let* ((cnt 0) output
895 (depth org-export-latex-sectioning-depth
))
896 (while (org-re-search-forward-unprotected
897 (concat "^\\(\\(?:\\*\\)\\{"
898 (number-to-string (+ (if odd
2 1) level
))
900 ;; make sure that there is no upper heading
904 (org-re-search-forward-unprotected
905 (concat "^\\(\\(?:\\*\\)\\{"
906 (number-to-string level
)
907 "\\}\\) \\(.*\\)$") nil t
)))) t
)
909 (let* ((pos (match-beginning 0))
910 (heading (match-string 2))
911 (nlevel (if odd
(/ (+ 3 level
) 2) (1+ level
))))
916 (if (org-re-search-forward-unprotected
917 (concat "^\\(\\(?:\\*\\)\\{"
918 (number-to-string (+ (if odd
2 1) level
))
919 "\\}\\) \\(.*\\)$") nil t
)
922 (goto-char (point-min))
930 `(heading .
,heading
)
931 `(content .
,(org-export-latex-parse-content))
932 `(subcontent .
,(org-export-latex-parse-subcontent
937 (defun org-export-latex-parse-content ()
938 "Extract the content of a section."
940 (end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t
)
941 (progn (beginning-of-line) (point))
943 (buffer-substring beg end
)))
945 (defun org-export-latex-parse-subcontent (level odd
)
946 "Extract the subcontent of a section at LEVEL.
947 If ODD Is non-nil, assume subcontent only contains odd sections."
948 (if (not (org-re-search-forward-unprotected
949 (concat "^\\(\\(?:\\*\\)\\{"
950 (number-to-string (+ (if odd
4 2) level
))
953 nil
; subcontent is nil
954 (org-export-latex-parse-global (+ (if odd
2 1) level
) odd
)))
956 ;;; Rendering functions:
957 (defun org-export-latex-global (content)
958 "Export CONTENT to LaTeX.
959 CONTENT is an element of the list produced by
960 `org-export-latex-parse-global'."
961 (if (eq (car content
) 'subcontent
)
962 (mapc 'org-export-latex-sub
(cdr content
))
963 (org-export-latex-sub (car content
))))
965 (defun org-export-latex-sub (subcontent)
966 "Export the list SUBCONTENT to LaTeX.
967 SUBCONTENT is an alist containing information about the headline
969 (let ((num (plist-get org-export-latex-options-plist
:section-numbers
)))
970 (mapc (lambda(x) (org-export-latex-subcontent x num
)) subcontent
)))
972 (defun org-export-latex-subcontent (subcontent num
)
973 "Export each cell of SUBCONTENT to LaTeX.
974 If NUM, export sections as numerical sections."
975 (let* ((heading (cdr (assoc 'heading subcontent
)))
976 (level (- (cdr (assoc 'level subcontent
))
977 org-export-latex-add-level
))
978 (occur (number-to-string (cdr (assoc 'occur subcontent
))))
979 (content (cdr (assoc 'content subcontent
)))
980 (subcontent (cadr (assoc 'subcontent subcontent
)))
981 (label (org-get-text-property-any 0 'target heading
))
982 (label-list (cons label
(cdr (assoc label
983 org-export-target-aliases
))))
984 (sectioning org-export-latex-sectioning
)
985 (depth org-export-latex-sectioning-depth
)
986 main-heading sub-heading
)
987 (when (symbolp (car sectioning
))
988 (setq sectioning
(funcall (car sectioning
) level heading
))
990 (setq heading
(car sectioning
)
991 sectioning
(cdr sectioning
)
992 ;; target property migh have changed...
993 label
(org-get-text-property-any 0 'target heading
)
994 label-list
(cons label
(cdr (assoc label
995 org-export-target-aliases
)))))
996 (if sectioning
(setq sectioning
(make-list 10 sectioning
)))
997 (setq depth
(if sectioning
10000 0)))
998 (if (string-match "[ \t]*\\\\\\\\[ \t]*" heading
)
999 (setq main-heading
(substring heading
0 (match-beginning 0))
1000 sub-heading
(substring heading
(match-end 0))))
1001 (setq heading
(org-export-latex-fontify-headline heading
)
1002 sub-heading
(and sub-heading
1003 (org-export-latex-fontify-headline sub-heading
))
1004 main-heading
(and main-heading
1005 (org-export-latex-fontify-headline main-heading
)))
1007 ;; Normal conversion
1009 (let* ((sec (nth (1- level
) sectioning
))
1011 (if (consp (cdr sec
))
1012 (setq start
(nth (if num
0 2) sec
)
1013 end
(nth (if num
1 3) sec
))
1014 (setq start
(if num
(car sec
) (cdr sec
))))
1015 (insert (format start
(if main-heading main-heading heading
)
1016 (or sub-heading
"")))
1019 (insert (mapconcat (lambda (l) (format "\\label{%s}" l
))
1020 label-list
"\n") "\n"))
1021 (insert (org-export-latex-content content
))
1022 (cond ((stringp subcontent
) (insert subcontent
))
1024 (while (org-looking-back "\n\n") (backward-delete-char 1))
1025 (org-export-latex-sub subcontent
)))
1026 (when (and end
(string-match "[^ \t]" end
))
1027 (let ((hook (org-get-text-property-any 0 'org-insert-hook end
)))
1028 (and (functionp hook
) (funcall hook
)))
1029 (insert end
"\n"))))
1030 ;; At a level under the hl option: we can drop this subsection
1032 (cond ((eq org-export-latex-low-levels
'description
)
1033 (if (string-match "% ends low level$"
1034 (buffer-substring (point-at-bol 0) (point)))
1035 (delete-region (point-at-bol 0) (point))
1036 (insert "\\begin{description}\n"))
1037 (insert (format "\n\\item[%s]%s~\n"
1039 (if label
(format "\\label{%s}" label
) "")))
1040 (insert (org-export-latex-content content
))
1041 (cond ((stringp subcontent
) (insert subcontent
))
1042 ((listp subcontent
) (org-export-latex-sub subcontent
)))
1043 (insert "\\end{description} % ends low level\n"))
1044 ((memq org-export-latex-low-levels
'(itemize enumerate
))
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 (format "\\begin{%s}\n"
1049 (symbol-name org-export-latex-low-levels
))))
1050 (insert (format "\n\\item %s\\\\\n%s%%"
1052 (if label
(format "\\label{%s}" label
) "")))
1053 (insert (org-export-latex-content content
))
1054 (cond ((stringp subcontent
) (insert subcontent
))
1055 ((listp subcontent
) (org-export-latex-sub subcontent
)))
1056 (insert (format "\\end{%s} %% ends low level\n"
1057 (symbol-name org-export-latex-low-levels
))))
1059 ((listp org-export-latex-low-levels
)
1060 (if (string-match "% ends low level$"
1061 (buffer-substring (point-at-bol 0) (point)))
1062 (delete-region (point-at-bol 0) (point))
1063 (insert (car org-export-latex-low-levels
) "\n"))
1064 (insert (format (nth 2 org-export-latex-low-levels
)
1066 (if label
(format "\\label{%s}" label
) "")))
1067 (insert (org-export-latex-content content
))
1068 (cond ((stringp subcontent
) (insert subcontent
))
1069 ((listp subcontent
) (org-export-latex-sub subcontent
)))
1070 (insert (nth 1 org-export-latex-low-levels
)
1071 " %% ends low level\n"))
1073 ((stringp org-export-latex-low-levels
)
1074 (insert (format org-export-latex-low-levels heading
) "\n")
1075 (when label
(insert (format "\\label{%s}\n" label
)))
1076 (insert (org-export-latex-content content
))
1077 (cond ((stringp subcontent
) (insert subcontent
))
1078 ((listp subcontent
) (org-export-latex-sub subcontent
)))))))))
1080 ;;; Exporting internals:
1081 (defun org-export-latex-set-initial-vars (ext-plist level
)
1082 "Store org local variables required for LaTeX export.
1083 EXT-PLIST is an optional additional plist.
1084 LEVEL indicates the default depth for export."
1085 (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
1086 org-export-latex-done-keywords org-done-keywords
1087 org-export-latex-not-done-keywords org-not-done-keywords
1088 org-export-latex-complex-heading-re org-complex-heading-regexp
1089 org-export-latex-display-custom-times org-display-custom-times
1090 org-export-latex-all-targets-re
1091 (org-make-target-link-regexp (org-all-targets))
1092 org-export-latex-options-plist
1093 (org-combine-plists (org-default-export-plist) ext-plist
1094 (org-infile-export-plist))
1095 org-export-latex-class
1096 (or (and (org-region-active-p)
1098 (goto-char (region-beginning))
1099 (and (looking-at org-complex-heading-regexp
)
1100 (org-entry-get nil
"LaTeX_CLASS" 'selective
))))
1104 (goto-char (point-min))
1105 (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\(-[a-zA-Z]+\\)" nil t
)
1107 (plist-get org-export-latex-options-plist
:latex-class
)
1108 org-export-latex-default-class
)
1109 org-export-latex-class-options
1110 (or (and (org-region-active-p)
1112 (goto-char (region-beginning))
1113 (and (looking-at org-complex-heading-regexp
)
1114 (org-entry-get nil
"LaTeX_CLASS_OPTIONS" 'selective
))))
1118 (goto-char (point-min))
1119 (and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t
)
1121 (plist-get org-export-latex-options-plist
:latex-class-options
))
1122 org-export-latex-class
1123 (or (car (assoc org-export-latex-class org-export-latex-classes
))
1124 (error "No definition for class `%s' in `org-export-latex-classes'"
1125 org-export-latex-class
))
1126 org-export-latex-header
1127 (cadr (assoc org-export-latex-class org-export-latex-classes
))
1128 org-export-latex-sectioning
1129 (cddr (assoc org-export-latex-class org-export-latex-classes
))
1130 org-export-latex-sectioning-depth
1133 (plist-get org-export-latex-options-plist
:headline-levels
))
1134 (sec-depth (length org-export-latex-sectioning
)))
1135 (if (> hl-levels sec-depth
) sec-depth hl-levels
))))
1136 (when (and org-export-latex-class-options
1137 (string-match "\\S-" org-export-latex-class-options
)
1138 (string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
1139 org-export-latex-header
))
1140 (setq org-export-latex-header
1141 (concat (substring org-export-latex-header
0 (match-end 1))
1142 org-export-latex-class-options
1143 (substring org-export-latex-header
(match-end 0))))))
1145 (defvar org-export-latex-format-toc-function
1146 'org-export-latex-format-toc-default
1147 "The function formatting returning the string to create the table of contents.
1148 The function mus take one parameter, the depth of the table of contents.")
1150 (defun org-export-latex-make-header (title opt-plist
)
1151 "Make the LaTeX header and return it as a string.
1152 TITLE is the current title from the buffer or region.
1153 OPT-PLIST is the options plist for current buffer."
1154 (let ((toc (plist-get opt-plist
:table-of-contents
))
1155 (author (org-export-apply-macros-in-string
1156 (plist-get opt-plist
:author
))))
1158 (if (plist-get opt-plist
:time-stamp-file
)
1159 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1160 ;; insert LaTeX custom header and packages from the list
1161 (org-splice-latex-header
1162 (org-export-apply-macros-in-string org-export-latex-header
)
1163 org-export-latex-default-packages-alist
1164 org-export-latex-packages-alist nil
1165 (org-export-apply-macros-in-string
1166 (plist-get opt-plist
:latex-header-extra
)))
1167 ;; append another special variable
1168 (org-export-apply-macros-in-string org-export-latex-append-header
)
1169 ;; define align if not yet defined
1170 "\n\\providecommand{\\alert}[1]{\\textbf{#1}}"
1174 ;; convert the title
1175 (org-export-latex-content
1176 title
'(lists tables fixed-width keywords
)))
1177 ;; insert author info
1178 (if (plist-get opt-plist
:author-info
)
1179 (format "\\author{%s}\n"
1180 (org-export-latex-fontify-headline (or author user-full-name
)))
1181 (format "%%\\author{%s}\n"
1182 (org-export-latex-fontify-headline (or author user-full-name
))))
1184 (format "\\date{%s}\n"
1186 (or (plist-get opt-plist
:date
)
1187 org-export-latex-date-format
)))
1188 ;; beginning of the document
1189 "\n\\begin{document}\n\n"
1190 ;; insert the title command
1191 (when (string-match "\\S-" title
)
1192 (if (string-match "%s" org-export-latex-title-command
)
1193 (format org-export-latex-title-command title
)
1194 org-export-latex-title-command
))
1196 ;; table of contents
1197 (when (and org-export-with-toc
1198 (plist-get opt-plist
:section-numbers
))
1199 (funcall org-export-latex-format-toc-function
1200 (cond ((numberp toc
)
1201 (min toc
(plist-get opt-plist
:headline-levels
)))
1202 (toc (plist-get opt-plist
:headline-levels
))))))))
1204 (defun org-export-latex-format-toc-default (depth)
1206 (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
1209 (defun org-export-latex-first-lines (opt-plist &optional beg end
)
1210 "Export the first lines before first headline.
1211 If BEG is non-nil, it is the beginning of the region.
1212 If END is non-nil, it is the end of the region."
1214 (goto-char (or beg
(point-min)))
1216 (end (if (re-search-forward "^\\*+ " end t
)
1217 (goto-char (match-beginning 0))
1218 (goto-char (or end
(point-max))))))
1220 (org-export-latex-content
1221 (org-export-preprocess-string
1222 (buffer-substring pt end
)
1227 :skip-before-1st-heading nil
1228 :LaTeX-fragments nil
1229 :timestamps
(plist-get opt-plist
:timestamps
)
1230 :footnotes
(plist-get opt-plist
:footnotes
)))
1232 (let ((inhibit-read-only t
)
1233 (limit (max pt
(1- end
))))
1234 (add-text-properties pt limit
1235 '(:org-license-to-kill t
))
1238 (while (re-search-forward "^[ \t]*#+.*\n?" limit t
)
1239 (remove-text-properties (match-beginning 0) (match-end 0)
1240 '(:org-license-to-kill t
))))))))))
1243 (defvar org-export-latex-header-defs nil
1244 "The header definitions that might be used in the LaTeX body.")
1245 (defvar org-export-latex-header-defs-re nil
1246 "The header definitions that might be used in the LaTeX body.")
1248 (defun org-export-latex-content (content &optional exclude-list
)
1249 "Convert CONTENT string to LaTeX.
1250 Don't perform conversions that are in EXCLUDE-LIST. Recognized
1251 conversion types are: quotation-marks, emphasis, sub-superscript,
1252 links, keywords, lists, tables, fixed-width"
1255 (unless (memq 'timestamps exclude-list
)
1256 (org-export-latex-time-stamps))
1257 (unless (memq 'quotation-marks exclude-list
)
1258 (org-export-latex-quotation-marks))
1259 (unless (memq 'emphasis exclude-list
)
1260 (when (plist-get org-export-latex-options-plist
:emphasize
)
1261 (org-export-latex-fontify)))
1262 (unless (memq 'sub-superscript exclude-list
)
1263 (org-export-latex-special-chars
1264 (plist-get org-export-latex-options-plist
:sub-superscript
)))
1265 (unless (memq 'links exclude-list
)
1266 (org-export-latex-links))
1267 (unless (memq 'keywords exclude-list
)
1268 (org-export-latex-keywords))
1269 (unless (memq 'lists exclude-list
)
1270 (org-export-latex-lists))
1271 (unless (memq 'tables exclude-list
)
1272 (org-export-latex-tables
1273 (plist-get org-export-latex-options-plist
:tables
)))
1274 (unless (memq 'fixed-width exclude-list
)
1275 (org-export-latex-fixed-width
1276 (plist-get org-export-latex-options-plist
:fixed-width
)))
1278 (buffer-substring (point-min) (point-max))))
1280 (defun org-export-latex-protect-string (s)
1281 "Add the org-protected property to string S."
1282 (add-text-properties 0 (length s
) '(org-protected t
) s
) s
)
1284 (defun org-export-latex-protect-char-in-string (char-list string
)
1285 "Add org-protected text-property to char from CHAR-LIST in STRING."
1289 (goto-char (point-min))
1290 (while (re-search-forward (regexp-opt char-list
) nil t
)
1291 (add-text-properties (match-beginning 0)
1292 (match-end 0) '(org-protected t
)))
1295 (defun org-export-latex-keywords-maybe (&optional remove-list
)
1296 "Maybe remove keywords depending on rules in REMOVE-LIST."
1297 (goto-char (point-min))
1298 (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1
"\\|"))
1299 (case-fold-search nil
)
1300 (todo-markup org-export-latex-todo-keyword-markup
)
1302 ;; convert TODO keywords
1303 (when (re-search-forward (concat "^\\(" re-todo
"\\)") nil t
)
1304 (if (plist-get remove-list
:todo
)
1307 ((stringp todo-markup
) todo-markup
)
1308 ((and (consp todo-markup
) (stringp (car todo-markup
)))
1309 (if (member (match-string 1) org-export-latex-done-keywords
)
1310 (cdr todo-markup
) (car todo-markup
)))
1311 (t (cdr (or (assoc (match-string 1) todo-markup
)
1312 (car todo-markup
))))))
1313 (replace-match (org-export-latex-protect-string
1314 (format fmt
(match-string 1))) t t
)))
1315 ;; convert priority string
1316 (when (re-search-forward "\\[\\\\#.\\]" nil t
)
1317 (if (plist-get remove-list
:priority
)
1319 (replace-match (format "\\textbf{%s}" (match-string 0)) t t
)))
1321 (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t
)
1322 (if (or (not org-export-with-tags
)
1323 (plist-get remove-list
:tags
))
1326 (org-export-latex-protect-string
1327 (format "\\textbf{%s}"
1329 (replace-regexp-in-string
1330 "_" "\\\\_" (match-string 0)))))
1333 (defun org-export-latex-fontify-headline (string)
1334 "Fontify special words in STRING."
1336 ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
1337 ;; the beginning of the buffer - inserting "\n" is safe here though.
1338 (insert "\n" string
)
1339 (goto-char (point-min))
1340 (let ((re (concat "\\\\\\([a-zA-Z]+\\)"
1341 "\\(?:<[^<>\n]*>\\)*"
1342 "\\(?:\\[[^][\n]*?\\]\\)*"
1343 "\\(?:<[^<>\n]*>\\)*"
1345 (org-create-multibrace-regexp "{" "}" 3)
1347 (while (re-search-forward re nil t
)
1349 ;; check for comment line
1350 (save-excursion (goto-char (match-beginning 0))
1351 (org-in-indented-comment-line))
1352 ;; Check if this is a defined entity, so that is may need conversion
1353 (org-entity-get (match-string 1)))
1354 (add-text-properties (match-beginning 0) (match-end 0)
1355 '(org-protected t
)))))
1356 (when (plist-get org-export-latex-options-plist
:emphasize
)
1357 (org-export-latex-fontify))
1358 (org-export-latex-keywords-maybe)
1359 (org-export-latex-special-chars
1360 (plist-get org-export-latex-options-plist
:sub-superscript
))
1361 (org-export-latex-links)
1362 (org-trim (buffer-string))))
1364 (defun org-export-latex-time-stamps ()
1365 "Format time stamps."
1366 (goto-char (point-min))
1367 (let ((org-display-custom-times org-export-latex-display-custom-times
))
1368 (while (re-search-forward org-ts-regexp-both nil t
)
1369 (org-if-unprotected-at (1- (point))
1371 (org-export-latex-protect-string
1372 (format org-export-latex-timestamp-markup
1373 (substring (org-translate-time (match-string 0)) 1 -
1)))
1376 (defun org-export-latex-quotation-marks ()
1377 "Export quotation marks depending on language conventions."
1378 (let* ((lang (plist-get org-export-latex-options-plist
:language
))
1379 (quote-rpl (if (equal lang
"fr")
1380 '(("\\(\\s-\\)\"" "«~")
1381 ("\\(\\S-\\)\"" "~»")
1382 ("\\(\\s-\\)'" "`"))
1383 '(("\\(\\s-\\|[[(]\\)\"" "``")
1384 ("\\(\\S-\\)\"" "''")
1385 ("\\(\\s-\\|(\\)'" "`")))))
1386 (mapc (lambda(l) (goto-char (point-min))
1387 (while (re-search-forward (car l
) nil t
)
1388 (let ((rpl (concat (match-string 1)
1389 (org-export-latex-protect-string
1390 (copy-sequence (cadr l
))))))
1391 (org-if-unprotected-1
1392 (replace-match rpl t t
))))) quote-rpl
)))
1394 (defun org-export-latex-special-chars (sub-superscript)
1395 "Export special characters to LaTeX.
1396 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
1397 See the `org-export-latex.el' code for a complete conversion table."
1398 (goto-char (point-min))
1400 (goto-char (point-min))
1401 (while (re-search-forward c nil t
)
1402 ;; Put the point where to check for org-protected
1403 (unless (get-text-property (match-beginning 2) 'org-protected
)
1404 (cond ((member (match-string 2) '("\\$" "$"))
1405 (if (equal (match-string 2) "\\$")
1407 (replace-match "\\$" t t
)))
1408 ((member (match-string 2) '("&" "%" "#"))
1409 (if (equal (match-string 1) "\\")
1410 (replace-match (match-string 2) t t
)
1411 (replace-match (concat (match-string 1) "\\"
1412 (match-string 2)) t t
)
1414 ((equal (match-string 2) "...")
1416 (concat (match-string 1)
1417 (org-export-latex-protect-string "\\ldots{}")) t t
))
1418 ((equal (match-string 2) "~")
1419 (cond ((equal (match-string 1) "\\") nil
)
1420 ((eq 'org-link
(get-text-property 0 'face
(match-string 2)))
1421 (replace-match (concat (match-string 1) "\\~") t t
))
1423 (org-export-latex-protect-string
1424 (concat (match-string 1) "\\~{}")) t t
))))
1425 ((member (match-string 2) '("{" "}"))
1426 (unless (save-match-data (org-inside-latex-math-p))
1427 (if (equal (match-string 1) "\\")
1428 (replace-match (match-string 2) t t
)
1429 (replace-match (concat (match-string 1) "\\"
1430 (match-string 2)) t t
)))))
1431 (unless (save-match-data (org-inside-latex-math-p))
1432 (cond ((equal (match-string 2) "\\")
1433 (replace-match (or (save-match-data
1434 (org-export-latex-treat-backslash-char
1436 (or (match-string 3) "")))
1438 (when (and (get-text-property (1- (point)) 'org-entity
)
1440 ;; OK, this was an entity replacement, and the user
1441 ;; had terminated the entity with {}. Make sure
1442 ;; {} is protected as well, and remove the extra {}
1443 ;; inserted by the conversion.
1444 (put-text-property (point) (+ 2 (point)) 'org-protected t
)
1445 (if (save-excursion (goto-char (max (- (point) 2) (point-min)))
1450 ((member (match-string 2) '("_" "^"))
1451 (replace-match (or (save-match-data
1452 (org-export-latex-treat-sub-super-char
1456 (match-string 3))) "") t t
)
1457 (backward-char 1)))))))
1458 '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
1459 "\\(\\(\\\\?\\$\\)\\)"
1460 "\\([a-zA-Z0-9()]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-zA-Z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-zA-Z0-9]+}\\|([a-zA-Z0-9]+)\\)"
1461 "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|\\([&#%{}\"]\\|[a-zA-Z][a-zA-Z0-9]*\\)\\)"
1462 "\\(.\\|^\\)\\(&\\)"
1463 "\\(.\\|^\\)\\(#\\)"
1464 "\\(.\\|^\\)\\(%\\)"
1465 "\\(.\\|^\\)\\({\\)"
1466 "\\(.\\|^\\)\\(}\\)"
1467 "\\(.\\|^\\)\\(~\\)"
1468 "\\(.\\|^\\)\\(\\.\\.\\.\\)"
1469 ;; (?\< . "\\textless{}")
1470 ;; (?\> . "\\textgreater{}")
1473 (defun org-inside-latex-math-p ()
1474 (get-text-property (point) 'org-latex-math
))
1476 (defun org-export-latex-treat-sub-super-char
1477 (subsup char string-before string-after
)
1478 "Convert the \"_\" and \"^\" characters to LaTeX.
1479 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
1480 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
1481 (cond ((equal string-before
"\\")
1482 (concat string-before char string-after
))
1483 ((and (string-match "\\S-+" string-after
))
1484 ;; this is part of a math formula
1485 (cond ((eq 'org-link
(get-text-property 0 'face char
))
1486 (concat string-before
"\\" char string-after
))
1487 ((save-match-data (org-inside-latex-math-p))
1489 (cond ((eq 1 (length string-after
))
1490 (concat string-before char string-after
))
1491 ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after
)
1492 (format "%s%s{%s}" string-before char
1493 (match-string 1 string-after
))))))
1494 ((and (> (length string-after
) 1)
1496 (and (equal subsup
'{}) (eq (string-to-char string-after
) ?\
{)))
1497 (or (string-match "[{]?\\([^}]+\\)[}]?" string-after
)
1498 (string-match "[(]?\\([^)]+\\)[)]?" string-after
)))
1500 (org-export-latex-protect-string
1501 (format "%s$%s{%s}$" string-before char
1502 (if (and (> (match-end 1) (1+ (match-beginning 1)))
1503 (not (equal (substring string-after
0 2) "{\\")))
1504 (concat "\\mathrm{" (match-string 1 string-after
) "}")
1505 (match-string 1 string-after
)))))
1506 ((eq subsup t
) (concat string-before
"$" char string-after
"$"))
1507 (t (org-export-latex-protect-string
1508 (concat string-before
"\\" char
"{}" string-after
)))))
1509 (t (org-export-latex-protect-string
1510 (concat string-before
"\\" char
"{}" string-after
)))))
1512 (defun org-export-latex-treat-backslash-char (string-before string-after
)
1513 "Convert the \"$\" special character to LaTeX.
1514 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
1515 (let ((ass (org-entity-get string-after
)))
1519 (concat string-before
1520 (org-export-latex-protect-string
1521 (concat "$" (nth 1 ass
) "$")))
1522 (concat string-before
(org-export-latex-protect-string
1525 ((and (not (string-match "^[ \n\t]" string-after
))
1526 (not (string-match "[ \t]\\'\\|^" string-before
)))
1527 ;; backslash is inside a word
1528 (concat string-before
1529 (org-export-latex-protect-string
1530 (concat "\\textbackslash{}" string-after
))))
1531 ((not (or (equal string-after
"")
1532 (string-match "^[ \t\n]" string-after
)))
1533 ;; backslash might escape a character (like \#) or a user TeX
1534 ;; macro (like \setcounter)
1535 (concat string-before
1536 (org-export-latex-protect-string (concat "\\" string-after
))))
1537 ((and (string-match "^[ \t\n]" string-after
)
1538 (string-match "[ \t\n]\\'" string-before
))
1539 ;; backslash is alone, convert it to $\backslash$
1540 (org-export-latex-protect-string
1541 (concat string-before
"\\textbackslash{}" string-after
)))
1542 (t (org-export-latex-protect-string
1543 (concat string-before
"\\textbackslash{}" string-after
))))))
1545 (defun org-export-latex-keywords ()
1546 "Convert special keywords to LaTeX."
1547 (goto-char (point-min))
1548 (while (re-search-forward org-export-latex-special-keyword-regexp nil t
)
1549 (replace-match (format org-export-latex-timestamp-keyword-markup
1550 (match-string 0)) t t
)
1552 (beginning-of-line 1)
1553 (unless (looking-at ".*\n[ \t]*\n")
1557 (defun org-export-latex-fixed-width (opt)
1558 "When OPT is non-nil convert fixed-width sections to LaTeX."
1559 (goto-char (point-min))
1560 (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t
)
1561 (unless (get-text-property (point) 'org-example
)
1563 (progn (goto-char (match-beginning 0))
1564 (insert "\\begin{verbatim}\n")
1565 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1566 (replace-match (concat (match-string 1)
1567 (match-string 2)) t t
)
1569 (insert "\\end{verbatim}\n\n"))
1570 (progn (goto-char (match-beginning 0))
1571 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1572 (replace-match (concat "%" (match-string 1)
1573 (match-string 2)) t t
)
1574 (forward-line)))))))
1576 (defvar org-table-last-alignment
) ; defined in org-table.el
1577 (defvar org-table-last-column-widths
) ; defined in org-table.el
1578 (declare-function orgtbl-to-latex
"org-table" (table params
) t
)
1579 (defun org-export-latex-tables (insert)
1580 "Convert tables to LaTeX and INSERT it."
1581 ;; First, get the table.el tables
1582 (goto-char (point-min))
1583 (while (re-search-forward "^[ \t]*\\(\\+-[-+]*\\+\\)[ \t]*\n[ \t]*|" nil t
)
1586 (org-export-latex-convert-table.el-table
)))
1588 ;; And now the Org-mode tables
1589 (goto-char (point-min))
1590 (while (re-search-forward "^\\([ \t]*\\)|" nil t
)
1591 (org-if-unprotected-at (1- (point))
1593 (let* ((beg (org-table-begin))
1594 (end (org-table-end))
1595 (raw-table (buffer-substring beg end
))
1596 (org-table-last-alignment (copy-sequence org-table-last-alignment
))
1597 (org-table-last-column-widths (copy-sequence
1598 org-table-last-column-widths
))
1599 fnum fields line lines olines gr colgropen line-fmt align
1600 caption shortn label attr floatp longtblp
)
1601 (if org-export-latex-tables-verbatim
1602 (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1603 "\\end{verbatim}\n")))
1604 (apply 'delete-region
(list beg end
))
1605 (insert (org-export-latex-protect-string tbl
)))
1607 (setq caption
(org-find-text-property-in-string
1608 'org-caption raw-table
)
1609 shortn
(org-find-text-property-in-string
1610 'org-caption-shortn raw-table
)
1611 attr
(org-find-text-property-in-string
1612 'org-attributes raw-table
)
1613 label
(org-find-text-property-in-string
1614 'org-label raw-table
)
1615 longtblp
(and attr
(stringp attr
)
1616 (string-match "\\<longtable\\>" attr
))
1617 align
(and attr
(stringp attr
)
1618 (string-match "\\<align=\\([^ \t\n\r]+\\)" attr
)
1619 (match-string 1 attr
))
1620 floatp
(or caption label
))
1621 (setq caption
(and caption
(org-export-latex-fontify-headline caption
)))
1622 (setq lines
(org-split-string raw-table
"\n"))
1623 (apply 'delete-region
(list beg end
))
1624 (when org-export-table-remove-special-lines
1625 (setq lines
(org-table-clean-before-export lines
'maybe-quoted
)))
1626 (when org-table-clean-did-remove-column
1627 (pop org-table-last-alignment
)
1628 (pop org-table-last-column-widths
))
1629 ;; make a formatting string to reflect alignment
1631 (while (and (not line-fmt
) (setq line
(pop olines
)))
1632 (unless (string-match "^[ \t]*|-" line
)
1633 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1634 (setq fnum
(make-vector (length fields
) 0))
1638 (setq gr
(pop org-table-colgroup-info
))
1640 (cond ((eq gr
:start
)
1641 (prog1 (if colgropen
"|" "|")
1642 (setq colgropen t
)))
1644 (prog1 (if colgropen
"|" "|")
1645 (setq colgropen nil
)))
1647 (if (memq gr
'(:end
:startend
))
1648 (progn (setq colgropen nil
) "|")
1651 ;; fix double || in line-fmt
1652 (setq line-fmt
(replace-regexp-in-string "||" "|" line-fmt
))
1653 ;; maybe remove the first and last "|"
1654 (when (and (not org-export-latex-tables-column-borders
)
1655 (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt
))
1656 (setq line-fmt
(match-string 2 line-fmt
)))
1659 (setq align
(apply 'format
1661 (mapcar (lambda (x) (if x
"r" "l"))
1662 org-table-last-alignment
)))))
1663 ;; prepare the table to send to orgtbl-to-latex
1667 (or (and (string-match "[ \t]*|-+" elem
) 'hline
)
1668 (org-split-string (org-trim elem
) "|")))
1671 (insert (org-export-latex-protect-string
1674 (concat "\\begin{longtable}{" align
"}\n")
1675 (if floatp
"\\begin{table}[htb]\n"))
1679 (if shortn
(concat "[" shortn
"]") "")
1681 (if (and longtblp caption
) "\\\\\n" "\n")
1682 (if (and org-export-latex-tables-centered
(not longtblp
))
1683 "\\begin{center}\n")
1685 (format "\\begin{%s}{%s}\n"
1686 org-export-latex-tabular-environment align
))
1689 `(:tstart nil
:tend nil
1690 :hlend
,(if longtblp
1694 \\hline\\multicolumn{%d}{r}{Continued on next page}\\
1696 \\endlastfoot" (length org-table-last-alignment
))
1699 (format "\n\\end{%s}"
1700 org-export-latex-tabular-environment
))
1701 (if longtblp
"\n" (if org-export-latex-tables-centered
1702 "\n\\end{center}\n" "\n"))
1705 (if floatp
"\\end{table}"))))
1708 (defun org-export-latex-convert-table.el-table
()
1709 "Replace table.el table at point with LaTeX code."
1710 (let (tbl caption shortn label line floatp attr align rmlines
)
1711 (setq line
(buffer-substring (point-at-bol) (point-at-eol))
1712 label
(org-get-text-property-any 0 'org-label line
)
1713 caption
(org-get-text-property-any 0 'org-caption line
)
1714 shortn
(org-get-text-property-any 0 'org-caption-shortn line
)
1715 attr
(org-get-text-property-any 0 'org-attributes line
)
1716 align
(and attr
(stringp attr
)
1717 (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr
)
1718 (match-string 1 attr
))
1719 rmlines
(and attr
(stringp attr
)
1720 (string-match "\\<rmlines\\>" attr
))
1721 floatp
(or label caption
))
1722 (and (get-buffer "*org-export-table*")
1723 (kill-buffer (get-buffer "*org-export-table*")))
1724 (table-generate-source 'latex
"*org-export-table*" "caption")
1725 (setq tbl
(with-current-buffer "*org-export-table*"
1727 (while (string-match "^%.*\n" tbl
)
1728 (setq tbl
(replace-match "" t t tbl
)))
1732 (setq lines
(mapcar (lambda (x)
1733 (if (string-match "^\\\\hline$" x
)
1738 (org-split-string tbl
"\n")))
1739 (setq tbl
(mapconcat 'identity
(delq nil lines
) "\n"))))
1740 (when (and align
(string-match "\\\\begin{tabular}{.*}" tbl
))
1741 (setq tbl
(replace-match (concat "\\begin{tabular}{" align
"}")
1743 (and (get-buffer "*org-export-table*")
1744 (kill-buffer (get-buffer "*org-export-table*")))
1745 (beginning-of-line 0)
1746 (while (looking-at "[ \t]*\\(|\\|\\+-\\)")
1747 (delete-region (point) (1+ (point-at-eol))))
1748 (when org-export-latex-tables-centered
1749 (setq tbl
(concat "\\begin{center}\n" tbl
"\\end{center}")))
1751 (setq tbl
(concat "\\begin{table}\n"
1752 (format "\\caption%s{%s%s}\n"
1753 (if shortn
(format "[%s]" shortn
) "")
1754 (if label
(format "\\label{%s}" label
) "")
1757 "\n\\end{table}\n")))
1758 (insert (org-export-latex-protect-string tbl
))))
1760 (defun org-export-latex-fontify ()
1761 "Convert fontification to LaTeX."
1762 (goto-char (point-min))
1763 (while (re-search-forward org-emph-re nil t
)
1764 ;; The match goes one char after the *string*, except at the end of a line
1765 (let ((emph (assoc (match-string 3)
1766 org-export-latex-emphasis-alist
))
1767 (beg (match-beginning 0))
1771 (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
1773 (unless (or (and (get-text-property (- (point) 2) 'org-protected
)
1774 (not (get-text-property
1775 (- (point) 2) 'org-verbatim-emph
)))
1776 (equal (char-after (match-beginning 3))
1777 (char-after (1+ (match-beginning 3))))
1779 (goto-char (match-beginning 1))
1781 (and (org-at-table-p)
1783 "[|\n]" (buffer-substring beg end
)))))
1784 (and (equal (match-string 3) "+")
1786 (string-match "\\`-+\\'" (match-string 4)))))
1787 (setq s
(match-string 4))
1788 (setq rpl
(concat (match-string 1)
1789 (org-export-latex-emph-format (cadr emph
)
1793 (setq rpl
(org-export-latex-protect-string rpl
))
1795 (if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl
)
1797 (add-text-properties (match-beginning 1) (match-end 1)
1798 '(org-protected t
) rpl
)
1799 (add-text-properties (match-beginning 3) (match-end 3)
1800 '(org-protected t
) rpl
)))))
1801 (replace-match rpl t t
)))
1804 (defvar org-export-latex-use-verb nil
)
1805 (defun org-export-latex-emph-format (format string
)
1806 "Format an emphasis string and handle the \\verb special case."
1807 (when (equal format
"\\verb")
1809 (if org-export-latex-use-verb
1810 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1812 (loop for i from
0 to
(1- (length ll
)) do
1813 (if (not (string-match (regexp-quote (substring ll i
(1+ i
)))
1816 (setq format
(concat "\\verb" (substring ll i
(1+ i
))
1817 "%s" (substring ll i
(1+ i
))))
1818 (throw 'exit nil
))))))
1820 (trans '(("\\" .
"\\textbackslash{}")
1821 ("~" .
"\\textasciitilde{}")
1822 ("^" .
"\\textasciicircum{}")))
1824 (while (string-match "[\\{}$%&_#~^]" string
)
1825 (setq char
(match-string 0 string
))
1826 (if (> (match-beginning 0) 0)
1827 (setq rtn
(concat rtn
(substring string
1828 0 (match-beginning 0)))))
1829 (setq string
(substring string
(1+ (match-beginning 0))))
1830 (setq char
(or (cdr (assoc char trans
)) (concat "\\" char
))
1831 rtn
(concat rtn char
)))
1832 (setq string
(concat rtn string
) format
"\\texttt{%s}")))))
1833 (format format string
))
1835 (defun org-export-latex-links ()
1836 ;; Make sure to use the LaTeX hyperref and graphicx package
1837 ;; or send some warnings.
1838 "Convert links to LaTeX."
1839 (goto-char (point-min))
1840 (while (re-search-forward org-bracket-link-analytic-regexp
++ nil t
)
1841 (org-if-unprotected-1
1842 (goto-char (match-beginning 0))
1843 (let* ((re-radio org-export-latex-all-targets-re
)
1844 (remove (list (match-beginning 0) (match-end 0)))
1845 (raw-path (org-extract-attributes (match-string 3)))
1846 (full-raw-path (concat (match-string 1) raw-path
))
1847 (desc (match-string 5))
1848 (type (or (match-string 2)
1849 (if (or (file-name-absolute-p raw-path
)
1850 (string-match "^\\.\\.?/" raw-path
))
1852 (coderefp (equal type
"coderef"))
1853 (caption (org-find-text-property-in-string 'org-caption raw-path
))
1854 (shortn (org-find-text-property-in-string 'org-caption-shortn raw-path
))
1855 (attr (or (org-find-text-property-in-string 'org-attributes raw-path
)
1856 (plist-get org-export-latex-options-plist
:latex-image-options
)))
1857 (label (org-find-text-property-in-string 'org-label raw-path
))
1859 ;; define the path of the link
1861 ((member type
'("coderef"))
1863 ((member type
'("http" "https" "ftp"))
1864 (concat type
":" raw-path
))
1865 ((and re-radio
(string-match re-radio raw-path
))
1867 ((equal type
"mailto")
1868 (concat type
":" raw-path
))
1869 ((equal type
"file")
1870 (if (and (org-file-image-p
1873 org-export-latex-inline-image-extensions
)
1874 (or (get-text-property 0 'org-no-description
1876 (equal desc full-raw-path
)))
1878 (progn (when (string-match "\\(.+\\)::.+" raw-path
)
1879 (setq raw-path
(match-string 1 raw-path
)))
1880 (if (file-exists-p raw-path
)
1881 (concat type
"://" (expand-file-name raw-path
))
1882 (concat type
"://" (org-export-directory
1883 :LaTeX org-export-latex-options-plist
)
1885 ;; process with link inserting
1886 (apply 'delete-region remove
)
1887 (setq caption
(and caption
(org-export-latex-fontify-headline caption
)))
1889 (plist-get org-export-latex-options-plist
:inline-images
))
1890 ;; OK, we need to inline an image
1892 (org-export-latex-format-image raw-path caption label attr shortn
)))
1895 (org-export-get-coderef-format path desc
)
1896 (cdr (assoc path org-export-code-refs
)))))
1897 (radiop (insert (format "\\hyperref[%s]{%s}"
1898 (org-solidify-link-text raw-path
) desc
)))
1900 (insert (format "\\hyperref[%s]{%s}"
1901 (org-remove-initial-hash
1902 (org-solidify-link-text raw-path
))
1905 (when (org-at-table-p)
1906 ;; There is a strange problem when we have a link in a table,
1907 ;; ampersands then cause a problem. I think this must be
1908 ;; a LaTeX issue, but we here implement a work-around anyway.
1909 (setq path
(org-export-latex-protect-amp path
)
1910 desc
(org-export-latex-protect-amp desc
)))
1911 (insert (format org-export-latex-hyperref-format path desc
)))
1913 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
1914 ;; The link protocol has a function for formatting the link
1917 (funcall fnc
(org-link-unescape raw-path
) desc
'latex
))))
1919 (t (insert "\\texttt{" desc
"}")))))))
1922 (defun org-export-latex-format-image (path caption label attr
&optional shortn
)
1923 "Format the image element, depending on user settings."
1924 (let (ind floatp wrapp multicolumnp placement figenv
)
1925 (setq floatp
(or caption label
))
1926 (setq ind
(org-get-text-property-any 0 'original-indentation path
))
1927 (when (and attr
(stringp attr
))
1928 (if (string-match "[ \t]*\\<wrap\\>" attr
)
1929 (setq wrapp t floatp nil attr
(replace-match "" t t attr
)))
1930 (if (string-match "[ \t]*\\<float\\>" attr
)
1931 (setq wrapp nil floatp t attr
(replace-match "" t t attr
)))
1932 (if (string-match "[ \t]*\\<multicolumn\\>" attr
)
1933 (setq multicolumnp t attr
(replace-match "" t t attr
))))
1937 (wrapp "{l}{0.5\\textwidth}")
1941 (when (and attr
(stringp attr
)
1942 (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr
))
1943 (setq placement
(match-string 1 attr
)
1944 attr
(replace-match "" t t attr
)))
1945 (setq attr
(and attr
(org-trim attr
)))
1946 (when (or (not attr
) (= (length attr
) 0))
1947 (setq attr
(cond (floatp "width=0.7\\textwidth")
1948 (wrapp "width=0.48\\textwidth")
1952 (wrapp "\\begin{wrapfigure}%placement
1954 \\includegraphics[%attr]{%path}
1955 \\caption%shortn{%labelcmd%caption}
1957 (multicolumnp "\\begin{figure*}%placement
1959 \\includegraphics[%attr]{%path}
1960 \\caption{%labelcmd%caption}
1962 (floatp "\\begin{figure}%placement
1964 \\includegraphics[%attr]{%path}
1965 \\caption{%labelcmd%caption}
1967 (t "\\includegraphics[%attr]{%path}")))
1970 (setq figenv
(mapconcat 'identity
(split-string figenv
"\n")
1971 (save-excursion (beginning-of-line 1)
1972 (looking-at "[ \t]*")
1973 (concat "\n" (match-string 0)))))
1975 (if (and (not label
) (not caption
)
1976 (string-match "^\\\\caption{.*\n" figenv
))
1977 (setq figenv
(replace-match "" t t figenv
)))
1982 (if (file-name-absolute-p path
)
1983 (expand-file-name path
)
1986 (cons "shortn" (if shortn
(format "[%s]" shortn
) ""))
1987 (cons "labelcmd" (if label
(format "\\label{%s}"
1989 (cons "caption" (or caption
""))
1990 (cons "placement" (or placement
""))))
1991 nil
'original-indentation ind
)))
1993 (defun org-export-latex-protect-amp (s)
1994 (while (string-match "\\([^\\\\]\\)\\(&\\)" s
)
1995 (setq s
(replace-match (concat (match-string 1 s
) "\\" (match-string 2 s
))
1999 (defun org-remove-initial-hash (s)
2000 (if (string-match "\\`#" s
)
2003 (defvar org-latex-entities
) ; defined below
2004 (defvar org-latex-entities-regexp
) ; defined below
2006 (defun org-export-latex-preprocess (parameters)
2007 "Clean stuff in the LaTeX export."
2008 ;; Preserve line breaks
2009 (goto-char (point-min))
2010 (while (re-search-forward "\\\\\\\\" nil t
)
2011 (add-text-properties (match-beginning 0) (match-end 0)
2012 '(org-protected t
)))
2014 ;; Preserve latex environments
2015 (goto-char (point-min))
2016 (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t
)
2018 (let* ((start (progn (beginning-of-line) (point)))
2019 (end (and (re-search-forward
2020 (concat "^[ \t]*\\\\end{"
2021 (regexp-quote (match-string 1))
2025 (add-text-properties start end
'(org-protected t
))
2026 (goto-char (point-at-eol))))))
2028 ;; Preserve math snippets
2030 (let* ((matchers (plist-get org-format-latex-options
:matchers
))
2031 (re-list org-latex-regexps
)
2032 beg end re e m n block off
)
2033 ;; Check the different regular expressions
2034 (while (setq e
(pop re-list
))
2035 (setq m
(car e
) re
(nth 1 e
) n
(nth 2 e
)
2036 block
(if (nth 3 e
) "\n\n" ""))
2037 (setq off
(if (member m
'("$" "$1")) 1 0))
2038 (when (and (member m matchers
) (not (equal m
"begin")))
2039 (goto-char (point-min))
2040 (while (re-search-forward re nil t
)
2041 (setq beg
(+ (match-beginning 0) off
) end
(- (match-end 0) 0))
2042 (add-text-properties beg end
'(org-protected t org-latex-math t
))))))
2044 ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
2045 (goto-char (point-min))
2046 (let ((case-fold-search nil
))
2047 (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t
)
2048 (unless (eq (char-before (match-beginning 1)) ?
\\)
2049 (org-if-unprotected-1
2050 (replace-match (org-export-latex-protect-string
2051 (concat "\\" (match-string 1)
2054 ;; Convert blockquotes
2055 (goto-char (point-min))
2056 (while (search-forward "ORG-BLOCKQUOTE-START" nil t
)
2057 (org-replace-match-keep-properties "\\begin{quote}" t t
))
2058 (goto-char (point-min))
2059 (while (search-forward "ORG-BLOCKQUOTE-END" nil t
)
2060 (org-replace-match-keep-properties "\\end{quote}" t t
))
2063 (goto-char (point-min))
2064 (while (search-forward "ORG-VERSE-START" nil t
)
2065 (org-replace-match-keep-properties "\\begin{verse}" t t
)
2066 (beginning-of-line 2)
2067 (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
2068 (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
2069 (goto-char (match-end 1))
2070 (org-replace-match-keep-properties
2071 (org-export-latex-protect-string
2072 (concat "\\hspace*{1cm}" (match-string 2))) t t
)
2073 (beginning-of-line 1))
2074 (if (looking-at "[ \t]*$")
2075 (insert (org-export-latex-protect-string "\\vspace*{1em}"))
2076 (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
2079 (beginning-of-line 2))
2080 (and (looking-at "[ \t]*ORG-VERSE-END.*")
2081 (org-replace-match-keep-properties "\\end{verse}" t t
)))
2084 (goto-char (point-min))
2085 (while (search-forward "ORG-CENTER-START" nil t
)
2086 (org-replace-match-keep-properties "\\begin{center}" t t
))
2087 (goto-char (point-min))
2088 (while (search-forward "ORG-CENTER-END" nil t
)
2089 (org-replace-match-keep-properties "\\end{center}" t t
))
2091 (run-hooks 'org-export-latex-after-blockquotes-hook
)
2093 ;; Convert horizontal rules
2094 (goto-char (point-min))
2095 (while (re-search-forward "^----+.$" nil t
)
2097 (replace-match (org-export-latex-protect-string "\\hrule") t t
)))
2099 ;; Protect LaTeX commands like \command[...]{...} or \command{...}
2100 (goto-char (point-min))
2102 "\\\\\\([a-zA-Z]+\\)"
2103 "\\(?:<[^<>\n]*>\\)*"
2104 "\\(?:\\[[^][\n]*?\\]\\)*"
2105 "\\(?:<[^<>\n]*>\\)*"
2106 "\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
2107 (while (re-search-forward re nil t
)
2109 ;; check for comment line
2110 (save-excursion (goto-char (match-beginning 0))
2111 (org-in-indented-comment-line))
2112 ;; Check if this is a defined entity, so that is may need conversion
2113 (org-entity-get (match-string 1))
2115 (add-text-properties (match-beginning 0) (match-end 0)
2116 '(org-protected t
)))))
2118 ;; Special case for \nbsp
2119 (goto-char (point-min))
2120 (while (re-search-forward "\\\\nbsp\\({}\\|\\>\\)" nil t
)
2122 (replace-match (org-export-latex-protect-string "~"))))
2124 ;; Protect LaTeX entities
2125 (goto-char (point-min))
2126 (while (re-search-forward org-latex-entities-regexp nil t
)
2128 (add-text-properties (match-beginning 0) (match-end 0)
2129 '(org-protected t
))))
2131 ;; Replace radio links
2132 (goto-char (point-min))
2133 (while (re-search-forward
2134 (concat "<<<?" org-export-latex-all-targets-re
2135 ">>>?\\((INVISIBLE)\\)?") nil t
)
2136 (org-if-unprotected-at (+ (match-beginning 0) 2)
2139 (org-export-latex-protect-string
2140 (format "\\label{%s}" (save-match-data (org-solidify-link-text
2141 (match-string 1)))))
2142 (if (match-string 2) "" (match-string 1)))
2145 ;; Delete @<...> constructs
2146 ;; Thanks to Daniel Clemente for this regexp
2147 (goto-char (point-min))
2148 (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t
)
2150 (replace-match "")))
2152 ;; When converting to LaTeX, replace footnotes
2153 ;; FIXME: don't protect footnotes from conversion
2154 (when (plist-get org-export-latex-options-plist
:footnotes
)
2155 (goto-char (point-min))
2156 (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t
)
2158 (when (and (save-match-data
2159 (save-excursion (beginning-of-line)
2160 (looking-at "[^:|#]")))
2161 (not (org-in-verbatim-emphasis)))
2162 (let ((foot-beg (match-beginning 0))
2163 (foot-end (match-end 0))
2164 (foot-prefix (match-string 0))
2165 footnote footnote-rpl
)
2167 (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix
))
2169 (replace-match (org-export-latex-protect-string
2170 (concat "$^{" (match-string 1) "}$")))
2172 (let ((end (save-excursion
2173 (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t
)
2174 (match-beginning 0) (point-max)))))
2175 (setq footnote
(concat (org-trim (buffer-substring (point) end
))
2176 " ")) ; prevent last } being part of a link
2177 (delete-region (point) end
))
2178 (goto-char foot-beg
)
2179 (delete-region foot-beg foot-end
)
2180 (unless (null footnote
)
2181 (setq footnote-rpl
(format "\\footnote{%s}" footnote
))
2182 (add-text-properties 0 10 '(org-protected t
) footnote-rpl
)
2183 (add-text-properties (1- (length footnote-rpl
))
2184 (length footnote-rpl
)
2185 '(org-protected t
) footnote-rpl
)
2186 (if (org-on-heading-p)
2188 (concat (org-export-latex-protect-string "\\protect")
2190 (insert footnote-rpl
)))
2193 ;; Remove footnote section tag for LaTeX
2194 (goto-char (point-min))
2195 (while (re-search-forward
2196 (concat "^" footnote-section-tag-regexp
) nil t
)
2198 (replace-match "")))))
2200 (defun org-export-latex-fix-inputenc ()
2201 "Set the coding system in inputenc to what the buffer is."
2202 (let* ((cs buffer-file-coding-system
)
2203 (opt (or (ignore-errors (latexenc-coding-system-to-inputenc cs
))
2206 ;; Translate if that is requested
2207 (setq opt
(or (cdr (assoc opt org-export-latex-inputenc-alist
)) opt
))
2208 ;; find the \usepackage statement and replace the option
2209 (goto-char (point-min))
2210 (while (re-search-forward "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
2212 (goto-char (match-beginning 1))
2213 (delete-region (match-beginning 1) (match-end 1))
2215 (and buffer-file-name
2220 (defun org-export-latex-lists ()
2221 "Convert plain text lists in current buffer into LaTeX lists."
2223 (goto-char (point-min))
2224 (while (org-re-search-forward-unprotected org-list-beginning-re nil t
)
2226 (setq res
(org-list-to-latex (org-list-parse-list t
)
2227 org-export-latex-list-parameters
))
2228 (while (string-match "^\\(\\\\item[ \t]+\\)\\[@start:\\([0-9]+\\)\\]"
2230 (setq res
(replace-match
2231 (concat (format "\\setcounter{enumi}{%d}"
2232 (1- (string-to-number
2233 (match-string 2 res
))))
2235 (match-string 1 res
))
2237 (insert res
"\n"))))
2239 (defconst org-latex-entities
2268 "\\begin{description}"
2269 "\\begin{enumerate}"
2273 "\\begin{flushleft}"
2274 "\\begin{flushright}"
2279 "\\begin{quotation}"
2284 "\\begin{thebibliography}"
2286 "\\begin{titlepage}"
2413 "A list of LaTeX commands to be protected when performing conversion.")
2415 (defconst org-latex-entities-regexp
2417 (dolist (x org-latex-entities
)
2418 (if (string-match "[a-zA-Z]$" x
)
2421 (concat "\\(" (regexp-opt (nreverse names
)) "\\>\\)"
2422 "\\|\\(" (regexp-opt (nreverse rest
)) "\\)")))
2424 (provide 'org-export-latex
)
2425 (provide 'org-latex
)
2427 ;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
2429 ;;; org-latex.el ends here