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