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