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