ox-odt: Fix defcustom keywords
[org-mode.git] / lisp / ox-odt.el
blob163f5804cdad8ba1bf142a6945b1630a9fd7b5f4
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\\|svg\\)\\'"))
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 "25.1"
776 :package-version '(Org . "8.3")
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* ((element-or-parent
2156 (case (org-element-type element)
2157 (link (org-export-get-parent-element element))
2158 (t element)))
2159 ;; Get label and caption.
2160 (label (and (or (org-element-property :name element)
2161 (org-element-property :name element-or-parent))
2162 (org-export-get-reference element-or-parent info)))
2163 (caption (let ((c (org-export-get-caption element-or-parent)))
2164 (and c (org-export-data c info))))
2165 ;; FIXME: We don't use short-caption for now
2166 (short-caption nil))
2167 (when (or label caption)
2168 (let* ((default-category
2169 (case (org-element-type element)
2170 (table "__Table__")
2171 (src-block "__Listing__")
2172 ((link paragraph)
2173 (cond
2174 ((org-odt--enumerable-latex-image-p element info)
2175 "__DvipngImage__")
2176 ((org-odt--enumerable-image-p element info)
2177 "__Figure__")
2178 ((org-odt--enumerable-formula-p element info)
2179 "__MathFormula__")
2180 (t (error "Don't know how to format label for link: %S"
2181 element))))
2182 (t (error "Don't know how to format label for element type: %s"
2183 (org-element-type element)))))
2184 seqno)
2185 (assert default-category)
2186 (destructuring-bind (counter label-style category predicate)
2187 (assoc-default default-category org-odt-category-map-alist)
2188 ;; Compute sequence number of the element.
2189 (setq seqno (org-odt--enumerate element info predicate))
2190 ;; Localize category string.
2191 (setq category (org-export-translate category :utf-8 info))
2192 (case op
2193 ;; Case 1: Handle Label definition.
2194 (definition
2195 (cons
2196 (concat
2197 ;; Sneak in a bookmark. The bookmark is used when the
2198 ;; labeled element is referenced with a link that
2199 ;; provides its own description.
2200 (format "\n<text:bookmark text:name=\"%s\"/>" label)
2201 ;; Label definition: Typically formatted as below:
2202 ;; CATEGORY SEQ-NO: LONG CAPTION
2203 ;; with translation for correct punctuation.
2204 (format-spec
2205 (org-export-translate
2206 (cadr (assoc-string label-style org-odt-label-styles t))
2207 :utf-8 info)
2208 `((?e . ,category)
2209 (?n . ,(format
2210 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2211 label counter counter seqno))
2212 (?c . ,(or caption "")))))
2213 short-caption))
2214 ;; Case 2: Handle Label reference.
2215 (reference
2216 (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
2217 (fmt1 (car fmt))
2218 (fmt2 (cadr fmt)))
2219 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2220 fmt1
2221 label
2222 (format-spec fmt2 `((?e . ,category) (?n . ,seqno))))))
2223 (t (error "Unknown %S on label" op))))))))
2226 ;;;; Links :: Inline Images
2228 (defun org-odt--copy-image-file (path)
2229 "Returns the internal name of the file"
2230 (let* ((image-type (file-name-extension path))
2231 (media-type (format "image/%s" image-type))
2232 (target-dir "Images/")
2233 (target-file
2234 (format "%s%04d.%s" target-dir
2235 (incf org-odt-embedded-images-count) image-type)))
2236 (message "Embedding %s as %s..."
2237 (substring-no-properties path) target-file)
2239 (when (= 1 org-odt-embedded-images-count)
2240 (make-directory (concat org-odt-zip-dir target-dir))
2241 (org-odt-create-manifest-file-entry "" target-dir))
2243 (copy-file path (concat org-odt-zip-dir target-file) 'overwrite)
2244 (org-odt-create-manifest-file-entry media-type target-file)
2245 target-file))
2247 (defun org-odt--image-size
2248 (file info &optional user-width user-height scale dpi embed-as)
2249 (let* ((--pixels-to-cms
2250 (function (lambda (pixels dpi)
2251 (let ((cms-per-inch 2.54)
2252 (inches (/ pixels dpi)))
2253 (* cms-per-inch inches)))))
2254 (--size-in-cms
2255 (function
2256 (lambda (size-in-pixels dpi)
2257 (and size-in-pixels
2258 (cons (funcall --pixels-to-cms (car size-in-pixels) dpi)
2259 (funcall --pixels-to-cms (cdr size-in-pixels) dpi))))))
2260 (dpi (or dpi (plist-get info :odt-pixels-per-inch)))
2261 (anchor-type (or embed-as "paragraph"))
2262 (user-width (and (not scale) user-width))
2263 (user-height (and (not scale) user-height))
2264 (size
2265 (and
2266 (not (and user-height user-width))
2268 ;; Use Imagemagick.
2269 (and (executable-find "identify")
2270 (let ((size-in-pixels
2271 (let ((dim (shell-command-to-string
2272 (format "identify -format \"%%w:%%h\" \"%s\""
2273 file))))
2274 (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
2275 (cons (string-to-number (match-string 1 dim))
2276 (string-to-number (match-string 2 dim)))))))
2277 (funcall --size-in-cms size-in-pixels dpi)))
2278 ;; Use Emacs.
2279 (let ((size-in-pixels
2280 (ignore-errors ; Emacs could be in batch mode
2281 (clear-image-cache)
2282 (image-size (create-image file) 'pixels))))
2283 (funcall --size-in-cms size-in-pixels dpi))
2284 ;; Use hard-coded values.
2285 (cdr (assoc-string anchor-type
2286 org-odt-default-image-sizes-alist))
2287 ;; Error out.
2288 (error "Cannot determine image size, aborting"))))
2289 (width (car size)) (height (cdr size)))
2290 (cond
2291 (scale
2292 (setq width (* width scale) height (* height scale)))
2293 ((and user-height user-width)
2294 (setq width user-width height user-height))
2295 (user-height
2296 (setq width (* user-height (/ width height)) height user-height))
2297 (user-width
2298 (setq height (* user-width (/ height width)) width user-width))
2299 (t (ignore)))
2300 ;; ensure that an embedded image fits comfortably within a page
2301 (let ((max-width (car org-odt-max-image-size))
2302 (max-height (cdr org-odt-max-image-size)))
2303 (when (or (> width max-width) (> height max-height))
2304 (let* ((scale1 (/ max-width width))
2305 (scale2 (/ max-height height))
2306 (scale (min scale1 scale2)))
2307 (setq width (* scale width) height (* scale height)))))
2308 (cons width height)))
2310 (defun org-odt-link--inline-image (element info)
2311 "Return ODT code for an inline image.
2312 LINK is the link pointing to the inline image. INFO is a plist
2313 used as a communication channel."
2314 (assert (eq (org-element-type element) 'link))
2315 (let* ((src (let* ((type (org-element-property :type element))
2316 (raw-path (org-element-property :path element)))
2317 (cond ((member type '("http" "https"))
2318 (concat type ":" raw-path))
2319 ((file-name-absolute-p raw-path)
2320 (expand-file-name raw-path))
2321 (t raw-path))))
2322 (src-expanded (if (file-name-absolute-p src) src
2323 (expand-file-name src (file-name-directory
2324 (plist-get info :input-file)))))
2325 (href (format
2326 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2327 (org-odt--copy-image-file src-expanded)))
2328 ;; Extract attributes from #+ATTR_ODT line.
2329 (attr-from (case (org-element-type element)
2330 (link (org-export-get-parent-element element))
2331 (t element)))
2332 ;; Convert attributes to a plist.
2333 (attr-plist (org-export-read-attribute :attr_odt attr-from))
2334 ;; Handle `:anchor', `:style' and `:attributes' properties.
2335 (user-frame-anchor
2336 (car (assoc-string (plist-get attr-plist :anchor)
2337 '(("as-char") ("paragraph") ("page")) t)))
2338 (user-frame-style
2339 (and user-frame-anchor (plist-get attr-plist :style)))
2340 (user-frame-attrs
2341 (and user-frame-anchor (plist-get attr-plist :attributes)))
2342 (user-frame-params
2343 (list user-frame-style user-frame-attrs user-frame-anchor))
2344 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2346 ;; Handle `:width', `:height' and `:scale' properties. Read
2347 ;; them as numbers since we need them for computations.
2348 (size (org-odt--image-size
2349 src-expanded info
2350 (let ((width (plist-get attr-plist :width)))
2351 (and width (read width)))
2352 (let ((length (plist-get attr-plist :length)))
2353 (and length (read length)))
2354 (let ((scale (plist-get attr-plist :scale)))
2355 (and scale (read scale)))
2356 nil ; embed-as
2357 "paragraph" ; FIXME
2359 (width (car size)) (height (cdr size))
2360 (standalone-link-p (org-odt--standalone-link-p element info))
2361 (embed-as (if standalone-link-p "paragraph" "as-char"))
2362 (captions (org-odt-format-label element info 'definition))
2363 (caption (car captions)) (short-caption (cdr captions))
2364 (entity (concat (and caption "Captioned") embed-as "Image"))
2365 ;; Check if this link was created by LaTeX-to-PNG converter.
2366 (replaces (org-element-property
2367 :replaces (if (not standalone-link-p) element
2368 (org-export-get-parent-element element))))
2369 ;; If yes, note down the type of the element - LaTeX Fragment
2370 ;; or LaTeX environment. It will go in to frame title.
2371 (title (and replaces (capitalize
2372 (symbol-name (org-element-type replaces)))))
2374 ;; If yes, note down its contents. It will go in to frame
2375 ;; description. This quite useful for debugging.
2376 (desc (and replaces (org-element-property :value replaces))))
2377 (org-odt--render-image/formula entity href width height
2378 captions user-frame-params title desc)))
2381 ;;;; Links :: Math formula
2383 (defun org-odt-link--inline-formula (element info)
2384 (let* ((src (let* ((type (org-element-property :type element))
2385 (raw-path (org-element-property :path element)))
2386 (cond
2387 ((file-name-absolute-p raw-path)
2388 (expand-file-name raw-path))
2389 (t raw-path))))
2390 (src-expanded (if (file-name-absolute-p src) src
2391 (expand-file-name src (file-name-directory
2392 (plist-get info :input-file)))))
2393 (href
2394 (format
2395 "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
2396 " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
2397 (file-name-directory (org-odt--copy-formula-file src-expanded))))
2398 (standalone-link-p (org-odt--standalone-link-p element info))
2399 (embed-as (if standalone-link-p 'paragraph 'character))
2400 (captions (org-odt-format-label element info 'definition))
2401 (caption (car captions)) (short-caption (cdr captions))
2402 ;; Check if this link was created by LaTeX-to-MathML
2403 ;; converter.
2404 (replaces (org-element-property
2405 :replaces (if (not standalone-link-p) element
2406 (org-export-get-parent-element element))))
2407 ;; If yes, note down the type of the element - LaTeX Fragment
2408 ;; or LaTeX environment. It will go in to frame title.
2409 (title (and replaces (capitalize
2410 (symbol-name (org-element-type replaces)))))
2412 ;; If yes, note down its contents. It will go in to frame
2413 ;; description. This quite useful for debugging.
2414 (desc (and replaces (org-element-property :value replaces)))
2415 width height)
2416 (cond
2417 ((eq embed-as 'character)
2418 (org-odt--render-image/formula "InlineFormula" href width height
2419 nil nil title desc))
2421 (let* ((equation (org-odt--render-image/formula
2422 "CaptionedDisplayFormula" href width height
2423 captions nil title desc))
2424 (label
2425 (let* ((org-odt-category-map-alist
2426 '(("__MathFormula__" "Text" "math-label" "Equation"
2427 org-odt--enumerable-formula-p))))
2428 (car (org-odt-format-label element info 'definition)))))
2429 (concat equation "<text:tab/>" label))))))
2431 (defun org-odt--copy-formula-file (src-file)
2432 "Returns the internal name of the file"
2433 (let* ((target-dir (format "Formula-%04d/"
2434 (incf org-odt-embedded-formulas-count)))
2435 (target-file (concat target-dir "content.xml")))
2436 ;; Create a directory for holding formula file. Also enter it in
2437 ;; to manifest.
2438 (make-directory (concat org-odt-zip-dir target-dir))
2439 (org-odt-create-manifest-file-entry
2440 "application/vnd.oasis.opendocument.formula" target-dir "1.2")
2441 ;; Copy over the formula file from user directory to zip
2442 ;; directory.
2443 (message "Embedding %s as %s..." src-file target-file)
2444 (let ((case-fold-search nil))
2445 (cond
2446 ;; Case 1: Mathml.
2447 ((string-match "\\.\\(mathml\\|mml\\)\\'" src-file)
2448 (copy-file src-file (concat org-odt-zip-dir target-file) 'overwrite))
2449 ;; Case 2: OpenDocument formula.
2450 ((string-match "\\.odf\\'" src-file)
2451 (org-odt--zip-extract src-file "content.xml"
2452 (concat org-odt-zip-dir target-dir)))
2453 (t (error "%s is not a formula file" src-file))))
2454 ;; Enter the formula file in to manifest.
2455 (org-odt-create-manifest-file-entry "text/xml" target-file)
2456 target-file))
2458 ;;;; Targets
2460 (defun org-odt--render-image/formula (cfg-key href width height &optional
2461 captions user-frame-params
2462 &rest title-and-desc)
2463 (let* ((frame-cfg-alist
2464 ;; Each element of this alist is of the form (CFG-HANDLE
2465 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2467 ;; CFG-HANDLE is the key to the alist.
2469 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2470 ;; frame params for INNER-FRAME and OUTER-FRAME
2471 ;; respectively. See below.
2473 ;; Configurations that are meant to be applied to
2474 ;; non-captioned image/formula specifies no
2475 ;; OUTER-FRAME-PARAMS.
2477 ;; TERMINOLOGY
2478 ;; ===========
2479 ;; INNER-FRAME :: Frame that directly surrounds an
2480 ;; image/formula.
2482 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2483 ;; frame also contains the caption, if any.
2485 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2486 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2487 ;; that these are the last three arguments
2488 ;; to `org-odt--frame'.
2490 ;; Note that an un-captioned image/formula requires just an
2491 ;; INNER-FRAME, while a captioned image/formula requires
2492 ;; both an INNER and an OUTER-FRAME.
2493 '(("As-CharImage" ("OrgInlineImage" nil "as-char"))
2494 ("ParagraphImage" ("OrgDisplayImage" nil "paragraph"))
2495 ("PageImage" ("OrgPageImage" nil "page"))
2496 ("CaptionedAs-CharImage"
2497 ("OrgCaptionedImage"
2498 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2499 ("OrgInlineImage" nil "as-char"))
2500 ("CaptionedParagraphImage"
2501 ("OrgCaptionedImage"
2502 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2503 ("OrgImageCaptionFrame" nil "paragraph"))
2504 ("CaptionedPageImage"
2505 ("OrgCaptionedImage"
2506 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2507 ("OrgPageImageCaptionFrame" nil "page"))
2508 ("InlineFormula" ("OrgInlineFormula" nil "as-char"))
2509 ("DisplayFormula" ("OrgDisplayFormula" nil "as-char"))
2510 ("CaptionedDisplayFormula"
2511 ("OrgCaptionedFormula" nil "paragraph")
2512 ("OrgFormulaCaptionFrame" nil "paragraph"))))
2513 (caption (car captions)) (short-caption (cdr captions))
2514 ;; Retrieve inner and outer frame params, from configuration.
2515 (frame-cfg (assoc-string cfg-key frame-cfg-alist t))
2516 (inner (nth 1 frame-cfg))
2517 (outer (nth 2 frame-cfg))
2518 ;; User-specified frame params (from #+ATTR_ODT spec)
2519 (user user-frame-params)
2520 (--merge-frame-params (function
2521 (lambda (default user)
2522 "Merge default and user frame params."
2523 (if (not user) default
2524 (assert (= (length default) 3))
2525 (assert (= (length user) 3))
2526 (loop for u in user
2527 for d in default
2528 collect (or u d)))))))
2529 (cond
2530 ;; Case 1: Image/Formula has no caption.
2531 ;; There is only one frame, one that surrounds the image
2532 ;; or formula.
2533 ((not caption)
2534 ;; Merge user frame params with that from configuration.
2535 (setq inner (funcall --merge-frame-params inner user))
2536 (apply 'org-odt--frame href width height
2537 (append inner title-and-desc)))
2538 ;; Case 2: Image/Formula is captioned or labeled.
2539 ;; There are two frames: The inner one surrounds the
2540 ;; image or formula. The outer one contains the
2541 ;; caption/sequence number.
2543 ;; Merge user frame params with outer frame params.
2544 (setq outer (funcall --merge-frame-params outer user))
2545 ;; Short caption, if specified, goes as part of inner frame.
2546 (setq inner (let ((frame-params (copy-sequence inner)))
2547 (setcar (cdr frame-params)
2548 (concat
2549 (cadr frame-params)
2550 (when short-caption
2551 (format " draw:name=\"%s\" " short-caption))))
2552 frame-params))
2553 (apply 'org-odt--textbox
2554 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2555 "Illustration"
2556 (concat
2557 (apply 'org-odt--frame href width height
2558 (append inner title-and-desc))
2559 caption))
2560 width height outer)))))
2562 (defun org-odt--enumerable-p (element info)
2563 ;; Element should have a caption or label.
2564 (or (org-element-property :caption element)
2565 (org-element-property :name element)))
2567 (defun org-odt--enumerable-image-p (element info)
2568 (org-odt--standalone-link-p
2569 element info
2570 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2571 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2572 ;; processing.)
2573 (lambda (p)
2574 (and (not (org-element-property :replaces p))
2575 (or (org-element-property :caption p)
2576 (org-element-property :name p))))
2577 ;; Link should point to an image file.
2578 (lambda (l)
2579 (assert (eq (org-element-type l) 'link))
2580 (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
2582 (defun org-odt--enumerable-latex-image-p (element info)
2583 (org-odt--standalone-link-p
2584 element info
2585 ;; Paragraph should have a caption or label. It SHOULD also be a
2586 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2587 ;; processing.)
2588 (lambda (p)
2589 (and (org-element-property :replaces p)
2590 (or (org-element-property :caption p)
2591 (org-element-property :name p))))
2592 ;; Link should point to an image file.
2593 (lambda (l)
2594 (assert (eq (org-element-type l) 'link))
2595 (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
2597 (defun org-odt--enumerable-formula-p (element info)
2598 (org-odt--standalone-link-p
2599 element info
2600 ;; Paragraph should have a caption or label.
2601 (lambda (p)
2602 (or (org-element-property :caption p)
2603 (org-element-property :name p)))
2604 ;; Link should point to a MathML or ODF file.
2605 (lambda (l)
2606 (assert (eq (org-element-type l) 'link))
2607 (org-export-inline-image-p l (plist-get info :odt-inline-formula-rules)))))
2609 (defun org-odt--standalone-link-p (element info &optional
2610 paragraph-predicate
2611 link-predicate)
2612 "Test if ELEMENT is a standalone link for the purpose ODT export.
2613 INFO is a plist holding contextual information.
2615 Return non-nil, if ELEMENT is of type paragraph satisfying
2616 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2617 is a link that satisfies LINK-PREDICATE.
2619 Return non-nil, if ELEMENT is of type link satisfying
2620 LINK-PREDICATE and its containing paragraph satisfies
2621 PARAGRAPH-PREDICATE in addition to having no other content save for
2622 leading and trailing whitespaces.
2624 Return nil, otherwise."
2625 (let ((p (case (org-element-type element)
2626 (paragraph element)
2627 (link (and (or (not link-predicate)
2628 (funcall link-predicate element))
2629 (org-export-get-parent element)))
2630 (t nil))))
2631 (when (and p (eq (org-element-type p) 'paragraph))
2632 (when (or (not paragraph-predicate)
2633 (funcall paragraph-predicate p))
2634 (let ((contents (org-element-contents p)))
2635 (loop for x in contents
2636 with inline-image-count = 0
2637 always (case (org-element-type x)
2638 (plain-text
2639 (not (org-string-nw-p x)))
2640 (link
2641 (and (or (not link-predicate)
2642 (funcall link-predicate x))
2643 (= (incf inline-image-count) 1)))
2644 (t nil))))))))
2646 (defun org-odt-link--infer-description (destination info)
2647 ;; DESTINATION is a headline or an element (like paragraph,
2648 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2650 ;; Note that labels that are attached to captioned entities - inline
2651 ;; images, math formulae and tables - get resolved as part of
2652 ;; `org-odt-format-label' and `org-odt--enumerate'.
2654 ;; Create a cross-reference to DESTINATION but make best-efforts to
2655 ;; create a *meaningful* description. Check item numbers, section
2656 ;; number and section title in that order.
2658 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2659 ;; FIXME: Handle footnote-definition footnote-reference?
2660 (let* ((genealogy (org-element-lineage destination))
2661 (data (reverse genealogy))
2662 (label (let ((type (org-element-type destination)))
2663 (if (memq type '(headline target))
2664 (org-export-get-reference destination info)
2665 (error "FIXME: Unable to resolve %S" destination)))))
2667 (let* ( ;; Locate top-level list.
2668 (top-level-list
2669 (loop for x on data
2670 when (eq (org-element-type (car x)) 'plain-list)
2671 return x))
2672 ;; Get list item nos.
2673 (item-numbers
2674 (loop for (plain-list item . rest) on top-level-list by #'cddr
2675 until (not (eq (org-element-type plain-list) 'plain-list))
2676 collect (when (eq (org-element-property :type
2677 plain-list)
2678 'ordered)
2679 (1+ (length (org-export-get-previous-element
2680 item info t))))))
2681 ;; Locate top-most listified headline.
2682 (listified-headlines
2683 (loop for x on data
2684 when (and (eq (org-element-type (car x)) 'headline)
2685 (org-export-low-level-p (car x) info))
2686 return x))
2687 ;; Get listified headline numbers.
2688 (listified-headline-nos
2689 (loop for el in listified-headlines
2690 when (eq (org-element-type el) 'headline)
2691 collect (when (org-export-numbered-headline-p el info)
2692 (1+ (length (org-export-get-previous-element
2693 el info t)))))))
2694 ;; Combine item numbers from both the listified headlines and
2695 ;; regular list items.
2697 ;; Case 1: Check if all the parents of list item are numbered.
2698 ;; If yes, link to the item proper.
2699 (let ((item-numbers (append listified-headline-nos item-numbers)))
2700 (when (and item-numbers (not (memq nil item-numbers)))
2701 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2702 label
2703 (mapconcat (lambda (n) (if (not n) " "
2704 (concat (number-to-string n) ".")))
2705 item-numbers "")))))
2706 ;; Case 2: Locate a regular and numbered headline in the
2707 ;; hierarchy. Display its section number.
2708 (let ((headline
2709 (and
2710 ;; Test if destination is a numbered headline.
2711 (org-export-numbered-headline-p destination info)
2712 (loop for el in (cons destination genealogy)
2713 when (and (eq (org-element-type el) 'headline)
2714 (not (org-export-low-level-p el info))
2715 (org-export-numbered-headline-p el info))
2716 return el))))
2717 ;; We found one.
2718 (when headline
2719 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2720 label
2721 (mapconcat 'number-to-string (org-export-get-headline-number
2722 headline info) "."))))
2723 ;; Case 4: Locate a regular headline in the hierarchy. Display
2724 ;; its title.
2725 (let ((headline (loop for el in (cons destination genealogy)
2726 when (and (eq (org-element-type el) 'headline)
2727 (not (org-export-low-level-p el info)))
2728 return el)))
2729 ;; We found one.
2730 (when headline
2731 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2732 label
2733 (let ((title (org-element-property :title headline)))
2734 (org-export-data title info)))))
2735 (error "FIXME?"))))
2737 (defun org-odt-link (link desc info)
2738 "Transcode a LINK object from Org to ODT.
2740 DESC is the description part of the link, or the empty string.
2741 INFO is a plist holding contextual information. See
2742 `org-export-data'."
2743 (let* ((type (org-element-property :type link))
2744 (raw-path (org-element-property :path link))
2745 ;; Ensure DESC really exists, or set it to nil.
2746 (desc (and (not (string= desc "")) desc))
2747 (imagep (org-export-inline-image-p
2748 link (plist-get info :odt-inline-image-rules)))
2749 (path (cond
2750 ((member type '("http" "https" "ftp" "mailto"))
2751 (concat type ":" raw-path))
2752 ((string= type "file") (org-export-file-uri raw-path))
2753 (t raw-path)))
2754 ;; Convert & to &amp; for correct XML representation
2755 (path (replace-regexp-in-string "&" "&amp;" path)))
2756 (cond
2757 ;; Link type is handled by a special function.
2758 ((org-export-custom-protocol-maybe link desc 'odt))
2759 ;; Image file.
2760 ((and (not desc) (org-export-inline-image-p
2761 link (plist-get info :odt-inline-image-rules)))
2762 (org-odt-link--inline-image link info))
2763 ;; Formula file.
2764 ((and (not desc) (org-export-inline-image-p
2765 link (plist-get info :odt-inline-formula-rules)))
2766 (org-odt-link--inline-formula link info))
2767 ;; Radio target: Transcode target's contents and use them as
2768 ;; link's description.
2769 ((string= type "radio")
2770 (let ((destination (org-export-resolve-radio-link link info)))
2771 (if (not destination) desc
2772 (format
2773 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2774 (org-export-get-reference destination info)
2775 desc))))
2776 ;; Links pointing to a headline: Find destination and build
2777 ;; appropriate referencing command.
2778 ((member type '("custom-id" "fuzzy" "id"))
2779 (let ((destination (if (string= type "fuzzy")
2780 (org-export-resolve-fuzzy-link link info)
2781 (org-export-resolve-id-link link info))))
2782 (case (org-element-type destination)
2783 ;; Case 1: Fuzzy link points nowhere.
2784 ('nil
2785 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2786 "Emphasis"
2787 (or desc
2788 (org-export-data (org-element-property :raw-link link)
2789 info))))
2790 ;; Case 2: Fuzzy link points to a headline.
2791 (headline
2792 ;; If there's a description, create a hyperlink.
2793 ;; Otherwise, try to provide a meaningful description.
2794 (if (not desc) (org-odt-link--infer-description destination info)
2795 (let ((label
2796 (or (and (string= type "custom-id")
2797 (org-element-property :CUSTOM_ID destination))
2798 (org-export-get-reference destination info))))
2799 (format
2800 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2801 label desc))))
2802 ;; Case 3: Fuzzy link points to a target.
2803 (target
2804 ;; If there's a description, create a hyperlink.
2805 ;; Otherwise, try to provide a meaningful description.
2806 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2807 (org-export-get-reference destination info)
2808 (or desc (org-export-get-ordinal destination info))))
2809 ;; Case 4: Fuzzy link points to some element (e.g., an
2810 ;; inline image, a math formula or a table).
2811 (otherwise
2812 (let ((label-reference
2813 (ignore-errors
2814 (org-odt-format-label destination info 'reference))))
2815 (cond
2816 ((not label-reference)
2817 (org-odt-link--infer-description destination info))
2818 ;; LINK has no description. Create
2819 ;; a cross-reference showing entity's sequence
2820 ;; number.
2821 ((not desc) label-reference)
2822 ;; LINK has description. Insert a hyperlink with
2823 ;; user-provided description.
2825 (format
2826 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2827 (org-export-get-reference destination info)
2828 desc))))))))
2829 ;; Coderef: replace link with the reference name or the
2830 ;; equivalent line number.
2831 ((string= type "coderef")
2832 (let* ((line-no (format "%d" (org-export-resolve-coderef path info)))
2833 (href (concat "coderef-" path)))
2834 (format
2835 (org-export-get-coderef-format path desc)
2836 (format
2837 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2838 href line-no))))
2839 ;; External link with a description part.
2840 ((and path desc)
2841 (let ((link-contents (org-element-contents link)))
2842 ;; Check if description is a link to an inline image.
2843 (if (and (not (cdr link-contents))
2844 (let ((desc-element (car link-contents)))
2845 (and (eq (org-element-type desc-element) 'link)
2846 (org-export-inline-image-p
2847 desc-element
2848 (plist-get info :odt-inline-image-rules)))))
2849 ;; Format link as a clickable image.
2850 (format "\n<draw:a xlink:type=\"simple\" xlink:href=\"%s\">\n%s\n</draw:a>"
2851 path desc)
2852 ;; Otherwise, format it as a regular link.
2853 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2854 path desc))))
2855 ;; External link without a description part.
2856 (path
2857 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2858 path path))
2859 ;; No path, only description. Try to do something useful.
2860 (t (format "<text:span text:style-name=\"%s\">%s</text:span>"
2861 "Emphasis" desc)))))
2864 ;;;; Node Property
2866 (defun org-odt-node-property (node-property contents info)
2867 "Transcode a NODE-PROPERTY element from Org to ODT.
2868 CONTENTS is nil. INFO is a plist holding contextual
2869 information."
2870 (org-odt--encode-plain-text
2871 (format "%s:%s"
2872 (org-element-property :key node-property)
2873 (let ((value (org-element-property :value node-property)))
2874 (if value (concat " " value) "")))))
2876 ;;;; Paragraph
2878 (defun org-odt--paragraph-style (paragraph)
2879 "Return style of PARAGRAPH.
2880 Style is a symbol among `quoted', `centered' and nil."
2881 (let ((up paragraph))
2882 (while (and (setq up (org-element-property :parent up))
2883 (not (memq (org-element-type up)
2884 '(center-block quote-block section)))))
2885 (case (org-element-type up)
2886 (center-block 'centered)
2887 (quote-block 'quoted))))
2889 (defun org-odt--format-paragraph (paragraph contents info default center quote)
2890 "Format paragraph according to given styles.
2891 PARAGRAPH is a paragraph type element. CONTENTS is the
2892 transcoded contents of that paragraph, as a string. INFO is
2893 a plist used as a communication channel. DEFAULT, CENTER and
2894 QUOTE are, respectively, style to use when paragraph belongs to
2895 no special environment, a center block, or a quote block."
2896 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2897 (case (org-odt--paragraph-style paragraph)
2898 (quoted quote)
2899 (centered center)
2900 (otherwise default))
2901 ;; If PARAGRAPH is a leading paragraph in an item that has
2902 ;; a checkbox, splice checkbox and paragraph contents
2903 ;; together.
2904 (concat (let ((parent (org-element-property :parent paragraph)))
2905 (and (eq (org-element-type parent) 'item)
2906 (not (org-export-get-previous-element paragraph info))
2907 (org-odt--checkbox parent)))
2908 contents)))
2910 (defun org-odt-paragraph (paragraph contents info)
2911 "Transcode a PARAGRAPH element from Org to ODT.
2912 CONTENTS is the contents of the paragraph, as a string. INFO is
2913 the plist used as a communication channel."
2914 (org-odt--format-paragraph
2915 paragraph contents info
2916 (or (org-element-property :style paragraph) "Text_20_body")
2917 "OrgCenter"
2918 "Quotations"))
2921 ;;;; Plain List
2923 (defun org-odt-plain-list (plain-list contents info)
2924 "Transcode a PLAIN-LIST element from Org to ODT.
2925 CONTENTS is the contents of the list. INFO is a plist holding
2926 contextual information."
2927 (format "\n<text:list text:style-name=\"%s\" %s>\n%s</text:list>"
2928 ;; Choose style based on list type.
2929 (case (org-element-property :type plain-list)
2930 (ordered "OrgNumberedList")
2931 (unordered "OrgBulletedList")
2932 (descriptive-1 "OrgDescriptionList")
2933 (descriptive-2 "OrgDescriptionList"))
2934 ;; If top-level list, re-start numbering. Otherwise,
2935 ;; continue numbering.
2936 (format "text:continue-numbering=\"%s\""
2937 (let* ((parent (org-export-get-parent plain-list)))
2938 (if (and parent (eq (org-element-type parent) 'item))
2939 "true" "false")))
2940 contents))
2942 ;;;; Plain Text
2944 (defun org-odt--encode-tabs-and-spaces (line)
2945 (replace-regexp-in-string
2946 "\\([\t]\\|\\([ ]+\\)\\)"
2947 (lambda (s)
2948 (cond
2949 ((string= s "\t") "<text:tab/>")
2950 (t (let ((n (length s)))
2951 (cond
2952 ((= n 1) " ")
2953 ((> n 1) (concat " " (format "<text:s text:c=\"%d\"/>" (1- n))))
2954 (t ""))))))
2955 line))
2957 (defun org-odt--encode-plain-text (text &optional no-whitespace-filling)
2958 (mapc
2959 (lambda (pair)
2960 (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t)))
2961 '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
2962 (if no-whitespace-filling text
2963 (org-odt--encode-tabs-and-spaces text)))
2965 (defun org-odt-plain-text (text info)
2966 "Transcode a TEXT string from Org to ODT.
2967 TEXT is the string to transcode. INFO is a plist holding
2968 contextual information."
2969 (let ((output text))
2970 ;; Protect &, < and >.
2971 (setq output (org-odt--encode-plain-text output t))
2972 ;; Handle smart quotes. Be sure to provide original string since
2973 ;; OUTPUT may have been modified.
2974 (when (plist-get info :with-smart-quotes)
2975 (setq output (org-export-activate-smart-quotes output :utf-8 info text)))
2976 ;; Convert special strings.
2977 (when (plist-get info :with-special-strings)
2978 (mapc
2979 (lambda (pair)
2980 (setq output
2981 (replace-regexp-in-string (car pair) (cdr pair) output t nil)))
2982 org-odt-special-string-regexps))
2983 ;; Handle break preservation if required.
2984 (when (plist-get info :preserve-breaks)
2985 (setq output (replace-regexp-in-string
2986 "\\(\\\\\\\\\\)?[ \t]*\n" "<text:line-break/>" output t)))
2987 ;; Return value.
2988 output))
2991 ;;;; Planning
2993 (defun org-odt-planning (planning contents info)
2994 "Transcode a PLANNING element from Org to ODT.
2995 CONTENTS is nil. INFO is a plist used as a communication
2996 channel."
2997 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2998 "OrgPlanning"
2999 (concat
3000 (let ((closed (org-element-property :closed planning)))
3001 (when closed
3002 (concat
3003 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3004 "OrgClosedKeyword" org-closed-string)
3005 (org-odt-timestamp closed contents info))))
3006 (let ((deadline (org-element-property :deadline planning)))
3007 (when deadline
3008 (concat
3009 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3010 "OrgDeadlineKeyword" org-deadline-string)
3011 (org-odt-timestamp deadline contents info))))
3012 (let ((scheduled (org-element-property :scheduled planning)))
3013 (when scheduled
3014 (concat
3015 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3016 "OrgScheduledKeyword" org-deadline-string)
3017 (org-odt-timestamp scheduled contents info)))))))
3020 ;;;; Property Drawer
3022 (defun org-odt-property-drawer (property-drawer contents info)
3023 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3024 CONTENTS holds the contents of the drawer. INFO is a plist
3025 holding contextual information."
3026 (and (org-string-nw-p contents)
3027 (format "<text:p text:style-name=\"OrgFixedWidthBlock\">%s</text:p>"
3028 contents)))
3031 ;;;; Quote Block
3033 (defun org-odt-quote-block (quote-block contents info)
3034 "Transcode a QUOTE-BLOCK element from Org to ODT.
3035 CONTENTS holds the contents of the block. INFO is a plist
3036 holding contextual information."
3037 contents)
3040 ;;;; Section
3042 (defun org-odt-format-section (text style &optional name)
3043 (let ((default-name (car (org-odt-add-automatic-style "Section"))))
3044 (format "\n<text:section text:style-name=\"%s\" %s>\n%s\n</text:section>"
3045 style
3046 (format "text:name=\"%s\"" (or name default-name))
3047 text)))
3050 (defun org-odt-section (section contents info) ; FIXME
3051 "Transcode a SECTION element from Org to ODT.
3052 CONTENTS holds the contents of the section. INFO is a plist
3053 holding contextual information."
3054 contents)
3056 ;;;; Radio Target
3058 (defun org-odt-radio-target (radio-target text info)
3059 "Transcode a RADIO-TARGET object from Org to ODT.
3060 TEXT is the text of the target. INFO is a plist holding
3061 contextual information."
3062 (org-odt--target text (org-export-get-reference radio-target info)))
3065 ;;;; Special Block
3067 (defun org-odt-special-block (special-block contents info)
3068 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3069 CONTENTS holds the contents of the block. INFO is a plist
3070 holding contextual information."
3071 (let ((type (org-element-property :type special-block))
3072 (attributes (org-export-read-attribute :attr_odt special-block)))
3073 (cond
3074 ;; Annotation.
3075 ((string= type "annotation")
3076 (let* ((author (or (plist-get attributes :author)
3077 (let ((author (plist-get info :author)))
3078 (and author (org-export-data author info)))))
3079 (date (or (plist-get attributes :date)
3080 ;; FIXME: Is `car' right thing to do below?
3081 (car (plist-get info :date)))))
3082 (format "\n<text:p>%s</text:p>"
3083 (format "<office:annotation>\n%s\n</office:annotation>"
3084 (concat
3085 (and author
3086 (format "<dc:creator>%s</dc:creator>" author))
3087 (and date
3088 (format "<dc:date>%s</dc:date>"
3089 (org-odt--format-timestamp date nil 'iso-date)))
3090 contents)))))
3091 ;; Textbox.
3092 ((string= type "textbox")
3093 (let ((width (plist-get attributes :width))
3094 (height (plist-get attributes :height))
3095 (style (plist-get attributes :style))
3096 (extra (plist-get attributes :extra))
3097 (anchor (plist-get attributes :anchor)))
3098 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3099 "Text_20_body" (org-odt--textbox contents width height
3100 style extra anchor))))
3101 (t contents))))
3104 ;;;; Src Block
3106 (defun org-odt-hfy-face-to-css (fn)
3107 "Create custom style for face FN.
3108 When FN is the default face, use its foreground and background
3109 properties to create \"OrgSrcBlock\" paragraph style. Otherwise
3110 use its color attribute to create a character style whose name
3111 is obtained from FN. Currently all attributes of FN other than
3112 color are ignored.
3114 The style name for a face FN is derived using the following
3115 operations on the face name in that order - de-dash, CamelCase
3116 and prefix with \"OrgSrc\". For example,
3117 `font-lock-function-name-face' is associated with
3118 \"OrgSrcFontLockFunctionNameFace\"."
3119 (let* ((css-list (hfy-face-to-style fn))
3120 (style-name (concat "OrgSrc"
3121 (mapconcat
3122 'capitalize (split-string
3123 (hfy-face-or-def-to-name fn) "-")
3124 "")))
3125 (color-val (cdr (assoc "color" css-list)))
3126 (background-color-val (cdr (assoc "background" css-list)))
3127 (style (and org-odt-create-custom-styles-for-srcblocks
3128 (cond
3129 ((eq fn 'default)
3130 (format org-odt-src-block-paragraph-format
3131 background-color-val color-val))
3133 (format
3135 <style:style style:name=\"%s\" style:family=\"text\">
3136 <style:text-properties fo:color=\"%s\"/>
3137 </style:style>" style-name color-val))))))
3138 (cons style-name style)))
3140 (defun org-odt-htmlfontify-string (line)
3141 (let* ((hfy-html-quote-regex "\\([<\"&> ]\\)")
3142 (hfy-html-quote-map '(("\"" "&quot;")
3143 ("<" "&lt;")
3144 ("&" "&amp;")
3145 (">" "&gt;")
3146 (" " "<text:s/>")
3147 (" " "<text:tab/>")))
3148 (hfy-face-to-css 'org-odt-hfy-face-to-css)
3149 (hfy-optimisations-1 (copy-sequence hfy-optimisations))
3150 (hfy-optimisations (add-to-list 'hfy-optimisations-1
3151 'body-text-only))
3152 (hfy-begin-span-handler
3153 (lambda (style text-block text-id text-begins-block-p)
3154 (insert (format "<text:span text:style-name=\"%s\">" style))))
3155 (hfy-end-span-handler (lambda nil (insert "</text:span>"))))
3156 (org-no-warnings (htmlfontify-string line))))
3158 (defun org-odt-do-format-code
3159 (code info &optional lang refs retain-labels num-start)
3160 (let* ((lang (or (assoc-default lang org-src-lang-modes) lang))
3161 (lang-mode (and lang (intern (format "%s-mode" lang))))
3162 (code-lines (org-split-string code "\n"))
3163 (code-length (length code-lines))
3164 (use-htmlfontify-p (and (functionp lang-mode)
3165 (plist-get info :odt-fontify-srcblocks)
3166 (require 'htmlfontify nil t)
3167 (fboundp 'htmlfontify-string)))
3168 (code (if (not use-htmlfontify-p) code
3169 (with-temp-buffer
3170 (insert code)
3171 (funcall lang-mode)
3172 (font-lock-ensure)
3173 (buffer-string))))
3174 (fontifier (if use-htmlfontify-p 'org-odt-htmlfontify-string
3175 'org-odt--encode-plain-text))
3176 (par-style (if use-htmlfontify-p "OrgSrcBlock"
3177 "OrgFixedWidthBlock"))
3178 (i 0))
3179 (assert (= code-length (length (org-split-string code "\n"))))
3180 (setq code
3181 (org-export-format-code
3182 code
3183 (lambda (loc line-num ref)
3184 (setq par-style
3185 (concat par-style (and (= (incf i) code-length) "LastLine")))
3187 (setq loc (concat loc (and ref retain-labels (format " (%s)" ref))))
3188 (setq loc (funcall fontifier loc))
3189 (when ref
3190 (setq loc (org-odt--target loc (concat "coderef-" ref))))
3191 (assert par-style)
3192 (setq loc (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3193 par-style loc))
3194 (if (not line-num) loc
3195 (format "\n<text:list-item>%s\n</text:list-item>" loc)))
3196 num-start refs))
3197 (cond
3198 ((not num-start) code)
3199 ((= num-start 0)
3200 (format
3201 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3202 " text:continue-numbering=\"false\"" code))
3204 (format
3205 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3206 " text:continue-numbering=\"true\"" code)))))
3208 (defun org-odt-format-code (element info)
3209 (let* ((lang (org-element-property :language element))
3210 ;; Extract code and references.
3211 (code-info (org-export-unravel-code element))
3212 (code (car code-info))
3213 (refs (cdr code-info))
3214 ;; Does the src block contain labels?
3215 (retain-labels (org-element-property :retain-labels element))
3216 ;; Does it have line numbers?
3217 (num-start (case (org-element-property :number-lines element)
3218 (continued (org-export-get-loc element info))
3219 (new 0))))
3220 (org-odt-do-format-code code info lang refs retain-labels num-start)))
3222 (defun org-odt-src-block (src-block contents info)
3223 "Transcode a SRC-BLOCK element from Org to ODT.
3224 CONTENTS holds the contents of the item. INFO is a plist holding
3225 contextual information."
3226 (let* ((lang (org-element-property :language src-block))
3227 (attributes (org-export-read-attribute :attr_odt src-block))
3228 (captions (org-odt-format-label src-block info 'definition))
3229 (caption (car captions)) (short-caption (cdr captions)))
3230 (concat
3231 (and caption
3232 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3233 "Listing" caption))
3234 (let ((--src-block (org-odt-format-code src-block info)))
3235 (if (not (plist-get attributes :textbox)) --src-block
3236 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3237 "Text_20_body"
3238 (org-odt--textbox --src-block nil nil nil)))))))
3241 ;;;; Statistics Cookie
3243 (defun org-odt-statistics-cookie (statistics-cookie contents info)
3244 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3245 CONTENTS is nil. INFO is a plist holding contextual information."
3246 (let ((cookie-value (org-element-property :value statistics-cookie)))
3247 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3248 "OrgCode" cookie-value)))
3251 ;;;; Strike-Through
3253 (defun org-odt-strike-through (strike-through contents info)
3254 "Transcode STRIKE-THROUGH from Org to ODT.
3255 CONTENTS is the text with strike-through markup. INFO is a plist
3256 holding contextual information."
3257 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3258 "Strikethrough" contents))
3261 ;;;; Subscript
3263 (defun org-odt-subscript (subscript contents info)
3264 "Transcode a SUBSCRIPT object from Org to ODT.
3265 CONTENTS is the contents of the object. INFO is a plist holding
3266 contextual information."
3267 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3268 "OrgSubscript" contents))
3271 ;;;; Superscript
3273 (defun org-odt-superscript (superscript contents info)
3274 "Transcode a SUPERSCRIPT object from Org to ODT.
3275 CONTENTS is the contents of the object. INFO is a plist holding
3276 contextual information."
3277 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3278 "OrgSuperscript" contents))
3281 ;;;; Table Cell
3283 (defun org-odt-table-style-spec (element info)
3284 (let* ((table (org-export-get-parent-table element))
3285 (table-attributes (org-export-read-attribute :attr_odt table))
3286 (table-style (plist-get table-attributes :style)))
3287 (assoc table-style (plist-get info :odt-table-styles))))
3289 (defun org-odt-get-table-cell-styles (table-cell info)
3290 "Retrieve styles applicable to a table cell.
3291 R and C are (zero-based) row and column numbers of the table
3292 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3293 applicable to the current table. It is nil if the table is not
3294 associated with any style attributes.
3296 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3298 When STYLE-SPEC is nil, style the table cell the conventional way
3299 - choose cell borders based on row and column groupings and
3300 choose paragraph alignment based on `org-col-cookies' text
3301 property. See also
3302 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3304 When STYLE-SPEC is non-nil, ignore the above cookie and return
3305 styles congruent with the ODF-1.2 specification."
3306 (let* ((table-cell-address (org-export-table-cell-address table-cell info))
3307 (r (car table-cell-address)) (c (cdr table-cell-address))
3308 (style-spec (org-odt-table-style-spec table-cell info))
3309 (table-dimensions (org-export-table-dimensions
3310 (org-export-get-parent-table table-cell)
3311 info)))
3312 (when style-spec
3313 ;; LibreOffice - particularly the Writer - honors neither table
3314 ;; templates nor custom table-cell styles. Inorder to retain
3315 ;; inter-operability with LibreOffice, only automatic styles are
3316 ;; used for styling of table-cells. The current implementation is
3317 ;; congruent with ODF-1.2 specification and hence is
3318 ;; future-compatible.
3320 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3321 ;; which recognizes as many as 16 different cell types - is much
3322 ;; richer. Unfortunately it is NOT amenable to easy configuration
3323 ;; by hand.
3324 (let* ((template-name (nth 1 style-spec))
3325 (cell-style-selectors (nth 2 style-spec))
3326 (cell-type
3327 (cond
3328 ((and (cdr (assoc 'use-first-column-styles cell-style-selectors))
3329 (= c 0)) "FirstColumn")
3330 ((and (cdr (assoc 'use-last-column-styles cell-style-selectors))
3331 (= (1+ c) (cdr table-dimensions)))
3332 "LastColumn")
3333 ((and (cdr (assoc 'use-first-row-styles cell-style-selectors))
3334 (= r 0)) "FirstRow")
3335 ((and (cdr (assoc 'use-last-row-styles cell-style-selectors))
3336 (= (1+ r) (car table-dimensions)))
3337 "LastRow")
3338 ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
3339 (= (% r 2) 1)) "EvenRow")
3340 ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
3341 (= (% r 2) 0)) "OddRow")
3342 ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
3343 (= (% c 2) 1)) "EvenColumn")
3344 ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
3345 (= (% c 2) 0)) "OddColumn")
3346 (t ""))))
3347 (concat template-name cell-type)))))
3349 (defun org-odt-table-cell (table-cell contents info)
3350 "Transcode a TABLE-CELL element from Org to ODT.
3351 CONTENTS is nil. INFO is a plist used as a communication
3352 channel."
3353 (let* ((table-cell-address (org-export-table-cell-address table-cell info))
3354 (r (car table-cell-address))
3355 (c (cdr table-cell-address))
3356 (horiz-span (or (org-export-table-cell-width table-cell info) 0))
3357 (table-row (org-export-get-parent table-cell))
3358 (custom-style-prefix (org-odt-get-table-cell-styles
3359 table-cell info))
3360 (paragraph-style
3362 (and custom-style-prefix
3363 (format "%sTableParagraph" custom-style-prefix))
3364 (concat
3365 (cond
3366 ((and (= 1 (org-export-table-row-group table-row info))
3367 (org-export-table-has-header-p
3368 (org-export-get-parent-table table-row) info))
3369 "OrgTableHeading")
3370 ((let* ((table (org-export-get-parent-table table-cell))
3371 (table-attrs (org-export-read-attribute :attr_odt table))
3372 (table-header-columns
3373 (let ((cols (plist-get table-attrs :header-columns)))
3374 (and cols (read cols)))))
3375 (<= c (cond ((wholenump table-header-columns)
3376 (- table-header-columns 1))
3377 (table-header-columns 0)
3378 (t -1))))
3379 "OrgTableHeading")
3380 (t "OrgTableContents"))
3381 (capitalize (symbol-name (org-export-table-cell-alignment
3382 table-cell info))))))
3383 (cell-style-name
3385 (and custom-style-prefix (format "%sTableCell"
3386 custom-style-prefix))
3387 (concat
3388 "OrgTblCell"
3389 (when (or (org-export-table-row-starts-rowgroup-p table-row info)
3390 (zerop r)) "T")
3391 (when (org-export-table-row-ends-rowgroup-p table-row info) "B")
3392 (when (and (org-export-table-cell-starts-colgroup-p table-cell info)
3393 (not (zerop c)) ) "L"))))
3394 (cell-attributes
3395 (concat
3396 (format " table:style-name=\"%s\"" cell-style-name)
3397 (and (> horiz-span 0)
3398 (format " table:number-columns-spanned=\"%d\""
3399 (1+ horiz-span))))))
3400 (unless contents (setq contents ""))
3401 (concat
3402 (assert paragraph-style)
3403 (format "\n<table:table-cell%s>\n%s\n</table:table-cell>"
3404 cell-attributes
3405 (let ((table-cell-contents (org-element-contents table-cell)))
3406 (if (memq (org-element-type (car table-cell-contents))
3407 org-element-all-elements)
3408 contents
3409 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3410 paragraph-style contents))))
3411 (let (s)
3412 (dotimes (i horiz-span s)
3413 (setq s (concat s "\n<table:covered-table-cell/>"))))
3414 "\n")))
3417 ;;;; Table Row
3419 (defun org-odt-table-row (table-row contents info)
3420 "Transcode a TABLE-ROW element from Org to ODT.
3421 CONTENTS is the contents of the row. INFO is a plist used as a
3422 communication channel."
3423 ;; Rules are ignored since table separators are deduced from
3424 ;; borders of the current row.
3425 (when (eq (org-element-property :type table-row) 'standard)
3426 (let* ((rowgroup-tags
3427 (if (and (= 1 (org-export-table-row-group table-row info))
3428 (org-export-table-has-header-p
3429 (org-export-get-parent-table table-row) info))
3430 ;; If the row belongs to the first rowgroup and the
3431 ;; table has more than one row groups, then this row
3432 ;; belongs to the header row group.
3433 '("\n<table:table-header-rows>" . "\n</table:table-header-rows>")
3434 ;; Otherwise, it belongs to non-header row group.
3435 '("\n<table:table-rows>" . "\n</table:table-rows>"))))
3436 (concat
3437 ;; Does this row begin a rowgroup?
3438 (when (org-export-table-row-starts-rowgroup-p table-row info)
3439 (car rowgroup-tags))
3440 ;; Actual table row
3441 (format "\n<table:table-row>\n%s\n</table:table-row>" contents)
3442 ;; Does this row end a rowgroup?
3443 (when (org-export-table-row-ends-rowgroup-p table-row info)
3444 (cdr rowgroup-tags))))))
3447 ;;;; Table
3449 (defun org-odt-table-first-row-data-cells (table info)
3450 (let ((table-row
3451 (org-element-map table 'table-row
3452 (lambda (row)
3453 (unless (eq (org-element-property :type row) 'rule) row))
3454 info 'first-match))
3455 (special-column-p (org-export-table-has-special-column-p table)))
3456 (if (not special-column-p) (org-element-contents table-row)
3457 (cdr (org-element-contents table-row)))))
3459 (defun org-odt--table (table contents info)
3460 "Transcode a TABLE element from Org to ODT.
3461 CONTENTS is the contents of the table. INFO is a plist holding
3462 contextual information."
3463 (case (org-element-property :type table)
3464 ;; Case 1: table.el doesn't support export to OD format. Strip
3465 ;; such tables from export.
3466 (table.el
3467 (prog1 nil
3468 (message
3469 (concat
3470 "(ox-odt): Found table.el-type table in the source Org file."
3471 " table.el doesn't support export to ODT format."
3472 " Stripping the table from export."))))
3473 ;; Case 2: Native Org tables.
3474 (otherwise
3475 (let* ((captions (org-odt-format-label table info 'definition))
3476 (caption (car captions)) (short-caption (cdr captions))
3477 (attributes (org-export-read-attribute :attr_odt table))
3478 (custom-table-style (nth 1 (org-odt-table-style-spec table info)))
3479 (table-column-specs
3480 (function
3481 (lambda (table info)
3482 (let* ((table-style (or custom-table-style "OrgTable"))
3483 (column-style (format "%sColumn" table-style)))
3484 (mapconcat
3485 (lambda (table-cell)
3486 (let ((width (1+ (or (org-export-table-cell-width
3487 table-cell info) 0)))
3488 (s (format
3489 "\n<table:table-column table:style-name=\"%s\"/>"
3490 column-style))
3491 out)
3492 (dotimes (i width out) (setq out (concat s out)))))
3493 (org-odt-table-first-row-data-cells table info) "\n"))))))
3494 (concat
3495 ;; caption.
3496 (when caption
3497 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3498 "Table" caption))
3499 ;; begin table.
3500 (let* ((automatic-name
3501 (org-odt-add-automatic-style "Table" attributes)))
3502 (format
3503 "\n<table:table table:style-name=\"%s\"%s>"
3504 (or custom-table-style (cdr automatic-name) "OrgTable")
3505 (concat (when short-caption
3506 (format " table:name=\"%s\"" short-caption)))))
3507 ;; column specification.
3508 (funcall table-column-specs table info)
3509 ;; actual contents.
3510 "\n" contents
3511 ;; end table.
3512 "</table:table>")))))
3514 (defun org-odt-table (table contents info)
3515 "Transcode a TABLE element from Org to ODT.
3516 CONTENTS is the contents of the table. INFO is a plist holding
3517 contextual information.
3519 Use `org-odt--table' to typeset the table. Handle details
3520 pertaining to indentation here."
3521 (let* ((--element-preceded-by-table-p
3522 (function
3523 (lambda (element info)
3524 (loop for el in (org-export-get-previous-element element info t)
3525 thereis (eq (org-element-type el) 'table)))))
3526 (--walk-list-genealogy-and-collect-tags
3527 (function
3528 (lambda (table info)
3529 (let* ((genealogy (org-element-lineage table))
3530 (list-genealogy
3531 (when (eq (org-element-type (car genealogy)) 'item)
3532 (loop for el in genealogy
3533 when (memq (org-element-type el)
3534 '(item plain-list))
3535 collect el)))
3536 (llh-genealogy
3537 (apply 'nconc
3538 (loop for el in genealogy
3539 when (and (eq (org-element-type el) 'headline)
3540 (org-export-low-level-p el info))
3541 collect
3542 (list el
3543 (assq 'headline
3544 (org-element-contents
3545 (org-export-get-parent el)))))))
3546 parent-list)
3547 (nconc
3548 ;; Handle list genealogy.
3549 (loop for el in list-genealogy collect
3550 (case (org-element-type el)
3551 (plain-list
3552 (setq parent-list el)
3553 (cons "</text:list>"
3554 (format "\n<text:list text:style-name=\"%s\" %s>"
3555 (case (org-element-property :type el)
3556 (ordered "OrgNumberedList")
3557 (unordered "OrgBulletedList")
3558 (descriptive-1 "OrgDescriptionList")
3559 (descriptive-2 "OrgDescriptionList"))
3560 "text:continue-numbering=\"true\"")))
3561 (item
3562 (cond
3563 ((not parent-list)
3564 (if (funcall --element-preceded-by-table-p table info)
3565 '("</text:list-header>" . "<text:list-header>")
3566 '("</text:list-item>" . "<text:list-header>")))
3567 ((funcall --element-preceded-by-table-p
3568 parent-list info)
3569 '("</text:list-header>" . "<text:list-header>"))
3570 (t '("</text:list-item>" . "<text:list-item>"))))))
3571 ;; Handle low-level headlines.
3572 (loop for el in llh-genealogy
3573 with step = 'item collect
3574 (case step
3575 (plain-list
3576 (setq step 'item) ; Flip-flop
3577 (setq parent-list el)
3578 (cons "</text:list>"
3579 (format "\n<text:list text:style-name=\"%s\" %s>"
3580 (if (org-export-numbered-headline-p
3581 el info)
3582 "OrgNumberedList"
3583 "OrgBulletedList")
3584 "text:continue-numbering=\"true\"")))
3585 (item
3586 (setq step 'plain-list) ; Flip-flop
3587 (cond
3588 ((not parent-list)
3589 (if (funcall --element-preceded-by-table-p table info)
3590 '("</text:list-header>" . "<text:list-header>")
3591 '("</text:list-item>" . "<text:list-header>")))
3592 ((let ((section? (org-export-get-previous-element
3593 parent-list info)))
3594 (and section?
3595 (eq (org-element-type section?) 'section)
3596 (assq 'table (org-element-contents section?))))
3597 '("</text:list-header>" . "<text:list-header>"))
3599 '("</text:list-item>" . "<text:list-item>")))))))))))
3600 (close-open-tags (funcall --walk-list-genealogy-and-collect-tags
3601 table info)))
3602 ;; OpenDocument schema does not permit table to occur within a
3603 ;; list item.
3605 ;; One solution - the easiest and lightweight, in terms of
3606 ;; implementation - is to put the table in an indented text box
3607 ;; and make the text box part of the list-item. Unfortunately if
3608 ;; the table is big and spans multiple pages, the text box could
3609 ;; overflow. In this case, the following attribute will come
3610 ;; handy.
3612 ;; ,---- From OpenDocument-v1.1.pdf
3613 ;; | 15.27.28 Overflow behavior
3614 ;; |
3615 ;; | For text boxes contained within text document, the
3616 ;; | style:overflow-behavior property specifies the behavior of text
3617 ;; | boxes where the containing text does not fit into the text
3618 ;; | box.
3619 ;; |
3620 ;; | If the attribute's value is clip, the text that does not fit
3621 ;; | into the text box is not displayed.
3622 ;; |
3623 ;; | If the attribute value is auto-create-new-frame, a new frame
3624 ;; | will be created on the next page, with the same position and
3625 ;; | dimensions of the original frame.
3626 ;; |
3627 ;; | If the style:overflow-behavior property's value is
3628 ;; | auto-create-new-frame and the text box has a minimum width or
3629 ;; | height specified, then the text box will grow until the page
3630 ;; | bounds are reached before a new frame is created.
3631 ;; `----
3633 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3634 ;; auto-create-new-frame property and always resorts to clipping
3635 ;; the text box. This results in table being truncated.
3637 ;; So we solve the problem the hard (and fun) way using list
3638 ;; continuations.
3640 ;; The problem only becomes more interesting if you take in to
3641 ;; account the following facts:
3643 ;; - Description lists are simulated as plain lists.
3644 ;; - Low-level headlines can be listified.
3645 ;; - In Org-mode, a table can occur not only as a regular list
3646 ;; item, but also within description lists and low-level
3647 ;; headlines.
3649 ;; See `org-odt-translate-description-lists' and
3650 ;; `org-odt-translate-low-level-headlines' for how this is
3651 ;; tackled.
3653 (concat "\n"
3654 ;; Discontinue the list.
3655 (mapconcat 'car close-open-tags "\n")
3656 ;; Put the table in an indented section.
3657 (let* ((table (org-odt--table table contents info))
3658 (level (/ (length (mapcar 'car close-open-tags)) 2))
3659 (style (format "OrgIndentedSection-Level-%d" level)))
3660 (when table (org-odt-format-section table style)))
3661 ;; Continue the list.
3662 (mapconcat 'cdr (nreverse close-open-tags) "\n"))))
3665 ;;;; Target
3667 (defun org-odt-target (target contents info)
3668 "Transcode a TARGET object from Org to ODT.
3669 CONTENTS is nil. INFO is a plist holding contextual
3670 information."
3671 (org-odt--target "" (org-export-get-reference target info)))
3674 ;;;; Timestamp
3676 (defun org-odt-timestamp (timestamp contents info)
3677 "Transcode a TIMESTAMP object from Org to ODT.
3678 CONTENTS is nil. INFO is a plist used as a communication
3679 channel."
3680 (let* ((raw-value (org-element-property :raw-value timestamp))
3681 (type (org-element-property :type timestamp)))
3682 (if (not (plist-get info :odt-use-date-fields))
3683 (let ((value (org-odt-plain-text
3684 (org-timestamp-translate timestamp) info)))
3685 (case (org-element-property :type timestamp)
3686 ((active active-range)
3687 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3688 "OrgActiveTimestamp" value))
3689 ((inactive inactive-range)
3690 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3691 "OrgInactiveTimestamp" value))
3692 (otherwise value)))
3693 (case type
3694 (active
3695 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3696 "OrgActiveTimestamp"
3697 (format "&lt;%s&gt;" (org-odt--format-timestamp timestamp))))
3698 (inactive
3699 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3700 "OrgInactiveTimestamp"
3701 (format "[%s]" (org-odt--format-timestamp timestamp))))
3702 (active-range
3703 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3704 "OrgActiveTimestamp"
3705 (format "&lt;%s&gt;&#x2013;&lt;%s&gt;"
3706 (org-odt--format-timestamp timestamp)
3707 (org-odt--format-timestamp timestamp 'end))))
3708 (inactive-range
3709 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3710 "OrgInactiveTimestamp"
3711 (format "[%s]&#x2013;[%s]"
3712 (org-odt--format-timestamp timestamp)
3713 (org-odt--format-timestamp timestamp 'end))))
3714 (otherwise
3715 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3716 "OrgDiaryTimestamp"
3717 (org-odt-plain-text (org-timestamp-translate timestamp)
3718 info)))))))
3721 ;;;; Underline
3723 (defun org-odt-underline (underline contents info)
3724 "Transcode UNDERLINE from Org to ODT.
3725 CONTENTS is the text with underline markup. INFO is a plist
3726 holding contextual information."
3727 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3728 "Underline" contents))
3731 ;;;; Verbatim
3733 (defun org-odt-verbatim (verbatim contents info)
3734 "Transcode a VERBATIM object from Org to ODT.
3735 CONTENTS is nil. INFO is a plist used as a communication
3736 channel."
3737 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3738 "OrgCode" (org-odt--encode-plain-text
3739 (org-element-property :value verbatim))))
3742 ;;;; Verse Block
3744 (defun org-odt-verse-block (verse-block contents info)
3745 "Transcode a VERSE-BLOCK element from Org to ODT.
3746 CONTENTS is verse block contents. INFO is a plist holding
3747 contextual information."
3748 ;; Add line breaks to each line of verse.
3749 (setq contents (replace-regexp-in-string
3750 "\\(<text:line-break/>\\)?[ \t]*\n"
3751 "<text:line-break/>" contents))
3752 ;; Replace tabs and spaces.
3753 (setq contents (org-odt--encode-tabs-and-spaces contents))
3754 ;; Surround it in a verse environment.
3755 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3756 "OrgVerse" contents))
3760 ;;; Filters
3762 ;;;; LaTeX fragments
3764 (defun org-odt--translate-latex-fragments (tree backend info)
3765 (let ((processing-type (plist-get info :with-latex))
3766 (count 0))
3767 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3768 ;; If the desired converter is not available, force verbatim
3769 ;; processing.
3770 (case processing-type
3771 ((t mathml)
3772 (if (and (fboundp 'org-format-latex-mathml-available-p)
3773 (org-format-latex-mathml-available-p))
3774 (setq processing-type 'mathml)
3775 (message "LaTeX to MathML converter not available.")
3776 (setq processing-type 'verbatim)))
3777 ((dvipng imagemagick)
3778 (unless (and (org-check-external-command "latex" "" t)
3779 (org-check-external-command
3780 (if (eq processing-type 'dvipng) "dvipng" "convert") "" t))
3781 (message "LaTeX to PNG converter not available.")
3782 (setq processing-type 'verbatim)))
3783 (otherwise
3784 (message "Unknown LaTeX option. Forcing verbatim.")
3785 (setq processing-type 'verbatim)))
3787 ;; Store normalized value for later use.
3788 (when (plist-get info :with-latex)
3789 (plist-put info :with-latex processing-type))
3790 (message "Formatting LaTeX using %s" processing-type)
3792 ;; Convert `latex-fragment's and `latex-environment's.
3793 (when (memq processing-type '(mathml dvipng imagemagick))
3794 (org-element-map tree '(latex-fragment latex-environment)
3795 (lambda (latex-*)
3796 (incf count)
3797 (let* ((latex-frag (org-element-property :value latex-*))
3798 (input-file (plist-get info :input-file))
3799 (cache-dir (file-name-directory input-file))
3800 (cache-subdir (concat
3801 (case processing-type
3802 ((dvipng imagemagick) "ltxpng/")
3803 (mathml "ltxmathml/"))
3804 (file-name-sans-extension
3805 (file-name-nondirectory input-file))))
3806 (display-msg
3807 (case processing-type
3808 ((dvipng imagemagick)
3809 (format "Creating LaTeX Image %d..." count))
3810 (mathml (format "Creating MathML snippet %d..." count))))
3811 ;; Get an Org-style link to PNG image or the MathML
3812 ;; file.
3813 (org-link
3814 (let ((link (with-temp-buffer
3815 (insert latex-frag)
3816 (org-format-latex cache-subdir cache-dir
3817 nil display-msg
3818 nil processing-type)
3819 (buffer-substring-no-properties
3820 (point-min) (point-max)))))
3821 (if (org-string-match-p "file:\\([^]]*\\)" link) link
3822 (message "LaTeX Conversion failed.")
3823 nil))))
3824 (when org-link
3825 ;; Conversion succeeded. Parse above Org-style link to
3826 ;; a `link' object.
3827 (let* ((link
3828 (org-element-map
3829 (org-element-parse-secondary-string org-link '(link))
3830 'link #'identity info t))
3831 (replacement
3832 (case (org-element-type latex-*)
3833 ;; Case 1: LaTeX environment. Mimic
3834 ;; a "standalone image or formula" by
3835 ;; enclosing the `link' in a `paragraph'.
3836 ;; Copy over original attributes, captions to
3837 ;; the enclosing paragraph.
3838 (latex-environment
3839 (org-element-adopt-elements
3840 (list 'paragraph
3841 (list :style "OrgFormula"
3842 :name
3843 (org-element-property :name latex-*)
3844 :caption
3845 (org-element-property :caption latex-*)))
3846 link))
3847 ;; Case 2: LaTeX fragment. No special action.
3848 (latex-fragment link))))
3849 ;; Note down the object that link replaces.
3850 (org-element-put-property replacement :replaces
3851 (list (org-element-type latex-*)
3852 (list :value latex-frag)))
3853 ;; Restore blank after initial element or object.
3854 (org-element-put-property
3855 replacement :post-blank
3856 (org-element-property :post-blank latex-*))
3857 ;; Replace now.
3858 (org-element-set-element latex-* replacement)))))
3859 info nil nil t)))
3860 tree)
3863 ;;;; Description lists
3865 ;; This translator is necessary to handle indented tables in a uniform
3866 ;; manner. See comment in `org-odt--table'.
3868 (defun org-odt--translate-description-lists (tree backend info)
3869 ;; OpenDocument has no notion of a description list. So simulate it
3870 ;; using plain lists. Description lists in the exported document
3871 ;; are typeset in the same manner as they are in a typical HTML
3872 ;; document.
3874 ;; Specifically, a description list like this:
3876 ;; ,----
3877 ;; | - term-1 :: definition-1
3878 ;; | - term-2 :: definition-2
3879 ;; `----
3881 ;; gets translated in to the following form:
3883 ;; ,----
3884 ;; | - term-1
3885 ;; | - definition-1
3886 ;; | - term-2
3887 ;; | - definition-2
3888 ;; `----
3890 ;; Further effect is achieved by fixing the OD styles as below:
3892 ;; 1. Set the :type property of the simulated lists to
3893 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3894 ;; that has *no* bullets whatsoever.
3896 ;; 2. The paragraph containing the definition term is styled to be
3897 ;; in bold.
3899 (org-element-map tree 'plain-list
3900 (lambda (el)
3901 (when (equal (org-element-property :type el) 'descriptive)
3902 (org-element-set-element
3904 (apply 'org-element-adopt-elements
3905 (list 'plain-list (list :type 'descriptive-1))
3906 (mapcar
3907 (lambda (item)
3908 (org-element-adopt-elements
3909 (list 'item (list :checkbox (org-element-property
3910 :checkbox item)))
3911 (list 'paragraph (list :style "Text_20_body_20_bold")
3912 (or (org-element-property :tag item) "(no term)"))
3913 (org-element-adopt-elements
3914 (list 'plain-list (list :type 'descriptive-2))
3915 (apply 'org-element-adopt-elements
3916 (list 'item nil)
3917 (org-element-contents item)))))
3918 (org-element-contents el)))))
3919 nil)
3920 info)
3921 tree)
3923 ;;;; List tables
3925 ;; Lists that are marked with attribute `:list-table' are called as
3926 ;; list tables. They will be rendered as a table within the exported
3927 ;; document.
3929 ;; Consider an example. The following list table
3931 ;; #+attr_odt :list-table t
3932 ;; - Row 1
3933 ;; - 1.1
3934 ;; - 1.2
3935 ;; - 1.3
3936 ;; - Row 2
3937 ;; - 2.1
3938 ;; - 2.2
3939 ;; - 2.3
3941 ;; will be exported as though it were an Org table like the one show
3942 ;; below.
3944 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3945 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3947 ;; Note that org-tables are NOT multi-line and each line is mapped to
3948 ;; a unique row in the exported document. So if an exported table
3949 ;; needs to contain a single paragraph (with copious text) it needs to
3950 ;; be typed up in a single line. Editing such long lines using the
3951 ;; table editor will be a cumbersome task. Furthermore inclusion of
3952 ;; multi-paragraph text in a table cell is well-nigh impossible.
3954 ;; A LIST-TABLE circumvents above problems.
3956 ;; Note that in the example above the list items could be paragraphs
3957 ;; themselves and the list can be arbitrarily deep.
3959 ;; Inspired by following thread:
3960 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3962 ;; Translate lists to tables
3964 (defun org-odt--translate-list-tables (tree backend info)
3965 (org-element-map tree 'plain-list
3966 (lambda (l1-list)
3967 (when (org-export-read-attribute :attr_odt l1-list :list-table)
3968 ;; Replace list with table.
3969 (org-element-set-element
3970 l1-list
3971 ;; Build replacement table.
3972 (apply 'org-element-adopt-elements
3973 (list 'table '(:type org :attr_odt (":style \"GriddedTable\"")))
3974 (org-element-map l1-list 'item
3975 (lambda (l1-item)
3976 (let* ((l1-item-contents (org-element-contents l1-item))
3977 l1-item-leading-text l2-list)
3978 ;; Remove Level-2 list from the Level-item. It
3979 ;; will be subsequently attached as table-cells.
3980 (let ((cur l1-item-contents) prev)
3981 (while (and cur (not (eq (org-element-type (car cur))
3982 'plain-list)))
3983 (setq prev cur)
3984 (setq cur (cdr cur)))
3985 (when prev
3986 (setcdr prev nil)
3987 (setq l2-list (car cur)))
3988 (setq l1-item-leading-text l1-item-contents))
3989 ;; Level-1 items start a table row.
3990 (apply 'org-element-adopt-elements
3991 (list 'table-row (list :type 'standard))
3992 ;; Leading text of level-1 item define
3993 ;; the first table-cell.
3994 (apply 'org-element-adopt-elements
3995 (list 'table-cell nil)
3996 l1-item-leading-text)
3997 ;; Level-2 items define subsequent
3998 ;; table-cells of the row.
3999 (org-element-map l2-list 'item
4000 (lambda (l2-item)
4001 (apply 'org-element-adopt-elements
4002 (list 'table-cell nil)
4003 (org-element-contents l2-item)))
4004 info nil 'item))))
4005 info nil 'item))))
4006 nil)
4007 info)
4008 tree)
4011 ;;; Interactive functions
4013 (defun org-odt-create-manifest-file-entry (&rest args)
4014 (push args org-odt-manifest-file-entries))
4016 (defun org-odt-write-manifest-file ()
4017 (make-directory (concat org-odt-zip-dir "META-INF"))
4018 (let ((manifest-file (concat org-odt-zip-dir "META-INF/manifest.xml")))
4019 (with-current-buffer
4020 (let ((nxml-auto-insert-xml-declaration-flag nil))
4021 (find-file-noselect manifest-file t))
4022 (insert
4023 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
4024 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4025 (mapc
4026 (lambda (file-entry)
4027 (let* ((version (nth 2 file-entry))
4028 (extra (if (not version) ""
4029 (format " manifest:version=\"%s\"" version))))
4030 (insert
4031 (format org-odt-manifest-file-entry-tag
4032 (nth 0 file-entry) (nth 1 file-entry) extra))))
4033 org-odt-manifest-file-entries)
4034 (insert "\n</manifest:manifest>"))))
4036 (defmacro org-odt--export-wrap (out-file &rest body)
4037 `(let* ((--out-file ,out-file)
4038 (out-file-type (file-name-extension --out-file))
4039 (org-odt-xml-files '("META-INF/manifest.xml" "content.xml"
4040 "meta.xml" "styles.xml"))
4041 ;; Initialize temporary workarea. All files that end up in
4042 ;; the exported document get parked/created here.
4043 (org-odt-zip-dir (file-name-as-directory
4044 (make-temp-file (format "%s-" out-file-type) t)))
4045 (org-odt-manifest-file-entries nil)
4046 (--cleanup-xml-buffers
4047 (function
4048 (lambda nil
4049 ;; Kill all XML buffers.
4050 (mapc (lambda (file)
4051 (let ((buf (find-buffer-visiting
4052 (concat org-odt-zip-dir file))))
4053 (when buf
4054 (with-current-buffer buf
4055 (set-buffer-modified-p nil)
4056 (kill-buffer buf)))))
4057 org-odt-xml-files)
4058 ;; Delete temporary directory and also other embedded
4059 ;; files that get copied there.
4060 (delete-directory org-odt-zip-dir t)))))
4061 (condition-case err
4062 (progn
4063 (unless (executable-find "zip")
4064 ;; Not at all OSes ship with zip by default
4065 (error "Executable \"zip\" needed for creating OpenDocument files"))
4066 ;; Do export. This creates a bunch of xml files ready to be
4067 ;; saved and zipped.
4068 (progn ,@body)
4069 ;; Create a manifest entry for content.xml.
4070 (org-odt-create-manifest-file-entry "text/xml" "content.xml")
4071 ;; Write mimetype file
4072 (let* ((mimetypes
4073 '(("odt" . "application/vnd.oasis.opendocument.text")
4074 ("odf" . "application/vnd.oasis.opendocument.formula")))
4075 (mimetype (cdr (assoc-string out-file-type mimetypes t))))
4076 (unless mimetype
4077 (error "Unknown OpenDocument backend %S" out-file-type))
4078 (write-region mimetype nil (concat org-odt-zip-dir "mimetype"))
4079 (org-odt-create-manifest-file-entry mimetype "/" "1.2"))
4080 ;; Write out the manifest entries before zipping
4081 (org-odt-write-manifest-file)
4082 ;; Save all XML files.
4083 (mapc (lambda (file)
4084 (let ((buf (find-buffer-visiting
4085 (concat org-odt-zip-dir file))))
4086 (when buf
4087 (with-current-buffer buf
4088 ;; Prettify output if needed.
4089 (when org-odt-prettify-xml
4090 (indent-region (point-min) (point-max)))
4091 (save-buffer 0)))))
4092 org-odt-xml-files)
4093 ;; Run zip.
4094 (let* ((target --out-file)
4095 (target-name (file-name-nondirectory target))
4096 (cmds `(("zip" "-mX0" ,target-name "mimetype")
4097 ("zip" "-rmTq" ,target-name "."))))
4098 ;; If a file with same name as the desired output file
4099 ;; exists, remove it.
4100 (when (file-exists-p target)
4101 (delete-file target))
4102 ;; Zip up the xml files.
4103 (let ((coding-system-for-write 'no-conversion) exitcode err-string)
4104 (message "Creating ODT file...")
4105 ;; Switch temporarily to content.xml. This way Zip
4106 ;; process will inherit `org-odt-zip-dir' as the current
4107 ;; directory.
4108 (with-current-buffer
4109 (find-file-noselect (concat org-odt-zip-dir "content.xml") t)
4110 (mapc
4111 (lambda (cmd)
4112 (message "Running %s" (mapconcat 'identity cmd " "))
4113 (setq err-string
4114 (with-output-to-string
4115 (setq exitcode
4116 (apply 'call-process (car cmd)
4117 nil standard-output nil (cdr cmd)))))
4118 (or (zerop exitcode)
4119 (error (concat "Unable to create OpenDocument file."
4120 (format " Zip failed with error (%s)"
4121 err-string)))))
4122 cmds)))
4123 ;; Move the zip file from temporary work directory to
4124 ;; user-mandated location.
4125 (rename-file (concat org-odt-zip-dir target-name) target)
4126 (message "Created %s" (expand-file-name target))
4127 ;; Cleanup work directory and work files.
4128 (funcall --cleanup-xml-buffers)
4129 ;; Open the OpenDocument file in archive-mode for
4130 ;; examination.
4131 (find-file-noselect target t)
4132 ;; Return exported file.
4133 (cond
4134 ;; Case 1: Conversion desired on exported file. Run the
4135 ;; converter on the OpenDocument file. Return the
4136 ;; converted file.
4137 (org-odt-preferred-output-format
4138 (or (org-odt-convert target org-odt-preferred-output-format)
4139 target))
4140 ;; Case 2: No further conversion. Return exported
4141 ;; OpenDocument file.
4142 (t target))))
4143 (error
4144 ;; Cleanup work directory and work files.
4145 (funcall --cleanup-xml-buffers)
4146 (message "OpenDocument export failed: %s"
4147 (error-message-string err))))))
4150 ;;;; Export to OpenDocument formula
4152 ;;;###autoload
4153 (defun org-odt-export-as-odf (latex-frag &optional odf-file)
4154 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4155 Use `org-create-math-formula' to convert LATEX-FRAG first to
4156 MathML. When invoked as an interactive command, use
4157 `org-latex-regexps' to infer LATEX-FRAG from currently active
4158 region. If no LaTeX fragments are found, prompt for it. Push
4159 MathML source to kill ring depending on the value of
4160 `org-export-copy-to-kill-ring'."
4161 (interactive
4162 `(,(let (frag)
4163 (setq frag (and (setq frag (and (region-active-p)
4164 (buffer-substring (region-beginning)
4165 (region-end))))
4166 (loop for e in org-latex-regexps
4167 thereis (when (string-match (nth 1 e) frag)
4168 (match-string (nth 2 e) frag)))))
4169 (read-string "LaTeX Fragment: " frag nil frag))
4170 ,(let ((odf-filename (expand-file-name
4171 (concat
4172 (file-name-sans-extension
4173 (or (file-name-nondirectory buffer-file-name)))
4174 "." "odf")
4175 (file-name-directory buffer-file-name))))
4176 (read-file-name "ODF filename: " nil odf-filename nil
4177 (file-name-nondirectory odf-filename)))))
4178 (let ((filename (or odf-file
4179 (expand-file-name
4180 (concat
4181 (file-name-sans-extension
4182 (or (file-name-nondirectory buffer-file-name)))
4183 "." "odf")
4184 (file-name-directory buffer-file-name)))))
4185 (org-odt--export-wrap
4186 filename
4187 (let* ((buffer (progn
4188 (require 'nxml-mode)
4189 (let ((nxml-auto-insert-xml-declaration-flag nil))
4190 (find-file-noselect (concat org-odt-zip-dir
4191 "content.xml") t))))
4192 (coding-system-for-write 'utf-8)
4193 (save-buffer-coding-system 'utf-8))
4194 (set-buffer buffer)
4195 (set-buffer-file-coding-system coding-system-for-write)
4196 (let ((mathml (org-create-math-formula latex-frag)))
4197 (unless mathml (error "No Math formula created"))
4198 (insert mathml)
4199 ;; Add MathML to kill ring, if needed.
4200 (when (org-export--copy-to-kill-ring-p)
4201 (org-kill-new (buffer-string))))))))
4203 ;;;###autoload
4204 (defun org-odt-export-as-odf-and-open ()
4205 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4206 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4207 formula file."
4208 (interactive)
4209 (org-open-file (call-interactively 'org-odt-export-as-odf) 'system))
4212 ;;;; Export to OpenDocument Text
4214 ;;;###autoload
4215 (defun org-odt-export-to-odt (&optional async subtreep visible-only ext-plist)
4216 "Export current buffer to a ODT file.
4218 If narrowing is active in the current buffer, only export its
4219 narrowed part.
4221 If a region is active, export that region.
4223 A non-nil optional argument ASYNC means the process should happen
4224 asynchronously. The resulting file should be accessible through
4225 the `org-export-stack' interface.
4227 When optional argument SUBTREEP is non-nil, export the sub-tree
4228 at point, extracting information from the headline properties
4229 first.
4231 When optional argument VISIBLE-ONLY is non-nil, don't export
4232 contents of hidden elements.
4234 EXT-PLIST, when provided, is a property list with external
4235 parameters overriding Org default settings, but still inferior to
4236 file-local settings.
4238 Return output file's name."
4239 (interactive)
4240 (let ((outfile (org-export-output-file-name ".odt" subtreep)))
4241 (if async
4242 (org-export-async-start (lambda (f) (org-export-add-to-stack f 'odt))
4243 `(expand-file-name
4244 (org-odt--export-wrap
4245 ,outfile
4246 (let* ((org-odt-embedded-images-count 0)
4247 (org-odt-embedded-formulas-count 0)
4248 (org-odt-automatic-styles nil)
4249 (org-odt-object-counters nil)
4250 ;; Let `htmlfontify' know that we are interested in
4251 ;; collecting styles.
4252 (hfy-user-sheet-assoc nil))
4253 ;; Initialize content.xml and kick-off the export
4254 ;; process.
4255 (let ((out-buf
4256 (progn
4257 (require 'nxml-mode)
4258 (let ((nxml-auto-insert-xml-declaration-flag nil))
4259 (find-file-noselect
4260 (concat org-odt-zip-dir "content.xml") t))))
4261 (output (org-export-as
4262 'odt ,subtreep ,visible-only nil ,ext-plist)))
4263 (with-current-buffer out-buf
4264 (erase-buffer)
4265 (insert output)))))))
4266 (org-odt--export-wrap
4267 outfile
4268 (let* ((org-odt-embedded-images-count 0)
4269 (org-odt-embedded-formulas-count 0)
4270 (org-odt-automatic-styles nil)
4271 (org-odt-object-counters nil)
4272 ;; Let `htmlfontify' know that we are interested in collecting
4273 ;; styles.
4274 (hfy-user-sheet-assoc nil))
4275 ;; Initialize content.xml and kick-off the export process.
4276 (let ((output (org-export-as 'odt subtreep visible-only nil ext-plist))
4277 (out-buf (progn
4278 (require 'nxml-mode)
4279 (let ((nxml-auto-insert-xml-declaration-flag nil))
4280 (find-file-noselect
4281 (concat org-odt-zip-dir "content.xml") t)))))
4282 (with-current-buffer out-buf (erase-buffer) (insert output))))))))
4285 ;;;; Convert between OpenDocument and other formats
4287 (defun org-odt-reachable-p (in-fmt out-fmt)
4288 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4289 (catch 'done
4290 (let ((reachable-formats (org-odt-do-reachable-formats in-fmt)))
4291 (dolist (e reachable-formats)
4292 (let ((out-fmt-spec (assoc out-fmt (cdr e))))
4293 (when out-fmt-spec
4294 (throw 'done (cons (car e) out-fmt-spec))))))))
4296 (defun org-odt-do-convert (in-file out-fmt &optional prefix-arg)
4297 "Workhorse routine for `org-odt-convert'."
4298 (require 'browse-url)
4299 (let* ((in-file (expand-file-name (or in-file buffer-file-name)))
4300 (dummy (or (file-readable-p in-file)
4301 (error "Cannot read %s" in-file)))
4302 (in-fmt (file-name-extension in-file))
4303 (out-fmt (or out-fmt (error "Output format unspecified")))
4304 (how (or (org-odt-reachable-p in-fmt out-fmt)
4305 (error "Cannot convert from %s format to %s format?"
4306 in-fmt out-fmt)))
4307 (convert-process (car how))
4308 (out-file (concat (file-name-sans-extension in-file) "."
4309 (nth 1 (or (cdr how) out-fmt))))
4310 (extra-options (or (nth 2 (cdr how)) ""))
4311 (out-dir (file-name-directory in-file))
4312 (cmd (format-spec convert-process
4313 `((?i . ,(shell-quote-argument in-file))
4314 (?I . ,(browse-url-file-url in-file))
4315 (?f . ,out-fmt)
4316 (?o . ,out-file)
4317 (?O . ,(browse-url-file-url out-file))
4318 (?d . , (shell-quote-argument out-dir))
4319 (?D . ,(browse-url-file-url out-dir))
4320 (?x . ,extra-options)))))
4321 (when (file-exists-p out-file)
4322 (delete-file out-file))
4324 (message "Executing %s" cmd)
4325 (let ((cmd-output (shell-command-to-string cmd)))
4326 (message "%s" cmd-output))
4328 (cond
4329 ((file-exists-p out-file)
4330 (message "Exported to %s" out-file)
4331 (when prefix-arg
4332 (message "Opening %s..." out-file)
4333 (org-open-file out-file 'system))
4334 out-file)
4336 (message "Export to %s failed" out-file)
4337 nil))))
4339 (defun org-odt-do-reachable-formats (in-fmt)
4340 "Return verbose info about formats to which IN-FMT can be converted.
4341 Return a list where each element is of the
4342 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4343 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4344 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4345 (let* ((converter
4346 (and org-odt-convert-process
4347 (cadr (assoc-string org-odt-convert-process
4348 org-odt-convert-processes t))))
4349 (capabilities
4350 (and org-odt-convert-process
4351 (cadr (assoc-string org-odt-convert-process
4352 org-odt-convert-processes t))
4353 org-odt-convert-capabilities))
4354 reachable-formats)
4355 (when converter
4356 (dolist (c capabilities)
4357 (when (member in-fmt (nth 1 c))
4358 (push (cons converter (nth 2 c)) reachable-formats))))
4359 reachable-formats))
4361 (defun org-odt-reachable-formats (in-fmt)
4362 "Return list of formats to which IN-FMT can be converted.
4363 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4364 (let (l)
4365 (mapc (lambda (e) (add-to-list 'l e))
4366 (apply 'append (mapcar
4367 (lambda (e) (mapcar 'car (cdr e)))
4368 (org-odt-do-reachable-formats in-fmt))))
4371 (defun org-odt-convert-read-params ()
4372 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4373 This is a helper routine for interactive use."
4374 (let* ((input (if (featurep 'ido) 'ido-completing-read 'completing-read))
4375 (in-file (read-file-name "File to be converted: "
4376 nil buffer-file-name t))
4377 (in-fmt (file-name-extension in-file))
4378 (out-fmt-choices (org-odt-reachable-formats in-fmt))
4379 (out-fmt
4380 (or (and out-fmt-choices
4381 (funcall input "Output format: "
4382 out-fmt-choices nil nil nil))
4383 (error
4384 "No known converter or no known output formats for %s files"
4385 in-fmt))))
4386 (list in-file out-fmt)))
4388 ;;;###autoload
4389 (defun org-odt-convert (&optional in-file out-fmt prefix-arg)
4390 "Convert IN-FILE to format OUT-FMT using a command line converter.
4391 IN-FILE is the file to be converted. If unspecified, it defaults
4392 to variable `buffer-file-name'. OUT-FMT is the desired output
4393 format. Use `org-odt-convert-process' as the converter.
4394 If PREFIX-ARG is non-nil then the newly converted file is opened
4395 using `org-open-file'."
4396 (interactive
4397 (append (org-odt-convert-read-params) current-prefix-arg))
4398 (org-odt-do-convert in-file out-fmt prefix-arg))
4400 ;;; Library Initializations
4402 (mapc
4403 (lambda (desc)
4404 ;; Let Emacs open all OpenDocument files in archive mode
4405 (add-to-list 'auto-mode-alist
4406 (cons (concat "\\." (car desc) "\\'") 'archive-mode)))
4407 org-odt-file-extensions)
4409 (provide 'ox-odt)
4411 ;; Local variables:
4412 ;; generated-autoload-file: "org-loaddefs.el"
4413 ;; End:
4415 ;;; ox-odt.el ends here