1 ;;; org-e-latex.el --- LaTeX Back-End For Org Export Engine
3 ;; Copyright (C) 2011-2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;; This library implements a LaTeX back-end for Org generic exporter.
27 ;; M-: (org-export-to-buffer 'e-latex "*Test e-LaTeX*") RET
29 ;; in an org-mode buffer then switch to the buffer to see the LaTeX
30 ;; export. See contrib/lisp/org-export.el for more details on how
31 ;; this exporter works.
33 ;; It introduces three new buffer keywords: "LATEX_CLASS",
34 ;; "LATEX_CLASS_OPTIONS" and "LATEX_HEADER".
38 (eval-when-compile (require 'cl
))
40 (defvar org-export-latex-default-packages-alist
)
41 (defvar org-export-latex-packages-alist
)
43 (declare-function org-element-property
"org-element" (property element
))
44 (declare-function org-element-normalize-string
"org-element" (s))
45 (declare-function org-element-parse-secondary-string
46 "org-element" (string restriction
&optional buffer
))
47 (defvar org-element-string-restrictions
)
48 (defvar org-element-object-restrictions
)
50 (declare-function org-export-clean-table
"org-export" (table specialp
))
51 (declare-function org-export-data
"org-export" (data backend info
))
52 (declare-function org-export-directory
"org-export" (type plist
))
53 (declare-function org-export-expand-macro
"org-export" (macro info
))
54 (declare-function org-export-first-sibling-p
"org-export" (headline info
))
55 (declare-function org-export-footnote-first-reference-p
"org-export"
56 (footnote-reference info
))
57 (declare-function org-export-get-coderef-format
"org-export" (path desc
))
58 (declare-function org-export-get-footnote-definition
"org-export"
59 (footnote-reference info
))
60 (declare-function org-export-get-footnote-number
"org-export" (footnote info
))
61 (declare-function org-export-get-previous-element
"org-export" (blob info
))
62 (declare-function org-export-get-relative-level
"org-export" (headline info
))
63 (declare-function org-export-handle-code
64 "org-export" (element info
&optional num-fmt ref-fmt delayed
))
65 (declare-function org-export-included-file
"org-export" (keyword backend info
))
66 (declare-function org-export-inline-image-p
"org-export"
67 (link &optional extensions
))
68 (declare-function org-export-last-sibling-p
"org-export" (headline info
))
69 (declare-function org-export-low-level-p
"org-export" (headline info
))
70 (declare-function org-export-output-file-name
71 "org-export" (extension &optional subtreep pub-dir
))
72 (declare-function org-export-resolve-coderef
"org-export" (ref info
))
73 (declare-function org-export-resolve-fuzzy-link
"org-export" (link info
))
74 (declare-function org-export-secondary-string
"org-export"
75 (secondary backend info
))
76 (declare-function org-export-solidify-link-text
"org-export" (s))
77 (declare-function org-export-table-format-info
"org-export" (table))
79 org-export-to-buffer
"org-export"
80 (backend buffer
&optional subtreep visible-only body-only ext-plist
))
82 org-export-to-file
"org-export"
83 (backend file
&optional subtreep visible-only body-only ext-plist
))
87 ;;; Internal Variables
89 (defconst org-e-latex-option-alist
90 '((:date
"DATE" nil org-e-latex-date-format t
)
91 (:latex-class
"LATEX_CLASS" nil org-e-latex-default-class t
)
92 (:latex-class-options
"LATEX_CLASS_OPTIONS" nil nil t
)
93 (:latex-header-extra
"LATEX_HEADER" nil nil newline
))
94 "Alist between LaTeX export properties and ways to set them.
95 See `org-export-option-alist' for more information on the
96 structure of the value.")
100 ;;; User Configurable Variables
102 (defgroup org-export-e-latex nil
103 "Options for exporting Org mode files to LaTeX."
104 :tag
"Org Export LaTeX"
110 (defcustom org-e-latex-default-class
"article"
111 "The default LaTeX class."
112 :group
'org-export-e-latex
113 :type
'(string :tag
"LaTeX class"))
115 (defcustom org-e-latex-classes
117 "\\documentclass[11pt]{article}"
118 ("\\section{%s}" .
"\\section*{%s}")
119 ("\\subsection{%s}" .
"\\subsection*{%s}")
120 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")
121 ("\\paragraph{%s}" .
"\\paragraph*{%s}")
122 ("\\subparagraph{%s}" .
"\\subparagraph*{%s}"))
124 "\\documentclass[11pt]{report}"
125 ("\\part{%s}" .
"\\part*{%s}")
126 ("\\chapter{%s}" .
"\\chapter*{%s}")
127 ("\\section{%s}" .
"\\section*{%s}")
128 ("\\subsection{%s}" .
"\\subsection*{%s}")
129 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}"))
131 "\\documentclass[11pt]{book}"
132 ("\\part{%s}" .
"\\part*{%s}")
133 ("\\chapter{%s}" .
"\\chapter*{%s}")
134 ("\\section{%s}" .
"\\section*{%s}")
135 ("\\subsection{%s}" .
"\\subsection*{%s}")
136 ("\\subsubsection{%s}" .
"\\subsubsection*{%s}")))
137 "Alist of LaTeX classes and associated header and structure.
138 If #+LaTeX_CLASS is set in the buffer, use its value and the
139 associated information. Here is the structure of each cell:
143 \(numbered-section . unnumbered-section\)
149 The HEADER-STRING is the header that will be inserted into the
150 LaTeX file. It should contain the \\documentclass macro, and
151 anything else that is needed for this setup. To this header, the
152 following commands will be added:
154 - Calls to \\usepackage for all packages mentioned in the
155 variables `org-export-latex-default-packages-alist' and
156 `org-export-latex-packages-alist'. Thus, your header
157 definitions should avoid to also request these packages.
159 - Lines specified via \"#+LaTeX_HEADER:\"
161 If you need more control about the sequence in which the header
162 is built up, or if you want to exclude one of these building
163 blocks for a particular class, you can use the following
164 macro-like placeholders.
166 [DEFAULT-PACKAGES] \\usepackage statements for default packages
167 [NO-DEFAULT-PACKAGES] do not include any of the default packages
168 [PACKAGES] \\usepackage statements for packages
169 [NO-PACKAGES] do not include the packages
170 [EXTRA] the stuff from #+LaTeX_HEADER
171 [NO-EXTRA] do not include #+LaTeX_HEADER stuff
172 [BEAMER-HEADER-EXTRA] the beamer extra headers
176 \\documentclass{article}
177 [NO-DEFAULT-PACKAGES]
179 \\providecommand{\\alert}[1]{\\textbf{#1}}
182 will omit the default packages, and will include the
183 #+LaTeX_HEADER lines, then have a call to \\providecommand, and
184 then place \\usepackage commands based on the content of
185 `org-export-latex-packages-alist'.
187 If your header, `org-export-latex-default-packages-alist' or
188 `org-export-latex-packages-alist' inserts
189 \"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be
190 replaced with a coding system derived from
191 `buffer-file-coding-system'. See also the variable
192 `org-e-latex-inputenc-alist' for a way to influence this
195 The sectioning structure
196 ------------------------
198 The sectioning structure of the class is given by the elements
199 following the header string. For each sectioning level, a number
200 of strings is specified. A %s formatter is mandatory in each
201 section string and will be replaced by the title of the section.
203 Instead of a cons cell \(numbered . unnumbered\), you can also
204 provide a list of 2 or 4 elements,
206 \(numbered-open numbered-close\)
210 \(numbered-open numbered-close unnumbered-open unnumbered-close\)
212 providing opening and closing strings for a LaTeX environment
213 that should represent the document section. The opening clause
214 should have a %s to represent the section title.
216 Instead of a list of sectioning commands, you can also specify
217 a function name. That function will be called with two
218 parameters, the \(reduced) level of the headline, and a predicate
219 non-nil when the headline should be numbered. It must return
220 a format string in which the section title will be added."
221 :group
'org-export-e-latex
223 (list (string :tag
"LaTeX class")
224 (string :tag
"LaTeX header")
225 (repeat :tag
"Levels" :inline t
228 (string :tag
" numbered")
229 (string :tag
"unnumbered"))
230 (list :tag
"Environment"
231 (string :tag
"Opening (numbered)")
232 (string :tag
"Closing (numbered)")
233 (string :tag
"Opening (unnumbered)")
234 (string :tag
"Closing (unnumbered)"))
235 (function :tag
"Hook computing sectioning"))))))
237 (defcustom org-e-latex-inputenc-alist nil
238 "Alist of inputenc coding system names, and what should really be used.
239 For example, adding an entry
241 (\"utf8\" . \"utf8x\")
243 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
244 are written as utf8 files."
245 :group
'org-export-e-latex
248 (string :tag
"Derived from buffer")
249 (string :tag
"Use this instead"))))
251 (defcustom org-e-latex-date-format
253 "Format string for \\date{...}."
254 :group
'org-export-e-latex
257 (defcustom org-e-latex-title-command
"\\maketitle"
258 "The command used to insert the title just after \\begin{document}.
259 If this string contains the formatting specification \"%s\" then
260 it will be used as a formatting string, passing the title as an
262 :group
'org-export-e-latex
268 (defcustom org-e-latex-format-headline-function nil
269 "Function to format headline text.
271 This function will be called with 5 arguments:
272 TODO the todo keyword \(string or nil\).
273 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
274 PRIORITY the priority of the headline \(integer or nil\)
275 TEXT the main headline text \(string\).
276 TAGS the tags string, separated with colons \(string or nil\).
278 The function result will be used in the section format string.
280 As an example, one could set the variable to the following, in
281 order to reproduce the default set-up:
283 \(defun org-e-latex-format-headline \(todo todo-type priority text tags\)
284 \"Default format function for an headline.\"
286 \(format \"\\\\textbf{\\\\textsc{\\\\textsf{%s}}} \" todo\)\)
288 \(format \"\\\\framebox{\\\\#%c} \" priority\)\)
290 \(when tags \(format \"\\\\hfill{}\\\\textsc{%s}\" tags\)\)\)\)"
291 :group
'org-export-e-latex
297 (defcustom org-e-latex-emphasis-alist
298 '(("*" .
"\\textbf{%s}")
300 ("_" .
"\\underline{%s}")
302 ("=" . protectedtexttt
)
304 "Alist of LaTeX expressions to convert emphasis fontifiers.
306 The key is the character used as a marker for fontification. The
307 value is a formatting string to wrap fontified text with.
309 Value can also be set to the following symbols: `verb' and
310 `protectedtexttt'. For the former, Org will use \"\\verb\" to
311 create a format string and select a delimiter character that
312 isn't in the string. For the latter, Org will use \"\\texttt\"
313 to typeset and try to protect special characters."
314 :group
'org-export-e-latex
320 (defcustom org-e-latex-footnote-separator
"\\textsuperscript{,}\\,"
321 "Text used to separate footnotes."
322 :group
'org-export-e-latex
328 (defcustom org-e-latex-active-timestamp-format
"\\textit{%s}"
329 "A printf format string to be applied to active time-stamps."
330 :group
'org-export-e-latex
333 (defcustom org-e-latex-inactive-timestamp-format
"\\textit{%s}"
334 "A printf format string to be applied to inactive time-stamps."
335 :group
'org-export-e-latex
338 (defcustom org-e-latex-diary-timestamp-format
"\\textit{%s}"
339 "A printf format string to be applied to diary time-stamps."
340 :group
'org-export-e-latex
346 (defcustom org-e-latex-image-default-option
"width=.9\\linewidth"
347 "Default option for images."
348 :group
'org-export-e-latex
351 (defcustom org-e-latex-default-figure-position
"htb"
352 "Default position for latex figures."
353 :group
'org-export-e-latex
356 (defcustom org-e-latex-inline-image-rules
357 '(("file" .
"\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\)\\'"))
358 "Rules characterizing image files that can be inlined into LaTeX.
360 A rule consists in an association whose key is the type of link
361 to consider, and value is a regexp that will be matched against
364 Note that, by default, the image extension *actually* allowed
365 depend on the way the LaTeX file is processed. When used with
366 pdflatex, pdf, jpg and png images are OK. When processing
367 through dvi to Postscript, only ps and eps are allowed. The
368 default we use here encompasses both."
369 :group
'org-export-e-latex
370 :type
'(alist :key-type
(string :tag
"Type")
371 :value-type
(regexp :tag
"Path")))
376 (defcustom org-e-latex-default-table-environment
"tabular"
377 "Default environment used to build tables."
378 :group
'org-export-e-latex
381 (defcustom org-e-latex-tables-centered t
382 "When non-nil, tables are exported in a center environment."
383 :group
'org-export-e-latex
386 (defcustom org-e-latex-tables-verbatim nil
387 "When non-nil, tables are exported verbatim."
388 :group
'org-export-e-latex
391 (defcustom org-e-latex-tables-booktabs nil
392 "When non-nil, display tables in a formal \"booktabs\" style.
393 This option assumes that the \"booktabs\" package is properly
394 loaded in the header of the document. This value can be ignored
395 locally with \"booktabs=yes\" and \"booktabs=no\" LaTeX
397 :group
'org-export-e-latex
400 (defcustom org-e-latex-table-caption-above t
401 "When non-nil, place caption string at the beginning of the table.
402 Otherwise, place it near the end."
403 :group
'org-export-e-latex
409 (defcustom org-e-latex-format-drawer-function nil
410 "Function called to format a drawer in LaTeX code.
412 The function must accept two parameters:
413 NAME the drawer name, like \"LOGBOOK\"
414 CONTENTS the contents of the drawer.
416 The function should return the string to be exported.
418 For example, the variable could be set to the following function
419 in order to mimic default behaviour:
421 \(defun org-e-latex-format-drawer-default \(name contents\)
422 \"Format a drawer element for LaTeX export.\"
424 :group
'org-export-e-latex
430 (defcustom org-e-latex-format-inlinetask-function nil
431 "Function called to format an inlinetask in LaTeX code.
433 The function must accept six parameters:
434 TODO the todo keyword, as a string
435 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
436 PRIORITY the inlinetask priority, as a string
437 NAME the inlinetask name, as a string.
438 TAGS the inlinetask tags, as a string.
439 CONTENTS the contents of the inlinetask, as a string.
441 The function should return the string to be exported.
443 For example, the variable could be set to the following function
444 in order to mimic default behaviour:
446 \(defun org-e-latex-format-inlinetask \(todo type priority name tags contents\)
447 \"Format an inline task element for LaTeX export.\"
451 \(format \"\\\\textbf{\\\\textsf{\\\\textsc{%s}}} \" todo\)\)
452 \(when priority \(format \"\\\\framebox{\\\\#%c} \" priority\)\)
454 \(when tags \(format \"\\\\hfill{}\\\\textsc{%s}\" tags\)\)\)\)\)
455 \(format \(concat \"\\\\begin{center}\\n\"
457 \"\\\\begin{minipage}[c]{.6\\\\textwidth}\\n\"
459 \"\\\\rule[.8em]{\\\\textwidth}{2pt}\\n\\n\"
461 \"\\\\end{minipage}}\"
462 \"\\\\end{center}\"\)
463 full-title contents\)\)"
464 :group
'org-export-e-latex
470 (defcustom org-e-latex-listings nil
471 "Non-nil means export source code using the listings package.
472 This package will fontify source code, possibly even with color.
473 If you want to use this, you also need to make LaTeX use the
474 listings package, and if you want to have color, the color
475 package. Just add these to `org-export-latex-packages-alist',
476 for example using customize, or with something like:
478 \(require 'org-e-latex)
479 \(add-to-list 'org-export-latex-packages-alist '\(\"\" \"listings\"))
480 \(add-to-list 'org-export-latex-packages-alist '\(\"\" \"color\"))
484 \(setq org-e-latex-listings 'minted)
486 causes source code to be exported using the minted package as
487 opposed to listings. If you want to use minted, you need to add
488 the minted package to `org-export-latex-packages-alist', for
489 example using customize, or with
491 \(require 'org-e-latex)
492 \(add-to-list 'org-export-latex-packages-alist '\(\"\" \"minted\"))
494 In addition, it is necessary to install pygments
495 \(http://pygments.org), and to configure the variable
496 `org-e-latex-pdf-process' so that the -shell-escape option is
498 :group
'org-export-e-latex
500 (const :tag
"Use listings" t
)
501 (const :tag
"Use minted" 'minted
)
502 (const :tag
"Export verbatim" nil
)))
504 (defcustom org-e-latex-listings-langs
505 '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
508 (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
509 (html "HTML") (xml "XML")
510 (tex "TeX") (latex "TeX")
511 (shell-script "bash")
513 (ocaml "Caml") (caml "Caml")
514 (sql "SQL") (sqlite "sql"))
515 "Alist mapping languages to their listing language counterpart.
516 The key is a symbol, the major mode symbol without the \"-mode\".
517 The value is the string that should be inserted as the language
518 parameter for the listings package. If the mode name and the
519 listings name are the same, the language does not need an entry
520 in this list - but it does not hurt if it is present."
521 :group
'org-export-e-latex
524 (symbol :tag
"Major mode ")
525 (string :tag
"Listings language"))))
527 (defcustom org-e-latex-listings-options nil
528 "Association list of options for the latex listings package.
530 These options are supplied as a comma-separated list to the
531 \\lstset command. Each element of the association list should be
532 a list containing two strings: the name of the option, and the
535 (setq org-e-latex-listings-options
536 '((\"basicstyle\" \"\\small\")
537 (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
539 will typeset the code in a small size font with underlined, bold
542 Note that the same options will be applied to blocks of all
544 :group
'org-export-e-latex
547 (string :tag
"Listings option name ")
548 (string :tag
"Listings option value"))))
550 (defcustom org-e-latex-minted-langs
551 '((emacs-lisp "common-lisp")
554 (shell-script "bash")
556 "Alist mapping languages to their minted language counterpart.
557 The key is a symbol, the major mode symbol without the \"-mode\".
558 The value is the string that should be inserted as the language
559 parameter for the minted package. If the mode name and the
560 listings name are the same, the language does not need an entry
561 in this list - but it does not hurt if it is present.
563 Note that minted uses all lower case for language identifiers,
564 and that the full list of language identifiers can be obtained
567 pygmentize -L lexers"
568 :group
'org-export-e-latex
571 (symbol :tag
"Major mode ")
572 (string :tag
"Minted language"))))
574 (defcustom org-e-latex-minted-options nil
575 "Association list of options for the latex minted package.
577 These options are supplied within square brackets in
578 \\begin{minted} environments. Each element of the alist should
579 be a list containing two strings: the name of the option, and the
582 \(setq org-e-latex-minted-options
583 '\((\"bgcolor\" \"bg\") \(\"frame\" \"lines\")))
585 will result in src blocks being exported with
587 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
589 as the start of the minted environment. Note that the same
590 options will be applied to blocks of all languages."
591 :group
'org-export-e-latex
594 (string :tag
"Minted option name ")
595 (string :tag
"Minted option value"))))
597 (defvar org-e-latex-custom-lang-environments nil
598 "Alist mapping languages to language-specific LaTeX environments.
600 It is used during export of src blocks by the listings and minted
601 latex packages. For example,
603 \(setq org-e-latex-custom-lang-environments
604 '\(\(python \"pythoncode\"\)\)\)
606 would have the effect that if org encounters begin_src python
607 during latex export it will output
616 (defcustom org-e-latex-quotes
617 '(("fr" ("\\(\\s-\\|[[(]\\)\"" .
"«~") ("\\(\\S-\\)\"" .
"~»") ("\\(\\s-\\|(\\)'" .
"'"))
618 ("en" ("\\(\\s-\\|[[(]\\)\"" .
"``") ("\\(\\S-\\)\"" .
"''") ("\\(\\s-\\|(\\)'" .
"`")))
619 "Alist for quotes to use when converting english double-quotes.
621 The CAR of each item in this alist is the language code.
622 The CDR of each item in this alist is a list of three CONS:
623 - the first CONS defines the opening quote;
624 - the second CONS defines the closing quote;
625 - the last CONS defines single quotes.
627 For each item in a CONS, the first string is a regexp
628 for allowed characters before/after the quote, the second
629 string defines the replacement string for this quote."
630 :group
'org-export-e-latex
632 (cons :tag
"Opening quote"
633 (string :tag
"Regexp for char before")
634 (string :tag
"Replacement quote "))
635 (cons :tag
"Closing quote"
636 (string :tag
"Regexp for char after ")
637 (string :tag
"Replacement quote "))
638 (cons :tag
"Single quote"
639 (string :tag
"Regexp for char before")
640 (string :tag
"Replacement quote "))))
645 (defcustom org-e-latex-pdf-process
646 '("pdflatex -interaction nonstopmode -output-directory %o %f"
647 "pdflatex -interaction nonstopmode -output-directory %o %f"
648 "pdflatex -interaction nonstopmode -output-directory %o %f")
649 "Commands to process a LaTeX file to a PDF file.
650 This is a list of strings, each of them will be given to the
651 shell as a command. %f in the command will be replaced by the
652 full file name, %b by the file base name \(i.e. without
653 extension) and %o by the base directory of the file.
655 The reason why this is a list is that it usually takes several
656 runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
657 does not have a clever mechanism to detect which of these
658 commands have to be run to get to a stable result, and it also
659 does not do any error checking.
661 By default, Org uses 3 runs of `pdflatex' to do the processing.
662 If you have texi2dvi on your system and if that does not cause
663 the infamous egrep/locale bug:
665 http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
667 then `texi2dvi' is the superior choice. Org does offer it as one
668 of the customize options.
670 Alternatively, this may be a Lisp function that does the
671 processing, so you could use this to apply the machinery of
672 AUCTeX or the Emacs LaTeX mode. This function should accept the
673 file name as its single argument."
674 :group
'org-export-pdf
676 (repeat :tag
"Shell command sequence"
677 (string :tag
"Shell command"))
678 (const :tag
"2 runs of pdflatex"
679 ("pdflatex -interaction nonstopmode -output-directory %o %f"
680 "pdflatex -interaction nonstopmode -output-directory %o %f"))
681 (const :tag
"3 runs of pdflatex"
682 ("pdflatex -interaction nonstopmode -output-directory %o %f"
683 "pdflatex -interaction nonstopmode -output-directory %o %f"
684 "pdflatex -interaction nonstopmode -output-directory %o %f"))
685 (const :tag
"pdflatex,bibtex,pdflatex,pdflatex"
686 ("pdflatex -interaction nonstopmode -output-directory %o %f"
688 "pdflatex -interaction nonstopmode -output-directory %o %f"
689 "pdflatex -interaction nonstopmode -output-directory %o %f"))
690 (const :tag
"texi2dvi"
691 ("texi2dvi -p -b -c -V %f"))
693 ("rubber -d --into %o %f"))
696 (defcustom org-e-latex-logfiles-extensions
697 '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
698 "The list of file extensions to consider as LaTeX logfiles."
699 :group
'org-export-e-latex
700 :type
'(repeat (string :tag
"Extension")))
702 (defcustom org-e-latex-remove-logfiles t
703 "Non-nil means remove the logfiles produced by PDF production.
704 These are the .aux, .log, .out, and .toc files."
705 :group
'org-export-e-latex
710 ;;; Internal Functions
712 (defun org-e-latex--caption/label-string
(caption label info
)
713 "Return caption and label LaTeX string for floats.
715 CAPTION is a cons cell of secondary strings, the car being the
716 standard caption and the cdr its short form. LABEL is a string
717 representing the label. INFO is a plist holding contextual
720 If there's no caption nor label, return the empty string.
722 For non-floats, see `org-e-latex--wrap-label'."
723 (let ((label-str (if label
(format "\\label{%s}" label
) "")))
725 ((and (not caption
) (not label
)) "")
726 ((not caption
) (format "\\label{%s}\n" label
))
727 ;; Option caption format with short name.
729 (format "\\caption[%s]{%s%s}\n"
730 (org-export-secondary-string (cdr caption
) 'e-latex info
)
732 (org-export-secondary-string (car caption
) 'e-latex info
)))
733 ;; Standard caption format.
734 (t (format "\\caption{%s%s}\n"
736 (org-export-secondary-string (car caption
) 'e-latex info
))))))
738 (defun org-e-latex--guess-inputenc (header)
739 "Set the coding system in inputenc to what the buffer is.
741 HEADER is the LaTeX header string.
743 Return the new header."
744 (let* ((cs (or (ignore-errors
745 (latexenc-coding-system-to-inputenc
746 buffer-file-coding-system
))
749 ;; First translate if that is requested.
750 (setq cs
(or (cdr (assoc cs org-e-latex-inputenc-alist
)) cs
))
751 ;; Then find the \usepackage statement and replace the option.
752 (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
753 cs header t nil
1))))
755 (defun org-e-latex--find-verb-separator (s)
756 "Return a character not used in string S.
757 This is used to choose a separator for constructs like \\verb."
758 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
759 (loop for c across ll
760 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
761 return
(char-to-string c
))))
763 (defun org-e-latex--make-option-string (options)
764 "Return a comma separated string of keywords and values.
765 OPTIONS is an alist where the key is the options keyword as
766 a string, and the value a list containing the keyword value, or
768 (mapconcat (lambda (pair)
770 (when (> (length (second pair
)) 0)
771 (concat "=" (second pair
)))))
775 (defun org-e-latex--quotation-marks (text info
)
776 "Export quotation marks depending on language conventions.
777 TEXT is a string containing quotation marks to be replaced. INFO
778 is a plist used as a communication channel."
781 (while (setq start
(string-match (car l
) text start
))
782 (let ((new-quote (concat (match-string 1 text
) (cdr l
))))
783 (setq text
(replace-match new-quote t t text
))))))
784 (cdr (or (assoc (plist-get info
:language
) org-e-latex-quotes
)
785 ;; Falls back on English.
786 (assoc "en" org-e-latex-quotes
))))
789 (defun org-e-latex--wrap-label (element output
)
790 "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
791 This function shouldn't be used for floats. See
792 `org-e-latex--caption/label-string'."
793 (let ((label (org-element-property :name element
)))
794 (if (or (not output
) (not label
) (string= output
"") (string= label
""))
796 (concat (format "\\label{%s}\n" label
) output
))))
802 (defun org-e-latex-template (contents info
)
803 "Return complete document string after LaTeX conversion.
804 CONTENTS is the transcoded contents string. INFO is a plist
805 holding export options."
806 (let ((title (org-export-secondary-string
807 (plist-get info
:title
) 'e-latex info
)))
810 (and (plist-get info
:time-stamp-file
)
811 (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
812 ;; 2. Document class and packages.
813 (let ((class (plist-get info
:latex-class
))
814 (class-options (plist-get info
:latex-class-options
)))
815 (org-element-normalize-string
816 (let* ((header (nth 1 (assoc class org-e-latex-classes
)))
817 (document-class-string
818 (and (stringp header
)
820 (replace-regexp-in-string
821 "^[ \t]*\\\\documentclass\\(\\[.*?\\]\\)"
822 class-options header t nil
1)
824 (org-e-latex--guess-inputenc
825 (org-splice-latex-header
826 document-class-string
827 org-export-latex-default-packages-alist
; defined in org.el
828 org-export-latex-packages-alist nil
; defined in org.el
829 (plist-get info
:latex-header-extra
))))))
830 ;; 3. Define alert if not yet defined.
831 "\\providecommand{\\alert}[1]{\\textbf{#1}}\n"
832 ;; 4. Possibly limit depth for headline numbering.
833 (let ((sec-num (plist-get info
:section-numbers
)))
834 (when (integerp sec-num
)
835 (format "\\setcounter{secnumdepth}{%d}\n" sec-num
)))
837 (let ((author (and (plist-get info
:with-author
)
838 (let ((auth (plist-get info
:author
)))
839 (and auth
(org-export-secondary-string
840 auth
'e-latex info
)))))
841 (email (and (plist-get info
:with-email
)
842 (org-export-secondary-string
843 (plist-get info
:email
) 'e-latex info
))))
844 (cond ((and author email
(not (string= "" email
)))
845 (format "\\author{%s\\thanks{%s}}\n" author email
))
846 (author (format "\\author{%s}\n" author
))
849 (let ((date (plist-get info
:date
)))
850 (and date
(format "\\date{%s}\n" date
)))
852 (format "\\title{%s}\n" title
)
853 ;; 8. Hyperref options.
854 (format "\\hypersetup{\n pdfkeywords={%s},\n pdfsubject={%s},\n pdfcreator={%s}}\n"
855 (or (plist-get info
:keywords
) "")
856 (or (plist-get info
:description
) "")
857 (if (not (plist-get info
:with-creator
)) ""
858 (plist-get info
:creator
)))
859 ;; 9. Document start.
860 "\\begin{document}\n\n"
861 ;; 10. Title command.
862 (org-element-normalize-string
863 (cond ((string= "" title
) nil
)
864 ((not (stringp org-e-latex-title-command
)) nil
)
865 ((string-match "\\(?:[^%]\\|^\\)%s"
866 org-e-latex-title-command
)
867 (format org-e-latex-title-command title
))
868 (t org-e-latex-title-command
)))
869 ;; 11. Table of contents.
870 (let ((depth (plist-get info
:with-toc
)))
872 (concat (when (wholenump depth
)
873 (format "\\setcounter{tocdepth}{%d}\n" depth
))
874 "\\tableofcontents\n\\vspace*{1cm}\n\n")))
875 ;; 12. Document's body.
878 (let ((creator-info (plist-get info
:with-creator
)))
880 ((not creator-info
) "")
881 ((eq creator-info
'comment
)
882 (format "%% %s\n" (plist-get info
:creator
)))
883 (t (concat (plist-get info
:creator
) "\n"))))
889 ;;; Transcode Functions
893 (defun org-e-latex-center-block (center-block contents info
)
894 "Transcode a CENTER-BLOCK element from Org to LaTeX.
895 CONTENTS holds the contents of the block. INFO is a plist
896 holding contextual information."
897 (org-e-latex--wrap-label
899 (format "\\begin{center}\n%s\\end{center}" contents
)))
904 ;; Comments are ignored.
909 ;; Comment Blocks are ignored.
914 (defun org-e-latex-drawer (drawer contents info
)
915 "Transcode a DRAWER element from Org to LaTeX.
916 CONTENTS holds the contents of the block. INFO is a plist
917 holding contextual information."
918 (let* ((name (org-element-property :drawer-name drawer
))
919 (output (if (functionp org-e-latex-format-drawer-function
)
920 (funcall org-e-latex-format-drawer-function
922 ;; If there's no user defined function: simply
923 ;; display contents of the drawer.
925 (org-e-latex--wrap-label drawer output
)))
930 (defun org-e-latex-dynamic-block (dynamic-block contents info
)
931 "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
932 CONTENTS holds the contents of the block. INFO is a plist
933 holding contextual information. See
935 (org-e-latex--wrap-label dynamic-block contents
))
940 (defun org-e-latex-emphasis (emphasis contents info
)
941 "Transcode EMPHASIS from Org to LaTeX.
942 CONTENTS is the contents of the emphasized text. INFO is a plist
943 holding contextual information.."
944 (format (cdr (assoc (org-element-property :marker emphasis
)
945 org-e-latex-emphasis-alist
))
951 (defun org-e-latex-entity (entity contents info
)
952 "Transcode an ENTITY object from Org to LaTeX.
953 CONTENTS are the definition itself. INFO is a plist holding
954 contextual information."
955 (let ((ent (org-element-property :latex entity
)))
956 (if (org-element-property :latex-math-p entity
) (format "$%s$" ent
) ent
)))
961 (defun org-e-latex-example-block (example-block contents info
)
962 "Transcode a EXAMPLE-BLOCK element from Org to LaTeX.
963 CONTENTS is nil. INFO is a plist holding contextual information."
964 (let* ((options (or (org-element-property :options example-block
) ""))
965 (value (org-export-handle-code example-block info
)))
966 (org-e-latex--wrap-label
967 example-block
(format "\\begin{verbatim}\n%s\\end{verbatim}" value
))))
972 (defun org-e-latex-export-snippet (export-snippet contents info
)
973 "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
974 CONTENTS is nil. INFO is a plist holding contextual information."
975 (org-element-property :value export-snippet
))
980 (defun org-e-latex-export-block (export-block contents info
)
981 "Transcode a EXPORT-BLOCK element from Org to LaTeX.
982 CONTENTS is nil. INFO is a plist holding contextual information."
983 (when (string= (org-element-property :type export-block
) "latex")
984 (org-remove-indentation (org-element-property :value export-block
))))
989 (defun org-e-latex-fixed-width (fixed-width contents info
)
990 "Transcode a FIXED-WIDTH element from Org to LaTeX.
991 CONTENTS is nil. INFO is a plist holding contextual information."
992 (let* ((value (org-element-normalize-string
993 (replace-regexp-in-string
995 (org-element-property :value fixed-width
)))))
996 (org-e-latex--wrap-label
997 fixed-width
(format "\\begin{verbatim}\n%s\\end{verbatim}" value
))))
1000 ;;;; Footnote Definition
1002 ;; Footnote Definitions are ignored.
1005 ;;;; Footnote Reference
1007 (defun org-e-latex-footnote-reference (footnote-reference contents info
)
1008 "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
1009 CONTENTS is nil. INFO is a plist holding contextual information."
1011 ;; Insert separator between two footnotes in a row.
1012 (let ((prev (org-export-get-previous-element footnote-reference info
)))
1013 (when (eq (org-element-type prev
) 'footnote-reference
)
1014 org-e-latex-footnote-separator
))
1015 ;; Use \footnotemark if the footnote has already been defined.
1016 ;; Otherwise, define it with \footnote command.
1018 ((not (org-export-footnote-first-reference-p footnote-reference info
))
1019 (format "\\footnotemark[%s]"
1020 (org-export-get-footnote-number footnote-reference info
)))
1021 ;; Inline definitions are secondary strings.
1022 ((eq (org-element-property :type footnote-reference
) 'inline
)
1023 (format "\\footnote{%s}"
1025 (org-export-secondary-string
1026 (org-export-get-footnote-definition footnote-reference info
)
1028 ;; Non-inline footnotes definitions are full Org data.
1030 (format "\\footnote{%s}"
1033 (org-export-get-footnote-definition footnote-reference info
)
1034 'e-latex info
)))))))
1039 (defun org-e-latex-headline (headline contents info
)
1040 "Transcode an HEADLINE element from Org to LaTeX.
1041 CONTENTS holds the contents of the headline. INFO is a plist
1042 holding contextual information."
1043 (let* ((class (plist-get info
:latex-class
))
1044 (numberedp (plist-get info
:section-numbers
))
1045 ;; Get level relative to current parsed data.
1046 (level (org-export-get-relative-level headline info
))
1047 (class-sectionning (assoc class org-e-latex-classes
))
1048 ;; Section formatting will set two placeholders: one for the
1049 ;; title and the other for the contents.
1051 (let ((sec (if (and (symbolp (nth 2 class-sectionning
))
1052 (fboundp (nth 2 class-sectionning
)))
1053 (funcall (nth 2 class-sectionning
) level numberedp
)
1054 (nth (1+ level
) class-sectionning
))))
1056 ;; No section available for that LEVEL.
1058 ;; Section format directly returned by a function.
1060 ;; (numbered-section . unnumbered-section)
1061 ((not (consp (cdr sec
)))
1062 (concat (funcall (if numberedp
#'car
#'cdr
) sec
) "\n%s"))
1063 ;; (numbered-open numbered-close)
1065 (when numberedp
(concat (car sec
) "\n%s" (nth 1 sec
))))
1066 ;; (num-in num-out no-num-in no-num-out)
1069 (concat (car sec
) "\n%s" (nth 1 sec
))
1070 (concat (nth 2 sec
) "\n%s" (nth 3 sec
)))))))
1071 (text (org-export-secondary-string
1072 (org-element-property :title headline
) 'e-latex info
))
1074 (and (plist-get info
:with-todo-keywords
)
1075 (let ((todo (org-element-property :todo-keyword headline
)))
1076 (and todo
(org-export-secondary-string todo
'e-latex info
)))))
1077 (todo-type (and todo
(org-element-property :todo-type headline
)))
1078 (tags (and (plist-get info
:with-tags
)
1079 (org-element-property :tags headline
)))
1080 (priority (and (plist-get info
:with-priority
)
1081 (org-element-property :priority headline
)))
1082 ;; Create the headline text.
1083 (full-text (if (functionp org-e-latex-format-headline-function
)
1084 ;; User-defined formatting function.
1085 (funcall org-e-latex-format-headline-function
1086 todo todo-type priority text tags
)
1087 ;; Default formatting.
1090 (format "\\textbf{\\textsf{\\textsc{%s}}} " todo
))
1091 (when priority
(format "\\framebox{\\#%c} " priority
))
1093 (when tags
(format "\\hfill{}\\textsc{%s}" tags
)))))
1094 ;; Associate some \label to the headline for internal links.
1096 (format "\\label{sec-%s}\n"
1097 (mapconcat 'number-to-string
1098 (org-export-get-headline-number headline info
)
1101 (make-string (org-element-property :pre-blank headline
) 10)))
1103 ;; Case 1: This is a footnote section: ignore it.
1104 ((org-element-property :footnote-section-p headline
) nil
)
1105 ;; Case 2. This is a deep sub-tree: export it as a list item.
1106 ;; Also export as items headlines for which no section
1107 ;; format has been found.
1108 ((or (not section-fmt
) (org-export-low-level-p headline info
))
1109 ;; Build the real contents of the sub-tree.
1110 (let ((low-level-body
1112 ;; If the headline is the first sibling, start a list.
1113 (when (org-export-first-sibling-p headline info
)
1114 (format "\\begin{%s}\n" (if numberedp
'enumerate
'itemize
)))
1116 "\\item " full-text
"\n" headline-label pre-blanks contents
)))
1117 ;; If headline in the last sibling, close the list, before any
1118 ;; blank line. Otherwise, simply return LOW-LEVEL-BODY.
1119 (if (org-export-last-sibling-p headline info
)
1120 (replace-regexp-in-string
1122 (format "\n\\\\end{%s}" (if numberedp
'enumerate
'itemize
))
1125 ;; Case 3. Standard headline. Export it as a section.
1126 (t (format section-fmt full-text
1127 (concat headline-label pre-blanks contents
))))))
1130 ;;;; Horizontal Rule
1132 (defun org-e-latex-horizontal-rule (horizontal-rule contents info
)
1133 "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
1134 CONTENTS is nil. INFO is a plist holding contextual information."
1135 (let ((attr (mapconcat #'identity
1136 (org-element-property :attr_latex horizontal-rule
)
1138 (org-e-latex--wrap-label horizontal-rule
(concat "\\hrule " attr
))))
1141 ;;;; Inline Babel Call
1143 ;; Inline Babel Calls are ignored.
1146 ;;;; Inline Src Block
1148 (defun org-e-latex-inline-src-block (inline-src-block contents info
)
1149 "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
1150 CONTENTS holds the contents of the item. INFO is a plist holding
1151 contextual information."
1152 (let* ((code (org-element-property :value inline-src-block
))
1153 (separator (org-e-latex--find-verb-separator code
)))
1155 ;; Do not use a special package: transcode it verbatim.
1156 ((not org-e-latex-listings
)
1157 (concat "\\verb" separator code separator
))
1158 ;; Use minted package.
1159 ((eq org-e-latex-listings
'minted
)
1160 (let* ((org-lang (org-element-property :language inline-src-block
))
1161 (mint-lang (or (cadr (assq (intern org-lang
)
1162 org-e-latex-minted-langs
))
1164 (options (org-e-latex--make-option-string
1165 org-e-latex-minted-options
)))
1166 (concat (format "\\mint%s{%s}"
1167 (if (string= options
"") "" (format "[%s]" options
))
1169 separator code separator
)))
1170 ;; Use listings package.
1172 ;; Maybe translate language's name.
1173 (let* ((org-lang (org-element-property :language inline-src-block
))
1174 (lst-lang (or (cadr (assq (intern org-lang
)
1175 org-e-latex-listings-langs
))
1177 (options (org-e-latex--make-option-string
1178 (append org-e-latex-listings-options
1179 `(("language" ,lst-lang
))))))
1180 (concat (format "\\lstinline[%s]" options
)
1181 separator code separator
))))))
1186 (defun org-e-latex-inlinetask (inlinetask contents info
)
1187 "Transcode an INLINETASK element from Org to LaTeX.
1188 CONTENTS holds the contents of the block. INFO is a plist
1189 holding contextual information."
1190 (let ((title (org-export-secondary-string
1191 (org-element-property :title inlinetask
) 'e-latex info
))
1192 (todo (and (plist-get info
:with-todo-keywords
)
1193 (let ((todo (org-element-property
1194 :todo-keyword inlinetask
)))
1196 (org-export-secondary-string todo
'e-latex info
)))))
1197 (todo-type (org-element-property :todo-type inlinetask
))
1198 (tags (and (plist-get info
:with-tags
)
1199 (org-element-property :tags inlinetask
)))
1200 (priority (and (plist-get info
:with-priority
)
1201 (org-element-property :priority inlinetask
))))
1202 ;; If `org-e-latex-format-inlinetask-function' is provided, call it
1203 ;; with appropriate arguments.
1204 (if (functionp org-e-latex-format-inlinetask-function
)
1205 (funcall org-e-latex-format-inlinetask-function
1206 todo todo-type priority title tags contents
)
1207 ;; Otherwise, use a default template.
1208 (org-e-latex--wrap-label
1212 (when todo
(format "\\textbf{\\textsf{\\textsc{%s}}} " todo
))
1213 (when priority
(format "\\framebox{\\#%c} " priority
))
1215 (when tags
(format "\\hfill{}\\textsc{%s}" tags
)))))
1216 (format (concat "\\begin{center}\n"
1218 "\\begin{minipage}[c]{.6\\textwidth}\n"
1220 "\\rule[.8em]{\\textwidth}{2pt}\n\n"
1225 full-title contents
))))))
1230 (defun org-e-latex-item (item contents info
)
1231 "Transcode an ITEM element from Org to LaTeX.
1232 CONTENTS holds the contents of the item. INFO is a plist holding
1233 contextual information."
1234 ;; Grab `:level' from plain-list properties, which is always the
1235 ;; first element above current item.
1236 (let* ((level (org-element-property
1237 :level
(car (org-export-get-genealogy item info
))))
1238 (counter (let ((count (org-element-property :counter item
)))
1241 (format "\\setcounter{enum%s}{%s}\n"
1242 (nth level
'("i" "ii" "iii" "iv"))
1244 (checkbox (let ((checkbox (org-element-property :checkbox item
)))
1245 (cond ((eq checkbox
'on
) "$\\boxtimes$ ")
1246 ((eq checkbox
'off
) "$\\Box$ ")
1247 ((eq checkbox
'trans
) "$\\boxminus$ "))))
1248 (tag (let ((tag (org-element-property :tag item
)))
1250 (format "[%s]" (org-export-secondary-string
1251 tag
'e-latex info
))))))
1252 (concat counter
"\\item" tag
" " checkbox contents
)))
1257 (defun org-e-latex-keyword (keyword contents info
)
1258 "Transcode a KEYWORD element from Org to LaTeX.
1259 CONTENTS is nil. INFO is a plist holding contextual information."
1260 (let ((key (downcase (org-element-property :key keyword
)))
1261 (value (org-element-property :value keyword
)))
1263 ((string= key
"latex") value
)
1264 ((string= key
"index") (format "\\index{%s}" value
))
1265 ((string= key
"target")
1266 (format "\\label{%s}" (org-export-solidify-link-text value
)))
1267 ((string= key
"toc")
1268 (let ((value (downcase value
)))
1270 ((string-match "\\<headlines\\>" value
)
1271 (let ((depth (or (and (string-match "[0-9]+" value
)
1272 (string-to-number (match-string 0 value
)))
1273 (plist-get info
:with-toc
))))
1275 (when (wholenump depth
)
1276 (format "\\setcounter{tocdepth}{%s}\n" depth
))
1277 "\\tableofcontents")))
1278 ((string= "tables" value
) "\\listoftables")
1279 ((string= "figures" value
) "\\listoffigures")
1280 ((string= "listings" value
)
1282 ((eq org-e-latex-listings
'minted
) "\\listoflistings")
1283 (org-e-latex-listings "\\lstlistoflistings")
1284 ;; At the moment, src blocks with a caption are wrapped
1285 ;; into a figure environment.
1286 (t "\\listoffigures")))))))))
1289 ;;;; Latex Environment
1291 (defun org-e-latex-latex-environment (latex-environment contents info
)
1292 "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
1293 CONTENTS is nil. INFO is a plist holding contextual information."
1294 (let ((label (org-element-property :name latex-environment
))
1295 (value (org-remove-indentation
1296 (org-element-property :value latex-environment
))))
1297 (if (not (org-string-nw-p label
)) value
1298 ;; Environment is labelled: label must be within the environment
1299 ;; (otherwise, a reference pointing to that element will count
1300 ;; the section instead).
1303 (goto-char (point-min))
1305 (insert (format "\\label{%s}\n" label
))
1311 (defun org-e-latex-latex-fragment (latex-fragment contents info
)
1312 "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
1313 CONTENTS is nil. INFO is a plist holding contextual information."
1314 (org-element-property :value latex-fragment
))
1319 (defun org-e-latex-line-break (line-break contents info
)
1320 "Transcode a LINE-BREAK object from Org to LaTeX.
1321 CONTENTS is nil. INFO is a plist holding contextual information."
1327 (defun org-e-latex-link--inline-image (link info
)
1328 "Return LaTeX code for an inline image.
1329 LINK is the link pointing to the inline image. INFO is a plist
1330 used as a communication channel."
1331 (let* ((parent (org-export-get-parent-paragraph link info
))
1332 (path (let ((raw-path (org-element-property :path link
)))
1333 (if (not (file-name-absolute-p raw-path
)) raw-path
1334 (expand-file-name raw-path
))))
1335 (caption (org-e-latex--caption/label-string
1336 (org-element-property :caption parent
)
1337 (org-element-property :name parent
)
1339 ;; Retrieve latex attributes from the element around.
1340 (attr (let ((raw-attr
1341 (mapconcat #'identity
1342 (org-element-property :attr_latex parent
)
1344 (unless (string= raw-attr
"") raw-attr
)))
1347 ((and attr
(string-match "\\<wrap\\>" attr
)) 'wrap
)
1348 ((and attr
(string-match "\\<multicolumn\\>" attr
)) 'multicolumn
)
1349 ((or (and attr
(string-match "\\<float\\>" attr
))
1350 (not (string= caption
"")))
1354 ((and attr
(string-match "\\<placement=\\(\\S-+\\)" attr
))
1355 (org-match-string-no-properties 1 attr
))
1356 ((eq disposition
'wrap
) "{l}{0.5\\textwidth}")
1357 ((eq disposition
'float
)
1358 (concat "[" org-e-latex-default-figure-position
"]"))
1360 ;; Now clear ATTR from any special keyword and set a default
1361 ;; value if nothing is left.
1365 (replace-regexp-in-string
1366 "\\(wrap\\|multicolumn\\|float\\|placement=\\S-+\\)" "" attr
))))
1367 (setq attr
(cond ((not (string= attr
"")) attr
)
1368 ((eq disposition
'float
) "width=0.7\\textwidth")
1369 ((eq disposition
'wrap
) "width=0.48\\textwidth")
1370 (t (or org-e-latex-image-default-option
""))))
1371 ;; Return proper string, depending on DISPOSITION.
1373 (wrap (format "\\begin{wrapfigure}%s
1375 \\includegraphics[%s]{%s}
1376 %s\\end{wrapfigure}" placement attr path caption
))
1377 (mulicolumn (format "\\begin{figure*}%s
1379 \\includegraphics[%s]{%s}
1380 %s\\end{figure*}" placement attr path caption
))
1381 (float (format "\\begin{figure}%s
1383 \\includegraphics[%s]{%s}
1384 %s\\end{figure}" placement attr path caption
))
1385 (t (format "\\includegraphics[%s]{%s}" attr path
)))))
1387 (defun org-e-latex-link (link desc info
)
1388 "Transcode a LINK object from Org to LaTeX.
1390 DESC is the description part of the link, or the empty string.
1391 INFO is a plist holding contextual information. See
1393 (let* ((type (org-element-property :type link
))
1394 (raw-path (org-element-property :path link
))
1395 ;; Ensure DESC really exists, or set it to nil.
1396 (desc (and (not (string= desc
"")) desc
))
1397 (imagep (org-export-inline-image-p
1398 link org-e-latex-inline-image-rules
))
1400 ((member type
'("http" "https" "ftp" "mailto"))
1401 (concat type
":" raw-path
))
1402 ((string= type
"file")
1403 (when (string-match "\\(.+\\)::.+" raw-path
)
1404 (setq raw-path
(match-string 1 raw-path
)))
1405 (if (file-name-absolute-p raw-path
)
1406 (concat "file://" (expand-file-name raw-path
))
1407 ;; TODO: Not implemented yet. Concat also:
1408 ;; (org-export-directory :LaTeX info)
1409 (concat "file://" raw-path
)))
1414 (imagep (org-e-latex-link--inline-image link info
))
1415 ;; Radioed target: Target's name is obtained from original raw
1416 ;; link. Path is parsed and transcoded in order to have a proper
1417 ;; display of the contents.
1418 ((string= type
"radio")
1419 (format "\\hyperref[%s]{%s}"
1420 (org-export-solidify-link-text path
)
1421 (org-export-secondary-string
1422 (org-element-parse-secondary-string
1423 path
(cdr (assq 'radio-target org-element-object-restrictions
)))
1425 ;; Ref link: If no description is provided, reference label PATH
1426 ;; and display table number. Otherwise move to label but display
1427 ;; description instead.
1428 ((string= type
"ref")
1429 (if (not desc
) (format "\\ref{%s}" path
)
1430 (format "\\hyperref[%s]{%s}" path desc
)))
1431 ;; Links pointing to an headline: Find destination and build
1432 ;; appropriate referencing command.
1433 ((member type
'("custom-id" "fuzzy" "id"))
1434 (let ((destination (if (string= type
"fuzzy")
1435 (org-export-resolve-fuzzy-link link info
)
1436 (org-export-resolve-id-link link info
))))
1437 ;; Fuzzy link points to a target. Do as above.
1438 (case (org-element-type destination
)
1440 (format "\\hyperref[%s]{%s}"
1441 (org-export-solidify-link-text
1442 (org-element-property :raw-value destination
))
1444 (org-export-secondary-string
1445 (org-element-property :raw-link link
)
1447 ;; Fuzzy link points to an headline. If headlines are
1448 ;; numbered and the link has no description, display
1449 ;; headline's number. Otherwise, display description or
1450 ;; headline's title.
1456 (org-export-get-headline-number destination info
)
1458 (if (and (plist-get info
:section-numbers
) (not desc
))
1459 (format "\\ref{%s}" label
)
1460 (format "\\hyperref[%s]{%s}" label
1462 (org-export-secondary-string
1463 (org-element-property :title destination
)
1465 ;; Fuzzy link points nowhere.
1467 (format "\\texttt{%s}"
1469 (org-export-secondary-string
1470 (org-element-property :raw-link link
)
1471 'e-latex info
)))))))
1472 ;; Coderef: replace link with the reference name or the
1473 ;; equivalent line number.
1474 ((string= type
"coderef")
1475 (format (org-export-get-coderef-format path
(or desc
""))
1476 (org-export-resolve-coderef path info
)))
1477 ;; Link type is handled by a special function.
1478 ((functionp (setq protocol
(nth 2 (assoc type org-link-protocols
))))
1479 (funcall protocol
(org-link-unescape path
) desc
'latex
))
1480 ;; External link with a description part.
1481 ((and path desc
) (format "\\href{%s}{%s}" path desc
))
1482 ;; External link without a description part.
1483 (path (format "\\url{%s}" path
))
1484 ;; No path, only description. Try to do something useful.
1485 (t (format "\\texttt{%s}" desc
)))))
1490 ;; Babel Calls are ignored.
1495 (defun org-e-latex-macro (macro contents info
)
1496 "Transcode a MACRO element from Org to LaTeX.
1497 CONTENTS is nil. INFO is a plist holding contextual information."
1498 ;; Use available tools.
1499 (org-export-expand-macro macro info
))
1504 (defun org-e-latex-paragraph (paragraph contents info
)
1505 "Transcode a PARAGRAPH element from Org to LaTeX.
1506 CONTENTS is the contents of the paragraph, as a string. INFO is
1507 the plist used as a communication channel."
1513 (defun org-e-latex-plain-list (plain-list contents info
)
1514 "Transcode a PLAIN-LIST element from Org to LaTeX.
1515 CONTENTS is the contents of the list. INFO is a plist holding
1516 contextual information."
1517 (let* ((type (org-element-property :type plain-list
))
1518 (paralist-types '("inparaenum" "asparaenum" "inparaitem" "asparaitem"
1519 "inparadesc" "asparadesc"))
1520 (paralist-regexp (concat
1522 (mapconcat 'identity paralist-types
"\\|")
1524 (attr (mapconcat #'identity
1525 (org-element-property :attr_latex plain-list
)
1530 (format "\\<%s\\>" paralist-regexp
) attr
))
1531 (match-string 1 attr
))
1532 ((eq type
'ordered
) "enumerate")
1533 ((eq type
'unordered
) "itemize")
1534 ((eq type
'descriptive
) "description"))))
1535 (org-e-latex--wrap-label
1537 (format "\\begin{%s}%s\n%s\\end{%s}"
1539 ;; Once special environment, if any, has been removed, the
1540 ;; rest of the attributes will be optional arguments.
1541 ;; They will be put inside square brackets if necessary.
1542 (let ((opt (replace-regexp-in-string
1543 (format " *%s *" paralist-regexp
) "" attr
)))
1544 (cond ((string= opt
"") "")
1545 ((string-match "\\`\\[[^][]+\\]\\'" opt
) opt
)
1546 (t (format "[%s]" opt
))))
1553 (defun org-e-latex-plain-text (text info
)
1554 "Transcode a TEXT string from Org to LaTeX.
1555 TEXT is the string to transcode. INFO is a plist holding
1556 contextual information."
1557 ;; Protect %, #, &, $, ~, ^, _, { and }.
1558 (while (string-match "\\([^\\]\\|^\\)\\([%$#&{}~^_]\\)" text
)
1560 (replace-match (format "\\%s" (match-string 2 text
)) nil t text
2)))
1562 (setq text
(replace-regexp-in-string
1563 "\\(?:[^\\]\\|^\\)\\(\\\\\\)\\(?:[^%$#&{}~^_\\]\\|$\\)"
1564 "$\\backslash$" text nil t
1))
1565 ;; LaTeX into \LaTeX{} and TeX into \TeX{}.
1566 (let ((case-fold-search nil
)
1568 (while (string-match "\\<\\(\\(?:La\\)?TeX\\)\\>" text start
)
1569 (setq text
(replace-match
1570 (format "\\%s{}" (match-string 1 text
)) nil t text
)
1571 start
(match-end 0))))
1572 ;; Handle quotation marks
1573 (setq text
(org-e-latex--quotation-marks text info
))
1574 ;; Convert special strings.
1575 (when (plist-get info
:with-special-strings
)
1576 (while (string-match (regexp-quote "...") text
)
1577 (setq text
(replace-match "\\ldots{}" nil t text
))))
1578 ;; Handle break preservation if required.
1579 (when (plist-get info
:preserve-breaks
)
1580 (setq text
(replace-regexp-in-string "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n"
1586 ;;;; Property Drawer
1588 (defun org-e-latex-property-drawer (property-drawer contents info
)
1589 "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
1590 CONTENTS is nil. INFO is a plist holding contextual
1592 ;; The property drawer isn't exported but we want separating blank
1593 ;; lines nonetheless.
1599 (defun org-e-latex-quote-block (quote-block contents info
)
1600 "Transcode a QUOTE-BLOCK element from Org to LaTeX.
1601 CONTENTS holds the contents of the block. INFO is a plist
1602 holding contextual information."
1603 (org-e-latex--wrap-label
1605 (format "\\begin{quote}\n%s\\end{quote}" contents
)))
1610 (defun org-e-latex-quote-section (quote-section contents info
)
1611 "Transcode a QUOTE-SECTION element from Org to LaTeX.
1612 CONTENTS is nil. INFO is a plist holding contextual information."
1613 (let ((value (org-remove-indentation
1614 (org-element-property :value quote-section
))))
1615 (when value
(format "\\begin{verbatim}\n%s\\end{verbatim}" value
))))
1620 (defun org-e-latex-section (section contents info
)
1621 "Transcode a SECTION element from Org to LaTeX.
1622 CONTENTS holds the contents of the section. INFO is a plist
1623 holding contextual information."
1629 (defun org-e-latex-radio-target (radio-target text info
)
1630 "Transcode a RADIO-TARGET object from Org to LaTeX.
1631 TEXT is the text of the target. INFO is a plist holding
1632 contextual information."
1633 (format "\\label{%s}%s"
1634 (org-export-solidify-link-text
1635 (org-element-property :raw-value radio-target
))
1641 (defun org-e-latex-special-block (special-block contents info
)
1642 "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
1643 CONTENTS holds the contents of the block. INFO is a plist
1644 holding contextual information."
1645 (let ((type (downcase (org-element-property :type special-block
))))
1646 (org-e-latex--wrap-label
1648 (format "\\begin{%s}\n%s\\end{%s}" type contents type
))))
1653 (defun org-e-latex-src-block (src-block contents info
)
1654 "Transcode a SRC-BLOCK element from Org to LaTeX.
1655 CONTENTS holds the contents of the item. INFO is a plist holding
1656 contextual information."
1657 (let* ((lang (org-element-property :language src-block
))
1658 (code (org-export-handle-code src-block info
))
1659 (caption (org-element-property :caption src-block
))
1660 (label (org-element-property :name src-block
))
1661 (custom-env (and lang
1662 (cadr (assq (intern lang
)
1663 org-e-latex-custom-lang-environments
)))))
1665 ;; No source fontification.
1666 ((not org-e-latex-listings
)
1667 (let ((caption-str (org-e-latex--caption/label-string
1668 caption label info
))
1669 (float-env (when caption
"\\begin{figure}[H]\n%s\n\\end{figure}")))
1670 (format (or float-env
"%s")
1673 (format "\\begin{verbatim}\n%s\\end{verbatim}" code
)))))
1674 ;; Custom environment.
1676 (format "\\begin{%s}\n%s\\end{%s}\n" custom-env code custom-env
))
1677 ;; Use minted package.
1678 ((eq org-e-latex-listings
'minted
)
1679 (let* ((mint-lang (or (cadr (assq (intern lang
) org-e-latex-minted-langs
))
1681 (float-env (when (or label caption
)
1682 (format "\\begin{listing}[H]\n%%s\n%s\\end{listing}"
1683 (org-e-latex--caption/label-string
1684 caption label info
))))
1685 (body (format "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
1686 (org-e-latex--make-option-string
1687 org-e-latex-minted-options
)
1689 (if float-env
(format float-env body
) body
)))
1690 ;; Use listings package.
1693 (or (cadr (assq (intern lang
) org-e-latex-listings-langs
)) lang
))
1696 (let ((main (org-export-secondary-string
1697 (car caption
) 'e-latex info
)))
1698 (if (not (cdr caption
)) (format "{%s}" main
)
1701 (org-export-secondary-string (cdr caption
) 'e-latex info
)
1703 (concat (format "\\lstset{%s}\n"
1704 (org-e-latex--make-option-string
1705 (append org-e-latex-listings-options
1706 `(("language" ,lst-lang
))
1707 (when label
`(("label" ,label
)))
1709 `(("caption" ,caption-str
))))))
1710 (format "\\begin{lstlisting}\n%s\\end{lstlisting}" code
)))))))
1713 ;;;; Statistics Cookie
1715 (defun org-e-latex-statistics-cookie (statistics-cookie contents info
)
1716 "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
1717 CONTENTS is nil. INFO is a plist holding contextual information."
1718 (org-element-property :value statistics-cookie
))
1723 (defun org-e-latex-subscript (subscript contents info
)
1724 "Transcode a SUBSCRIPT object from Org to LaTeX.
1725 CONTENTS is the contents of the object. INFO is a plist holding
1726 contextual information."
1727 (format (if (= (length contents
) 1) "$_%s$" "$_{\\mathrm{%s}}$") contents
))
1732 (defun org-e-latex-superscript (superscript contents info
)
1733 "Transcode a SUPERSCRIPT object from Org to LaTeX.
1734 CONTENTS is the contents of the object. INFO is a plist holding
1735 contextual information."
1736 (format (if (= (length contents
) 1) "$^%s$" "$^{\\mathrm{%s}}$") contents
))
1741 (defun org-e-latex-table--format-string (table table-info info
)
1742 "Return an appropriate format string for TABLE.
1744 TABLE-INFO is the plist containing format info about the table,
1745 as returned by `org-export-table-format-info'. INFO is a plist
1746 used as a communication channel.
1748 The format string leaves one placeholder for the body of the
1750 (let* ((label (org-element-property :name table
))
1751 (caption (org-e-latex--caption/label-string
1752 (org-element-property :caption table
) label info
))
1753 (attr (mapconcat 'identity
1754 (org-element-property :attr_latex table
)
1756 ;; Determine alignment string.
1757 (alignment (org-e-latex-table--align-string attr table-info
))
1758 ;; Determine environment for the table: longtable, tabular...
1760 ((not attr
) org-e-latex-default-table-environment
)
1761 ((string-match "\\<longtable\\>" attr
) "longtable")
1762 ((string-match "\\<tabular.?\\>" attr
)
1763 (org-match-string-no-properties 0 attr
))
1764 (t org-e-latex-default-table-environment
)))
1765 ;; If table is a float, determine environment: table or table*.
1767 ((string= "longtable" table-env
) nil
)
1769 (or (string-match (regexp-quote "table*") attr
)
1770 (string-match "\\<multicolumn\\>" attr
)))
1772 ((or (not (string= caption
"")) label
) "table")))
1773 ;; Extract others display options.
1774 (width (and attr
(string-match "\\<width=\\(\\S-+\\)" attr
)
1775 (org-match-string-no-properties 1 attr
)))
1777 (if (and attr
(string-match "\\<placement=\\(\\S-+\\)" attr
))
1778 (org-match-string-no-properties 1 attr
)
1779 (format "[%s]" org-e-latex-default-figure-position
))))
1780 ;; Prepare the final format string for the table.
1783 ((string= "longtable" table-env
)
1785 "\\begin{longtable}{%s}\n%s\n%%s\n%s\\end{longtable}"
1787 (if (or (not org-e-latex-table-caption-above
) (string= "" caption
)) ""
1788 (concat (org-trim caption
) "\\\\"))
1789 (if (or org-e-latex-table-caption-above
(string= "" caption
)) ""
1790 (concat (org-trim caption
) "\\\\\n"))))
1792 (t (concat (when float-env
1794 (format "\\begin{%s}%s\n" float-env placement
)
1795 (if org-e-latex-table-caption-above caption
"")))
1796 (when org-e-latex-tables-centered
"\\begin{center}\n")
1797 (format "\\begin{%s}%s{%s}\n%%s\n\\end{%s}"
1799 (if width
(format "{%s}" width
) "") alignment table-env
)
1800 (when org-e-latex-tables-centered
"\n\\end{center}")
1802 (concat (if org-e-latex-table-caption-above
"" caption
)
1803 (format "\n\\end{%s}" float-env
))))))))
1805 (defun org-e-latex-table--align-string (attr table-info
)
1806 "Return an appropriate LaTeX alignment string.
1807 ATTR is a string containing table's LaTeX specific attributes.
1808 TABLE-INFO is the plist containing format info about the table,
1809 as returned by `org-export-table-format-info'."
1811 (string-match "\\<align=\\(\\S-+\\)" attr
)
1812 (match-string 1 attr
))
1813 (let* ((align (copy-sequence (plist-get table-info
:alignment
)))
1814 (colgroups (copy-sequence (plist-get table-info
:column-groups
)))
1815 (cols (length align
))
1816 (separators (make-vector (1+ cols
) "")))
1817 ;; Ignore the first column if it's special.
1818 (when (plist-get table-info
:special-column-p
)
1819 (aset align
0 "") (aset colgroups
0 nil
))
1822 (let ((gr (aref colgroups col
)))
1823 (when (memq gr
'(start start-end
))
1824 (aset separators col
"|"))
1825 (when (memq gr
'(end start-end
))
1826 (aset separators
(1+ col
) "|")))
1829 ;; Build the LaTeX specific alignment string.
1830 (loop for al across align
1831 for sep across separators
1832 concat
(concat sep al
) into output
1833 finally return
(concat output
(aref separators cols
))))))
1835 (defun org-e-latex-table (table contents info
)
1836 "Transcode a TABLE element from Org to LaTeX.
1837 CONTENTS is nil. INFO is a plist holding contextual information."
1838 (let ((attr (mapconcat #'identity
1839 (org-element-property :attr_latex table
)
1841 (raw-table (org-element-property :raw-table table
)))
1843 ;; Case 1: verbatim table.
1844 ((or org-e-latex-tables-verbatim
1845 (and attr
(string-match "\\<verbatim\\>" attr
)))
1846 (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
1847 (org-export-clean-table
1849 (plist-get (org-export-table-format-info raw-table
)
1850 :special-column-p
))))
1851 ;; Case 2: table.el table. Convert it using appropriate tools.
1852 ((eq (org-element-property :type table
) 'table.el
)
1854 ;; Ensure "*org-export-table*" buffer is empty.
1855 (with-current-buffer (get-buffer-create "*org-export-table*")
1857 (let ((output (with-temp-buffer
1860 (re-search-forward "^[ \t]*|[^|]" nil t
)
1861 (table-generate-source 'latex
"*org-export-table*")
1862 (with-current-buffer "*org-export-table*"
1863 (org-trim (buffer-string))))))
1864 (kill-buffer (get-buffer "*org-export-table*"))
1865 ;; Remove left out comments.
1866 (while (string-match "^%.*\n" output
)
1867 (setq output
(replace-match "" t t output
)))
1868 ;; When the "rmlines" attribute is provided, remove all hlines
1869 ;; but the the one separating heading from the table body.
1870 (when (and attr
(string-match "\\<rmlines\\>" attr
))
1871 (let ((n 0) (pos 0))
1872 (while (and (< (length output
) pos
)
1873 (setq pos
(string-match "^\\\\hline\n?" output pos
)))
1876 (setq output
(replace-match "" nil nil output
))))))
1877 (if (not org-e-latex-tables-centered
) output
1878 (format "\\begin{center}\n%s\n\\end{center}" output
))))
1879 ;; Case 3: Standard table.
1881 (let* ((table-info (org-export-table-format-info raw-table
))
1882 (columns-number (length (plist-get table-info
:alignment
)))
1883 (longtablep (and attr
(string-match "\\<longtable\\>" attr
)))
1885 (or (and attr
(string-match "\\<booktabs=\\(yes\\|t\\)\\>" attr
))
1886 org-e-latex-tables-booktabs
))
1887 ;; CLEAN-TABLE is a table turned into a list, much like
1888 ;; `org-table-to-lisp', with special column and
1889 ;; formatting cookies removed, and cells already
1894 (if (string-match org-table-hline-regexp row
) 'hline
1897 (org-export-secondary-string
1898 (org-element-parse-secondary-string
1900 (cdr (assq 'table org-element-string-restrictions
)))
1902 (org-split-string row
"[ \t]*|[ \t]*"))))
1904 (org-export-clean-table
1905 raw-table
(plist-get table-info
:special-column-p
))
1907 ;; If BOOKTABSP is non-nil, remove any rule at the beginning
1908 ;; and the end of the table, since booktabs' special rules
1909 ;; will be inserted instead.
1911 (when (eq (car clean-table
) 'hline
)
1912 (setq clean-table
(cdr clean-table
)))
1913 (when (eq (car (last clean-table
)) 'hline
)
1914 (setq clean-table
(butlast clean-table
))))
1915 ;; Convert ROWS to send them to `orgtbl-to-latex'. In
1916 ;; particular, send each cell to
1917 ;; `org-element-parse-secondary-string' to expand any Org
1918 ;; object within. Eventually, flesh the format string out
1921 (org-e-latex-table--format-string table table-info info
)
1924 ;; Parameters passed to `orgtbl-to-latex'.
1925 `(:tstart
,(and booktabsp
"\\toprule")
1926 :tend
,(and booktabsp
"\\bottomrule")
1927 :hline
,(if booktabsp
"\\midrule" "\\hline")
1928 ;; Longtable environment requires specific header
1929 ;; lines end string.
1930 :hlend
,(and longtablep
1934 %s\\multicolumn{%d}{r}{Continued on next page}\\\\
1937 (if booktabsp
"\\midrule" "\\hline")
1938 (if booktabsp
"\\midrule" "\\hline")
1939 columns-number
))))))))))
1944 (defun org-e-latex-target (target text info
)
1945 "Transcode a TARGET object from Org to LaTeX.
1946 TEXT is the text of the target. INFO is a plist holding
1947 contextual information."
1948 (format "\\label{%s}%s"
1949 (org-export-solidify-link-text
1950 (org-element-property :raw-value target
))
1956 (defun org-e-latex-time-stamp (time-stamp contents info
)
1957 "Transcode a TIME-STAMP object from Org to LaTeX.
1958 CONTENTS is nil. INFO is a plist holding contextual
1960 (let ((value (org-element-property :value time-stamp
))
1961 (type (org-element-property :type time-stamp
))
1962 (appt-type (org-element-property :appt-type time-stamp
)))
1963 (concat (cond ((eq appt-type
'scheduled
)
1964 (format "\\textbf{\\textsc{%s}} " org-scheduled-string
))
1965 ((eq appt-type
'deadline
)
1966 (format "\\textbf{\\textsc{%s}} " org-deadline-string
))
1967 ((eq appt-type
'closed
)
1968 (format "\\textbf{\\textsc{%s}} " org-closed-string
)))
1969 (cond ((memq type
'(active active-range
))
1970 (format org-e-latex-active-timestamp-format value
))
1971 ((memq type
'(inactive inactive-range
))
1972 (format org-e-latex-inactive-timestamp-format value
))
1974 (format org-e-latex-diary-timestamp-format value
))))))
1979 (defun org-e-latex-verbatim (verbatim contents info
)
1980 "Transcode a VERBATIM object from Org to LaTeX.
1981 CONTENTS is nil. INFO is a plist used as a communication
1983 (let ((fmt (cdr (assoc (org-element-property :marker verbatim
)
1984 org-e-latex-emphasis-alist
)))
1985 (value (org-element-property :value verbatim
)))
1987 ;; Handle the `verb' special case.
1989 (let ((separator (org-e-latex--find-verb-separator value
)))
1990 (concat "\\verb" separator value separator
)))
1991 ;; Handle the `protectedtexttt' special case.
1992 ((eq 'protectedtexttt fmt
)
1994 (trans '(("\\" .
"\\textbackslash{}")
1995 ("~" .
"\\textasciitilde{}")
1996 ("^" .
"\\textasciicircum{}")))
1999 (while (string-match "[\\{}$%&_#~^]" value
)
2000 (setq char
(match-string 0 value
))
2001 (if (> (match-beginning 0) 0)
2002 (setq rtn
(concat rtn
(substring value
0 (match-beginning 0)))))
2003 (setq value
(substring value
(1+ (match-beginning 0))))
2004 (setq char
(or (cdr (assoc char trans
)) (concat "\\" char
))
2005 rtn
(concat rtn char
)))
2006 (setq value
(concat rtn value
)
2008 (while (string-match "--" value
)
2009 (setq value
(replace-match "-{}-" t t value
)))
2010 (format fmt value
)))
2011 ;; Else use format string.
2012 (t (format fmt value
)))))
2017 (defun org-e-latex-verse-block (verse-block contents info
)
2018 "Transcode a VERSE-BLOCK element from Org to LaTeX.
2019 CONTENTS is nil. INFO is a plist holding contextual information."
2020 (org-e-latex--wrap-label
2022 ;; In a verse environment, add a line break to each newline
2023 ;; character and change each white space at beginning of a line
2024 ;; into a space of 1 em. Also change each blank line with
2025 ;; a vertical space of 1 em.
2027 (setq contents
(replace-regexp-in-string
2028 "^ *\\\\\\\\$" "\\\\vspace*{1em}"
2029 (replace-regexp-in-string
2030 "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n"
2031 (org-remove-indentation
2032 (org-export-secondary-string
2033 (org-element-property :value verse-block
)
2035 (while (string-match "^[ \t]+" contents
)
2036 (let ((new-str (format "\\hspace*{%dem}"
2037 (length (match-string 0 contents
)))))
2038 (setq contents
(replace-match new-str nil t contents
))))
2039 (format "\\begin{verse}\n%s\\end{verse}" contents
))))
2043 ;;; Interactive functions
2045 (defun org-e-latex-export-to-latex
2046 (&optional subtreep visible-only body-only ext-plist pub-dir
)
2047 "Export current buffer to a LaTeX file.
2049 If narrowing is active in the current buffer, only export its
2052 If a region is active, export that region.
2054 When optional argument SUBTREEP is non-nil, export the sub-tree
2055 at point, extracting information from the headline properties
2058 When optional argument VISIBLE-ONLY is non-nil, don't export
2059 contents of hidden elements.
2061 When optional argument BODY-ONLY is non-nil, only write code
2062 between \"\\begin{document}\" and \"\\end{document}\".
2064 EXT-PLIST, when provided, is a property list with external
2065 parameters overriding Org default settings, but still inferior to
2066 file-local settings.
2068 When optional argument PUB-DIR is set, use it as the publishing
2071 Return output file's name."
2073 (let ((outfile (org-export-output-file-name ".tex" subtreep pub-dir
)))
2075 'e-latex outfile subtreep visible-only body-only ext-plist
)))
2077 (defun org-e-latex-export-to-pdf
2078 (&optional subtreep visible-only body-only ext-plist pub-dir
)
2079 "Export current buffer to LaTeX then process through to PDF.
2081 If narrowing is active in the current buffer, only export its
2084 If a region is active, export that region.
2086 When optional argument SUBTREEP is non-nil, export the sub-tree
2087 at point, extracting information from the headline properties
2090 When optional argument VISIBLE-ONLY is non-nil, don't export
2091 contents of hidden elements.
2093 When optional argument BODY-ONLY is non-nil, only write code
2094 between \"\\begin{document}\" and \"\\end{document}\".
2096 EXT-PLIST, when provided, is a property list with external
2097 parameters overriding Org default settings, but still inferior to
2098 file-local settings.
2100 When optional argument PUB-DIR is set, use it as the publishing
2103 Return PDF file's name."
2105 (org-e-latex-compile
2106 (org-e-latex-export-to-latex
2107 subtreep visible-only body-only ext-plist pub-dir
)))
2109 (defun org-e-latex-compile (texfile)
2110 "Compile a TeX file.
2112 TEXFILE is the name of the file being compiled. Processing is
2113 done through the command specified in `org-e-latex-pdf-process'.
2115 Return PDF file name or an error if it couldn't be produced."
2116 (let* ((wconfig (current-window-configuration))
2117 (texfile (file-truename texfile
))
2118 (base (file-name-sans-extension texfile
))
2120 (message (format "Processing LaTeX file %s ..." texfile
))
2124 ;; A function is provided: Apply it.
2125 ((functionp org-latex-to-pdf-process
)
2126 (funcall org-latex-to-pdf-process
(shell-quote-argument texfile
)))
2127 ;; A list is provided: Replace %b, %f and %o with appropriate
2128 ;; values in each command before applying it. Output is
2129 ;; redirected to "*Org PDF LaTeX Output*" buffer.
2130 ((consp org-e-latex-pdf-process
)
2131 (let* ((out-dir (or (file-name-directory texfile
) "./"))
2132 (outbuf (get-buffer-create "*Org PDF LaTeX Output*")))
2136 (replace-regexp-in-string
2137 "%b" (shell-quote-argument base
)
2138 (replace-regexp-in-string
2139 "%f" (shell-quote-argument texfile
)
2140 (replace-regexp-in-string
2141 "%o" (shell-quote-argument out-dir
) command
)))
2143 org-e-latex-pdf-process
)
2144 ;; Collect standard errors from output buffer.
2145 (setq errors
(org-e-latex-collect-errors outbuf
))))
2146 (t (error "No valid command to process to PDF")))
2147 (let ((pdffile (concat base
".pdf")))
2148 ;; Check for process failure. Provide collected errors if
2150 (if (not (file-exists-p pdffile
))
2151 (error (concat (format "PDF file %s wasn't produced" pdffile
)
2152 (when errors
(concat ": " errors
))))
2153 ;; Else remove log files, when specified, and signal end of
2154 ;; process to user, along with any error encountered.
2155 (when org-e-latex-remove-logfiles
2156 (dolist (ext org-e-latex-logfiles-extensions
)
2157 (let ((file (concat base
"." ext
)))
2158 (when (file-exists-p file
) (delete-file file
)))))
2159 (message (concat "Process completed"
2160 (if (not errors
) "."
2161 (concat " with errors: " errors
)))))
2162 ;; Return output file name.
2164 (set-window-configuration wconfig
))))
2166 (defun org-e-latex-collect-errors (buffer)
2167 "Collect some kind of errors from \"pdflatex\" command output.
2169 BUFFER is the buffer containing output.
2171 Return collected error types as a string, or nil if there was
2173 (with-current-buffer buffer
2175 (goto-char (point-max))
2176 ;; Find final "pdflatex" run.
2177 (when (re-search-backward "^[ \t]*This is pdf.*?TeX.*?Version" nil t
)
2178 (let ((case-fold-search t
)
2180 (when (save-excursion
2181 (re-search-forward "Reference.*?undefined" nil t
))
2182 (setq errors
(concat errors
" [undefined reference]")))
2183 (when (save-excursion
2184 (re-search-forward "Citation.*?undefined" nil t
))
2185 (setq errors
(concat errors
" [undefined citation]")))
2186 (when (save-excursion
2187 (re-search-forward "Undefined control sequence" nil t
))
2188 (setq errors
(concat errors
" [undefined control sequence]")))
2189 (when (save-excursion
2190 (re-search-forward "^! LaTeX.*?Error" nil t
))
2191 (setq errors
(concat errors
" [LaTeX error]")))
2192 (when (save-excursion
2193 (re-search-forward "^! Package.*?Error" nil t
))
2194 (setq errors
(concat errors
" [package error]")))
2195 (and (org-string-nw-p errors
) (org-trim errors
)))))))
2198 (provide 'org-e-latex
)
2199 ;;; org-e-latex.el ends here