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