1 ;;; org-latex.el --- LaTeX exporter for org-mode
3 ;; Copyright (C) 2007, 2008, 2009 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'
54 (defvar org-export-latex-class nil
)
55 (defvar org-export-latex-header nil
)
56 (defvar org-export-latex-append-header nil
)
57 (defvar org-export-latex-options-plist nil
)
58 (defvar org-export-latex-todo-keywords-1 nil
)
59 (defvar org-export-latex-complex-heading-re nil
)
60 (defvar org-export-latex-not-done-keywords nil
)
61 (defvar org-export-latex-done-keywords nil
)
62 (defvar org-export-latex-display-custom-times nil
)
63 (defvar org-export-latex-all-targets-re nil
)
64 (defvar org-export-latex-add-level
0)
65 (defvar org-export-latex-sectioning
"")
66 (defvar org-export-latex-sectioning-depth
0)
67 (defvar org-export-latex-special-keyword-regexp
68 (concat "\\<\\(" org-scheduled-string
"\\|"
69 org-deadline-string
"\\|"
70 org-closed-string
"\\)")
71 "Regexp matching special time planning keywords plus the time after it.")
73 (defvar latexp
) ; dynamically scoped from org.el
74 (defvar re-quote
) ; dynamically scoped from org.el
75 (defvar commentsp
) ; dynamically scoped from org.el
79 (defgroup org-export-latex nil
80 "Options for exporting Org-mode files to LaTeX."
81 :tag
"Org Export LaTeX"
84 (defcustom org-export-latex-default-class
"article"
85 "The default LaTeX class."
86 :group
'org-export-latex
87 :type
'(string :tag
"LaTeX class"))
89 (defcustom org-export-latex-classes
91 "\\documentclass[11pt]{article}
92 \\usepackage[utf8]{inputenc}
93 \\usepackage[T1]{fontenc}
94 \\usepackage{graphicx}
95 \\usepackage{longtable}
96 \\usepackage{hyperref}"
97 ("\\section{%s}" .
"\\section*{%s}")
98 ("\\subsection{%s}" .
"\\subsection*{%s}")
99 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")
100 ("\\paragraph{%s}" .
"\\paragraph*{%s}")
101 ("\\subparagraph{%s}" .
"\\subparagraph*{%s}"))
103 "\\documentclass[11pt]{report}
104 \\usepackage[utf8]{inputenc}
105 \\usepackage[T1]{fontenc}
106 \\usepackage{graphicx}
107 \\usepackage{longtable}
108 \\usepackage{hyperref}"
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[11pt]{book}
116 \\usepackage[utf8]{inputenc}
117 \\usepackage[T1]{fontenc}
118 \\usepackage{graphicx}
119 \\usepackage{longtable}
120 \\usepackage{hyperref}"
121 ("\\part{%s}" .
"\\part*{%s}")
122 ("\\chapter{%s}" .
"\\chapter*{%s}")
123 ("\\section{%s}" .
"\\section*{%s}")
124 ("\\subsection{%s}" .
"\\subsection*{%s}")
125 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")))
126 "Alist of LaTeX classes and associated header and structure.
127 If #+LaTeX_CLASS is set in the buffer, use its value and the
128 associated information. Here is the structure of each cell:
132 (numbered-section . unnumbered-section\)
135 A %s formatter is mandatory in each section string and will be
136 replaced by the title of the section.
138 Instead of a cons cell (numbered . unnumbered), you can also provide a list
141 (numbered-open numbered-close)
145 (numbered-open numbered-close unnumbered-open unnumbered-close)
147 providing opening and closing strings for an environment that should
148 represent the document section. The opening clause should have a %s
149 to represent the section title."
150 :group
'org-export-latex
152 (list (string :tag
"LaTeX class")
153 (string :tag
"LaTeX header")
154 (repeat :tag
"Levels" :inline t
157 (string :tag
"numbered")
158 (string :tag
"unnumbered)"))
159 (list :tag
"Environment"
160 (string :tag
"Opening (numbered) ")
161 (string :tag
"Closing (numbered) ")
162 (string :tag
"Opening (unnumbered)")
163 (string :tag
"Closing (unnumbered)")))))))
165 (defcustom org-export-latex-emphasis-alist
166 '(("*" "\\textbf{%s}" nil
)
167 ("/" "\\emph{%s}" nil
)
168 ("_" "\\underline{%s}" nil
)
169 ("+" "\\texttt{%s}" nil
)
172 "Alist of LaTeX expressions to convert emphasis fontifiers.
173 Each element of the list is a list of three elements.
174 The first element is the character used as a marker for fontification.
175 The second element is a formatting string to wrap fontified text with.
176 If it is \"\\verb\", Org will automatically select a deimiter
177 character that is not in the string.
178 The third element decides whether to protect converted text from other
180 :group
'org-export-latex
183 (defcustom org-export-latex-title-command
"\\maketitle"
184 "The command used to insert the title just after \\begin{document}.
185 If this string contains the formatting specification \"%s\" then
186 it will be used as a formatting string, passing the title as an
188 :group
'org-export-latex
191 (defcustom org-export-latex-import-inbuffer-stuff nil
192 "Non-nil means define TeX macros for Org's inbuffer definitions.
193 For example \orgTITLE for #+TITLE."
194 :group
'org-export-latex
197 (defcustom org-export-latex-date-format
199 "Format string for \\date{...}."
200 :group
'org-export-latex
203 (defcustom org-export-latex-todo-keyword-markup
"\\textbf{%s}"
204 "Markup for TODO keywords, as a printf format.
205 This can be a single format for all keywords, a cons cell with separate
206 formats for not-done and done states, or an association list with setup
207 for individual keywords. If a keyword shows up for which there is no
208 markup defined, the first one in the association list will be used."
209 :group
'org-export-latex
211 (string :tag
"Default")
212 (cons :tag
"Distinguish undone and done"
213 (string :tag
"Not-DONE states")
214 (string :tag
"DONE states"))
215 (repeat :tag
"Per keyword markup"
217 (string :tag
"Keyword")
218 (string :tag
"Markup")))))
220 (defcustom org-export-latex-timestamp-markup
"\\textit{%s}"
221 "A printf format string to be applied to time stamps."
222 :group
'org-export-latex
225 (defcustom org-export-latex-timestamp-keyword-markup
"\\texttt{%s}"
226 "A printf format string to be applied to time stamps."
227 :group
'org-export-latex
230 (defcustom org-export-latex-tables-verbatim nil
231 "When non-nil, tables are exported verbatim."
232 :group
'org-export-latex
235 (defcustom org-export-latex-tables-centered t
236 "When non-nil, tables are exported in a center environment."
237 :group
'org-export-latex
240 (defcustom org-export-latex-tables-column-borders nil
241 "When non-nil, grouping columns can cause outer vertical lines in tables.
242 When nil, grouping causes only separation lines between groups."
243 :group
'org-export-latex
246 (defcustom org-export-latex-packages-alist nil
247 "Alist of packages to be inserted in the header.
248 Each cell is of the forma \( \"option\" . \"package\" \)."
249 :group
'org-export-latex
252 (defcustom org-export-latex-low-levels
'itemize
253 "How to convert sections below the current level of sectioning.
254 This is specified by the `org-export-headline-levels' option or the
255 value of \"H:\" in Org's #+OPTION line.
257 This can be either nil (skip the sections), `description', `itemize',
258 or `enumerate' (convert the sections as the corresponding list type), or
259 a string to be used instead of \\section{%s}. In this latter case,
260 the %s stands here for the inserted headline and is mandatory.
262 It may also be a list of three string to define a user-defined environment
263 that should be used. The first string should be the like
264 \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
265 to two occurrences of %s for the title and a lable, respectively. The third
266 string should be like \"\\end{itemize\"."
267 :group
'org-export-latex
268 :type
'(choice (const :tag
"Ignore" nil
)
269 (const :tag
"Convert as descriptive list" description
)
270 (const :tag
"Convert as itemized list" itemize
)
271 (const :tag
"Convert as enumerated list" enumerate
)
272 (list :tag
"User-defined environment"
273 :value
("\\begin{itemize}" "\\end{itemize}" "\\item %s")
274 (string :tag
"Start")
276 (string :tag
"item"))
277 (string :tag
"Use a section string" :value
"\\subparagraph{%s}")))
279 (defcustom org-export-latex-list-parameters
280 '(:cbon
"\\texttt{[X]}" :cboff
"\\texttt{[ ]}")
281 "Parameters for the LaTeX list exporter.
282 These parameters will be passed on to `org-list-to-latex', which in turn
283 will pass them (combined with the LaTeX default list parameters) to
284 `org-list-to-generic'."
285 :group
'org-export-latex
288 (defcustom org-export-latex-verbatim-wrap
289 '("\\begin{verbatim}\n" .
"\\end{verbatim}\n")
290 "Environment to be wrapped around a fixed-width section in LaTeX export.
291 This is a cons with two strings, to be added before and after the
294 Defaults to \\begin{verbatim} and \\end{verbatim}."
295 :group
'org-export-translation
296 :group
'org-export-latex
297 :type
'(cons (string :tag
"Open")
298 (string :tag
"Close")))
300 (defcustom org-export-latex-remove-from-headlines
301 '(:todo nil
:priority nil
:tags nil
)
302 "A plist of keywords to remove from headlines. OBSOLETE.
303 Non-nil means remove this keyword type from the headline.
305 Don't remove the keys, just change their values.
307 Obsolete, this variable is no longer used. Use the separate
308 variables `org-export-with-todo-keywords', `org-export-with-priority',
309 and `org-export-with-tags' instead."
311 :group
'org-export-latex
)
313 (defcustom org-export-latex-image-default-option
"width=10em"
314 "Default option for images."
315 :group
'org-export-latex
318 (defcustom org-export-latex-inline-image-extensions
319 '("pdf" "jpeg" "jpg" "png" "ps" "eps")
320 "Extensions of image files that can be inlined into LaTeX.
321 Note that the image extension *actually* allowed depend on the way the
322 LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
323 are OK. When processing through dvi to Postscript, only ps and eps are
324 allowed. The default we use here encompasses both."
325 :group
'org-export-latex
326 :type
'(repeat (string :tag
"Extension")))
328 (defcustom org-export-latex-coding-system nil
329 "Coding system for the exported LaTex file."
330 :group
'org-export-latex
331 :type
'coding-system
)
333 (defgroup org-export-pdf nil
334 "Options for exporting Org-mode files to PDF, via LaTeX."
335 :tag
"Org Export LaTeX"
336 :group
'org-export-latex
339 (defcustom org-latex-to-pdf-process
340 '("pdflatex -interaction nonstopmode %s"
341 "pdflatex -interaction nonstopmode %s")
342 "Commands to process a LaTeX file to a PDF file.
343 This is a list of strings, each of them will be given to the shell
344 as a command. %s in the command will be replaced by the full file name, %b
345 by the file base name (i.e. without extension).
346 The reason why this is a list is that it usually takes several runs of
347 pdflatex, maybe mixed with a call to bibtex. Org does not have a clever
348 mechanism to detect whihc of these commands have to be run to get to a stable
349 result, and it also does not do any error checking.
351 Alternatively, this may be a Lisp function that does the processing, so you
352 could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
353 THis function should accept the file name as its single argument."
354 :group
'org-export-latex
355 :type
'(choice (repeat :tag
"Shell command sequence"
356 (string :tag
"Shell command"))
359 (defcustom org-export-pdf-remove-logfiles t
360 "Non-nil means, remove the logfiles produced by PDF production.
361 These are the .aux, .log, .out, and .toc files."
362 :group
'org-export-pdf
367 (defvar org-export-latex-after-blockquotes-hook nil
368 "Hook run during LaTeX export, after blockquote, verse, center are done.")
370 ;;; Autoload functions:
373 (defun org-export-as-latex-batch ()
374 "Call `org-export-as-latex', may be used in batch processing.
378 --load=$HOME/lib/emacs/org.el
379 --eval \"(setq org-export-headline-levels 2)\"
380 --visit=MyFile --funcall org-export-as-latex-batch"
381 (org-export-as-latex org-export-headline-levels
'hidden
))
384 (defun org-export-as-latex-to-buffer (arg)
385 "Call `org-export-as-latex` with output to a temporary buffer.
386 No file is created. The prefix ARG is passed through to `org-export-as-latex'."
388 (org-export-as-latex arg nil nil
"*Org LaTeX Export*")
389 (when org-export-show-temporary-export-buffer
390 (switch-to-buffer-other-window "*Org LaTeX Export*")))
393 (defun org-replace-region-by-latex (beg end
)
394 "Replace the region from BEG to END with its LaTeX export.
395 It assumes the region has `org-mode' syntax, and then convert it to
396 LaTeX. This can be used in any buffer. For example, you could
397 write an itemized list in `org-mode' syntax in an LaTeX buffer and
398 then use this command to convert it."
401 (save-window-excursion
403 (setq latex
(org-export-region-as-latex
405 (setq reg
(buffer-substring beg end
)
406 buf
(get-buffer-create "*Org tmp*"))
412 (setq latex
(org-export-region-as-latex
413 (point-min) (point-max) t
'string
)))
415 (delete-region beg end
)
419 (defun org-export-region-as-latex (beg end
&optional body-only buffer
)
420 "Convert region from BEG to END in `org-mode' buffer to LaTeX.
421 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
422 contents, and only produce the region of converted text, useful for
423 cut-and-paste operations.
424 If BUFFER is a buffer or a string, use/create that buffer as a target
425 of the converted LaTeX. If BUFFER is the symbol `string', return the
426 produced LaTeX as a string and leave no buffer behind. For example,
427 a Lisp program could call this function in the following way:
429 (setq latex (org-export-region-as-latex beg end t 'string))
431 When called interactively, the output buffer is selected, and shown
432 in a window. A non-interactive call will only return the buffer."
434 (when (interactive-p)
435 (setq buffer
"*Org LaTeX Export*"))
436 (let ((transient-mark-mode t
) (zmacs-regions t
)
438 (setq ext-plist
(plist-put ext-plist
:ignore-subree-p t
))
440 (set-mark (point)) ;; to activate the region
442 (setq rtn
(org-export-as-latex
445 (if (fboundp 'deactivate-mark
) (deactivate-mark))
446 (if (and (interactive-p) (bufferp rtn
))
447 (switch-to-buffer-other-window rtn
)
451 (defun org-export-as-latex (arg &optional hidden ext-plist
452 to-buffer body-only pub-dir
)
453 "Export current buffer to a LaTeX file.
454 If there is an active region, export only the region. The prefix
455 ARG specifies how many levels of the outline should become
456 headlines. The default is 3. Lower levels will be exported
457 depending on `org-export-latex-low-levels'. The default is to
458 convert them as description lists.
459 HIDDEN is obsolete and does nothing.
460 EXT-PLIST is a property list with
461 external parameters overriding org-mode's default settings, but
462 still inferior to file-local settings. When TO-BUFFER is
463 non-nil, create a buffer with that name and export to that
464 buffer. If TO-BUFFER is the symbol `string', don't leave any
465 buffer behind but just return the resulting LaTeX as a string.
466 When BODY-ONLY is set, don't produce the file header and footer,
467 simply return the content of \begin{document}...\end{document},
468 without even the \begin{document} and \end{document} commands.
469 when PUB-DIR is set, use this as the publishing directory."
471 ;; Make sure we have a file name when we need it.
472 (when (and (not (or to-buffer body-only
))
473 (not buffer-file-name
))
474 (if (buffer-base-buffer)
475 (org-set-local 'buffer-file-name
476 (with-current-buffer (buffer-base-buffer)
478 (error "Need a file name to be able to export")))
480 (message "Exporting to LaTeX...")
482 (remove-text-properties (point-min) (point-max)
483 '(:org-license-to-kill nil
)))
484 (org-update-radio-target-regexp)
485 (org-export-latex-set-initial-vars ext-plist arg
)
486 (let* ((wcf (current-window-configuration))
487 (opt-plist org-export-latex-options-plist
)
488 (region-p (org-region-active-p))
489 (rbeg (and region-p
(region-beginning)))
490 (rend (and region-p
(region-end)))
492 (if (plist-get opt-plist
:ignore-subree-p
)
497 (and (org-at-heading-p)
498 (>= (org-end-of-subtree t t
) rend
))))))
499 (opt-plist (setq org-export-opt-plist
501 (org-export-add-subtree-options opt-plist rbeg
)
503 ;; Make sure the variable contains the updated values.
504 (org-export-latex-options-plist opt-plist
)
505 (title (or (and subtree-p
(org-export-get-title-from-subtree))
506 (plist-get opt-plist
:title
)
508 (plist-get opt-plist
:skip-before-1st-heading
))
509 (org-export-grab-title-from-buffer))
510 (file-name-sans-extension
511 (file-name-nondirectory buffer-file-name
))))
512 (filename (concat (file-name-as-directory
514 (org-export-directory :LaTeX ext-plist
)))
515 (file-name-sans-extension
517 (org-entry-get rbeg
"EXPORT_FILE_NAME" t
))
518 (file-name-nondirectory ;sans-extension
521 (filename (if (equal (file-truename filename
)
522 (file-truename buffer-file-name
))
523 (concat filename
".tex")
525 (buffer (if to-buffer
527 ((eq to-buffer
'string
) (get-buffer-create
528 "*Org LaTeX Export*"))
529 (t (get-buffer-create to-buffer
)))
530 (find-file-noselect filename
)))
531 (odd org-odd-levels-only
)
532 (header (org-export-latex-make-header title opt-plist
))
533 (skip (cond (subtree-p nil
)
535 (t (plist-get opt-plist
:skip-before-1st-heading
))))
536 (text (plist-get opt-plist
:text
))
537 (org-export-preprocess-hook
539 `(lambda () (org-set-local 'org-complex-heading-regexp
540 ,org-export-latex-complex-heading-re
))
541 org-export-preprocess-hook
))
542 (first-lines (if skip
"" (org-export-latex-first-lines
549 (if region-p rend
))))
550 (coding-system (and (boundp 'buffer-file-coding-system
)
551 buffer-file-coding-system
))
552 (coding-system-for-write (or org-export-latex-coding-system
554 (save-buffer-coding-system (or org-export-latex-coding-system
556 (region (buffer-substring
557 (if region-p
(region-beginning) (point-min))
558 (if region-p
(region-end) (point-max))))
560 (org-export-preprocess-string
565 :tags
(plist-get opt-plist
:tags
)
566 :priority
(plist-get opt-plist
:priority
)
567 :footnotes
(plist-get opt-plist
:footnotes
)
568 :timestamps
(plist-get opt-plist
:timestamps
)
569 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
570 :add-text
(if (eq to-buffer
'string
) nil text
)
571 :skip-before-1st-heading skip
572 :select-tags
(plist-get opt-plist
:select-tags
)
573 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
574 :LaTeX-fragments nil
)))
578 (org-install-letbind)
580 (and (fboundp 'set-buffer-file-coding-system
)
581 (set-buffer-file-coding-system coding-system-for-write
))
583 ;; insert the header and initial document commands
584 (unless (or (eq to-buffer
'string
) body-only
)
587 ;; insert text found in #+TEXT
588 (when (and text
(not (eq to-buffer
'string
)))
589 (insert (org-export-latex-content
590 text
'(lists tables fixed-width keywords
))
593 ;; insert lines before the first headline
595 (insert first-lines
))
597 ;; export the content of headlines
598 (org-export-latex-global
600 (insert string-for-export
)
601 (goto-char (point-min))
602 (when (re-search-forward "^\\(\\*+\\) " nil t
)
603 (let* ((asters (length (match-string 1)))
604 (level (if odd
(- asters
2) (- asters
1))))
605 (setq org-export-latex-add-level
606 (if odd
(1- (/ (1+ asters
) 2)) (1- asters
)))
607 (org-export-latex-parse-global level odd
)))))
610 (unless body-only
(insert "\n\\end{document}"))
612 ;; Relocate the table of contents
613 (goto-char (point-min))
614 (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t
)
615 (goto-char (point-min))
616 (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t
)
618 (goto-char (point-min))
619 (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t
)
620 (replace-match "\\tableofcontents" t t
)))
622 (or to-buffer
(save-buffer))
623 (goto-char (point-min))
624 (or (org-export-push-to-kill-ring "LaTeX")
625 (message "Exporting to LaTeX...done"))
627 (if (eq to-buffer
'string
)
628 (prog1 (buffer-substring (point-min) (point-max))
629 (kill-buffer (current-buffer)))
631 (set-window-configuration wcf
))))
634 (defun org-export-as-pdf (arg &optional hidden ext-plist
635 to-buffer body-only pub-dir
)
636 "Export as LaTeX, then process through to PDF."
638 (message "Exporting to PDF...")
639 (let* ((wconfig (current-window-configuration))
640 (lbuf (org-export-as-latex arg hidden ext-plist
641 to-buffer body-only pub-dir
))
642 (file (buffer-file-name lbuf
))
643 (base (file-name-sans-extension (buffer-file-name lbuf
)))
644 (pdffile (concat base
".pdf"))
645 (cmds org-latex-to-pdf-process
)
646 (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
647 (bibtex-p (with-current-buffer lbuf
649 (goto-char (point-min))
650 (re-search-forward "\\\\bibliography{" nil t
))))
652 (with-current-buffer outbuf
(erase-buffer))
653 (and (file-exists-p pdffile
) (delete-file pdffile
))
654 (message "Processing LaTeX file...")
655 (if (and cmds
(symbolp cmds
))
658 (setq cmd
(pop cmds
))
659 (while (string-match "%b" cmd
)
660 (setq cmd
(replace-match
662 (shell-quote-argument base
))
664 (while (string-match "%s" cmd
)
665 (setq cmd
(replace-match
667 (shell-quote-argument file
))
669 (shell-command cmd outbuf outbuf
)))
670 (message "Processing LaTeX file...done")
671 (if (not (file-exists-p pdffile
))
672 (error "PDF file was not produced")
673 (set-window-configuration wconfig
)
674 (when org-export-pdf-remove-logfiles
675 (dolist (ext '("aux" "log" "out" "toc"))
676 (setq file
(concat base
"." ext
))
677 (and (file-exists-p file
) (delete-file file
))))
678 (message "Exporting to PDF...done")
682 (defun org-export-as-pdf-and-open (arg)
683 "Export as LaTeX, then process through to PDF, and open."
685 (let ((pdffile (org-export-as-pdf arg
)))
687 (org-open-file pdffile
)
688 (error "PDF file was not produced"))))
690 ;;; Parsing functions:
692 (defun org-export-latex-parse-global (level odd
)
693 "Parse the current buffer recursively, starting at LEVEL.
694 If ODD is non-nil, assume the buffer only contains odd sections.
695 Return a list reflecting the document structure."
697 (goto-char (point-min))
698 (let* ((cnt 0) output
699 (depth org-export-latex-sectioning-depth
))
700 (while (re-search-forward
701 (concat "^\\(\\(?:\\*\\)\\{"
702 (number-to-string (+ (if odd
2 1) level
))
704 ;; make sure that there is no upper heading
709 (concat "^\\(\\(?:\\*\\)\\{"
710 (number-to-string level
)
711 "\\}\\) \\(.*\\)$") nil t
)))) t
)
713 (let* ((pos (match-beginning 0))
714 (heading (match-string 2))
715 (nlevel (if odd
(/ (+ 3 level
) 2) (1+ level
))))
720 (if (re-search-forward
721 (concat "^\\(\\(?:\\*\\)\\{"
722 (number-to-string (+ (if odd
2 1) level
))
723 "\\}\\) \\(.*\\)$") nil t
)
726 (goto-char (point-min))
734 `(heading .
,heading
)
735 `(content .
,(org-export-latex-parse-content))
736 `(subcontent .
,(org-export-latex-parse-subcontent
741 (defun org-export-latex-parse-content ()
742 "Extract the content of a section."
744 (end (if (re-search-forward "^\\(\\*\\)+ .*$" nil t
)
745 (progn (beginning-of-line) (point))
747 (buffer-substring beg end
)))
749 (defun org-export-latex-parse-subcontent (level odd
)
750 "Extract the subcontent of a section at LEVEL.
751 If ODD Is non-nil, assume subcontent only contains odd sections."
752 (if (not (re-search-forward
753 (concat "^\\(\\(?:\\*\\)\\{"
754 (number-to-string (+ (if odd
4 2) level
))
757 nil
; subcontent is nil
758 (org-export-latex-parse-global (+ (if odd
2 1) level
) odd
)))
760 ;;; Rendering functions:
761 (defun org-export-latex-global (content)
762 "Export CONTENT to LaTeX.
763 CONTENT is an element of the list produced by
764 `org-export-latex-parse-global'."
765 (if (eq (car content
) 'subcontent
)
766 (mapc 'org-export-latex-sub
(cdr content
))
767 (org-export-latex-sub (car content
))))
769 (defun org-export-latex-sub (subcontent)
770 "Export the list SUBCONTENT to LaTeX.
771 SUBCONTENT is an alist containing information about the headline
773 (let ((num (plist-get org-export-latex-options-plist
:section-numbers
)))
774 (mapc (lambda(x) (org-export-latex-subcontent x num
)) subcontent
)))
776 (defun org-export-latex-subcontent (subcontent num
)
777 "Export each cell of SUBCONTENT to LaTeX.
778 If NUM, export sections as numerical sections."
779 (let* ((heading (org-export-latex-fontify-headline
780 (cdr (assoc 'heading subcontent
))))
781 (level (- (cdr (assoc 'level subcontent
))
782 org-export-latex-add-level
))
783 (occur (number-to-string (cdr (assoc 'occur subcontent
))))
784 (content (cdr (assoc 'content subcontent
)))
785 (subcontent (cadr (assoc 'subcontent subcontent
)))
786 (label (org-get-text-property-any 0 'target heading
))
787 (label-list (cons label
(cdr (assoc label
788 org-export-target-aliases
)))))
791 ((<= level org-export-latex-sectioning-depth
)
792 (let* ((sec (nth (1- level
) org-export-latex-sectioning
))
794 (if (consp (cdr sec
))
795 (setq start
(nth (if num
0 2) sec
)
796 end
(nth (if num
1 3) sec
))
797 (setq start
(if num
(car sec
) (cdr sec
))))
798 (insert (format start heading
) "\n")
800 (insert (mapconcat (lambda (l) (format "\\label{%s}" l
))
801 label-list
"\n") "\n"))
802 (insert (org-export-latex-content content
))
803 (cond ((stringp subcontent
) (insert subcontent
))
804 ((listp subcontent
) (org-export-latex-sub subcontent
)))
805 (if end
(insert end
"\n"))))
806 ;; At a level under the hl option: we can drop this subsection
807 ((> level org-export-latex-sectioning-depth
)
808 (cond ((eq org-export-latex-low-levels
'description
)
809 (if (string-match "% ends low level$"
810 (buffer-substring (point-at-bol 0) (point)))
811 (delete-region (point-at-bol 0) (point))
812 (insert "\\begin{description}\n"))
813 (insert (format "\n\\item[%s]%s~\n\n"
815 (if label
(format "\\label{%s}" label
) "")))
816 (insert (org-export-latex-content content
))
817 (cond ((stringp subcontent
) (insert subcontent
))
818 ((listp subcontent
) (org-export-latex-sub subcontent
)))
819 (insert "\\end{description} % ends low level\n"))
820 ((memq org-export-latex-low-levels
'(itemize enumerate
))
821 (if (string-match "% ends low level$"
822 (buffer-substring (point-at-bol 0) (point)))
823 (delete-region (point-at-bol 0) (point))
824 (insert (format "\\begin{%s}\n"
825 (symbol-name org-export-latex-low-levels
))))
826 (insert (format "\n\\item %s\\\\\n%s\n"
828 (if label
(format "\\label{%s}" label
) "")))
829 (insert (org-export-latex-content content
))
830 (cond ((stringp subcontent
) (insert subcontent
))
831 ((listp subcontent
) (org-export-latex-sub subcontent
)))
832 (insert (format "\\end{%s} %% ends low level\n"
833 (symbol-name org-export-latex-low-levels
))))
835 ((listp org-export-latex-low-levels
)
836 (if (string-match "% ends low level$"
837 (buffer-substring (point-at-bol 0) (point)))
838 (delete-region (point-at-bol 0) (point))
839 (insert (car org-export-latex-low-levels
) "\n"))
840 (insert (format (nth 2 org-export-latex-low-levels
)
842 (if label
(format "\\label{%s}" label
) "")))
843 (insert (org-export-latex-content content
))
844 (cond ((stringp subcontent
) (insert subcontent
))
845 ((listp subcontent
) (org-export-latex-sub subcontent
)))
846 (insert (nth 1 org-export-latex-low-levels
)
847 " %% ends low level\n"))
849 ((stringp org-export-latex-low-levels
)
850 (insert (format org-export-latex-low-levels heading
) "\n")
851 (when label
(insert (format "\\label{%s}\n" label
)))
852 (insert (org-export-latex-content content
))
853 (cond ((stringp subcontent
) (insert subcontent
))
854 ((listp subcontent
) (org-export-latex-sub subcontent
)))))))))
856 ;;; Exporting internals:
857 (defun org-export-latex-set-initial-vars (ext-plist level
)
858 "Store org local variables required for LaTeX export.
859 EXT-PLIST is an optional additional plist.
860 LEVEL indicates the default depth for export."
861 (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
862 org-export-latex-done-keywords org-done-keywords
863 org-export-latex-not-done-keywords org-not-done-keywords
864 org-export-latex-complex-heading-re org-complex-heading-regexp
865 org-export-latex-display-custom-times org-display-custom-times
866 org-export-latex-all-targets-re
867 (org-make-target-link-regexp (org-all-targets))
868 org-export-latex-options-plist
869 (org-combine-plists (org-default-export-plist) ext-plist
870 (org-infile-export-plist))
871 org-export-latex-class
872 (or (and (org-region-active-p)
874 (goto-char (region-beginning))
875 (and (looking-at org-complex-heading-regexp
)
876 (org-entry-get nil
"LaTeX_CLASS" 'selective
))))
880 (goto-char (point-min))
881 (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([a-zA-Z]+\\)" nil t
)
883 org-export-latex-default-class
)
884 org-export-latex-class
885 (or (car (assoc org-export-latex-class org-export-latex-classes
))
886 (error "No definition for class `%s' in `org-export-latex-classes'"
887 org-export-latex-class
))
888 org-export-latex-header
889 (cadr (assoc org-export-latex-class org-export-latex-classes
))
890 org-export-latex-sectioning
891 (cddr (assoc org-export-latex-class org-export-latex-classes
))
892 org-export-latex-sectioning-depth
895 (plist-get org-export-latex-options-plist
:headline-levels
))
896 (sec-depth (length org-export-latex-sectioning
)))
897 (if (> hl-levels sec-depth
) sec-depth hl-levels
)))))
899 (defun org-export-latex-make-header (title opt-plist
)
900 "Make the LaTeX header and return it as a string.
901 TITLE is the current title from the buffer or region.
902 OPT-PLIST is the options plist for current buffer."
903 (let ((toc (plist-get opt-plist
:table-of-contents
))
904 (author (plist-get opt-plist
:author
)))
906 (if (plist-get opt-plist
:time-stamp-file
)
907 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
908 ;; insert LaTeX custom header
909 (org-export-apply-macros-in-string org-export-latex-header
)
911 ;; insert information on LaTeX packages
912 (when org-export-latex-packages-alist
913 (mapconcat (lambda(p)
914 (if (equal "" (car p
))
915 (format "\\usepackage{%s}" (cadr p
))
916 (format "\\usepackage[%s]{%s}"
918 org-export-latex-packages-alist
"\n"))
919 ;; insert additional commands in the header
920 (org-export-apply-macros-in-string
921 (plist-get opt-plist
:latex-header-extra
))
922 (org-export-apply-macros-in-string org-export-latex-append-header
)
927 (org-export-latex-content
928 title
'(lists tables fixed-width keywords
)))
929 ;; insert author info
930 (if (plist-get opt-plist
:author-info
)
931 (format "\\author{%s}\n"
932 (org-export-latex-fontify-headline (or author user-full-name
)));????????????????????
933 (format "%%\\author{%s}\n"
934 (or author user-full-name
)))
936 (format "\\date{%s}\n"
938 (or (plist-get opt-plist
:date
)
939 org-export-latex-date-format
)))
940 ;; beginning of the document
941 "\n\\begin{document}\n\n"
942 ;; insert the title command
943 (when (string-match "\\S-" title
)
944 (if (string-match "%s" org-export-latex-title-command
)
945 (format org-export-latex-title-command title
)
946 org-export-latex-title-command
))
949 (when (and org-export-with-toc
950 (plist-get opt-plist
:section-numbers
))
952 (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
953 (min toc
(plist-get opt-plist
:headline-levels
))))
954 (toc (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
955 (plist-get opt-plist
:headline-levels
))))))))
957 (defun org-export-latex-first-lines (opt-plist &optional beg end
)
958 "Export the first lines before first headline.
959 If BEG is non-nil, it is the beginning of the region.
960 If END is non-nil, it is the end of the region."
962 (goto-char (or beg
(point-min)))
964 (end (if (re-search-forward "^\\*+ " end t
)
965 (goto-char (match-beginning 0))
968 (org-export-latex-content
969 (org-export-preprocess-string
970 (buffer-substring pt end
)
975 :skip-before-1st-heading nil
977 :timestamps
(plist-get opt-plist
:timestamps
)
978 :footnotes
(plist-get opt-plist
:footnotes
)))
980 (add-text-properties pt
(max pt
(1- end
))
981 '(:org-license-to-kill t
)))))))
983 (defvar org-export-latex-header-defs nil
984 "The header definitions that might be used in the LaTeX body.")
985 (defvar org-export-latex-header-defs-re nil
986 "The header definitions that might be used in the LaTeX body.")
988 (defun org-export-latex-content (content &optional exclude-list
)
989 "Convert CONTENT string to LaTeX.
990 Don't perform conversions that are in EXCLUDE-LIST. Recognized
991 conversion types are: quotation-marks, emphasis, sub-superscript,
992 links, keywords, lists, tables, fixed-width"
995 (unless (memq 'timestamps exclude-list
)
996 (org-export-latex-time-stamps))
997 (unless (memq 'quotation-marks exclude-list
)
998 (org-export-latex-quotation-marks))
999 (unless (memq 'emphasis exclude-list
)
1000 (when (plist-get org-export-latex-options-plist
:emphasize
)
1001 (org-export-latex-fontify)))
1002 (unless (memq 'sub-superscript exclude-list
)
1003 (org-export-latex-special-chars
1004 (plist-get org-export-latex-options-plist
:sub-superscript
)))
1005 (unless (memq 'links exclude-list
)
1006 (org-export-latex-links))
1007 (unless (memq 'keywords exclude-list
)
1008 (org-export-latex-keywords))
1009 (unless (memq 'lists exclude-list
)
1010 (org-export-latex-lists))
1011 (unless (memq 'tables exclude-list
)
1012 (org-export-latex-tables
1013 (plist-get org-export-latex-options-plist
:tables
)))
1014 (unless (memq 'fixed-width exclude-list
)
1015 (org-export-latex-fixed-width
1016 (plist-get org-export-latex-options-plist
:fixed-width
)))
1018 (buffer-substring (point-min) (point-max))))
1020 (defun org-export-latex-protect-string (s)
1021 "Add the org-protected property to string S."
1022 (add-text-properties 0 (length s
) '(org-protected t
) s
) s
)
1024 (defun org-export-latex-protect-char-in-string (char-list string
)
1025 "Add org-protected text-property to char from CHAR-LIST in STRING."
1029 (goto-char (point-min))
1030 (while (re-search-forward (regexp-opt char-list
) nil t
)
1031 (add-text-properties (match-beginning 0)
1032 (match-end 0) '(org-protected t
)))
1035 (defun org-export-latex-keywords-maybe (&optional remove-list
)
1036 "Maybe remove keywords depending on rules in REMOVE-LIST."
1037 (goto-char (point-min))
1038 (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1
"\\|"))
1039 (case-fold-search nil
)
1040 (todo-markup org-export-latex-todo-keyword-markup
)
1042 ;; convert TODO keywords
1043 (when (re-search-forward (concat "^\\(" re-todo
"\\)") nil t
)
1044 (if (plist-get remove-list
:todo
)
1047 ((stringp todo-markup
) todo-markup
)
1048 ((and (consp todo-markup
) (stringp (car todo-markup
)))
1049 (if (member (match-string 1) org-export-latex-done-keywords
)
1050 (cdr todo-markup
) (car todo-markup
)))
1051 (t (cdr (or (assoc (match-string 1) todo-markup
)
1052 (car todo-markup
))))))
1053 (replace-match (format fmt
(match-string 1)) t t
)))
1054 ;; convert priority string
1055 (when (re-search-forward "\\[\\\\#.\\]" nil t
)
1056 (if (plist-get remove-list
:priority
)
1058 (replace-match (format "\\textbf{%s}" (match-string 0)) t t
)))
1060 (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t
)
1061 (if (or (not org-export-with-tags
)
1062 (plist-get remove-list
:tags
))
1065 (org-export-latex-protect-string
1066 (format "\\textbf{%s}"
1068 (replace-regexp-in-string
1069 "_" "\\\\_" (match-string 0)))))
1072 (defun org-export-latex-fontify-headline (string)
1073 "Fontify special words in STRING."
1075 ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
1076 ;; the beginning of the buffer - inserting "\n" is safe here though.
1077 (insert "\n" string
)
1078 (goto-char (point-min))
1079 (when (plist-get org-export-latex-options-plist
:emphasize
)
1080 (org-export-latex-fontify))
1081 (org-export-latex-keywords-maybe)
1082 (org-export-latex-special-chars
1083 (plist-get org-export-latex-options-plist
:sub-superscript
))
1084 (org-export-latex-links)
1085 (org-trim (buffer-string))))
1087 (defun org-export-latex-time-stamps ()
1088 "Format time stamps."
1089 (goto-char (point-min))
1090 (let ((org-display-custom-times org-export-latex-display-custom-times
))
1091 (while (re-search-forward org-ts-regexp-both nil t
)
1092 (org-if-unprotected-at (1- (point))
1094 (org-export-latex-protect-string
1095 (format org-export-latex-timestamp-markup
1096 (substring (org-translate-time (match-string 0)) 1 -
1)))
1099 (defun org-export-latex-quotation-marks ()
1100 "Export quotation marks depending on language conventions."
1101 (let* ((lang (plist-get org-export-latex-options-plist
:language
))
1102 (quote-rpl (if (equal lang
"fr")
1103 '(("\\(\\s-\\)\"" "«~")
1104 ("\\(\\S-\\)\"" "~»")
1105 ("\\(\\s-\\)'" "`"))
1106 '(("\\(\\s-\\|(\\)\"" "``")
1107 ("\\(\\S-\\)\"" "''")
1108 ("\\(\\s-\\|(\\)'" "`")))))
1109 (mapc (lambda(l) (goto-char (point-min))
1110 (while (re-search-forward (car l
) nil t
)
1111 (let ((rpl (concat (match-string 1) (cadr l
))))
1112 (org-export-latex-protect-string rpl
)
1113 (org-if-unprotected-1
1114 (replace-match rpl t t
))))) quote-rpl
)))
1116 (defun org-export-latex-special-chars (sub-superscript)
1117 "Export special characters to LaTeX.
1118 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
1119 See the `org-export-latex.el' code for a complete conversion table."
1120 (goto-char (point-min))
1122 (goto-char (point-min))
1123 (while (re-search-forward c nil t
)
1124 ;; Put the point where to check for org-protected
1125 (unless (get-text-property (match-beginning 2) 'org-protected
)
1126 (cond ((member (match-string 2) '("\\$" "$"))
1127 (if (equal (match-string 2) "\\$")
1129 (replace-match "\\$" t t
)))
1130 ((member (match-string 2) '("&" "%" "#"))
1131 (if (equal (match-string 1) "\\")
1132 (replace-match (match-string 2) t t
)
1133 (replace-match (concat (match-string 1) "\\"
1134 (match-string 2)) t t
)))
1135 ((equal (match-string 2) "...")
1137 (concat (match-string 1)
1138 (org-export-latex-protect-string "\\ldots{}")) t t
))
1139 ((equal (match-string 2) "~")
1140 (cond ((equal (match-string 1) "\\") nil
)
1141 ((eq 'org-link
(get-text-property 0 'face
(match-string 2)))
1142 (replace-match (concat (match-string 1) "\\~") t t
))
1144 (org-export-latex-protect-string
1145 (concat (match-string 1) "\\~{}")) t t
))))
1146 ((member (match-string 2) '("{" "}"))
1147 (unless (save-match-data (org-inside-latex-math-p))
1148 (if (equal (match-string 1) "\\")
1149 (replace-match (match-string 2) t t
)
1150 (replace-match (concat (match-string 1) "\\"
1151 (match-string 2)) t t
)))))
1152 (unless (save-match-data (org-inside-latex-math-p))
1153 (cond ((equal (match-string 2) "\\")
1154 (replace-match (or (save-match-data
1155 (org-export-latex-treat-backslash-char
1157 (or (match-string 3) "")))
1159 ((member (match-string 2) '("_" "^"))
1160 (replace-match (or (save-match-data
1161 (org-export-latex-treat-sub-super-char
1165 (match-string 3))) "") t t
)
1166 (backward-char 1)))))))
1167 '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
1168 "\\(\\(\\\\?\\$\\)\\)"
1169 "\\([a-za-z0-9]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-za-z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-za-z0-9]+}\\|([a-za-z0-9]+)\\)"
1170 "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|[a-zA-Z&#%{}\"]+\\)"
1171 "\\(.\\|^\\)\\(&\\)"
1172 "\\(.\\|^\\)\\(#\\)"
1173 "\\(.\\|^\\)\\(%\\)"
1174 "\\(.\\|^\\)\\({\\)"
1175 "\\(.\\|^\\)\\(}\\)"
1176 "\\(.\\|^\\)\\(~\\)"
1177 "\\(.\\|^\\)\\(\\.\\.\\.\\)"
1178 ;; (?\< . "\\textless{}")
1179 ;; (?\> . "\\textgreater{}")
1182 (defun org-inside-latex-math-p ()
1183 (get-text-property (point) 'org-latex-math
))
1185 (defun org-export-latex-treat-sub-super-char
1186 (subsup char string-before string-after
)
1187 "Convert the \"_\" and \"^\" characters to LaTeX.
1188 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
1189 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
1190 (cond ((equal string-before
"\\")
1191 (concat string-before char string-after
))
1192 ;; this is part of a math formula
1193 ((and (string-match "\\S-+" string-before
)
1194 (string-match "\\S-+" string-after
))
1195 (cond ((eq 'org-link
(get-text-property 0 'face char
))
1196 (concat string-before
"\\" char string-after
))
1197 ((save-match-data (org-inside-latex-math-p))
1199 (cond ((eq 1 (length string-after
))
1200 (concat string-before char string-after
))
1201 ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after
)
1202 (format "%s%s{%s}" string-before char
1203 (match-string 1 string-after
))))))
1204 ((and (> (length string-after
) 1)
1206 (and (equal subsup
'{}) (eq (string-to-char string-after
) ?\
{)))
1207 (string-match "[({]?\\([^)}]+\\)[)}]?" string-after
))
1208 (org-export-latex-protect-string
1209 (format "%s$%s{%s}$" string-before char
1210 (if (and (> (match-end 1) (1+ (match-beginning 1)))
1211 (not (equal (substring string-after
0 2) "{\\")))
1212 (concat "\\mathrm{" (match-string 1 string-after
) "}")
1213 (match-string 1 string-after
)))))
1214 ((eq subsup t
) (concat string-before
"$" char string-after
"$"))
1215 (t (org-export-latex-protect-string
1216 (concat string-before
"\\" char
"{}" string-after
)))))
1217 (t (org-export-latex-protect-string
1218 (concat string-before
"\\" char
"{}" string-after
)))))
1220 (defun org-export-latex-treat-backslash-char (string-before string-after
)
1221 "Convert the \"$\" special character to LaTeX.
1222 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
1223 (cond ((member (list string-after
) org-html-entities
)
1224 ;; backslash is part of a special entity (like "\alpha")
1225 (concat string-before
"$\\"
1226 (or (cdar (member (list string-after
) org-html-entities
))
1228 ((and (not (string-match "^[ \n\t]" string-after
))
1229 (not (string-match "[ \t]\\'\\|^" string-before
)))
1230 ;; backslash is inside a word
1231 (org-export-latex-protect-string
1232 (concat string-before
"\\textbackslash{}" string-after
)))
1233 ((not (or (equal string-after
"")
1234 (string-match "^[ \t\n]" string-after
)))
1235 ;; backslash might escape a character (like \#) or a user TeX
1236 ;; macro (like \setcounter)
1237 (org-export-latex-protect-string
1238 (concat string-before
"\\" string-after
)))
1239 ((and (string-match "^[ \t\n]" string-after
)
1240 (string-match "[ \t\n]\\'" string-before
))
1241 ;; backslash is alone, convert it to $\backslash$
1242 (org-export-latex-protect-string
1243 (concat string-before
"\\textbackslash{}" string-after
)))
1244 (t (org-export-latex-protect-string
1245 (concat string-before
"\\textbackslash{}" string-after
)))))
1247 (defun org-export-latex-keywords ()
1248 "Convert special keywords to LaTeX."
1249 (goto-char (point-min))
1250 (while (re-search-forward org-export-latex-special-keyword-regexp nil t
)
1251 (replace-match (format org-export-latex-timestamp-keyword-markup
1252 (match-string 0)) t t
)
1254 (beginning-of-line 1)
1255 (unless (looking-at ".*\\\\newline[ \t]*$")
1257 (insert "\\newline")))))
1259 (defun org-export-latex-fixed-width (opt)
1260 "When OPT is non-nil convert fixed-width sections to LaTeX."
1261 (goto-char (point-min))
1262 (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t
)
1264 (progn (goto-char (match-beginning 0))
1265 (insert "\\begin{verbatim}\n")
1266 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1267 (replace-match (concat (match-string 1)
1268 (match-string 2)) t t
)
1270 (insert "\\end{verbatim}\n\n"))
1271 (progn (goto-char (match-beginning 0))
1272 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1273 (replace-match (concat "%" (match-string 1)
1274 (match-string 2)) t t
)
1278 (defvar org-table-last-alignment
) ; defined in org-table.el
1279 (declare-function orgtbl-to-latex
"org-table" (table params
) t
)
1280 (defun org-export-latex-tables (insert)
1281 "Convert tables to LaTeX and INSERT it."
1282 (goto-char (point-min))
1283 (while (re-search-forward "^\\([ \t]*\\)|" nil t
)
1284 ;; FIXME really need to save-excursion?
1285 (save-excursion (org-table-align))
1286 (let* ((beg (org-table-begin))
1287 (end (org-table-end))
1288 (raw-table (buffer-substring beg end
))
1289 fnum fields line lines olines gr colgropen line-fmt align
1290 caption label attr floatp longtblp
)
1291 (if org-export-latex-tables-verbatim
1292 (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1293 "\\end{verbatim}\n")))
1294 (apply 'delete-region
(list beg end
))
1295 (insert (org-export-latex-protect-string tbl
)))
1297 (setq caption
(org-find-text-property-in-string
1298 'org-caption raw-table
)
1299 attr
(org-find-text-property-in-string
1300 'org-attributes raw-table
)
1301 label
(org-find-text-property-in-string
1302 'org-label raw-table
)
1303 longtblp
(and attr
(stringp attr
)
1304 (string-match "\\<longtable\\>" attr
))
1305 align
(and attr
(stringp attr
)
1306 (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr
)
1307 (match-string 1 attr
))
1308 floatp
(or caption label
))
1309 (setq lines
(org-split-string raw-table
"\n"))
1310 (apply 'delete-region
(list beg end
))
1311 (when org-export-table-remove-special-lines
1312 (setq lines
(org-table-clean-before-export lines
'maybe-quoted
)))
1313 ;; make a formatting string to reflect aligment
1315 (while (and (not line-fmt
) (setq line
(pop olines
)))
1316 (unless (string-match "^[ \t]*|-" line
)
1317 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1318 (setq fnum
(make-vector (length fields
) 0))
1322 (setq gr
(pop org-table-colgroup-info
))
1324 (cond ((eq gr
:start
)
1325 (prog1 (if colgropen
"|" "|")
1326 (setq colgropen t
)))
1328 (prog1 (if colgropen
"|" "|")
1329 (setq colgropen nil
)))
1331 (if (memq gr
'(:end
:startend
))
1332 (progn (setq colgropen nil
) "|")
1335 ;; fix double || in line-fmt
1336 (setq line-fmt
(replace-regexp-in-string "||" "|" line-fmt
))
1337 ;; maybe remove the first and last "|"
1338 (when (and (not org-export-latex-tables-column-borders
)
1339 (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt
))
1340 (setq line-fmt
(match-string 2 line-fmt
)))
1343 (setq align
(apply 'format
1345 (mapcar (lambda (x) (if x
"r" "l"))
1346 org-table-last-alignment
)))))
1347 ;; prepare the table to send to orgtbl-to-latex
1351 (or (and (string-match "[ \t]*|-+" elem
) 'hline
)
1352 (org-split-string (org-trim elem
) "|")))
1355 (insert (org-export-latex-protect-string
1358 (concat "\\begin{longtable}{" align
"}\n")
1359 (if floatp
"\\begin{table}[htb]\n"))
1360 (if (or floatp longtblp
)
1363 (if label
(concat "\\\label{" label
"}") "")
1365 (if longtblp
"\\\\\n" "\n")
1366 (if (and org-export-latex-tables-centered
(not longtblp
))
1367 "\\begin{center}\n")
1368 (if (not longtblp
) (concat "\\begin{tabular}{" align
"}\n"))
1371 `(:tstart nil
:tend nil
1372 :hlend
,(if longtblp
1376 \\hline\\multicolumn{%d}{r}{Continued on next page}\\
1378 \\endlastfoot" (length org-table-last-alignment
))
1380 (if (not longtblp
) (concat "\n\\end{tabular}"))
1381 (if longtblp
"\n" (if org-export-latex-tables-centered
1382 "\n\\end{center}\n" "\n"))
1385 (if floatp
"\\end{table}"))))
1388 (defun org-export-latex-fontify ()
1389 "Convert fontification to LaTeX."
1390 (goto-char (point-min))
1391 (while (re-search-forward org-emph-re nil t
)
1392 ;; The match goes one char after the *string*
1393 (let ((emph (assoc (match-string 3)
1394 org-export-latex-emphasis-alist
))
1395 (beg (match-beginning 0))
1399 (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
1401 (unless (or (get-text-property (1- (point)) 'org-protected
)
1403 (goto-char (match-beginning 1))
1405 (and (org-at-table-p)
1407 "[|\n]" (buffer-substring beg end
))))))
1408 (setq rpl
(concat (match-string 1)
1409 (org-export-latex-emph-format (cadr emph
)
1413 (setq rpl
(org-export-latex-protect-string rpl
)))
1414 (replace-match rpl t t
)))
1417 (defvar org-export-latex-use-verb nil
)
1418 (defun org-export-latex-emph-format (format string
)
1419 "Format an emphasis string and handle the \\verb special case."
1420 (when (equal format
"\\verb")
1422 (if org-export-latex-use-verb
1423 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1425 (loop for i from
0 to
(1- (length ll
)) do
1426 (if (not (string-match (regexp-quote (substring ll i
(1+ i
)))
1429 (setq format
(concat "\\verb" (substring ll i
(1+ i
))
1430 "%s" (substring ll i
(1+ i
))))
1431 (throw 'exit nil
))))))
1433 (trans '(("\\" .
"\\backslash")
1434 ("~" .
"\\ensuremath{\\sim}")
1435 ("^" .
"\\ensuremath{\\wedge}")))
1437 (while (string-match "[\\{}$%&_#~^]" string
)
1438 (setq char
(match-string 0 string
))
1439 (if (> (match-beginning 0) 0)
1440 (setq rtn
(concat rtn
(substring string
1441 0 (match-beginning 0)))))
1442 (setq string
(substring string
(1+ (match-beginning 0))))
1443 (setq char
(or (cdr (assoc char trans
)) (concat "\\" char
))
1444 rtn
(concat rtn char
)))
1445 (setq string
(concat rtn string
) format
"\\texttt{%s}")))))
1446 (setq string
(org-export-latex-protect-string
1447 (format format string
))))
1449 (defun org-export-latex-links ()
1450 ;; Make sure to use the LaTeX hyperref and graphicx package
1451 ;; or send some warnings.
1452 "Convert links to LaTeX."
1453 (goto-char (point-min))
1454 (while (re-search-forward org-bracket-link-analytic-regexp
++ nil t
)
1456 (goto-char (match-beginning 0))
1457 (let* ((re-radio org-export-latex-all-targets-re
)
1458 (remove (list (match-beginning 0) (match-end 0)))
1459 (raw-path (org-extract-attributes (match-string 3)))
1460 (full-raw-path (concat (match-string 1) raw-path
))
1461 (desc (match-string 5))
1462 (type (or (match-string 2)
1463 (if (or (file-name-absolute-p raw-path
)
1464 (string-match "^\\.\\.?/" raw-path
))
1466 (coderefp (equal type
"coderef"))
1467 (caption (org-find-text-property-in-string 'org-caption raw-path
))
1468 (attr (or (org-find-text-property-in-string 'org-attributes raw-path
)
1469 (plist-get org-export-latex-options-plist
:latex-image-options
)))
1470 (label (org-find-text-property-in-string 'org-label raw-path
))
1471 (floatp (or label caption
))
1473 ;; define the path of the link
1475 ((member type
'("coderef"))
1477 ((member type
'("http" "https" "ftp"))
1478 (concat type
":" raw-path
))
1479 ((and re-radio
(string-match re-radio raw-path
))
1481 ((equal type
"mailto")
1482 (concat type
":" raw-path
))
1483 ((equal type
"file")
1484 (if (and (org-file-image-p
1487 org-export-latex-inline-image-extensions
)
1488 (or (get-text-property 0 'org-no-description
1490 (equal desc full-raw-path
)))
1492 (progn (when (string-match "\\(.+\\)::.+" raw-path
)
1493 (setq raw-path
(match-string 1 raw-path
)))
1494 (if (file-exists-p raw-path
)
1495 (concat type
"://" (expand-file-name raw-path
))
1496 (concat type
"://" (org-export-directory
1497 :LaTeX org-export-latex-options-plist
)
1499 ;; process with link inserting
1500 (apply 'delete-region remove
)
1501 (cond ((and imgp
(plist-get org-export-latex-options-plist
:inline-images
))
1504 (if floatp
"\\begin{figure}[htb]\n")
1505 (format "\\centerline{\\includegraphics[%s]{%s}}\n"
1507 (if (file-name-absolute-p raw-path
)
1508 (expand-file-name raw-path
)
1511 (format "\\caption{%s%s}\n"
1512 (if label
(concat "\\label{" label
"}") "")
1514 (if floatp
"\\end{figure}\n"))))
1517 (org-export-get-coderef-format path desc
)
1518 (cdr (assoc path org-export-code-refs
)))))
1519 (radiop (insert (format "\\hyperref[%s]{%s}"
1520 (org-solidify-link-text raw-path
) desc
)))
1522 (insert (format "\\hyperref[%s]{%s}"
1523 (org-remove-initial-hash
1524 (org-solidify-link-text raw-path
)) desc
)))
1525 (path (insert (format "\\href{%s}{%s}" path desc
)))
1526 (t (insert "\\texttt{" desc
"}")))))))
1528 (defun org-remove-initial-hash (s)
1529 (if (string-match "\\`#" s
)
1532 (defvar org-latex-entities
) ; defined below
1533 (defvar org-latex-entities-regexp
) ; defined below
1534 (defvar org-latex-entities-exceptions
) ; defined below
1536 (defun org-export-latex-preprocess (parameters)
1537 "Clean stuff in the LaTeX export."
1538 ;; Preserve line breaks
1539 (goto-char (point-min))
1540 (while (re-search-forward "\\\\\\\\" nil t
)
1541 (add-text-properties (match-beginning 0) (match-end 0)
1542 '(org-protected t
)))
1544 ;; Preserve latex environments
1545 (goto-char (point-min))
1546 (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t
)
1547 (let* ((start (progn (beginning-of-line) (point)))
1548 (end (and (re-search-forward
1549 (concat "^[ \t]*\\\\end{"
1550 (regexp-quote (match-string 1))
1554 (add-text-properties start end
'(org-protected t
))
1555 (goto-char (point-at-eol)))))
1557 ;; Preserve math snippets
1559 (let* ((matchers (plist-get org-format-latex-options
:matchers
))
1560 (re-list org-latex-regexps
)
1561 beg end re e m n block off
)
1562 ;; Check the different regular expressions
1563 (while (setq e
(pop re-list
))
1564 (setq m
(car e
) re
(nth 1 e
) n
(nth 2 e
)
1565 block
(if (nth 3 e
) "\n\n" ""))
1566 (setq off
(if (member m
'("$" "$1")) 1 0))
1567 (when (and (member m matchers
) (not (equal m
"begin")))
1568 (goto-char (point-min))
1569 (while (re-search-forward re nil t
)
1570 (setq beg
(+ (match-beginning 0) off
) end
(- (match-end 0) 0))
1571 (add-text-properties beg end
'(org-protected t org-latex-math t
))))))
1573 ;; Convert LaTeX to \LaTeX{}
1574 (goto-char (point-min))
1575 (let ((case-fold-search nil
))
1576 (while (re-search-forward "\\([^+_]\\)LaTeX" nil t
)
1578 (replace-match (org-export-latex-protect-string
1579 (concat (match-string 1) "\\LaTeX{}")) t t
))))
1581 ;; Convert blockquotes
1582 (goto-char (point-min))
1583 (while (search-forward "ORG-BLOCKQUOTE-START" nil t
)
1584 (org-replace-match-keep-properties "\\begin{quote}" t t
))
1585 (goto-char (point-min))
1586 (while (search-forward "ORG-BLOCKQUOTE-END" nil t
)
1587 (org-replace-match-keep-properties "\\end{quote}" t t
))
1590 (goto-char (point-min))
1591 (while (search-forward "ORG-VERSE-START" nil t
)
1592 (org-replace-match-keep-properties "\\begin{verse}" t t
)
1593 (beginning-of-line 2)
1594 (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
1595 (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
1596 (goto-char (match-end 1))
1597 (org-replace-match-keep-properties
1598 (org-export-latex-protect-string
1599 (concat "\\hspace*{1cm}" (match-string 2))) t t
)
1600 (beginning-of-line 1))
1601 (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
1604 (beginning-of-line 2))
1605 (and (looking-at "[ \t]*ORG-VERSE-END.*")
1606 (org-replace-match-keep-properties "\\end{verse}" t t
)))
1609 (goto-char (point-min))
1610 (while (search-forward "ORG-CENTER-START" nil t
)
1611 (org-replace-match-keep-properties "\\begin{center}" t t
))
1612 (goto-char (point-min))
1613 (while (search-forward "ORG-CENTER-END" nil t
)
1614 (org-replace-match-keep-properties "\\end{center}" t t
))
1616 (run-hooks 'org-export-latex-after-blockquotes-hook
)
1618 ;; Convert horizontal rules
1619 (goto-char (point-min))
1620 (while (re-search-forward "^----+.$" nil t
)
1622 (replace-match (org-export-latex-protect-string "\\hrule") t t
)))
1624 ;; Protect LaTeX commands like \command[...]{...} or \command{...}
1625 (let ((re (concat "\\\\[a-zA-Z]+\\(?:"
1628 (org-create-multibrace-regexp "{" "}" 3))))
1629 (while (re-search-forward re nil t
)
1630 (add-text-properties (match-beginning 0) (match-end 0)
1631 '(org-protected t
))))
1633 ;; Protect LaTeX entities
1634 (goto-char (point-min))
1636 (while (re-search-forward org-latex-entities-regexp nil t
)
1637 (if (setq a
(assoc (match-string 0) org-latex-entities-exceptions
))
1638 (replace-match (org-add-props (nth 1 a
) nil
'org-protected t
)
1640 (add-text-properties (match-beginning 0) (match-end 0)
1641 '(org-protected t
)))))
1643 ;; Replace radio links
1644 (goto-char (point-min))
1645 (while (re-search-forward
1646 (concat "<<<?" org-export-latex-all-targets-re
1647 ">>>?\\((INVISIBLE)\\)?") nil t
)
1650 (org-export-latex-protect-string
1651 (format "\\label{%s}%s" (save-match-data (org-solidify-link-text
1653 (if (match-string 2) "" (match-string 1)))) t t
)))
1655 ;; Delete @<...> constructs
1656 ;; Thanks to Daniel Clemente for this regexp
1657 (goto-char (point-min))
1658 (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t
)
1660 (replace-match "")))
1662 ;; When converting to LaTeX, replace footnotes
1663 ;; FIXME: don't protect footnotes from conversion
1664 (when (plist-get org-export-latex-options-plist
:footnotes
)
1665 (goto-char (point-min))
1666 (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t
)
1668 (when (save-match-data
1669 (save-excursion (beginning-of-line)
1670 (looking-at "[^:|#]")))
1671 (let ((foot-beg (match-beginning 0))
1672 (foot-end (match-end 0))
1673 (foot-prefix (match-string 0))
1674 footnote footnote-rpl
)
1676 (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix
))
1678 (replace-match "$^{\\1}$")
1680 (let ((end (save-excursion
1681 (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t
)
1682 (match-beginning 0) (point-max)))))
1683 (setq footnote
(concat (org-trim (buffer-substring (point) end
))
1684 " ")) ; prevent last } being part of a link
1685 (delete-region (point) end
))
1686 (goto-char foot-beg
)
1687 (delete-region foot-beg foot-end
)
1688 (unless (null footnote
)
1689 (setq footnote-rpl
(format "\\footnote{%s}" footnote
))
1690 (add-text-properties 0 10 '(org-protected t
) footnote-rpl
)
1691 (add-text-properties (1- (length footnote-rpl
))
1692 (length footnote-rpl
)
1693 '(org-protected t
) footnote-rpl
)
1694 (insert footnote-rpl
)))
1697 ;; Remove footnote section tag for LaTeX
1698 (goto-char (point-min))
1699 (while (re-search-forward
1700 (concat "^" footnote-section-tag-regexp
) nil t
)
1702 (replace-match "")))))
1706 (defun org-export-latex-lists ()
1707 "Convert plain text lists in current buffer into LaTeX lists."
1708 (goto-char (point-min))
1709 (while (re-search-forward org-list-beginning-re nil t
)
1712 (insert (org-list-to-latex (org-list-parse-list t
)
1713 org-export-latex-list-parameters
))
1716 (defconst org-latex-entities
1745 "\\begin{description}"
1746 "\\begin{enumerate}"
1750 "\\begin{flushleft}"
1751 "\\begin{flushright}"
1756 "\\begin{quotation}"
1761 "\\begin{thebibliography}"
1763 "\\begin{titlepage}"
1891 "A list of LaTeX commands to be protected when performing conversion.")
1893 (defvar org-latex-entities-exceptions nil
)
1895 (defconst org-latex-entities-regexp
1897 (dolist (x org-latex-entities
)
1899 (add-to-list 'org-latex-entities-exceptions x
)
1901 (if (string-match "[a-z][A-Z]$" x
)
1904 (concat "\\(" (regexp-opt (nreverse names
)) "\\>\\)"
1905 "\\|\\(" (regexp-opt (nreverse rest
)) "\\)")))
1907 (provide 'org-export-latex
)
1908 (provide 'org-latex
)
1910 ;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
1912 ;;; org-latex.el ends here