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