lisp/org-odt.el

   1 ;;; org-odt.el --- OpenDocument Text exporter for Org-mode
   2
   3 ;; Copyright (C) 2010-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
   6 ;; Keywords: outlines, hypermedia, calendar, wp
   7 ;; Homepage: http://orgmode.org
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27 (eval-when-compile
  28   (require 'cl))
  29 (require 'org-lparse)
  30
  31 (defgroup org-export-odt nil
  32   "Options specific for ODT export of Org-mode files."
  33   :tag "Org Export ODT"
  34   :group 'org-export
  35   :version "24.1")
  36
  37 (defvar org-lparse-dyn-first-heading-pos) ; let bound during org-do-lparse
  38 (defun org-odt-insert-toc ()
  39   (goto-char (point-min))
  40   (cond
  41    ((re-search-forward
  42      "\\(<text:p [^>]*>\\)?\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*\\(</text:p>\\)?"
  43      nil t)
  44     (replace-match ""))
  45    (t
  46     (goto-char org-lparse-dyn-first-heading-pos)))
  47   (insert (org-odt-format-toc)))
  48
  49 (defun org-odt-end-export ()
  50   (org-odt-insert-toc)
  51   (org-odt-fixup-label-references)
  52
  53   ;; remove empty paragraphs
  54   (goto-char (point-min))
  55   (while (re-search-forward
  56           "<text:p\\( text:style-name=\"Text_20_body\"\\)?>[ \r\n\t]*</text:p>"
  57           nil t)
  58     (replace-match ""))
  59   (goto-char (point-min))
  60
  61   ;; Convert whitespace place holders
  62   (goto-char (point-min))
  63   (let (beg end n)
  64     (while (setq beg (next-single-property-change (point) 'org-whitespace))
  65       (setq n (get-text-property beg 'org-whitespace)
  66             end (next-single-property-change beg 'org-whitespace))
  67       (goto-char beg)
  68       (delete-region beg end)
  69       (insert (format "<span style=\"visibility:hidden;\">%s</span>"
  70                       (make-string n ?x)))))
  71
  72   ;; Remove empty lines at the beginning of the file.
  73   (goto-char (point-min))
  74   (when (looking-at "\\s-+\n") (replace-match ""))
  75
  76   ;; Remove display properties
  77   (remove-text-properties (point-min) (point-max) '(display t)))
  78
  79 (defvar org-odt-suppress-xref nil)
  80 (defconst org-export-odt-special-string-regexps
  81   '(("\\\\-" . "&#x00ad;\\1")           ; shy
  82     ("---\\([^-]\\)" . "&#x2014;\\1")   ; mdash
  83     ("--\\([^-]\\)" . "&#x2013;\\1")    ; ndash
  84     ("\\.\\.\\." . "&#x2026;"))         ; hellip
  85   "Regular expressions for special string conversion.")
  86
  87 (defconst org-odt-lib-dir (file-name-directory load-file-name)
  88   "Location of ODT exporter.
  89 Use this to infer values of `org-odt-styles-dir' and
  90 `org-export-odt-schema-dir'.")
  91
  92 (defvar org-odt-data-dir nil
  93   "Data directory for ODT exporter.
  94 Use this to infer values of `org-odt-styles-dir' and
  95 `org-export-odt-schema-dir'.")
  96
  97 (defconst org-odt-schema-dir-list
  98   (list
  99    (and org-odt-data-dir
 100         (expand-file-name "./schema/" org-odt-data-dir)) ; bail out
 101    (eval-when-compile
 102      (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
 103           (expand-file-name "./schema/" org-odt-data-dir)))
 104    (expand-file-name "../contrib/odt/etc/schema/" org-odt-lib-dir) ; git
 105    )
 106   "List of directories to search for OpenDocument schema files.
 107 Use this list to set the default value of
 108 `org-export-odt-schema-dir'.  The entries in this list are
 109 populated heuristically based on the values of `org-odt-lib-dir'
 110 and `org-odt-data-dir'.")
 111
 112 (defcustom org-export-odt-schema-dir
 113   (let* ((schema-dir
 114           (catch 'schema-dir
 115             (message "Debug (org-odt): Searching for OpenDocument schema files...")
 116             (mapc
 117              (lambda (schema-dir)
 118                (when schema-dir
 119                  (message "Debug (org-odt): Trying %s..." schema-dir)
 120                  (when (and (file-readable-p
 121                              (expand-file-name "od-manifest-schema-v1.2-cs01.rnc"
 122                                                schema-dir))
 123                             (file-readable-p
 124                              (expand-file-name "od-schema-v1.2-cs01.rnc"
 125                                                schema-dir))
 126                             (file-readable-p
 127                              (expand-file-name "schemas.xml" schema-dir)))
 128                    (message "Debug (org-odt): Using schema files under %s"
 129                             schema-dir)
 130                    (throw 'schema-dir schema-dir))))
 131              org-odt-schema-dir-list)
 132             (message "Debug (org-odt): No OpenDocument schema files installed")
 133             nil)))
 134     schema-dir)
 135   "Directory that contains OpenDocument schema files.
 136
 137 This directory contains:
 138 1. rnc files for OpenDocument schema
 139 2. a \"schemas.xml\" file that specifies locating rules needed
 140    for auto validation of OpenDocument XML files.
 141
 142 Use the customize interface to set this variable.  This ensures
 143 that `rng-schema-locating-files' is updated and auto-validation
 144 of OpenDocument XML takes place based on the value
 145 `rng-nxml-auto-validate-flag'.
 146
 147 The default value of this variable varies depending on the
 148 version of org in use and is initialized from
 149 `org-odt-schema-dir-list'.  The OASIS schema files are available
 150 only in the org's private git repository.  It is *not* bundled
 151 with GNU ELPA tar or standard Emacs distribution."
 152   :type '(choice
 153           (const :tag "Not set" nil)
 154           (directory :tag "Schema directory"))
 155   :group 'org-export-odt
 156   :version "24.1"
 157   :set
 158   (lambda (var value)
 159     "Set `org-export-odt-schema-dir'.
 160 Also add it to `rng-schema-locating-files'."
 161     (let ((schema-dir value))
 162       (set var
 163            (if (and
 164                 (file-readable-p
 165                  (expand-file-name "od-manifest-schema-v1.2-cs01.rnc" schema-dir))
 166                 (file-readable-p
 167                  (expand-file-name "od-schema-v1.2-cs01.rnc" schema-dir))
 168                 (file-readable-p
 169                  (expand-file-name "schemas.xml" schema-dir)))
 170                schema-dir
 171              (when value
 172                (message "Error (org-odt): %s has no OpenDocument schema files"
 173                         value))
 174              nil)))
 175     (when org-export-odt-schema-dir
 176       (eval-after-load 'rng-loc
 177         '(add-to-list 'rng-schema-locating-files
 178                       (expand-file-name "schemas.xml"
 179                                         org-export-odt-schema-dir))))))
 180
 181 (defconst org-odt-styles-dir-list
 182   (list
 183    (and org-odt-data-dir
 184         (expand-file-name "./styles/" org-odt-data-dir)) ; bail out
 185    (eval-when-compile
 186      (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
 187           (expand-file-name "./styles/" org-odt-data-dir)))
 188    (expand-file-name "../etc/styles/" org-odt-lib-dir) ; git
 189    (expand-file-name "./etc/styles/" org-odt-lib-dir)  ; elpa
 190    (expand-file-name "./org/" data-directory)          ; system
 191    )
 192   "List of directories to search for OpenDocument styles files.
 193 See `org-odt-styles-dir'.  The entries in this list are populated
 194 heuristically based on the values of `org-odt-lib-dir' and
 195 `org-odt-data-dir'.")
 196
 197 (defconst org-odt-styles-dir
 198   (let* ((styles-dir
 199           (catch 'styles-dir
 200             (message "Debug (org-odt): Searching for OpenDocument styles files...")
 201             (mapc (lambda (styles-dir)
 202                     (when styles-dir
 203                       (message "Debug (org-odt): Trying %s..." styles-dir)
 204                       (when (and (file-readable-p
 205                                   (expand-file-name
 206                                    "OrgOdtContentTemplate.xml" styles-dir))
 207                                  (file-readable-p
 208                                   (expand-file-name
 209                                    "OrgOdtStyles.xml" styles-dir)))
 210                         (message "Debug (org-odt): Using styles under %s"
 211                                  styles-dir)
 212                         (throw 'styles-dir styles-dir))))
 213                   org-odt-styles-dir-list)
 214             nil)))
 215     (unless styles-dir
 216       (error "Error (org-odt): Cannot find factory styles files. Aborting."))
 217     styles-dir)
 218   "Directory that holds auxiliary XML files used by the ODT exporter.
 219
 220 This directory contains the following XML files -
 221  \"OrgOdtStyles.xml\" and \"OrgOdtContentTemplate.xml\".  These
 222  XML files are used as the default values of
 223  `org-export-odt-styles-file' and
 224  `org-export-odt-content-template-file'.
 225
 226 The default value of this variable varies depending on the
 227 version of org in use and is initialized from
 228 `org-odt-styles-dir-list'.  Note that the user could be using org
 229 from one of: org's own private git repository, GNU ELPA tar or
 230 standard Emacs.")
 231
 232 (defvar org-odt-file-extensions
 233   '(("odt" . "OpenDocument Text")
 234     ("ott" . "OpenDocument Text Template")
 235     ("odm" . "OpenDocument Master Document")
 236     ("ods" . "OpenDocument Spreadsheet")
 237     ("ots" . "OpenDocument Spreadsheet Template")
 238     ("odg" . "OpenDocument Drawing (Graphics)")
 239     ("otg" . "OpenDocument Drawing Template")
 240     ("odp" . "OpenDocument Presentation")
 241     ("otp" . "OpenDocument Presentation Template")
 242     ("odi" . "OpenDocument Image")
 243     ("odf" . "OpenDocument Formula")
 244     ("odc" . "OpenDocument Chart")))
 245
 246 (mapc
 247  (lambda (desc)
 248    ;; Let Org open all OpenDocument files using system-registered app
 249    (add-to-list 'org-file-apps
 250                 (cons (concat  "\\." (car desc) "\\'") 'system))
 251    ;; Let Emacs open all OpenDocument files in archive mode
 252    (add-to-list 'auto-mode-alist
 253                 (cons (concat  "\\." (car desc) "\\'") 'archive-mode)))
 254  org-odt-file-extensions)
 255
 256 ;; register the odt exporter with the pre-processor
 257 (add-to-list 'org-export-backends 'odt)
 258
 259 ;; register the odt exporter with org-lparse library
 260 (org-lparse-register-backend 'odt)
 261
 262 (defun org-odt-unload-function ()
 263   (org-lparse-unregister-backend 'odt)
 264   (remove-hook 'org-export-preprocess-after-blockquote-hook
 265                'org-export-odt-preprocess-latex-fragments)
 266   nil)
 267
 268 (defcustom org-export-odt-content-template-file nil
 269   "Template file for \"content.xml\".
 270 The exporter embeds the exported content just before
 271 \"</office:text>\" element.
 272
 273 If unspecified, the file named \"OrgOdtContentTemplate.xml\"
 274 under `org-odt-styles-dir' is used."
 275   :type 'file
 276   :group 'org-export-odt
 277   :version "24.1")
 278
 279 (defcustom org-export-odt-styles-file nil
 280   "Default styles file for use with ODT export.
 281 Valid values are one of:
 282 1. nil
 283 2. path to a styles.xml file
 284 3. path to a *.odt or a *.ott file
 285 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
 286 ...))
 287
 288 In case of option 1, an in-built styles.xml is used. See
 289 `org-odt-styles-dir' for more information.
 290
 291 In case of option 3, the specified file is unzipped and the
 292 styles.xml embedded therein is used.
 293
 294 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
 295 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
 296 generated odt file.  Use relative path for specifying the
 297 FILE-MEMBERS.  styles.xml must be specified as one of the
 298 FILE-MEMBERS.
 299
 300 Use options 1, 2 or 3 only if styles.xml alone suffices for
 301 achieving the desired formatting.  Use option 4, if the styles.xml
 302 references additional files like header and footer images for
 303 achieving the desired formatting.
 304
 305 Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
 306 a per-file basis.  For example,
 307
 308 #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
 309 #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
 310   :group 'org-export-odt
 311   :version "24.1"
 312   :type
 313   '(choice
 314     (const :tag "Factory settings" nil)
 315     (file :must-match t :tag "styles.xml")
 316     (file :must-match t :tag "ODT or OTT file")
 317     (list :tag "ODT or OTT file + Members"
 318           (file :must-match t :tag "ODF Text or Text Template file")
 319           (cons :tag "Members"
 320                 (file :tag "    Member" "styles.xml")
 321                 (repeat (file :tag "Member"))))))
 322
 323 (eval-after-load 'org-exp
 324   '(add-to-list 'org-export-inbuffer-options-extra
 325                 '("ODT_STYLES_FILE" :odt-styles-file)))
 326
 327 (defconst org-export-odt-tmpdir-prefix "%s-")
 328 (defconst org-export-odt-bookmark-prefix "OrgXref.")
 329
 330 (defvar org-export-odt-embed-images t
 331   "Should the images be copied in to the odt file or just linked?")
 332
 333 (defvar org-export-odt-inline-images 'maybe)
 334 (defcustom org-export-odt-inline-image-extensions
 335   '("png" "jpeg" "jpg" "gif")
 336   "Extensions of image files that can be inlined into HTML."
 337   :type '(repeat (string :tag "Extension"))
 338   :group 'org-export-odt
 339   :version "24.1")
 340
 341 (defcustom org-export-odt-pixels-per-inch display-pixels-per-inch
 342   "Scaling factor for converting images pixels to inches.
 343 Use this for sizing of embedded images.  See Info node `(org)
 344 Images in ODT export' for more information."
 345   :type 'float
 346   :group 'org-export-odt
 347   :version "24.1")
 348
 349 (defcustom org-export-odt-create-custom-styles-for-srcblocks t
 350   "Whether custom styles for colorized source blocks be automatically created.
 351 When this option is turned on, the exporter creates custom styles
 352 for source blocks based on the advice of `htmlfontify'.  Creation
 353 of custom styles happen as part of `org-odt-hfy-face-to-css'.
 354
 355 When this option is turned off exporter does not create such
 356 styles.
 357
 358 Use the latter option if you do not want the custom styles to be
 359 based on your current display settings.  It is necessary that the
 360 styles.xml already contains needed styles for colorizing to work.
 361
 362 This variable is effective only if
 363 `org-export-odt-fontify-srcblocks' is turned on."
 364   :group 'org-export-odt
 365   :version "24.1"
 366   :type 'boolean)
 367
 368 (defvar org-export-odt-default-org-styles-alist
 369   '((paragraph . ((default . "Text_20_body")
 370                   (fixedwidth . "OrgFixedWidthBlock")
 371                   (verse . "OrgVerse")
 372                   (quote . "Quotations")
 373                   (blockquote . "Quotations")
 374                   (center . "OrgCenter")
 375                   (left . "OrgLeft")
 376                   (right . "OrgRight")
 377                   (title . "OrgTitle")
 378                   (subtitle . "OrgSubtitle")
 379                   (footnote . "Footnote")
 380                   (src . "OrgSrcBlock")
 381                   (illustration . "Illustration")
 382                   (table . "Table")
 383                   (definition-term . "Text_20_body_20_bold")
 384                   (horizontal-line . "Horizontal_20_Line")))
 385     (character . ((bold . "Bold")
 386                   (emphasis . "Emphasis")
 387                   (code . "OrgCode")
 388                   (verbatim . "OrgCode")
 389                   (strike . "Strikethrough")
 390                   (underline . "Underline")
 391                   (subscript . "OrgSubscript")
 392                   (superscript . "OrgSuperscript")))
 393     (list . ((ordered . "OrgNumberedList")
 394              (unordered . "OrgBulletedList")
 395              (description . "OrgDescriptionList"))))
 396   "Default styles for various entities.")
 397
 398 (defvar org-export-odt-org-styles-alist org-export-odt-default-org-styles-alist)
 399 (defun org-odt-get-style-name-for-entity (category &optional entity)
 400   (let ((entity (or entity 'default)))
 401     (or
 402      (cdr (assoc entity (cdr (assoc category
 403                                     org-export-odt-org-styles-alist))))
 404      (cdr (assoc entity (cdr (assoc category
 405                                     org-export-odt-default-org-styles-alist))))
 406      (error "Cannot determine style name for entity %s of type %s"
 407             entity category))))
 408
 409 (defcustom org-export-odt-preferred-output-format nil
 410   "Automatically post-process to this format after exporting to \"odt\".
 411 Interactive commands `org-export-as-odt' and
 412 `org-export-as-odt-and-open' export first to \"odt\" format and
 413 then use `org-export-odt-convert-process' to convert the
 414 resulting document to this format.  During customization of this
 415 variable, the list of valid values are populated based on
 416 `org-export-odt-convert-capabilities'."
 417   :group 'org-export-odt
 418   :version "24.1"
 419   :type '(choice :convert-widget
 420                  (lambda (w)
 421                    (apply 'widget-convert (widget-type w)
 422                           (eval (car (widget-get w :args)))))
 423                  `((const :tag "None" nil)
 424                    ,@(mapcar (lambda (c)
 425                                `(const :tag ,c ,c))
 426                              (org-lparse-reachable-formats "odt")))))
 427
 428 ;;;###autoload
 429 (defun org-export-as-odt-and-open (arg)
 430   "Export the outline as ODT and immediately open it with a browser.
 431 If there is an active region, export only the region.
 432 The prefix ARG specifies how many levels of the outline should become
 433 headlines.  The default is 3.  Lower levels will become bulleted lists."
 434   (interactive "P")
 435   (org-lparse-and-open
 436    (or org-export-odt-preferred-output-format "odt") "odt" arg))
 437
 438 ;;;###autoload
 439 (defun org-export-as-odt-batch ()
 440   "Call the function `org-lparse-batch'.
 441 This function can be used in batch processing as:
 442 emacs   --batch
 443         --load=$HOME/lib/emacs/org.el
 444         --eval \"(setq org-export-headline-levels 2)\"
 445         --visit=MyFile --funcall org-export-as-odt-batch"
 446   (org-lparse-batch "odt"))
 447
 448 ;;; org-export-as-odt
 449 ;;;###autoload
 450 (defun org-export-as-odt (arg &optional hidden ext-plist
 451                               to-buffer body-only pub-dir)
 452   "Export the outline as a OpenDocumentText file.
 453 If there is an active region, export only the region.  The prefix
 454 ARG specifies how many levels of the outline should become
 455 headlines.  The default is 3.  Lower levels will become bulleted
 456 lists.  HIDDEN is obsolete and does nothing.
 457 EXT-PLIST is a property list with external parameters overriding
 458 org-mode's default settings, but still inferior to file-local
 459 settings.  When TO-BUFFER is non-nil, create a buffer with that
 460 name and export to that buffer.  If TO-BUFFER is the symbol
 461 `string', don't leave any buffer behind but just return the
 462 resulting XML as a string.  When BODY-ONLY is set, don't produce
 463 the file header and footer, simply return the content of
 464 <body>...</body>, without even the body tags themselves.  When
 465 PUB-DIR is set, use this as the publishing directory."
 466   (interactive "P")
 467   (org-lparse (or org-export-odt-preferred-output-format "odt")
 468               "odt" arg hidden ext-plist to-buffer body-only pub-dir))
 469
 470 (defvar org-odt-entity-control-callbacks-alist
 471   `((EXPORT
 472      . (org-odt-begin-export org-odt-end-export))
 473     (DOCUMENT-CONTENT
 474      . (org-odt-begin-document-content org-odt-end-document-content))
 475     (DOCUMENT-BODY
 476      . (org-odt-begin-document-body org-odt-end-document-body))
 477     (TOC
 478      . (org-odt-begin-toc org-odt-end-toc))
 479     (ENVIRONMENT
 480      . (org-odt-begin-environment org-odt-end-environment))
 481     (FOOTNOTE-DEFINITION
 482      . (org-odt-begin-footnote-definition org-odt-end-footnote-definition))
 483     (TABLE
 484      . (org-odt-begin-table org-odt-end-table))
 485     (TABLE-ROWGROUP
 486      . (org-odt-begin-table-rowgroup org-odt-end-table-rowgroup))
 487     (LIST
 488      . (org-odt-begin-list org-odt-end-list))
 489     (LIST-ITEM
 490      . (org-odt-begin-list-item org-odt-end-list-item))
 491     (OUTLINE
 492      . (org-odt-begin-outline org-odt-end-outline))
 493     (OUTLINE-TEXT
 494      . (org-odt-begin-outline-text org-odt-end-outline-text))
 495     (PARAGRAPH
 496      . (org-odt-begin-paragraph org-odt-end-paragraph)))
 497   "")
 498
 499 (defvar org-odt-entity-format-callbacks-alist
 500   `((EXTRA-TARGETS . org-lparse-format-extra-targets)
 501     (ORG-TAGS . org-lparse-format-org-tags)
 502     (SECTION-NUMBER . org-lparse-format-section-number)
 503     (HEADLINE . org-odt-format-headline)
 504     (TOC-ENTRY . org-odt-format-toc-entry)
 505     (TOC-ITEM . org-odt-format-toc-item)
 506     (TAGS . org-odt-format-tags)
 507     (SPACES . org-odt-format-spaces)
 508     (TABS . org-odt-format-tabs)
 509     (LINE-BREAK . org-odt-format-line-break)
 510     (FONTIFY . org-odt-format-fontify)
 511     (TODO . org-lparse-format-todo)
 512     (LINK . org-odt-format-link)
 513     (INLINE-IMAGE . org-odt-format-inline-image)
 514     (ORG-LINK . org-odt-format-org-link)
 515     (HEADING . org-odt-format-heading)
 516     (ANCHOR . org-odt-format-anchor)
 517     (TABLE . org-lparse-format-table)
 518     (TABLE-ROW . org-odt-format-table-row)
 519     (TABLE-CELL . org-odt-format-table-cell)
 520     (FOOTNOTES-SECTION . ignore)
 521     (FOOTNOTE-REFERENCE . org-odt-format-footnote-reference)
 522     (HORIZONTAL-LINE . org-odt-format-horizontal-line)
 523     (COMMENT . org-odt-format-comment)
 524     (LINE . org-odt-format-line)
 525     (ORG-ENTITY . org-odt-format-org-entity))
 526   "")
 527
 528 ;;;_. callbacks
 529 ;;;_. control callbacks
 530 ;;;_ , document body
 531 (defun org-odt-begin-office-body ()
 532   ;; automatic styles
 533   (insert-file-contents
 534    (or org-export-odt-content-template-file
 535        (expand-file-name "OrgOdtContentTemplate.xml"
 536                          org-odt-styles-dir)))
 537   (goto-char (point-min))
 538   (re-search-forward "</office:text>" nil nil)
 539   (delete-region (match-beginning 0) (point-max)))
 540
 541 ;; Following variable is let bound when `org-do-lparse' is in
 542 ;; progress. See org-html.el.
 543 (defvar org-lparse-toc)
 544 (defun org-odt-format-toc ()
 545   (if (not org-lparse-toc) "" (concat  "\n" org-lparse-toc "\n")))
 546
 547 (defun org-odt-format-preamble (opt-plist)
 548   (let* ((title (plist-get opt-plist :title))
 549          (author (plist-get opt-plist :author))
 550          (date (plist-get opt-plist :date))
 551          (iso-date (org-odt-format-date date))
 552          (date (org-odt-format-date date "%d %b %Y"))
 553          (email (plist-get opt-plist :email))
 554          ;; switch on or off above vars based on user settings
 555          (author (and (plist-get opt-plist :author-info) (or author email)))
 556          (email (and (plist-get opt-plist :email-info) email))
 557          (date (and (plist-get opt-plist :time-stamp-file) date)))
 558     (concat
 559      ;; title
 560      (when title
 561        (concat
 562         (org-odt-format-stylized-paragraph
 563          'title (org-odt-format-tags
 564                  '("<text:title>" . "</text:title>") title))
 565         ;; separator
 566         "<text:p text:style-name=\"OrgTitle\"/>"))
 567      (cond
 568       ((and author (not email))
 569        ;; author only
 570        (concat
 571         (org-odt-format-stylized-paragraph
 572          'subtitle
 573          (org-odt-format-tags
 574           '("<text:initial-creator>" . "</text:initial-creator>")
 575           author))
 576         ;; separator
 577         "<text:p text:style-name=\"OrgSubtitle\"/>"))
 578       ((and author email)
 579        ;; author and email
 580        (concat
 581         (org-odt-format-stylized-paragraph
 582          'subtitle
 583          (org-odt-format-link
 584           (org-odt-format-tags
 585            '("<text:initial-creator>" . "</text:initial-creator>")
 586            author) (concat "mailto:" email)))
 587         ;; separator
 588         "<text:p text:style-name=\"OrgSubtitle\"/>")))
 589      ;; date
 590      (when date
 591        (concat
 592         (org-odt-format-stylized-paragraph
 593          'subtitle
 594          (org-odt-format-tags
 595           '("<text:date style:data-style-name=\"%s\" text:date-value=\"%s\">"
 596             . "</text:date>") date "N75" iso-date))
 597         ;; separator
 598         "<text:p text:style-name=\"OrgSubtitle\"/>")))))
 599
 600 (defun org-odt-begin-document-body (opt-plist)
 601   (org-odt-begin-office-body)
 602   (insert (org-odt-format-preamble opt-plist))
 603   (setq org-lparse-dyn-first-heading-pos (point)))
 604
 605 (defvar org-lparse-body-only)           ; let bound during org-do-lparse
 606 (defvar org-lparse-to-buffer)           ; let bound during org-do-lparse
 607 (defun org-odt-end-document-body (opt-plist)
 608   (unless org-lparse-body-only
 609     (org-lparse-insert-tag "</office:text>")
 610     (org-lparse-insert-tag "</office:body>")))
 611
 612 (defun org-odt-begin-document-content (opt-plist)
 613   (ignore))
 614
 615 (defun org-odt-end-document-content ()
 616   (org-lparse-insert-tag "</office:document-content>"))
 617
 618 (defun org-odt-begin-outline (level1 snumber title tags
 619                                      target extra-targets class)
 620   (org-lparse-insert
 621    'HEADING (org-lparse-format
 622              'HEADLINE title extra-targets tags snumber level1)
 623    level1 target))
 624
 625 (defun org-odt-end-outline ()
 626   (ignore))
 627
 628 (defun org-odt-begin-outline-text (level1 snumber class)
 629   (ignore))
 630
 631 (defun org-odt-end-outline-text ()
 632   (ignore))
 633
 634 (defun org-odt-begin-section (style &optional name)
 635   (let ((default-name (car (org-odt-add-automatic-style "Section"))))
 636     (org-lparse-insert-tag
 637      "<text:section text:style-name=\"%s\" text:name=\"%s\">"
 638      style (or name default-name))))
 639
 640 (defun org-odt-end-section ()
 641   (org-lparse-insert-tag "</text:section>"))
 642
 643 (defun org-odt-begin-paragraph (&optional style)
 644   (org-lparse-insert-tag
 645    "<text:p%s>" (org-odt-get-extra-attrs-for-paragraph-style style)))
 646
 647 (defun org-odt-end-paragraph ()
 648   (org-lparse-insert-tag "</text:p>"))
 649
 650 (defun org-odt-get-extra-attrs-for-paragraph-style (style)
 651   (let (style-name)
 652     (setq style-name
 653           (cond
 654            ((stringp style) style)
 655            ((symbolp style) (org-odt-get-style-name-for-entity
 656                              'paragraph style))))
 657     (unless style-name
 658       (error "Don't know how to handle paragraph style %s" style))
 659     (format " text:style-name=\"%s\"" style-name)))
 660
 661 (defun org-odt-format-stylized-paragraph (style text)
 662   (org-odt-format-tags
 663    '("<text:p%s>" . "</text:p>") text
 664    (org-odt-get-extra-attrs-for-paragraph-style style)))
 665
 666 (defvar org-lparse-opt-plist)               ; bound during org-do-lparse
 667 (defun org-odt-format-author (&optional author)
 668   (when (setq author (or author (plist-get org-lparse-opt-plist :author)))
 669     (org-odt-format-tags '("<dc:creator>" . "</dc:creator>") author)))
 670
 671 (defun org-odt-format-date (&optional org-ts fmt)
 672   (save-match-data
 673     (let* ((time
 674             (and (stringp org-ts)
 675                  (string-match org-ts-regexp0 org-ts)
 676                  (apply 'encode-time
 677                         (org-fix-decoded-time
 678                          (org-parse-time-string (match-string 0 org-ts) t)))))
 679            date)
 680       (cond
 681        (fmt (format-time-string fmt time))
 682        (t (setq date (format-time-string "%Y-%m-%dT%H:%M:%S%z" time))
 683           (format "%s:%s" (substring date 0 -2) (substring date -2)))))))
 684
 685 (defun org-odt-begin-annotation (&optional author date)
 686   (org-lparse-insert-tag "<office:annotation>")
 687   (when (setq author (org-odt-format-author author))
 688     (insert author))
 689   (insert (org-odt-format-tags
 690            '("<dc:date>" . "</dc:date>")
 691            (org-odt-format-date
 692             (or date (plist-get org-lparse-opt-plist :date)))))
 693   (org-lparse-begin-paragraph))
 694
 695 (defun org-odt-end-annotation ()
 696   (org-lparse-insert-tag  "</office:annotation>"))
 697
 698 (defun org-odt-begin-environment (style env-options-plist)
 699   (case style
 700     (annotation
 701      (org-lparse-stash-save-paragraph-state)
 702      (org-odt-begin-annotation (plist-get env-options-plist 'author)
 703                                (plist-get env-options-plist 'date)))
 704     ((blockquote verse center quote)
 705      (org-lparse-begin-paragraph style)
 706      (list))
 707     ((fixedwidth native)
 708      (org-lparse-end-paragraph)
 709      (list))
 710     (t (error "Unknown environment %s" style))))
 711
 712 (defun org-odt-end-environment (style env-options-plist)
 713   (case style
 714     (annotation
 715      (org-lparse-end-paragraph)
 716      (org-odt-end-annotation)
 717      (org-lparse-stash-pop-paragraph-state))
 718     ((blockquote verse center quote)
 719      (org-lparse-end-paragraph)
 720      (list))
 721     ((fixedwidth native)
 722      (org-lparse-begin-paragraph)
 723      (list))
 724     (t (error "Unknown environment %s" style))))
 725
 726 (defvar org-lparse-list-stack) ; dynamically bound in org-do-lparse
 727 (defvar org-odt-list-stack-stashed)
 728 (defun org-odt-begin-list (ltype)
 729   (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
 730                   ltype))
 731   (let* ((style-name (org-odt-get-style-name-for-entity 'list ltype))
 732          (extra (concat (if (or org-lparse-list-table-p
 733                                 (and (= 1 (length org-lparse-list-stack))
 734                                      (null org-odt-list-stack-stashed)))
 735                             " text:continue-numbering=\"false\""
 736                           " text:continue-numbering=\"true\"")
 737                         (when style-name
 738                           (format " text:style-name=\"%s\""  style-name)))))
 739     (case ltype
 740       ((ordered unordered description)
 741        (org-lparse-end-paragraph)
 742        (org-lparse-insert-tag "<text:list%s>" extra))
 743       (t (error "Unknown list type: %s"  ltype)))))
 744
 745 (defun org-odt-end-list (ltype)
 746   (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
 747                   ltype))
 748   (if ltype
 749       (org-lparse-insert-tag "</text:list>")
 750     (error "Unknown list type: %s" ltype)))
 751
 752 (defun org-odt-begin-list-item (ltype &optional arg headline)
 753   (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
 754                   ltype))
 755   (case ltype
 756     (ordered
 757      (assert (not headline) t)
 758      (let* ((counter arg) (extra ""))
 759        (org-lparse-insert-tag (if (= (length org-lparse-list-stack)
 760                                      (length org-odt-list-stack-stashed))
 761                                   "<text:list-header>" "<text:list-item>"))
 762        (org-lparse-begin-paragraph)))
 763     (unordered
 764      (let* ((id arg) (extra ""))
 765        (org-lparse-insert-tag (if (= (length org-lparse-list-stack)
 766                                      (length org-odt-list-stack-stashed))
 767                                   "<text:list-header>" "<text:list-item>"))
 768        (org-lparse-begin-paragraph)
 769        (insert (if headline (org-odt-format-target headline id)
 770                  (org-odt-format-bookmark "" id)))))
 771     (description
 772      (assert (not headline) t)
 773      (let ((term (or arg "(no term)")))
 774        (insert
 775         (org-odt-format-tags
 776          '("<text:list-item>" . "</text:list-item>")
 777          (org-odt-format-stylized-paragraph 'definition-term term)))
 778        (org-lparse-begin-list-item 'unordered)
 779        (org-lparse-begin-list 'description)
 780        (org-lparse-begin-list-item 'unordered)))
 781     (t (error "Unknown list type"))))
 782
 783 (defun org-odt-end-list-item (ltype)
 784   (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
 785                   ltype))
 786   (case ltype
 787     ((ordered unordered)
 788      (org-lparse-insert-tag (if (= (length org-lparse-list-stack)
 789                                    (length org-odt-list-stack-stashed))
 790                                 (prog1 "</text:list-header>"
 791                                   (setq org-odt-list-stack-stashed nil))
 792                               "</text:list-item>")))
 793     (description
 794      (org-lparse-end-list-item-1)
 795      (org-lparse-end-list 'description)
 796      (org-lparse-end-list-item-1))
 797     (t (error "Unknown list type"))))
 798
 799 (defun org-odt-discontinue-list ()
 800   (let ((stashed-stack org-lparse-list-stack))
 801     (loop for list-type in stashed-stack
 802           do (org-lparse-end-list-item-1 list-type)
 803           (org-lparse-end-list list-type))
 804     (setq org-odt-list-stack-stashed stashed-stack)))
 805
 806 (defun org-odt-continue-list ()
 807   (setq org-odt-list-stack-stashed (nreverse org-odt-list-stack-stashed))
 808   (loop for list-type in org-odt-list-stack-stashed
 809         do (org-lparse-begin-list list-type)
 810         (org-lparse-begin-list-item list-type)))
 811
 812 ;; Following variables are let bound when table emission is in
 813 ;; progress. See org-lparse.el.
 814 (defvar org-lparse-table-begin-marker)
 815 (defvar org-lparse-table-ncols)
 816 (defvar org-lparse-table-rowgrp-open)
 817 (defvar org-lparse-table-rownum)
 818 (defvar org-lparse-table-cur-rowgrp-is-hdr)
 819 (defvar org-lparse-table-is-styled)
 820 (defvar org-lparse-table-rowgrp-info)
 821 (defvar org-lparse-table-colalign-vector)
 822
 823 (defvar org-odt-table-style nil
 824   "Table style specified by \"#+ATTR_ODT: <style-name>\" line.
 825 This is set during `org-odt-begin-table'.")
 826
 827 (defvar org-odt-table-style-spec nil
 828   "Entry for `org-odt-table-style' in `org-export-odt-table-styles'.")
 829
 830 (defcustom org-export-odt-table-styles
 831   '(("OrgEquation" "OrgEquation"
 832      ((use-first-column-styles . t)
 833       (use-last-column-styles . t))))
 834   "Specify how Table Styles should be derived from a Table Template.
 835 This is a list where each element is of the
 836 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
 837
 838 TABLE-STYLE-NAME is the style associated with the table through
 839 `org-odt-table-style'.
 840
 841 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
 842 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
 843 below) that is included in
 844 `org-export-odt-content-template-file'.
 845
 846 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
 847                          \"TableCell\"
 848 PARAGRAPH-STYLE-NAME  := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
 849                          \"TableParagraph\"
 850 TABLE-CELL-TYPE       := \"FirstRow\"   | \"LastColumn\" |
 851                          \"FirstRow\"   | \"LastRow\"    |
 852                          \"EvenRow\"    | \"OddRow\"     |
 853                          \"EvenColumn\" | \"OddColumn\"  | \"\"
 854 where \"+\" above denotes string concatenation.
 855
 856 TABLE-CELL-OPTIONS is an alist where each element is of the
 857 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
 858 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles'       |
 859                              `use-last-row-styles'        |
 860                              `use-first-column-styles'    |
 861                              `use-last-column-styles'     |
 862                              `use-banding-rows-styles'    |
 863                              `use-banding-columns-styles' |
 864                              `use-first-row-styles'
 865 ON-OR-OFF                 := `t' | `nil'
 866
 867 For example, with the following configuration
 868
 869 \(setq org-export-odt-table-styles
 870       '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
 871          \(\(use-first-row-styles . t\)
 872           \(use-first-column-styles . t\)\)\)
 873         \(\"TableWithHeaderColumns\" \"Custom\"
 874          \(\(use-first-column-styles . t\)\)\)\)\)
 875
 876 1. A table associated with \"TableWithHeaderRowsAndColumns\"
 877    style will use the following table-cell styles -
 878    \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
 879    \"CustomTableCell\" and the following paragraph styles
 880    \"CustomFirstRowTableParagraph\",
 881    \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
 882    as appropriate.
 883
 884 2. A table associated with \"TableWithHeaderColumns\" style will
 885    use the following table-cell styles -
 886    \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
 887    following paragraph styles
 888    \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
 889    as appropriate..
 890
 891 Note that TABLE-TEMPLATE-NAME corresponds to the
 892 \"<table:table-template>\" elements contained within
 893 \"<office:styles>\".  The entries (TABLE-STYLE-NAME
 894 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
 895 \"table:template-name\" and \"table:use-first-row-styles\" etc
 896 attributes of \"<table:table>\" element.  Refer ODF-1.2
 897 specification for more information.  Also consult the
 898 implementation filed under `org-odt-get-table-cell-styles'.
 899
 900 The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
 901 formatting of numbered display equations.  Do not delete this
 902 style from the list."
 903   :group 'org-export-odt
 904   :version "24.1"
 905   :type '(choice
 906           (const :tag "None" nil)
 907           (repeat :tag "Table Styles"
 908                   (list :tag "Table Style Specification"
 909                         (string :tag "Table Style Name")
 910                         (string  :tag "Table Template Name")
 911                         (alist :options (use-first-row-styles
 912                                          use-last-row-styles
 913                                          use-first-column-styles
 914                                          use-last-column-styles
 915                                          use-banding-rows-styles
 916                                          use-banding-columns-styles)
 917                                :key-type symbol
 918                                :value-type (const :tag "True" t))))))
 919
 920 (defvar org-odt-table-style-format
 921   "
 922 <style:style style:name=\"%s\" style:family=\"table\">
 923   <style:table-properties style:rel-width=\"%d%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
 924 </style:style>
 925 "
 926   "Template for auto-generated Table styles.")
 927
 928 (defvar org-odt-automatic-styles '()
 929   "Registry of automatic styles for various OBJECT-TYPEs.
 930 The variable has the following form:
 931 \(\(OBJECT-TYPE-A
 932   \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
 933    \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
 934  \(OBJECT-TYPE-B
 935   \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
 936    \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
 937  ...\).
 938
 939 OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
 940 OBJECT-PROPS is (typically) a plist created by passing
 941 \"#+ATTR_ODT: \" option to `org-lparse-get-block-params'.
 942
 943 Use `org-odt-add-automatic-style' to add update this variable.'")
 944
 945 (defvar org-odt-object-counters nil
 946   "Running counters for various OBJECT-TYPEs.
 947 Use this to generate automatic names and style-names. See
 948 `org-odt-add-automatic-style'.")
 949
 950 (defun org-odt-write-automatic-styles ()
 951   "Write automatic styles to \"content.xml\"."
 952   (with-current-buffer
 953       (find-file-noselect (expand-file-name "content.xml") t)
 954     ;; position the cursor
 955     (goto-char (point-min))
 956     (re-search-forward "  </office:automatic-styles>" nil t)
 957     (goto-char (match-beginning 0))
 958     ;; write automatic table styles
 959     (loop for (style-name props) in
 960           (plist-get org-odt-automatic-styles 'Table) do
 961           (when (setq props (or (plist-get props :rel-width) 96))
 962             (insert (format org-odt-table-style-format style-name props))))))
 963
 964 (defun org-odt-add-automatic-style (object-type &optional object-props)
 965   "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
 966 OBJECT-PROPS is (typically) a plist created by passing
 967 \"#+ATTR_ODT: \" option of the object in question to
 968 `org-lparse-get-block-params'.
 969
 970 Use `org-odt-object-counters' to generate an automatic
 971 OBJECT-NAME and STYLE-NAME.  If OBJECT-PROPS is non-nil, add a
 972 new entry in `org-odt-automatic-styles'.  Return (OBJECT-NAME
 973 . STYLE-NAME)."
 974   (assert (stringp object-type))
 975   (let* ((object (intern object-type))
 976          (seqvar object)
 977          (seqno (1+ (or (plist-get org-odt-object-counters seqvar) 0)))
 978          (object-name (format "%s%d" object-type seqno)) style-name)
 979     (setq org-odt-object-counters
 980           (plist-put org-odt-object-counters seqvar seqno))
 981     (when object-props
 982       (setq style-name (format "Org%s" object-name))
 983       (setq org-odt-automatic-styles
 984             (plist-put org-odt-automatic-styles object
 985                        (append (list (list style-name object-props))
 986                                (plist-get org-odt-automatic-styles object)))))
 987     (cons object-name style-name)))
 988
 989 (defvar org-odt-table-indentedp nil)
 990 (defun org-odt-begin-table (caption label attributes)
 991   (setq org-odt-table-indentedp (not (null org-lparse-list-stack)))
 992   (when org-odt-table-indentedp
 993     ;; Within the Org file, the table is appearing within a list item.
 994     ;; OpenDocument doesn't allow table to appear within list items.
 995     ;; Temporarily terminate the list, emit the table and then
 996     ;; re-continue the list.
 997     (org-odt-discontinue-list)
 998     ;; Put the Table in an indented section.
 999     (let ((level (length org-odt-list-stack-stashed)))
1000       (org-odt-begin-section (format "OrgIndentedSection-Level-%d" level))))
1001   (setq attributes (org-lparse-get-block-params attributes))
1002   (setq org-odt-table-style (plist-get attributes :style))
1003   (setq org-odt-table-style-spec
1004         (assoc org-odt-table-style org-export-odt-table-styles))
1005   (when (or label caption)
1006     (insert
1007      (org-odt-format-stylized-paragraph
1008       'table (org-odt-format-entity-caption label caption "__Table__"))))
1009   (let ((name-and-style (org-odt-add-automatic-style "Table" attributes)))
1010     (org-lparse-insert-tag
1011      "<table:table table:name=\"%s\" table:style-name=\"%s\">"
1012      (car name-and-style) (or (nth 1 org-odt-table-style-spec)
1013                               (cdr name-and-style) "OrgTable")))
1014   (setq org-lparse-table-begin-marker (point)))
1015
1016 (defvar org-lparse-table-colalign-info)
1017 (defun org-odt-end-table ()
1018   (goto-char org-lparse-table-begin-marker)
1019   (loop for level from 0 below org-lparse-table-ncols
1020         do (let* ((col-cookie (and org-lparse-table-is-styled
1021                                    (cdr (assoc (1+ level)
1022                                                org-lparse-table-colalign-info))))
1023                   (extra-columns (or (nth 1 col-cookie) 0)))
1024              (dotimes (i (1+ extra-columns))
1025                (insert
1026                 (org-odt-format-tags
1027                  "<table:table-column table:style-name=\"%sColumn\"/>"
1028                  "" (or (nth 1 org-odt-table-style-spec) "OrgTable"))))
1029              (insert "\n")))
1030   ;; fill style attributes for table cells
1031   (when org-lparse-table-is-styled
1032     (while (re-search-forward "@@\\(table-cell:p\\|table-cell:style-name\\)@@\\([0-9]+\\)@@\\([0-9]+\\)@@" nil t)
1033       (let* ((spec (match-string 1))
1034              (r (string-to-number (match-string 2)))
1035              (c (string-to-number (match-string 3)))
1036              (cell-styles (org-odt-get-table-cell-styles
1037                            r c org-odt-table-style-spec))
1038              (table-cell-style (car cell-styles))
1039              (table-cell-paragraph-style (cdr cell-styles)))
1040         (cond
1041          ((equal spec "table-cell:p")
1042           (replace-match table-cell-paragraph-style t t))
1043          ((equal spec "table-cell:style-name")
1044           (replace-match table-cell-style t t))))))
1045   (goto-char (point-max))
1046   (org-lparse-insert-tag "</table:table>")
1047   (when org-odt-table-indentedp
1048     (org-odt-end-section)
1049     (org-odt-continue-list)))
1050
1051 (defun org-odt-begin-table-rowgroup (&optional is-header-row)
1052   (when org-lparse-table-rowgrp-open
1053     (org-lparse-end 'TABLE-ROWGROUP))
1054   (org-lparse-insert-tag (if is-header-row
1055                              "<table:table-header-rows>"
1056                            "<table:table-rows>"))
1057   (setq org-lparse-table-rowgrp-open t)
1058   (setq org-lparse-table-cur-rowgrp-is-hdr is-header-row))
1059
1060 (defun org-odt-end-table-rowgroup ()
1061   (when org-lparse-table-rowgrp-open
1062     (setq org-lparse-table-rowgrp-open nil)
1063     (org-lparse-insert-tag
1064      (if org-lparse-table-cur-rowgrp-is-hdr
1065          "</table:table-header-rows>" "</table:table-rows>"))))
1066
1067 (defun org-odt-format-table-row (row)
1068   (org-odt-format-tags
1069    '("<table:table-row>" . "</table:table-row>") row))
1070
1071 (defun org-odt-get-table-cell-styles (r c &optional style-spec)
1072   "Retrieve styles applicable to a table cell.
1073 R and C are (zero-based) row and column numbers of the table
1074 cell.  STYLE-SPEC is an entry in `org-export-odt-table-styles'
1075 applicable to the current table.  It is `nil' if the table is not
1076 associated with any style attributes.
1077
1078 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
1079
1080 When STYLE-SPEC is nil, style the table cell the conventional way
1081 - choose cell borders based on row and column groupings and
1082 choose paragraph alignment based on `org-col-cookies' text
1083 property.  See also
1084 `org-odt-get-paragraph-style-cookie-for-table-cell'.
1085
1086 When STYLE-SPEC is non-nil, ignore the above cookie and return
1087 styles congruent with the ODF-1.2 specification."
1088   (cond
1089    (style-spec
1090
1091     ;; LibreOffice - particularly the Writer - honors neither table
1092     ;; templates nor custom table-cell styles.  Inorder to retain
1093     ;; inter-operability with LibreOffice, only automatic styles are
1094     ;; used for styling of table-cells.  The current implementation is
1095     ;; congruent with ODF-1.2 specification and hence is
1096     ;; future-compatible.
1097
1098     ;; Additional Note: LibreOffice's AutoFormat facility for tables -
1099     ;; which recognizes as many as 16 different cell types - is much
1100     ;; richer. Unfortunately it is NOT amenable to easy configuration
1101     ;; by hand.
1102
1103     (let* ((template-name (nth 1 style-spec))
1104            (cell-style-selectors (nth 2 style-spec))
1105            (cell-type
1106             (cond
1107              ((and (cdr (assoc 'use-first-column-styles cell-style-selectors))
1108                    (= c 0)) "FirstColumn")
1109              ((and (cdr (assoc 'use-last-column-styles cell-style-selectors))
1110                    (= c (1- org-lparse-table-ncols))) "LastColumn")
1111              ((and (cdr (assoc 'use-first-row-styles cell-style-selectors))
1112                    (= r 0)) "FirstRow")
1113              ((and (cdr (assoc 'use-last-row-styles cell-style-selectors))
1114                    (= r org-lparse-table-rownum))
1115               "LastRow")
1116              ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
1117                    (= (% r 2) 1)) "EvenRow")
1118              ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
1119                    (= (% r 2) 0)) "OddRow")
1120              ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
1121                    (= (% c 2) 1)) "EvenColumn")
1122              ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
1123                    (= (% c 2) 0)) "OddColumn")
1124              (t ""))))
1125       (cons
1126        (concat template-name cell-type "TableCell")
1127        (concat template-name cell-type "TableParagraph"))))
1128    (t
1129     (cons
1130      (concat
1131       "OrgTblCell"
1132       (cond
1133        ((= r 0) "T")
1134        ((eq (cdr (assoc r org-lparse-table-rowgrp-info))  :start) "T")
1135        (t ""))
1136       (when (= r org-lparse-table-rownum) "B")
1137       (cond
1138        ((= c 0) "")
1139        ((or (memq (nth c org-table-colgroup-info) '(:start :startend))
1140             (memq (nth (1- c) org-table-colgroup-info) '(:end :startend))) "L")
1141        (t "")))
1142      (capitalize (aref org-lparse-table-colalign-vector c))))))
1143
1144 (defun org-odt-get-paragraph-style-cookie-for-table-cell (r c)
1145   (concat
1146    (and (not org-odt-table-style-spec)
1147         (cond
1148          (org-lparse-table-cur-rowgrp-is-hdr "OrgTableHeading")
1149          ((and (= c 0) (org-lparse-get 'TABLE-FIRST-COLUMN-AS-LABELS))
1150           "OrgTableHeading")
1151          (t "OrgTableContents")))
1152    (and org-lparse-table-is-styled
1153         (format "@@table-cell:p@@%03d@@%03d@@" r c))))
1154
1155 (defun org-odt-get-style-name-cookie-for-table-cell (r c)
1156   (when org-lparse-table-is-styled
1157     (format "@@table-cell:style-name@@%03d@@%03d@@" r c)))
1158
1159 (defun org-odt-format-table-cell (data r c horiz-span)
1160   (concat
1161    (let* ((paragraph-style-cookie
1162            (org-odt-get-paragraph-style-cookie-for-table-cell r c))
1163           (style-name-cookie
1164            (org-odt-get-style-name-cookie-for-table-cell r c))
1165           (extra (and style-name-cookie
1166                       (format " table:style-name=\"%s\""  style-name-cookie)))
1167           (extra (concat extra
1168                          (and (> horiz-span 0)
1169                               (format " table:number-columns-spanned=\"%d\""
1170                                       (1+ horiz-span))))))
1171      (org-odt-format-tags
1172       '("<table:table-cell%s>" . "</table:table-cell>")
1173       (if org-lparse-list-table-p data
1174         (org-odt-format-stylized-paragraph paragraph-style-cookie data)) extra))
1175    (let (s)
1176      (dotimes (i horiz-span)
1177        (setq s (concat s "\n<table:covered-table-cell/>"))) s)
1178    "\n"))
1179
1180 (defun org-odt-begin-footnote-definition (n)
1181   (org-lparse-begin-paragraph 'footnote))
1182
1183 (defun org-odt-end-footnote-definition (n)
1184   (org-lparse-end-paragraph))
1185
1186 (defun org-odt-begin-toc (lang-specific-heading max-level)
1187   (insert
1188    (format "
1189     <text:table-of-content text:style-name=\"Sect2\" text:protected=\"true\" text:name=\"Table of Contents1\">
1190      <text:table-of-content-source text:outline-level=\"%d\">
1191       <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1192 " max-level lang-specific-heading))
1193   (loop for level from 1 upto 10
1194         do (insert (format
1195                     "
1196       <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1197        <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
1198        <text:index-entry-chapter/>
1199        <text:index-entry-text/>
1200        <text:index-entry-link-end/>
1201       </text:table-of-content-entry-template>
1202 " level level)))
1203
1204   (insert
1205    (format  "
1206      </text:table-of-content-source>
1207
1208      <text:index-body>
1209       <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
1210        <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
1211       </text:index-title>
1212 " lang-specific-heading)))
1213
1214 (defun org-odt-end-toc ()
1215   (insert "
1216      </text:index-body>
1217     </text:table-of-content>
1218 "))
1219
1220 (defun org-odt-format-toc-entry (snumber todo headline tags href)
1221   (setq headline (concat
1222                   (and org-export-with-section-numbers
1223                        (concat snumber ". "))
1224                   headline
1225                   (and tags
1226                        (concat
1227                         (org-lparse-format 'SPACES 3)
1228                         (org-lparse-format 'FONTIFY tags "tag")))))
1229   (when todo
1230     (setq headline (org-lparse-format 'FONTIFY headline "todo")))
1231
1232   (let ((org-odt-suppress-xref t))
1233     (org-odt-format-link headline (concat  "#" href))))
1234
1235 (defun org-odt-format-toc-item (toc-entry level org-last-level)
1236   (let ((style (format "Contents_20_%d"
1237                        (+ level (or (org-lparse-get 'TOPLEVEL-HLEVEL) 1) -1))))
1238     (insert "\n" (org-odt-format-stylized-paragraph style toc-entry) "\n")))
1239
1240 ;; Following variable is let bound during 'ORG-LINK callback. See
1241 ;; org-html.el
1242 (defvar org-lparse-link-description-is-image nil)
1243 (defun org-odt-format-link (desc href &optional attr)
1244   (cond
1245    ((and (= (string-to-char href) ?#) (not org-odt-suppress-xref))
1246     (setq href (concat org-export-odt-bookmark-prefix (substring href 1)))
1247     (let ((xref-format "text"))
1248       (when (numberp desc)
1249         (setq desc (format "%d" desc) xref-format "number"))
1250       (org-odt-format-tags
1251        '("<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">" .
1252          "</text:bookmark-ref>")
1253        desc xref-format href)))
1254    (org-lparse-link-description-is-image
1255     (org-odt-format-tags
1256      '("<draw:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</draw:a>")
1257      desc href (or attr "")))
1258    (t
1259     (org-odt-format-tags
1260      '("<text:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</text:a>")
1261      desc href (or attr "")))))
1262
1263 (defun org-odt-format-spaces (n)
1264   (cond
1265    ((= n 1) " ")
1266    ((> n 1) (concat
1267              " " (org-odt-format-tags "<text:s text:c=\"%d\"/>" "" (1- n))))
1268    (t "")))
1269
1270 (defun org-odt-format-tabs (&optional n)
1271   (let ((tab "<text:tab/>")
1272         (n (or n 1)))
1273     (insert tab)))
1274
1275 (defun org-odt-format-line-break ()
1276   (org-odt-format-tags "<text:line-break/>" ""))
1277
1278 (defun org-odt-format-horizontal-line ()
1279   (org-odt-format-stylized-paragraph 'horizontal-line ""))
1280
1281 (defun org-odt-encode-plain-text (line &optional no-whitespace-filling)
1282   (setq line (org-xml-encode-plain-text line))
1283   (if no-whitespace-filling line
1284     (org-odt-fill-tabs-and-spaces line)))
1285
1286 (defun org-odt-format-line (line)
1287   (case org-lparse-dyn-current-environment
1288     (fixedwidth (concat
1289                  (org-odt-format-stylized-paragraph
1290                   'fixedwidth (org-odt-encode-plain-text line)) "\n"))
1291     (t (concat line "\n"))))
1292
1293 (defun org-odt-format-comment (fmt &rest args)
1294   (let ((comment (apply 'format fmt args)))
1295     (format "\n<!-- %s  -->\n" comment)))
1296
1297 (defun org-odt-format-org-entity (wd)
1298   (org-entity-get-representation wd 'utf8))
1299
1300 (defun org-odt-fill-tabs-and-spaces (line)
1301   (replace-regexp-in-string
1302    "\\([\t]\\|\\([ ]+\\)\\)" (lambda (s)
1303                                (cond
1304                                 ((string= s "\t") (org-odt-format-tabs))
1305                                 (t (org-odt-format-spaces (length s))))) line))
1306
1307 (defcustom org-export-odt-fontify-srcblocks t
1308   "Specify whether or not source blocks need to be fontified.
1309 Turn this option on if you want to colorize the source code
1310 blocks in the exported file.  For colorization to work, you need
1311 to make available an enhanced version of `htmlfontify' library."
1312   :type 'boolean
1313   :group 'org-export-odt
1314   :version "24.1")
1315
1316 (defun org-odt-format-source-line-with-line-number-and-label
1317   (line rpllbl num fontifier par-style)
1318
1319   (let ((keep-label (not (numberp rpllbl)))
1320         (ref (org-find-text-property-in-string 'org-coderef line)))
1321     (setq line (concat line (and keep-label ref (format "(%s)" ref))))
1322     (setq line (funcall fontifier line))
1323     (when ref
1324       (setq line (org-odt-format-target line (concat "coderef-" ref))))
1325     (setq line (org-odt-format-stylized-paragraph par-style line))
1326     (if (not num) line
1327       (org-odt-format-tags '("<text:list-item>" . "</text:list-item>") line))))
1328
1329 (defun org-odt-format-source-code-or-example-plain
1330   (lines lang caption textareap cols rows num cont rpllbl fmt)
1331   "Format source or example blocks much like fixedwidth blocks.
1332 Use this when `org-export-odt-fontify-srcblocks' option is turned
1333 off."
1334   (let* ((lines (org-split-string lines "[\r\n]"))
1335          (line-count (length lines))
1336          (i 0))
1337     (mapconcat
1338      (lambda (line)
1339        (incf i)
1340        (org-odt-format-source-line-with-line-number-and-label
1341         line rpllbl num 'org-odt-encode-plain-text
1342         (if (= i line-count) "OrgFixedWidthBlockLastLine"
1343           "OrgFixedWidthBlock")))
1344      lines "\n")))
1345
1346 (defvar org-src-block-paragraph-format
1347   "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
1348    <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
1349     <style:background-image/>
1350    </style:paragraph-properties>
1351    <style:text-properties fo:color=\"%s\"/>
1352   </style:style>"
1353   "Custom paragraph style for colorized source and example blocks.
1354 This style is much the same as that of \"OrgFixedWidthBlock\"
1355 except that the foreground and background colors are set
1356 according to the default face identified by the `htmlfontify'.")
1357
1358 (defvar hfy-optimisations)
1359 (declare-function hfy-face-to-style "htmlfontify" (fn))
1360 (declare-function hfy-face-or-def-to-name "htmlfontify" (fn))
1361
1362 (defun org-odt-hfy-face-to-css (fn)
1363   "Create custom style for face FN.
1364 When FN is the default face, use it's foreground and background
1365 properties to create \"OrgSrcBlock\" paragraph style.  Otherwise
1366 use it's color attribute to create a character style whose name
1367 is obtained from FN.  Currently all attributes of FN other than
1368 color are ignored.
1369
1370 The style name for a face FN is derived using the following
1371 operations on the face name in that order - de-dash, CamelCase
1372 and prefix with \"OrgSrc\".  For example,
1373 `font-lock-function-name-face' is associated with
1374 \"OrgSrcFontLockFunctionNameFace\"."
1375   (let* ((css-list (hfy-face-to-style fn))
1376          (style-name ((lambda (fn)
1377                         (concat "OrgSrc"
1378                                 (mapconcat
1379                                  'capitalize (split-string
1380                                               (hfy-face-or-def-to-name fn) "-")
1381                                  ""))) fn))
1382          (color-val (cdr (assoc "color" css-list)))
1383          (background-color-val (cdr (assoc "background" css-list)))
1384          (style (and org-export-odt-create-custom-styles-for-srcblocks
1385                      (cond
1386                       ((eq fn 'default)
1387                        (format org-src-block-paragraph-format
1388                                background-color-val color-val))
1389                       (t
1390                        (format
1391                         "
1392 <style:style style:name=\"%s\" style:family=\"text\">
1393   <style:text-properties fo:color=\"%s\"/>
1394  </style:style>" style-name color-val))))))
1395     (cons style-name style)))
1396
1397 (defun org-odt-insert-custom-styles-for-srcblocks (styles)
1398   "Save STYLES used for colorizing of source blocks.
1399 Update styles.xml with styles that were collected as part of
1400 `org-odt-hfy-face-to-css' callbacks."
1401   (when styles
1402     (with-current-buffer
1403         (find-file-noselect (expand-file-name "styles.xml") t)
1404       (goto-char (point-min))
1405       (when (re-search-forward "</office:styles>" nil t)
1406         (goto-char (match-beginning 0))
1407         (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n")))))
1408
1409 (defun org-odt-format-source-code-or-example-colored
1410   (lines lang caption textareap cols rows num cont rpllbl fmt)
1411   "Format source or example blocks using `htmlfontify-string'.
1412 Use this routine when `org-export-odt-fontify-srcblocks' option
1413 is turned on."
1414   (let* ((lang-m (and lang (or (cdr (assoc lang org-src-lang-modes)) lang)))
1415          (mode (and lang-m (intern (concat (if (symbolp lang-m)
1416                                                (symbol-name lang-m)
1417                                              lang-m) "-mode"))))
1418          (org-inhibit-startup t)
1419          (org-startup-folded nil)
1420          (lines (with-temp-buffer
1421                   (insert lines)
1422                   (if (functionp mode) (funcall mode) (fundamental-mode))
1423                   (font-lock-fontify-buffer)
1424                   (buffer-string)))
1425          (hfy-html-quote-regex "\\([<\"&>       ]\\)")
1426          (hfy-html-quote-map '(("\"" "&quot;")
1427                                ("<" "&lt;")
1428                                ("&" "&amp;")
1429                                (">" "&gt;")
1430                                (" " "<text:s/>")
1431                                ("       " "<text:tab/>")))
1432          (hfy-face-to-css 'org-odt-hfy-face-to-css)
1433          (hfy-optimisations-1 (copy-seq hfy-optimisations))
1434          (hfy-optimisations (add-to-list 'hfy-optimisations-1
1435                                          'body-text-only))
1436          (hfy-begin-span-handler
1437           (lambda (style text-block text-id text-begins-block-p)
1438             (insert (format "<text:span text:style-name=\"%s\">" style))))
1439          (hfy-end-span-handler (lambda nil (insert "</text:span>"))))
1440     (when (fboundp 'htmlfontify-string)
1441       (let* ((lines (org-split-string lines "[\r\n]"))
1442              (line-count (length lines))
1443              (i 0))
1444         (mapconcat
1445          (lambda (line)
1446            (incf i)
1447            (org-odt-format-source-line-with-line-number-and-label
1448             line rpllbl num 'htmlfontify-string
1449             (if (= i line-count) "OrgSrcBlockLastLine" "OrgSrcBlock")))
1450          lines "\n")))))
1451
1452 (defun org-odt-format-source-code-or-example (lines lang caption textareap
1453                                                     cols rows num cont
1454                                                     rpllbl fmt)
1455   "Format source or example blocks for export.
1456 Use `org-odt-format-source-code-or-example-plain' or
1457 `org-odt-format-source-code-or-example-colored' depending on the
1458 value of `org-export-odt-fontify-srcblocks."
1459   (setq lines (org-export-number-lines
1460                lines 0 0 num cont rpllbl fmt 'preprocess)
1461         lines (funcall
1462                (or (and org-export-odt-fontify-srcblocks
1463                         (or (featurep 'htmlfontify)
1464                             ;; htmlfontify.el was introduced in Emacs 23.2
1465                             ;; So load it with some caution
1466                             (require 'htmlfontify nil t))
1467                         (fboundp 'htmlfontify-string)
1468                         'org-odt-format-source-code-or-example-colored)
1469                    'org-odt-format-source-code-or-example-plain)
1470                lines lang caption textareap cols rows num cont rpllbl fmt))
1471   (if (not num) lines
1472     (let ((extra (format " text:continue-numbering=\"%s\""
1473                          (if cont "true" "false"))))
1474       (org-odt-format-tags
1475        '("<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>"
1476          . "</text:list>") lines extra))))
1477
1478 (defun org-odt-remap-stylenames (style-name)
1479   (or
1480    (cdr (assoc style-name '(("timestamp-wrapper" . "OrgTimestampWrapper")
1481                             ("timestamp" . "OrgTimestamp")
1482                             ("timestamp-kwd" . "OrgTimestampKeyword")
1483                             ("tag" . "OrgTag")
1484                             ("todo" . "OrgTodo")
1485                             ("done" . "OrgDone")
1486                             ("target" . "OrgTarget"))))
1487    style-name))
1488
1489 (defun org-odt-format-fontify (text style &optional id)
1490   (let* ((style-name
1491           (cond
1492            ((stringp style)
1493             (org-odt-remap-stylenames style))
1494            ((symbolp style)
1495             (org-odt-get-style-name-for-entity 'character style))
1496            ((listp style)
1497             (assert (< 1 (length style)))
1498             (let ((parent-style (pop style)))
1499               (mapconcat (lambda (s)
1500                            ;; (assert (stringp s) t)
1501                            (org-odt-remap-stylenames s)) style "")
1502               (org-odt-remap-stylenames parent-style)))
1503            (t (error "Don't how to handle style %s"  style)))))
1504     (org-odt-format-tags
1505      '("<text:span text:style-name=\"%s\">" . "</text:span>")
1506      text style-name)))
1507
1508 (defun org-odt-relocate-relative-path (path dir)
1509   (if (file-name-absolute-p path) path
1510     (file-relative-name (expand-file-name path dir)
1511                         (expand-file-name "eyecandy" dir))))
1512
1513 (defun org-odt-format-inline-image (thefile)
1514   (let* ((thelink (if (file-name-absolute-p thefile) thefile
1515                     (org-xml-format-href
1516                      (org-odt-relocate-relative-path
1517                       thefile org-current-export-file))))
1518          (href
1519           (org-odt-format-tags
1520            "<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
1521            (if org-export-odt-embed-images
1522                (org-odt-copy-image-file thefile) thelink))))
1523     (org-export-odt-format-image thefile href)))
1524
1525 (defun org-export-odt-format-formula (src href)
1526   (save-match-data
1527     (let* ((caption (org-find-text-property-in-string 'org-caption src))
1528            (caption (and caption (org-xml-format-desc caption)))
1529            (label (org-find-text-property-in-string 'org-label src))
1530            (latex-frag (org-find-text-property-in-string 'org-latex-src src))
1531            (embed-as (or (and latex-frag
1532                               (org-find-text-property-in-string
1533                                'org-latex-src-embed-type src))
1534                          (if (or caption label) 'paragraph 'character)))
1535            width height)
1536       (when latex-frag
1537         (setq href (org-propertize href :title "LaTeX Fragment"
1538                                    :description latex-frag)))
1539       (cond
1540        ((eq embed-as 'character)
1541         (org-odt-format-entity "InlineFormula" href width height))
1542        (t
1543         (org-lparse-end-paragraph)
1544         (org-lparse-insert-list-table
1545          `((,(org-odt-format-entity
1546               (if caption "CaptionedDisplayFormula" "DisplayFormula")
1547               href width height :caption caption :label nil)
1548             ,(if (not label) ""
1549                (org-odt-format-entity-caption label nil "__MathFormula__"))))
1550          nil nil nil ":style \"OrgEquation\"" nil '((1 "c" 8) (2 "c" 1)))
1551         (throw 'nextline nil))))))
1552
1553 (defvar org-odt-embedded-formulas-count 0)
1554 (defun org-odt-copy-formula-file (path)
1555   "Returns the internal name of the file"
1556   (let* ((src-file (expand-file-name
1557                     path (file-name-directory org-current-export-file)))
1558          (target-dir (format "Formula-%04d/"
1559                              (incf org-odt-embedded-formulas-count)))
1560          (target-file (concat target-dir "content.xml")))
1561     (when (not org-lparse-to-buffer)
1562       (message "Embedding %s as %s ..."
1563                (substring-no-properties path) target-file)
1564
1565       (make-directory target-dir)
1566       (org-odt-create-manifest-file-entry
1567        "application/vnd.oasis.opendocument.formula" target-dir "1.2")
1568
1569       (case (org-odt-is-formula-link-p src-file)
1570         (mathml
1571          (copy-file src-file target-file 'overwrite))
1572         (odf
1573          (org-odt-zip-extract-one src-file "content.xml" target-dir))
1574         (t
1575          (error "%s is not a formula file" src-file)))
1576
1577       (org-odt-create-manifest-file-entry "text/xml" target-file))
1578     target-file))
1579
1580 (defun org-odt-format-inline-formula (thefile)
1581   (let* ((thelink (if (file-name-absolute-p thefile) thefile
1582                     (org-xml-format-href
1583                      (org-odt-relocate-relative-path
1584                       thefile org-current-export-file))))
1585          (href
1586           (org-odt-format-tags
1587            "<draw:object xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
1588            (file-name-directory (org-odt-copy-formula-file thefile)))))
1589     (org-export-odt-format-formula thefile href)))
1590
1591 (defun org-odt-is-formula-link-p (file)
1592   (let ((case-fold-search nil))
1593     (cond
1594      ((string-match "\\.\\(mathml\\|mml\\)\\'" file)
1595       'mathml)
1596      ((string-match "\\.odf\\'" file)
1597       'odf))))
1598
1599 (defun org-odt-format-org-link (opt-plist type-1 path fragment desc attr
1600                                           descp)
1601   "Make a OpenDocument link.
1602 OPT-PLIST is an options list.
1603 TYPE-1 is the device-type of the link (THIS://foo.html).
1604 PATH is the path of the link (http://THIS#location).
1605 FRAGMENT is the fragment part of the link, if any (foo.html#THIS).
1606 DESC is the link description, if any.
1607 ATTR is a string of other attributes of the a element."
1608   (declare (special org-lparse-par-open))
1609   (save-match-data
1610     (let* ((may-inline-p
1611             (and (member type-1 '("http" "https" "file"))
1612                  (org-lparse-should-inline-p path descp)
1613                  (not fragment)))
1614            (type (if (equal type-1 "id") "file" type-1))
1615            (filename path)
1616            (thefile path))
1617       (cond
1618        ;; check for inlined images
1619        ((and (member type '("file"))
1620              (not fragment)
1621              (org-file-image-p
1622               filename org-export-odt-inline-image-extensions)
1623              (or (eq t org-export-odt-inline-images)
1624                  (and org-export-odt-inline-images (not descp))))
1625         (org-odt-format-inline-image thefile))
1626        ;; check for embedded formulas
1627        ((and (member type '("file"))
1628              (not fragment)
1629              (org-odt-is-formula-link-p filename)
1630              (or (not descp)))
1631         (org-odt-format-inline-formula thefile))
1632        ((string= type "coderef")
1633         (let* ((ref fragment)
1634                (lineno-or-ref (cdr (assoc ref org-export-code-refs)))
1635                (desc (and descp desc))
1636                (org-odt-suppress-xref nil)
1637                (href (org-xml-format-href (concat "#coderef-" ref))))
1638           (cond
1639            ((and (numberp lineno-or-ref) (not desc))
1640             (org-odt-format-link lineno-or-ref href))
1641            ((and (numberp lineno-or-ref) desc
1642                  (string-match (regexp-quote (concat "(" ref ")")) desc))
1643             (format (replace-match "%s" t t desc)
1644                     (org-odt-format-link lineno-or-ref href)))
1645            (t
1646             (setq desc (format
1647                         (if (and desc (string-match
1648                                        (regexp-quote (concat "(" ref ")"))
1649                                        desc))
1650                             (replace-match "%s" t t desc)
1651                           (or desc "%s"))
1652                         lineno-or-ref))
1653             (org-odt-format-link (org-xml-format-desc desc) href)))))
1654        (t
1655         (when (string= type "file")
1656           (setq thefile
1657                 (cond
1658                  ((file-name-absolute-p path)
1659                   (concat "file://" (expand-file-name path)))
1660                  (t (org-odt-relocate-relative-path
1661                      thefile org-current-export-file)))))
1662
1663         (when (and (member type '("" "http" "https" "file")) fragment)
1664           (setq thefile (concat thefile "#" fragment)))
1665
1666         (setq thefile (org-xml-format-href thefile))
1667
1668         (when (not (member type '("" "file")))
1669           (setq thefile (concat type ":" thefile)))
1670
1671         (let ((org-odt-suppress-xref nil))
1672           (org-odt-format-link
1673            (org-xml-format-desc desc) thefile attr)))))))
1674
1675 (defun org-odt-format-heading (text level &optional id)
1676   (let* ((text (if id (org-odt-format-target text id) text)))
1677     (org-odt-format-tags
1678      '("<text:h text:style-name=\"Heading_20_%s\" text:outline-level=\"%s\">" .
1679        "</text:h>") text level level)))
1680
1681 (defun org-odt-format-headline (title extra-targets tags
1682                                       &optional snumber level)
1683   (concat
1684    (org-lparse-format 'EXTRA-TARGETS extra-targets)
1685
1686    ;; No need to generate section numbers. They are auto-generated by
1687    ;; the application
1688
1689    ;; (concat (org-lparse-format 'SECTION-NUMBER snumber level) " ")
1690    title
1691    (and tags (concat (org-lparse-format 'SPACES 3)
1692                      (org-lparse-format 'ORG-TAGS tags)))))
1693
1694 (defun org-odt-format-anchor (text name &optional class)
1695   (org-odt-format-target text name))
1696
1697 (defun org-odt-format-bookmark (text id)
1698   (if id
1699       (org-odt-format-tags "<text:bookmark text:name=\"%s\"/>" text id)
1700     text))
1701
1702 (defun org-odt-format-target (text id)
1703   (let ((name (concat org-export-odt-bookmark-prefix id)))
1704     (concat
1705      (and id (org-odt-format-tags
1706               "<text:bookmark-start text:name=\"%s\"/>" "" name))
1707      (org-odt-format-bookmark text id)
1708      (and id (org-odt-format-tags
1709               "<text:bookmark-end text:name=\"%s\"/>" "" name)))))
1710
1711 (defun org-odt-format-footnote (n def)
1712   (let ((id (concat  "fn" n))
1713         (note-class "footnote")
1714         (par-style "Footnote"))
1715     (org-odt-format-tags
1716      '("<text:note text:id=\"%s\" text:note-class=\"%s\">" .
1717        "</text:note>")
1718      (concat
1719       (org-odt-format-tags
1720        '("<text:note-citation>" . "</text:note-citation>")
1721        n)
1722       (org-odt-format-tags
1723        '("<text:note-body>" . "</text:note-body>")
1724        def))
1725      id note-class)))
1726
1727 (defun org-odt-format-footnote-reference (n def refcnt)
1728   (if (= refcnt 1)
1729       (org-odt-format-footnote n def)
1730     (org-odt-format-footnote-ref n)))
1731
1732 (defun org-odt-format-footnote-ref (n)
1733   (let ((note-class "footnote")
1734         (ref-format "text")
1735         (ref-name (concat "fn" n)))
1736     (org-odt-format-tags
1737      '("<text:span text:style-name=\"%s\">" . "</text:span>")
1738      (org-odt-format-tags
1739       '("<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">" . "</text:note-ref>")
1740       n note-class ref-format ref-name)
1741      "OrgSuperscript")))
1742
1743 (defun org-odt-get-image-name (file-name)
1744   (require 'sha1)
1745   (file-relative-name
1746    (expand-file-name
1747     (concat (sha1 file-name) "." (file-name-extension file-name)) "Pictures")))
1748
1749 (defun org-export-odt-format-image (src href)
1750   "Create image tag with source and attributes."
1751   (save-match-data
1752     (let* ((caption (org-find-text-property-in-string 'org-caption src))
1753            (caption (and caption (org-xml-format-desc caption)))
1754            (attr (org-find-text-property-in-string 'org-attributes src))
1755            (label (org-find-text-property-in-string 'org-label src))
1756            (latex-frag (org-find-text-property-in-string
1757                         'org-latex-src src))
1758            (category (and latex-frag "__DvipngImage__"))
1759            (attr-plist (org-lparse-get-block-params attr))
1760            (user-frame-anchor
1761             (car (assoc-string (plist-get attr-plist :anchor)
1762                                '(("as-char") ("paragraph") ("page")) t)))
1763            (user-frame-style
1764             (and user-frame-anchor (plist-get attr-plist :style)))
1765            (user-frame-attrs
1766             (and user-frame-anchor (plist-get attr-plist :attributes)))
1767            (user-frame-params
1768             (list user-frame-style user-frame-attrs user-frame-anchor))
1769            (embed-as (cond
1770                       (latex-frag
1771                        (symbol-name
1772                         (case (org-find-text-property-in-string
1773                                'org-latex-src-embed-type src)
1774                           (paragraph 'paragraph)
1775                           (t 'as-char))))
1776                       (user-frame-anchor)
1777                       (t "paragraph")))
1778            (size (org-odt-image-size-from-file
1779                   src (plist-get attr-plist :width)
1780                   (plist-get attr-plist :height)
1781                   (plist-get attr-plist :scale) nil embed-as))
1782            (width (car size)) (height (cdr size)))
1783       (when latex-frag
1784         (setq href (org-propertize href :title "LaTeX Fragment"
1785                                    :description latex-frag)))
1786       (let ((frame-style-handle (concat (and (or caption label) "Captioned")
1787                                         embed-as "Image")))
1788         (org-odt-format-entity
1789          frame-style-handle href width height
1790          :caption caption :label label :category category
1791          :user-frame-params user-frame-params)))))
1792
1793 (defun org-odt-format-object-description (title description)
1794   (concat (and title (org-odt-format-tags
1795                       '("<svg:title>" . "</svg:title>")
1796                       (org-odt-encode-plain-text title t)))
1797           (and description (org-odt-format-tags
1798                             '("<svg:desc>" . "</svg:desc>")
1799                             (org-odt-encode-plain-text description t)))))
1800
1801 (defun org-odt-format-frame (text width height style &optional
1802                                   extra anchor-type)
1803   (let ((frame-attrs
1804          (concat
1805           (if width (format " svg:width=\"%0.2fcm\"" width) "")
1806           (if height (format " svg:height=\"%0.2fcm\"" height) "")
1807           extra
1808           (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph")))))
1809     (org-odt-format-tags
1810      '("<draw:frame draw:style-name=\"%s\"%s>" . "</draw:frame>")
1811      (concat text (org-odt-format-object-description
1812                    (get-text-property 0 :title text)
1813                    (get-text-property 0 :description text)))
1814      style frame-attrs)))
1815
1816 (defun org-odt-format-textbox (text width height style &optional
1817                                     extra anchor-type)
1818   (org-odt-format-frame
1819    (org-odt-format-tags
1820     '("<draw:text-box %s>" . "</draw:text-box>")
1821     text (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
1822                  (unless width
1823                    (format " fo:min-width=\"%0.2fcm\"" (or width .2)))))
1824    width nil style extra anchor-type))
1825
1826 (defun org-odt-format-inlinetask (heading content
1827                                           &optional todo priority tags)
1828   (org-odt-format-stylized-paragraph
1829    nil (org-odt-format-textbox
1830         (concat (org-odt-format-stylized-paragraph
1831                  "OrgInlineTaskHeading"
1832                  (org-lparse-format
1833                   'HEADLINE (concat (org-lparse-format-todo todo) " " heading)
1834                   nil tags))
1835                 content) nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
1836
1837 (defvar org-odt-entity-frame-styles
1838   '(("As-CharImage" "__Figure__" ("OrgInlineImage" nil "as-char"))
1839     ("ParagraphImage" "__Figure__" ("OrgDisplayImage" nil "paragraph"))
1840     ("PageImage" "__Figure__" ("OrgPageImage" nil "page"))
1841     ("CaptionedAs-CharImage" "__Figure__"
1842      ("OrgCaptionedImage"
1843       " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
1844      ("OrgInlineImage" nil "as-char"))
1845     ("CaptionedParagraphImage" "__Figure__"
1846      ("OrgCaptionedImage"
1847       " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
1848      ("OrgImageCaptionFrame" nil "paragraph"))
1849     ("CaptionedPageImage" "__Figure__"
1850      ("OrgCaptionedImage"
1851       " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
1852      ("OrgPageImageCaptionFrame" nil "page"))
1853     ("InlineFormula" "__MathFormula__" ("OrgInlineFormula" nil "as-char"))
1854     ("DisplayFormula" "__MathFormula__" ("OrgDisplayFormula" nil "as-char"))
1855     ("CaptionedDisplayFormula" "__MathFormula__"
1856      ("OrgCaptionedFormula" nil "paragraph")
1857      ("OrgFormulaCaptionFrame" nil "as-char"))))
1858
1859 (defun org-odt-merge-frame-params(default-frame-params user-frame-params)
1860   (if (not user-frame-params) default-frame-params
1861     (assert (= (length default-frame-params) 3))
1862     (assert (= (length user-frame-params) 3))
1863     (loop for user-frame-param in user-frame-params
1864           for default-frame-param in default-frame-params
1865           collect (or user-frame-param default-frame-param))))
1866
1867 (defun* org-odt-format-entity (entity href width height
1868                                       &key caption label category
1869                                       user-frame-params)
1870   (let* ((entity-style (assoc-string entity org-odt-entity-frame-styles t))
1871          default-frame-params frame-params)
1872     (cond
1873      ((not (or caption label))
1874       (setq default-frame-params (nth 2 entity-style))
1875       (setq frame-params (org-odt-merge-frame-params
1876                           default-frame-params user-frame-params))
1877       (apply 'org-odt-format-frame href width height frame-params))
1878      (t
1879       (setq default-frame-params (nth 3 entity-style))
1880       (setq frame-params (org-odt-merge-frame-params
1881                           default-frame-params user-frame-params))
1882       (apply 'org-odt-format-textbox
1883              (org-odt-format-stylized-paragraph
1884               'illustration
1885               (concat
1886                (apply 'org-odt-format-frame href width height
1887                       (nth 2 entity-style))
1888                (org-odt-format-entity-caption
1889                 label caption (or category (nth 1 entity-style)))))
1890              width height frame-params)))))
1891
1892 (defvar org-odt-embedded-images-count 0)
1893 (defun org-odt-copy-image-file (path)
1894   "Returns the internal name of the file"
1895   (let* ((image-type (file-name-extension path))
1896          (media-type (format "image/%s" image-type))
1897          (src-file (expand-file-name
1898                     path (file-name-directory org-current-export-file)))
1899          (target-dir "Images/")
1900          (target-file
1901           (format "%s%04d.%s" target-dir
1902                   (incf org-odt-embedded-images-count) image-type)))
1903     (when (not org-lparse-to-buffer)
1904       (message "Embedding %s as %s ..."
1905                (substring-no-properties path) target-file)
1906
1907       (when (= 1 org-odt-embedded-images-count)
1908         (make-directory target-dir)
1909         (org-odt-create-manifest-file-entry "" target-dir))
1910
1911       (copy-file src-file target-file 'overwrite)
1912       (org-odt-create-manifest-file-entry media-type target-file))
1913     target-file))
1914
1915 (defvar org-export-odt-image-size-probe-method
1916   (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
1917           '(emacs fixed))
1918   "Ordered list of methods for determining image sizes.")
1919
1920 (defvar org-export-odt-default-image-sizes-alist
1921   '(("as-char" . (5 . 0.4))
1922     ("paragraph" . (5 . 5)))
1923   "Hardcoded image dimensions one for each of the anchor
1924   methods.")
1925
1926 ;; A4 page size is 21.0 by 29.7 cms
1927 ;; The default page settings has 2cm margin on each of the sides. So
1928 ;; the effective text area is 17.0 by 25.7 cm
1929 (defvar org-export-odt-max-image-size '(17.0 . 20.0)
1930   "Limiting dimensions for an embedded image.")
1931
1932 (defun org-odt-do-image-size (probe-method file &optional dpi anchor-type)
1933   (setq dpi (or dpi org-export-odt-pixels-per-inch))
1934   (setq anchor-type (or anchor-type "paragraph"))
1935   (flet ((size-in-cms (size-in-pixels)
1936                       (flet ((pixels-to-cms (pixels)
1937                                             (let* ((cms-per-inch 2.54)
1938                                                    (inches (/ pixels dpi)))
1939                                               (* cms-per-inch inches))))
1940                         (and size-in-pixels
1941                              (cons (pixels-to-cms (car size-in-pixels))
1942                                    (pixels-to-cms (cdr size-in-pixels)))))))
1943     (case probe-method
1944       (emacs
1945        (size-in-cms (ignore-errors      ; Emacs could be in batch mode
1946                       (clear-image-cache)
1947                       (image-size (create-image file) 'pixels))))
1948       (imagemagick
1949        (size-in-cms
1950         (let ((dim (shell-command-to-string
1951                     (format "identify -format \"%%w:%%h\" \"%s\"" file))))
1952           (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
1953             (cons (string-to-number (match-string 1 dim))
1954                   (string-to-number (match-string 2 dim)))))))
1955       (t
1956        (cdr (assoc-string anchor-type
1957                           org-export-odt-default-image-sizes-alist))))))
1958
1959 (defun org-odt-image-size-from-file (file &optional user-width
1960                                           user-height scale dpi embed-as)
1961   (unless (file-name-absolute-p file)
1962     (setq file (expand-file-name
1963                 file (file-name-directory org-current-export-file))))
1964   (let* (size width height)
1965     (unless (and user-height user-width)
1966       (loop for probe-method in org-export-odt-image-size-probe-method
1967             until size
1968             do (setq size (org-odt-do-image-size
1969                            probe-method file dpi embed-as)))
1970       (or size (error "Cannot determine Image size. Aborting ..."))
1971       (setq width (car size) height (cdr size)))
1972     (cond
1973      (scale
1974       (setq width (* width scale) height (* height scale)))
1975      ((and user-height user-width)
1976       (setq width user-width height user-height))
1977      (user-height
1978       (setq width (* user-height (/ width height)) height user-height))
1979      (user-width
1980       (setq height (* user-width (/ height width)) width user-width))
1981      (t (ignore)))
1982     ;; ensure that an embedded image fits comfortably within a page
1983     (let ((max-width (car org-export-odt-max-image-size))
1984           (max-height (cdr org-export-odt-max-image-size)))
1985       (when (or (> width max-width) (> height max-height))
1986         (let* ((scale1 (/ max-width width))
1987                (scale2 (/ max-height height))
1988                (scale (min scale1 scale2)))
1989           (setq width (* scale width) height (* scale height)))))
1990     (cons width height)))
1991
1992 (defvar org-odt-entity-labels-alist nil
1993   "Associate Labels with the Labeled entities.
1994 Each element of the alist is of the form (LABEL-NAME
1995 CATEGORY-NAME SEQNO LABEL-STYLE-NAME).  LABEL-NAME is same as
1996 that specified by \"#+LABEL: ...\" line.  CATEGORY-NAME is the
1997 type of the entity that LABEL-NAME is attached to.  CATEGORY-NAME
1998 can be one of \"Table\", \"Figure\" or \"Equation\".  SEQNO is
1999 the unique number assigned to the referenced entity on a
2000 per-CATEGORY basis.  It is generated sequentially and is 1-based.
2001 LABEL-STYLE-NAME is a key `org-odt-label-styles'.
2002
2003 See `org-odt-add-label-definition' and
2004 `org-odt-fixup-label-references'.")
2005
2006 (defvar org-odt-entity-counts-plist nil
2007   "Plist of running counters of SEQNOs for each of the CATEGORY-NAMEs.
2008 See `org-odt-entity-labels-alist' for known CATEGORY-NAMEs.")
2009
2010 (defvar org-odt-label-styles
2011   '(("text" "(%n)" "text" "(%n)")
2012     ("category-and-value" "%e %n%c" "category-and-value" "%e %n")
2013     ("value" "%e %n%c" "value" "%n"))
2014   "Specify how labels are applied and referenced.
2015 This is an alist where each element is of the
2016 form (LABEL-STYLE-NAME LABEL-ATTACH-FMT LABEL-REF-MODE
2017 LABEL-REF-FMT).
2018
2019 LABEL-ATTACH-FMT controls how labels and captions are attached to
2020 an entity.  It may contain following specifiers - %e, %n and %c.
2021 %e is replaced with the CATEGORY-NAME.  %n is replaced with
2022 \"<text:sequence ...> SEQNO </text:sequence>\".  %c is replaced
2023 with CAPTION. See `org-odt-format-label-definition'.
2024
2025 LABEL-REF-MODE and LABEL-REF-FMT controls how label references
2026 are generated.  The following XML is generated for a label
2027 reference - \"<text:sequence-ref
2028 text:reference-format=\"LABEL-REF-MODE\" ...> LABEL-REF-FMT
2029 </text:sequence-ref>\".  LABEL-REF-FMT may contain following
2030 specifiers - %e and %n.  %e is replaced with the CATEGORY-NAME.
2031 %n is replaced with SEQNO. See
2032 `org-odt-format-label-reference'.")
2033
2034 (defvar org-odt-category-map-alist
2035   '(("__Table__" "Table" "value")
2036     ("__Figure__" "Figure" "value")
2037     ("__MathFormula__" "Equation" "text")
2038     ("__DvipngImage__" "Equation" "value")
2039     ;; ("__Table__" "Table" "category-and-value")
2040     ;; ("__Figure__" "Figure" "category-and-value")
2041     ;; ("__DvipngImage__" "Equation" "category-and-value")
2042     )
2043   "Map a CATEGORY-HANDLE to CATEGORY-NAME and LABEL-STYLE.
2044 This is an alist where each element is of the form
2045 \\(CATEGORY-HANDLE CATEGORY-NAME LABEL-STYLE\\).  CATEGORY_HANDLE
2046 could either be one of the internal handles (as seen above) or be
2047 derived from the \"#+LABEL:<label-name>\" specification.  See
2048 `org-export-odt-get-category-from-label'.  CATEGORY-NAME and
2049 LABEL-STYLE are used for generating ODT labels.  See
2050 `org-odt-label-styles'.")
2051
2052 (defvar org-export-odt-user-categories
2053   '("Illustration" "Table" "Text" "Drawing" "Equation" "Figure"))
2054
2055 (defvar org-export-odt-get-category-from-label nil
2056   "Should category of label be inferred from label itself.
2057 When this option is non-nil, a label is parsed in to two
2058 component parts delimited by a \":\" (colon) as shown here -
2059 #+LABEL:[CATEGORY-HANDLE:]EXTRA.  The CATEGORY-HANDLE is mapped
2060 to a CATEGORY-NAME and LABEL-STYLE using
2061 `org-odt-category-map-alist'.  (If no such map is provided and
2062 CATEGORY-NAME is set to CATEGORY-HANDLE and LABEL-STYLE is set to
2063 \"category-and-value\").  If CATEGORY-NAME so obtained is listed
2064 under `org-export-odt-user-categories' then the user specified
2065 styles are used.  Otherwise styles as determined by the internal
2066 CATEGORY-HANDLE is used.  See
2067 `org-odt-get-label-category-and-style' for details.")
2068
2069 (defun org-odt-get-label-category-and-style (label default-category)
2070   "See `org-export-odt-get-category-from-label'."
2071   (let ((default-category-map
2072           (assoc default-category org-odt-category-map-alist))
2073         user-category user-category-map category)
2074     (cond
2075      ((not org-export-odt-get-category-from-label)
2076       default-category-map)
2077      ((not (setq user-category
2078                  (save-match-data
2079                    (and (string-match "\\`\\(.*\\):.+" label)
2080                         (match-string 1 label)))))
2081       default-category-map)
2082      (t
2083       (setq user-category-map
2084             (or (assoc user-category org-odt-category-map-alist)
2085                 (list nil user-category "category-and-value"))
2086             category (nth 1 user-category-map))
2087       (if (member category org-export-odt-user-categories)
2088           user-category-map
2089         default-category-map)))))
2090
2091 (defun org-odt-add-label-definition (label default-category)
2092   "Create an entry in `org-odt-entity-labels-alist' and return it."
2093   (setq label (substring-no-properties label))
2094   (let* ((label-props (org-odt-get-label-category-and-style
2095                        label default-category))
2096          (category (nth 1 label-props))
2097          (counter category)
2098          (label-style (nth 2 label-props))
2099          (sequence-var (intern (mapconcat
2100                                 'downcase
2101                                 (org-split-string counter) "-")))
2102          (seqno (1+ (or (plist-get org-odt-entity-counts-plist sequence-var)
2103                         0)))
2104          (label-props (list label category seqno label-style)))
2105     (setq org-odt-entity-counts-plist
2106           (plist-put org-odt-entity-counts-plist sequence-var seqno))
2107     (push label-props org-odt-entity-labels-alist)
2108     label-props))
2109
2110 (defun org-odt-format-label-definition (caption label category seqno label-style)
2111   (assert label)
2112   (format-spec
2113    (cadr (assoc-string label-style org-odt-label-styles t))
2114    `((?e . ,category)
2115      (?n . ,(org-odt-format-tags
2116              '("<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">" . "</text:sequence>")
2117              (format "%d" seqno) label category category))
2118      (?c . ,(or (and caption (concat ": " caption)) "")))))
2119
2120 (defun org-odt-format-label-reference (label category seqno label-style)
2121   (assert label)
2122   (save-match-data
2123     (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
2124            (fmt1 (car fmt))
2125            (fmt2 (cadr fmt)))
2126       (org-odt-format-tags
2127        '("<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">"
2128          . "</text:sequence-ref>")
2129        (format-spec fmt2 `((?e . ,category)
2130                            (?n . ,(format "%d" seqno)))) fmt1 label))))
2131
2132 (defun org-odt-fixup-label-references ()
2133   (goto-char (point-min))
2134   (while (re-search-forward
2135           "<text:sequence-ref text:ref-name=\"\\([^\"]+\\)\">[ \t\n]*</text:sequence-ref>"
2136           nil t)
2137     (let* ((label (match-string 1))
2138            (label-def (assoc label org-odt-entity-labels-alist))
2139            (rpl (and label-def
2140                      (apply 'org-odt-format-label-reference label-def))))
2141       (if rpl (replace-match rpl t t)
2142         (org-lparse-warn
2143          (format "Unable to resolve reference to label \"%s\"" label))))))
2144
2145 (defun org-odt-format-entity-caption (label caption category)
2146   (or (and label
2147            (apply 'org-odt-format-label-definition
2148                   caption (org-odt-add-label-definition label category)))
2149       caption ""))
2150
2151 (defun org-odt-format-tags (tag text &rest args)
2152   (let ((prefix (when org-lparse-encode-pending "@"))
2153         (suffix (when org-lparse-encode-pending "@")))
2154     (apply 'org-lparse-format-tags tag text prefix suffix args)))
2155
2156 (defvar org-odt-manifest-file-entries nil)
2157 (defun org-odt-init-outfile (filename)
2158   (unless (executable-find "zip")
2159     ;; Not at all OSes ship with zip by default
2160     (error "Executable \"zip\" needed for creating OpenDocument files"))
2161
2162   (let* ((outdir (make-temp-file
2163                   (format org-export-odt-tmpdir-prefix org-lparse-backend) t))
2164          (content-file (expand-file-name "content.xml" outdir)))
2165
2166     ;; init conten.xml
2167     (with-current-buffer (find-file-noselect content-file t))
2168
2169     ;; reset variables
2170     (setq org-odt-manifest-file-entries nil
2171           org-odt-embedded-images-count 0
2172           org-odt-embedded-formulas-count 0
2173           org-odt-entity-labels-alist nil
2174           org-odt-list-stack-stashed nil
2175           org-odt-automatic-styles nil
2176           org-odt-object-counters nil
2177           org-odt-entity-counts-plist nil)
2178     content-file))
2179
2180 (defcustom org-export-odt-prettify-xml nil
2181   "Specify whether or not the xml output should be prettified.
2182 When this option is turned on, `indent-region' is run on all
2183 component xml buffers before they are saved.  Turn this off for
2184 regular use.  Turn this on if you need to examine the xml
2185 visually."
2186   :group 'org-export-odt
2187   :version "24.1"
2188   :type 'boolean)
2189
2190 (defvar hfy-user-sheet-assoc)           ; bound during org-do-lparse
2191 (defun org-odt-save-as-outfile (target opt-plist)
2192   ;; write automatic styles
2193   (org-odt-write-automatic-styles)
2194
2195   ;; write meta file
2196   (org-odt-update-meta-file opt-plist)
2197
2198   ;; write styles file
2199   (when (equal org-lparse-backend 'odt)
2200     (org-odt-update-styles-file opt-plist))
2201
2202   ;; create mimetype file
2203   (let ((mimetype (org-odt-write-mimetype-file org-lparse-backend)))
2204     (org-odt-create-manifest-file-entry mimetype "/" "1.2"))
2205
2206   ;; create a manifest entry for content.xml
2207   (org-odt-create-manifest-file-entry "text/xml" "content.xml")
2208
2209   ;; write out the manifest entries before zipping
2210   (org-odt-write-manifest-file)
2211
2212   (let ((xml-files '("mimetype" "META-INF/manifest.xml" "content.xml"
2213                      "meta.xml"))
2214         (zipdir default-directory))
2215     (when (equal org-lparse-backend 'odt)
2216       (push "styles.xml" xml-files))
2217     (message "Switching to directory %s" (expand-file-name zipdir))
2218
2219     ;; save all xml files
2220     (mapc (lambda (file)
2221             (with-current-buffer
2222                 (find-file-noselect (expand-file-name file) t)
2223               ;; prettify output if needed
2224               (when org-export-odt-prettify-xml
2225                 (indent-region (point-min) (point-max)))
2226               (save-buffer 0)))
2227           xml-files)
2228
2229     (let* ((target-name (file-name-nondirectory target))
2230            (target-dir (file-name-directory target))
2231            (cmds `(("zip" "-mX0" ,target-name "mimetype")
2232                    ("zip" "-rmTq" ,target-name "."))))
2233       (when (file-exists-p target)
2234         ;; FIXME: If the file is locked this throws a cryptic error
2235         (delete-file target))
2236
2237       (let ((coding-system-for-write 'no-conversion) exitcode err-string)
2238         (message "Creating odt file...")
2239         (mapc
2240          (lambda (cmd)
2241            (message "Running %s" (mapconcat 'identity cmd " "))
2242            (setq err-string
2243                  (with-output-to-string
2244                    (setq exitcode
2245                          (apply 'call-process (car cmd)
2246                                 nil standard-output nil (cdr cmd)))))
2247            (or (zerop exitcode)
2248                (ignore (message "%s" err-string))
2249                (error "Unable to create odt file (%S)" exitcode)))
2250          cmds))
2251
2252       ;; move the file from outdir to target-dir
2253       (rename-file target-name target-dir)
2254
2255       ;; kill all xml buffers
2256       (mapc (lambda (file)
2257               (kill-buffer
2258                (find-file-noselect (expand-file-name file zipdir) t)))
2259             xml-files)
2260
2261       (delete-directory zipdir)))
2262   (message "Created %s" target)
2263   (set-buffer (find-file-noselect target t)))
2264
2265 (defconst org-odt-manifest-file-entry-tag
2266   "
2267 <manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
2268
2269 (defun org-odt-create-manifest-file-entry (&rest args)
2270   (push args org-odt-manifest-file-entries))
2271
2272 (defun org-odt-write-manifest-file ()
2273   (make-directory "META-INF")
2274   (let ((manifest-file (expand-file-name "META-INF/manifest.xml")))
2275     (with-current-buffer
2276         (find-file-noselect manifest-file t)
2277       (insert
2278        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
2279      <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
2280       (mapc
2281        (lambda (file-entry)
2282          (let* ((version (nth 2 file-entry))
2283                 (extra (if version
2284                            (format  " manifest:version=\"%s\"" version)
2285                          "")))
2286            (insert
2287             (format org-odt-manifest-file-entry-tag
2288                     (nth 0 file-entry) (nth 1 file-entry) extra))))
2289        org-odt-manifest-file-entries)
2290       (insert "\n</manifest:manifest>"))))
2291
2292 (defun org-odt-update-meta-file (opt-plist)
2293   (let ((date (org-odt-format-date (plist-get opt-plist :date)))
2294         (author (or (plist-get opt-plist :author) ""))
2295         (email (plist-get opt-plist :email))
2296         (keywords (plist-get opt-plist :keywords))
2297         (description (plist-get opt-plist :description))
2298         (title (plist-get opt-plist :title)))
2299     (write-region
2300      (concat
2301       "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
2302      <office:document-meta
2303          xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
2304          xmlns:xlink=\"http://www.w3.org/1999/xlink\"
2305          xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
2306          xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
2307          xmlns:ooo=\"http://openoffice.org/2004/office\"
2308          office:version=\"1.2\">
2309        <office:meta>" "\n"
2310        (org-odt-format-author)
2311        (org-odt-format-tags
2312         '("\n<meta:initial-creator>" . "</meta:initial-creator>") author)
2313        (org-odt-format-tags '("\n<dc:date>" . "</dc:date>") date)
2314        (org-odt-format-tags
2315         '("\n<meta:creation-date>" . "</meta:creation-date>") date)
2316        (org-odt-format-tags '("\n<meta:generator>" . "</meta:generator>")
2317                             (when org-export-creator-info
2318                               (format "Org-%s/Emacs-%s"
2319                                       org-version emacs-version)))
2320        (org-odt-format-tags '("\n<meta:keyword>" . "</meta:keyword>") keywords)
2321        (org-odt-format-tags '("\n<dc:subject>" . "</dc:subject>") description)
2322        (org-odt-format-tags '("\n<dc:title>" . "</dc:title>") title)
2323        "\n"
2324        "  </office:meta>" "</office:document-meta>")
2325      nil (expand-file-name "meta.xml")))
2326
2327   ;; create a manifest entry for meta.xml
2328   (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
2329
2330 (defun org-odt-update-styles-file (opt-plist)
2331   ;; write styles file
2332   (let ((styles-file (plist-get opt-plist :odt-styles-file)))
2333     (org-odt-copy-styles-file (and styles-file
2334                                    (read (org-trim styles-file)))))
2335
2336   ;; Update styles.xml - take care of outline numbering
2337   (with-current-buffer
2338       (find-file-noselect (expand-file-name "styles.xml") t)
2339     ;; Don't make automatic backup of styles.xml file. This setting
2340     ;; prevents the backed-up styles.xml file from being zipped in to
2341     ;; odt file. This is more of a hackish fix. Better alternative
2342     ;; would be to fix the zip command so that the output odt file
2343     ;; includes only the needed files and excludes any auto-generated
2344     ;; extra files like backups and auto-saves etc etc. Note that
2345     ;; currently the zip command zips up the entire temp directory so
2346     ;; that any auto-generated files created under the hood ends up in
2347     ;; the resulting odt file.
2348     (set (make-local-variable 'backup-inhibited) t)
2349
2350     ;; Import local setting of `org-export-with-section-numbers'
2351     (org-lparse-bind-local-variables opt-plist)
2352     (org-odt-configure-outline-numbering
2353      (if org-export-with-section-numbers org-export-headline-levels 0)))
2354
2355   ;; Write custom styles for source blocks
2356   (org-odt-insert-custom-styles-for-srcblocks
2357    (mapconcat
2358     (lambda (style)
2359       (format " %s\n" (cddr style)))
2360     hfy-user-sheet-assoc "")))
2361
2362 (defun org-odt-write-mimetype-file (format)
2363   ;; create mimetype file
2364   (let ((mimetype
2365          (case format
2366            (odt "application/vnd.oasis.opendocument.text")
2367            (odf "application/vnd.oasis.opendocument.formula")
2368            (t (error "Unknown OpenDocument backend %S" org-lparse-backend)))))
2369     (write-region mimetype nil (expand-file-name "mimetype"))
2370     mimetype))
2371
2372 (defun org-odt-finalize-outfile ()
2373   (org-odt-delete-empty-paragraphs))
2374
2375 (defun org-odt-delete-empty-paragraphs ()
2376   (goto-char (point-min))
2377   (let ((open "<text:p[^>]*>")
2378         (close "</text:p>"))
2379     (while (re-search-forward (format "%s[ \r\n\t]*%s" open close) nil t)
2380       (replace-match ""))))
2381
2382 (defcustom org-export-odt-convert-processes
2383   '(("LibreOffice"
2384      "soffice --headless --convert-to %f%x --outdir %d %i")
2385     ("unoconv"
2386      "unoconv -f %f -o %d %i"))
2387   "Specify a list of document converters and their usage.
2388 The converters in this list are offered as choices while
2389 customizing `org-export-odt-convert-process'.
2390
2391 This variable is a list where each element is of the
2392 form (CONVERTER-NAME CONVERTER-CMD).  CONVERTER-NAME is the name
2393 of the converter.  CONVERTER-CMD is the shell command for the
2394 converter and can contain format specifiers.  These format
2395 specifiers are interpreted as below:
2396
2397 %i input file name in full
2398 %I input file name as a URL
2399 %f format of the output file
2400 %o output file name in full
2401 %O output file name as a URL
2402 %d output dir in full
2403 %D output dir as a URL.
2404 %x extra options as set in `org-export-odt-convert-capabilities'."
2405   :group 'org-export-odt
2406   :version "24.1"
2407   :type
2408   '(choice
2409     (const :tag "None" nil)
2410     (alist :tag "Converters"
2411            :key-type (string :tag "Converter Name")
2412            :value-type (group (string :tag "Command line")))))
2413
2414 (defcustom org-export-odt-convert-process "LibreOffice"
2415   "Use this converter to convert from \"odt\" format to other formats.
2416 During customization, the list of converter names are populated
2417 from `org-export-odt-convert-processes'."
2418   :group 'org-export-odt
2419   :version "24.1"
2420   :type '(choice :convert-widget
2421                  (lambda (w)
2422                    (apply 'widget-convert (widget-type w)
2423                           (eval (car (widget-get w :args)))))
2424                  `((const :tag "None" nil)
2425                    ,@(mapcar (lambda (c)
2426                                `(const :tag ,(car c) ,(car c)))
2427                              org-export-odt-convert-processes))))
2428
2429 (defcustom org-export-odt-convert-capabilities
2430   '(("Text"
2431      ("odt" "ott" "doc" "rtf" "docx")
2432      (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
2433       ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
2434     ("Web"
2435      ("html")
2436      (("pdf" "pdf") ("odt" "odt") ("html" "html")))
2437     ("Spreadsheet"
2438      ("ods" "ots" "xls" "csv" "xlsx")
2439      (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
2440       ("xls" "xls") ("xlsx" "xlsx")))
2441     ("Presentation"
2442      ("odp" "otp" "ppt" "pptx")
2443      (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
2444       ("pptx" "pptx") ("odg" "odg"))))
2445   "Specify input and output formats of `org-export-odt-convert-process'.
2446 More correctly, specify the set of input and output formats that
2447 the user is actually interested in.
2448
2449 This variable is an alist where each element is of the
2450 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
2451 INPUT-FMT-LIST is a list of INPUT-FMTs.  OUTPUT-FMT-ALIST is an
2452 alist where each element is of the form (OUTPUT-FMT
2453 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
2454
2455 The variable is interpreted as follows:
2456 `org-export-odt-convert-process' can take any document that is in
2457 INPUT-FMT-LIST and produce any document that is in the
2458 OUTPUT-FMT-LIST.  A document converted to OUTPUT-FMT will have
2459 OUTPUT-FILE-EXTENSION as the file name extension.  OUTPUT-FMT
2460 serves dual purposes:
2461 - It is used for populating completion candidates during
2462   `org-export-odt-convert' commands.
2463 - It is used as the value of \"%f\" specifier in
2464   `org-export-odt-convert-process'.
2465
2466 EXTRA-OPTIONS is used as the value of \"%x\" specifier in
2467 `org-export-odt-convert-process'.
2468
2469 DOCUMENT-CLASS is used to group a set of file formats in
2470 INPUT-FMT-LIST in to a single class.
2471
2472 Note that this variable inherently captures how LibreOffice based
2473 converters work.  LibreOffice maps documents of various formats
2474 to classes like Text, Web, Spreadsheet, Presentation etc and
2475 allow document of a given class (irrespective of it's source
2476 format) to be converted to any of the export formats associated
2477 with that class.
2478
2479 See default setting of this variable for an typical
2480 configuration."
2481   :group 'org-export-odt
2482   :version "24.1"
2483   :type
2484   '(choice
2485     (const :tag "None" nil)
2486     (alist :tag "Capabilities"
2487            :key-type (string :tag "Document Class")
2488            :value-type
2489            (group (repeat :tag "Input formats" (string :tag "Input format"))
2490                   (alist :tag "Output formats"
2491                          :key-type (string :tag "Output format")
2492                          :value-type
2493                          (group (string :tag "Output file extension")
2494                                 (choice
2495                                  (const :tag "None" nil)
2496                                  (string :tag "Extra options"))))))))
2497
2498 (declare-function org-create-math-formula "org"
2499                   (latex-frag &optional mathml-file))
2500
2501 ;;;###autoload
2502 (defun org-export-odt-convert (&optional in-file out-fmt prefix-arg)
2503   "Convert IN-FILE to format OUT-FMT using a command line converter.
2504 IN-FILE is the file to be converted.  If unspecified, it defaults
2505 to variable `buffer-file-name'.  OUT-FMT is the desired output
2506 format.  Use `org-export-odt-convert-process' as the converter.
2507 If PREFIX-ARG is non-nil then the newly converted file is opened
2508 using `org-open-file'."
2509   (interactive
2510    (append (org-lparse-convert-read-params) current-prefix-arg))
2511   (org-lparse-do-convert in-file out-fmt prefix-arg))
2512
2513 (defun org-odt-get (what &optional opt-plist)
2514   (case what
2515     (BACKEND 'odt)
2516     (EXPORT-DIR (org-export-directory :html opt-plist))
2517     (FILE-NAME-EXTENSION "odt")
2518     (EXPORT-BUFFER-NAME "*Org ODT Export*")
2519     (ENTITY-CONTROL org-odt-entity-control-callbacks-alist)
2520     (ENTITY-FORMAT org-odt-entity-format-callbacks-alist)
2521     (INIT-METHOD 'org-odt-init-outfile)
2522     (FINAL-METHOD 'org-odt-finalize-outfile)
2523     (SAVE-METHOD 'org-odt-save-as-outfile)
2524     (CONVERT-METHOD
2525      (and org-export-odt-convert-process
2526           (cadr (assoc-string org-export-odt-convert-process
2527                               org-export-odt-convert-processes t))))
2528     (CONVERT-CAPABILITIES
2529      (and org-export-odt-convert-process
2530           (cadr (assoc-string org-export-odt-convert-process
2531                               org-export-odt-convert-processes t))
2532           org-export-odt-convert-capabilities))
2533     (TOPLEVEL-HLEVEL 1)
2534     (SPECIAL-STRING-REGEXPS org-export-odt-special-string-regexps)
2535     (INLINE-IMAGES 'maybe)
2536     (INLINE-IMAGE-EXTENSIONS '("png" "jpeg" "jpg" "gif" "svg"))
2537     (PLAIN-TEXT-MAP '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
2538     (TABLE-FIRST-COLUMN-AS-LABELS nil)
2539     (FOOTNOTE-SEPARATOR (org-lparse-format 'FONTIFY "," 'superscript))
2540     (CODING-SYSTEM-FOR-WRITE 'utf-8)
2541     (CODING-SYSTEM-FOR-SAVE 'utf-8)
2542     (t (error "Unknown property: %s"  what))))
2543
2544 (defvar org-lparse-latex-fragment-fallback) ; set by org-do-lparse
2545 (defun org-export-odt-do-preprocess-latex-fragments ()
2546   "Convert LaTeX fragments to images."
2547   (let* ((latex-frag-opt (plist-get org-lparse-opt-plist :LaTeX-fragments))
2548          (latex-frag-opt                ;  massage the options
2549           (or (and (member latex-frag-opt '(mathjax t))
2550                    (not (and (fboundp 'org-format-latex-mathml-available-p)
2551                              (org-format-latex-mathml-available-p)))
2552                    (prog1 org-lparse-latex-fragment-fallback
2553                      (org-lparse-warn
2554                       (concat
2555                        "LaTeX to MathML converter not available. "
2556                        (format "Using %S instead."
2557                                org-lparse-latex-fragment-fallback)))))
2558               latex-frag-opt))
2559          cache-dir display-msg)
2560     (cond
2561      ((eq latex-frag-opt 'dvipng)
2562       (setq cache-dir "ltxpng/")
2563       (setq display-msg "Creating LaTeX image %s"))
2564      ((member latex-frag-opt '(mathjax t))
2565       (setq latex-frag-opt 'mathml)
2566       (setq cache-dir "ltxmathml/")
2567       (setq display-msg "Creating MathML formula %s")))
2568     (when (and org-current-export-file)
2569       (org-format-latex
2570        (concat cache-dir (file-name-sans-extension
2571                           (file-name-nondirectory org-current-export-file)))
2572        org-current-export-dir nil display-msg
2573        nil nil latex-frag-opt))))
2574
2575 (defadvice org-format-latex-as-mathml
2576   (after org-odt-protect-latex-fragment activate)
2577   "Encode LaTeX fragment as XML.
2578 Do this when translation to MathML fails."
2579   (when (or (not (> (length ad-return-value) 0))
2580             (get-text-property 0 'org-protected ad-return-value))
2581     (setq ad-return-value
2582           (org-propertize (org-odt-encode-plain-text (ad-get-arg 0))
2583                           'org-protected t))))
2584
2585 (defun org-export-odt-preprocess-latex-fragments ()
2586   (when (equal org-export-current-backend 'odt)
2587     (org-export-odt-do-preprocess-latex-fragments)))
2588
2589 (defun org-export-odt-preprocess-label-references ()
2590   (goto-char (point-min))
2591   (let (label label-components category value pretty-label)
2592     (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
2593       (org-if-unprotected-at (match-beginning 1)
2594         (replace-match
2595          (let ((org-lparse-encode-pending t)
2596                (label (match-string 1)))
2597            ;; markup generated below is mostly an eye-candy.  At
2598            ;; pre-processing stage, there is no information on which
2599            ;; entity a label reference points to.  The actual markup
2600            ;; is generated as part of `org-odt-fixup-label-references'
2601            ;; which gets called at the fag end of export.  By this
2602            ;; time we would have seen and collected all the label
2603            ;; definitions in `org-odt-entity-labels-alist'.
2604            (org-odt-format-tags
2605             '("<text:sequence-ref text:ref-name=\"%s\">" .
2606               "</text:sequence-ref>")
2607             "" (org-add-props label '(org-protected t)))) t t)))))
2608
2609 ;; process latex fragments as part of
2610 ;; `org-export-preprocess-after-blockquote-hook'. Note that this hook
2611 ;; is the one that is closest and well before the call to
2612 ;; `org-export-attach-captions-and-attributes' in
2613 ;; `org-export-preprocess-string'.  The above arrangement permits
2614 ;; captions, labels and attributes to be attached to png images
2615 ;; generated out of latex equations.
2616 (add-hook 'org-export-preprocess-after-blockquote-hook
2617           'org-export-odt-preprocess-latex-fragments)
2618
2619 (defun org-export-odt-preprocess (parameters)
2620   (org-export-odt-preprocess-label-references))
2621
2622 (declare-function archive-zip-extract "arc-mode.el" (archive name))
2623 (defun org-odt-zip-extract-one (archive member &optional target)
2624   (require 'arc-mode)
2625   (let* ((target (or target default-directory))
2626          (archive (expand-file-name archive))
2627          (archive-zip-extract
2628           (list "unzip" "-qq" "-o" "-d" target))
2629          exit-code command-output)
2630     (setq command-output
2631           (with-temp-buffer
2632             (setq exit-code (archive-zip-extract archive member))
2633             (buffer-string)))
2634     (unless (zerop exit-code)
2635       (message command-output)
2636       (error "Extraction failed"))))
2637
2638 (defun org-odt-zip-extract (archive members &optional target)
2639   (when (atom members) (setq members (list members)))
2640   (mapc (lambda (member)
2641           (org-odt-zip-extract-one archive member target))
2642         members))
2643
2644 (defun org-odt-copy-styles-file (&optional styles-file)
2645   ;; Non-availability of styles.xml is not a critical error. For now
2646   ;; throw an error purely for aesthetic reasons.
2647   (setq styles-file (or styles-file
2648                         org-export-odt-styles-file
2649                         (expand-file-name "OrgOdtStyles.xml"
2650                                           org-odt-styles-dir)
2651                         (error "org-odt: Missing styles file?")))
2652   (cond
2653    ((listp styles-file)
2654     (let ((archive (nth 0 styles-file))
2655           (members (nth 1 styles-file)))
2656       (org-odt-zip-extract archive members)
2657       (mapc
2658        (lambda (member)
2659          (when (org-file-image-p member)
2660            (let* ((image-type (file-name-extension member))
2661                   (media-type (format "image/%s" image-type)))
2662              (org-odt-create-manifest-file-entry media-type member))))
2663        members)))
2664    ((and (stringp styles-file) (file-exists-p styles-file))
2665     (let ((styles-file-type (file-name-extension styles-file)))
2666       (cond
2667        ((string= styles-file-type "xml")
2668         (copy-file styles-file "styles.xml" t))
2669        ((member styles-file-type '("odt" "ott"))
2670         (org-odt-zip-extract styles-file "styles.xml")))))
2671    (t
2672     (error (format "Invalid specification of styles.xml file: %S"
2673                    org-export-odt-styles-file))))
2674
2675   ;; create a manifest entry for styles.xml
2676   (org-odt-create-manifest-file-entry "text/xml" "styles.xml"))
2677
2678 (defun org-odt-configure-outline-numbering (level)
2679   "Outline numbering is retained only upto LEVEL.
2680 To disable outline numbering pass a LEVEL of 0."
2681   (goto-char (point-min))
2682   (let ((regex
2683          "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
2684         (replacement
2685          "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
2686     (while (re-search-forward regex nil t)
2687       (when (> (string-to-number (match-string 2)) level)
2688         (replace-match replacement t nil))))
2689   (save-buffer 0))
2690
2691 ;;;###autoload
2692 (defun org-export-as-odf (latex-frag &optional odf-file)
2693   "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
2694 Use `org-create-math-formula' to convert LATEX-FRAG first to
2695 MathML.  When invoked as an interactive command, use
2696 `org-latex-regexps' to infer LATEX-FRAG from currently active
2697 region.  If no LaTeX fragments are found, prompt for it.  Push
2698 MathML source to kill ring, if `org-export-copy-to-kill-ring' is
2699 non-nil."
2700   (interactive
2701    `(,(let (frag)
2702         (setq frag (and (setq frag (and (region-active-p)
2703                                         (buffer-substring (region-beginning)
2704                                                           (region-end))))
2705                         (loop for e in org-latex-regexps
2706                               thereis (when (string-match (nth 1 e) frag)
2707                                         (match-string (nth 2 e) frag)))))
2708         (read-string "LaTeX Fragment: " frag nil frag))
2709      ,(let ((odf-filename (expand-file-name
2710                            (concat
2711                             (file-name-sans-extension
2712                              (or (file-name-nondirectory buffer-file-name)))
2713                             "." "odf")
2714                            (file-name-directory buffer-file-name))))
2715         (read-file-name "ODF filename: " nil odf-filename nil
2716                         (file-name-nondirectory odf-filename)))))
2717   (let* ((org-lparse-backend 'odf)
2718          org-lparse-opt-plist
2719          (filename (or odf-file
2720                        (expand-file-name
2721                         (concat
2722                          (file-name-sans-extension
2723                           (or (file-name-nondirectory buffer-file-name)))
2724                          "." "odf")
2725                         (file-name-directory buffer-file-name))))
2726          (buffer (find-file-noselect (org-odt-init-outfile filename)))
2727          (coding-system-for-write 'utf-8)
2728          (save-buffer-coding-system 'utf-8))
2729     (set-buffer buffer)
2730     (set-buffer-file-coding-system coding-system-for-write)
2731     (let ((mathml (org-create-math-formula latex-frag)))
2732       (unless mathml (error "No Math formula created"))
2733       (insert mathml)
2734       (or (org-export-push-to-kill-ring
2735            (upcase (symbol-name org-lparse-backend)))
2736           (message "Exporting... done")))
2737     (org-odt-save-as-outfile filename nil)))
2738
2739 ;;;###autoload
2740 (defun org-export-as-odf-and-open ()
2741   "Export LaTeX fragment as OpenDocument formula and immediately open it.
2742 Use `org-export-as-odf' to read LaTeX fragment and OpenDocument
2743 formula file."
2744   (interactive)
2745   (org-lparse-and-open
2746    nil nil nil (call-interactively 'org-export-as-odf)))
2747
2748 (provide 'org-odt)
2749
2750 ;;; org-odt.el ends here