Export back-ends: Use `org-export-file-uri'
[org-mode.git] / lisp / ox-odt.el
bloba8544a435d02fa4448686427e71f56c8cf936613
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2015 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-optimisations)
280 (defvar org-odt-embedded-formulas-count 0)
281 (defvar org-odt-embedded-images-count 0)
282 (defvar org-odt-image-size-probe-method
283 (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
284 '(emacs fixed))
285 "Ordered list of methods for determining image sizes.")
287 (defvar org-odt-default-image-sizes-alist
288 '(("as-char" . (5 . 0.4))
289 ("paragraph" . (5 . 5)))
290 "Hardcoded image dimensions one for each of the anchor
291 methods.")
293 ;; A4 page size is 21.0 by 29.7 cms
294 ;; The default page settings has 2cm margin on each of the sides. So
295 ;; the effective text area is 17.0 by 25.7 cm
296 (defvar org-odt-max-image-size '(17.0 . 20.0)
297 "Limiting dimensions for an embedded image.")
299 (defconst org-odt-label-styles
300 '(("math-formula" "%c" "text" "(%n)")
301 ("math-label" "(%n)" "text" "(%n)")
302 ("category-and-value" "%e %n: %c" "category-and-value" "%e %n")
303 ("value" "%e %n: %c" "value" "%n"))
304 "Specify how labels are applied and referenced.
306 This is an alist where each element is of the form:
308 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
310 ATTACH-FMT controls how labels and captions are attached to an
311 entity. It may contain following specifiers - %e and %c. %e is
312 replaced with the CATEGORY-NAME. %n is replaced with
313 \"<text:sequence ...> SEQNO </text:sequence>\". %c is replaced
314 with CAPTION.
316 REF-MODE and REF-FMT controls how label references are generated.
317 The following XML is generated for a label reference -
318 \"<text:sequence-ref text:reference-format=\"REF-MODE\" ...>
319 REF-FMT </text:sequence-ref>\". REF-FMT may contain following
320 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
321 %n is replaced with SEQNO.
323 See also `org-odt-format-label'.")
325 (defvar org-odt-category-map-alist
326 '(("__Table__" "Table" "value" "Table" org-odt--enumerable-p)
327 ("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)
328 ("__MathFormula__" "Text" "math-formula" "Equation" org-odt--enumerable-formula-p)
329 ("__DvipngImage__" "Equation" "value" "Equation" org-odt--enumerable-latex-image-p)
330 ("__Listing__" "Listing" "value" "Listing" org-odt--enumerable-p))
331 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
333 This is a list where each entry is of the form:
335 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
337 CATEGORY_HANDLE identifies the captionable entity in question.
339 OD-VARIABLE is the OpenDocument sequence counter associated with
340 the entity. These counters are declared within
341 \"<text:sequence-decls>...</text:sequence-decls>\" block of
342 `org-odt-content-template-file'.
344 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
345 how a given entity should be captioned and referenced.
347 CATEGORY-NAME is used for qualifying captions on export.
349 ENUMERATOR-PREDICATE is used for assigning a sequence number to
350 the entity. See `org-odt--enumerate'.")
352 (defvar org-odt-manifest-file-entries nil)
353 (defvar hfy-user-sheet-assoc)
355 (defvar org-odt-zip-dir nil
356 "Temporary work directory for OpenDocument exporter.")
360 ;;; User Configuration Variables
362 (defgroup org-export-odt nil
363 "Options for exporting Org mode files to ODT."
364 :tag "Org Export ODT"
365 :group 'org-export)
368 ;;;; Debugging
370 (defcustom org-odt-prettify-xml nil
371 "Specify whether or not the xml output should be prettified.
372 When this option is turned on, `indent-region' is run on all
373 component xml buffers before they are saved. Turn this off for
374 regular use. Turn this on if you need to examine the xml
375 visually."
376 :group 'org-export-odt
377 :version "24.1"
378 :type 'boolean)
381 ;;;; Document schema
383 (require 'rng-loc)
384 (defcustom org-odt-schema-dir
385 (let* ((schema-dir
386 (catch 'schema-dir
387 (message "Debug (ox-odt): Searching for OpenDocument schema files...")
388 (mapc
389 (lambda (schema-dir)
390 (when schema-dir
391 (message "Debug (ox-odt): Trying %s..." schema-dir)
392 (when (and (file-expand-wildcards
393 (expand-file-name "od-manifest-schema*.rnc"
394 schema-dir))
395 (file-expand-wildcards
396 (expand-file-name "od-schema*.rnc"
397 schema-dir))
398 (file-readable-p
399 (expand-file-name "schemas.xml" schema-dir)))
400 (message "Debug (ox-odt): Using schema files under %s"
401 schema-dir)
402 (throw 'schema-dir schema-dir))))
403 org-odt-schema-dir-list)
404 (message "Debug (ox-odt): No OpenDocument schema files installed")
405 nil)))
406 schema-dir)
407 "Directory that contains OpenDocument schema files.
409 This directory contains:
410 1. rnc files for OpenDocument schema
411 2. a \"schemas.xml\" file that specifies locating rules needed
412 for auto validation of OpenDocument XML files.
414 Use the customize interface to set this variable. This ensures
415 that `rng-schema-locating-files' is updated and auto-validation
416 of OpenDocument XML takes place based on the value
417 `rng-nxml-auto-validate-flag'.
419 The default value of this variable varies depending on the
420 version of org in use and is initialized from
421 `org-odt-schema-dir-list'. The OASIS schema files are available
422 only in the org's private git repository. It is *not* bundled
423 with GNU ELPA tar or standard Emacs distribution."
424 :type '(choice
425 (const :tag "Not set" nil)
426 (directory :tag "Schema directory"))
427 :group 'org-export-odt
428 :version "24.1"
429 :set
430 (lambda (var value)
431 "Set `org-odt-schema-dir'.
432 Also add it to `rng-schema-locating-files'."
433 (let ((schema-dir value))
434 (set var
435 (if (and
436 (file-expand-wildcards
437 (expand-file-name "od-manifest-schema*.rnc" schema-dir))
438 (file-expand-wildcards
439 (expand-file-name "od-schema*.rnc" schema-dir))
440 (file-readable-p
441 (expand-file-name "schemas.xml" schema-dir)))
442 schema-dir
443 (when value
444 (message "Error (ox-odt): %s has no OpenDocument schema files"
445 value))
446 nil)))
447 (when org-odt-schema-dir
448 (eval-after-load 'rng-loc
449 '(add-to-list 'rng-schema-locating-files
450 (expand-file-name "schemas.xml"
451 org-odt-schema-dir))))))
454 ;;;; Document styles
456 (defcustom org-odt-content-template-file nil
457 "Template file for \"content.xml\".
458 The exporter embeds the exported content just before
459 \"</office:text>\" element.
461 If unspecified, the file named \"OrgOdtContentTemplate.xml\"
462 under `org-odt-styles-dir' is used."
463 :type '(choice (const nil)
464 (file))
465 :group 'org-export-odt
466 :version "24.3")
468 (defcustom org-odt-styles-file nil
469 "Default styles file for use with ODT export.
470 Valid values are one of:
471 1. nil
472 2. path to a styles.xml file
473 3. path to a *.odt or a *.ott file
474 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
475 ...))
477 In case of option 1, an in-built styles.xml is used. See
478 `org-odt-styles-dir' for more information.
480 In case of option 3, the specified file is unzipped and the
481 styles.xml embedded therein is used.
483 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
484 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
485 generated odt file. Use relative path for specifying the
486 FILE-MEMBERS. styles.xml must be specified as one of the
487 FILE-MEMBERS.
489 Use options 1, 2 or 3 only if styles.xml alone suffices for
490 achieving the desired formatting. Use option 4, if the styles.xml
491 references additional files like header and footer images for
492 achieving the desired formatting.
494 Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
495 a per-file basis. For example,
497 #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
498 #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
499 :group 'org-export-odt
500 :version "24.1"
501 :type
502 '(choice
503 (const :tag "Factory settings" nil)
504 (file :must-match t :tag "styles.xml")
505 (file :must-match t :tag "ODT or OTT file")
506 (list :tag "ODT or OTT file + Members"
507 (file :must-match t :tag "ODF Text or Text Template file")
508 (cons :tag "Members"
509 (file :tag " Member" "styles.xml")
510 (repeat (file :tag "Member"))))))
512 (defcustom org-odt-display-outline-level 2
513 "Outline levels considered for enumerating captioned entities."
514 :group 'org-export-odt
515 :version "24.4"
516 :package-version '(Org . "8.0")
517 :type 'integer)
519 ;;;; Document conversion
521 (defcustom org-odt-convert-processes
522 '(("LibreOffice"
523 "soffice --headless --convert-to %f%x --outdir %d %i")
524 ("unoconv"
525 "unoconv -f %f -o %d %i"))
526 "Specify a list of document converters and their usage.
527 The converters in this list are offered as choices while
528 customizing `org-odt-convert-process'.
530 This variable is a list where each element is of the
531 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
532 of the converter. CONVERTER-CMD is the shell command for the
533 converter and can contain format specifiers. These format
534 specifiers are interpreted as below:
536 %i input file name in full
537 %I input file name as a URL
538 %f format of the output file
539 %o output file name in full
540 %O output file name as a URL
541 %d output dir in full
542 %D output dir as a URL.
543 %x extra options as set in `org-odt-convert-capabilities'."
544 :group 'org-export-odt
545 :version "24.1"
546 :type
547 '(choice
548 (const :tag "None" nil)
549 (alist :tag "Converters"
550 :key-type (string :tag "Converter Name")
551 :value-type (group (string :tag "Command line")))))
553 (defcustom org-odt-convert-process "LibreOffice"
554 "Use this converter to convert from \"odt\" format to other formats.
555 During customization, the list of converter names are populated
556 from `org-odt-convert-processes'."
557 :group 'org-export-odt
558 :version "24.1"
559 :type '(choice :convert-widget
560 (lambda (w)
561 (apply 'widget-convert (widget-type w)
562 (eval (car (widget-get w :args)))))
563 `((const :tag "None" nil)
564 ,@(mapcar (lambda (c)
565 `(const :tag ,(car c) ,(car c)))
566 org-odt-convert-processes))))
568 (defcustom org-odt-convert-capabilities
569 '(("Text"
570 ("odt" "ott" "doc" "rtf" "docx")
571 (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
572 ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
573 ("Web"
574 ("html")
575 (("pdf" "pdf") ("odt" "odt") ("html" "html")))
576 ("Spreadsheet"
577 ("ods" "ots" "xls" "csv" "xlsx")
578 (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
579 ("xls" "xls") ("xlsx" "xlsx")))
580 ("Presentation"
581 ("odp" "otp" "ppt" "pptx")
582 (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
583 ("pptx" "pptx") ("odg" "odg"))))
584 "Specify input and output formats of `org-odt-convert-process'.
585 More correctly, specify the set of input and output formats that
586 the user is actually interested in.
588 This variable is an alist where each element is of the
589 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
590 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
591 alist where each element is of the form (OUTPUT-FMT
592 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
594 The variable is interpreted as follows:
595 `org-odt-convert-process' can take any document that is in
596 INPUT-FMT-LIST and produce any document that is in the
597 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
598 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
599 serves dual purposes:
600 - It is used for populating completion candidates during
601 `org-odt-convert' commands.
602 - It is used as the value of \"%f\" specifier in
603 `org-odt-convert-process'.
605 EXTRA-OPTIONS is used as the value of \"%x\" specifier in
606 `org-odt-convert-process'.
608 DOCUMENT-CLASS is used to group a set of file formats in
609 INPUT-FMT-LIST in to a single class.
611 Note that this variable inherently captures how LibreOffice based
612 converters work. LibreOffice maps documents of various formats
613 to classes like Text, Web, Spreadsheet, Presentation etc and
614 allow document of a given class (irrespective of its source
615 format) to be converted to any of the export formats associated
616 with that class.
618 See default setting of this variable for an typical
619 configuration."
620 :group 'org-export-odt
621 :version "24.1"
622 :type
623 '(choice
624 (const :tag "None" nil)
625 (alist :tag "Capabilities"
626 :key-type (string :tag "Document Class")
627 :value-type
628 (group (repeat :tag "Input formats" (string :tag "Input format"))
629 (alist :tag "Output formats"
630 :key-type (string :tag "Output format")
631 :value-type
632 (group (string :tag "Output file extension")
633 (choice
634 (const :tag "None" nil)
635 (string :tag "Extra options"))))))))
637 (defcustom org-odt-preferred-output-format nil
638 "Automatically post-process to this format after exporting to \"odt\".
639 Command `org-odt-export-to-odt' exports first to \"odt\" format
640 and then uses `org-odt-convert-process' to convert the
641 resulting document to this format. During customization of this
642 variable, the list of valid values are populated based on
643 `org-odt-convert-capabilities'.
645 You can set this option on per-file basis using file local
646 values. See Info node `(emacs) File Variables'."
647 :group 'org-export-odt
648 :version "24.1"
649 :type '(choice :convert-widget
650 (lambda (w)
651 (apply 'widget-convert (widget-type w)
652 (eval (car (widget-get w :args)))))
653 `((const :tag "None" nil)
654 ,@(mapcar (lambda (c)
655 `(const :tag ,c ,c))
656 (org-odt-reachable-formats "odt")))))
657 ;;;###autoload
658 (put 'org-odt-preferred-output-format 'safe-local-variable 'stringp)
661 ;;;; Drawers
663 (defcustom org-odt-format-drawer-function
664 (lambda (name contents) contents)
665 "Function called to format a drawer in ODT code.
667 The function must accept two parameters:
668 NAME the drawer name, like \"LOGBOOK\"
669 CONTENTS the contents of the drawer.
671 The function should return the string to be exported.
673 The default value simply returns the value of CONTENTS."
674 :group 'org-export-odt
675 :version "24.4"
676 :package-version '(Org . "8.3")
677 :type 'function)
680 ;;;; Headline
682 (defcustom org-odt-format-headline-function
683 'org-odt-format-headline-default-function
684 "Function to format headline text.
686 This function will be called with 5 arguments:
687 TODO the todo keyword \(string or nil\).
688 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
689 PRIORITY the priority of the headline \(integer or nil\)
690 TEXT the main headline text \(string\).
691 TAGS the tags string, separated with colons \(string or nil\).
693 The function result will be used as headline text."
694 :group 'org-export-odt
695 :version "25.1"
696 :package-version '(Org . "8.3")
697 :type 'function)
700 ;;;; Inlinetasks
702 (defcustom org-odt-format-inlinetask-function
703 'org-odt-format-inlinetask-default-function
704 "Function called to format an inlinetask in ODT code.
706 The function must accept six parameters:
707 TODO the todo keyword, as a string
708 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
709 PRIORITY the inlinetask priority, as a string
710 NAME the inlinetask name, as a string.
711 TAGS the inlinetask tags, as a string.
712 CONTENTS the contents of the inlinetask, as a string.
714 The function should return the string to be exported."
715 :group 'org-export-odt
716 :version "25.1"
717 :package-version '(Org . "8.3")
718 :type 'function)
721 ;;;; LaTeX
723 (defcustom org-odt-with-latex org-export-with-latex
724 "Non-nil means process LaTeX math snippets.
726 When set, the exporter will process LaTeX environments and
727 fragments.
729 This option can also be set with the +OPTIONS line,
730 e.g. \"tex:mathjax\". Allowed values are:
732 nil Ignore math snippets.
733 `verbatim' Keep everything in verbatim
734 `dvipng' Process the LaTeX fragments to images. This will also
735 include processing of non-math environments.
736 `imagemagick' Convert the LaTeX fragments to pdf files and use
737 imagemagick to convert pdf files to png files.
738 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
739 be loaded.
740 t Synonym for `mathjax'."
741 :group 'org-export-odt
742 :version "24.4"
743 :package-version '(Org . "8.0")
744 :type '(choice
745 (const :tag "Do not process math in any way" nil)
746 (const :tag "Use dvipng to make images" dvipng)
747 (const :tag "Use imagemagick to make images" imagemagick)
748 (const :tag "Use MathJax to display math" mathjax)
749 (const :tag "Leave math verbatim" verbatim)))
752 ;;;; Links
754 (defcustom org-odt-inline-formula-rules
755 '(("file" . "\\.\\(mathml\\|mml\\|odf\\)\\'"))
756 "Rules characterizing formula files that can be inlined into ODT.
758 A rule consists in an association whose key is the type of link
759 to consider, and value is a regexp that will be matched against
760 link's path."
761 :group 'org-export-odt
762 :version "24.4"
763 :package-version '(Org . "8.0")
764 :type '(alist :key-type (string :tag "Type")
765 :value-type (regexp :tag "Path")))
767 (defcustom org-odt-inline-image-rules
768 '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\)\\'"))
769 "Rules characterizing image files that can be inlined into ODT.
771 A rule consists in an association whose key is the type of link
772 to consider, and value is a regexp that will be matched against
773 link's path."
774 :group 'org-export-odt
775 :version "24.4"
776 :package-version '(Org . "8.0")
777 :type '(alist :key-type (string :tag "Type")
778 :value-type (regexp :tag "Path")))
780 (defcustom org-odt-pixels-per-inch 96.0
781 "Scaling factor for converting images pixels to inches.
782 Use this for sizing of embedded images. See Info node `(org)
783 Images in ODT export' for more information."
784 :type 'float
785 :group 'org-export-odt
786 :version "24.4"
787 :package-version '(Org . "8.1"))
790 ;;;; Src Block
792 (defcustom org-odt-create-custom-styles-for-srcblocks t
793 "Whether custom styles for colorized source blocks be automatically created.
794 When this option is turned on, the exporter creates custom styles
795 for source blocks based on the advice of `htmlfontify'. Creation
796 of custom styles happen as part of `org-odt-hfy-face-to-css'.
798 When this option is turned off exporter does not create such
799 styles.
801 Use the latter option if you do not want the custom styles to be
802 based on your current display settings. It is necessary that the
803 styles.xml already contains needed styles for colorizing to work.
805 This variable is effective only if `org-odt-fontify-srcblocks' is
806 turned on."
807 :group 'org-export-odt
808 :version "24.1"
809 :type 'boolean)
811 (defcustom org-odt-fontify-srcblocks t
812 "Specify whether or not source blocks need to be fontified.
813 Turn this option on if you want to colorize the source code
814 blocks in the exported file. For colorization to work, you need
815 to make available an enhanced version of `htmlfontify' library."
816 :type 'boolean
817 :group 'org-export-odt
818 :version "24.1")
821 ;;;; Table
823 (defcustom org-odt-table-styles
824 '(("OrgEquation" "OrgEquation"
825 ((use-first-column-styles . t)
826 (use-last-column-styles . t)))
827 ("TableWithHeaderRowAndColumn" "Custom"
828 ((use-first-row-styles . t)
829 (use-first-column-styles . t)))
830 ("TableWithFirstRowandLastRow" "Custom"
831 ((use-first-row-styles . t)
832 (use-last-row-styles . t)))
833 ("GriddedTable" "Custom" nil))
834 "Specify how Table Styles should be derived from a Table Template.
835 This is a list where each element is of the
836 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
838 TABLE-STYLE-NAME is the style associated with the table through
839 \"#+ATTR_ODT: :style TABLE-STYLE-NAME\" line.
841 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
842 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
843 below) that is included in `org-odt-content-template-file'.
845 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
846 \"TableCell\"
847 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
848 \"TableParagraph\"
849 TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
850 \"FirstRow\" | \"LastRow\" |
851 \"EvenRow\" | \"OddRow\" |
852 \"EvenColumn\" | \"OddColumn\" | \"\"
853 where \"+\" above denotes string concatenation.
855 TABLE-CELL-OPTIONS is an alist where each element is of the
856 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
857 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
858 `use-last-row-styles' |
859 `use-first-column-styles' |
860 `use-last-column-styles' |
861 `use-banding-rows-styles' |
862 `use-banding-columns-styles' |
863 `use-first-row-styles'
864 ON-OR-OFF := `t' | `nil'
866 For example, with the following configuration
868 \(setq org-odt-table-styles
869 '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
870 \(\(use-first-row-styles . t\)
871 \(use-first-column-styles . t\)\)\)
872 \(\"TableWithHeaderColumns\" \"Custom\"
873 \(\(use-first-column-styles . t\)\)\)\)\)
875 1. A table associated with \"TableWithHeaderRowsAndColumns\"
876 style will use the following table-cell styles -
877 \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
878 \"CustomTableCell\" and the following paragraph styles
879 \"CustomFirstRowTableParagraph\",
880 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
881 as appropriate.
883 2. A table associated with \"TableWithHeaderColumns\" style will
884 use the following table-cell styles -
885 \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
886 following paragraph styles
887 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
888 as appropriate..
890 Note that TABLE-TEMPLATE-NAME corresponds to the
891 \"<table:table-template>\" elements contained within
892 \"<office:styles>\". The entries (TABLE-STYLE-NAME
893 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
894 \"table:template-name\" and \"table:use-first-row-styles\" etc
895 attributes of \"<table:table>\" element. Refer ODF-1.2
896 specification for more information. Also consult the
897 implementation filed under `org-odt-get-table-cell-styles'.
899 The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
900 formatting of numbered display equations. Do not delete this
901 style from the list."
902 :group 'org-export-odt
903 :version "24.1"
904 :type '(choice
905 (const :tag "None" nil)
906 (repeat :tag "Table Styles"
907 (list :tag "Table Style Specification"
908 (string :tag "Table Style Name")
909 (string :tag "Table Template Name")
910 (alist :options (use-first-row-styles
911 use-last-row-styles
912 use-first-column-styles
913 use-last-column-styles
914 use-banding-rows-styles
915 use-banding-columns-styles)
916 :key-type symbol
917 :value-type (const :tag "True" t))))))
919 ;;;; Timestamps
921 (defcustom org-odt-use-date-fields nil
922 "Non-nil, if timestamps should be exported as date fields.
924 When nil, export timestamps as plain text.
926 When non-nil, map `org-time-stamp-custom-formats' to a pair of
927 OpenDocument date-styles with names \"OrgDate1\" and \"OrgDate2\"
928 respectively. A timestamp with no time component is formatted
929 with style \"OrgDate1\" while one with explicit hour and minutes
930 is formatted with style \"OrgDate2\".
932 This feature is experimental. Most (but not all) of the common
933 %-specifiers in `format-time-string' are supported.
934 Specifically, locale-dependent specifiers like \"%c\", \"%x\" are
935 formatted as canonical Org timestamps. For finer control, avoid
936 these %-specifiers.
938 Textual specifiers like \"%b\", \"%h\", \"%B\", \"%a\", \"%A\"
939 etc., are displayed by the application in the default language
940 and country specified in `org-odt-styles-file'. Note that the
941 default styles file uses language \"en\" and country \"GB\". You
942 can localize the week day and month strings in the exported
943 document by setting the default language and country either using
944 the application UI or through a custom styles file.
946 See `org-odt--build-date-styles' for implementation details."
947 :group 'org-export-odt
948 :version "24.4"
949 :package-version '(Org . "8.0")
950 :type 'boolean)
954 ;;; Internal functions
956 ;;;; Date
958 (defun org-odt--format-timestamp (timestamp &optional end iso-date-p)
959 (let* ((format-timestamp
960 (lambda (timestamp format &optional end utc)
961 (if timestamp
962 (org-timestamp-format timestamp format end utc)
963 (format-time-string format nil utc))))
964 (has-time-p (or (not timestamp)
965 (org-timestamp-has-time-p timestamp)))
966 (iso-date (let ((format (if has-time-p "%Y-%m-%dT%H:%M:%S"
967 "%Y-%m-%dT%H:%M:%S")))
968 (funcall format-timestamp timestamp format end))))
969 (if iso-date-p iso-date
970 (let* ((style (if has-time-p "OrgDate2" "OrgDate1"))
971 ;; LibreOffice does not care about end goes as content
972 ;; within the "<text:date>...</text:date>" field. The
973 ;; displayed date is automagically corrected to match the
974 ;; format requested by "style:data-style-name" attribute. So
975 ;; don't bother about formatting the date contents to be
976 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
977 ;; simple Org-style date should suffice.
978 (date (let* ((formats
979 (if org-display-custom-times
980 (cons (substring
981 (car org-time-stamp-custom-formats) 1 -1)
982 (substring
983 (cdr org-time-stamp-custom-formats) 1 -1))
984 '("%Y-%m-%d %a" . "%Y-%m-%d %a %H:%M")))
985 (format (if has-time-p (cdr formats) (car formats))))
986 (funcall format-timestamp timestamp format end)))
987 (repeater (let ((repeater-type (org-element-property
988 :repeater-type timestamp))
989 (repeater-value (org-element-property
990 :repeater-value timestamp))
991 (repeater-unit (org-element-property
992 :repeater-unit timestamp)))
993 (concat
994 (case repeater-type
995 (catchup "++") (restart ".+") (cumulate "+"))
996 (when repeater-value
997 (number-to-string repeater-value))
998 (case repeater-unit
999 (hour "h") (day "d") (week "w") (month "m")
1000 (year "y"))))))
1001 (concat
1002 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1003 iso-date style date)
1004 (and (not (string= repeater "")) " ")
1005 repeater)))))
1007 ;;;; Frame
1009 (defun org-odt--frame (text width height style &optional extra
1010 anchor-type &rest title-and-desc)
1011 (let ((frame-attrs
1012 (concat
1013 (if width (format " svg:width=\"%0.2fcm\"" width) "")
1014 (if height (format " svg:height=\"%0.2fcm\"" height) "")
1015 extra
1016 (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph"))
1017 (format " draw:name=\"%s\""
1018 (car (org-odt-add-automatic-style "Frame"))))))
1019 (format
1020 "\n<draw:frame draw:style-name=\"%s\"%s>\n%s\n</draw:frame>"
1021 style frame-attrs
1022 (concat text
1023 (let ((title (car title-and-desc))
1024 (desc (cadr title-and-desc)))
1025 (concat (when title
1026 (format "<svg:title>%s</svg:title>"
1027 (org-odt--encode-plain-text title t)))
1028 (when desc
1029 (format "<svg:desc>%s</svg:desc>"
1030 (org-odt--encode-plain-text desc t)))))))))
1033 ;;;; Library wrappers
1035 (defun org-odt--zip-extract (archive members target)
1036 (when (atom members) (setq members (list members)))
1037 (mapc (lambda (member)
1038 (require 'arc-mode)
1039 (let* ((--quote-file-name
1040 ;; This is shamelessly stolen from `archive-zip-extract'.
1041 (lambda (name)
1042 (if (or (not (memq system-type '(windows-nt ms-dos)))
1043 (and (boundp 'w32-quote-process-args)
1044 (null w32-quote-process-args)))
1045 (shell-quote-argument name)
1046 name)))
1047 (target (funcall --quote-file-name target))
1048 (archive (expand-file-name archive))
1049 (archive-zip-extract
1050 (list "unzip" "-qq" "-o" "-d" target))
1051 exit-code command-output)
1052 (setq command-output
1053 (with-temp-buffer
1054 (setq exit-code (archive-zip-extract archive member))
1055 (buffer-string)))
1056 (unless (zerop exit-code)
1057 (message command-output)
1058 (error "Extraction failed"))))
1059 members))
1061 ;;;; Target
1063 (defun org-odt--target (text id)
1064 (if (not id) text
1065 (concat
1066 (format "\n<text:bookmark-start text:name=\"OrgXref.%s\"/>" id)
1067 (format "\n<text:bookmark text:name=\"%s\"/>" id) text
1068 (format "\n<text:bookmark-end text:name=\"OrgXref.%s\"/>" id))))
1070 ;;;; Textbox
1072 (defun org-odt--textbox (text width height style &optional
1073 extra anchor-type)
1074 (org-odt--frame
1075 (format "\n<draw:text-box %s>%s\n</draw:text-box>"
1076 (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
1077 (and (not width)
1078 (format " fo:min-width=\"%0.2fcm\"" (or width .2))))
1079 text)
1080 width nil style extra anchor-type))
1084 ;;;; Table of Contents
1086 (defun org-odt--format-toc (title entries depth)
1087 "Return a table of contents.
1088 TITLE is the title of the table, as a string, or nil. ENTRIES is
1089 the contents of the table, as a string. DEPTH is an integer
1090 specifying the depth of the table."
1091 (concat
1093 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1094 (format " <text:table-of-content-source text:outline-level=\"%d\">" depth)
1095 (and title
1096 (format "
1097 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1099 title))
1101 (let ((levels (number-sequence 1 10)))
1102 (mapconcat
1103 (lambda (level)
1104 (format
1106 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1107 <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
1108 <text:index-entry-chapter/>
1109 <text:index-entry-text/>
1110 <text:index-entry-link-end/>
1111 </text:table-of-content-entry-template>\n"
1112 level level)) levels ""))
1114 </text:table-of-content-source>
1115 <text:index-body>"
1116 (and title
1117 (format "
1118 <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
1119 <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
1120 </text:index-title>\n"
1121 title))
1122 entries
1124 </text:index-body>
1125 </text:table-of-content>"))
1127 (defun* org-odt-format-toc-headline
1128 (todo todo-type priority text tags
1129 &key level section-number headline-label &allow-other-keys)
1130 (setq text
1131 (concat
1132 ;; Section number.
1133 (and section-number (concat section-number ". "))
1134 ;; Todo.
1135 (when todo
1136 (let ((style (if (member todo org-done-keywords)
1137 "OrgDone" "OrgTodo")))
1138 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1139 style todo)))
1140 (when priority
1141 (let* ((style (format "OrgPriority-%s" priority))
1142 (priority (format "[#%c]" priority)))
1143 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1144 style priority)))
1145 ;; Title.
1146 text
1147 ;; Tags.
1148 (when tags
1149 (concat
1150 (format " <text:span text:style-name=\"%s\">[%s]</text:span>"
1151 "OrgTags"
1152 (mapconcat
1153 (lambda (tag)
1154 (format
1155 "<text:span text:style-name=\"%s\">%s</text:span>"
1156 "OrgTag" tag)) tags " : "))))))
1157 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
1158 headline-label text))
1160 (defun org-odt-toc (depth info &optional scope)
1161 "Build a table of contents.
1162 DEPTH is an integer specifying the depth of the table. INFO is
1163 a plist containing current export properties. Optional argument
1164 SCOPE, when non-nil, defines the scope of the table. Return the
1165 table of contents as a string, or nil."
1166 (assert (wholenump depth))
1167 ;; When a headline is marked as a radio target, as in the example below:
1169 ;; ** <<<Some Heading>>>
1170 ;; Some text.
1172 ;; suppress generation of radio targets. i.e., Radio targets are to
1173 ;; be marked as targets within /document body/ and *not* within
1174 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1175 ;; and one in the document body.
1177 ;; FIXME: Are there any other objects that need to be suppressed
1178 ;; within TOC?
1179 (let* ((headlines (org-export-collect-headlines info depth scope))
1180 (backend (org-export-create-backend
1181 :parent (org-export-backend-name (plist-get info :back-end))
1182 :transcoders (mapcar
1183 (lambda (type) (cons type (lambda (d c i) c)))
1184 (list 'radio-target)))))
1185 (when headlines
1186 (org-odt--format-toc
1187 (and (not scope) (org-export-translate "Table of Contents" :utf-8 info))
1188 (mapconcat
1189 (lambda (headline)
1190 (let* ((entry (org-odt-format-headline--wrap
1191 headline backend info 'org-odt-format-toc-headline))
1192 (level (org-export-get-relative-level headline info))
1193 (style (format "Contents_20_%d" level)))
1194 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1195 style entry)))
1196 headlines "\n")
1197 depth))))
1200 ;;;; Document styles
1202 (defun org-odt-add-automatic-style (object-type &optional object-props)
1203 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1204 OBJECT-PROPS is (typically) a plist created by passing
1205 \"#+ATTR_ODT: \" option of the object in question to
1206 `org-odt-parse-block-attributes'.
1208 Use `org-odt-object-counters' to generate an automatic
1209 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1210 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1211 . STYLE-NAME)."
1212 (assert (stringp object-type))
1213 (let* ((object (intern object-type))
1214 (seqvar object)
1215 (seqno (1+ (or (plist-get org-odt-object-counters seqvar) 0)))
1216 (object-name (format "%s%d" object-type seqno)) style-name)
1217 (setq org-odt-object-counters
1218 (plist-put org-odt-object-counters seqvar seqno))
1219 (when object-props
1220 (setq style-name (format "Org%s" object-name))
1221 (setq org-odt-automatic-styles
1222 (plist-put org-odt-automatic-styles object
1223 (append (list (list style-name object-props))
1224 (plist-get org-odt-automatic-styles object)))))
1225 (cons object-name style-name)))
1227 ;;;; Checkbox
1229 (defun org-odt--checkbox (item)
1230 "Return check-box string associated to ITEM."
1231 (let ((checkbox (org-element-property :checkbox item)))
1232 (if (not checkbox) ""
1233 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1234 "OrgCode" (case checkbox
1235 (on "[&#x2713;] ") ; CHECK MARK
1236 (off "[ ] ")
1237 (trans "[-] "))))))
1239 ;;; Template
1241 (defun org-odt--build-date-styles (fmt style)
1242 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1243 ;; to modify the date fields. A date could be modified by
1244 ;; offsetting in days. That's about it. Also, date and time may
1245 ;; have to be emitted as two fields - a date field and a time field
1246 ;; - separately.
1248 ;; One can add Form Controls to date and time fields so that they
1249 ;; can be easily modified. But then, the exported document will
1250 ;; become tightly coupled with LibreOffice and may not function
1251 ;; properly with other OpenDocument applications.
1253 ;; I have a strange feeling that Date styles are a bit flaky at the
1254 ;; moment.
1256 ;; The feature is experimental.
1257 (when (and fmt style)
1258 (let* ((fmt-alist
1259 '(("%A" . "<number:day-of-week number:style=\"long\"/>")
1260 ("%B" . "<number:month number:textual=\"true\" number:style=\"long\"/>")
1261 ("%H" . "<number:hours number:style=\"long\"/>")
1262 ("%M" . "<number:minutes number:style=\"long\"/>")
1263 ("%S" . "<number:seconds number:style=\"long\"/>")
1264 ("%V" . "<number:week-of-year/>")
1265 ("%Y" . "<number:year number:style=\"long\"/>")
1266 ("%a" . "<number:day-of-week number:style=\"short\"/>")
1267 ("%b" . "<number:month number:textual=\"true\" number:style=\"short\"/>")
1268 ("%d" . "<number:day number:style=\"long\"/>")
1269 ("%e" . "<number:day number:style=\"short\"/>")
1270 ("%h" . "<number:month number:textual=\"true\" number:style=\"short\"/>")
1271 ("%k" . "<number:hours number:style=\"short\"/>")
1272 ("%m" . "<number:month number:style=\"long\"/>")
1273 ("%p" . "<number:am-pm/>")
1274 ("%y" . "<number:year number:style=\"short\"/>")))
1275 (case-fold-search nil)
1276 (re (mapconcat 'identity (mapcar 'car fmt-alist) "\\|"))
1277 match rpl (start 0) (filler-beg 0) filler-end filler output)
1278 (mapc
1279 (lambda (pair)
1280 (setq fmt (replace-regexp-in-string (car pair) (cdr pair) fmt t t)))
1281 '(("\\(?:%[[:digit:]]*N\\)" . "") ; strip ns, us and ns
1282 ("%C" . "Y") ; replace century with year
1283 ("%D" . "%m/%d/%y")
1284 ("%G" . "Y") ; year corresponding to iso week
1285 ("%I" . "%H") ; hour on a 12-hour clock
1286 ("%R" . "%H:%M")
1287 ("%T" . "%H:%M:%S")
1288 ("%U\\|%W" . "%V") ; week no. starting on Sun./Mon.
1289 ("%Z" . "") ; time zone name
1290 ("%c" . "%Y-%M-%d %a %H:%M" ) ; locale's date and time format
1291 ("%g" . "%y")
1292 ("%X" . "%x" ) ; locale's pref. time format
1293 ("%j" . "") ; day of the year
1294 ("%l" . "%k") ; like %I blank-padded
1295 ("%s" . "") ; no. of secs since 1970-01-01 00:00:00 +0000
1296 ("%n" . "<text:line-break/>")
1297 ("%r" . "%I:%M:%S %p")
1298 ("%t" . "<text:tab/>")
1299 ("%u\\|%w" . "") ; numeric day of week - Mon (1-7), Sun(0-6)
1300 ("%x" . "%Y-%M-%d %a") ; locale's pref. time format
1301 ("%z" . "") ; time zone in numeric form
1303 (while (string-match re fmt start)
1304 (setq match (match-string 0 fmt))
1305 (setq rpl (assoc-default match fmt-alist))
1306 (setq start (match-end 0))
1307 (setq filler-end (match-beginning 0))
1308 (setq filler (substring fmt (prog1 filler-beg
1309 (setq filler-beg (match-end 0)))
1310 filler-end))
1311 (setq filler (and (not (string= filler ""))
1312 (format "<number:text>%s</number:text>"
1313 (org-odt--encode-plain-text filler))))
1314 (setq output (concat output "\n" filler "\n" rpl)))
1315 (setq filler (substring fmt filler-beg))
1316 (unless (string= filler "")
1317 (setq output (concat output
1318 (format "\n<number:text>%s</number:text>"
1319 (org-odt--encode-plain-text filler)))))
1320 (format "\n<number:date-style style:name=\"%s\" %s>%s\n</number:date-style>"
1321 style
1322 (concat " number:automatic-order=\"true\""
1323 " number:format-source=\"fixed\"")
1324 output ))))
1326 (defun org-odt-template (contents info)
1327 "Return complete document string after ODT conversion.
1328 CONTENTS is the transcoded contents string. RAW-DATA is the
1329 original parsed data. INFO is a plist holding export options."
1330 ;; Write meta file.
1331 (let ((title (org-export-data (plist-get info :title) info))
1332 (subtitle (org-export-data (plist-get info :subtitle) info))
1333 (author (let ((author (plist-get info :author)))
1334 (if (not author) "" (org-export-data author info))))
1335 (email (plist-get info :email))
1336 (keywords (or (plist-get info :keywords) ""))
1337 (description (or (plist-get info :description) "")))
1338 (write-region
1339 (concat
1340 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
1341 <office:document-meta
1342 xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
1343 xmlns:xlink=\"http://www.w3.org/1999/xlink\"
1344 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
1345 xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
1346 xmlns:ooo=\"http://openoffice.org/2004/office\"
1347 office:version=\"1.2\">
1348 <office:meta>\n"
1349 (format "<dc:creator>%s</dc:creator>\n" author)
1350 (format "<meta:initial-creator>%s</meta:initial-creator>\n" author)
1351 ;; Date, if required.
1352 (when (plist-get info :with-date)
1353 ;; Check if DATE is specified as an Org-timestamp. If yes,
1354 ;; include it as meta information. Otherwise, just use
1355 ;; today's date.
1356 (let* ((date (let ((date (plist-get info :date)))
1357 (and (not (cdr date))
1358 (eq (org-element-type (car date)) 'timestamp)
1359 (car date)))))
1360 (let ((iso-date (org-odt--format-timestamp date nil 'iso-date)))
1361 (concat
1362 (format "<dc:date>%s</dc:date>\n" iso-date)
1363 (format "<meta:creation-date>%s</meta:creation-date>\n"
1364 iso-date)))))
1365 (format "<meta:generator>%s</meta:generator>\n"
1366 (plist-get info :creator))
1367 (format "<meta:keyword>%s</meta:keyword>\n" keywords)
1368 (format "<dc:subject>%s</dc:subject>\n" description)
1369 (format "<dc:title>%s</dc:title>\n" title)
1370 (when (org-string-nw-p subtitle)
1371 (format
1372 "<meta:user-defined meta:name=\"subtitle\">%s</meta:user-defined>\n"
1373 subtitle))
1374 "\n"
1375 " </office:meta>\n" "</office:document-meta>")
1376 nil (concat org-odt-zip-dir "meta.xml"))
1377 ;; Add meta.xml in to manifest.
1378 (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
1380 ;; Update styles file.
1381 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1382 ;; Write styles file.
1383 (let* ((styles-file (plist-get info :odt-styles-file))
1384 (styles-file (and styles-file (read (org-trim styles-file))))
1385 ;; Non-availability of styles.xml is not a critical
1386 ;; error. For now, throw an error.
1387 (styles-file (or styles-file
1388 (plist-get info :odt-styles-file)
1389 (expand-file-name "OrgOdtStyles.xml"
1390 org-odt-styles-dir)
1391 (error "org-odt: Missing styles file?"))))
1392 (cond
1393 ((listp styles-file)
1394 (let ((archive (nth 0 styles-file))
1395 (members (nth 1 styles-file)))
1396 (org-odt--zip-extract archive members org-odt-zip-dir)
1397 (mapc
1398 (lambda (member)
1399 (when (org-file-image-p member)
1400 (let* ((image-type (file-name-extension member))
1401 (media-type (format "image/%s" image-type)))
1402 (org-odt-create-manifest-file-entry media-type member))))
1403 members)))
1404 ((and (stringp styles-file) (file-exists-p styles-file))
1405 (let ((styles-file-type (file-name-extension styles-file)))
1406 (cond
1407 ((string= styles-file-type "xml")
1408 (copy-file styles-file (concat org-odt-zip-dir "styles.xml") t))
1409 ((member styles-file-type '("odt" "ott"))
1410 (org-odt--zip-extract styles-file "styles.xml" org-odt-zip-dir)))))
1412 (error (format "Invalid specification of styles.xml file: %S"
1413 (plist-get info :odt-styles-file)))))
1415 ;; create a manifest entry for styles.xml
1416 (org-odt-create-manifest-file-entry "text/xml" "styles.xml")
1418 ;; FIXME: Who is opening an empty styles.xml before this point?
1419 (with-current-buffer
1420 (find-file-noselect (concat org-odt-zip-dir "styles.xml") t)
1421 (revert-buffer t t)
1423 ;; Write custom styles for source blocks
1424 ;; Save STYLES used for colorizing of source blocks.
1425 ;; Update styles.xml with styles that were collected as part of
1426 ;; `org-odt-hfy-face-to-css' callbacks.
1427 (let ((styles (mapconcat (lambda (style) (format " %s\n" (cddr style)))
1428 hfy-user-sheet-assoc "")))
1429 (when styles
1430 (goto-char (point-min))
1431 (when (re-search-forward "</office:styles>" nil t)
1432 (goto-char (match-beginning 0))
1433 (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n"))))
1435 ;; Update styles.xml - take care of outline numbering
1437 ;; Don't make automatic backup of styles.xml file. This setting
1438 ;; prevents the backed-up styles.xml file from being zipped in to
1439 ;; odt file. This is more of a hackish fix. Better alternative
1440 ;; would be to fix the zip command so that the output odt file
1441 ;; includes only the needed files and excludes any auto-generated
1442 ;; extra files like backups and auto-saves etc etc. Note that
1443 ;; currently the zip command zips up the entire temp directory so
1444 ;; that any auto-generated files created under the hood ends up in
1445 ;; the resulting odt file.
1446 (set (make-local-variable 'backup-inhibited) t)
1448 ;; Outline numbering is retained only upto LEVEL.
1449 ;; To disable outline numbering pass a LEVEL of 0.
1451 (goto-char (point-min))
1452 (let ((regex
1453 "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
1454 (replacement
1455 "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
1456 (while (re-search-forward regex nil t)
1457 (unless (let ((sec-num (plist-get info :section-numbers))
1458 (level (string-to-number (match-string 2))))
1459 (if (wholenump sec-num) (<= level sec-num) sec-num))
1460 (replace-match replacement t nil))))
1461 (save-buffer 0)))
1462 ;; Update content.xml.
1464 (let* ( ;; `org-display-custom-times' should be accessed right
1465 ;; within the context of the Org buffer. So obtain its
1466 ;; value before moving on to temp-buffer context down below.
1467 (custom-time-fmts
1468 (if org-display-custom-times
1469 (cons (substring (car org-time-stamp-custom-formats) 1 -1)
1470 (substring (cdr org-time-stamp-custom-formats) 1 -1))
1471 '("%Y-%M-%d %a" . "%Y-%M-%d %a %H:%M"))))
1472 (with-temp-buffer
1473 (insert-file-contents
1474 (or (plist-get info :odt-content-template-file)
1475 (expand-file-name "OrgOdtContentTemplate.xml"
1476 org-odt-styles-dir)))
1477 ;; Write automatic styles.
1478 ;; - Position the cursor.
1479 (goto-char (point-min))
1480 (re-search-forward " </office:automatic-styles>" nil t)
1481 (goto-char (match-beginning 0))
1482 ;; - Dump automatic table styles.
1483 (loop for (style-name props) in
1484 (plist-get org-odt-automatic-styles 'Table) do
1485 (when (setq props (or (plist-get props :rel-width) "96"))
1486 (insert (format org-odt-table-style-format style-name props))))
1487 ;; - Dump date-styles.
1488 (when (plist-get info :odt-use-date-fields)
1489 (insert (org-odt--build-date-styles (car custom-time-fmts)
1490 "OrgDate1")
1491 (org-odt--build-date-styles (cdr custom-time-fmts)
1492 "OrgDate2")))
1493 ;; Update display level.
1494 ;; - Remove existing sequence decls. Also position the cursor.
1495 (goto-char (point-min))
1496 (when (re-search-forward "<text:sequence-decls" nil t)
1497 (delete-region (match-beginning 0)
1498 (re-search-forward "</text:sequence-decls>" nil nil)))
1499 ;; Update sequence decls according to user preference.
1500 (insert
1501 (format
1502 "\n<text:sequence-decls>\n%s\n</text:sequence-decls>"
1503 (mapconcat
1504 (lambda (x)
1505 (format
1506 "<text:sequence-decl text:display-outline-level=\"%d\" text:name=\"%s\"/>"
1507 (plist-get info :odt-display-outline-level)
1508 (nth 1 x)))
1509 org-odt-category-map-alist "\n")))
1510 ;; Position the cursor to document body.
1511 (goto-char (point-min))
1512 (re-search-forward "</office:text>" nil nil)
1513 (goto-char (match-beginning 0))
1515 ;; Preamble - Title, Author, Date etc.
1516 (insert
1517 (let* ((title (and (plist-get info :with-title)
1518 (org-export-data (plist-get info :title) info)))
1519 (subtitle (when title
1520 (org-export-data (plist-get info :subtitle) info)))
1521 (author (and (plist-get info :with-author)
1522 (let ((auth (plist-get info :author)))
1523 (and auth (org-export-data auth info)))))
1524 (email (plist-get info :email))
1525 ;; Switch on or off above vars based on user settings
1526 (author (and (plist-get info :with-author) (or author email)))
1527 (email (and (plist-get info :with-email) email)))
1528 (concat
1529 ;; Title.
1530 (when (org-string-nw-p title)
1531 (concat
1532 (format "\n<text:p text:style-name=\"%s\">%s</text:p>\n"
1533 "OrgTitle" (format "\n<text:title>%s</text:title>" title))
1534 ;; Separator.
1535 "\n<text:p text:style-name=\"OrgTitle\"/>\n"
1536 ;; Subtitle.
1537 (when (org-string-nw-p subtitle)
1538 (concat
1539 (format "<text:p text:style-name=\"OrgSubtitle\">\n%s\n</text:p>\n"
1540 (concat
1541 "<text:user-defined style:data-style-name=\"N0\" text:name=\"subtitle\">\n"
1542 subtitle
1543 "</text:user-defined>\n"))
1544 ;; Separator.
1545 "<text:p text:style-name=\"OrgSubtitle\"/>\n"))))
1546 (cond
1547 ((and author (not email))
1548 ;; Author only.
1549 (concat
1550 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1551 "OrgSubtitle"
1552 (format "<text:initial-creator>%s</text:initial-creator>" author))
1553 ;; Separator.
1554 "\n<text:p text:style-name=\"OrgSubtitle\"/>"))
1555 ((and author email)
1556 ;; Author and E-mail.
1557 (concat
1558 (format
1559 "\n<text:p text:style-name=\"%s\">%s</text:p>"
1560 "OrgSubtitle"
1561 (format
1562 "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
1563 (concat "mailto:" email)
1564 (format "<text:initial-creator>%s</text:initial-creator>" author)))
1565 ;; Separator.
1566 "\n<text:p text:style-name=\"OrgSubtitle\"/>")))
1567 ;; Date, if required.
1568 (when (plist-get info :with-date)
1569 (let* ((date (plist-get info :date))
1570 ;; Check if DATE is specified as a timestamp.
1571 (timestamp (and (not (cdr date))
1572 (eq (org-element-type (car date)) 'timestamp)
1573 (car date))))
1574 (when date
1575 (concat
1576 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1577 "OrgSubtitle"
1578 (if (and (plist-get info :odt-use-date-fields) timestamp)
1579 (org-odt--format-timestamp (car date))
1580 (org-export-data date info)))
1581 ;; Separator
1582 "<text:p text:style-name=\"OrgSubtitle\"/>")))))))
1583 ;; Table of Contents
1584 (let* ((with-toc (plist-get info :with-toc))
1585 (depth (and with-toc (if (wholenump with-toc)
1586 with-toc
1587 (plist-get info :headline-levels)))))
1588 (when depth (insert (or (org-odt-toc depth info) ""))))
1589 ;; Contents.
1590 (insert contents)
1591 ;; Return contents.
1592 (buffer-substring-no-properties (point-min) (point-max)))))
1596 ;;; Transcode Functions
1598 ;;;; Bold
1600 (defun org-odt-bold (bold contents info)
1601 "Transcode BOLD from Org to ODT.
1602 CONTENTS is the text with bold markup. INFO is a plist holding
1603 contextual information."
1604 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1605 "Bold" contents))
1608 ;;;; Center Block
1610 (defun org-odt-center-block (center-block contents info)
1611 "Transcode a CENTER-BLOCK element from Org to ODT.
1612 CONTENTS holds the contents of the center block. INFO is a plist
1613 holding contextual information."
1614 contents)
1617 ;;;; Clock
1619 (defun org-odt-clock (clock contents info)
1620 "Transcode a CLOCK element from Org to ODT.
1621 CONTENTS is nil. INFO is a plist used as a communication
1622 channel."
1623 (let ((timestamp (org-element-property :value clock))
1624 (duration (org-element-property :duration clock)))
1625 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1626 (if (eq (org-element-type (org-export-get-next-element clock info))
1627 'clock) "OrgClock" "OrgClockLastLine")
1628 (concat
1629 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1630 "OrgClockKeyword" org-clock-string)
1631 (org-odt-timestamp timestamp contents info)
1632 (and duration (format " (%s)" duration))))))
1635 ;;;; Code
1637 (defun org-odt-code (code contents info)
1638 "Transcode a CODE object from Org to ODT.
1639 CONTENTS is nil. INFO is a plist used as a communication
1640 channel."
1641 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1642 "OrgCode" (org-odt--encode-plain-text
1643 (org-element-property :value code))))
1646 ;;;; Comment
1648 ;; Comments are ignored.
1651 ;;;; Comment Block
1653 ;; Comment Blocks are ignored.
1656 ;;;; Drawer
1658 (defun org-odt-drawer (drawer contents info)
1659 "Transcode a DRAWER element from Org to ODT.
1660 CONTENTS holds the contents of the block. INFO is a plist
1661 holding contextual information."
1662 (let* ((name (org-element-property :drawer-name drawer))
1663 (output (funcall (plist-get info :odt-format-drawer-function)
1664 name contents)))
1665 output))
1668 ;;;; Dynamic Block
1670 (defun org-odt-dynamic-block (dynamic-block contents info)
1671 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1672 CONTENTS holds the contents of the block. INFO is a plist
1673 holding contextual information. See `org-export-data'."
1674 contents)
1677 ;;;; Entity
1679 (defun org-odt-entity (entity contents info)
1680 "Transcode an ENTITY object from Org to ODT.
1681 CONTENTS are the definition itself. INFO is a plist holding
1682 contextual information."
1683 (org-element-property :utf-8 entity))
1686 ;;;; Example Block
1688 (defun org-odt-example-block (example-block contents info)
1689 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1690 CONTENTS is nil. INFO is a plist holding contextual information."
1691 (org-odt-format-code example-block info))
1694 ;;;; Export Snippet
1696 (defun org-odt-export-snippet (export-snippet contents info)
1697 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1698 CONTENTS is nil. INFO is a plist holding contextual information."
1699 (when (eq (org-export-snippet-backend export-snippet) 'odt)
1700 (org-element-property :value export-snippet)))
1703 ;;;; Export Block
1705 (defun org-odt-export-block (export-block contents info)
1706 "Transcode a EXPORT-BLOCK element from Org to ODT.
1707 CONTENTS is nil. INFO is a plist holding contextual information."
1708 (when (string= (org-element-property :type export-block) "ODT")
1709 (org-remove-indentation (org-element-property :value export-block))))
1712 ;;;; Fixed Width
1714 (defun org-odt-fixed-width (fixed-width contents info)
1715 "Transcode a FIXED-WIDTH element from Org to ODT.
1716 CONTENTS is nil. INFO is a plist holding contextual information."
1717 (org-odt-do-format-code (org-element-property :value fixed-width) info))
1720 ;;;; Footnote Definition
1722 ;; Footnote Definitions are ignored.
1725 ;;;; Footnote Reference
1727 (defun org-odt-footnote-reference (footnote-reference contents info)
1728 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1729 CONTENTS is nil. INFO is a plist holding contextual information."
1730 (let ((--format-footnote-definition
1731 (function
1732 (lambda (n def)
1733 (setq n (format "%d" n))
1734 (let ((id (concat "fn" n))
1735 (note-class "footnote")
1736 (par-style "Footnote"))
1737 (format
1738 "<text:note text:id=\"%s\" text:note-class=\"%s\">%s</text:note>"
1739 id note-class
1740 (concat
1741 (format "<text:note-citation>%s</text:note-citation>" n)
1742 (format "<text:note-body>%s</text:note-body>" def)))))))
1743 (--format-footnote-reference
1744 (function
1745 (lambda (n)
1746 (setq n (format "%d" n))
1747 (let ((note-class "footnote")
1748 (ref-format "text")
1749 (ref-name (concat "fn" n)))
1750 (format
1751 "<text:span text:style-name=\"%s\">%s</text:span>"
1752 "OrgSuperscript"
1753 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1754 note-class ref-format ref-name n)))))))
1755 (concat
1756 ;; Insert separator between two footnotes in a row.
1757 (let ((prev (org-export-get-previous-element footnote-reference info)))
1758 (and (eq (org-element-type prev) 'footnote-reference)
1759 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1760 "OrgSuperscript" ",")))
1761 ;; Transcode footnote reference.
1762 (let ((n (org-export-get-footnote-number footnote-reference info nil t)))
1763 (cond
1764 ((not
1765 (org-export-footnote-first-reference-p footnote-reference info nil t))
1766 (funcall --format-footnote-reference n))
1767 ;; Inline definitions are secondary strings.
1768 ;; Non-inline footnotes definitions are full Org data.
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 (if (eq (org-element-type raw) 'org-data) def
1787 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1788 "Footnote" def)))))
1789 (funcall --format-footnote-definition n def))))))))
1792 ;;;; Headline
1794 (defun org-odt-format-headline--wrap (headline backend info
1795 &optional format-function
1796 &rest extra-keys)
1797 "Transcode a HEADLINE element using BACKEND.
1798 INFO is a plist holding contextual information."
1799 (setq backend (or backend (plist-get info :back-end)))
1800 (let* ((level (+ (org-export-get-relative-level headline info)))
1801 (headline-number (org-export-get-headline-number headline info))
1802 (section-number (and (org-export-numbered-headline-p headline info)
1803 (mapconcat 'number-to-string
1804 headline-number ".")))
1805 (todo (and (plist-get info :with-todo-keywords)
1806 (let ((todo (org-element-property :todo-keyword headline)))
1807 (and todo
1808 (org-export-data-with-backend todo backend info)))))
1809 (todo-type (and todo (org-element-property :todo-type headline)))
1810 (priority (and (plist-get info :with-priority)
1811 (org-element-property :priority headline)))
1812 (text (org-export-data-with-backend
1813 (org-element-property :title headline) backend info))
1814 (tags (and (plist-get info :with-tags)
1815 (org-export-get-tags headline info)))
1816 (headline-label (org-export-get-reference headline info))
1817 (format-function
1818 (if (functionp format-function) format-function
1819 (function*
1820 (lambda (todo todo-type priority text tags
1821 &key level section-number headline-label
1822 &allow-other-keys)
1823 (funcall (plist-get info :odt-format-headline-function)
1824 todo todo-type priority text tags))))))
1825 (apply format-function
1826 todo todo-type priority text tags
1827 :headline-label headline-label :level level
1828 :section-number section-number extra-keys)))
1830 (defun org-odt-headline (headline contents info)
1831 "Transcode a HEADLINE element from Org to ODT.
1832 CONTENTS holds the contents of the headline. INFO is a plist
1833 holding contextual information."
1834 ;; Case 1: This is a footnote section: ignore it.
1835 (unless (org-element-property :footnote-section-p headline)
1836 (let* ((text (org-export-data (org-element-property :title headline) info))
1837 ;; Create the headline text.
1838 (full-text (org-odt-format-headline--wrap headline nil info))
1839 ;; Get level relative to current parsed data.
1840 (level (org-export-get-relative-level headline info))
1841 (numbered (org-export-numbered-headline-p headline info))
1842 ;; Get canonical label for the headline.
1843 (id (org-export-get-reference headline info))
1844 ;; Extra targets.
1845 (extra-targets
1846 (let ((id (org-element-property :ID headline)))
1847 (if id (org-odt--target "" (concat "ID-" id)) "")))
1848 ;; Title.
1849 (anchored-title (org-odt--target full-text id)))
1850 (cond
1851 ;; Case 2. This is a deep sub-tree: export it as a list item.
1852 ;; Also export as items headlines for which no section
1853 ;; format has been found.
1854 ((org-export-low-level-p headline info)
1855 ;; Build the real contents of the sub-tree.
1856 (concat
1857 (and (org-export-first-sibling-p headline info)
1858 (format "\n<text:list text:style-name=\"%s\" %s>"
1859 ;; Choose style based on list type.
1860 (if numbered "OrgNumberedList" "OrgBulletedList")
1861 ;; If top-level list, re-start numbering. Otherwise,
1862 ;; continue numbering.
1863 (format "text:continue-numbering=\"%s\""
1864 (let* ((parent (org-export-get-parent-headline
1865 headline)))
1866 (if (and parent
1867 (org-export-low-level-p parent info))
1868 "true" "false")))))
1869 (let ((headline-has-table-p
1870 (let ((section (assq 'section (org-element-contents headline))))
1871 (assq 'table (and section (org-element-contents section))))))
1872 (format "\n<text:list-item>\n%s\n%s"
1873 (concat
1874 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1875 "Text_20_body"
1876 (concat extra-targets anchored-title))
1877 contents)
1878 (if headline-has-table-p
1879 "</text:list-header>"
1880 "</text:list-item>")))
1881 (and (org-export-last-sibling-p headline info)
1882 "</text:list>")))
1883 ;; Case 3. Standard headline. Export it as a section.
1885 (concat
1886 (format
1887 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1888 (format "Heading_20_%s%s"
1889 level (if numbered "" "_unnumbered"))
1890 level
1891 (if numbered "false" "true")
1892 (concat extra-targets anchored-title))
1893 contents))))))
1895 (defun org-odt-format-headline-default-function
1896 (todo todo-type priority text tags)
1897 "Default format function for a headline.
1898 See `org-odt-format-headline-function' for details."
1899 (concat
1900 ;; Todo.
1901 (when todo
1902 (let ((style (if (eq todo-type 'done) "OrgDone" "OrgTodo")))
1903 (format "<text:span text:style-name=\"%s\">%s</text:span> " style todo)))
1904 (when priority
1905 (let* ((style (format "OrgPriority-%s" priority))
1906 (priority (format "[#%c]" priority)))
1907 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1908 style priority)))
1909 ;; Title.
1910 text
1911 ;; Tags.
1912 (when tags
1913 (concat
1914 "<text:tab/>"
1915 (format "<text:span text:style-name=\"%s\">[%s]</text:span>"
1916 "OrgTags" (mapconcat
1917 (lambda (tag)
1918 (format
1919 "<text:span text:style-name=\"%s\">%s</text:span>"
1920 "OrgTag" tag)) tags " : "))))))
1923 ;;;; Horizontal Rule
1925 (defun org-odt-horizontal-rule (horizontal-rule contents info)
1926 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1927 CONTENTS is nil. INFO is a plist holding contextual information."
1928 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1929 "Horizontal_20_Line" ""))
1932 ;;;; Inline Babel Call
1934 ;; Inline Babel Calls are ignored.
1937 ;;;; Inline Src Block
1939 (defun org-odt--find-verb-separator (s)
1940 "Return a character not used in string S.
1941 This is used to choose a separator for constructs like \\verb."
1942 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1943 (loop for c across ll
1944 when (not (string-match (regexp-quote (char-to-string c)) s))
1945 return (char-to-string c))))
1947 (defun org-odt-inline-src-block (inline-src-block contents info)
1948 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1949 CONTENTS holds the contents of the item. INFO is a plist holding
1950 contextual information."
1951 (let* ((org-lang (org-element-property :language inline-src-block))
1952 (code (org-element-property :value inline-src-block))
1953 (separator (org-odt--find-verb-separator code)))
1954 (error "FIXME")))
1957 ;;;; Inlinetask
1959 (defun org-odt-inlinetask (inlinetask contents info)
1960 "Transcode an INLINETASK element from Org to ODT.
1961 CONTENTS holds the contents of the block. INFO is a plist
1962 holding contextual information."
1963 (let* ((todo
1964 (and (plist-get info :with-todo-keywords)
1965 (let ((todo (org-element-property :todo-keyword inlinetask)))
1966 (and todo (org-export-data todo info)))))
1967 (todo-type (and todo (org-element-property :todo-type inlinetask)))
1968 (priority (and (plist-get info :with-priority)
1969 (org-element-property :priority inlinetask)))
1970 (text (org-export-data (org-element-property :title inlinetask) info))
1971 (tags (and (plist-get info :with-tags)
1972 (org-export-get-tags inlinetask info))))
1973 (funcall (plist-get info :odt-format-inlinetask-function)
1974 todo todo-type priority text tags contents)))
1976 (defun org-odt-format-inlinetask-default-function
1977 (todo todo-type priority name tags contents)
1978 "Default format function for a inlinetasks.
1979 See `org-odt-format-inlinetask-function' for details."
1980 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1981 "Text_20_body"
1982 (org-odt--textbox
1983 (concat
1984 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1985 "OrgInlineTaskHeading"
1986 (org-odt-format-headline-default-function
1987 todo todo-type priority name tags))
1988 contents)
1989 nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
1991 ;;;; Italic
1993 (defun org-odt-italic (italic contents info)
1994 "Transcode ITALIC from Org to ODT.
1995 CONTENTS is the text with italic markup. INFO is a plist holding
1996 contextual information."
1997 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1998 "Emphasis" contents))
2001 ;;;; Item
2003 (defun org-odt-item (item contents info)
2004 "Transcode an ITEM element from Org to ODT.
2005 CONTENTS holds the contents of the item. INFO is a plist holding
2006 contextual information."
2007 (let* ((plain-list (org-export-get-parent item))
2008 (type (org-element-property :type plain-list))
2009 (counter (org-element-property :counter item))
2010 (tag (let ((tag (org-element-property :tag item)))
2011 (and tag
2012 (concat (org-odt--checkbox item)
2013 (org-export-data tag info))))))
2014 (case type
2015 ((ordered unordered descriptive-1 descriptive-2)
2016 (format "\n<text:list-item>\n%s\n%s"
2017 contents
2018 (let* ((--element-has-a-table-p
2019 (function
2020 (lambda (element info)
2021 (loop for el in (org-element-contents element)
2022 thereis (eq (org-element-type el) 'table))))))
2023 (cond
2024 ((funcall --element-has-a-table-p item info)
2025 "</text:list-header>")
2026 (t "</text:list-item>")))))
2027 (t (error "Unknown list type: %S" type)))))
2029 ;;;; Keyword
2031 (defun org-odt-keyword (keyword contents info)
2032 "Transcode a KEYWORD element from Org to ODT.
2033 CONTENTS is nil. INFO is a plist holding contextual
2034 information."
2035 (let ((key (org-element-property :key keyword))
2036 (value (org-element-property :value keyword)))
2037 (cond
2038 ((string= key "ODT") value)
2039 ((string= key "INDEX")
2040 ;; FIXME
2041 (ignore))
2042 ((string= key "TOC")
2043 (let ((case-fold-search t))
2044 (cond
2045 ((org-string-match-p "\\<headlines\\>" value)
2046 (let ((depth (or (and (string-match "\\<[0-9]+\\>" value)
2047 (string-to-number (match-string 0 value)))
2048 (plist-get info :headline-levels)))
2049 (localp (org-string-match-p "\\<local\\>" value)))
2050 (org-odt-toc depth info (and localp keyword))))
2051 ((org-string-match-p "tables\\|figures\\|listings" value)
2052 ;; FIXME
2053 (ignore))))))))
2056 ;;;; Latex Environment
2059 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2060 ;; (defadvice org-format-latex-as-mathml ; FIXME
2061 ;; (after org-odt-protect-latex-fragment activate)
2062 ;; "Encode LaTeX fragment as XML.
2063 ;; Do this when translation to MathML fails."
2064 ;; (unless (> (length ad-return-value) 0)
2065 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2067 (defun org-odt-latex-environment (latex-environment contents info)
2068 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2069 CONTENTS is nil. INFO is a plist holding contextual information."
2070 (let* ((latex-frag (org-remove-indentation
2071 (org-element-property :value latex-environment))))
2072 (org-odt-do-format-code latex-frag info)))
2075 ;;;; Latex Fragment
2077 ;; (when latex-frag ; FIXME
2078 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2079 ;; :description latex-frag)))
2080 ;; handle verbatim
2081 ;; provide descriptions
2083 (defun org-odt-latex-fragment (latex-fragment contents info)
2084 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2085 CONTENTS is nil. INFO is a plist holding contextual information."
2086 (let* ((latex-frag (org-element-property :value latex-fragment))
2087 (processing-type (plist-get info :with-latex)))
2088 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2089 "OrgCode" (org-odt--encode-plain-text latex-frag t))))
2092 ;;;; Line Break
2094 (defun org-odt-line-break (line-break contents info)
2095 "Transcode a LINE-BREAK object from Org to ODT.
2096 CONTENTS is nil. INFO is a plist holding contextual information."
2097 "<text:line-break/>")
2100 ;;;; Link
2102 ;;;; Links :: Label references
2104 (defun org-odt--enumerate (element info &optional predicate n)
2105 (when predicate (assert (funcall predicate element info)))
2106 (let* ((--numbered-parent-headline-at-<=-n
2107 (function
2108 (lambda (element n info)
2109 (loop for x in (org-element-lineage element)
2110 thereis (and (eq (org-element-type x) 'headline)
2111 (<= (org-export-get-relative-level x info) n)
2112 (org-export-numbered-headline-p x info)
2113 x)))))
2114 (--enumerate
2115 (function
2116 (lambda (element scope info &optional predicate)
2117 (let ((counter 0))
2118 (org-element-map (or scope (plist-get info :parse-tree))
2119 (org-element-type element)
2120 (lambda (el)
2121 (and (or (not predicate) (funcall predicate el info))
2122 (incf counter)
2123 (eq element el)
2124 counter))
2125 info 'first-match)))))
2126 (scope (funcall --numbered-parent-headline-at-<=-n
2127 element
2128 (or n (plist-get info :odt-display-outline-level))
2129 info))
2130 (ordinal (funcall --enumerate element scope info predicate))
2131 (tag
2132 (concat
2133 ;; Section number.
2134 (and scope
2135 (mapconcat 'number-to-string
2136 (org-export-get-headline-number scope info) "."))
2137 ;; Separator.
2138 (and scope ".")
2139 ;; Ordinal.
2140 (number-to-string ordinal))))
2141 tag))
2143 (defun org-odt-format-label (element info op)
2144 "Return a label for ELEMENT.
2146 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2147 element. INFO is a plist used as a communication channel. OP is
2148 either `definition' or `reference', depending on the purpose of
2149 the generated string.
2151 Return value is a string if OP is set to `reference' or a cons
2152 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2153 SHORT-CAPTION are strings."
2154 (assert (memq (org-element-type element) '(link table src-block paragraph)))
2155 (let* ((caption-from
2156 (case (org-element-type element)
2157 (link (org-export-get-parent-element element))
2158 (t element)))
2159 ;; Get label and caption.
2160 (label (org-export-get-reference element info))
2161 (caption (let ((c (org-export-get-caption caption-from)))
2162 (and c (org-export-data c info))))
2163 ;; FIXME: We don't use short-caption for now
2164 (short-caption nil))
2165 (when (or label caption)
2166 (let* ((default-category
2167 (case (org-element-type element)
2168 (table "__Table__")
2169 (src-block "__Listing__")
2170 ((link paragraph)
2171 (cond
2172 ((org-odt--enumerable-latex-image-p element info)
2173 "__DvipngImage__")
2174 ((org-odt--enumerable-image-p element info)
2175 "__Figure__")
2176 ((org-odt--enumerable-formula-p element info)
2177 "__MathFormula__")
2178 (t (error "Don't know how to format label for link: %S"
2179 element))))
2180 (t (error "Don't know how to format label for element type: %s"
2181 (org-element-type element)))))
2182 seqno)
2183 (assert default-category)
2184 (destructuring-bind (counter label-style category predicate)
2185 (assoc-default default-category org-odt-category-map-alist)
2186 ;; Compute sequence number of the element.
2187 (setq seqno (org-odt--enumerate element info predicate))
2188 ;; Localize category string.
2189 (setq category (org-export-translate category :utf-8 info))
2190 (case op
2191 ;; Case 1: Handle Label definition.
2192 (definition
2193 (cons
2194 (concat
2195 ;; Sneak in a bookmark. The bookmark is used when the
2196 ;; labeled element is referenced with a link that
2197 ;; provides its own description.
2198 (format "\n<text:bookmark text:name=\"%s\"/>" label)
2199 ;; Label definition: Typically formatted as below:
2200 ;; CATEGORY SEQ-NO: LONG CAPTION
2201 ;; with translation for correct punctuation.
2202 (format-spec
2203 (org-export-translate
2204 (cadr (assoc-string label-style org-odt-label-styles t))
2205 :utf-8 info)
2206 `((?e . ,category)
2207 (?n . ,(format
2208 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2209 label counter counter seqno))
2210 (?c . ,(or caption "")))))
2211 short-caption))
2212 ;; Case 2: Handle Label reference.
2213 (reference
2214 (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
2215 (fmt1 (car fmt))
2216 (fmt2 (cadr fmt)))
2217 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2218 fmt1
2219 label
2220 (format-spec fmt2 `((?e . ,category) (?n . ,seqno))))))
2221 (t (error "Unknown %S on label" op))))))))
2224 ;;;; Links :: Inline Images
2226 (defun org-odt--copy-image-file (path)
2227 "Returns the internal name of the file"
2228 (let* ((image-type (file-name-extension path))
2229 (media-type (format "image/%s" image-type))
2230 (target-dir "Images/")
2231 (target-file
2232 (format "%s%04d.%s" target-dir
2233 (incf org-odt-embedded-images-count) image-type)))
2234 (message "Embedding %s as %s..."
2235 (substring-no-properties path) target-file)
2237 (when (= 1 org-odt-embedded-images-count)
2238 (make-directory (concat org-odt-zip-dir target-dir))
2239 (org-odt-create-manifest-file-entry "" target-dir))
2241 (copy-file path (concat org-odt-zip-dir target-file) 'overwrite)
2242 (org-odt-create-manifest-file-entry media-type target-file)
2243 target-file))
2245 (defun org-odt--image-size
2246 (file info &optional user-width user-height scale dpi embed-as)
2247 (let* ((--pixels-to-cms
2248 (function (lambda (pixels dpi)
2249 (let ((cms-per-inch 2.54)
2250 (inches (/ pixels dpi)))
2251 (* cms-per-inch inches)))))
2252 (--size-in-cms
2253 (function
2254 (lambda (size-in-pixels dpi)
2255 (and size-in-pixels
2256 (cons (funcall --pixels-to-cms (car size-in-pixels) dpi)
2257 (funcall --pixels-to-cms (cdr size-in-pixels) dpi))))))
2258 (dpi (or dpi (plist-get info :odt-pixels-per-inch)))
2259 (anchor-type (or embed-as "paragraph"))
2260 (user-width (and (not scale) user-width))
2261 (user-height (and (not scale) user-height))
2262 (size
2263 (and
2264 (not (and user-height user-width))
2266 ;; Use Imagemagick.
2267 (and (executable-find "identify")
2268 (let ((size-in-pixels
2269 (let ((dim (shell-command-to-string
2270 (format "identify -format \"%%w:%%h\" \"%s\""
2271 file))))
2272 (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
2273 (cons (string-to-number (match-string 1 dim))
2274 (string-to-number (match-string 2 dim)))))))
2275 (funcall --size-in-cms size-in-pixels dpi)))
2276 ;; Use Emacs.
2277 (let ((size-in-pixels
2278 (ignore-errors ; Emacs could be in batch mode
2279 (clear-image-cache)
2280 (image-size (create-image file) 'pixels))))
2281 (funcall --size-in-cms size-in-pixels dpi))
2282 ;; Use hard-coded values.
2283 (cdr (assoc-string anchor-type
2284 org-odt-default-image-sizes-alist))
2285 ;; Error out.
2286 (error "Cannot determine image size, aborting"))))
2287 (width (car size)) (height (cdr size)))
2288 (cond
2289 (scale
2290 (setq width (* width scale) height (* height scale)))
2291 ((and user-height user-width)
2292 (setq width user-width height user-height))
2293 (user-height
2294 (setq width (* user-height (/ width height)) height user-height))
2295 (user-width
2296 (setq height (* user-width (/ height width)) width user-width))
2297 (t (ignore)))
2298 ;; ensure that an embedded image fits comfortably within a page
2299 (let ((max-width (car org-odt-max-image-size))
2300 (max-height (cdr org-odt-max-image-size)))
2301 (when (or (> width max-width) (> height max-height))
2302 (let* ((scale1 (/ max-width width))
2303 (scale2 (/ max-height height))
2304 (scale (min scale1 scale2)))
2305 (setq width (* scale width) height (* scale height)))))
2306 (cons width height)))
2308 (defun org-odt-link--inline-image (element info)
2309 "Return ODT code for an inline image.
2310 LINK is the link pointing to the inline image. INFO is a plist
2311 used as a communication channel."
2312 (assert (eq (org-element-type element) 'link))
2313 (let* ((src (let* ((type (org-element-property :type element))
2314 (raw-path (org-element-property :path element)))
2315 (cond ((member type '("http" "https"))
2316 (concat type ":" raw-path))
2317 ((file-name-absolute-p raw-path)
2318 (expand-file-name raw-path))
2319 (t raw-path))))
2320 (src-expanded (if (file-name-absolute-p src) src
2321 (expand-file-name src (file-name-directory
2322 (plist-get info :input-file)))))
2323 (href (format
2324 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2325 (org-odt--copy-image-file src-expanded)))
2326 ;; Extract attributes from #+ATTR_ODT line.
2327 (attr-from (case (org-element-type element)
2328 (link (org-export-get-parent-element element))
2329 (t element)))
2330 ;; Convert attributes to a plist.
2331 (attr-plist (org-export-read-attribute :attr_odt attr-from))
2332 ;; Handle `:anchor', `:style' and `:attributes' properties.
2333 (user-frame-anchor
2334 (car (assoc-string (plist-get attr-plist :anchor)
2335 '(("as-char") ("paragraph") ("page")) t)))
2336 (user-frame-style
2337 (and user-frame-anchor (plist-get attr-plist :style)))
2338 (user-frame-attrs
2339 (and user-frame-anchor (plist-get attr-plist :attributes)))
2340 (user-frame-params
2341 (list user-frame-style user-frame-attrs user-frame-anchor))
2342 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2344 ;; Handle `:width', `:height' and `:scale' properties. Read
2345 ;; them as numbers since we need them for computations.
2346 (size (org-odt--image-size
2347 src-expanded info
2348 (let ((width (plist-get attr-plist :width)))
2349 (and width (read width)))
2350 (let ((length (plist-get attr-plist :length)))
2351 (and length (read length)))
2352 (let ((scale (plist-get attr-plist :scale)))
2353 (and scale (read scale)))
2354 nil ; embed-as
2355 "paragraph" ; FIXME
2357 (width (car size)) (height (cdr size))
2358 (standalone-link-p (org-odt--standalone-link-p element info))
2359 (embed-as (if standalone-link-p "paragraph" "as-char"))
2360 (captions (org-odt-format-label element info 'definition))
2361 (caption (car captions)) (short-caption (cdr captions))
2362 (entity (concat (and caption "Captioned") embed-as "Image"))
2363 ;; Check if this link was created by LaTeX-to-PNG converter.
2364 (replaces (org-element-property
2365 :replaces (if (not standalone-link-p) element
2366 (org-export-get-parent-element element))))
2367 ;; If yes, note down the type of the element - LaTeX Fragment
2368 ;; or LaTeX environment. It will go in to frame title.
2369 (title (and replaces (capitalize
2370 (symbol-name (org-element-type replaces)))))
2372 ;; If yes, note down its contents. It will go in to frame
2373 ;; description. This quite useful for debugging.
2374 (desc (and replaces (org-element-property :value replaces))))
2375 (org-odt--render-image/formula entity href width height
2376 captions user-frame-params title desc)))
2379 ;;;; Links :: Math formula
2381 (defun org-odt-link--inline-formula (element info)
2382 (let* ((src (let* ((type (org-element-property :type element))
2383 (raw-path (org-element-property :path element)))
2384 (cond
2385 ((file-name-absolute-p raw-path)
2386 (expand-file-name raw-path))
2387 (t raw-path))))
2388 (src-expanded (if (file-name-absolute-p src) src
2389 (expand-file-name src (file-name-directory
2390 (plist-get info :input-file)))))
2391 (href
2392 (format
2393 "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
2394 " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
2395 (file-name-directory (org-odt--copy-formula-file src-expanded))))
2396 (standalone-link-p (org-odt--standalone-link-p element info))
2397 (embed-as (if standalone-link-p 'paragraph 'character))
2398 (captions (org-odt-format-label element info 'definition))
2399 (caption (car captions)) (short-caption (cdr captions))
2400 ;; Check if this link was created by LaTeX-to-MathML
2401 ;; converter.
2402 (replaces (org-element-property
2403 :replaces (if (not standalone-link-p) element
2404 (org-export-get-parent-element element))))
2405 ;; If yes, note down the type of the element - LaTeX Fragment
2406 ;; or LaTeX environment. It will go in to frame title.
2407 (title (and replaces (capitalize
2408 (symbol-name (org-element-type replaces)))))
2410 ;; If yes, note down its contents. It will go in to frame
2411 ;; description. This quite useful for debugging.
2412 (desc (and replaces (org-element-property :value replaces)))
2413 width height)
2414 (cond
2415 ((eq embed-as 'character)
2416 (org-odt--render-image/formula "InlineFormula" href width height
2417 nil nil title desc))
2419 (let* ((equation (org-odt--render-image/formula
2420 "CaptionedDisplayFormula" href width height
2421 captions nil title desc))
2422 (label
2423 (let* ((org-odt-category-map-alist
2424 '(("__MathFormula__" "Text" "math-label" "Equation"
2425 org-odt--enumerable-formula-p))))
2426 (car (org-odt-format-label element info 'definition)))))
2427 (concat equation "<text:tab/>" label))))))
2429 (defun org-odt--copy-formula-file (src-file)
2430 "Returns the internal name of the file"
2431 (let* ((target-dir (format "Formula-%04d/"
2432 (incf org-odt-embedded-formulas-count)))
2433 (target-file (concat target-dir "content.xml")))
2434 ;; Create a directory for holding formula file. Also enter it in
2435 ;; to manifest.
2436 (make-directory (concat org-odt-zip-dir target-dir))
2437 (org-odt-create-manifest-file-entry
2438 "application/vnd.oasis.opendocument.formula" target-dir "1.2")
2439 ;; Copy over the formula file from user directory to zip
2440 ;; directory.
2441 (message "Embedding %s as %s..." src-file target-file)
2442 (let ((case-fold-search nil))
2443 (cond
2444 ;; Case 1: Mathml.
2445 ((string-match "\\.\\(mathml\\|mml\\)\\'" src-file)
2446 (copy-file src-file (concat org-odt-zip-dir target-file) 'overwrite))
2447 ;; Case 2: OpenDocument formula.
2448 ((string-match "\\.odf\\'" src-file)
2449 (org-odt--zip-extract src-file "content.xml"
2450 (concat org-odt-zip-dir target-dir)))
2451 (t (error "%s is not a formula file" src-file))))
2452 ;; Enter the formula file in to manifest.
2453 (org-odt-create-manifest-file-entry "text/xml" target-file)
2454 target-file))
2456 ;;;; Targets
2458 (defun org-odt--render-image/formula (cfg-key href width height &optional
2459 captions user-frame-params
2460 &rest title-and-desc)
2461 (let* ((frame-cfg-alist
2462 ;; Each element of this alist is of the form (CFG-HANDLE
2463 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2465 ;; CFG-HANDLE is the key to the alist.
2467 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2468 ;; frame params for INNER-FRAME and OUTER-FRAME
2469 ;; respectively. See below.
2471 ;; Configurations that are meant to be applied to
2472 ;; non-captioned image/formula specifies no
2473 ;; OUTER-FRAME-PARAMS.
2475 ;; TERMINOLOGY
2476 ;; ===========
2477 ;; INNER-FRAME :: Frame that directly surrounds an
2478 ;; image/formula.
2480 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2481 ;; frame also contains the caption, if any.
2483 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2484 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2485 ;; that these are the last three arguments
2486 ;; to `org-odt--frame'.
2488 ;; Note that an un-captioned image/formula requires just an
2489 ;; INNER-FRAME, while a captioned image/formula requires
2490 ;; both an INNER and an OUTER-FRAME.
2491 '(("As-CharImage" ("OrgInlineImage" nil "as-char"))
2492 ("ParagraphImage" ("OrgDisplayImage" nil "paragraph"))
2493 ("PageImage" ("OrgPageImage" nil "page"))
2494 ("CaptionedAs-CharImage"
2495 ("OrgCaptionedImage"
2496 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2497 ("OrgInlineImage" nil "as-char"))
2498 ("CaptionedParagraphImage"
2499 ("OrgCaptionedImage"
2500 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2501 ("OrgImageCaptionFrame" nil "paragraph"))
2502 ("CaptionedPageImage"
2503 ("OrgCaptionedImage"
2504 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2505 ("OrgPageImageCaptionFrame" nil "page"))
2506 ("InlineFormula" ("OrgInlineFormula" nil "as-char"))
2507 ("DisplayFormula" ("OrgDisplayFormula" nil "as-char"))
2508 ("CaptionedDisplayFormula"
2509 ("OrgCaptionedFormula" nil "paragraph")
2510 ("OrgFormulaCaptionFrame" nil "paragraph"))))
2511 (caption (car captions)) (short-caption (cdr captions))
2512 ;; Retrieve inner and outer frame params, from configuration.
2513 (frame-cfg (assoc-string cfg-key frame-cfg-alist t))
2514 (inner (nth 1 frame-cfg))
2515 (outer (nth 2 frame-cfg))
2516 ;; User-specified frame params (from #+ATTR_ODT spec)
2517 (user user-frame-params)
2518 (--merge-frame-params (function
2519 (lambda (default user)
2520 "Merge default and user frame params."
2521 (if (not user) default
2522 (assert (= (length default) 3))
2523 (assert (= (length user) 3))
2524 (loop for u in user
2525 for d in default
2526 collect (or u d)))))))
2527 (cond
2528 ;; Case 1: Image/Formula has no caption.
2529 ;; There is only one frame, one that surrounds the image
2530 ;; or formula.
2531 ((not caption)
2532 ;; Merge user frame params with that from configuration.
2533 (setq inner (funcall --merge-frame-params inner user))
2534 (apply 'org-odt--frame href width height
2535 (append inner title-and-desc)))
2536 ;; Case 2: Image/Formula is captioned or labeled.
2537 ;; There are two frames: The inner one surrounds the
2538 ;; image or formula. The outer one contains the
2539 ;; caption/sequence number.
2541 ;; Merge user frame params with outer frame params.
2542 (setq outer (funcall --merge-frame-params outer user))
2543 ;; Short caption, if specified, goes as part of inner frame.
2544 (setq inner (let ((frame-params (copy-sequence inner)))
2545 (setcar (cdr frame-params)
2546 (concat
2547 (cadr frame-params)
2548 (when short-caption
2549 (format " draw:name=\"%s\" " short-caption))))
2550 frame-params))
2551 (apply 'org-odt--textbox
2552 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2553 "Illustration"
2554 (concat
2555 (apply 'org-odt--frame href width height
2556 (append inner title-and-desc))
2557 caption))
2558 width height outer)))))
2560 (defun org-odt--enumerable-p (element info)
2561 ;; Element should have a caption or label.
2562 (or (org-element-property :caption element)
2563 (org-element-property :name element)))
2565 (defun org-odt--enumerable-image-p (element info)
2566 (org-odt--standalone-link-p
2567 element info
2568 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2569 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2570 ;; processing.)
2571 (lambda (p)
2572 (and (not (org-element-property :replaces p))
2573 (or (org-element-property :caption p)
2574 (org-element-property :name p))))
2575 ;; Link should point to an image file.
2576 (lambda (l)
2577 (assert (eq (org-element-type l) 'link))
2578 (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
2580 (defun org-odt--enumerable-latex-image-p (element info)
2581 (org-odt--standalone-link-p
2582 element info
2583 ;; Paragraph should have a caption or label. It SHOULD also be a
2584 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2585 ;; processing.)
2586 (lambda (p)
2587 (and (org-element-property :replaces p)
2588 (or (org-element-property :caption p)
2589 (org-element-property :name p))))
2590 ;; Link should point to an image file.
2591 (lambda (l)
2592 (assert (eq (org-element-type l) 'link))
2593 (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
2595 (defun org-odt--enumerable-formula-p (element info)
2596 (org-odt--standalone-link-p
2597 element info
2598 ;; Paragraph should have a caption or label.
2599 (lambda (p)
2600 (or (org-element-property :caption p)
2601 (org-element-property :name p)))
2602 ;; Link should point to a MathML or ODF file.
2603 (lambda (l)
2604 (assert (eq (org-element-type l) 'link))
2605 (org-export-inline-image-p l (plist-get info :odt-inline-formula-rules)))))
2607 (defun org-odt--standalone-link-p (element info &optional
2608 paragraph-predicate
2609 link-predicate)
2610 "Test if ELEMENT is a standalone link for the purpose ODT export.
2611 INFO is a plist holding contextual information.
2613 Return non-nil, if ELEMENT is of type paragraph satisfying
2614 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2615 is a link that satisfies LINK-PREDICATE.
2617 Return non-nil, if ELEMENT is of type link satisfying
2618 LINK-PREDICATE and its containing paragraph satisfies
2619 PARAGRAPH-PREDICATE in addition to having no other content save for
2620 leading and trailing whitespaces.
2622 Return nil, otherwise."
2623 (let ((p (case (org-element-type element)
2624 (paragraph element)
2625 (link (and (or (not link-predicate)
2626 (funcall link-predicate element))
2627 (org-export-get-parent element)))
2628 (t nil))))
2629 (when (and p (eq (org-element-type p) 'paragraph))
2630 (when (or (not paragraph-predicate)
2631 (funcall paragraph-predicate p))
2632 (let ((contents (org-element-contents p)))
2633 (loop for x in contents
2634 with inline-image-count = 0
2635 always (case (org-element-type x)
2636 (plain-text
2637 (not (org-string-nw-p x)))
2638 (link
2639 (and (or (not link-predicate)
2640 (funcall link-predicate x))
2641 (= (incf inline-image-count) 1)))
2642 (t nil))))))))
2644 (defun org-odt-link--infer-description (destination info)
2645 ;; DESTINATION is a headline or an element (like paragraph,
2646 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2648 ;; Note that labels that are attached to captioned entities - inline
2649 ;; images, math formulae and tables - get resolved as part of
2650 ;; `org-odt-format-label' and `org-odt--enumerate'.
2652 ;; Create a cross-reference to DESTINATION but make best-efforts to
2653 ;; create a *meaningful* description. Check item numbers, section
2654 ;; number and section title in that order.
2656 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2657 ;; FIXME: Handle footnote-definition footnote-reference?
2658 (let* ((genealogy (org-element-lineage destination))
2659 (data (reverse genealogy))
2660 (label (let ((type (org-element-type destination)))
2661 (if (memq type '(headline target))
2662 (org-export-get-reference destination info)
2663 (error "FIXME: Unable to resolve %S" destination)))))
2665 (let* ( ;; Locate top-level list.
2666 (top-level-list
2667 (loop for x on data
2668 when (eq (org-element-type (car x)) 'plain-list)
2669 return x))
2670 ;; Get list item nos.
2671 (item-numbers
2672 (loop for (plain-list item . rest) on top-level-list by #'cddr
2673 until (not (eq (org-element-type plain-list) 'plain-list))
2674 collect (when (eq (org-element-property :type
2675 plain-list)
2676 'ordered)
2677 (1+ (length (org-export-get-previous-element
2678 item info t))))))
2679 ;; Locate top-most listified headline.
2680 (listified-headlines
2681 (loop for x on data
2682 when (and (eq (org-element-type (car x)) 'headline)
2683 (org-export-low-level-p (car x) info))
2684 return x))
2685 ;; Get listified headline numbers.
2686 (listified-headline-nos
2687 (loop for el in listified-headlines
2688 when (eq (org-element-type el) 'headline)
2689 collect (when (org-export-numbered-headline-p el info)
2690 (1+ (length (org-export-get-previous-element
2691 el info t)))))))
2692 ;; Combine item numbers from both the listified headlines and
2693 ;; regular list items.
2695 ;; Case 1: Check if all the parents of list item are numbered.
2696 ;; If yes, link to the item proper.
2697 (let ((item-numbers (append listified-headline-nos item-numbers)))
2698 (when (and item-numbers (not (memq nil item-numbers)))
2699 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2700 label
2701 (mapconcat (lambda (n) (if (not n) " "
2702 (concat (number-to-string n) ".")))
2703 item-numbers "")))))
2704 ;; Case 2: Locate a regular and numbered headline in the
2705 ;; hierarchy. Display its section number.
2706 (let ((headline
2707 (and
2708 ;; Test if destination is a numbered headline.
2709 (org-export-numbered-headline-p destination info)
2710 (loop for el in (cons destination genealogy)
2711 when (and (eq (org-element-type el) 'headline)
2712 (not (org-export-low-level-p el info))
2713 (org-export-numbered-headline-p el info))
2714 return el))))
2715 ;; We found one.
2716 (when headline
2717 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2718 label
2719 (mapconcat 'number-to-string (org-export-get-headline-number
2720 headline info) "."))))
2721 ;; Case 4: Locate a regular headline in the hierarchy. Display
2722 ;; its title.
2723 (let ((headline (loop for el in (cons destination genealogy)
2724 when (and (eq (org-element-type el) 'headline)
2725 (not (org-export-low-level-p el info)))
2726 return el)))
2727 ;; We found one.
2728 (when headline
2729 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2730 label
2731 (let ((title (org-element-property :title headline)))
2732 (org-export-data title info)))))
2733 (error "FIXME?"))))
2735 (defun org-odt-link (link desc info)
2736 "Transcode a LINK object from Org to ODT.
2738 DESC is the description part of the link, or the empty string.
2739 INFO is a plist holding contextual information. See
2740 `org-export-data'."
2741 (let* ((type (org-element-property :type link))
2742 (raw-path (org-element-property :path link))
2743 ;; Ensure DESC really exists, or set it to nil.
2744 (desc (and (not (string= desc "")) desc))
2745 (imagep (org-export-inline-image-p
2746 link (plist-get info :odt-inline-image-rules)))
2747 (path (cond
2748 ((member type '("http" "https" "ftp" "mailto"))
2749 (concat type ":" raw-path))
2750 ((string= type "file") (org-export-file-uri raw-path))
2751 (t raw-path)))
2752 ;; Convert & to &amp; for correct XML representation
2753 (path (replace-regexp-in-string "&" "&amp;" path)))
2754 (cond
2755 ;; Link type is handled by a special function.
2756 ((org-export-custom-protocol-maybe link desc 'odt))
2757 ;; Image file.
2758 ((and (not desc) (org-export-inline-image-p
2759 link (plist-get info :odt-inline-image-rules)))
2760 (org-odt-link--inline-image link info))
2761 ;; Formula file.
2762 ((and (not desc) (org-export-inline-image-p
2763 link (plist-get info :odt-inline-formula-rules)))
2764 (org-odt-link--inline-formula link info))
2765 ;; Radio target: Transcode target's contents and use them as
2766 ;; link's description.
2767 ((string= type "radio")
2768 (let ((destination (org-export-resolve-radio-link link info)))
2769 (if (not destination) desc
2770 (format
2771 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2772 (org-export-get-reference destination info)
2773 desc))))
2774 ;; Links pointing to a headline: Find destination and build
2775 ;; appropriate referencing command.
2776 ((member type '("custom-id" "fuzzy" "id"))
2777 (let ((destination (if (string= type "fuzzy")
2778 (org-export-resolve-fuzzy-link link info)
2779 (org-export-resolve-id-link link info))))
2780 (case (org-element-type destination)
2781 ;; Case 1: Fuzzy link points nowhere.
2782 ('nil
2783 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2784 "Emphasis"
2785 (or desc
2786 (org-export-data (org-element-property :raw-link link)
2787 info))))
2788 ;; Case 2: Fuzzy link points to a headline.
2789 (headline
2790 ;; If there's a description, create a hyperlink.
2791 ;; Otherwise, try to provide a meaningful description.
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 ;; Case 3: Fuzzy link points to a target.
2801 (target
2802 ;; If there's a description, create a hyperlink.
2803 ;; Otherwise, try to provide a meaningful description.
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 ;; Case 4: Fuzzy link points to some element (e.g., an
2808 ;; inline image, 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-optimisations-1 (copy-sequence hfy-optimisations))
3148 (hfy-optimisations (add-to-list 'hfy-optimisations-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 (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 (format " 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