lisp/org-latex.el

   1 ;;; org-latex.el --- LaTeX exporter for org-mode
   2 ;;
   3 ;; Copyright (C) 2007-2012 Free Software Foundation, Inc.
   4 ;;
   5 ;; Emacs Lisp Archive Entry
   6 ;; Filename: org-latex.el
   7 ;; Author: Bastien Guerry <bzg AT gnu DOT org>
   8 ;; Maintainer: Carsten Dominik <carsten.dominik AT gmail DOT com>
   9 ;; Keywords: org, wp, tex
  10 ;; Description: Converts an org-mode buffer into LaTeX
  11
  12 ;; This file is part of GNU Emacs.
  13
  14 ;; GNU Emacs is free software: you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation, either version 3 of the License, or
  17 ;; (at your option) any later version.
  18
  19 ;; GNU Emacs is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  26
  27 ;;; Commentary:
  28 ;;
  29 ;; This library implements a LaTeX exporter for org-mode.
  30 ;;
  31 ;; It is part of Org and will be autoloaded
  32 ;;
  33 ;; The interactive functions are similar to those of the HTML exporter:
  34 ;;
  35 ;; M-x `org-export-as-latex'
  36 ;; M-x `org-export-as-pdf'
  37 ;; M-x `org-export-as-pdf-and-open'
  38 ;; M-x `org-export-as-latex-batch'
  39 ;; M-x `org-export-as-latex-to-buffer'
  40 ;; M-x `org-export-region-as-latex'
  41 ;; M-x `org-replace-region-by-latex'
  42 ;;
  43 ;;; Code:
  44
  45 (eval-when-compile
  46   (require 'cl))
  47
  48 (require 'footnote)
  49 (require 'org)
  50 (require 'org-exp)
  51 (require 'org-macs)
  52 (require 'org-beamer)
  53
  54 ;;; Variables:
  55 (defvar org-export-latex-class nil)
  56 (defvar org-export-latex-class-options 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-complex-heading-re nil)
  62 (defvar org-export-latex-not-done-keywords nil)
  63 (defvar org-export-latex-done-keywords nil)
  64 (defvar org-export-latex-display-custom-times nil)
  65 (defvar org-export-latex-all-targets-re nil)
  66 (defvar org-export-latex-add-level 0)
  67 (defvar org-export-latex-footmark-seen nil
  68   "List of footnotes markers seen so far by exporter.")
  69 (defvar org-export-latex-sectioning "")
  70 (defvar org-export-latex-sectioning-depth 0)
  71 (defvar org-export-latex-special-keyword-regexp
  72   (concat "\\<\\(" org-scheduled-string "\\|"
  73           org-deadline-string "\\|"
  74           org-closed-string"\\)")
  75   "Regexp matching special time planning keywords plus the time after it.")
  76 (defvar org-re-quote)  ; dynamically scoped from org.el
  77 (defvar org-commentsp) ; dynamically scoped from org.el
  78
  79 ;;; User variables:
  80
  81 (defgroup org-export-latex nil
  82   "Options for exporting Org-mode files to LaTeX."
  83   :tag "Org Export LaTeX"
  84   :group 'org-export)
  85
  86 (defcustom org-export-latex-default-class "article"
  87   "The default LaTeX class."
  88   :group 'org-export-latex
  89   :type '(string :tag "LaTeX class"))
  90
  91 (defcustom org-export-latex-classes
  92   '(("article"
  93      "\\documentclass[11pt]{article}"
  94      ("\\section{%s}" . "\\section*{%s}")
  95      ("\\subsection{%s}" . "\\subsection*{%s}")
  96      ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
  97      ("\\paragraph{%s}" . "\\paragraph*{%s}")
  98      ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
  99     ("report"
 100      "\\documentclass[11pt]{report}"
 101      ("\\part{%s}" . "\\part*{%s}")
 102      ("\\chapter{%s}" . "\\chapter*{%s}")
 103      ("\\section{%s}" . "\\section*{%s}")
 104      ("\\subsection{%s}" . "\\subsection*{%s}")
 105      ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
 106     ("book"
 107      "\\documentclass[11pt]{book}"
 108      ("\\part{%s}" . "\\part*{%s}")
 109      ("\\chapter{%s}" . "\\chapter*{%s}")
 110      ("\\section{%s}" . "\\section*{%s}")
 111      ("\\subsection{%s}" . "\\subsection*{%s}")
 112      ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
 113     ("beamer"
 114      "\\documentclass{beamer}"
 115      org-beamer-sectioning
 116      ))
 117   "Alist of LaTeX classes and associated header and structure.
 118 If #+LaTeX_CLASS is set in the buffer, use its value and the
 119 associated information.  Here is the structure of each cell:
 120
 121   \(class-name
 122     header-string
 123     (numbered-section . unnumbered-section\)
 124     ...\)
 125
 126 The header string
 127 -----------------
 128
 129 The HEADER-STRING is the header that will be inserted into the LaTeX file.
 130 It should contain the \\documentclass macro, and anything else that is needed
 131 for this setup.  To this header, the following commands will be added:
 132
 133 - Calls to \\usepackage for all packages mentioned in the variables
 134   `org-export-latex-default-packages-alist' and
 135   `org-export-latex-packages-alist'.  Thus, your header definitions should
 136   avoid to also request these packages.
 137
 138 - Lines specified via \"#+LaTeX_HEADER:\"
 139
 140 If you need more control about the sequence in which the header is built
 141 up, or if you want to exclude one of these building blocks for a particular
 142 class, you can use the following macro-like placeholders.
 143
 144  [DEFAULT-PACKAGES]      \\usepackage statements for default packages
 145  [NO-DEFAULT-PACKAGES]   do not include any of the default packages
 146  [PACKAGES]              \\usepackage statements for packages
 147  [NO-PACKAGES]           do not include the packages
 148  [EXTRA]                 the stuff from #+LaTeX_HEADER
 149  [NO-EXTRA]              do not include #+LaTeX_HEADER stuff
 150  [BEAMER-HEADER-EXTRA]   the beamer extra headers
 151
 152 So a header like
 153
 154   \\documentclass{article}
 155   [NO-DEFAULT-PACKAGES]
 156   [EXTRA]
 157   \\providecommand{\\alert}[1]{\\textbf{#1}}
 158   [PACKAGES]
 159
 160 will omit the default packages, and will include the #+LaTeX_HEADER lines,
 161 then have a call to \\providecommand, and then place \\usepackage commands
 162 based on the content of `org-export-latex-packages-alist'.
 163
 164 If your header or `org-export-latex-default-packages-alist' inserts
 165 \"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be replaced with
 166 a coding system derived from `buffer-file-coding-system'.  See also the
 167 variable `org-export-latex-inputenc-alist' for a way to influence this
 168 mechanism.
 169
 170 The sectioning structure
 171 ------------------------
 172
 173 The sectioning structure of the class is given by the elements following
 174 the header string.  For each sectioning level, a number of strings is
 175 specified.  A %s formatter is mandatory in each section string and will
 176 be replaced by the title of the section.
 177
 178 Instead of a cons cell (numbered . unnumbered), you can also provide a list
 179 of 2 or 4 elements,
 180
 181   (numbered-open numbered-close)
 182
 183 or
 184
 185   (numbered-open numbered-close unnumbered-open unnumbered-close)
 186
 187 providing opening and closing strings for a LaTeX environment that should
 188 represent the document section.  The opening clause should have a %s
 189 to represent the section title.
 190
 191 Instead of a list of sectioning commands, you can also specify a
 192 function name.  That function will be called with two parameters,
 193 the (reduced) level of the headline, and the headline text.  The function
 194 must return a cons cell with the (possibly modified) headline text, and the
 195 sectioning list in the cdr."
 196   :group 'org-export-latex
 197   :type '(repeat
 198           (list (string :tag "LaTeX class")
 199                 (string :tag "LaTeX header")
 200                 (repeat :tag "Levels" :inline t
 201                         (choice
 202                          (cons :tag "Heading"
 203                                (string :tag "  numbered")
 204                                (string :tag "unnumbered"))
 205                          (list :tag "Environment"
 206                                (string :tag "Opening   (numbered)")
 207                                (string :tag "Closing   (numbered)")
 208                                (string :tag "Opening (unnumbered)")
 209                                (string :tag "Closing (unnumbered)"))
 210                          (function :tag "Hook computing sectioning"))))))
 211
 212 (defcustom org-export-latex-inputenc-alist nil
 213   "Alist of inputenc coding system names, and what should really be used.
 214 For example, adding an entry
 215
 216       (\"utf8\" . \"utf8x\")
 217
 218 will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
 219 are written as utf8 files."
 220   :group 'org-export-latex
 221   :type '(repeat
 222           (cons
 223            (string :tag "Derived from buffer")
 224            (string :tag "Use this instead"))))
 225
 226
 227 (defcustom org-export-latex-emphasis-alist
 228   '(("*" "\\textbf{%s}" nil)
 229     ("/" "\\emph{%s}" nil)
 230     ("_" "\\underline{%s}" nil)
 231     ("+" "\\st{%s}" nil)
 232     ("=" "\\protectedtexttt" t)
 233     ("~" "\\verb" t))
 234   "Alist of LaTeX expressions to convert emphasis fontifiers.
 235 Each element of the list is a list of three elements.
 236 The first element is the character used as a marker for fontification.
 237 The second element is a formatting string to wrap fontified text with.
 238 If it is \"\\verb\", Org will automatically select a delimiter
 239 character that is not in the string.  \"\\protectedtexttt\" will use \\texttt
 240 to typeset and try to protect special characters.
 241 The third element decides whether to protect converted text from other
 242 conversions."
 243   :group 'org-export-latex
 244   :type 'alist)
 245
 246 (defcustom org-export-latex-title-command "\\maketitle"
 247   "The command used to insert the title just after \\begin{document}.
 248 If this string contains the formatting specification \"%s\" then
 249 it will be used as a formatting string, passing the title as an
 250 argument."
 251   :group 'org-export-latex
 252   :type 'string)
 253
 254 (defcustom org-export-latex-import-inbuffer-stuff nil
 255   "Non-nil means define TeX macros for Org's inbuffer definitions.
 256 For example \orgTITLE for #+TITLE."
 257   :group 'org-export-latex
 258   :type 'boolean)
 259
 260 (defcustom org-export-latex-date-format
 261   "\\today"
 262   "Format string for \\date{...}."
 263   :group 'org-export-latex
 264   :type 'string)
 265
 266 (defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
 267   "Markup for TODO keywords, as a printf format.
 268 This can be a single format for all keywords, a cons cell with separate
 269 formats for not-done and done states, or an association list with setup
 270 for individual keywords.  If a keyword shows up for which there is no
 271 markup defined, the first one in the association list will be used."
 272   :group 'org-export-latex
 273   :type '(choice
 274           (string :tag "Default")
 275           (cons :tag "Distinguish undone and done"
 276                 (string :tag "Not-DONE states")
 277                 (string :tag "DONE states"))
 278           (repeat :tag "Per keyword markup"
 279                   (cons
 280                    (string :tag "Keyword")
 281                    (string :tag "Markup")))))
 282
 283 (defcustom org-export-latex-tag-markup "\\textbf{%s}"
 284   "Markup for tags, as a printf format."
 285   :group 'org-export-latex
 286   :type 'string)
 287
 288 (defcustom org-export-latex-timestamp-markup "\\textit{%s}"
 289   "A printf format string to be applied to time stamps."
 290   :group 'org-export-latex
 291   :type 'string)
 292
 293 (defcustom org-export-latex-timestamp-inactive-markup "\\textit{%s}"
 294   "A printf format string to be applied to inactive time stamps."
 295   :group 'org-export-latex
 296   :type 'string)
 297
 298 (defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
 299   "A printf format string to be applied to time stamps."
 300   :group 'org-export-latex
 301   :type 'string)
 302
 303 (defcustom org-export-latex-href-format "\\href{%s}{%s}"
 304   "A printf format string to be applied to href links.
 305 The format must contain either two %s instances or just one.
 306 If it contains two %s instances, the first will be filled with
 307 the link, the second with the link description.  If it contains
 308 only one, the %s will be filled with the link."
 309   :group 'org-export-latex
 310   :type 'string)
 311
 312 (defcustom org-export-latex-hyperref-format "\\hyperref[%s]{%s}"
 313   "A printf format string to be applied to hyperref links.
 314 The format must contain one or two %s instances.  The first one
 315 will be filled with the link, the second with its description."
 316   :group 'org-export-latex
 317   :type 'string)
 318
 319 (defcustom org-export-latex-footnote-separator "\\textsuperscript{,}\\,"
 320   "Text used to separate footnotes."
 321   :group 'org-export-latex
 322   :type 'string)
 323
 324 (defcustom org-export-latex-quotes
 325   '(("fr" ("\\(\\s-\\|[[(]\\)\"" . "«~") ("\\(\\S-\\)\"" . "~»") ("\\(\\s-\\|(\\)'" . "'"))
 326     ("en" ("\\(\\s-\\|[[(]\\)\"" . "``") ("\\(\\S-\\)\"" . "''") ("\\(\\s-\\|(\\)'" . "`")))
 327   "Alist for quotes to use when converting english double-quotes.
 328
 329 The CAR of each item in this alist is the language code.
 330 The CDR of each item in this alist is a list of three CONS:
 331 - the first CONS defines the opening quote;
 332 - the second CONS defines the closing quote;
 333 - the last CONS defines single quotes.
 334
 335 For each item in a CONS, the first string is a regexp
 336 for allowed characters before/after the quote, the second
 337 string defines the replacement string for this quote."
 338   :group 'org-export-latex
 339   :type '(list
 340           (cons :tag "Opening quote"
 341                 (string :tag "Regexp for char before")
 342                 (string :tag "Replacement quote     "))
 343           (cons :tag "Closing quote"
 344                 (string :tag "Regexp for char after ")
 345                 (string :tag "Replacement quote     "))
 346           (cons :tag "Single quote"
 347                 (string :tag "Regexp for char before")
 348                 (string :tag "Replacement quote     "))))
 349
 350 (defcustom org-export-latex-tables-verbatim nil
 351   "When non-nil, tables are exported verbatim."
 352   :group 'org-export-latex
 353   :type 'boolean)
 354
 355 (defcustom org-export-latex-tables-centered t
 356   "When non-nil, tables are exported in a center environment."
 357   :group 'org-export-latex
 358   :type 'boolean)
 359
 360 (defcustom org-export-latex-table-caption-above t
 361   "When non-nil, the caption is set above the table.  When nil,
 362 the caption is set below the table."
 363   :group 'org-export-latex
 364   :type 'boolean)
 365
 366 (defcustom org-export-latex-tables-column-borders nil
 367   "When non-nil, grouping columns can cause outer vertical lines in tables.
 368 When nil, grouping causes only separation lines between groups."
 369   :group 'org-export-latex
 370   :type 'boolean)
 371
 372 (defcustom org-export-latex-low-levels 'itemize
 373   "How to convert sections below the current level of sectioning.
 374 This is specified by the `org-export-headline-levels' option or the
 375 value of \"H:\" in Org's #+OPTION line.
 376
 377 This can be either nil (skip the sections), `description', `itemize',
 378 or `enumerate' (convert the sections as the corresponding list type), or
 379 a string to be used instead of \\section{%s}.  In this latter case,
 380 the %s stands here for the inserted headline and is mandatory.
 381
 382 It may also be a list of three string to define a user-defined environment
 383 that should be used.  The first string should be the like
 384 \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
 385 to two occurrences of %s for the title and a label, respectively.  The third
 386 string should be like \"\\end{itemize\"."
 387   :group 'org-export-latex
 388   :type '(choice (const :tag "Ignore" nil)
 389                  (const :tag "Convert as descriptive list" description)
 390                  (const :tag "Convert as itemized list" itemize)
 391                  (const :tag "Convert as enumerated list" enumerate)
 392                  (list  :tag "User-defined environment"
 393                         :value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
 394                         (string :tag "Start")
 395                         (string :tag "End")
 396                         (string :tag "item"))
 397                  (string :tag "Use a section string" :value "\\subparagraph{%s}")))
 398
 399 (defcustom org-export-latex-list-parameters
 400   '(:cbon "$\\boxtimes$" :cboff "$\\Box$" :cbtrans "$\\boxminus$")
 401   "Parameters for the LaTeX list exporter.
 402 These parameters will be passed on to `org-list-to-latex', which in turn
 403 will pass them (combined with the LaTeX default list parameters) to
 404 `org-list-to-generic'."
 405   :group 'org-export-latex
 406   :type 'plist)
 407
 408 (defcustom org-export-latex-verbatim-wrap
 409   '("\\begin{verbatim}\n" . "\\end{verbatim}")
 410   "Environment to be wrapped around a fixed-width section in LaTeX export.
 411 This is a cons with two strings, to be added before and after the
 412 fixed-with text.
 413
 414 Defaults to \\begin{verbatim} and \\end{verbatim}."
 415   :group 'org-export-translation
 416   :group 'org-export-latex
 417   :type '(cons (string :tag "Open")
 418                (string :tag "Close")))
 419
 420 (defcustom org-export-latex-listings nil
 421   "Non-nil means export source code using the listings package.
 422 This package will fontify source code, possibly even with color.
 423 If you want to use this, you also need to make LaTeX use the
 424 listings package, and if you want to have color, the color
 425 package.  Just add these to `org-export-latex-packages-alist',
 426 for example using customize, or with something like
 427
 428   (require 'org-latex)
 429   (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
 430   (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))
 431
 432 Alternatively,
 433
 434   (setq org-export-latex-listings 'minted)
 435
 436 causes source code to be exported using the minted package as
 437 opposed to listings.  If you want to use minted, you need to add
 438 the minted package to `org-export-latex-packages-alist', for
 439 example using customize, or with
 440
 441   (require 'org-latex)
 442   (add-to-list 'org-export-latex-packages-alist '(\"\" \"minted\"))
 443
 444 In addition, it is necessary to install
 445 pygments (http://pygments.org), and to configure the variable
 446 `org-latex-to-pdf-process' so that the -shell-escape option is
 447 passed to pdflatex.
 448 "
 449   :group 'org-export-latex
 450   :type 'boolean)
 451
 452 (defcustom org-export-latex-listings-langs
 453   '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
 454     (c "C") (cc "C++")
 455     (fortran "fortran")
 456     (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
 457     (html "HTML") (xml "XML")
 458     (tex "TeX") (latex "TeX")
 459     (shell-script "bash")
 460     (gnuplot "Gnuplot")
 461     (ocaml "Caml") (caml "Caml")
 462     (sql "SQL") (sqlite "sql"))
 463   "Alist mapping languages to their listing language counterpart.
 464 The key is a symbol, the major mode symbol without the \"-mode\".
 465 The value is the string that should be inserted as the language parameter
 466 for the listings package.  If the mode name and the listings name are
 467 the same, the language does not need an entry in this list - but it does not
 468 hurt if it is present."
 469   :group 'org-export-latex
 470   :type '(repeat
 471           (list
 472            (symbol :tag "Major mode       ")
 473            (string :tag "Listings language"))))
 474
 475 (defcustom org-export-latex-listings-w-names t
 476   "Non-nil means export names of named code blocks.
 477 Code blocks exported with the listings package (controlled by the
 478 `org-export-latex-listings' variable) can be named in the style
 479 of noweb."
 480   :group 'org-export-latex
 481   :type 'boolean)
 482
 483 (defcustom org-export-latex-minted-langs
 484   '((emacs-lisp "common-lisp")
 485     (cc "c++")
 486     (cperl "perl")
 487     (shell-script "bash")
 488     (caml "ocaml"))
 489   "Alist mapping languages to their minted language counterpart.
 490 The key is a symbol, the major mode symbol without the \"-mode\".
 491 The value is the string that should be inserted as the language parameter
 492 for the minted package.  If the mode name and the listings name are
 493 the same, the language does not need an entry in this list - but it does not
 494 hurt if it is present.
 495
 496 Note that minted uses all lower case for language identifiers,
 497 and that the full list of language identifiers can be obtained
 498 with:
 499 pygmentize -L lexers
 500 "
 501   :group 'org-export-latex
 502   :type '(repeat
 503           (list
 504            (symbol :tag "Major mode       ")
 505            (string :tag "Listings language"))))
 506
 507 (defcustom org-export-latex-listings-options nil
 508   "Association list of options for the latex listings package.
 509
 510 These options are supplied as a comma-separated list to the
 511 \\lstset command. Each element of the association list should be
 512 a list containing two strings: the name of the option, and the
 513 value. For example,
 514
 515   (setq org-export-latex-listings-options
 516     '((\"basicstyle\" \"\\small\")
 517       (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
 518
 519 will typeset the code in a small size font with underlined, bold
 520 black keywords.
 521
 522 Note that the same options will be applied to blocks of all
 523 languages."
 524   :group 'org-export-latex
 525   :type '(repeat
 526           (list
 527            (string :tag "Listings option name ")
 528            (string :tag "Listings option value"))))
 529
 530 (defcustom org-export-latex-minted-options nil
 531   "Association list of options for the latex minted package.
 532
 533 These options are supplied within square brackets in
 534 \\begin{minted} environments. Each element of the alist should be
 535 a list containing two strings: the name of the option, and the
 536 value. For example,
 537
 538   (setq org-export-latex-minted-options
 539     '((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
 540
 541 will result in src blocks being exported with
 542
 543 \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
 544
 545 as the start of the minted environment. Note that the same
 546 options will be applied to blocks of all languages."
 547   :group 'org-export-latex
 548   :type '(repeat
 549           (list
 550            (string :tag "Minted option name ")
 551            (string :tag "Minted option value"))))
 552
 553 (defvar org-export-latex-custom-lang-environments nil
 554   "Association list mapping languages to language-specific latex
 555   environments used during export of src blocks by the listings
 556   and minted latex packages. For example,
 557
 558   (setq org-export-latex-custom-lang-environments
 559      '((python \"pythoncode\")))
 560
 561   would have the effect that if org encounters begin_src python
 562   during latex export it will output
 563
 564   \\begin{pythoncode}
 565   <src block body>
 566   \\end{pythoncode}")
 567
 568 (defcustom org-export-latex-remove-from-headlines
 569   '(:todo nil :priority nil :tags nil)
 570   "A plist of keywords to remove from headlines.  OBSOLETE.
 571 Non-nil means remove this keyword type from the headline.
 572
 573 Don't remove the keys, just change their values.
 574
 575 Obsolete, this variable is no longer used.  Use the separate
 576 variables `org-export-with-todo-keywords', `org-export-with-priority',
 577 and `org-export-with-tags' instead."
 578   :type 'plist
 579   :group 'org-export-latex)
 580
 581 (defcustom org-export-latex-image-default-option "width=.9\\linewidth"
 582   "Default option for images."
 583   :group 'org-export-latex
 584   :type 'string)
 585
 586 (defcustom org-latex-default-figure-position "htb"
 587   "Default position for latex figures."
 588   :group 'org-export-latex
 589   :type 'string)
 590
 591 (defcustom org-export-latex-tabular-environment "tabular"
 592   "Default environment used to build tables."
 593   :group 'org-export-latex
 594   :type 'string)
 595
 596 (defcustom org-export-latex-inline-image-extensions
 597   '("pdf" "jpeg" "jpg" "png" "ps" "eps")
 598   "Extensions of image files that can be inlined into LaTeX.
 599 Note that the image extension *actually* allowed depend on the way the
 600 LaTeX file is processed.  When used with pdflatex, pdf, jpg and png images
 601 are OK.  When processing through dvi to Postscript, only ps and eps are
 602 allowed.  The default we use here encompasses both."
 603   :group 'org-export-latex
 604   :type '(repeat (string :tag "Extension")))
 605
 606 (defcustom org-export-latex-coding-system nil
 607   "Coding system for the exported LaTeX file."
 608   :group 'org-export-latex
 609   :type 'coding-system)
 610
 611 (defgroup org-export-pdf nil
 612   "Options for exporting Org-mode files to PDF, via LaTeX."
 613   :tag "Org Export PDF"
 614   :group 'org-export-latex
 615   :group 'org-export)
 616
 617 (defcustom org-latex-to-pdf-process
 618   '("pdflatex -interaction nonstopmode -output-directory %o %f"
 619     "pdflatex -interaction nonstopmode -output-directory %o %f"
 620     "pdflatex -interaction nonstopmode -output-directory %o %f")
 621   "Commands to process a LaTeX file to a PDF file.
 622 This is a list of strings, each of them will be given to the shell
 623 as a command.  %f in the command will be replaced by the full file name, %b
 624 by the file base name (i.e. without extension) and %o by the base directory
 625 of the file.
 626
 627 The reason why this is a list is that it usually takes several runs of
 628 `pdflatex', maybe mixed with a call to `bibtex'.  Org does not have a clever
 629 mechanism to detect which of these commands have to be run to get to a stable
 630 result, and it also does not do any error checking.
 631
 632 By default, Org uses 3 runs of `pdflatex' to do the processing.  If you
 633 have texi2dvi on your system and if that does not cause the infamous
 634 egrep/locale bug:
 635
 636      http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
 637
 638 then `texi2dvi' is the superior choice.  Org does offer it as one
 639 of the customize options.
 640
 641 Alternatively, this may be a Lisp function that does the processing, so you
 642 could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
 643 This function should accept the file name as its single argument."
 644   :group 'org-export-pdf
 645   :type '(choice
 646           (repeat :tag "Shell command sequence"
 647                   (string :tag "Shell command"))
 648           (const :tag "2 runs of pdflatex"
 649                  ("pdflatex -interaction nonstopmode -output-directory %o %f"
 650                    "pdflatex -interaction nonstopmode -output-directory %o %f"))
 651           (const :tag "3 runs of pdflatex"
 652                  ("pdflatex -interaction nonstopmode -output-directory %o %f"
 653                    "pdflatex -interaction nonstopmode -output-directory %o %f"
 654                    "pdflatex -interaction nonstopmode -output-directory %o %f"))
 655           (const :tag "pdflatex,bibtex,pdflatex,pdflatex"
 656                  ("pdflatex -interaction nonstopmode -output-directory %o %f"
 657                    "bibtex %b"
 658                    "pdflatex -interaction nonstopmode -output-directory %o %f"
 659                    "pdflatex -interaction nonstopmode -output-directory %o %f"))
 660           (const :tag "texi2dvi"
 661                  ("texi2dvi -p -b -c -V %f"))
 662           (const :tag "rubber"
 663                  ("rubber -d --into %o %f"))
 664           (function)))
 665
 666 (defcustom org-export-pdf-logfiles
 667   '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
 668   "The list of file extensions to consider as LaTeX logfiles."
 669   :group 'org-export-pdf
 670   :type '(repeat (string :tag "Extension")))
 671
 672 (defcustom org-export-pdf-remove-logfiles t
 673   "Non-nil means remove the logfiles produced by PDF production.
 674 These are the .aux, .log, .out, and .toc files."
 675   :group 'org-export-pdf
 676   :type 'boolean)
 677
 678 ;;; Hooks
 679
 680 (defvar org-export-latex-after-initial-vars-hook nil
 681   "Hook run before LaTeX export.
 682 The exact moment is after the initial variables like org-export-latex-class
 683 have been determined from the environment.")
 684
 685 (defvar org-export-latex-after-blockquotes-hook nil
 686   "Hook run during LaTeX export, after blockquote, verse, center are done.")
 687
 688 (defvar org-export-latex-final-hook nil
 689   "Hook run in the finalized LaTeX buffer.")
 690
 691 (defvar org-export-latex-after-save-hook nil
 692   "Hook run in the finalized LaTeX buffer, after it has been saved.")
 693
 694 ;;; Autoload functions:
 695
 696 ;;;###autoload
 697 (defun org-export-as-latex-batch ()
 698   "Call `org-export-as-latex', may be used in batch processing.
 699 For example:
 700
 701 emacs   --batch
 702         --load=$HOME/lib/emacs/org.el
 703         --eval \"(setq org-export-headline-levels 2)\"
 704         --visit=MyFile --funcall org-export-as-latex-batch"
 705   (org-export-as-latex org-export-headline-levels 'hidden))
 706
 707 ;;;###autoload
 708 (defun org-export-as-latex-to-buffer (arg)
 709   "Call `org-export-as-latex` with output to a temporary buffer.
 710 No file is created.  The prefix ARG is passed through to `org-export-as-latex'."
 711   (interactive "P")
 712   (org-export-as-latex arg nil nil "*Org LaTeX Export*")
 713   (when org-export-show-temporary-export-buffer
 714     (switch-to-buffer-other-window "*Org LaTeX Export*")))
 715
 716 ;;;###autoload
 717 (defun org-replace-region-by-latex (beg end)
 718   "Replace the region from BEG to END with its LaTeX export.
 719 It assumes the region has `org-mode' syntax, and then convert it to
 720 LaTeX.  This can be used in any buffer.  For example, you could
 721 write an itemized list in `org-mode' syntax in an LaTeX buffer and
 722 then use this command to convert it."
 723   (interactive "r")
 724   (let (reg latex buf)
 725     (save-window-excursion
 726       (if (eq major-mode 'org-mode)
 727           (setq latex (org-export-region-as-latex
 728                        beg end t 'string))
 729         (setq reg (buffer-substring beg end)
 730               buf (get-buffer-create "*Org tmp*"))
 731         (with-current-buffer buf
 732           (erase-buffer)
 733           (insert reg)
 734           (org-mode)
 735           (setq latex (org-export-region-as-latex
 736                        (point-min) (point-max) t 'string)))
 737         (kill-buffer buf)))
 738     (delete-region beg end)
 739     (insert latex)))
 740
 741 ;;;###autoload
 742 (defun org-export-region-as-latex (beg end &optional body-only buffer)
 743   "Convert region from BEG to END in `org-mode' buffer to LaTeX.
 744 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
 745 contents, and only produce the region of converted text, useful for
 746 cut-and-paste operations.
 747 If BUFFER is a buffer or a string, use/create that buffer as a target
 748 of the converted LaTeX.  If BUFFER is the symbol `string', return the
 749 produced LaTeX as a string and leave no buffer behind.  For example,
 750 a Lisp program could call this function in the following way:
 751
 752   (setq latex (org-export-region-as-latex beg end t 'string))
 753
 754 When called interactively, the output buffer is selected, and shown
 755 in a window.  A non-interactive call will only return the buffer."
 756   (interactive "r\nP")
 757   (when (org-called-interactively-p 'any)
 758     (setq buffer "*Org LaTeX Export*"))
 759   (let ((transient-mark-mode t) (zmacs-regions t)
 760         ext-plist rtn)
 761     (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
 762     (goto-char end)
 763     (set-mark (point)) ;; to activate the region
 764     (goto-char beg)
 765     (setq rtn (org-export-as-latex
 766                nil nil ext-plist
 767                buffer body-only))
 768     (if (fboundp 'deactivate-mark) (deactivate-mark))
 769     (if (and (org-called-interactively-p 'any) (bufferp rtn))
 770         (switch-to-buffer-other-window rtn)
 771       rtn)))
 772
 773 ;;;###autoload
 774 (defun org-export-as-latex (arg &optional hidden ext-plist
 775                                 to-buffer body-only pub-dir)
 776   "Export current buffer to a LaTeX file.
 777 If there is an active region, export only the region.  The prefix
 778 ARG specifies how many levels of the outline should become
 779 headlines.  The default is 3.  Lower levels will be exported
 780 depending on `org-export-latex-low-levels'.  The default is to
 781 convert them as description lists.
 782 HIDDEN is obsolete and does nothing.
 783 EXT-PLIST is a property list with
 784 external parameters overriding org-mode's default settings, but
 785 still inferior to file-local settings.  When TO-BUFFER is
 786 non-nil, create a buffer with that name and export to that
 787 buffer.  If TO-BUFFER is the symbol `string', don't leave any
 788 buffer behind but just return the resulting LaTeX as a string.
 789 When BODY-ONLY is set, don't produce the file header and footer,
 790 simply return the content of \\begin{document}...\\end{document},
 791 without even the \\begin{document} and \\end{document} commands.
 792 when PUB-DIR is set, use this as the publishing directory."
 793   (interactive "P")
 794   (when (and (not body-only) arg (listp arg)) (setq body-only t))
 795   (run-hooks 'org-export-first-hook)
 796
 797   ;; Make sure we have a file name when we need it.
 798   (when (and (not (or to-buffer body-only))
 799              (not buffer-file-name))
 800     (if (buffer-base-buffer)
 801         (org-set-local 'buffer-file-name
 802                        (with-current-buffer (buffer-base-buffer)
 803                          buffer-file-name))
 804       (error "Need a file name to be able to export")))
 805
 806   (message "Exporting to LaTeX...")
 807   (org-unmodified
 808    (let ((inhibit-read-only t))
 809      (remove-text-properties (point-min) (point-max)
 810                              '(:org-license-to-kill nil))))
 811   (org-update-radio-target-regexp)
 812   (org-export-latex-set-initial-vars ext-plist arg)
 813   (setq org-export-opt-plist org-export-latex-options-plist
 814         org-export-footnotes-data (org-footnote-all-labels 'with-defs)
 815         org-export-footnotes-seen nil
 816         org-export-latex-footmark-seen nil)
 817   (org-install-letbind)
 818   (run-hooks 'org-export-latex-after-initial-vars-hook)
 819   (let* ((wcf (current-window-configuration))
 820          (opt-plist
 821           (org-export-process-option-filters org-export-latex-options-plist))
 822          (region-p (org-region-active-p))
 823          (rbeg (and region-p (region-beginning)))
 824          (rend (and region-p (region-end)))
 825          (subtree-p
 826           (if (plist-get opt-plist :ignore-subtree-p)
 827               nil
 828             (when region-p
 829               (save-excursion
 830                 (goto-char rbeg)
 831                 (and (org-at-heading-p)
 832                      (>= (org-end-of-subtree t t) rend))))))
 833          (opt-plist (setq org-export-opt-plist
 834                           (if subtree-p
 835                               (org-export-add-subtree-options opt-plist rbeg)
 836                             opt-plist)))
 837          ;; Make sure the variable contains the updated values.
 838          (org-export-latex-options-plist (setq org-export-opt-plist opt-plist))
 839          ;; The following two are dynamically scoped into other
 840          ;; routines below.
 841          (org-current-export-dir
 842           (or pub-dir (org-export-directory :html opt-plist)))
 843          (org-current-export-file buffer-file-name)
 844          (title (or (and subtree-p (org-export-get-title-from-subtree))
 845                     (plist-get opt-plist :title)
 846                     (and (not
 847                           (plist-get opt-plist :skip-before-1st-heading))
 848                          (org-export-grab-title-from-buffer))
 849                     (and buffer-file-name
 850                          (file-name-sans-extension
 851                           (file-name-nondirectory buffer-file-name)))
 852                     "No Title"))
 853          (filename
 854           (and (not to-buffer)
 855                (concat
 856                 (file-name-as-directory
 857                  (or pub-dir
 858                      (org-export-directory :LaTeX ext-plist)))
 859                 (file-name-sans-extension
 860                  (or (and subtree-p
 861                           (org-entry-get rbeg "EXPORT_FILE_NAME" t))
 862                      (file-name-nondirectory ;sans-extension
 863                       (or buffer-file-name
 864                           (error "Don't know which export file to use")))))
 865                 ".tex")))
 866          (filename
 867           (and filename
 868                (if (equal (file-truename filename)
 869                           (file-truename (or buffer-file-name "dummy.org")))
 870                    (concat filename ".tex")
 871                  filename)))
 872          (auto-insert nil); Avoid any auto-insert stuff for the new file
 873          (buffer (if to-buffer
 874                      (cond
 875                       ((eq to-buffer 'string) (get-buffer-create
 876                                                "*Org LaTeX Export*"))
 877                       (t (get-buffer-create to-buffer)))
 878                    (find-file-noselect filename)))
 879          (odd org-odd-levels-only)
 880          (header (org-export-latex-make-header title opt-plist))
 881          (skip (cond (subtree-p nil)
 882                      (region-p nil)
 883                      (t (plist-get opt-plist :skip-before-1st-heading))))
 884          (text (plist-get opt-plist :text))
 885          (org-export-preprocess-hook
 886           (cons
 887            `(lambda () (org-set-local 'org-complex-heading-regexp
 888                                       ,org-export-latex-complex-heading-re))
 889            org-export-preprocess-hook))
 890          (first-lines (if skip "" (org-export-latex-first-lines
 891                                    opt-plist
 892                                    (if subtree-p
 893                                        (save-excursion
 894                                          (goto-char rbeg)
 895                                          (point-at-bol 2))
 896                                      rbeg)
 897                                    (if region-p rend))))
 898          (coding-system (and (boundp 'buffer-file-coding-system)
 899                              buffer-file-coding-system))
 900          (coding-system-for-write (or org-export-latex-coding-system
 901                                       coding-system))
 902          (save-buffer-coding-system (or org-export-latex-coding-system
 903                                         coding-system))
 904          (region (buffer-substring
 905                   (if region-p (region-beginning) (point-min))
 906                   (if region-p (region-end) (point-max))))
 907          (text
 908           (and text (string-match "\\S-" text)
 909                (org-export-preprocess-string
 910                 text
 911                 :emph-multiline t
 912                 :for-backend 'latex
 913                 :comments nil
 914                 :tags (plist-get opt-plist :tags)
 915                 :priority (plist-get opt-plist :priority)
 916                 :footnotes (plist-get opt-plist :footnotes)
 917                 :drawers (plist-get opt-plist :drawers)
 918                 :timestamps (plist-get opt-plist :timestamps)
 919                 :todo-keywords (plist-get opt-plist :todo-keywords)
 920                 :tasks (plist-get opt-plist :tasks)
 921                 :add-text nil
 922                 :skip-before-1st-heading skip
 923                 :select-tags nil
 924                 :exclude-tags nil
 925                 :LaTeX-fragments nil)))
 926          (string-for-export
 927           (org-export-preprocess-string
 928            region
 929            :emph-multiline t
 930            :for-backend 'latex
 931            :comments nil
 932            :tags (plist-get opt-plist :tags)
 933            :priority (plist-get opt-plist :priority)
 934            :footnotes (plist-get opt-plist :footnotes)
 935            :drawers (plist-get opt-plist :drawers)
 936            :timestamps (plist-get opt-plist :timestamps)
 937            :todo-keywords (plist-get opt-plist :todo-keywords)
 938            :tasks (plist-get opt-plist :tasks)
 939            :add-text (if (eq to-buffer 'string) nil text)
 940            :skip-before-1st-heading skip
 941            :select-tags (plist-get opt-plist :select-tags)
 942            :exclude-tags (plist-get opt-plist :exclude-tags)
 943            :LaTeX-fragments nil)))
 944
 945     ;; Avoid the Query for TeX master from AUCTeX
 946     (if (boundp 'TeX-master) (setq TeX-master t))
 947
 948     (set-buffer buffer)
 949     (erase-buffer)
 950     (org-install-letbind)
 951
 952     (and (fboundp 'set-buffer-file-coding-system)
 953          (set-buffer-file-coding-system coding-system-for-write))
 954
 955     ;; insert the header and initial document commands
 956     (unless (or (eq to-buffer 'string) body-only)
 957       (insert header))
 958
 959     ;; insert text found in #+TEXT
 960     (when (and text (not (eq to-buffer 'string)))
 961       (insert (org-export-latex-content
 962                text '(lists tables fixed-width keywords))
 963                "\n\n"))
 964
 965     ;; insert lines before the first headline
 966     (unless (or skip (string-match "^\\*" first-lines))
 967       (insert first-lines))
 968
 969     ;; export the content of headlines
 970     (org-export-latex-global
 971      (with-temp-buffer
 972        (insert string-for-export)
 973        (goto-char (point-min))
 974        (when (re-search-forward "^\\(\\*+\\) " nil t)
 975          (let* ((asters (length (match-string 1)))
 976                 (level (if odd (- asters 2) (- asters 1))))
 977            (setq org-export-latex-add-level
 978                  (if odd (1- (/ (1+ asters) 2)) (1- asters)))
 979            (org-export-latex-parse-global level odd)))))
 980
 981     ;; finalization
 982     (unless body-only (insert "\n\\end{document}"))
 983
 984     ;; Attach description terms to the \item macro
 985     (goto-char (point-min))
 986     (while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t)
 987       (delete-region (match-beginning 1) (match-end 1)))
 988
 989     ;; Relocate the table of contents
 990     (goto-char (point-min))
 991     (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
 992       (goto-char (point-min))
 993       (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
 994         (replace-match ""))
 995       (goto-char (point-min))
 996       (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
 997            (replace-match "\\tableofcontents" t t)))
 998
 999     ;; Cleanup forced line ends in items where they are not needed
1000     (goto-char (point-min))
1001     (while (re-search-forward
1002             "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
1003             nil t)
1004       (delete-region (match-beginning 1) (match-end 1)))
1005     (goto-char (point-min))
1006     (while (re-search-forward
1007             "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
1008             nil t)
1009       (if (looking-at "[\n \t]+")
1010           (replace-match "\n")))
1011
1012     (run-hooks 'org-export-latex-final-hook)
1013     (if to-buffer
1014         (unless (eq major-mode 'latex-mode) (latex-mode))
1015       (save-buffer))
1016     (org-export-latex-fix-inputenc)
1017     (run-hooks 'org-export-latex-after-save-hook)
1018     (goto-char (point-min))
1019     (or (org-export-push-to-kill-ring "LaTeX")
1020         (message "Exporting to LaTeX...done"))
1021     (prog1
1022         (if (eq to-buffer 'string)
1023             (prog1 (buffer-substring (point-min) (point-max))
1024               (kill-buffer (current-buffer)))
1025           (current-buffer))
1026       (set-window-configuration wcf))))
1027
1028 ;;;###autoload
1029 (defun org-export-as-pdf (arg &optional hidden ext-plist
1030                               to-buffer body-only pub-dir)
1031   "Export as LaTeX, then process through to PDF."
1032   (interactive "P")
1033   (message "Exporting to PDF...")
1034   (let* ((wconfig (current-window-configuration))
1035          (lbuf (org-export-as-latex arg hidden ext-plist
1036                                     to-buffer body-only pub-dir))
1037          (file (buffer-file-name lbuf))
1038          (base (file-name-sans-extension (buffer-file-name lbuf)))
1039          (pdffile (concat base ".pdf"))
1040          (cmds (if (eq org-export-latex-listings 'minted)
1041                    ;; automatically add -shell-escape when needed
1042                    (mapcar (lambda (cmd)
1043                              (replace-regexp-in-string
1044                               "pdflatex " "pdflatex -shell-escape " cmd))
1045                            org-latex-to-pdf-process)
1046                  org-latex-to-pdf-process))
1047          (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
1048          (bibtex-p (with-current-buffer lbuf
1049                      (save-excursion
1050                        (goto-char (point-min))
1051                        (re-search-forward "\\\\bibliography{" nil t))))
1052          cmd output-dir errors)
1053     (with-current-buffer outbuf (erase-buffer))
1054     (message (concat "Processing LaTeX file " file "..."))
1055     (setq output-dir (file-name-directory file))
1056     (with-current-buffer lbuf
1057       (save-excursion
1058         (if (and cmds (symbolp cmds))
1059             (funcall cmds (shell-quote-argument file))
1060           (while cmds
1061             (setq cmd (pop cmds))
1062             (while (string-match "%b" cmd)
1063               (setq cmd (replace-match
1064                          (save-match-data
1065                            (shell-quote-argument base))
1066                          t t cmd)))
1067             (while (string-match "%f" cmd)
1068               (setq cmd (replace-match
1069                          (save-match-data
1070                            (shell-quote-argument file))
1071                          t t cmd)))
1072             (while (string-match "%o" cmd)
1073               (setq cmd (replace-match
1074                          (save-match-data
1075                            (shell-quote-argument output-dir))
1076                          t t cmd)))
1077             (shell-command cmd outbuf)))))
1078     (message (concat "Processing LaTeX file " file "...done"))
1079     (setq errors (org-export-latex-get-error outbuf))
1080     (if (not (file-exists-p pdffile))
1081         (error (concat "PDF file " pdffile " was not produced"
1082                        (if errors (concat ":" errors "") "")))
1083       (set-window-configuration wconfig)
1084       (when org-export-pdf-remove-logfiles
1085         (dolist (ext org-export-pdf-logfiles)
1086           (setq file (concat base "." ext))
1087           (and (file-exists-p file) (delete-file file))))
1088       (message (concat
1089                 "Exporting to PDF...done"
1090                 (if errors
1091                     (concat ", with some errors:" errors)
1092                   "")))
1093       pdffile)))
1094
1095 (defun org-export-latex-get-error (buf)
1096   "Collect the kinds of errors that remain in pdflatex processing."
1097   (with-current-buffer buf
1098     (save-excursion
1099       (goto-char (point-max))
1100       (when (re-search-backward "^[ \t]*This is pdf.*?TeX.*?Version" nil t)
1101         ;; OK, we are at the location of the final run
1102         (let ((pos (point)) (errors "") (case-fold-search t))
1103           (if (re-search-forward "Reference.*?undefined" nil t)
1104               (setq errors (concat errors " [undefined reference]")))
1105           (goto-char pos)
1106           (if (re-search-forward "Citation.*?undefined" nil t)
1107               (setq errors (concat errors " [undefined citation]")))
1108           (goto-char pos)
1109           (if (re-search-forward "Undefined control sequence" nil t)
1110               (setq errors (concat errors " [undefined control sequence]")))
1111           (and (org-string-nw-p errors) errors))))))
1112
1113 ;;;###autoload
1114 (defun org-export-as-pdf-and-open (arg)
1115   "Export as LaTeX, then process through to PDF, and open."
1116   (interactive "P")
1117   (let ((pdffile (org-export-as-pdf arg)))
1118     (if pdffile
1119         (progn
1120           (org-open-file pdffile)
1121           (when org-export-kill-product-buffer-when-displayed
1122             (kill-buffer (find-buffer-visiting
1123                           (concat (file-name-sans-extension (buffer-file-name))
1124                                   ".tex")))))
1125       (error "PDF file was not produced"))))
1126
1127 ;;; Parsing functions:
1128
1129 (defun org-export-latex-parse-global (level odd)
1130   "Parse the current buffer recursively, starting at LEVEL.
1131 If ODD is non-nil, assume the buffer only contains odd sections.
1132 Return a list reflecting the document structure."
1133   (save-excursion
1134     (goto-char (point-min))
1135     (let* ((cnt 0) output
1136            (depth org-export-latex-sectioning-depth))
1137       (while (org-re-search-forward-unprotected
1138               (concat "^\\(\\(?:\\*\\)\\{"
1139                       (number-to-string (+ (if odd 2 1) level))
1140                       "\\}\\) \\(.*\\)$")
1141               ;; make sure that there is no upper heading
1142               (when (> level 0)
1143                 (save-excursion
1144                   (save-match-data
1145                     (org-re-search-forward-unprotected
1146                      (concat "^\\(\\(?:\\*\\)\\{"
1147                              (number-to-string level)
1148                              "\\}\\) \\(.*\\)$") nil t)))) t)
1149         (setq cnt (1+ cnt))
1150         (let* ((pos (match-beginning 0))
1151                (heading (match-string 2))
1152                (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
1153           (save-excursion
1154             (narrow-to-region
1155              (point)
1156              (save-match-data
1157                (if (org-re-search-forward-unprotected
1158                     (concat "^\\(\\(?:\\*\\)\\{"
1159                             (number-to-string (+ (if odd 2 1) level))
1160                             "\\}\\) \\(.*\\)$") nil t)
1161                    (match-beginning 0)
1162                  (point-max))))
1163             (goto-char (point-min))
1164             (setq output
1165                   (append output
1166                           (list
1167                            (list
1168                             `(pos . ,pos)
1169                             `(level . ,nlevel)
1170                             `(occur . ,cnt)
1171                             `(heading . ,heading)
1172                             `(content . ,(org-export-latex-parse-content))
1173                             `(subcontent . ,(org-export-latex-parse-subcontent
1174                                              level odd)))))))
1175           (widen)))
1176       (list output))))
1177
1178 (defun org-export-latex-parse-content ()
1179   "Extract the content of a section."
1180   (let ((beg (point))
1181         (end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t)
1182                  (progn (beginning-of-line) (point))
1183                (point-max))))
1184     (buffer-substring beg end)))
1185
1186 (defun org-export-latex-parse-subcontent (level odd)
1187   "Extract the subcontent of a section at LEVEL.
1188 If ODD Is non-nil, assume subcontent only contains odd sections."
1189   (if (not (org-re-search-forward-unprotected
1190             (concat "^\\(\\(?:\\*\\)\\{"
1191                     (number-to-string (+ (if odd 4 2) level))
1192                     "\\}\\) \\(.*\\)$")
1193             nil t))
1194       nil ; subcontent is nil
1195     (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
1196
1197 ;;; Rendering functions:
1198 (defun org-export-latex-global (content)
1199   "Export CONTENT to LaTeX.
1200 CONTENT is an element of the list produced by
1201 `org-export-latex-parse-global'."
1202   (if (eq (car content) 'subcontent)
1203       (mapc 'org-export-latex-sub (cdr content))
1204     (org-export-latex-sub (car content))))
1205
1206 (defun org-export-latex-sub (subcontent)
1207   "Export the list SUBCONTENT to LaTeX.
1208 SUBCONTENT is an alist containing information about the headline
1209 and its content."
1210   (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
1211     (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
1212
1213 (defun org-export-latex-subcontent (subcontent num)
1214   "Export each cell of SUBCONTENT to LaTeX.
1215 If NUM is non-nil export numbered sections, otherwise use unnumbered
1216 sections.  If NUM is an integer, export the highest NUM levels as
1217 numbered sections and lower levels as unnumbered sections."
1218   (let* ((heading (cdr (assoc 'heading subcontent)))
1219          (level (- (cdr (assoc 'level subcontent))
1220                    org-export-latex-add-level))
1221          (occur (number-to-string (cdr (assoc 'occur subcontent))))
1222          (content (cdr (assoc 'content subcontent)))
1223          (subcontent (cadr (assoc 'subcontent subcontent)))
1224          (label (org-get-text-property-any 0 'target heading))
1225          (label-list (cons label (cdr (assoc label
1226                                              org-export-target-aliases))))
1227          (sectioning org-export-latex-sectioning)
1228          (depth org-export-latex-sectioning-depth)
1229          main-heading sub-heading)
1230     (when (symbolp (car sectioning))
1231       (setq sectioning (funcall (car sectioning) level heading))
1232       (when sectioning
1233         (setq heading (car sectioning)
1234               sectioning (cdr sectioning)
1235               ;; target property migh have changed...
1236               label (org-get-text-property-any 0 'target heading)
1237               label-list (cons label (cdr (assoc label
1238                                                  org-export-target-aliases)))))
1239       (if sectioning (setq sectioning (make-list 10 sectioning)))
1240       (setq depth (if sectioning 10000 0)))
1241     (if (string-match "[ \t]*\\\\\\\\[ \t]*" heading)
1242         (setq main-heading (substring heading 0 (match-beginning 0))
1243               sub-heading (substring heading (match-end 0))))
1244     (setq heading (org-export-latex-fontify-headline heading)
1245           sub-heading (and sub-heading
1246                            (org-export-latex-fontify-headline sub-heading))
1247           main-heading (and main-heading
1248                             (org-export-latex-fontify-headline main-heading)))
1249     (cond
1250      ;; Normal conversion
1251      ((<= level depth)
1252       (let* ((sec (nth (1- level) sectioning))
1253              (num (if (integerp num)
1254                       (>= num level)
1255                     num))
1256              start end)
1257         (if (consp (cdr sec))
1258             (setq start (nth (if num 0 2) sec)
1259                   end (nth (if num 1 3) sec))
1260           (setq start (if num (car sec) (cdr sec))))
1261         (insert (format start (if main-heading main-heading heading)
1262                         (or sub-heading "")))
1263         (insert "\n")
1264         (when label
1265           (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
1266                              label-list "\n") "\n"))
1267         (insert (org-export-latex-content content))
1268         (cond ((stringp subcontent) (insert subcontent))
1269               ((listp subcontent)
1270                (while (org-looking-back "\n\n") (backward-delete-char 1))
1271                (org-export-latex-sub subcontent)))
1272         (when (and end (string-match "[^ \t]" end))
1273           (let ((hook (org-get-text-property-any 0 'org-insert-hook end)))
1274             (and (functionp hook) (funcall hook)))
1275           (insert end "\n"))))
1276      ;; At a level under the hl option: we can drop this subsection
1277      ((> level depth)
1278       (cond ((eq org-export-latex-low-levels 'description)
1279              (if (string-match "% ends low level$"
1280                                (buffer-substring (point-at-bol 0) (point)))
1281                  (delete-region (point-at-bol 0) (point))
1282                (insert "\\begin{description}\n"))
1283              (insert (format "\n\\item[%s]%s~\n"
1284                              heading
1285                              (if label (format "\\label{%s}" label) "")))
1286              (insert (org-export-latex-content content))
1287              (cond ((stringp subcontent) (insert subcontent))
1288                    ((listp subcontent) (org-export-latex-sub subcontent)))
1289              (insert "\\end{description} % ends low level\n"))
1290             ((memq org-export-latex-low-levels '(itemize enumerate))
1291              (if (string-match "% ends low level$"
1292                                (buffer-substring (point-at-bol 0) (point)))
1293                  (delete-region (point-at-bol 0) (point))
1294                (insert (format "\\begin{%s}\n"
1295                                (symbol-name org-export-latex-low-levels))))
1296              (insert (format "\n\\item %s\\\\\n%s%%"
1297                              heading
1298                              (if label (format "\\label{%s}" label) "")))
1299              (insert (org-export-latex-content content))
1300              (cond ((stringp subcontent) (insert subcontent))
1301                    ((listp subcontent) (org-export-latex-sub subcontent)))
1302              (insert (format "\\end{%s} %% ends low level\n"
1303                              (symbol-name org-export-latex-low-levels))))
1304
1305             ((listp org-export-latex-low-levels)
1306              (if (string-match "% ends low level$"
1307                                (buffer-substring (point-at-bol 0) (point)))
1308                  (delete-region (point-at-bol 0) (point))
1309                (insert (car org-export-latex-low-levels) "\n"))
1310              (insert (format (nth 2 org-export-latex-low-levels)
1311                              heading
1312                              (if label (format "\\label{%s}" label) "")))
1313              (insert (org-export-latex-content content))
1314              (cond ((stringp subcontent) (insert subcontent))
1315                    ((listp subcontent) (org-export-latex-sub subcontent)))
1316              (insert (nth 1 org-export-latex-low-levels)
1317                      " %% ends low level\n"))
1318
1319             ((stringp org-export-latex-low-levels)
1320              (insert (format org-export-latex-low-levels heading) "\n")
1321              (when label (insert (format "\\label{%s}\n" label)))
1322              (insert (org-export-latex-content content))
1323              (cond ((stringp subcontent) (insert subcontent))
1324                    ((listp subcontent) (org-export-latex-sub subcontent)))))))))
1325
1326 ;;; Exporting internals:
1327 (defun org-export-latex-set-initial-vars (ext-plist level)
1328   "Store org local variables required for LaTeX export.
1329 EXT-PLIST is an optional additional plist.
1330 LEVEL indicates the default depth for export."
1331   (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
1332         org-export-latex-done-keywords org-done-keywords
1333         org-export-latex-not-done-keywords org-not-done-keywords
1334         org-export-latex-complex-heading-re org-complex-heading-regexp
1335         org-export-latex-display-custom-times org-display-custom-times
1336         org-export-latex-all-targets-re
1337         (org-make-target-link-regexp (org-all-targets))
1338         org-export-latex-options-plist
1339         (org-combine-plists (org-default-export-plist) ext-plist
1340                             (org-infile-export-plist))
1341         org-export-latex-class
1342         (or (and (org-region-active-p)
1343                  (save-excursion
1344                    (goto-char (region-beginning))
1345                    (and (looking-at org-complex-heading-regexp)
1346                         (org-entry-get nil "LaTeX_CLASS" 'selective))))
1347             (save-excursion
1348               (save-restriction
1349                 (widen)
1350                 (goto-char (point-min))
1351                 (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([-/a-zA-Z]+\\)" nil t)
1352                      (match-string 1))))
1353             (plist-get org-export-latex-options-plist :latex-class)
1354             org-export-latex-default-class)
1355         org-export-latex-class-options
1356         (or (and (org-region-active-p)
1357                  (save-excursion
1358                    (goto-char (region-beginning))
1359                    (and (looking-at org-complex-heading-regexp)
1360                         (org-entry-get nil "LaTeX_CLASS_OPTIONS" 'selective))))
1361             (save-excursion
1362               (save-restriction
1363                 (widen)
1364                 (goto-char (point-min))
1365                 (and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t)
1366                      (match-string 1))))
1367             (plist-get org-export-latex-options-plist :latex-class-options))
1368         org-export-latex-class
1369         (or (car (assoc org-export-latex-class org-export-latex-classes))
1370             (error "No definition for class `%s' in `org-export-latex-classes'"
1371                    org-export-latex-class))
1372         org-export-latex-header
1373         (cadr (assoc org-export-latex-class org-export-latex-classes))
1374         org-export-latex-sectioning
1375         (cddr (assoc org-export-latex-class org-export-latex-classes))
1376         org-export-latex-sectioning-depth
1377         (or level
1378             (let ((hl-levels
1379                    (plist-get org-export-latex-options-plist :headline-levels))
1380                   (sec-depth (length org-export-latex-sectioning)))
1381               (if (> hl-levels sec-depth) sec-depth hl-levels))))
1382   (when (and org-export-latex-class-options
1383              (string-match "\\S-" org-export-latex-class-options)
1384              (string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
1385                            org-export-latex-header))
1386     (setq org-export-latex-header
1387           (concat (substring org-export-latex-header 0 (match-end 1))
1388                   org-export-latex-class-options
1389                   (substring org-export-latex-header (match-end 0))))))
1390
1391 (defvar org-export-latex-format-toc-function
1392   'org-export-latex-format-toc-default
1393   "The function formatting returning the string to create the table of contents.
1394 The function mus take one parameter, the depth of the table of contents.")
1395
1396 (defun org-export-latex-make-header (title opt-plist)
1397   "Make the LaTeX header and return it as a string.
1398 TITLE is the current title from the buffer or region.
1399 OPT-PLIST is the options plist for current buffer."
1400   (let ((toc (plist-get opt-plist :table-of-contents))
1401         (author (org-export-apply-macros-in-string
1402                  (plist-get opt-plist :author)))
1403         (email (replace-regexp-in-string
1404                 "_" "\\\\_"
1405                 (org-export-apply-macros-in-string
1406                  (plist-get opt-plist :email))))
1407         (description (org-export-apply-macros-in-string
1408                       (plist-get opt-plist :description)))
1409         (keywords (org-export-apply-macros-in-string
1410                    (plist-get opt-plist :keywords))))
1411     (concat
1412      (if (plist-get opt-plist :time-stamp-file)
1413          (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
1414      ;; insert LaTeX custom header and packages from the list
1415      (org-splice-latex-header
1416       (org-export-apply-macros-in-string org-export-latex-header)
1417       org-export-latex-default-packages-alist
1418       org-export-latex-packages-alist nil
1419       (org-export-apply-macros-in-string
1420        (plist-get opt-plist :latex-header-extra)))
1421      ;; append another special variable
1422      (org-export-apply-macros-in-string org-export-latex-append-header)
1423      ;; define alert if not yet defined
1424      "\n\\providecommand{\\alert}[1]{\\textbf{#1}}"
1425      ;; insert the title
1426      (format
1427       "\n\n\\title{%s}\n"
1428       (org-export-latex-fontify-headline title))
1429      ;; insert author info
1430      (if (plist-get opt-plist :author-info)
1431          (format "\\author{%s%s}\n"
1432                  (org-export-latex-fontify-headline (or author user-full-name))
1433                  (if (and (plist-get opt-plist :email-info) email
1434                           (string-match "\\S-" email))
1435                      (format "\\thanks{%s}" email)
1436                    ""))
1437        (format "%%\\author{%s}\n"
1438                (org-export-latex-fontify-headline (or author user-full-name))))
1439      ;; insert the date
1440      (format "\\date{%s}\n"
1441              (format-time-string
1442               (or (plist-get opt-plist :date)
1443                   org-export-latex-date-format)))
1444      ;; add some hyperref options
1445      ;; FIXME: let's have a defcustom for this?
1446      (format "\\hypersetup{\n  pdfkeywords={%s},\n  pdfsubject={%s},\n  pdfcreator={%s}}\n"
1447          (org-export-latex-fontify-headline keywords)
1448          (org-export-latex-fontify-headline description)
1449          (concat "Emacs Org-mode version " org-version))
1450      ;; beginning of the document
1451      "\n\\begin{document}\n\n"
1452      ;; insert the title command
1453      (when (string-match "\\S-" title)
1454        (if (string-match "%s" org-export-latex-title-command)
1455            (format org-export-latex-title-command title)
1456          org-export-latex-title-command))
1457      "\n\n"
1458      ;; table of contents
1459      (when (and org-export-with-toc
1460                 (plist-get opt-plist :section-numbers))
1461        (funcall org-export-latex-format-toc-function
1462                 (cond ((numberp toc)
1463                        (min toc (plist-get opt-plist :headline-levels)))
1464                       (toc  (plist-get opt-plist :headline-levels))))))))
1465
1466 (defun org-export-latex-format-toc-default (depth)
1467   (when depth
1468     (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
1469             depth)))
1470
1471 (defun org-export-latex-first-lines (opt-plist &optional beg end)
1472   "Export the first lines before first headline.
1473 If BEG is non-nil, it is the beginning of the region.
1474 If END is non-nil, it is the end of the region."
1475   (save-excursion
1476     (goto-char (or beg (point-min)))
1477     (let* ((pt (point))
1478            (end (if (re-search-forward
1479                      (concat "^" (org-get-limited-outline-regexp)) end t)
1480                     (goto-char (match-beginning 0))
1481                   (goto-char (or end (point-max))))))
1482       (prog1
1483           (org-export-latex-content
1484            (org-export-preprocess-string
1485             (buffer-substring pt end)
1486             :for-backend 'latex
1487             :emph-multiline t
1488             :add-text nil
1489             :comments nil
1490             :skip-before-1st-heading nil
1491             :LaTeX-fragments nil
1492             :timestamps (plist-get opt-plist :timestamps)
1493             :footnotes (plist-get opt-plist :footnotes)))
1494         (org-unmodified
1495          (let ((inhibit-read-only t)
1496                (limit (max pt (1- end))))
1497            (add-text-properties pt limit
1498                                 '(:org-license-to-kill t))
1499            (save-excursion
1500              (goto-char pt)
1501              (while (re-search-forward "^[ \t]*#\\+.*\n?" limit t)
1502                (let ((case-fold-search t))
1503                  (unless (org-string-match-p
1504                           "^[ \t]*#\\+\\(attr_\\|caption\\>\\|label\\>\\)"
1505                           (match-string 0))
1506                    (remove-text-properties (match-beginning 0) (match-end 0)
1507                                            '(:org-license-to-kill t))))))))))))
1508
1509
1510 (defvar org-export-latex-header-defs nil
1511   "The header definitions that might be used in the LaTeX body.")
1512
1513 (defun org-export-latex-content (content &optional exclude-list)
1514   "Convert CONTENT string to LaTeX.
1515 Don't perform conversions that are in EXCLUDE-LIST.  Recognized
1516 conversion types are: quotation-marks, emphasis, sub-superscript,
1517 links, keywords, lists, tables, fixed-width"
1518   (with-temp-buffer
1519     (org-install-letbind)
1520     (insert content)
1521     (unless (memq 'timestamps exclude-list)
1522       (org-export-latex-time-stamps))
1523     (unless (memq 'quotation-marks exclude-list)
1524       (org-export-latex-quotation-marks))
1525     (unless (memq 'emphasis exclude-list)
1526       (when (plist-get org-export-latex-options-plist :emphasize)
1527         (org-export-latex-fontify)))
1528     (unless (memq 'sub-superscript exclude-list)
1529       (org-export-latex-special-chars
1530        (plist-get org-export-latex-options-plist :sub-superscript)))
1531     (unless (memq 'links exclude-list)
1532       (org-export-latex-links))
1533     (unless (memq 'keywords exclude-list)
1534       (org-export-latex-keywords))
1535     (unless (memq 'lists exclude-list)
1536       (org-export-latex-lists))
1537     (unless (memq 'tables exclude-list)
1538       (org-export-latex-tables
1539        (plist-get org-export-latex-options-plist :tables)))
1540     (unless (memq 'fixed-width exclude-list)
1541       (org-export-latex-fixed-width
1542        (plist-get org-export-latex-options-plist :fixed-width)))
1543    ;; return string
1544     (buffer-substring (point-min) (point-max))))
1545
1546 (defun org-export-latex-protect-string (s)
1547   "Add the org-protected property to string S."
1548   (add-text-properties 0 (length s) '(org-protected t) s) s)
1549
1550 (defun org-export-latex-protect-char-in-string (char-list string)
1551   "Add org-protected text-property to char from CHAR-LIST in STRING."
1552   (with-temp-buffer
1553     (save-match-data
1554       (insert string)
1555       (goto-char (point-min))
1556       (while (re-search-forward (regexp-opt char-list) nil t)
1557         (add-text-properties (match-beginning 0)
1558                              (match-end 0) '(org-protected t)))
1559       (buffer-string))))
1560
1561 (defun org-export-latex-keywords-maybe (&optional remove-list)
1562   "Maybe remove keywords depending on rules in REMOVE-LIST."
1563   (goto-char (point-min))
1564   (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
1565         (case-fold-search nil)
1566         (todo-markup org-export-latex-todo-keyword-markup)
1567         fmt)
1568     ;; convert TODO keywords
1569     (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
1570       (if (plist-get remove-list :todo)
1571           (replace-match "")
1572         (setq fmt (cond
1573                    ((stringp todo-markup) todo-markup)
1574                    ((and (consp todo-markup) (stringp (car todo-markup)))
1575                     (if (member (match-string 1) org-export-latex-done-keywords)
1576                         (cdr todo-markup) (car todo-markup)))
1577                    (t (cdr (or (assoc (match-string 1) todo-markup)
1578                                (car todo-markup))))))
1579         (replace-match (org-export-latex-protect-string
1580                         (format fmt (match-string 1))) t t)))
1581     ;; convert priority string
1582     (when (re-search-forward "\\[\\\\#.\\]" nil t)
1583       (if (plist-get remove-list :priority)
1584           (replace-match "")
1585         (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
1586     ;; convert tags
1587     (when (re-search-forward "\\(:[a-zA-Z0-9_@#%]+\\)+:" nil t)
1588       (if (or (not org-export-with-tags)
1589               (plist-get remove-list :tags))
1590           (replace-match "")
1591         (replace-match
1592          (org-export-latex-protect-string
1593           (format org-export-latex-tag-markup
1594                   (save-match-data
1595                     (replace-regexp-in-string
1596                      "\\([_#]\\)" "\\\\\\1" (match-string 0)))))
1597          t t)))))
1598
1599 (defun org-export-latex-fontify-headline (string)
1600   "Fontify special words in STRING."
1601   (with-temp-buffer
1602     ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
1603     ;; the beginning of the buffer - inserting "\n" is safe here though.
1604     (insert "\n" string)
1605
1606     ;; Preserve math snippets
1607
1608     (let* ((matchers (plist-get org-format-latex-options :matchers))
1609            (re-list org-latex-regexps)
1610            beg end re e m n block off)
1611       ;; Check the different regular expressions
1612       (while (setq e (pop re-list))
1613         (setq m (car e) re (nth 1 e) n (nth 2 e)
1614               block (if (nth 3 e) "\n\n" ""))
1615         (setq off (if (member m '("$" "$1")) 1 0))
1616         (when (and (member m matchers) (not (equal m "begin")))
1617           (goto-char (point-min))
1618           (while (re-search-forward re nil t)
1619             (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
1620             (add-text-properties beg end
1621                                  '(org-protected t org-latex-math t))))))
1622
1623     ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
1624     (goto-char (point-min))
1625     (let ((case-fold-search nil))
1626       (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
1627         (unless (eq (char-before (match-beginning 1)) ?\\)
1628           (org-if-unprotected-1
1629            (replace-match (org-export-latex-protect-string
1630                            (concat "\\" (match-string 1)
1631                                    "{}")) t t)))))
1632     (goto-char (point-min))
1633     (let ((re (concat "\\\\\\([a-zA-Z]+\\)"
1634                       "\\(?:<[^<>\n]*>\\)*"
1635                       "\\(?:\\[[^][\n]*?\\]\\)*"
1636                       "\\(?:<[^<>\n]*>\\)*"
1637                       "\\("
1638                       (org-create-multibrace-regexp "{" "}" 3)
1639                       "\\)\\{1,3\\}")))
1640       (while (re-search-forward re nil t)
1641         (unless (or
1642                  ;; check for comment line
1643                  (save-excursion (goto-char (match-beginning 0))
1644                                  (org-in-indented-comment-line))
1645                  ;; Check if this is a defined entity, so that is may need conversion
1646                  (org-entity-get (match-string 1)))
1647           (add-text-properties (match-beginning 0) (match-end 0)
1648                                '(org-protected t)))))
1649     (when (plist-get org-export-latex-options-plist :emphasize)
1650       (org-export-latex-fontify))
1651     (org-export-latex-time-stamps)
1652     (org-export-latex-quotation-marks)
1653     (org-export-latex-keywords-maybe)
1654     (org-export-latex-special-chars
1655      (plist-get org-export-latex-options-plist :sub-superscript))
1656     (org-export-latex-links)
1657     (org-trim (buffer-string))))
1658
1659 (defun org-export-latex-time-stamps ()
1660   "Format time stamps."
1661   (goto-char (point-min))
1662   (let ((org-display-custom-times org-export-latex-display-custom-times))
1663     (while (re-search-forward org-ts-regexp-both nil t)
1664       (org-if-unprotected-at (1- (point))
1665        (replace-match
1666         (org-export-latex-protect-string
1667          (format (if (string= "<" (substring (match-string 0) 0 1))
1668                      org-export-latex-timestamp-markup
1669                    org-export-latex-timestamp-inactive-markup)
1670                  (substring (org-translate-time (match-string 0)) 1 -1)))
1671         t t)))))
1672
1673 (defun org-export-latex-quotation-marks ()
1674   "Export quotation marks depending on language conventions."
1675   (mapc (lambda(l)
1676           (goto-char (point-min))
1677           (while (re-search-forward (car l) nil t)
1678             (let ((rpl (concat (match-string 1)
1679                                (org-export-latex-protect-string
1680                                 (copy-sequence (cdr l))))))
1681               (org-if-unprotected-1
1682                (replace-match rpl t t)))))
1683         (cdr (or (assoc (plist-get org-export-latex-options-plist :language)
1684                         org-export-latex-quotes)
1685                  ;; falls back on english
1686                  (assoc "en" org-export-latex-quotes)))))
1687
1688 (defun org-export-latex-special-chars (sub-superscript)
1689   "Export special characters to LaTeX.
1690 If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
1691 See the `org-export-latex.el' code for a complete conversion table."
1692   (goto-char (point-min))
1693   (mapc (lambda(c)
1694           (goto-char (point-min))
1695           (while (re-search-forward c nil t)
1696             ;; Put the point where to check for org-protected
1697             (unless (or (get-text-property (match-beginning 2) 'org-protected)
1698                         (save-match-data (org-at-table.el-p)))
1699               (cond ((member (match-string 2) '("\\$" "$"))
1700                      (if (equal (match-string 2) "\\$")
1701                          nil
1702                        (replace-match "\\$" t t)))
1703                     ((member (match-string 2) '("&" "%" "#"))
1704                      (if (equal (match-string 1) "\\")
1705                          (replace-match (match-string 2) t t)
1706                        (replace-match (concat (match-string 1) "\\"
1707                                               (match-string 2)) t t)
1708                        (backward-char 1)))
1709                     ((equal (match-string 2) "...")
1710                      (replace-match
1711                       (concat (match-string 1)
1712                               (org-export-latex-protect-string "\\ldots{}")) t t))
1713                     ((equal (match-string 2) "~")
1714                      (cond ((equal (match-string 1) "\\") nil)
1715                            ((eq 'org-link (get-text-property 0 'face (match-string 2)))
1716                             (replace-match (concat (match-string 1) "\\~") t t))
1717                            (t (replace-match
1718                                (org-export-latex-protect-string
1719                                 (concat (match-string 1) "\\~{}")) t t))))
1720                     ((member (match-string 2) '("{" "}"))
1721                      (unless (save-match-data (org-inside-latex-math-p))
1722                        (if (equal (match-string 1) "\\")
1723                            (replace-match (match-string 2) t t)
1724                          (replace-match (concat (match-string 1) "\\"
1725                                                 (match-string 2)) t t)))))
1726               (unless (save-match-data (org-inside-latex-math-p))
1727                 (cond ((equal (match-string 2) "\\")
1728                        (replace-match (or (save-match-data
1729                                             (org-export-latex-treat-backslash-char
1730                                              (match-string 1)
1731                                              (or (match-string 3) "")))
1732                                           "") t t)
1733                        (when (and (get-text-property (1- (point)) 'org-entity)
1734                                   (looking-at "{}"))
1735                          ;; OK, this was an entity replacement, and the user
1736                          ;; had terminated the entity with {}.  Make sure
1737                          ;; {} is protected as well, and remove the extra {}
1738                          ;; inserted by the conversion.
1739                          (put-text-property (point) (+ 2 (point)) 'org-protected t)
1740                          (if (save-excursion (goto-char (max (- (point) 2) (point-min)))
1741                                              (looking-at "{}"))
1742                              (replace-match ""))
1743                          (forward-char 2))
1744                        (backward-char 1))
1745                       ((member (match-string 2) '("_" "^"))
1746                        (replace-match (or (save-match-data
1747                                             (org-export-latex-treat-sub-super-char
1748                                              sub-superscript
1749                                              (match-string 2)
1750                                              (match-string 1)
1751                                              (match-string 3))) "") t t)
1752                        (backward-char 1)))))))
1753         '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
1754           "\\(\\(\\\\?\\$\\)\\)"
1755           "\\([a-zA-Z0-9()]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-zA-Z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-zA-Z0-9]+}\\|([a-zA-Z0-9]+)\\)"
1756           "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|\\([&#%{}\"]\\|[a-zA-Z][a-zA-Z0-9]*\\)\\)"
1757           "\\(^\\|.\\)\\([&#%{}~]\\|\\.\\.\\.\\)"
1758           ;; (?\< . "\\textless{}")
1759           ;; (?\> . "\\textgreater{}")
1760           )))
1761
1762 (defun org-inside-latex-math-p ()
1763   (get-text-property (point) 'org-latex-math))
1764
1765 (defun org-export-latex-treat-sub-super-char
1766   (subsup char string-before string-after)
1767   "Convert the \"_\" and \"^\" characters to LaTeX.
1768 SUBSUP corresponds to the ^: option in the #+OPTIONS line.
1769 Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
1770   (cond ((equal string-before "\\")
1771          (concat string-before char string-after))
1772         ((and (string-match "\\S-+" string-after))
1773          ;; this is part of a math formula
1774          (cond ((eq 'org-link (get-text-property 0 'face char))
1775                 (concat string-before "\\" char string-after))
1776                ((save-match-data (org-inside-latex-math-p))
1777                 (if subsup
1778                     (cond ((eq 1 (length string-after))
1779                            (concat string-before char string-after))
1780                           ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
1781                            (format "%s%s{%s}" string-before char
1782                                    (match-string 1 string-after))))))
1783                ((and (> (length string-after) 1)
1784                      (or (eq subsup t)
1785                          (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
1786                      (or (string-match "[{]?\\([^}]+\\)[}]?" string-after)
1787                          (string-match "[(]?\\([^)]+\\)[)]?" string-after)))
1788
1789                 (org-export-latex-protect-string
1790                  (format "%s$%s{%s}$" string-before char
1791                          (if (and (> (match-end 1) (1+ (match-beginning 1)))
1792                                   (not (equal (substring string-after 0 2) "{\\")))
1793                              (concat "\\mathrm{" (match-string 1 string-after) "}")
1794                            (match-string 1 string-after)))))
1795                ((eq subsup t) (concat string-before "$" char string-after "$"))
1796                (t (org-export-latex-protect-string
1797                    (concat string-before "\\" char "{}" string-after)))))
1798         (t (org-export-latex-protect-string
1799             (concat string-before "\\" char "{}" string-after)))))
1800
1801 (defun org-export-latex-treat-backslash-char (string-before string-after)
1802   "Convert the \"$\" special character to LaTeX.
1803 The conversion is made depending of STRING-BEFORE and STRING-AFTER."
1804   (let  ((ass (org-entity-get string-after)))
1805     (cond
1806      (ass (org-add-props
1807               (if (nth 2 ass)
1808                   (concat string-before
1809                           (org-export-latex-protect-string
1810                            (concat "$" (nth 1 ass) "$")))
1811                 (concat string-before (org-export-latex-protect-string
1812                                        (nth 1 ass))))
1813               nil 'org-entity t))
1814      ((and (not (string-match "^[ \n\t]" string-after))
1815            (not (string-match "[ \t]\\'\\|^" string-before)))
1816       ;; backslash is inside a word
1817       (concat string-before
1818               (org-export-latex-protect-string
1819                (concat "\\textbackslash{}" string-after))))
1820      ((not (or (equal string-after "")
1821                (string-match "^[ \t\n]" string-after)))
1822       ;; backslash might escape a character (like \#) or a user TeX
1823       ;; macro (like \setcounter)
1824       (concat string-before
1825               (org-export-latex-protect-string (concat "\\" string-after))))
1826      ((and (string-match "^[ \t\n]" string-after)
1827            (string-match "[ \t\n]\\'" string-before))
1828       ;; backslash is alone, convert it to $\backslash$
1829       (org-export-latex-protect-string
1830        (concat string-before "\\textbackslash{}" string-after)))
1831      (t (org-export-latex-protect-string
1832          (concat string-before "\\textbackslash{}" string-after))))))
1833
1834 (defun org-export-latex-keywords ()
1835   "Convert special keywords to LaTeX."
1836   (goto-char (point-min))
1837   (while (re-search-forward org-export-latex-special-keyword-regexp nil t)
1838     (replace-match (format org-export-latex-timestamp-keyword-markup
1839                            (match-string 0)) t t)
1840     (save-excursion
1841       (beginning-of-line 1)
1842       (unless (looking-at ".*\n[ \t]*\n")
1843         (end-of-line 1)
1844         (insert "\n")))))
1845
1846 (defun org-export-latex-fixed-width (opt)
1847   "When OPT is non-nil convert fixed-width sections to LaTeX."
1848   (goto-char (point-min))
1849   (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
1850     (unless (get-text-property (point) 'org-example)
1851      (if opt
1852          (progn (goto-char (match-beginning 0))
1853                 (insert "\\begin{verbatim}\n")
1854                 (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1855                   (replace-match (concat (match-string 1)
1856                                          (match-string 2)) t t)
1857                   (forward-line))
1858                 (insert "\\end{verbatim}\n"))
1859        (progn (goto-char (match-beginning 0))
1860               (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
1861                 (replace-match (concat "%" (match-string 1)
1862                                        (match-string 2)) t t)
1863                 (forward-line)))))))
1864
1865 (defvar org-table-last-alignment) ; defined in org-table.el
1866 (defvar org-table-last-column-widths) ; defined in org-table.el
1867 (declare-function orgtbl-to-latex "org-table" (table params) t)
1868 (defun org-export-latex-tables (insert)
1869   "Convert tables to LaTeX and INSERT it."
1870   ;; First, get the table.el tables
1871   (goto-char (point-min))
1872   (while (re-search-forward "^[ \t]*\\(\\+-[-+]*\\+\\)[ \t]*\n[ \t]*|" nil t)
1873     (org-if-unprotected
1874      (require 'table)
1875      (org-export-latex-convert-table.el-table)))
1876
1877   ;; And now the Org-mode tables
1878   (goto-char (point-min))
1879   (while (re-search-forward "^\\([ \t]*\\)|" nil t)
1880     (org-if-unprotected-at (1- (point))
1881       (org-table-align)
1882       (let* ((beg (org-table-begin))
1883              (end (org-table-end))
1884              (raw-table (buffer-substring beg end))
1885              (org-table-last-alignment (copy-sequence org-table-last-alignment))
1886              (org-table-last-column-widths (copy-sequence
1887                                             org-table-last-column-widths))
1888              fnum fields line lines olines gr colgropen line-fmt align
1889              caption width shortn label attr floatp placement
1890              longtblp tblenv tabular-env)
1891         (if org-export-latex-tables-verbatim
1892             (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
1893                                 "\\end{verbatim}\n")))
1894               (apply 'delete-region (list beg end))
1895               (insert (org-export-latex-protect-string tbl)))
1896           (progn
1897             (setq caption (org-find-text-property-in-string
1898                            'org-caption raw-table)
1899                   shortn (org-find-text-property-in-string
1900                           'org-caption-shortn raw-table)
1901                   attr (org-find-text-property-in-string
1902                         'org-attributes raw-table)
1903                   label (org-find-text-property-in-string
1904                          'org-label raw-table)
1905                   longtblp (and attr (stringp attr)
1906                                 (string-match "\\<longtable\\>" attr))
1907                   tblenv (if (and attr (stringp attr))
1908                              (cond ((string-match "\\<sidewaystable\\>" attr)
1909                                     "sidewaystable")
1910                                    ((or (string-match (regexp-quote "table*") attr)
1911                                         (string-match "\\<multicolumn\\>" attr))
1912                                     "table*")
1913                                    (t "table"))
1914                            "table")
1915                   tabular-env
1916                   (if (and attr (stringp attr)
1917                            (string-match "\\(tabular.\\)" attr))
1918                       (match-string 1 attr)
1919                     org-export-latex-tabular-environment)
1920                   width (and attr (stringp attr)
1921                              (string-match "\\<width=\\([^ \t\n\r]+\\)" attr)
1922                              (match-string 1 attr))
1923                   align (and attr (stringp attr)
1924                              (string-match "\\<align=\\([^ \t\n\r]+\\)" attr)
1925                              (match-string 1 attr))
1926                   floatp (or caption label (string= "table*" tblenv))
1927                   placement     (if (and attr
1928                                          (stringp attr)
1929                                          (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
1930                                     (match-string 1 attr)
1931                                   (concat
1932                                    "[" org-latex-default-figure-position "]")))
1933             (setq caption (and caption (org-export-latex-fontify-headline caption)))
1934             (setq lines (org-split-string raw-table "\n"))
1935             (apply 'delete-region (list beg end))
1936             (when org-export-table-remove-special-lines
1937               (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
1938             (when org-table-clean-did-remove-column
1939               (pop org-table-last-alignment)
1940               (pop org-table-last-column-widths))
1941             ;; make a formatting string to reflect alignment
1942             (setq olines lines)
1943             (while (and (not line-fmt) (setq line (pop olines)))
1944               (unless (string-match "^[ \t]*|-" line)
1945                 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1946                 (setq fnum (make-vector (length fields) 0))
1947                 (setq line-fmt
1948                       (mapconcat
1949                        (lambda (x)
1950                          (setq gr (pop org-table-colgroup-info))
1951                          (format "%s%%s%s"
1952                                  (cond ((eq gr :start)
1953                                         (prog1 (if colgropen "|" "|")
1954                                           (setq colgropen t)))
1955                                        ((eq gr :startend)
1956                                         (prog1 (if colgropen "|" "|")
1957                                           (setq colgropen nil)))
1958                                        (t ""))
1959                                  (if (memq gr '(:end :startend))
1960                                      (progn (setq colgropen nil) "|")
1961                                    "")))
1962                        fnum ""))))
1963             ;; fix double || in line-fmt
1964             (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
1965             ;; maybe remove the first and last "|"
1966             (when (and (not org-export-latex-tables-column-borders)
1967                        (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
1968               (setq line-fmt (match-string 2 line-fmt)))
1969             ;; format alignment
1970             (unless align
1971               (setq align (apply 'format
1972                                  (cons line-fmt
1973                                        (mapcar (lambda (x) (if x "r" "l"))
1974                                                org-table-last-alignment)))))
1975             ;; prepare the table to send to orgtbl-to-latex
1976             (setq lines
1977                   (mapcar
1978                    (lambda(elem)
1979                      (or (and (string-match "[ \t]*|-+" elem) 'hline)
1980                          (org-split-string
1981                           (progn (set-text-properties 0 (length elem) nil elem)
1982                                  (org-trim elem)) "|")))
1983                    lines))
1984             (when insert
1985               (insert (org-export-latex-protect-string
1986                        (concat
1987                         (if longtblp
1988                             (concat "\\begin{longtable}{" align "}\n")
1989                           (if floatp
1990                               (format "\\begin{%s}%s\n" tblenv placement)))
1991                         (if (and floatp org-export-latex-table-caption-above)
1992                             (format
1993                              "\\caption%s{%s} %s"
1994                              (if shortn (concat "[" shortn "]") "")
1995                              (or caption "")
1996                              (if label (format "\\label{%s}" label) "")))
1997                         (if (and longtblp caption org-export-latex-table-caption-above)
1998                             "\\\\\n" "\n")
1999                         (if (and org-export-latex-tables-centered (not longtblp))
2000                             "\\begin{center}\n")
2001                         (if (not longtblp)
2002                             (format "\\begin{%s}%s{%s}\n"
2003                                     tabular-env
2004                                     (if width (format "{%s}" width) "")
2005                                     align))
2006                         (orgtbl-to-latex
2007                          lines
2008                          `(:tstart nil :tend nil
2009                                    :hlend ,(if longtblp
2010                                                (format "\\\\
2011 \\hline
2012 \\endhead
2013 \\hline\\multicolumn{%d}{r}{Continued on next page}\\
2014 \\endfoot
2015 \\endlastfoot" (length org-table-last-alignment))
2016                                              nil)))
2017                         (if (not longtblp) (format "\n\\end{%s}" tabular-env))
2018                         (if longtblp "\n" (if org-export-latex-tables-centered
2019                                               "\n\\end{center}\n" "\n"))
2020                         (if (and floatp (not org-export-latex-table-caption-above))
2021                             (format
2022                              "\\caption%s{%s} %s"
2023                              (if shortn (concat "[" shortn "]") "")
2024                              (or caption "")
2025                              (if label (format "\\label{%s}" label) "")))
2026                         (if longtblp
2027                             "\\end{longtable}"
2028                           (if floatp (format "\\end{%s}" tblenv)))))
2029                       "\n\n"))))))))
2030
2031 (defun org-export-latex-convert-table.el-table ()
2032   "Replace table.el table at point with LaTeX code."
2033   (let (tbl caption shortn label line floatp attr align rmlines)
2034     (setq line (buffer-substring (point-at-bol) (point-at-eol))
2035           label (org-get-text-property-any 0 'org-label line)
2036           caption (org-get-text-property-any 0 'org-caption line)
2037           shortn (org-get-text-property-any 0 'org-caption-shortn line)
2038           attr (org-get-text-property-any 0 'org-attributes line)
2039           align (and attr (stringp attr)
2040                      (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
2041                      (match-string 1 attr))
2042           rmlines (and attr (stringp attr)
2043                        (string-match "\\<rmlines\\>" attr))
2044           floatp (or label caption))
2045     (and (get-buffer "*org-export-table*")
2046          (kill-buffer (get-buffer "*org-export-table*")))
2047     (table-generate-source 'latex "*org-export-table*" "caption")
2048     (setq tbl (with-current-buffer "*org-export-table*"
2049                 (buffer-string)))
2050     (while (string-match "^%.*\n" tbl)
2051       (setq tbl (replace-match "" t t tbl)))
2052     ;; fix the hlines
2053     (when rmlines
2054       (let ((n 0) lines)
2055         (setq lines (mapcar (lambda (x)
2056                               (if (string-match "^\\\\hline$" x)
2057                                   (progn
2058                                     (setq n (1+ n))
2059                                     (if (= n 2) x nil))
2060                                 x))
2061                             (org-split-string tbl "\n")))
2062         (setq tbl (mapconcat 'identity (delq nil lines) "\n"))))
2063     (when (and align (string-match "\\\\begin{tabular}{.*}" tbl))
2064       (setq tbl (replace-match (concat "\\begin{tabular}{" align "}")
2065                                t t tbl)))
2066     (and (get-buffer "*org-export-table*")
2067          (kill-buffer (get-buffer "*org-export-table*")))
2068     (beginning-of-line 0)
2069     (while (looking-at "[ \t]*\\(|\\|\\+-\\)")
2070       (delete-region (point) (1+ (point-at-eol))))
2071     (when org-export-latex-tables-centered
2072       (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
2073     (when floatp
2074       (setq tbl (concat "\\begin{table}\n"
2075                         (if (not org-export-latex-table-caption-above) tbl)
2076                         (format "\\caption%s{%s%s}\n"
2077                                 (if shortn (format "[%s]" shortn) "")
2078                                 (if label (format "\\label{%s}" label) "")
2079                                 (or caption ""))
2080                         (if org-export-latex-table-caption-above tbl)
2081                         "\n\\end{table}\n")))
2082     (insert (org-export-latex-protect-string tbl))))
2083
2084 (defun org-export-latex-fontify ()
2085   "Convert fontification to LaTeX."
2086   (goto-char (point-min))
2087   (while (re-search-forward org-emph-re nil t)
2088     ;; The match goes one char after the *string*, except at the end of a line
2089     (let ((emph (assoc (match-string 3)
2090                        org-export-latex-emphasis-alist))
2091           (beg (match-beginning 0))
2092           (end (match-end 0))
2093           rpl s)
2094       (unless emph
2095         (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
2096                  (match-string 3)))
2097       (unless (or (and (get-text-property (- (point) 2) 'org-protected)
2098                        (not (get-text-property
2099                              (- (point) 2) 'org-verbatim-emph)))
2100                   (equal (char-after (match-beginning 3))
2101                          (char-after (1+ (match-beginning 3))))
2102                   (save-excursion
2103                     (goto-char (match-beginning 1))
2104                     (save-match-data
2105                       (and (org-at-table-p)
2106                            (string-match
2107                             "[|\n]" (buffer-substring beg end)))))
2108                   (and (equal (match-string 3) "+")
2109                        (save-match-data
2110                          (string-match "\\`-+\\'" (match-string 4)))))
2111         (setq s (match-string 4))
2112         (setq rpl (concat (match-string 1)
2113                           (org-export-latex-emph-format (cadr emph)
2114                                                         (match-string 4))
2115                           (match-string 5)))
2116         (if (caddr emph)
2117             (setq rpl (org-export-latex-protect-string rpl))
2118           (save-match-data
2119             (if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl)
2120                 (progn
2121                   (add-text-properties (match-beginning 1) (match-end 1)
2122                                        '(org-protected t) rpl)
2123                   (add-text-properties (match-beginning 3) (match-end 3)
2124                                        '(org-protected t) rpl)))))
2125         (replace-match rpl t t)))
2126     (backward-char)))
2127
2128 (defun org-export-latex-emph-format (format string)
2129   "Format an emphasis string and handle the \\verb special case."
2130   (when (member format '("\\verb" "\\protectedtexttt"))
2131     (save-match-data
2132       (if (equal format "\\verb")
2133           (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
2134             (catch 'exit
2135               (loop for i from 0 to (1- (length ll)) do
2136                     (if (not (string-match (regexp-quote (substring ll i (1+ i)))
2137                                            string))
2138                         (progn
2139                           (setq format (concat "\\verb" (substring ll i (1+ i))
2140                                                "%s" (substring ll i (1+ i))))
2141                           (throw 'exit nil))))))
2142         (let ((start 0)
2143               (trans '(("\\" . "\\textbackslash{}")
2144                        ("~" . "\\textasciitilde{}")
2145                        ("^" . "\\textasciicircum{}")))
2146               (rtn "") char)
2147           (while (string-match "[\\{}$%&_#~^]" string)
2148             (setq char (match-string 0 string))
2149             (if (> (match-beginning 0) 0)
2150                 (setq rtn (concat rtn (substring string
2151                                                  0 (match-beginning 0)))))
2152             (setq string (substring string (1+ (match-beginning 0))))
2153             (setq char (or (cdr (assoc char trans)) (concat "\\" char))
2154                   rtn (concat rtn char)))
2155           (setq string (concat rtn string) format "\\texttt{%s}")
2156           (while (string-match "--" string)
2157             (setq string (replace-match "-{}-" t t string)))))))
2158   (format format string))
2159
2160 (defun org-export-latex-links ()
2161   ;; Make sure to use the LaTeX hyperref and graphicx package
2162   ;; or send some warnings.
2163   "Convert links to LaTeX."
2164   (goto-char (point-min))
2165   (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
2166     (org-if-unprotected-1
2167      (goto-char (match-beginning 0))
2168      (let* ((re-radio org-export-latex-all-targets-re)
2169             (remove (list (match-beginning 0) (match-end 0)))
2170             (raw-path (org-extract-attributes (match-string 3)))
2171             (full-raw-path (concat (match-string 1) raw-path))
2172             (desc (match-string 5))
2173             (type (or (match-string 2)
2174                       (if (or (file-name-absolute-p raw-path)
2175                               (string-match "^\\.\\.?/" raw-path))
2176                           "file")))
2177             (coderefp (equal type "coderef"))
2178             (caption (org-find-text-property-in-string 'org-caption raw-path))
2179             (shortn (org-find-text-property-in-string 'org-caption-shortn raw-path))
2180             (attr (or (org-find-text-property-in-string 'org-attributes raw-path)
2181                       (plist-get org-export-latex-options-plist :latex-image-options)))
2182             (label (org-find-text-property-in-string 'org-label raw-path))
2183             imgp radiop fnc
2184             ;; define the path of the link
2185             (path (cond
2186                    ((member type '("coderef"))
2187                     raw-path)
2188                    ((member type '("http" "https" "ftp"))
2189                     (concat type ":" raw-path))
2190                    ((and re-radio (string-match re-radio raw-path))
2191                     (setq radiop t))
2192                    ((equal type "mailto")
2193                     (concat type ":" raw-path))
2194                    ((equal type "file")
2195                     (if (and (org-file-image-p
2196                               (expand-file-name
2197                                raw-path)
2198                               org-export-latex-inline-image-extensions)
2199                              (or (get-text-property 0 'org-no-description
2200                                                     raw-path)
2201                                  (equal desc full-raw-path)))
2202                         (setq imgp t)
2203                       (progn (when (string-match "\\(.+\\)::.+" raw-path)
2204                                (setq raw-path (match-string 1 raw-path)))
2205                              (if (file-exists-p raw-path)
2206                                  (concat type "://" (expand-file-name raw-path))
2207                                (concat type "://" (org-export-directory
2208                                                    :LaTeX org-export-latex-options-plist)
2209                                        raw-path))))))))
2210        ;; process with link inserting
2211        (apply 'delete-region remove)
2212        (setq caption (and caption (org-export-latex-fontify-headline caption)))
2213        (cond ((and imgp
2214                    (plist-get org-export-latex-options-plist :inline-images))
2215               ;; OK, we need to inline an image
2216               (insert
2217                (org-export-latex-format-image raw-path caption label attr shortn)))
2218              (coderefp
2219               (insert (format
2220                        (org-export-get-coderef-format path desc)
2221                        (cdr (assoc path org-export-code-refs)))))
2222              (radiop (insert (format org-export-latex-hyperref-format
2223                                      (org-solidify-link-text raw-path) desc)))
2224              ((not type)
2225               (insert (format org-export-latex-hyperref-format
2226                               (org-remove-initial-hash
2227                                (org-solidify-link-text raw-path))
2228                               desc)))
2229              (path
2230               (when (org-at-table-p)
2231                 ;; There is a strange problem when we have a link in a table,
2232                 ;; ampersands then cause a problem.  I think this must be
2233                 ;; a LaTeX issue, but we here implement a work-around anyway.
2234                 (setq path (org-export-latex-protect-amp path)
2235                       desc (org-export-latex-protect-amp desc)))
2236               (insert
2237                (if (string-match "%s.*%s" org-export-latex-href-format)
2238                    (format org-export-latex-href-format path desc)
2239                  (format org-export-latex-href-format path))))
2240
2241              ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
2242               ;; The link protocol has a function for formatting the link
2243               (insert
2244                (save-match-data
2245                  (funcall fnc (org-link-unescape raw-path) desc 'latex))))
2246
2247              (t (insert "\\texttt{" desc "}")))))))
2248
2249
2250 (defun org-export-latex-format-image (path caption label attr &optional shortn)
2251   "Format the image element, depending on user settings."
2252   (let (ind floatp wrapp multicolumnp placement figenv)
2253     (setq floatp (or caption label))
2254     (setq ind (org-get-text-property-any 0 'original-indentation path))
2255     (when (and attr (stringp attr))
2256       (if (string-match "[ \t]*\\<wrap\\>" attr)
2257           (setq wrapp t floatp nil attr (replace-match "" t t attr)))
2258       (if (string-match "[ \t]*\\<float\\>" attr)
2259           (setq wrapp nil floatp t attr (replace-match "" t t attr)))
2260       (if (string-match "[ \t]*\\<multicolumn\\>" attr)
2261           (setq multicolumnp t attr (replace-match "" t t attr))))
2262
2263     (setq placement
2264           (cond
2265            (wrapp "{l}{0.5\\textwidth}")
2266            (floatp (concat "[" org-latex-default-figure-position "]"))
2267            (t "")))
2268
2269     (when (and attr (stringp attr)
2270                (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
2271       (setq placement (match-string 1 attr)
2272             attr (replace-match "" t t attr)))
2273     (setq attr (and attr (org-trim attr)))
2274     (when (or (not attr) (= (length attr) 0))
2275       (setq attr (cond (floatp "width=0.7\\textwidth")
2276                        (wrapp "width=0.48\\textwidth")
2277                        (t attr))))
2278     (setq figenv
2279           (cond
2280            (wrapp "\\begin{wrapfigure}%placement
2281 \\centering
2282 \\includegraphics[%attr]{%path}
2283 \\caption%shortn{%labelcmd%caption}
2284 \\end{wrapfigure}")
2285            (multicolumnp "\\begin{figure*}%placement
2286 \\centering
2287 \\includegraphics[%attr]{%path}
2288 \\caption%shortn{%labelcmd%caption}
2289 \\end{figure*}")
2290            (floatp "\\begin{figure}%placement
2291 \\centering
2292 \\includegraphics[%attr]{%path}
2293 \\caption%shortn{%labelcmd%caption}
2294 \\end{figure}")
2295            (t "\\includegraphics[%attr]{%path}")))
2296
2297
2298     (setq figenv (mapconcat 'identity (split-string figenv "\n")
2299                             (save-excursion (beginning-of-line 1)
2300                                             (looking-at "[ \t]*")
2301                                             (concat "\n" (match-string 0)))))
2302
2303     (if (and (not label) (not caption)
2304              (string-match "^\\\\caption{.*\n" figenv))
2305         (setq figenv (replace-match "" t t figenv)))
2306     (org-add-props
2307         (org-fill-template
2308          figenv
2309          (list (cons "path"
2310                      (if (file-name-absolute-p path)
2311                          (expand-file-name path)
2312                        path))
2313                (cons "attr" attr)
2314                (cons "shortn" (if shortn (format "[%s]" shortn) ""))
2315                (cons "labelcmd" (if label (format "\\label{%s}"
2316                                                   label)""))
2317                (cons "caption" (or caption ""))
2318                (cons "placement" (or placement ""))))
2319         nil 'original-indentation ind)))
2320
2321 (defun org-export-latex-protect-amp (s)
2322   (while (string-match "\\([^\\\\]\\)\\(&\\)" s)
2323     (setq s (replace-match (concat (match-string 1 s) "\\" (match-string 2 s))
2324                            t t s)))
2325   s)
2326
2327 (defun org-remove-initial-hash (s)
2328   (if (string-match "\\`#" s)
2329       (substring s 1)
2330     s))
2331 (defvar org-latex-entities)   ; defined below
2332 (defvar org-latex-entities-regexp)   ; defined below
2333
2334 (defun org-export-latex-preprocess (parameters)
2335   "Clean stuff in the LaTeX export."
2336   ;; Replace footnotes.
2337   (when (plist-get parameters :footnotes)
2338     (goto-char (point-min))
2339     (let (ref)
2340       (while (setq ref (org-footnote-get-next-reference))
2341         (let* ((beg (nth 1 ref))
2342                (lbl (car ref))
2343                (def (nth 1 (assoc (string-to-number lbl)
2344                                   (mapcar (lambda (e) (cdr e))
2345                                           org-export-footnotes-seen)))))
2346           ;; Fix body for footnotes ending on a link or a list and
2347           ;; remove definition from buffer.
2348           (setq def
2349                 (concat def
2350                         (if (string-match "ORG-LIST-END-MARKER\\'" def)
2351                             "\n" " ")))
2352           (org-footnote-delete-definitions lbl)
2353           ;; Compute string to insert (FNOTE), and protect the outside
2354           ;; macro from further transformation.  When footnote at
2355           ;; point is referring to a previously defined footnote, use
2356           ;; \footnotemark. Otherwise, use \footnote.
2357           (let ((fnote (if (member lbl org-export-latex-footmark-seen)
2358                            (org-export-latex-protect-string
2359                             (format "\\footnotemark[%s]" lbl))
2360                          (push lbl org-export-latex-footmark-seen)
2361                          (concat (org-export-latex-protect-string "\\footnote{")
2362                                  def
2363                                  (org-export-latex-protect-string "}"))))
2364                 ;; Check if another footnote is immediately following.
2365                 ;; If so, add a separator in-between.
2366                 (sep (org-export-latex-protect-string
2367                       (if (save-excursion (goto-char (1- (nth 2 ref)))
2368                                           (let ((next (org-footnote-get-next-reference)))
2369                                             (and next (= (nth 1 next) (nth 2 ref)))))
2370                           org-export-latex-footnote-separator ""))))
2371             (when (org-at-heading-p)
2372               (setq fnote (concat (org-export-latex-protect-string "\\protect")
2373                                   fnote)))
2374             ;; Ensure a footnote at column 0 cannot end a list
2375             ;; containing it.
2376             (put-text-property 0 (length fnote) 'original-indentation 1000 fnote)
2377             ;; Replace footnote reference with FNOTE and, maybe, SEP.
2378             ;; `save-excursion' is required if there are two footnotes
2379             ;; in a row.  In that case, point would be left at the
2380             ;; beginning of the second one, and
2381             ;; `org-footnote-get-next-reference' would then skip it.
2382             (goto-char beg)
2383             (delete-region beg (nth 2 ref))
2384             (save-excursion (insert fnote sep)))))))
2385
2386   ;; Remove footnote section tag for LaTeX
2387   (goto-char (point-min))
2388   (while (re-search-forward
2389           (concat "^" footnote-section-tag-regexp) nil t)
2390     (org-if-unprotected
2391      (replace-match "")))
2392   ;; Remove any left-over footnote definition.
2393   (mapc (lambda (fn) (org-footnote-delete-definitions (car fn)))
2394         org-export-footnotes-data)
2395   (mapc (lambda (fn) (org-footnote-delete-definitions fn))
2396         org-export-latex-footmark-seen)
2397
2398   ;; Preserve line breaks
2399   (goto-char (point-min))
2400   (while (re-search-forward "\\\\\\\\" nil t)
2401     (add-text-properties (match-beginning 0) (match-end 0)
2402                          '(org-protected t)))
2403
2404   ;; Preserve latex environments
2405   (goto-char (point-min))
2406   (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
2407     (org-if-unprotected
2408      (let* ((start (progn (beginning-of-line) (point)))
2409             (end (and (re-search-forward
2410                        (concat "^[ \t]*\\\\end{"
2411                                (regexp-quote (match-string 1))
2412                                "}") nil t)
2413                       (point-at-eol))))
2414        (if end
2415            (add-text-properties start end '(org-protected t))
2416          (goto-char (point-at-eol))))))
2417
2418   ;; Preserve math snippets
2419   (let* ((matchers (plist-get org-format-latex-options :matchers))
2420          (re-list org-latex-regexps)
2421          beg end re e m n block off)
2422     ;; Check the different regular expressions
2423     (while (setq e (pop re-list))
2424       (setq m (car e) re (nth 1 e) n (nth 2 e)
2425             block (if (nth 3 e) "\n\n" ""))
2426       (setq off (if (member m '("$" "$1")) 1 0))
2427       (when (and (member m matchers) (not (equal m "begin")))
2428         (goto-char (point-min))
2429         (while (re-search-forward re nil t)
2430           (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
2431           (add-text-properties beg end '(org-protected t org-latex-math t))))))
2432
2433   ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
2434   (goto-char (point-min))
2435   (let ((case-fold-search nil))
2436     (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
2437       (unless (eq (char-before (match-beginning 1)) ?\\)
2438         (org-if-unprotected-1
2439          (replace-match (org-export-latex-protect-string
2440                          (concat "\\" (match-string 1)
2441                                  "{}")) t t)))))
2442
2443   ;; Convert blockquotes
2444   (goto-char (point-min))
2445   (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
2446     (org-replace-match-keep-properties "\\begin{quote}" t t))
2447   (goto-char (point-min))
2448   (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
2449     (org-replace-match-keep-properties "\\end{quote}" t t))
2450
2451   ;; Convert verse
2452   (goto-char (point-min))
2453   (while (search-forward "ORG-VERSE-START" nil t)
2454     (org-replace-match-keep-properties "\\begin{verse}" t t)
2455     (beginning-of-line 2)
2456     (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
2457       (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
2458         (goto-char (match-end 1))
2459         (org-replace-match-keep-properties
2460          (org-export-latex-protect-string
2461           (concat "\\hspace*{1cm}" (match-string 2))) t t)
2462         (beginning-of-line 1))
2463       (if (looking-at "[ \t]*$")
2464           (insert (org-export-latex-protect-string "\\vspace*{1em}"))
2465         (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
2466           (end-of-line 1)
2467           (insert "\\\\")))
2468       (beginning-of-line 2))
2469     (and (looking-at "[ \t]*ORG-VERSE-END.*")
2470          (org-replace-match-keep-properties "\\end{verse}" t t)))
2471
2472   ;; Convert #+INDEX to LaTeX \\index.
2473   (goto-char (point-min))
2474   (let ((case-fold-search t) entry)
2475     (while (re-search-forward
2476             "^[ \t]*#\\+index:[ \t]*\\([^ \t\r\n].*?\\)[ \t]*$"
2477             nil t)
2478       (setq entry
2479             (save-match-data
2480               (org-export-latex-protect-string
2481                (org-export-latex-fontify-headline (match-string 1)))))
2482       (replace-match (format "\\index{%s}" entry) t t)))
2483
2484   ;; Convert center
2485   (goto-char (point-min))
2486   (while (search-forward "ORG-CENTER-START" nil t)
2487     (org-replace-match-keep-properties "\\begin{center}" t t))
2488   (goto-char (point-min))
2489   (while (search-forward "ORG-CENTER-END" nil t)
2490     (org-replace-match-keep-properties "\\end{center}" t t))
2491
2492   (run-hooks 'org-export-latex-after-blockquotes-hook)
2493
2494   ;; Convert horizontal rules
2495   (goto-char (point-min))
2496   (while (re-search-forward "^[ \t]*-\\{5,\\}[ \t]*$" nil t)
2497     (org-if-unprotected
2498      (replace-match (org-export-latex-protect-string "\\hrule") t t)))
2499
2500   ;; Protect LaTeX commands like \command[...]{...} or \command{...}
2501   (goto-char (point-min))
2502   (let ((re (concat
2503              "\\\\\\([a-zA-Z]+\\*?\\)"
2504              "\\(?:<[^<>\n]*>\\)*"
2505              "\\(?:\\[[^][\n]*?\\]\\)*"
2506              "\\(?:<[^<>\n]*>\\)*"
2507              "\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
2508     (while (re-search-forward re nil t)
2509       (unless (or
2510                ;; Check for comment line.
2511                (save-excursion (goto-char (match-beginning 0))
2512                                (org-in-indented-comment-line))
2513                ;; Check if this is a defined entity, so that is may
2514                ;; need conversion.
2515                (org-entity-get (match-string 1))
2516                ;; Do not protect interior of footnotes.  Those have
2517                ;; already been taken care of earlier in the function.
2518                ;; Yet, keep looking inside them for more commands.
2519                (and (equal (match-string 1) "footnote")
2520                     (goto-char (match-end 1))))
2521         (add-text-properties (match-beginning 0) (match-end 0)
2522                              '(org-protected t)))))
2523
2524   ;; Special case for \nbsp
2525   (goto-char (point-min))
2526   (while (re-search-forward "\\\\nbsp\\({}\\|\\>\\)" nil t)
2527     (org-if-unprotected
2528      (replace-match (org-export-latex-protect-string "~"))))
2529
2530   ;; Protect LaTeX entities
2531   (goto-char (point-min))
2532   (while (re-search-forward org-latex-entities-regexp nil t)
2533     (org-if-unprotected
2534      (add-text-properties (match-beginning 0) (match-end 0)
2535                           '(org-protected t))))
2536
2537   ;; Replace radio links
2538   (goto-char (point-min))
2539   (while (re-search-forward
2540           (concat "<<<?" org-export-latex-all-targets-re
2541                   ">>>?\\((INVISIBLE)\\)?") nil t)
2542     (org-if-unprotected-at (+ (match-beginning 0) 2)
2543       (replace-match
2544        (concat
2545         (org-export-latex-protect-string
2546          (format "\\label{%s}" (save-match-data (org-solidify-link-text
2547                                                  (match-string 1)))))
2548         (if (match-string 2) "" (match-string 1)))
2549        t t)))
2550
2551   ;; Delete @<...> constructs
2552   ;; Thanks to Daniel Clemente for this regexp
2553   (goto-char (point-min))
2554   (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
2555     (org-if-unprotected
2556      (replace-match ""))))
2557
2558 (defun org-export-latex-fix-inputenc ()
2559   "Set the coding system in inputenc to what the buffer is."
2560   (let* ((cs buffer-file-coding-system)
2561          (opt (or (ignore-errors (latexenc-coding-system-to-inputenc cs))
2562                   "utf8")))
2563     (when opt
2564       ;; Translate if that is requested
2565       (setq opt (or (cdr (assoc opt org-export-latex-inputenc-alist)) opt))
2566       ;; find the \usepackage statement and replace the option
2567       (goto-char (point-min))
2568       (while (re-search-forward "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
2569                                 nil t)
2570         (goto-char (match-beginning 1))
2571         (delete-region (match-beginning 1) (match-end 1))
2572         (insert opt))
2573       (and buffer-file-name
2574            (save-buffer)))))
2575
2576 ;;; List handling:
2577
2578 (defun org-export-latex-lists ()
2579   "Convert plain text lists in current buffer into LaTeX lists."
2580   ;; `org-list-end-re' output has changed since preprocess from
2581   ;; org-exp.el. Make sure it is taken into account.
2582   (let ((org-list-end-re "^ORG-LIST-END-MARKER\n"))
2583     (mapc
2584      (lambda (e)
2585        ;; For each type of context allowed for list export (E), find
2586        ;; every list, parse it, delete it and insert resulting
2587        ;; conversion to latex (RES), while keeping the same
2588        ;; `original-indentation' property.
2589        (let (res)
2590          (goto-char (point-min))
2591          (while (re-search-forward (org-item-beginning-re) nil t)
2592            (when (and (eq (get-text-property (point) 'list-context) e)
2593                       (not (get-text-property (point) 'org-example)))
2594              (beginning-of-line)
2595              (setq res
2596                    (org-list-to-latex
2597                     ;; Narrowing is needed because we're converting
2598                     ;; from inner functions to outer ones.
2599                     (save-restriction
2600                       (narrow-to-region (point) (point-max))
2601                       (org-list-parse-list t))
2602                     org-export-latex-list-parameters))
2603              ;; Extend previous value of original-indentation to the
2604              ;; whole string
2605              (insert (org-add-props res nil 'original-indentation
2606                                     (org-find-text-property-in-string
2607                                      'original-indentation res)))))))
2608      ;; List of allowed contexts for export, and the default one.
2609      (append org-list-export-context '(nil)))))
2610
2611 (defconst org-latex-entities
2612  '("\\!"
2613    "\\'"
2614    "\\+"
2615    "\\,"
2616    "\\-"
2617    "\\:"
2618    "\\;"
2619    "\\<"
2620    "\\="
2621    "\\>"
2622    "\\Huge"
2623    "\\LARGE"
2624    "\\Large"
2625    "\\Styles"
2626    "\\\\"
2627    "\\`"
2628    "\\\""
2629    "\\addcontentsline"
2630    "\\address"
2631    "\\addtocontents"
2632    "\\addtocounter"
2633    "\\addtolength"
2634    "\\addvspace"
2635    "\\alph"
2636    "\\appendix"
2637    "\\arabic"
2638    "\\author"
2639    "\\begin{array}"
2640    "\\begin{center}"
2641    "\\begin{description}"
2642    "\\begin{enumerate}"
2643    "\\begin{eqnarray}"
2644    "\\begin{equation}"
2645    "\\begin{figure}"
2646    "\\begin{flushleft}"
2647    "\\begin{flushright}"
2648    "\\begin{itemize}"
2649    "\\begin{list}"
2650    "\\begin{minipage}"
2651    "\\begin{picture}"
2652    "\\begin{quotation}"
2653    "\\begin{quote}"
2654    "\\begin{tabbing}"
2655    "\\begin{table}"
2656    "\\begin{tabular}"
2657    "\\begin{thebibliography}"
2658    "\\begin{theorem}"
2659    "\\begin{titlepage}"
2660    "\\begin{verbatim}"
2661    "\\begin{verse}"
2662    "\\bf"
2663    "\\bf"
2664    "\\bibitem"
2665    "\\bigskip"
2666    "\\cdots"
2667    "\\centering"
2668    "\\circle"
2669    "\\cite"
2670    "\\cleardoublepage"
2671    "\\clearpage"
2672    "\\cline"
2673    "\\closing"
2674    "\\dashbox"
2675    "\\date"
2676    "\\ddots"
2677    "\\dotfill"
2678    "\\em"
2679    "\\fbox"
2680    "\\flushbottom"
2681    "\\fnsymbol"
2682    "\\footnote"
2683    "\\footnotemark"
2684    "\\footnotesize"
2685    "\\footnotetext"
2686    "\\frac"
2687    "\\frame"
2688    "\\framebox"
2689    "\\hfill"
2690    "\\hline"
2691    "\\hrulespace"
2692    "\\hspace"
2693    "\\huge"
2694    "\\hyphenation"
2695    "\\include"
2696    "\\includeonly"
2697    "\\indent"
2698    "\\input"
2699    "\\it"
2700    "\\kill"
2701    "\\label"
2702    "\\large"
2703    "\\ldots"
2704    "\\line"
2705    "\\linebreak"
2706    "\\linethickness"
2707    "\\listoffigures"
2708    "\\listoftables"
2709    "\\location"
2710    "\\makebox"
2711    "\\maketitle"
2712    "\\mark"
2713    "\\mbox"
2714    "\\medskip"
2715    "\\multicolumn"
2716    "\\multiput"
2717    "\\newcommand"
2718    "\\newcounter"
2719    "\\newenvironment"
2720    "\\newfont"
2721    "\\newlength"
2722    "\\newline"
2723    "\\newpage"
2724    "\\newsavebox"
2725    "\\newtheorem"
2726    "\\nocite"
2727    "\\nofiles"
2728    "\\noindent"
2729    "\\nolinebreak"
2730    "\\nopagebreak"
2731    "\\normalsize"
2732    "\\onecolumn"
2733    "\\opening"
2734    "\\oval"
2735    "\\overbrace"
2736    "\\overline"
2737    "\\pagebreak"
2738    "\\pagenumbering"
2739    "\\pageref"
2740    "\\pagestyle"
2741    "\\par"
2742    "\\parbox"
2743    "\\put"
2744    "\\raggedbottom"
2745    "\\raggedleft"
2746    "\\raggedright"
2747    "\\raisebox"
2748    "\\ref"
2749    "\\rm"
2750    "\\roman"
2751    "\\rule"
2752    "\\savebox"
2753    "\\sc"
2754    "\\scriptsize"
2755    "\\setcounter"
2756    "\\setlength"
2757    "\\settowidth"
2758    "\\sf"
2759    "\\shortstack"
2760    "\\signature"
2761    "\\sl"
2762    "\\small"
2763    "\\smallskip"
2764    "\\sqrt"
2765    "\\tableofcontents"
2766    "\\telephone"
2767    "\\thanks"
2768    "\\thispagestyle"
2769    "\\tiny"
2770    "\\title"
2771    "\\tt"
2772    "\\twocolumn"
2773    "\\typein"
2774    "\\typeout"
2775    "\\underbrace"
2776    "\\underline"
2777    "\\usebox"
2778    "\\usecounter"
2779    "\\value"
2780    "\\vdots"
2781    "\\vector"
2782    "\\verb"
2783    "\\vfill"
2784    "\\vline"
2785    "\\vspace")
2786  "A list of LaTeX commands to be protected when performing conversion.")
2787
2788 (defconst org-latex-entities-regexp
2789   (let (names rest)
2790     (dolist (x org-latex-entities)
2791       (if (string-match "[a-zA-Z]$" x)
2792           (push x names)
2793         (push x rest)))
2794     (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
2795             "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
2796
2797 (provide 'org-export-latex)
2798 (provide 'org-latex)
2799
2800 ;;; org-latex.el ends here