lisp/org-exp.el

   1 ;;; org-exp.el --- Export internals for Org-mode
   2
   3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
   6 ;; Keywords: outlines, hypermedia, calendar, wp
   7 ;; Homepage: http://orgmode.org
   8 ;;
   9 ;; This file is part of GNU Emacs.
  10 ;;
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24 ;;
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (require 'org)
  30 (require 'org-macs)
  31 (require 'org-agenda)
  32 (require 'org-exp-blocks)
  33 (require 'ob-exp)
  34 (require 'org-src)
  35
  36 (eval-when-compile
  37   (require 'cl))
  38
  39 (declare-function org-export-latex-preprocess "org-latex" (parameters))
  40 (declare-function org-export-ascii-preprocess "org-ascii" (parameters))
  41 (declare-function org-export-html-preprocess "org-html" (parameters))
  42 (declare-function org-export-docbook-preprocess "org-docbook" (parameters))
  43 (declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
  44 (declare-function org-export-htmlize-region-for-paste "org-html" (beg end))
  45 (declare-function htmlize-buffer "ext:htmlize" (&optional buffer))
  46 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  47 (declare-function org-table-cookie-line-p "org-table" (line))
  48 (declare-function org-table-colgroup-line-p "org-table" (line))
  49 (declare-function org-pop-to-buffer-same-window "org-compat"
  50                   (&optional buffer-or-name norecord label))
  51
  52 (autoload 'org-export-generic "org-export-generic" "Export using the generic exporter" t)
  53
  54 (autoload 'org-export-as-odt "org-odt"
  55   "Export the outline to a OpenDocument Text file." t)
  56 (autoload 'org-export-as-odt-and-open "org-odt"
  57   "Export the outline to a OpenDocument Text file and open it." t)
  58
  59 (defgroup org-export nil
  60   "Options for exporting org-listings."
  61   :tag "Org Export"
  62   :group 'org)
  63
  64 (defgroup org-export-general nil
  65   "General options for exporting Org-mode files."
  66   :tag "Org Export General"
  67   :group 'org-export)
  68
  69 (defcustom org-export-allow-BIND 'confirm
  70   "Non-nil means allow #+BIND to define local variable values for export.
  71 This is a potential security risk, which is why the user must confirm the
  72 use of these lines."
  73   :group 'org-export-general
  74   :type '(choice
  75           (const :tag "Never" nil)
  76           (const :tag "Always" t)
  77           (const :tag "Make the user confirm for each file" confirm)))
  78
  79 ;; FIXME
  80 (defvar org-export-publishing-directory nil)
  81
  82 (defcustom org-export-show-temporary-export-buffer t
  83   "Non-nil means show buffer after exporting to temp buffer.
  84 When Org exports to a file, the buffer visiting that file is ever
  85 shown, but remains buried.  However, when exporting to a temporary
  86 buffer, that buffer is popped up in a second window.  When this variable
  87 is nil, the buffer remains buried also in these cases."
  88   :group 'org-export-general
  89   :type 'boolean)
  90
  91 (defcustom org-export-copy-to-kill-ring t
  92   "Non-nil means exported stuff will also be pushed onto the kill ring."
  93   :group 'org-export-general
  94   :type 'boolean)
  95
  96 (defcustom org-export-kill-product-buffer-when-displayed nil
  97   "Non-nil means kill the product buffer if it is displayed immediately.
  98 This applied to the commands `org-export-as-html-and-open' and
  99 `org-export-as-pdf-and-open'."
 100   :group 'org-export-general
 101   :version "24.1"
 102   :type 'boolean)
 103
 104 (defcustom org-export-run-in-background nil
 105   "Non-nil means export and publishing commands will run in background.
 106 This works by starting up a separate Emacs process visiting the same file
 107 and doing the export from there.
 108 Not all export commands are affected by this - only the ones which
 109 actually write to a file, and that do not depend on the buffer state.
 110 \\<org-mode-map>
 111 If this option is nil, you can still get background export by calling
 112 `org-export' with a double prefix arg: \
 113 \\[universal-argument] \\[universal-argument] \\[org-export].
 114
 115 If this option is t, the double prefix can be used to exceptionally
 116 force an export command into the current process."
 117   :group 'org-export-general
 118   :type 'boolean)
 119
 120 (defcustom org-export-initial-scope 'buffer
 121   "The initial scope when exporting with `org-export'.
 122 This variable can be either set to 'buffer or 'subtree."
 123   :group 'org-export-general
 124   :version "24.1"
 125   :type '(choice
 126           (const :tag "Export current buffer" 'buffer)
 127           (const :tag "Export current subtree" 'subtree)))
 128
 129 (defcustom org-export-select-tags '("export")
 130   "Tags that select a tree for export.
 131 If any such tag is found in a buffer, all trees that do not carry one
 132 of these tags will be deleted before export.
 133 Inside trees that are selected like this, you can still deselect a
 134 subtree by tagging it with one of the `org-export-exclude-tags'."
 135   :group 'org-export-general
 136   :type '(repeat (string :tag "Tag")))
 137
 138 (defcustom org-export-exclude-tags '("noexport")
 139   "Tags that exclude a tree from export.
 140 All trees carrying any of these tags will be excluded from export.
 141 This is without condition, so even subtrees inside that carry one of the
 142 `org-export-select-tags' will be removed."
 143   :group 'org-export-general
 144   :type '(repeat (string :tag "Tag")))
 145
 146 ;; FIXME: rename, this is a general variable
 147 (defcustom org-export-html-expand t
 148   "Non-nil means for HTML export, treat @<...> as HTML tag.
 149 When nil, these tags will be exported as plain text and therefore
 150 not be interpreted by a browser.
 151
 152 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
 153   :group 'org-export-html
 154   :group 'org-export-general
 155   :type 'boolean)
 156
 157 (defcustom org-export-with-special-strings t
 158   "Non-nil means interpret \"\-\", \"--\" and \"---\" for export.
 159 When this option is turned on, these strings will be exported as:
 160
 161   Org   HTML       LaTeX
 162  -----+----------+--------
 163   \\-    &shy;      \\-
 164   --    &ndash;    --
 165   ---   &mdash;    ---
 166   ...   &hellip;   \ldots
 167
 168 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
 169   :group 'org-export-translation
 170   :type 'boolean)
 171
 172 (defcustom org-export-html-link-up ""
 173   "Where should the \"UP\" link of exported HTML pages lead?"
 174   :group 'org-export-html
 175   :group 'org-export-general
 176   :type '(string :tag "File or URL"))
 177
 178 (defcustom org-export-html-link-home ""
 179   "Where should the \"HOME\" link of exported HTML pages lead?"
 180   :group 'org-export-html
 181   :group 'org-export-general
 182   :type '(string :tag "File or URL"))
 183
 184 (defcustom org-export-language-setup
 185   '(("en" "Author"     "Date"  "Table of Contents" "Footnotes")
 186     ("ca"  "Autor"      "Data" "&Iacute;ndex" "Peus de p&agrave;gina")
 187     ("cs" "Autor"      "Datum" "Obsah" "Pozn\xe1mky pod carou")
 188     ("da" "Ophavsmand" "Dato"  "Indhold" "Fodnoter")
 189     ("de" "Autor"      "Datum" "Inhaltsverzeichnis" "Fu&szlig;noten")
 190     ("eo"  "A&#365;toro"      "Dato" "Enhavo" "Piednotoj")
 191     ("es" "Autor"      "Fecha" "&Iacute;ndice" "Pies de p&aacute;gina")
 192     ("fi" "Tekij&auml;"     "P&auml;iv&auml;m&auml;&auml;r&auml;"   "Sis&auml;llysluettelo"  "Alaviitteet")
 193     ("fr" "Auteur"     "Date"  "Sommaire" "Notes de bas de page")
 194     ("hu" "Szerz&otilde;" "D&aacute;tum" "Tartalomjegyz&eacute;k" "L&aacute;bjegyzet")
 195     ("is" "H&ouml;fundur" "Dagsetning" "Efnisyfirlit" "Aftanm&aacute;lsgreinar")
 196     ("it" "Autore"     "Data"  "Indice" "Note a pi&egrave; di pagina")
 197     ;; Use numeric character entities for proper rendering of non-UTF8 documents
 198     ;; ("ja" "著者"       "日付"  "目次"          "脚注")
 199     ("ja" "&#33879;&#32773;" "&#26085;&#20184;" "&#30446;&#27425;" "&#33050;&#27880;")
 200     ("nl" "Auteur"     "Datum" "Inhoudsopgave" "Voetnoten")
 201     ("no" "Forfatter"  "Dato"  "Innhold" "Fotnoter")
 202     ("nb" "Forfatter"  "Dato"  "Innhold" "Fotnoter")  ;; nb = Norsk (bokm.l)
 203     ("nn" "Forfattar"  "Dato"  "Innhald" "Fotnotar")  ;; nn = Norsk (nynorsk)
 204     ("pl" "Autor"      "Data" "Spis tre&#x015b;ci"  "Przypis")
 205     ;; Use numeric character entities for proper rendering of non-UTF8 documents
 206     ;; ("ru" "Автор"      "Дата"  "Содержание" "Сноски")
 207     ("ru" "&#1040;&#1074;&#1090;&#1086;&#1088;"      "&#1044;&#1072;&#1090;&#1072;"  "&#1057;&#1086;&#1076;&#1077;&#1088;&#1078;&#1072;&#1085;&#1080;&#1077;" "&#1057;&#1085;&#1086;&#1089;&#1082;&#1080;")
 208     ("sv" "F&ouml;rfattare" "Datum" "Inneh&aring;ll" "Fotnoter")
 209     ;; Use numeric character entities for proper rendering of non-UTF8 documents
 210     ;; ("uk" "Автор" "Дата" "Зміст" "Примітки")
 211     ("uk" "&#1040;&#1074;&#1090;&#1086;&#1088;" "&#1044;&#1072;&#1090;&#1072;" "&#1047;&#1084;&#1110;&#1089;&#1090;" "&#1055;&#1088;&#1080;&#1084;&#1110;&#1090;&#1082;&#1080;")
 212     ;; Use numeric character entities for proper rendering of non-UTF8 documents
 213     ;; ("zh-CN" "作者" "日期" "目录" "脚注")
 214     ("zh-CN" "&#20316;&#32773;" "&#26085;&#26399;" "&#30446;&#24405;" "&#33050;&#27880;")
 215     ;; Use numeric character entities for proper rendering of non-UTF8 documents
 216     ;; ("zh-TW" "作者" "日期" "目錄" "腳註")
 217     ("zh-TW" "&#20316;&#32773;" "&#26085;&#26399;" "&#30446;&#37636;" "&#33139;&#35387;"))
 218   "Terms used in export text, translated to different languages.
 219 Use the variable `org-export-default-language' to set the language,
 220 or use the +OPTION lines for a per-file setting."
 221   :group 'org-export-general
 222   :type '(repeat
 223           (list
 224            (string :tag "HTML language tag")
 225            (string :tag "Author")
 226            (string :tag "Date")
 227            (string :tag "Table of Contents")
 228            (string :tag "Footnotes"))))
 229
 230 (defcustom org-export-default-language "en"
 231   "The default language for export and clocktable translations, as a string.
 232 This should have an association in `org-export-language-setup'
 233 and in `org-clock-clocktable-language-setup'."
 234   :group 'org-export-general
 235   :type 'string)
 236
 237 (defcustom org-export-date-timestamp-format "%Y-%m-%d"
 238   "Time string format for Org timestamps in the #+DATE option."
 239   :group 'org-export-general
 240   :version "24.1"
 241   :type 'string)
 242
 243 (defvar org-export-page-description ""
 244   "The page description, for the XHTML meta tag.
 245 This is best set with the #+DESCRIPTION line in a file, it does not make
 246 sense to set this globally.")
 247
 248 (defvar org-export-page-keywords ""
 249   "The page description, for the XHTML meta tag.
 250 This is best set with the #+KEYWORDS line in a file, it does not make
 251 sense to set this globally.")
 252
 253 (defcustom org-export-skip-text-before-1st-heading nil
 254   "Non-nil means skip all text before the first headline when exporting.
 255 When nil, that text is exported as well."
 256   :group 'org-export-general
 257   :type 'boolean)
 258
 259 (defcustom org-export-headline-levels 3
 260   "The last level which is still exported as a headline.
 261 Inferior levels will produce itemize lists when exported.
 262 Note that a numeric prefix argument to an exporter function overrides
 263 this setting.
 264
 265 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
 266   :group 'org-export-general
 267   :type 'integer)
 268
 269 (defcustom org-export-with-section-numbers t
 270   "Non-nil means add section numbers to headlines when exporting.
 271
 272 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
 273   :group 'org-export-general
 274   :type 'boolean)
 275
 276 (defcustom org-export-section-number-format '((("1" ".")) . "")
 277   "Format of section numbers for export.
 278 The variable has two components.
 279 1. A list of lists, each indicating a counter type and a separator.
 280    The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"i\".
 281    It causes causes numeric, alphabetic, or roman counters, respectively.
 282    The separator is only used if another counter for a subsection is being
 283    added.
 284    If there are more numbered section levels than entries in this lists,
 285    then the last entry will be reused.
 286 2. A terminator string that will be added after the entire
 287    section number."
 288   :group 'org-export-general
 289   :type '(cons
 290           (repeat
 291            (list
 292             (string :tag "Counter Type")
 293             (string :tag "Separator   ")))
 294           (string :tag "Terminator")))
 295
 296 (defcustom org-export-with-toc t
 297   "Non-nil means create a table of contents in exported files.
 298 The TOC contains headlines with levels up to`org-export-headline-levels'.
 299 When an integer, include levels up to N in the toc, this may then be
 300 different from `org-export-headline-levels', but it will not be allowed
 301 to be larger than the number of headline levels.
 302 When nil, no table of contents is made.
 303
 304 Headlines which contain any TODO items will be marked with \"(*)\" in
 305 ASCII export, and with red color in HTML output, if the option
 306 `org-export-mark-todo-in-toc' is set.
 307
 308 In HTML output, the TOC will be clickable.
 309
 310 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
 311 or \"toc:3\"."
 312   :group 'org-export-general
 313   :type '(choice
 314           (const :tag "No Table of Contents" nil)
 315           (const :tag "Full Table of Contents" t)
 316           (integer :tag "TOC to level")))
 317
 318 (defcustom org-export-mark-todo-in-toc nil
 319   "Non-nil means mark TOC lines that contain any open TODO items."
 320   :group 'org-export-general
 321   :type 'boolean)
 322
 323 (defcustom org-export-with-todo-keywords t
 324   "Non-nil means include TODO keywords in export.
 325 When nil, remove all these keywords from the export."
 326   :group 'org-export-general
 327   :type 'boolean)
 328
 329 (defcustom org-export-with-tasks t
 330   "Non-nil means include TODO items for export.
 331 This may have the following values:
 332 t                    include tasks independent of state.
 333 todo                 include only tasks that are not yet done.
 334 done                 include only tasks that are already done.
 335 nil                  remove all tasks before export
 336 list of TODO kwds    keep only tasks with these keywords"
 337   :group 'org-export-general
 338   :version "24.1"
 339   :type '(choice
 340           (const :tag "All tasks" t)
 341           (const :tag "No tasks" nil)
 342           (const :tag "Not-done tasks" todo)
 343           (const :tag "Only done tasks" done)
 344           (repeat :tag "Specific TODO keywords"
 345                   (string :tag "Keyword"))))
 346
 347 (defcustom org-export-with-priority nil
 348   "Non-nil means include priority cookies in export.
 349 When nil, remove priority cookies for export."
 350   :group 'org-export-general
 351   :type 'boolean)
 352
 353 (defcustom org-export-preserve-breaks nil
 354   "Non-nil means preserve all line breaks when exporting.
 355 Normally, in HTML output paragraphs will be reformatted.  In ASCII
 356 export, line breaks will always be preserved, regardless of this variable.
 357
 358 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
 359   :group 'org-export-general
 360   :type 'boolean)
 361
 362 (defcustom org-export-with-archived-trees 'headline
 363   "Whether subtrees with the ARCHIVE tag should be exported.
 364 This can have three different values
 365 nil       Do not export, pretend this tree is not present
 366 t         Do export the entire tree
 367 headline  Only export the headline, but skip the tree below it."
 368   :group 'org-export-general
 369   :group 'org-archive
 370   :type '(choice
 371           (const :tag "not at all" nil)
 372           (const :tag "headline only" 'headline)
 373           (const :tag "entirely" t)))
 374
 375 (defcustom org-export-author-info t
 376   "Non-nil means insert author name and email into the exported file.
 377
 378 This option can also be set with the +OPTIONS line,
 379 e.g. \"author:nil\"."
 380   :group 'org-export-general
 381   :type 'boolean)
 382
 383 (defcustom org-export-email-info nil
 384   "Non-nil means insert author name and email into the exported file.
 385
 386 This option can also be set with the +OPTIONS line,
 387 e.g. \"email:t\"."
 388   :group 'org-export-general
 389   :version "24.1"
 390   :type 'boolean)
 391
 392 (defcustom org-export-creator-info t
 393   "Non-nil means the postamble should contain a creator sentence.
 394 This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
 395   :group 'org-export-general
 396   :type 'boolean)
 397
 398 (defcustom org-export-time-stamp-file t
 399   "Non-nil means insert a time stamp into the exported file.
 400 The time stamp shows when the file was created.
 401
 402 This option can also be set with the +OPTIONS line,
 403 e.g. \"timestamp:nil\"."
 404   :group 'org-export-general
 405   :type 'boolean)
 406
 407 (defcustom org-export-with-timestamps t
 408   "If nil, do not export time stamps and associated keywords."
 409   :group 'org-export-general
 410   :type 'boolean)
 411
 412 (defcustom org-export-remove-timestamps-from-toc t
 413   "If t, remove timestamps from the table of contents entries."
 414   :group 'org-export-general
 415   :type 'boolean)
 416
 417 (defcustom org-export-with-tags 'not-in-toc
 418   "If nil, do not export tags, just remove them from headlines.
 419 If this is the symbol `not-in-toc', tags will be removed from table of
 420 contents entries, but still be shown in the headlines of the document.
 421
 422 This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
 423   :group 'org-export-general
 424   :type '(choice
 425           (const :tag "Off" nil)
 426           (const :tag "Not in TOC" not-in-toc)
 427           (const :tag "On" t)))
 428
 429 (defcustom org-export-with-drawers nil
 430   "Non-nil means export with drawers like the property drawer.
 431 When t, all drawers are exported.  This may also be a list of
 432 drawer names to export."
 433   :group 'org-export-general
 434   :type '(choice
 435           (const :tag "All drawers" t)
 436           (const :tag "None" nil)
 437           (repeat :tag "Selected drawers"
 438                   (string :tag "Drawer name"))))
 439
 440 (defvar org-export-first-hook nil
 441   "Hook called as the first thing in each exporter.
 442 Point will be still in the original buffer.
 443 Good for general initialization")
 444
 445 (defvar org-export-preprocess-hook nil
 446   "Hook for preprocessing an export buffer.
 447 Pretty much the first thing when exporting is running this hook.
 448 Point will be in a temporary buffer that contains a copy of
 449 the original buffer, or of the section that is being exported.
 450 All the other hooks in the org-export-preprocess... category
 451 also work in that temporary buffer, already modified by various
 452 stages of the processing.")
 453
 454 (defvar org-export-preprocess-after-include-files-hook nil
 455   "Hook for preprocessing an export buffer.
 456 This is run after the contents of included files have been inserted.")
 457
 458 (defvar org-export-preprocess-after-tree-selection-hook nil
 459   "Hook for preprocessing an export buffer.
 460 This is run after selection of trees to be exported has happened.
 461 This selection includes tags-based selection, as well as removal
 462 of commented and archived trees.")
 463
 464 (defvar org-export-preprocess-after-headline-targets-hook nil
 465   "Hook for preprocessing export buffer.
 466 This is run just after the headline targets have been defined and
 467 the target-alist has been set up.")
 468
 469 (defvar org-export-preprocess-before-selecting-backend-code-hook nil
 470   "Hook for preprocessing an export buffer.
 471 This is run just before backend-specific blocks get selected.")
 472
 473 (defvar org-export-preprocess-after-blockquote-hook nil
 474   "Hook for preprocessing an export buffer.
 475 This is run after blockquote/quote/verse/center have been marked
 476 with cookies.")
 477
 478 (defvar org-export-preprocess-after-radio-targets-hook nil
 479   "Hook for preprocessing an export buffer.
 480 This is run after radio target processing.")
 481
 482 (defvar org-export-preprocess-before-normalizing-links-hook nil
 483   "Hook for preprocessing an export buffer.
 484 This hook is run before links are normalized.")
 485
 486 (defvar org-export-preprocess-before-backend-specifics-hook nil
 487   "Hook run before backend-specific functions are called during preprocessing.")
 488
 489 (defvar org-export-preprocess-final-hook nil
 490   "Hook for preprocessing an export buffer.
 491 This is run as the last thing in the preprocessing buffer, just before
 492 returning the buffer string to the backend.")
 493
 494 (defgroup org-export-translation nil
 495   "Options for translating special ascii sequences for the export backends."
 496   :tag "Org Export Translation"
 497   :group 'org-export)
 498
 499 (defcustom org-export-with-emphasize t
 500   "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
 501 If the export target supports emphasizing text, the word will be
 502 typeset in bold, italic, or underlined, respectively.  Works only for
 503 single words, but you can say: I *really* *mean* *this*.
 504 Not all export backends support this.
 505
 506 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
 507   :group 'org-export-translation
 508   :type 'boolean)
 509
 510 (defcustom org-export-with-footnotes t
 511   "If nil, export [1] as a footnote marker.
 512 Lines starting with [1] will be formatted as footnotes.
 513
 514 This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
 515   :group 'org-export-translation
 516   :type 'boolean)
 517
 518 (defcustom org-export-with-TeX-macros t
 519   "Non-nil means interpret simple TeX-like macros when exporting.
 520 For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
 521 Not only real TeX macros will work here, but the standard HTML entities
 522 for math can be used as macro names as well.  For a list of supported
 523 names in HTML export, see the constant `org-entities' and the user option
 524 `org-entities-user'.
 525 Not all export backends support this.
 526
 527 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
 528   :group 'org-export-translation
 529   :group 'org-export-latex
 530   :type 'boolean)
 531
 532 (defcustom org-export-with-LaTeX-fragments t
 533   "Non-nil means process LaTeX math fragments for HTML display.
 534 When set, the exporter will find and process LaTeX environments if the
 535 \\begin line is the first non-white thing on a line.  It will also find
 536 and process the math delimiters like $a=b$ and \\( a=b \\) for inline math,
 537 $$a=b$$ and \\=\\[ a=b \\] for display math.
 538
 539 This option can also be set with the +OPTIONS line, e.g. \"LaTeX:mathjax\".
 540
 541 Allowed values are:
 542
 543 nil             Don't do anything.
 544 verbatim        Keep everything in verbatim
 545 dvipng          Process the LaTeX fragments to images.
 546                 This will also include processing of non-math environments.
 547 imagemagick     Convert the LaTeX fragments to pdf files and use imagemagick
 548                 to convert pdf files to png files.
 549 t               Do MathJax preprocessing if there is at least on math snippet,
 550                 and arrange for MathJax.js to be loaded.
 551
 552 The default is nil, because this option needs the `dvipng' program which
 553 is not available on all systems."
 554   :group 'org-export-translation
 555   :group 'org-export-latex
 556   :type '(choice
 557           (const :tag "Do not process math in any way" nil)
 558           (const :tag "Obsolete, use dvipng setting" t)
 559           (const :tag "Use dvipng to make images" dvipng)
 560           (const :tag "Use imagemagick to make images" imagemagick)
 561           (const :tag "Use MathJax to display math" mathjax)
 562           (const :tag "Leave math verbatim" verbatim)))
 563
 564 (defcustom org-export-with-fixed-width t
 565   "Non-nil means lines starting with \":\" will be in fixed width font.
 566 This can be used to have pre-formatted text, fragments of code etc.  For
 567 example:
 568   : ;; Some Lisp examples
 569   : (while (defc cnt)
 570   :   (ding))
 571 will be looking just like this in also HTML.  See also the QUOTE keyword.
 572 Not all export backends support this.
 573
 574 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
 575   :group 'org-export-translation
 576   :type 'boolean)
 577
 578 (defgroup org-export-tables nil
 579   "Options for exporting tables in Org-mode."
 580   :tag "Org Export Tables"
 581   :group 'org-export)
 582
 583 (defcustom org-export-with-tables t
 584   "If non-nil, lines starting with \"|\" define a table.
 585 For example:
 586
 587   | Name        | Address  | Birthday  |
 588   |-------------+----------+-----------|
 589   | Arthur Dent | England  | 29.2.2100 |
 590
 591 Not all export backends support this.
 592
 593 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
 594   :group 'org-export-tables
 595   :type 'boolean)
 596
 597 (defcustom org-export-highlight-first-table-line t
 598   "Non-nil means highlight the first table line.
 599 In HTML export, this means use <th> instead of <td>.
 600 In tables created with table.el, this applies to the first table line.
 601 In Org-mode tables, all lines before the first horizontal separator
 602 line will be formatted with <th> tags."
 603   :group 'org-export-tables
 604   :type 'boolean)
 605
 606 (defcustom org-export-table-remove-special-lines t
 607   "Remove special lines and marking characters in calculating tables.
 608 This removes the special marking character column from tables that are set
 609 up for spreadsheet calculations.  It also removes the entire lines
 610 marked with `!', `_', or `^'.  The lines with `$' are kept, because
 611 the values of constants may be useful to have."
 612   :group 'org-export-tables
 613   :type 'boolean)
 614
 615 (defcustom org-export-table-remove-empty-lines t
 616   "Remove empty lines when exporting tables.
 617 This is the global equivalent of the :remove-nil-lines option
 618 when locally sending a table with #+ORGTBL."
 619   :group 'org-export-tables
 620   :version "24.1"
 621   :type 'boolean)
 622
 623 (defcustom org-export-prefer-native-exporter-for-tables nil
 624   "Non-nil means always export tables created with table.el natively.
 625 Natively means use the HTML code generator in table.el.
 626 When nil, Org-mode's own HTML generator is used when possible (i.e. if
 627 the table does not use row- or column-spanning).  This has the
 628 advantage, that the automatic HTML conversions for math symbols and
 629 sub/superscripts can be applied.  Org-mode's HTML generator is also
 630 much faster.  The LaTeX exporter always use the native exporter for
 631 table.el tables."
 632   :group 'org-export-tables
 633   :type 'boolean)
 634
 635 ;;;; Exporting
 636
 637 ;;; Variables, constants, and parameter plists
 638
 639 (defconst org-level-max 20)
 640
 641 (defvar org-export-current-backend nil
 642   "During export, this will be bound to a symbol such as 'html,
 643   'latex, 'docbook, 'ascii, etc, indicating which of the export
 644   backends is in use.  Otherwise it has the value nil.  Users
 645   should not attempt to change the value of this variable
 646   directly, but it can be used in code to test whether export is
 647   in progress, and if so, what the backend is.")
 648
 649 (defvar org-current-export-file nil) ; dynamically scoped parameter
 650 (defvar org-current-export-dir nil) ; dynamically scoped parameter
 651 (defvar org-export-opt-plist nil
 652   "Contains the current option plist.")
 653 (defvar org-last-level nil) ; dynamically scoped variable
 654 (defvar org-min-level nil) ; dynamically scoped variable
 655 (defvar org-levels-open nil) ; dynamically scoped parameter
 656 (defvar org-export-footnotes-data nil
 657   "Alist of labels used in buffers, along with their definition.")
 658 (defvar org-export-footnotes-seen nil
 659   "Alist of labels encountered so far by the exporter, along with their definition.")
 660
 661
 662 (defconst org-export-plist-vars
 663   '((:link-up                 nil         org-export-html-link-up)
 664     (:link-home               nil         org-export-html-link-home)
 665     (:language                nil         org-export-default-language)
 666     (:keywords                nil         org-export-page-keywords)
 667     (:description             nil         org-export-page-description)
 668     (:customtime              nil         org-display-custom-times)
 669     (:headline-levels         "H"         org-export-headline-levels)
 670     (:section-numbers         "num"       org-export-with-section-numbers)
 671     (:section-number-format   nil         org-export-section-number-format)
 672     (:table-of-contents       "toc"       org-export-with-toc)
 673     (:preserve-breaks         "\\n"       org-export-preserve-breaks)
 674     (:archived-trees          nil         org-export-with-archived-trees)
 675     (:emphasize               "*"         org-export-with-emphasize)
 676     (:sub-superscript         "^"         org-export-with-sub-superscripts)
 677     (:special-strings         "-"         org-export-with-special-strings)
 678     (:footnotes               "f"         org-export-with-footnotes)
 679     (:drawers                 "d"         org-export-with-drawers)
 680     (:tags                    "tags"      org-export-with-tags)
 681     (:todo-keywords           "todo"      org-export-with-todo-keywords)
 682     (:tasks                   "tasks"     org-export-with-tasks)
 683     (:priority                "pri"       org-export-with-priority)
 684     (:TeX-macros              "TeX"       org-export-with-TeX-macros)
 685     (:LaTeX-fragments         "LaTeX"     org-export-with-LaTeX-fragments)
 686     (:latex-listings          nil         org-export-latex-listings)
 687     (:skip-before-1st-heading "skip"      org-export-skip-text-before-1st-heading)
 688     (:fixed-width             ":"         org-export-with-fixed-width)
 689     (:timestamps              "<"         org-export-with-timestamps)
 690     (:author                  nil         user-full-name)
 691     (:email                   nil         user-mail-address)
 692     (:author-info             "author"    org-export-author-info)
 693     (:email-info              "email"     org-export-email-info)
 694     (:creator-info            "creator"   org-export-creator-info)
 695     (:time-stamp-file         "timestamp" org-export-time-stamp-file)
 696     (:tables                  "|"         org-export-with-tables)
 697     (:table-auto-headline     nil         org-export-highlight-first-table-line)
 698     (:style-include-default   nil         org-export-html-style-include-default)
 699     (:style-include-scripts   nil         org-export-html-style-include-scripts)
 700     (:style                   nil         org-export-html-style)
 701     (:style-extra             nil         org-export-html-style-extra)
 702     (:agenda-style            nil         org-agenda-export-html-style)
 703     (:convert-org-links       nil         org-export-html-link-org-files-as-html)
 704     (:inline-images           nil         org-export-html-inline-images)
 705     (:html-extension          nil         org-export-html-extension)
 706     (:html-preamble           nil         org-export-html-preamble)
 707     (:html-postamble          nil         org-export-html-postamble)
 708     (:xml-declaration         nil         org-export-html-xml-declaration)
 709     (:html-table-tag          nil         org-export-html-table-tag)
 710     (:expand-quoted-html      "@"         org-export-html-expand)
 711     (:timestamp               nil         org-export-html-with-timestamp)
 712     (:publishing-directory    nil         org-export-publishing-directory)
 713     (:select-tags             nil         org-export-select-tags)
 714     (:exclude-tags            nil         org-export-exclude-tags)
 715
 716     (:latex-image-options     nil         org-export-latex-image-default-option))
 717   "List of properties that represent export/publishing variables.
 718 Each element is a list of 3 items:
 719 1. The property that is used internally, and also for org-publish-project-alist
 720 2. The string that can be used in the OPTION lines to set this option,
 721    or nil if this option cannot be changed in this way
 722 3. The customization variable that sets the default for this option."
 723   )
 724
 725 (defun org-default-export-plist ()
 726   "Return the property list with default settings for the export variables."
 727   (let* ((infile (org-infile-export-plist))
 728          (letbind (plist-get infile :let-bind))
 729          (l org-export-plist-vars) rtn e s v)
 730     (while (setq e (pop l))
 731       (setq s (nth 2 e)
 732             v (cond
 733                ((assq s letbind) (nth 1 (assq s letbind)))
 734                ((boundp s) (symbol-value s)))
 735             rtn (cons (car e) (cons v rtn))))
 736     rtn))
 737
 738 (defvar org-export-inbuffer-options-extra nil
 739   "List of additional in-buffer options that should be detected.
 740 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
 741 etc.  Extensions can add to this list to get their options detected, and they
 742 can then add a function to `org-export-options-filters' to process these
 743 options.
 744 Each element in this list must be a list, with the in-buffer keyword as car,
 745 and a property (a symbol) as the next element.  All occurrences of the
 746 keyword will be found, the values concatenated with a space character
 747 in between, and the result stored in the export options property list.")
 748
 749 (defvar org-export-options-filters nil
 750   "Functions to be called to finalize the export/publishing options.
 751 All these options are stored in a property list, and each of the functions
 752 in this hook gets a chance to modify this property list.  Each function
 753 must accept the property list as an argument, and must return the (possibly
 754 modified) list.")
 755
 756 ;; FIXME: should we fold case here?
 757
 758 (defun org-infile-export-plist ()
 759   "Return the property list with file-local settings for export."
 760   (save-excursion
 761     (save-restriction
 762       (widen)
 763       (goto-char (point-min))
 764       (let ((re (org-make-options-regexp
 765                  (append
 766                   '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
 767                     "MATHJAX"
 768                     "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
 769                     "LATEX_HEADER" "LATEX_CLASS" "LATEX_CLASS_OPTIONS"
 770                     "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
 771                     "KEYWORDS" "DESCRIPTION" "MACRO" "BIND" "XSLT")
 772                   (mapcar 'car org-export-inbuffer-options-extra))))
 773             (case-fold-search t)
 774             p key val text options mathjax a pr style
 775             latex-header latex-class latex-class-options macros letbind
 776             ext-setup-or-nil setup-file setup-dir setup-contents (start 0))
 777         (while (or (and ext-setup-or-nil
 778                         (string-match re ext-setup-or-nil start)
 779                         (setq start (match-end 0)))
 780                    (and (setq ext-setup-or-nil nil start 0)
 781                         (re-search-forward re nil t)))
 782           (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
 783                 val (org-match-string-no-properties 2 ext-setup-or-nil))
 784           (cond
 785            ((setq a (assoc key org-export-inbuffer-options-extra))
 786             (setq pr (nth 1 a))
 787             (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
 788            ((string-equal key "TITLE") (setq p (plist-put p :title val)))
 789            ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
 790            ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
 791            ((string-equal key "DATE")
 792             ;; If date is an Org timestamp, convert it to a time
 793             ;; string using `org-export-date-timestamp-format'
 794             (when (string-match org-ts-regexp3 val)
 795               (setq val (format-time-string
 796                          org-export-date-timestamp-format
 797                          (apply 'encode-time (org-parse-time-string
 798                                               (match-string 0 val))))))
 799             (setq p (plist-put p :date val)))
 800            ((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
 801            ((string-equal key "DESCRIPTION")
 802             (setq p (plist-put p :description val)))
 803            ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
 804            ((string-equal key "STYLE")
 805             (setq style (concat style "\n" val)))
 806            ((string-equal key "LATEX_HEADER")
 807             (setq latex-header (concat latex-header "\n" val)))
 808            ((string-equal key "LATEX_CLASS")
 809             (setq latex-class val))
 810            ((string-equal key "LATEX_CLASS_OPTIONS")
 811             (setq latex-class-options val))
 812            ((string-equal key "TEXT")
 813             (setq text (if text (concat text "\n" val) val)))
 814            ((string-equal key "OPTIONS")
 815             (setq options (concat val " " options)))
 816            ((string-equal key "MATHJAX")
 817             (setq mathjax (concat val " " mathjax)))
 818            ((string-equal key "BIND")
 819             (push (read (concat "(" val ")")) letbind))
 820            ((string-equal key "XSLT")
 821             (setq p (plist-put p :xslt val)))
 822            ((string-equal key "LINK_UP")
 823             (setq p (plist-put p :link-up val)))
 824            ((string-equal key "LINK_HOME")
 825             (setq p (plist-put p :link-home val)))
 826            ((string-equal key "EXPORT_SELECT_TAGS")
 827             (setq p (plist-put p :select-tags (org-split-string val))))
 828            ((string-equal key "EXPORT_EXCLUDE_TAGS")
 829             (setq p (plist-put p :exclude-tags (org-split-string val))))
 830            ((string-equal key "MACRO")
 831             (push val macros))
 832            ((equal key "SETUPFILE")
 833             (setq setup-file (org-remove-double-quotes (org-trim val))
 834                   ;; take care of recursive inclusion of setupfiles
 835                   setup-file (if (or (file-name-absolute-p val) (not setup-dir))
 836                                  (expand-file-name setup-file)
 837                                (let ((default-directory setup-dir))
 838                                  (expand-file-name setup-file))))
 839             (setq setup-dir (file-name-directory setup-file))
 840             (setq setup-contents (org-file-contents setup-file 'noerror))
 841             (if (not ext-setup-or-nil)
 842                 (setq ext-setup-or-nil setup-contents start 0)
 843               (setq ext-setup-or-nil
 844                     (concat (substring ext-setup-or-nil 0 start)
 845                             "\n" setup-contents "\n"
 846                             (substring ext-setup-or-nil start)))))))
 847         (setq p (plist-put p :text text))
 848         (when (and letbind (org-export-confirm-letbind))
 849           (setq p (plist-put p :let-bind letbind)))
 850         (when style (setq p (plist-put p :style-extra style)))
 851         (when latex-header
 852           (setq p (plist-put p :latex-header-extra (substring latex-header 1))))
 853         (when latex-class
 854           (setq p (plist-put p :latex-class latex-class)))
 855         (when latex-class-options
 856           (setq p (plist-put p :latex-class-options latex-class-options)))
 857         (when options
 858           (setq p (org-export-add-options-to-plist p options)))
 859         (when mathjax
 860           (setq p (plist-put p :mathjax mathjax)))
 861         ;; Add macro definitions
 862         (setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
 863         (setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
 864         (setq p (plist-put p :macro-property "(eval (org-entry-get nil \"$1\" 'selective))"))
 865         (setq p (plist-put
 866                  p :macro-modification-time
 867                  (and (buffer-file-name)
 868                       (file-exists-p (buffer-file-name))
 869                       (concat
 870                        "(eval (format-time-string \"$1\" '"
 871                        (prin1-to-string (nth 5 (file-attributes
 872                                                 (buffer-file-name))))
 873                        "))"))))
 874         (setq p (plist-put p :macro-input-file (and (buffer-file-name)
 875                                                     (file-name-nondirectory
 876                                                      (buffer-file-name)))))
 877         (while (setq val (pop macros))
 878           (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
 879             (setq p (plist-put
 880                      p (intern
 881                         (concat ":macro-" (downcase (match-string 1 val))))
 882                      (org-export-interpolate-newlines (match-string 2 val))))))
 883         p))))
 884
 885 (defun org-export-interpolate-newlines (s)
 886   (while (string-match "\\\\n" s)
 887     (setq s (replace-match "\n" t t s)))
 888   s)
 889
 890 (defvar org-export-allow-BIND-local nil)
 891 (defun org-export-confirm-letbind ()
 892   "Can we use #+BIND values during export?
 893 By default this will ask for confirmation by the user, to divert possible
 894 security risks."
 895   (cond
 896    ((not org-export-allow-BIND) nil)
 897    ((eq org-export-allow-BIND t) t)
 898    ((local-variable-p 'org-export-allow-BIND-local (current-buffer))
 899     org-export-allow-BIND-local)
 900    (t (org-set-local 'org-export-allow-BIND-local
 901                      (yes-or-no-p "Allow BIND values in this buffer? ")))))
 902
 903 (defun org-install-letbind ()
 904   "Install the values from #+BIND lines as local variables."
 905   (let ((letbind (plist-get org-export-opt-plist :let-bind))
 906         pair)
 907     (while (setq pair (pop letbind))
 908       (org-set-local (car pair) (nth 1 pair)))))
 909
 910 (defun org-export-add-options-to-plist (p options)
 911   "Parse an OPTIONS line and set values in the property list P."
 912   (let (o)
 913     (when options
 914       (let ((op org-export-plist-vars))
 915         (while (setq o (pop op))
 916           (if (and (nth 1 o)
 917                    (string-match (concat "\\(\\`\\|[ \t]\\)"
 918                                          (regexp-quote (nth 1 o))
 919                                          ":\\(([^)\n]+)\\|[^ \t\n\r;,.]*\\)")
 920                                  options))
 921               (setq p (plist-put p (car o)
 922                                  (car (read-from-string
 923                                        (match-string 2 options))))))))))
 924   p)
 925
 926 (defun org-export-add-subtree-options (p pos)
 927   "Add options in subtree at position POS to property list P."
 928   (save-excursion
 929     (goto-char pos)
 930     (when (org-at-heading-p)
 931       (let (a)
 932         ;; This is actually read in `org-export-get-title-from-subtree'
 933         ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
 934         ;;   (setq p (plist-put p :title a)))
 935         (when (setq a (org-entry-get pos "EXPORT_TEXT"))
 936           (setq p (plist-put p :text a)))
 937         (when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
 938           (setq p (plist-put p :author a)))
 939         (when (setq a (org-entry-get pos "EXPORT_DATE"))
 940           (setq p (plist-put p :date a)))
 941         (when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
 942           (setq p (org-export-add-options-to-plist p a)))))
 943     p))
 944
 945 (defun org-export-directory (type plist)
 946   (let* ((val (plist-get plist :publishing-directory))
 947          (dir (if (listp val)
 948                   (or (cdr (assoc type val)) ".")
 949                 val)))
 950     dir))
 951
 952 (defun org-export-process-option-filters (plist)
 953   (let ((functions org-export-options-filters) f)
 954     (while (setq f (pop functions))
 955       (setq plist (funcall f plist))))
 956   plist)
 957
 958 ;;;###autoload
 959 (defun org-export (&optional arg)
 960   "Export dispatcher for Org-mode.
 961 When `org-export-run-in-background' is non-nil, try to run the command
 962 in the background.  This will be done only for commands that write
 963 to a file.  For details see the docstring of `org-export-run-in-background'.
 964
 965 The prefix argument ARG will be passed to the exporter.  However, if
 966 ARG is a double universal prefix \\[universal-argument] \\[universal-argument], \
 967 that means to inverse the
 968 value of `org-export-run-in-background'.
 969
 970 If `org-export-initial-scope' is set to 'subtree, try to export
 971 the current subtree, otherwise try to export the whole buffer.
 972 Pressing `1' will switch between these two options."
 973   (interactive "P")
 974   (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
 975          (subtree-p (or (org-region-active-p)
 976                         (eq org-export-initial-scope 'subtree)))
 977          (help "[t]   insert the export option template
 978 \[v]   limit export to visible part of outline tree
 979 \[1]   switch buffer/subtree export
 980 \[SPC] publish enclosing subtree (with LaTeX_CLASS or EXPORT_FILE_NAME prop)
 981
 982 \[a/n/u] export as ASCII/Latin-1/UTF-8         [A/N/U] to temporary buffer
 983
 984 \[h] export as HTML      [H] to temporary buffer   [R] export region
 985 \[b] export as HTML and open in browser
 986
 987 \[l] export as LaTeX     [L] to temporary buffer
 988 \[p] export as LaTeX and process to PDF            [d] ... and open PDF file
 989
 990 \[D] export as DocBook   [V] export as DocBook, process to PDF, and open
 991
 992 \[o] export as OpenDocument Text                   [O] ... and open
 993
 994 \[j] export as TaskJuggler                         [J] ... and open
 995
 996 \[m] export as Freemind mind map
 997 \[x] export as XOXO
 998 \[g] export using Wes Hardaker's generic exporter
 999
1000 \[i] export current file as iCalendar file
1001 \[I] export all agenda files as iCalendar files   [c] ...as one combined file
1002
1003 \[F] publish current file          [P] publish current project
1004 \[X] publish a project...          [E] publish every projects")
1005          (cmds
1006           '((?t org-insert-export-options-template nil)
1007             (?v org-export-visible nil)
1008             (?a org-export-as-ascii t)
1009             (?A org-export-as-ascii-to-buffer t)
1010             (?n org-export-as-latin1 t)
1011             (?N org-export-as-latin1-to-buffer t)
1012             (?u org-export-as-utf8 t)
1013             (?U org-export-as-utf8-to-buffer t)
1014             (?h org-export-as-html t)
1015             (?b org-export-as-html-and-open t)
1016             (?H org-export-as-html-to-buffer nil)
1017             (?R org-export-region-as-html nil)
1018             (?x org-export-as-xoxo t)
1019             (?g org-export-generic t)
1020             (?D org-export-as-docbook t)
1021             (?V org-export-as-docbook-pdf-and-open t)
1022             (?o org-export-as-odt t)
1023             (?O org-export-as-odt-and-open t)
1024             (?j org-export-as-taskjuggler t)
1025             (?J org-export-as-taskjuggler-and-open t)
1026             (?m org-export-as-freemind t)
1027             (?l org-export-as-latex t)
1028             (?p org-export-as-pdf t)
1029             (?d org-export-as-pdf-and-open t)
1030             (?L org-export-as-latex-to-buffer nil)
1031             (?i org-export-icalendar-this-file t)
1032             (?I org-export-icalendar-all-agenda-files t)
1033             (?c org-export-icalendar-combine-agenda-files t)
1034             (?F org-publish-current-file t)
1035             (?P org-publish-current-project t)
1036             (?X org-publish t)
1037             (?E org-publish-all t)))
1038          r1 r2 ass
1039          (cpos (point)) (cbuf (current-buffer)) bpos)
1040     (save-excursion
1041       (save-window-excursion
1042         (if subtree-p
1043             (message "Export subtree: ")
1044           (message "Export buffer: "))
1045         (delete-other-windows)
1046         (with-output-to-temp-buffer "*Org Export/Publishing Help*"
1047           (princ help))
1048         (org-fit-window-to-buffer (get-buffer-window
1049                                    "*Org Export/Publishing Help*"))
1050         (while (eq (setq r1 (read-char-exclusive)) ?1)
1051           (cond (subtree-p
1052                  (setq subtree-p nil)
1053                  (message "Export buffer: "))
1054                 ((not subtree-p)
1055                  (setq subtree-p t)
1056                  (setq bpos (point))
1057                  (message "Export subtree: "))))
1058         (when (eq r1 ?\ )
1059           (let ((case-fold-search t)
1060                 (end (save-excursion (while (org-up-heading-safe)) (point))))
1061             (outline-next-heading)
1062             (if (re-search-backward
1063                  "^[ \t]+\\(:latex_class:\\|:export_title:\\|:export_file_name:\\)[ \t]+\\S-"
1064                  end t)
1065                 (progn
1066                   (org-back-to-heading t)
1067                   (setq subtree-p t)
1068                   (setq bpos (point))
1069                   (message "Select command (for subtree): ")
1070                   (setq r1 (read-char-exclusive)))
1071               (error "No enclosing node with LaTeX_CLASS or EXPORT_TITLE or EXPORT_FILE_NAME")
1072               )))))
1073     (if (fboundp 'redisplay) (redisplay)) ;; XEmacs does not have/need (redisplay)
1074     (and bpos (goto-char bpos))
1075     (setq r2 (if (< r1 27) (+ r1 96) r1))
1076     (unless (setq ass (assq r2 cmds))
1077       (error "No command associated with key %c" r1))
1078     (if (and bg (nth 2 ass)
1079              (not (buffer-base-buffer))
1080              (not (org-region-active-p)))
1081         ;; execute in background
1082         (let ((p (start-process
1083                   (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
1084                   "*Org Processes*"
1085                   (expand-file-name invocation-name invocation-directory)
1086                   "-batch"
1087                   "-l" user-init-file
1088                   "--eval" "(require 'org-exp)"
1089                   "--eval" "(setq org-wait .2)"
1090                   (buffer-file-name)
1091                   "-f" (symbol-name (nth 1 ass)))))
1092           (set-process-sentinel p 'org-export-process-sentinel)
1093           (message "Background process \"%s\": started" p))
1094       ;; background processing not requested, or not possible
1095       (if subtree-p (progn (org-mark-subtree) (org-activate-mark)))
1096       (call-interactively (nth 1 ass))
1097       (when (and bpos (get-buffer-window cbuf))
1098         (let ((cw (selected-window)))
1099           (select-window (get-buffer-window cbuf))
1100           (goto-char cpos)
1101           (deactivate-mark)
1102           (select-window cw))))))
1103
1104 (defun org-export-process-sentinel (process status)
1105   (if (string-match "\n+\\'" status)
1106       (setq status (substring status 0 -1)))
1107   (message "Background process \"%s\": %s" process status))
1108
1109 ;;; General functions for all backends
1110
1111 (defvar org-export-target-aliases nil
1112   "Alist of targets with invisible aliases.")
1113 (defvar org-export-preferred-target-alist nil
1114   "Alist of section id's with preferred aliases.")
1115 (defvar org-export-id-target-alist nil
1116   "Alist of section id's with preferred aliases.")
1117 (defvar org-export-code-refs nil
1118   "Alist of code references and line numbers.")
1119
1120 (defun org-export-preprocess-string (string &rest parameters)
1121   "Cleanup STRING so that the true exported has a more consistent source.
1122 This function takes STRING, which should be a buffer-string of an org-file
1123 to export.  It then creates a temporary buffer where it does its job.
1124 The result is then again returned as a string, and the exporter works
1125 on this string to produce the exported version."
1126   (interactive)
1127   (let* ((org-export-current-backend (or (plist-get parameters :for-backend)
1128                                          org-export-current-backend))
1129          (archived-trees (plist-get parameters :archived-trees))
1130          (inhibit-read-only t)
1131          (drawers org-drawers)
1132          (source-buffer (current-buffer))
1133          target-alist rtn)
1134
1135     (setq org-export-target-aliases nil
1136           org-export-preferred-target-alist nil
1137           org-export-id-target-alist nil
1138           org-export-code-refs nil)
1139
1140     (with-temp-buffer
1141       (erase-buffer)
1142       (insert string)
1143       (setq case-fold-search t)
1144
1145       (let ((inhibit-read-only t))
1146         (remove-text-properties (point-min) (point-max)
1147                                 '(read-only t)))
1148
1149       ;; Remove license-to-kill stuff
1150       ;; The caller marks some stuff for killing, stuff that has been
1151       ;; used to create the page title, for example.
1152       (org-export-kill-licensed-text)
1153
1154       (let ((org-inhibit-startup t)) (org-mode))
1155       (setq case-fold-search t)
1156       (org-clone-local-variables source-buffer "^\\(org-\\|orgtbl-\\)")
1157       (org-install-letbind)
1158
1159       ;; Call the hook
1160       (run-hooks 'org-export-preprocess-hook)
1161
1162       (untabify (point-min) (point-max))
1163
1164       ;; Handle include files, and call a hook
1165       (org-export-handle-include-files-recurse)
1166       (run-hooks 'org-export-preprocess-after-include-files-hook)
1167
1168       ;; Get rid of archived trees
1169       (org-export-remove-archived-trees archived-trees)
1170
1171       ;; Remove comment environment and comment subtrees
1172       (org-export-remove-comment-blocks-and-subtrees)
1173
1174       ;; Get rid of excluded trees, and call a hook
1175       (org-export-handle-export-tags (plist-get parameters :select-tags)
1176                                      (plist-get parameters :exclude-tags))
1177       (run-hooks 'org-export-preprocess-after-tree-selection-hook)
1178
1179       ;; Get rid of tasks, depending on configuration
1180       (org-export-remove-tasks (plist-get parameters :tasks))
1181
1182       ;; Prepare footnotes for export.  During that process, footnotes
1183       ;; actually included in the exported part of the buffer go
1184       ;; though some transformations:
1185
1186       ;; 1. They have their label normalized (like "[N]");
1187
1188       ;; 2. They get moved at the same place in the buffer (usually at
1189       ;;    its end, but backends may define another place via
1190       ;;    `org-footnote-insert-pos-for-preprocessor');
1191
1192       ;; 3. The are stored in `org-export-footnotes-seen', while
1193       ;;    `org-export-preprocess-string' is applied to their
1194       ;;    definition.
1195
1196       ;; Line-wise exporters ignore `org-export-footnotes-seen', as
1197       ;; they interpret footnotes at the moment they see them in the
1198       ;; buffer.  Context-wise exporters grab all the info needed in
1199       ;; that variable and delete moved definitions (as described in
1200       ;; 2nd step).
1201       (when (plist-get parameters :footnotes)
1202         (org-footnote-normalize nil parameters))
1203
1204       ;; Change lists ending.  Other parts of export may insert blank
1205       ;; lines and lists' structure could be altered.
1206       (org-export-mark-list-end)
1207
1208       ;; Process the macros
1209       (org-export-preprocess-apply-macros)
1210       (run-hooks 'org-export-preprocess-after-macros-hook)
1211
1212       ;; Export code blocks
1213       (org-export-blocks-preprocess)
1214
1215       ;; Mark lists with properties
1216       (org-export-mark-list-properties)
1217
1218       ;; Handle source code snippets
1219       (org-export-replace-src-segments-and-examples)
1220
1221       ;; Protect short examples marked by a leading colon
1222       (org-export-protect-colon-examples)
1223
1224       ;; Protected spaces
1225       (org-export-convert-protected-spaces)
1226
1227       ;; Find all headings and compute the targets for them
1228       (setq target-alist (org-export-define-heading-targets target-alist))
1229
1230       (run-hooks 'org-export-preprocess-after-headline-targets-hook)
1231
1232       ;; Find HTML special classes for headlines
1233       (org-export-remember-html-container-classes)
1234
1235       ;; Get rid of drawers
1236       (org-export-remove-or-extract-drawers
1237        drawers (plist-get parameters :drawers))
1238
1239       ;; Get the correct stuff before the first headline
1240       (when (plist-get parameters :skip-before-1st-heading)
1241         (goto-char (point-min))
1242         (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t)
1243           (delete-region (point-min) (match-beginning 0))
1244           (goto-char (point-min))
1245           (insert "\n")))
1246       (when (plist-get parameters :add-text)
1247         (goto-char (point-min))
1248         (insert (plist-get parameters :add-text) "\n"))
1249
1250       ;; Remove todo-keywords before exporting, if the user has requested so
1251       (org-export-remove-headline-metadata parameters)
1252
1253       ;; Find targets in comments and move them out of comments,
1254       ;; but mark them as targets that should be invisible
1255       (setq target-alist (org-export-handle-invisible-targets target-alist))
1256
1257       ;; Select and protect backend specific stuff, throw away stuff
1258       ;; that is specific for other backends
1259       (run-hooks 'org-export-preprocess-before-selecting-backend-code-hook)
1260       (org-export-select-backend-specific-text)
1261
1262       ;; Protect quoted subtrees
1263       (org-export-protect-quoted-subtrees)
1264
1265       ;; Remove clock lines
1266       (org-export-remove-clock-lines)
1267
1268       ;; Protect verbatim elements
1269       (org-export-protect-verbatim)
1270
1271       ;; Blockquotes, verse, and center
1272       (org-export-mark-blockquote-verse-center)
1273       (run-hooks 'org-export-preprocess-after-blockquote-hook)
1274
1275       ;; Remove timestamps, if the user has requested so
1276       (unless (plist-get parameters :timestamps)
1277         (org-export-remove-timestamps))
1278
1279       ;; Attach captions to the correct object
1280       (setq target-alist (org-export-attach-captions-and-attributes target-alist))
1281
1282       ;; Find matches for radio targets and turn them into internal links
1283       (org-export-mark-radio-links)
1284       (run-hooks 'org-export-preprocess-after-radio-targets-hook)
1285
1286       ;; Find all links that contain a newline and put them into a single line
1287       (org-export-concatenate-multiline-links)
1288
1289       ;; Normalize links: Convert angle and plain links into bracket links
1290       ;; and expand link abbreviations
1291       (run-hooks 'org-export-preprocess-before-normalizing-links-hook)
1292       (org-export-normalize-links)
1293
1294       ;; Find all internal links.  If they have a fuzzy match (i.e. not
1295       ;; a *dedicated* target match, let the link  point to the
1296       ;; corresponding section.
1297       (org-export-target-internal-links target-alist)
1298
1299       ;; Find multiline emphasis and put them into single line
1300       (when (plist-get parameters :emph-multiline)
1301         (org-export-concatenate-multiline-emphasis))
1302
1303       ;; Remove special table lines, and store alignment information
1304       (org-store-forced-table-alignment)
1305       (when org-export-table-remove-special-lines
1306         (org-export-remove-special-table-lines))
1307
1308       ;; Another hook
1309       (run-hooks 'org-export-preprocess-before-backend-specifics-hook)
1310
1311       ;; Backend-specific preprocessing
1312       (let* ((backend-name (symbol-name org-export-current-backend))
1313              (f (intern (format "org-export-%s-preprocess" backend-name))))
1314         (require (intern (concat "org-" backend-name)) nil)
1315         (funcall f parameters))
1316
1317       ;; Remove or replace comments
1318       (org-export-handle-comments (plist-get parameters :comments))
1319
1320       ;; Remove #+TBLFM #+TBLNAME #+NAME #+RESULTS lines
1321       (org-export-handle-metalines)
1322
1323       ;; Run the final hook
1324       (run-hooks 'org-export-preprocess-final-hook)
1325
1326       (setq rtn (buffer-string)))
1327     rtn))
1328
1329 (defun org-export-kill-licensed-text ()
1330   "Remove all text that is marked with a :org-license-to-kill property."
1331   (let (p)
1332     (while (setq p (text-property-any (point-min) (point-max)
1333                                       :org-license-to-kill t))
1334       (delete-region
1335        p (or (next-single-property-change p :org-license-to-kill)
1336              (point-max))))))
1337
1338 (defvar org-export-define-heading-targets-headline-hook nil
1339   "Hook that is run when a headline was matched during target search.
1340 This is part of the preprocessing for export.")
1341
1342 (defun org-export-define-heading-targets (target-alist)
1343   "Find all headings and define the targets for them.
1344 The new targets are added to TARGET-ALIST, which is also returned.
1345 Also find all ID and CUSTOM_ID properties and store them."
1346   (goto-char (point-min))
1347   (org-init-section-numbers)
1348   (let ((re (concat "^" org-outline-regexp
1349                     "\\|"
1350                     "^[ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
1351         level target last-section-target a id)
1352     (while (re-search-forward re nil t)
1353       (org-if-unprotected-at (match-beginning 0)
1354         (if (match-end 2)
1355             (progn
1356               (setq id (org-match-string-no-properties 2))
1357               (push (cons id target) target-alist)
1358               (setq a (or (assoc last-section-target org-export-target-aliases)
1359                           (progn
1360                             (push (list last-section-target)
1361                                   org-export-target-aliases)
1362                             (car org-export-target-aliases))))
1363               (push (caar target-alist) (cdr a))
1364               (when (equal (match-string 1) "CUSTOM_ID")
1365                 (if (not (assoc last-section-target
1366                                 org-export-preferred-target-alist))
1367                     (push (cons last-section-target id)
1368                           org-export-preferred-target-alist)))
1369               (when (equal (match-string 1) "ID")
1370                 (if (not (assoc last-section-target
1371                                 org-export-id-target-alist))
1372                     (push (cons last-section-target (concat "ID-" id))
1373                           org-export-id-target-alist))))
1374           (setq level (org-reduced-level
1375                        (save-excursion (goto-char (point-at-bol))
1376                                        (org-outline-level))))
1377           (setq target (org-solidify-link-text
1378                         (format "sec-%s" (replace-regexp-in-string
1379                                           "\\." "-"
1380                                           (org-section-number level)))))
1381           (setq last-section-target target)
1382           (push (cons target target) target-alist)
1383           (add-text-properties
1384            (point-at-bol) (point-at-eol)
1385            (list 'target target))
1386           (run-hooks 'org-export-define-heading-targets-headline-hook)))))
1387   target-alist)
1388
1389 (defun org-export-handle-invisible-targets (target-alist)
1390   "Find targets in comments and move them out of comments.
1391 Mark them as invisible targets."
1392   (let (target tmp a)
1393     (goto-char (point-min))
1394     (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
1395       ;; Check if the line before or after is a headline with a target
1396       (if (setq target (or (get-text-property (point-at-bol 0) 'target)
1397                            (get-text-property (point-at-bol 2) 'target)))
1398           (progn
1399             ;; use the existing target in a neighboring line
1400             (setq tmp (match-string 2))
1401             (replace-match "")
1402             (and (looking-at "\n") (delete-char 1))
1403             (push (cons (setq tmp (org-solidify-link-text tmp)) target)
1404                   target-alist)
1405             (setq a (or (assoc target org-export-target-aliases)
1406                         (progn
1407                           (push (list target) org-export-target-aliases)
1408                           (car org-export-target-aliases))))
1409             (push tmp (cdr a)))
1410         ;; Make an invisible target
1411         (replace-match "\\1(INVISIBLE)"))))
1412   target-alist)
1413
1414 (defun org-export-target-internal-links (target-alist)
1415   "Find all internal links and assign targets to them.
1416 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1417 let the link  point to the corresponding section.
1418 This function also handles the id links, if they have a match in
1419 the current file."
1420   (goto-char (point-min))
1421   (while (re-search-forward org-bracket-link-regexp nil t)
1422     (org-if-unprotected-at (1+ (match-beginning 0))
1423       (let* ((org-link-search-must-match-exact-headline t)
1424              (md (match-data))
1425              (desc (match-end 2))
1426              (link (org-link-unescape (match-string 1)))
1427              (slink (org-solidify-link-text link))
1428              found props pos cref
1429              (target
1430               (cond
1431                ((= (string-to-char link) ?#)
1432                 ;; user wants exactly this link
1433                 link)
1434                ((cdr (assoc slink target-alist))
1435                 (or (cdr (assoc (assoc slink target-alist)
1436                                 org-export-preferred-target-alist))
1437                     (cdr (assoc slink target-alist))))
1438                ((and (string-match "^id:" link)
1439                      (cdr (assoc (substring link 3) target-alist))))
1440                ((string-match "^(\\(.*\\))$" link)
1441                 (setq cref (match-string 1 link))
1442                 (concat "coderef:" cref))
1443                ((string-match org-link-types-re link) nil)
1444                ((or (file-name-absolute-p link)
1445                     (string-match "^\\." link))
1446                 nil)
1447                (t
1448                 (let ((org-link-search-inhibit-query t))
1449                   (save-excursion
1450                     (setq found (condition-case nil (org-link-search link)
1451                                   (error nil)))
1452                     (when (and found
1453                                (or (org-at-heading-p)
1454                                    (not (eq found 'dedicated))))
1455                       (or (get-text-property (point) 'target)
1456                           (get-text-property
1457                            (max (point-min)
1458                                 (1- (or (previous-single-property-change
1459                                          (point) 'target) 0)))
1460                            'target)))))))))
1461         (when target
1462           (set-match-data md)
1463           (goto-char (match-beginning 1))
1464           (setq props (text-properties-at (point)))
1465           (delete-region (match-beginning 1) (match-end 1))
1466           (setq pos (point))
1467           (insert target)
1468           (unless desc (insert "][" link))
1469           (add-text-properties pos (point) props))))))
1470
1471 (defun org-export-remember-html-container-classes ()
1472   "Store the HTML_CONTAINER_CLASS properties in a text property."
1473   (goto-char (point-min))
1474   (let (class)
1475     (while (re-search-forward
1476             "^[ \t]*:HTML_CONTAINER_CLASS:[ \t]+\\(.+\\)$" nil t)
1477       (setq class (match-string 1))
1478       (save-excursion
1479         (when (re-search-backward "^\\*" (point-min) t)
1480           (org-back-to-heading t)
1481           (put-text-property (point-at-bol) (point-at-eol)
1482                              'html-container-class class))))))
1483
1484 (defvar org-export-format-drawer-function nil
1485   "Function to be called to format the contents of a drawer.
1486 The function must accept two parameters:
1487   NAME     the drawer name, like \"PROPERTIES\"
1488   CONTENT  the content of the drawer.
1489 You can check the export backend through `org-export-current-backend'.
1490 The function should return the text to be inserted into the buffer.
1491 If this is nil, `org-export-format-drawer' is used as a default.")
1492
1493 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers)
1494   "Remove drawers, or extract and format the content.
1495 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1496 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1497 whose content to keep.  Any drawers that are in ALL-DRAWERS but not in
1498 EXP-DRAWERS will be removed."
1499   (goto-char (point-min))
1500   (let ((re (concat "^[ \t]*:\\("
1501                     (mapconcat 'identity all-drawers "\\|")
1502                     "\\):[ \t]*$"))
1503         name beg beg-content eol content)
1504     (while (re-search-forward re nil t)
1505       (org-if-unprotected
1506        (setq name (match-string 1))
1507        (setq beg (match-beginning 0)
1508              beg-content (1+ (point-at-eol))
1509              eol (point-at-eol))
1510        (if (not (and (re-search-forward
1511                       "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t)
1512                      (match-end 1)))
1513            (goto-char eol)
1514          (goto-char (match-beginning 0))
1515          (and (looking-at ".*\n?") (replace-match ""))
1516          (setq content (buffer-substring beg-content (point)))
1517          (delete-region beg (point))
1518          (when (or (eq exp-drawers t)
1519                    (member name exp-drawers))
1520            (setq content (funcall (or org-export-format-drawer-function
1521                                       'org-export-format-drawer)
1522                                   name content))
1523            (insert content)))))))
1524
1525 (defun org-export-format-drawer (name content)
1526   "Format the content of a drawer as a colon example."
1527   (if (string-match "[ \t]+\\'" content)
1528       (setq content (substring content (match-beginning 0))))
1529   (while (string-match "\\`[ \t]*\n" content)
1530     (setq content (substring content (match-end 0))))
1531   (setq content (org-remove-indentation content))
1532   (setq content (concat ": " (mapconcat 'identity
1533                                         (org-split-string content "\n")
1534                                         "\n: ")
1535                         "\n"))
1536   (setq content (concat " : " (upcase name) "\n" content))
1537   (org-add-props content nil 'org-protected t))
1538
1539 (defun org-export-handle-export-tags (select-tags exclude-tags)
1540   "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
1541 Both arguments are lists of tags.
1542 If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
1543 will be removed.
1544 After that, all subtrees that are marked by EXCLUDE-TAGS will be
1545 removed as well."
1546   (remove-text-properties (point-min) (point-max) '(:org-delete t))
1547   (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
1548                                            select-tags "\\|")
1549                          "\\):"))
1550          (re-excl (concat ":\\(" (mapconcat 'regexp-quote
1551                                             exclude-tags "\\|")
1552                           "\\):"))
1553          beg end cont)
1554     (goto-char (point-min))
1555     (when (and select-tags
1556                (re-search-forward
1557                 (concat "^\\*+[ \t].*" re-sel "[^ \t\n]*[ \t]*$") nil t))
1558       ;; At least one tree is marked for export, this means
1559       ;; all the unmarked stuff needs to go.
1560       ;; Dig out the trees that should be exported
1561       (goto-char (point-min))
1562       (outline-next-heading)
1563       (setq beg (point))
1564       (put-text-property beg (point-max) :org-delete t)
1565       (while (re-search-forward re-sel nil t)
1566         (when (org-at-heading-p)
1567           (org-back-to-heading)
1568           (remove-text-properties
1569            (max (1- (point)) (point-min))
1570            (setq cont (save-excursion (org-end-of-subtree t t)))
1571            '(:org-delete t))
1572           (while (and (org-up-heading-safe)
1573                       (get-text-property (point) :org-delete))
1574             (remove-text-properties (max (1- (point)) (point-min))
1575                                     (point-at-eol) '(:org-delete t)))
1576           (goto-char cont))))
1577     ;; Remove the trees explicitly marked for noexport
1578     (when exclude-tags
1579       (goto-char (point-min))
1580       (while (re-search-forward re-excl nil t)
1581         (when (org-at-heading-p)
1582           (org-back-to-heading t)
1583           (setq beg (point))
1584           (org-end-of-subtree t t)
1585           (delete-region beg (point))
1586           (when (featurep 'org-inlinetask)
1587             (org-inlinetask-remove-END-maybe)))))
1588     ;; Remove everything that is now still marked for deletion
1589     (goto-char (point-min))
1590     (while (setq beg (text-property-any (point-min) (point-max) :org-delete t))
1591       (setq end (or (next-single-property-change beg :org-delete)
1592                     (point-max)))
1593       (delete-region beg end))))
1594
1595 (defun org-export-remove-tasks (keep)
1596   "Remove tasks depending on configuration.
1597 When KEEP is nil, remove all tasks.
1598 When KEEP is `todo', remove the tasks that are DONE.
1599 When KEEP is `done', remove the tasks that are not yet done.
1600 When it is a list of strings, keep only tasks with these TODO keywords."
1601   (when (or (listp keep) (memq keep '(todo done nil)))
1602     (let ((re (concat "^\\*+[ \t]+\\("
1603                       (mapconcat
1604                        'regexp-quote
1605                        (cond ((not keep) org-todo-keywords-1)
1606                              ((eq keep 'todo) org-done-keywords)
1607                              ((eq keep 'done) org-not-done-keywords)
1608                              ((listp keep)
1609                               (org-delete-all keep (copy-sequence
1610                                                     org-todo-keywords-1))))
1611                        "\\|")
1612                       "\\)\\($\\|[ \t]\\)"))
1613           (case-fold-search nil)
1614           beg)
1615       (goto-char (point-min))
1616       (while (re-search-forward re nil t)
1617         (org-if-unprotected
1618          (setq beg (match-beginning 0))
1619          (org-end-of-subtree t t)
1620          (if (looking-at "^\\*+[ \t]+END[ \t]*$")
1621              ;; Kill the END line of the inline task
1622              (goto-char (min (point-max) (1+ (match-end 0)))))
1623          (delete-region beg (point)))))))
1624
1625 (defun org-export-remove-archived-trees (export-archived-trees)
1626   "Remove archived trees.
1627 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1628 When it is t, the entire archived tree will be exported.
1629 When it is nil the entire tree including the headline will be removed
1630 from the buffer."
1631   (let ((re-archive (concat ":" org-archive-tag ":"))
1632         a b)
1633     (when (not (eq export-archived-trees t))
1634       (goto-char (point-min))
1635       (while (re-search-forward re-archive nil t)
1636         (if (not (org-at-heading-p t))
1637             (goto-char (point-at-eol))
1638           (beginning-of-line 1)
1639           (setq a (if export-archived-trees
1640                       (1+ (point-at-eol)) (point))
1641                 b (org-end-of-subtree t))
1642           (if (> b a) (delete-region a b)))))))
1643
1644 (defun org-export-remove-headline-metadata (opts)
1645   "Remove meta data from the headline, according to user options."
1646   (let ((re org-complex-heading-regexp)
1647         (todo (plist-get opts :todo-keywords))
1648         (tags (plist-get opts :tags))
1649         (pri  (plist-get opts :priority))
1650         (elts '(1 2 3 4 5))
1651         (case-fold-search nil)
1652         rpl)
1653     (setq elts (delq nil (list 1 (if todo 2) (if pri 3) 4 (if tags 5))))
1654     (when (or (not todo) (not tags) (not pri))
1655       (goto-char (point-min))
1656       (while (re-search-forward re nil t)
1657         (org-if-unprotected
1658          (setq rpl (mapconcat (lambda (i) (if (match-end i) (match-string i) ""))
1659                               elts " "))
1660          (replace-match rpl t t))))))
1661
1662 (defun org-export-remove-timestamps ()
1663   "Remove timestamps and keywords for export."
1664   (goto-char (point-min))
1665   (while (re-search-forward org-maybe-keyword-time-regexp nil t)
1666     (backward-char 1)
1667     (org-if-unprotected
1668      (unless (save-match-data (org-at-table-p))
1669        (replace-match "")
1670        (beginning-of-line 1)
1671        (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
1672            (replace-match ""))))))
1673
1674 (defun org-export-remove-clock-lines ()
1675   "Remove clock lines for export."
1676   (goto-char (point-min))
1677   (let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
1678     (while (re-search-forward re nil t)
1679       (org-if-unprotected
1680        (replace-match "")))))
1681
1682 (defvar org-heading-keyword-regexp-format) ; defined in org.el
1683 (defun org-export-protect-quoted-subtrees ()
1684   "Mark quoted subtrees with the protection property."
1685   (let ((org-re-quote (format org-heading-keyword-regexp-format
1686                               org-quote-string)))
1687     (goto-char (point-min))
1688     (while (re-search-forward org-re-quote nil t)
1689       (goto-char (match-beginning 0))
1690       (end-of-line 1)
1691       (add-text-properties (point) (org-end-of-subtree t)
1692                            '(org-protected t)))))
1693
1694 (defun org-export-convert-protected-spaces ()
1695   "Convert strings like \\____ to protected spaces in all backends."
1696   (goto-char (point-min))
1697   (while (re-search-forward "\\\\__+" nil t)
1698     (org-if-unprotected-1
1699      (replace-match
1700       (org-add-props
1701           (cond
1702            ((eq org-export-current-backend 'latex)
1703             (format "\\hspace{%dex}" (- (match-end 0) (match-beginning 0))))
1704            ((eq org-export-current-backend 'html)
1705             (org-add-props (match-string 0) nil
1706               'org-whitespace (- (match-end 0) (match-beginning 0))))
1707            ;; ((eq org-export-current-backend 'docbook))
1708            ((eq org-export-current-backend 'ascii)
1709             (org-add-props (match-string 0) '(org-whitespace t)))
1710            (t (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
1711           '(org-protected t))
1712       t t))))
1713
1714 (defun org-export-protect-verbatim ()
1715   "Mark verbatim snippets with the protection property."
1716   (goto-char (point-min))
1717   (while (re-search-forward org-verbatim-re nil t)
1718     (org-if-unprotected
1719      (add-text-properties (match-beginning 4) (match-end 4)
1720                           '(org-protected t org-verbatim-emph t))
1721      (goto-char (1+ (match-end 4))))))
1722
1723 (defun org-export-protect-colon-examples ()
1724   "Protect lines starting with a colon."
1725   (goto-char (point-min))
1726   (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg)
1727     (while (re-search-forward re nil t)
1728       (beginning-of-line 1)
1729       (setq beg (point))
1730       (while (looking-at re)
1731         (end-of-line 1)
1732         (or (eobp) (forward-char 1)))
1733       (add-text-properties beg (if (bolp) (1- (point)) (point))
1734                            '(org-protected t)))))
1735
1736 (defvar org-export-backends
1737   '(docbook html beamer ascii latex)
1738   "List of Org supported export backends.")
1739
1740 (defun org-export-select-backend-specific-text ()
1741   (let ((formatters org-export-backends)
1742         (case-fold-search t)
1743         backend backend-name beg beg-content end end-content ind)
1744
1745     (while formatters
1746       (setq backend (pop formatters)
1747             backend-name (symbol-name backend))
1748
1749       ;; Handle #+BACKEND: stuff
1750       (goto-char (point-min))
1751       (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" backend-name
1752                                         ":[ \t]*\\(.*\\)") nil t)
1753         (if (not (eq backend org-export-current-backend))
1754             (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
1755           (let ((ind (get-text-property (point-at-bol) 'original-indentation)))
1756             (replace-match "\\1\\2" t)
1757             (add-text-properties
1758              (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1759              `(org-protected t original-indentation ,ind org-native-text t)))))
1760       ;; Delete #+ATTR_BACKEND: stuff of another backend.  Those
1761       ;; matching the current backend will be taken care of by
1762       ;; `org-export-attach-captions-and-attributes'
1763       (goto-char (point-min))
1764       (while (re-search-forward (concat "^\\([ \t]*\\)#\\+ATTR_" backend-name
1765                                         ":[ \t]*\\(.*\\)") nil t)
1766         (setq ind (org-get-indentation))
1767         (when (not (eq backend org-export-current-backend))
1768           (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1769       ;; Handle #+BEGIN_BACKEND and #+END_BACKEND stuff
1770       (goto-char (point-min))
1771       (while (re-search-forward (concat "^[ \t]*#\\+BEGIN_" backend-name "\\>.*\n?")
1772                                 nil t)
1773         (setq beg (match-beginning 0) beg-content (match-end 0))
1774         (setq ind (or (get-text-property beg 'original-indentation)
1775                       (save-excursion (goto-char beg) (org-get-indentation))))
1776         (when (re-search-forward (concat "^[ \t]*#\\+END_" backend-name "\\>.*\n?")
1777                                  nil t)
1778           (setq end (match-end 0) end-content (match-beginning 0))
1779           (if (eq backend org-export-current-backend)
1780               ;; yes, keep this
1781               (progn
1782                 (add-text-properties
1783                  beg-content end-content
1784                  `(org-protected t original-indentation ,ind org-native-text t))
1785                 ;; strip protective commas
1786                 (org-strip-protective-commas beg-content end-content)
1787                 (delete-region (match-beginning 0) (match-end 0))
1788                 (save-excursion
1789                   (goto-char beg)
1790                   (delete-region (point) (1+ (point-at-eol)))))
1791             ;; No, this is for a different backend, kill it
1792             (delete-region beg end)))))))
1793
1794 (defun org-export-mark-blockquote-verse-center ()
1795   "Mark block quote and verse environments with special cookies.
1796 These special cookies will later be interpreted by the backend."
1797   ;; Blockquotes
1798   (let (type t1 ind beg end beg1 end1 content)
1799     (goto-char (point-min))
1800     (while (re-search-forward
1801             "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
1802             nil t)
1803       (setq ind (length (match-string 1))
1804             type (downcase (match-string 3))
1805             t1 (if (equal type "quote") "blockquote" type))
1806       (setq beg (match-beginning 0)
1807             beg1 (1+ (match-end 0)))
1808       (when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
1809         (setq end1 (1- (match-beginning 0))
1810               end (+ (point-at-eol) (if (looking-at "\n$") 1 0)))
1811         (setq content (org-remove-indentation (buffer-substring beg1 end1)))
1812         (setq content (concat "ORG-" (upcase t1) "-START\n"
1813                               content "\n"
1814                               "ORG-" (upcase t1) "-END\n"))
1815         (delete-region beg end)
1816         (insert (org-add-props content nil 'original-indentation ind))))))
1817
1818 (defun org-export-mark-list-end ()
1819   "Mark all list endings with a special string."
1820   (unless (eq org-export-current-backend 'ascii)
1821     (mapc
1822      (lambda (e)
1823        ;; For each type allowing list export, find every list, remove
1824        ;; ending regexp if needed, and insert org-list-end.
1825        (goto-char (point-min))
1826        (while (re-search-forward (org-item-beginning-re) nil t)
1827          (when (eq (nth 2 (org-list-context)) e)
1828            (let* ((struct (org-list-struct))
1829                   (bottom (org-list-get-bottom-point struct))
1830                   (top (point-at-bol))
1831                   (top-ind (org-list-get-ind top struct)))
1832              (goto-char bottom)
1833              (when (and (not (looking-at "[ \t]*$"))
1834                         (looking-at org-list-end-re))
1835                (replace-match ""))
1836              (unless (bolp) (insert "\n"))
1837              ;; As org-list-end is inserted at column 0, it would end
1838              ;; by indentation any list.  It can be problematic when
1839              ;; there are lists within lists: the inner list end would
1840              ;; also become the outer list end.  To avoid this, text
1841              ;; property `original-indentation' is added, as
1842              ;; `org-list-struct' pays attention to it when reading a
1843              ;; list.
1844              (insert (org-add-props
1845                          "ORG-LIST-END-MARKER\n"
1846                          (list 'original-indentation top-ind)))))))
1847      (cons nil org-list-export-context))))
1848
1849 (defun org-export-mark-list-properties ()
1850   "Mark list with special properties.
1851 These special properties will later be interpreted by the backend."
1852   (let ((mark-list
1853          (function
1854           ;; Mark a list with 3 properties: `list-item' which is
1855           ;; position at beginning of line, `list-struct' which is
1856           ;; list structure, and `list-prevs' which is the alist of
1857           ;; item and its predecessor.  Leave point at list ending.
1858           (lambda (ctxt)
1859             (let* ((struct (org-list-struct))
1860                    (top (org-list-get-top-point struct))
1861                    (bottom (org-list-get-bottom-point struct))
1862                    (prevs (org-list-prevs-alist struct))
1863                    poi)
1864               ;; Get every item and ending position, without dups and
1865               ;; without bottom point of list.
1866               (mapc (lambda (e)
1867                       (let ((pos (car e))
1868                             (end (nth 6 e)))
1869                         (unless (memq pos poi)
1870                           (push pos poi))
1871                         (unless (or (= end bottom) (memq end poi))
1872                           (push end poi))))
1873                     struct)
1874               (setq poi (sort poi '<))
1875               ;; For every point of interest, mark the whole line with
1876               ;; its position in list.
1877               (mapc
1878                (lambda (e)
1879                  (goto-char e)
1880                  (add-text-properties (point-at-bol) (point-at-eol)
1881                                       (list 'list-item (point-at-bol)
1882                                             'list-struct struct
1883                                             'list-prevs prevs)))
1884                poi)
1885               ;; Take care of bottom point.  As babel may have inserted
1886               ;; a new list in buffer, list ending isn't always
1887               ;; marked.  Now mark every list ending and add properties
1888               ;; useful to line processing exporters.
1889               (goto-char bottom)
1890               (when (or (looking-at "^ORG-LIST-END-MARKER\n")
1891                         (and (not (looking-at "[ \t]*$"))
1892                              (looking-at org-list-end-re)))
1893                 (replace-match ""))
1894               (unless (bolp) (insert "\n"))
1895               (insert
1896                (org-add-props "ORG-LIST-END-MARKER\n" (list 'list-item bottom
1897                                                             'list-struct struct
1898                                                             'list-prevs prevs)))
1899               ;; Following property is used by LaTeX exporter.
1900               (add-text-properties top (point) (list 'list-context ctxt)))))))
1901     ;; Mark lists except for backends not interpreting them.
1902     (unless (eq org-export-current-backend 'ascii)
1903       (let ((org-list-end-re "^ORG-LIST-END-MARKER\n"))
1904         (mapc
1905          (lambda (e)
1906            (goto-char (point-min))
1907            (while (re-search-forward (org-item-beginning-re) nil t)
1908              (let ((context (nth 2 (org-list-context))))
1909                (if (eq context e)
1910                    (funcall mark-list e)
1911                  (put-text-property (point-at-bol) (point-at-eol)
1912                                     'list-context context)))))
1913          (cons nil org-list-export-context))))))
1914
1915 (defun org-export-attach-captions-and-attributes (target-alist)
1916   "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
1917 If the next thing following is a table, add the text properties to the first
1918 table line.  If it is a link, add it to the line containing the link."
1919   (goto-char (point-min))
1920   (remove-text-properties (point-min) (point-max)
1921                           '(org-caption nil org-attributes nil))
1922   (let ((case-fold-search t)
1923         (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
1924                     "\\|"
1925                     "^[ \t]*#\\+attr_" (symbol-name org-export-current-backend) ":[ \t]+\\(.*\\)"
1926                     "\\|"
1927                     "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
1928                     "\\|"
1929                     "^[ \t]*\\(|[^-]\\)"
1930                     "\\|"
1931                     "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
1932         cap shortn attr label end)
1933     (while (re-search-forward re nil t)
1934       (cond
1935        ;; there is a caption
1936        ((match-end 1)
1937         (progn
1938           (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
1939           (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
1940             (setq shortn (match-string 1 cap)
1941                   cap (match-string 2 cap)))
1942           (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1943        ;; there is an attribute
1944        ((match-end 2)
1945         (progn
1946           (setq attr (concat attr (if attr " " "") (org-trim (match-string 2))))
1947           (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1948        ;; there is a label
1949        ((match-end 3)
1950         (progn
1951           (setq label (org-trim (match-string 3)))
1952           (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1953        (t
1954         (setq end (if (match-end 4)
1955                       (let ((ee (org-table-end)))
1956                         (prog1 (1- (marker-position ee)) (move-marker ee nil)))
1957                     (point-at-eol)))
1958         (add-text-properties (point-at-bol) end
1959                              (list 'org-caption cap
1960                                    'org-caption-shortn shortn
1961                                    'org-attributes attr
1962                                    'org-label label))
1963         (if label (push (cons label label) target-alist))
1964         (goto-char end)
1965         (setq cap nil shortn nil attr nil label nil)))))
1966   target-alist)
1967
1968 (defun org-export-remove-comment-blocks-and-subtrees ()
1969   "Remove the comment environment, and also commented subtrees."
1970   (let ((re-commented (format org-heading-keyword-regexp-format
1971                               org-comment-string))
1972         case-fold-search)
1973     ;; Remove comment environment
1974     (goto-char (point-min))
1975     (setq case-fold-search t)
1976     (while (re-search-forward
1977             "^#\\+begin_comment[ \t]*\n[^\000]*?\n#\\+end_comment\\>.*" nil t)
1978       (replace-match "" t t))
1979     ;; Remove subtrees that are commented
1980     (goto-char (point-min))
1981     (setq case-fold-search nil)
1982     (while (re-search-forward re-commented nil t)
1983       (goto-char (match-beginning 0))
1984       (delete-region (point) (org-end-of-subtree t)))))
1985
1986 (defun org-export-handle-comments (org-commentsp)
1987   "Remove comments, or convert to backend-specific format.
1988 ORG-COMMENTSP can be a format string for publishing comments.
1989 When it is nil, all comments will be removed."
1990   (let ((re "^[ \t]*#\\( \\|$\\)"))
1991     (goto-char (point-min))
1992     (while (re-search-forward re nil t)
1993       (let ((pos (match-beginning 0))
1994             (end (progn (forward-line) (point))))
1995         (if (get-text-property pos 'org-protected)
1996             (forward-line)
1997           (if (not org-commentsp) (delete-region pos end)
1998             (add-text-properties pos end '(org-protected t))
1999             (replace-match
2000              (org-add-props
2001                  (format org-commentsp (buffer-substring (match-end 0) end))
2002                  nil 'org-protected t)
2003              t t)))))
2004     ;; Hack attack: previous implementation also removed keywords at
2005     ;; column 0. Brainlessly do it again.
2006     (goto-char (point-min))
2007     (while (re-search-forward "^#\\+" nil t)
2008       (unless (get-text-property (point-at-bol) 'org-protected)
2009         (delete-region (point-at-bol) (progn (forward-line) (point)))))))
2010
2011 (defun org-export-handle-metalines ()
2012   "Remove tables and source blocks metalines.
2013 This function should only be called after all block processing
2014 has taken place."
2015   (let ((re "^[ \t]*#\\+\\(tbl\\(?:name\\|fm\\)\\|results\\(?:\\[[a-z0-9]+\\]\\)?\\|name\\):\\(.*\n?\\)")
2016         (case-fold-search t)
2017         pos)
2018     (goto-char (point-min))
2019     (while (or (looking-at re)
2020                (re-search-forward re nil t))
2021       (setq pos (match-beginning 0))
2022       (if (get-text-property (match-beginning 1) 'org-protected)
2023           (goto-char (1+ pos))
2024         (goto-char (1+ pos))
2025         (replace-match "")
2026         (goto-char (max (point-min) (1- pos)))))))
2027
2028 (defun org-export-mark-radio-links ()
2029   "Find all matches for radio targets and turn them into internal links."
2030   (let ((re-radio (and org-target-link-regexp
2031                        (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
2032     (goto-char (point-min))
2033     (when re-radio
2034       (while (re-search-forward re-radio nil t)
2035         (unless
2036             (save-match-data
2037               (or (org-in-regexp org-bracket-link-regexp)
2038                   (org-in-regexp org-plain-link-re)
2039                   (org-in-regexp "<<[^<>]+>>")))
2040           (org-if-unprotected
2041            (replace-match "\\1[[\\2]]")))))))
2042
2043 (defun org-store-forced-table-alignment ()
2044   "Find table lines which force alignment, store the results in properties."
2045   (let (line cnt cookies)
2046     (goto-char (point-min))
2047     (while (re-search-forward "|[ \t]*<\\([lrc]?[0-9]+\\|[lrc]\\)>[ \t]*|"
2048                               nil t)
2049       ;; OK, this looks like a table line with an alignment cookie
2050       (org-if-unprotected
2051        (setq line (buffer-substring (point-at-bol) (point-at-eol)))
2052        (when (and (org-at-table-p)
2053                   (org-table-cookie-line-p line))
2054          (setq cnt 0 cookies nil)
2055          (mapc
2056           (lambda (x)
2057             (setq cnt (1+ cnt))
2058             (when (string-match "\\`<\\([lrc]\\)?\\([0-9]+\\)?>\\'" x)
2059               (let ((align (and (match-end 1)
2060                                 (downcase (match-string 1 x))))
2061                     (width (and (match-end 2)
2062                                 (string-to-number (match-string 2 x)))))
2063                 (push (cons cnt (list align width)) cookies))))
2064           (org-split-string line "[ \t]*|[ \t]*"))
2065          (add-text-properties (org-table-begin) (org-table-end)
2066                               (list 'org-col-cookies cookies))))
2067       (goto-char (point-at-eol)))))
2068
2069 (defun org-export-remove-special-table-lines ()
2070   "Remove tables lines that are used for internal purposes.
2071 Also, store forced alignment information found in such lines."
2072   (goto-char (point-min))
2073   (while (re-search-forward "^[ \t]*|" nil t)
2074     (org-if-unprotected-at (1- (point))
2075       (beginning-of-line 1)
2076       (if (or (looking-at "[ \t]*| *[!_^] *|")
2077               (not
2078                (memq
2079                 nil
2080                 (mapcar
2081                  (lambda (f)
2082                    (or (and org-export-table-remove-empty-lines (= (length f) 0))
2083                        (string-match
2084                         "\\`<\\([0-9]\\|[lrc]\\|[lrc][0-9]+\\)>\\'" f)))
2085                  (org-split-string ;; FIXME, can't we do without splitting???
2086                   (buffer-substring (point-at-bol) (point-at-eol))
2087                   "[ \t]*|[ \t]*")))))
2088           (delete-region (max (point-min) (1- (point-at-bol)))
2089                          (point-at-eol))
2090         (end-of-line 1)))))
2091
2092 (defun org-export-protect-sub-super (s)
2093   (save-match-data
2094     (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s)
2095       (setq s (replace-match "\\1\\\\\\2" nil nil s)))
2096     s))
2097
2098 (defun org-export-normalize-links ()
2099   "Convert all links to bracket links, and expand link abbreviations."
2100   (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
2101         (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
2102         nodesc)
2103     (goto-char (point-min))
2104     (while (re-search-forward org-bracket-link-regexp nil t)
2105       (put-text-property (match-beginning 0) (match-end 0) 'org-normalized-link t))
2106     (goto-char (point-min))
2107     (while (re-search-forward re-plain-link nil t)
2108       (unless (get-text-property (match-beginning 0) 'org-normalized-link)
2109         (goto-char (1- (match-end 0)))
2110         (org-if-unprotected-at (1+ (match-beginning 0))
2111           (let* ((s (concat (match-string 1)
2112                             "[[" (match-string 2) ":" (match-string 3)
2113                             "][" (match-string 2) ":" (org-export-protect-sub-super
2114                                                        (match-string 3))
2115                             "]]")))
2116             ;; added 'org-link face to links
2117             (put-text-property 0 (length s) 'face 'org-link s)
2118             (replace-match s t t)))))
2119     (goto-char (point-min))
2120     (while (re-search-forward re-angle-link nil t)
2121       (goto-char (1- (match-end 0)))
2122       (org-if-unprotected
2123        (let* ((s (concat (match-string 1)
2124                          "[[" (match-string 2) ":" (match-string 3)
2125                          "][" (match-string 2) ":" (org-export-protect-sub-super
2126                                                     (match-string 3))
2127                          "]]")))
2128          (put-text-property 0 (length s) 'face 'org-link s)
2129          (replace-match s t t))))
2130     (goto-char (point-min))
2131     (while (re-search-forward org-bracket-link-regexp nil t)
2132       (goto-char (1- (match-end 0)))
2133       (setq nodesc (not (match-end 3)))
2134       (org-if-unprotected
2135        (let* ((xx (save-match-data
2136                     (org-translate-link
2137                      (org-link-expand-abbrev (match-string 1)))))
2138               (s (concat
2139                   "[[" (org-add-props (copy-sequence xx)
2140                            nil 'org-protected t 'org-no-description nodesc)
2141                   "]"
2142                   (if (match-end 3)
2143                       (match-string 2)
2144                     (concat "[" (copy-sequence xx)
2145                             "]"))
2146                   "]")))
2147          (put-text-property 0 (length s) 'face 'org-link s)
2148          (replace-match s t t))))))
2149
2150 (defun org-export-concatenate-multiline-links ()
2151   "Find multi-line links and put it all into a single line.
2152 This is to make sure that the line-processing export backends
2153 can work correctly."
2154   (goto-char (point-min))
2155   (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
2156     (org-if-unprotected-at (match-beginning 1)
2157       (replace-match "\\1 \\3")
2158       (goto-char (match-beginning 0)))))
2159
2160 (defun org-export-concatenate-multiline-emphasis ()
2161   "Find multi-line emphasis and put it all into a single line.
2162 This is to make sure that the line-processing export backends
2163 can work correctly."
2164   (goto-char (point-min))
2165   (while (re-search-forward org-emph-re nil t)
2166     (if (and (not (= (char-after (match-beginning 3))
2167                      (char-after (match-beginning 4))))
2168              (save-excursion (goto-char (match-beginning 0))
2169                              (save-match-data
2170                                (and (not (org-at-table-p))
2171                                     (not (org-at-heading-p))))))
2172         (org-if-unprotected
2173          (subst-char-in-region (match-beginning 0) (match-end 0)
2174                                ?\n ?\  t)
2175          (goto-char (1- (match-end 0))))
2176       (goto-char (1+ (match-beginning 0))))))
2177
2178 (defun org-export-grab-title-from-buffer ()
2179   "Get a title for the current document, from looking at the buffer."
2180   (let ((inhibit-read-only t))
2181     (save-excursion
2182       (goto-char (point-min))
2183       (let ((end (if (looking-at org-outline-regexp)
2184                      (point)
2185                    (save-excursion (outline-next-heading) (point)))))
2186         (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
2187           ;; Mark the line so that it will not be exported as normal text.
2188           (unless (org-in-block-p org-list-forbidden-blocks)
2189             (org-unmodified
2190              (add-text-properties (match-beginning 0) (match-end 0)
2191                                   (list :org-license-to-kill t))))
2192           ;; Return the title string
2193           (org-trim (match-string 0)))))))
2194
2195 (defun org-export-get-title-from-subtree ()
2196   "Return subtree title and exclude it from export."
2197   (let ((rbeg (region-beginning)) (rend (region-end))
2198         (inhibit-read-only t)
2199         (tags (plist-get (org-infile-export-plist) :tags))
2200         title)
2201     (save-excursion
2202       (goto-char rbeg)
2203       (when (and (org-at-heading-p)
2204                  (>= (org-end-of-subtree t t) rend))
2205         (when (plist-member org-export-opt-plist :tags)
2206           (setq tags (or (plist-get org-export-opt-plist :tags) tags)))
2207         ;; This is a subtree, we take the title from the first heading
2208         (goto-char rbeg)
2209         (looking-at org-todo-line-tags-regexp)
2210         (setq title (if (and (eq tags t) (match-string 4))
2211                         (format "%s\t%s" (match-string 3) (match-string 4))
2212                       (match-string 3)))
2213         (org-unmodified
2214          (add-text-properties (point) (1+ (point-at-eol))
2215                               (list :org-license-to-kill t)))
2216         (setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
2217     title))
2218
2219 (defun org-solidify-link-text (s &optional alist)
2220   "Take link text and make a safe target out of it."
2221   (save-match-data
2222     (let* ((rtn
2223             (mapconcat
2224              'identity
2225              (org-split-string s "[^a-zA-Z0-9_\\.-]+") "-"))
2226            (a (assoc rtn alist)))
2227       (or (cdr a) rtn))))
2228
2229 (defun org-get-min-level (lines &optional offset)
2230   "Get the minimum level in LINES."
2231   (let ((re "^\\(\\*+\\) ") l)
2232     (catch 'exit
2233       (while (setq l (pop lines))
2234         (if (string-match re l)
2235             (throw 'exit (org-tr-level (- (length (match-string 1 l))
2236                                           (or offset 0))))))
2237       1)))
2238
2239 ;; Variable holding the vector with section numbers
2240 (defvar org-section-numbers (make-vector org-level-max 0))
2241
2242 (defun org-init-section-numbers ()
2243   "Initialize the vector for the section numbers."
2244   (let* ((level  -1)
2245          (numbers (nreverse (org-split-string "" "\\.")))
2246          (depth (1- (length org-section-numbers)))
2247          (i depth) number-string)
2248     (while (>= i 0)
2249       (if (> i level)
2250           (aset org-section-numbers i 0)
2251         (setq number-string (or (car numbers) "0"))
2252         (if (string-match "\\`[A-Z]\\'" number-string)
2253             (aset org-section-numbers i
2254                   (- (string-to-char number-string) ?A -1))
2255           (aset org-section-numbers i (string-to-number number-string)))
2256         (pop numbers))
2257       (setq i (1- i)))))
2258
2259 (defun org-section-number (&optional level)
2260   "Return a string with the current section number.
2261 When LEVEL is non-nil, increase section numbers on that level."
2262   (let* ((depth (1- (length org-section-numbers)))
2263          (string "")
2264          (fmts (car org-export-section-number-format))
2265          (term (cdr org-export-section-number-format))
2266          (sep "")
2267          ctype fmt idx n)
2268     (when level
2269       (when (> level -1)
2270         (aset org-section-numbers
2271               level (1+ (aref org-section-numbers level))))
2272       (setq idx (1+ level))
2273       (while (<= idx depth)
2274         (if (not (= idx 1))
2275             (aset org-section-numbers idx 0))
2276         (setq idx (1+ idx))))
2277     (setq idx 0)
2278     (while (<= idx depth)
2279       (when (> (aref org-section-numbers idx) 0)
2280         (setq fmt (or (pop fmts) fmt)
2281               ctype (car fmt)
2282               n (aref org-section-numbers idx)
2283               string (if (> n 0)
2284                          (concat string sep (org-number-to-counter n ctype))
2285                        (concat string ".0"))
2286               sep (nth 1 fmt)))
2287       (setq idx (1+ idx)))
2288     (save-match-data
2289       (if (string-match "\\`\\([@0]\\.\\)+" string)
2290           (setq string (replace-match "" t nil string)))
2291       (if (string-match "\\(\\.0\\)+\\'" string)
2292           (setq string (replace-match "" t nil string))))
2293     (concat string term)))
2294
2295 (defun org-number-to-counter (n type)
2296   "Concert number N to a string counter, according to TYPE.
2297 TYPE must be a string, any of:
2298  1  number
2299  A  A,B,....
2300  a  a,b,....
2301  I  upper case roman numeral
2302  i  lower case roman numeral"
2303   (cond
2304    ((equal type "1") (number-to-string n))
2305    ((equal type "A") (char-to-string (+ ?A n -1)))
2306    ((equal type "a") (char-to-string (+ ?a n -1)))
2307    ((equal type "I") (org-number-to-roman n))
2308    ((equal type "i") (downcase (org-number-to-roman n)))
2309    (t (error "Invalid counter type `%s'" type))))
2310
2311 (defun org-number-to-roman (n)
2312   "Convert integer N into a roman numeral."
2313   (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
2314                  ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
2315                  (  10 . "X") (  9 . "IX") (  5 . "V") (  4 . "IV")
2316                  (   1 . "I")))
2317         (res ""))
2318     (if (<= n 0)
2319         (number-to-string n)
2320       (while roman
2321         (if (>= n (caar roman))
2322             (setq n (- n (caar roman))
2323                   res (concat res (cdar roman)))
2324           (pop roman)))
2325       res)))
2326
2327 ;;; Macros
2328
2329 (defun org-export-preprocess-apply-macros ()
2330   "Replace macro references."
2331   (goto-char (point-min))
2332   (let (sy val key args args2 ind-str s n)
2333     (while (re-search-forward
2334             "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
2335             nil t)
2336       (unless (save-match-data (save-excursion
2337                                  (goto-char (point-at-bol))
2338                                  (looking-at "[ \t]*#\\+macro")))
2339         ;; Get macro name (KEY), arguments (ARGS), and indentation of
2340         ;; current line (IND-STR) as strings.
2341         (setq key (downcase (match-string 1))
2342               args (match-string 3)
2343               ind-str (save-match-data (save-excursion
2344                                          (beginning-of-line)
2345                                          (looking-at "^\\([ \t]*\\).*")
2346                                          (match-string 1))))
2347         ;; When macro is defined, retrieve replacement text in VAL,
2348         ;; and proceed with expansion.
2349         (when (setq val (or (plist-get org-export-opt-plist
2350                                        (intern (concat ":macro-" key)))
2351                             (plist-get org-export-opt-plist
2352                                        (intern (concat ":" key)))))
2353           (save-match-data
2354             ;; If arguments are provided, first retrieve them properly
2355             ;; (in ARGS, as a list), then replace them in VAL.
2356             (when args
2357               (setq args (org-split-string args ",") args2 nil)
2358               (while args
2359                 (while (string-match "\\\\\\'" (car args))
2360                   ;; Repair bad splits.
2361                   (setcar (cdr args) (concat (substring (car args) 0 -1)
2362                                              "," (nth 1 args)))
2363                   (pop args))
2364                 (push (pop args) args2))
2365               (setq args (mapcar 'org-trim (nreverse args2)))
2366               (setq s 0)
2367               (while (string-match "\\$\\([0-9]+\\)" val s)
2368                 (setq s (1+ (match-beginning 0))
2369                       n (string-to-number (match-string 1 val)))
2370                 (and (>= (length args) n)
2371                      (setq val (replace-match (nth (1- n) args) t t val)))))
2372             ;; VAL starts with "(eval": it is a sexp, `eval' it.
2373             (when (string-match "\\`(eval\\>" val)
2374               (setq val (eval (read val))))
2375             ;; Ensure VAL is a string (or nil) and that each new line
2376             ;; is indented as the first one.
2377             (setq val (and val
2378                            (mapconcat 'identity
2379                                       (org-split-string
2380                                        (if (stringp val) val (format "%s" val))
2381                                        "\n")
2382                                       (concat "\n" ind-str)))))
2383           ;; Eventually do the replacement, if VAL isn't nil.  Move
2384           ;; point at beginning of macro for recursive expansions.
2385           (when val
2386             (replace-match val t t)
2387             (goto-char (match-beginning 0))))))))
2388
2389 (defun org-export-apply-macros-in-string (s)
2390   "Apply the macros in string S."
2391   (when s
2392     (with-temp-buffer
2393       (insert s)
2394       (org-export-preprocess-apply-macros)
2395       (buffer-string))))
2396
2397 ;;; Include files
2398
2399 (defun org-export-handle-include-files ()
2400   "Include the contents of include files, with proper formatting."
2401   (let ((case-fold-search t)
2402         params file markup lang start end prefix prefix1 switches all minlevel currentlevel addlevel lines)
2403     (goto-char (point-min))
2404     (while (re-search-forward "^#\\+include:[ \t]+\\(.*\\)" nil t)
2405       (setq params (read (concat "(" (match-string 1) ")"))
2406             prefix (org-get-and-remove-property 'params :prefix)
2407             prefix1 (org-get-and-remove-property 'params :prefix1)
2408             minlevel (org-get-and-remove-property 'params :minlevel)
2409             addlevel (org-get-and-remove-property 'params :addlevel)
2410             lines (org-get-and-remove-property 'params :lines)
2411             file (org-symname-or-string (pop params))
2412             markup (org-symname-or-string (pop params))
2413             lang (and (member markup '("src" "SRC"))
2414                       (org-symname-or-string (pop params)))
2415             switches (mapconcat #'(lambda (x) (format "%s" x)) params " ")
2416             start nil end nil)
2417       (delete-region (match-beginning 0) (match-end 0))
2418       (setq currentlevel (or (org-current-level) 0))
2419       (if (or (not file)
2420               (not (file-exists-p file))
2421               (not (file-readable-p file)))
2422           (insert (format "CANNOT INCLUDE FILE %s" file))
2423         (setq all (cons file all))
2424         (when markup
2425           (if (equal (downcase markup) "src")
2426               (setq start (format "#+begin_src %s %s\n"
2427                                   (or lang "fundamental")
2428                                   (or switches ""))
2429                     end "#+end_src")
2430             (setq start (format "#+begin_%s %s\n" markup switches)
2431                   end  (format "#+end_%s" markup))))
2432         (insert (or start ""))
2433         (insert (org-get-file-contents (expand-file-name file)
2434                                        prefix prefix1 markup currentlevel minlevel addlevel lines))
2435         (or (bolp) (newline))
2436         (insert (or end ""))))
2437     all))
2438
2439 (defun org-export-handle-include-files-recurse ()
2440   "Recursively include files aborting on circular inclusion."
2441   (let ((now (list org-current-export-file)) all)
2442     (while now
2443       (setq all (append now all))
2444       (setq now (org-export-handle-include-files))
2445       (let ((intersection
2446              (delq nil
2447                    (mapcar (lambda (el) (when (member el all) el)) now))))
2448         (when intersection
2449           (error "Recursive #+INCLUDE: %S" intersection))))))
2450
2451 (defun org-get-file-contents (file &optional prefix prefix1 markup minlevel parentlevel addlevel lines)
2452   "Get the contents of FILE and return them as a string.
2453 If PREFIX is a string, prepend it to each line.  If PREFIX1
2454 is a string, prepend it to the first line instead of PREFIX.
2455 If MARKUP, don't protect org-like lines, the exporter will
2456 take care of the block they are in.  If ADDLEVEL is a number,
2457 demote included file to current heading level+ADDLEVEL.
2458 If LINES is a string specifying a range of lines,
2459 include only those lines."
2460   (if (stringp markup) (setq markup (downcase markup)))
2461   (with-temp-buffer
2462     (insert-file-contents file)
2463     (when lines
2464       (let* ((lines (split-string lines "-"))
2465              (lbeg (string-to-number (car lines)))
2466              (lend (string-to-number (cadr lines)))
2467              (beg (if (zerop lbeg) (point-min)
2468                     (goto-char (point-min))
2469                     (forward-line (1- lbeg))
2470                     (point)))
2471              (end (if (zerop lend) (point-max)
2472                     (goto-char (point-min))
2473                     (forward-line (1- lend))
2474                     (point))))
2475         (narrow-to-region beg end)))
2476     (when (or prefix prefix1)
2477       (goto-char (point-min))
2478       (while (not (eobp))
2479         (insert (or prefix1 prefix))
2480         (setq prefix1 "")
2481         (beginning-of-line 2)))
2482     (buffer-string)
2483     (when (member markup '("src" "example"))
2484       (goto-char (point-min))
2485       (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t)
2486         (goto-char (match-beginning 0))
2487         (insert ",")
2488         (end-of-line 1)))
2489     (when minlevel
2490       (dotimes (lvl minlevel)
2491         (org-map-region 'org-demote (point-min) (point-max))))
2492     (when addlevel
2493       (let ((inclevel (or (if (org-before-first-heading-p)
2494                               (1- (and (outline-next-heading)
2495                                        (org-current-level)))
2496                             (1- (org-current-level)))
2497                           0)))
2498         (dotimes (level (- (+ parentlevel addlevel) inclevel))
2499           (org-map-region 'org-demote (point-min) (point-max)))))
2500     (buffer-string)))
2501
2502 (defun org-get-and-remove-property (listvar prop)
2503   "Check if the value of LISTVAR contains PROP as a property.
2504 If yes, return the value of that property (i.e. the element following
2505 in the list) and remove property and value from the list in LISTVAR."
2506   (let ((list (symbol-value listvar)) m v)
2507     (when (setq m (member prop list))
2508       (setq v (nth 1 m))
2509       (if (equal (car list) prop)
2510           (set listvar (cddr list))
2511         (setcdr (nthcdr (- (length list) (length m) 1) list)
2512                 (cddr m))
2513         (set listvar list)))
2514     v))
2515
2516 (defun org-symname-or-string (s)
2517   (if (symbolp s)
2518       (if s (symbol-name s) s)
2519     s))
2520
2521 ;;; Fontification and line numbers for code examples
2522
2523 (defvar org-export-last-code-line-counter-value 0)
2524
2525 (defun org-export-replace-src-segments-and-examples ()
2526   "Replace source code segments with special code for export."
2527   (setq org-export-last-code-line-counter-value 0)
2528   (let ((case-fold-search t)
2529         lang code trans opts indent caption)
2530     (goto-char (point-min))
2531     (while (re-search-forward
2532             "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?\\([ \t]+\\([^ \t\n]+\\)\\)?\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
2533             nil t)
2534       (if (match-end 1)
2535           (if (not (match-string 4))
2536               (error "Source block missing language specification: %s"
2537                      (let* ((body (match-string 6))
2538                             (nothing (message "body:%s" body))
2539                             (preview (or (and (string-match
2540                                                "^[ \t]*\\([^\n\r]*\\)" body)
2541                                               (match-string 1 body)) body)))
2542                        (if (> (length preview) 35)
2543                            (concat (substring preview 0 32) "...")
2544                          preview)))
2545             ;; src segments
2546             (setq lang (match-string 4)
2547                   opts (match-string 5)
2548                   code (match-string 6)
2549                   indent (length (match-string 2))
2550                   caption (get-text-property 0 'org-caption (match-string 0))))
2551         (setq lang nil
2552               opts (match-string 9)
2553               code (match-string 10)
2554               indent (length (match-string 8))
2555               caption (get-text-property 0 'org-caption (match-string 0))))
2556
2557       (setq trans (org-export-format-source-code-or-example
2558                    lang code opts indent caption))
2559       (replace-match trans t t))))
2560
2561 (defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
2562 (defvar org-export-latex-listings) ;; defined in org-latex.el
2563 (defvar org-export-latex-listings-langs) ;; defined in org-latex.el
2564 (defvar org-export-latex-listings-w-names) ;; defined in org-latex.el
2565 (defvar org-export-latex-minted-langs) ;; defined in org-latex.el
2566 (defvar org-export-latex-custom-lang-environments) ;; defined in org-latex.el
2567 (defvar org-export-latex-listings-options) ;; defined in org-latex.el
2568 (defvar org-export-latex-minted-options) ;; defined in org-latex.el
2569
2570 (defun org-remove-formatting-on-newlines-in-region (beg end)
2571   "Remove formatting on newline characters."
2572   (interactive "r")
2573   (save-excursion
2574     (goto-char beg)
2575     (while (progn (end-of-line) (< (point) end))
2576       (put-text-property (point) (1+ (point)) 'face nil)
2577       (forward-char 1))))
2578
2579 (defun org-export-format-source-code-or-example
2580   (lang code &optional opts indent caption)
2581   "Format CODE from language LANG and return it formatted for export.
2582 The CODE is marked up in `org-export-current-backend' format.
2583
2584 Check if a function by name
2585 \"org-<backend>-format-source-code-or-example\" is bound.  If yes,
2586 use it as the custom formatter.  Otherwise, use the default
2587 formatter.  Default formatters are provided for docbook, html,
2588 latex and ascii backends.  For example, use
2589 `org-html-format-source-code-or-example' to provide a custom
2590 formatter for export to \"html\".
2591
2592 If LANG is nil, do not add any fontification.
2593 OPTS contains formatting options, like `-n' for triggering numbering lines,
2594 and `+n' for continuing previous numbering.
2595 Code formatting according to language currently only works for HTML.
2596 Numbering lines works for all three major backends (html, latex, and ascii).
2597 INDENT was the original indentation of the block."
2598   (save-match-data
2599     (let* ((backend-name (symbol-name org-export-current-backend))
2600            (backend-formatter
2601             (intern (format "org-%s-format-source-code-or-example"
2602                             backend-name)))
2603            (backend-feature (intern (concat "org-" backend-name)))
2604            (backend-formatter
2605             (and (require (intern (concat "org-" backend-name)) nil)
2606                  (fboundp backend-formatter) backend-formatter))
2607            num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt)
2608       (setq opts (or opts "")
2609             num (string-match "[-+]n\\>" opts)
2610             cont (string-match "\\+n\\>" opts)
2611             rpllbl (string-match "-r\\>" opts)
2612             keepp (string-match "-k\\>" opts)
2613             textareap (string-match "-t\\>" opts)
2614             preserve-indentp (or org-src-preserve-indentation
2615                                  (string-match "-i\\>" opts))
2616             cols (if (string-match "-w[ \t]+\\([0-9]+\\)" opts)
2617                      (string-to-number (match-string 1 opts))
2618                    80)
2619             rows (if (string-match "-h[ \t]+\\([0-9]+\\)" opts)
2620                      (string-to-number (match-string 1 opts))
2621                    (org-count-lines code))
2622             fmt (if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts)
2623                     (match-string 1 opts)))
2624       (when (and textareap (eq org-export-current-backend 'html))
2625         ;; we cannot use numbering or highlighting.
2626         (setq num nil cont nil lang nil))
2627       (if keepp (setq rpllbl 'keep))
2628       (setq rtn (if preserve-indentp code (org-remove-indentation code)))
2629       (when (string-match "^," rtn)
2630         (setq rtn (with-temp-buffer
2631                     (insert rtn)
2632                     ;; Free up the protected lines
2633                     (goto-char (point-min))
2634                     (while (re-search-forward "^," nil t)
2635                       (if (or (equal lang "org")
2636                               (save-match-data
2637                                 (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
2638                           (replace-match ""))
2639                       (end-of-line 1))
2640                     (buffer-string))))
2641       ;; Now backend-specific coding
2642       (setq rtn
2643             (cond
2644              (backend-formatter
2645               (funcall backend-formatter rtn lang caption textareap cols rows num
2646                        cont rpllbl fmt))
2647              ((eq org-export-current-backend 'docbook)
2648               (setq rtn (org-export-number-lines rtn 0 0 num cont rpllbl fmt))
2649               (concat "<programlisting><![CDATA["
2650                       rtn
2651                       "]]></programlisting>\n"))
2652              ((eq org-export-current-backend 'html)
2653               ;; We are exporting to HTML
2654               (when lang
2655                 (if (featurep 'xemacs)
2656                     (require 'htmlize)
2657                   (require 'htmlize nil t))
2658                 (when (not (fboundp 'htmlize-region-for-paste))
2659                   ;; we do not have htmlize.el, or an old version of it
2660                   (setq lang nil)
2661                   (message
2662                    "htmlize.el 1.34 or later is needed for source code formatting")))
2663
2664               (if lang
2665                   (let* ((lang-m (when lang
2666                                    (or (cdr (assoc lang org-src-lang-modes))
2667                                        lang)))
2668                          (mode (and lang-m (intern
2669                                             (concat
2670                                              (if (symbolp lang-m)
2671                                                  (symbol-name lang-m)
2672                                                lang-m)
2673                                              "-mode"))))
2674                          (org-inhibit-startup t)
2675                          (org-startup-folded nil))
2676                     (setq rtn
2677                           (with-temp-buffer
2678                             (insert rtn)
2679                             (if (functionp mode)
2680                                 (funcall mode)
2681                               (fundamental-mode))
2682                             (font-lock-fontify-buffer)
2683                             ;; markup each line separately
2684                             (org-remove-formatting-on-newlines-in-region (point-min) (point-max))
2685                             (org-src-mode)
2686                             (set-buffer-modified-p nil)
2687                             (org-export-htmlize-region-for-paste
2688                              (point-min) (point-max))))
2689                     (if (string-match "<pre\\([^>]*\\)>\n*" rtn)
2690                         (setq rtn
2691                               (concat
2692                                (if caption
2693                                    (concat
2694                                     "<div class=\"org-src-container\">"
2695                                     (format
2696                                      "<label class=\"org-src-name\">%s</label>"
2697                                      caption))
2698                                  "")
2699                                (replace-match
2700                                 (format "<pre class=\"src src-%s\">\n" lang)
2701                                 t t rtn)
2702                                (if caption "</div>" "")))))
2703                 (if textareap
2704                     (setq rtn (concat
2705                                (format "<p>\n<textarea cols=\"%d\" rows=\"%d\">"
2706                                        cols rows)
2707                                rtn "</textarea>\n</p>\n"))
2708                   (with-temp-buffer
2709                     (insert rtn)
2710                     (goto-char (point-min))
2711                     (while (re-search-forward "[<>&]" nil t)
2712                       (replace-match (cdr (assq (char-before)
2713                                                 '((?&."&amp;")(?<."&lt;")(?>."&gt;"))))
2714                                      t t))
2715                     (setq rtn (buffer-string)))
2716                   (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
2717               (unless textareap
2718                 (setq rtn (org-export-number-lines rtn 1 1 num cont rpllbl fmt)))
2719               (if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
2720                   (setq rtn (replace-match "\\1" t nil rtn)))
2721               rtn)
2722              ((eq org-export-current-backend 'latex)
2723               (setq rtn (org-export-number-lines rtn 0 0 num cont rpllbl fmt))
2724               (cond
2725                ((and lang org-export-latex-listings)
2726                 (let* ((make-option-string
2727                         (lambda (pair)
2728                           (concat (first pair)
2729                                   (if (> (length (second pair)) 0)
2730                                       (concat "=" (second pair))))))
2731                        (lang-sym (intern lang))
2732                        (minted-p (eq org-export-latex-listings 'minted))
2733                        (listings-p (not minted-p))
2734                        (backend-lang
2735                         (or (cadr
2736                              (assq
2737                               lang-sym
2738                               (cond
2739                                (minted-p org-export-latex-minted-langs)
2740                                (listings-p org-export-latex-listings-langs))))
2741                             lang))
2742                        (custom-environment
2743                         (cadr
2744                          (assq
2745                           lang-sym
2746                           org-export-latex-custom-lang-environments))))
2747                   (concat
2748                    (when (and listings-p (not custom-environment))
2749                      (format
2750                       "\\lstset{%s}\n"
2751                       (mapconcat
2752                        make-option-string
2753                        (append org-export-latex-listings-options
2754                                `(("language" ,backend-lang))) ",")))
2755                    (when (and caption org-export-latex-listings-w-names)
2756                      (format
2757                       "\n%s $\\equiv$ \n"
2758                       (replace-regexp-in-string "_" "\\\\_" caption)))
2759                    (cond
2760                     (custom-environment
2761                      (format "\\begin{%s}\n%s\\end{%s}\n"
2762                              custom-environment rtn custom-environment))
2763                     (listings-p
2764                      (format "\\begin{%s}\n%s\\end{%s}"
2765                              "lstlisting" rtn "lstlisting"))
2766                     (minted-p
2767                      (format
2768                       "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
2769                       (mapconcat make-option-string
2770                                  org-export-latex-minted-options ",")
2771                       backend-lang rtn))))))
2772                (t (concat (car org-export-latex-verbatim-wrap)
2773                           rtn (cdr org-export-latex-verbatim-wrap)))))
2774              ((eq org-export-current-backend 'ascii)
2775               ;; This is not HTML or LaTeX, so just make it an example.
2776               (setq rtn (org-export-number-lines rtn 0 0 num cont rpllbl fmt))
2777               (concat caption "\n"
2778                       (concat
2779                        (mapconcat
2780                         (lambda (l) (concat "  " l))
2781                         (org-split-string rtn "\n")
2782                         "\n")
2783                        "\n")))
2784              (t
2785               (error "Don't know how to markup source or example block in %s"
2786                      (upcase backend-name)))))
2787       (setq rtn
2788             (concat
2789              "\n#+BEGIN_" backend-name "\n"
2790              (org-add-props rtn
2791                  '(org-protected t org-example t org-native-text t))
2792              "\n#+END_" backend-name "\n"))
2793       (org-add-props rtn nil 'original-indentation indent))))
2794
2795 (defun org-export-number-lines (text &optional skip1 skip2 number cont
2796                                      replace-labels label-format preprocess)
2797   "Apply line numbers to literal examples and handle code references.
2798 Handle user-specified options under info node `(org)Literal
2799 examples' and return the modified source block.
2800
2801 TEXT contains the source or example block.
2802
2803 SKIP1 and SKIP2 are the number of lines that are to be skipped at
2804 the beginning and end of TEXT.  Use these to skip over
2805 backend-specific lines pre-pended or appended to the original
2806 source block.
2807
2808 NUMBER is non-nil if the literal example specifies \"+n\" or
2809 \"-n\" switch.  If NUMBER is non-nil add line numbers.
2810
2811 CONT is non-nil if the literal example specifies \"+n\" switch.
2812 If CONT is nil, start numbering this block from 1.  Otherwise
2813 continue numbering from the last numbered block.
2814
2815 REPLACE-LABELS is dual-purpose.
2816 1. It controls the retention of labels in the exported block.
2817 2. It specifies in what manner the links (or references) to a
2818    labeled line be formatted.
2819
2820 REPLACE-LABELS is the symbol `keep' if the literal example
2821 specifies \"-k\" option, is numeric if the literal example
2822 specifies \"-r\" option and is nil otherwise.
2823
2824 Handle REPLACE-LABELS as below:
2825 - If nil, retain labels in the exported block and use
2826   user-provided labels for referencing the labeled lines.
2827 - If it is a number, remove labels in the exported block and use
2828   one of line numbers or labels for referencing labeled lines based
2829   on NUMBER option.
2830 - If it is a keep, retain labels in the exported block and use
2831   one of line numbers or labels for referencing labeled lines
2832   based on NUMBER option.
2833
2834 LABEL-FORMAT is the value of \"-l\" switch associated with
2835 literal example.  See `org-coderef-label-format'.
2836
2837 PREPROCESS is intended for backend-agnostic handling of source
2838 block numbering.  When non-nil do the following:
2839 - do not number the lines
2840 - always strip the labels from exported block
2841 - do not make the labeled line a target of an incoming link.
2842   Instead mark the labeled line with `org-coderef' property and
2843   store the label in it."
2844   (setq skip1 (or skip1 0) skip2 (or skip2 0))
2845   (if (and number (not cont)) (setq org-export-last-code-line-counter-value 0))
2846   (with-temp-buffer
2847     (insert text)
2848     (goto-char (point-max))
2849     (skip-chars-backward " \t\n\r")
2850     (delete-region (point) (point-max))
2851     (beginning-of-line (- 1 skip2))
2852     (let* ((last (org-current-line))
2853            (n org-export-last-code-line-counter-value)
2854            (nmax (+ n (- last skip1)))
2855            (fmt (format "%%%dd:  " (length (number-to-string nmax))))
2856            (fm
2857             (cond
2858              ((eq org-export-current-backend 'html) (format "<span class=\"linenr\">%s</span>"
2859                                                             fmt))
2860              ((eq org-export-current-backend 'ascii) fmt)
2861              ((eq org-export-current-backend 'latex) fmt)
2862              ((eq org-export-current-backend 'docbook) fmt)
2863              (t "")))
2864            (label-format (or label-format org-coderef-label-format))
2865            (label-pre (if (string-match "%s" label-format)
2866                           (substring label-format 0 (match-beginning 0))
2867                         label-format))
2868            (label-post (if (string-match "%s" label-format)
2869                            (substring label-format (match-end 0))
2870                          ""))
2871            (lbl-re
2872             (concat
2873              ".*?\\S-.*?\\([ \t]*\\("
2874              (regexp-quote label-pre)
2875              "\\([-a-zA-Z0-9_ ]+\\)"
2876              (regexp-quote label-post)
2877              "\\)\\)"))
2878            ref)
2879
2880       (org-goto-line (1+ skip1))
2881       (while (and (re-search-forward "^" nil t) (not (eobp)) (< n nmax))
2882         (when number (incf n))
2883         (if (or preprocess (not number))
2884             (forward-char 1)
2885           (insert (format fm n)))
2886         (when (looking-at lbl-re)
2887           (setq ref (match-string 3))
2888           (cond ((numberp replace-labels)
2889                  ;; remove labels; use numbers for references when lines
2890                  ;; are numbered, use labels otherwise
2891                  (delete-region (match-beginning 1) (match-end 1))
2892                  (push (cons ref (if (> n 0) n ref)) org-export-code-refs))
2893                 ((eq replace-labels 'keep)
2894                  ;; don't remove labels; use numbers for references when
2895                  ;; lines are numbered, use labels otherwise
2896                  (goto-char (match-beginning 2))
2897                  (delete-region (match-beginning 2) (match-end 2))
2898                  (unless preprocess
2899                    (insert "(" ref ")"))
2900                  (push (cons ref (if (> n 0) n (concat "(" ref ")")))
2901                        org-export-code-refs))
2902                 (t
2903                  ;; don't remove labels and don't use numbers for
2904                  ;; references
2905                  (goto-char (match-beginning 2))
2906                  (delete-region (match-beginning 2) (match-end 2))
2907                  (unless preprocess
2908                    (insert "(" ref ")"))
2909                  (push (cons ref (concat "(" ref ")")) org-export-code-refs)))
2910           (when (and (eq org-export-current-backend 'html) (not preprocess))
2911             (save-excursion
2912               (beginning-of-line 1)
2913               (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
2914                               ref))
2915               (end-of-line 1)
2916               (insert "</span>")))
2917           (when preprocess
2918             (add-text-properties
2919              (point-at-bol) (point-at-eol) (list 'org-coderef ref)))))
2920       (setq org-export-last-code-line-counter-value n)
2921       (goto-char (point-max))
2922       (newline)
2923       (buffer-string))))
2924
2925 (defun org-search-todo-below (line lines level)
2926   "Search the subtree below LINE for any TODO entries."
2927   (let ((rest (cdr (memq line lines)))
2928         (re org-todo-line-regexp)
2929         line lv todo)
2930     (catch 'exit
2931       (while (setq line (pop rest))
2932         (if (string-match re line)
2933             (progn
2934               (setq lv (- (match-end 1) (match-beginning 1))
2935                     todo (and (match-beginning 2)
2936                               (not (member (match-string 2 line)
2937                                            org-done-keywords))))
2938                                         ; TODO, not DONE
2939               (if (<= lv level) (throw 'exit nil))
2940               (if todo (throw 'exit t))))))))
2941
2942 ;;;###autoload
2943 (defun org-export-visible (type arg)
2944   "Create a copy of the visible part of the current buffer, and export it.
2945 The copy is created in a temporary buffer and removed after use.
2946 TYPE is the final key (as a string) that also selects the export command in
2947 the \\<org-mode-map>\\[org-export] export dispatcher.
2948 As a special case, if the you type SPC at the prompt, the temporary
2949 org-mode file will not be removed but presented to you so that you can
2950 continue to use it.  The prefix arg ARG is passed through to the exporting
2951 command."
2952   (interactive
2953    (list (progn
2954            (message "Export visible: [a]SCII  [h]tml  [b]rowse HTML [H/R]buffer with HTML  [D]ocBook  [l]atex  [p]df  [d]view pdf  [L]atex buffer  [x]OXO  [ ]keep buffer")
2955            (read-char-exclusive))
2956          current-prefix-arg))
2957   (if (not (member type '(?a ?n ?u ?\C-a ?b ?\C-b ?h ?D ?x ?\ ?l ?p ?d ?L ?H ?R)))
2958       (error "Invalid export key"))
2959   (let* ((binding (cdr (assoc type
2960                               '(
2961                                 (?a . org-export-as-ascii)
2962                                 (?A . org-export-as-ascii-to-buffer)
2963                                 (?n . org-export-as-latin1)
2964                                 (?N . org-export-as-latin1-to-buffer)
2965                                 (?u . org-export-as-utf8)
2966                                 (?U . org-export-as-utf8-to-buffer)
2967                                 (?\C-a . org-export-as-ascii)
2968                                 (?b . org-export-as-html-and-open)
2969                                 (?\C-b . org-export-as-html-and-open)
2970                                 (?h . org-export-as-html)
2971                                 (?H . org-export-as-html-to-buffer)
2972                                 (?R . org-export-region-as-html)
2973                                 (?D . org-export-as-docbook)
2974
2975                                 (?l . org-export-as-latex)
2976                                 (?p . org-export-as-pdf)
2977                                 (?d . org-export-as-pdf-and-open)
2978                                 (?L . org-export-as-latex-to-buffer)
2979
2980                                 (?x . org-export-as-xoxo)))))
2981          (keepp (equal type ?\ ))
2982          (file buffer-file-name)
2983          (buffer (get-buffer-create "*Org Export Visible*"))
2984          s e)
2985     ;; Need to hack the drawers here.
2986     (save-excursion
2987       (goto-char (point-min))
2988       (while (re-search-forward org-drawer-regexp nil t)
2989         (goto-char (match-beginning 1))
2990         (or (outline-invisible-p) (org-flag-drawer nil))))
2991     (with-current-buffer buffer (erase-buffer))
2992     (save-excursion
2993       (setq s (goto-char (point-min)))
2994       (while (not (= (point) (point-max)))
2995         (goto-char (org-find-invisible))
2996         (append-to-buffer buffer s (point))
2997         (setq s (goto-char (org-find-visible))))
2998       (org-cycle-hide-drawers 'all)
2999       (goto-char (point-min))
3000       (unless keepp
3001         ;; Copy all comment lines to the end, to make sure #+ settings are
3002         ;; still available for the second export step.  Kind of a hack, but
3003         ;; does do the trick.
3004         (if (looking-at "#[^\r\n]*")
3005             (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
3006         (when (re-search-forward "^\\*+[ \t]+" nil t)
3007           (while (re-search-backward "[\n\r]#[^\n\r]*" nil t)
3008             (append-to-buffer buffer (1+ (match-beginning 0))
3009                               (min (point-max) (1+ (match-end 0)))))))
3010       (set-buffer buffer)
3011       (let ((buffer-file-name file)
3012             (org-inhibit-startup t))
3013         (org-mode)
3014         (show-all)
3015         (unless keepp (funcall binding arg))))
3016     (if (not keepp)
3017         (kill-buffer buffer)
3018       (switch-to-buffer-other-window buffer)
3019       (goto-char (point-min)))))
3020
3021 (defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
3022
3023 (defun org-export-string (string fmt &optional dir)
3024   "Export STRING to FMT using existing export facilities.
3025 During export STRING is saved to a temporary file whose location
3026 could vary.  Optional argument DIR can be used to force the
3027 directory in which the temporary file is created during export
3028 which can be useful for resolving relative paths.  Dir defaults
3029 to the value of `temporary-file-directory'."
3030   (let ((temporary-file-directory (or dir temporary-file-directory))
3031         (tmp-file (make-temp-file "org-")))
3032     (unwind-protect
3033         (with-temp-buffer
3034           (insert string)
3035           (write-file tmp-file)
3036           (org-load-modules-maybe)
3037           (unless org-local-vars
3038             (setq org-local-vars (org-get-local-variables)))
3039           (eval ;; convert to fmt -- mimicking `org-run-like-in-org-mode'
3040            (list 'let org-local-vars
3041                  (list (intern (format "org-export-as-%s" fmt))
3042                        nil nil nil ''string t))))
3043       (delete-file tmp-file))))
3044
3045 ;;;###autoload
3046 (defun org-export-as-org (arg &optional hidden ext-plist
3047                               to-buffer body-only pub-dir)
3048   "Make a copy with not-exporting stuff removed.
3049 The purpose of this function is to provide a way to export the source
3050 Org file of a webpage in Org format, but with sensitive and/or irrelevant
3051 stuff removed.  This command will remove the following:
3052
3053 - archived trees (if the variable `org-export-with-archived-trees' is nil)
3054 - comment blocks and trees starting with the COMMENT keyword
3055 - only trees that are consistent with `org-export-select-tags'
3056   and `org-export-exclude-tags'.
3057
3058 The only arguments that will be used are EXT-PLIST and PUB-DIR,
3059 all the others will be ignored (but are present so that the general
3060 mechanism to call publishing functions will work).
3061
3062 EXT-PLIST is a property list with external parameters overriding
3063 org-mode's default settings, but still inferior to file-local
3064 settings.  When PUB-DIR is set, use this as the publishing
3065 directory."
3066   (interactive "P")
3067   (let* ((opt-plist (org-combine-plists (org-default-export-plist)
3068                                         ext-plist
3069                                         (org-infile-export-plist)))
3070          (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3071          (filename (concat (file-name-as-directory
3072                             (or pub-dir
3073                                 (org-export-directory :org opt-plist)))
3074                            (file-name-sans-extension
3075                             (file-name-nondirectory bfname))
3076                            ".org"))
3077          (filename (and filename
3078                         (if (equal (file-truename filename)
3079                                    (file-truename bfname))
3080                             (concat (file-name-sans-extension filename)
3081                                     "-source."
3082                                     (file-name-extension filename))
3083                           filename)))
3084          (backup-inhibited t)
3085          (buffer (find-file-noselect filename))
3086          (region (buffer-string))
3087          str-ret)
3088     (save-excursion
3089       (org-pop-to-buffer-same-window buffer)
3090       (erase-buffer)
3091       (insert region)
3092       (let ((org-inhibit-startup t)) (org-mode))
3093       (org-install-letbind)
3094
3095       ;; Get rid of archived trees
3096       (org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
3097
3098       ;; Remove comment environment and comment subtrees
3099       (org-export-remove-comment-blocks-and-subtrees)
3100
3101       ;; Get rid of excluded trees
3102       (org-export-handle-export-tags (plist-get opt-plist :select-tags)
3103                                      (plist-get opt-plist :exclude-tags))
3104
3105       (when (or (plist-get opt-plist :plain-source)
3106                 (not (or (plist-get opt-plist :plain-source)
3107                          (plist-get opt-plist :htmlized-source))))
3108         ;; Either nothing special is requested (default call)
3109         ;; or the plain source is explicitly requested
3110         ;; so: save it
3111         (save-buffer))
3112       (when (plist-get opt-plist :htmlized-source)
3113         ;; Make the htmlized version
3114         (require 'htmlize)
3115         (require 'org-html)
3116         (font-lock-fontify-buffer)
3117         (let* ((htmlize-output-type 'css)
3118                (newbuf (htmlize-buffer)))
3119           (with-current-buffer newbuf
3120             (when org-export-htmlized-org-css-url
3121               (goto-char (point-min))
3122               (and (re-search-forward
3123                     "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
3124                     nil t)
3125                    (replace-match
3126                     (format
3127                      "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
3128                      org-export-htmlized-org-css-url)
3129                     t t)))
3130             (write-file (concat filename ".html")))
3131           (kill-buffer newbuf)))
3132       (set-buffer-modified-p nil)
3133       (if (equal to-buffer 'string)
3134           (progn (setq str-ret (buffer-string))
3135                  (kill-buffer (current-buffer))
3136                  str-ret)
3137         (kill-buffer (current-buffer))))))
3138
3139 (defvar org-archive-location)  ;; gets loaded with the org-archive require.
3140 (defun org-get-current-options ()
3141   "Return a string with current options as keyword options.
3142 Does include HTML export options as well as TODO and CATEGORY stuff."
3143   (require 'org-archive)
3144   (format
3145    "#+TITLE:     %s
3146 #+AUTHOR:    %s
3147 #+EMAIL:     %s
3148 #+DATE:      %s
3149 #+DESCRIPTION:
3150 #+KEYWORDS:
3151 #+LANGUAGE:  %s
3152 #+OPTIONS:   H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
3153 #+OPTIONS:   TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
3154 %s
3155 #+EXPORT_SELECT_TAGS: %s
3156 #+EXPORT_EXCLUDE_TAGS: %s
3157 #+LINK_UP:   %s
3158 #+LINK_HOME: %s
3159 #+XSLT:
3160 #+CATEGORY:  %s
3161 #+SEQ_TODO:  %s
3162 #+TYP_TODO:  %s
3163 #+PRIORITIES: %c %c %c
3164 #+DRAWERS:   %s
3165 #+STARTUP:   %s %s %s %s %s
3166 #+TAGS:      %s
3167 #+FILETAGS:  %s
3168 #+ARCHIVE:   %s
3169 #+LINK:      %s
3170 "
3171    (buffer-name) (user-full-name) user-mail-address
3172    (format-time-string (substring (car org-time-stamp-formats) 1 -1))
3173    org-export-default-language
3174    org-export-headline-levels
3175    org-export-with-section-numbers
3176    org-export-with-toc
3177    org-export-preserve-breaks
3178    org-export-html-expand
3179    org-export-with-fixed-width
3180    org-export-with-tables
3181    org-export-with-sub-superscripts
3182    org-export-with-special-strings
3183    org-export-with-footnotes
3184    org-export-with-emphasize
3185    org-export-with-timestamps
3186    org-export-with-TeX-macros
3187    org-export-with-LaTeX-fragments
3188    org-export-skip-text-before-1st-heading
3189    org-export-with-drawers
3190    org-export-with-todo-keywords
3191    org-export-with-priority
3192    org-export-with-tags
3193    (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
3194    (mapconcat 'identity org-export-select-tags " ")
3195    (mapconcat 'identity org-export-exclude-tags " ")
3196    org-export-html-link-up
3197    org-export-html-link-home
3198    (or (ignore-errors
3199          (file-name-sans-extension
3200           (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
3201        "NOFILENAME")
3202    "TODO FEEDBACK VERIFY DONE"
3203    "Me Jason Marie DONE"
3204    org-highest-priority org-lowest-priority org-default-priority
3205    (mapconcat 'identity org-drawers " ")
3206    (cdr (assoc org-startup-folded
3207                '((nil . "showall") (t . "overview") (content . "content"))))
3208    (if org-odd-levels-only "odd" "oddeven")
3209    (if org-hide-leading-stars "hidestars" "showstars")
3210    (if org-startup-align-all-tables "align" "noalign")
3211    (cond ((eq org-log-done t) "logdone")
3212          ((equal org-log-done 'note) "lognotedone")
3213          ((not org-log-done) "nologdone"))
3214    (or (mapconcat (lambda (x)
3215                     (cond
3216                      ((equal :startgroup (car x)) "{")
3217                      ((equal :endgroup (car x)) "}")
3218                      ((equal :newline (car x)) "")
3219                      ((cdr x) (format "%s(%c)" (car x) (cdr x)))
3220                      (t (car x))))
3221                   (or org-tag-alist (org-get-buffer-tags)) " ") "")
3222    (mapconcat 'identity org-file-tags " ")
3223    org-archive-location
3224    "org file:~/org/%s.org"))
3225
3226 ;;;###autoload
3227 (defun org-insert-export-options-template ()
3228   "Insert into the buffer a template with information for exporting."
3229   (interactive)
3230   (if (not (bolp)) (newline))
3231   (let ((s (org-get-current-options)))
3232     (and (string-match "#\\+CATEGORY" s)
3233          (setq s (substring s 0 (match-beginning 0))))
3234     (insert s)))
3235
3236 (defvar org-table-colgroup-info nil)
3237
3238 (defun org-table-clean-before-export (lines &optional maybe-quoted)
3239   "Check if the table has a marking column.
3240 If yes remove the column and the special lines."
3241   (setq org-table-colgroup-info nil)
3242   (if (memq nil
3243             (mapcar
3244              (lambda (x) (or (string-match "^[ \t]*|-" x)
3245                              (string-match
3246                               (if maybe-quoted
3247                                   "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
3248                                 "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
3249                               x)))
3250              lines))
3251       ;; No special marking column
3252       (progn
3253         (setq org-table-clean-did-remove-column nil)
3254         (delq nil
3255               (mapcar
3256                (lambda (x)
3257                  (cond
3258                   ((org-table-colgroup-line-p x)
3259                    ;; This line contains colgroup info, extract it
3260                    ;; and then discard the line
3261                    (setq org-table-colgroup-info
3262                          (mapcar (lambda (x)
3263                                    (cond ((member x '("<" "&lt;")) :start)
3264                                          ((member x '(">" "&gt;")) :end)
3265                                          ((member x '("<>" "&lt;&gt;")) :startend)))
3266                                  (org-split-string x "[ \t]*|[ \t]*")))
3267                    nil)
3268                   ((org-table-cookie-line-p x)
3269                    ;; This line contains formatting cookies, discard it
3270                    nil)
3271                   (t x)))
3272                lines)))
3273     ;; there is a special marking column
3274     (setq org-table-clean-did-remove-column t)
3275     (delq nil
3276           (mapcar
3277            (lambda (x)
3278              (cond
3279               ((org-table-colgroup-line-p x)
3280                ;; This line contains colgroup info, extract it
3281                ;; and then discard the line
3282                (setq org-table-colgroup-info
3283                      (mapcar (lambda (x)
3284                                (cond ((member x '("<" "&lt;")) :start)
3285                                      ((member x '(">" "&gt;")) :end)
3286                                      ((member x '("<>" "&lt;&gt;")) :startend)))
3287                              (cdr (org-split-string x "[ \t]*|[ \t]*"))))
3288                nil)
3289               ((org-table-cookie-line-p x)
3290                ;; This line contains formatting cookies, discard it
3291                nil)
3292               ((string-match "^[ \t]*| *\\([!_^/$]\\|\\\\\\$\\) *|" x)
3293                ;; ignore this line
3294                nil)
3295               ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
3296                    (string-match "^\\([ \t]*\\)|[^|]*|" x))
3297                ;; remove the first column
3298                (replace-match "\\1|" t nil x))))
3299            lines))))
3300
3301 (defun org-export-cleanup-toc-line (s)
3302   "Remove tags and timestamps from lines going into the toc."
3303   (if (not s)
3304       "" ; Return a string when argument is nil
3305     (when (memq org-export-with-tags '(not-in-toc nil))
3306       (if (string-match (org-re " +:[[:alnum:]_@#%:]+: *$") s)
3307           (setq s (replace-match "" t t s))))
3308     (when org-export-remove-timestamps-from-toc
3309       (while (string-match org-maybe-keyword-time-regexp s)
3310         (setq s (replace-match "" t t s))))
3311     (while (string-match org-bracket-link-regexp s)
3312       (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
3313                              t t s)))
3314     (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s)
3315       (setq s (replace-match "" t t s)))
3316     s))
3317
3318
3319 (defun org-get-text-property-any (pos prop &optional object)
3320   (or (get-text-property pos prop object)
3321       (and (setq pos (next-single-property-change pos prop object))
3322            (get-text-property pos prop object))))
3323
3324 (defun org-export-get-coderef-format (path desc)
3325   (save-match-data
3326     (if (and desc (string-match
3327                    (regexp-quote (concat "(" path ")"))
3328                    desc))
3329         (replace-match "%s" t t desc)
3330       (or desc "%s"))))
3331
3332 (defun org-export-push-to-kill-ring (format)
3333   "Push buffer content to kill ring.
3334 The depends on the variable `org-export-copy-to-kill-ring'."
3335   (when org-export-copy-to-kill-ring
3336     (org-kill-new (buffer-string))
3337     (when (fboundp 'x-set-selection)
3338       (ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
3339       (ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
3340     (message "%s export done, pushed to kill ring and clipboard" format)))
3341
3342 (provide 'org-exp)
3343
3344 ;;; org-exp.el ends here