1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2018 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: https://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/>.
29 (require 'format-spec
)
32 (require 'table nil
'noerror
)
36 (org-export-define-backend 'odt
37 '((bold . org-odt-bold
)
38 (center-block . org-odt-center-block
)
39 (clock . org-odt-clock
)
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
)
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
)
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
)))
92 ((?o
"As ODT file" org-odt-export-to-odt
)
93 (?O
"As ODT file and open"
95 (if a
(org-odt-export-to-odt t s v
)
96 (org-open-file (org-odt-export-to-odt nil s v
) 'system
))))))
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
)
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
)))
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 '(("\\\\-" .
"­\\1") ; shy
158 ("---\\([^-]\\)" .
"—\\1") ; mdash
159 ("--\\([^-]\\)" .
"–\\1") ; ndash
160 ("\\.\\.\\." .
"…")) ; hellip
161 "Regular expressions for special string conversion.")
163 (defconst org-odt-schema-dir-list
165 (and org-odt-data-dir
166 (expand-file-name "./schema/" org-odt-data-dir
)) ; bail out
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
178 (and org-odt-data-dir
179 (expand-file-name "./styles/" org-odt-data-dir
)) ; bail out
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
198 (expand-file-name "OrgOdtContentTemplate.xml" dir
))
199 (file-readable-p (expand-file-name "OrgOdtStyles.xml" dir
))))
200 org-odt-styles-dir-list
)))
202 (error "Error (ox-odt): Cannot find factory styles files, aborting"))
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
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\"/>
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:
248 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
249 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
251 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
252 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
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\"/>
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
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
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
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"
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
375 :group
'org-export-odt
383 (defcustom org-odt-schema-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."
410 (const :tag
"Not set" nil
)
411 (directory :tag
"Schema directory"))
412 :group
'org-export-odt
416 "Set `org-odt-schema-dir'.
417 Also add it to `rng-schema-locating-files'."
418 (let ((schema-dir value
))
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
))
426 (expand-file-name "schemas.xml" schema-dir
)))
429 (message "Error (ox-odt): %s has no OpenDocument schema files"
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
))))))
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
)
450 :group
'org-export-odt
453 (defcustom org-odt-styles-file nil
454 "Default styles file for use with ODT export.
455 Valid values are one of:
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
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
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
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")
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
501 :package-version
'(Org .
"8.0")
504 ;;;; Document conversion
506 (defcustom org-odt-convert-processes
508 "soffice --headless --convert-to %f%x --outdir %d %i")
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
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
544 :type
'(choice :convert-widget
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
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")))
560 (("pdf" "pdf") ("odt" "odt") ("html" "html")))
562 ("ods" "ots" "xls" "csv" "xlsx")
563 (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
564 ("xls" "xls") ("xlsx" "xlsx")))
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
603 See default setting of this variable for an typical
605 :group
'org-export-odt
609 (const :tag
"None" nil
)
610 (alist :tag
"Capabilities"
611 :key-type
(string :tag
"Document Class")
613 (group (repeat :tag
"Input formats" (string :tag
"Input format"))
614 (alist :tag
"Output formats"
615 :key-type
(string :tag
"Output format")
617 (group (string :tag
"Output file extension")
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
634 :type
'(choice :convert-widget
636 (apply 'widget-convert
(widget-type w
)
637 (eval (car (widget-get w
:args
)))))
638 `((const :tag
"None" nil
)
639 ,@(mapcar (lambda (c)
641 (org-odt-reachable-formats "odt")))))
643 (put 'org-odt-preferred-output-format
'safe-local-variable
'stringp
)
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
660 :package-version
'(Org .
"8.3")
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
680 :package-version
'(Org .
"8.3")
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
701 :package-version
'(Org .
"8.3")
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
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
725 Any other symbol is a synonym for `mathjax'."
726 :group
'org-export-odt
728 :package-version
'(Org .
"8.0")
730 (const :tag
"Do not process math in any way" nil
)
731 (const :tag
"Leave math verbatim" verbatim
)
732 (const :tag
"Use dvipng to make images" dvipng
)
733 (const :tag
"Use imagemagick to make images" imagemagick
)
734 (other :tag
"Use MathJax to display math" mathjax
)))
739 (defcustom org-odt-inline-formula-rules
740 '(("file" .
"\\.\\(mathml\\|mml\\|odf\\)\\'"))
741 "Rules characterizing formula files that can be inlined into ODT.
743 A rule consists in an association whose key is the type of link
744 to consider, and value is a regexp that will be matched against
746 :group
'org-export-odt
748 :package-version
'(Org .
"8.0")
749 :type
'(alist :key-type
(string :tag
"Type")
750 :value-type
(regexp :tag
"Path")))
752 (defcustom org-odt-inline-image-rules
753 '(("file" .
"\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
754 "Rules characterizing image files that can be inlined into ODT.
756 A rule consists in an association whose key is the type of link
757 to consider, and value is a regexp that will be matched against
759 :group
'org-export-odt
761 :package-version
'(Org .
"8.3")
762 :type
'(alist :key-type
(string :tag
"Type")
763 :value-type
(regexp :tag
"Path")))
765 (defcustom org-odt-pixels-per-inch
96.0
766 "Scaling factor for converting images pixels to inches.
767 Use this for sizing of embedded images. See Info node `(org)
768 Images in ODT export' for more information."
770 :group
'org-export-odt
772 :package-version
'(Org .
"8.1"))
777 (defcustom org-odt-create-custom-styles-for-srcblocks t
778 "Whether custom styles for colorized source blocks be automatically created.
779 When this option is turned on, the exporter creates custom styles
780 for source blocks based on the advice of `htmlfontify'. Creation
781 of custom styles happen as part of `org-odt-hfy-face-to-css'.
783 When this option is turned off exporter does not create such
786 Use the latter option if you do not want the custom styles to be
787 based on your current display settings. It is necessary that the
788 styles.xml already contains needed styles for colorizing to work.
790 This variable is effective only if `org-odt-fontify-srcblocks' is
792 :group
'org-export-odt
796 (defcustom org-odt-fontify-srcblocks t
797 "Specify whether or not source blocks need to be fontified.
798 Turn this option on if you want to colorize the source code
799 blocks in the exported file. For colorization to work, you need
800 to make available an enhanced version of `htmlfontify' library."
802 :group
'org-export-odt
808 (defcustom org-odt-table-styles
809 '(("OrgEquation" "OrgEquation"
810 ((use-first-column-styles . t
)
811 (use-last-column-styles . t
)))
812 ("TableWithHeaderRowAndColumn" "Custom"
813 ((use-first-row-styles . t
)
814 (use-first-column-styles . t
)))
815 ("TableWithFirstRowandLastRow" "Custom"
816 ((use-first-row-styles . t
)
817 (use-last-row-styles . t
)))
818 ("GriddedTable" "Custom" nil
))
819 "Specify how Table Styles should be derived from a Table Template.
820 This is a list where each element is of the
821 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
823 TABLE-STYLE-NAME is the style associated with the table through
824 \"#+ATTR_ODT: :style TABLE-STYLE-NAME\" line.
826 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
827 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
828 below) that is included in `org-odt-content-template-file'.
830 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
832 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
834 TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
835 \"FirstRow\" | \"LastRow\" |
836 \"EvenRow\" | \"OddRow\" |
837 \"EvenColumn\" | \"OddColumn\" | \"\"
838 where \"+\" above denotes string concatenation.
840 TABLE-CELL-OPTIONS is an alist where each element is of the
841 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
842 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
843 `use-last-row-styles' |
844 `use-first-column-styles' |
845 `use-last-column-styles' |
846 `use-banding-rows-styles' |
847 `use-banding-columns-styles' |
848 `use-first-row-styles'
851 For example, with the following configuration
853 \(setq org-odt-table-styles
854 \\='((\"TableWithHeaderRowsAndColumns\" \"Custom\"
855 ((use-first-row-styles . t)
856 (use-first-column-styles . t)))
857 (\"TableWithHeaderColumns\" \"Custom\"
858 ((use-first-column-styles . t)))))
860 1. A table associated with \"TableWithHeaderRowsAndColumns\"
861 style will use the following table-cell styles -
862 \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
863 \"CustomTableCell\" and the following paragraph styles
864 \"CustomFirstRowTableParagraph\",
865 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
868 2. A table associated with \"TableWithHeaderColumns\" style will
869 use the following table-cell styles -
870 \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
871 following paragraph styles
872 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
875 Note that TABLE-TEMPLATE-NAME corresponds to the
876 \"<table:table-template>\" elements contained within
877 \"<office:styles>\". The entries (TABLE-STYLE-NAME
878 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
879 \"table:template-name\" and \"table:use-first-row-styles\" etc
880 attributes of \"<table:table>\" element. Refer ODF-1.2
881 specification for more information. Also consult the
882 implementation filed under `org-odt-get-table-cell-styles'.
884 The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
885 formatting of numbered display equations. Do not delete this
886 style from the list."
887 :group
'org-export-odt
890 (const :tag
"None" nil
)
891 (repeat :tag
"Table Styles"
892 (list :tag
"Table Style Specification"
893 (string :tag
"Table Style Name")
894 (string :tag
"Table Template Name")
895 (alist :options
(use-first-row-styles
897 use-first-column-styles
898 use-last-column-styles
899 use-banding-rows-styles
900 use-banding-columns-styles
)
902 :value-type
(const :tag
"True" t
))))))
906 (defcustom org-odt-use-date-fields nil
907 "Non-nil, if timestamps should be exported as date fields.
909 When nil, export timestamps as plain text.
911 When non-nil, map `org-time-stamp-custom-formats' to a pair of
912 OpenDocument date-styles with names \"OrgDate1\" and \"OrgDate2\"
913 respectively. A timestamp with no time component is formatted
914 with style \"OrgDate1\" while one with explicit hour and minutes
915 is formatted with style \"OrgDate2\".
917 This feature is experimental. Most (but not all) of the common
918 %-specifiers in `format-time-string' are supported.
919 Specifically, locale-dependent specifiers like \"%c\", \"%x\" are
920 formatted as canonical Org timestamps. For finer control, avoid
923 Textual specifiers like \"%b\", \"%h\", \"%B\", \"%a\", \"%A\"
924 etc., are displayed by the application in the default language
925 and country specified in `org-odt-styles-file'. Note that the
926 default styles file uses language \"en\" and country \"GB\". You
927 can localize the week day and month strings in the exported
928 document by setting the default language and country either using
929 the application UI or through a custom styles file.
931 See `org-odt--build-date-styles' for implementation details."
932 :group
'org-export-odt
934 :package-version
'(Org .
"8.0")
939 ;;; Internal functions
943 (defun org-odt--format-timestamp (timestamp &optional end iso-date-p
)
944 (let* ((format-timestamp
945 (lambda (timestamp format
&optional end utc
)
947 (org-timestamp-format timestamp format end utc
)
948 (format-time-string format nil utc
))))
949 (has-time-p (or (not timestamp
)
950 (org-timestamp-has-time-p timestamp
)))
951 (iso-date (let ((format (if has-time-p
"%Y-%m-%dT%H:%M:%S"
952 "%Y-%m-%dT%H:%M:%S")))
953 (funcall format-timestamp timestamp format end
))))
954 (if iso-date-p iso-date
955 (let* ((style (if has-time-p
"OrgDate2" "OrgDate1"))
956 ;; LibreOffice does not care about end goes as content
957 ;; within the "<text:date>...</text:date>" field. The
958 ;; displayed date is automagically corrected to match the
959 ;; format requested by "style:data-style-name" attribute. So
960 ;; don't bother about formatting the date contents to be
961 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
962 ;; simple Org-style date should suffice.
963 (date (let* ((formats
964 (if org-display-custom-times
966 (car org-time-stamp-custom-formats
) 1 -
1)
968 (cdr org-time-stamp-custom-formats
) 1 -
1))
969 '("%Y-%m-%d %a" .
"%Y-%m-%d %a %H:%M")))
970 (format (if has-time-p
(cdr formats
) (car formats
))))
971 (funcall format-timestamp timestamp format end
)))
972 (repeater (let ((repeater-type (org-element-property
973 :repeater-type timestamp
))
974 (repeater-value (org-element-property
975 :repeater-value timestamp
))
976 (repeater-unit (org-element-property
977 :repeater-unit timestamp
)))
979 (cl-case repeater-type
980 (catchup "++") (restart ".+") (cumulate "+"))
982 (number-to-string repeater-value
))
983 (cl-case repeater-unit
984 (hour "h") (day "d") (week "w") (month "m")
987 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
989 (and (not (string= repeater
"")) " ")
994 (defun org-odt--frame (text width height style
&optional extra
995 anchor-type
&rest title-and-desc
)
998 (if width
(format " svg:width=\"%0.2fcm\"" width
) "")
999 (if height
(format " svg:height=\"%0.2fcm\"" height
) "")
1001 (format " text:anchor-type=\"%s\"" (or anchor-type
"paragraph"))
1002 (format " draw:name=\"%s\""
1003 (car (org-odt-add-automatic-style "Frame"))))))
1005 "\n<draw:frame draw:style-name=\"%s\"%s>\n%s\n</draw:frame>"
1008 (let ((title (car title-and-desc
))
1009 (desc (cadr title-and-desc
)))
1011 (format "<svg:title>%s</svg:title>"
1012 (org-odt--encode-plain-text title t
)))
1014 (format "<svg:desc>%s</svg:desc>"
1015 (org-odt--encode-plain-text desc t
)))))))))
1018 ;;;; Library wrappers
1020 (defun org-odt--zip-extract (archive members target
)
1021 (when (atom members
) (setq members
(list members
)))
1023 (dolist (member members
)
1024 (let* ((--quote-file-name
1025 ;; This is shamelessly stolen from `archive-zip-extract'.
1027 (if (or (not (memq system-type
'(windows-nt ms-dos
)))
1028 (and (boundp 'w32-quote-process-args
)
1029 (null w32-quote-process-args
)))
1030 (shell-quote-argument name
)
1032 (target (funcall --quote-file-name target
))
1033 (archive (expand-file-name archive
))
1034 (archive-zip-extract
1035 (list "unzip" "-qq" "-o" "-d" target
))
1036 exit-code command-output
)
1037 (setq command-output
1039 (setq exit-code
(archive-zip-extract archive member
))
1041 (unless (zerop exit-code
)
1042 (message command-output
)
1043 (error "Extraction failed")))))
1047 (defun org-odt--target (text id
)
1050 (format "\n<text:bookmark-start text:name=\"OrgXref.%s\"/>" id
)
1051 (format "\n<text:bookmark text:name=\"%s\"/>" id
) text
1052 (format "\n<text:bookmark-end text:name=\"OrgXref.%s\"/>" id
))))
1056 (defun org-odt--textbox (text width height style
&optional
1059 (format "\n<draw:text-box %s>%s\n</draw:text-box>"
1060 (concat (format " fo:min-height=\"%0.2fcm\"" (or height
.2))
1062 (format " fo:min-width=\"%0.2fcm\"" (or width
.2))))
1064 width nil style extra anchor-type
))
1068 ;;;; Table of Contents
1070 (defun org-odt--format-toc (title entries depth
)
1071 "Return a table of contents.
1072 TITLE is the title of the table, as a string, or nil. ENTRIES is
1073 the contents of the table, as a string. DEPTH is an integer
1074 specifying the depth of the table."
1077 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1078 (format " <text:table-of-content-source text:outline-level=\"%d\">" depth
)
1081 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1085 (let ((levels (number-sequence 1 10)))
1090 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1091 <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
1092 <text:index-entry-chapter/>
1093 <text:index-entry-text/>
1094 <text:index-entry-link-end/>
1095 </text:table-of-content-entry-template>\n"
1096 level level
)) levels
""))
1098 </text:table-of-content-source>
1102 <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
1103 <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
1104 </text:index-title>\n"
1109 </text:table-of-content>"))
1111 (cl-defun org-odt-format-toc-headline
1112 (todo _todo-type priority text tags
1113 &key _level section-number headline-label
&allow-other-keys
)
1114 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
1118 (and section-number
(concat section-number
". "))
1121 (let ((style (if (member todo org-done-keywords
)
1122 "OrgDone" "OrgTodo")))
1123 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1126 (let* ((style (format "OrgPriority-%s" priority
))
1127 (priority (format "[#%c]" priority
)))
1128 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1135 (format " <text:span text:style-name=\"%s\">[%s]</text:span>"
1140 "<text:span text:style-name=\"%s\">%s</text:span>"
1141 "OrgTag" tag
)) tags
" : ")))))))
1143 (defun org-odt-toc (depth info
&optional scope
)
1144 "Build a table of contents.
1145 DEPTH is an integer specifying the depth of the table. INFO is
1146 a plist containing current export properties. Optional argument
1147 SCOPE, when non-nil, defines the scope of the table. Return the
1148 table of contents as a string, or nil."
1149 (cl-assert (wholenump depth
))
1150 ;; When a headline is marked as a radio target, as in the example below:
1152 ;; ** <<<Some Heading>>>
1155 ;; suppress generation of radio targets. i.e., Radio targets are to
1156 ;; be marked as targets within /document body/ and *not* within
1157 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1158 ;; and one in the document body.
1160 ;; Likewise, links, footnote references and regular targets are also
1162 (let* ((headlines (org-export-collect-headlines info depth scope
))
1163 (backend (org-export-toc-entry-backend
1164 (org-export-backend-name (plist-get info
:back-end
)))))
1166 (org-odt--format-toc
1167 (and (not scope
) (org-export-translate "Table of Contents" :utf-8 info
))
1170 (let* ((entry (org-odt-format-headline--wrap
1171 headline backend info
'org-odt-format-toc-headline
))
1172 (level (org-export-get-relative-level headline info
))
1173 (style (format "Contents_20_%d" level
)))
1174 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1180 ;;;; Document styles
1182 (defun org-odt-add-automatic-style (object-type &optional object-props
)
1183 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1184 OBJECT-PROPS is (typically) a plist created by passing
1185 \"#+ATTR_ODT: \" option of the object in question to
1186 `org-odt-parse-block-attributes'.
1188 Use `org-odt-object-counters' to generate an automatic
1189 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1190 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1192 (cl-assert (stringp object-type
))
1193 (let* ((object (intern object-type
))
1195 (seqno (1+ (or (plist-get org-odt-object-counters seqvar
) 0)))
1196 (object-name (format "%s%d" object-type seqno
)) style-name
)
1197 (setq org-odt-object-counters
1198 (plist-put org-odt-object-counters seqvar seqno
))
1200 (setq style-name
(format "Org%s" object-name
))
1201 (setq org-odt-automatic-styles
1202 (plist-put org-odt-automatic-styles object
1203 (append (list (list style-name object-props
))
1204 (plist-get org-odt-automatic-styles object
)))))
1205 (cons object-name style-name
)))
1209 (defun org-odt--checkbox (item)
1210 "Return check-box string associated to ITEM."
1211 (let ((checkbox (org-element-property :checkbox item
)))
1212 (if (not checkbox
) ""
1213 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1214 "OrgCode" (cl-case checkbox
1215 (on "[✓] ") ; CHECK MARK
1221 (defun org-odt--build-date-styles (fmt style
)
1222 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1223 ;; to modify the date fields. A date could be modified by
1224 ;; offsetting in days. That's about it. Also, date and time may
1225 ;; have to be emitted as two fields - a date field and a time field
1228 ;; One can add Form Controls to date and time fields so that they
1229 ;; can be easily modified. But then, the exported document will
1230 ;; become tightly coupled with LibreOffice and may not function
1231 ;; properly with other OpenDocument applications.
1233 ;; I have a strange feeling that Date styles are a bit flaky at the
1236 ;; The feature is experimental.
1237 (when (and fmt style
)
1239 '(("%A" .
"<number:day-of-week number:style=\"long\"/>")
1240 ("%B" .
"<number:month number:textual=\"true\" number:style=\"long\"/>")
1241 ("%H" .
"<number:hours number:style=\"long\"/>")
1242 ("%M" .
"<number:minutes number:style=\"long\"/>")
1243 ("%S" .
"<number:seconds number:style=\"long\"/>")
1244 ("%V" .
"<number:week-of-year/>")
1245 ("%Y" .
"<number:year number:style=\"long\"/>")
1246 ("%a" .
"<number:day-of-week number:style=\"short\"/>")
1247 ("%b" .
"<number:month number:textual=\"true\" number:style=\"short\"/>")
1248 ("%d" .
"<number:day number:style=\"long\"/>")
1249 ("%e" .
"<number:day number:style=\"short\"/>")
1250 ("%h" .
"<number:month number:textual=\"true\" number:style=\"short\"/>")
1251 ("%k" .
"<number:hours number:style=\"short\"/>")
1252 ("%m" .
"<number:month number:style=\"long\"/>")
1253 ("%p" .
"<number:am-pm/>")
1254 ("%y" .
"<number:year number:style=\"short\"/>")))
1255 (case-fold-search nil
)
1256 (re (mapconcat 'identity
(mapcar 'car fmt-alist
) "\\|"))
1257 match rpl
(start 0) (filler-beg 0) filler-end filler output
)
1259 '(("\\(?:%[[:digit:]]*N\\)" .
"") ; strip ns, us and ns
1260 ("%C" .
"Y") ; replace century with year
1262 ("%G" .
"Y") ; year corresponding to iso week
1263 ("%I" .
"%H") ; hour on a 12-hour clock
1266 ("%U\\|%W" .
"%V") ; week no. starting on Sun./Mon.
1267 ("%Z" .
"") ; time zone name
1268 ("%c" .
"%Y-%M-%d %a %H:%M" ) ; locale's date and time format
1270 ("%X" .
"%x" ) ; locale's pref. time format
1271 ("%j" .
"") ; day of the year
1272 ("%l" .
"%k") ; like %I blank-padded
1273 ("%s" .
"") ; no. of secs since 1970-01-01 00:00:00 +0000
1274 ("%n" .
"<text:line-break/>")
1275 ("%r" .
"%I:%M:%S %p")
1276 ("%t" .
"<text:tab/>")
1277 ("%u\\|%w" .
"") ; numeric day of week - Mon (1-7), Sun(0-6)
1278 ("%x" .
"%Y-%M-%d %a") ; locale's pref. time format
1279 ("%z" .
"") ; time zone in numeric form
1281 (setq fmt
(replace-regexp-in-string (car pair
) (cdr pair
) fmt t t
)))
1282 (while (string-match re fmt start
)
1283 (setq match
(match-string 0 fmt
))
1284 (setq rpl
(assoc-default match fmt-alist
))
1285 (setq start
(match-end 0))
1286 (setq filler-end
(match-beginning 0))
1287 (setq filler
(substring fmt
(prog1 filler-beg
1288 (setq filler-beg
(match-end 0)))
1290 (setq filler
(and (not (string= filler
""))
1291 (format "<number:text>%s</number:text>"
1292 (org-odt--encode-plain-text filler
))))
1293 (setq output
(concat output
"\n" filler
"\n" rpl
)))
1294 (setq filler
(substring fmt filler-beg
))
1295 (unless (string= filler
"")
1296 (setq output
(concat output
1297 (format "\n<number:text>%s</number:text>"
1298 (org-odt--encode-plain-text filler
)))))
1299 (format "\n<number:date-style style:name=\"%s\" %s>%s\n</number:date-style>"
1301 (concat " number:automatic-order=\"true\""
1302 " number:format-source=\"fixed\"")
1305 (defun org-odt-template (contents info
)
1306 "Return complete document string after ODT conversion.
1307 CONTENTS is the transcoded contents string. RAW-DATA is the
1308 original parsed data. INFO is a plist holding export options."
1310 (let ((title (org-export-data (plist-get info
:title
) info
))
1311 (subtitle (org-export-data (plist-get info
:subtitle
) info
))
1312 (author (let ((author (plist-get info
:author
)))
1313 (if (not author
) "" (org-export-data author info
))))
1314 (keywords (or (plist-get info
:keywords
) ""))
1315 (description (or (plist-get info
:description
) "")))
1318 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
1319 <office:document-meta
1320 xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
1321 xmlns:xlink=\"http://www.w3.org/1999/xlink\"
1322 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
1323 xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
1324 xmlns:ooo=\"http://openoffice.org/2004/office\"
1325 office:version=\"1.2\">
1327 (format "<dc:creator>%s</dc:creator>\n" author
)
1328 (format "<meta:initial-creator>%s</meta:initial-creator>\n" author
)
1329 ;; Date, if required.
1330 (when (plist-get info
:with-date
)
1331 ;; Check if DATE is specified as an Org-timestamp. If yes,
1332 ;; include it as meta information. Otherwise, just use
1334 (let* ((date (let ((date (plist-get info
:date
)))
1335 (and (not (cdr date
))
1336 (eq (org-element-type (car date
)) 'timestamp
)
1338 (let ((iso-date (org-odt--format-timestamp date nil
'iso-date
)))
1340 (format "<dc:date>%s</dc:date>\n" iso-date
)
1341 (format "<meta:creation-date>%s</meta:creation-date>\n"
1343 (format "<meta:generator>%s</meta:generator>\n"
1344 (plist-get info
:creator
))
1345 (format "<meta:keyword>%s</meta:keyword>\n" keywords
)
1346 (format "<dc:subject>%s</dc:subject>\n" description
)
1347 (format "<dc:title>%s</dc:title>\n" title
)
1348 (when (org-string-nw-p subtitle
)
1350 "<meta:user-defined meta:name=\"subtitle\">%s</meta:user-defined>\n"
1353 " </office:meta>\n" "</office:document-meta>")
1354 nil
(concat org-odt-zip-dir
"meta.xml"))
1355 ;; Add meta.xml in to manifest.
1356 (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
1358 ;; Update styles file.
1359 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1360 ;; Write styles file.
1361 (let* ((styles-file (plist-get info
:odt-styles-file
))
1362 (styles-file (and (org-string-nw-p styles-file
)
1363 (read (org-trim styles-file
))))
1364 ;; Non-availability of styles.xml is not a critical
1365 ;; error. For now, throw an error.
1366 (styles-file (or styles-file
1367 (plist-get info
:odt-styles-file
)
1368 (expand-file-name "OrgOdtStyles.xml"
1370 (error "org-odt: Missing styles file?"))))
1372 ((listp styles-file
)
1373 (let ((archive (nth 0 styles-file
))
1374 (members (nth 1 styles-file
)))
1375 (org-odt--zip-extract archive members org-odt-zip-dir
)
1376 (dolist (member members
)
1377 (when (org-file-image-p member
)
1378 (let* ((image-type (file-name-extension member
))
1379 (media-type (format "image/%s" image-type
)))
1380 (org-odt-create-manifest-file-entry media-type member
))))))
1381 ((and (stringp styles-file
) (file-exists-p styles-file
))
1382 (let ((styles-file-type (file-name-extension styles-file
)))
1384 ((string= styles-file-type
"xml")
1385 (copy-file styles-file
(concat org-odt-zip-dir
"styles.xml") t
))
1386 ((member styles-file-type
'("odt" "ott"))
1387 (org-odt--zip-extract styles-file
"styles.xml" org-odt-zip-dir
)))))
1389 (error "Invalid specification of styles.xml file: %S"
1390 (plist-get info
:odt-styles-file
))))
1392 ;; create a manifest entry for styles.xml
1393 (org-odt-create-manifest-file-entry "text/xml" "styles.xml")
1395 ;; FIXME: Who is opening an empty styles.xml before this point?
1396 (with-current-buffer
1397 (find-file-noselect (concat org-odt-zip-dir
"styles.xml") t
)
1400 ;; Write custom styles for source blocks
1401 ;; Save STYLES used for colorizing of source blocks.
1402 ;; Update styles.xml with styles that were collected as part of
1403 ;; `org-odt-hfy-face-to-css' callbacks.
1404 (let ((styles (mapconcat (lambda (style) (format " %s\n" (cddr style
)))
1405 hfy-user-sheet-assoc
"")))
1407 (goto-char (point-min))
1408 (when (re-search-forward "</office:styles>" nil t
)
1409 (goto-char (match-beginning 0))
1410 (insert "\n<!-- Org Htmlfontify Styles -->\n" styles
"\n"))))
1412 ;; Update styles.xml - take care of outline numbering
1414 ;; Don't make automatic backup of styles.xml file. This setting
1415 ;; prevents the backed-up styles.xml file from being zipped in to
1416 ;; odt file. This is more of a hackish fix. Better alternative
1417 ;; would be to fix the zip command so that the output odt file
1418 ;; includes only the needed files and excludes any auto-generated
1419 ;; extra files like backups and auto-saves etc etc. Note that
1420 ;; currently the zip command zips up the entire temp directory so
1421 ;; that any auto-generated files created under the hood ends up in
1422 ;; the resulting odt file.
1423 (setq-local backup-inhibited t
)
1425 ;; Outline numbering is retained only upto LEVEL.
1426 ;; To disable outline numbering pass a LEVEL of 0.
1428 (goto-char (point-min))
1430 "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
1432 "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
1433 (while (re-search-forward regex nil t
)
1434 (unless (let ((sec-num (plist-get info
:section-numbers
))
1435 (level (string-to-number (match-string 2))))
1436 (if (wholenump sec-num
) (<= level sec-num
) sec-num
))
1437 (replace-match replacement t nil
))))
1439 ;; Update content.xml.
1441 (let* ( ;; `org-display-custom-times' should be accessed right
1442 ;; within the context of the Org buffer. So obtain its
1443 ;; value before moving on to temp-buffer context down below.
1445 (if org-display-custom-times
1446 (cons (substring (car org-time-stamp-custom-formats
) 1 -
1)
1447 (substring (cdr org-time-stamp-custom-formats
) 1 -
1))
1448 '("%Y-%M-%d %a" .
"%Y-%M-%d %a %H:%M"))))
1450 (insert-file-contents
1451 (or (plist-get info
:odt-content-template-file
)
1452 (expand-file-name "OrgOdtContentTemplate.xml"
1453 org-odt-styles-dir
)))
1454 ;; Write automatic styles.
1455 ;; - Position the cursor.
1456 (goto-char (point-min))
1457 (re-search-forward " </office:automatic-styles>" nil t
)
1458 (goto-char (match-beginning 0))
1459 ;; - Dump automatic table styles.
1460 (cl-loop for
(style-name props
) in
1461 (plist-get org-odt-automatic-styles
'Table
) do
1462 (when (setq props
(or (plist-get props
:rel-width
) "96"))
1463 (insert (format org-odt-table-style-format style-name props
))))
1464 ;; - Dump date-styles.
1465 (when (plist-get info
:odt-use-date-fields
)
1466 (insert (org-odt--build-date-styles (car custom-time-fmts
)
1468 (org-odt--build-date-styles (cdr custom-time-fmts
)
1470 ;; Update display level.
1471 ;; - Remove existing sequence decls. Also position the cursor.
1472 (goto-char (point-min))
1473 (when (re-search-forward "<text:sequence-decls" nil t
)
1474 (delete-region (match-beginning 0)
1475 (re-search-forward "</text:sequence-decls>" nil nil
)))
1476 ;; Update sequence decls according to user preference.
1479 "\n<text:sequence-decls>\n%s\n</text:sequence-decls>"
1483 "<text:sequence-decl text:display-outline-level=\"%d\" text:name=\"%s\"/>"
1484 (plist-get info
:odt-display-outline-level
)
1486 org-odt-category-map-alist
"\n")))
1487 ;; Position the cursor to document body.
1488 (goto-char (point-min))
1489 (re-search-forward "</office:text>" nil nil
)
1490 (goto-char (match-beginning 0))
1492 ;; Preamble - Title, Author, Date etc.
1494 (let* ((title (and (plist-get info
:with-title
)
1495 (org-export-data (plist-get info
:title
) info
)))
1496 (subtitle (when title
1497 (org-export-data (plist-get info
:subtitle
) info
)))
1498 (author (and (plist-get info
:with-author
)
1499 (let ((auth (plist-get info
:author
)))
1500 (and auth
(org-export-data auth info
)))))
1501 (email (plist-get info
:email
))
1502 ;; Switch on or off above vars based on user settings
1503 (author (and (plist-get info
:with-author
) (or author email
)))
1504 (email (and (plist-get info
:with-email
) email
)))
1507 (when (org-string-nw-p title
)
1509 (format "\n<text:p text:style-name=\"%s\">%s</text:p>\n"
1510 "OrgTitle" (format "\n<text:title>%s</text:title>" title
))
1512 "\n<text:p text:style-name=\"OrgTitle\"/>\n"
1514 (when (org-string-nw-p subtitle
)
1516 (format "<text:p text:style-name=\"OrgSubtitle\">\n%s\n</text:p>\n"
1518 "<text:user-defined style:data-style-name=\"N0\" text:name=\"subtitle\">\n"
1520 "</text:user-defined>\n"))
1522 "<text:p text:style-name=\"OrgSubtitle\"/>\n"))))
1524 ((and author
(not email
))
1527 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1529 (format "<text:initial-creator>%s</text:initial-creator>" author
))
1531 "\n<text:p text:style-name=\"OrgSubtitle\"/>"))
1533 ;; Author and E-mail.
1536 "\n<text:p text:style-name=\"%s\">%s</text:p>"
1539 "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
1540 (concat "mailto:" email
)
1541 (format "<text:initial-creator>%s</text:initial-creator>" author
)))
1543 "\n<text:p text:style-name=\"OrgSubtitle\"/>")))
1544 ;; Date, if required.
1545 (when (plist-get info
:with-date
)
1546 (let* ((date (plist-get info
:date
))
1547 ;; Check if DATE is specified as a timestamp.
1548 (timestamp (and (not (cdr date
))
1549 (eq (org-element-type (car date
)) 'timestamp
)
1553 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1555 (if (and (plist-get info
:odt-use-date-fields
) timestamp
)
1556 (org-odt--format-timestamp (car date
))
1557 (org-export-data date info
)))
1559 "<text:p text:style-name=\"OrgSubtitle\"/>")))))))
1560 ;; Table of Contents
1561 (let* ((with-toc (plist-get info
:with-toc
))
1562 (depth (and with-toc
(if (wholenump with-toc
)
1564 (plist-get info
:headline-levels
)))))
1565 (when depth
(insert (or (org-odt-toc depth info
) ""))))
1569 (buffer-substring-no-properties (point-min) (point-max)))))
1573 ;;; Transcode Functions
1577 (defun org-odt-bold (_bold contents _info
)
1578 "Transcode BOLD from Org to ODT.
1579 CONTENTS is the text with bold markup. INFO is a plist holding
1580 contextual information."
1581 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1587 (defun org-odt-center-block (_center-block contents _info
)
1588 "Transcode a CENTER-BLOCK element from Org to ODT.
1589 CONTENTS holds the contents of the center block. INFO is a plist
1590 holding contextual information."
1596 (defun org-odt-clock (clock contents info
)
1597 "Transcode a CLOCK element from Org to ODT.
1598 CONTENTS is nil. INFO is a plist used as a communication
1600 (let ((timestamp (org-element-property :value clock
))
1601 (duration (org-element-property :duration clock
)))
1602 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1603 (if (eq (org-element-type (org-export-get-next-element clock info
))
1604 'clock
) "OrgClock" "OrgClockLastLine")
1606 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1607 "OrgClockKeyword" org-clock-string
)
1608 (org-odt-timestamp timestamp contents info
)
1609 (and duration
(format " (%s)" duration
))))))
1614 (defun org-odt-code (code _contents _info
)
1615 "Transcode a CODE object from Org to ODT.
1616 CONTENTS is nil. INFO is a plist used as a communication
1618 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1619 "OrgCode" (org-odt--encode-plain-text
1620 (org-element-property :value code
))))
1625 (defun org-odt-drawer (drawer contents info
)
1626 "Transcode a DRAWER element from Org to ODT.
1627 CONTENTS holds the contents of the block. INFO is a plist
1628 holding contextual information."
1629 (let* ((name (org-element-property :drawer-name drawer
))
1630 (output (funcall (plist-get info
:odt-format-drawer-function
)
1637 (defun org-odt-dynamic-block (_dynamic-block contents _info
)
1638 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1639 CONTENTS holds the contents of the block. INFO is a plist
1640 holding contextual information. See `org-export-data'."
1646 (defun org-odt-entity (entity _contents _info
)
1647 "Transcode an ENTITY object from Org to ODT.
1648 CONTENTS are the definition itself. INFO is a plist holding
1649 contextual information."
1650 (org-element-property :utf-8 entity
))
1655 (defun org-odt-example-block (example-block _contents info
)
1656 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1657 CONTENTS is nil. INFO is a plist holding contextual information."
1658 (org-odt-format-code example-block info
))
1663 (defun org-odt-export-snippet (export-snippet _contents _info
)
1664 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1665 CONTENTS is nil. INFO is a plist holding contextual information."
1666 (when (eq (org-export-snippet-backend export-snippet
) 'odt
)
1667 (org-element-property :value export-snippet
)))
1672 (defun org-odt-export-block (export-block _contents _info
)
1673 "Transcode a EXPORT-BLOCK element from Org to ODT.
1674 CONTENTS is nil. INFO is a plist holding contextual information."
1675 (when (string= (org-element-property :type export-block
) "ODT")
1676 (org-remove-indentation (org-element-property :value export-block
))))
1681 (defun org-odt-fixed-width (fixed-width _contents info
)
1682 "Transcode a FIXED-WIDTH element from Org to ODT.
1683 CONTENTS is nil. INFO is a plist holding contextual information."
1684 (org-odt-do-format-code (org-element-property :value fixed-width
) info
))
1687 ;;;; Footnote Definition
1689 ;; Footnote Definitions are ignored.
1692 ;;;; Footnote Reference
1694 (defun org-odt-footnote-reference (footnote-reference _contents info
)
1695 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1696 CONTENTS is nil. INFO is a plist holding contextual information."
1697 (let ((--format-footnote-definition
1699 (setq n
(format "%d" n
))
1700 (let ((id (concat "fn" n
))
1701 (note-class "footnote"))
1703 "<text:note text:id=\"%s\" text:note-class=\"%s\">%s</text:note>"
1706 (format "<text:note-citation>%s</text:note-citation>" n
)
1707 (format "<text:note-body>%s</text:note-body>" def
))))))
1708 (--format-footnote-reference
1710 (setq n
(format "%d" n
))
1711 (let ((note-class "footnote")
1713 (ref-name (concat "fn" n
)))
1715 "<text:span text:style-name=\"%s\">%s</text:span>"
1717 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1718 note-class ref-format ref-name n
))))))
1720 ;; Insert separator between two footnotes in a row.
1721 (let ((prev (org-export-get-previous-element footnote-reference info
)))
1722 (and (eq (org-element-type prev
) 'footnote-reference
)
1723 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1724 "OrgSuperscript" ",")))
1725 ;; Transcode footnote reference.
1726 (let ((n (org-export-get-footnote-number footnote-reference info nil t
)))
1729 (org-export-footnote-first-reference-p footnote-reference info nil t
))
1730 (funcall --format-footnote-reference n
))
1732 (let* ((raw (org-export-get-footnote-definition
1733 footnote-reference info
))
1735 (let ((def (org-trim
1736 (org-export-data-with-backend
1738 (org-export-create-backend
1741 '((paragraph .
(lambda (p c i
)
1742 (org-odt--format-paragraph
1746 "OrgFootnoteQuotations")))))
1748 ;; Inline definitions are secondary strings. We
1749 ;; need to wrap them within a paragraph.
1750 (if (eq (org-element-class (car (org-element-contents raw
)))
1754 "\n<text:p text:style-name=\"Footnote\">%s</text:p>"
1756 (funcall --format-footnote-definition n def
))))))))
1761 (defun org-odt-format-headline--wrap (headline backend info
1762 &optional format-function
1764 "Transcode a HEADLINE element using BACKEND.
1765 INFO is a plist holding contextual information."
1766 (setq backend
(or backend
(plist-get info
:back-end
)))
1767 (let* ((level (+ (org-export-get-relative-level headline info
)))
1768 (headline-number (org-export-get-headline-number headline info
))
1769 (section-number (and (org-export-numbered-headline-p headline info
)
1770 (mapconcat 'number-to-string
1771 headline-number
".")))
1772 (todo (and (plist-get info
:with-todo-keywords
)
1773 (let ((todo (org-element-property :todo-keyword headline
)))
1775 (org-export-data-with-backend todo backend info
)))))
1776 (todo-type (and todo
(org-element-property :todo-type headline
)))
1777 (priority (and (plist-get info
:with-priority
)
1778 (org-element-property :priority headline
)))
1779 (text (org-export-data-with-backend
1780 (org-element-property :title headline
) backend info
))
1781 (tags (and (plist-get info
:with-tags
)
1782 (org-export-get-tags headline info
)))
1783 (headline-label (org-export-get-reference headline info
))
1785 (if (functionp format-function
) format-function
1787 (lambda (todo todo-type priority text tags
1788 &key _level _section-number _headline-label
1790 (funcall (plist-get info
:odt-format-headline-function
)
1791 todo todo-type priority text tags
))))))
1792 (apply format-function
1793 todo todo-type priority text tags
1794 :headline-label headline-label
1796 :section-number section-number extra-keys
)))
1798 (defun org-odt-headline (headline contents info
)
1799 "Transcode a HEADLINE element from Org to ODT.
1800 CONTENTS holds the contents of the headline. INFO is a plist
1801 holding contextual information."
1802 ;; Case 1: This is a footnote section: ignore it.
1803 (unless (org-element-property :footnote-section-p headline
)
1804 (let* ((full-text (org-odt-format-headline--wrap headline nil info
))
1805 ;; Get level relative to current parsed data.
1806 (level (org-export-get-relative-level headline info
))
1807 (numbered (org-export-numbered-headline-p headline info
))
1808 ;; Get canonical label for the headline.
1809 (id (org-export-get-reference headline info
))
1812 (let ((id (org-element-property :ID headline
)))
1813 (if id
(org-odt--target "" (concat "ID-" id
)) "")))
1815 (anchored-title (org-odt--target full-text id
)))
1817 ;; Case 2. This is a deep sub-tree: export it as a list item.
1818 ;; Also export as items headlines for which no section
1819 ;; format has been found.
1820 ((org-export-low-level-p headline info
)
1821 ;; Build the real contents of the sub-tree.
1823 (and (org-export-first-sibling-p headline info
)
1824 (format "\n<text:list text:style-name=\"%s\" %s>"
1825 ;; Choose style based on list type.
1826 (if numbered
"OrgNumberedList" "OrgBulletedList")
1827 ;; If top-level list, re-start numbering. Otherwise,
1828 ;; continue numbering.
1829 (format "text:continue-numbering=\"%s\""
1830 (let* ((parent (org-export-get-parent-headline
1833 (org-export-low-level-p parent info
))
1835 (let ((headline-has-table-p
1836 (let ((section (assq 'section
(org-element-contents headline
))))
1837 (assq 'table
(and section
(org-element-contents section
))))))
1838 (format "\n<text:list-item>\n%s\n%s"
1840 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1842 (concat extra-targets anchored-title
))
1844 (if headline-has-table-p
1845 "</text:list-header>"
1846 "</text:list-item>")))
1847 (and (org-export-last-sibling-p headline info
)
1849 ;; Case 3. Standard headline. Export it as a section.
1853 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1854 (format "Heading_20_%s%s"
1855 level
(if numbered
"" "_unnumbered"))
1857 (if numbered
"false" "true")
1858 (concat extra-targets anchored-title
))
1861 (defun org-odt-format-headline-default-function
1862 (todo todo-type priority text tags
)
1863 "Default format function for a headline.
1864 See `org-odt-format-headline-function' for details."
1868 (let ((style (if (eq todo-type
'done
) "OrgDone" "OrgTodo")))
1869 (format "<text:span text:style-name=\"%s\">%s</text:span> " style todo
)))
1871 (let* ((style (format "OrgPriority-%c" priority
))
1872 (priority (format "[#%c]" priority
)))
1873 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1881 (format "<text:span text:style-name=\"%s\">[%s]</text:span>"
1882 "OrgTags" (mapconcat
1885 "<text:span text:style-name=\"%s\">%s</text:span>"
1886 "OrgTag" tag
)) tags
" : "))))))
1889 ;;;; Horizontal Rule
1891 (defun org-odt-horizontal-rule (_horizontal-rule _contents _info
)
1892 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1893 CONTENTS is nil. INFO is a plist holding contextual information."
1894 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1895 "Horizontal_20_Line" ""))
1898 ;;;; Inline Babel Call
1900 ;; Inline Babel Calls are ignored.
1903 ;;;; Inline Src Block
1905 (defun org-odt--find-verb-separator (s)
1906 "Return a character not used in string S.
1907 This is used to choose a separator for constructs like \\verb."
1908 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1909 (cl-loop for c across ll
1910 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
1911 return
(char-to-string c
))))
1913 (defun org-odt-inline-src-block (_inline-src-block _contents _info
)
1914 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1915 CONTENTS holds the contents of the item. INFO is a plist holding
1916 contextual information."
1922 (defun org-odt-inlinetask (inlinetask contents info
)
1923 "Transcode an INLINETASK element from Org to ODT.
1924 CONTENTS holds the contents of the block. INFO is a plist
1925 holding contextual information."
1927 (and (plist-get info
:with-todo-keywords
)
1928 (let ((todo (org-element-property :todo-keyword inlinetask
)))
1929 (and todo
(org-export-data todo info
)))))
1930 (todo-type (and todo
(org-element-property :todo-type inlinetask
)))
1931 (priority (and (plist-get info
:with-priority
)
1932 (org-element-property :priority inlinetask
)))
1933 (text (org-export-data (org-element-property :title inlinetask
) info
))
1934 (tags (and (plist-get info
:with-tags
)
1935 (org-export-get-tags inlinetask info
))))
1936 (funcall (plist-get info
:odt-format-inlinetask-function
)
1937 todo todo-type priority text tags contents
)))
1939 (defun org-odt-format-inlinetask-default-function
1940 (todo todo-type priority name tags contents
)
1941 "Default format function for a inlinetasks.
1942 See `org-odt-format-inlinetask-function' for details."
1943 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1947 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1948 "OrgInlineTaskHeading"
1949 (org-odt-format-headline-default-function
1950 todo todo-type priority name tags
))
1952 nil nil
"OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
1956 (defun org-odt-italic (_italic contents _info
)
1957 "Transcode ITALIC from Org to ODT.
1958 CONTENTS is the text with italic markup. INFO is a plist holding
1959 contextual information."
1960 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1961 "Emphasis" contents
))
1966 (defun org-odt-item (item contents info
)
1967 "Transcode an ITEM element from Org to ODT.
1968 CONTENTS holds the contents of the item. INFO is a plist holding
1969 contextual information."
1970 (let* ((plain-list (org-export-get-parent item
))
1971 (type (org-element-property :type plain-list
)))
1972 (unless (memq type
'(ordered unordered descriptive-1 descriptive-2
))
1973 (error "Unknown list type: %S" type
))
1974 (format "\n<text:list-item>\n%s\n%s"
1976 (if (org-element-map item
'table
#'identity info
'first-match
)
1977 "</text:list-header>"
1978 "</text:list-item>"))))
1982 (defun org-odt-keyword (keyword _contents info
)
1983 "Transcode a KEYWORD element from Org to ODT.
1984 CONTENTS is nil. INFO is a plist holding contextual
1986 (let ((key (org-element-property :key keyword
))
1987 (value (org-element-property :value keyword
)))
1989 ((string= key
"ODT") value
)
1990 ((string= key
"INDEX")
1993 ((string= key
"TOC")
1994 (let ((case-fold-search t
))
1996 ((string-match-p "\\<headlines\\>" value
)
1997 (let ((depth (or (and (string-match "\\<[0-9]+\\>" value
)
1998 (string-to-number (match-string 0 value
)))
1999 (plist-get info
:headline-levels
)))
2000 (localp (string-match-p "\\<local\\>" value
)))
2001 (org-odt-toc depth info
(and localp keyword
))))
2002 ((string-match-p "tables\\|figures\\|listings" value
)
2007 ;;;; Latex Environment
2010 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2011 ;; (defadvice org-format-latex-as-mathml ; FIXME
2012 ;; (after org-odt-protect-latex-fragment activate)
2013 ;; "Encode LaTeX fragment as XML.
2014 ;; Do this when translation to MathML fails."
2015 ;; (unless (> (length ad-return-value) 0)
2016 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2018 (defun org-odt-latex-environment (latex-environment _contents info
)
2019 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2020 CONTENTS is nil. INFO is a plist holding contextual information."
2021 (let* ((latex-frag (org-remove-indentation
2022 (org-element-property :value latex-environment
))))
2023 (org-odt-do-format-code latex-frag info
)))
2028 ;; (when latex-frag ; FIXME
2029 ;; (setq href (propertize href :title "LaTeX Fragment"
2030 ;; :description latex-frag)))
2032 ;; provide descriptions
2034 (defun org-odt-latex-fragment (latex-fragment _contents _info
)
2035 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2036 CONTENTS is nil. INFO is a plist holding contextual information."
2037 (let ((latex-frag (org-element-property :value latex-fragment
)))
2038 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2039 "OrgCode" (org-odt--encode-plain-text latex-frag t
))))
2044 (defun org-odt-line-break (_line-break _contents _info
)
2045 "Transcode a LINE-BREAK object from Org to ODT.
2046 CONTENTS is nil. INFO is a plist holding contextual information."
2047 "<text:line-break/>")
2052 ;;;; Links :: Label references
2054 (defun org-odt--enumerate (element info
&optional predicate n
)
2055 (when predicate
(cl-assert (funcall predicate element info
)))
2056 (let* ((--numbered-parent-headline-at-<=-n
2057 (lambda (element n info
)
2058 (cl-loop for x in
(org-element-lineage element
)
2059 thereis
(and (eq (org-element-type x
) 'headline
)
2060 (<= (org-export-get-relative-level x info
) n
)
2061 (org-export-numbered-headline-p x info
)
2064 (lambda (element scope info
&optional predicate
)
2066 (org-element-map (or scope
(plist-get info
:parse-tree
))
2067 (org-element-type element
)
2069 (and (or (not predicate
) (funcall predicate el info
))
2073 info
'first-match
))))
2074 (scope (funcall --numbered-parent-headline-at-
<=-n
2076 (or n
(plist-get info
:odt-display-outline-level
))
2078 (ordinal (funcall --enumerate element scope info predicate
))
2083 (mapconcat 'number-to-string
2084 (org-export-get-headline-number scope info
) "."))
2088 (number-to-string ordinal
))))
2091 (defun org-odt-format-label (element info op
)
2092 "Return a label for ELEMENT.
2094 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2095 element. INFO is a plist used as a communication channel. OP is
2096 either `definition' or `reference', depending on the purpose of
2097 the generated string.
2099 Return value is a string if OP is set to `reference' or a cons
2100 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2101 SHORT-CAPTION are strings."
2102 (cl-assert (memq (org-element-type element
) '(link table src-block paragraph
)))
2103 (let* ((element-or-parent
2104 (cl-case (org-element-type element
)
2105 (link (org-export-get-parent-element element
))
2107 ;; Get label and caption.
2108 (label (and (or (org-element-property :name element
)
2109 (org-element-property :name element-or-parent
))
2110 (org-export-get-reference element-or-parent info
)))
2111 (caption (let ((c (org-export-get-caption element-or-parent
)))
2112 (and c
(org-export-data c info
))))
2113 ;; FIXME: We don't use short-caption for now
2114 (short-caption nil
))
2115 (when (or label caption
)
2116 (let* ((default-category
2117 (cl-case (org-element-type element
)
2119 (src-block "__Listing__")
2122 ((org-odt--enumerable-latex-image-p element info
)
2124 ((org-odt--enumerable-image-p element info
)
2126 ((org-odt--enumerable-formula-p element info
)
2128 (t (error "Don't know how to format label for link: %S"
2130 (t (error "Don't know how to format label for element type: %s"
2131 (org-element-type element
)))))
2133 (cl-assert default-category
)
2135 ((`(,counter
,label-style
,category
,predicate
)
2136 (assoc-default default-category org-odt-category-map-alist
)))
2137 ;; Compute sequence number of the element.
2138 (setq seqno
(org-odt--enumerate element info predicate
))
2139 ;; Localize category string.
2140 (setq category
(org-export-translate category
:utf-8 info
))
2142 ;; Case 1: Handle Label definition.
2146 ;; Sneak in a bookmark. The bookmark is used when the
2147 ;; labeled element is referenced with a link that
2148 ;; provides its own description.
2149 (format "\n<text:bookmark text:name=\"%s\"/>" label
)
2150 ;; Label definition: Typically formatted as below:
2151 ;; CATEGORY SEQ-NO: LONG CAPTION
2152 ;; with translation for correct punctuation.
2154 (org-export-translate
2155 (cadr (assoc-string label-style org-odt-label-styles t
))
2159 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2160 label counter counter seqno
))
2161 (?c .
,(or caption
"")))))
2163 ;; Case 2: Handle Label reference.
2165 (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t
)))
2168 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2171 (format-spec fmt2
`((?e .
,category
) (?n .
,seqno
))))))
2172 (t (error "Unknown %S on label" op
))))))))
2175 ;;;; Links :: Inline Images
2177 (defun org-odt--copy-image-file (path)
2178 "Returns the internal name of the file"
2179 (let* ((image-type (file-name-extension path
))
2180 (media-type (format "image/%s" image-type
))
2181 (target-dir "Images/")
2183 (format "%s%04d.%s" target-dir
2184 (cl-incf org-odt-embedded-images-count
) image-type
)))
2185 (message "Embedding %s as %s..."
2186 (substring-no-properties path
) target-file
)
2188 (when (= 1 org-odt-embedded-images-count
)
2189 (make-directory (concat org-odt-zip-dir target-dir
))
2190 (org-odt-create-manifest-file-entry "" target-dir
))
2192 (copy-file path
(concat org-odt-zip-dir target-file
) 'overwrite
)
2193 (org-odt-create-manifest-file-entry media-type target-file
)
2196 (defun org-odt--image-size
2197 (file info
&optional user-width user-height scale dpi embed-as
)
2198 (let* ((--pixels-to-cms
2199 (function (lambda (pixels dpi
)
2200 (let ((cms-per-inch 2.54)
2201 (inches (/ pixels dpi
)))
2202 (* cms-per-inch inches
)))))
2205 (lambda (size-in-pixels dpi
)
2207 (cons (funcall --pixels-to-cms
(car size-in-pixels
) dpi
)
2208 (funcall --pixels-to-cms
(cdr size-in-pixels
) dpi
))))))
2209 (dpi (or dpi
(plist-get info
:odt-pixels-per-inch
)))
2210 (anchor-type (or embed-as
"paragraph"))
2211 (user-width (and (not scale
) user-width
))
2212 (user-height (and (not scale
) user-height
))
2215 (not (and user-height user-width
))
2218 (and (executable-find "identify")
2219 (let ((size-in-pixels
2220 (let ((dim (shell-command-to-string
2221 (format "identify -format \"%%w:%%h\" \"%s\""
2223 (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim
)
2224 (cons (string-to-number (match-string 1 dim
))
2225 (string-to-number (match-string 2 dim
)))))))
2226 (funcall --size-in-cms size-in-pixels dpi
)))
2228 (let ((size-in-pixels
2229 (ignore-errors ; Emacs could be in batch mode
2231 (image-size (create-image file
) 'pixels
))))
2232 (funcall --size-in-cms size-in-pixels dpi
))
2233 ;; Use hard-coded values.
2234 (cdr (assoc-string anchor-type
2235 org-odt-default-image-sizes-alist
))
2237 (error "Cannot determine image size, aborting"))))
2238 (width (car size
)) (height (cdr size
)))
2241 (setq width
(* width scale
) height
(* height scale
)))
2242 ((and user-height user-width
)
2243 (setq width user-width height user-height
))
2245 (setq width
(* user-height
(/ width height
)) height user-height
))
2247 (setq height
(* user-width
(/ height width
)) width user-width
))
2249 ;; ensure that an embedded image fits comfortably within a page
2250 (let ((max-width (car org-odt-max-image-size
))
2251 (max-height (cdr org-odt-max-image-size
)))
2252 (when (or (> width max-width
) (> height max-height
))
2253 (let* ((scale1 (/ max-width width
))
2254 (scale2 (/ max-height height
))
2255 (scale (min scale1 scale2
)))
2256 (setq width
(* scale width
) height
(* scale height
)))))
2257 (cons width height
)))
2259 (defun org-odt-link--inline-image (element info
)
2260 "Return ODT code for an inline image.
2261 LINK is the link pointing to the inline image. INFO is a plist
2262 used as a communication channel."
2263 (cl-assert (eq (org-element-type element
) 'link
))
2264 (let* ((src (let* ((type (org-element-property :type element
))
2265 (raw-path (org-element-property :path element
)))
2266 (cond ((member type
'("http" "https"))
2267 (concat type
":" raw-path
))
2268 ((file-name-absolute-p raw-path
)
2269 (expand-file-name raw-path
))
2271 (src-expanded (if (file-name-absolute-p src
) src
2272 (expand-file-name src
(file-name-directory
2273 (plist-get info
:input-file
)))))
2275 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2276 (org-odt--copy-image-file src-expanded
)))
2277 ;; Extract attributes from #+ATTR_ODT line.
2278 (attr-from (cl-case (org-element-type element
)
2279 (link (org-export-get-parent-element element
))
2281 ;; Convert attributes to a plist.
2282 (attr-plist (org-export-read-attribute :attr_odt attr-from
))
2283 ;; Handle `:anchor', `:style' and `:attributes' properties.
2285 (car (assoc-string (plist-get attr-plist
:anchor
)
2286 '(("as-char") ("paragraph") ("page")) t
)))
2288 (and user-frame-anchor
(plist-get attr-plist
:style
)))
2290 (and user-frame-anchor
(plist-get attr-plist
:attributes
)))
2292 (list user-frame-style user-frame-attrs user-frame-anchor
))
2293 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2295 ;; Handle `:width', `:height' and `:scale' properties. Read
2296 ;; them as numbers since we need them for computations.
2297 (size (org-odt--image-size
2299 (let ((width (plist-get attr-plist
:width
)))
2300 (and width
(read width
)))
2301 (let ((length (plist-get attr-plist
:length
)))
2302 (and length
(read length
)))
2303 (let ((scale (plist-get attr-plist
:scale
)))
2304 (and scale
(read scale
)))
2308 (width (car size
)) (height (cdr size
))
2309 (standalone-link-p (org-odt--standalone-link-p element info
))
2310 (embed-as (if standalone-link-p
"paragraph" "as-char"))
2311 (captions (org-odt-format-label element info
'definition
))
2312 (caption (car captions
))
2313 (entity (concat (and caption
"Captioned") embed-as
"Image"))
2314 ;; Check if this link was created by LaTeX-to-PNG converter.
2315 (replaces (org-element-property
2316 :replaces
(if (not standalone-link-p
) element
2317 (org-export-get-parent-element element
))))
2318 ;; If yes, note down the type of the element - LaTeX Fragment
2319 ;; or LaTeX environment. It will go in to frame title.
2320 (title (and replaces
(capitalize
2321 (symbol-name (org-element-type replaces
)))))
2323 ;; If yes, note down its contents. It will go in to frame
2324 ;; description. This quite useful for debugging.
2325 (desc (and replaces
(org-element-property :value replaces
))))
2326 (org-odt--render-image/formula entity href width height
2327 captions user-frame-params title desc
)))
2330 ;;;; Links :: Math formula
2332 (defun org-odt-link--inline-formula (element info
)
2333 (let* ((src (let ((raw-path (org-element-property :path element
)))
2335 ((file-name-absolute-p raw-path
)
2336 (expand-file-name raw-path
))
2338 (src-expanded (if (file-name-absolute-p src
) src
2339 (expand-file-name src
(file-name-directory
2340 (plist-get info
:input-file
)))))
2343 "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
2344 " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
2345 (file-name-directory (org-odt--copy-formula-file src-expanded
))))
2346 (standalone-link-p (org-odt--standalone-link-p element info
))
2347 (embed-as (if standalone-link-p
'paragraph
'character
))
2348 (captions (org-odt-format-label element info
'definition
))
2349 ;; Check if this link was created by LaTeX-to-MathML
2351 (replaces (org-element-property
2352 :replaces
(if (not standalone-link-p
) element
2353 (org-export-get-parent-element element
))))
2354 ;; If yes, note down the type of the element - LaTeX Fragment
2355 ;; or LaTeX environment. It will go in to frame title.
2356 (title (and replaces
(capitalize
2357 (symbol-name (org-element-type replaces
)))))
2359 ;; If yes, note down its contents. It will go in to frame
2360 ;; description. This quite useful for debugging.
2361 (desc (and replaces
(org-element-property :value replaces
)))
2364 ((eq embed-as
'character
)
2365 (org-odt--render-image/formula
"InlineFormula" href width height
2366 nil nil title desc
))
2368 (let* ((equation (org-odt--render-image/formula
2369 "CaptionedDisplayFormula" href width height
2370 captions nil title desc
))
2372 (let* ((org-odt-category-map-alist
2373 '(("__MathFormula__" "Text" "math-label" "Equation"
2374 org-odt--enumerable-formula-p
))))
2375 (car (org-odt-format-label element info
'definition
)))))
2376 (concat equation
"<text:tab/>" label
))))))
2378 (defun org-odt--copy-formula-file (src-file)
2379 "Returns the internal name of the file"
2380 (let* ((target-dir (format "Formula-%04d/"
2381 (cl-incf org-odt-embedded-formulas-count
)))
2382 (target-file (concat target-dir
"content.xml")))
2383 ;; Create a directory for holding formula file. Also enter it in
2385 (make-directory (concat org-odt-zip-dir target-dir
))
2386 (org-odt-create-manifest-file-entry
2387 "application/vnd.oasis.opendocument.formula" target-dir
"1.2")
2388 ;; Copy over the formula file from user directory to zip
2390 (message "Embedding %s as %s..." src-file target-file
)
2391 (let ((ext (file-name-extension src-file
)))
2394 ((member ext
'("mathml" "mml"))
2395 (copy-file src-file
(concat org-odt-zip-dir target-file
) 'overwrite
))
2396 ;; Case 2: OpenDocument formula.
2397 ((string= ext
"odf")
2398 (org-odt--zip-extract src-file
"content.xml"
2399 (concat org-odt-zip-dir target-dir
)))
2400 (t (error "%s is not a formula file" src-file
))))
2401 ;; Enter the formula file in to manifest.
2402 (org-odt-create-manifest-file-entry "text/xml" target-file
)
2407 (defun org-odt--render-image/formula
(cfg-key href width height
&optional
2408 captions user-frame-params
2409 &rest title-and-desc
)
2410 (let* ((frame-cfg-alist
2411 ;; Each element of this alist is of the form (CFG-HANDLE
2412 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2414 ;; CFG-HANDLE is the key to the alist.
2416 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2417 ;; frame params for INNER-FRAME and OUTER-FRAME
2418 ;; respectively. See below.
2420 ;; Configurations that are meant to be applied to
2421 ;; non-captioned image/formula specifies no
2422 ;; OUTER-FRAME-PARAMS.
2426 ;; INNER-FRAME :: Frame that directly surrounds an
2429 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2430 ;; frame also contains the caption, if any.
2432 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2433 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2434 ;; that these are the last three arguments
2435 ;; to `org-odt--frame'.
2437 ;; Note that an un-captioned image/formula requires just an
2438 ;; INNER-FRAME, while a captioned image/formula requires
2439 ;; both an INNER and an OUTER-FRAME.
2440 '(("As-CharImage" ("OrgInlineImage" nil
"as-char"))
2441 ("ParagraphImage" ("OrgDisplayImage" nil
"paragraph"))
2442 ("PageImage" ("OrgPageImage" nil
"page"))
2443 ("CaptionedAs-CharImage"
2444 ("OrgCaptionedImage"
2445 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2446 ("OrgInlineImage" nil
"as-char"))
2447 ("CaptionedParagraphImage"
2448 ("OrgCaptionedImage"
2449 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2450 ("OrgImageCaptionFrame" nil
"paragraph"))
2451 ("CaptionedPageImage"
2452 ("OrgCaptionedImage"
2453 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2454 ("OrgPageImageCaptionFrame" nil
"page"))
2455 ("InlineFormula" ("OrgInlineFormula" nil
"as-char"))
2456 ("DisplayFormula" ("OrgDisplayFormula" nil
"as-char"))
2457 ("CaptionedDisplayFormula"
2458 ("OrgCaptionedFormula" nil
"paragraph")
2459 ("OrgFormulaCaptionFrame" nil
"paragraph"))))
2460 (caption (car captions
)) (short-caption (cdr captions
))
2461 ;; Retrieve inner and outer frame params, from configuration.
2462 (frame-cfg (assoc-string cfg-key frame-cfg-alist t
))
2463 (inner (nth 1 frame-cfg
))
2464 (outer (nth 2 frame-cfg
))
2465 ;; User-specified frame params (from #+ATTR_ODT spec)
2466 (user user-frame-params
)
2467 (--merge-frame-params (function
2468 (lambda (default user
)
2469 "Merge default and user frame params."
2470 (if (not user
) default
2471 (cl-assert (= (length default
) 3))
2472 (cl-assert (= (length user
) 3))
2473 (cl-loop for u in user
2475 collect
(or u d
)))))))
2477 ;; Case 1: Image/Formula has no caption.
2478 ;; There is only one frame, one that surrounds the image
2481 ;; Merge user frame params with that from configuration.
2482 (setq inner
(funcall --merge-frame-params inner user
))
2483 (apply 'org-odt--frame href width height
2484 (append inner title-and-desc
)))
2485 ;; Case 2: Image/Formula is captioned or labeled.
2486 ;; There are two frames: The inner one surrounds the
2487 ;; image or formula. The outer one contains the
2488 ;; caption/sequence number.
2490 ;; Merge user frame params with outer frame params.
2491 (setq outer
(funcall --merge-frame-params outer user
))
2492 ;; Short caption, if specified, goes as part of inner frame.
2493 (setq inner
(let ((frame-params (copy-sequence inner
)))
2494 (setcar (cdr frame-params
)
2498 (format " draw:name=\"%s\" " short-caption
))))
2500 (apply 'org-odt--textbox
2501 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2504 (apply 'org-odt--frame href width height
2505 (append inner title-and-desc
))
2507 width height outer
)))))
2509 (defun org-odt--enumerable-p (element _info
)
2510 ;; Element should have a caption or label.
2511 (or (org-element-property :caption element
)
2512 (org-element-property :name element
)))
2514 (defun org-odt--enumerable-image-p (element info
)
2515 (org-odt--standalone-link-p
2517 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2518 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2521 (and (not (org-element-property :replaces p
))
2522 (or (org-element-property :caption p
)
2523 (org-element-property :name p
))))
2524 ;; Link should point to an image file.
2526 (cl-assert (eq (org-element-type l
) 'link
))
2527 (org-export-inline-image-p l
(plist-get info
:odt-inline-image-rules
)))))
2529 (defun org-odt--enumerable-latex-image-p (element info
)
2530 (org-odt--standalone-link-p
2532 ;; Paragraph should have a caption or label. It SHOULD also be a
2533 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2536 (and (org-element-property :replaces p
)
2537 (or (org-element-property :caption p
)
2538 (org-element-property :name p
))))
2539 ;; Link should point to an image file.
2541 (cl-assert (eq (org-element-type l
) 'link
))
2542 (org-export-inline-image-p l
(plist-get info
:odt-inline-image-rules
)))))
2544 (defun org-odt--enumerable-formula-p (element info
)
2545 (org-odt--standalone-link-p
2547 ;; Paragraph should have a caption or label.
2549 (or (org-element-property :caption p
)
2550 (org-element-property :name p
)))
2551 ;; Link should point to a MathML or ODF file.
2553 (cl-assert (eq (org-element-type l
) 'link
))
2554 (org-export-inline-image-p l
(plist-get info
:odt-inline-formula-rules
)))))
2556 (defun org-odt--standalone-link-p (element _info
&optional
2559 "Test if ELEMENT is a standalone link for the purpose ODT export.
2560 INFO is a plist holding contextual information.
2562 Return non-nil, if ELEMENT is of type paragraph satisfying
2563 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2564 is a link that satisfies LINK-PREDICATE.
2566 Return non-nil, if ELEMENT is of type link satisfying
2567 LINK-PREDICATE and its containing paragraph satisfies
2568 PARAGRAPH-PREDICATE in addition to having no other content save for
2569 leading and trailing whitespaces.
2571 Return nil, otherwise."
2572 (let ((p (cl-case (org-element-type element
)
2574 (link (and (or (not link-predicate
)
2575 (funcall link-predicate element
))
2576 (org-export-get-parent element
)))
2578 (when (and p
(eq (org-element-type p
) 'paragraph
))
2579 (when (or (not paragraph-predicate
)
2580 (funcall paragraph-predicate p
))
2581 (let ((contents (org-element-contents p
)))
2582 (cl-loop for x in contents
2583 with inline-image-count
= 0
2584 always
(cl-case (org-element-type x
)
2586 (not (org-string-nw-p x
)))
2588 (and (or (not link-predicate
)
2589 (funcall link-predicate x
))
2590 (= (cl-incf inline-image-count
) 1)))
2593 (defun org-odt-link--infer-description (destination info
)
2594 ;; DESTINATION is a headline or an element (like paragraph,
2595 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2597 ;; Note that labels that are attached to captioned entities - inline
2598 ;; images, math formulae and tables - get resolved as part of
2599 ;; `org-odt-format-label' and `org-odt--enumerate'.
2601 ;; Create a cross-reference to DESTINATION but make best-efforts to
2602 ;; create a *meaningful* description. Check item numbers, section
2603 ;; number and section title in that order.
2605 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2606 ;; FIXME: Handle footnote-definition footnote-reference?
2607 (let* ((genealogy (org-element-lineage destination
))
2608 (data (reverse genealogy
))
2609 (label (let ((type (org-element-type destination
)))
2610 (if (memq type
'(headline target
))
2611 (org-export-get-reference destination info
)
2612 (error "FIXME: Unable to resolve %S" destination
)))))
2614 (let* ( ;; Locate top-level list.
2616 (cl-loop for x on data
2617 when
(eq (org-element-type (car x
)) 'plain-list
)
2619 ;; Get list item nos.
2621 (cl-loop for
(plain-list item . rest
) on top-level-list by
#'cddr
2622 until
(not (eq (org-element-type plain-list
) 'plain-list
))
2623 collect
(when (eq (org-element-property :type
2626 (1+ (length (org-export-get-previous-element
2628 ;; Locate top-most listified headline.
2629 (listified-headlines
2630 (cl-loop for x on data
2631 when
(and (eq (org-element-type (car x
)) 'headline
)
2632 (org-export-low-level-p (car x
) info
))
2634 ;; Get listified headline numbers.
2635 (listified-headline-nos
2636 (cl-loop for el in listified-headlines
2637 when
(eq (org-element-type el
) 'headline
)
2638 collect
(when (org-export-numbered-headline-p el info
)
2639 (1+ (length (org-export-get-previous-element
2641 ;; Combine item numbers from both the listified headlines and
2642 ;; regular list items.
2644 ;; Case 1: Check if all the parents of list item are numbered.
2645 ;; If yes, link to the item proper.
2646 (let ((item-numbers (append listified-headline-nos item-numbers
)))
2647 (when (and item-numbers
(not (memq nil item-numbers
)))
2648 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2650 (mapconcat (lambda (n) (if (not n
) " "
2651 (concat (number-to-string n
) ".")))
2652 item-numbers
"")))))
2653 ;; Case 2: Locate a regular and numbered headline in the
2654 ;; hierarchy. Display its section number.
2657 ;; Test if destination is a numbered headline.
2658 (org-export-numbered-headline-p destination info
)
2659 (cl-loop for el in
(cons destination genealogy
)
2660 when
(and (eq (org-element-type el
) 'headline
)
2661 (not (org-export-low-level-p el info
))
2662 (org-export-numbered-headline-p el info
))
2666 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2668 (mapconcat 'number-to-string
(org-export-get-headline-number
2669 headline info
) "."))))
2670 ;; Case 4: Locate a regular headline in the hierarchy. Display
2672 (let ((headline (cl-loop for el in
(cons destination genealogy
)
2673 when
(and (eq (org-element-type el
) 'headline
)
2674 (not (org-export-low-level-p el info
)))
2678 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2680 (let ((title (org-element-property :title headline
)))
2681 (org-export-data title info
)))))
2684 (defun org-odt-link (link desc info
)
2685 "Transcode a LINK object from Org to ODT.
2687 DESC is the description part of the link, or the empty string.
2688 INFO is a plist holding contextual information. See
2690 (let* ((type (org-element-property :type link
))
2691 (raw-path (org-element-property :path link
))
2692 ;; Ensure DESC really exists, or set it to nil.
2693 (desc (and (not (string= desc
"")) desc
))
2694 (imagep (org-export-inline-image-p
2695 link
(plist-get info
:odt-inline-image-rules
)))
2697 ((member type
'("http" "https" "ftp" "mailto"))
2698 (concat type
":" raw-path
))
2699 ((string= type
"file") (org-export-file-uri raw-path
))
2701 ;; Convert & to & for correct XML representation
2702 (path (replace-regexp-in-string "&" "&" path
)))
2704 ;; Link type is handled by a special function.
2705 ((org-export-custom-protocol-maybe link desc
'odt
))
2707 ((and (not desc
) imagep
) (org-odt-link--inline-image link info
))
2710 (org-export-inline-image-p
2711 link
(plist-get info
:odt-inline-formula-rules
)))
2712 (org-odt-link--inline-formula link info
))
2713 ;; Radio target: Transcode target's contents and use them as
2714 ;; link's description.
2715 ((string= type
"radio")
2716 (let ((destination (org-export-resolve-radio-link link info
)))
2717 (if (not destination
) desc
2719 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2720 (org-export-get-reference destination info
)
2722 ;; Links pointing to a headline: Find destination and build
2723 ;; appropriate referencing command.
2724 ((member type
'("custom-id" "fuzzy" "id"))
2725 (let ((destination (if (string= type
"fuzzy")
2726 (org-export-resolve-fuzzy-link link info
)
2727 (org-export-resolve-id-link link info
))))
2728 (cl-case (org-element-type destination
)
2729 ;; Fuzzy link points to a headline. If there's
2730 ;; a description, create a hyperlink. Otherwise, try to
2731 ;; provide a meaningful description.
2733 (if (not desc
) (org-odt-link--infer-description destination info
)
2735 (or (and (string= type
"custom-id")
2736 (org-element-property :CUSTOM_ID destination
))
2737 (org-export-get-reference destination info
))))
2739 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2741 ;; Fuzzy link points to a target. If there's a description,
2742 ;; create a hyperlink. Otherwise, try to provide
2743 ;; a meaningful description.
2745 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2746 (org-export-get-reference destination info
)
2747 (or desc
(org-export-get-ordinal destination info
))))
2748 ;; Fuzzy link points to some element (e.g., an inline image,
2749 ;; a math formula or a table).
2751 (let ((label-reference
2753 (org-odt-format-label destination info
'reference
))))
2755 ((not label-reference
)
2756 (org-odt-link--infer-description destination info
))
2757 ;; LINK has no description. Create
2758 ;; a cross-reference showing entity's sequence
2760 ((not desc
) label-reference
)
2761 ;; LINK has description. Insert a hyperlink with
2762 ;; user-provided description.
2765 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2766 (org-export-get-reference destination info
)
2768 ;; Coderef: replace link with the reference name or the
2769 ;; equivalent line number.
2770 ((string= type
"coderef")
2771 (let* ((line-no (format "%d" (org-export-resolve-coderef path info
)))
2772 (href (concat "coderef-" path
)))
2774 (org-export-get-coderef-format path desc
)
2776 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2778 ;; External link with a description part.
2780 (let ((link-contents (org-element-contents link
)))
2781 ;; Check if description is a link to an inline image.
2782 (if (and (not (cdr link-contents
))
2783 (let ((desc-element (car link-contents
)))
2784 (and (eq (org-element-type desc-element
) 'link
)
2785 (org-export-inline-image-p
2787 (plist-get info
:odt-inline-image-rules
)))))
2788 ;; Format link as a clickable image.
2789 (format "\n<draw:a xlink:type=\"simple\" xlink:href=\"%s\">\n%s\n</draw:a>"
2791 ;; Otherwise, format it as a regular link.
2792 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2794 ;; External link without a description part.
2796 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2798 ;; No path, only description. Try to do something useful.
2799 (t (format "<text:span text:style-name=\"%s\">%s</text:span>"
2800 "Emphasis" desc
)))))
2805 (defun org-odt-node-property (node-property _contents _info
)
2806 "Transcode a NODE-PROPERTY element from Org to ODT.
2807 CONTENTS is nil. INFO is a plist holding contextual
2809 (org-odt--encode-plain-text
2811 (org-element-property :key node-property
)
2812 (let ((value (org-element-property :value node-property
)))
2813 (if value
(concat " " value
) "")))))
2817 (defun org-odt--paragraph-style (paragraph)
2818 "Return style of PARAGRAPH.
2819 Style is a symbol among `quoted', `centered' and nil."
2820 (let ((up paragraph
))
2821 (while (and (setq up
(org-element-property :parent up
))
2822 (not (memq (org-element-type up
)
2823 '(center-block quote-block section
)))))
2824 (cl-case (org-element-type up
)
2825 (center-block 'centered
)
2826 (quote-block 'quoted
))))
2828 (defun org-odt--format-paragraph (paragraph contents info default center quote
)
2829 "Format paragraph according to given styles.
2830 PARAGRAPH is a paragraph type element. CONTENTS is the
2831 transcoded contents of that paragraph, as a string. INFO is
2832 a plist used as a communication channel. DEFAULT, CENTER and
2833 QUOTE are, respectively, style to use when paragraph belongs to
2834 no special environment, a center block, or a quote block."
2835 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2836 (cl-case (org-odt--paragraph-style paragraph
)
2839 (otherwise default
))
2840 ;; If PARAGRAPH is a leading paragraph in an item that has
2841 ;; a checkbox, splice checkbox and paragraph contents
2843 (concat (let ((parent (org-element-property :parent paragraph
)))
2844 (and (eq (org-element-type parent
) 'item
)
2845 (not (org-export-get-previous-element paragraph info
))
2846 (org-odt--checkbox parent
)))
2849 (defun org-odt-paragraph (paragraph contents info
)
2850 "Transcode a PARAGRAPH element from Org to ODT.
2851 CONTENTS is the contents of the paragraph, as a string. INFO is
2852 the plist used as a communication channel."
2853 (org-odt--format-paragraph
2854 paragraph contents info
2855 (or (org-element-property :style paragraph
) "Text_20_body")
2862 (defun org-odt-plain-list (plain-list contents _info
)
2863 "Transcode a PLAIN-LIST element from Org to ODT.
2864 CONTENTS is the contents of the list. INFO is a plist holding
2865 contextual information."
2866 (format "\n<text:list text:style-name=\"%s\" %s>\n%s</text:list>"
2867 ;; Choose style based on list type.
2868 (cl-case (org-element-property :type plain-list
)
2869 (ordered "OrgNumberedList")
2870 (unordered "OrgBulletedList")
2871 (descriptive-1 "OrgDescriptionList")
2872 (descriptive-2 "OrgDescriptionList"))
2873 ;; If top-level list, re-start numbering. Otherwise,
2874 ;; continue numbering.
2875 (format "text:continue-numbering=\"%s\""
2876 (let* ((parent (org-export-get-parent plain-list
)))
2877 (if (and parent
(eq (org-element-type parent
) 'item
))
2883 (defun org-odt--encode-tabs-and-spaces (line)
2884 (replace-regexp-in-string
2885 "\\(\t\\| \\{2,\\}\\)"
2887 (if (string= s
"\t") "<text:tab/>"
2888 (format " <text:s text:c=\"%d\"/>" (1- (length s
)))))
2891 (defun org-odt--encode-plain-text (text &optional no-whitespace-filling
)
2892 (dolist (pair '(("&" .
"&") ("<" .
"<") (">" .
">")))
2893 (setq text
(replace-regexp-in-string (car pair
) (cdr pair
) text t t
)))
2894 (if no-whitespace-filling text
2895 (org-odt--encode-tabs-and-spaces text
)))
2897 (defun org-odt-plain-text (text info
)
2898 "Transcode a TEXT string from Org to ODT.
2899 TEXT is the string to transcode. INFO is a plist holding
2900 contextual information."
2901 (let ((output text
))
2902 ;; Protect &, < and >.
2903 (setq output
(org-odt--encode-plain-text output t
))
2904 ;; Handle smart quotes. Be sure to provide original string since
2905 ;; OUTPUT may have been modified.
2906 (when (plist-get info
:with-smart-quotes
)
2907 (setq output
(org-export-activate-smart-quotes output
:utf-8 info text
)))
2908 ;; Convert special strings.
2909 (when (plist-get info
:with-special-strings
)
2910 (dolist (pair org-odt-special-string-regexps
)
2912 (replace-regexp-in-string (car pair
) (cdr pair
) output t nil
))))
2913 ;; Handle break preservation if required.
2914 (when (plist-get info
:preserve-breaks
)
2915 (setq output
(replace-regexp-in-string
2916 "\\(\\\\\\\\\\)?[ \t]*\n" "<text:line-break/>" output t
)))
2923 (defun org-odt-planning (planning contents info
)
2924 "Transcode a PLANNING element from Org to ODT.
2925 CONTENTS is nil. INFO is a plist used as a communication
2927 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2930 (let ((closed (org-element-property :closed planning
)))
2933 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2934 "OrgClosedKeyword" org-closed-string
)
2935 (org-odt-timestamp closed contents info
))))
2936 (let ((deadline (org-element-property :deadline planning
)))
2939 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2940 "OrgDeadlineKeyword" org-deadline-string
)
2941 (org-odt-timestamp deadline contents info
))))
2942 (let ((scheduled (org-element-property :scheduled planning
)))
2945 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2946 "OrgScheduledKeyword" org-deadline-string
)
2947 (org-odt-timestamp scheduled contents info
)))))))
2950 ;;;; Property Drawer
2952 (defun org-odt-property-drawer (_property-drawer contents _info
)
2953 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2954 CONTENTS holds the contents of the drawer. INFO is a plist
2955 holding contextual information."
2956 (and (org-string-nw-p contents
)
2957 (format "<text:p text:style-name=\"OrgFixedWidthBlock\">%s</text:p>"
2963 (defun org-odt-quote-block (_quote-block contents _info
)
2964 "Transcode a QUOTE-BLOCK element from Org to ODT.
2965 CONTENTS holds the contents of the block. INFO is a plist
2966 holding contextual information."
2972 (defun org-odt-format-section (text style
&optional name
)
2973 (let ((default-name (car (org-odt-add-automatic-style "Section"))))
2974 (format "\n<text:section text:style-name=\"%s\" %s>\n%s\n</text:section>"
2976 (format "text:name=\"%s\"" (or name default-name
))
2980 (defun org-odt-section (_section contents _info
) ; FIXME
2981 "Transcode a SECTION element from Org to ODT.
2982 CONTENTS holds the contents of the section. INFO is a plist
2983 holding contextual information."
2988 (defun org-odt-radio-target (radio-target text info
)
2989 "Transcode a RADIO-TARGET object from Org to ODT.
2990 TEXT is the text of the target. INFO is a plist holding
2991 contextual information."
2992 (org-odt--target text
(org-export-get-reference radio-target info
)))
2997 (defun org-odt-special-block (special-block contents info
)
2998 "Transcode a SPECIAL-BLOCK element from Org to ODT.
2999 CONTENTS holds the contents of the block. INFO is a plist
3000 holding contextual information."
3001 (let ((type (org-element-property :type special-block
))
3002 (attributes (org-export-read-attribute :attr_odt special-block
)))
3005 ((string= type
"annotation")
3006 (let* ((author (or (plist-get attributes
:author
)
3007 (let ((author (plist-get info
:author
)))
3008 (and author
(org-export-data author info
)))))
3009 (date (or (plist-get attributes
:date
)
3010 ;; FIXME: Is `car' right thing to do below?
3011 (car (plist-get info
:date
)))))
3012 (format "\n<text:p>%s</text:p>"
3013 (format "<office:annotation>\n%s\n</office:annotation>"
3016 (format "<dc:creator>%s</dc:creator>" author
))
3018 (format "<dc:date>%s</dc:date>"
3019 (org-odt--format-timestamp date nil
'iso-date
)))
3022 ((string= type
"textbox")
3023 (let ((width (plist-get attributes
:width
))
3024 (height (plist-get attributes
:height
))
3025 (style (plist-get attributes
:style
))
3026 (extra (plist-get attributes
:extra
))
3027 (anchor (plist-get attributes
:anchor
)))
3028 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3029 "Text_20_body" (org-odt--textbox contents width height
3030 style extra anchor
))))
3036 (defun org-odt-hfy-face-to-css (fn)
3037 "Create custom style for face FN.
3038 When FN is the default face, use its foreground and background
3039 properties to create \"OrgSrcBlock\" paragraph style. Otherwise
3040 use its color attribute to create a character style whose name
3041 is obtained from FN. Currently all attributes of FN other than
3044 The style name for a face FN is derived using the following
3045 operations on the face name in that order - de-dash, CamelCase
3046 and prefix with \"OrgSrc\". For example,
3047 `font-lock-function-name-face' is associated with
3048 \"OrgSrcFontLockFunctionNameFace\"."
3049 (let* ((css-list (hfy-face-to-style fn
))
3050 (style-name (concat "OrgSrc"
3052 'capitalize
(split-string
3053 (hfy-face-or-def-to-name fn
) "-")
3055 (color-val (cdr (assoc "color" css-list
)))
3056 (background-color-val (cdr (assoc "background" css-list
)))
3057 (style (and org-odt-create-custom-styles-for-srcblocks
3060 (format org-odt-src-block-paragraph-format
3061 background-color-val color-val
))
3065 <style:style style:name=\"%s\" style:family=\"text\">
3066 <style:text-properties fo:color=\"%s\"/>
3067 </style:style>" style-name color-val
))))))
3068 (cons style-name style
)))
3070 (defun org-odt-htmlfontify-string (line)
3071 (let* ((hfy-html-quote-regex "\\([<\"&> \t]\\)")
3072 (hfy-html-quote-map '(("\"" """)
3077 ("\t" "<text:tab/>")))
3078 (hfy-face-to-css 'org-odt-hfy-face-to-css
)
3079 (hfy-optimizations-1 (copy-sequence hfy-optimizations
))
3080 (hfy-optimizations (cl-pushnew 'body-text-only hfy-optimizations-1
))
3081 (hfy-begin-span-handler
3082 (lambda (style _text-block _text-id _text-begins-block-p
)
3083 (insert (format "<text:span text:style-name=\"%s\">" style
))))
3084 (hfy-end-span-handler (lambda () (insert "</text:span>"))))
3085 (with-no-warnings (htmlfontify-string line
))))
3087 (defun org-odt-do-format-code
3088 (code info
&optional lang refs retain-labels num-start
)
3089 (let* ((lang (or (assoc-default lang org-src-lang-modes
) lang
))
3090 (lang-mode (and lang
(intern (format "%s-mode" lang
))))
3091 (code-lines (org-split-string code
"\n"))
3092 (code-length (length code-lines
))
3093 (use-htmlfontify-p (and (functionp lang-mode
)
3094 (plist-get info
:odt-fontify-srcblocks
)
3095 (require 'htmlfontify nil t
)
3096 (fboundp 'htmlfontify-string
)))
3097 (code (if (not use-htmlfontify-p
) code
3101 (org-font-lock-ensure)
3103 (fontifier (if use-htmlfontify-p
'org-odt-htmlfontify-string
3104 'org-odt--encode-plain-text
))
3105 (par-style (if use-htmlfontify-p
"OrgSrcBlock"
3106 "OrgFixedWidthBlock"))
3108 (cl-assert (= code-length
(length (org-split-string code
"\n"))))
3110 (org-export-format-code
3112 (lambda (loc line-num ref
)
3114 (concat par-style
(and (= (cl-incf i
) code-length
)
3117 (setq loc
(concat loc
(and ref retain-labels
(format " (%s)" ref
))))
3118 (setq loc
(funcall fontifier loc
))
3120 (setq loc
(org-odt--target loc
(concat "coderef-" ref
))))
3121 (cl-assert par-style
)
3122 (setq loc
(format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3124 (if (not line-num
) loc
3125 (format "\n<text:list-item>%s\n</text:list-item>" loc
)))
3128 ((not num-start
) code
)
3131 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3132 " text:continue-numbering=\"false\"" code
))
3135 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3136 " text:continue-numbering=\"true\"" code
)))))
3138 (defun org-odt-format-code (element info
)
3139 (let* ((lang (org-element-property :language element
))
3140 ;; Extract code and references.
3141 (code-info (org-export-unravel-code element
))
3142 (code (car code-info
))
3143 (refs (cdr code-info
))
3144 ;; Does the src block contain labels?
3145 (retain-labels (org-element-property :retain-labels element
))
3146 ;; Does it have line numbers?
3147 (num-start (org-export-get-loc element info
)))
3148 (org-odt-do-format-code code info lang refs retain-labels num-start
)))
3150 (defun org-odt-src-block (src-block _contents info
)
3151 "Transcode a SRC-BLOCK element from Org to ODT.
3152 CONTENTS holds the contents of the item. INFO is a plist holding
3153 contextual information."
3154 (let* ((attributes (org-export-read-attribute :attr_odt src-block
))
3155 (caption (car (org-odt-format-label src-block info
'definition
))))
3158 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3160 (let ((--src-block (org-odt-format-code src-block info
)))
3161 (if (not (plist-get attributes
:textbox
)) --src-block
3162 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3164 (org-odt--textbox --src-block nil nil nil
)))))))
3167 ;;;; Statistics Cookie
3169 (defun org-odt-statistics-cookie (statistics-cookie _contents _info
)
3170 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3171 CONTENTS is nil. INFO is a plist holding contextual information."
3172 (let ((cookie-value (org-element-property :value statistics-cookie
)))
3173 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3174 "OrgCode" cookie-value
)))
3179 (defun org-odt-strike-through (_strike-through contents _info
)
3180 "Transcode STRIKE-THROUGH from Org to ODT.
3181 CONTENTS is the text with strike-through markup. INFO is a plist
3182 holding contextual information."
3183 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3184 "Strikethrough" contents
))
3189 (defun org-odt-subscript (_subscript contents _info
)
3190 "Transcode a SUBSCRIPT object from Org to ODT.
3191 CONTENTS is the contents of the object. INFO is a plist holding
3192 contextual information."
3193 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3194 "OrgSubscript" contents
))
3199 (defun org-odt-superscript (_superscript contents _info
)
3200 "Transcode a SUPERSCRIPT object from Org to ODT.
3201 CONTENTS is the contents of the object. INFO is a plist holding
3202 contextual information."
3203 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3204 "OrgSuperscript" contents
))
3209 (defun org-odt-table-style-spec (element info
)
3210 (let* ((table (org-export-get-parent-table element
))
3211 (table-attributes (org-export-read-attribute :attr_odt table
))
3212 (table-style (plist-get table-attributes
:style
)))
3213 (assoc table-style
(plist-get info
:odt-table-styles
))))
3215 (defun org-odt-get-table-cell-styles (table-cell info
)
3216 "Retrieve styles applicable to a table cell.
3217 R and C are (zero-based) row and column numbers of the table
3218 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3219 applicable to the current table. It is nil if the table is not
3220 associated with any style attributes.
3222 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3224 When STYLE-SPEC is nil, style the table cell the conventional way
3225 - choose cell borders based on row and column groupings and
3226 choose paragraph alignment based on `org-col-cookies' text
3228 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3230 When STYLE-SPEC is non-nil, ignore the above cookie and return
3231 styles congruent with the ODF-1.2 specification."
3232 (let* ((table-cell-address (org-export-table-cell-address table-cell info
))
3233 (r (car table-cell-address
)) (c (cdr table-cell-address
))
3234 (style-spec (org-odt-table-style-spec table-cell info
))
3235 (table-dimensions (org-export-table-dimensions
3236 (org-export-get-parent-table table-cell
)
3239 ;; LibreOffice - particularly the Writer - honors neither table
3240 ;; templates nor custom table-cell styles. Inorder to retain
3241 ;; inter-operability with LibreOffice, only automatic styles are
3242 ;; used for styling of table-cells. The current implementation is
3243 ;; congruent with ODF-1.2 specification and hence is
3244 ;; future-compatible.
3246 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3247 ;; which recognizes as many as 16 different cell types - is much
3248 ;; richer. Unfortunately it is NOT amenable to easy configuration
3250 (let* ((template-name (nth 1 style-spec
))
3251 (cell-style-selectors (nth 2 style-spec
))
3254 ((and (cdr (assq 'use-first-column-styles cell-style-selectors
))
3255 (= c
0)) "FirstColumn")
3256 ((and (cdr (assq 'use-last-column-styles cell-style-selectors
))
3257 (= (1+ c
) (cdr table-dimensions
)))
3259 ((and (cdr (assq 'use-first-row-styles cell-style-selectors
))
3260 (= r
0)) "FirstRow")
3261 ((and (cdr (assq 'use-last-row-styles cell-style-selectors
))
3262 (= (1+ r
) (car table-dimensions
)))
3264 ((and (cdr (assq 'use-banding-rows-styles cell-style-selectors
))
3265 (= (% r
2) 1)) "EvenRow")
3266 ((and (cdr (assq 'use-banding-rows-styles cell-style-selectors
))
3267 (= (% r
2) 0)) "OddRow")
3268 ((and (cdr (assq 'use-banding-columns-styles cell-style-selectors
))
3269 (= (% c
2) 1)) "EvenColumn")
3270 ((and (cdr (assq 'use-banding-columns-styles cell-style-selectors
))
3271 (= (% c
2) 0)) "OddColumn")
3273 (concat template-name cell-type
)))))
3275 (defun org-odt-table-cell (table-cell contents info
)
3276 "Transcode a TABLE-CELL element from Org to ODT.
3277 CONTENTS is nil. INFO is a plist used as a communication
3279 (let* ((table-cell-address (org-export-table-cell-address table-cell info
))
3280 (r (car table-cell-address
))
3281 (c (cdr table-cell-address
))
3282 (horiz-span (or (org-export-table-cell-width table-cell info
) 0))
3283 (table-row (org-export-get-parent table-cell
))
3284 (custom-style-prefix (org-odt-get-table-cell-styles
3288 (and custom-style-prefix
3289 (format "%sTableParagraph" custom-style-prefix
))
3292 ((and (= 1 (org-export-table-row-group table-row info
))
3293 (org-export-table-has-header-p
3294 (org-export-get-parent-table table-row
) info
))
3296 ((let* ((table (org-export-get-parent-table table-cell
))
3297 (table-attrs (org-export-read-attribute :attr_odt table
))
3298 (table-header-columns
3299 (let ((cols (plist-get table-attrs
:header-columns
)))
3300 (and cols
(read cols
)))))
3301 (<= c
(cond ((wholenump table-header-columns
)
3302 (- table-header-columns
1))
3303 (table-header-columns 0)
3306 (t "OrgTableContents"))
3307 (capitalize (symbol-name (org-export-table-cell-alignment
3308 table-cell info
))))))
3311 (and custom-style-prefix
(format "%sTableCell"
3312 custom-style-prefix
))
3315 (when (or (org-export-table-row-starts-rowgroup-p table-row info
)
3317 (when (org-export-table-row-ends-rowgroup-p table-row info
) "B")
3318 (when (and (org-export-table-cell-starts-colgroup-p table-cell info
)
3319 (not (zerop c
)) ) "L"))))
3322 (format " table:style-name=\"%s\"" cell-style-name
)
3323 (and (> horiz-span
0)
3324 (format " table:number-columns-spanned=\"%d\""
3325 (1+ horiz-span
))))))
3326 (unless contents
(setq contents
""))
3328 (cl-assert paragraph-style
)
3329 (format "\n<table:table-cell%s>\n%s\n</table:table-cell>"
3331 (let ((table-cell-contents (org-element-contents table-cell
)))
3332 (if (eq (org-element-class (car table-cell-contents
)) 'element
)
3334 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3335 paragraph-style contents
))))
3337 (dotimes (_ horiz-span s
)
3338 (setq s
(concat s
"\n<table:covered-table-cell/>"))))
3344 (defun org-odt-table-row (table-row contents info
)
3345 "Transcode a TABLE-ROW element from Org to ODT.
3346 CONTENTS is the contents of the row. INFO is a plist used as a
3347 communication channel."
3348 ;; Rules are ignored since table separators are deduced from
3349 ;; borders of the current row.
3350 (when (eq (org-element-property :type table-row
) 'standard
)
3351 (let* ((rowgroup-tags
3352 (if (and (= 1 (org-export-table-row-group table-row info
))
3353 (org-export-table-has-header-p
3354 (org-export-get-parent-table table-row
) info
))
3355 ;; If the row belongs to the first rowgroup and the
3356 ;; table has more than one row groups, then this row
3357 ;; belongs to the header row group.
3358 '("\n<table:table-header-rows>" .
"\n</table:table-header-rows>")
3359 ;; Otherwise, it belongs to non-header row group.
3360 '("\n<table:table-rows>" .
"\n</table:table-rows>"))))
3362 ;; Does this row begin a rowgroup?
3363 (when (org-export-table-row-starts-rowgroup-p table-row info
)
3364 (car rowgroup-tags
))
3366 (format "\n<table:table-row>\n%s\n</table:table-row>" contents
)
3367 ;; Does this row end a rowgroup?
3368 (when (org-export-table-row-ends-rowgroup-p table-row info
)
3369 (cdr rowgroup-tags
))))))
3374 (defun org-odt-table-first-row-data-cells (table info
)
3376 (org-element-map table
'table-row
3378 (unless (eq (org-element-property :type row
) 'rule
) row
))
3380 (special-column-p (org-export-table-has-special-column-p table
)))
3381 (if (not special-column-p
) (org-element-contents table-row
)
3382 (cdr (org-element-contents table-row
)))))
3384 (defun org-odt--table (table contents info
)
3385 "Transcode a TABLE element from Org to ODT.
3386 CONTENTS is the contents of the table. INFO is a plist holding
3387 contextual information."
3388 (cl-case (org-element-property :type table
)
3389 ;; Case 1: table.el doesn't support export to OD format. Strip
3390 ;; such tables from export.
3395 "(ox-odt): Found table.el-type table in the source Org file."
3396 " table.el doesn't support export to ODT format."
3397 " Stripping the table from export."))))
3398 ;; Case 2: Native Org tables.
3400 (let* ((captions (org-odt-format-label table info
'definition
))
3401 (caption (car captions
)) (short-caption (cdr captions
))
3402 (attributes (org-export-read-attribute :attr_odt table
))
3403 (custom-table-style (nth 1 (org-odt-table-style-spec table info
)))
3405 (lambda (table info
)
3406 (let* ((table-style (or custom-table-style
"OrgTable"))
3407 (column-style (format "%sColumn" table-style
)))
3409 (lambda (table-cell)
3410 (let ((width (1+ (or (org-export-table-cell-width
3411 table-cell info
) 0)))
3413 "\n<table:table-column table:style-name=\"%s\"/>"
3416 (dotimes (_ width out
) (setq out
(concat s out
)))))
3417 (org-odt-table-first-row-data-cells table info
) "\n")))))
3421 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3424 (let* ((automatic-name
3425 (org-odt-add-automatic-style "Table" attributes
)))
3427 "\n<table:table table:style-name=\"%s\"%s>"
3428 (or custom-table-style
(cdr automatic-name
) "OrgTable")
3429 (concat (when short-caption
3430 (format " table:name=\"%s\"" short-caption
)))))
3431 ;; column specification.
3432 (funcall table-column-specs table info
)
3436 "</table:table>")))))
3438 (defun org-odt-table (table contents info
)
3439 "Transcode a TABLE element from Org to ODT.
3440 CONTENTS is the contents of the table. INFO is a plist holding
3441 contextual information.
3443 Use `org-odt--table' to typeset the table. Handle details
3444 pertaining to indentation here."
3445 (let* ((--element-preceded-by-table-p
3446 (lambda (element info
)
3447 (cl-loop for el in
(org-export-get-previous-element element info t
)
3448 thereis
(eq (org-element-type el
) 'table
))))
3449 (--walk-list-genealogy-and-collect-tags
3450 (lambda (table info
)
3451 (let* ((genealogy (org-element-lineage table
))
3453 (when (eq (org-element-type (car genealogy
)) 'item
)
3454 (cl-loop for el in genealogy
3455 when
(memq (org-element-type el
)
3462 when
(and (eq (org-element-type el
) 'headline
)
3463 (org-export-low-level-p el info
))
3467 (org-element-contents
3468 (org-export-get-parent el
)))))))
3471 ;; Handle list genealogy.
3473 for el in list-genealogy collect
3474 (cl-case (org-element-type el
)
3476 (setq parent-list el
)
3477 (cons "</text:list>"
3478 (format "\n<text:list text:style-name=\"%s\" %s>"
3479 (cl-case (org-element-property :type el
)
3480 (ordered "OrgNumberedList")
3481 (unordered "OrgBulletedList")
3482 (descriptive-1 "OrgDescriptionList")
3483 (descriptive-2 "OrgDescriptionList"))
3484 "text:continue-numbering=\"true\"")))
3488 (if (funcall --element-preceded-by-table-p table info
)
3489 '("</text:list-header>" .
"<text:list-header>")
3490 '("</text:list-item>" .
"<text:list-header>")))
3491 ((funcall --element-preceded-by-table-p
3493 '("</text:list-header>" .
"<text:list-header>"))
3494 (t '("</text:list-item>" .
"<text:list-item>"))))))
3495 ;; Handle low-level headlines.
3496 (cl-loop for el in llh-genealogy
3497 with step
= 'item collect
3500 (setq step
'item
) ; Flip-flop
3501 (setq parent-list el
)
3502 (cons "</text:list>"
3503 (format "\n<text:list text:style-name=\"%s\" %s>"
3504 (if (org-export-numbered-headline-p
3508 "text:continue-numbering=\"true\"")))
3510 (setq step
'plain-list
) ; Flip-flop
3513 (if (funcall --element-preceded-by-table-p table info
)
3514 '("</text:list-header>" .
"<text:list-header>")
3515 '("</text:list-item>" .
"<text:list-header>")))
3516 ((let ((section?
(org-export-get-previous-element
3519 (eq (org-element-type section?
) 'section
)
3520 (assq 'table
(org-element-contents section?
))))
3521 '("</text:list-header>" .
"<text:list-header>"))
3523 '("</text:list-item>" .
"<text:list-item>"))))))))))
3524 (close-open-tags (funcall --walk-list-genealogy-and-collect-tags
3526 ;; OpenDocument schema does not permit table to occur within a
3529 ;; One solution - the easiest and lightweight, in terms of
3530 ;; implementation - is to put the table in an indented text box
3531 ;; and make the text box part of the list-item. Unfortunately if
3532 ;; the table is big and spans multiple pages, the text box could
3533 ;; overflow. In this case, the following attribute will come
3536 ;; ,---- From OpenDocument-v1.1.pdf
3537 ;; | 15.27.28 Overflow behavior
3539 ;; | For text boxes contained within text document, the
3540 ;; | style:overflow-behavior property specifies the behavior of text
3541 ;; | boxes where the containing text does not fit into the text
3544 ;; | If the attribute's value is clip, the text that does not fit
3545 ;; | into the text box is not displayed.
3547 ;; | If the attribute value is auto-create-new-frame, a new frame
3548 ;; | will be created on the next page, with the same position and
3549 ;; | dimensions of the original frame.
3551 ;; | If the style:overflow-behavior property's value is
3552 ;; | auto-create-new-frame and the text box has a minimum width or
3553 ;; | height specified, then the text box will grow until the page
3554 ;; | bounds are reached before a new frame is created.
3557 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3558 ;; auto-create-new-frame property and always resorts to clipping
3559 ;; the text box. This results in table being truncated.
3561 ;; So we solve the problem the hard (and fun) way using list
3564 ;; The problem only becomes more interesting if you take in to
3565 ;; account the following facts:
3567 ;; - Description lists are simulated as plain lists.
3568 ;; - Low-level headlines can be listified.
3569 ;; - In Org mode, a table can occur not only as a regular list
3570 ;; item, but also within description lists and low-level
3573 ;; See `org-odt-translate-description-lists' and
3574 ;; `org-odt-translate-low-level-headlines' for how this is
3578 ;; Discontinue the list.
3579 (mapconcat 'car close-open-tags
"\n")
3580 ;; Put the table in an indented section.
3581 (let* ((table (org-odt--table table contents info
))
3582 (level (/ (length (mapcar 'car close-open-tags
)) 2))
3583 (style (format "OrgIndentedSection-Level-%d" level
)))
3584 (when table
(org-odt-format-section table style
)))
3585 ;; Continue the list.
3586 (mapconcat 'cdr
(nreverse close-open-tags
) "\n"))))
3591 (defun org-odt-target (target _contents info
)
3592 "Transcode a TARGET object from Org to ODT.
3593 CONTENTS is nil. INFO is a plist holding contextual
3595 (org-odt--target "" (org-export-get-reference target info
)))
3600 (defun org-odt-timestamp (timestamp _contents info
)
3601 "Transcode a TIMESTAMP object from Org to ODT.
3602 CONTENTS is nil. INFO is a plist used as a communication
3604 (let ((type (org-element-property :type timestamp
)))
3605 (if (not (plist-get info
:odt-use-date-fields
))
3606 (let ((value (org-odt-plain-text
3607 (org-timestamp-translate timestamp
) info
)))
3608 (cl-case (org-element-property :type timestamp
)
3609 ((active active-range
)
3610 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3611 "OrgActiveTimestamp" value
))
3612 ((inactive inactive-range
)
3613 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3614 "OrgInactiveTimestamp" value
))
3618 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3619 "OrgActiveTimestamp"
3620 (format "<%s>" (org-odt--format-timestamp timestamp
))))
3622 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3623 "OrgInactiveTimestamp"
3624 (format "[%s]" (org-odt--format-timestamp timestamp
))))
3626 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3627 "OrgActiveTimestamp"
3628 (format "<%s>–<%s>"
3629 (org-odt--format-timestamp timestamp
)
3630 (org-odt--format-timestamp timestamp
'end
))))
3632 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3633 "OrgInactiveTimestamp"
3634 (format "[%s]–[%s]"
3635 (org-odt--format-timestamp timestamp
)
3636 (org-odt--format-timestamp timestamp
'end
))))
3638 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3640 (org-odt-plain-text (org-timestamp-translate timestamp
)
3646 (defun org-odt-underline (_underline contents _info
)
3647 "Transcode UNDERLINE from Org to ODT.
3648 CONTENTS is the text with underline markup. INFO is a plist
3649 holding contextual information."
3650 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3651 "Underline" contents
))
3656 (defun org-odt-verbatim (verbatim _contents _info
)
3657 "Transcode a VERBATIM object from Org to ODT.
3658 CONTENTS is nil. INFO is a plist used as a communication
3660 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3661 "OrgCode" (org-odt--encode-plain-text
3662 (org-element-property :value verbatim
))))
3667 (defun org-odt-verse-block (_verse-block contents _info
)
3668 "Transcode a VERSE-BLOCK element from Org to ODT.
3669 CONTENTS is verse block contents. INFO is a plist holding
3670 contextual information."
3671 (format "\n<text:p text:style-name=\"OrgVerse\">%s</text:p>"
3672 (replace-regexp-in-string
3673 ;; Replace leading tabs and spaces.
3674 "^[ \t]+" #'org-odt--encode-tabs-and-spaces
3675 ;; Add line breaks to each line of verse.
3676 (replace-regexp-in-string
3677 "\\(<text:line-break/>\\)?[ \t]*$" "<text:line-break/>" contents
))))
3685 (defun org-odt--translate-image-links (data _backend info
)
3686 (org-export-insert-image-links data info org-odt-inline-image-rules
))
3688 ;;;; LaTeX fragments
3690 (defun org-odt--translate-latex-fragments (tree _backend info
)
3691 (let ((processing-type (plist-get info
:with-latex
))
3693 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3694 ;; If the desired converter is not available, force verbatim
3696 (cl-case processing-type
3698 (if (and (fboundp 'org-format-latex-mathml-available-p
)
3699 (org-format-latex-mathml-available-p))
3700 (setq processing-type
'mathml
)
3701 (message "LaTeX to MathML converter not available.")
3702 (setq processing-type
'verbatim
)))
3703 ((dvipng imagemagick
)
3704 (unless (and (org-check-external-command "latex" "" t
)
3705 (org-check-external-command
3706 (if (eq processing-type
'dvipng
) "dvipng" "convert") "" t
))
3707 (message "LaTeX to PNG converter not available.")
3708 (setq processing-type
'verbatim
)))
3710 (message "Unknown LaTeX option. Forcing verbatim.")
3711 (setq processing-type
'verbatim
)))
3713 ;; Store normalized value for later use.
3714 (when (plist-get info
:with-latex
)
3715 (plist-put info
:with-latex processing-type
))
3716 (message "Formatting LaTeX using %s" processing-type
)
3718 ;; Convert `latex-fragment's and `latex-environment's.
3719 (when (memq processing-type
'(mathml dvipng imagemagick
))
3720 (org-element-map tree
'(latex-fragment latex-environment
)
3723 (let* ((latex-frag (org-element-property :value latex-
*))
3724 (input-file (plist-get info
:input-file
))
3725 (cache-dir (file-name-directory input-file
))
3726 (cache-subdir (concat
3727 (cl-case processing-type
3728 ((dvipng imagemagick
) "ltxpng/")
3729 (mathml "ltxmathml/"))
3730 (file-name-sans-extension
3731 (file-name-nondirectory input-file
))))
3733 (cl-case processing-type
3734 ((dvipng imagemagick
)
3735 (format "Creating LaTeX Image %d..." count
))
3736 (mathml (format "Creating MathML snippet %d..." count
))))
3737 ;; Get an Org-style link to PNG image or the MathML
3742 ;; When converting to a PNG image, make sure to
3743 ;; copy all LaTeX header specifications from the
3745 (unless (eq processing-type
'mathml
)
3746 (let ((h (plist-get info
:latex-header
)))
3749 (replace-regexp-in-string
3750 "^" "#+LATEX_HEADER: " h
)))))
3751 (org-format-latex cache-subdir nil nil cache-dir
3754 (goto-char (point-min))
3755 (skip-chars-forward " \t\n")
3756 (org-element-link-parser))))
3757 (if (not (eq 'link
(org-element-type link
)))
3758 (message "LaTeX Conversion failed.")
3759 ;; Conversion succeeded. Parse above Org-style link to
3762 (cl-case (org-element-type latex-
*)
3763 ;;LaTeX environment. Mimic a "standalone image
3764 ;; or formula" by enclosing the `link' in
3765 ;; a `paragraph'. Copy over original
3766 ;; attributes, captions to the enclosing
3769 (org-element-adopt-elements
3771 (list :style
"OrgFormula"
3773 (org-element-property :name latex-
*)
3775 (org-element-property :caption latex-
*)))
3777 ;; LaTeX fragment. No special action.
3778 (latex-fragment link
))))
3779 ;; Note down the object that link replaces.
3780 (org-element-put-property replacement
:replaces
3781 (list (org-element-type latex-
*)
3782 (list :value latex-frag
)))
3783 ;; Restore blank after initial element or object.
3784 (org-element-put-property
3785 replacement
:post-blank
3786 (org-element-property :post-blank latex-
*))
3788 (org-element-set-element latex-
* replacement
)))))
3793 ;;;; Description lists
3795 ;; This translator is necessary to handle indented tables in a uniform
3796 ;; manner. See comment in `org-odt--table'.
3798 (defun org-odt--translate-description-lists (tree _backend info
)
3799 ;; OpenDocument has no notion of a description list. So simulate it
3800 ;; using plain lists. Description lists in the exported document
3801 ;; are typeset in the same manner as they are in a typical HTML
3804 ;; Specifically, a description list like this:
3807 ;; | - term-1 :: definition-1
3808 ;; | - term-2 :: definition-2
3811 ;; gets translated in to the following form:
3820 ;; Further effect is achieved by fixing the OD styles as below:
3822 ;; 1. Set the :type property of the simulated lists to
3823 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3824 ;; that has *no* bullets whatsoever.
3826 ;; 2. The paragraph containing the definition term is styled to be
3829 (org-element-map tree
'plain-list
3831 (when (eq (org-element-property :type el
) 'descriptive
)
3832 (org-element-set-element
3834 (apply 'org-element-adopt-elements
3835 (list 'plain-list
(list :type
'descriptive-1
))
3838 (org-element-adopt-elements
3839 (list 'item
(list :checkbox
(org-element-property
3841 (list 'paragraph
(list :style
"Text_20_body_20_bold")
3842 (or (org-element-property :tag item
) "(no term)"))
3843 (org-element-adopt-elements
3844 (list 'plain-list
(list :type
'descriptive-2
))
3845 (apply 'org-element-adopt-elements
3847 (org-element-contents item
)))))
3848 (org-element-contents el
)))))
3855 ;; Lists that are marked with attribute `:list-table' are called as
3856 ;; list tables. They will be rendered as a table within the exported
3859 ;; Consider an example. The following list table
3861 ;; #+attr_odt :list-table t
3871 ;; will be exported as though it were an Org table like the one show
3874 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3875 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3877 ;; Note that org-tables are NOT multi-line and each line is mapped to
3878 ;; a unique row in the exported document. So if an exported table
3879 ;; needs to contain a single paragraph (with copious text) it needs to
3880 ;; be typed up in a single line. Editing such long lines using the
3881 ;; table editor will be a cumbersome task. Furthermore inclusion of
3882 ;; multi-paragraph text in a table cell is well-nigh impossible.
3884 ;; A LIST-TABLE circumvents above problems.
3886 ;; Note that in the example above the list items could be paragraphs
3887 ;; themselves and the list can be arbitrarily deep.
3889 ;; Inspired by following thread:
3890 ;; https://lists.gnu.org/r/emacs-orgmode/2011-03/msg01101.html
3892 ;; Translate lists to tables
3894 (defun org-odt--translate-list-tables (tree _backend info
)
3895 (org-element-map tree
'plain-list
3897 (when (org-export-read-attribute :attr_odt l1-list
:list-table
)
3898 ;; Replace list with table.
3899 (org-element-set-element
3901 ;; Build replacement table.
3902 (apply 'org-element-adopt-elements
3903 (list 'table
'(:type org
:attr_odt
(":style \"GriddedTable\"")))
3904 (org-element-map l1-list
'item
3906 (let* ((l1-item-contents (org-element-contents l1-item
))
3907 l1-item-leading-text l2-list
)
3908 ;; Remove Level-2 list from the Level-item. It
3909 ;; will be subsequently attached as table-cells.
3910 (let ((cur l1-item-contents
) prev
)
3911 (while (and cur
(not (eq (org-element-type (car cur
))
3914 (setq cur
(cdr cur
)))
3917 (setq l2-list
(car cur
)))
3918 (setq l1-item-leading-text l1-item-contents
))
3919 ;; Level-1 items start a table row.
3920 (apply 'org-element-adopt-elements
3921 (list 'table-row
(list :type
'standard
))
3922 ;; Leading text of level-1 item define
3923 ;; the first table-cell.
3924 (apply 'org-element-adopt-elements
3925 (list 'table-cell nil
)
3926 l1-item-leading-text
)
3927 ;; Level-2 items define subsequent
3928 ;; table-cells of the row.
3929 (org-element-map l2-list
'item
3931 (apply 'org-element-adopt-elements
3932 (list 'table-cell nil
)
3933 (org-element-contents l2-item
)))
3941 ;;; Interactive functions
3943 (defun org-odt-create-manifest-file-entry (&rest args
)
3944 (push args org-odt-manifest-file-entries
))
3946 (defun org-odt-write-manifest-file ()
3947 (make-directory (concat org-odt-zip-dir
"META-INF"))
3948 (let ((manifest-file (concat org-odt-zip-dir
"META-INF/manifest.xml")))
3949 (with-current-buffer
3950 (let ((nxml-auto-insert-xml-declaration-flag nil
))
3951 (find-file-noselect manifest-file t
))
3953 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
3954 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3955 (dolist (file-entry org-odt-manifest-file-entries
)
3956 (let* ((version (nth 2 file-entry
))
3957 (extra (if (not version
) ""
3958 (format " manifest:version=\"%s\"" version
))))
3960 (format org-odt-manifest-file-entry-tag
3961 (nth 0 file-entry
) (nth 1 file-entry
) extra
))))
3962 (insert "\n</manifest:manifest>"))))
3964 (defmacro org-odt--export-wrap
(out-file &rest body
)
3965 `(let* ((--out-file ,out-file
)
3966 (out-file-type (file-name-extension --out-file
))
3967 (org-odt-xml-files '("META-INF/manifest.xml" "content.xml"
3968 "meta.xml" "styles.xml"))
3969 ;; Initialize temporary workarea. All files that end up in
3970 ;; the exported document get parked/created here.
3971 (org-odt-zip-dir (file-name-as-directory
3972 (make-temp-file (format "%s-" out-file-type
) t
)))
3973 (org-odt-manifest-file-entries nil
)
3974 (--cleanup-xml-buffers
3976 ;; Kill all XML buffers.
3977 (dolist (file org-odt-xml-files
)
3978 (let ((buf (find-buffer-visiting
3979 (concat org-odt-zip-dir file
))))
3981 (with-current-buffer buf
3982 (set-buffer-modified-p nil
)
3983 (kill-buffer buf
)))))
3984 ;; Delete temporary directory and also other embedded
3985 ;; files that get copied there.
3986 (delete-directory org-odt-zip-dir t
))))
3989 (unless (executable-find "zip")
3990 ;; Not at all OSes ship with zip by default
3991 (error "Executable \"zip\" needed for creating OpenDocument files"))
3992 ;; Do export. This creates a bunch of xml files ready to be
3993 ;; saved and zipped.
3995 ;; Create a manifest entry for content.xml.
3996 (org-odt-create-manifest-file-entry "text/xml" "content.xml")
3997 ;; Write mimetype file
3999 '(("odt" .
"application/vnd.oasis.opendocument.text")
4000 ("odf" .
"application/vnd.oasis.opendocument.formula")))
4001 (mimetype (cdr (assoc-string out-file-type mimetypes t
))))
4003 (error "Unknown OpenDocument backend %S" out-file-type
))
4004 (write-region mimetype nil
(concat org-odt-zip-dir
"mimetype"))
4005 (org-odt-create-manifest-file-entry mimetype
"/" "1.2"))
4006 ;; Write out the manifest entries before zipping
4007 (org-odt-write-manifest-file)
4008 ;; Save all XML files.
4009 (dolist (file org-odt-xml-files
)
4010 (let ((buf (find-buffer-visiting
4011 (concat org-odt-zip-dir file
))))
4013 (with-current-buffer buf
4014 ;; Prettify output if needed.
4015 (when org-odt-prettify-xml
4016 (indent-region (point-min) (point-max)))
4019 (let* ((target --out-file
)
4020 (target-name (file-name-nondirectory target
))
4021 (cmds `(("zip" "-mX0" ,target-name
"mimetype")
4022 ("zip" "-rmTq" ,target-name
"."))))
4023 ;; If a file with same name as the desired output file
4024 ;; exists, remove it.
4025 (when (file-exists-p target
)
4026 (delete-file target
))
4027 ;; Zip up the xml files.
4028 (let ((coding-system-for-write 'no-conversion
) exitcode err-string
)
4029 (message "Creating ODT file...")
4030 ;; Switch temporarily to content.xml. This way Zip
4031 ;; process will inherit `org-odt-zip-dir' as the current
4033 (with-current-buffer
4034 (find-file-noselect (concat org-odt-zip-dir
"content.xml") t
)
4036 (message "Running %s" (mapconcat 'identity cmd
" "))
4038 (with-output-to-string
4040 (apply 'call-process
(car cmd
)
4041 nil standard-output nil
(cdr cmd
)))))
4042 (or (zerop exitcode
)
4043 (error (concat "Unable to create OpenDocument file."
4044 " Zip failed with error (%s)")
4046 ;; Move the zip file from temporary work directory to
4047 ;; user-mandated location.
4048 (rename-file (concat org-odt-zip-dir target-name
) target
)
4049 (message "Created %s" (expand-file-name target
))
4050 ;; Cleanup work directory and work files.
4051 (funcall --cleanup-xml-buffers
)
4052 ;; Open the OpenDocument file in archive-mode for
4054 (find-file-noselect target t
)
4055 ;; Return exported file.
4057 ;; Case 1: Conversion desired on exported file. Run the
4058 ;; converter on the OpenDocument file. Return the
4060 (org-odt-preferred-output-format
4061 (or (org-odt-convert target org-odt-preferred-output-format
)
4063 ;; Case 2: No further conversion. Return exported
4064 ;; OpenDocument file.
4067 ;; Cleanup work directory and work files.
4068 (funcall --cleanup-xml-buffers
)
4069 (message "OpenDocument export failed: %s"
4070 (error-message-string err
))))))
4073 ;;;; Export to OpenDocument formula
4076 (defun org-odt-export-as-odf (latex-frag &optional odf-file
)
4077 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4078 Use `org-create-math-formula' to convert LATEX-FRAG first to
4079 MathML. When invoked as an interactive command, use
4080 `org-latex-regexps' to infer LATEX-FRAG from currently active
4081 region. If no LaTeX fragments are found, prompt for it. Push
4082 MathML source to kill ring depending on the value of
4083 `org-export-copy-to-kill-ring'."
4086 (setq frag
(and (setq frag
(and (region-active-p)
4087 (buffer-substring (region-beginning)
4089 (cl-loop for e in org-latex-regexps
4090 thereis
(when (string-match (nth 1 e
) frag
)
4091 (match-string (nth 2 e
) frag
)))))
4092 (read-string "LaTeX Fragment: " frag nil frag
))
4093 ,(let ((odf-filename (expand-file-name
4095 (file-name-sans-extension
4096 (or (file-name-nondirectory buffer-file-name
)))
4098 (file-name-directory buffer-file-name
))))
4099 (read-file-name "ODF filename: " nil odf-filename nil
4100 (file-name-nondirectory odf-filename
)))))
4101 (let ((filename (or odf-file
4104 (file-name-sans-extension
4105 (or (file-name-nondirectory buffer-file-name
)))
4107 (file-name-directory buffer-file-name
)))))
4108 (org-odt--export-wrap
4110 (let* ((buffer (progn
4111 (require 'nxml-mode
)
4112 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4113 (find-file-noselect (concat org-odt-zip-dir
4114 "content.xml") t
))))
4115 (coding-system-for-write 'utf-8
)
4116 (save-buffer-coding-system 'utf-8
))
4118 (set-buffer-file-coding-system coding-system-for-write
)
4119 (let ((mathml (org-create-math-formula latex-frag
)))
4120 (unless mathml
(error "No Math formula created"))
4122 ;; Add MathML to kill ring, if needed.
4123 (when (org-export--copy-to-kill-ring-p)
4124 (org-kill-new (buffer-string))))))))
4127 (defun org-odt-export-as-odf-and-open ()
4128 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4129 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4132 (org-open-file (call-interactively 'org-odt-export-as-odf
) 'system
))
4135 ;;;; Export to OpenDocument Text
4138 (defun org-odt-export-to-odt (&optional async subtreep visible-only ext-plist
)
4139 "Export current buffer to a ODT file.
4141 If narrowing is active in the current buffer, only export its
4144 If a region is active, export that region.
4146 A non-nil optional argument ASYNC means the process should happen
4147 asynchronously. The resulting file should be accessible through
4148 the `org-export-stack' interface.
4150 When optional argument SUBTREEP is non-nil, export the sub-tree
4151 at point, extracting information from the headline properties
4154 When optional argument VISIBLE-ONLY is non-nil, don't export
4155 contents of hidden elements.
4157 EXT-PLIST, when provided, is a property list with external
4158 parameters overriding Org default settings, but still inferior to
4159 file-local settings.
4161 Return output file's name."
4163 (let ((outfile (org-export-output-file-name ".odt" subtreep
)))
4165 (org-export-async-start (lambda (f) (org-export-add-to-stack f
'odt
))
4167 (org-odt--export-wrap
4169 (let* ((org-odt-embedded-images-count 0)
4170 (org-odt-embedded-formulas-count 0)
4171 (org-odt-automatic-styles nil
)
4172 (org-odt-object-counters nil
)
4173 ;; Let `htmlfontify' know that we are interested in
4174 ;; collecting styles.
4175 (hfy-user-sheet-assoc nil
))
4176 ;; Initialize content.xml and kick-off the export
4180 (require 'nxml-mode
)
4181 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4183 (concat org-odt-zip-dir
"content.xml") t
))))
4184 (output (org-export-as
4185 'odt
,subtreep
,visible-only nil
,ext-plist
)))
4186 (with-current-buffer out-buf
4188 (insert output
)))))))
4189 (org-odt--export-wrap
4191 (let* ((org-odt-embedded-images-count 0)
4192 (org-odt-embedded-formulas-count 0)
4193 (org-odt-automatic-styles nil
)
4194 (org-odt-object-counters nil
)
4195 ;; Let `htmlfontify' know that we are interested in collecting
4197 (hfy-user-sheet-assoc nil
))
4198 ;; Initialize content.xml and kick-off the export process.
4199 (let ((output (org-export-as 'odt subtreep visible-only nil ext-plist
))
4201 (require 'nxml-mode
)
4202 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4204 (concat org-odt-zip-dir
"content.xml") t
)))))
4205 (with-current-buffer out-buf
(erase-buffer) (insert output
))))))))
4208 ;;;; Convert between OpenDocument and other formats
4210 (defun org-odt-reachable-p (in-fmt out-fmt
)
4211 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4213 (let ((reachable-formats (org-odt-do-reachable-formats in-fmt
)))
4214 (dolist (e reachable-formats
)
4215 (let ((out-fmt-spec (assoc out-fmt
(cdr e
))))
4217 (throw 'done
(cons (car e
) out-fmt-spec
))))))))
4219 (defun org-odt-do-convert (in-file out-fmt
&optional open
)
4220 "Workhorse routine for `org-odt-convert'."
4221 (require 'browse-url
)
4222 (let* ((in-file (let ((f (expand-file-name (or in-file buffer-file-name
))))
4223 (if (file-readable-p f
) f
4224 (error "Cannot read %s" in-file
))))
4225 (in-fmt (file-name-extension in-file
))
4226 (out-fmt (or out-fmt
(error "Output format unspecified")))
4227 (how (or (org-odt-reachable-p in-fmt out-fmt
)
4228 (error "Cannot convert from %s format to %s format?"
4230 (convert-process (car how
))
4231 (out-file (concat (file-name-sans-extension in-file
) "."
4232 (nth 1 (or (cdr how
) out-fmt
))))
4233 (extra-options (or (nth 2 (cdr how
)) ""))
4234 (out-dir (file-name-directory in-file
))
4235 (cmd (format-spec convert-process
4236 `((?i .
,(shell-quote-argument in-file
))
4237 (?I .
,(browse-url-file-url in-file
))
4240 (?O .
,(browse-url-file-url out-file
))
4241 (?d .
, (shell-quote-argument out-dir
))
4242 (?D .
,(browse-url-file-url out-dir
))
4243 (?x .
,extra-options
)))))
4244 (when (file-exists-p out-file
)
4245 (delete-file out-file
))
4247 (message "Executing %s" cmd
)
4248 (let ((cmd-output (shell-command-to-string cmd
)))
4249 (message "%s" cmd-output
))
4252 ((file-exists-p out-file
)
4253 (message "Exported to %s" out-file
)
4255 (message "Opening %s..." out-file
)
4256 (org-open-file out-file
'system
))
4259 (message "Export to %s failed" out-file
)
4262 (defun org-odt-do-reachable-formats (in-fmt)
4263 "Return verbose info about formats to which IN-FMT can be converted.
4264 Return a list where each element is of the
4265 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4266 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4267 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4269 (and org-odt-convert-process
4270 (cadr (assoc-string org-odt-convert-process
4271 org-odt-convert-processes t
))))
4273 (and org-odt-convert-process
4274 (cadr (assoc-string org-odt-convert-process
4275 org-odt-convert-processes t
))
4276 org-odt-convert-capabilities
))
4279 (dolist (c capabilities
)
4280 (when (member in-fmt
(nth 1 c
))
4281 (push (cons converter
(nth 2 c
)) reachable-formats
))))
4284 (defun org-odt-reachable-formats (in-fmt)
4285 "Return list of formats to which IN-FMT can be converted.
4286 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4288 (apply #'append
(mapcar
4289 (lambda (e) (mapcar #'car
(cdr e
)))
4290 (org-odt-do-reachable-formats in-fmt
)))))
4292 (defun org-odt-convert-read-params ()
4293 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4294 This is a helper routine for interactive use."
4295 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
4296 (in-file (read-file-name "File to be converted: "
4297 nil buffer-file-name t
))
4298 (in-fmt (file-name-extension in-file
))
4299 (out-fmt-choices (org-odt-reachable-formats in-fmt
))
4301 (or (and out-fmt-choices
4302 (funcall input
"Output format: "
4303 out-fmt-choices nil nil nil
))
4305 "No known converter or no known output formats for %s files"
4307 (list in-file out-fmt
)))
4310 (defun org-odt-convert (&optional in-file out-fmt open
)
4311 "Convert IN-FILE to format OUT-FMT using a command line converter.
4312 IN-FILE is the file to be converted. If unspecified, it defaults
4313 to variable `buffer-file-name'. OUT-FMT is the desired output
4314 format. Use `org-odt-convert-process' as the converter. If OPEN
4315 is non-nil then the newly converted file is opened using
4318 (append (org-odt-convert-read-params) current-prefix-arg
))
4319 (org-odt-do-convert in-file out-fmt open
))
4321 ;;; Library Initializations
4323 (dolist (desc org-odt-file-extensions
)
4324 ;; Let Emacs open all OpenDocument files in archive mode.
4325 (add-to-list 'auto-mode-alist
4326 (cons (concat "\\." (car desc
) "\\'") 'archive-mode
)))
4331 ;; generated-autoload-file: "org-loaddefs.el"
4334 ;;; ox-odt.el ends here