lisp/ox-odt.el

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