lisp/ox-odt.el

   1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
   2
   3 ;; Copyright (C) 2010-2015 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
  28 (eval-when-compile
  29   (require 'cl)
  30   (require 'table nil 'noerror))
  31 (require 'format-spec)
  32 (require 'ox)
  33 (require 'org-compat)
  34
  35 ;;; Define Back-End
  36
  37 (org-export-define-backend 'odt
  38   '((bold . org-odt-bold)
  39     (center-block . org-odt-center-block)
  40     (clock . org-odt-clock)
  41     (code . org-odt-code)
  42     (drawer . org-odt-drawer)
  43     (dynamic-block . org-odt-dynamic-block)
  44     (entity . org-odt-entity)
  45     (example-block . org-odt-example-block)
  46     (export-block . org-odt-export-block)
  47     (export-snippet . org-odt-export-snippet)
  48     (fixed-width . org-odt-fixed-width)
  49     (footnote-definition . org-odt-footnote-definition)
  50     (footnote-reference . org-odt-footnote-reference)
  51     (headline . org-odt-headline)
  52     (horizontal-rule . org-odt-horizontal-rule)
  53     (inline-src-block . org-odt-inline-src-block)
  54     (inlinetask . org-odt-inlinetask)
  55     (italic . org-odt-italic)
  56     (item . org-odt-item)
  57     (keyword . org-odt-keyword)
  58     (latex-environment . org-odt-latex-environment)
  59     (latex-fragment . org-odt-latex-fragment)
  60     (line-break . org-odt-line-break)
  61     (link . org-odt-link)
  62     (node-property . org-odt-node-property)
  63     (paragraph . org-odt-paragraph)
  64     (plain-list . org-odt-plain-list)
  65     (plain-text . org-odt-plain-text)
  66     (planning . org-odt-planning)
  67     (property-drawer . org-odt-property-drawer)
  68     (quote-block . org-odt-quote-block)
  69     (radio-target . org-odt-radio-target)
  70     (section . org-odt-section)
  71     (special-block . org-odt-special-block)
  72     (src-block . org-odt-src-block)
  73     (statistics-cookie . org-odt-statistics-cookie)
  74     (strike-through . org-odt-strike-through)
  75     (subscript . org-odt-subscript)
  76     (superscript . org-odt-superscript)
  77     (table . org-odt-table)
  78     (table-cell . org-odt-table-cell)
  79     (table-row . org-odt-table-row)
  80     (target . org-odt-target)
  81     (template . org-odt-template)
  82     (timestamp . org-odt-timestamp)
  83     (underline . org-odt-underline)
  84     (verbatim . org-odt-verbatim)
  85     (verse-block . org-odt-verse-block))
  86   :export-block "ODT"
  87   :filters-alist '((:filter-parse-tree
  88                     . (org-odt--translate-latex-fragments
  89                        org-odt--translate-description-lists
  90                        org-odt--translate-list-tables)))
  91   :menu-entry
  92   '(?o "Export to ODT"
  93        ((?o "As ODT file" org-odt-export-to-odt)
  94         (?O "As ODT file and open"
  95             (lambda (a s v b)
  96               (if a (org-odt-export-to-odt t s v)
  97                 (org-open-file (org-odt-export-to-odt nil s v) 'system))))))
  98   :options-alist
  99   '((:odt-styles-file "ODT_STYLES_FILE" nil nil t)
 100     (:description "DESCRIPTION" nil nil newline)
 101     (:keywords "KEYWORDS" nil nil space)
 102     (:subtitle "SUBTITLE" nil nil parse)
 103     ;; Other variables.
 104     (:odt-content-template-file nil nil org-odt-content-template-file)
 105     (:odt-display-outline-level nil nil org-odt-display-outline-level)
 106     (:odt-fontify-srcblocks nil nil org-odt-fontify-srcblocks)
 107     (:odt-format-drawer-function nil nil org-odt-format-drawer-function)
 108     (:odt-format-headline-function nil nil org-odt-format-headline-function)
 109     (:odt-format-inlinetask-function nil nil org-odt-format-inlinetask-function)
 110     (:odt-inline-formula-rules nil nil org-odt-inline-formula-rules)
 111     (:odt-inline-image-rules nil nil org-odt-inline-image-rules)
 112     (:odt-pixels-per-inch nil nil org-odt-pixels-per-inch)
 113     (:odt-styles-file nil nil org-odt-styles-file)
 114     (:odt-table-styles nil nil org-odt-table-styles)
 115     (:odt-use-date-fields nil nil org-odt-use-date-fields)
 116     ;; Redefine regular option.
 117     (:with-latex nil "tex" org-odt-with-latex)))
 118
 119
 120 ;;; Dependencies
 121
 122 ;;; Hooks
 123
 124 ;;; Function Declarations
 125
 126 (declare-function hfy-face-to-style "htmlfontify" (fn))
 127 (declare-function hfy-face-or-def-to-name "htmlfontify" (fn))
 128 (declare-function archive-zip-extract "arc-mode" (archive name))
 129 (declare-function org-create-math-formula "org" (latex-frag &optional mathml-file))
 130 (declare-function browse-url-file-url "browse-url" (file))
 131
 132
 133 \f
 134 ;;; Internal Variables
 135
 136 (defconst org-odt-lib-dir
 137   (file-name-directory (or load-file-name (buffer-file-name)))
 138   "Location of ODT exporter.
 139 Use this to infer values of `org-odt-styles-dir' and
 140 `org-odt-schema-dir'.")
 141
 142 (defvar org-odt-data-dir
 143   (expand-file-name "../../etc/" org-odt-lib-dir)
 144   "Data directory for ODT exporter.
 145 Use this to infer values of `org-odt-styles-dir' and
 146 `org-odt-schema-dir'.")
 147
 148 (defconst org-odt-special-string-regexps
 149   '(("\\\\-" . "&#x00ad;\\1")           ; shy
 150     ("---\\([^-]\\)" . "&#x2014;\\1")   ; mdash
 151     ("--\\([^-]\\)" . "&#x2013;\\1")    ; ndash
 152     ("\\.\\.\\." . "&#x2026;"))         ; hellip
 153   "Regular expressions for special string conversion.")
 154
 155 (defconst org-odt-schema-dir-list
 156   (list
 157    (and org-odt-data-dir
 158         (expand-file-name "./schema/" org-odt-data-dir)) ; bail out
 159    (eval-when-compile
 160      (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
 161           (expand-file-name "./schema/" org-odt-data-dir))))
 162   "List of directories to search for OpenDocument schema files.
 163 Use this list to set the default value of
 164 `org-odt-schema-dir'.  The entries in this list are
 165 populated heuristically based on the values of `org-odt-lib-dir'
 166 and `org-odt-data-dir'.")
 167
 168 (defconst org-odt-styles-dir-list
 169   (list
 170    (and org-odt-data-dir
 171         (expand-file-name "./styles/" org-odt-data-dir)) ; bail out
 172    (eval-when-compile
 173      (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
 174           (expand-file-name "./styles/" org-odt-data-dir)))
 175    (expand-file-name "../../etc/styles/" org-odt-lib-dir) ; git
 176    (expand-file-name "./etc/styles/" org-odt-lib-dir)  ; elpa
 177    (expand-file-name "./org/" data-directory)          ; system
 178    )
 179   "List of directories to search for OpenDocument styles files.
 180 See `org-odt-styles-dir'.  The entries in this list are populated
 181 heuristically based on the values of `org-odt-lib-dir' and
 182 `org-odt-data-dir'.")
 183
 184 (defconst org-odt-styles-dir
 185   (let* ((styles-dir
 186           (catch 'styles-dir
 187             (message "Debug (ox-odt): Searching for OpenDocument styles files...")
 188             (mapc (lambda (styles-dir)
 189                     (when styles-dir
 190                       (message "Debug (ox-odt): Trying %s..." styles-dir)
 191                       (when (and (file-readable-p
 192                                   (expand-file-name
 193                                    "OrgOdtContentTemplate.xml" styles-dir))
 194                                  (file-readable-p
 195                                   (expand-file-name
 196                                    "OrgOdtStyles.xml" styles-dir)))
 197                         (message "Debug (ox-odt): Using styles under %s"
 198                                  styles-dir)
 199                         (throw 'styles-dir styles-dir))))
 200                   org-odt-styles-dir-list)
 201             nil)))
 202     (unless styles-dir
 203       (error "Error (ox-odt): Cannot find factory styles files, aborting"))
 204     styles-dir)
 205   "Directory that holds auxiliary XML files used by the ODT exporter.
 206
 207 This directory contains the following XML files -
 208  \"OrgOdtStyles.xml\" and \"OrgOdtContentTemplate.xml\".  These
 209  XML files are used as the default values of
 210  `org-odt-styles-file' and `org-odt-content-template-file'.
 211
 212 The default value of this variable varies depending on the
 213 version of org in use and is initialized from
 214 `org-odt-styles-dir-list'.  Note that the user could be using org
 215 from one of: org's own private git repository, GNU ELPA tar or
 216 standard Emacs.")
 217
 218 (defconst org-odt-bookmark-prefix "OrgXref.")
 219
 220 (defconst org-odt-manifest-file-entry-tag
 221   "\n<manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
 222
 223 (defconst org-odt-file-extensions
 224   '(("odt" . "OpenDocument Text")
 225     ("ott" . "OpenDocument Text Template")
 226     ("odm" . "OpenDocument Master Document")
 227     ("ods" . "OpenDocument Spreadsheet")
 228     ("ots" . "OpenDocument Spreadsheet Template")
 229     ("odg" . "OpenDocument Drawing (Graphics)")
 230     ("otg" . "OpenDocument Drawing Template")
 231     ("odp" . "OpenDocument Presentation")
 232     ("otp" . "OpenDocument Presentation Template")
 233     ("odi" . "OpenDocument Image")
 234     ("odf" . "OpenDocument Formula")
 235     ("odc" . "OpenDocument Chart")))
 236
 237 (defconst org-odt-table-style-format
 238   "
 239 <style:style style:name=\"%s\" style:family=\"table\">
 240   <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
 241 </style:style>
 242 "
 243   "Template for auto-generated Table styles.")
 244
 245 (defvar org-odt-automatic-styles '()
 246   "Registry of automatic styles for various OBJECT-TYPEs.
 247 The variable has the following form:
 248 \(\(OBJECT-TYPE-A
 249   \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
 250    \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
 251  \(OBJECT-TYPE-B
 252   \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
 253    \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
 254  ...\).
 255
 256 OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
 257 OBJECT-PROPS is (typically) a plist created by passing
 258 \"#+ATTR_ODT: \" option to `org-odt-parse-block-attributes'.
 259
 260 Use `org-odt-add-automatic-style' to add update this variable.'")
 261
 262 (defvar org-odt-object-counters nil
 263   "Running counters for various OBJECT-TYPEs.
 264 Use this to generate automatic names and style-names. See
 265 `org-odt-add-automatic-style'.")
 266
 267 (defvar org-odt-src-block-paragraph-format
 268   "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
 269    <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
 270     <style:background-image/>
 271    </style:paragraph-properties>
 272    <style:text-properties fo:color=\"%s\"/>
 273   </style:style>"
 274   "Custom paragraph style for colorized source and example blocks.
 275 This style is much the same as that of \"OrgFixedWidthBlock\"
 276 except that the foreground and background colors are set
 277 according to the default face identified by the `htmlfontify'.")
 278
 279 (defvar hfy-optimizations)
 280 (define-obsolete-variable-alias 'hfy-optimisations 'hfy-optimizations "25.1")
 281 (defvar org-odt-embedded-formulas-count 0)
 282 (defvar org-odt-embedded-images-count 0)
 283 (defvar org-odt-image-size-probe-method
 284   (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
 285           '(emacs fixed))
 286   "Ordered list of methods for determining image sizes.")
 287
 288 (defvar org-odt-default-image-sizes-alist
 289   '(("as-char" . (5 . 0.4))
 290     ("paragraph" . (5 . 5)))
 291   "Hardcoded image dimensions one for each of the anchor
 292   methods.")
 293
 294 ;; A4 page size is 21.0 by 29.7 cms
 295 ;; The default page settings has 2cm margin on each of the sides. So
 296 ;; the effective text area is 17.0 by 25.7 cm
 297 (defvar org-odt-max-image-size '(17.0 . 20.0)
 298   "Limiting dimensions for an embedded image.")
 299
 300 (defconst org-odt-label-styles
 301   '(("math-formula" "%c" "text" "(%n)")
 302     ("math-label" "(%n)" "text" "(%n)")
 303     ("category-and-value" "%e %n: %c" "category-and-value" "%e %n")
 304     ("value" "%e %n: %c" "value" "%n"))
 305   "Specify how labels are applied and referenced.
 306
 307 This is an alist where each element is of the form:
 308
 309   \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
 310
 311 ATTACH-FMT controls how labels and captions are attached to an
 312 entity.  It may contain following specifiers - %e and %c.  %e is
 313 replaced with the CATEGORY-NAME.  %n is replaced with
 314 \"<text:sequence ...> SEQNO </text:sequence>\".  %c is replaced
 315 with CAPTION.
 316
 317 REF-MODE and REF-FMT controls how label references are generated.
 318 The following XML is generated for a label reference -
 319 \"<text:sequence-ref text:reference-format=\"REF-MODE\" ...>
 320 REF-FMT </text:sequence-ref>\".  REF-FMT may contain following
 321 specifiers - %e and %n.  %e is replaced with the CATEGORY-NAME.
 322 %n is replaced with SEQNO.
 323
 324 See also `org-odt-format-label'.")
 325
 326 (defvar org-odt-category-map-alist
 327   '(("__Table__" "Table" "value" "Table" org-odt--enumerable-p)
 328     ("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)
 329     ("__MathFormula__" "Text" "math-formula" "Equation" org-odt--enumerable-formula-p)
 330     ("__DvipngImage__" "Equation" "value" "Equation" org-odt--enumerable-latex-image-p)
 331     ("__Listing__" "Listing" "value" "Listing" org-odt--enumerable-p))
 332   "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
 333
 334 This is a list where each entry is of the form:
 335
 336   \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
 337
 338 CATEGORY_HANDLE identifies the captionable entity in question.
 339
 340 OD-VARIABLE is the OpenDocument sequence counter associated with
 341 the entity.  These counters are declared within
 342 \"<text:sequence-decls>...</text:sequence-decls>\" block of
 343 `org-odt-content-template-file'.
 344
 345 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
 346 how a given entity should be captioned and referenced.
 347
 348 CATEGORY-NAME is used for qualifying captions on export.
 349
 350 ENUMERATOR-PREDICATE is used for assigning a sequence number to
 351 the entity.  See `org-odt--enumerate'.")
 352
 353 (defvar org-odt-manifest-file-entries nil)
 354 (defvar hfy-user-sheet-assoc)
 355
 356 (defvar org-odt-zip-dir nil
 357   "Temporary work directory for OpenDocument exporter.")
 358
 359
 360 \f
 361 ;;; User Configuration Variables
 362
 363 (defgroup org-export-odt nil
 364   "Options for exporting Org mode files to ODT."
 365   :tag "Org Export ODT"
 366   :group 'org-export)
 367
 368
 369 ;;;; Debugging
 370
 371 (defcustom org-odt-prettify-xml nil
 372   "Specify whether or not the xml output should be prettified.
 373 When this option is turned on, `indent-region' is run on all
 374 component xml buffers before they are saved.  Turn this off for
 375 regular use.  Turn this on if you need to examine the xml
 376 visually."
 377   :group 'org-export-odt
 378   :version "24.1"
 379   :type 'boolean)
 380
 381
 382 ;;;; Document schema
 383
 384 (require 'rng-loc)
 385 (defcustom org-odt-schema-dir
 386   (let* ((schema-dir
 387           (catch 'schema-dir
 388             (message "Debug (ox-odt): Searching for OpenDocument schema files...")
 389             (mapc
 390              (lambda (schema-dir)
 391                (when schema-dir
 392                  (message "Debug (ox-odt): Trying %s..." schema-dir)
 393                  (when (and (file-expand-wildcards
 394                              (expand-file-name "od-manifest-schema*.rnc"
 395                                                schema-dir))
 396                             (file-expand-wildcards
 397                              (expand-file-name "od-schema*.rnc"
 398                                                schema-dir))
 399                             (file-readable-p
 400                              (expand-file-name "schemas.xml" schema-dir)))
 401                    (message "Debug (ox-odt): Using schema files under %s"
 402                             schema-dir)
 403                    (throw 'schema-dir schema-dir))))
 404              org-odt-schema-dir-list)
 405             (message "Debug (ox-odt): No OpenDocument schema files installed")
 406             nil)))
 407     schema-dir)
 408   "Directory that contains OpenDocument schema files.
 409
 410 This directory contains:
 411 1. rnc files for OpenDocument schema
 412 2. a \"schemas.xml\" file that specifies locating rules needed
 413    for auto validation of OpenDocument XML files.
 414
 415 Use the customize interface to set this variable.  This ensures
 416 that `rng-schema-locating-files' is updated and auto-validation
 417 of OpenDocument XML takes place based on the value
 418 `rng-nxml-auto-validate-flag'.
 419
 420 The default value of this variable varies depending on the
 421 version of org in use and is initialized from
 422 `org-odt-schema-dir-list'.  The OASIS schema files are available
 423 only in the org's private git repository.  It is *not* bundled
 424 with GNU ELPA tar or standard Emacs distribution."
 425   :type '(choice
 426           (const :tag "Not set" nil)
 427           (directory :tag "Schema directory"))
 428   :group 'org-export-odt
 429   :version "24.1"
 430   :set
 431   (lambda (var value)
 432     "Set `org-odt-schema-dir'.
 433 Also add it to `rng-schema-locating-files'."
 434     (let ((schema-dir value))
 435       (set var
 436            (if (and
 437                 (file-expand-wildcards
 438                  (expand-file-name "od-manifest-schema*.rnc" schema-dir))
 439                 (file-expand-wildcards
 440                  (expand-file-name "od-schema*.rnc" schema-dir))
 441                 (file-readable-p
 442                  (expand-file-name "schemas.xml" schema-dir)))
 443                schema-dir
 444              (when value
 445                (message "Error (ox-odt): %s has no OpenDocument schema files"
 446                         value))
 447              nil)))
 448     (when org-odt-schema-dir
 449       (eval-after-load 'rng-loc
 450         '(add-to-list 'rng-schema-locating-files
 451                       (expand-file-name "schemas.xml"
 452                                         org-odt-schema-dir))))))
 453
 454
 455 ;;;; Document styles
 456
 457 (defcustom org-odt-content-template-file nil
 458   "Template file for \"content.xml\".
 459 The exporter embeds the exported content just before
 460 \"</office:text>\" element.
 461
 462 If unspecified, the file named \"OrgOdtContentTemplate.xml\"
 463 under `org-odt-styles-dir' is used."
 464   :type '(choice (const nil)
 465                  (file))
 466   :group 'org-export-odt
 467   :version "24.3")
 468
 469 (defcustom org-odt-styles-file nil
 470   "Default styles file for use with ODT export.
 471 Valid values are one of:
 472 1. nil
 473 2. path to a styles.xml file
 474 3. path to a *.odt or a *.ott file
 475 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
 476 ...))
 477
 478 In case of option 1, an in-built styles.xml is used. See
 479 `org-odt-styles-dir' for more information.
 480
 481 In case of option 3, the specified file is unzipped and the
 482 styles.xml embedded therein is used.
 483
 484 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
 485 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
 486 generated odt file.  Use relative path for specifying the
 487 FILE-MEMBERS.  styles.xml must be specified as one of the
 488 FILE-MEMBERS.
 489
 490 Use options 1, 2 or 3 only if styles.xml alone suffices for
 491 achieving the desired formatting.  Use option 4, if the styles.xml
 492 references additional files like header and footer images for
 493 achieving the desired formatting.
 494
 495 Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
 496 a per-file basis.  For example,
 497
 498 #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
 499 #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
 500   :group 'org-export-odt
 501   :version "24.1"
 502   :type
 503   '(choice
 504     (const :tag "Factory settings" nil)
 505     (file :must-match t :tag "styles.xml")
 506     (file :must-match t :tag "ODT or OTT file")
 507     (list :tag "ODT or OTT file + Members"
 508           (file :must-match t :tag "ODF Text or Text Template file")
 509           (cons :tag "Members"
 510                 (file :tag "    Member" "styles.xml")
 511                 (repeat (file :tag "Member"))))))
 512
 513 (defcustom org-odt-display-outline-level 2
 514   "Outline levels considered for enumerating captioned entities."
 515   :group 'org-export-odt
 516   :version "24.4"
 517   :package-version '(Org . "8.0")
 518   :type 'integer)
 519
 520 ;;;; Document conversion
 521
 522 (defcustom org-odt-convert-processes
 523   '(("LibreOffice"
 524      "soffice --headless --convert-to %f%x --outdir %d %i")
 525     ("unoconv"
 526      "unoconv -f %f -o %d %i"))
 527   "Specify a list of document converters and their usage.
 528 The converters in this list are offered as choices while
 529 customizing `org-odt-convert-process'.
 530
 531 This variable is a list where each element is of the
 532 form (CONVERTER-NAME CONVERTER-CMD).  CONVERTER-NAME is the name
 533 of the converter.  CONVERTER-CMD is the shell command for the
 534 converter and can contain format specifiers.  These format
 535 specifiers are interpreted as below:
 536
 537 %i input file name in full
 538 %I input file name as a URL
 539 %f format of the output file
 540 %o output file name in full
 541 %O output file name as a URL
 542 %d output dir in full
 543 %D output dir as a URL.
 544 %x extra options as set in `org-odt-convert-capabilities'."
 545   :group 'org-export-odt
 546   :version "24.1"
 547   :type
 548   '(choice
 549     (const :tag "None" nil)
 550     (alist :tag "Converters"
 551            :key-type (string :tag "Converter Name")
 552            :value-type (group (string :tag "Command line")))))
 553
 554 (defcustom org-odt-convert-process "LibreOffice"
 555   "Use this converter to convert from \"odt\" format to other formats.
 556 During customization, the list of converter names are populated
 557 from `org-odt-convert-processes'."
 558   :group 'org-export-odt
 559   :version "24.1"
 560   :type '(choice :convert-widget
 561                  (lambda (w)
 562                    (apply 'widget-convert (widget-type w)
 563                           (eval (car (widget-get w :args)))))
 564                  `((const :tag "None" nil)
 565                    ,@(mapcar (lambda (c)
 566                                `(const :tag ,(car c) ,(car c)))
 567                              org-odt-convert-processes))))
 568
 569 (defcustom org-odt-convert-capabilities
 570   '(("Text"
 571      ("odt" "ott" "doc" "rtf" "docx")
 572      (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
 573       ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
 574     ("Web"
 575      ("html")
 576      (("pdf" "pdf") ("odt" "odt") ("html" "html")))
 577     ("Spreadsheet"
 578      ("ods" "ots" "xls" "csv" "xlsx")
 579      (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
 580       ("xls" "xls") ("xlsx" "xlsx")))
 581     ("Presentation"
 582      ("odp" "otp" "ppt" "pptx")
 583      (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
 584       ("pptx" "pptx") ("odg" "odg"))))
 585   "Specify input and output formats of `org-odt-convert-process'.
 586 More correctly, specify the set of input and output formats that
 587 the user is actually interested in.
 588
 589 This variable is an alist where each element is of the
 590 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
 591 INPUT-FMT-LIST is a list of INPUT-FMTs.  OUTPUT-FMT-ALIST is an
 592 alist where each element is of the form (OUTPUT-FMT
 593 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
 594
 595 The variable is interpreted as follows:
 596 `org-odt-convert-process' can take any document that is in
 597 INPUT-FMT-LIST and produce any document that is in the
 598 OUTPUT-FMT-LIST.  A document converted to OUTPUT-FMT will have
 599 OUTPUT-FILE-EXTENSION as the file name extension.  OUTPUT-FMT
 600 serves dual purposes:
 601 - It is used for populating completion candidates during
 602   `org-odt-convert' commands.
 603 - It is used as the value of \"%f\" specifier in
 604   `org-odt-convert-process'.
 605
 606 EXTRA-OPTIONS is used as the value of \"%x\" specifier in
 607 `org-odt-convert-process'.
 608
 609 DOCUMENT-CLASS is used to group a set of file formats in
 610 INPUT-FMT-LIST in to a single class.
 611
 612 Note that this variable inherently captures how LibreOffice based
 613 converters work.  LibreOffice maps documents of various formats
 614 to classes like Text, Web, Spreadsheet, Presentation etc and
 615 allow document of a given class (irrespective of its source
 616 format) to be converted to any of the export formats associated
 617 with that class.
 618
 619 See default setting of this variable for an typical
 620 configuration."
 621   :group 'org-export-odt
 622   :version "24.1"
 623   :type
 624   '(choice
 625     (const :tag "None" nil)
 626     (alist :tag "Capabilities"
 627            :key-type (string :tag "Document Class")
 628            :value-type
 629            (group (repeat :tag "Input formats" (string :tag "Input format"))
 630                   (alist :tag "Output formats"
 631                          :key-type (string :tag "Output format")
 632                          :value-type
 633                          (group (string :tag "Output file extension")
 634                                 (choice
 635                                  (const :tag "None" nil)
 636                                  (string :tag "Extra options"))))))))
 637
 638 (defcustom org-odt-preferred-output-format nil
 639   "Automatically post-process to this format after exporting to \"odt\".
 640 Command `org-odt-export-to-odt' exports first to \"odt\" format
 641 and then uses `org-odt-convert-process' to convert the
 642 resulting document to this format.  During customization of this
 643 variable, the list of valid values are populated based on
 644 `org-odt-convert-capabilities'.
 645
 646 You can set this option on per-file basis using file local
 647 values.  See Info node `(emacs) File Variables'."
 648   :group 'org-export-odt
 649   :version "24.1"
 650   :type '(choice :convert-widget
 651                  (lambda (w)
 652                    (apply 'widget-convert (widget-type w)
 653                           (eval (car (widget-get w :args)))))
 654                  `((const :tag "None" nil)
 655                    ,@(mapcar (lambda (c)
 656                                `(const :tag ,c ,c))
 657                              (org-odt-reachable-formats "odt")))))
 658 ;;;###autoload
 659 (put 'org-odt-preferred-output-format 'safe-local-variable 'stringp)
 660
 661
 662 ;;;; Drawers
 663
 664 (defcustom org-odt-format-drawer-function
 665   (lambda (name contents) contents)
 666   "Function called to format a drawer in ODT code.
 667
 668 The function must accept two parameters:
 669   NAME      the drawer name, like \"LOGBOOK\"
 670   CONTENTS  the contents of the drawer.
 671
 672 The function should return the string to be exported.
 673
 674 The default value simply returns the value of CONTENTS."
 675   :group 'org-export-odt
 676   :version "24.4"
 677   :package-version '(Org . "8.3")
 678   :type 'function)
 679
 680
 681 ;;;; Headline
 682
 683 (defcustom org-odt-format-headline-function
 684   'org-odt-format-headline-default-function
 685   "Function to format headline text.
 686
 687 This function will be called with 5 arguments:
 688 TODO      the todo keyword \(string or nil\).
 689 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
 690 PRIORITY  the priority of the headline \(integer or nil\)
 691 TEXT      the main headline text \(string\).
 692 TAGS      the tags string, separated with colons \(string or nil\).
 693
 694 The function result will be used as headline text."
 695   :group 'org-export-odt
 696   :version "25.1"
 697   :package-version '(Org . "8.3")
 698   :type 'function)
 699
 700
 701 ;;;; Inlinetasks
 702
 703 (defcustom org-odt-format-inlinetask-function
 704   'org-odt-format-inlinetask-default-function
 705   "Function called to format an inlinetask in ODT code.
 706
 707 The function must accept six parameters:
 708   TODO      the todo keyword, as a string
 709   TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
 710   PRIORITY  the inlinetask priority, as a string
 711   NAME      the inlinetask name, as a string.
 712   TAGS      the inlinetask tags, as a string.
 713   CONTENTS  the contents of the inlinetask, as a string.
 714
 715 The function should return the string to be exported."
 716   :group 'org-export-odt
 717   :version "25.1"
 718   :package-version '(Org . "8.3")
 719   :type 'function)
 720
 721
 722 ;;;; LaTeX
 723
 724 (defcustom org-odt-with-latex org-export-with-latex
 725   "Non-nil means process LaTeX math snippets.
 726
 727 When set, the exporter will process LaTeX environments and
 728 fragments.
 729
 730 This option can also be set with the +OPTIONS line,
 731 e.g. \"tex:mathjax\".  Allowed values are:
 732
 733 nil            Ignore math snippets.
 734 `verbatim'     Keep everything in verbatim
 735 `dvipng'       Process the LaTeX fragments to images.  This will also
 736                include processing of non-math environments.
 737 `imagemagick'  Convert the LaTeX fragments to pdf files and use
 738                imagemagick to convert pdf files to png files.
 739 `mathjax'      Do MathJax preprocessing and arrange for MathJax.js to
 740                be loaded.
 741 t              Synonym for `mathjax'."
 742   :group 'org-export-odt
 743   :version "24.4"
 744   :package-version '(Org . "8.0")
 745   :type '(choice
 746           (const :tag "Do not process math in any way" nil)
 747           (const :tag "Use dvipng to make images" dvipng)
 748           (const :tag "Use imagemagick to make images" imagemagick)
 749           (const :tag "Use MathJax to display math" mathjax)
 750           (const :tag "Leave math verbatim" verbatim)))
 751
 752
 753 ;;;; Links
 754
 755 (defcustom org-odt-inline-formula-rules
 756   '(("file" . "\\.\\(mathml\\|mml\\|odf\\)\\'"))
 757   "Rules characterizing formula files that can be inlined into ODT.
 758
 759 A rule consists in an association whose key is the type of link
 760 to consider, and value is a regexp that will be matched against
 761 link's path."
 762   :group 'org-export-odt
 763   :version "24.4"
 764   :package-version '(Org . "8.0")
 765   :type '(alist :key-type (string :tag "Type")
 766                 :value-type (regexp :tag "Path")))
 767
 768 (defcustom org-odt-inline-image-rules
 769   '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
 770   "Rules characterizing image files that can be inlined into ODT.
 771
 772 A rule consists in an association whose key is the type of link
 773 to consider, and value is a regexp that will be matched against
 774 link's path."
 775   :group 'org-export-odt
 776   :version "25.1"
 777   :package-version '(Org . "8.3")
 778   :type '(alist :key-type (string :tag "Type")
 779                 :value-type (regexp :tag "Path")))
 780
 781 (defcustom org-odt-pixels-per-inch 96.0
 782   "Scaling factor for converting images pixels to inches.
 783 Use this for sizing of embedded images.  See Info node `(org)
 784 Images in ODT export' for more information."
 785   :type 'float
 786   :group 'org-export-odt
 787   :version "24.4"
 788   :package-version '(Org . "8.1"))
 789
 790
 791 ;;;; Src Block
 792
 793 (defcustom org-odt-create-custom-styles-for-srcblocks t
 794   "Whether custom styles for colorized source blocks be automatically created.
 795 When this option is turned on, the exporter creates custom styles
 796 for source blocks based on the advice of `htmlfontify'.  Creation
 797 of custom styles happen as part of `org-odt-hfy-face-to-css'.
 798
 799 When this option is turned off exporter does not create such
 800 styles.
 801
 802 Use the latter option if you do not want the custom styles to be
 803 based on your current display settings.  It is necessary that the
 804 styles.xml already contains needed styles for colorizing to work.
 805
 806 This variable is effective only if `org-odt-fontify-srcblocks' is
 807 turned on."
 808   :group 'org-export-odt
 809   :version "24.1"
 810   :type 'boolean)
 811
 812 (defcustom org-odt-fontify-srcblocks t
 813   "Specify whether or not source blocks need to be fontified.
 814 Turn this option on if you want to colorize the source code
 815 blocks in the exported file.  For colorization to work, you need
 816 to make available an enhanced version of `htmlfontify' library."
 817   :type 'boolean
 818   :group 'org-export-odt
 819   :version "24.1")
 820
 821
 822 ;;;; Table
 823
 824 (defcustom org-odt-table-styles
 825   '(("OrgEquation" "OrgEquation"
 826      ((use-first-column-styles . t)
 827       (use-last-column-styles . t)))
 828     ("TableWithHeaderRowAndColumn" "Custom"
 829      ((use-first-row-styles . t)
 830       (use-first-column-styles . t)))
 831     ("TableWithFirstRowandLastRow" "Custom"
 832      ((use-first-row-styles . t)
 833       (use-last-row-styles . t)))
 834     ("GriddedTable" "Custom" nil))
 835   "Specify how Table Styles should be derived from a Table Template.
 836 This is a list where each element is of the
 837 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
 838
 839 TABLE-STYLE-NAME is the style associated with the table through
 840 \"#+ATTR_ODT: :style TABLE-STYLE-NAME\" line.
 841
 842 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
 843 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
 844 below) that is included in `org-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-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 ;;;; Timestamps
 921
 922 (defcustom org-odt-use-date-fields nil
 923   "Non-nil, if timestamps should be exported as date fields.
 924
 925 When nil, export timestamps as plain text.
 926
 927 When non-nil, map `org-time-stamp-custom-formats' to a pair of
 928 OpenDocument date-styles with names \"OrgDate1\" and \"OrgDate2\"
 929 respectively.  A timestamp with no time component is formatted
 930 with style \"OrgDate1\" while one with explicit hour and minutes
 931 is formatted with style \"OrgDate2\".
 932
 933 This feature is experimental.  Most (but not all) of the common
 934 %-specifiers in `format-time-string' are supported.
 935 Specifically, locale-dependent specifiers like \"%c\", \"%x\" are
 936 formatted as canonical Org timestamps.  For finer control, avoid
 937 these %-specifiers.
 938
 939 Textual specifiers like \"%b\", \"%h\", \"%B\", \"%a\", \"%A\"
 940 etc., are displayed by the application in the default language
 941 and country specified in `org-odt-styles-file'.  Note that the
 942 default styles file uses language \"en\" and country \"GB\".  You
 943 can localize the week day and month strings in the exported
 944 document by setting the default language and country either using
 945 the application UI or through a custom styles file.
 946
 947 See `org-odt--build-date-styles' for implementation details."
 948   :group 'org-export-odt
 949   :version "24.4"
 950   :package-version '(Org . "8.0")
 951   :type 'boolean)
 952
 953
 954 \f
 955 ;;; Internal functions
 956
 957 ;;;; Date
 958
 959 (defun org-odt--format-timestamp (timestamp &optional end iso-date-p)
 960   (let* ((format-timestamp
 961           (lambda (timestamp format &optional end utc)
 962             (if timestamp
 963                 (org-timestamp-format timestamp format end utc)
 964               (format-time-string format nil utc))))
 965          (has-time-p (or (not timestamp)
 966                          (org-timestamp-has-time-p timestamp)))
 967          (iso-date (let ((format (if has-time-p "%Y-%m-%dT%H:%M:%S"
 968                                    "%Y-%m-%dT%H:%M:%S")))
 969                      (funcall format-timestamp timestamp format end))))
 970     (if iso-date-p iso-date
 971       (let* ((style (if has-time-p "OrgDate2" "OrgDate1"))
 972              ;; LibreOffice does not care about end goes as content
 973              ;; within the "<text:date>...</text:date>" field.  The
 974              ;; displayed date is automagically corrected to match the
 975              ;; format requested by "style:data-style-name" attribute.  So
 976              ;; don't bother about formatting the date contents to be
 977              ;; compatible with "OrgDate1" and "OrgDateTime" styles.  A
 978              ;; simple Org-style date should suffice.
 979              (date (let* ((formats
 980                            (if org-display-custom-times
 981                                (cons (substring
 982                                       (car org-time-stamp-custom-formats) 1 -1)
 983                                      (substring
 984                                       (cdr org-time-stamp-custom-formats) 1 -1))
 985                              '("%Y-%m-%d %a" . "%Y-%m-%d %a %H:%M")))
 986                           (format (if has-time-p (cdr formats) (car formats))))
 987                      (funcall format-timestamp timestamp format end)))
 988              (repeater (let ((repeater-type (org-element-property
 989                                              :repeater-type timestamp))
 990                              (repeater-value (org-element-property
 991                                               :repeater-value timestamp))
 992                              (repeater-unit (org-element-property
 993                                              :repeater-unit timestamp)))
 994                          (concat
 995                           (case repeater-type
 996                             (catchup "++") (restart ".+") (cumulate "+"))
 997                           (when repeater-value
 998                             (number-to-string repeater-value))
 999                           (case repeater-unit
1000                             (hour "h") (day "d") (week "w") (month "m")
1001                             (year "y"))))))
1002         (concat
1003          (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1004                  iso-date style date)
1005          (and (not (string= repeater ""))  " ")
1006          repeater)))))
1007
1008 ;;;; Frame
1009
1010 (defun org-odt--frame (text width height style &optional extra
1011                               anchor-type &rest title-and-desc)
1012   (let ((frame-attrs
1013          (concat
1014           (if width (format " svg:width=\"%0.2fcm\"" width) "")
1015           (if height (format " svg:height=\"%0.2fcm\"" height) "")
1016           extra
1017           (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph"))
1018           (format " draw:name=\"%s\""
1019                   (car (org-odt-add-automatic-style "Frame"))))))
1020     (format
1021      "\n<draw:frame draw:style-name=\"%s\"%s>\n%s\n</draw:frame>"
1022      style frame-attrs
1023      (concat text
1024              (let ((title (car title-and-desc))
1025                    (desc (cadr title-and-desc)))
1026                (concat (when title
1027                          (format "<svg:title>%s</svg:title>"
1028                                  (org-odt--encode-plain-text title t)))
1029                        (when desc
1030                          (format "<svg:desc>%s</svg:desc>"
1031                                  (org-odt--encode-plain-text desc t)))))))))
1032
1033
1034 ;;;; Library wrappers
1035
1036 (defun org-odt--zip-extract (archive members target)
1037   (when (atom members) (setq members (list members)))
1038   (mapc (lambda (member)
1039           (require 'arc-mode)
1040           (let* ((--quote-file-name
1041                   ;; This is shamelessly stolen from `archive-zip-extract'.
1042                   (lambda (name)
1043                     (if (or (not (memq system-type '(windows-nt ms-dos)))
1044                             (and (boundp 'w32-quote-process-args)
1045                                  (null w32-quote-process-args)))
1046                         (shell-quote-argument name)
1047                       name)))
1048                  (target (funcall --quote-file-name target))
1049                  (archive (expand-file-name archive))
1050                  (archive-zip-extract
1051                   (list "unzip" "-qq" "-o" "-d" target))
1052                  exit-code command-output)
1053             (setq command-output
1054                   (with-temp-buffer
1055                     (setq exit-code (archive-zip-extract archive member))
1056                     (buffer-string)))
1057             (unless (zerop exit-code)
1058               (message command-output)
1059               (error "Extraction failed"))))
1060         members))
1061
1062 ;;;; Target
1063
1064 (defun org-odt--target (text id)
1065   (if (not id) text
1066     (concat
1067      (format "\n<text:bookmark-start text:name=\"OrgXref.%s\"/>" id)
1068      (format "\n<text:bookmark text:name=\"%s\"/>" id) text
1069      (format "\n<text:bookmark-end text:name=\"OrgXref.%s\"/>" id))))
1070
1071 ;;;; Textbox
1072
1073 (defun org-odt--textbox (text width height style &optional
1074                                 extra anchor-type)
1075   (org-odt--frame
1076    (format "\n<draw:text-box %s>%s\n</draw:text-box>"
1077            (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
1078                    (and (not width)
1079                         (format " fo:min-width=\"%0.2fcm\"" (or width .2))))
1080            text)
1081    width nil style extra anchor-type))
1082
1083
1084
1085 ;;;; Table of Contents
1086
1087 (defun org-odt--format-toc (title entries depth)
1088   "Return a table of contents.
1089 TITLE is the title of the table, as a string, or nil.  ENTRIES is
1090 the contents of the table, as a string.  DEPTH is an integer
1091 specifying the depth of the table."
1092   (concat
1093    "
1094 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1095    (format "  <text:table-of-content-source text:outline-level=\"%d\">" depth)
1096    (and title
1097         (format "
1098     <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1099 "
1100                 title))
1101
1102    (let ((levels (number-sequence 1 10)))
1103      (mapconcat
1104       (lambda (level)
1105         (format
1106          "
1107       <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1108        <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
1109        <text:index-entry-chapter/>
1110        <text:index-entry-text/>
1111        <text:index-entry-link-end/>
1112       </text:table-of-content-entry-template>\n"
1113          level level)) levels ""))
1114    "
1115   </text:table-of-content-source>
1116   <text:index-body>"
1117    (and title
1118         (format "
1119     <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
1120       <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
1121     </text:index-title>\n"
1122                 title))
1123    entries
1124    "
1125   </text:index-body>
1126 </text:table-of-content>"))
1127
1128 (defun* org-odt-format-toc-headline
1129     (todo todo-type priority text tags
1130           &key level section-number headline-label &allow-other-keys)
1131   (setq text
1132         (concat
1133          ;; Section number.
1134          (and section-number (concat section-number ". "))
1135          ;; Todo.
1136          (when todo
1137            (let ((style (if (member todo org-done-keywords)
1138                             "OrgDone" "OrgTodo")))
1139              (format "<text:span text:style-name=\"%s\">%s</text:span> "
1140                      style todo)))
1141          (when priority
1142            (let* ((style (format "OrgPriority-%s" priority))
1143                   (priority (format "[#%c]" priority)))
1144              (format "<text:span text:style-name=\"%s\">%s</text:span> "
1145                      style priority)))
1146          ;; Title.
1147          text
1148          ;; Tags.
1149          (when tags
1150            (concat
1151             (format " <text:span text:style-name=\"%s\">[%s]</text:span>"
1152                     "OrgTags"
1153                     (mapconcat
1154                      (lambda (tag)
1155                        (format
1156                         "<text:span text:style-name=\"%s\">%s</text:span>"
1157                         "OrgTag" tag)) tags " : "))))))
1158   (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
1159           headline-label text))
1160
1161 (defun org-odt-toc (depth info &optional scope)
1162   "Build a table of contents.
1163 DEPTH is an integer specifying the depth of the table.  INFO is
1164 a plist containing current export properties.  Optional argument
1165 SCOPE, when non-nil, defines the scope of the table.  Return the
1166 table of contents as a string, or nil."
1167   (assert (wholenump depth))
1168   ;; When a headline is marked as a radio target, as in the example below:
1169   ;;
1170   ;; ** <<<Some Heading>>>
1171   ;;    Some text.
1172   ;;
1173   ;; suppress generation of radio targets.  i.e., Radio targets are to
1174   ;; be marked as targets within /document body/ and *not* within
1175   ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1176   ;; and one in the document body.
1177   ;;
1178   ;; FIXME: Are there any other objects that need to be suppressed
1179   ;; within TOC?
1180   (let* ((headlines (org-export-collect-headlines info depth scope))
1181          (backend (org-export-create-backend
1182                    :parent (org-export-backend-name (plist-get info :back-end))
1183                    :transcoders (mapcar
1184                                  (lambda (type) (cons type (lambda (d c i) c)))
1185                                  (list 'radio-target)))))
1186     (when headlines
1187       (org-odt--format-toc
1188        (and (not scope) (org-export-translate "Table of Contents" :utf-8 info))
1189        (mapconcat
1190         (lambda (headline)
1191           (let* ((entry (org-odt-format-headline--wrap
1192                          headline backend info 'org-odt-format-toc-headline))
1193                  (level (org-export-get-relative-level headline info))
1194                  (style (format "Contents_20_%d" level)))
1195             (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1196                     style entry)))
1197         headlines "\n")
1198        depth))))
1199
1200
1201 ;;;; Document styles
1202
1203 (defun org-odt-add-automatic-style (object-type &optional object-props)
1204   "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1205 OBJECT-PROPS is (typically) a plist created by passing
1206 \"#+ATTR_ODT: \" option of the object in question to
1207 `org-odt-parse-block-attributes'.
1208
1209 Use `org-odt-object-counters' to generate an automatic
1210 OBJECT-NAME and STYLE-NAME.  If OBJECT-PROPS is non-nil, add a
1211 new entry in `org-odt-automatic-styles'.  Return (OBJECT-NAME
1212 . STYLE-NAME)."
1213   (assert (stringp object-type))
1214   (let* ((object (intern object-type))
1215          (seqvar object)
1216          (seqno (1+ (or (plist-get org-odt-object-counters seqvar) 0)))
1217          (object-name (format "%s%d" object-type seqno)) style-name)
1218     (setq org-odt-object-counters
1219           (plist-put org-odt-object-counters seqvar seqno))
1220     (when object-props
1221       (setq style-name (format "Org%s" object-name))
1222       (setq org-odt-automatic-styles
1223             (plist-put org-odt-automatic-styles object
1224                        (append (list (list style-name object-props))
1225                                (plist-get org-odt-automatic-styles object)))))
1226     (cons object-name style-name)))
1227
1228 ;;;; Checkbox
1229
1230 (defun org-odt--checkbox (item)
1231   "Return check-box string associated to ITEM."
1232   (let ((checkbox (org-element-property :checkbox item)))
1233     (if (not checkbox) ""
1234       (format "<text:span text:style-name=\"%s\">%s</text:span>"
1235               "OrgCode" (case checkbox
1236                           (on "[&#x2713;] ") ; CHECK MARK
1237                           (off "[ ] ")
1238                           (trans "[-] "))))))
1239
1240 ;;; Template
1241
1242 (defun org-odt--build-date-styles (fmt style)
1243   ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1244   ;; to modify the date fields.  A date could be modified by
1245   ;; offsetting in days.  That's about it.  Also, date and time may
1246   ;; have to be emitted as two fields - a date field and a time field
1247   ;; - separately.
1248
1249   ;; One can add Form Controls to date and time fields so that they
1250   ;; can be easily modified.  But then, the exported document will
1251   ;; become tightly coupled with LibreOffice and may not function
1252   ;; properly with other OpenDocument applications.
1253
1254   ;; I have a strange feeling that Date styles are a bit flaky at the
1255   ;; moment.
1256
1257   ;; The feature is experimental.
1258   (when (and fmt style)
1259     (let* ((fmt-alist
1260             '(("%A" . "<number:day-of-week number:style=\"long\"/>")
1261               ("%B" . "<number:month number:textual=\"true\" number:style=\"long\"/>")
1262               ("%H" . "<number:hours number:style=\"long\"/>")
1263               ("%M" . "<number:minutes number:style=\"long\"/>")
1264               ("%S" . "<number:seconds number:style=\"long\"/>")
1265               ("%V" . "<number:week-of-year/>")
1266               ("%Y" . "<number:year number:style=\"long\"/>")
1267               ("%a" . "<number:day-of-week number:style=\"short\"/>")
1268               ("%b" . "<number:month number:textual=\"true\" number:style=\"short\"/>")
1269               ("%d" . "<number:day number:style=\"long\"/>")
1270               ("%e" . "<number:day number:style=\"short\"/>")
1271               ("%h" . "<number:month number:textual=\"true\" number:style=\"short\"/>")
1272               ("%k" . "<number:hours number:style=\"short\"/>")
1273               ("%m" . "<number:month number:style=\"long\"/>")
1274               ("%p" . "<number:am-pm/>")
1275               ("%y" . "<number:year number:style=\"short\"/>")))
1276            (case-fold-search nil)
1277            (re (mapconcat 'identity (mapcar 'car fmt-alist) "\\|"))
1278            match rpl (start 0) (filler-beg 0) filler-end filler output)
1279       (mapc
1280        (lambda (pair)
1281          (setq fmt (replace-regexp-in-string (car pair) (cdr pair) fmt t t)))
1282        '(("\\(?:%[[:digit:]]*N\\)" . "") ; strip ns, us and ns
1283          ("%C" . "Y")                    ; replace century with year
1284          ("%D" . "%m/%d/%y")
1285          ("%G" . "Y")                 ; year corresponding to iso week
1286          ("%I" . "%H")                ; hour on a 12-hour clock
1287          ("%R" . "%H:%M")
1288          ("%T" . "%H:%M:%S")
1289          ("%U\\|%W" . "%V")           ; week no. starting on Sun./Mon.
1290          ("%Z" . "")                  ; time zone name
1291          ("%c" . "%Y-%M-%d %a %H:%M" ) ; locale's date and time format
1292          ("%g" . "%y")
1293          ("%X" . "%x" )  ; locale's pref. time format
1294          ("%j" . "")     ; day of the year
1295          ("%l" . "%k")   ; like %I blank-padded
1296          ("%s" . "")     ; no. of secs since 1970-01-01 00:00:00 +0000
1297          ("%n" . "<text:line-break/>")
1298          ("%r" . "%I:%M:%S %p")
1299          ("%t" . "<text:tab/>")
1300          ("%u\\|%w" . "")  ; numeric day of week - Mon (1-7), Sun(0-6)
1301          ("%x" . "%Y-%M-%d %a")         ; locale's pref. time format
1302          ("%z" . "")                    ; time zone in numeric form
1303          ))
1304       (while (string-match re fmt start)
1305         (setq match (match-string 0 fmt))
1306         (setq rpl (assoc-default match fmt-alist))
1307         (setq start (match-end 0))
1308         (setq filler-end (match-beginning 0))
1309         (setq filler (substring fmt (prog1 filler-beg
1310                                       (setq filler-beg (match-end 0)))
1311                                 filler-end))
1312         (setq filler (and (not (string= filler ""))
1313                           (format "<number:text>%s</number:text>"
1314                                   (org-odt--encode-plain-text filler))))
1315         (setq output (concat output "\n" filler "\n" rpl)))
1316       (setq filler (substring fmt filler-beg))
1317       (unless (string= filler "")
1318         (setq output (concat output
1319                              (format "\n<number:text>%s</number:text>"
1320                                      (org-odt--encode-plain-text filler)))))
1321       (format "\n<number:date-style style:name=\"%s\" %s>%s\n</number:date-style>"
1322               style
1323               (concat " number:automatic-order=\"true\""
1324                       " number:format-source=\"fixed\"")
1325               output ))))
1326
1327 (defun org-odt-template (contents info)
1328   "Return complete document string after ODT conversion.
1329 CONTENTS is the transcoded contents string.  RAW-DATA is the
1330 original parsed data.  INFO is a plist holding export options."
1331   ;; Write meta file.
1332   (let ((title (org-export-data (plist-get info :title) info))
1333         (subtitle (org-export-data (plist-get info :subtitle) info))
1334         (author (let ((author (plist-get info :author)))
1335                   (if (not author) "" (org-export-data author info))))
1336         (email (plist-get info :email))
1337         (keywords (or (plist-get info :keywords) ""))
1338         (description (or (plist-get info :description) "")))
1339     (write-region
1340      (concat
1341       "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
1342      <office:document-meta
1343          xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
1344          xmlns:xlink=\"http://www.w3.org/1999/xlink\"
1345          xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
1346          xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
1347          xmlns:ooo=\"http://openoffice.org/2004/office\"
1348          office:version=\"1.2\">
1349        <office:meta>\n"
1350       (format "<dc:creator>%s</dc:creator>\n" author)
1351       (format "<meta:initial-creator>%s</meta:initial-creator>\n" author)
1352       ;; Date, if required.
1353       (when (plist-get info :with-date)
1354         ;; Check if DATE is specified as an Org-timestamp.  If yes,
1355         ;; include it as meta information.  Otherwise, just use
1356         ;; today's date.
1357         (let* ((date (let ((date (plist-get info :date)))
1358                        (and (not (cdr date))
1359                             (eq (org-element-type (car date)) 'timestamp)
1360                             (car date)))))
1361           (let ((iso-date (org-odt--format-timestamp date nil 'iso-date)))
1362             (concat
1363              (format "<dc:date>%s</dc:date>\n" iso-date)
1364              (format "<meta:creation-date>%s</meta:creation-date>\n"
1365                      iso-date)))))
1366       (format "<meta:generator>%s</meta:generator>\n"
1367               (plist-get info :creator))
1368       (format "<meta:keyword>%s</meta:keyword>\n" keywords)
1369       (format "<dc:subject>%s</dc:subject>\n" description)
1370       (format "<dc:title>%s</dc:title>\n" title)
1371       (when (org-string-nw-p subtitle)
1372         (format
1373          "<meta:user-defined meta:name=\"subtitle\">%s</meta:user-defined>\n"
1374          subtitle))
1375       "\n"
1376       "  </office:meta>\n" "</office:document-meta>")
1377      nil (concat org-odt-zip-dir "meta.xml"))
1378     ;; Add meta.xml in to manifest.
1379     (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
1380
1381   ;; Update styles file.
1382   ;; Copy styles.xml.  Also dump htmlfontify styles, if there is any.
1383   ;; Write styles file.
1384   (let* ((styles-file (plist-get info :odt-styles-file))
1385          (styles-file (and styles-file (read (org-trim styles-file))))
1386          ;; Non-availability of styles.xml is not a critical
1387          ;; error. For now, throw an error.
1388          (styles-file (or styles-file
1389                           (plist-get info :odt-styles-file)
1390                           (expand-file-name "OrgOdtStyles.xml"
1391                                             org-odt-styles-dir)
1392                           (error "org-odt: Missing styles file?"))))
1393     (cond
1394      ((listp styles-file)
1395       (let ((archive (nth 0 styles-file))
1396             (members (nth 1 styles-file)))
1397         (org-odt--zip-extract archive members org-odt-zip-dir)
1398         (mapc
1399          (lambda (member)
1400            (when (org-file-image-p member)
1401              (let* ((image-type (file-name-extension member))
1402                     (media-type (format "image/%s" image-type)))
1403                (org-odt-create-manifest-file-entry media-type member))))
1404          members)))
1405      ((and (stringp styles-file) (file-exists-p styles-file))
1406       (let ((styles-file-type (file-name-extension styles-file)))
1407         (cond
1408          ((string= styles-file-type "xml")
1409           (copy-file styles-file (concat org-odt-zip-dir "styles.xml") t))
1410          ((member styles-file-type '("odt" "ott"))
1411           (org-odt--zip-extract styles-file "styles.xml" org-odt-zip-dir)))))
1412      (t
1413       (error "Invalid specification of styles.xml file: %S"
1414              (plist-get info :odt-styles-file))))
1415
1416     ;; create a manifest entry for styles.xml
1417     (org-odt-create-manifest-file-entry "text/xml" "styles.xml")
1418
1419     ;; FIXME: Who is opening an empty styles.xml before this point?
1420     (with-current-buffer
1421         (find-file-noselect (concat org-odt-zip-dir "styles.xml") t)
1422       (revert-buffer t t)
1423
1424       ;; Write custom styles for source blocks
1425       ;; Save STYLES used for colorizing of source blocks.
1426       ;; Update styles.xml with styles that were collected as part of
1427       ;; `org-odt-hfy-face-to-css' callbacks.
1428       (let ((styles (mapconcat (lambda (style) (format " %s\n" (cddr style)))
1429                                hfy-user-sheet-assoc "")))
1430         (when styles
1431           (goto-char (point-min))
1432           (when (re-search-forward "</office:styles>" nil t)
1433             (goto-char (match-beginning 0))
1434             (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n"))))
1435
1436       ;; Update styles.xml - take care of outline numbering
1437
1438       ;; Don't make automatic backup of styles.xml file. This setting
1439       ;; prevents the backed-up styles.xml file from being zipped in to
1440       ;; odt file. This is more of a hackish fix. Better alternative
1441       ;; would be to fix the zip command so that the output odt file
1442       ;; includes only the needed files and excludes any auto-generated
1443       ;; extra files like backups and auto-saves etc etc. Note that
1444       ;; currently the zip command zips up the entire temp directory so
1445       ;; that any auto-generated files created under the hood ends up in
1446       ;; the resulting odt file.
1447       (set (make-local-variable 'backup-inhibited) t)
1448
1449       ;; Outline numbering is retained only upto LEVEL.
1450       ;; To disable outline numbering pass a LEVEL of 0.
1451
1452       (goto-char (point-min))
1453       (let ((regex
1454              "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
1455             (replacement
1456              "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
1457         (while (re-search-forward regex nil t)
1458           (unless (let ((sec-num (plist-get info :section-numbers))
1459                         (level (string-to-number (match-string 2))))
1460                     (if (wholenump sec-num) (<= level sec-num) sec-num))
1461             (replace-match replacement t nil))))
1462       (save-buffer 0)))
1463   ;; Update content.xml.
1464
1465   (let* ( ;; `org-display-custom-times' should be accessed right
1466          ;; within the context of the Org buffer.  So obtain its
1467          ;; value before moving on to temp-buffer context down below.
1468          (custom-time-fmts
1469           (if org-display-custom-times
1470               (cons (substring (car org-time-stamp-custom-formats) 1 -1)
1471                     (substring (cdr org-time-stamp-custom-formats) 1 -1))
1472             '("%Y-%M-%d %a" . "%Y-%M-%d %a %H:%M"))))
1473     (with-temp-buffer
1474       (insert-file-contents
1475        (or (plist-get info :odt-content-template-file)
1476            (expand-file-name "OrgOdtContentTemplate.xml"
1477                              org-odt-styles-dir)))
1478       ;; Write automatic styles.
1479       ;; - Position the cursor.
1480       (goto-char (point-min))
1481       (re-search-forward "  </office:automatic-styles>" nil t)
1482       (goto-char (match-beginning 0))
1483       ;; - Dump automatic table styles.
1484       (loop for (style-name props) in
1485             (plist-get org-odt-automatic-styles 'Table) do
1486             (when (setq props (or (plist-get props :rel-width) "96"))
1487               (insert (format org-odt-table-style-format style-name props))))
1488       ;; - Dump date-styles.
1489       (when (plist-get info :odt-use-date-fields)
1490         (insert (org-odt--build-date-styles (car custom-time-fmts)
1491                                               "OrgDate1")
1492                 (org-odt--build-date-styles (cdr custom-time-fmts)
1493                                               "OrgDate2")))
1494       ;; Update display level.
1495       ;; - Remove existing sequence decls.  Also position the cursor.
1496       (goto-char (point-min))
1497       (when (re-search-forward "<text:sequence-decls" nil t)
1498         (delete-region (match-beginning 0)
1499                        (re-search-forward "</text:sequence-decls>" nil nil)))
1500       ;; Update sequence decls according to user preference.
1501       (insert
1502        (format
1503         "\n<text:sequence-decls>\n%s\n</text:sequence-decls>"
1504         (mapconcat
1505          (lambda (x)
1506            (format
1507             "<text:sequence-decl text:display-outline-level=\"%d\" text:name=\"%s\"/>"
1508             (plist-get info :odt-display-outline-level)
1509             (nth 1 x)))
1510          org-odt-category-map-alist "\n")))
1511       ;; Position the cursor to document body.
1512       (goto-char (point-min))
1513       (re-search-forward "</office:text>" nil nil)
1514       (goto-char (match-beginning 0))
1515
1516       ;; Preamble - Title, Author, Date etc.
1517       (insert
1518        (let* ((title (and (plist-get info :with-title)
1519                           (org-export-data (plist-get info :title) info)))
1520               (subtitle (when title
1521                           (org-export-data (plist-get info :subtitle) info)))
1522               (author (and (plist-get info :with-author)
1523                            (let ((auth (plist-get info :author)))
1524                              (and auth (org-export-data auth info)))))
1525               (email (plist-get info :email))
1526               ;; Switch on or off above vars based on user settings
1527               (author (and (plist-get info :with-author) (or author email)))
1528               (email (and (plist-get info :with-email) email)))
1529          (concat
1530           ;; Title.
1531           (when (org-string-nw-p title)
1532             (concat
1533              (format "\n<text:p text:style-name=\"%s\">%s</text:p>\n"
1534                      "OrgTitle" (format "\n<text:title>%s</text:title>" title))
1535              ;; Separator.
1536              "\n<text:p text:style-name=\"OrgTitle\"/>\n"
1537              ;; Subtitle.
1538              (when (org-string-nw-p subtitle)
1539                (concat
1540                 (format "<text:p text:style-name=\"OrgSubtitle\">\n%s\n</text:p>\n"
1541                         (concat
1542                          "<text:user-defined style:data-style-name=\"N0\" text:name=\"subtitle\">\n"
1543                          subtitle
1544                          "</text:user-defined>\n"))
1545                 ;; Separator.
1546                 "<text:p text:style-name=\"OrgSubtitle\"/>\n"))))
1547           (cond
1548            ((and author (not email))
1549             ;; Author only.
1550             (concat
1551              (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1552                      "OrgSubtitle"
1553                      (format "<text:initial-creator>%s</text:initial-creator>" author))
1554              ;; Separator.
1555              "\n<text:p text:style-name=\"OrgSubtitle\"/>"))
1556            ((and author email)
1557             ;; Author and E-mail.
1558             (concat
1559              (format
1560               "\n<text:p text:style-name=\"%s\">%s</text:p>"
1561               "OrgSubtitle"
1562               (format
1563                "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
1564                (concat "mailto:" email)
1565                (format "<text:initial-creator>%s</text:initial-creator>" author)))
1566              ;; Separator.
1567              "\n<text:p text:style-name=\"OrgSubtitle\"/>")))
1568           ;; Date, if required.
1569           (when (plist-get info :with-date)
1570             (let* ((date (plist-get info :date))
1571                    ;; Check if DATE is specified as a timestamp.
1572                    (timestamp (and (not (cdr date))
1573                                    (eq (org-element-type (car date)) 'timestamp)
1574                                    (car date))))
1575               (when date
1576                 (concat
1577                  (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1578                          "OrgSubtitle"
1579                          (if (and (plist-get info :odt-use-date-fields) timestamp)
1580                              (org-odt--format-timestamp (car date))
1581                            (org-export-data date info)))
1582                  ;; Separator
1583                  "<text:p text:style-name=\"OrgSubtitle\"/>")))))))
1584       ;; Table of Contents
1585       (let* ((with-toc (plist-get info :with-toc))
1586              (depth (and with-toc (if (wholenump with-toc)
1587                                       with-toc
1588                                     (plist-get info :headline-levels)))))
1589         (when depth (insert (or (org-odt-toc depth info) ""))))
1590       ;; Contents.
1591       (insert contents)
1592       ;; Return contents.
1593       (buffer-substring-no-properties (point-min) (point-max)))))
1594
1595
1596 \f
1597 ;;; Transcode Functions
1598
1599 ;;;; Bold
1600
1601 (defun org-odt-bold (bold contents info)
1602   "Transcode BOLD from Org to ODT.
1603 CONTENTS is the text with bold markup.  INFO is a plist holding
1604 contextual information."
1605   (format "<text:span text:style-name=\"%s\">%s</text:span>"
1606           "Bold" contents))
1607
1608
1609 ;;;; Center Block
1610
1611 (defun org-odt-center-block (center-block contents info)
1612   "Transcode a CENTER-BLOCK element from Org to ODT.
1613 CONTENTS holds the contents of the center block.  INFO is a plist
1614 holding contextual information."
1615   contents)
1616
1617
1618 ;;;; Clock
1619
1620 (defun org-odt-clock (clock contents info)
1621   "Transcode a CLOCK element from Org to ODT.
1622 CONTENTS is nil.  INFO is a plist used as a communication
1623 channel."
1624   (let ((timestamp (org-element-property :value clock))
1625         (duration (org-element-property :duration clock)))
1626     (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1627             (if (eq (org-element-type (org-export-get-next-element clock info))
1628                     'clock) "OrgClock" "OrgClockLastLine")
1629             (concat
1630              (format "<text:span text:style-name=\"%s\">%s</text:span>"
1631                      "OrgClockKeyword" org-clock-string)
1632              (org-odt-timestamp timestamp contents info)
1633              (and duration (format " (%s)" duration))))))
1634
1635
1636 ;;;; Code
1637
1638 (defun org-odt-code (code contents info)
1639   "Transcode a CODE object from Org to ODT.
1640 CONTENTS is nil.  INFO is a plist used as a communication
1641 channel."
1642   (format "<text:span text:style-name=\"%s\">%s</text:span>"
1643           "OrgCode" (org-odt--encode-plain-text
1644                      (org-element-property :value code))))
1645
1646
1647 ;;;; Comment
1648
1649 ;; Comments are ignored.
1650
1651
1652 ;;;; Comment Block
1653
1654 ;; Comment Blocks are ignored.
1655
1656
1657 ;;;; Drawer
1658
1659 (defun org-odt-drawer (drawer contents info)
1660   "Transcode a DRAWER element from Org to ODT.
1661 CONTENTS holds the contents of the block.  INFO is a plist
1662 holding contextual information."
1663   (let* ((name (org-element-property :drawer-name drawer))
1664          (output (funcall (plist-get info :odt-format-drawer-function)
1665                           name contents)))
1666     output))
1667
1668
1669 ;;;; Dynamic Block
1670
1671 (defun org-odt-dynamic-block (dynamic-block contents info)
1672   "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1673 CONTENTS holds the contents of the block.  INFO is a plist
1674 holding contextual information.  See `org-export-data'."
1675   contents)
1676
1677
1678 ;;;; Entity
1679
1680 (defun org-odt-entity (entity contents info)
1681   "Transcode an ENTITY object from Org to ODT.
1682 CONTENTS are the definition itself.  INFO is a plist holding
1683 contextual information."
1684   (org-element-property :utf-8 entity))
1685
1686
1687 ;;;; Example Block
1688
1689 (defun org-odt-example-block (example-block contents info)
1690   "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1691 CONTENTS is nil.  INFO is a plist holding contextual information."
1692   (org-odt-format-code example-block info))
1693
1694
1695 ;;;; Export Snippet
1696
1697 (defun org-odt-export-snippet (export-snippet contents info)
1698   "Transcode a EXPORT-SNIPPET object from Org to ODT.
1699 CONTENTS is nil.  INFO is a plist holding contextual information."
1700   (when (eq (org-export-snippet-backend export-snippet) 'odt)
1701     (org-element-property :value export-snippet)))
1702
1703
1704 ;;;; Export Block
1705
1706 (defun org-odt-export-block (export-block contents info)
1707   "Transcode a EXPORT-BLOCK element from Org to ODT.
1708 CONTENTS is nil.  INFO is a plist holding contextual information."
1709   (when (string= (org-element-property :type export-block) "ODT")
1710     (org-remove-indentation (org-element-property :value export-block))))
1711
1712
1713 ;;;; Fixed Width
1714
1715 (defun org-odt-fixed-width (fixed-width contents info)
1716   "Transcode a FIXED-WIDTH element from Org to ODT.
1717 CONTENTS is nil.  INFO is a plist holding contextual information."
1718   (org-odt-do-format-code (org-element-property :value fixed-width) info))
1719
1720
1721 ;;;; Footnote Definition
1722
1723 ;; Footnote Definitions are ignored.
1724
1725
1726 ;;;; Footnote Reference
1727
1728 (defun org-odt-footnote-reference (footnote-reference contents info)
1729   "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1730 CONTENTS is nil.  INFO is a plist holding contextual information."
1731   (let ((--format-footnote-definition
1732          (function
1733           (lambda (n def)
1734             (setq n (format "%d" n))
1735             (let ((id (concat  "fn" n))
1736                   (note-class "footnote")
1737                   (par-style "Footnote"))
1738               (format
1739                "<text:note text:id=\"%s\" text:note-class=\"%s\">%s</text:note>"
1740                id note-class
1741                (concat
1742                 (format "<text:note-citation>%s</text:note-citation>" n)
1743                 (format "<text:note-body>%s</text:note-body>" def)))))))
1744         (--format-footnote-reference
1745          (function
1746           (lambda (n)
1747             (setq n (format "%d" n))
1748             (let ((note-class "footnote")
1749                   (ref-format "text")
1750                   (ref-name (concat "fn" n)))
1751               (format
1752                "<text:span text:style-name=\"%s\">%s</text:span>"
1753                "OrgSuperscript"
1754                (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1755                        note-class ref-format ref-name n)))))))
1756     (concat
1757      ;; Insert separator between two footnotes in a row.
1758      (let ((prev (org-export-get-previous-element footnote-reference info)))
1759        (and (eq (org-element-type prev) 'footnote-reference)
1760             (format "<text:span text:style-name=\"%s\">%s</text:span>"
1761                     "OrgSuperscript" ",")))
1762      ;; Transcode footnote reference.
1763      (let ((n (org-export-get-footnote-number footnote-reference info nil t)))
1764        (cond
1765         ((not
1766           (org-export-footnote-first-reference-p footnote-reference info nil t))
1767          (funcall --format-footnote-reference n))
1768         (t
1769          (let* ((raw (org-export-get-footnote-definition
1770                       footnote-reference info))
1771                 (def
1772                  (let ((def (org-trim
1773                              (org-export-data-with-backend
1774                               raw
1775                               (org-export-create-backend
1776                                :parent 'odt
1777                                :transcoders
1778                                '((paragraph . (lambda (p c i)
1779                                                 (org-odt--format-paragraph
1780                                                  p c i
1781                                                  "Footnote"
1782                                                  "OrgFootnoteCenter"
1783                                                  "OrgFootnoteQuotations")))))
1784                               info))))
1785                    ;; Inline definitions are secondary strings.  We
1786                    ;; need to wrap them within a paragraph.
1787                    (if (memq (org-element-type (car (org-element-contents raw)))
1788                              org-element-all-elements)
1789                        def
1790                      (format
1791                       "\n<text:p text:style-name=\"Footnote\">%s</text:p>"
1792                       def)))))
1793            (funcall --format-footnote-definition n def))))))))
1794
1795
1796 ;;;; Headline
1797
1798 (defun org-odt-format-headline--wrap (headline backend info
1799                                                &optional format-function
1800                                                &rest extra-keys)
1801   "Transcode a HEADLINE element using BACKEND.
1802 INFO is a plist holding contextual information."
1803   (setq backend (or backend (plist-get info :back-end)))
1804   (let* ((level (+ (org-export-get-relative-level headline info)))
1805          (headline-number (org-export-get-headline-number headline info))
1806          (section-number (and (org-export-numbered-headline-p headline info)
1807                               (mapconcat 'number-to-string
1808                                          headline-number ".")))
1809          (todo (and (plist-get info :with-todo-keywords)
1810                     (let ((todo (org-element-property :todo-keyword headline)))
1811                       (and todo
1812                            (org-export-data-with-backend todo backend info)))))
1813          (todo-type (and todo (org-element-property :todo-type headline)))
1814          (priority (and (plist-get info :with-priority)
1815                         (org-element-property :priority headline)))
1816          (text (org-export-data-with-backend
1817                 (org-element-property :title headline) backend info))
1818          (tags (and (plist-get info :with-tags)
1819                     (org-export-get-tags headline info)))
1820          (headline-label (org-export-get-reference headline info))
1821          (format-function
1822           (if (functionp format-function) format-function
1823             (function*
1824              (lambda (todo todo-type priority text tags
1825                            &key level section-number headline-label
1826                            &allow-other-keys)
1827                (funcall (plist-get info :odt-format-headline-function)
1828                         todo todo-type priority text tags))))))
1829     (apply format-function
1830            todo todo-type priority text tags
1831            :headline-label headline-label :level level
1832            :section-number section-number extra-keys)))
1833
1834 (defun org-odt-headline (headline contents info)
1835   "Transcode a HEADLINE element from Org to ODT.
1836 CONTENTS holds the contents of the headline.  INFO is a plist
1837 holding contextual information."
1838   ;; Case 1: This is a footnote section: ignore it.
1839   (unless (org-element-property :footnote-section-p headline)
1840     (let* ((text (org-export-data (org-element-property :title headline) info))
1841            ;; Create the headline text.
1842            (full-text (org-odt-format-headline--wrap headline nil info))
1843            ;; Get level relative to current parsed data.
1844            (level (org-export-get-relative-level headline info))
1845            (numbered (org-export-numbered-headline-p headline info))
1846            ;; Get canonical label for the headline.
1847            (id (org-export-get-reference headline info))
1848            ;; Extra targets.
1849            (extra-targets
1850             (let ((id (org-element-property :ID headline)))
1851               (if id (org-odt--target "" (concat "ID-" id)) "")))
1852            ;; Title.
1853            (anchored-title (org-odt--target full-text id)))
1854       (cond
1855        ;; Case 2. This is a deep sub-tree: export it as a list item.
1856        ;;         Also export as items headlines for which no section
1857        ;;         format has been found.
1858        ((org-export-low-level-p headline info)
1859         ;; Build the real contents of the sub-tree.
1860         (concat
1861          (and (org-export-first-sibling-p headline info)
1862               (format "\n<text:list text:style-name=\"%s\" %s>"
1863                       ;; Choose style based on list type.
1864                       (if numbered "OrgNumberedList" "OrgBulletedList")
1865                       ;; If top-level list, re-start numbering.  Otherwise,
1866                       ;; continue numbering.
1867                       (format "text:continue-numbering=\"%s\""
1868                               (let* ((parent (org-export-get-parent-headline
1869                                               headline)))
1870                                 (if (and parent
1871                                          (org-export-low-level-p parent info))
1872                                     "true" "false")))))
1873          (let ((headline-has-table-p
1874                 (let ((section (assq 'section (org-element-contents headline))))
1875                   (assq 'table (and section (org-element-contents section))))))
1876            (format "\n<text:list-item>\n%s\n%s"
1877                    (concat
1878                     (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1879                             "Text_20_body"
1880                             (concat extra-targets anchored-title))
1881                     contents)
1882                    (if headline-has-table-p
1883                        "</text:list-header>"
1884                      "</text:list-item>")))
1885          (and (org-export-last-sibling-p headline info)
1886               "</text:list>")))
1887        ;; Case 3. Standard headline.  Export it as a section.
1888        (t
1889         (concat
1890          (format
1891           "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1892           (format "Heading_20_%s%s"
1893                   level (if numbered "" "_unnumbered"))
1894           level
1895           (if numbered "false" "true")
1896           (concat extra-targets anchored-title))
1897          contents))))))
1898
1899 (defun org-odt-format-headline-default-function
1900   (todo todo-type priority text tags)
1901   "Default format function for a headline.
1902 See `org-odt-format-headline-function' for details."
1903   (concat
1904    ;; Todo.
1905    (when todo
1906      (let ((style (if (eq todo-type 'done) "OrgDone" "OrgTodo")))
1907        (format "<text:span text:style-name=\"%s\">%s</text:span> " style todo)))
1908    (when priority
1909      (let* ((style (format "OrgPriority-%s" priority))
1910             (priority (format "[#%c]" priority)))
1911        (format "<text:span text:style-name=\"%s\">%s</text:span> "
1912                style priority)))
1913    ;; Title.
1914    text
1915    ;; Tags.
1916    (when tags
1917      (concat
1918       "<text:tab/>"
1919       (format "<text:span text:style-name=\"%s\">[%s]</text:span>"
1920               "OrgTags" (mapconcat
1921                          (lambda (tag)
1922                            (format
1923                             "<text:span text:style-name=\"%s\">%s</text:span>"
1924                             "OrgTag" tag)) tags " : "))))))
1925
1926
1927 ;;;; Horizontal Rule
1928
1929 (defun org-odt-horizontal-rule (horizontal-rule contents info)
1930   "Transcode an HORIZONTAL-RULE  object from Org to ODT.
1931 CONTENTS is nil.  INFO is a plist holding contextual information."
1932   (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1933           "Horizontal_20_Line" ""))
1934
1935
1936 ;;;; Inline Babel Call
1937
1938 ;; Inline Babel Calls are ignored.
1939
1940
1941 ;;;; Inline Src Block
1942
1943 (defun org-odt--find-verb-separator (s)
1944   "Return a character not used in string S.
1945 This is used to choose a separator for constructs like \\verb."
1946   (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1947     (loop for c across ll
1948           when (not (string-match (regexp-quote (char-to-string c)) s))
1949           return (char-to-string c))))
1950
1951 (defun org-odt-inline-src-block (inline-src-block contents info)
1952   "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1953 CONTENTS holds the contents of the item.  INFO is a plist holding
1954 contextual information."
1955   (let* ((org-lang (org-element-property :language inline-src-block))
1956          (code (org-element-property :value inline-src-block))
1957          (separator (org-odt--find-verb-separator code)))
1958     (error "FIXME")))
1959
1960
1961 ;;;; Inlinetask
1962
1963 (defun org-odt-inlinetask (inlinetask contents info)
1964   "Transcode an INLINETASK element from Org to ODT.
1965 CONTENTS holds the contents of the block.  INFO is a plist
1966 holding contextual information."
1967   (let* ((todo
1968           (and (plist-get info :with-todo-keywords)
1969                (let ((todo (org-element-property :todo-keyword inlinetask)))
1970                  (and todo (org-export-data todo info)))))
1971          (todo-type (and todo (org-element-property :todo-type inlinetask)))
1972          (priority (and (plist-get info :with-priority)
1973                         (org-element-property :priority inlinetask)))
1974          (text (org-export-data (org-element-property :title inlinetask) info))
1975          (tags (and (plist-get info :with-tags)
1976                     (org-export-get-tags inlinetask info))))
1977     (funcall (plist-get info :odt-format-inlinetask-function)
1978              todo todo-type priority text tags contents)))
1979
1980 (defun org-odt-format-inlinetask-default-function
1981   (todo todo-type priority name tags contents)
1982   "Default format function for a inlinetasks.
1983 See `org-odt-format-inlinetask-function' for details."
1984   (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1985           "Text_20_body"
1986           (org-odt--textbox
1987            (concat
1988             (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1989                     "OrgInlineTaskHeading"
1990                     (org-odt-format-headline-default-function
1991                      todo todo-type priority name tags))
1992             contents)
1993            nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
1994
1995 ;;;; Italic
1996
1997 (defun org-odt-italic (italic contents info)
1998   "Transcode ITALIC from Org to ODT.
1999 CONTENTS is the text with italic markup.  INFO is a plist holding
2000 contextual information."
2001   (format "<text:span text:style-name=\"%s\">%s</text:span>"
2002           "Emphasis" contents))
2003
2004
2005 ;;;; Item
2006
2007 (defun org-odt-item (item contents info)
2008   "Transcode an ITEM element from Org to ODT.
2009 CONTENTS holds the contents of the item.  INFO is a plist holding
2010 contextual information."
2011   (let* ((plain-list (org-export-get-parent item))
2012          (type (org-element-property :type plain-list))
2013          (counter (org-element-property :counter item))
2014          (tag (let ((tag (org-element-property :tag item)))
2015                 (and tag
2016                      (concat (org-odt--checkbox item)
2017                              (org-export-data tag info))))))
2018     (case type
2019       ((ordered unordered descriptive-1 descriptive-2)
2020        (format "\n<text:list-item>\n%s\n%s"
2021                contents
2022                (let* ((--element-has-a-table-p
2023                        (function
2024                         (lambda (element info)
2025                           (loop for el in (org-element-contents element)
2026                                 thereis (eq (org-element-type el) 'table))))))
2027                  (cond
2028                   ((funcall --element-has-a-table-p item info)
2029                    "</text:list-header>")
2030                   (t "</text:list-item>")))))
2031       (t (error "Unknown list type: %S" type)))))
2032
2033 ;;;; Keyword
2034
2035 (defun org-odt-keyword (keyword contents info)
2036   "Transcode a KEYWORD element from Org to ODT.
2037 CONTENTS is nil.  INFO is a plist holding contextual
2038 information."
2039   (let ((key (org-element-property :key keyword))
2040         (value (org-element-property :value keyword)))
2041     (cond
2042      ((string= key "ODT") value)
2043      ((string= key "INDEX")
2044       ;; FIXME
2045       (ignore))
2046      ((string= key "TOC")
2047       (let ((case-fold-search t))
2048         (cond
2049          ((org-string-match-p "\\<headlines\\>" value)
2050           (let ((depth (or (and (string-match "\\<[0-9]+\\>" value)
2051                                 (string-to-number (match-string 0 value)))
2052                            (plist-get info :headline-levels)))
2053                 (localp (org-string-match-p "\\<local\\>" value)))
2054             (org-odt-toc depth info (and localp keyword))))
2055          ((org-string-match-p "tables\\|figures\\|listings" value)
2056           ;; FIXME
2057           (ignore))))))))
2058
2059
2060 ;;;; Latex Environment
2061
2062
2063 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2064 ;; (defadvice org-format-latex-as-mathml        ; FIXME
2065 ;;   (after org-odt-protect-latex-fragment activate)
2066 ;;   "Encode LaTeX fragment as XML.
2067 ;; Do this when translation to MathML fails."
2068 ;;   (unless (> (length ad-return-value) 0)
2069 ;;     (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2070
2071 (defun org-odt-latex-environment (latex-environment contents info)
2072   "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2073 CONTENTS is nil.  INFO is a plist holding contextual information."
2074   (let* ((latex-frag (org-remove-indentation
2075                       (org-element-property :value latex-environment))))
2076     (org-odt-do-format-code latex-frag info)))
2077
2078
2079 ;;;; Latex Fragment
2080
2081 ;; (when latex-frag                     ; FIXME
2082 ;;      (setq href (org-propertize href :title "LaTeX Fragment"
2083 ;;                                 :description latex-frag)))
2084 ;; handle verbatim
2085 ;; provide descriptions
2086
2087 (defun org-odt-latex-fragment (latex-fragment contents info)
2088   "Transcode a LATEX-FRAGMENT object from Org to ODT.
2089 CONTENTS is nil.  INFO is a plist holding contextual information."
2090   (let* ((latex-frag (org-element-property :value latex-fragment))
2091          (processing-type (plist-get info :with-latex)))
2092     (format "<text:span text:style-name=\"%s\">%s</text:span>"
2093             "OrgCode" (org-odt--encode-plain-text latex-frag t))))
2094
2095
2096 ;;;; Line Break
2097
2098 (defun org-odt-line-break (line-break contents info)
2099   "Transcode a LINE-BREAK object from Org to ODT.
2100 CONTENTS is nil.  INFO is a plist holding contextual information."
2101   "<text:line-break/>")
2102
2103
2104 ;;;; Link
2105
2106 ;;;; Links :: Label references
2107
2108 (defun org-odt--enumerate (element info &optional predicate n)
2109   (when predicate (assert (funcall predicate element info)))
2110   (let* ((--numbered-parent-headline-at-<=-n
2111           (function
2112            (lambda (element n info)
2113              (loop for x in (org-element-lineage element)
2114                    thereis (and (eq (org-element-type x) 'headline)
2115                                 (<= (org-export-get-relative-level x info) n)
2116                                 (org-export-numbered-headline-p x info)
2117                                 x)))))
2118          (--enumerate
2119           (function
2120            (lambda (element scope info &optional predicate)
2121              (let ((counter 0))
2122                (org-element-map (or scope (plist-get info :parse-tree))
2123                    (org-element-type element)
2124                  (lambda (el)
2125                    (and (or (not predicate) (funcall predicate el info))
2126                         (incf counter)
2127                         (eq element el)
2128                         counter))
2129                  info 'first-match)))))
2130          (scope (funcall --numbered-parent-headline-at-<=-n
2131                          element
2132                          (or n (plist-get info :odt-display-outline-level))
2133                          info))
2134          (ordinal (funcall --enumerate element scope info predicate))
2135          (tag
2136           (concat
2137            ;; Section number.
2138            (and scope
2139                 (mapconcat 'number-to-string
2140                            (org-export-get-headline-number scope info) "."))
2141            ;; Separator.
2142            (and scope ".")
2143            ;; Ordinal.
2144            (number-to-string ordinal))))
2145     tag))
2146
2147 (defun org-odt-format-label (element info op)
2148   "Return a label for ELEMENT.
2149
2150 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2151 element.  INFO is a plist used as a communication channel.  OP is
2152 either `definition' or `reference', depending on the purpose of
2153 the generated string.
2154
2155 Return value is a string if OP is set to `reference' or a cons
2156 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2157 SHORT-CAPTION are strings."
2158   (assert (memq (org-element-type element) '(link table src-block paragraph)))
2159   (let* ((element-or-parent
2160           (case (org-element-type element)
2161             (link (org-export-get-parent-element element))
2162             (t element)))
2163          ;; Get label and caption.
2164          (label (and (or (org-element-property :name element)
2165                          (org-element-property :name element-or-parent))
2166                      (org-export-get-reference element-or-parent info)))
2167          (caption (let ((c (org-export-get-caption element-or-parent)))
2168                     (and c (org-export-data c info))))
2169          ;; FIXME: We don't use short-caption for now
2170          (short-caption nil))
2171     (when (or label caption)
2172       (let* ((default-category
2173                (case (org-element-type element)
2174                  (table "__Table__")
2175                  (src-block "__Listing__")
2176                  ((link paragraph)
2177                   (cond
2178                    ((org-odt--enumerable-latex-image-p element info)
2179                     "__DvipngImage__")
2180                    ((org-odt--enumerable-image-p element info)
2181                     "__Figure__")
2182                    ((org-odt--enumerable-formula-p element info)
2183                     "__MathFormula__")
2184                    (t (error "Don't know how to format label for link: %S"
2185                              element))))
2186                  (t (error "Don't know how to format label for element type: %s"
2187                            (org-element-type element)))))
2188              seqno)
2189         (assert default-category)
2190         (destructuring-bind (counter label-style category predicate)
2191             (assoc-default default-category org-odt-category-map-alist)
2192           ;; Compute sequence number of the element.
2193           (setq seqno (org-odt--enumerate element info predicate))
2194           ;; Localize category string.
2195           (setq category (org-export-translate category :utf-8 info))
2196           (case op
2197             ;; Case 1: Handle Label definition.
2198             (definition
2199               (cons
2200                (concat
2201                 ;; Sneak in a bookmark.  The bookmark is used when the
2202                 ;; labeled element is referenced with a link that
2203                 ;; provides its own description.
2204                 (format "\n<text:bookmark text:name=\"%s\"/>" label)
2205                 ;; Label definition: Typically formatted as below:
2206                 ;;     CATEGORY SEQ-NO: LONG CAPTION
2207                 ;; with translation for correct punctuation.
2208                 (format-spec
2209                  (org-export-translate
2210                   (cadr (assoc-string label-style org-odt-label-styles t))
2211                   :utf-8 info)
2212                  `((?e . ,category)
2213                    (?n . ,(format
2214                            "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2215                            label counter counter seqno))
2216                    (?c . ,(or caption "")))))
2217                short-caption))
2218             ;; Case 2: Handle Label reference.
2219             (reference
2220              (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
2221                     (fmt1 (car fmt))
2222                     (fmt2 (cadr fmt)))
2223                (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2224                        fmt1
2225                        label
2226                        (format-spec fmt2 `((?e . ,category) (?n . ,seqno))))))
2227             (t (error "Unknown %S on label" op))))))))
2228
2229
2230 ;;;; Links :: Inline Images
2231
2232 (defun org-odt--copy-image-file (path)
2233   "Returns the internal name of the file"
2234   (let* ((image-type (file-name-extension path))
2235          (media-type (format "image/%s" image-type))
2236          (target-dir "Images/")
2237          (target-file
2238           (format "%s%04d.%s" target-dir
2239                   (incf org-odt-embedded-images-count) image-type)))
2240     (message "Embedding %s as %s..."
2241              (substring-no-properties path) target-file)
2242
2243     (when (= 1 org-odt-embedded-images-count)
2244       (make-directory (concat org-odt-zip-dir target-dir))
2245       (org-odt-create-manifest-file-entry "" target-dir))
2246
2247     (copy-file path (concat org-odt-zip-dir target-file) 'overwrite)
2248     (org-odt-create-manifest-file-entry media-type target-file)
2249     target-file))
2250
2251 (defun org-odt--image-size
2252   (file info &optional user-width user-height scale dpi embed-as)
2253   (let* ((--pixels-to-cms
2254           (function (lambda (pixels dpi)
2255                       (let ((cms-per-inch 2.54)
2256                             (inches (/ pixels dpi)))
2257                         (* cms-per-inch inches)))))
2258          (--size-in-cms
2259           (function
2260            (lambda (size-in-pixels dpi)
2261              (and size-in-pixels
2262                   (cons (funcall --pixels-to-cms (car size-in-pixels) dpi)
2263                         (funcall --pixels-to-cms (cdr size-in-pixels) dpi))))))
2264          (dpi (or dpi (plist-get info :odt-pixels-per-inch)))
2265          (anchor-type (or embed-as "paragraph"))
2266          (user-width (and (not scale) user-width))
2267          (user-height (and (not scale) user-height))
2268          (size
2269           (and
2270            (not (and user-height user-width))
2271            (or
2272             ;; Use Imagemagick.
2273             (and (executable-find "identify")
2274                  (let ((size-in-pixels
2275                         (let ((dim (shell-command-to-string
2276                                     (format "identify -format \"%%w:%%h\" \"%s\""
2277                                             file))))
2278                           (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
2279                             (cons (string-to-number (match-string 1 dim))
2280                                   (string-to-number (match-string 2 dim)))))))
2281                    (funcall --size-in-cms size-in-pixels dpi)))
2282             ;; Use Emacs.
2283             (let ((size-in-pixels
2284                    (ignore-errors       ; Emacs could be in batch mode
2285                      (clear-image-cache)
2286                      (image-size (create-image file) 'pixels))))
2287               (funcall --size-in-cms size-in-pixels dpi))
2288             ;; Use hard-coded values.
2289             (cdr (assoc-string anchor-type
2290                                org-odt-default-image-sizes-alist))
2291             ;; Error out.
2292             (error "Cannot determine image size, aborting"))))
2293          (width (car size)) (height (cdr size)))
2294     (cond
2295      (scale
2296       (setq width (* width scale) height (* height scale)))
2297      ((and user-height user-width)
2298       (setq width user-width height user-height))
2299      (user-height
2300       (setq width (* user-height (/ width height)) height user-height))
2301      (user-width
2302       (setq height (* user-width (/ height width)) width user-width))
2303      (t (ignore)))
2304     ;; ensure that an embedded image fits comfortably within a page
2305     (let ((max-width (car org-odt-max-image-size))
2306           (max-height (cdr org-odt-max-image-size)))
2307       (when (or (> width max-width) (> height max-height))
2308         (let* ((scale1 (/ max-width width))
2309                (scale2 (/ max-height height))
2310                (scale (min scale1 scale2)))
2311           (setq width (* scale width) height (* scale height)))))
2312     (cons width height)))
2313
2314 (defun org-odt-link--inline-image (element info)
2315   "Return ODT code for an inline image.
2316 LINK is the link pointing to the inline image.  INFO is a plist
2317 used as a communication channel."
2318   (assert (eq (org-element-type element) 'link))
2319   (let* ((src (let* ((type (org-element-property :type element))
2320                      (raw-path (org-element-property :path element)))
2321                 (cond ((member type '("http" "https"))
2322                        (concat type ":" raw-path))
2323                       ((file-name-absolute-p raw-path)
2324                        (expand-file-name raw-path))
2325                       (t raw-path))))
2326          (src-expanded (if (file-name-absolute-p src) src
2327                          (expand-file-name src (file-name-directory
2328                                                 (plist-get info :input-file)))))
2329          (href (format
2330                 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2331                 (org-odt--copy-image-file src-expanded)))
2332          ;; Extract attributes from #+ATTR_ODT line.
2333          (attr-from (case (org-element-type element)
2334                       (link (org-export-get-parent-element element))
2335                       (t element)))
2336          ;; Convert attributes to a plist.
2337          (attr-plist (org-export-read-attribute :attr_odt attr-from))
2338          ;; Handle `:anchor', `:style' and `:attributes' properties.
2339          (user-frame-anchor
2340           (car (assoc-string (plist-get attr-plist :anchor)
2341                              '(("as-char") ("paragraph") ("page")) t)))
2342          (user-frame-style
2343           (and user-frame-anchor (plist-get attr-plist :style)))
2344          (user-frame-attrs
2345           (and user-frame-anchor (plist-get attr-plist :attributes)))
2346          (user-frame-params
2347           (list user-frame-style user-frame-attrs user-frame-anchor))
2348          ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2349          ;;
2350          ;; Handle `:width', `:height' and `:scale' properties.  Read
2351          ;; them as numbers since we need them for computations.
2352          (size (org-odt--image-size
2353                 src-expanded info
2354                 (let ((width (plist-get attr-plist :width)))
2355                   (and width (read width)))
2356                 (let ((length (plist-get attr-plist :length)))
2357                   (and length (read length)))
2358                 (let ((scale (plist-get attr-plist :scale)))
2359                   (and scale (read scale)))
2360                 nil                     ; embed-as
2361                 "paragraph"             ; FIXME
2362                 ))
2363          (width (car size)) (height (cdr size))
2364          (standalone-link-p (org-odt--standalone-link-p element info))
2365          (embed-as (if standalone-link-p "paragraph" "as-char"))
2366          (captions (org-odt-format-label element info 'definition))
2367          (caption (car captions)) (short-caption (cdr captions))
2368          (entity (concat (and caption "Captioned") embed-as "Image"))
2369          ;; Check if this link was created by LaTeX-to-PNG converter.
2370          (replaces (org-element-property
2371                     :replaces (if (not standalone-link-p) element
2372                                 (org-export-get-parent-element element))))
2373          ;; If yes, note down the type of the element - LaTeX Fragment
2374          ;; or LaTeX environment.  It will go in to frame title.
2375          (title (and replaces (capitalize
2376                                (symbol-name (org-element-type replaces)))))
2377
2378          ;; If yes, note down its contents.  It will go in to frame
2379          ;; description.  This quite useful for debugging.
2380          (desc (and replaces (org-element-property :value replaces))))
2381     (org-odt--render-image/formula entity href width height
2382                                    captions user-frame-params title desc)))
2383
2384
2385 ;;;; Links :: Math formula
2386
2387 (defun org-odt-link--inline-formula (element info)
2388   (let* ((src (let* ((type (org-element-property :type element))
2389                      (raw-path (org-element-property :path element)))
2390                 (cond
2391                  ((file-name-absolute-p raw-path)
2392                   (expand-file-name raw-path))
2393                  (t raw-path))))
2394          (src-expanded (if (file-name-absolute-p src) src
2395                          (expand-file-name src (file-name-directory
2396                                                 (plist-get info :input-file)))))
2397          (href
2398           (format
2399            "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
2400            " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
2401            (file-name-directory (org-odt--copy-formula-file src-expanded))))
2402          (standalone-link-p (org-odt--standalone-link-p element info))
2403          (embed-as (if standalone-link-p 'paragraph 'character))
2404          (captions (org-odt-format-label element info 'definition))
2405          (caption (car captions)) (short-caption (cdr captions))
2406          ;; Check if this link was created by LaTeX-to-MathML
2407          ;; converter.
2408          (replaces (org-element-property
2409                     :replaces (if (not standalone-link-p) element
2410                                 (org-export-get-parent-element element))))
2411          ;; If yes, note down the type of the element - LaTeX Fragment
2412          ;; or LaTeX environment.  It will go in to frame title.
2413          (title (and replaces (capitalize
2414                                (symbol-name (org-element-type replaces)))))
2415
2416          ;; If yes, note down its contents.  It will go in to frame
2417          ;; description.  This quite useful for debugging.
2418          (desc (and replaces (org-element-property :value replaces)))
2419          width height)
2420     (cond
2421      ((eq embed-as 'character)
2422       (org-odt--render-image/formula "InlineFormula" href width height
2423                                        nil nil title desc))
2424      (t
2425       (let* ((equation (org-odt--render-image/formula
2426                         "CaptionedDisplayFormula" href width height
2427                         captions nil title desc))
2428              (label
2429               (let* ((org-odt-category-map-alist
2430                       '(("__MathFormula__" "Text" "math-label" "Equation"
2431                          org-odt--enumerable-formula-p))))
2432                 (car (org-odt-format-label element info 'definition)))))
2433         (concat equation "<text:tab/>" label))))))
2434
2435 (defun org-odt--copy-formula-file (src-file)
2436   "Returns the internal name of the file"
2437   (let* ((target-dir (format "Formula-%04d/"
2438                              (incf org-odt-embedded-formulas-count)))
2439          (target-file (concat target-dir "content.xml")))
2440     ;; Create a directory for holding formula file.  Also enter it in
2441     ;; to manifest.
2442     (make-directory (concat org-odt-zip-dir target-dir))
2443     (org-odt-create-manifest-file-entry
2444      "application/vnd.oasis.opendocument.formula" target-dir "1.2")
2445     ;; Copy over the formula file from user directory to zip
2446     ;; directory.
2447     (message "Embedding %s as %s..." src-file target-file)
2448     (let ((case-fold-search nil))
2449       (cond
2450        ;; Case 1: Mathml.
2451        ((string-match "\\.\\(mathml\\|mml\\)\\'" src-file)
2452         (copy-file src-file (concat org-odt-zip-dir target-file) 'overwrite))
2453        ;; Case 2: OpenDocument formula.
2454        ((string-match "\\.odf\\'" src-file)
2455         (org-odt--zip-extract src-file "content.xml"
2456                                 (concat org-odt-zip-dir target-dir)))
2457        (t (error "%s is not a formula file" src-file))))
2458     ;; Enter the formula file in to manifest.
2459     (org-odt-create-manifest-file-entry "text/xml" target-file)
2460     target-file))
2461
2462 ;;;; Targets
2463
2464 (defun org-odt--render-image/formula (cfg-key href width height &optional
2465                                                 captions user-frame-params
2466                                                 &rest title-and-desc)
2467   (let* ((frame-cfg-alist
2468           ;; Each element of this alist is of the form (CFG-HANDLE
2469           ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2470
2471           ;; CFG-HANDLE is the key to the alist.
2472
2473           ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2474           ;; frame params for INNER-FRAME and OUTER-FRAME
2475           ;; respectively.  See below.
2476
2477           ;; Configurations that are meant to be applied to
2478           ;; non-captioned image/formula specifies no
2479           ;; OUTER-FRAME-PARAMS.
2480
2481           ;; TERMINOLOGY
2482           ;; ===========
2483           ;; INNER-FRAME :: Frame that directly surrounds an
2484           ;;                image/formula.
2485
2486           ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME.  This
2487           ;;                frame also contains the caption, if any.
2488
2489           ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2490           ;;                 FRAME-ATTRIBUTES FRAME-ANCHOR).  Note
2491           ;;                 that these are the last three arguments
2492           ;;                 to `org-odt--frame'.
2493
2494           ;; Note that an un-captioned image/formula requires just an
2495           ;; INNER-FRAME, while a captioned image/formula requires
2496           ;; both an INNER and an OUTER-FRAME.
2497           '(("As-CharImage" ("OrgInlineImage" nil "as-char"))
2498             ("ParagraphImage" ("OrgDisplayImage" nil "paragraph"))
2499             ("PageImage" ("OrgPageImage" nil "page"))
2500             ("CaptionedAs-CharImage"
2501              ("OrgCaptionedImage"
2502               " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2503              ("OrgInlineImage" nil "as-char"))
2504             ("CaptionedParagraphImage"
2505              ("OrgCaptionedImage"
2506               " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2507              ("OrgImageCaptionFrame" nil "paragraph"))
2508             ("CaptionedPageImage"
2509              ("OrgCaptionedImage"
2510               " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2511              ("OrgPageImageCaptionFrame" nil "page"))
2512             ("InlineFormula" ("OrgInlineFormula" nil "as-char"))
2513             ("DisplayFormula" ("OrgDisplayFormula" nil "as-char"))
2514             ("CaptionedDisplayFormula"
2515              ("OrgCaptionedFormula" nil "paragraph")
2516              ("OrgFormulaCaptionFrame" nil "paragraph"))))
2517          (caption (car captions)) (short-caption (cdr captions))
2518          ;; Retrieve inner and outer frame params, from configuration.
2519          (frame-cfg (assoc-string cfg-key frame-cfg-alist t))
2520          (inner (nth 1 frame-cfg))
2521          (outer (nth 2 frame-cfg))
2522          ;; User-specified frame params (from #+ATTR_ODT spec)
2523          (user user-frame-params)
2524          (--merge-frame-params (function
2525                                 (lambda (default user)
2526                                   "Merge default and user frame params."
2527                                   (if (not user) default
2528                                     (assert (= (length default) 3))
2529                                     (assert (= (length user) 3))
2530                                     (loop for u in user
2531                                           for d in default
2532                                           collect (or u d)))))))
2533     (cond
2534      ;; Case 1: Image/Formula has no caption.
2535      ;;         There is only one frame, one that surrounds the image
2536      ;;         or formula.
2537      ((not caption)
2538       ;; Merge user frame params with that from configuration.
2539       (setq inner (funcall --merge-frame-params inner user))
2540       (apply 'org-odt--frame href width height
2541              (append inner title-and-desc)))
2542      ;; Case 2: Image/Formula is captioned or labeled.
2543      ;;         There are two frames: The inner one surrounds the
2544      ;;         image or formula.  The outer one contains the
2545      ;;         caption/sequence number.
2546      (t
2547       ;; Merge user frame params with outer frame params.
2548       (setq outer (funcall --merge-frame-params outer user))
2549       ;; Short caption, if specified, goes as part of inner frame.
2550       (setq inner (let ((frame-params (copy-sequence inner)))
2551                     (setcar (cdr frame-params)
2552                             (concat
2553                              (cadr frame-params)
2554                              (when short-caption
2555                                (format " draw:name=\"%s\" " short-caption))))
2556                     frame-params))
2557       (apply 'org-odt--textbox
2558              (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2559                      "Illustration"
2560                      (concat
2561                       (apply 'org-odt--frame href width height
2562                              (append inner title-and-desc))
2563                       caption))
2564              width height outer)))))
2565
2566 (defun org-odt--enumerable-p (element info)
2567   ;; Element should have a caption or label.
2568   (or (org-element-property :caption element)
2569       (org-element-property :name element)))
2570
2571 (defun org-odt--enumerable-image-p (element info)
2572   (org-odt--standalone-link-p
2573    element info
2574    ;; Paragraph should have a caption or label.  It SHOULD NOT be a
2575    ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2576    ;; processing.)
2577    (lambda (p)
2578      (and (not (org-element-property :replaces p))
2579           (or (org-element-property :caption p)
2580               (org-element-property :name p))))
2581    ;; Link should point to an image file.
2582    (lambda (l)
2583      (assert (eq (org-element-type l) 'link))
2584      (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
2585
2586 (defun org-odt--enumerable-latex-image-p (element info)
2587   (org-odt--standalone-link-p
2588    element info
2589    ;; Paragraph should have a caption or label.  It SHOULD also be a
2590    ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2591    ;; processing.)
2592    (lambda (p)
2593      (and (org-element-property :replaces p)
2594           (or (org-element-property :caption p)
2595               (org-element-property :name p))))
2596    ;; Link should point to an image file.
2597    (lambda (l)
2598      (assert (eq (org-element-type l) 'link))
2599      (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
2600
2601 (defun org-odt--enumerable-formula-p (element info)
2602   (org-odt--standalone-link-p
2603    element info
2604    ;; Paragraph should have a caption or label.
2605    (lambda (p)
2606      (or (org-element-property :caption p)
2607          (org-element-property :name p)))
2608    ;; Link should point to a MathML or ODF file.
2609    (lambda (l)
2610      (assert (eq (org-element-type l) 'link))
2611      (org-export-inline-image-p l (plist-get info :odt-inline-formula-rules)))))
2612
2613 (defun org-odt--standalone-link-p (element info &optional
2614                                              paragraph-predicate
2615                                              link-predicate)
2616   "Test if ELEMENT is a standalone link for the purpose ODT export.
2617 INFO is a plist holding contextual information.
2618
2619 Return non-nil, if ELEMENT is of type paragraph satisfying
2620 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2621 is a link that satisfies LINK-PREDICATE.
2622
2623 Return non-nil, if ELEMENT is of type link satisfying
2624 LINK-PREDICATE and its containing paragraph satisfies
2625 PARAGRAPH-PREDICATE in addition to having no other content save for
2626 leading and trailing whitespaces.
2627
2628 Return nil, otherwise."
2629   (let ((p (case (org-element-type element)
2630              (paragraph element)
2631              (link (and (or (not link-predicate)
2632                             (funcall link-predicate element))
2633                         (org-export-get-parent element)))
2634              (t nil))))
2635     (when (and p (eq (org-element-type p) 'paragraph))
2636       (when (or (not paragraph-predicate)
2637                 (funcall paragraph-predicate p))
2638         (let ((contents (org-element-contents p)))
2639           (loop for x in contents
2640                 with inline-image-count = 0
2641                 always (case (org-element-type x)
2642                          (plain-text
2643                           (not (org-string-nw-p x)))
2644                          (link
2645                           (and (or (not link-predicate)
2646                                    (funcall link-predicate x))
2647                                (= (incf inline-image-count) 1)))
2648                          (t nil))))))))
2649
2650 (defun org-odt-link--infer-description (destination info)
2651   ;; DESTINATION is a headline or an element (like paragraph,
2652   ;; verse-block etc) to which a "#+NAME: label" can be attached.
2653
2654   ;; Note that labels that are attached to captioned entities - inline
2655   ;; images, math formulae and tables - get resolved as part of
2656   ;; `org-odt-format-label' and `org-odt--enumerate'.
2657
2658   ;; Create a cross-reference to DESTINATION but make best-efforts to
2659   ;; create a *meaningful* description.  Check item numbers, section
2660   ;; number and section title in that order.
2661
2662   ;; NOTE: Counterpart of `org-export-get-ordinal'.
2663   ;; FIXME: Handle footnote-definition footnote-reference?
2664   (let* ((genealogy (org-element-lineage destination))
2665          (data (reverse genealogy))
2666          (label (let ((type (org-element-type destination)))
2667                   (if (memq type '(headline target))
2668                       (org-export-get-reference destination info)
2669                     (error "FIXME: Unable to resolve %S" destination)))))
2670     (or
2671      (let* ( ;; Locate top-level list.
2672             (top-level-list
2673              (loop for x on data
2674                    when (eq (org-element-type (car x)) 'plain-list)
2675                    return x))
2676             ;; Get list item nos.
2677             (item-numbers
2678              (loop for (plain-list item . rest) on top-level-list by #'cddr
2679                    until (not (eq (org-element-type plain-list) 'plain-list))
2680                    collect (when (eq (org-element-property :type
2681                                                            plain-list)
2682                                      'ordered)
2683                              (1+ (length (org-export-get-previous-element
2684                                           item info t))))))
2685             ;; Locate top-most listified headline.
2686             (listified-headlines
2687              (loop for x on data
2688                    when (and (eq (org-element-type (car x)) 'headline)
2689                              (org-export-low-level-p (car x) info))
2690                    return x))
2691             ;; Get listified headline numbers.
2692             (listified-headline-nos
2693              (loop for el in listified-headlines
2694                    when (eq (org-element-type el) 'headline)
2695                    collect (when (org-export-numbered-headline-p el info)
2696                              (1+ (length (org-export-get-previous-element
2697                                           el info t)))))))
2698        ;; Combine item numbers from both the listified headlines and
2699        ;; regular list items.
2700
2701        ;; Case 1: Check if all the parents of list item are numbered.
2702        ;; If yes, link to the item proper.
2703        (let ((item-numbers (append listified-headline-nos item-numbers)))
2704          (when (and item-numbers (not (memq nil item-numbers)))
2705            (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2706                    label
2707                    (mapconcat (lambda (n) (if (not n) " "
2708                                        (concat (number-to-string n) ".")))
2709                               item-numbers "")))))
2710      ;; Case 2: Locate a regular and numbered headline in the
2711      ;; hierarchy.  Display its section number.
2712      (let ((headline
2713             (and
2714              ;; Test if destination is a numbered headline.
2715              (org-export-numbered-headline-p destination info)
2716              (loop for el in (cons destination genealogy)
2717                    when (and (eq (org-element-type el) 'headline)
2718                              (not (org-export-low-level-p el info))
2719                              (org-export-numbered-headline-p el info))
2720                    return el))))
2721        ;; We found one.
2722        (when headline
2723          (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2724                  label
2725                  (mapconcat 'number-to-string (org-export-get-headline-number
2726                                                headline info) "."))))
2727      ;; Case 4: Locate a regular headline in the hierarchy.  Display
2728      ;; its title.
2729      (let ((headline (loop for el in (cons destination genealogy)
2730                            when (and (eq (org-element-type el) 'headline)
2731                                      (not (org-export-low-level-p el info)))
2732                            return el)))
2733        ;; We found one.
2734        (when headline
2735          (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2736                  label
2737                  (let ((title (org-element-property :title headline)))
2738                    (org-export-data title info)))))
2739      (error "FIXME?"))))
2740
2741 (defun org-odt-link (link desc info)
2742   "Transcode a LINK object from Org to ODT.
2743
2744 DESC is the description part of the link, or the empty string.
2745 INFO is a plist holding contextual information.  See
2746 `org-export-data'."
2747   (let* ((type (org-element-property :type link))
2748          (raw-path (org-element-property :path link))
2749          ;; Ensure DESC really exists, or set it to nil.
2750          (desc (and (not (string= desc "")) desc))
2751          (imagep (org-export-inline-image-p
2752                   link (plist-get info :odt-inline-image-rules)))
2753          (path (cond
2754                 ((member type '("http" "https" "ftp" "mailto"))
2755                  (concat type ":" raw-path))
2756                 ((string= type "file") (org-export-file-uri raw-path))
2757                 (t raw-path)))
2758          ;; Convert & to &amp; for correct XML representation
2759          (path (replace-regexp-in-string "&" "&amp;" path)))
2760     (cond
2761      ;; Link type is handled by a special function.
2762      ((org-export-custom-protocol-maybe link desc 'odt))
2763      ;; Image file.
2764      ((and (not desc) (org-export-inline-image-p
2765                        link (plist-get info :odt-inline-image-rules)))
2766       (org-odt-link--inline-image link info))
2767      ;; Formula file.
2768      ((and (not desc) (org-export-inline-image-p
2769                        link (plist-get info :odt-inline-formula-rules)))
2770       (org-odt-link--inline-formula link info))
2771      ;; Radio target: Transcode target's contents and use them as
2772      ;; link's description.
2773      ((string= type "radio")
2774       (let ((destination (org-export-resolve-radio-link link info)))
2775         (if (not destination) desc
2776           (format
2777            "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2778            (org-export-get-reference destination info)
2779            desc))))
2780      ;; Links pointing to a headline: Find destination and build
2781      ;; appropriate referencing command.
2782      ((member type '("custom-id" "fuzzy" "id"))
2783       (let ((destination (if (string= type "fuzzy")
2784                              (org-export-resolve-fuzzy-link link info)
2785                            (org-export-resolve-id-link link info))))
2786         (case (org-element-type destination)
2787           ;; Case 1: Fuzzy link points nowhere.
2788           ('nil
2789            (format "<text:span text:style-name=\"%s\">%s</text:span>"
2790                    "Emphasis"
2791                    (or desc
2792                        (org-export-data (org-element-property :raw-link link)
2793                                         info))))
2794           ;; Case 2: Fuzzy link points to a headline.
2795           (headline
2796            ;; If there's a description, create a hyperlink.
2797            ;; Otherwise, try to provide a meaningful description.
2798            (if (not desc) (org-odt-link--infer-description destination info)
2799              (let ((label
2800                     (or (and (string= type "custom-id")
2801                              (org-element-property :CUSTOM_ID destination))
2802                         (org-export-get-reference destination info))))
2803                (format
2804                 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2805                 label desc))))
2806           ;; Case 3: Fuzzy link points to a target.
2807           (target
2808            ;; If there's a description, create a hyperlink.
2809            ;; Otherwise, try to provide a meaningful description.
2810            (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2811                    (org-export-get-reference destination info)
2812                    (or desc (org-export-get-ordinal destination info))))
2813           ;; Case 4: Fuzzy link points to some element (e.g., an
2814           ;; inline image, a math formula or a table).
2815           (otherwise
2816            (let ((label-reference
2817                   (ignore-errors
2818                     (org-odt-format-label destination info 'reference))))
2819              (cond
2820               ((not label-reference)
2821                (org-odt-link--infer-description destination info))
2822               ;; LINK has no description.  Create
2823               ;; a cross-reference showing entity's sequence
2824               ;; number.
2825               ((not desc) label-reference)
2826               ;; LINK has description.  Insert a hyperlink with
2827               ;; user-provided description.
2828               (t
2829                (format
2830                 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2831                 (org-export-get-reference destination info)
2832                 desc))))))))
2833      ;; Coderef: replace link with the reference name or the
2834      ;; equivalent line number.
2835      ((string= type "coderef")
2836       (let* ((line-no (format "%d" (org-export-resolve-coderef path info)))
2837              (href (concat "coderef-" path)))
2838         (format
2839          (org-export-get-coderef-format path desc)
2840          (format
2841           "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2842           href line-no))))
2843      ;; External link with a description part.
2844      ((and path desc)
2845       (let ((link-contents (org-element-contents link)))
2846         ;; Check if description is a link to an inline image.
2847         (if (and (not (cdr link-contents))
2848                  (let ((desc-element (car link-contents)))
2849                    (and (eq (org-element-type desc-element) 'link)
2850                         (org-export-inline-image-p
2851                          desc-element
2852                          (plist-get info :odt-inline-image-rules)))))
2853             ;; Format link as a clickable image.
2854             (format "\n<draw:a xlink:type=\"simple\" xlink:href=\"%s\">\n%s\n</draw:a>"
2855                     path desc)
2856           ;; Otherwise, format it as a regular link.
2857           (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2858                   path desc))))
2859      ;; External link without a description part.
2860      (path
2861       (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2862               path path))
2863      ;; No path, only description.  Try to do something useful.
2864      (t (format "<text:span text:style-name=\"%s\">%s</text:span>"
2865                 "Emphasis" desc)))))
2866
2867
2868 ;;;; Node Property
2869
2870 (defun org-odt-node-property (node-property contents info)
2871   "Transcode a NODE-PROPERTY element from Org to ODT.
2872 CONTENTS is nil.  INFO is a plist holding contextual
2873 information."
2874   (org-odt--encode-plain-text
2875    (format "%s:%s"
2876            (org-element-property :key node-property)
2877            (let ((value (org-element-property :value node-property)))
2878              (if value (concat " " value) "")))))
2879
2880 ;;;; Paragraph
2881
2882 (defun org-odt--paragraph-style (paragraph)
2883   "Return style of PARAGRAPH.
2884 Style is a symbol among `quoted', `centered' and nil."
2885   (let ((up paragraph))
2886     (while (and (setq up (org-element-property :parent up))
2887                 (not (memq (org-element-type up)
2888                            '(center-block quote-block section)))))
2889     (case (org-element-type up)
2890       (center-block 'centered)
2891       (quote-block 'quoted))))
2892
2893 (defun org-odt--format-paragraph (paragraph contents info default center quote)
2894   "Format paragraph according to given styles.
2895 PARAGRAPH is a paragraph type element.  CONTENTS is the
2896 transcoded contents of that paragraph, as a string.  INFO is
2897 a plist used as a communication channel.  DEFAULT, CENTER and
2898 QUOTE are, respectively, style to use when paragraph belongs to
2899 no special environment, a center block, or a quote block."
2900   (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2901           (case (org-odt--paragraph-style paragraph)
2902             (quoted quote)
2903             (centered center)
2904             (otherwise default))
2905           ;; If PARAGRAPH is a leading paragraph in an item that has
2906           ;; a checkbox, splice checkbox and paragraph contents
2907           ;; together.
2908           (concat (let ((parent (org-element-property :parent paragraph)))
2909                     (and (eq (org-element-type parent) 'item)
2910                          (not (org-export-get-previous-element paragraph info))
2911                          (org-odt--checkbox parent)))
2912                   contents)))
2913
2914 (defun org-odt-paragraph (paragraph contents info)
2915   "Transcode a PARAGRAPH element from Org to ODT.
2916 CONTENTS is the contents of the paragraph, as a string.  INFO is
2917 the plist used as a communication channel."
2918   (org-odt--format-paragraph
2919    paragraph contents info
2920    (or (org-element-property :style paragraph) "Text_20_body")
2921    "OrgCenter"
2922    "Quotations"))
2923
2924
2925 ;;;; Plain List
2926
2927 (defun org-odt-plain-list (plain-list contents info)
2928   "Transcode a PLAIN-LIST element from Org to ODT.
2929 CONTENTS is the contents of the list.  INFO is a plist holding
2930 contextual information."
2931   (format "\n<text:list text:style-name=\"%s\" %s>\n%s</text:list>"
2932           ;; Choose style based on list type.
2933           (case (org-element-property :type plain-list)
2934             (ordered "OrgNumberedList")
2935             (unordered "OrgBulletedList")
2936             (descriptive-1 "OrgDescriptionList")
2937             (descriptive-2 "OrgDescriptionList"))
2938           ;; If top-level list, re-start numbering.  Otherwise,
2939           ;; continue numbering.
2940           (format "text:continue-numbering=\"%s\""
2941                   (let* ((parent (org-export-get-parent plain-list)))
2942                     (if (and parent (eq (org-element-type parent) 'item))
2943                         "true" "false")))
2944           contents))
2945
2946 ;;;; Plain Text
2947
2948 (defun org-odt--encode-tabs-and-spaces (line)
2949   (replace-regexp-in-string
2950    "\\([\t]\\|\\([ ]+\\)\\)"
2951    (lambda (s)
2952      (cond
2953       ((string= s "\t") "<text:tab/>")
2954       (t (let ((n (length s)))
2955            (cond
2956             ((= n 1) " ")
2957             ((> n 1) (concat " " (format "<text:s text:c=\"%d\"/>" (1- n))))
2958             (t ""))))))
2959    line))
2960
2961 (defun org-odt--encode-plain-text (text &optional no-whitespace-filling)
2962   (mapc
2963    (lambda (pair)
2964      (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t)))
2965    '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
2966   (if no-whitespace-filling text
2967     (org-odt--encode-tabs-and-spaces text)))
2968
2969 (defun org-odt-plain-text (text info)
2970   "Transcode a TEXT string from Org to ODT.
2971 TEXT is the string to transcode.  INFO is a plist holding
2972 contextual information."
2973   (let ((output text))
2974     ;; Protect &, < and >.
2975     (setq output (org-odt--encode-plain-text output t))
2976     ;; Handle smart quotes.  Be sure to provide original string since
2977     ;; OUTPUT may have been modified.
2978     (when (plist-get info :with-smart-quotes)
2979       (setq output (org-export-activate-smart-quotes output :utf-8 info text)))
2980     ;; Convert special strings.
2981     (when (plist-get info :with-special-strings)
2982       (mapc
2983        (lambda (pair)
2984          (setq output
2985                (replace-regexp-in-string (car pair) (cdr pair) output t nil)))
2986        org-odt-special-string-regexps))
2987     ;; Handle break preservation if required.
2988     (when (plist-get info :preserve-breaks)
2989       (setq output (replace-regexp-in-string
2990                     "\\(\\\\\\\\\\)?[ \t]*\n" "<text:line-break/>" output t)))
2991     ;; Return value.
2992     output))
2993
2994
2995 ;;;; Planning
2996
2997 (defun org-odt-planning (planning contents info)
2998   "Transcode a PLANNING element from Org to ODT.
2999 CONTENTS is nil.  INFO is a plist used as a communication
3000 channel."
3001   (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3002           "OrgPlanning"
3003           (concat
3004            (let ((closed (org-element-property :closed planning)))
3005              (when closed
3006                (concat
3007                 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3008                         "OrgClosedKeyword" org-closed-string)
3009                 (org-odt-timestamp closed contents info))))
3010            (let ((deadline (org-element-property :deadline planning)))
3011              (when deadline
3012                (concat
3013                 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3014                         "OrgDeadlineKeyword" org-deadline-string)
3015                 (org-odt-timestamp deadline contents info))))
3016            (let ((scheduled (org-element-property :scheduled planning)))
3017              (when scheduled
3018                (concat
3019                 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3020                         "OrgScheduledKeyword" org-deadline-string)
3021                 (org-odt-timestamp scheduled contents info)))))))
3022
3023
3024 ;;;; Property Drawer
3025
3026 (defun org-odt-property-drawer (property-drawer contents info)
3027   "Transcode a PROPERTY-DRAWER element from Org to ODT.
3028 CONTENTS holds the contents of the drawer.  INFO is a plist
3029 holding contextual information."
3030   (and (org-string-nw-p contents)
3031        (format "<text:p text:style-name=\"OrgFixedWidthBlock\">%s</text:p>"
3032                contents)))
3033
3034
3035 ;;;; Quote Block
3036
3037 (defun org-odt-quote-block (quote-block contents info)
3038   "Transcode a QUOTE-BLOCK element from Org to ODT.
3039 CONTENTS holds the contents of the block.  INFO is a plist
3040 holding contextual information."
3041   contents)
3042
3043
3044 ;;;; Section
3045
3046 (defun org-odt-format-section (text style &optional name)
3047   (let ((default-name (car (org-odt-add-automatic-style "Section"))))
3048     (format "\n<text:section text:style-name=\"%s\" %s>\n%s\n</text:section>"
3049             style
3050             (format "text:name=\"%s\"" (or name default-name))
3051             text)))
3052
3053
3054 (defun org-odt-section (section contents info) ; FIXME
3055   "Transcode a SECTION element from Org to ODT.
3056 CONTENTS holds the contents of the section.  INFO is a plist
3057 holding contextual information."
3058   contents)
3059
3060 ;;;; Radio Target
3061
3062 (defun org-odt-radio-target (radio-target text info)
3063   "Transcode a RADIO-TARGET object from Org to ODT.
3064 TEXT is the text of the target.  INFO is a plist holding
3065 contextual information."
3066   (org-odt--target text (org-export-get-reference radio-target info)))
3067
3068
3069 ;;;; Special Block
3070
3071 (defun org-odt-special-block (special-block contents info)
3072   "Transcode a SPECIAL-BLOCK element from Org to ODT.
3073 CONTENTS holds the contents of the block.  INFO is a plist
3074 holding contextual information."
3075   (let ((type (org-element-property :type special-block))
3076         (attributes (org-export-read-attribute :attr_odt special-block)))
3077     (cond
3078      ;; Annotation.
3079      ((string= type "annotation")
3080       (let* ((author (or (plist-get attributes :author)
3081                          (let ((author (plist-get info :author)))
3082                            (and author (org-export-data author info)))))
3083              (date (or (plist-get attributes :date)
3084                        ;; FIXME: Is `car' right thing to do below?
3085                        (car (plist-get info :date)))))
3086         (format "\n<text:p>%s</text:p>"
3087                 (format "<office:annotation>\n%s\n</office:annotation>"
3088                         (concat
3089                          (and author
3090                               (format "<dc:creator>%s</dc:creator>" author))
3091                          (and date
3092                               (format "<dc:date>%s</dc:date>"
3093                                       (org-odt--format-timestamp date nil 'iso-date)))
3094                          contents)))))
3095      ;; Textbox.
3096      ((string= type "textbox")
3097       (let ((width (plist-get attributes :width))
3098             (height (plist-get attributes :height))
3099             (style (plist-get attributes :style))
3100             (extra (plist-get attributes :extra))
3101             (anchor (plist-get attributes :anchor)))
3102         (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3103                 "Text_20_body" (org-odt--textbox contents width height
3104                                                    style extra anchor))))
3105      (t contents))))
3106
3107
3108 ;;;; Src Block
3109
3110 (defun org-odt-hfy-face-to-css (fn)
3111   "Create custom style for face FN.
3112 When FN is the default face, use its foreground and background
3113 properties to create \"OrgSrcBlock\" paragraph style.  Otherwise
3114 use its color attribute to create a character style whose name
3115 is obtained from FN.  Currently all attributes of FN other than
3116 color are ignored.
3117
3118 The style name for a face FN is derived using the following
3119 operations on the face name in that order - de-dash, CamelCase
3120 and prefix with \"OrgSrc\".  For example,
3121 `font-lock-function-name-face' is associated with
3122 \"OrgSrcFontLockFunctionNameFace\"."
3123   (let* ((css-list (hfy-face-to-style fn))
3124          (style-name (concat "OrgSrc"
3125                              (mapconcat
3126                               'capitalize (split-string
3127                                            (hfy-face-or-def-to-name fn) "-")
3128                               "")))
3129          (color-val (cdr (assoc "color" css-list)))
3130          (background-color-val (cdr (assoc "background" css-list)))
3131          (style (and org-odt-create-custom-styles-for-srcblocks
3132                      (cond
3133                       ((eq fn 'default)
3134                        (format org-odt-src-block-paragraph-format
3135                                background-color-val color-val))
3136                       (t
3137                        (format
3138                         "
3139 <style:style style:name=\"%s\" style:family=\"text\">
3140   <style:text-properties fo:color=\"%s\"/>
3141  </style:style>" style-name color-val))))))
3142     (cons style-name style)))
3143
3144 (defun org-odt-htmlfontify-string (line)
3145   (let* ((hfy-html-quote-regex "\\([<\"&>       ]\\)")
3146          (hfy-html-quote-map '(("\"" "&quot;")
3147                                ("<" "&lt;")
3148                                ("&" "&amp;")
3149                                (">" "&gt;")
3150                                (" " "<text:s/>")
3151                                ("       " "<text:tab/>")))
3152          (hfy-face-to-css 'org-odt-hfy-face-to-css)
3153          (hfy-optimizations-1 (copy-sequence hfy-optimizations))
3154          (hfy-optimizations (add-to-list 'hfy-optimizations-1
3155                                          'body-text-only))
3156          (hfy-begin-span-handler
3157           (lambda (style text-block text-id text-begins-block-p)
3158             (insert (format "<text:span text:style-name=\"%s\">" style))))
3159          (hfy-end-span-handler (lambda nil (insert "</text:span>"))))
3160     (org-no-warnings (htmlfontify-string line))))
3161
3162 (defun org-odt-do-format-code
3163   (code info &optional lang refs retain-labels num-start)
3164   (let* ((lang (or (assoc-default lang org-src-lang-modes) lang))
3165          (lang-mode (and lang (intern (format "%s-mode" lang))))
3166          (code-lines (org-split-string code "\n"))
3167          (code-length (length code-lines))
3168          (use-htmlfontify-p (and (functionp lang-mode)
3169                                  (plist-get info :odt-fontify-srcblocks)
3170                                  (require 'htmlfontify nil t)
3171                                  (fboundp 'htmlfontify-string)))
3172          (code (if (not use-htmlfontify-p) code
3173                  (with-temp-buffer
3174                    (insert code)
3175                    (funcall lang-mode)
3176                    (font-lock-ensure)
3177                    (buffer-string))))
3178          (fontifier (if use-htmlfontify-p 'org-odt-htmlfontify-string
3179                       'org-odt--encode-plain-text))
3180          (par-style (if use-htmlfontify-p "OrgSrcBlock"
3181                       "OrgFixedWidthBlock"))
3182          (i 0))
3183     (assert (= code-length (length (org-split-string code "\n"))))
3184     (setq code
3185           (org-export-format-code
3186            code
3187            (lambda (loc line-num ref)
3188              (setq par-style
3189                    (concat par-style (and (= (incf i) code-length) "LastLine")))
3190
3191              (setq loc (concat loc (and ref retain-labels (format " (%s)" ref))))
3192              (setq loc (funcall fontifier loc))
3193              (when ref
3194                (setq loc (org-odt--target loc (concat "coderef-" ref))))
3195              (assert par-style)
3196              (setq loc (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3197                                par-style loc))
3198              (if (not line-num) loc
3199                (format "\n<text:list-item>%s\n</text:list-item>" loc)))
3200            num-start refs))
3201     (cond
3202      ((not num-start) code)
3203      ((= num-start 0)
3204       (format
3205        "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3206        " text:continue-numbering=\"false\"" code))
3207      (t
3208       (format
3209        "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3210        " text:continue-numbering=\"true\"" code)))))
3211
3212 (defun org-odt-format-code (element info)
3213   (let* ((lang (org-element-property :language element))
3214          ;; Extract code and references.
3215          (code-info (org-export-unravel-code element))
3216          (code (car code-info))
3217          (refs (cdr code-info))
3218          ;; Does the src block contain labels?
3219          (retain-labels (org-element-property :retain-labels element))
3220          ;; Does it have line numbers?
3221          (num-start (case (org-element-property :number-lines element)
3222                       (continued (org-export-get-loc element info))
3223                       (new 0))))
3224     (org-odt-do-format-code code info lang refs retain-labels num-start)))
3225
3226 (defun org-odt-src-block (src-block contents info)
3227   "Transcode a SRC-BLOCK element from Org to ODT.
3228 CONTENTS holds the contents of the item.  INFO is a plist holding
3229 contextual information."
3230   (let* ((lang (org-element-property :language src-block))
3231          (attributes (org-export-read-attribute :attr_odt src-block))
3232          (captions (org-odt-format-label src-block info 'definition))
3233          (caption (car captions)) (short-caption (cdr captions)))
3234     (concat
3235      (and caption
3236           (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3237                   "Listing" caption))
3238      (let ((--src-block (org-odt-format-code src-block info)))
3239        (if (not (plist-get attributes :textbox)) --src-block
3240          (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3241                  "Text_20_body"
3242                  (org-odt--textbox --src-block nil nil nil)))))))
3243
3244
3245 ;;;; Statistics Cookie
3246
3247 (defun org-odt-statistics-cookie (statistics-cookie contents info)
3248   "Transcode a STATISTICS-COOKIE object from Org to ODT.
3249 CONTENTS is nil.  INFO is a plist holding contextual information."
3250   (let ((cookie-value (org-element-property :value statistics-cookie)))
3251     (format "<text:span text:style-name=\"%s\">%s</text:span>"
3252             "OrgCode" cookie-value)))
3253
3254
3255 ;;;; Strike-Through
3256
3257 (defun org-odt-strike-through (strike-through contents info)
3258   "Transcode STRIKE-THROUGH from Org to ODT.
3259 CONTENTS is the text with strike-through markup.  INFO is a plist
3260 holding contextual information."
3261   (format "<text:span text:style-name=\"%s\">%s</text:span>"
3262           "Strikethrough" contents))
3263
3264
3265 ;;;; Subscript
3266
3267 (defun org-odt-subscript (subscript contents info)
3268   "Transcode a SUBSCRIPT object from Org to ODT.
3269 CONTENTS is the contents of the object.  INFO is a plist holding
3270 contextual information."
3271   (format "<text:span text:style-name=\"%s\">%s</text:span>"
3272           "OrgSubscript" contents))
3273
3274
3275 ;;;; Superscript
3276
3277 (defun org-odt-superscript (superscript contents info)
3278   "Transcode a SUPERSCRIPT object from Org to ODT.
3279 CONTENTS is the contents of the object.  INFO is a plist holding
3280 contextual information."
3281   (format "<text:span text:style-name=\"%s\">%s</text:span>"
3282           "OrgSuperscript" contents))
3283
3284
3285 ;;;; Table Cell
3286
3287 (defun org-odt-table-style-spec (element info)
3288   (let* ((table (org-export-get-parent-table element))
3289          (table-attributes (org-export-read-attribute :attr_odt table))
3290          (table-style (plist-get table-attributes :style)))
3291     (assoc table-style (plist-get info :odt-table-styles))))
3292
3293 (defun org-odt-get-table-cell-styles (table-cell info)
3294   "Retrieve styles applicable to a table cell.
3295 R and C are (zero-based) row and column numbers of the table
3296 cell.  STYLE-SPEC is an entry in `org-odt-table-styles'
3297 applicable to the current table.  It is nil if the table is not
3298 associated with any style attributes.
3299
3300 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3301
3302 When STYLE-SPEC is nil, style the table cell the conventional way
3303 - choose cell borders based on row and column groupings and
3304 choose paragraph alignment based on `org-col-cookies' text
3305 property.  See also
3306 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3307
3308 When STYLE-SPEC is non-nil, ignore the above cookie and return
3309 styles congruent with the ODF-1.2 specification."
3310   (let* ((table-cell-address (org-export-table-cell-address table-cell info))
3311          (r (car table-cell-address)) (c (cdr table-cell-address))
3312          (style-spec (org-odt-table-style-spec table-cell info))
3313          (table-dimensions (org-export-table-dimensions
3314                             (org-export-get-parent-table table-cell)
3315                             info)))
3316     (when style-spec
3317       ;; LibreOffice - particularly the Writer - honors neither table
3318       ;; templates nor custom table-cell styles.  Inorder to retain
3319       ;; inter-operability with LibreOffice, only automatic styles are
3320       ;; used for styling of table-cells.  The current implementation is
3321       ;; congruent with ODF-1.2 specification and hence is
3322       ;; future-compatible.
3323
3324       ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3325       ;; which recognizes as many as 16 different cell types - is much
3326       ;; richer. Unfortunately it is NOT amenable to easy configuration
3327       ;; by hand.
3328       (let* ((template-name (nth 1 style-spec))
3329              (cell-style-selectors (nth 2 style-spec))
3330              (cell-type
3331               (cond
3332                ((and (cdr (assoc 'use-first-column-styles cell-style-selectors))
3333                      (= c 0)) "FirstColumn")
3334                ((and (cdr (assoc 'use-last-column-styles cell-style-selectors))
3335                      (= (1+ c) (cdr table-dimensions)))
3336                 "LastColumn")
3337                ((and (cdr (assoc 'use-first-row-styles cell-style-selectors))
3338                      (= r 0)) "FirstRow")
3339                ((and (cdr (assoc 'use-last-row-styles cell-style-selectors))
3340                      (= (1+ r) (car table-dimensions)))
3341                 "LastRow")
3342                ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
3343                      (= (% r 2) 1)) "EvenRow")
3344                ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
3345                      (= (% r 2) 0)) "OddRow")
3346                ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
3347                      (= (% c 2) 1)) "EvenColumn")
3348                ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
3349                      (= (% c 2) 0)) "OddColumn")
3350                (t ""))))
3351         (concat template-name cell-type)))))
3352
3353 (defun org-odt-table-cell (table-cell contents info)
3354   "Transcode a TABLE-CELL element from Org to ODT.
3355 CONTENTS is nil.  INFO is a plist used as a communication
3356 channel."
3357   (let* ((table-cell-address (org-export-table-cell-address table-cell info))
3358          (r (car table-cell-address))
3359          (c (cdr table-cell-address))
3360          (horiz-span (or (org-export-table-cell-width table-cell info) 0))
3361          (table-row (org-export-get-parent table-cell))
3362          (custom-style-prefix (org-odt-get-table-cell-styles
3363                                table-cell info))
3364          (paragraph-style
3365           (or
3366            (and custom-style-prefix
3367                 (format "%sTableParagraph" custom-style-prefix))
3368            (concat
3369             (cond
3370              ((and (= 1 (org-export-table-row-group table-row info))
3371                    (org-export-table-has-header-p
3372                     (org-export-get-parent-table table-row) info))
3373               "OrgTableHeading")
3374              ((let* ((table (org-export-get-parent-table table-cell))
3375                      (table-attrs (org-export-read-attribute :attr_odt table))
3376                      (table-header-columns
3377                       (let ((cols (plist-get table-attrs :header-columns)))
3378                         (and cols (read cols)))))
3379                 (<= c (cond ((wholenump table-header-columns)
3380                              (- table-header-columns 1))
3381                             (table-header-columns 0)
3382                             (t -1))))
3383               "OrgTableHeading")
3384              (t "OrgTableContents"))
3385             (capitalize (symbol-name (org-export-table-cell-alignment
3386                                       table-cell info))))))
3387          (cell-style-name
3388           (or
3389            (and custom-style-prefix (format "%sTableCell"
3390                                             custom-style-prefix))
3391            (concat
3392             "OrgTblCell"
3393             (when (or (org-export-table-row-starts-rowgroup-p table-row info)
3394                       (zerop r)) "T")
3395             (when (org-export-table-row-ends-rowgroup-p table-row info) "B")
3396             (when (and (org-export-table-cell-starts-colgroup-p table-cell info)
3397                        (not (zerop c)) ) "L"))))
3398          (cell-attributes
3399           (concat
3400            (format " table:style-name=\"%s\"" cell-style-name)
3401            (and (> horiz-span 0)
3402                 (format " table:number-columns-spanned=\"%d\""
3403                         (1+ horiz-span))))))
3404     (unless contents (setq contents ""))
3405     (concat
3406      (assert paragraph-style)
3407      (format "\n<table:table-cell%s>\n%s\n</table:table-cell>"
3408              cell-attributes
3409              (let ((table-cell-contents (org-element-contents table-cell)))
3410                (if (memq (org-element-type (car table-cell-contents))
3411                          org-element-all-elements)
3412                    contents
3413                  (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3414                          paragraph-style contents))))
3415      (let (s)
3416        (dotimes (i horiz-span s)
3417          (setq s (concat s "\n<table:covered-table-cell/>"))))
3418      "\n")))
3419
3420
3421 ;;;; Table Row
3422
3423 (defun org-odt-table-row (table-row contents info)
3424   "Transcode a TABLE-ROW element from Org to ODT.
3425 CONTENTS is the contents of the row.  INFO is a plist used as a
3426 communication channel."
3427   ;; Rules are ignored since table separators are deduced from
3428   ;; borders of the current row.
3429   (when (eq (org-element-property :type table-row) 'standard)
3430     (let* ((rowgroup-tags
3431             (if (and (= 1 (org-export-table-row-group table-row info))
3432                      (org-export-table-has-header-p
3433                       (org-export-get-parent-table table-row) info))
3434                 ;; If the row belongs to the first rowgroup and the
3435                 ;; table has more than one row groups, then this row
3436                 ;; belongs to the header row group.
3437                 '("\n<table:table-header-rows>" . "\n</table:table-header-rows>")
3438               ;; Otherwise, it belongs to non-header row group.
3439               '("\n<table:table-rows>" . "\n</table:table-rows>"))))
3440       (concat
3441        ;; Does this row begin a rowgroup?
3442        (when (org-export-table-row-starts-rowgroup-p table-row info)
3443          (car rowgroup-tags))
3444        ;; Actual table row
3445        (format "\n<table:table-row>\n%s\n</table:table-row>" contents)
3446        ;; Does this row end a rowgroup?
3447        (when (org-export-table-row-ends-rowgroup-p table-row info)
3448          (cdr rowgroup-tags))))))
3449
3450
3451 ;;;; Table
3452
3453 (defun org-odt-table-first-row-data-cells (table info)
3454   (let ((table-row
3455          (org-element-map table 'table-row
3456            (lambda (row)
3457              (unless (eq (org-element-property :type row) 'rule) row))
3458            info 'first-match))
3459         (special-column-p (org-export-table-has-special-column-p table)))
3460     (if (not special-column-p) (org-element-contents table-row)
3461       (cdr (org-element-contents table-row)))))
3462
3463 (defun org-odt--table (table contents info)
3464   "Transcode a TABLE element from Org to ODT.
3465 CONTENTS is the contents of the table.  INFO is a plist holding
3466 contextual information."
3467   (case (org-element-property :type table)
3468     ;; Case 1: table.el doesn't support export to OD format.  Strip
3469     ;; such tables from export.
3470     (table.el
3471      (prog1 nil
3472        (message
3473         (concat
3474          "(ox-odt): Found table.el-type table in the source Org file."
3475          "  table.el doesn't support export to ODT format."
3476          "  Stripping the table from export."))))
3477     ;; Case 2: Native Org tables.
3478     (otherwise
3479      (let* ((captions (org-odt-format-label table info 'definition))
3480             (caption (car captions)) (short-caption (cdr captions))
3481             (attributes (org-export-read-attribute :attr_odt table))
3482             (custom-table-style (nth 1 (org-odt-table-style-spec table info)))
3483             (table-column-specs
3484              (function
3485               (lambda (table info)
3486                 (let* ((table-style (or custom-table-style "OrgTable"))
3487                        (column-style (format "%sColumn" table-style)))
3488                   (mapconcat
3489                    (lambda (table-cell)
3490                      (let ((width (1+ (or (org-export-table-cell-width
3491                                            table-cell info) 0)))
3492                            (s (format
3493                                "\n<table:table-column table:style-name=\"%s\"/>"
3494                                column-style))
3495                            out)
3496                        (dotimes (i width out) (setq out (concat s out)))))
3497                    (org-odt-table-first-row-data-cells table info) "\n"))))))
3498        (concat
3499         ;; caption.
3500         (when caption
3501           (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3502                   "Table" caption))
3503         ;; begin table.
3504         (let* ((automatic-name
3505                 (org-odt-add-automatic-style "Table" attributes)))
3506           (format
3507            "\n<table:table table:style-name=\"%s\"%s>"
3508            (or custom-table-style (cdr automatic-name) "OrgTable")
3509            (concat (when short-caption
3510                      (format " table:name=\"%s\"" short-caption)))))
3511         ;; column specification.
3512         (funcall table-column-specs table info)
3513         ;; actual contents.
3514         "\n" contents
3515         ;; end table.
3516         "</table:table>")))))
3517
3518 (defun org-odt-table (table contents info)
3519   "Transcode a TABLE element from Org to ODT.
3520 CONTENTS is the contents of the table.  INFO is a plist holding
3521 contextual information.
3522
3523 Use `org-odt--table' to typeset the table.  Handle details
3524 pertaining to indentation here."
3525   (let* ((--element-preceded-by-table-p
3526           (function
3527            (lambda (element info)
3528              (loop for el in (org-export-get-previous-element element info t)
3529                    thereis (eq (org-element-type el) 'table)))))
3530          (--walk-list-genealogy-and-collect-tags
3531           (function
3532            (lambda (table info)
3533              (let* ((genealogy (org-element-lineage table))
3534                     (list-genealogy
3535                      (when (eq (org-element-type (car genealogy)) 'item)
3536                        (loop for el in genealogy
3537                              when (memq (org-element-type el)
3538                                         '(item plain-list))
3539                              collect el)))
3540                     (llh-genealogy
3541                      (apply 'nconc
3542                             (loop for el in genealogy
3543                                   when (and (eq (org-element-type el) 'headline)
3544                                             (org-export-low-level-p el info))
3545                                   collect
3546                                   (list el
3547                                         (assq 'headline
3548                                               (org-element-contents
3549                                                (org-export-get-parent el)))))))
3550                     parent-list)
3551                (nconc
3552                 ;; Handle list genealogy.
3553                 (loop for el in list-genealogy collect
3554                       (case (org-element-type el)
3555                         (plain-list
3556                          (setq parent-list el)
3557                          (cons "</text:list>"
3558                                (format "\n<text:list text:style-name=\"%s\" %s>"
3559                                        (case (org-element-property :type el)
3560                                          (ordered "OrgNumberedList")
3561                                          (unordered "OrgBulletedList")
3562                                          (descriptive-1 "OrgDescriptionList")
3563                                          (descriptive-2 "OrgDescriptionList"))
3564                                        "text:continue-numbering=\"true\"")))
3565                         (item
3566                          (cond
3567                           ((not parent-list)
3568                            (if (funcall --element-preceded-by-table-p table info)
3569                                '("</text:list-header>" . "<text:list-header>")
3570                              '("</text:list-item>" . "<text:list-header>")))
3571                           ((funcall --element-preceded-by-table-p
3572                                     parent-list info)
3573                            '("</text:list-header>" . "<text:list-header>"))
3574                           (t '("</text:list-item>" . "<text:list-item>"))))))
3575                 ;; Handle low-level headlines.
3576                 (loop for el in llh-genealogy
3577                       with step = 'item collect
3578                       (case step
3579                         (plain-list
3580                          (setq step 'item) ; Flip-flop
3581                          (setq parent-list el)
3582                          (cons "</text:list>"
3583                                (format "\n<text:list text:style-name=\"%s\" %s>"
3584                                        (if (org-export-numbered-headline-p
3585                                             el info)
3586                                            "OrgNumberedList"
3587                                          "OrgBulletedList")
3588                                        "text:continue-numbering=\"true\"")))
3589                         (item
3590                          (setq step 'plain-list) ; Flip-flop
3591                          (cond
3592                           ((not parent-list)
3593                            (if (funcall --element-preceded-by-table-p table info)
3594                                '("</text:list-header>" . "<text:list-header>")
3595                              '("</text:list-item>" . "<text:list-header>")))
3596                           ((let ((section? (org-export-get-previous-element
3597                                             parent-list info)))
3598                              (and section?
3599                                   (eq (org-element-type section?) 'section)
3600                                   (assq 'table (org-element-contents section?))))
3601                            '("</text:list-header>" . "<text:list-header>"))
3602                           (t
3603                            '("</text:list-item>" . "<text:list-item>")))))))))))
3604          (close-open-tags (funcall --walk-list-genealogy-and-collect-tags
3605                                    table info)))
3606     ;; OpenDocument schema does not permit table to occur within a
3607     ;; list item.
3608
3609     ;; One solution - the easiest and lightweight, in terms of
3610     ;; implementation - is to put the table in an indented text box
3611     ;; and make the text box part of the list-item.  Unfortunately if
3612     ;; the table is big and spans multiple pages, the text box could
3613     ;; overflow.  In this case, the following attribute will come
3614     ;; handy.
3615
3616     ;; ,---- From OpenDocument-v1.1.pdf
3617     ;; | 15.27.28 Overflow behavior
3618     ;; |
3619     ;; | For text boxes contained within text document, the
3620     ;; | style:overflow-behavior property specifies the behavior of text
3621     ;; | boxes where the containing text does not fit into the text
3622     ;; | box.
3623     ;; |
3624     ;; | If the attribute's value is clip, the text that does not fit
3625     ;; | into the text box is not displayed.
3626     ;; |
3627     ;; | If the attribute value is auto-create-new-frame, a new frame
3628     ;; | will be created on the next page, with the same position and
3629     ;; | dimensions of the original frame.
3630     ;; |
3631     ;; | If the style:overflow-behavior property's value is
3632     ;; | auto-create-new-frame and the text box has a minimum width or
3633     ;; | height specified, then the text box will grow until the page
3634     ;; | bounds are reached before a new frame is created.
3635     ;; `----
3636
3637     ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3638     ;; auto-create-new-frame property and always resorts to clipping
3639     ;; the text box.  This results in table being truncated.
3640
3641     ;; So we solve the problem the hard (and fun) way using list
3642     ;; continuations.
3643
3644     ;; The problem only becomes more interesting if you take in to
3645     ;; account the following facts:
3646     ;;
3647     ;; - Description lists are simulated as plain lists.
3648     ;; - Low-level headlines can be listified.
3649     ;; - In Org-mode, a table can occur not only as a regular list
3650     ;;   item, but also within description lists and low-level
3651     ;;   headlines.
3652
3653     ;; See `org-odt-translate-description-lists' and
3654     ;; `org-odt-translate-low-level-headlines' for how this is
3655     ;; tackled.
3656
3657     (concat "\n"
3658             ;; Discontinue the list.
3659             (mapconcat 'car close-open-tags "\n")
3660             ;; Put the table in an indented section.
3661             (let* ((table (org-odt--table table contents info))
3662                    (level (/ (length (mapcar 'car close-open-tags)) 2))
3663                    (style (format "OrgIndentedSection-Level-%d" level)))
3664               (when table (org-odt-format-section table style)))
3665             ;; Continue the list.
3666             (mapconcat 'cdr (nreverse close-open-tags) "\n"))))
3667
3668
3669 ;;;; Target
3670
3671 (defun org-odt-target (target contents info)
3672   "Transcode a TARGET object from Org to ODT.
3673 CONTENTS is nil.  INFO is a plist holding contextual
3674 information."
3675   (org-odt--target "" (org-export-get-reference target info)))
3676
3677
3678 ;;;; Timestamp
3679
3680 (defun org-odt-timestamp (timestamp contents info)
3681   "Transcode a TIMESTAMP object from Org to ODT.
3682 CONTENTS is nil.  INFO is a plist used as a communication
3683 channel."
3684   (let* ((raw-value (org-element-property :raw-value timestamp))
3685          (type (org-element-property :type timestamp)))
3686     (if (not (plist-get info :odt-use-date-fields))
3687         (let ((value (org-odt-plain-text
3688                       (org-timestamp-translate timestamp) info)))
3689           (case (org-element-property :type timestamp)
3690             ((active active-range)
3691              (format "<text:span text:style-name=\"%s\">%s</text:span>"
3692                      "OrgActiveTimestamp" value))
3693             ((inactive inactive-range)
3694              (format "<text:span text:style-name=\"%s\">%s</text:span>"
3695                      "OrgInactiveTimestamp" value))
3696             (otherwise value)))
3697       (case type
3698         (active
3699          (format "<text:span text:style-name=\"%s\">%s</text:span>"
3700                  "OrgActiveTimestamp"
3701                  (format "&lt;%s&gt;" (org-odt--format-timestamp timestamp))))
3702         (inactive
3703          (format "<text:span text:style-name=\"%s\">%s</text:span>"
3704                  "OrgInactiveTimestamp"
3705                  (format "[%s]" (org-odt--format-timestamp timestamp))))
3706         (active-range
3707          (format "<text:span text:style-name=\"%s\">%s</text:span>"
3708                  "OrgActiveTimestamp"
3709                  (format "&lt;%s&gt;&#x2013;&lt;%s&gt;"
3710                          (org-odt--format-timestamp timestamp)
3711                          (org-odt--format-timestamp timestamp 'end))))
3712         (inactive-range
3713          (format "<text:span text:style-name=\"%s\">%s</text:span>"
3714                  "OrgInactiveTimestamp"
3715                  (format "[%s]&#x2013;[%s]"
3716                          (org-odt--format-timestamp timestamp)
3717                          (org-odt--format-timestamp timestamp 'end))))
3718         (otherwise
3719          (format "<text:span text:style-name=\"%s\">%s</text:span>"
3720                  "OrgDiaryTimestamp"
3721                  (org-odt-plain-text (org-timestamp-translate timestamp)
3722                                      info)))))))
3723
3724
3725 ;;;; Underline
3726
3727 (defun org-odt-underline (underline contents info)
3728   "Transcode UNDERLINE from Org to ODT.
3729 CONTENTS is the text with underline markup.  INFO is a plist
3730 holding contextual information."
3731   (format "<text:span text:style-name=\"%s\">%s</text:span>"
3732           "Underline" contents))
3733
3734
3735 ;;;; Verbatim
3736
3737 (defun org-odt-verbatim (verbatim contents info)
3738   "Transcode a VERBATIM object from Org to ODT.
3739 CONTENTS is nil.  INFO is a plist used as a communication
3740 channel."
3741   (format "<text:span text:style-name=\"%s\">%s</text:span>"
3742           "OrgCode" (org-odt--encode-plain-text
3743                      (org-element-property :value verbatim))))
3744
3745
3746 ;;;; Verse Block
3747
3748 (defun org-odt-verse-block (verse-block contents info)
3749   "Transcode a VERSE-BLOCK element from Org to ODT.
3750 CONTENTS is verse block contents.  INFO is a plist holding
3751 contextual information."
3752   ;; Add line breaks to each line of verse.
3753   (setq contents (replace-regexp-in-string
3754                   "\\(<text:line-break/>\\)?[ \t]*\n"
3755                   "<text:line-break/>" contents))
3756   ;; Replace tabs and spaces.
3757   (setq contents (org-odt--encode-tabs-and-spaces contents))
3758   ;; Surround it in a verse environment.
3759   (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3760           "OrgVerse" contents))
3761
3762
3763 \f
3764 ;;; Filters
3765
3766 ;;;; LaTeX fragments
3767
3768 (defun org-odt--translate-latex-fragments (tree backend info)
3769   (let ((processing-type (plist-get info :with-latex))
3770         (count 0))
3771     ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3772     ;; If the desired converter is not available, force verbatim
3773     ;; processing.
3774     (case processing-type
3775       ((t mathml)
3776        (if (and (fboundp 'org-format-latex-mathml-available-p)
3777                 (org-format-latex-mathml-available-p))
3778            (setq processing-type 'mathml)
3779          (message "LaTeX to MathML converter not available.")
3780          (setq processing-type 'verbatim)))
3781       ((dvipng imagemagick)
3782        (unless (and (org-check-external-command "latex" "" t)
3783                     (org-check-external-command
3784                      (if (eq processing-type 'dvipng) "dvipng" "convert") "" t))
3785          (message "LaTeX to PNG converter not available.")
3786          (setq processing-type 'verbatim)))
3787       (otherwise
3788        (message "Unknown LaTeX option.  Forcing verbatim.")
3789        (setq processing-type 'verbatim)))
3790
3791     ;; Store normalized value for later use.
3792     (when (plist-get info :with-latex)
3793       (plist-put info :with-latex processing-type))
3794     (message "Formatting LaTeX using %s" processing-type)
3795
3796     ;; Convert `latex-fragment's and `latex-environment's.
3797     (when (memq processing-type '(mathml dvipng imagemagick))
3798       (org-element-map tree '(latex-fragment latex-environment)
3799         (lambda (latex-*)
3800           (incf count)
3801           (let* ((latex-frag (org-element-property :value latex-*))
3802                  (input-file (plist-get info :input-file))
3803                  (cache-dir (file-name-directory input-file))
3804                  (cache-subdir (concat
3805                                 (case processing-type
3806                                   ((dvipng imagemagick) "ltxpng/")
3807                                   (mathml "ltxmathml/"))
3808                                 (file-name-sans-extension
3809                                  (file-name-nondirectory input-file))))
3810                  (display-msg
3811                   (case processing-type
3812                     ((dvipng imagemagick)
3813                      (format "Creating LaTeX Image %d..." count))
3814                     (mathml (format "Creating MathML snippet %d..." count))))
3815                  ;; Get an Org-style link to PNG image or the MathML
3816                  ;; file.
3817                  (org-link
3818                   (let ((link (with-temp-buffer
3819                                 (insert latex-frag)
3820                                 (org-format-latex cache-subdir cache-dir
3821                                                   nil display-msg
3822                                                   nil processing-type)
3823                                 (buffer-substring-no-properties
3824                                  (point-min) (point-max)))))
3825                     (if (org-string-match-p "file:\\([^]]*\\)" link) link
3826                       (message "LaTeX Conversion failed.")
3827                       nil))))
3828             (when org-link
3829               ;; Conversion succeeded.  Parse above Org-style link to
3830               ;; a `link' object.
3831               (let* ((link
3832                       (org-element-map
3833                           (org-element-parse-secondary-string org-link '(link))
3834                           'link #'identity info t))
3835                      (replacement
3836                       (case (org-element-type latex-*)
3837                         ;; Case 1: LaTeX environment.  Mimic
3838                         ;; a "standalone image or formula" by
3839                         ;; enclosing the `link' in a `paragraph'.
3840                         ;; Copy over original attributes, captions to
3841                         ;; the enclosing paragraph.
3842                         (latex-environment
3843                          (org-element-adopt-elements
3844                           (list 'paragraph
3845                                 (list :style "OrgFormula"
3846                                       :name
3847                                       (org-element-property :name latex-*)
3848                                       :caption
3849                                       (org-element-property :caption latex-*)))
3850                           link))
3851                         ;; Case 2: LaTeX fragment.  No special action.
3852                         (latex-fragment link))))
3853                 ;; Note down the object that link replaces.
3854                 (org-element-put-property replacement :replaces
3855                                           (list (org-element-type latex-*)
3856                                                 (list :value latex-frag)))
3857                 ;; Restore blank after initial element or object.
3858                 (org-element-put-property
3859                  replacement :post-blank
3860                  (org-element-property :post-blank latex-*))
3861                 ;; Replace now.
3862                 (org-element-set-element latex-* replacement)))))
3863         info nil nil t)))
3864   tree)
3865
3866
3867 ;;;; Description lists
3868
3869 ;; This translator is necessary to handle indented tables in a uniform
3870 ;; manner.  See comment in `org-odt--table'.
3871
3872 (defun org-odt--translate-description-lists (tree backend info)
3873   ;; OpenDocument has no notion of a description list.  So simulate it
3874   ;; using plain lists.  Description lists in the exported document
3875   ;; are typeset in the same manner as they are in a typical HTML
3876   ;; document.
3877   ;;
3878   ;; Specifically, a description list like this:
3879   ;;
3880   ;;     ,----
3881   ;;     | - term-1 :: definition-1
3882   ;;     | - term-2 :: definition-2
3883   ;;     `----
3884   ;;
3885   ;; gets translated in to the following form:
3886   ;;
3887   ;;     ,----
3888   ;;     | - term-1
3889   ;;     |   - definition-1
3890   ;;     | - term-2
3891   ;;     |   - definition-2
3892   ;;     `----
3893   ;;
3894   ;; Further effect is achieved by fixing the OD styles as below:
3895   ;;
3896   ;; 1. Set the :type property of the simulated lists to
3897   ;;    `descriptive-1' and `descriptive-2'.  Map these to list-styles
3898   ;;    that has *no* bullets whatsoever.
3899   ;;
3900   ;; 2. The paragraph containing the definition term is styled to be
3901   ;;    in bold.
3902   ;;
3903   (org-element-map tree 'plain-list
3904     (lambda (el)
3905       (when (equal (org-element-property :type el) 'descriptive)
3906         (org-element-set-element
3907          el
3908          (apply 'org-element-adopt-elements
3909                 (list 'plain-list (list :type 'descriptive-1))
3910                 (mapcar
3911                  (lambda (item)
3912                    (org-element-adopt-elements
3913                     (list 'item (list :checkbox (org-element-property
3914                                                  :checkbox item)))
3915                     (list 'paragraph (list :style "Text_20_body_20_bold")
3916                           (or (org-element-property :tag item) "(no term)"))
3917                     (org-element-adopt-elements
3918                      (list 'plain-list (list :type 'descriptive-2))
3919                      (apply 'org-element-adopt-elements
3920                             (list 'item nil)
3921                             (org-element-contents item)))))
3922                  (org-element-contents el)))))
3923       nil)
3924     info)
3925   tree)
3926
3927 ;;;; List tables
3928
3929 ;; Lists that are marked with attribute `:list-table' are called as
3930 ;; list tables.  They will be rendered as a table within the exported
3931 ;; document.
3932
3933 ;; Consider an example.  The following list table
3934 ;;
3935 ;; #+attr_odt :list-table t
3936 ;; - Row 1
3937 ;;   - 1.1
3938 ;;   - 1.2
3939 ;;   - 1.3
3940 ;; - Row 2
3941 ;;   - 2.1
3942 ;;   - 2.2
3943 ;;   - 2.3
3944 ;;
3945 ;; will be exported as though it were an Org table like the one show
3946 ;; below.
3947 ;;
3948 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3949 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3950 ;;
3951 ;; Note that org-tables are NOT multi-line and each line is mapped to
3952 ;; a unique row in the exported document.  So if an exported table
3953 ;; needs to contain a single paragraph (with copious text) it needs to
3954 ;; be typed up in a single line.  Editing such long lines using the
3955 ;; table editor will be a cumbersome task.  Furthermore inclusion of
3956 ;; multi-paragraph text in a table cell is well-nigh impossible.
3957 ;;
3958 ;; A LIST-TABLE circumvents above problems.
3959 ;;
3960 ;; Note that in the example above the list items could be paragraphs
3961 ;; themselves and the list can be arbitrarily deep.
3962 ;;
3963 ;; Inspired by following thread:
3964 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3965
3966 ;; Translate lists to tables
3967
3968 (defun org-odt--translate-list-tables (tree backend info)
3969   (org-element-map tree 'plain-list
3970     (lambda (l1-list)
3971       (when (org-export-read-attribute :attr_odt l1-list :list-table)
3972         ;; Replace list with table.
3973         (org-element-set-element
3974          l1-list
3975          ;; Build replacement table.
3976          (apply 'org-element-adopt-elements
3977                 (list 'table '(:type org :attr_odt (":style \"GriddedTable\"")))
3978                 (org-element-map l1-list 'item
3979                   (lambda (l1-item)
3980                     (let* ((l1-item-contents (org-element-contents l1-item))
3981                            l1-item-leading-text l2-list)
3982                       ;; Remove Level-2 list from the Level-item.  It
3983                       ;; will be subsequently attached as table-cells.
3984                       (let ((cur l1-item-contents) prev)
3985                         (while (and cur (not (eq (org-element-type (car cur))
3986                                                  'plain-list)))
3987                           (setq prev cur)
3988                           (setq cur (cdr cur)))
3989                         (when prev
3990                           (setcdr prev nil)
3991                           (setq l2-list (car cur)))
3992                         (setq l1-item-leading-text l1-item-contents))
3993                       ;; Level-1 items start a table row.
3994                       (apply 'org-element-adopt-elements
3995                              (list 'table-row (list :type 'standard))
3996                              ;;  Leading text of level-1 item define
3997                              ;;  the first table-cell.
3998                              (apply 'org-element-adopt-elements
3999                                     (list 'table-cell nil)
4000                                     l1-item-leading-text)
4001                              ;; Level-2 items define subsequent
4002                              ;; table-cells of the row.
4003                              (org-element-map l2-list 'item
4004                                (lambda (l2-item)
4005                                  (apply 'org-element-adopt-elements
4006                                         (list 'table-cell nil)
4007                                         (org-element-contents l2-item)))
4008                                info nil 'item))))
4009                   info nil 'item))))
4010       nil)
4011     info)
4012   tree)
4013
4014 \f
4015 ;;; Interactive functions
4016
4017 (defun org-odt-create-manifest-file-entry (&rest args)
4018   (push args org-odt-manifest-file-entries))
4019
4020 (defun org-odt-write-manifest-file ()
4021   (make-directory (concat org-odt-zip-dir "META-INF"))
4022   (let ((manifest-file (concat org-odt-zip-dir "META-INF/manifest.xml")))
4023     (with-current-buffer
4024         (let ((nxml-auto-insert-xml-declaration-flag nil))
4025           (find-file-noselect manifest-file t))
4026       (insert
4027        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
4028      <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4029       (mapc
4030        (lambda (file-entry)
4031          (let* ((version (nth 2 file-entry))
4032                 (extra (if (not version) ""
4033                          (format " manifest:version=\"%s\"" version))))
4034            (insert
4035             (format org-odt-manifest-file-entry-tag
4036                     (nth 0 file-entry) (nth 1 file-entry) extra))))
4037        org-odt-manifest-file-entries)
4038       (insert "\n</manifest:manifest>"))))
4039
4040 (defmacro org-odt--export-wrap (out-file &rest body)
4041   `(let* ((--out-file ,out-file)
4042           (out-file-type (file-name-extension --out-file))
4043           (org-odt-xml-files '("META-INF/manifest.xml" "content.xml"
4044                                  "meta.xml" "styles.xml"))
4045           ;; Initialize temporary workarea.  All files that end up in
4046           ;; the exported document get parked/created here.
4047           (org-odt-zip-dir (file-name-as-directory
4048                               (make-temp-file (format "%s-" out-file-type) t)))
4049           (org-odt-manifest-file-entries nil)
4050           (--cleanup-xml-buffers
4051            (function
4052             (lambda nil
4053               ;; Kill all XML buffers.
4054               (mapc (lambda (file)
4055                       (let ((buf (find-buffer-visiting
4056                                   (concat org-odt-zip-dir file))))
4057                         (when buf
4058                           (with-current-buffer buf
4059                             (set-buffer-modified-p nil)
4060                             (kill-buffer buf)))))
4061                     org-odt-xml-files)
4062               ;; Delete temporary directory and also other embedded
4063               ;; files that get copied there.
4064               (delete-directory org-odt-zip-dir t)))))
4065      (condition-case err
4066          (progn
4067            (unless (executable-find "zip")
4068              ;; Not at all OSes ship with zip by default
4069              (error "Executable \"zip\" needed for creating OpenDocument files"))
4070            ;; Do export.  This creates a bunch of xml files ready to be
4071            ;; saved and zipped.
4072            (progn ,@body)
4073            ;; Create a manifest entry for content.xml.
4074            (org-odt-create-manifest-file-entry "text/xml" "content.xml")
4075            ;; Write mimetype file
4076            (let* ((mimetypes
4077                    '(("odt" . "application/vnd.oasis.opendocument.text")
4078                      ("odf" .  "application/vnd.oasis.opendocument.formula")))
4079                   (mimetype (cdr (assoc-string out-file-type mimetypes t))))
4080              (unless mimetype
4081                (error "Unknown OpenDocument backend %S" out-file-type))
4082              (write-region mimetype nil (concat org-odt-zip-dir "mimetype"))
4083              (org-odt-create-manifest-file-entry mimetype "/" "1.2"))
4084            ;; Write out the manifest entries before zipping
4085            (org-odt-write-manifest-file)
4086            ;; Save all XML files.
4087            (mapc (lambda (file)
4088                    (let ((buf (find-buffer-visiting
4089                                (concat org-odt-zip-dir file))))
4090                      (when buf
4091                        (with-current-buffer buf
4092                          ;; Prettify output if needed.
4093                          (when org-odt-prettify-xml
4094                            (indent-region (point-min) (point-max)))
4095                          (save-buffer 0)))))
4096                  org-odt-xml-files)
4097            ;; Run zip.
4098            (let* ((target --out-file)
4099                   (target-name (file-name-nondirectory target))
4100                   (cmds `(("zip" "-mX0" ,target-name "mimetype")
4101                           ("zip" "-rmTq" ,target-name "."))))
4102              ;; If a file with same name as the desired output file
4103              ;; exists, remove it.
4104              (when (file-exists-p target)
4105                (delete-file target))
4106              ;; Zip up the xml files.
4107              (let ((coding-system-for-write 'no-conversion) exitcode err-string)
4108                (message "Creating ODT file...")
4109                ;; Switch temporarily to content.xml.  This way Zip
4110                ;; process will inherit `org-odt-zip-dir' as the current
4111                ;; directory.
4112                (with-current-buffer
4113                    (find-file-noselect (concat org-odt-zip-dir "content.xml") t)
4114                  (mapc
4115                   (lambda (cmd)
4116                     (message "Running %s" (mapconcat 'identity cmd " "))
4117                     (setq err-string
4118                           (with-output-to-string
4119                             (setq exitcode
4120                                   (apply 'call-process (car cmd)
4121                                          nil standard-output nil (cdr cmd)))))
4122                     (or (zerop exitcode)
4123                         (error (concat "Unable to create OpenDocument file."
4124                                        (format "  Zip failed with error (%s)"
4125                                                err-string)))))
4126                   cmds)))
4127              ;; Move the zip file from temporary work directory to
4128              ;; user-mandated location.
4129              (rename-file (concat org-odt-zip-dir target-name) target)
4130              (message "Created %s" (expand-file-name target))
4131              ;; Cleanup work directory and work files.
4132              (funcall --cleanup-xml-buffers)
4133              ;; Open the OpenDocument file in archive-mode for
4134              ;; examination.
4135              (find-file-noselect target t)
4136              ;; Return exported file.
4137              (cond
4138               ;; Case 1: Conversion desired on exported file.  Run the
4139               ;; converter on the OpenDocument file.  Return the
4140               ;; converted file.
4141               (org-odt-preferred-output-format
4142                (or (org-odt-convert target org-odt-preferred-output-format)
4143                    target))
4144               ;; Case 2: No further conversion.  Return exported
4145               ;; OpenDocument file.
4146               (t target))))
4147        (error
4148         ;; Cleanup work directory and work files.
4149         (funcall --cleanup-xml-buffers)
4150         (message "OpenDocument export failed: %s"
4151                  (error-message-string err))))))
4152
4153
4154 ;;;; Export to OpenDocument formula
4155
4156 ;;;###autoload
4157 (defun org-odt-export-as-odf (latex-frag &optional odf-file)
4158   "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4159 Use `org-create-math-formula' to convert LATEX-FRAG first to
4160 MathML.  When invoked as an interactive command, use
4161 `org-latex-regexps' to infer LATEX-FRAG from currently active
4162 region.  If no LaTeX fragments are found, prompt for it.  Push
4163 MathML source to kill ring depending on the value of
4164 `org-export-copy-to-kill-ring'."
4165   (interactive
4166    `(,(let (frag)
4167         (setq frag (and (setq frag (and (region-active-p)
4168                                         (buffer-substring (region-beginning)
4169                                                           (region-end))))
4170                         (loop for e in org-latex-regexps
4171                               thereis (when (string-match (nth 1 e) frag)
4172                                         (match-string (nth 2 e) frag)))))
4173         (read-string "LaTeX Fragment: " frag nil frag))
4174      ,(let ((odf-filename (expand-file-name
4175                            (concat
4176                             (file-name-sans-extension
4177                              (or (file-name-nondirectory buffer-file-name)))
4178                             "." "odf")
4179                            (file-name-directory buffer-file-name))))
4180         (read-file-name "ODF filename: " nil odf-filename nil
4181                         (file-name-nondirectory odf-filename)))))
4182   (let ((filename (or odf-file
4183                       (expand-file-name
4184                        (concat
4185                         (file-name-sans-extension
4186                          (or (file-name-nondirectory buffer-file-name)))
4187                         "." "odf")
4188                        (file-name-directory buffer-file-name)))))
4189     (org-odt--export-wrap
4190      filename
4191      (let* ((buffer (progn
4192                       (require 'nxml-mode)
4193                       (let ((nxml-auto-insert-xml-declaration-flag nil))
4194                         (find-file-noselect (concat org-odt-zip-dir
4195                                                     "content.xml") t))))
4196             (coding-system-for-write 'utf-8)
4197             (save-buffer-coding-system 'utf-8))
4198        (set-buffer buffer)
4199        (set-buffer-file-coding-system coding-system-for-write)
4200        (let ((mathml (org-create-math-formula latex-frag)))
4201          (unless mathml (error "No Math formula created"))
4202          (insert mathml)
4203          ;; Add MathML to kill ring, if needed.
4204          (when (org-export--copy-to-kill-ring-p)
4205            (org-kill-new (buffer-string))))))))
4206
4207 ;;;###autoload
4208 (defun org-odt-export-as-odf-and-open ()
4209   "Export LaTeX fragment as OpenDocument formula and immediately open it.
4210 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4211 formula file."
4212   (interactive)
4213   (org-open-file (call-interactively 'org-odt-export-as-odf) 'system))
4214
4215
4216 ;;;; Export to OpenDocument Text
4217
4218 ;;;###autoload
4219 (defun org-odt-export-to-odt (&optional async subtreep visible-only ext-plist)
4220   "Export current buffer to a ODT file.
4221
4222 If narrowing is active in the current buffer, only export its
4223 narrowed part.
4224
4225 If a region is active, export that region.
4226
4227 A non-nil optional argument ASYNC means the process should happen
4228 asynchronously.  The resulting file should be accessible through
4229 the `org-export-stack' interface.
4230
4231 When optional argument SUBTREEP is non-nil, export the sub-tree
4232 at point, extracting information from the headline properties
4233 first.
4234
4235 When optional argument VISIBLE-ONLY is non-nil, don't export
4236 contents of hidden elements.
4237
4238 EXT-PLIST, when provided, is a property list with external
4239 parameters overriding Org default settings, but still inferior to
4240 file-local settings.
4241
4242 Return output file's name."
4243   (interactive)
4244   (let ((outfile (org-export-output-file-name ".odt" subtreep)))
4245     (if async
4246         (org-export-async-start (lambda (f) (org-export-add-to-stack f 'odt))
4247           `(expand-file-name
4248             (org-odt--export-wrap
4249              ,outfile
4250              (let* ((org-odt-embedded-images-count 0)
4251                     (org-odt-embedded-formulas-count 0)
4252                     (org-odt-automatic-styles nil)
4253                     (org-odt-object-counters nil)
4254                     ;; Let `htmlfontify' know that we are interested in
4255                     ;; collecting styles.
4256                     (hfy-user-sheet-assoc nil))
4257                ;; Initialize content.xml and kick-off the export
4258                ;; process.
4259                (let ((out-buf
4260                       (progn
4261                         (require 'nxml-mode)
4262                         (let ((nxml-auto-insert-xml-declaration-flag nil))
4263                           (find-file-noselect
4264                            (concat org-odt-zip-dir "content.xml") t))))
4265                      (output (org-export-as
4266                               'odt ,subtreep ,visible-only nil ,ext-plist)))
4267                  (with-current-buffer out-buf
4268                    (erase-buffer)
4269                    (insert output)))))))
4270       (org-odt--export-wrap
4271        outfile
4272        (let* ((org-odt-embedded-images-count 0)
4273               (org-odt-embedded-formulas-count 0)
4274               (org-odt-automatic-styles nil)
4275               (org-odt-object-counters nil)
4276               ;; Let `htmlfontify' know that we are interested in collecting
4277               ;; styles.
4278               (hfy-user-sheet-assoc nil))
4279          ;; Initialize content.xml and kick-off the export process.
4280          (let ((output (org-export-as 'odt subtreep visible-only nil ext-plist))
4281                (out-buf (progn
4282                           (require 'nxml-mode)
4283                           (let ((nxml-auto-insert-xml-declaration-flag nil))
4284                             (find-file-noselect
4285                              (concat org-odt-zip-dir "content.xml") t)))))
4286            (with-current-buffer out-buf (erase-buffer) (insert output))))))))
4287
4288
4289 ;;;; Convert between OpenDocument and other formats
4290
4291 (defun org-odt-reachable-p (in-fmt out-fmt)
4292   "Return non-nil if IN-FMT can be converted to OUT-FMT."
4293   (catch 'done
4294     (let ((reachable-formats (org-odt-do-reachable-formats in-fmt)))
4295       (dolist (e reachable-formats)
4296         (let ((out-fmt-spec (assoc out-fmt (cdr e))))
4297           (when out-fmt-spec
4298             (throw 'done (cons (car e) out-fmt-spec))))))))
4299
4300 (defun org-odt-do-convert (in-file out-fmt &optional prefix-arg)
4301   "Workhorse routine for `org-odt-convert'."
4302   (require 'browse-url)
4303   (let* ((in-file (expand-file-name (or in-file buffer-file-name)))
4304          (dummy (or (file-readable-p in-file)
4305                     (error "Cannot read %s" in-file)))
4306          (in-fmt (file-name-extension in-file))
4307          (out-fmt (or out-fmt (error "Output format unspecified")))
4308          (how (or (org-odt-reachable-p in-fmt out-fmt)
4309                   (error "Cannot convert from %s format to %s format?"
4310                          in-fmt out-fmt)))
4311          (convert-process (car how))
4312          (out-file (concat (file-name-sans-extension in-file) "."
4313                            (nth 1 (or (cdr how) out-fmt))))
4314          (extra-options (or (nth 2 (cdr how)) ""))
4315          (out-dir (file-name-directory in-file))
4316          (cmd (format-spec convert-process
4317                            `((?i . ,(shell-quote-argument in-file))
4318                              (?I . ,(browse-url-file-url in-file))
4319                              (?f . ,out-fmt)
4320                              (?o . ,out-file)
4321                              (?O . ,(browse-url-file-url out-file))
4322                              (?d . , (shell-quote-argument out-dir))
4323                              (?D . ,(browse-url-file-url out-dir))
4324                              (?x . ,extra-options)))))
4325     (when (file-exists-p out-file)
4326       (delete-file out-file))
4327
4328     (message "Executing %s" cmd)
4329     (let ((cmd-output (shell-command-to-string cmd)))
4330       (message "%s" cmd-output))
4331
4332     (cond
4333      ((file-exists-p out-file)
4334       (message "Exported to %s" out-file)
4335       (when prefix-arg
4336         (message "Opening %s..."  out-file)
4337         (org-open-file out-file 'system))
4338       out-file)
4339      (t
4340       (message "Export to %s failed" out-file)
4341       nil))))
4342
4343 (defun org-odt-do-reachable-formats (in-fmt)
4344   "Return verbose info about formats to which IN-FMT can be converted.
4345 Return a list where each element is of the
4346 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST).  See
4347 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4348 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4349   (let* ((converter
4350           (and org-odt-convert-process
4351                (cadr (assoc-string org-odt-convert-process
4352                                    org-odt-convert-processes t))))
4353          (capabilities
4354           (and org-odt-convert-process
4355                (cadr (assoc-string org-odt-convert-process
4356                                    org-odt-convert-processes t))
4357                org-odt-convert-capabilities))
4358          reachable-formats)
4359     (when converter
4360       (dolist (c capabilities)
4361         (when (member in-fmt (nth 1 c))
4362           (push (cons converter (nth 2 c)) reachable-formats))))
4363     reachable-formats))
4364
4365 (defun org-odt-reachable-formats (in-fmt)
4366   "Return list of formats to which IN-FMT can be converted.
4367 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4368   (let (l)
4369     (mapc (lambda (e) (add-to-list 'l e))
4370           (apply 'append (mapcar
4371                           (lambda (e) (mapcar 'car (cdr e)))
4372                           (org-odt-do-reachable-formats in-fmt))))
4373     l))
4374
4375 (defun org-odt-convert-read-params ()
4376   "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4377 This is a helper routine for interactive use."
4378   (let* ((input (if (featurep 'ido) 'ido-completing-read 'completing-read))
4379          (in-file (read-file-name "File to be converted: "
4380                                   nil buffer-file-name t))
4381          (in-fmt (file-name-extension in-file))
4382          (out-fmt-choices (org-odt-reachable-formats in-fmt))
4383          (out-fmt
4384           (or (and out-fmt-choices
4385                    (funcall input "Output format: "
4386                             out-fmt-choices nil nil nil))
4387               (error
4388                "No known converter or no known output formats for %s files"
4389                in-fmt))))
4390     (list in-file out-fmt)))
4391
4392 ;;;###autoload
4393 (defun org-odt-convert (&optional in-file out-fmt prefix-arg)
4394   "Convert IN-FILE to format OUT-FMT using a command line converter.
4395 IN-FILE is the file to be converted.  If unspecified, it defaults
4396 to variable `buffer-file-name'.  OUT-FMT is the desired output
4397 format.  Use `org-odt-convert-process' as the converter.
4398 If PREFIX-ARG is non-nil then the newly converted file is opened
4399 using `org-open-file'."
4400   (interactive
4401    (append (org-odt-convert-read-params) current-prefix-arg))
4402   (org-odt-do-convert in-file out-fmt prefix-arg))
4403
4404 ;;; Library Initializations
4405
4406 (mapc
4407  (lambda (desc)
4408    ;; Let Emacs open all OpenDocument files in archive mode
4409    (add-to-list 'auto-mode-alist
4410                 (cons (concat  "\\." (car desc) "\\'") 'archive-mode)))
4411  org-odt-file-extensions)
4412
4413 (provide 'ox-odt)
4414
4415 ;; Local variables:
4416 ;; generated-autoload-file: "org-loaddefs.el"
4417 ;; End:
4418
4419 ;;; ox-odt.el ends here