lisp/org-exp.el

   1 ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
   7 ;; Keywords: outlines, hypermedia, calendar, wp
   8 ;; Homepage: http://orgmode.org
   9 ;; Version: 6.33trans
  10 ;;
  11 ;; This file is part of GNU Emacs.
  12 ;;
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  26 ;;
  27 ;;; Commentary:
  28
  29 (require 'org)
  30 (require 'org-macs)
  31 (require 'org-agenda)
  32 (require 'org-exp-blocks)
  33 (require 'org-src)
  34 (eval-when-compile
  35   (require 'cl))
  36
  37 (declare-function org-export-latex-preprocess "org-latex" (parameters))
  38 (declare-function org-export-ascii-preprocess "org-ascii" (parameters))
  39 (declare-function org-export-html-preprocess "org-html" (parameters))
  40 (declare-function org-export-docbook-preprocess "org-docbook" (parameters))
  41 (declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
  42 (declare-function org-export-htmlize-region-for-paste "org-html" (beg end))
  43 (declare-function htmlize-buffer "ext:htmlize" (&optional buffer))
  44 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  45 (autoload 'org-export-generic "org-export-generic" "Export using the generic exporter" t)
  46 (defgroup org-export nil
  47   "Options for exporting org-listings."
  48   :tag "Org Export"
  49   :group 'org)
  50
  51 (defgroup org-export-general nil
  52   "General options for exporting Org-mode files."
  53   :tag "Org Export General"
  54   :group 'org-export)
  55
  56 (defcustom org-export-allow-BIND 'confirm
  57   "Non-nil means, allow #+BIND to define local variable values for export.
  58 This is a potential security risk, which is why the user must confirm the
  59 use of these lines."
  60   :group 'org-export-general
  61   :type '(choice
  62           (const :tag "Never" nil)
  63           (const :tag "Always" t)
  64           (const :tag "Make the user confirm for each file" confirm)))
  65
  66 ;; FIXME
  67 (defvar org-export-publishing-directory nil)
  68
  69 (defcustom org-export-show-temporary-export-buffer t
  70   "Non-nil means, show buffer after exporting to temp buffer.
  71 When Org exports to a file, the buffer visiting that file is ever
  72 shown, but remains buried.  However, when exporting to a temporary
  73 buffer, that buffer is popped up in a second window.  When this variable
  74 is nil, the buffer remains buried also in these cases."
  75   :group 'org-export-general
  76   :type 'boolean)
  77
  78 (defcustom org-export-copy-to-kill-ring t
  79   "Non-nil means, exported stuff will also be pushed onto the kill ring."
  80   :group 'org-export-general
  81   :type 'boolean)
  82
  83 (defcustom org-export-run-in-background nil
  84   "Non-nil means export and publishing commands will run in background.
  85 This works by starting up a separate Emacs process visiting the same file
  86 and doing the export from there.
  87 Not all export commands are affected by this - only the ones which
  88 actually write to a file, and that do not depend on the buffer state.
  89
  90 If this option is nil, you can still get background export by calling
  91 `org-export' with a double prefix arg: `C-u C-u C-c C-e'.
  92
  93 If this option is t, the double prefix can be used to exceptionally
  94 force an export command into the current process."
  95   :group 'org-export-general
  96   :type 'boolean)
  97
  98 (defcustom org-export-select-tags '("export")
  99   "Tags that select a tree for export.
 100 If any such tag is found in a buffer, all trees that do not carry one
 101 of these tags will be deleted before export.
 102 Inside trees that are selected like this, you can still deselect a
 103 subtree by tagging it with one of the `org-export-exclude-tags'."
 104   :group 'org-export-general
 105   :type '(repeat (string :tag "Tag")))
 106
 107 (defcustom org-export-exclude-tags '("noexport")
 108   "Tags that exclude a tree from export.
 109 All trees carrying any of these tags will be excluded from export.
 110 This is without condition, so even subtrees inside that carry one of the
 111 `org-export-select-tags' will be removed."
 112   :group 'org-export-general
 113   :type '(repeat (string :tag "Tag")))
 114
 115 ;; FIXME: rename, this is a general variable
 116 (defcustom org-export-html-expand t
 117   "Non-nil means, for HTML export, treat @<...> as HTML tag.
 118 When nil, these tags will be exported as plain text and therefore
 119 not be interpreted by a browser.
 120
 121 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
 122   :group 'org-export-html
 123   :group 'org-export-general
 124   :type 'boolean)
 125
 126 (defcustom org-export-with-special-strings t
 127   "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
 128 When this option is turned on, these strings will be exported as:
 129
 130   Org   HTML       LaTeX
 131  -----+----------+--------
 132   \\-    &shy;      \\-
 133   --    &ndash;    --
 134   ---   &mdash;    ---
 135   ...   &hellip;   \ldots
 136
 137 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
 138   :group 'org-export-translation
 139   :type 'boolean)
 140
 141 (defcustom org-export-html-link-up ""
 142   "Where should the \"UP\" link of exported HTML pages lead?"
 143   :group 'org-export-html
 144   :group 'org-export-general
 145   :type '(string :tag "File or URL"))
 146
 147 (defcustom org-export-html-link-home ""
 148   "Where should the \"HOME\" link of exported HTML pages lead?"
 149   :group 'org-export-html
 150   :group 'org-export-general
 151   :type '(string :tag "File or URL"))
 152
 153 (defcustom org-export-language-setup
 154   '(("en" "Author"     "Date"  "Table of Contents" "Footnotes")
 155     ("ca"  "Autor"      "Data" "&Iacute;ndex" "Peus de p&agrave;gina")
 156     ("cs" "Autor"      "Datum" "Obsah" "Pozn\xe1mky pod carou")
 157     ("da" "Ophavsmand" "Dato"  "Indhold" "Fodnoter")
 158     ("de" "Autor"      "Datum" "Inhaltsverzeichnis" "Fu&szlig;noten")
 159     ("eo"  "A&#365;toro"      "Dato" "Enhavo" "Piednotoj")
 160     ("es" "Autor"      "Fecha" "&Iacute;ndice" "Pies de p&aacute;gina")
 161     ("fi" "Tekij&auml;"     "P&auml;iv&auml;m&auml;&auml;r&auml;"   "Sis&auml;llysluettelo"  "Alaviitteet")
 162     ("fr" "Auteur"     "Date"  "Table des mati&egrave;res" "Notes de bas de page")
 163     ("hu" "Szerz&otilde;" "D&aacute;tum" "Tartalomjegyz&eacute;k" "L&aacute;bjegyzet")
 164     ("is" "H&ouml;fundur" "Dagsetning" "Efnisyfirlit" "Aftanm&aacute;lsgreinar")
 165     ("it" "Autore"     "Data"  "Indice" "Note a pi&egrave; di pagina")
 166     ("nl" "Auteur"     "Datum" "Inhoudsopgave" "Voetnoten")
 167     ("no" "Forfatter"  "Dato"  "Innhold" "Fotnoter")
 168     ("nb" "Forfatter"  "Dato"  "Innhold" "Fotnoter")  ;; nb = Norsk (bokm.l)
 169     ("nn" "Forfattar"  "Dato"  "Innhald" "Fotnotar")  ;; nn = Norsk (nynorsk)
 170     ("pl" "Autor"      "Data" "Spis tre&sacute;ci"  "Przypis")
 171     ("sv" "F&ouml;rfattare" "Datum" "Inneh&aring;ll" "Fotnoter"))
 172   "Terms used in export text, translated to different languages.
 173 Use the variable `org-export-default-language' to set the language,
 174 or use the +OPTION lines for a per-file setting."
 175   :group 'org-export-general
 176   :type '(repeat
 177           (list
 178            (string :tag "HTML language tag")
 179            (string :tag "Author")
 180            (string :tag "Date")
 181            (string :tag "Table of Contents")
 182            (string :tag "Footnotes"))))
 183
 184 (defcustom org-export-default-language "en"
 185   "The default language of HTML export, as a string.
 186 This should have an association in `org-export-language-setup'."
 187   :group 'org-export-general
 188   :type 'string)
 189
 190 (defvar org-export-page-description ""
 191   "The page description, for the XHTML meta tag.
 192 This is best set with the #+DESCRIPTION line in a file, it does not make
 193 sense to set this globally.")
 194
 195 (defvar org-export-page-keywords ""
 196   "The page description, for the XHTML meta tag.
 197 This is best set with the #+KEYWORDS line in a file, it does not make
 198 sense to set this globally.")
 199
 200 (defcustom org-export-skip-text-before-1st-heading nil
 201   "Non-nil means, skip all text before the first headline when exporting.
 202 When nil, that text is exported as well."
 203   :group 'org-export-general
 204   :type 'boolean)
 205
 206 (defcustom org-export-headline-levels 3
 207   "The last level which is still exported as a headline.
 208 Inferior levels will produce itemize lists when exported.
 209 Note that a numeric prefix argument to an exporter function overrides
 210 this setting.
 211
 212 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
 213   :group 'org-export-general
 214   :type 'integer)
 215
 216 (defcustom org-export-with-section-numbers t
 217   "Non-nil means, add section numbers to headlines when exporting.
 218
 219 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
 220   :group 'org-export-general
 221   :type 'boolean)
 222
 223 (defcustom org-export-section-number-format '((("1" ".")) . "")
 224   "Format of section numbers for export.
 225 The variable has two components.
 226 1. A list of lists, each indicating a counter type and a separator.
 227    The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"a\".
 228    It causes causes numeric, alphabetic, or roman counters, respectively.
 229    The separator is only used if another counter for a subsection is being
 230    added.
 231    If there are more numbered section levels than entries in this lists,
 232    then the last entry will be reused.
 233 2. A terminator string that will be added after the entire
 234    section number."
 235   :group 'org-export-general
 236   :type '(cons
 237           (repeat
 238            (list
 239             (string :tag "Counter Type")
 240             (string :tag "Separator   ")))
 241           (string :tag "Terminator")))
 242
 243 (defcustom org-export-with-toc t
 244   "Non-nil means, create a table of contents in exported files.
 245 The TOC contains headlines with levels up to`org-export-headline-levels'.
 246 When an integer, include levels up to N in the toc, this may then be
 247 different from `org-export-headline-levels', but it will not be allowed
 248 to be larger than the number of headline levels.
 249 When nil, no table of contents is made.
 250
 251 Headlines which contain any TODO items will be marked with \"(*)\" in
 252 ASCII export, and with red color in HTML output, if the option
 253 `org-export-mark-todo-in-toc' is set.
 254
 255 In HTML output, the TOC will be clickable.
 256
 257 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
 258 or \"toc:3\"."
 259   :group 'org-export-general
 260   :type '(choice
 261           (const :tag "No Table of Contents" nil)
 262           (const :tag "Full Table of Contents" t)
 263           (integer :tag "TOC to level")))
 264
 265 (defcustom org-export-mark-todo-in-toc nil
 266   "Non-nil means, mark TOC lines that contain any open TODO items."
 267   :group 'org-export-general
 268   :type 'boolean)
 269
 270 (defcustom org-export-with-todo-keywords t
 271   "Non-nil means, include TODO keywords in export.
 272 When nil, remove all these keywords from the export."
 273   :group 'org-export-general
 274   :type 'boolean)
 275
 276 (defcustom org-export-with-priority nil
 277   "Non-nil means, include priority cookies in export.
 278 When nil, remove priority cookies for export."
 279   :group 'org-export-general
 280   :type 'boolean)
 281
 282 (defcustom org-export-preserve-breaks nil
 283   "Non-nil means, preserve all line breaks when exporting.
 284 Normally, in HTML output paragraphs will be reformatted.  In ASCII
 285 export, line breaks will always be preserved, regardless of this variable.
 286
 287 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
 288   :group 'org-export-general
 289   :type 'boolean)
 290
 291 (defcustom org-export-with-archived-trees 'headline
 292   "Whether subtrees with the ARCHIVE tag should be exported.
 293 This can have three different values
 294 nil       Do not export, pretend this tree is not present
 295 t         Do export the entire tree
 296 headline  Only export the headline, but skip the tree below it."
 297   :group 'org-export-general
 298   :group 'org-archive
 299   :type '(choice
 300           (const :tag "not at all" nil)
 301           (const :tag "headline only" 'headline)
 302           (const :tag "entirely" t)))
 303
 304 (defcustom org-export-author-info t
 305   "Non-nil means, insert author name and email into the exported file.
 306
 307 This option can also be set with the +OPTIONS line,
 308 e.g. \"author-info:nil\"."
 309   :group 'org-export-general
 310   :type 'boolean)
 311
 312 (defcustom org-export-creator-info t
 313   "Non-nil means, the postamble should contain a creator sentence.
 314 This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
 315   :group 'org-export-general
 316   :type 'boolean)
 317
 318 (defcustom org-export-time-stamp-file t
 319   "Non-nil means, insert a time stamp into the exported file.
 320 The time stamp shows when the file was created.
 321
 322 This option can also be set with the +OPTIONS line,
 323 e.g. \"timestamp:nil\"."
 324   :group 'org-export-general
 325   :type 'boolean)
 326
 327 (defcustom org-export-with-timestamps t
 328   "If nil, do not export time stamps and associated keywords."
 329   :group 'org-export-general
 330   :type 'boolean)
 331
 332 (defcustom org-export-remove-timestamps-from-toc t
 333   "If t, remove timestamps from the table of contents entries."
 334   :group 'org-export-general
 335   :type 'boolean)
 336
 337 (defcustom org-export-with-tags 'not-in-toc
 338   "If nil, do not export tags, just remove them from headlines.
 339 If this is the symbol `not-in-toc', tags will be removed from table of
 340 contents entries, but still be shown in the headlines of the document.
 341
 342 This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
 343   :group 'org-export-general
 344   :type '(choice
 345           (const :tag "Off" nil)
 346           (const :tag "Not in TOC" not-in-toc)
 347           (const :tag "On" t)))
 348
 349 (defcustom org-export-with-drawers nil
 350   "Non-nil means, export with drawers like the property drawer.
 351 When t, all drawers are exported.  This may also be a list of
 352 drawer names to export."
 353   :group 'org-export-general
 354   :type '(choice
 355           (const :tag "All drawers" t)
 356           (const :tag "None" nil)
 357           (repeat :tag "Selected drawers"
 358                   (string :tag "Drawer name"))))
 359
 360 (defvar org-export-first-hook nil
 361   "Hook called as the first thing in each exporter.
 362 Good for general initialization")
 363
 364 (defvar org-export-preprocess-hook nil
 365   "Hook for preprocessing an export buffer.
 366 Pretty much the first thing when exporting is running this hook.")
 367
 368 (defvar org-export-preprocess-after-include-files-hook nil
 369   "Hook for preprocessing an export buffer.
 370 This is run after the contents of included files have been inserted.")
 371
 372 (defvar org-export-preprocess-after-tree-selection-hook nil
 373   "Hook for preprocessing an export buffer.
 374 This is run after selection of trees to be exported has happened.
 375 This selection includes tags-based selection, as well as removal
 376 of commented and archived trees.")
 377
 378 (defvar org-export-preprocess-before-selecting-backend-code-hook nil
 379   "Hook for preprocessing an export buffer.
 380 This is run just before backend-specific blocks get selected.")
 381
 382 (defvar org-export-preprocess-after-blockquote-hook nil
 383   "Hook for preprocessing an export buffer.
 384 This is run after blockquote/quote/verse/center have been marked
 385 with cookies.")
 386
 387 (defvar org-export-preprocess-before-backend-specifics-hook nil
 388   "Hook run before backend-specific functions are called during preprocessing.")
 389
 390 (defvar org-export-preprocess-final-hook nil
 391   "Hook for preprocessing an export buffer.
 392 This is run as the last thing in the preprocessing buffer, just before
 393 returning the buffer string to the backend.")
 394
 395 (defgroup org-export-translation nil
 396   "Options for translating special ascii sequences for the export backends."
 397   :tag "Org Export Translation"
 398   :group 'org-export)
 399
 400 (defcustom org-export-with-emphasize t
 401   "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
 402 If the export target supports emphasizing text, the word will be
 403 typeset in bold, italic, or underlined, respectively.  Works only for
 404 single words, but you can say: I *really* *mean* *this*.
 405 Not all export backends support this.
 406
 407 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
 408   :group 'org-export-translation
 409   :type 'boolean)
 410
 411 (defcustom org-export-with-footnotes t
 412   "If nil, export [1] as a footnote marker.
 413 Lines starting with [1] will be formatted as footnotes.
 414
 415 This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
 416   :group 'org-export-translation
 417   :type 'boolean)
 418
 419 (defcustom org-export-with-sub-superscripts t
 420   "Non-nil means, interpret \"_\" and \"^\" for export.
 421 When this option is turned on, you can use TeX-like syntax for sub- and
 422 superscripts.  Several characters after \"_\" or \"^\" will be
 423 considered as a single item - so grouping with {} is normally not
 424 needed.  For example, the following things will be parsed as single
 425 sub- or superscripts.
 426
 427  10^24   or   10^tau     several digits will be considered 1 item.
 428  10^-12  or   10^-tau    a leading sign with digits or a word
 429  x^2-y^3                 will be read as x^2 - y^3, because items are
 430                          terminated by almost any nonword/nondigit char.
 431  x_{i^2} or   x^(2-i)    braces or parenthesis do grouping.
 432
 433 Still, ambiguity is possible - so when in doubt use {} to enclose the
 434 sub/superscript.  If you set this variable to the symbol `{}',
 435 the braces are *required* in order to trigger interpretations as
 436 sub/superscript.  This can be helpful in documents that need \"_\"
 437 frequently in plain text.
 438
 439 Not all export backends support this, but HTML does.
 440
 441 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
 442   :group 'org-export-translation
 443   :type '(choice
 444           (const :tag "Always interpret" t)
 445           (const :tag "Only with braces" {})
 446           (const :tag "Never interpret" nil)))
 447
 448 (defcustom org-export-with-TeX-macros t
 449   "Non-nil means, interpret simple TeX-like macros when exporting.
 450 For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
 451 Not only real TeX macros will work here, but the standard HTML entities
 452 for math can be used as macro names as well.  For a list of supported
 453 names in HTML export, see the constant `org-html-entities'.
 454 Not all export backends support this.
 455
 456 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
 457   :group 'org-export-translation
 458   :group 'org-export-latex
 459   :type 'boolean)
 460
 461 (defcustom org-export-with-LaTeX-fragments nil
 462   "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
 463 When set, the exporter will find LaTeX environments if the \\begin line is
 464 the first non-white thing on a line.  It will also find the math delimiters
 465 like $a=b$ and \\( a=b \\) for inline math,  $$a=b$$ and \\[ a=b \\] for
 466 display math.
 467
 468 This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\".
 469
 470 The default is nil, because this option needs the `dvipng' program which
 471 is not available on all systems."
 472   :group 'org-export-translation
 473   :group 'org-export-latex
 474   :type 'boolean)
 475
 476 (defcustom org-export-with-fixed-width t
 477   "Non-nil means, lines starting with \":\" will be in fixed width font.
 478 This can be used to have pre-formatted text, fragments of code etc.  For
 479 example:
 480   : ;; Some Lisp examples
 481   : (while (defc cnt)
 482   :   (ding))
 483 will be looking just like this in also HTML.  See also the QUOTE keyword.
 484 Not all export backends support this.
 485
 486 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
 487   :group 'org-export-translation
 488   :type 'boolean)
 489
 490 (defcustom org-match-sexp-depth 3
 491   "Number of stacked braces for sub/superscript matching.
 492 This has to be set before loading org.el to be effective."
 493   :group 'org-export-translation
 494   :type 'integer)
 495
 496 (defgroup org-export-tables nil
 497   "Options for exporting tables in Org-mode."
 498   :tag "Org Export Tables"
 499   :group 'org-export)
 500
 501 (defcustom org-export-with-tables t
 502   "If non-nil, lines starting with \"|\" define a table.
 503 For example:
 504
 505   | Name        | Address  | Birthday  |
 506   |-------------+----------+-----------|
 507   | Arthur Dent | England  | 29.2.2100 |
 508
 509 Not all export backends support this.
 510
 511 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
 512   :group 'org-export-tables
 513   :type 'boolean)
 514
 515 (defcustom org-export-highlight-first-table-line t
 516   "Non-nil means, highlight the first table line.
 517 In HTML export, this means use <th> instead of <td>.
 518 In tables created with table.el, this applies to the first table line.
 519 In Org-mode tables, all lines before the first horizontal separator
 520 line will be formatted with <th> tags."
 521   :group 'org-export-tables
 522   :type 'boolean)
 523
 524 (defcustom org-export-table-remove-special-lines t
 525   "Remove special lines and marking characters in calculating tables.
 526 This removes the special marking character column from tables that are set
 527 up for spreadsheet calculations.  It also removes the entire lines
 528 marked with `!', `_', or `^'.  The lines with `$' are kept, because
 529 the values of constants may be useful to have."
 530   :group 'org-export-tables
 531   :type 'boolean)
 532
 533 (defcustom org-export-prefer-native-exporter-for-tables nil
 534   "Non-nil means, always export tables created with table.el natively.
 535 Natively means, use the HTML code generator in table.el.
 536 When nil, Org-mode's own HTML generator is used when possible (i.e. if
 537 the table does not use row- or column-spanning).  This has the
 538 advantage, that the automatic HTML conversions for math symbols and
 539 sub/superscripts can be applied.  Org-mode's HTML generator is also
 540 much faster."
 541   :group 'org-export-tables
 542   :type 'boolean)
 543
 544
 545 (defgroup org-export-xml nil
 546   "Options specific for XML export of Org-mode files."
 547   :tag "Org Export XML"
 548   :group 'org-export)
 549
 550 ;;;; Exporting
 551
 552 ;;; Variables, constants, and parameter plists
 553
 554 (defconst org-level-max 20)
 555
 556 (defvar org-current-export-file nil) ; dynamically scoped parameter
 557 (defvar org-current-export-dir nil) ; dynamically scoped parameter
 558 (defvar org-export-opt-plist nil
 559   "Contains the current option plist.")
 560 (defvar org-last-level nil) ; dynamically scoped variable
 561 (defvar org-min-level nil) ; dynamically scoped variable
 562 (defvar org-levels-open nil) ; dynamically scoped parameter
 563
 564 (defconst org-export-plist-vars
 565   '((:link-up                 nil         org-export-html-link-up)
 566     (:link-home               nil         org-export-html-link-home)
 567     (:language                nil         org-export-default-language)
 568     (:keywords                nil         org-export-page-keywords)
 569     (:description             nil         org-export-page-description)
 570     (:customtime              nil         org-display-custom-times)
 571     (:headline-levels         "H"         org-export-headline-levels)
 572     (:section-numbers         "num"       org-export-with-section-numbers)
 573     (:section-number-format   nil         org-export-section-number-format)
 574     (:table-of-contents       "toc"       org-export-with-toc)
 575     (:preserve-breaks         "\\n"       org-export-preserve-breaks)
 576     (:archived-trees          nil         org-export-with-archived-trees)
 577     (:emphasize               "*"         org-export-with-emphasize)
 578     (:sub-superscript         "^"         org-export-with-sub-superscripts)
 579     (:special-strings         "-"         org-export-with-special-strings)
 580     (:footnotes               "f"         org-export-with-footnotes)
 581     (:drawers                 "d"         org-export-with-drawers)
 582     (:tags                    "tags"      org-export-with-tags)
 583     (:todo-keywords           "todo"      org-export-with-todo-keywords)
 584     (:priority                "pri"       org-export-with-priority)
 585     (:TeX-macros              "TeX"       org-export-with-TeX-macros)
 586     (:LaTeX-fragments         "LaTeX"     org-export-with-LaTeX-fragments)
 587     (:latex-listings          nil         org-export-latex-listings)
 588     (:skip-before-1st-heading "skip"      org-export-skip-text-before-1st-heading)
 589     (:fixed-width             ":"         org-export-with-fixed-width)
 590     (:timestamps              "<"         org-export-with-timestamps)
 591     (:author-info             "author"    org-export-author-info)
 592     (:creator-info            "creator"   org-export-creator-info)
 593     (:time-stamp-file         "timestamp" org-export-time-stamp-file)
 594     (:tables                  "|"         org-export-with-tables)
 595     (:table-auto-headline     nil         org-export-highlight-first-table-line)
 596     (:style-include-default   nil         org-export-html-style-include-default)
 597     (:style-include-scripts   nil         org-export-html-style-include-scripts)
 598     (:style                   nil         org-export-html-style)
 599     (:style-extra             nil         org-export-html-style-extra)
 600     (:agenda-style            nil         org-agenda-export-html-style)
 601     (:convert-org-links       nil         org-export-html-link-org-files-as-html)
 602     (:inline-images           nil         org-export-html-inline-images)
 603     (:html-extension          nil         org-export-html-extension)
 604     (:xml-declaration         nil         org-export-html-xml-declaration)
 605     (:html-table-tag          nil         org-export-html-table-tag)
 606     (:expand-quoted-html      "@"         org-export-html-expand)
 607     (:timestamp               nil         org-export-html-with-timestamp)
 608     (:publishing-directory    nil         org-export-publishing-directory)
 609     (:preamble                nil         org-export-html-preamble)
 610     (:postamble               nil         org-export-html-postamble)
 611     (:auto-preamble           nil         org-export-html-auto-preamble)
 612     (:auto-postamble          nil         org-export-html-auto-postamble)
 613     (:author                  nil         user-full-name)
 614     (:email                   nil         user-mail-address)
 615     (:select-tags             nil         org-export-select-tags)
 616     (:exclude-tags            nil         org-export-exclude-tags)
 617
 618     (:latex-image-options     nil         org-export-latex-image-default-option))
 619   "List of properties that represent export/publishing variables.
 620 Each element is a list of 3 items:
 621 1. The property that is used internally, and also for org-publish-project-alist
 622 2. The string that can be used in the OPTION lines to set this option,
 623    or nil if this option cannot be changed in this way
 624 3. The customization variable that sets the default for this option."
 625 )
 626
 627 (defun org-default-export-plist ()
 628   "Return the property list with default settings for the export variables."
 629   (let* ((infile (org-infile-export-plist))
 630          (letbind (plist-get infile :let-bind))
 631          (l org-export-plist-vars) rtn e s v)
 632     (while (setq e (pop l))
 633       (setq s (nth 2 e)
 634             v (cond
 635                ((assq s letbind) (nth 1 (assq s letbind)))
 636                ((boundp s) (symbol-value s))
 637                (t nil))
 638             rtn (cons (car e) (cons v rtn))))
 639     rtn))
 640
 641 (defvar org-export-inbuffer-options-extra nil
 642   "List of additional in-buffer options that should be detected.
 643 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
 644 etc.  Extensions can add to this list to get their options detected, and they
 645 can then add a function to `org-export-options-filters' to process these
 646 options.
 647 Each element in this list must be a list, with the in-buffer keyword as car,
 648 and a property (a symbol) as the next element.  All occurrences of the
 649 keyword will be found, the values concatenated with a space character
 650 in between, and the result stored in the export options property list.")
 651
 652 (defvar org-export-options-filters nil
 653   "Functions to be called to finalize the export/publishing options.
 654 All these options are stored in a property list, and each of the functions
 655 in this hook gets a chance to modify this property list.  Each function
 656 must accept the property list as an argument, and must return the (possibly
 657 modified) list.")
 658
 659 ;; FIXME: should we fold case here?
 660 (defun org-infile-export-plist ()
 661   "Return the property list with file-local settings for export."
 662   (save-excursion
 663     (save-restriction
 664       (widen)
 665       (goto-char (point-min))
 666       (let ((re (org-make-options-regexp
 667                  (append
 668                   '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
 669                     "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
 670                     "LATEX_HEADER" "LATEX_CLASS"
 671                     "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
 672                     "KEYWORDS" "DESCRIPTION" "MACRO" "BIND")
 673                   (mapcar 'car org-export-inbuffer-options-extra))))
 674             p key val text options a pr style
 675             latex-header latex-class macros letbind
 676             ext-setup-or-nil setup-contents (start 0))
 677         (while (or (and ext-setup-or-nil
 678                         (string-match re ext-setup-or-nil start)
 679                         (setq start (match-end 0)))
 680                    (and (setq ext-setup-or-nil nil start 0)
 681                         (re-search-forward re nil t)))
 682           (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
 683                 val (org-match-string-no-properties 2 ext-setup-or-nil))
 684           (cond
 685            ((setq a (assoc key org-export-inbuffer-options-extra))
 686             (setq pr (nth 1 a))
 687             (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
 688            ((string-equal key "TITLE") (setq p (plist-put p :title val)))
 689            ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
 690            ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
 691            ((string-equal key "DATE") (setq p (plist-put p :date val)))
 692            ((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
 693            ((string-equal key "DESCRIPTION")
 694             (setq p (plist-put p :description val)))
 695            ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
 696            ((string-equal key "STYLE")
 697             (setq style (concat style "\n" val)))
 698            ((string-equal key "LATEX_HEADER")
 699             (setq latex-header (concat latex-header "\n" val)))
 700            ((string-equal key "LATEX_CLASS")
 701             (setq latex-class val))
 702            ((string-equal key "TEXT")
 703             (setq text (if text (concat text "\n" val) val)))
 704            ((string-equal key "OPTIONS")
 705             (setq options (concat val " " options)))
 706            ((string-equal key "BIND")
 707             (push (read (concat "(" val ")")) letbind))
 708            ((string-equal key "LINK_UP")
 709             (setq p (plist-put p :link-up val)))
 710            ((string-equal key "LINK_HOME")
 711             (setq p (plist-put p :link-home val)))
 712            ((string-equal key "EXPORT_SELECT_TAGS")
 713             (setq p (plist-put p :select-tags (org-split-string val))))
 714            ((string-equal key "EXPORT_EXCLUDE_TAGS")
 715             (setq p (plist-put p :exclude-tags (org-split-string val))))
 716            ((string-equal key "MACRO")
 717             (push val macros))
 718            ((equal key "SETUPFILE")
 719             (setq setup-contents (org-file-contents
 720                                   (expand-file-name
 721                                    (org-remove-double-quotes
 722                                     (org-trim val)))
 723                                   'noerror))
 724             (if (not ext-setup-or-nil)
 725                 (setq ext-setup-or-nil setup-contents start 0)
 726               (setq ext-setup-or-nil
 727                     (concat (substring ext-setup-or-nil 0 start)
 728                             "\n" setup-contents "\n"
 729                             (substring ext-setup-or-nil start)))))))
 730         (setq p (plist-put p :text text))
 731         (when (and letbind (org-export-confirm-letbind))
 732           (setq p (plist-put p :let-bind letbind)))
 733         (when style (setq p (plist-put p :style-extra style)))
 734         (when latex-header
 735           (setq p (plist-put p :latex-header-extra (substring latex-header 1))))
 736         (when latex-class
 737           (setq p (plist-put p :latex-class latex-class)))
 738         (when options
 739           (setq p (org-export-add-options-to-plist p options)))
 740         ;; Add macro definitions
 741         (setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
 742         (setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
 743         (setq p (plist-put
 744                  p :macro-modification-time
 745                  (and (buffer-file-name)
 746                       (file-exists-p (buffer-file-name))
 747                       (concat
 748                        "(eval (format-time-string \"$1\" '"
 749                        (prin1-to-string (nth 5 (file-attributes
 750                                                 (buffer-file-name))))
 751                        "))"))))
 752         (setq p (plist-put p :macro-input-file (and (buffer-file-name)
 753                                                     (file-name-nondirectory
 754                                                      (buffer-file-name)))))
 755         (while (setq val (pop macros))
 756           (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
 757             (setq p (plist-put
 758                      p (intern
 759                         (concat ":macro-" (downcase (match-string 1 val))))
 760                      (org-export-interpolate-newlines (match-string 2 val))))))
 761         p))))
 762
 763 (defun org-export-interpolate-newlines (s)
 764   (while (string-match "\\\\n" s)
 765     (setq s (replace-match "\n" t t s)))
 766   s)
 767
 768 (defvar org-export-allow-BIND-local nil)
 769 (defun org-export-confirm-letbind ()
 770   "Can we use #+BIND values during export?
 771 By default this will ask fro confirmation by the user, to divert possible
 772 security risks."
 773   (cond
 774    ((not org-export-allow-BIND) nil)
 775    ((eq org-export-allow-BIND t) t)
 776    ((local-variable-p 'org-export-allow-BIND-local (current-buffer))
 777     org-export-allow-BIND-local)
 778    (t (org-set-local 'org-export-allow-BIND-local
 779                      (yes-or-no-p "Allow BIND values in this buffer? ")))))
 780
 781 (defun org-install-letbind ()
 782   "Install the values from #+BIND lines as local variables."
 783   (let ((letbind (plist-get org-export-opt-plist :let-bind)))
 784     (while letbind
 785       (org-set-local (caar letbind) (nth 1 (pop letbind))))))
 786
 787 (defun org-export-add-options-to-plist (p options)
 788   "Parse an OPTIONS line and set values in the property list P."
 789   (let (o)
 790     (when options
 791       (let ((op org-export-plist-vars))
 792         (while (setq o (pop op))
 793           (if (and (nth 1 o)
 794                    (string-match (concat (regexp-quote (nth 1 o))
 795                                          ":\\([^ \t\n\r;,.]*\\)")
 796                                  options))
 797               (setq p (plist-put p (car o)
 798                                  (car (read-from-string
 799                                        (match-string 1 options))))))))))
 800   p)
 801
 802 (defun org-export-add-subtree-options (p pos)
 803   "Add options in subtree at position POS to property list P."
 804   (save-excursion
 805     (goto-char pos)
 806     (when (org-at-heading-p)
 807       (let (a)
 808         ;; This is actually read in `org-export-get-title-from-subtree'
 809         ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
 810         ;;   (setq p (plist-put p :title a)))
 811         (when (setq a (org-entry-get pos "EXPORT_TEXT"))
 812           (setq p (plist-put p :text a)))
 813         (when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
 814           (setq p (plist-put p :author a)))
 815         (when (setq a (org-entry-get pos "EXPORT_DATE"))
 816           (setq p (plist-put p :date a)))
 817         (when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
 818           (setq p (org-export-add-options-to-plist p a)))))
 819     p))
 820
 821 (defun org-export-directory (type plist)
 822   (let* ((val (plist-get plist :publishing-directory))
 823          (dir (if (listp val)
 824                   (or (cdr (assoc type val)) ".")
 825                 val)))
 826     dir))
 827
 828 (defun org-export-process-option-filters (plist)
 829   (let ((functions org-export-options-filters) f)
 830     (while (setq f (pop functions))
 831       (setq plist (funcall f plist))))
 832   plist)
 833
 834 ;;;###autoload
 835 (defun org-export (&optional arg)
 836   "Export dispatcher for Org-mode.
 837 When `org-export-run-in-background' is non-nil, try to run the command
 838 in the background.  This will be done only for commands that write
 839 to a file.  For details see the docstring of `org-export-run-in-background'.
 840
 841 The prefix argument ARG will be passed to the exporter.  However, if
 842 ARG is a double universal prefix `C-u C-u', that means to inverse the
 843 value of `org-export-run-in-background'."
 844   (interactive "P")
 845   (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
 846          subtree-p
 847          (help "[t]   insert the export option template
 848 \[v]   limit export to visible part of outline tree
 849 \[1]   only export the current subtree
 850
 851 \[a] export as ASCII   [A] to temporary buffer
 852
 853 \[h] export as HTML    [H] to temporary buffer   [R] export region
 854 \[b] export as HTML and open in browser
 855
 856 \[l] export as LaTeX   [L] to temporary buffer
 857 \[p] export as LaTeX and process to PDF
 858 \[d] export as LaTeX, process to PDF, and open the resulting PDF document
 859
 860 \[D] export as DocBook
 861 \[V] export as DocBook, process to PDF, and open the resulting PDF document
 862
 863 \[m] export as Freemind mind map
 864
 865 \[x] export as XOXO
 866 \[g] export using Wes Hardaker's generic exporter
 867
 868 \[i] export current file as iCalendar file
 869 \[I] export all agenda files as iCalendar files
 870 \[c] export agenda files into combined iCalendar file
 871
 872 \[F] publish current file          [P] publish current project
 873 \[X] publish a project...          [E] publish every projects")
 874          (cmds
 875           '((?t org-insert-export-options-template nil)
 876             (?v org-export-visible nil)
 877             (?a org-export-as-ascii t)
 878             (?A org-export-as-ascii-to-buffer t)
 879             (?h org-export-as-html t)
 880             (?b org-export-as-html-and-open t)
 881             (?H org-export-as-html-to-buffer nil)
 882             (?R org-export-region-as-html nil)
 883             (?x org-export-as-xoxo t)
 884             (?g org-export-generic t)
 885             (?D org-export-as-docbook t)
 886             (?V org-export-as-docbook-pdf-and-open t)
 887             (?m org-export-as-freemind t)
 888             (?l org-export-as-latex t)
 889             (?p org-export-as-pdf t)
 890             (?d org-export-as-pdf-and-open t)
 891             (?L org-export-as-latex-to-buffer nil)
 892             (?i org-export-icalendar-this-file t)
 893             (?I org-export-icalendar-all-agenda-files t)
 894             (?c org-export-icalendar-combine-agenda-files t)
 895             (?F org-publish-current-file t)
 896             (?P org-publish-current-project t)
 897             (?X org-publish t)
 898             (?E org-publish-all t)))
 899          r1 r2 ass)
 900     (save-excursion
 901       (save-window-excursion
 902         (delete-other-windows)
 903         (with-output-to-temp-buffer "*Org Export/Publishing Help*"
 904           (princ help))
 905         (org-fit-window-to-buffer (get-buffer-window
 906                                    "*Org Export/Publishing Help*"))
 907         (message "Select command: ")
 908         (setq r1 (read-char-exclusive))
 909         (when (eq r1 ?1)
 910           (setq subtree-p t)
 911           (message "Select command (for subtree): ")
 912           (setq r1 (read-char-exclusive)))))
 913     (setq r2 (if (< r1 27) (+ r1 96) r1))
 914     (unless (setq ass (assq r2 cmds))
 915       (error "No command associated with key %c" r1))
 916     (if (and bg (nth 2 ass)
 917              (not (buffer-base-buffer))
 918              (not (org-region-active-p)))
 919         ;; execute in background
 920         (let ((p (start-process
 921                   (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
 922                   "*Org Processes*"
 923                   (expand-file-name invocation-name invocation-directory)
 924                   "-batch"
 925                   "-l" user-init-file
 926                   "--eval" "(require 'org-exp)"
 927                   "--eval" "(setq org-wait .2)"
 928                   (buffer-file-name)
 929                   "-f" (symbol-name (nth 1 ass)))))
 930           (set-process-sentinel p 'org-export-process-sentinel)
 931           (message "Background process \"%s\": started" p))
 932       ;; background processing not requested, or not possible
 933       (if subtree-p (outline-mark-subtree))
 934       (call-interactively (nth 1 ass)))))
 935
 936 (defun org-export-process-sentinel (process status)
 937   (if (string-match "\n+\\'" status)
 938       (setq status (substring status 0 -1)))
 939   (message "Background process \"%s\": %s" process status))
 940
 941 (defconst org-html-entities
 942   '(("nbsp")
 943     ("iexcl")
 944     ("cent")
 945     ("pound")
 946     ("curren")
 947     ("yen")
 948     ("brvbar")
 949     ("vert" . "&#124;")
 950     ("sect")
 951     ("uml")
 952     ("copy")
 953     ("ordf")
 954     ("laquo")
 955     ("not")
 956     ("shy")
 957     ("reg")
 958     ("macr")
 959     ("deg")
 960     ("pm" . "&plusmn;")
 961     ("plusmn")
 962     ("sup2")
 963     ("sup3")
 964     ("acute")
 965     ("micro")
 966     ("para")
 967     ("middot")
 968     ("odot"."o")
 969     ("star"."*")
 970     ("cedil")
 971     ("sup1")
 972     ("ordm")
 973     ("raquo")
 974     ("frac14")
 975     ("frac12")
 976     ("frac34")
 977     ("iquest")
 978     ("Agrave")
 979     ("Aacute")
 980     ("Acirc")
 981     ("Atilde")
 982     ("Auml")
 983     ("Aring") ("AA"."&Aring;")
 984     ("AElig")
 985     ("Ccedil")
 986     ("Egrave")
 987     ("Eacute")
 988     ("Ecirc")
 989     ("Euml")
 990     ("Igrave")
 991     ("Iacute")
 992     ("Icirc")
 993     ("Iuml")
 994     ("ETH")
 995     ("Ntilde")
 996     ("Ograve")
 997     ("Oacute")
 998     ("Ocirc")
 999     ("Otilde")
1000     ("Ouml")
1001     ("times")
1002     ("Oslash")
1003     ("Ugrave")
1004     ("Uacute")
1005     ("Ucirc")
1006     ("Uuml")
1007     ("Yacute")
1008     ("THORN")
1009     ("szlig")
1010     ("agrave")
1011     ("aacute")
1012     ("acirc")
1013     ("atilde")
1014     ("auml")
1015     ("aring")
1016     ("aelig")
1017     ("ccedil")
1018     ("egrave")
1019     ("eacute")
1020     ("ecirc")
1021     ("euml")
1022     ("igrave")
1023     ("iacute")
1024     ("icirc")
1025     ("iuml")
1026     ("eth")
1027     ("ntilde")
1028     ("ograve")
1029     ("oacute")
1030     ("ocirc")
1031     ("otilde")
1032     ("ouml")
1033     ("divide")
1034     ("oslash")
1035     ("ugrave")
1036     ("uacute")
1037     ("ucirc")
1038     ("uuml")
1039     ("yacute")
1040     ("thorn")
1041     ("yuml")
1042     ("fnof")
1043     ("Alpha")
1044     ("Beta")
1045     ("Gamma")
1046     ("Delta")
1047     ("Epsilon")
1048     ("Zeta")
1049     ("Eta")
1050     ("Theta")
1051     ("Iota")
1052     ("Kappa")
1053     ("Lambda")
1054     ("Mu")
1055     ("Nu")
1056     ("Xi")
1057     ("Omicron")
1058     ("Pi")
1059     ("Rho")
1060     ("Sigma")
1061     ("Tau")
1062     ("Upsilon")
1063     ("Phi")
1064     ("Chi")
1065     ("Psi")
1066     ("Omega")
1067     ("alpha")
1068     ("beta")
1069     ("gamma")
1070     ("delta")
1071     ("epsilon")
1072     ("varepsilon"."&epsilon;")
1073     ("zeta")
1074     ("eta")
1075     ("theta")
1076     ("iota")
1077     ("kappa")
1078     ("lambda")
1079     ("mu")
1080     ("nu")
1081     ("xi")
1082     ("omicron")
1083     ("pi")
1084     ("rho")
1085     ("sigmaf") ("varsigma"."&sigmaf;")
1086     ("sigma")
1087     ("tau")
1088     ("upsilon")
1089     ("phi")
1090     ("chi")
1091     ("psi")
1092     ("omega")
1093     ("thetasym") ("vartheta"."&thetasym;")
1094     ("upsih")
1095     ("piv")
1096     ("bull") ("bullet"."&bull;")
1097     ("hellip") ("dots"."&hellip;")
1098     ("prime")
1099     ("Prime")
1100     ("oline")
1101     ("frasl")
1102     ("weierp")
1103     ("image")
1104     ("real")
1105     ("trade")
1106     ("alefsym")
1107     ("larr") ("leftarrow"."&larr;") ("gets"."&larr;")
1108     ("uarr") ("uparrow"."&uarr;")
1109     ("rarr") ("to"."&rarr;") ("rightarrow"."&rarr;")
1110     ("darr")("downarrow"."&darr;")
1111     ("harr") ("leftrightarrow"."&harr;")
1112     ("crarr") ("hookleftarrow"."&crarr;") ; has round hook, not quite CR
1113     ("lArr") ("Leftarrow"."&lArr;")
1114     ("uArr") ("Uparrow"."&uArr;")
1115     ("rArr") ("Rightarrow"."&rArr;")
1116     ("dArr") ("Downarrow"."&dArr;")
1117     ("hArr") ("Leftrightarrow"."&hArr;")
1118     ("forall")
1119     ("part") ("partial"."&part;")
1120     ("exist") ("exists"."&exist;")
1121     ("empty") ("emptyset"."&empty;")
1122     ("nabla")
1123     ("isin") ("in"."&isin;")
1124     ("notin")
1125     ("ni")
1126     ("prod")
1127     ("sum")
1128     ("minus")
1129     ("lowast") ("ast"."&lowast;")
1130     ("radic")
1131     ("prop") ("proptp"."&prop;")
1132     ("infin") ("infty"."&infin;")
1133     ("ang") ("angle"."&ang;")
1134     ("and") ("wedge"."&and;")
1135     ("or") ("vee"."&or;")
1136     ("cap")
1137     ("cup")
1138     ("int")
1139     ("there4")
1140     ("sim")
1141     ("cong") ("simeq"."&cong;")
1142     ("asymp")("approx"."&asymp;")
1143     ("ne") ("neq"."&ne;")
1144     ("equiv")
1145     ("le")
1146     ("ge")
1147     ("sub") ("subset"."&sub;")
1148     ("sup") ("supset"."&sup;")
1149     ("nsub")
1150     ("sube")
1151     ("supe")
1152     ("oplus")
1153     ("otimes")
1154     ("perp")
1155     ("sdot") ("cdot"."&sdot;")
1156     ("lceil")
1157     ("rceil")
1158     ("lfloor")
1159     ("rfloor")
1160     ("lang")
1161     ("rang")
1162     ("loz") ("Diamond"."&loz;")
1163     ("spades") ("spadesuit"."&spades;")
1164     ("clubs") ("clubsuit"."&clubs;")
1165     ("hearts") ("diamondsuit"."&hearts;")
1166     ("diams") ("diamondsuit"."&diams;")
1167     ("smile"."&#9786;") ("blacksmile"."&#9787;") ("sad"."&#9785;")
1168     ("quot")
1169     ("amp")
1170     ("lt")
1171     ("gt")
1172     ("OElig")
1173     ("oelig")
1174     ("Scaron")
1175     ("scaron")
1176     ("Yuml")
1177     ("circ")
1178     ("tilde")
1179     ("ensp")
1180     ("emsp")
1181     ("thinsp")
1182     ("zwnj")
1183     ("zwj")
1184     ("lrm")
1185     ("rlm")
1186     ("ndash")
1187     ("mdash")
1188     ("lsquo")
1189     ("rsquo")
1190     ("sbquo")
1191     ("ldquo")
1192     ("rdquo")
1193     ("bdquo")
1194     ("dagger")
1195     ("Dagger")
1196     ("permil")
1197     ("lsaquo")
1198     ("rsaquo")
1199     ("euro")
1200
1201     ("arccos"."arccos")
1202     ("arcsin"."arcsin")
1203     ("arctan"."arctan")
1204     ("arg"."arg")
1205     ("cos"."cos")
1206     ("cosh"."cosh")
1207     ("cot"."cot")
1208     ("coth"."coth")
1209     ("csc"."csc")
1210     ("deg"."deg")
1211     ("det"."det")
1212     ("dim"."dim")
1213     ("exp"."exp")
1214     ("gcd"."gcd")
1215     ("hom"."hom")
1216     ("inf"."inf")
1217     ("ker"."ker")
1218     ("lg"."lg")
1219     ("lim"."lim")
1220     ("liminf"."liminf")
1221     ("limsup"."limsup")
1222     ("ln"."ln")
1223     ("log"."log")
1224     ("max"."max")
1225     ("min"."min")
1226     ("Pr"."Pr")
1227     ("sec"."sec")
1228     ("sin"."sin")
1229     ("sinh"."sinh")
1230     ("sup"."sup")
1231     ("tan"."tan")
1232     ("tanh"."tanh")
1233     )
1234   "Entities for TeX->HTML translation.
1235 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
1236 \"&ent;\".  An entry can also be a dotted pair like (\"ent\".\"&other;\").
1237 In that case, \"\\ent\" will be translated to \"&other;\".
1238 The list contains HTML entities for Latin-1, Greek and other symbols.
1239 It is supplemented by a number of commonly used TeX macros with appropriate
1240 translations.  There is currently no way for users to extend this.")
1241
1242 ;;; General functions for all backends
1243
1244 (defvar org-export-target-aliases nil
1245   "Alist of targets with invisible aliases.")
1246 (defvar org-export-preferred-target-alist nil
1247   "Alist of section id's with preferred aliases.")
1248 (defvar org-export-code-refs nil
1249   "Alist of code references and line numbers")
1250
1251 (defun org-export-preprocess-string (string &rest parameters)
1252   "Cleanup STRING so that that the true exported has a more consistent source.
1253 This function takes STRING, which should be a buffer-string of an org-file
1254 to export.  It then creates a temporary buffer where it does its job.
1255 The result is then again returned as a string, and the exporter works
1256 on this string to produce the exported version."
1257   (interactive)
1258   (let* ((htmlp (plist-get parameters :for-html))
1259          (asciip (plist-get parameters :for-ascii))
1260          (latexp (plist-get parameters :for-LaTeX))
1261          (docbookp (plist-get parameters :for-docbook))
1262          (backend (cond (htmlp 'html)
1263                         (latexp 'latex)
1264                         (asciip 'ascii)
1265                         (docbookp 'docbook)))
1266          (archived-trees (plist-get parameters :archived-trees))
1267          (inhibit-read-only t)
1268          (drawers org-drawers)
1269          (outline-regexp "\\*+ ")
1270          target-alist rtn)
1271
1272     (setq org-export-target-aliases nil)
1273     (setq org-export-preferred-target-alist nil)
1274     (setq org-export-code-refs nil)
1275
1276     (with-current-buffer (get-buffer-create " org-mode-tmp")
1277       (erase-buffer)
1278       (insert string)
1279       (setq case-fold-search t)
1280
1281       (let ((inhibit-read-only t))
1282         (remove-text-properties (point-min) (point-max)
1283                                 '(read-only t)))
1284
1285       ;; Remove license-to-kill stuff
1286       ;; The caller marks some stuff for killing, stuff that has been
1287       ;; used to create the page title, for example.
1288       (org-export-kill-licensed-text)
1289
1290       (let ((org-inhibit-startup t)) (org-mode))
1291       (setq case-fold-search t)
1292       (org-install-letbind)
1293
1294       ;; Call the hook
1295       (run-hooks 'org-export-preprocess-hook)
1296
1297       ;; Process the macros
1298       (org-export-preprocess-apply-macros)
1299       (run-hooks 'org-export-preprocess-after-macros-hook)
1300
1301       (untabify (point-min) (point-max))
1302
1303       ;; Handle include files, and call a hook
1304       (org-export-handle-include-files)
1305       (run-hooks 'org-export-preprocess-after-include-files-hook)
1306
1307       ;; Get rid of archived trees
1308       (org-export-remove-archived-trees archived-trees)
1309
1310       ;; Remove comment environment and comment subtrees
1311       (org-export-remove-comment-blocks-and-subtrees)
1312
1313       ;; Get rid of excluded trees, and call a hook
1314       (org-export-handle-export-tags (plist-get parameters :select-tags)
1315                                      (plist-get parameters :exclude-tags))
1316       (run-hooks 'org-export-preprocess-after-tree-selection-hook)
1317
1318       ;; Handle source code snippets
1319       (org-export-replace-src-segments-and-examples backend)
1320
1321       ;; Protect short examples marked by a leading colon
1322       (org-export-protect-colon-examples)
1323
1324       ;; Normalize footnotes
1325       (when (plist-get parameters :footnotes)
1326         (org-footnote-normalize nil t))
1327
1328       ;; Find all headings and compute the targets for them
1329       (setq target-alist (org-export-define-heading-targets target-alist))
1330
1331       ;; Get rid of drawers
1332       (org-export-remove-or-extract-drawers
1333        drawers (plist-get parameters :drawers) backend)
1334
1335       ;; Get the correct stuff before the first headline
1336       (when (plist-get parameters :skip-before-1st-heading)
1337         (goto-char (point-min))
1338         (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t)
1339           (delete-region (point-min) (match-beginning 0))
1340           (goto-char (point-min))
1341           (insert "\n")))
1342       (when (plist-get parameters :add-text)
1343         (goto-char (point-min))
1344         (insert (plist-get parameters :add-text) "\n"))
1345
1346       ;; Remove todo-keywords before exporting, if the user has requested so
1347       (org-export-remove-headline-metadata parameters)
1348
1349       ;; Find targets in comments and move them out of comments,
1350       ;; but mark them as targets that should be invisible
1351       (setq target-alist (org-export-handle-invisible-targets target-alist))
1352
1353       ;; Select and protect backend specific stuff, throw away stuff
1354       ;; that is specific for other backends
1355       (run-hooks 'org-export-preprocess-before-selecting-backend-code-hook)
1356       (org-export-select-backend-specific-text backend)
1357
1358       ;; Protect quoted subtrees
1359       (org-export-protect-quoted-subtrees)
1360
1361       ;; Remove clock lines
1362       (org-export-remove-clock-lines)
1363
1364       ;; Protect verbatim elements
1365       (org-export-protect-verbatim)
1366
1367       ;; Blockquotes, verse, and center
1368       (org-export-mark-blockquote-verse-center)
1369       (run-hooks 'org-export-preprocess-after-blockquote-hook)
1370
1371       ;; Remove timestamps, if the user has requested so
1372       (unless (plist-get parameters :timestamps)
1373         (org-export-remove-timestamps))
1374
1375       ;; Attach captions to the correct object
1376       (setq target-alist (org-export-attach-captions-and-attributes
1377                           backend target-alist))
1378
1379       ;; Find matches for radio targets and turn them into internal links
1380       (org-export-mark-radio-links)
1381
1382       ;; Find all links that contain a newline and put them into a single line
1383       (org-export-concatenate-multiline-links)
1384
1385       ;; Normalize links: Convert angle and plain links into bracket links
1386       ;; and expand link abbreviations
1387       (org-export-normalize-links)
1388
1389       ;; Find all internal links.  If they have a fuzzy match (i.e. not
1390       ;; a *dedicated* target match, let the link  point to the
1391       ;; corresponding section.
1392       (org-export-target-internal-links target-alist)
1393
1394       ;; Find multiline emphasis and put them into single line
1395       (when (plist-get parameters :emph-multiline)
1396         (org-export-concatenate-multiline-emphasis))
1397
1398       ;; Remove special table lines
1399       (when org-export-table-remove-special-lines
1400         (org-export-remove-special-table-lines))
1401
1402       ;; Another hook
1403       (run-hooks 'org-export-preprocess-before-backend-specifics-hook)
1404
1405       ;; LaTeX-specific preprocessing
1406       (when latexp
1407         (require 'org-latex nil)
1408         (org-export-latex-preprocess parameters))
1409
1410       ;; ASCII-specific preprocessing
1411       (when asciip
1412         (org-export-ascii-preprocess parameters))
1413
1414       ;; HTML-specific preprocessing
1415       (when htmlp
1416         (org-export-html-preprocess parameters))
1417
1418       ;; DocBook-specific preprocessing
1419       (when docbookp
1420         (require 'org-docbook nil)
1421         (org-export-docbook-preprocess parameters))
1422
1423       ;; Remove or replace comments
1424       (org-export-handle-comments (plist-get parameters :comments))
1425
1426       ;; Run the final hook
1427       (run-hooks 'org-export-preprocess-final-hook)
1428
1429       (setq rtn (buffer-string)))
1430     (kill-buffer " org-mode-tmp")
1431     rtn))
1432
1433 (defun org-export-kill-licensed-text ()
1434   "Remove all text that is marked with a :org-license-to-kill property."
1435   (let (p)
1436     (while (setq p (text-property-any (point-min) (point-max)
1437                                       :org-license-to-kill t))
1438       (delete-region
1439        p (or (next-single-property-change p :org-license-to-kill)
1440              (point-max))))))
1441
1442 (defun org-export-define-heading-targets (target-alist)
1443   "Find all headings and define the targets for them.
1444 The new targets are added to TARGET-ALIST, which is also returned."
1445   (goto-char (point-min))
1446   (org-init-section-numbers)
1447   (let ((re (concat "^" org-outline-regexp
1448                     "\\| [ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
1449         level target last-section-target a id)
1450     (while (re-search-forward re nil t)
1451       (if (match-end 2)
1452           (progn
1453             (setq id (org-match-string-no-properties 2))
1454             (push (cons id target) target-alist)
1455             (setq a (or (assoc last-section-target org-export-target-aliases)
1456                         (progn
1457                           (push (list last-section-target)
1458                                 org-export-target-aliases)
1459                           (car org-export-target-aliases))))
1460             (push (caar target-alist) (cdr a))
1461             (when (equal (match-string 1) "CUSTOM_ID")
1462               (if (not (assoc last-section-target
1463                               org-export-preferred-target-alist))
1464                   (push (cons last-section-target id)
1465                         org-export-preferred-target-alist))))
1466         (setq level (org-reduced-level
1467                      (save-excursion (goto-char (point-at-bol))
1468                                      (org-outline-level))))
1469         (setq target (org-solidify-link-text
1470                       (format "sec-%s" (org-section-number level))))
1471         (setq last-section-target target)
1472         (push (cons target target) target-alist)
1473         (add-text-properties
1474          (point-at-bol) (point-at-eol)
1475          (list 'target target)))))
1476   target-alist)
1477
1478 (defun org-export-handle-invisible-targets (target-alist)
1479   "Find targets in comments and move them out of comments.
1480 Mark them as invisible targets."
1481   (let (target tmp a)
1482     (goto-char (point-min))
1483     (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
1484       ;; Check if the line before or after is a headline with a target
1485       (if (setq target (or (get-text-property (point-at-bol 0) 'target)
1486                            (get-text-property (point-at-bol 2) 'target)))
1487           (progn
1488             ;; use the existing target in a neighboring line
1489             (setq tmp (match-string 2))
1490             (replace-match "")
1491             (and (looking-at "\n") (delete-char 1))
1492             (push (cons (setq tmp (org-solidify-link-text tmp)) target)
1493                   target-alist)
1494             (setq a (or (assoc target org-export-target-aliases)
1495                         (progn
1496                           (push (list target) org-export-target-aliases)
1497                           (car org-export-target-aliases))))
1498             (push tmp (cdr a)))
1499         ;; Make an invisible target
1500         (replace-match "\\1(INVISIBLE)"))))
1501   target-alist)
1502
1503 (defun org-export-target-internal-links (target-alist)
1504   "Find all internal links and assign targets to them.
1505 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1506 let the link  point to the corresponding section.
1507 This function also handles the id links, if they have a match in
1508 the current file."
1509   (goto-char (point-min))
1510   (while (re-search-forward org-bracket-link-regexp nil t)
1511     (org-if-unprotected-at (match-beginning 1)
1512      (let* ((md (match-data))
1513             (desc (match-end 2))
1514             (link (org-link-unescape (match-string 1)))
1515             (slink (org-solidify-link-text link))
1516             found props pos cref
1517             (target
1518              (cond
1519               ((= (string-to-char link) ?#)
1520                ;; user wants exactly this link
1521                link)
1522               ((cdr (assoc slink target-alist))
1523                (or (cdr (assoc (assoc slink target-alist)
1524                                org-export-preferred-target-alist))
1525                    (cdr (assoc slink target-alist))))
1526               ((and (string-match "^id:" link)
1527                     (cdr (assoc (substring link 3) target-alist))))
1528               ((string-match "^(\\(.*\\))$" link)
1529                (setq cref (match-string 1 link))
1530                (concat "coderef:" cref))
1531               ((string-match org-link-types-re link) nil)
1532               ((or (file-name-absolute-p link)
1533                    (string-match "^\\." link))
1534                nil)
1535               (t
1536                (save-excursion
1537                  (setq found (condition-case nil (org-link-search link)
1538                                (error nil)))
1539                  (when (and found
1540                             (or (org-on-heading-p)
1541                                 (not (eq found 'dedicated))))
1542                    (or (get-text-property (point) 'target)
1543                        (get-text-property
1544                         (max (point-min)
1545                              (1- (or (previous-single-property-change
1546                                       (point) 'target) 0)))
1547                         'target))))))))
1548        (when target
1549          (set-match-data md)
1550          (goto-char (match-beginning 1))
1551          (setq props (text-properties-at (point)))
1552          (delete-region (match-beginning 1) (match-end 1))
1553          (setq pos (point))
1554          (insert target)
1555          (unless desc (insert "][" link))
1556          (add-text-properties pos (point) props))))))
1557
1558 (defvar org-export-format-drawer-function nil
1559   "Function to be called to format the contents of a drawer.
1560 The function must accept three parameters:
1561   BACKEND  one of the symbols html, docbook, latex, ascii, xoxo
1562   NAME     the drawer name, like \"PROPERTIES\"
1563   CONTENT  the content of the drawer.
1564 The function should return the text to be inserted into the buffer.
1565 If this is nil, `org-export-format-drawer' is used as a default.")
1566
1567 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers backend)
1568   "Remove drawers, or extract and format the content.
1569 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1570 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1571 whose content to keep.  Any drawers that are in ALL-DRAWERS but not in
1572 EXP-DRAWERS will be removed.
1573 BACKEND is the current export backend."
1574   (goto-char (point-min))
1575   (let ((re (concat "^[ \t]*:\\("
1576                     (mapconcat 'identity all-drawers "\\|")
1577                     "\\):[ \t]*$"))
1578         name beg beg-content eol content)
1579     (while (re-search-forward re nil t)
1580       (org-if-unprotected
1581        (setq name (match-string 1))
1582        (setq beg (match-beginning 0)
1583              beg-content (1+ (point-at-eol))
1584              eol (point-at-eol))
1585        (if (not (and (re-search-forward
1586                       "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t)
1587                      (match-end 1)))
1588            (goto-char eol)
1589          (goto-char (match-beginning 0))
1590          (and (looking-at ".*\n?") (replace-match ""))
1591          (setq content (buffer-substring beg-content (point)))
1592          (delete-region beg (point))
1593          (when (or (eq exp-drawers t)
1594                    (member name exp-drawers))
1595            (setq content (funcall (or org-export-format-drawer-function
1596                                       'org-export-format-drawer)
1597                                   name content backend))
1598            (insert content)))))))
1599
1600 (defun org-export-format-drawer (name content backend)
1601   "Format the content of a drawer as a colon example."
1602   (if (string-match "[ \t]+\\'" content)
1603       (setq content (substring content (match-beginning 0))))
1604   (while (string-match "\\`[ \t]*\n" content)
1605     (setq content (substring content (match-end 0))))
1606   (setq content (org-remove-indentation content))
1607   (setq content (concat ": " (mapconcat 'identity
1608                                         (org-split-string content "\n")
1609                                         "\n: ")
1610                         "\n"))
1611   (setq content (concat " : " (upcase name) "\n" content))
1612   (org-add-props content nil 'org-protected t))
1613
1614 (defun org-export-handle-export-tags (select-tags exclude-tags)
1615   "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
1616 Both arguments are lists of tags.
1617 If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
1618 will be removed.
1619 After that, all subtrees that are marked by EXCLUDE-TAGS will be
1620 removed as well."
1621   (remove-text-properties (point-min) (point-max) '(:org-delete t))
1622   (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
1623                                            select-tags "\\|")
1624                          "\\):"))
1625          (re-excl (concat ":\\(" (mapconcat 'regexp-quote
1626                                            exclude-tags "\\|")
1627                         "\\):"))
1628          beg end cont)
1629     (goto-char (point-min))
1630     (when (and select-tags
1631                (re-search-forward
1632                 (concat "^\\*+[ \t].*" re-sel "[^ \t\n]*[ \t]*$") nil t))
1633       ;; At least one tree is marked for export, this means
1634       ;; all the unmarked stuff needs to go.
1635       ;; Dig out the trees that should be exported
1636       (goto-char (point-min))
1637       (outline-next-heading)
1638       (setq beg (point))
1639       (put-text-property beg (point-max) :org-delete t)
1640       (while (re-search-forward re-sel nil t)
1641         (when (org-on-heading-p)
1642           (org-back-to-heading)
1643           (remove-text-properties
1644            (max (1- (point)) (point-min))
1645            (setq cont (save-excursion (org-end-of-subtree t t)))
1646            '(:org-delete t))
1647           (while (and (org-up-heading-safe)
1648                       (get-text-property (point) :org-delete))
1649             (remove-text-properties (max (1- (point)) (point-min))
1650                                     (point-at-eol) '(:org-delete t)))
1651           (goto-char cont))))
1652     ;; Remove the trees explicitly marked for noexport
1653     (when exclude-tags
1654       (goto-char (point-min))
1655       (while (re-search-forward re-excl nil t)
1656         (when (org-at-heading-p)
1657           (org-back-to-heading t)
1658           (setq beg (point))
1659           (org-end-of-subtree t t)
1660           (delete-region beg (point))
1661           (when (featurep 'org-inlinetask)
1662             (org-inlinetask-remove-END-maybe)))))
1663     ;; Remove everything that is now still marked for deletion
1664     (goto-char (point-min))
1665     (while (setq beg (text-property-any (point-min) (point-max) :org-delete t))
1666       (setq end (or (next-single-property-change beg :org-delete)
1667                     (point-max)))
1668       (delete-region beg end))))
1669
1670 (defun org-export-remove-archived-trees (export-archived-trees)
1671   "Remove archived trees.
1672 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1673 When it is t, the entire archived tree will be exported.
1674 When it is nil the entire tree including the headline will be removed
1675 from the buffer."
1676   (let ((re-archive (concat ":" org-archive-tag ":"))
1677         a b)
1678     (when (not (eq export-archived-trees t))
1679       (goto-char (point-min))
1680       (while (re-search-forward re-archive nil t)
1681         (if (not (org-on-heading-p t))
1682             (org-end-of-subtree t)
1683           (beginning-of-line 1)
1684           (setq a (if export-archived-trees
1685                       (1+ (point-at-eol)) (point))
1686                 b (org-end-of-subtree t))
1687           (if (> b a) (delete-region a b)))))))
1688
1689 (defun org-export-remove-headline-metadata (opts)
1690   "Remove meta data from the headline, according to user options."
1691   (let ((re org-complex-heading-regexp)
1692         (todo (plist-get opts :todo-keywords))
1693         (tags (plist-get opts :tags))
1694         (pri  (plist-get opts :priority))
1695         (elts '(1 2 3 4 5))
1696         rpl)
1697     (setq elts (delq nil (list 1 (if todo 2) (if pri 3) 4 (if tags 5))))
1698     (when (or (not todo) (not tags) (not pri))
1699       (goto-char (point-min))
1700       (while (re-search-forward re nil t)
1701         (org-if-unprotected
1702          (setq rpl (mapconcat (lambda (i) (if (match-end i) (match-string i) ""))
1703                               elts " "))
1704          (replace-match rpl t t))))))
1705
1706 (defun org-export-remove-timestamps ()
1707   "Remove timestamps and keywords for export."
1708   (goto-char (point-min))
1709   (while (re-search-forward org-maybe-keyword-time-regexp nil t)
1710     (backward-char 1)
1711     (org-if-unprotected
1712      (unless (save-match-data (org-at-table-p))
1713        (replace-match "")
1714        (beginning-of-line 1)
1715        (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
1716            (replace-match ""))))))
1717
1718 (defun org-export-remove-clock-lines ()
1719   "Remove clock lines for export."
1720   (goto-char (point-min))
1721   (let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
1722     (while (re-search-forward re nil t)
1723       (org-if-unprotected
1724        (replace-match "")))))
1725
1726 (defun org-export-protect-quoted-subtrees ()
1727   "Mark quoted subtrees with the protection property."
1728   (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string "\\>")))
1729     (goto-char (point-min))
1730     (while (re-search-forward re-quote nil t)
1731       (goto-char (match-beginning 0))
1732       (end-of-line 1)
1733       (add-text-properties (point) (org-end-of-subtree t)
1734                            '(org-protected t)))))
1735
1736 (defun org-export-protect-verbatim ()
1737   "Mark verbatim snippets with the protection property."
1738   (goto-char (point-min))
1739   (while (re-search-forward org-verbatim-re nil t)
1740     (org-if-unprotected
1741      (add-text-properties (match-beginning 4) (match-end 4)
1742                           '(org-protected t org-verbatim-emph t))
1743      (goto-char (1+ (match-end 4))))))
1744
1745 (defun org-export-protect-colon-examples ()
1746   "Protect lines starting with a colon."
1747   (goto-char (point-min))
1748   (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg)
1749     (while (re-search-forward re nil t)
1750       (beginning-of-line 1)
1751       (setq beg (point))
1752       (while (looking-at re)
1753         (end-of-line 1)
1754         (or (eobp) (forward-char 1)))
1755       (add-text-properties beg (if (bolp) (1- (point)) (point))
1756                            '(org-protected t)))))
1757
1758 (defun org-export-select-backend-specific-text (backend)
1759   (let ((formatters
1760          '((docbook "DOCBOOK" "BEGIN_DOCBOOK" "END_DOCBOOK")
1761            (html "HTML" "BEGIN_HTML" "END_HTML")
1762            (beamer "BEAMER" "BEGIN_BEAMER" "END_BEAMER")
1763            (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
1764            (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
1765         (case-fold-search t)
1766         fmt beg beg-content end end-content)
1767
1768     (while formatters
1769       (setq fmt (pop formatters))
1770       (when (eq (car fmt) backend)
1771         ;; This is selected code, put it into the file for real
1772         (goto-char (point-min))
1773         (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" (cadr fmt)
1774                                           ":[ \t]*\\(.*\\)") nil t)
1775           (replace-match "\\1\\2" t)
1776           (add-text-properties
1777            (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1778            '(org-protected t))))
1779       (goto-char (point-min))
1780       (while (re-search-forward (concat "^[ \t]*#\\+" (caddr fmt) "\\>.*\n?")
1781                                 nil t)
1782         (setq beg (match-beginning 0) beg-content (match-end 0))
1783         (when (re-search-forward (concat "^[ \t]*#\\+" (cadddr fmt) "\\>.*\n?")
1784                                  nil t)
1785           (setq end (match-end 0) end-content (match-beginning 0))
1786           (if (eq (car fmt) backend)
1787               ;; yes, keep this
1788               (progn
1789                 (add-text-properties beg-content end-content '(org-protected t))
1790                 (delete-region (match-beginning 0) (match-end 0))
1791                 (save-excursion
1792                   (goto-char beg)
1793                   (delete-region (point) (1+ (point-at-eol)))))
1794             ;; No, this is for a different backend, kill it
1795             (delete-region beg end)))))))
1796
1797 (defun org-export-mark-blockquote-verse-center ()
1798   "Mark block quote and verse environments with special cookies.
1799 These special cookies will later be interpreted by the backend."
1800   ;; Blockquotes
1801   (let (type t1 ind beg end beg1 end1 content)
1802     (goto-char (point-min))
1803     (while (re-search-forward
1804             "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
1805             nil t)
1806       (setq ind (length (match-string 1))
1807             type (downcase (match-string 3))
1808             t1 (if (equal type "quote") "blockquote" type))
1809       (setq beg (match-beginning 0)
1810             beg1 (1+ (match-end 0)))
1811       (when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
1812         (setq end (1+ (point-at-eol))
1813               end1 (1- (match-beginning 0)))
1814         (setq content (org-remove-indentation (buffer-substring beg1 end1)))
1815         (setq content (concat "ORG-" (upcase t1) "-START\n"
1816                               content "\n"
1817                               "ORG-" (upcase t1) "-END\n"))
1818         (delete-region beg end)
1819         (insert (org-add-props content nil 'original-indentation ind))))))
1820
1821 (defun org-export-attach-captions-and-attributes (backend target-alist)
1822   "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
1823 If the next thing following is a table, add the text properties to the first
1824 table line.  If it is a link, add it to the line containing the link."
1825   (goto-char (point-min))
1826   (remove-text-properties (point-min) (point-max)
1827                           '(org-caption nil org-attributes nil))
1828   (let ((case-fold-search t)
1829         (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
1830                     "\\|"
1831                     "^[ \t]*#\\+attr_" (symbol-name backend) ":[ \t]+\\(.*\\)"
1832                     "\\|"
1833                     "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
1834                     "\\|"
1835                     "^[ \t]*|[^-]"
1836                     "\\|"
1837                     "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
1838         cap attr label)
1839     (while (re-search-forward re nil t)
1840       (cond
1841        ((match-end 1)
1842         (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
1843        ((match-end 2)
1844         (setq attr (concat attr (if attr " " "") (org-trim (match-string 2)))))
1845        ((match-end 3)
1846         (setq label (org-trim (match-string 3))))
1847        (t
1848         (add-text-properties (point-at-bol) (point-at-eol)
1849                              (list 'org-caption cap
1850                                    'org-attributes attr
1851                                    'org-label label))
1852         (if label (push (cons label label) target-alist))
1853         (setq cap nil attr nil label nil)))))
1854   target-alist)
1855
1856 (defun org-export-remove-comment-blocks-and-subtrees ()
1857   "Remove the comment environment, and also commented subtrees."
1858   (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string "\\>"))
1859         (case-fold-search nil))
1860     ;; Remove comment environment
1861     (goto-char (point-min))
1862     (while (re-search-forward
1863             "^#\\+BEGIN_COMMENT[ \t]*\n[^\000]*?^#\\+END_COMMENT\\>.*" nil t)
1864       (replace-match "" t t))
1865     ;; Remove subtrees that are commented
1866     (goto-char (point-min))
1867     (while (re-search-forward re-commented nil t)
1868       (goto-char (match-beginning 0))
1869       (delete-region (point) (org-end-of-subtree t)))))
1870
1871 (defun org-export-handle-comments (commentsp)
1872   "Remove comments, or convert to backend-specific format.
1873 COMMENTSP can be a format string for publishing comments.
1874 When it is nil, all comments will be removed."
1875   (let ((re "^\\(#\\|[ \t]*#\\+\\)\\(.*\n?\\)")
1876         pos)
1877     (goto-char (point-min))
1878     (while (or (looking-at re)
1879                (re-search-forward re nil t))
1880       (setq pos (match-beginning 0))
1881       (if (and commentsp
1882                (not (equal (char-before (match-end 1)) ?+)))
1883           (progn (add-text-properties
1884                   (match-beginning 0) (match-end 0) '(org-protected t))
1885                  (replace-match (format commentsp (match-string 2)) t t))
1886         (goto-char (1+ pos))
1887         (org-if-unprotected
1888          (replace-match "")
1889          (goto-char (max (point-min) (1- pos))))))))
1890
1891 (defun org-export-mark-radio-links ()
1892   "Find all matches for radio targets and turn them into internal links."
1893   (let ((re-radio (and org-target-link-regexp
1894                        (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
1895     (goto-char (point-min))
1896     (when re-radio
1897       (while (re-search-forward re-radio nil t)
1898         (unless
1899             (save-match-data
1900               (or (org-in-regexp org-bracket-link-regexp)
1901                   (org-in-regexp org-plain-link-re)))
1902           (org-if-unprotected
1903            (replace-match "\\1[[\\2]]")))))))
1904
1905 (defun org-export-remove-special-table-lines ()
1906   "Remove tables lines that are used for internal purposes."
1907   (goto-char (point-min))
1908   (while (re-search-forward "^[ \t]*|" nil t)
1909     (beginning-of-line 1)
1910     (if (or (looking-at "[ \t]*| *[!_^] *|")
1911             (not
1912              (memq
1913               nil
1914               (mapcar
1915                (lambda (f)
1916                  (or (= (length f) 0)
1917                      (string-match
1918                       "\\`<\\([0-9]\\|[rl]\\|[rl][0-9]+\\)>\\'" f)))
1919                (org-split-string ;; FIXME, can't we do this without splitting???
1920                 (buffer-substring (point-at-bol) (point-at-eol))
1921                 "[ \t]*|[ \t]*")))))
1922         (delete-region (max (point-min) (1- (point-at-bol)))
1923                        (point-at-eol))
1924       (end-of-line 1))))
1925
1926 (defun org-export-protect-sub-super (s)
1927   (save-match-data
1928     (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s)
1929       (setq s (replace-match "\\1\\\\\\2" nil nil s)))
1930     s))
1931
1932 (defun org-export-normalize-links ()
1933   "Convert all links to bracket links, and expand link abbreviations."
1934   (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
1935         (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
1936         nodesc)
1937     (goto-char (point-min))
1938     (while (re-search-forward re-plain-link nil t)
1939       (goto-char (1- (match-end 0)))
1940       (org-if-unprotected-at (1+ (match-beginning 0))
1941        (let* ((s (concat (match-string 1)
1942                          "[[" (match-string 2) ":" (match-string 3)
1943                          "][" (match-string 2) ":" (org-export-protect-sub-super
1944                                                     (match-string 3))
1945                          "]]")))
1946          ;; added 'org-link face to links
1947          (put-text-property 0 (length s) 'face 'org-link s)
1948          (replace-match s t t))))
1949     (goto-char (point-min))
1950     (while (re-search-forward re-angle-link nil t)
1951       (goto-char (1- (match-end 0)))
1952       (org-if-unprotected
1953        (let* ((s (concat (match-string 1)
1954                          "[[" (match-string 2) ":" (match-string 3)
1955                          "][" (match-string 2) ":" (org-export-protect-sub-super
1956                                                     (match-string 3))
1957                          "]]")))
1958          (put-text-property 0 (length s) 'face 'org-link s)
1959          (replace-match s t t))))
1960     (goto-char (point-min))
1961     (while (re-search-forward org-bracket-link-regexp nil t)
1962       (goto-char (1- (match-end 0)))
1963       (setq nodesc (not (match-end 3)))
1964       (org-if-unprotected
1965        (let* ((xx (save-match-data
1966                     (org-translate-link
1967                      (org-link-expand-abbrev (match-string 1)))))
1968               (s (concat
1969                   "[[" (org-add-props (copy-sequence xx)
1970                            nil 'org-protected t 'org-no-description nodesc)
1971                   "]"
1972                   (if (match-end 3)
1973                       (match-string 2)
1974                     (concat "[" (copy-sequence xx)
1975                             "]"))
1976                   "]")))
1977          (put-text-property 0 (length s) 'face 'org-link s)
1978          (replace-match s t t))))))
1979
1980 (defun org-export-concatenate-multiline-links ()
1981   "Find multi-line links and put it all into a single line.
1982 This is to make sure that the line-processing export backends
1983 can work correctly."
1984   (goto-char (point-min))
1985   (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
1986     (org-if-unprotected
1987      (replace-match "\\1 \\3")
1988      (goto-char (match-beginning 0)))))
1989
1990 (defun org-export-concatenate-multiline-emphasis ()
1991   "Find multi-line emphasis and put it all into a single line.
1992 This is to make sure that the line-processing export backends
1993 can work correctly."
1994   (goto-char (point-min))
1995   (while (re-search-forward org-emph-re nil t)
1996     (if (and (not (= (char-after (match-beginning 3))
1997                      (char-after (match-beginning 4))))
1998              (save-excursion (goto-char (match-beginning 0))
1999                              (save-match-data (not (org-at-table-p)))))
2000         (org-if-unprotected
2001          (subst-char-in-region (match-beginning 0) (match-end 0)
2002                                ?\n ?\  t)
2003          (goto-char (1- (match-end 0))))
2004       (goto-char (1+ (match-beginning 0))))))
2005
2006 (defun org-export-grab-title-from-buffer ()
2007   "Get a title for the current document, from looking at the buffer."
2008   (let ((inhibit-read-only t))
2009     (save-excursion
2010       (goto-char (point-min))
2011       (let ((end (if (looking-at org-outline-regexp)
2012                      (point)
2013                    (save-excursion (outline-next-heading) (point)))))
2014         (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
2015           ;; Mark the line so that it will not be exported as normal text.
2016           (org-unmodified
2017            (add-text-properties (match-beginning 0) (match-end 0)
2018                                 (list :org-license-to-kill t)))
2019           ;; Return the title string
2020           (org-trim (match-string 0)))))))
2021
2022 (defun org-export-get-title-from-subtree ()
2023   "Return subtree title and exclude it from export."
2024   (let (title (rbeg (region-beginning)) (rend (region-end)))
2025     (save-excursion
2026       (goto-char rbeg)
2027       (when (and (org-at-heading-p)
2028                  (>= (org-end-of-subtree t t) rend))
2029         ;; This is a subtree, we take the title from the first heading
2030         (goto-char rbeg)
2031         (looking-at org-todo-line-regexp)
2032         (setq title (match-string 3))
2033         (org-unmodified
2034          (add-text-properties (point) (1+ (point-at-eol))
2035                               (list :org-license-to-kill t)))
2036         (setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
2037     title))
2038
2039 (defun org-solidify-link-text (s &optional alist)
2040   "Take link text and make a safe target out of it."
2041   (save-match-data
2042     (let* ((rtn
2043             (mapconcat
2044              'identity
2045              (org-split-string s "[ \t\r\n]+") "=="))
2046            (a (assoc rtn alist)))
2047       (or (cdr a) rtn))))
2048
2049 (defun org-get-min-level (lines &optional offset)
2050   "Get the minimum level in LINES."
2051   (let ((re "^\\(\\*+\\) ") l)
2052     (catch 'exit
2053       (while (setq l (pop lines))
2054         (if (string-match re l)
2055             (throw 'exit (org-tr-level (- (length (match-string 1 l))
2056                                           (or offset 0))))))
2057       1)))
2058
2059 ;; Variable holding the vector with section numbers
2060 (defvar org-section-numbers (make-vector org-level-max 0))
2061
2062 (defun org-init-section-numbers ()
2063   "Initialize the vector for the section numbers."
2064   (let* ((level  -1)
2065          (numbers (nreverse (org-split-string "" "\\.")))
2066          (depth (1- (length org-section-numbers)))
2067          (i depth) number-string)
2068     (while (>= i 0)
2069       (if (> i level)
2070           (aset org-section-numbers i 0)
2071         (setq number-string (or (car numbers) "0"))
2072         (if (string-match "\\`[A-Z]\\'" number-string)
2073             (aset org-section-numbers i
2074                   (- (string-to-char number-string) ?A -1))
2075           (aset org-section-numbers i (string-to-number number-string)))
2076         (pop numbers))
2077       (setq i (1- i)))))
2078
2079 (defun org-section-number (&optional level)
2080   "Return a string with the current section number.
2081 When LEVEL is non-nil, increase section numbers on that level."
2082   (let* ((depth (1- (length org-section-numbers)))
2083          (string "")
2084          (fmts (car org-export-section-number-format))
2085          (term (cdr org-export-section-number-format))
2086          (sep "")
2087          ctype fmt idx n)
2088     (when level
2089       (when (> level -1)
2090         (aset org-section-numbers
2091               level (1+ (aref org-section-numbers level))))
2092       (setq idx (1+ level))
2093       (while (<= idx depth)
2094         (if (not (= idx 1))
2095             (aset org-section-numbers idx 0))
2096         (setq idx (1+ idx))))
2097     (setq idx 0)
2098     (while (<= idx depth)
2099       (when (> (aref org-section-numbers idx) 0)
2100         (setq fmt (or (pop fmts) fmt)
2101               ctype (car fmt)
2102               n (aref org-section-numbers idx)
2103               string (if (> n 0)
2104                          (concat string sep (org-number-to-counter n ctype))
2105                        (concat string ".0"))
2106               sep (nth 1 fmt)))
2107       (setq idx (1+ idx)))
2108     (save-match-data
2109       (if (string-match "\\`\\([@0]\\.\\)+" string)
2110           (setq string (replace-match "" t nil string)))
2111       (if (string-match "\\(\\.0\\)+\\'" string)
2112           (setq string (replace-match "" t nil string))))
2113     (concat string term)))
2114
2115 (defun org-number-to-counter (n type)
2116   "Concert number N to a string counter, according to TYPE.
2117 TYPE must be a string, any of:
2118  1  number
2119  A  A,B,....
2120  a  a,b,....
2121  I  upper case roman numeral
2122  i  lower case roman numeral"
2123   (cond
2124    ((equal type "1") (number-to-string n))
2125    ((equal type "A") (char-to-string (+ ?A n -1)))
2126    ((equal type "a") (char-to-string (+ ?a n -1)))
2127    ((equal type "I") (org-number-to-roman n))
2128    ((equal type "i") (downcase (org-number-to-roman n)))
2129    (t (error "Invalid counter type `%s'" type))))
2130
2131 (defun org-number-to-roman (n)
2132   "Convert integer N into a roman numeral."
2133   (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
2134                  ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
2135                  (  10 . "X") (  9 . "IX") (  5 . "V") (  4 . "IV")
2136                  (   1 . "I")))
2137         (res ""))
2138     (if (<= n 0)
2139         (number-to-string n)
2140       (while roman
2141         (if (>= n (caar roman))
2142             (setq n (- n (caar roman))
2143                   res (concat res (cdar roman)))
2144           (pop roman)))
2145       res)))
2146
2147 ;;; Macros
2148
2149 (defun org-export-preprocess-apply-macros ()
2150   "Replace macro references."
2151   (goto-char (point-min))
2152   (let (sy val key args args2 s n)
2153     (while (re-search-forward
2154             "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
2155             nil t)
2156       (unless (save-match-data
2157                 (save-excursion
2158                   (goto-char (point-at-bol))
2159                   (looking-at "[ \t]*#\\+macro")))
2160         (setq key (downcase (match-string 1))
2161               args (match-string 3))
2162         (when (setq val (or (plist-get org-export-opt-plist
2163                                        (intern (concat ":macro-" key)))
2164                             (plist-get org-export-opt-plist
2165                                        (intern (concat ":" key)))))
2166           (save-match-data
2167             (when args
2168               (setq args (org-split-string args ",[ \t\n]*") args2 nil)
2169               (setq args (mapcar 'org-trim args))
2170               (while args
2171                 (while (string-match "\\\\\\'" (car args))
2172                   ;; repair bad splits
2173                   (setcar (cdr args) (concat (substring (car args) 0 -1)
2174                                              ";" (nth 1 args)))
2175                   (pop args))
2176                 (push (pop args) args2))
2177               (setq args (nreverse args2))
2178               (setq s 0)
2179               (while (string-match "\\$\\([0-9]+\\)" val s)
2180                 (setq s (1+ (match-beginning 0))
2181                       n (string-to-number (match-string 1 val)))
2182                 (and (>= (length args) n)
2183                      (setq val (replace-match (nth (1- n) args) t t val)))))
2184             (when (string-match "\\`(eval\\>" val)
2185               (setq val (eval (read val))))
2186             (if (and val (not (stringp val)))
2187                 (setq val (format "%s" val))))
2188           (and (stringp val)
2189                (prog1 (replace-match val t t)
2190                  (goto-char (match-beginning 0)))))))))
2191
2192 (defun org-export-apply-macros-in-string (s)
2193   "Apply the macros in string S."
2194   (when s
2195     (with-temp-buffer
2196       (insert s)
2197       (org-export-preprocess-apply-macros)
2198       (buffer-string))))
2199
2200 ;;; Include files
2201
2202 (defun org-export-handle-include-files ()
2203   "Include the contents of include files, with proper formatting."
2204   (let ((case-fold-search t)
2205         params file markup lang start end prefix prefix1 switches)
2206     (goto-char (point-min))
2207     (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
2208       (setq params (read (concat "(" (match-string 1) ")"))
2209             prefix (org-get-and-remove-property 'params :prefix)
2210             prefix1 (org-get-and-remove-property 'params :prefix1)
2211             file (org-symname-or-string (pop params))
2212             markup (org-symname-or-string (pop params))
2213             lang (and (member markup '("src" "SRC"))
2214                       (org-symname-or-string (pop params)))
2215             switches (mapconcat '(lambda (x) (format "%s" x)) params " ")
2216             start nil end nil)
2217       (delete-region (match-beginning 0) (match-end 0))
2218       (if (or (not file)
2219               (not (file-exists-p file))
2220               (not (file-readable-p file)))
2221           (insert (format "CANNOT INCLUDE FILE %s" file))
2222         (when markup
2223           (if (equal (downcase markup) "src")
2224               (setq start (format "#+begin_src %s %s\n"
2225                                   (or lang "fundamental")
2226                                   (or switches ""))
2227                     end "#+end_src")
2228             (setq start (format "#+begin_%s %s\n" markup switches)
2229                   end  (format "#+end_%s" markup))))
2230         (insert (or start ""))
2231         (insert (org-get-file-contents (expand-file-name file)
2232                                        prefix prefix1 markup))
2233         (or (bolp) (newline))
2234         (insert (or end ""))))))
2235
2236 (defun org-get-file-contents (file &optional prefix prefix1 markup)
2237   "Get the contents of FILE and return them as a string.
2238 If PREFIX is a string, prepend it to each line.  If PREFIX1
2239 is a string, prepend it to the first line instead of PREFIX.
2240 If MARKUP, don't protect org-like lines, the exporter will
2241 take care of the block they are in."
2242   (if (stringp markup) (setq markup (downcase markup)))
2243   (with-temp-buffer
2244     (insert-file-contents file)
2245     (when (or prefix prefix1)
2246       (goto-char (point-min))
2247       (while (not (eobp))
2248         (insert (or prefix1 prefix))
2249         (setq prefix1 nil)
2250         (beginning-of-line 2)))
2251     (buffer-string)
2252     (when (member markup '("src" "example"))
2253       (goto-char (point-min))
2254       (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t)
2255         (goto-char (match-beginning 0))
2256         (insert ",")
2257         (end-of-line 1)))
2258     (buffer-string)))
2259
2260 (defun org-get-and-remove-property (listvar prop)
2261   "Check if the value of LISTVAR contains PROP as a property.
2262 If yes, return the value of that property (i.e. the element following
2263 in the list) and remove property and value from the list in LISTVAR."
2264   (let ((list (symbol-value listvar)) m v)
2265     (when (setq m (member prop list))
2266       (setq v (nth 1 m))
2267       (if (equal (car list) prop)
2268           (set listvar (cddr list))
2269         (setcdr (nthcdr (- (length list) (length m) 1) list)
2270                 (cddr m))
2271         (set listvar list)))
2272     v))
2273
2274 (defun org-symname-or-string (s)
2275   (if (symbolp s)
2276       (if s (symbol-name s) s)
2277     s))
2278
2279 ;;; Fontification and line numbers for code examples
2280
2281 (defvar org-export-last-code-line-counter-value 0)
2282
2283 (defun org-export-replace-src-segments-and-examples (backend)
2284   "Replace source code segments with special code for export."
2285   (setq org-export-last-code-line-counter-value 0)
2286   (let ((case-fold-search t)
2287         lang code trans opts indent)
2288     (goto-char (point-min))
2289     (while (re-search-forward
2290             "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
2291             nil t)
2292       (if (match-end 1)
2293           ;; src segments
2294           (setq lang (match-string 3)
2295                 opts (match-string 4)
2296                 code (match-string 5)
2297                 indent (length (match-string 2)))
2298         (setq lang nil
2299               opts (match-string 8)
2300               code (match-string 9)
2301               indent (length (match-string 7))))
2302
2303       (setq trans (org-export-format-source-code-or-example
2304                    backend lang code opts indent))
2305       (replace-match trans t t))))
2306
2307 (defvar htmlp)  ;; dynamically scoped
2308 (defvar latexp)  ;; dynamically scoped
2309 (defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
2310 (defvar org-export-latex-listings) ;; defined in org-latex.el
2311 (defvar org-export-latex-listings-langs) ;; defined in org-latex.el
2312
2313 (defun org-export-format-source-code-or-example
2314   (backend lang code &optional opts indent)
2315   "Format CODE from language LANG and return it formatted for export.
2316 If LANG is nil, do not add any fontification.
2317 OPTS contains formatting options, like `-n' for triggering numbering lines,
2318 and `+n' for continuing previous numbering.
2319 Code formatting according to language currently only works for HTML.
2320 Numbering lines works for all three major backends (html, latex, and ascii).
2321 INDENT was the original indentation of the block."
2322   (save-match-data
2323     (let (num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt)
2324       (setq opts (or opts "")
2325             num (string-match "[-+]n\\>" opts)
2326             cont (string-match "\\+n\\>" opts)
2327             rpllbl (string-match "-r\\>" opts)
2328             keepp (string-match "-k\\>" opts)
2329             textareap (string-match "-t\\>" opts)
2330             preserve-indentp (or org-src-preserve-indentation
2331                                  (string-match "-i\\>" opts))
2332             cols (if (string-match "-w[ \t]+\\([0-9]+\\)" opts)
2333                      (string-to-number (match-string 1 opts))
2334                    80)
2335             rows (if (string-match "-h[ \t]+\\([0-9]+\\)" opts)
2336                      (string-to-number (match-string 1 opts))
2337                    (org-count-lines code))
2338             fmt (if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts)
2339                     (match-string 1 opts)))
2340       (when (and textareap (eq backend 'html))
2341         ;; we cannot use numbering or highlighting.
2342         (setq num nil cont nil lang nil))
2343       (if keepp (setq rpllbl 'keep))
2344       (setq rtn (if preserve-indentp code (org-remove-indentation code)))
2345       (when (string-match "^," rtn)
2346         (setq rtn (with-temp-buffer
2347                     (insert rtn)
2348                     ;; Free up the protected lines
2349                     (goto-char (point-min))
2350                     (while (re-search-forward "^," nil t)
2351                       (if (or (equal lang "org")
2352                               (save-match-data
2353                                 (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
2354                           (replace-match ""))
2355                       (end-of-line 1))
2356                     (buffer-string))))
2357       ;; Now backend-specific coding
2358       (setq rtn
2359             (cond
2360              ((eq backend 'docbook)
2361               (setq rtn (org-export-number-lines rtn 'docbook 0 0 num cont rpllbl fmt))
2362               (concat "\n#+BEGIN_DOCBOOK\n"
2363                       (org-add-props (concat "<programlisting><![CDATA["
2364                                              rtn
2365                                              "]]>\n</programlisting>\n")
2366                           '(org-protected t))
2367                       "#+END_DOCBOOK\n"))
2368              ((eq backend 'html)
2369               ;; We are exporting to HTML
2370               (when lang
2371                 (require 'htmlize nil t)
2372                 (when (not (fboundp 'htmlize-region-for-paste))
2373                   ;; we do not have htmlize.el, or an old version of it
2374                   (setq lang nil)
2375                   (message
2376                    "htmlize.el 1.34 or later is needed for source code formatting")))
2377
2378               (if lang
2379                   (let* ((lang-m (when lang
2380                                    (or (cdr (assoc lang org-src-lang-modes))
2381                                        lang)))
2382                          (mode (and lang-m (intern
2383                                             (concat
2384                                              (if (symbolp lang-m)
2385                                                  (symbol-name lang-m)
2386                                                lang-m)
2387                                              "-mode"))))
2388                          (org-inhibit-startup t)
2389                          (org-startup-folded nil))
2390                     (setq rtn
2391                           (with-temp-buffer
2392                             (insert rtn)
2393                             (if (functionp mode)
2394                                 (funcall mode)
2395                               (fundamental-mode))
2396                             (font-lock-fontify-buffer)
2397                             (org-src-mode)
2398                             (set-buffer-modified-p nil)
2399                             (org-export-htmlize-region-for-paste
2400                              (point-min) (point-max))))
2401                     (if (string-match "<pre\\([^>]*\\)>\n*" rtn)
2402                         (setq rtn (replace-match
2403                                    (format "<pre class=\"src src-%s\">\n" lang)
2404                                    t t rtn))))
2405                 (if textareap
2406                     (setq rtn (concat
2407                                (format "<p>\n<textarea cols=\"%d\" rows=\"%d\" overflow-x:scroll >\n"
2408                                        cols rows)
2409                                rtn "</textarea>\n</p>\n"))
2410                   (with-temp-buffer
2411                     (insert rtn)
2412                     (goto-char (point-min))
2413                     (while (re-search-forward "[<>&]" nil t)
2414                       (replace-match (cdr (assq (char-before)
2415                                                 '((?&."&amp;")(?<."&lt;")(?>."&gt;"))))
2416                                      t t))
2417                     (setq rtn (buffer-string)))
2418                   (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
2419               (unless textareap
2420                 (setq rtn (org-export-number-lines rtn 'html 1 1 num
2421                                                    cont rpllbl fmt)))
2422               (if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
2423                   (setq rtn (replace-match "\\1" t nil rtn)))
2424               (concat "\n#+BEGIN_HTML\n" (org-add-props rtn '(org-protected t)) "\n#+END_HTML\n\n"))
2425              ((eq backend 'latex)
2426               (setq rtn (org-export-number-lines rtn 'latex 0 0 num cont rpllbl fmt))
2427               (concat "#+BEGIN_LaTeX\n"
2428                       (org-add-props
2429                           (if org-export-latex-listings
2430                               (concat
2431                                (if lang
2432                                    (let*
2433                                        ((lang-sym (intern lang))
2434                                         (lstlang
2435                                          (or (cadr
2436                                               (assq
2437                                                lang-sym
2438                                                org-export-latex-listings-langs))
2439                                              lang)))
2440                                      (format "\\lstset{language=%s}\n" lstlang))
2441                                  "")
2442                                "\\begin{lstlisting}\n"
2443                                rtn "\\end{lstlisting}\n")
2444                             (concat (car org-export-latex-verbatim-wrap)
2445                                     rtn (cdr org-export-latex-verbatim-wrap)))
2446                           '(org-protected t))
2447                       "#+END_LaTeX\n"))
2448              ((eq backend 'ascii)
2449               ;; This is not HTML or LaTeX, so just make it an example.
2450               (setq rtn (org-export-number-lines rtn 'ascii 0 0 num cont rpllbl fmt))
2451               (concat "#+BEGIN_ASCII\n"
2452                       (org-add-props
2453                           (concat
2454                            (mapconcat
2455                             (lambda (l) (concat "  " l))
2456                             (org-split-string rtn "\n")
2457                             "\n")
2458                            "\n")
2459                           '(org-protected t))
2460                       "#+END_ASCII\n"))))
2461       (org-add-props rtn nil 'original-indentation indent))))
2462
2463 (defun org-export-number-lines (text backend
2464                                      &optional skip1 skip2 number cont
2465                                      replace-labels label-format)
2466   (setq skip1 (or skip1 0) skip2 (or skip2 0))
2467   (if (not cont) (setq org-export-last-code-line-counter-value 0))
2468   (with-temp-buffer
2469     (insert text)
2470     (goto-char (point-max))
2471     (skip-chars-backward " \t\n\r")
2472     (delete-region (point) (point-max))
2473     (beginning-of-line (- 1 skip2))
2474     (let* ((last (org-current-line))
2475            (n org-export-last-code-line-counter-value)
2476            (nmax (+ n (- last skip1)))
2477            (fmt (format "%%%dd:  " (length (number-to-string nmax))))
2478            (fm
2479             (cond
2480              ((eq backend 'html) (format "<span class=\"linenr\">%s</span>"
2481                                          fmt))
2482              ((eq backend 'ascii) fmt)
2483              ((eq backend 'latex) fmt)
2484              ((eq backend 'docbook) fmt)
2485              (t "")))
2486            (label-format (or label-format org-coderef-label-format))
2487            (label-pre (if (string-match "%s" label-format)
2488                           (substring label-format 0 (match-beginning 0))
2489                         label-format))
2490            (label-post (if (string-match "%s" label-format)
2491                            (substring label-format (match-end 0))
2492                          ""))
2493            (lbl-re
2494             (concat
2495              ".*?\\S-.*?\\([ \t]*\\("
2496              (regexp-quote label-pre)
2497              "\\([-a-zA-Z0-9_ ]+\\)"
2498              (regexp-quote label-post)
2499              "\\)\\)"))
2500            ref)
2501
2502       (org-goto-line (1+ skip1))
2503       (while (and (re-search-forward "^" nil t) (not (eobp)) (< n nmax))
2504         (if number
2505             (insert (format fm (incf n)))
2506           (forward-char 1))
2507         (when (looking-at lbl-re)
2508           (setq ref (match-string 3))
2509           (cond ((numberp replace-labels)
2510                  ;; remove labels; use numbers for references when lines
2511                  ;; are numbered, use labels otherwise
2512                  (delete-region (match-beginning 1) (match-end 1))
2513                  (push (cons ref (if (> n 0) n ref)) org-export-code-refs))
2514                 ((eq replace-labels 'keep)
2515                  ;; don't remove labels; use numbers for references when
2516                  ;; lines are numbered, use labels otherwise
2517                  (goto-char (match-beginning 2))
2518                  (delete-region (match-beginning 2) (match-end 2))
2519                  (insert "(" ref ")")
2520                  (push (cons ref (if (> n 0) n (concat "(" ref ")")))
2521                        org-export-code-refs))
2522                 (t
2523                  ;; don't remove labels and don't use numbers for
2524                  ;; references
2525                  (goto-char (match-beginning 2))
2526                  (delete-region (match-beginning 2) (match-end 2))
2527                  (insert "(" ref ")")
2528                  (push (cons ref (concat "(" ref ")")) org-export-code-refs)))
2529           (when (eq backend 'html)
2530             (save-excursion
2531               (beginning-of-line 1)
2532               (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
2533                               ref))
2534               (end-of-line 1)
2535               (insert "</span>")))))
2536       (setq org-export-last-code-line-counter-value n)
2537       (goto-char (point-max))
2538       (newline)
2539       (buffer-string))))
2540
2541 (defun org-search-todo-below (line lines level)
2542   "Search the subtree below LINE for any TODO entries."
2543   (let ((rest (cdr (memq line lines)))
2544         (re org-todo-line-regexp)
2545         line lv todo)
2546     (catch 'exit
2547       (while (setq line (pop rest))
2548         (if (string-match re line)
2549             (progn
2550               (setq lv (- (match-end 1) (match-beginning 1))
2551                     todo (and (match-beginning 2)
2552                               (not (member (match-string 2 line)
2553                                           org-done-keywords))))
2554                                         ; TODO, not DONE
2555               (if (<= lv level) (throw 'exit nil))
2556               (if todo (throw 'exit t))))))))
2557
2558 ;;;###autoload
2559 (defun org-export-visible (type arg)
2560   "Create a copy of the visible part of the current buffer, and export it.
2561 The copy is created in a temporary buffer and removed after use.
2562 TYPE is the final key (as a string) that also select the export command in
2563 the `C-c C-e' export dispatcher.
2564 As a special case, if the you type SPC at the prompt, the temporary
2565 org-mode file will not be removed but presented to you so that you can
2566 continue to use it.  The prefix arg ARG is passed through to the exporting
2567 command."
2568   (interactive
2569    (list (progn
2570            (message "Export visible: [a]SCII  [h]tml  [b]rowse HTML [H/R]uffer with HTML  [D]ocBook  [x]OXO  [ ]keep buffer")
2571            (read-char-exclusive))
2572          current-prefix-arg))
2573   (if (not (member type '(?a ?\C-a ?b ?\C-b ?h ?D ?x ?\ )))
2574       (error "Invalid export key"))
2575   (let* ((binding (cdr (assoc type
2576                               '((?a . org-export-as-ascii)
2577                                 (?A . org-export-as-ascii-to-buffer)
2578                                 (?\C-a . org-export-as-ascii)
2579                                 (?b . org-export-as-html-and-open)
2580                                 (?\C-b . org-export-as-html-and-open)
2581                                 (?h . org-export-as-html)
2582                                 (?H . org-export-as-html-to-buffer)
2583                                 (?R . org-export-region-as-html)
2584                                 (?D . org-export-as-docbook)
2585                                 (?x . org-export-as-xoxo)))))
2586          (keepp (equal type ?\ ))
2587          (file buffer-file-name)
2588          (buffer (get-buffer-create "*Org Export Visible*"))
2589          s e)
2590     ;; Need to hack the drawers here.
2591     (save-excursion
2592       (goto-char (point-min))
2593       (while (re-search-forward org-drawer-regexp nil t)
2594         (goto-char (match-beginning 1))
2595         (or (org-invisible-p) (org-flag-drawer nil))))
2596     (with-current-buffer buffer (erase-buffer))
2597     (save-excursion
2598       (setq s (goto-char (point-min)))
2599       (while (not (= (point) (point-max)))
2600         (goto-char (org-find-invisible))
2601         (append-to-buffer buffer s (point))
2602         (setq s (goto-char (org-find-visible))))
2603       (org-cycle-hide-drawers 'all)
2604       (goto-char (point-min))
2605       (unless keepp
2606         ;; Copy all comment lines to the end, to make sure #+ settings are
2607         ;; still available for the second export step.  Kind of a hack, but
2608         ;; does do the trick.
2609         (if (looking-at "#[^\r\n]*")
2610             (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
2611         (while (re-search-forward "[\n\r]#[^\n\r]*" nil t)
2612           (append-to-buffer buffer (1+ (match-beginning 0))
2613                             (min (point-max) (1+ (match-end 0))))))
2614       (set-buffer buffer)
2615       (let ((buffer-file-name file)
2616             (org-inhibit-startup t))
2617         (org-mode)
2618         (show-all)
2619         (unless keepp (funcall binding arg))))
2620     (if (not keepp)
2621         (kill-buffer buffer)
2622       (switch-to-buffer-other-window buffer)
2623       (goto-char (point-min)))))
2624
2625 (defun org-find-visible ()
2626   (let ((s (point)))
2627     (while (and (not (= (point-max) (setq s (next-overlay-change s))))
2628                 (get-char-property s 'invisible)))
2629     s))
2630 (defun org-find-invisible ()
2631   (let ((s (point)))
2632     (while (and (not (= (point-max) (setq s (next-overlay-change s))))
2633                 (not (get-char-property s 'invisible))))
2634     s))
2635
2636 (defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
2637
2638 ;;;###autoload
2639 (defun org-export-as-org (arg &optional hidden ext-plist
2640                               to-buffer body-only pub-dir)
2641   "Make a copy with not-exporting stuff removed.
2642 The purpose of this function is to provide a way to export the source
2643 Org file of a webpage in Org format, but with sensitive and/or irrelevant
2644 stuff removed.  This command will remove the following:
2645
2646 - archived trees (if the variable `org-export-with-archived-trees' is nil)
2647 - comment blocks and trees starting with the COMMENT keyword
2648 - only trees that are consistent with `org-export-select-tags'
2649   and `org-export-exclude-tags'.
2650
2651 The only arguments that will be used are EXT-PLIST and PUB-DIR,
2652 all the others will be ignored (but are present so that the general
2653 mechanism to call publishing functions will work).
2654
2655 EXT-PLIST is a property list with external parameters overriding
2656 org-mode's default settings, but still inferior to file-local
2657 settings.  When PUB-DIR is set, use this as the publishing
2658 directory."
2659   (interactive "P")
2660   (let* ((opt-plist (org-combine-plists (org-default-export-plist)
2661                                         ext-plist
2662                                         (org-infile-export-plist)))
2663          (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
2664          (filename (concat (file-name-as-directory
2665                             (or pub-dir
2666                                 (org-export-directory :org opt-plist)))
2667                            (file-name-sans-extension
2668                             (file-name-nondirectory bfname))
2669                            ".org"))
2670          (filename (and filename
2671                         (if (equal (file-truename filename)
2672                                    (file-truename bfname))
2673                             (concat (file-name-sans-extension filename)
2674                                     "-source."
2675                                     (file-name-extension filename))
2676                           filename)))
2677          (backup-inhibited t)
2678          (buffer (find-file-noselect filename))
2679          (region (buffer-string)))
2680     (save-excursion
2681       (switch-to-buffer buffer)
2682       (erase-buffer)
2683       (insert region)
2684       (let ((org-inhibit-startup t)) (org-mode))
2685       (org-install-letbind)
2686
2687       ;; Get rid of archived trees
2688       (org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
2689
2690       ;; Remove comment environment and comment subtrees
2691       (org-export-remove-comment-blocks-and-subtrees)
2692
2693       ;; Get rid of excluded trees
2694       (org-export-handle-export-tags (plist-get opt-plist :select-tags)
2695                                      (plist-get opt-plist :exclude-tags))
2696
2697       (when (or (plist-get opt-plist :plain-source)
2698                 (not (or (plist-get opt-plist :plain-source)
2699                          (plist-get opt-plist :htmlized-source))))
2700         ;; Either nothing special is requested (default call)
2701         ;; or the plain source is explicitly requested
2702         ;; so: save it
2703         (save-buffer))
2704       (when (plist-get opt-plist :htmlized-source)
2705         ;; Make the htmlized version
2706         (require 'htmlize)
2707         (require 'org-html)
2708         (font-lock-fontify-buffer)
2709         (let* ((htmlize-output-type 'css)
2710                (newbuf (htmlize-buffer)))
2711           (with-current-buffer newbuf
2712             (when org-export-htmlized-org-css-url
2713               (goto-char (point-min))
2714               (and (re-search-forward
2715                     "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
2716                     nil t)
2717                    (replace-match
2718                     (format
2719                      "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
2720                      org-export-htmlized-org-css-url)
2721                     t t)))
2722             (write-file (concat filename ".html")))
2723           (kill-buffer newbuf)))
2724       (set-buffer-modified-p nil)
2725       (kill-buffer (current-buffer)))))
2726
2727 (defvar org-archive-location)  ;; gets loaded with the org-archive require.
2728 (defun org-get-current-options ()
2729   "Return a string with current options as keyword options.
2730 Does include HTML export options as well as TODO and CATEGORY stuff."
2731   (require 'org-archive)
2732   (format
2733    "#+TITLE:     %s
2734 #+AUTHOR:    %s
2735 #+EMAIL:     %s
2736 #+DATE:      %s
2737 #+DESCRIPTION:
2738 #+KEYWORDS:
2739 #+LANGUAGE:  %s
2740 #+OPTIONS:   H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
2741 #+OPTIONS:   TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
2742 %s
2743 #+EXPORT_SELECT_TAGS: %s
2744 #+EXPORT_EXCLUDE_TAGS: %s
2745 #+LINK_UP:   %s
2746 #+LINK_HOME: %s
2747 #+CATEGORY:  %s
2748 #+SEQ_TODO:  %s
2749 #+TYP_TODO:  %s
2750 #+PRIORITIES: %c %c %c
2751 #+DRAWERS:   %s
2752 #+STARTUP:   %s %s %s %s %s
2753 #+TAGS:      %s
2754 #+FILETAGS:  %s
2755 #+ARCHIVE:   %s
2756 #+LINK:      %s
2757 "
2758    (buffer-name) (user-full-name) user-mail-address
2759    (format-time-string (substring (car org-time-stamp-formats) 1 -1))
2760    org-export-default-language
2761    org-export-headline-levels
2762    org-export-with-section-numbers
2763    org-export-with-toc
2764    org-export-preserve-breaks
2765    org-export-html-expand
2766    org-export-with-fixed-width
2767    org-export-with-tables
2768    org-export-with-sub-superscripts
2769    org-export-with-special-strings
2770    org-export-with-footnotes
2771    org-export-with-emphasize
2772    org-export-with-timestamps
2773    org-export-with-TeX-macros
2774    org-export-with-LaTeX-fragments
2775    org-export-skip-text-before-1st-heading
2776    org-export-with-drawers
2777    org-export-with-todo-keywords
2778    org-export-with-priority
2779    org-export-with-tags
2780    (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
2781    (mapconcat 'identity org-export-select-tags " ")
2782    (mapconcat 'identity org-export-exclude-tags " ")
2783    org-export-html-link-up
2784    org-export-html-link-home
2785    (or (ignore-errors
2786          (file-name-sans-extension
2787           (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
2788        "NOFILENAME")
2789    "TODO FEEDBACK VERIFY DONE"
2790    "Me Jason Marie DONE"
2791    org-highest-priority org-lowest-priority org-default-priority
2792    (mapconcat 'identity org-drawers " ")
2793    (cdr (assoc org-startup-folded
2794                '((nil . "showall") (t . "overview") (content . "content"))))
2795    (if org-odd-levels-only "odd" "oddeven")
2796    (if org-hide-leading-stars "hidestars" "showstars")
2797    (if org-startup-align-all-tables "align" "noalign")
2798    (cond ((eq org-log-done t) "logdone")
2799          ((equal org-log-done 'note) "lognotedone")
2800          ((not org-log-done) "nologdone"))
2801    (or (mapconcat (lambda (x)
2802                     (cond
2803                      ((equal :startgroup (car x)) "{")
2804                      ((equal :endgroup (car x)) "}")
2805                      ((equal :newline (car x)) "")
2806                      ((cdr x) (format "%s(%c)" (car x) (cdr x)))
2807                      (t (car x))))
2808                   (or org-tag-alist (org-get-buffer-tags)) " ") "")
2809    (mapconcat 'identity org-file-tags " ")
2810    org-archive-location
2811    "org file:~/org/%s.org"
2812    ))
2813
2814 ;;;###autoload
2815 (defun org-insert-export-options-template ()
2816   "Insert into the buffer a template with information for exporting."
2817   (interactive)
2818   (if (not (bolp)) (newline))
2819   (let ((s (org-get-current-options)))
2820     (and (string-match "#\\+CATEGORY" s)
2821          (setq s (substring s 0 (match-beginning 0))))
2822     (insert s)))
2823
2824 (defvar org-table-colgroup-info nil)
2825
2826 (defun org-table-clean-before-export (lines &optional maybe-quoted)
2827   "Check if the table has a marking column.
2828 If yes remove the column and the special lines."
2829   (setq org-table-colgroup-info nil)
2830   (if (memq nil
2831             (mapcar
2832              (lambda (x) (or (string-match "^[ \t]*|-" x)
2833                              (string-match
2834                               (if maybe-quoted
2835                                   "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
2836                                 "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
2837                               x)))
2838              lines))
2839       (progn
2840         (setq org-table-clean-did-remove-column nil)
2841         (delq nil
2842               (mapcar
2843                (lambda (x)
2844                  (cond
2845                   ((string-match  "^[ \t]*| */ *|" x)
2846                    (setq org-table-colgroup-info
2847                          (mapcar (lambda (x)
2848                                    (cond ((member x '("<" "&lt;")) :start)
2849                                          ((member x '(">" "&gt;")) :end)
2850                                          ((member x '("<>" "&lt;&gt;")) :startend)
2851                                          (t nil)))
2852                                  (org-split-string x "[ \t]*|[ \t]*")))
2853                    nil)
2854                   (t x)))
2855                lines)))
2856     (setq org-table-clean-did-remove-column t)
2857     (delq nil
2858           (mapcar
2859            (lambda (x)
2860              (cond
2861               ((string-match  "^[ \t]*| */ *|" x)
2862                (setq org-table-colgroup-info
2863                      (mapcar (lambda (x)
2864                                (cond ((member x '("<" "&lt;")) :start)
2865                                      ((member x '(">" "&gt;")) :end)
2866                                      ((member x '("<>" "&lt;&gt;")) :startend)
2867                                      (t nil)))
2868                              (cdr (org-split-string x "[ \t]*|[ \t]*"))))
2869                nil)
2870               ((string-match "^[ \t]*| *[!_^/] *|" x)
2871                nil) ; ignore this line
2872               ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
2873                    (string-match "^\\([ \t]*\\)|[^|]*|" x))
2874                ;; remove the first column
2875                (replace-match "\\1|" t nil x))))
2876            lines))))
2877
2878 (defun org-export-cleanup-toc-line (s)
2879   "Remove tags and timestamps from lines going into the toc."
2880   (when (memq org-export-with-tags '(not-in-toc nil))
2881     (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s)
2882         (setq s (replace-match "" t t s))))
2883   (when org-export-remove-timestamps-from-toc
2884     (while (string-match org-maybe-keyword-time-regexp s)
2885       (setq s (replace-match "" t t s))))
2886   (while (string-match org-bracket-link-regexp s)
2887     (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
2888                            t t s)))
2889   (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s)
2890     (setq s (replace-match "" t t s)))
2891   s)
2892
2893 (defun org-create-multibrace-regexp (left right n)
2894   "Create a regular expression which will match a balanced sexp.
2895 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
2896 as single character strings.
2897 The regexp returned will match the entire expression including the
2898 delimiters.  It will also define a single group which contains the
2899 match except for the outermost delimiters.  The maximum depth of
2900 stacked delimiters is N.  Escaping delimiters is not possible."
2901   (let* ((nothing (concat "[^" left right "]*?"))
2902          (or "\\|")
2903          (re nothing)
2904          (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
2905     (while (> n 1)
2906       (setq n (1- n)
2907             re (concat re or next)
2908             next (concat "\\(?:" nothing left next right "\\)+" nothing)))
2909     (concat left "\\(" re "\\)" right)))
2910
2911 (defvar org-match-substring-regexp
2912   (concat
2913    "\\([^\\]\\)\\([_^]\\)\\("
2914    "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
2915    "\\|"
2916    "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
2917    "\\|"
2918    "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
2919   "The regular expression matching a sub- or superscript.")
2920
2921 (defvar org-match-substring-with-braces-regexp
2922   (concat
2923    "\\([^\\]\\)\\([_^]\\)\\("
2924    "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
2925    "\\)")
2926   "The regular expression matching a sub- or superscript, forcing braces.")
2927
2928
2929 (defun org-get-text-property-any (pos prop &optional object)
2930   (or (get-text-property pos prop object)
2931       (and (setq pos (next-single-property-change pos prop object))
2932            (get-text-property pos prop object))))
2933
2934 (defun org-export-get-coderef-format (path desc)
2935   (save-match-data
2936     (if (and desc (string-match
2937                    (regexp-quote (concat "(" path ")"))
2938                    desc))
2939         (replace-match "%s" t t desc)
2940       (or desc "%s"))))
2941
2942 (defun org-export-push-to-kill-ring (format)
2943   "Push buffer content to kill ring.
2944 The depends on the variable `org-export-copy-to-kill'."
2945   (when org-export-copy-to-kill-ring
2946     (org-kill-new (buffer-string))
2947     (when (fboundp 'x-set-selection)
2948       (ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
2949       (ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
2950     (message "%s export done, pushed to kill ring and clipboard" format)))
2951
2952 (provide 'org-exp)
2953
2954 ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
2955
2956 ;;; org-exp.el ends here
2957