2008-11-23 Carsten Dominik <carsten.dominik@gmail.com>
[emacs.git] / lisp / org / org-export-latex.el
blob09ada3e451d222006395c9bb89725775549d67f3
1 ;;; org-export-latex.el --- LaTeX exporter for org-mode
2 ;;
3 ;; Copyright (C) 2007, 2008 Free Software Foundation, Inc.
4 ;;
5 ;; Emacs Lisp Archive Entry
6 ;; Filename: org-export-latex.el
7 ;; Version: 6.13
8 ;; Author: Bastien Guerry <bzg AT altern DOT org>
9 ;; Maintainer: Bastien Guerry <bzg AT altern DOT org>
10 ;; Keywords: org, wp, tex
11 ;; Description: Converts an org-mode buffer into LaTeX
12 ;; URL: http://www.cognition.ens.fr/~guerry/u/org-export-latex.el
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software: you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation, either version 3 of the License, or
19 ;; (at your option) any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;;; Commentary:
31 ;; This library implements a LaTeX exporter for org-mode.
33 ;; Put this file into your load-path and the following into your ~/.emacs:
34 ;; (require 'org-export-latex)
36 ;; The interactive functions are similar to those of the HTML exporter:
38 ;; M-x `org-export-as-latex'
39 ;; M-x `org-export-as-pdf'
40 ;; M-x `org-export-as-pdf-and-open'
41 ;; M-x `org-export-as-latex-batch'
42 ;; M-x `org-export-as-latex-to-buffer'
43 ;; M-x `org-export-region-as-latex'
44 ;; M-x `org-replace-region-by-latex'
46 ;;; Code:
48 (eval-when-compile
49 (require 'cl))
51 (require 'footnote)
52 (require 'org)
53 (require 'org-exp)
55 ;;; Variables:
56 (defvar org-export-latex-class nil)
57 (defvar org-export-latex-header nil)
58 (defvar org-export-latex-append-header nil)
59 (defvar org-export-latex-options-plist nil)
60 (defvar org-export-latex-todo-keywords-1 nil)
61 (defvar org-export-latex-all-targets-re nil)
62 (defvar org-export-latex-add-level 0)
63 (defvar org-export-latex-sectioning "")
64 (defvar org-export-latex-sectioning-depth 0)
65 (defvar org-export-latex-special-string-regexps
66 '(org-ts-regexp
67 org-scheduled-string
68 org-deadline-string
69 org-clock-string)
70 "A list of regexps to convert as special keywords.")
72 (defvar latexp) ; dynamically scoped from org.el
73 (defvar re-quote) ; dynamically scoped from org.el
74 (defvar commentsp) ; dynamically scoped from org.el
76 ;;; User variables:
78 (defgroup org-export-latex nil
79 "Options for exporting Org-mode files to LaTeX."
80 :tag "Org Export LaTeX"
81 :group 'org-export)
83 (defcustom org-export-latex-default-class "article"
84 "The default LaTeX class."
85 :group 'org-export-latex
86 :type '(string :tag "LaTeX class"))
88 (defcustom org-export-latex-classes
89 '(("article"
90 "\\documentclass[11pt,a4paper]{article}
91 \\usepackage[utf8]{inputenc}
92 \\usepackage[T1]{fontenc}
93 \\usepackage{graphicx}
94 \\usepackage{hyperref}"
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}"))
100 ("report"
101 "\\documentclass[11pt,a4paper]{report}
102 \\usepackage[utf8]{inputenc}
103 \\usepackage[T1]{fontenc}
104 \\usepackage{graphicx}
105 \\usepackage{hyperref}"
106 ("\\part{%s}" . "\\part*{%s}")
107 ("\\chapter{%s}" . "\\chapter*{%s}")
108 ("\\section{%s}" . "\\section*{%s}")
109 ("\\subsection{%s}" . "\\subsection*{%s}")
110 ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
111 ("book"
112 "\\documentclass[11pt,a4paper]{book}
113 \\usepackage[utf8]{inputenc}
114 \\usepackage[T1]{fontenc}
115 \\usepackage{graphicx}
116 \\usepackage{hyperref}"
117 ("\\part{%s}" . "\\part*{%s}")
118 ("\\chapter{%s}" . "\\chapter*{%s}")
119 ("\\section{%s}" . "\\section*{%s}")
120 ("\\subsection{%s}" . "\\subsection*{%s}")
121 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
122 "Alist of LaTeX classes and associated header and structure.
123 If #+LaTeX_CLASS is set in the buffer, use its value and the
124 associated information. Here is the structure of each cell:
126 \(class-name
127 header-string
128 (numbered-section . unnumbered-section\)
129 ...\)
131 A %s formatter is mandatory in each section string and will be
132 replaced by the title of the section.
134 Instead of a cons cell (numbered . unnumbered), you can also provide a list
135 of 2-4 elements,
137 (numbered-open numbered-close)
141 (numbered-open numbered-close unnumbered-open unnumbered-close)
143 providing opening and closing strings for an environment that should
144 represent the document section. The opening clause should have a %s
145 to represent the section title."
146 :group 'org-export-latex
147 :type '(repeat
148 (list (string :tag "LaTeX class")
149 (string :tag "LaTeX header")
150 (repeat :tag "Levels" :inline t
151 (choice
152 (cons :tag "Heading"
153 (string :tag "numbered")
154 (string :tag "unnumbered)"))
155 (list :tag "Environment"
156 (string :tag "Opening (numbered) ")
157 (string :tag "Closing (numbered) ")
158 (string :tag "Opening (unnumbered)")
159 (string :tag "Closing (unnumbered)")))))))
161 (defcustom org-export-latex-emphasis-alist
162 '(("*" "\\textbf{%s}" nil)
163 ("/" "\\emph{%s}" nil)
164 ("_" "\\underline{%s}" nil)
165 ("+" "\\texttt{%s}" nil)
166 ("=" "\\texttt{%s}" nil)
167 ("~" "\\texttt{%s}" t))
168 "Alist of LaTeX expressions to convert emphasis fontifiers.
169 Each element of the list is a list of three elements.
170 The first element is the character used as a marker for fontification.
171 The second element is a formatting string to wrap fontified text with.
172 The third element decides whether to protect converted text from other
173 conversions."
174 :group 'org-export-latex
175 :type 'alist)
177 (defcustom org-export-latex-title-command "\\maketitle"
178 "The command used to insert the title just after \\begin{document}.
179 If this string contains the formatting specification \"%s\" then
180 it will be used as a formatting string, passing the title as an
181 argument."
182 :group 'org-export-latex
183 :type 'string)
185 (defcustom org-export-latex-date-format
186 "%d %B %Y"
187 "Format string for \\date{...}."
188 :group 'org-export-latex
189 :type 'string)
191 (defcustom org-export-latex-tables-verbatim nil
192 "When non-nil, tables are exported verbatim."
193 :group 'org-export-latex
194 :type 'boolean)
196 (defcustom org-export-latex-tables-column-borders nil
197 "When non-nil, group of columns are surrounded with borders."
198 :group 'org-export-latex
199 :type 'boolean)
201 (defcustom org-export-latex-packages-alist nil
202 "Alist of packages to be inserted in the header.
203 Each cell is of the forma \( \"option\" . \"package\" \)."
204 :group 'org-export-latex
205 :type 'alist)
207 (defcustom org-export-latex-low-levels 'description
208 "How to convert sections below the current level of sectioning.
209 This is specified by the `org-export-headline-levels' option or the
210 value of \"H:\" in Org's #+OPTION line.
212 This can be either nil (skip the sections), 'description (convert
213 the sections as descriptive lists) or a string to be used instead
214 of \\section{%s}. In this latter case, the %s stands here for the
215 inserted headline and is mandatory."
216 :group 'org-export-latex
217 :type '(choice (const :tag "Ignore" nil)
218 (symbol :tag "Convert as descriptive list" description)
219 (string :tag "Use a section string" :value "\\subparagraph{%s}")))
221 (defcustom org-export-latex-remove-from-headlines
222 '(:todo t :priority t :tags t)
223 "A plist of keywords to remove from headlines.
224 Non-nil means remove this keyword type from the headline.
226 Don't remove the keys, just change their values."
227 :type 'plist
228 :group 'org-export-latex)
230 (defcustom org-export-latex-image-default-option "width=10em"
231 "Default option for images."
232 :group 'org-export-latex
233 :type 'string)
235 (defcustom org-export-latex-coding-system nil
236 "Coding system for the exported LaTex file."
237 :group 'org-export-latex
238 :type 'coding-system)
240 (defgroup org-export-pdf nil
241 "Options for exporting Org-mode files to PDF, via LaTeX."
242 :tag "Org Export LaTeX"
243 :group 'org-export-latex
244 :group 'org-export)
246 (defcustom org-export-pdf-remove-logfiles t
247 "Non-nil means, remove the logfiles produced by PDF production.
248 These are the .aux, .log, .out, and .toc files."
249 :group 'org-export-latex
250 :type 'boolean)
252 ;;; Autoload functions:
254 ;;;###autoload
255 (defun org-export-as-latex-batch ()
256 "Call `org-export-as-latex', may be used in batch processing.
257 For example:
259 emacs --batch
260 --load=$HOME/lib/emacs/org.el
261 --eval \"(setq org-export-headline-levels 2)\"
262 --visit=MyFile --funcall org-export-as-latex-batch"
263 (org-export-as-latex org-export-headline-levels 'hidden))
265 ;;;###autoload
266 (defun org-export-as-latex-to-buffer (arg)
267 "Call `org-exort-as-latex` with output to a temporary buffer.
268 No file is created. The prefix ARG is passed through to `org-export-as-latex'."
269 (interactive "P")
270 (org-export-as-latex arg nil nil "*Org LaTeX Export*")
271 (switch-to-buffer-other-window "*Org LaTeX Export*"))
273 ;;;###autoload
274 (defun org-replace-region-by-latex (beg end)
275 "Replace the region from BEG to END with its LaTeX export.
276 It assumes the region has `org-mode' syntax, and then convert it to
277 LaTeX. This can be used in any buffer. For example, you could
278 write an itemized list in `org-mode' syntax in an LaTeX buffer and
279 then use this command to convert it."
280 (interactive "r")
281 (let (reg latex buf)
282 (save-window-excursion
283 (if (org-mode-p)
284 (setq latex (org-export-region-as-latex
285 beg end t 'string))
286 (setq reg (buffer-substring beg end)
287 buf (get-buffer-create "*Org tmp*"))
288 (save-excursion
289 (set-buffer buf)
290 (erase-buffer)
291 (insert reg)
292 (org-mode)
293 (setq latex (org-export-region-as-latex
294 (point-min) (point-max) t 'string)))
295 (kill-buffer buf)))
296 (delete-region beg end)
297 (insert latex)))
299 ;;;###autoload
300 (defun org-export-region-as-latex (beg end &optional body-only buffer)
301 "Convert region from BEG to END in `org-mode' buffer to LaTeX.
302 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
303 contents, and only produce the region of converted text, useful for
304 cut-and-paste operations.
305 If BUFFER is a buffer or a string, use/create that buffer as a target
306 of the converted LaTeX. If BUFFER is the symbol `string', return the
307 produced LaTeX as a string and leave not buffer behind. For example,
308 a Lisp program could call this function in the following way:
310 (setq latex (org-export-region-as-latex beg end t 'string))
312 When called interactively, the output buffer is selected, and shown
313 in a window. A non-interactive call will only retunr the buffer."
314 (interactive "r\nP")
315 (when (interactive-p)
316 (setq buffer "*Org LaTeX Export*"))
317 (let ((transient-mark-mode t) (zmacs-regions t)
318 rtn)
319 (goto-char end)
320 (set-mark (point)) ;; to activate the region
321 (goto-char beg)
322 (setq rtn (org-export-as-latex
323 nil nil nil
324 buffer body-only))
325 (if (fboundp 'deactivate-mark) (deactivate-mark))
326 (if (and (interactive-p) (bufferp rtn))
327 (switch-to-buffer-other-window rtn)
328 rtn)))
330 ;;;###autoload
331 (defun org-export-as-latex (arg &optional hidden ext-plist
332 to-buffer body-only pub-dir)
333 "Export current buffer to a LaTeX file.
334 If there is an active region, export only the region. The prefix
335 ARG specifies how many levels of the outline should become
336 headlines. The default is 3. Lower levels will be exported
337 depending on `org-export-latex-low-levels'. The default is to
338 convert them as description lists. When HIDDEN is non-nil, don't
339 display the LaTeX buffer. EXT-PLIST is a property list with
340 external parameters overriding org-mode's default settings, but
341 still inferior to file-local settings. When TO-BUFFER is
342 non-nil, create a buffer with that name and export to that
343 buffer. If TO-BUFFER is the symbol `string', don't leave any
344 buffer behind but just return the resulting LaTeX as a string.
345 When BODY-ONLY is set, don't produce the file header and footer,
346 simply return the content of \begin{document}...\end{document},
347 without even the \begin{document} and \end{document} commands.
348 when PUB-DIR is set, use this as the publishing directory."
349 (interactive "P")
350 ;; Make sure we have a file name when we need it.
351 (when (and (not (or to-buffer body-only))
352 (not buffer-file-name))
353 (if (buffer-base-buffer)
354 (org-set-local 'buffer-file-name
355 (with-current-buffer (buffer-base-buffer)
356 buffer-file-name))
357 (error "Need a file name to be able to export")))
359 (message "Exporting to LaTeX...")
360 (org-update-radio-target-regexp)
361 (org-export-latex-set-initial-vars ext-plist arg)
362 (let* ((wcf (current-window-configuration))
363 (opt-plist org-export-latex-options-plist)
364 (region-p (org-region-active-p))
365 (rbeg (and region-p (region-beginning)))
366 (rend (and region-p (region-end)))
367 (subtree-p
368 (when region-p
369 (save-excursion
370 (goto-char rbeg)
371 (and (org-at-heading-p)
372 (>= (org-end-of-subtree t t) rend)))))
373 (opt-plist (if subtree-p
374 (org-export-add-subtree-options opt-plist rbeg)
375 opt-plist))
376 ;; Make sure the variable contains the updated values.
377 (org-export-latex-options-plist opt-plist)
378 (title (or (and subtree-p (org-export-get-title-from-subtree))
379 (plist-get opt-plist :title)
380 (and (not
381 (plist-get opt-plist :skip-before-1st-heading))
382 (org-export-grab-title-from-buffer))
383 (file-name-sans-extension
384 (file-name-nondirectory buffer-file-name))))
385 (filename (concat (file-name-as-directory
386 (or pub-dir
387 (org-export-directory :LaTeX ext-plist)))
388 (file-name-sans-extension
389 (or (and subtree-p
390 (org-entry-get rbeg "EXPORT_FILE_NAME" t))
391 (file-name-nondirectory ;sans-extension
392 buffer-file-name)))
393 ".tex"))
394 (filename (if (equal (file-truename filename)
395 (file-truename buffer-file-name))
396 (concat filename ".tex")
397 filename))
398 (buffer (if to-buffer
399 (cond
400 ((eq to-buffer 'string) (get-buffer-create
401 "*Org LaTeX Export*"))
402 (t (get-buffer-create to-buffer)))
403 (find-file-noselect filename)))
404 (odd org-odd-levels-only)
405 (header (org-export-latex-make-header title opt-plist))
406 (skip (cond (subtree-p nil)
407 (region-p t)
408 ;; never skip first lines when exporting a subtree
409 (t (plist-get opt-plist :skip-before-1st-heading))))
410 (text (plist-get opt-plist :text))
411 (first-lines (if skip "" (org-export-latex-first-lines)))
412 (coding-system (and (boundp 'buffer-file-coding-system)
413 buffer-file-coding-system))
414 (coding-system-for-write (or org-export-latex-coding-system
415 coding-system))
416 (save-buffer-coding-system (or org-export-latex-coding-system
417 coding-system))
418 (region (buffer-substring
419 (if region-p (region-beginning) (point-min))
420 (if region-p (region-end) (point-max))))
421 (string-for-export
422 (org-export-preprocess-string
423 region :emph-multiline t
424 :for-LaTeX t
425 :comments nil
426 :add-text (if (eq to-buffer 'string) nil text)
427 :skip-before-1st-heading skip
428 :select-tags (plist-get opt-plist :select-tags)
429 :exclude-tags (plist-get opt-plist :exclude-tags)
430 :LaTeX-fragments nil)))
432 (set-buffer buffer)
433 (erase-buffer)
435 (and (fboundp 'set-buffer-file-coding-system)
436 (set-buffer-file-coding-system coding-system-for-write))
438 ;; insert the header and initial document commands
439 (unless (or (eq to-buffer 'string) body-only)
440 (insert header))
442 ;; insert text found in #+TEXT
443 (when (and text (not (eq to-buffer 'string)))
444 (insert (org-export-latex-content
445 text '(lists tables fixed-width keywords))
446 "\n\n"))
448 ;; insert lines before the first headline
449 (unless (or skip (eq to-buffer 'string))
450 (insert first-lines))
452 ;; handle the case where the region does not begin with a section
453 (when region-p
454 (insert (with-temp-buffer
455 (insert string-for-export)
456 (org-export-latex-first-lines))))
458 ;; export the content of headlines
459 (org-export-latex-global
460 (with-temp-buffer
461 (insert string-for-export)
462 (goto-char (point-min))
463 (when (re-search-forward "^\\(\\*+\\) " nil t)
464 (let* ((asters (length (match-string 1)))
465 (level (if odd (- asters 2) (- asters 1))))
466 (setq org-export-latex-add-level
467 (if odd (1- (/ (1+ asters) 2)) (1- asters)))
468 (org-export-latex-parse-global level odd)))))
470 ;; finalization
471 (unless body-only (insert "\n\\end{document}"))
472 (or to-buffer (save-buffer))
473 (goto-char (point-min))
474 (message "Exporting to LaTeX...done")
475 (prog1
476 (if (eq to-buffer 'string)
477 (prog1 (buffer-substring (point-min) (point-max))
478 (kill-buffer (current-buffer)))
479 (current-buffer))
480 (set-window-configuration wcf))))
482 ;;;###autoload
483 (defun org-export-as-pdf (arg &optional hidden ext-plist
484 to-buffer body-only pub-dir)
485 "Export as LaTeX, then process through to PDF."
486 (interactive "P")
487 (message "Exporting to PDF...")
488 (let* ((wconfig (current-window-configuration))
489 (lbuf (org-export-as-latex arg hidden ext-plist
490 to-buffer body-only pub-dir))
491 (file (buffer-file-name lbuf))
492 (base (file-name-sans-extension (buffer-file-name lbuf)))
493 (pdffile (concat base ".pdf")))
494 (and (file-exists-p pdffile) (delete-file pdffile))
495 (message "Processing LaTeX file...")
496 (shell-command (format "pdflatex -interaction nonstopmode %s"
497 (shell-quote-argument file)))
498 (shell-command (format "pdflatex -interaction nonstopmode %s"
499 (shell-quote-argument file)))
500 (message "Processing LaTeX file...done")
501 (if (not (file-exists-p pdffile))
502 (error "PDF file was not produced")
503 (set-window-configuration wconfig)
504 (when org-export-pdf-remove-logfiles
505 (dolist (ext '("aux" "log" "out" "toc"))
506 (setq file (concat base "." ext))
507 (and (file-exists-p file) (delete-file file))))
508 (message "Exporting to PDF...done")
509 pdffile)))
511 ;;;###autoload
512 (defun org-export-as-pdf-and-open (arg)
513 "Export as LaTeX, then process through to PDF, and open."
514 (interactive "P")
515 (let ((pdffile (org-export-as-pdf arg)))
516 (if pdffile
517 (org-open-file pdffile)
518 (error "PDF file was not produced"))))
520 ;;; Parsing functions:
522 (defun org-export-latex-parse-global (level odd)
523 "Parse the current buffer recursively, starting at LEVEL.
524 If ODD is non-nil, assume the buffer only contains odd sections.
525 Return a list reflecting the document structure."
526 (save-excursion
527 (goto-char (point-min))
528 (let* ((cnt 0) output
529 (depth org-export-latex-sectioning-depth))
530 (while (re-search-forward
531 (concat "^\\(\\(?:\\*\\)\\{"
532 (number-to-string (+ (if odd 2 1) level))
533 "\\}\\) \\(.*\\)$")
534 ;; make sure that there is no upper heading
535 (when (> level 0)
536 (save-excursion
537 (save-match-data
538 (re-search-forward
539 (concat "^\\(\\(?:\\*\\)\\{"
540 (number-to-string level)
541 "\\}\\) \\(.*\\)$") nil t)))) t)
542 (setq cnt (1+ cnt))
543 (let* ((pos (match-beginning 0))
544 (heading (match-string 2))
545 (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
546 (save-excursion
547 (narrow-to-region
548 (point)
549 (save-match-data
550 (if (re-search-forward
551 (concat "^\\(\\(?:\\*\\)\\{"
552 (number-to-string (+ (if odd 2 1) level))
553 "\\}\\) \\(.*\\)$") nil t)
554 (match-beginning 0)
555 (point-max))))
556 (goto-char (point-min))
557 (setq output
558 (append output
559 (list
560 (list
561 `(pos . ,pos)
562 `(level . ,nlevel)
563 `(occur . ,cnt)
564 `(heading . ,heading)
565 `(content . ,(org-export-latex-parse-content))
566 `(subcontent . ,(org-export-latex-parse-subcontent
567 level odd)))))))
568 (widen)))
569 (list output))))
571 (defun org-export-latex-parse-content ()
572 "Extract the content of a section."
573 (let ((beg (point))
574 (end (if (re-search-forward "^\\(\\*\\)+ .*$" nil t)
575 (progn (beginning-of-line) (point))
576 (point-max))))
577 (buffer-substring beg end)))
579 (defun org-export-latex-parse-subcontent (level odd)
580 "Extract the subcontent of a section at LEVEL.
581 If ODD Is non-nil, assume subcontent only contains odd sections."
582 (if (not (re-search-forward
583 (concat "^\\(\\(?:\\*\\)\\{"
584 (number-to-string (+ (if odd 4 2) level))
585 "\\}\\) \\(.*\\)$")
586 nil t))
587 nil ; subcontent is nil
588 (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
590 ;;; Rendering functions:
591 (defun org-export-latex-global (content)
592 "Export CONTENT to LaTeX.
593 CONTENT is an element of the list produced by
594 `org-export-latex-parse-global'."
595 (if (eq (car content) 'subcontent)
596 (mapc 'org-export-latex-sub (cdr content))
597 (org-export-latex-sub (car content))))
599 (defun org-export-latex-sub (subcontent)
600 "Export the list SUBCONTENT to LaTeX.
601 SUBCONTENT is an alist containing information about the headline
602 and its content."
603 (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
604 (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
606 (defun org-export-latex-subcontent (subcontent num)
607 "Export each cell of SUBCONTENT to LaTeX.
608 If NUM, export sections as numerical sections."
609 (let* ((heading (org-export-latex-fontify-headline
610 (cdr (assoc 'heading subcontent))))
611 (level (- (cdr (assoc 'level subcontent))
612 org-export-latex-add-level))
613 (occur (number-to-string (cdr (assoc 'occur subcontent))))
614 (content (cdr (assoc 'content subcontent)))
615 (subcontent (cadr (assoc 'subcontent subcontent)))
616 (label (org-get-text-property-any 0 'target heading))
617 (label-list (cons label (cdr (assoc label
618 org-export-target-aliases)))))
619 (cond
620 ;; Normal conversion
621 ((<= level org-export-latex-sectioning-depth)
622 (let* ((sec (nth (1- level) org-export-latex-sectioning))
623 start end)
624 (if (consp (cdr sec))
625 (setq start (nth (if num 0 2) sec)
626 end (nth (if num 1 3) sec))
627 (setq start (if num (car sec) (cdr sec))))
628 (insert (format start heading) "\n")
629 (when label
630 (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
631 label-list "\n") "\n"))
632 (insert (org-export-latex-content content))
633 (cond ((stringp subcontent) (insert subcontent))
634 ((listp subcontent) (org-export-latex-sub subcontent)))
635 (if end (insert end "\n"))))
636 ;; At a level under the hl option: we can drop this subsection
637 ((> level org-export-latex-sectioning-depth)
638 (cond ((eq org-export-latex-low-levels 'description)
639 (insert (format "\\begin{description}\n\n\\item[%s]%s\n\n"
640 heading
641 (if label (format "\\label{%s}" label) "")))
642 (insert (org-export-latex-content content))
643 (cond ((stringp subcontent) (insert subcontent))
644 ((listp subcontent) (org-export-latex-sub subcontent)))
645 (insert "\\end{description}\n"))
646 ((stringp org-export-latex-low-levels)
647 (insert (format org-export-latex-low-levels heading) "\n")
648 (when label (insert (format "\\label{%s}\n" label)))
649 (insert (org-export-latex-content content))
650 (cond ((stringp subcontent) (insert subcontent))
651 ((listp subcontent) (org-export-latex-sub subcontent)))))))))
653 ;;; Exporting internals:
654 (defun org-export-latex-set-initial-vars (ext-plist level)
655 "Store org local variables required for LaTeX export.
656 EXT-PLIST is an optional additional plist.
657 LEVEL indicates the default depth for export."
658 (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
659 org-export-latex-all-targets-re
660 (org-make-target-link-regexp (org-all-targets))
661 org-export-latex-options-plist
662 (org-combine-plists (org-default-export-plist) ext-plist
663 (org-infile-export-plist))
664 org-export-latex-class
665 (save-excursion
666 (goto-char (point-min))
667 (if (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([a-zA-Z]+\\)" nil t)
668 (assoc (match-string 1) org-export-latex-classes))
669 (match-string 1)
670 org-export-latex-default-class))
671 org-export-latex-header
672 (cadr (assoc org-export-latex-class org-export-latex-classes))
673 org-export-latex-sectioning
674 (cddr (assoc org-export-latex-class org-export-latex-classes))
675 org-export-latex-sectioning-depth
676 (or level
677 (let ((hl-levels
678 (plist-get org-export-latex-options-plist :headline-levels))
679 (sec-depth (length org-export-latex-sectioning)))
680 (if (> hl-levels sec-depth) sec-depth hl-levels)))))
682 (defun org-export-latex-make-header (title opt-plist)
683 "Make the LaTeX header and return it as a string.
684 TITLE is the current title from the buffer or region.
685 OPT-PLIST is the options plist for current buffer."
686 (let ((toc (plist-get opt-plist :table-of-contents))
687 (author (plist-get opt-plist :author)))
688 (concat
689 (if (plist-get opt-plist :time-stamp-file)
690 (format-time-string "% Created %Y-%m-%d %a %H:%M\n"))
691 ;; insert LaTeX custom header
692 org-export-latex-header
693 "\n"
694 ;; insert information on LaTeX packages
695 (when org-export-latex-packages-alist
696 (mapconcat (lambda(p)
697 (if (equal "" (car p))
698 (format "\\usepackage{%s}" (cadr p))
699 (format "\\usepackage[%s]{%s}"
700 (car p) (cadr p))))
701 org-export-latex-packages-alist "\n"))
702 ;; insert additional commands in the header
703 (plist-get opt-plist :latex-header-extra)
704 org-export-latex-append-header
705 ;; insert the title
706 (format
707 "\n\n\\title{%s}\n"
708 ;; convert the title
709 (org-export-latex-content
710 title '(lists tables fixed-width keywords)))
711 ;; insert author info
712 (if (plist-get opt-plist :author-info)
713 (format "\\author{%s}\n"
714 (or author user-full-name))
715 (format "%%\\author{%s}\n"
716 (or author user-full-name)))
717 ;; insert the date
718 (format "\\date{%s}\n"
719 (format-time-string
720 (or (plist-get opt-plist :date)
721 org-export-latex-date-format)))
722 ;; beginning of the document
723 "\n\\begin{document}\n\n"
724 ;; insert the title command
725 (if (string-match "%s" org-export-latex-title-command)
726 (format org-export-latex-title-command title)
727 org-export-latex-title-command)
728 "\n\n"
729 ;; table of contents
730 (when (and org-export-with-toc
731 (plist-get opt-plist :section-numbers))
732 (cond ((numberp toc)
733 (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\n"
734 (min toc (plist-get opt-plist :headline-levels))))
735 (toc (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\n"
736 (plist-get opt-plist :headline-levels))))))))
738 (defun org-export-latex-first-lines (&optional comments)
739 "Export the first lines before first headline.
740 COMMENTS is either nil to replace them with the empty string or a
741 formatting string like %%%%s if we want to comment them out."
742 (save-excursion
743 (goto-char (point-min))
744 (if (org-at-heading-p) (beginning-of-line 2))
745 (let* ((pt (point))
746 (end (if (and (re-search-forward "^\\* " nil t)
747 (not (eq pt (match-beginning 0))))
748 (goto-char (match-beginning 0))
749 (goto-char (point-max)))))
750 (org-export-latex-content
751 (org-export-preprocess-string
752 (buffer-substring (point-min) end)
753 :for-LaTeX t
754 :emph-multiline t
755 :add-text nil
756 :comments nil
757 :skip-before-1st-heading nil
758 :LaTeX-fragments nil)))))
760 (defun org-export-latex-content (content &optional exclude-list)
761 "Convert CONTENT string to LaTeX.
762 Don't perform conversions that are in EXCLUDE-LIST. Recognized
763 conversion types are: quotation-marks, emphasis, sub-superscript,
764 links, keywords, lists, tables, fixed-width"
765 (with-temp-buffer
766 (insert content)
767 (unless (memq 'quotation-marks exclude-list)
768 (org-export-latex-quotation-marks))
769 (unless (memq 'emphasis exclude-list)
770 (when (plist-get org-export-latex-options-plist :emphasize)
771 (org-export-latex-fontify)))
772 (unless (memq 'sub-superscript exclude-list)
773 (org-export-latex-special-chars
774 (plist-get org-export-latex-options-plist :sub-superscript)))
775 (unless (memq 'links exclude-list)
776 (org-export-latex-links))
777 (unless (memq 'keywords exclude-list)
778 (org-export-latex-keywords
779 (plist-get org-export-latex-options-plist :timestamps)))
780 (unless (memq 'lists exclude-list)
781 (org-export-latex-lists))
782 (unless (memq 'tables exclude-list)
783 (org-export-latex-tables
784 (plist-get org-export-latex-options-plist :tables)))
785 (unless (memq 'fixed-width exclude-list)
786 (org-export-latex-fixed-width
787 (plist-get org-export-latex-options-plist :fixed-width)))
788 ;; return string
789 (buffer-substring (point-min) (point-max))))
791 (defun org-export-latex-protect-string (s)
792 "Add the org-protected property to string S."
793 (add-text-properties 0 (length s) '(org-protected t) s) s)
795 (defun org-export-latex-protect-char-in-string (char-list string)
796 "Add org-protected text-property to char from CHAR-LIST in STRING."
797 (with-temp-buffer
798 (save-match-data
799 (insert string)
800 (goto-char (point-min))
801 (while (re-search-forward (regexp-opt char-list) nil t)
802 (add-text-properties (match-beginning 0)
803 (match-end 0) '(org-protected t)))
804 (buffer-string))))
806 (defun org-export-latex-keywords-maybe (remove-list)
807 "Maybe remove keywords depending on rules in REMOVE-LIST."
808 (goto-char (point-min))
809 (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
810 (case-fold-search nil))
811 ;; convert TODO keywords
812 (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
813 (if (plist-get remove-list :todo)
814 (replace-match "")
815 (replace-match (format "\\texttt{%s}" (match-string 1)) t t)))
816 ;; convert priority string
817 (when (re-search-forward "\\[\\\\#.\\]" nil t)
818 (if (plist-get remove-list :priority)
819 (replace-match "")
820 (replace-match (format "\\texttt{%s}" (match-string 0)) t t)))
821 ;; convert tags
822 (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t)
823 (if (or (not org-export-with-tags)
824 (plist-get remove-list :tags))
825 (replace-match "")
826 (replace-match
827 (org-export-latex-protect-string
828 (format "\\texttt{%s}"
829 (save-match-data
830 (replace-regexp-in-string
831 "_" "\\\\_" (match-string 0)))))
832 t t)))))
834 (defun org-export-latex-fontify-headline (string)
835 "Fontify special words in STRING."
836 (with-temp-buffer
837 ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
838 ;; the beginning of the buffer - inserting "\n" is safe here though.
839 (insert "\n" string)
840 (goto-char (point-min))
841 (when (plist-get org-export-latex-options-plist :emphasize)
842 (org-export-latex-fontify))
843 (org-export-latex-keywords-maybe
844 org-export-latex-remove-from-headlines)
845 (org-export-latex-special-chars
846 (plist-get org-export-latex-options-plist :sub-superscript))
847 (org-export-latex-links)
848 ; (org-trim (buffer-substring-no-properties (point-min) (point-max)))))
849 (org-trim (buffer-string))))
851 (defun org-export-latex-quotation-marks ()
852 "Export quotation marks depending on language conventions."
853 (let* ((lang (plist-get org-export-latex-options-plist :language))
854 (quote-rpl (if (equal lang "fr")
855 '(("\\(\\s-\\)\"" "«~")
856 ("\\(\\S-\\)\"" "~»")
857 ("\\(\\s-\\)'" "`"))
858 '(("\\(\\s-\\)\"" "``")
859 ("\\(\\S-\\)\"" "''")
860 ("\\(\\s-\\)'" "`")))))
861 (mapc (lambda(l) (goto-char (point-min))
862 (while (re-search-forward (car l) nil t)
863 (let ((rpl (concat (match-string 1) (cadr l))))
864 (org-export-latex-protect-string rpl)
865 (org-if-unprotected
866 (replace-match rpl t t))))) quote-rpl)))
868 (defun org-export-latex-special-chars (sub-superscript)
869 "Export special characters to LaTeX.
870 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
871 See the `org-export-latex.el' code for a complete conversion table."
872 (goto-char (point-min))
873 (mapc (lambda(c)
874 (goto-char (point-min))
875 (while (re-search-forward c nil t)
876 ;; Put the point where to check for org-protected
877 (unless (or (get-text-property (match-beginning 2) 'org-protected)
878 (org-at-table-p))
879 (cond ((member (match-string 2) '("\\$" "$"))
880 (if (equal (match-string 2) "\\$")
881 (replace-match (concat (match-string 1) "$"
882 (match-string 3)) t t)
883 (replace-match (concat (match-string 1) "\\$"
884 (match-string 3)) t t)))
885 ((member (match-string 2) '("&" "%" "#"))
886 (if (equal (match-string 1) "\\")
887 (replace-match (match-string 2) t t)
888 (replace-match (concat (match-string 1) "\\"
889 (match-string 2)) t t)))
890 ((equal (match-string 2) "...")
891 (replace-match
892 (concat (match-string 1)
893 (org-export-latex-protect-string "\\ldots{}")) t t))
894 ((equal (match-string 2) "~")
895 (cond ((equal (match-string 1) "\\") nil)
896 ((eq 'org-link (get-text-property 0 'face (match-string 2)))
897 (replace-match (concat (match-string 1) "\\~") t t))
898 (t (replace-match
899 (org-export-latex-protect-string
900 (concat (match-string 1) "\\~{}")) t t))))
901 ((member (match-string 2) '("{" "}"))
902 (unless (save-match-data (org-inside-LaTeX-fragment-p))
903 (if (equal (match-string 1) "\\")
904 (replace-match (match-string 2) t t)
905 (replace-match (concat (match-string 1) "\\"
906 (match-string 2)) t t)))))
907 (unless (save-match-data (org-inside-LaTeX-fragment-p))
908 (cond ((equal (match-string 2) "\\")
909 (replace-match (or (save-match-data
910 (org-export-latex-treat-backslash-char
911 (match-string 1)
912 (match-string 3))) "") t t))
913 ((member (match-string 2) '("_" "^"))
914 (replace-match (or (save-match-data
915 (org-export-latex-treat-sub-super-char
916 sub-superscript
917 (match-string 2)
918 (match-string 1)
919 (match-string 3))) "") t t)))))))
920 '("^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
921 "\\([a-za-z0-9]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\([a-za-z0-9]+\\|[ \t\n]\\|[:punct:]\\|{[a-za-z0-9]+}\\|([a-za-z0-9]+)\\)"
922 "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|[a-zA-Z&#%{}\"]+\\)"
923 "\\(.\\|^\\)\\(&\\)"
924 "\\(.\\|^\\)\\(#\\)"
925 "\\(.\\|^\\)\\(%\\)"
926 "\\(.\\|^\\)\\({\\)"
927 "\\(.\\|^\\)\\(}\\)"
928 "\\(.\\|^\\)\\(~\\)"
929 "\\(.\\|^\\)\\(\\.\\.\\.\\)"
930 ;; (?\< . "\\textless{}")
931 ;; (?\> . "\\textgreater{}")
934 (defun org-export-latex-treat-sub-super-char
935 (subsup char string-before string-after)
936 "Convert the \"_\" and \"^\" characters to LaTeX.
937 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
938 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
939 (cond ((equal string-before "\\")
940 (concat string-before char string-after))
941 ;; this is part of a math formula
942 ((and (string-match "\\S-+" string-before)
943 (string-match "\\S-+" string-after))
944 (cond ((eq 'org-link (get-text-property 0 'face char))
945 (concat string-before "\\" char string-after))
946 ((save-match-data (org-inside-LaTeX-fragment-p))
947 (if subsup
948 (cond ((eq 1 (length string-after))
949 (concat string-before char string-after))
950 ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
951 (format "%s%s{%s}" string-before char
952 (match-string 1 string-after))))))
953 ((and (> (length string-after) 1)
954 (or (eq subsup t)
955 (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
956 (string-match "[({]?\\([^)}]+\\)[)}]?" string-after))
957 (format "%s$%s{%s}$" string-before char
958 (if (> (match-end 1) (1+ (match-beginning 1)))
959 (concat "\\mathrm{" (match-string 1 string-after) "}")
960 (match-string 1 string-after))))
961 ((eq subsup t) (concat string-before "$" char string-after "$"))
962 (t (org-export-latex-protect-string
963 (concat string-before "\\" char "{}" string-after)))))
964 (t (org-export-latex-protect-string
965 (concat string-before "\\" char "{}" string-after)))))
967 (defun org-export-latex-treat-backslash-char (string-before string-after)
968 "Convert the \"$\" special character to LaTeX.
969 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
970 (cond ((member (list string-after) org-html-entities)
971 ;; backslash is part of a special entity (like "\alpha")
972 (concat string-before "$\\"
973 (or (cdar (member (list string-after) org-html-entities))
974 string-after) "$"))
975 ((and (not (string-match "^[ \n\t]" string-after))
976 (not (string-match "[ \t]\\'\\|^" string-before)))
977 ;; backslash is inside a word
978 (org-export-latex-protect-string
979 (concat string-before "\\textbackslash{}" string-after)))
980 ((not (or (equal string-after "")
981 (string-match "^[ \t\n]" string-after)))
982 ;; backslash might escape a character (like \#) or a user TeX
983 ;; macro (like \setcounter)
984 (org-export-latex-protect-string
985 (concat string-before "\\" string-after)))
986 ((and (string-match "^[ \t\n]" string-after)
987 (string-match "[ \t\n]\\'" string-before))
988 ;; backslash is alone, convert it to $\backslash$
989 (org-export-latex-protect-string
990 (concat string-before "\\textbackslash{}" string-after)))
991 (t (org-export-latex-protect-string
992 (concat string-before "\\textbackslash{}" string-after)))))
994 (defun org-export-latex-keywords (timestamps)
995 "Convert special keywords to LaTeX.
996 Regexps are those from `org-export-latex-special-string-regexps'.
997 If TIMESTAMPS, convert timestamps, otherwise delete them."
998 (let ((rg org-export-latex-special-string-regexps) r)
999 (while (setq r (pop rg))
1000 (goto-char (point-min))
1001 (while (re-search-forward (eval r) nil t)
1002 (if (not timestamps)
1003 (replace-match (format "\\\\texttt{%s}" (match-string 0)) t)
1004 (replace-match ""))))))
1006 (defun org-export-latex-fixed-width (opt)
1007 "When OPT is non-nil convert fixed-width sections to LaTeX."
1008 (goto-char (point-min))
1009 (while (re-search-forward "^[ \t]*:" nil t)
1010 (if opt
1011 (progn (goto-char (match-beginning 0))
1012 (insert "\\begin{verbatim}\n")
1013 (while (looking-at "^\\([ \t]*\\):\\(.*\\)$")
1014 (replace-match (concat (match-string 1)
1015 (match-string 2)) t t)
1016 (forward-line))
1017 (insert "\\end{verbatim}\n\n"))
1018 (progn (goto-char (match-beginning 0))
1019 (while (looking-at "^\\([ \t]*\\):\\(.*\\)$")
1020 (replace-match (concat "%" (match-string 1)
1021 (match-string 2)) t t)
1022 (forward-line))))))
1025 (defvar org-table-last-alignment) ; defined in org-table.el
1026 (declare-function orgtbl-to-latex "org-table" (table params) t)
1027 (defun org-export-latex-tables (insert)
1028 "Convert tables to LaTeX and INSERT it."
1029 (goto-char (point-min))
1030 (while (re-search-forward "^\\([ \t]*\\)|" nil t)
1031 ;; FIXME really need to save-excursion?
1032 (save-excursion (org-table-align))
1033 (let* ((beg (org-table-begin))
1034 (end (org-table-end))
1035 (raw-table (buffer-substring-no-properties beg end))
1036 fnum fields line lines olines gr colgropen line-fmt align)
1037 (if org-export-latex-tables-verbatim
1038 (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1039 "\\end{verbatim}\n")))
1040 (apply 'delete-region (list beg end))
1041 (insert (org-export-latex-protect-string tbl)))
1042 (progn
1043 (setq lines (split-string raw-table "\n" t))
1044 (apply 'delete-region (list beg end))
1045 (when org-export-table-remove-special-lines
1046 (setq lines (org-table-clean-before-export lines)))
1047 ;; make a formatting string to reflect aligment
1048 (setq olines lines)
1049 (while (and (not line-fmt) (setq line (pop olines)))
1050 (unless (string-match "^[ \t]*|-" line)
1051 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1052 (setq fnum (make-vector (length fields) 0))
1053 (setq line-fmt
1054 (mapconcat
1055 (lambda (x)
1056 (setq gr (pop org-table-colgroup-info))
1057 (format "%s%%s%s"
1058 (cond ((eq gr ':start)
1059 (prog1 (if colgropen "|" "")
1060 (setq colgropen t)))
1061 ((eq gr ':startend)
1062 (prog1 (if colgropen "|" "|")
1063 (setq colgropen nil)))
1064 (t ""))
1065 (if (memq gr '(:end :startend))
1066 (progn (setq colgropen nil) "|")
1067 "")))
1068 fnum ""))))
1069 ;; fix double || in line-fmt
1070 (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
1071 ;; maybe remove the first and last "|"
1072 (when (and (not org-export-latex-tables-column-borders)
1073 (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
1074 (setq line-fmt (match-string 2 line-fmt)))
1075 ;; format alignment
1076 (setq align (apply 'format
1077 (cons line-fmt
1078 (mapcar (lambda (x) (if x "r" "l"))
1079 org-table-last-alignment))))
1080 ;; prepare the table to send to orgtbl-to-latex
1081 (setq lines
1082 (mapcar
1083 (lambda(elem)
1084 (or (and (string-match "[ \t]*|-+" elem) 'hline)
1085 (split-string (org-trim elem) "|" t)))
1086 lines))
1087 (when insert
1088 (insert (org-export-latex-protect-string
1089 (orgtbl-to-latex
1090 lines `(:tstart ,(concat "\\begin{tabular}{" align "}"))))
1091 "\n\n")))))))
1093 (defun org-export-latex-fontify ()
1094 "Convert fontification to LaTeX."
1095 (goto-char (point-min))
1096 (while (re-search-forward org-emph-re nil t)
1097 ;; The match goes one char after the *string*
1098 (let ((emph (assoc (match-string 3)
1099 org-export-latex-emphasis-alist))
1100 rpl)
1101 (unless (get-text-property (1- (point)) 'org-protected)
1102 (setq rpl (concat (match-string 1)
1103 (format (org-export-latex-protect-char-in-string
1104 '("\\" "{" "}") (cadr emph))
1105 (match-string 4))
1106 (match-string 5)))
1107 (if (caddr emph)
1108 (setq rpl (org-export-latex-protect-string rpl)))
1109 (replace-match rpl t t)))
1110 (backward-char)))
1112 (defun org-export-latex-links ()
1113 ;; Make sure to use the LaTeX hyperref and graphicx package
1114 ;; or send some warnings.
1115 "Convert links to LaTeX."
1116 (goto-char (point-min))
1117 (while (re-search-forward org-bracket-link-analytic-regexp nil t)
1118 (org-if-unprotected
1119 (goto-char (match-beginning 0))
1120 (let* ((re-radio org-export-latex-all-targets-re)
1121 (remove (list (match-beginning 0) (match-end 0)))
1122 (type (match-string 2))
1123 (raw-path (org-extract-attributes (match-string 3)))
1124 (full-raw-path (concat (match-string 1) raw-path))
1125 (desc (match-string 5))
1126 imgp radiop
1127 ;; define the path of the link
1128 (path (cond
1129 ((member type '("http" "https" "ftp"))
1130 (concat type ":" raw-path))
1131 ((and re-radio (string-match re-radio raw-path))
1132 (setq radiop t))
1133 ((equal type "mailto")
1134 (concat type ":" raw-path))
1135 ((equal type "file")
1136 (if (and (or (org-file-image-p (expand-file-name raw-path))
1137 (string-match "\\.eps$" raw-path))
1138 (equal desc full-raw-path))
1139 (setq imgp t)
1140 (progn (when (string-match "\\(.+\\)::.+" raw-path)
1141 (setq raw-path (match-string 1 raw-path)))
1142 (if (file-exists-p raw-path)
1143 (concat type "://" (expand-file-name raw-path))
1144 (concat type "://" (org-export-directory
1145 :LaTeX org-export-latex-options-plist)
1146 raw-path))))))))
1147 ;; process with link inserting
1148 (apply 'delete-region remove)
1149 (cond ((and imgp (plist-get org-export-latex-options-plist :inline-images))
1150 (insert (format "\\includegraphics[%s]{%s}"
1151 ;; image option should be set be a comment line
1152 org-export-latex-image-default-option
1153 (expand-file-name raw-path))))
1154 (radiop (insert (format "\\hyperref[%s]{%s}"
1155 (org-solidify-link-text raw-path) desc)))
1156 ((not type)
1157 (insert (format "\\hyperref[%s]{%s}"
1158 (org-solidify-link-text raw-path) desc)))
1159 (path (insert (format "\\href{%s}{%s}" path desc)))
1160 (t (insert "\\texttt{" desc "}")))))))
1162 (defvar org-latex-entities) ; defined below
1163 (defvar org-latex-entities-regexp) ; defined below
1165 (defun org-export-latex-preprocess ()
1166 "Clean stuff in the LaTeX export."
1168 ;; Preserve line breaks
1169 (goto-char (point-min))
1170 (while (re-search-forward "\\\\\\\\" nil t)
1171 (add-text-properties (match-beginning 0) (match-end 0)
1172 '(org-protected t)))
1174 ;; Preserve latex environments
1175 (goto-char (point-min))
1176 (while (re-search-forward "^[ \t]*\\begin{\\([a-zA-Z]+\\)}" nil t)
1177 (let* ((start (progn (beginning-of-line) (point)))
1178 (end (or (and (re-search-forward
1179 (concat "^[ \t]*\\end{" (match-string 1) "}" nil t)
1180 (point-at-eol)))
1181 (point-max))))
1182 (add-text-properties start end '(org-protected t))))
1184 ;; Convert LaTeX to \LaTeX{}
1185 (goto-char (point-min))
1186 (let ((case-fold-search nil) rpl)
1187 (while (re-search-forward "\\([^+_]\\)LaTeX" nil t)
1188 (replace-match (org-export-latex-protect-string
1189 (concat (match-string 1) "\\LaTeX{}")) t t)))
1191 ;; Convert blockquotes
1192 (goto-char (point-min))
1193 (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
1194 (replace-match "\\begin{quote}" t t))
1195 (goto-char (point-min))
1196 (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
1197 (replace-match "\\end{quote}" t t))
1199 ;; Convert verse
1200 (goto-char (point-min))
1201 (while (search-forward "ORG-VERSE-START" nil t)
1202 (replace-match "\\begin{verse}" t t))
1203 (goto-char (point-min))
1204 (while (search-forward "ORG-VERSE-END" nil t)
1205 (replace-match "\\end{verse}" t t))
1207 ;; Convert horizontal rules
1208 (goto-char (point-min))
1209 (while (re-search-forward "^----+.$" nil t)
1210 (replace-match (org-export-latex-protect-string "\\hrule") t t))
1212 ;; Protect LaTeX commands like \commad[...]{...} or \command{...}
1213 (goto-char (point-min))
1214 (while (re-search-forward "\\\\[a-zA-Z]+\\(?:\\[.*\\]\\)?{.*}" nil t)
1215 (add-text-properties (match-beginning 0) (match-end 0)
1216 '(org-protected t)))
1218 ;; Protect LaTeX entities
1219 (goto-char (point-min))
1220 (while (re-search-forward org-latex-entities-regexp nil t)
1221 (add-text-properties (match-beginning 0) (match-end 0)
1222 '(org-protected t)))
1224 ;; Replace radio links
1225 (goto-char (point-min))
1226 (while (re-search-forward
1227 (concat "<<<?" org-export-latex-all-targets-re
1228 ">>>?\\((INVISIBLE)\\)?") nil t)
1229 (replace-match
1230 (org-export-latex-protect-string
1231 (format "\\label{%s}%s" (save-match-data (org-solidify-link-text
1232 (match-string 1)))
1233 (if (match-string 2) "" (match-string 1)))) t t))
1235 ;; Delete @<...> constructs
1236 ;; Thanks to Daniel Clemente for this regexp
1237 (goto-char (point-min))
1238 (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
1239 (replace-match ""))
1241 ;; When converting to LaTeX, replace footnotes
1242 ;; FIXME: don't protect footnotes from conversion
1243 (when (plist-get org-export-latex-options-plist :footnotes)
1244 (goto-char (point-min))
1245 (while (re-search-forward "\\[[0-9]+\\]" nil t)
1246 (when (save-match-data
1247 (save-excursion (beginning-of-line)
1248 (looking-at "[^:|#]")))
1249 (let ((foot-beg (match-beginning 0))
1250 (foot-end (match-end 0))
1251 (foot-prefix (match-string 0))
1252 footnote footnote-rpl)
1253 (save-excursion
1254 (when (search-forward foot-prefix nil t)
1255 (replace-match "")
1256 (let ((end (save-excursion
1257 (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t)
1258 (match-beginning 0) (point-max)))))
1259 (setq footnote (concat (org-trim (buffer-substring (point) end))
1260 " ")) ; prevent last } being part of a link
1261 (delete-region (point) end))
1262 (goto-char foot-beg)
1263 (delete-region foot-beg foot-end)
1264 (unless (null footnote)
1265 (setq footnote-rpl (format "\\footnote{%s}" footnote))
1266 (add-text-properties 0 10 '(org-protected t) footnote-rpl)
1267 (add-text-properties (1- (length footnote-rpl))
1268 (length footnote-rpl)
1269 '(org-protected t) footnote-rpl)
1270 (insert footnote-rpl)))))))
1272 ;; Replace footnote section tag for LaTeX
1273 (goto-char (point-min))
1274 (while (re-search-forward
1275 (concat "^" footnote-section-tag-regexp) nil t)
1276 (replace-match ""))))
1278 ;;; List handling:
1280 (defun org-export-latex-lists ()
1281 "Replace plain text lists in current buffer into LaTeX lists."
1282 "Convert lists to LaTeX."
1283 (goto-char (point-min))
1284 (while (re-search-forward org-list-beginning-re nil t)
1285 (org-if-unprotected
1286 (beginning-of-line)
1287 (insert (org-list-to-latex (org-list-parse-list t)) "\n"))))
1289 (defconst org-latex-entities
1290 '("\\!"
1291 "\\'"
1292 "\\+"
1293 "\\,"
1294 "\\-"
1295 "\\:"
1296 "\\;"
1297 "\\<"
1298 "\\="
1299 "\\>"
1300 "\\Huge"
1301 "\\LARGE"
1302 "\\Large"
1303 "\\Styles"
1304 "\\\\"
1305 "\\`"
1306 "\\addcontentsline"
1307 "\\address"
1308 "\\addtocontents"
1309 "\\addtocounter"
1310 "\\addtolength"
1311 "\\addvspace"
1312 "\\alph"
1313 "\\appendix"
1314 "\\arabic"
1315 "\\author"
1316 "\\begin{array}"
1317 "\\begin{center}"
1318 "\\begin{description}"
1319 "\\begin{enumerate}"
1320 "\\begin{eqnarray}"
1321 "\\begin{equation}"
1322 "\\begin{figure}"
1323 "\\begin{flushleft}"
1324 "\\begin{flushright}"
1325 "\\begin{itemize}"
1326 "\\begin{list}"
1327 "\\begin{minipage}"
1328 "\\begin{picture}"
1329 "\\begin{quotation}"
1330 "\\begin{quote}"
1331 "\\begin{tabbing}"
1332 "\\begin{table}"
1333 "\\begin{tabular}"
1334 "\\begin{thebibliography}"
1335 "\\begin{theorem}"
1336 "\\begin{titlepage}"
1337 "\\begin{verbatim}"
1338 "\\begin{verse}"
1339 "\\bf"
1340 "\\bf"
1341 "\\bibitem"
1342 "\\bigskip"
1343 "\\cdots"
1344 "\\centering"
1345 "\\circle"
1346 "\\cite"
1347 "\\cleardoublepage"
1348 "\\clearpage"
1349 "\\cline"
1350 "\\closing"
1351 "\\dashbox"
1352 "\\date"
1353 "\\ddots"
1354 "\\dotfill"
1355 "\\em"
1356 "\\fbox"
1357 "\\flushbottom"
1358 "\\fnsymbol"
1359 "\\footnote"
1360 "\\footnotemark"
1361 "\\footnotesize"
1362 "\\footnotetext"
1363 "\\frac"
1364 "\\frame"
1365 "\\framebox"
1366 "\\hfill"
1367 "\\hline"
1368 "\\hrulespace"
1369 "\\hspace"
1370 "\\huge"
1371 "\\hyphenation"
1372 "\\include"
1373 "\\includeonly"
1374 "\\indent"
1375 "\\input"
1376 "\\it"
1377 "\\kill"
1378 "\\label"
1379 "\\large"
1380 "\\ldots"
1381 "\\line"
1382 "\\linebreak"
1383 "\\linethickness"
1384 "\\listoffigures"
1385 "\\listoftables"
1386 "\\location"
1387 "\\makebox"
1388 "\\maketitle"
1389 "\\mark"
1390 "\\mbox"
1391 "\\medskip"
1392 "\\multicolumn"
1393 "\\multiput"
1394 "\\newcommand"
1395 "\\newcounter"
1396 "\\newenvironment"
1397 "\\newfont"
1398 "\\newlength"
1399 "\\newline"
1400 "\\newpage"
1401 "\\newsavebox"
1402 "\\newtheorem"
1403 "\\nocite"
1404 "\\nofiles"
1405 "\\noindent"
1406 "\\nolinebreak"
1407 "\\nopagebreak"
1408 "\\normalsize"
1409 "\\onecolumn"
1410 "\\opening"
1411 "\\oval"
1412 "\\overbrace"
1413 "\\overline"
1414 "\\pagebreak"
1415 "\\pagenumbering"
1416 "\\pageref"
1417 "\\pagestyle"
1418 "\\par"
1419 "\\parbox"
1420 "\\put"
1421 "\\raggedbottom"
1422 "\\raggedleft"
1423 "\\raggedright"
1424 "\\raisebox"
1425 "\\ref"
1426 "\\rm"
1427 "\\roman"
1428 "\\rule"
1429 "\\savebox"
1430 "\\sc"
1431 "\\scriptsize"
1432 "\\setcounter"
1433 "\\setlength"
1434 "\\settowidth"
1435 "\\sf"
1436 "\\shortstack"
1437 "\\signature"
1438 "\\sl"
1439 "\\small"
1440 "\\smallskip"
1441 "\\sqrt"
1442 "\\tableofcontents"
1443 "\\telephone"
1444 "\\thanks"
1445 "\\thispagestyle"
1446 "\\tiny"
1447 "\\title"
1448 "\\tt"
1449 "\\twocolumn"
1450 "\\typein"
1451 "\\typeout"
1452 "\\underbrace"
1453 "\\underline"
1454 "\\usebox"
1455 "\\usecounter"
1456 "\\value"
1457 "\\vdots"
1458 "\\vector"
1459 "\\verb"
1460 "\\vfill"
1461 "\\vline"
1462 "\\vspace")
1463 "A list of LaTeX commands to be protected when performing conversion.")
1465 (defconst org-latex-entities-regexp
1466 (let (names rest)
1467 (dolist (x org-latex-entities)
1468 (if (string-match "[a-z][A-Z]$" x)
1469 (push x names)
1470 (push x rest)))
1471 (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
1472 "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
1474 (provide 'org-export-latex)
1476 ;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
1478 ;;; org-export-latex.el ends here