1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2015 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (require 'table nil
'noerror
))
31 (require 'format-spec
)
37 (org-export-define-backend 'odt
38 '((bold . org-odt-bold
)
39 (center-block . org-odt-center-block
)
40 (clock . org-odt-clock
)
42 (drawer . org-odt-drawer
)
43 (dynamic-block . org-odt-dynamic-block
)
44 (entity . org-odt-entity
)
45 (example-block . org-odt-example-block
)
46 (export-block . org-odt-export-block
)
47 (export-snippet . org-odt-export-snippet
)
48 (fixed-width . org-odt-fixed-width
)
49 (footnote-definition . org-odt-footnote-definition
)
50 (footnote-reference . org-odt-footnote-reference
)
51 (headline . org-odt-headline
)
52 (horizontal-rule . org-odt-horizontal-rule
)
53 (inline-src-block . org-odt-inline-src-block
)
54 (inlinetask . org-odt-inlinetask
)
55 (italic . org-odt-italic
)
57 (keyword . org-odt-keyword
)
58 (latex-environment . org-odt-latex-environment
)
59 (latex-fragment . org-odt-latex-fragment
)
60 (line-break . org-odt-line-break
)
62 (node-property . org-odt-node-property
)
63 (paragraph . org-odt-paragraph
)
64 (plain-list . org-odt-plain-list
)
65 (plain-text . org-odt-plain-text
)
66 (planning . org-odt-planning
)
67 (property-drawer . org-odt-property-drawer
)
68 (quote-block . org-odt-quote-block
)
69 (radio-target . org-odt-radio-target
)
70 (section . org-odt-section
)
71 (special-block . org-odt-special-block
)
72 (src-block . org-odt-src-block
)
73 (statistics-cookie . org-odt-statistics-cookie
)
74 (strike-through . org-odt-strike-through
)
75 (subscript . org-odt-subscript
)
76 (superscript . org-odt-superscript
)
77 (table . org-odt-table
)
78 (table-cell . org-odt-table-cell
)
79 (table-row . org-odt-table-row
)
80 (target . org-odt-target
)
81 (template . org-odt-template
)
82 (timestamp . org-odt-timestamp
)
83 (underline . org-odt-underline
)
84 (verbatim . org-odt-verbatim
)
85 (verse-block . org-odt-verse-block
))
87 :filters-alist
'((:filter-parse-tree
88 .
(org-odt--translate-latex-fragments
89 org-odt--translate-description-lists
90 org-odt--translate-list-tables
)))
93 ((?o
"As ODT file" org-odt-export-to-odt
)
94 (?O
"As ODT file and open"
96 (if a
(org-odt-export-to-odt t s v
)
97 (org-open-file (org-odt-export-to-odt nil s v
) 'system
))))))
99 '((:odt-styles-file
"ODT_STYLES_FILE" nil nil t
)
100 (:description
"DESCRIPTION" nil nil newline
)
101 (:keywords
"KEYWORDS" nil nil space
)
102 (:subtitle
"SUBTITLE" nil nil parse
)
104 (:odt-content-template-file nil nil org-odt-content-template-file
)
105 (:odt-display-outline-level nil nil org-odt-display-outline-level
)
106 (:odt-fontify-srcblocks nil nil org-odt-fontify-srcblocks
)
107 (:odt-format-drawer-function nil nil org-odt-format-drawer-function
)
108 (:odt-format-headline-function nil nil org-odt-format-headline-function
)
109 (:odt-format-inlinetask-function nil nil org-odt-format-inlinetask-function
)
110 (:odt-inline-formula-rules nil nil org-odt-inline-formula-rules
)
111 (:odt-inline-image-rules nil nil org-odt-inline-image-rules
)
112 (:odt-pixels-per-inch nil nil org-odt-pixels-per-inch
)
113 (:odt-styles-file nil nil org-odt-styles-file
)
114 (:odt-table-styles nil nil org-odt-table-styles
)
115 (:odt-use-date-fields nil nil org-odt-use-date-fields
)
116 ;; Redefine regular option.
117 (:with-latex nil
"tex" org-odt-with-latex
)))
124 ;;; Function Declarations
126 (declare-function hfy-face-to-style
"htmlfontify" (fn))
127 (declare-function hfy-face-or-def-to-name
"htmlfontify" (fn))
128 (declare-function archive-zip-extract
"arc-mode" (archive name
))
129 (declare-function org-create-math-formula
"org" (latex-frag &optional mathml-file
))
130 (declare-function browse-url-file-url
"browse-url" (file))
134 ;;; Internal Variables
136 (defconst org-odt-lib-dir
137 (file-name-directory (or load-file-name
(buffer-file-name)))
138 "Location of ODT exporter.
139 Use this to infer values of `org-odt-styles-dir' and
140 `org-odt-schema-dir'.")
142 (defvar org-odt-data-dir
143 (expand-file-name "../../etc/" org-odt-lib-dir
)
144 "Data directory for ODT exporter.
145 Use this to infer values of `org-odt-styles-dir' and
146 `org-odt-schema-dir'.")
148 (defconst org-odt-special-string-regexps
149 '(("\\\\-" .
"­\\1") ; shy
150 ("---\\([^-]\\)" .
"—\\1") ; mdash
151 ("--\\([^-]\\)" .
"–\\1") ; ndash
152 ("\\.\\.\\." .
"…")) ; hellip
153 "Regular expressions for special string conversion.")
155 (defconst org-odt-schema-dir-list
157 (and org-odt-data-dir
158 (expand-file-name "./schema/" org-odt-data-dir
)) ; bail out
160 (and (boundp 'org-odt-data-dir
) org-odt-data-dir
; see make install
161 (expand-file-name "./schema/" org-odt-data-dir
))))
162 "List of directories to search for OpenDocument schema files.
163 Use this list to set the default value of
164 `org-odt-schema-dir'. The entries in this list are
165 populated heuristically based on the values of `org-odt-lib-dir'
166 and `org-odt-data-dir'.")
168 (defconst org-odt-styles-dir-list
170 (and org-odt-data-dir
171 (expand-file-name "./styles/" org-odt-data-dir
)) ; bail out
173 (and (boundp 'org-odt-data-dir
) org-odt-data-dir
; see make install
174 (expand-file-name "./styles/" org-odt-data-dir
)))
175 (expand-file-name "../../etc/styles/" org-odt-lib-dir
) ; git
176 (expand-file-name "./etc/styles/" org-odt-lib-dir
) ; elpa
177 (expand-file-name "./org/" data-directory
) ; system
179 "List of directories to search for OpenDocument styles files.
180 See `org-odt-styles-dir'. The entries in this list are populated
181 heuristically based on the values of `org-odt-lib-dir' and
182 `org-odt-data-dir'.")
184 (defconst org-odt-styles-dir
187 (message "Debug (ox-odt): Searching for OpenDocument styles files...")
188 (mapc (lambda (styles-dir)
190 (message "Debug (ox-odt): Trying %s..." styles-dir
)
191 (when (and (file-readable-p
193 "OrgOdtContentTemplate.xml" styles-dir
))
196 "OrgOdtStyles.xml" styles-dir
)))
197 (message "Debug (ox-odt): Using styles under %s"
199 (throw 'styles-dir styles-dir
))))
200 org-odt-styles-dir-list
)
203 (error "Error (ox-odt): Cannot find factory styles files, aborting"))
205 "Directory that holds auxiliary XML files used by the ODT exporter.
207 This directory contains the following XML files -
208 \"OrgOdtStyles.xml\" and \"OrgOdtContentTemplate.xml\". These
209 XML files are used as the default values of
210 `org-odt-styles-file' and `org-odt-content-template-file'.
212 The default value of this variable varies depending on the
213 version of org in use and is initialized from
214 `org-odt-styles-dir-list'. Note that the user could be using org
215 from one of: org's own private git repository, GNU ELPA tar or
218 (defconst org-odt-bookmark-prefix
"OrgXref.")
220 (defconst org-odt-manifest-file-entry-tag
221 "\n<manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
223 (defconst org-odt-file-extensions
224 '(("odt" .
"OpenDocument Text")
225 ("ott" .
"OpenDocument Text Template")
226 ("odm" .
"OpenDocument Master Document")
227 ("ods" .
"OpenDocument Spreadsheet")
228 ("ots" .
"OpenDocument Spreadsheet Template")
229 ("odg" .
"OpenDocument Drawing (Graphics)")
230 ("otg" .
"OpenDocument Drawing Template")
231 ("odp" .
"OpenDocument Presentation")
232 ("otp" .
"OpenDocument Presentation Template")
233 ("odi" .
"OpenDocument Image")
234 ("odf" .
"OpenDocument Formula")
235 ("odc" .
"OpenDocument Chart")))
237 (defconst org-odt-table-style-format
239 <style:style style:name=\"%s\" style:family=\"table\">
240 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
243 "Template for auto-generated Table styles.")
245 (defvar org-odt-automatic-styles
'()
246 "Registry of automatic styles for various OBJECT-TYPEs.
247 The variable has the following form:
249 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
250 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
252 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
253 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
256 OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
257 OBJECT-PROPS is (typically) a plist created by passing
258 \"#+ATTR_ODT: \" option to `org-odt-parse-block-attributes'.
260 Use `org-odt-add-automatic-style' to add update this variable.'")
262 (defvar org-odt-object-counters nil
263 "Running counters for various OBJECT-TYPEs.
264 Use this to generate automatic names and style-names. See
265 `org-odt-add-automatic-style'.")
267 (defvar org-odt-src-block-paragraph-format
268 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
269 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
270 <style:background-image/>
271 </style:paragraph-properties>
272 <style:text-properties fo:color=\"%s\"/>
274 "Custom paragraph style for colorized source and example blocks.
275 This style is much the same as that of \"OrgFixedWidthBlock\"
276 except that the foreground and background colors are set
277 according to the default face identified by the `htmlfontify'.")
279 (defvar hfy-optimizations
)
280 (define-obsolete-variable-alias 'hfy-optimisations
'hfy-optimizations
"25.1")
281 (defvar org-odt-embedded-formulas-count
0)
282 (defvar org-odt-embedded-images-count
0)
283 (defvar org-odt-image-size-probe-method
284 (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
286 "Ordered list of methods for determining image sizes.")
288 (defvar org-odt-default-image-sizes-alist
289 '(("as-char" .
(5 .
0.4))
290 ("paragraph" .
(5 .
5)))
291 "Hardcoded image dimensions one for each of the anchor
294 ;; A4 page size is 21.0 by 29.7 cms
295 ;; The default page settings has 2cm margin on each of the sides. So
296 ;; the effective text area is 17.0 by 25.7 cm
297 (defvar org-odt-max-image-size
'(17.0 .
20.0)
298 "Limiting dimensions for an embedded image.")
300 (defconst org-odt-label-styles
301 '(("math-formula" "%c" "text" "(%n)")
302 ("math-label" "(%n)" "text" "(%n)")
303 ("category-and-value" "%e %n: %c" "category-and-value" "%e %n")
304 ("value" "%e %n: %c" "value" "%n"))
305 "Specify how labels are applied and referenced.
307 This is an alist where each element is of the form:
309 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
311 ATTACH-FMT controls how labels and captions are attached to an
312 entity. It may contain following specifiers - %e and %c. %e is
313 replaced with the CATEGORY-NAME. %n is replaced with
314 \"<text:sequence ...> SEQNO </text:sequence>\". %c is replaced
317 REF-MODE and REF-FMT controls how label references are generated.
318 The following XML is generated for a label reference -
319 \"<text:sequence-ref text:reference-format=\"REF-MODE\" ...>
320 REF-FMT </text:sequence-ref>\". REF-FMT may contain following
321 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
322 %n is replaced with SEQNO.
324 See also `org-odt-format-label'.")
326 (defvar org-odt-category-map-alist
327 '(("__Table__" "Table" "value" "Table" org-odt--enumerable-p
)
328 ("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p
)
329 ("__MathFormula__" "Text" "math-formula" "Equation" org-odt--enumerable-formula-p
)
330 ("__DvipngImage__" "Equation" "value" "Equation" org-odt--enumerable-latex-image-p
)
331 ("__Listing__" "Listing" "value" "Listing" org-odt--enumerable-p
))
332 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
334 This is a list where each entry is of the form:
336 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
338 CATEGORY_HANDLE identifies the captionable entity in question.
340 OD-VARIABLE is the OpenDocument sequence counter associated with
341 the entity. These counters are declared within
342 \"<text:sequence-decls>...</text:sequence-decls>\" block of
343 `org-odt-content-template-file'.
345 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
346 how a given entity should be captioned and referenced.
348 CATEGORY-NAME is used for qualifying captions on export.
350 ENUMERATOR-PREDICATE is used for assigning a sequence number to
351 the entity. See `org-odt--enumerate'.")
353 (defvar org-odt-manifest-file-entries nil
)
354 (defvar hfy-user-sheet-assoc
)
356 (defvar org-odt-zip-dir nil
357 "Temporary work directory for OpenDocument exporter.")
361 ;;; User Configuration Variables
363 (defgroup org-export-odt nil
364 "Options for exporting Org mode files to ODT."
365 :tag
"Org Export ODT"
371 (defcustom org-odt-prettify-xml nil
372 "Specify whether or not the xml output should be prettified.
373 When this option is turned on, `indent-region' is run on all
374 component xml buffers before they are saved. Turn this off for
375 regular use. Turn this on if you need to examine the xml
377 :group
'org-export-odt
385 (defcustom org-odt-schema-dir
388 (message "Debug (ox-odt): Searching for OpenDocument schema files...")
392 (message "Debug (ox-odt): Trying %s..." schema-dir
)
393 (when (and (file-expand-wildcards
394 (expand-file-name "od-manifest-schema*.rnc"
396 (file-expand-wildcards
397 (expand-file-name "od-schema*.rnc"
400 (expand-file-name "schemas.xml" schema-dir
)))
401 (message "Debug (ox-odt): Using schema files under %s"
403 (throw 'schema-dir schema-dir
))))
404 org-odt-schema-dir-list
)
405 (message "Debug (ox-odt): No OpenDocument schema files installed")
408 "Directory that contains OpenDocument schema files.
410 This directory contains:
411 1. rnc files for OpenDocument schema
412 2. a \"schemas.xml\" file that specifies locating rules needed
413 for auto validation of OpenDocument XML files.
415 Use the customize interface to set this variable. This ensures
416 that `rng-schema-locating-files' is updated and auto-validation
417 of OpenDocument XML takes place based on the value
418 `rng-nxml-auto-validate-flag'.
420 The default value of this variable varies depending on the
421 version of org in use and is initialized from
422 `org-odt-schema-dir-list'. The OASIS schema files are available
423 only in the org's private git repository. It is *not* bundled
424 with GNU ELPA tar or standard Emacs distribution."
426 (const :tag
"Not set" nil
)
427 (directory :tag
"Schema directory"))
428 :group
'org-export-odt
432 "Set `org-odt-schema-dir'.
433 Also add it to `rng-schema-locating-files'."
434 (let ((schema-dir value
))
437 (file-expand-wildcards
438 (expand-file-name "od-manifest-schema*.rnc" schema-dir
))
439 (file-expand-wildcards
440 (expand-file-name "od-schema*.rnc" schema-dir
))
442 (expand-file-name "schemas.xml" schema-dir
)))
445 (message "Error (ox-odt): %s has no OpenDocument schema files"
448 (when org-odt-schema-dir
449 (eval-after-load 'rng-loc
450 '(add-to-list 'rng-schema-locating-files
451 (expand-file-name "schemas.xml"
452 org-odt-schema-dir
))))))
457 (defcustom org-odt-content-template-file nil
458 "Template file for \"content.xml\".
459 The exporter embeds the exported content just before
460 \"</office:text>\" element.
462 If unspecified, the file named \"OrgOdtContentTemplate.xml\"
463 under `org-odt-styles-dir' is used."
464 :type
'(choice (const nil
)
466 :group
'org-export-odt
469 (defcustom org-odt-styles-file nil
470 "Default styles file for use with ODT export.
471 Valid values are one of:
473 2. path to a styles.xml file
474 3. path to a *.odt or a *.ott file
475 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
478 In case of option 1, an in-built styles.xml is used. See
479 `org-odt-styles-dir' for more information.
481 In case of option 3, the specified file is unzipped and the
482 styles.xml embedded therein is used.
484 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
485 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
486 generated odt file. Use relative path for specifying the
487 FILE-MEMBERS. styles.xml must be specified as one of the
490 Use options 1, 2 or 3 only if styles.xml alone suffices for
491 achieving the desired formatting. Use option 4, if the styles.xml
492 references additional files like header and footer images for
493 achieving the desired formatting.
495 Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
496 a per-file basis. For example,
498 #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
499 #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
500 :group
'org-export-odt
504 (const :tag
"Factory settings" nil
)
505 (file :must-match t
:tag
"styles.xml")
506 (file :must-match t
:tag
"ODT or OTT file")
507 (list :tag
"ODT or OTT file + Members"
508 (file :must-match t
:tag
"ODF Text or Text Template file")
510 (file :tag
" Member" "styles.xml")
511 (repeat (file :tag
"Member"))))))
513 (defcustom org-odt-display-outline-level
2
514 "Outline levels considered for enumerating captioned entities."
515 :group
'org-export-odt
517 :package-version
'(Org .
"8.0")
520 ;;;; Document conversion
522 (defcustom org-odt-convert-processes
524 "soffice --headless --convert-to %f%x --outdir %d %i")
526 "unoconv -f %f -o %d %i"))
527 "Specify a list of document converters and their usage.
528 The converters in this list are offered as choices while
529 customizing `org-odt-convert-process'.
531 This variable is a list where each element is of the
532 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
533 of the converter. CONVERTER-CMD is the shell command for the
534 converter and can contain format specifiers. These format
535 specifiers are interpreted as below:
537 %i input file name in full
538 %I input file name as a URL
539 %f format of the output file
540 %o output file name in full
541 %O output file name as a URL
542 %d output dir in full
543 %D output dir as a URL.
544 %x extra options as set in `org-odt-convert-capabilities'."
545 :group
'org-export-odt
549 (const :tag
"None" nil
)
550 (alist :tag
"Converters"
551 :key-type
(string :tag
"Converter Name")
552 :value-type
(group (string :tag
"Command line")))))
554 (defcustom org-odt-convert-process
"LibreOffice"
555 "Use this converter to convert from \"odt\" format to other formats.
556 During customization, the list of converter names are populated
557 from `org-odt-convert-processes'."
558 :group
'org-export-odt
560 :type
'(choice :convert-widget
562 (apply 'widget-convert
(widget-type w
)
563 (eval (car (widget-get w
:args
)))))
564 `((const :tag
"None" nil
)
565 ,@(mapcar (lambda (c)
566 `(const :tag
,(car c
) ,(car c
)))
567 org-odt-convert-processes
))))
569 (defcustom org-odt-convert-capabilities
571 ("odt" "ott" "doc" "rtf" "docx")
572 (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
573 ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
576 (("pdf" "pdf") ("odt" "odt") ("html" "html")))
578 ("ods" "ots" "xls" "csv" "xlsx")
579 (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
580 ("xls" "xls") ("xlsx" "xlsx")))
582 ("odp" "otp" "ppt" "pptx")
583 (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
584 ("pptx" "pptx") ("odg" "odg"))))
585 "Specify input and output formats of `org-odt-convert-process'.
586 More correctly, specify the set of input and output formats that
587 the user is actually interested in.
589 This variable is an alist where each element is of the
590 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
591 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
592 alist where each element is of the form (OUTPUT-FMT
593 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
595 The variable is interpreted as follows:
596 `org-odt-convert-process' can take any document that is in
597 INPUT-FMT-LIST and produce any document that is in the
598 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
599 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
600 serves dual purposes:
601 - It is used for populating completion candidates during
602 `org-odt-convert' commands.
603 - It is used as the value of \"%f\" specifier in
604 `org-odt-convert-process'.
606 EXTRA-OPTIONS is used as the value of \"%x\" specifier in
607 `org-odt-convert-process'.
609 DOCUMENT-CLASS is used to group a set of file formats in
610 INPUT-FMT-LIST in to a single class.
612 Note that this variable inherently captures how LibreOffice based
613 converters work. LibreOffice maps documents of various formats
614 to classes like Text, Web, Spreadsheet, Presentation etc and
615 allow document of a given class (irrespective of its source
616 format) to be converted to any of the export formats associated
619 See default setting of this variable for an typical
621 :group
'org-export-odt
625 (const :tag
"None" nil
)
626 (alist :tag
"Capabilities"
627 :key-type
(string :tag
"Document Class")
629 (group (repeat :tag
"Input formats" (string :tag
"Input format"))
630 (alist :tag
"Output formats"
631 :key-type
(string :tag
"Output format")
633 (group (string :tag
"Output file extension")
635 (const :tag
"None" nil
)
636 (string :tag
"Extra options"))))))))
638 (defcustom org-odt-preferred-output-format nil
639 "Automatically post-process to this format after exporting to \"odt\".
640 Command `org-odt-export-to-odt' exports first to \"odt\" format
641 and then uses `org-odt-convert-process' to convert the
642 resulting document to this format. During customization of this
643 variable, the list of valid values are populated based on
644 `org-odt-convert-capabilities'.
646 You can set this option on per-file basis using file local
647 values. See Info node `(emacs) File Variables'."
648 :group
'org-export-odt
650 :type
'(choice :convert-widget
652 (apply 'widget-convert
(widget-type w
)
653 (eval (car (widget-get w
:args
)))))
654 `((const :tag
"None" nil
)
655 ,@(mapcar (lambda (c)
657 (org-odt-reachable-formats "odt")))))
659 (put 'org-odt-preferred-output-format
'safe-local-variable
'stringp
)
664 (defcustom org-odt-format-drawer-function
665 (lambda (name contents
) contents
)
666 "Function called to format a drawer in ODT code.
668 The function must accept two parameters:
669 NAME the drawer name, like \"LOGBOOK\"
670 CONTENTS the contents of the drawer.
672 The function should return the string to be exported.
674 The default value simply returns the value of CONTENTS."
675 :group
'org-export-odt
677 :package-version
'(Org .
"8.3")
683 (defcustom org-odt-format-headline-function
684 'org-odt-format-headline-default-function
685 "Function to format headline text.
687 This function will be called with 5 arguments:
688 TODO the todo keyword \(string or nil\).
689 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
690 PRIORITY the priority of the headline \(integer or nil\)
691 TEXT the main headline text \(string\).
692 TAGS the tags string, separated with colons \(string or nil\).
694 The function result will be used as headline text."
695 :group
'org-export-odt
697 :package-version
'(Org .
"8.3")
703 (defcustom org-odt-format-inlinetask-function
704 'org-odt-format-inlinetask-default-function
705 "Function called to format an inlinetask in ODT code.
707 The function must accept six parameters:
708 TODO the todo keyword, as a string
709 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
710 PRIORITY the inlinetask priority, as a string
711 NAME the inlinetask name, as a string.
712 TAGS the inlinetask tags, as a string.
713 CONTENTS the contents of the inlinetask, as a string.
715 The function should return the string to be exported."
716 :group
'org-export-odt
718 :package-version
'(Org .
"8.3")
724 (defcustom org-odt-with-latex org-export-with-latex
725 "Non-nil means process LaTeX math snippets.
727 When set, the exporter will process LaTeX environments and
730 This option can also be set with the +OPTIONS line,
731 e.g. \"tex:mathjax\". Allowed values are:
733 nil Ignore math snippets.
734 `verbatim' Keep everything in verbatim
735 `dvipng' Process the LaTeX fragments to images. This will also
736 include processing of non-math environments.
737 `imagemagick' Convert the LaTeX fragments to pdf files and use
738 imagemagick to convert pdf files to png files.
739 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
741 t Synonym for `mathjax'."
742 :group
'org-export-odt
744 :package-version
'(Org .
"8.0")
746 (const :tag
"Do not process math in any way" nil
)
747 (const :tag
"Use dvipng to make images" dvipng
)
748 (const :tag
"Use imagemagick to make images" imagemagick
)
749 (const :tag
"Use MathJax to display math" mathjax
)
750 (const :tag
"Leave math verbatim" verbatim
)))
755 (defcustom org-odt-inline-formula-rules
756 '(("file" .
"\\.\\(mathml\\|mml\\|odf\\)\\'"))
757 "Rules characterizing formula files that can be inlined into ODT.
759 A rule consists in an association whose key is the type of link
760 to consider, and value is a regexp that will be matched against
762 :group
'org-export-odt
764 :package-version
'(Org .
"8.0")
765 :type
'(alist :key-type
(string :tag
"Type")
766 :value-type
(regexp :tag
"Path")))
768 (defcustom org-odt-inline-image-rules
769 '(("file" .
"\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
770 "Rules characterizing image files that can be inlined into ODT.
772 A rule consists in an association whose key is the type of link
773 to consider, and value is a regexp that will be matched against
775 :group
'org-export-odt
777 :package-version
'(Org .
"8.3")
778 :type
'(alist :key-type
(string :tag
"Type")
779 :value-type
(regexp :tag
"Path")))
781 (defcustom org-odt-pixels-per-inch
96.0
782 "Scaling factor for converting images pixels to inches.
783 Use this for sizing of embedded images. See Info node `(org)
784 Images in ODT export' for more information."
786 :group
'org-export-odt
788 :package-version
'(Org .
"8.1"))
793 (defcustom org-odt-create-custom-styles-for-srcblocks t
794 "Whether custom styles for colorized source blocks be automatically created.
795 When this option is turned on, the exporter creates custom styles
796 for source blocks based on the advice of `htmlfontify'. Creation
797 of custom styles happen as part of `org-odt-hfy-face-to-css'.
799 When this option is turned off exporter does not create such
802 Use the latter option if you do not want the custom styles to be
803 based on your current display settings. It is necessary that the
804 styles.xml already contains needed styles for colorizing to work.
806 This variable is effective only if `org-odt-fontify-srcblocks' is
808 :group
'org-export-odt
812 (defcustom org-odt-fontify-srcblocks t
813 "Specify whether or not source blocks need to be fontified.
814 Turn this option on if you want to colorize the source code
815 blocks in the exported file. For colorization to work, you need
816 to make available an enhanced version of `htmlfontify' library."
818 :group
'org-export-odt
824 (defcustom org-odt-table-styles
825 '(("OrgEquation" "OrgEquation"
826 ((use-first-column-styles . t
)
827 (use-last-column-styles . t
)))
828 ("TableWithHeaderRowAndColumn" "Custom"
829 ((use-first-row-styles . t
)
830 (use-first-column-styles . t
)))
831 ("TableWithFirstRowandLastRow" "Custom"
832 ((use-first-row-styles . t
)
833 (use-last-row-styles . t
)))
834 ("GriddedTable" "Custom" nil
))
835 "Specify how Table Styles should be derived from a Table Template.
836 This is a list where each element is of the
837 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
839 TABLE-STYLE-NAME is the style associated with the table through
840 \"#+ATTR_ODT: :style TABLE-STYLE-NAME\" line.
842 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
843 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
844 below) that is included in `org-odt-content-template-file'.
846 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
848 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
850 TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
851 \"FirstRow\" | \"LastRow\" |
852 \"EvenRow\" | \"OddRow\" |
853 \"EvenColumn\" | \"OddColumn\" | \"\"
854 where \"+\" above denotes string concatenation.
856 TABLE-CELL-OPTIONS is an alist where each element is of the
857 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
858 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
859 `use-last-row-styles' |
860 `use-first-column-styles' |
861 `use-last-column-styles' |
862 `use-banding-rows-styles' |
863 `use-banding-columns-styles' |
864 `use-first-row-styles'
867 For example, with the following configuration
869 \(setq org-odt-table-styles
870 '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
871 \(\(use-first-row-styles . t\)
872 \(use-first-column-styles . t\)\)\)
873 \(\"TableWithHeaderColumns\" \"Custom\"
874 \(\(use-first-column-styles . t\)\)\)\)\)
876 1. A table associated with \"TableWithHeaderRowsAndColumns\"
877 style will use the following table-cell styles -
878 \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
879 \"CustomTableCell\" and the following paragraph styles
880 \"CustomFirstRowTableParagraph\",
881 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
884 2. A table associated with \"TableWithHeaderColumns\" style will
885 use the following table-cell styles -
886 \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
887 following paragraph styles
888 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
891 Note that TABLE-TEMPLATE-NAME corresponds to the
892 \"<table:table-template>\" elements contained within
893 \"<office:styles>\". The entries (TABLE-STYLE-NAME
894 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
895 \"table:template-name\" and \"table:use-first-row-styles\" etc
896 attributes of \"<table:table>\" element. Refer ODF-1.2
897 specification for more information. Also consult the
898 implementation filed under `org-odt-get-table-cell-styles'.
900 The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
901 formatting of numbered display equations. Do not delete this
902 style from the list."
903 :group
'org-export-odt
906 (const :tag
"None" nil
)
907 (repeat :tag
"Table Styles"
908 (list :tag
"Table Style Specification"
909 (string :tag
"Table Style Name")
910 (string :tag
"Table Template Name")
911 (alist :options
(use-first-row-styles
913 use-first-column-styles
914 use-last-column-styles
915 use-banding-rows-styles
916 use-banding-columns-styles
)
918 :value-type
(const :tag
"True" t
))))))
922 (defcustom org-odt-use-date-fields nil
923 "Non-nil, if timestamps should be exported as date fields.
925 When nil, export timestamps as plain text.
927 When non-nil, map `org-time-stamp-custom-formats' to a pair of
928 OpenDocument date-styles with names \"OrgDate1\" and \"OrgDate2\"
929 respectively. A timestamp with no time component is formatted
930 with style \"OrgDate1\" while one with explicit hour and minutes
931 is formatted with style \"OrgDate2\".
933 This feature is experimental. Most (but not all) of the common
934 %-specifiers in `format-time-string' are supported.
935 Specifically, locale-dependent specifiers like \"%c\", \"%x\" are
936 formatted as canonical Org timestamps. For finer control, avoid
939 Textual specifiers like \"%b\", \"%h\", \"%B\", \"%a\", \"%A\"
940 etc., are displayed by the application in the default language
941 and country specified in `org-odt-styles-file'. Note that the
942 default styles file uses language \"en\" and country \"GB\". You
943 can localize the week day and month strings in the exported
944 document by setting the default language and country either using
945 the application UI or through a custom styles file.
947 See `org-odt--build-date-styles' for implementation details."
948 :group
'org-export-odt
950 :package-version
'(Org .
"8.0")
955 ;;; Internal functions
959 (defun org-odt--format-timestamp (timestamp &optional end iso-date-p
)
960 (let* ((format-timestamp
961 (lambda (timestamp format
&optional end utc
)
963 (org-timestamp-format timestamp format end utc
)
964 (format-time-string format nil utc
))))
965 (has-time-p (or (not timestamp
)
966 (org-timestamp-has-time-p timestamp
)))
967 (iso-date (let ((format (if has-time-p
"%Y-%m-%dT%H:%M:%S"
968 "%Y-%m-%dT%H:%M:%S")))
969 (funcall format-timestamp timestamp format end
))))
970 (if iso-date-p iso-date
971 (let* ((style (if has-time-p
"OrgDate2" "OrgDate1"))
972 ;; LibreOffice does not care about end goes as content
973 ;; within the "<text:date>...</text:date>" field. The
974 ;; displayed date is automagically corrected to match the
975 ;; format requested by "style:data-style-name" attribute. So
976 ;; don't bother about formatting the date contents to be
977 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
978 ;; simple Org-style date should suffice.
979 (date (let* ((formats
980 (if org-display-custom-times
982 (car org-time-stamp-custom-formats
) 1 -
1)
984 (cdr org-time-stamp-custom-formats
) 1 -
1))
985 '("%Y-%m-%d %a" .
"%Y-%m-%d %a %H:%M")))
986 (format (if has-time-p
(cdr formats
) (car formats
))))
987 (funcall format-timestamp timestamp format end
)))
988 (repeater (let ((repeater-type (org-element-property
989 :repeater-type timestamp
))
990 (repeater-value (org-element-property
991 :repeater-value timestamp
))
992 (repeater-unit (org-element-property
993 :repeater-unit timestamp
)))
996 (catchup "++") (restart ".+") (cumulate "+"))
998 (number-to-string repeater-value
))
1000 (hour "h") (day "d") (week "w") (month "m")
1003 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1004 iso-date style date
)
1005 (and (not (string= repeater
"")) " ")
1010 (defun org-odt--frame (text width height style
&optional extra
1011 anchor-type
&rest title-and-desc
)
1014 (if width
(format " svg:width=\"%0.2fcm\"" width
) "")
1015 (if height
(format " svg:height=\"%0.2fcm\"" height
) "")
1017 (format " text:anchor-type=\"%s\"" (or anchor-type
"paragraph"))
1018 (format " draw:name=\"%s\""
1019 (car (org-odt-add-automatic-style "Frame"))))))
1021 "\n<draw:frame draw:style-name=\"%s\"%s>\n%s\n</draw:frame>"
1024 (let ((title (car title-and-desc
))
1025 (desc (cadr title-and-desc
)))
1027 (format "<svg:title>%s</svg:title>"
1028 (org-odt--encode-plain-text title t
)))
1030 (format "<svg:desc>%s</svg:desc>"
1031 (org-odt--encode-plain-text desc t
)))))))))
1034 ;;;; Library wrappers
1036 (defun org-odt--zip-extract (archive members target
)
1037 (when (atom members
) (setq members
(list members
)))
1038 (mapc (lambda (member)
1040 (let* ((--quote-file-name
1041 ;; This is shamelessly stolen from `archive-zip-extract'.
1043 (if (or (not (memq system-type
'(windows-nt ms-dos
)))
1044 (and (boundp 'w32-quote-process-args
)
1045 (null w32-quote-process-args
)))
1046 (shell-quote-argument name
)
1048 (target (funcall --quote-file-name target
))
1049 (archive (expand-file-name archive
))
1050 (archive-zip-extract
1051 (list "unzip" "-qq" "-o" "-d" target
))
1052 exit-code command-output
)
1053 (setq command-output
1055 (setq exit-code
(archive-zip-extract archive member
))
1057 (unless (zerop exit-code
)
1058 (message command-output
)
1059 (error "Extraction failed"))))
1064 (defun org-odt--target (text id
)
1067 (format "\n<text:bookmark-start text:name=\"OrgXref.%s\"/>" id
)
1068 (format "\n<text:bookmark text:name=\"%s\"/>" id
) text
1069 (format "\n<text:bookmark-end text:name=\"OrgXref.%s\"/>" id
))))
1073 (defun org-odt--textbox (text width height style
&optional
1076 (format "\n<draw:text-box %s>%s\n</draw:text-box>"
1077 (concat (format " fo:min-height=\"%0.2fcm\"" (or height
.2))
1079 (format " fo:min-width=\"%0.2fcm\"" (or width
.2))))
1081 width nil style extra anchor-type
))
1085 ;;;; Table of Contents
1087 (defun org-odt--format-toc (title entries depth
)
1088 "Return a table of contents.
1089 TITLE is the title of the table, as a string, or nil. ENTRIES is
1090 the contents of the table, as a string. DEPTH is an integer
1091 specifying the depth of the table."
1094 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1095 (format " <text:table-of-content-source text:outline-level=\"%d\">" depth
)
1098 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1102 (let ((levels (number-sequence 1 10)))
1107 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1108 <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
1109 <text:index-entry-chapter/>
1110 <text:index-entry-text/>
1111 <text:index-entry-link-end/>
1112 </text:table-of-content-entry-template>\n"
1113 level level
)) levels
""))
1115 </text:table-of-content-source>
1119 <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
1120 <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
1121 </text:index-title>\n"
1126 </text:table-of-content>"))
1128 (defun* org-odt-format-toc-headline
1129 (todo todo-type priority text tags
1130 &key level section-number headline-label
&allow-other-keys
)
1134 (and section-number
(concat section-number
". "))
1137 (let ((style (if (member todo org-done-keywords
)
1138 "OrgDone" "OrgTodo")))
1139 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1142 (let* ((style (format "OrgPriority-%s" priority
))
1143 (priority (format "[#%c]" priority
)))
1144 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1151 (format " <text:span text:style-name=\"%s\">[%s]</text:span>"
1156 "<text:span text:style-name=\"%s\">%s</text:span>"
1157 "OrgTag" tag
)) tags
" : "))))))
1158 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
1159 headline-label text
))
1161 (defun org-odt-toc (depth info
&optional scope
)
1162 "Build a table of contents.
1163 DEPTH is an integer specifying the depth of the table. INFO is
1164 a plist containing current export properties. Optional argument
1165 SCOPE, when non-nil, defines the scope of the table. Return the
1166 table of contents as a string, or nil."
1167 (assert (wholenump depth
))
1168 ;; When a headline is marked as a radio target, as in the example below:
1170 ;; ** <<<Some Heading>>>
1173 ;; suppress generation of radio targets. i.e., Radio targets are to
1174 ;; be marked as targets within /document body/ and *not* within
1175 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1176 ;; and one in the document body.
1178 ;; FIXME: Are there any other objects that need to be suppressed
1180 (let* ((headlines (org-export-collect-headlines info depth scope
))
1181 (backend (org-export-create-backend
1182 :parent
(org-export-backend-name (plist-get info
:back-end
))
1183 :transcoders
(mapcar
1184 (lambda (type) (cons type
(lambda (d c i
) c
)))
1185 (list 'radio-target
)))))
1187 (org-odt--format-toc
1188 (and (not scope
) (org-export-translate "Table of Contents" :utf-8 info
))
1191 (let* ((entry (org-odt-format-headline--wrap
1192 headline backend info
'org-odt-format-toc-headline
))
1193 (level (org-export-get-relative-level headline info
))
1194 (style (format "Contents_20_%d" level
)))
1195 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1201 ;;;; Document styles
1203 (defun org-odt-add-automatic-style (object-type &optional object-props
)
1204 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1205 OBJECT-PROPS is (typically) a plist created by passing
1206 \"#+ATTR_ODT: \" option of the object in question to
1207 `org-odt-parse-block-attributes'.
1209 Use `org-odt-object-counters' to generate an automatic
1210 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1211 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1213 (assert (stringp object-type
))
1214 (let* ((object (intern object-type
))
1216 (seqno (1+ (or (plist-get org-odt-object-counters seqvar
) 0)))
1217 (object-name (format "%s%d" object-type seqno
)) style-name
)
1218 (setq org-odt-object-counters
1219 (plist-put org-odt-object-counters seqvar seqno
))
1221 (setq style-name
(format "Org%s" object-name
))
1222 (setq org-odt-automatic-styles
1223 (plist-put org-odt-automatic-styles object
1224 (append (list (list style-name object-props
))
1225 (plist-get org-odt-automatic-styles object
)))))
1226 (cons object-name style-name
)))
1230 (defun org-odt--checkbox (item)
1231 "Return check-box string associated to ITEM."
1232 (let ((checkbox (org-element-property :checkbox item
)))
1233 (if (not checkbox
) ""
1234 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1235 "OrgCode" (case checkbox
1236 (on "[✓] ") ; CHECK MARK
1242 (defun org-odt--build-date-styles (fmt style
)
1243 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1244 ;; to modify the date fields. A date could be modified by
1245 ;; offsetting in days. That's about it. Also, date and time may
1246 ;; have to be emitted as two fields - a date field and a time field
1249 ;; One can add Form Controls to date and time fields so that they
1250 ;; can be easily modified. But then, the exported document will
1251 ;; become tightly coupled with LibreOffice and may not function
1252 ;; properly with other OpenDocument applications.
1254 ;; I have a strange feeling that Date styles are a bit flaky at the
1257 ;; The feature is experimental.
1258 (when (and fmt style
)
1260 '(("%A" .
"<number:day-of-week number:style=\"long\"/>")
1261 ("%B" .
"<number:month number:textual=\"true\" number:style=\"long\"/>")
1262 ("%H" .
"<number:hours number:style=\"long\"/>")
1263 ("%M" .
"<number:minutes number:style=\"long\"/>")
1264 ("%S" .
"<number:seconds number:style=\"long\"/>")
1265 ("%V" .
"<number:week-of-year/>")
1266 ("%Y" .
"<number:year number:style=\"long\"/>")
1267 ("%a" .
"<number:day-of-week number:style=\"short\"/>")
1268 ("%b" .
"<number:month number:textual=\"true\" number:style=\"short\"/>")
1269 ("%d" .
"<number:day number:style=\"long\"/>")
1270 ("%e" .
"<number:day number:style=\"short\"/>")
1271 ("%h" .
"<number:month number:textual=\"true\" number:style=\"short\"/>")
1272 ("%k" .
"<number:hours number:style=\"short\"/>")
1273 ("%m" .
"<number:month number:style=\"long\"/>")
1274 ("%p" .
"<number:am-pm/>")
1275 ("%y" .
"<number:year number:style=\"short\"/>")))
1276 (case-fold-search nil
)
1277 (re (mapconcat 'identity
(mapcar 'car fmt-alist
) "\\|"))
1278 match rpl
(start 0) (filler-beg 0) filler-end filler output
)
1281 (setq fmt
(replace-regexp-in-string (car pair
) (cdr pair
) fmt t t
)))
1282 '(("\\(?:%[[:digit:]]*N\\)" .
"") ; strip ns, us and ns
1283 ("%C" .
"Y") ; replace century with year
1285 ("%G" .
"Y") ; year corresponding to iso week
1286 ("%I" .
"%H") ; hour on a 12-hour clock
1289 ("%U\\|%W" .
"%V") ; week no. starting on Sun./Mon.
1290 ("%Z" .
"") ; time zone name
1291 ("%c" .
"%Y-%M-%d %a %H:%M" ) ; locale's date and time format
1293 ("%X" .
"%x" ) ; locale's pref. time format
1294 ("%j" .
"") ; day of the year
1295 ("%l" .
"%k") ; like %I blank-padded
1296 ("%s" .
"") ; no. of secs since 1970-01-01 00:00:00 +0000
1297 ("%n" .
"<text:line-break/>")
1298 ("%r" .
"%I:%M:%S %p")
1299 ("%t" .
"<text:tab/>")
1300 ("%u\\|%w" .
"") ; numeric day of week - Mon (1-7), Sun(0-6)
1301 ("%x" .
"%Y-%M-%d %a") ; locale's pref. time format
1302 ("%z" .
"") ; time zone in numeric form
1304 (while (string-match re fmt start
)
1305 (setq match
(match-string 0 fmt
))
1306 (setq rpl
(assoc-default match fmt-alist
))
1307 (setq start
(match-end 0))
1308 (setq filler-end
(match-beginning 0))
1309 (setq filler
(substring fmt
(prog1 filler-beg
1310 (setq filler-beg
(match-end 0)))
1312 (setq filler
(and (not (string= filler
""))
1313 (format "<number:text>%s</number:text>"
1314 (org-odt--encode-plain-text filler
))))
1315 (setq output
(concat output
"\n" filler
"\n" rpl
)))
1316 (setq filler
(substring fmt filler-beg
))
1317 (unless (string= filler
"")
1318 (setq output
(concat output
1319 (format "\n<number:text>%s</number:text>"
1320 (org-odt--encode-plain-text filler
)))))
1321 (format "\n<number:date-style style:name=\"%s\" %s>%s\n</number:date-style>"
1323 (concat " number:automatic-order=\"true\""
1324 " number:format-source=\"fixed\"")
1327 (defun org-odt-template (contents info
)
1328 "Return complete document string after ODT conversion.
1329 CONTENTS is the transcoded contents string. RAW-DATA is the
1330 original parsed data. INFO is a plist holding export options."
1332 (let ((title (org-export-data (plist-get info
:title
) info
))
1333 (subtitle (org-export-data (plist-get info
:subtitle
) info
))
1334 (author (let ((author (plist-get info
:author
)))
1335 (if (not author
) "" (org-export-data author info
))))
1336 (email (plist-get info
:email
))
1337 (keywords (or (plist-get info
:keywords
) ""))
1338 (description (or (plist-get info
:description
) "")))
1341 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
1342 <office:document-meta
1343 xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
1344 xmlns:xlink=\"http://www.w3.org/1999/xlink\"
1345 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
1346 xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
1347 xmlns:ooo=\"http://openoffice.org/2004/office\"
1348 office:version=\"1.2\">
1350 (format "<dc:creator>%s</dc:creator>\n" author
)
1351 (format "<meta:initial-creator>%s</meta:initial-creator>\n" author
)
1352 ;; Date, if required.
1353 (when (plist-get info
:with-date
)
1354 ;; Check if DATE is specified as an Org-timestamp. If yes,
1355 ;; include it as meta information. Otherwise, just use
1357 (let* ((date (let ((date (plist-get info
:date
)))
1358 (and (not (cdr date
))
1359 (eq (org-element-type (car date
)) 'timestamp
)
1361 (let ((iso-date (org-odt--format-timestamp date nil
'iso-date
)))
1363 (format "<dc:date>%s</dc:date>\n" iso-date
)
1364 (format "<meta:creation-date>%s</meta:creation-date>\n"
1366 (format "<meta:generator>%s</meta:generator>\n"
1367 (plist-get info
:creator
))
1368 (format "<meta:keyword>%s</meta:keyword>\n" keywords
)
1369 (format "<dc:subject>%s</dc:subject>\n" description
)
1370 (format "<dc:title>%s</dc:title>\n" title
)
1371 (when (org-string-nw-p subtitle
)
1373 "<meta:user-defined meta:name=\"subtitle\">%s</meta:user-defined>\n"
1376 " </office:meta>\n" "</office:document-meta>")
1377 nil
(concat org-odt-zip-dir
"meta.xml"))
1378 ;; Add meta.xml in to manifest.
1379 (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
1381 ;; Update styles file.
1382 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1383 ;; Write styles file.
1384 (let* ((styles-file (plist-get info
:odt-styles-file
))
1385 (styles-file (and styles-file
(read (org-trim styles-file
))))
1386 ;; Non-availability of styles.xml is not a critical
1387 ;; error. For now, throw an error.
1388 (styles-file (or styles-file
1389 (plist-get info
:odt-styles-file
)
1390 (expand-file-name "OrgOdtStyles.xml"
1392 (error "org-odt: Missing styles file?"))))
1394 ((listp styles-file
)
1395 (let ((archive (nth 0 styles-file
))
1396 (members (nth 1 styles-file
)))
1397 (org-odt--zip-extract archive members org-odt-zip-dir
)
1400 (when (org-file-image-p member
)
1401 (let* ((image-type (file-name-extension member
))
1402 (media-type (format "image/%s" image-type
)))
1403 (org-odt-create-manifest-file-entry media-type member
))))
1405 ((and (stringp styles-file
) (file-exists-p styles-file
))
1406 (let ((styles-file-type (file-name-extension styles-file
)))
1408 ((string= styles-file-type
"xml")
1409 (copy-file styles-file
(concat org-odt-zip-dir
"styles.xml") t
))
1410 ((member styles-file-type
'("odt" "ott"))
1411 (org-odt--zip-extract styles-file
"styles.xml" org-odt-zip-dir
)))))
1413 (error "Invalid specification of styles.xml file: %S"
1414 (plist-get info
:odt-styles-file
))))
1416 ;; create a manifest entry for styles.xml
1417 (org-odt-create-manifest-file-entry "text/xml" "styles.xml")
1419 ;; FIXME: Who is opening an empty styles.xml before this point?
1420 (with-current-buffer
1421 (find-file-noselect (concat org-odt-zip-dir
"styles.xml") t
)
1424 ;; Write custom styles for source blocks
1425 ;; Save STYLES used for colorizing of source blocks.
1426 ;; Update styles.xml with styles that were collected as part of
1427 ;; `org-odt-hfy-face-to-css' callbacks.
1428 (let ((styles (mapconcat (lambda (style) (format " %s\n" (cddr style
)))
1429 hfy-user-sheet-assoc
"")))
1431 (goto-char (point-min))
1432 (when (re-search-forward "</office:styles>" nil t
)
1433 (goto-char (match-beginning 0))
1434 (insert "\n<!-- Org Htmlfontify Styles -->\n" styles
"\n"))))
1436 ;; Update styles.xml - take care of outline numbering
1438 ;; Don't make automatic backup of styles.xml file. This setting
1439 ;; prevents the backed-up styles.xml file from being zipped in to
1440 ;; odt file. This is more of a hackish fix. Better alternative
1441 ;; would be to fix the zip command so that the output odt file
1442 ;; includes only the needed files and excludes any auto-generated
1443 ;; extra files like backups and auto-saves etc etc. Note that
1444 ;; currently the zip command zips up the entire temp directory so
1445 ;; that any auto-generated files created under the hood ends up in
1446 ;; the resulting odt file.
1447 (set (make-local-variable 'backup-inhibited
) t
)
1449 ;; Outline numbering is retained only upto LEVEL.
1450 ;; To disable outline numbering pass a LEVEL of 0.
1452 (goto-char (point-min))
1454 "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
1456 "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
1457 (while (re-search-forward regex nil t
)
1458 (unless (let ((sec-num (plist-get info
:section-numbers
))
1459 (level (string-to-number (match-string 2))))
1460 (if (wholenump sec-num
) (<= level sec-num
) sec-num
))
1461 (replace-match replacement t nil
))))
1463 ;; Update content.xml.
1465 (let* ( ;; `org-display-custom-times' should be accessed right
1466 ;; within the context of the Org buffer. So obtain its
1467 ;; value before moving on to temp-buffer context down below.
1469 (if org-display-custom-times
1470 (cons (substring (car org-time-stamp-custom-formats
) 1 -
1)
1471 (substring (cdr org-time-stamp-custom-formats
) 1 -
1))
1472 '("%Y-%M-%d %a" .
"%Y-%M-%d %a %H:%M"))))
1474 (insert-file-contents
1475 (or (plist-get info
:odt-content-template-file
)
1476 (expand-file-name "OrgOdtContentTemplate.xml"
1477 org-odt-styles-dir
)))
1478 ;; Write automatic styles.
1479 ;; - Position the cursor.
1480 (goto-char (point-min))
1481 (re-search-forward " </office:automatic-styles>" nil t
)
1482 (goto-char (match-beginning 0))
1483 ;; - Dump automatic table styles.
1484 (loop for
(style-name props
) in
1485 (plist-get org-odt-automatic-styles
'Table
) do
1486 (when (setq props
(or (plist-get props
:rel-width
) "96"))
1487 (insert (format org-odt-table-style-format style-name props
))))
1488 ;; - Dump date-styles.
1489 (when (plist-get info
:odt-use-date-fields
)
1490 (insert (org-odt--build-date-styles (car custom-time-fmts
)
1492 (org-odt--build-date-styles (cdr custom-time-fmts
)
1494 ;; Update display level.
1495 ;; - Remove existing sequence decls. Also position the cursor.
1496 (goto-char (point-min))
1497 (when (re-search-forward "<text:sequence-decls" nil t
)
1498 (delete-region (match-beginning 0)
1499 (re-search-forward "</text:sequence-decls>" nil nil
)))
1500 ;; Update sequence decls according to user preference.
1503 "\n<text:sequence-decls>\n%s\n</text:sequence-decls>"
1507 "<text:sequence-decl text:display-outline-level=\"%d\" text:name=\"%s\"/>"
1508 (plist-get info
:odt-display-outline-level
)
1510 org-odt-category-map-alist
"\n")))
1511 ;; Position the cursor to document body.
1512 (goto-char (point-min))
1513 (re-search-forward "</office:text>" nil nil
)
1514 (goto-char (match-beginning 0))
1516 ;; Preamble - Title, Author, Date etc.
1518 (let* ((title (and (plist-get info
:with-title
)
1519 (org-export-data (plist-get info
:title
) info
)))
1520 (subtitle (when title
1521 (org-export-data (plist-get info
:subtitle
) info
)))
1522 (author (and (plist-get info
:with-author
)
1523 (let ((auth (plist-get info
:author
)))
1524 (and auth
(org-export-data auth info
)))))
1525 (email (plist-get info
:email
))
1526 ;; Switch on or off above vars based on user settings
1527 (author (and (plist-get info
:with-author
) (or author email
)))
1528 (email (and (plist-get info
:with-email
) email
)))
1531 (when (org-string-nw-p title
)
1533 (format "\n<text:p text:style-name=\"%s\">%s</text:p>\n"
1534 "OrgTitle" (format "\n<text:title>%s</text:title>" title
))
1536 "\n<text:p text:style-name=\"OrgTitle\"/>\n"
1538 (when (org-string-nw-p subtitle
)
1540 (format "<text:p text:style-name=\"OrgSubtitle\">\n%s\n</text:p>\n"
1542 "<text:user-defined style:data-style-name=\"N0\" text:name=\"subtitle\">\n"
1544 "</text:user-defined>\n"))
1546 "<text:p text:style-name=\"OrgSubtitle\"/>\n"))))
1548 ((and author
(not email
))
1551 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1553 (format "<text:initial-creator>%s</text:initial-creator>" author
))
1555 "\n<text:p text:style-name=\"OrgSubtitle\"/>"))
1557 ;; Author and E-mail.
1560 "\n<text:p text:style-name=\"%s\">%s</text:p>"
1563 "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
1564 (concat "mailto:" email
)
1565 (format "<text:initial-creator>%s</text:initial-creator>" author
)))
1567 "\n<text:p text:style-name=\"OrgSubtitle\"/>")))
1568 ;; Date, if required.
1569 (when (plist-get info
:with-date
)
1570 (let* ((date (plist-get info
:date
))
1571 ;; Check if DATE is specified as a timestamp.
1572 (timestamp (and (not (cdr date
))
1573 (eq (org-element-type (car date
)) 'timestamp
)
1577 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1579 (if (and (plist-get info
:odt-use-date-fields
) timestamp
)
1580 (org-odt--format-timestamp (car date
))
1581 (org-export-data date info
)))
1583 "<text:p text:style-name=\"OrgSubtitle\"/>")))))))
1584 ;; Table of Contents
1585 (let* ((with-toc (plist-get info
:with-toc
))
1586 (depth (and with-toc
(if (wholenump with-toc
)
1588 (plist-get info
:headline-levels
)))))
1589 (when depth
(insert (or (org-odt-toc depth info
) ""))))
1593 (buffer-substring-no-properties (point-min) (point-max)))))
1597 ;;; Transcode Functions
1601 (defun org-odt-bold (bold contents info
)
1602 "Transcode BOLD from Org to ODT.
1603 CONTENTS is the text with bold markup. INFO is a plist holding
1604 contextual information."
1605 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1611 (defun org-odt-center-block (center-block contents info
)
1612 "Transcode a CENTER-BLOCK element from Org to ODT.
1613 CONTENTS holds the contents of the center block. INFO is a plist
1614 holding contextual information."
1620 (defun org-odt-clock (clock contents info
)
1621 "Transcode a CLOCK element from Org to ODT.
1622 CONTENTS is nil. INFO is a plist used as a communication
1624 (let ((timestamp (org-element-property :value clock
))
1625 (duration (org-element-property :duration clock
)))
1626 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1627 (if (eq (org-element-type (org-export-get-next-element clock info
))
1628 'clock
) "OrgClock" "OrgClockLastLine")
1630 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1631 "OrgClockKeyword" org-clock-string
)
1632 (org-odt-timestamp timestamp contents info
)
1633 (and duration
(format " (%s)" duration
))))))
1638 (defun org-odt-code (code contents info
)
1639 "Transcode a CODE object from Org to ODT.
1640 CONTENTS is nil. INFO is a plist used as a communication
1642 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1643 "OrgCode" (org-odt--encode-plain-text
1644 (org-element-property :value code
))))
1649 ;; Comments are ignored.
1654 ;; Comment Blocks are ignored.
1659 (defun org-odt-drawer (drawer contents info
)
1660 "Transcode a DRAWER element from Org to ODT.
1661 CONTENTS holds the contents of the block. INFO is a plist
1662 holding contextual information."
1663 (let* ((name (org-element-property :drawer-name drawer
))
1664 (output (funcall (plist-get info
:odt-format-drawer-function
)
1671 (defun org-odt-dynamic-block (dynamic-block contents info
)
1672 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1673 CONTENTS holds the contents of the block. INFO is a plist
1674 holding contextual information. See `org-export-data'."
1680 (defun org-odt-entity (entity contents info
)
1681 "Transcode an ENTITY object from Org to ODT.
1682 CONTENTS are the definition itself. INFO is a plist holding
1683 contextual information."
1684 (org-element-property :utf-8 entity
))
1689 (defun org-odt-example-block (example-block contents info
)
1690 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1691 CONTENTS is nil. INFO is a plist holding contextual information."
1692 (org-odt-format-code example-block info
))
1697 (defun org-odt-export-snippet (export-snippet contents info
)
1698 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1699 CONTENTS is nil. INFO is a plist holding contextual information."
1700 (when (eq (org-export-snippet-backend export-snippet
) 'odt
)
1701 (org-element-property :value export-snippet
)))
1706 (defun org-odt-export-block (export-block contents info
)
1707 "Transcode a EXPORT-BLOCK element from Org to ODT.
1708 CONTENTS is nil. INFO is a plist holding contextual information."
1709 (when (string= (org-element-property :type export-block
) "ODT")
1710 (org-remove-indentation (org-element-property :value export-block
))))
1715 (defun org-odt-fixed-width (fixed-width contents info
)
1716 "Transcode a FIXED-WIDTH element from Org to ODT.
1717 CONTENTS is nil. INFO is a plist holding contextual information."
1718 (org-odt-do-format-code (org-element-property :value fixed-width
) info
))
1721 ;;;; Footnote Definition
1723 ;; Footnote Definitions are ignored.
1726 ;;;; Footnote Reference
1728 (defun org-odt-footnote-reference (footnote-reference contents info
)
1729 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1730 CONTENTS is nil. INFO is a plist holding contextual information."
1731 (let ((--format-footnote-definition
1734 (setq n
(format "%d" n
))
1735 (let ((id (concat "fn" n
))
1736 (note-class "footnote")
1737 (par-style "Footnote"))
1739 "<text:note text:id=\"%s\" text:note-class=\"%s\">%s</text:note>"
1742 (format "<text:note-citation>%s</text:note-citation>" n
)
1743 (format "<text:note-body>%s</text:note-body>" def
)))))))
1744 (--format-footnote-reference
1747 (setq n
(format "%d" n
))
1748 (let ((note-class "footnote")
1750 (ref-name (concat "fn" n
)))
1752 "<text:span text:style-name=\"%s\">%s</text:span>"
1754 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1755 note-class ref-format ref-name n
)))))))
1757 ;; Insert separator between two footnotes in a row.
1758 (let ((prev (org-export-get-previous-element footnote-reference info
)))
1759 (and (eq (org-element-type prev
) 'footnote-reference
)
1760 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1761 "OrgSuperscript" ",")))
1762 ;; Transcode footnote reference.
1763 (let ((n (org-export-get-footnote-number footnote-reference info nil t
)))
1766 (org-export-footnote-first-reference-p footnote-reference info nil t
))
1767 (funcall --format-footnote-reference n
))
1768 ;; Inline definitions are secondary strings.
1769 ;; Non-inline footnotes definitions are full Org data.
1771 (let* ((raw (org-export-get-footnote-definition
1772 footnote-reference info
))
1774 (let ((def (org-trim
1775 (org-export-data-with-backend
1777 (org-export-create-backend
1780 '((paragraph .
(lambda (p c i
)
1781 (org-odt--format-paragraph
1785 "OrgFootnoteQuotations")))))
1787 (if (eq (org-element-type raw
) 'org-data
) def
1788 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1790 (funcall --format-footnote-definition n def
))))))))
1795 (defun org-odt-format-headline--wrap (headline backend info
1796 &optional format-function
1798 "Transcode a HEADLINE element using BACKEND.
1799 INFO is a plist holding contextual information."
1800 (setq backend
(or backend
(plist-get info
:back-end
)))
1801 (let* ((level (+ (org-export-get-relative-level headline info
)))
1802 (headline-number (org-export-get-headline-number headline info
))
1803 (section-number (and (org-export-numbered-headline-p headline info
)
1804 (mapconcat 'number-to-string
1805 headline-number
".")))
1806 (todo (and (plist-get info
:with-todo-keywords
)
1807 (let ((todo (org-element-property :todo-keyword headline
)))
1809 (org-export-data-with-backend todo backend info
)))))
1810 (todo-type (and todo
(org-element-property :todo-type headline
)))
1811 (priority (and (plist-get info
:with-priority
)
1812 (org-element-property :priority headline
)))
1813 (text (org-export-data-with-backend
1814 (org-element-property :title headline
) backend info
))
1815 (tags (and (plist-get info
:with-tags
)
1816 (org-export-get-tags headline info
)))
1817 (headline-label (org-export-get-reference headline info
))
1819 (if (functionp format-function
) format-function
1821 (lambda (todo todo-type priority text tags
1822 &key level section-number headline-label
1824 (funcall (plist-get info
:odt-format-headline-function
)
1825 todo todo-type priority text tags
))))))
1826 (apply format-function
1827 todo todo-type priority text tags
1828 :headline-label headline-label
:level level
1829 :section-number section-number extra-keys
)))
1831 (defun org-odt-headline (headline contents info
)
1832 "Transcode a HEADLINE element from Org to ODT.
1833 CONTENTS holds the contents of the headline. INFO is a plist
1834 holding contextual information."
1835 ;; Case 1: This is a footnote section: ignore it.
1836 (unless (org-element-property :footnote-section-p headline
)
1837 (let* ((text (org-export-data (org-element-property :title headline
) info
))
1838 ;; Create the headline text.
1839 (full-text (org-odt-format-headline--wrap headline nil info
))
1840 ;; Get level relative to current parsed data.
1841 (level (org-export-get-relative-level headline info
))
1842 (numbered (org-export-numbered-headline-p headline info
))
1843 ;; Get canonical label for the headline.
1844 (id (org-export-get-reference headline info
))
1847 (let ((id (org-element-property :ID headline
)))
1848 (if id
(org-odt--target "" (concat "ID-" id
)) "")))
1850 (anchored-title (org-odt--target full-text id
)))
1852 ;; Case 2. This is a deep sub-tree: export it as a list item.
1853 ;; Also export as items headlines for which no section
1854 ;; format has been found.
1855 ((org-export-low-level-p headline info
)
1856 ;; Build the real contents of the sub-tree.
1858 (and (org-export-first-sibling-p headline info
)
1859 (format "\n<text:list text:style-name=\"%s\" %s>"
1860 ;; Choose style based on list type.
1861 (if numbered
"OrgNumberedList" "OrgBulletedList")
1862 ;; If top-level list, re-start numbering. Otherwise,
1863 ;; continue numbering.
1864 (format "text:continue-numbering=\"%s\""
1865 (let* ((parent (org-export-get-parent-headline
1868 (org-export-low-level-p parent info
))
1870 (let ((headline-has-table-p
1871 (let ((section (assq 'section
(org-element-contents headline
))))
1872 (assq 'table
(and section
(org-element-contents section
))))))
1873 (format "\n<text:list-item>\n%s\n%s"
1875 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1877 (concat extra-targets anchored-title
))
1879 (if headline-has-table-p
1880 "</text:list-header>"
1881 "</text:list-item>")))
1882 (and (org-export-last-sibling-p headline info
)
1884 ;; Case 3. Standard headline. Export it as a section.
1888 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1889 (format "Heading_20_%s%s"
1890 level
(if numbered
"" "_unnumbered"))
1892 (if numbered
"false" "true")
1893 (concat extra-targets anchored-title
))
1896 (defun org-odt-format-headline-default-function
1897 (todo todo-type priority text tags
)
1898 "Default format function for a headline.
1899 See `org-odt-format-headline-function' for details."
1903 (let ((style (if (eq todo-type
'done
) "OrgDone" "OrgTodo")))
1904 (format "<text:span text:style-name=\"%s\">%s</text:span> " style todo
)))
1906 (let* ((style (format "OrgPriority-%s" priority
))
1907 (priority (format "[#%c]" priority
)))
1908 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1916 (format "<text:span text:style-name=\"%s\">[%s]</text:span>"
1917 "OrgTags" (mapconcat
1920 "<text:span text:style-name=\"%s\">%s</text:span>"
1921 "OrgTag" tag
)) tags
" : "))))))
1924 ;;;; Horizontal Rule
1926 (defun org-odt-horizontal-rule (horizontal-rule contents info
)
1927 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1928 CONTENTS is nil. INFO is a plist holding contextual information."
1929 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1930 "Horizontal_20_Line" ""))
1933 ;;;; Inline Babel Call
1935 ;; Inline Babel Calls are ignored.
1938 ;;;; Inline Src Block
1940 (defun org-odt--find-verb-separator (s)
1941 "Return a character not used in string S.
1942 This is used to choose a separator for constructs like \\verb."
1943 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1944 (loop for c across ll
1945 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
1946 return
(char-to-string c
))))
1948 (defun org-odt-inline-src-block (inline-src-block contents info
)
1949 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1950 CONTENTS holds the contents of the item. INFO is a plist holding
1951 contextual information."
1952 (let* ((org-lang (org-element-property :language inline-src-block
))
1953 (code (org-element-property :value inline-src-block
))
1954 (separator (org-odt--find-verb-separator code
)))
1960 (defun org-odt-inlinetask (inlinetask contents info
)
1961 "Transcode an INLINETASK element from Org to ODT.
1962 CONTENTS holds the contents of the block. INFO is a plist
1963 holding contextual information."
1965 (and (plist-get info
:with-todo-keywords
)
1966 (let ((todo (org-element-property :todo-keyword inlinetask
)))
1967 (and todo
(org-export-data todo info
)))))
1968 (todo-type (and todo
(org-element-property :todo-type inlinetask
)))
1969 (priority (and (plist-get info
:with-priority
)
1970 (org-element-property :priority inlinetask
)))
1971 (text (org-export-data (org-element-property :title inlinetask
) info
))
1972 (tags (and (plist-get info
:with-tags
)
1973 (org-export-get-tags inlinetask info
))))
1974 (funcall (plist-get info
:odt-format-inlinetask-function
)
1975 todo todo-type priority text tags contents
)))
1977 (defun org-odt-format-inlinetask-default-function
1978 (todo todo-type priority name tags contents
)
1979 "Default format function for a inlinetasks.
1980 See `org-odt-format-inlinetask-function' for details."
1981 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1985 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1986 "OrgInlineTaskHeading"
1987 (org-odt-format-headline-default-function
1988 todo todo-type priority name tags
))
1990 nil nil
"OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
1994 (defun org-odt-italic (italic contents info
)
1995 "Transcode ITALIC from Org to ODT.
1996 CONTENTS is the text with italic markup. INFO is a plist holding
1997 contextual information."
1998 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1999 "Emphasis" contents
))
2004 (defun org-odt-item (item contents info
)
2005 "Transcode an ITEM element from Org to ODT.
2006 CONTENTS holds the contents of the item. INFO is a plist holding
2007 contextual information."
2008 (let* ((plain-list (org-export-get-parent item
))
2009 (type (org-element-property :type plain-list
))
2010 (counter (org-element-property :counter item
))
2011 (tag (let ((tag (org-element-property :tag item
)))
2013 (concat (org-odt--checkbox item
)
2014 (org-export-data tag info
))))))
2016 ((ordered unordered descriptive-1 descriptive-2
)
2017 (format "\n<text:list-item>\n%s\n%s"
2019 (let* ((--element-has-a-table-p
2021 (lambda (element info
)
2022 (loop for el in
(org-element-contents element
)
2023 thereis
(eq (org-element-type el
) 'table
))))))
2025 ((funcall --element-has-a-table-p item info
)
2026 "</text:list-header>")
2027 (t "</text:list-item>")))))
2028 (t (error "Unknown list type: %S" type
)))))
2032 (defun org-odt-keyword (keyword contents info
)
2033 "Transcode a KEYWORD element from Org to ODT.
2034 CONTENTS is nil. INFO is a plist holding contextual
2036 (let ((key (org-element-property :key keyword
))
2037 (value (org-element-property :value keyword
)))
2039 ((string= key
"ODT") value
)
2040 ((string= key
"INDEX")
2043 ((string= key
"TOC")
2044 (let ((case-fold-search t
))
2046 ((org-string-match-p "\\<headlines\\>" value
)
2047 (let ((depth (or (and (string-match "\\<[0-9]+\\>" value
)
2048 (string-to-number (match-string 0 value
)))
2049 (plist-get info
:headline-levels
)))
2050 (localp (org-string-match-p "\\<local\\>" value
)))
2051 (org-odt-toc depth info
(and localp keyword
))))
2052 ((org-string-match-p "tables\\|figures\\|listings" value
)
2057 ;;;; Latex Environment
2060 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2061 ;; (defadvice org-format-latex-as-mathml ; FIXME
2062 ;; (after org-odt-protect-latex-fragment activate)
2063 ;; "Encode LaTeX fragment as XML.
2064 ;; Do this when translation to MathML fails."
2065 ;; (unless (> (length ad-return-value) 0)
2066 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2068 (defun org-odt-latex-environment (latex-environment contents info
)
2069 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2070 CONTENTS is nil. INFO is a plist holding contextual information."
2071 (let* ((latex-frag (org-remove-indentation
2072 (org-element-property :value latex-environment
))))
2073 (org-odt-do-format-code latex-frag info
)))
2078 ;; (when latex-frag ; FIXME
2079 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2080 ;; :description latex-frag)))
2082 ;; provide descriptions
2084 (defun org-odt-latex-fragment (latex-fragment contents info
)
2085 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2086 CONTENTS is nil. INFO is a plist holding contextual information."
2087 (let* ((latex-frag (org-element-property :value latex-fragment
))
2088 (processing-type (plist-get info
:with-latex
)))
2089 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2090 "OrgCode" (org-odt--encode-plain-text latex-frag t
))))
2095 (defun org-odt-line-break (line-break contents info
)
2096 "Transcode a LINE-BREAK object from Org to ODT.
2097 CONTENTS is nil. INFO is a plist holding contextual information."
2098 "<text:line-break/>")
2103 ;;;; Links :: Label references
2105 (defun org-odt--enumerate (element info
&optional predicate n
)
2106 (when predicate
(assert (funcall predicate element info
)))
2107 (let* ((--numbered-parent-headline-at-<=-n
2109 (lambda (element n info
)
2110 (loop for x in
(org-element-lineage element
)
2111 thereis
(and (eq (org-element-type x
) 'headline
)
2112 (<= (org-export-get-relative-level x info
) n
)
2113 (org-export-numbered-headline-p x info
)
2117 (lambda (element scope info
&optional predicate
)
2119 (org-element-map (or scope
(plist-get info
:parse-tree
))
2120 (org-element-type element
)
2122 (and (or (not predicate
) (funcall predicate el info
))
2126 info
'first-match
)))))
2127 (scope (funcall --numbered-parent-headline-at-
<=-n
2129 (or n
(plist-get info
:odt-display-outline-level
))
2131 (ordinal (funcall --enumerate element scope info predicate
))
2136 (mapconcat 'number-to-string
2137 (org-export-get-headline-number scope info
) "."))
2141 (number-to-string ordinal
))))
2144 (defun org-odt-format-label (element info op
)
2145 "Return a label for ELEMENT.
2147 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2148 element. INFO is a plist used as a communication channel. OP is
2149 either `definition' or `reference', depending on the purpose of
2150 the generated string.
2152 Return value is a string if OP is set to `reference' or a cons
2153 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2154 SHORT-CAPTION are strings."
2155 (assert (memq (org-element-type element
) '(link table src-block paragraph
)))
2156 (let* ((element-or-parent
2157 (case (org-element-type element
)
2158 (link (org-export-get-parent-element element
))
2160 ;; Get label and caption.
2161 (label (and (or (org-element-property :name element
)
2162 (org-element-property :name element-or-parent
))
2163 (org-export-get-reference element-or-parent info
)))
2164 (caption (let ((c (org-export-get-caption element-or-parent
)))
2165 (and c
(org-export-data c info
))))
2166 ;; FIXME: We don't use short-caption for now
2167 (short-caption nil
))
2168 (when (or label caption
)
2169 (let* ((default-category
2170 (case (org-element-type element
)
2172 (src-block "__Listing__")
2175 ((org-odt--enumerable-latex-image-p element info
)
2177 ((org-odt--enumerable-image-p element info
)
2179 ((org-odt--enumerable-formula-p element info
)
2181 (t (error "Don't know how to format label for link: %S"
2183 (t (error "Don't know how to format label for element type: %s"
2184 (org-element-type element
)))))
2186 (assert default-category
)
2187 (destructuring-bind (counter label-style category predicate
)
2188 (assoc-default default-category org-odt-category-map-alist
)
2189 ;; Compute sequence number of the element.
2190 (setq seqno
(org-odt--enumerate element info predicate
))
2191 ;; Localize category string.
2192 (setq category
(org-export-translate category
:utf-8 info
))
2194 ;; Case 1: Handle Label definition.
2198 ;; Sneak in a bookmark. The bookmark is used when the
2199 ;; labeled element is referenced with a link that
2200 ;; provides its own description.
2201 (format "\n<text:bookmark text:name=\"%s\"/>" label
)
2202 ;; Label definition: Typically formatted as below:
2203 ;; CATEGORY SEQ-NO: LONG CAPTION
2204 ;; with translation for correct punctuation.
2206 (org-export-translate
2207 (cadr (assoc-string label-style org-odt-label-styles t
))
2211 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2212 label counter counter seqno
))
2213 (?c .
,(or caption
"")))))
2215 ;; Case 2: Handle Label reference.
2217 (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t
)))
2220 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2223 (format-spec fmt2
`((?e .
,category
) (?n .
,seqno
))))))
2224 (t (error "Unknown %S on label" op
))))))))
2227 ;;;; Links :: Inline Images
2229 (defun org-odt--copy-image-file (path)
2230 "Returns the internal name of the file"
2231 (let* ((image-type (file-name-extension path
))
2232 (media-type (format "image/%s" image-type
))
2233 (target-dir "Images/")
2235 (format "%s%04d.%s" target-dir
2236 (incf org-odt-embedded-images-count
) image-type
)))
2237 (message "Embedding %s as %s..."
2238 (substring-no-properties path
) target-file
)
2240 (when (= 1 org-odt-embedded-images-count
)
2241 (make-directory (concat org-odt-zip-dir target-dir
))
2242 (org-odt-create-manifest-file-entry "" target-dir
))
2244 (copy-file path
(concat org-odt-zip-dir target-file
) 'overwrite
)
2245 (org-odt-create-manifest-file-entry media-type target-file
)
2248 (defun org-odt--image-size
2249 (file info
&optional user-width user-height scale dpi embed-as
)
2250 (let* ((--pixels-to-cms
2251 (function (lambda (pixels dpi
)
2252 (let ((cms-per-inch 2.54)
2253 (inches (/ pixels dpi
)))
2254 (* cms-per-inch inches
)))))
2257 (lambda (size-in-pixels dpi
)
2259 (cons (funcall --pixels-to-cms
(car size-in-pixels
) dpi
)
2260 (funcall --pixels-to-cms
(cdr size-in-pixels
) dpi
))))))
2261 (dpi (or dpi
(plist-get info
:odt-pixels-per-inch
)))
2262 (anchor-type (or embed-as
"paragraph"))
2263 (user-width (and (not scale
) user-width
))
2264 (user-height (and (not scale
) user-height
))
2267 (not (and user-height user-width
))
2270 (and (executable-find "identify")
2271 (let ((size-in-pixels
2272 (let ((dim (shell-command-to-string
2273 (format "identify -format \"%%w:%%h\" \"%s\""
2275 (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim
)
2276 (cons (string-to-number (match-string 1 dim
))
2277 (string-to-number (match-string 2 dim
)))))))
2278 (funcall --size-in-cms size-in-pixels dpi
)))
2280 (let ((size-in-pixels
2281 (ignore-errors ; Emacs could be in batch mode
2283 (image-size (create-image file
) 'pixels
))))
2284 (funcall --size-in-cms size-in-pixels dpi
))
2285 ;; Use hard-coded values.
2286 (cdr (assoc-string anchor-type
2287 org-odt-default-image-sizes-alist
))
2289 (error "Cannot determine image size, aborting"))))
2290 (width (car size
)) (height (cdr size
)))
2293 (setq width
(* width scale
) height
(* height scale
)))
2294 ((and user-height user-width
)
2295 (setq width user-width height user-height
))
2297 (setq width
(* user-height
(/ width height
)) height user-height
))
2299 (setq height
(* user-width
(/ height width
)) width user-width
))
2301 ;; ensure that an embedded image fits comfortably within a page
2302 (let ((max-width (car org-odt-max-image-size
))
2303 (max-height (cdr org-odt-max-image-size
)))
2304 (when (or (> width max-width
) (> height max-height
))
2305 (let* ((scale1 (/ max-width width
))
2306 (scale2 (/ max-height height
))
2307 (scale (min scale1 scale2
)))
2308 (setq width
(* scale width
) height
(* scale height
)))))
2309 (cons width height
)))
2311 (defun org-odt-link--inline-image (element info
)
2312 "Return ODT code for an inline image.
2313 LINK is the link pointing to the inline image. INFO is a plist
2314 used as a communication channel."
2315 (assert (eq (org-element-type element
) 'link
))
2316 (let* ((src (let* ((type (org-element-property :type element
))
2317 (raw-path (org-element-property :path element
)))
2318 (cond ((member type
'("http" "https"))
2319 (concat type
":" raw-path
))
2320 ((file-name-absolute-p raw-path
)
2321 (expand-file-name raw-path
))
2323 (src-expanded (if (file-name-absolute-p src
) src
2324 (expand-file-name src
(file-name-directory
2325 (plist-get info
:input-file
)))))
2327 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2328 (org-odt--copy-image-file src-expanded
)))
2329 ;; Extract attributes from #+ATTR_ODT line.
2330 (attr-from (case (org-element-type element
)
2331 (link (org-export-get-parent-element element
))
2333 ;; Convert attributes to a plist.
2334 (attr-plist (org-export-read-attribute :attr_odt attr-from
))
2335 ;; Handle `:anchor', `:style' and `:attributes' properties.
2337 (car (assoc-string (plist-get attr-plist
:anchor
)
2338 '(("as-char") ("paragraph") ("page")) t
)))
2340 (and user-frame-anchor
(plist-get attr-plist
:style
)))
2342 (and user-frame-anchor
(plist-get attr-plist
:attributes
)))
2344 (list user-frame-style user-frame-attrs user-frame-anchor
))
2345 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2347 ;; Handle `:width', `:height' and `:scale' properties. Read
2348 ;; them as numbers since we need them for computations.
2349 (size (org-odt--image-size
2351 (let ((width (plist-get attr-plist
:width
)))
2352 (and width
(read width
)))
2353 (let ((length (plist-get attr-plist
:length
)))
2354 (and length
(read length
)))
2355 (let ((scale (plist-get attr-plist
:scale
)))
2356 (and scale
(read scale
)))
2360 (width (car size
)) (height (cdr size
))
2361 (standalone-link-p (org-odt--standalone-link-p element info
))
2362 (embed-as (if standalone-link-p
"paragraph" "as-char"))
2363 (captions (org-odt-format-label element info
'definition
))
2364 (caption (car captions
)) (short-caption (cdr captions
))
2365 (entity (concat (and caption
"Captioned") embed-as
"Image"))
2366 ;; Check if this link was created by LaTeX-to-PNG converter.
2367 (replaces (org-element-property
2368 :replaces
(if (not standalone-link-p
) element
2369 (org-export-get-parent-element element
))))
2370 ;; If yes, note down the type of the element - LaTeX Fragment
2371 ;; or LaTeX environment. It will go in to frame title.
2372 (title (and replaces
(capitalize
2373 (symbol-name (org-element-type replaces
)))))
2375 ;; If yes, note down its contents. It will go in to frame
2376 ;; description. This quite useful for debugging.
2377 (desc (and replaces
(org-element-property :value replaces
))))
2378 (org-odt--render-image/formula entity href width height
2379 captions user-frame-params title desc
)))
2382 ;;;; Links :: Math formula
2384 (defun org-odt-link--inline-formula (element info
)
2385 (let* ((src (let* ((type (org-element-property :type element
))
2386 (raw-path (org-element-property :path element
)))
2388 ((file-name-absolute-p raw-path
)
2389 (expand-file-name raw-path
))
2391 (src-expanded (if (file-name-absolute-p src
) src
2392 (expand-file-name src
(file-name-directory
2393 (plist-get info
:input-file
)))))
2396 "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
2397 " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
2398 (file-name-directory (org-odt--copy-formula-file src-expanded
))))
2399 (standalone-link-p (org-odt--standalone-link-p element info
))
2400 (embed-as (if standalone-link-p
'paragraph
'character
))
2401 (captions (org-odt-format-label element info
'definition
))
2402 (caption (car captions
)) (short-caption (cdr captions
))
2403 ;; Check if this link was created by LaTeX-to-MathML
2405 (replaces (org-element-property
2406 :replaces
(if (not standalone-link-p
) element
2407 (org-export-get-parent-element element
))))
2408 ;; If yes, note down the type of the element - LaTeX Fragment
2409 ;; or LaTeX environment. It will go in to frame title.
2410 (title (and replaces
(capitalize
2411 (symbol-name (org-element-type replaces
)))))
2413 ;; If yes, note down its contents. It will go in to frame
2414 ;; description. This quite useful for debugging.
2415 (desc (and replaces
(org-element-property :value replaces
)))
2418 ((eq embed-as
'character
)
2419 (org-odt--render-image/formula
"InlineFormula" href width height
2420 nil nil title desc
))
2422 (let* ((equation (org-odt--render-image/formula
2423 "CaptionedDisplayFormula" href width height
2424 captions nil title desc
))
2426 (let* ((org-odt-category-map-alist
2427 '(("__MathFormula__" "Text" "math-label" "Equation"
2428 org-odt--enumerable-formula-p
))))
2429 (car (org-odt-format-label element info
'definition
)))))
2430 (concat equation
"<text:tab/>" label
))))))
2432 (defun org-odt--copy-formula-file (src-file)
2433 "Returns the internal name of the file"
2434 (let* ((target-dir (format "Formula-%04d/"
2435 (incf org-odt-embedded-formulas-count
)))
2436 (target-file (concat target-dir
"content.xml")))
2437 ;; Create a directory for holding formula file. Also enter it in
2439 (make-directory (concat org-odt-zip-dir target-dir
))
2440 (org-odt-create-manifest-file-entry
2441 "application/vnd.oasis.opendocument.formula" target-dir
"1.2")
2442 ;; Copy over the formula file from user directory to zip
2444 (message "Embedding %s as %s..." src-file target-file
)
2445 (let ((case-fold-search nil
))
2448 ((string-match "\\.\\(mathml\\|mml\\)\\'" src-file
)
2449 (copy-file src-file
(concat org-odt-zip-dir target-file
) 'overwrite
))
2450 ;; Case 2: OpenDocument formula.
2451 ((string-match "\\.odf\\'" src-file
)
2452 (org-odt--zip-extract src-file
"content.xml"
2453 (concat org-odt-zip-dir target-dir
)))
2454 (t (error "%s is not a formula file" src-file
))))
2455 ;; Enter the formula file in to manifest.
2456 (org-odt-create-manifest-file-entry "text/xml" target-file
)
2461 (defun org-odt--render-image/formula
(cfg-key href width height
&optional
2462 captions user-frame-params
2463 &rest title-and-desc
)
2464 (let* ((frame-cfg-alist
2465 ;; Each element of this alist is of the form (CFG-HANDLE
2466 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2468 ;; CFG-HANDLE is the key to the alist.
2470 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2471 ;; frame params for INNER-FRAME and OUTER-FRAME
2472 ;; respectively. See below.
2474 ;; Configurations that are meant to be applied to
2475 ;; non-captioned image/formula specifies no
2476 ;; OUTER-FRAME-PARAMS.
2480 ;; INNER-FRAME :: Frame that directly surrounds an
2483 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2484 ;; frame also contains the caption, if any.
2486 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2487 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2488 ;; that these are the last three arguments
2489 ;; to `org-odt--frame'.
2491 ;; Note that an un-captioned image/formula requires just an
2492 ;; INNER-FRAME, while a captioned image/formula requires
2493 ;; both an INNER and an OUTER-FRAME.
2494 '(("As-CharImage" ("OrgInlineImage" nil
"as-char"))
2495 ("ParagraphImage" ("OrgDisplayImage" nil
"paragraph"))
2496 ("PageImage" ("OrgPageImage" nil
"page"))
2497 ("CaptionedAs-CharImage"
2498 ("OrgCaptionedImage"
2499 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2500 ("OrgInlineImage" nil
"as-char"))
2501 ("CaptionedParagraphImage"
2502 ("OrgCaptionedImage"
2503 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2504 ("OrgImageCaptionFrame" nil
"paragraph"))
2505 ("CaptionedPageImage"
2506 ("OrgCaptionedImage"
2507 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2508 ("OrgPageImageCaptionFrame" nil
"page"))
2509 ("InlineFormula" ("OrgInlineFormula" nil
"as-char"))
2510 ("DisplayFormula" ("OrgDisplayFormula" nil
"as-char"))
2511 ("CaptionedDisplayFormula"
2512 ("OrgCaptionedFormula" nil
"paragraph")
2513 ("OrgFormulaCaptionFrame" nil
"paragraph"))))
2514 (caption (car captions
)) (short-caption (cdr captions
))
2515 ;; Retrieve inner and outer frame params, from configuration.
2516 (frame-cfg (assoc-string cfg-key frame-cfg-alist t
))
2517 (inner (nth 1 frame-cfg
))
2518 (outer (nth 2 frame-cfg
))
2519 ;; User-specified frame params (from #+ATTR_ODT spec)
2520 (user user-frame-params
)
2521 (--merge-frame-params (function
2522 (lambda (default user
)
2523 "Merge default and user frame params."
2524 (if (not user
) default
2525 (assert (= (length default
) 3))
2526 (assert (= (length user
) 3))
2529 collect
(or u d
)))))))
2531 ;; Case 1: Image/Formula has no caption.
2532 ;; There is only one frame, one that surrounds the image
2535 ;; Merge user frame params with that from configuration.
2536 (setq inner
(funcall --merge-frame-params inner user
))
2537 (apply 'org-odt--frame href width height
2538 (append inner title-and-desc
)))
2539 ;; Case 2: Image/Formula is captioned or labeled.
2540 ;; There are two frames: The inner one surrounds the
2541 ;; image or formula. The outer one contains the
2542 ;; caption/sequence number.
2544 ;; Merge user frame params with outer frame params.
2545 (setq outer
(funcall --merge-frame-params outer user
))
2546 ;; Short caption, if specified, goes as part of inner frame.
2547 (setq inner
(let ((frame-params (copy-sequence inner
)))
2548 (setcar (cdr frame-params
)
2552 (format " draw:name=\"%s\" " short-caption
))))
2554 (apply 'org-odt--textbox
2555 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2558 (apply 'org-odt--frame href width height
2559 (append inner title-and-desc
))
2561 width height outer
)))))
2563 (defun org-odt--enumerable-p (element info
)
2564 ;; Element should have a caption or label.
2565 (or (org-element-property :caption element
)
2566 (org-element-property :name element
)))
2568 (defun org-odt--enumerable-image-p (element info
)
2569 (org-odt--standalone-link-p
2571 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2572 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2575 (and (not (org-element-property :replaces p
))
2576 (or (org-element-property :caption p
)
2577 (org-element-property :name p
))))
2578 ;; Link should point to an image file.
2580 (assert (eq (org-element-type l
) 'link
))
2581 (org-export-inline-image-p l
(plist-get info
:odt-inline-image-rules
)))))
2583 (defun org-odt--enumerable-latex-image-p (element info
)
2584 (org-odt--standalone-link-p
2586 ;; Paragraph should have a caption or label. It SHOULD also be a
2587 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2590 (and (org-element-property :replaces p
)
2591 (or (org-element-property :caption p
)
2592 (org-element-property :name p
))))
2593 ;; Link should point to an image file.
2595 (assert (eq (org-element-type l
) 'link
))
2596 (org-export-inline-image-p l
(plist-get info
:odt-inline-image-rules
)))))
2598 (defun org-odt--enumerable-formula-p (element info
)
2599 (org-odt--standalone-link-p
2601 ;; Paragraph should have a caption or label.
2603 (or (org-element-property :caption p
)
2604 (org-element-property :name p
)))
2605 ;; Link should point to a MathML or ODF file.
2607 (assert (eq (org-element-type l
) 'link
))
2608 (org-export-inline-image-p l
(plist-get info
:odt-inline-formula-rules
)))))
2610 (defun org-odt--standalone-link-p (element info
&optional
2613 "Test if ELEMENT is a standalone link for the purpose ODT export.
2614 INFO is a plist holding contextual information.
2616 Return non-nil, if ELEMENT is of type paragraph satisfying
2617 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2618 is a link that satisfies LINK-PREDICATE.
2620 Return non-nil, if ELEMENT is of type link satisfying
2621 LINK-PREDICATE and its containing paragraph satisfies
2622 PARAGRAPH-PREDICATE in addition to having no other content save for
2623 leading and trailing whitespaces.
2625 Return nil, otherwise."
2626 (let ((p (case (org-element-type element
)
2628 (link (and (or (not link-predicate
)
2629 (funcall link-predicate element
))
2630 (org-export-get-parent element
)))
2632 (when (and p
(eq (org-element-type p
) 'paragraph
))
2633 (when (or (not paragraph-predicate
)
2634 (funcall paragraph-predicate p
))
2635 (let ((contents (org-element-contents p
)))
2636 (loop for x in contents
2637 with inline-image-count
= 0
2638 always
(case (org-element-type x
)
2640 (not (org-string-nw-p x
)))
2642 (and (or (not link-predicate
)
2643 (funcall link-predicate x
))
2644 (= (incf inline-image-count
) 1)))
2647 (defun org-odt-link--infer-description (destination info
)
2648 ;; DESTINATION is a headline or an element (like paragraph,
2649 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2651 ;; Note that labels that are attached to captioned entities - inline
2652 ;; images, math formulae and tables - get resolved as part of
2653 ;; `org-odt-format-label' and `org-odt--enumerate'.
2655 ;; Create a cross-reference to DESTINATION but make best-efforts to
2656 ;; create a *meaningful* description. Check item numbers, section
2657 ;; number and section title in that order.
2659 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2660 ;; FIXME: Handle footnote-definition footnote-reference?
2661 (let* ((genealogy (org-element-lineage destination
))
2662 (data (reverse genealogy
))
2663 (label (let ((type (org-element-type destination
)))
2664 (if (memq type
'(headline target
))
2665 (org-export-get-reference destination info
)
2666 (error "FIXME: Unable to resolve %S" destination
)))))
2668 (let* ( ;; Locate top-level list.
2671 when
(eq (org-element-type (car x
)) 'plain-list
)
2673 ;; Get list item nos.
2675 (loop for
(plain-list item . rest
) on top-level-list by
#'cddr
2676 until
(not (eq (org-element-type plain-list
) 'plain-list
))
2677 collect
(when (eq (org-element-property :type
2680 (1+ (length (org-export-get-previous-element
2682 ;; Locate top-most listified headline.
2683 (listified-headlines
2685 when
(and (eq (org-element-type (car x
)) 'headline
)
2686 (org-export-low-level-p (car x
) info
))
2688 ;; Get listified headline numbers.
2689 (listified-headline-nos
2690 (loop for el in listified-headlines
2691 when
(eq (org-element-type el
) 'headline
)
2692 collect
(when (org-export-numbered-headline-p el info
)
2693 (1+ (length (org-export-get-previous-element
2695 ;; Combine item numbers from both the listified headlines and
2696 ;; regular list items.
2698 ;; Case 1: Check if all the parents of list item are numbered.
2699 ;; If yes, link to the item proper.
2700 (let ((item-numbers (append listified-headline-nos item-numbers
)))
2701 (when (and item-numbers
(not (memq nil item-numbers
)))
2702 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2704 (mapconcat (lambda (n) (if (not n
) " "
2705 (concat (number-to-string n
) ".")))
2706 item-numbers
"")))))
2707 ;; Case 2: Locate a regular and numbered headline in the
2708 ;; hierarchy. Display its section number.
2711 ;; Test if destination is a numbered headline.
2712 (org-export-numbered-headline-p destination info
)
2713 (loop for el in
(cons destination genealogy
)
2714 when
(and (eq (org-element-type el
) 'headline
)
2715 (not (org-export-low-level-p el info
))
2716 (org-export-numbered-headline-p el info
))
2720 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2722 (mapconcat 'number-to-string
(org-export-get-headline-number
2723 headline info
) "."))))
2724 ;; Case 4: Locate a regular headline in the hierarchy. Display
2726 (let ((headline (loop for el in
(cons destination genealogy
)
2727 when
(and (eq (org-element-type el
) 'headline
)
2728 (not (org-export-low-level-p el info
)))
2732 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2734 (let ((title (org-element-property :title headline
)))
2735 (org-export-data title info
)))))
2738 (defun org-odt-link (link desc info
)
2739 "Transcode a LINK object from Org to ODT.
2741 DESC is the description part of the link, or the empty string.
2742 INFO is a plist holding contextual information. See
2744 (let* ((type (org-element-property :type link
))
2745 (raw-path (org-element-property :path link
))
2746 ;; Ensure DESC really exists, or set it to nil.
2747 (desc (and (not (string= desc
"")) desc
))
2748 (imagep (org-export-inline-image-p
2749 link
(plist-get info
:odt-inline-image-rules
)))
2751 ((member type
'("http" "https" "ftp" "mailto"))
2752 (concat type
":" raw-path
))
2753 ((string= type
"file") (org-export-file-uri raw-path
))
2755 ;; Convert & to & for correct XML representation
2756 (path (replace-regexp-in-string "&" "&" path
)))
2758 ;; Link type is handled by a special function.
2759 ((org-export-custom-protocol-maybe link desc
'odt
))
2761 ((and (not desc
) (org-export-inline-image-p
2762 link
(plist-get info
:odt-inline-image-rules
)))
2763 (org-odt-link--inline-image link info
))
2765 ((and (not desc
) (org-export-inline-image-p
2766 link
(plist-get info
:odt-inline-formula-rules
)))
2767 (org-odt-link--inline-formula link info
))
2768 ;; Radio target: Transcode target's contents and use them as
2769 ;; link's description.
2770 ((string= type
"radio")
2771 (let ((destination (org-export-resolve-radio-link link info
)))
2772 (if (not destination
) desc
2774 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2775 (org-export-get-reference destination info
)
2777 ;; Links pointing to a headline: Find destination and build
2778 ;; appropriate referencing command.
2779 ((member type
'("custom-id" "fuzzy" "id"))
2780 (let ((destination (if (string= type
"fuzzy")
2781 (org-export-resolve-fuzzy-link link info
)
2782 (org-export-resolve-id-link link info
))))
2783 (case (org-element-type destination
)
2784 ;; Case 1: Fuzzy link points nowhere.
2786 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2789 (org-export-data (org-element-property :raw-link link
)
2791 ;; Case 2: Fuzzy link points to a headline.
2793 ;; If there's a description, create a hyperlink.
2794 ;; Otherwise, try to provide a meaningful description.
2795 (if (not desc
) (org-odt-link--infer-description destination info
)
2797 (or (and (string= type
"custom-id")
2798 (org-element-property :CUSTOM_ID destination
))
2799 (org-export-get-reference destination info
))))
2801 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2803 ;; Case 3: Fuzzy link points to a target.
2805 ;; If there's a description, create a hyperlink.
2806 ;; Otherwise, try to provide a meaningful description.
2807 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2808 (org-export-get-reference destination info
)
2809 (or desc
(org-export-get-ordinal destination info
))))
2810 ;; Case 4: Fuzzy link points to some element (e.g., an
2811 ;; inline image, a math formula or a table).
2813 (let ((label-reference
2815 (org-odt-format-label destination info
'reference
))))
2817 ((not label-reference
)
2818 (org-odt-link--infer-description destination info
))
2819 ;; LINK has no description. Create
2820 ;; a cross-reference showing entity's sequence
2822 ((not desc
) label-reference
)
2823 ;; LINK has description. Insert a hyperlink with
2824 ;; user-provided description.
2827 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2828 (org-export-get-reference destination info
)
2830 ;; Coderef: replace link with the reference name or the
2831 ;; equivalent line number.
2832 ((string= type
"coderef")
2833 (let* ((line-no (format "%d" (org-export-resolve-coderef path info
)))
2834 (href (concat "coderef-" path
)))
2836 (org-export-get-coderef-format path desc
)
2838 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2840 ;; External link with a description part.
2842 (let ((link-contents (org-element-contents link
)))
2843 ;; Check if description is a link to an inline image.
2844 (if (and (not (cdr link-contents
))
2845 (let ((desc-element (car link-contents
)))
2846 (and (eq (org-element-type desc-element
) 'link
)
2847 (org-export-inline-image-p
2849 (plist-get info
:odt-inline-image-rules
)))))
2850 ;; Format link as a clickable image.
2851 (format "\n<draw:a xlink:type=\"simple\" xlink:href=\"%s\">\n%s\n</draw:a>"
2853 ;; Otherwise, format it as a regular link.
2854 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2856 ;; External link without a description part.
2858 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2860 ;; No path, only description. Try to do something useful.
2861 (t (format "<text:span text:style-name=\"%s\">%s</text:span>"
2862 "Emphasis" desc
)))))
2867 (defun org-odt-node-property (node-property contents info
)
2868 "Transcode a NODE-PROPERTY element from Org to ODT.
2869 CONTENTS is nil. INFO is a plist holding contextual
2871 (org-odt--encode-plain-text
2873 (org-element-property :key node-property
)
2874 (let ((value (org-element-property :value node-property
)))
2875 (if value
(concat " " value
) "")))))
2879 (defun org-odt--paragraph-style (paragraph)
2880 "Return style of PARAGRAPH.
2881 Style is a symbol among `quoted', `centered' and nil."
2882 (let ((up paragraph
))
2883 (while (and (setq up
(org-element-property :parent up
))
2884 (not (memq (org-element-type up
)
2885 '(center-block quote-block section
)))))
2886 (case (org-element-type up
)
2887 (center-block 'centered
)
2888 (quote-block 'quoted
))))
2890 (defun org-odt--format-paragraph (paragraph contents info default center quote
)
2891 "Format paragraph according to given styles.
2892 PARAGRAPH is a paragraph type element. CONTENTS is the
2893 transcoded contents of that paragraph, as a string. INFO is
2894 a plist used as a communication channel. DEFAULT, CENTER and
2895 QUOTE are, respectively, style to use when paragraph belongs to
2896 no special environment, a center block, or a quote block."
2897 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2898 (case (org-odt--paragraph-style paragraph
)
2901 (otherwise default
))
2902 ;; If PARAGRAPH is a leading paragraph in an item that has
2903 ;; a checkbox, splice checkbox and paragraph contents
2905 (concat (let ((parent (org-element-property :parent paragraph
)))
2906 (and (eq (org-element-type parent
) 'item
)
2907 (not (org-export-get-previous-element paragraph info
))
2908 (org-odt--checkbox parent
)))
2911 (defun org-odt-paragraph (paragraph contents info
)
2912 "Transcode a PARAGRAPH element from Org to ODT.
2913 CONTENTS is the contents of the paragraph, as a string. INFO is
2914 the plist used as a communication channel."
2915 (org-odt--format-paragraph
2916 paragraph contents info
2917 (or (org-element-property :style paragraph
) "Text_20_body")
2924 (defun org-odt-plain-list (plain-list contents info
)
2925 "Transcode a PLAIN-LIST element from Org to ODT.
2926 CONTENTS is the contents of the list. INFO is a plist holding
2927 contextual information."
2928 (format "\n<text:list text:style-name=\"%s\" %s>\n%s</text:list>"
2929 ;; Choose style based on list type.
2930 (case (org-element-property :type plain-list
)
2931 (ordered "OrgNumberedList")
2932 (unordered "OrgBulletedList")
2933 (descriptive-1 "OrgDescriptionList")
2934 (descriptive-2 "OrgDescriptionList"))
2935 ;; If top-level list, re-start numbering. Otherwise,
2936 ;; continue numbering.
2937 (format "text:continue-numbering=\"%s\""
2938 (let* ((parent (org-export-get-parent plain-list
)))
2939 (if (and parent
(eq (org-element-type parent
) 'item
))
2945 (defun org-odt--encode-tabs-and-spaces (line)
2946 (replace-regexp-in-string
2947 "\\([\t]\\|\\([ ]+\\)\\)"
2950 ((string= s
"\t") "<text:tab/>")
2951 (t (let ((n (length s
)))
2954 ((> n
1) (concat " " (format "<text:s text:c=\"%d\"/>" (1- n
))))
2958 (defun org-odt--encode-plain-text (text &optional no-whitespace-filling
)
2961 (setq text
(replace-regexp-in-string (car pair
) (cdr pair
) text t t
)))
2962 '(("&" .
"&") ("<" .
"<") (">" .
">")))
2963 (if no-whitespace-filling text
2964 (org-odt--encode-tabs-and-spaces text
)))
2966 (defun org-odt-plain-text (text info
)
2967 "Transcode a TEXT string from Org to ODT.
2968 TEXT is the string to transcode. INFO is a plist holding
2969 contextual information."
2970 (let ((output text
))
2971 ;; Protect &, < and >.
2972 (setq output
(org-odt--encode-plain-text output t
))
2973 ;; Handle smart quotes. Be sure to provide original string since
2974 ;; OUTPUT may have been modified.
2975 (when (plist-get info
:with-smart-quotes
)
2976 (setq output
(org-export-activate-smart-quotes output
:utf-8 info text
)))
2977 ;; Convert special strings.
2978 (when (plist-get info
:with-special-strings
)
2982 (replace-regexp-in-string (car pair
) (cdr pair
) output t nil
)))
2983 org-odt-special-string-regexps
))
2984 ;; Handle break preservation if required.
2985 (when (plist-get info
:preserve-breaks
)
2986 (setq output
(replace-regexp-in-string
2987 "\\(\\\\\\\\\\)?[ \t]*\n" "<text:line-break/>" output t
)))
2994 (defun org-odt-planning (planning contents info
)
2995 "Transcode a PLANNING element from Org to ODT.
2996 CONTENTS is nil. INFO is a plist used as a communication
2998 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3001 (let ((closed (org-element-property :closed planning
)))
3004 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3005 "OrgClosedKeyword" org-closed-string
)
3006 (org-odt-timestamp closed contents info
))))
3007 (let ((deadline (org-element-property :deadline planning
)))
3010 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3011 "OrgDeadlineKeyword" org-deadline-string
)
3012 (org-odt-timestamp deadline contents info
))))
3013 (let ((scheduled (org-element-property :scheduled planning
)))
3016 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3017 "OrgScheduledKeyword" org-deadline-string
)
3018 (org-odt-timestamp scheduled contents info
)))))))
3021 ;;;; Property Drawer
3023 (defun org-odt-property-drawer (property-drawer contents info
)
3024 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3025 CONTENTS holds the contents of the drawer. INFO is a plist
3026 holding contextual information."
3027 (and (org-string-nw-p contents
)
3028 (format "<text:p text:style-name=\"OrgFixedWidthBlock\">%s</text:p>"
3034 (defun org-odt-quote-block (quote-block contents info
)
3035 "Transcode a QUOTE-BLOCK element from Org to ODT.
3036 CONTENTS holds the contents of the block. INFO is a plist
3037 holding contextual information."
3043 (defun org-odt-format-section (text style
&optional name
)
3044 (let ((default-name (car (org-odt-add-automatic-style "Section"))))
3045 (format "\n<text:section text:style-name=\"%s\" %s>\n%s\n</text:section>"
3047 (format "text:name=\"%s\"" (or name default-name
))
3051 (defun org-odt-section (section contents info
) ; FIXME
3052 "Transcode a SECTION element from Org to ODT.
3053 CONTENTS holds the contents of the section. INFO is a plist
3054 holding contextual information."
3059 (defun org-odt-radio-target (radio-target text info
)
3060 "Transcode a RADIO-TARGET object from Org to ODT.
3061 TEXT is the text of the target. INFO is a plist holding
3062 contextual information."
3063 (org-odt--target text
(org-export-get-reference radio-target info
)))
3068 (defun org-odt-special-block (special-block contents info
)
3069 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3070 CONTENTS holds the contents of the block. INFO is a plist
3071 holding contextual information."
3072 (let ((type (org-element-property :type special-block
))
3073 (attributes (org-export-read-attribute :attr_odt special-block
)))
3076 ((string= type
"annotation")
3077 (let* ((author (or (plist-get attributes
:author
)
3078 (let ((author (plist-get info
:author
)))
3079 (and author
(org-export-data author info
)))))
3080 (date (or (plist-get attributes
:date
)
3081 ;; FIXME: Is `car' right thing to do below?
3082 (car (plist-get info
:date
)))))
3083 (format "\n<text:p>%s</text:p>"
3084 (format "<office:annotation>\n%s\n</office:annotation>"
3087 (format "<dc:creator>%s</dc:creator>" author
))
3089 (format "<dc:date>%s</dc:date>"
3090 (org-odt--format-timestamp date nil
'iso-date
)))
3093 ((string= type
"textbox")
3094 (let ((width (plist-get attributes
:width
))
3095 (height (plist-get attributes
:height
))
3096 (style (plist-get attributes
:style
))
3097 (extra (plist-get attributes
:extra
))
3098 (anchor (plist-get attributes
:anchor
)))
3099 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3100 "Text_20_body" (org-odt--textbox contents width height
3101 style extra anchor
))))
3107 (defun org-odt-hfy-face-to-css (fn)
3108 "Create custom style for face FN.
3109 When FN is the default face, use its foreground and background
3110 properties to create \"OrgSrcBlock\" paragraph style. Otherwise
3111 use its color attribute to create a character style whose name
3112 is obtained from FN. Currently all attributes of FN other than
3115 The style name for a face FN is derived using the following
3116 operations on the face name in that order - de-dash, CamelCase
3117 and prefix with \"OrgSrc\". For example,
3118 `font-lock-function-name-face' is associated with
3119 \"OrgSrcFontLockFunctionNameFace\"."
3120 (let* ((css-list (hfy-face-to-style fn
))
3121 (style-name (concat "OrgSrc"
3123 'capitalize
(split-string
3124 (hfy-face-or-def-to-name fn
) "-")
3126 (color-val (cdr (assoc "color" css-list
)))
3127 (background-color-val (cdr (assoc "background" css-list
)))
3128 (style (and org-odt-create-custom-styles-for-srcblocks
3131 (format org-odt-src-block-paragraph-format
3132 background-color-val color-val
))
3136 <style:style style:name=\"%s\" style:family=\"text\">
3137 <style:text-properties fo:color=\"%s\"/>
3138 </style:style>" style-name color-val
))))))
3139 (cons style-name style
)))
3141 (defun org-odt-htmlfontify-string (line)
3142 (let* ((hfy-html-quote-regex "\\([<\"&> ]\\)")
3143 (hfy-html-quote-map '(("\"" """)
3148 (" " "<text:tab/>")))
3149 (hfy-face-to-css 'org-odt-hfy-face-to-css
)
3150 (hfy-optimizations-1 (copy-sequence hfy-optimizations
))
3151 (hfy-optimizations (add-to-list 'hfy-optimizations-1
3153 (hfy-begin-span-handler
3154 (lambda (style text-block text-id text-begins-block-p
)
3155 (insert (format "<text:span text:style-name=\"%s\">" style
))))
3156 (hfy-end-span-handler (lambda nil
(insert "</text:span>"))))
3157 (org-no-warnings (htmlfontify-string line
))))
3159 (defun org-odt-do-format-code
3160 (code info
&optional lang refs retain-labels num-start
)
3161 (let* ((lang (or (assoc-default lang org-src-lang-modes
) lang
))
3162 (lang-mode (and lang
(intern (format "%s-mode" lang
))))
3163 (code-lines (org-split-string code
"\n"))
3164 (code-length (length code-lines
))
3165 (use-htmlfontify-p (and (functionp lang-mode
)
3166 (plist-get info
:odt-fontify-srcblocks
)
3167 (require 'htmlfontify nil t
)
3168 (fboundp 'htmlfontify-string
)))
3169 (code (if (not use-htmlfontify-p
) code
3175 (fontifier (if use-htmlfontify-p
'org-odt-htmlfontify-string
3176 'org-odt--encode-plain-text
))
3177 (par-style (if use-htmlfontify-p
"OrgSrcBlock"
3178 "OrgFixedWidthBlock"))
3180 (assert (= code-length
(length (org-split-string code
"\n"))))
3182 (org-export-format-code
3184 (lambda (loc line-num ref
)
3186 (concat par-style
(and (= (incf i
) code-length
) "LastLine")))
3188 (setq loc
(concat loc
(and ref retain-labels
(format " (%s)" ref
))))
3189 (setq loc
(funcall fontifier loc
))
3191 (setq loc
(org-odt--target loc
(concat "coderef-" ref
))))
3193 (setq loc
(format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3195 (if (not line-num
) loc
3196 (format "\n<text:list-item>%s\n</text:list-item>" loc
)))
3199 ((not num-start
) code
)
3202 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3203 " text:continue-numbering=\"false\"" code
))
3206 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3207 " text:continue-numbering=\"true\"" code
)))))
3209 (defun org-odt-format-code (element info
)
3210 (let* ((lang (org-element-property :language element
))
3211 ;; Extract code and references.
3212 (code-info (org-export-unravel-code element
))
3213 (code (car code-info
))
3214 (refs (cdr code-info
))
3215 ;; Does the src block contain labels?
3216 (retain-labels (org-element-property :retain-labels element
))
3217 ;; Does it have line numbers?
3218 (num-start (case (org-element-property :number-lines element
)
3219 (continued (org-export-get-loc element info
))
3221 (org-odt-do-format-code code info lang refs retain-labels num-start
)))
3223 (defun org-odt-src-block (src-block contents info
)
3224 "Transcode a SRC-BLOCK element from Org to ODT.
3225 CONTENTS holds the contents of the item. INFO is a plist holding
3226 contextual information."
3227 (let* ((lang (org-element-property :language src-block
))
3228 (attributes (org-export-read-attribute :attr_odt src-block
))
3229 (captions (org-odt-format-label src-block info
'definition
))
3230 (caption (car captions
)) (short-caption (cdr captions
)))
3233 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3235 (let ((--src-block (org-odt-format-code src-block info
)))
3236 (if (not (plist-get attributes
:textbox
)) --src-block
3237 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3239 (org-odt--textbox --src-block nil nil nil
)))))))
3242 ;;;; Statistics Cookie
3244 (defun org-odt-statistics-cookie (statistics-cookie contents info
)
3245 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3246 CONTENTS is nil. INFO is a plist holding contextual information."
3247 (let ((cookie-value (org-element-property :value statistics-cookie
)))
3248 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3249 "OrgCode" cookie-value
)))
3254 (defun org-odt-strike-through (strike-through contents info
)
3255 "Transcode STRIKE-THROUGH from Org to ODT.
3256 CONTENTS is the text with strike-through markup. INFO is a plist
3257 holding contextual information."
3258 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3259 "Strikethrough" contents
))
3264 (defun org-odt-subscript (subscript contents info
)
3265 "Transcode a SUBSCRIPT object from Org to ODT.
3266 CONTENTS is the contents of the object. INFO is a plist holding
3267 contextual information."
3268 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3269 "OrgSubscript" contents
))
3274 (defun org-odt-superscript (superscript contents info
)
3275 "Transcode a SUPERSCRIPT object from Org to ODT.
3276 CONTENTS is the contents of the object. INFO is a plist holding
3277 contextual information."
3278 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3279 "OrgSuperscript" contents
))
3284 (defun org-odt-table-style-spec (element info
)
3285 (let* ((table (org-export-get-parent-table element
))
3286 (table-attributes (org-export-read-attribute :attr_odt table
))
3287 (table-style (plist-get table-attributes
:style
)))
3288 (assoc table-style
(plist-get info
:odt-table-styles
))))
3290 (defun org-odt-get-table-cell-styles (table-cell info
)
3291 "Retrieve styles applicable to a table cell.
3292 R and C are (zero-based) row and column numbers of the table
3293 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3294 applicable to the current table. It is nil if the table is not
3295 associated with any style attributes.
3297 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3299 When STYLE-SPEC is nil, style the table cell the conventional way
3300 - choose cell borders based on row and column groupings and
3301 choose paragraph alignment based on `org-col-cookies' text
3303 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3305 When STYLE-SPEC is non-nil, ignore the above cookie and return
3306 styles congruent with the ODF-1.2 specification."
3307 (let* ((table-cell-address (org-export-table-cell-address table-cell info
))
3308 (r (car table-cell-address
)) (c (cdr table-cell-address
))
3309 (style-spec (org-odt-table-style-spec table-cell info
))
3310 (table-dimensions (org-export-table-dimensions
3311 (org-export-get-parent-table table-cell
)
3314 ;; LibreOffice - particularly the Writer - honors neither table
3315 ;; templates nor custom table-cell styles. Inorder to retain
3316 ;; inter-operability with LibreOffice, only automatic styles are
3317 ;; used for styling of table-cells. The current implementation is
3318 ;; congruent with ODF-1.2 specification and hence is
3319 ;; future-compatible.
3321 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3322 ;; which recognizes as many as 16 different cell types - is much
3323 ;; richer. Unfortunately it is NOT amenable to easy configuration
3325 (let* ((template-name (nth 1 style-spec
))
3326 (cell-style-selectors (nth 2 style-spec
))
3329 ((and (cdr (assoc 'use-first-column-styles cell-style-selectors
))
3330 (= c
0)) "FirstColumn")
3331 ((and (cdr (assoc 'use-last-column-styles cell-style-selectors
))
3332 (= (1+ c
) (cdr table-dimensions
)))
3334 ((and (cdr (assoc 'use-first-row-styles cell-style-selectors
))
3335 (= r
0)) "FirstRow")
3336 ((and (cdr (assoc 'use-last-row-styles cell-style-selectors
))
3337 (= (1+ r
) (car table-dimensions
)))
3339 ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors
))
3340 (= (% r
2) 1)) "EvenRow")
3341 ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors
))
3342 (= (% r
2) 0)) "OddRow")
3343 ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors
))
3344 (= (% c
2) 1)) "EvenColumn")
3345 ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors
))
3346 (= (% c
2) 0)) "OddColumn")
3348 (concat template-name cell-type
)))))
3350 (defun org-odt-table-cell (table-cell contents info
)
3351 "Transcode a TABLE-CELL element from Org to ODT.
3352 CONTENTS is nil. INFO is a plist used as a communication
3354 (let* ((table-cell-address (org-export-table-cell-address table-cell info
))
3355 (r (car table-cell-address
))
3356 (c (cdr table-cell-address
))
3357 (horiz-span (or (org-export-table-cell-width table-cell info
) 0))
3358 (table-row (org-export-get-parent table-cell
))
3359 (custom-style-prefix (org-odt-get-table-cell-styles
3363 (and custom-style-prefix
3364 (format "%sTableParagraph" custom-style-prefix
))
3367 ((and (= 1 (org-export-table-row-group table-row info
))
3368 (org-export-table-has-header-p
3369 (org-export-get-parent-table table-row
) info
))
3371 ((let* ((table (org-export-get-parent-table table-cell
))
3372 (table-attrs (org-export-read-attribute :attr_odt table
))
3373 (table-header-columns
3374 (let ((cols (plist-get table-attrs
:header-columns
)))
3375 (and cols
(read cols
)))))
3376 (<= c
(cond ((wholenump table-header-columns
)
3377 (- table-header-columns
1))
3378 (table-header-columns 0)
3381 (t "OrgTableContents"))
3382 (capitalize (symbol-name (org-export-table-cell-alignment
3383 table-cell info
))))))
3386 (and custom-style-prefix
(format "%sTableCell"
3387 custom-style-prefix
))
3390 (when (or (org-export-table-row-starts-rowgroup-p table-row info
)
3392 (when (org-export-table-row-ends-rowgroup-p table-row info
) "B")
3393 (when (and (org-export-table-cell-starts-colgroup-p table-cell info
)
3394 (not (zerop c
)) ) "L"))))
3397 (format " table:style-name=\"%s\"" cell-style-name
)
3398 (and (> horiz-span
0)
3399 (format " table:number-columns-spanned=\"%d\""
3400 (1+ horiz-span
))))))
3401 (unless contents
(setq contents
""))
3403 (assert paragraph-style
)
3404 (format "\n<table:table-cell%s>\n%s\n</table:table-cell>"
3406 (let ((table-cell-contents (org-element-contents table-cell
)))
3407 (if (memq (org-element-type (car table-cell-contents
))
3408 org-element-all-elements
)
3410 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3411 paragraph-style contents
))))
3413 (dotimes (i horiz-span s
)
3414 (setq s
(concat s
"\n<table:covered-table-cell/>"))))
3420 (defun org-odt-table-row (table-row contents info
)
3421 "Transcode a TABLE-ROW element from Org to ODT.
3422 CONTENTS is the contents of the row. INFO is a plist used as a
3423 communication channel."
3424 ;; Rules are ignored since table separators are deduced from
3425 ;; borders of the current row.
3426 (when (eq (org-element-property :type table-row
) 'standard
)
3427 (let* ((rowgroup-tags
3428 (if (and (= 1 (org-export-table-row-group table-row info
))
3429 (org-export-table-has-header-p
3430 (org-export-get-parent-table table-row
) info
))
3431 ;; If the row belongs to the first rowgroup and the
3432 ;; table has more than one row groups, then this row
3433 ;; belongs to the header row group.
3434 '("\n<table:table-header-rows>" .
"\n</table:table-header-rows>")
3435 ;; Otherwise, it belongs to non-header row group.
3436 '("\n<table:table-rows>" .
"\n</table:table-rows>"))))
3438 ;; Does this row begin a rowgroup?
3439 (when (org-export-table-row-starts-rowgroup-p table-row info
)
3440 (car rowgroup-tags
))
3442 (format "\n<table:table-row>\n%s\n</table:table-row>" contents
)
3443 ;; Does this row end a rowgroup?
3444 (when (org-export-table-row-ends-rowgroup-p table-row info
)
3445 (cdr rowgroup-tags
))))))
3450 (defun org-odt-table-first-row-data-cells (table info
)
3452 (org-element-map table
'table-row
3454 (unless (eq (org-element-property :type row
) 'rule
) row
))
3456 (special-column-p (org-export-table-has-special-column-p table
)))
3457 (if (not special-column-p
) (org-element-contents table-row
)
3458 (cdr (org-element-contents table-row
)))))
3460 (defun org-odt--table (table contents info
)
3461 "Transcode a TABLE element from Org to ODT.
3462 CONTENTS is the contents of the table. INFO is a plist holding
3463 contextual information."
3464 (case (org-element-property :type table
)
3465 ;; Case 1: table.el doesn't support export to OD format. Strip
3466 ;; such tables from export.
3471 "(ox-odt): Found table.el-type table in the source Org file."
3472 " table.el doesn't support export to ODT format."
3473 " Stripping the table from export."))))
3474 ;; Case 2: Native Org tables.
3476 (let* ((captions (org-odt-format-label table info
'definition
))
3477 (caption (car captions
)) (short-caption (cdr captions
))
3478 (attributes (org-export-read-attribute :attr_odt table
))
3479 (custom-table-style (nth 1 (org-odt-table-style-spec table info
)))
3482 (lambda (table info
)
3483 (let* ((table-style (or custom-table-style
"OrgTable"))
3484 (column-style (format "%sColumn" table-style
)))
3486 (lambda (table-cell)
3487 (let ((width (1+ (or (org-export-table-cell-width
3488 table-cell info
) 0)))
3490 "\n<table:table-column table:style-name=\"%s\"/>"
3493 (dotimes (i width out
) (setq out
(concat s out
)))))
3494 (org-odt-table-first-row-data-cells table info
) "\n"))))))
3498 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3501 (let* ((automatic-name
3502 (org-odt-add-automatic-style "Table" attributes
)))
3504 "\n<table:table table:style-name=\"%s\"%s>"
3505 (or custom-table-style
(cdr automatic-name
) "OrgTable")
3506 (concat (when short-caption
3507 (format " table:name=\"%s\"" short-caption
)))))
3508 ;; column specification.
3509 (funcall table-column-specs table info
)
3513 "</table:table>")))))
3515 (defun org-odt-table (table contents info
)
3516 "Transcode a TABLE element from Org to ODT.
3517 CONTENTS is the contents of the table. INFO is a plist holding
3518 contextual information.
3520 Use `org-odt--table' to typeset the table. Handle details
3521 pertaining to indentation here."
3522 (let* ((--element-preceded-by-table-p
3524 (lambda (element info
)
3525 (loop for el in
(org-export-get-previous-element element info t
)
3526 thereis
(eq (org-element-type el
) 'table
)))))
3527 (--walk-list-genealogy-and-collect-tags
3529 (lambda (table info
)
3530 (let* ((genealogy (org-element-lineage table
))
3532 (when (eq (org-element-type (car genealogy
)) 'item
)
3533 (loop for el in genealogy
3534 when
(memq (org-element-type el
)
3539 (loop for el in genealogy
3540 when
(and (eq (org-element-type el
) 'headline
)
3541 (org-export-low-level-p el info
))
3545 (org-element-contents
3546 (org-export-get-parent el
)))))))
3549 ;; Handle list genealogy.
3550 (loop for el in list-genealogy collect
3551 (case (org-element-type el
)
3553 (setq parent-list el
)
3554 (cons "</text:list>"
3555 (format "\n<text:list text:style-name=\"%s\" %s>"
3556 (case (org-element-property :type el
)
3557 (ordered "OrgNumberedList")
3558 (unordered "OrgBulletedList")
3559 (descriptive-1 "OrgDescriptionList")
3560 (descriptive-2 "OrgDescriptionList"))
3561 "text:continue-numbering=\"true\"")))
3565 (if (funcall --element-preceded-by-table-p table info
)
3566 '("</text:list-header>" .
"<text:list-header>")
3567 '("</text:list-item>" .
"<text:list-header>")))
3568 ((funcall --element-preceded-by-table-p
3570 '("</text:list-header>" .
"<text:list-header>"))
3571 (t '("</text:list-item>" .
"<text:list-item>"))))))
3572 ;; Handle low-level headlines.
3573 (loop for el in llh-genealogy
3574 with step
= 'item collect
3577 (setq step
'item
) ; Flip-flop
3578 (setq parent-list el
)
3579 (cons "</text:list>"
3580 (format "\n<text:list text:style-name=\"%s\" %s>"
3581 (if (org-export-numbered-headline-p
3585 "text:continue-numbering=\"true\"")))
3587 (setq step
'plain-list
) ; Flip-flop
3590 (if (funcall --element-preceded-by-table-p table info
)
3591 '("</text:list-header>" .
"<text:list-header>")
3592 '("</text:list-item>" .
"<text:list-header>")))
3593 ((let ((section?
(org-export-get-previous-element
3596 (eq (org-element-type section?
) 'section
)
3597 (assq 'table
(org-element-contents section?
))))
3598 '("</text:list-header>" .
"<text:list-header>"))
3600 '("</text:list-item>" .
"<text:list-item>")))))))))))
3601 (close-open-tags (funcall --walk-list-genealogy-and-collect-tags
3603 ;; OpenDocument schema does not permit table to occur within a
3606 ;; One solution - the easiest and lightweight, in terms of
3607 ;; implementation - is to put the table in an indented text box
3608 ;; and make the text box part of the list-item. Unfortunately if
3609 ;; the table is big and spans multiple pages, the text box could
3610 ;; overflow. In this case, the following attribute will come
3613 ;; ,---- From OpenDocument-v1.1.pdf
3614 ;; | 15.27.28 Overflow behavior
3616 ;; | For text boxes contained within text document, the
3617 ;; | style:overflow-behavior property specifies the behavior of text
3618 ;; | boxes where the containing text does not fit into the text
3621 ;; | If the attribute's value is clip, the text that does not fit
3622 ;; | into the text box is not displayed.
3624 ;; | If the attribute value is auto-create-new-frame, a new frame
3625 ;; | will be created on the next page, with the same position and
3626 ;; | dimensions of the original frame.
3628 ;; | If the style:overflow-behavior property's value is
3629 ;; | auto-create-new-frame and the text box has a minimum width or
3630 ;; | height specified, then the text box will grow until the page
3631 ;; | bounds are reached before a new frame is created.
3634 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3635 ;; auto-create-new-frame property and always resorts to clipping
3636 ;; the text box. This results in table being truncated.
3638 ;; So we solve the problem the hard (and fun) way using list
3641 ;; The problem only becomes more interesting if you take in to
3642 ;; account the following facts:
3644 ;; - Description lists are simulated as plain lists.
3645 ;; - Low-level headlines can be listified.
3646 ;; - In Org-mode, a table can occur not only as a regular list
3647 ;; item, but also within description lists and low-level
3650 ;; See `org-odt-translate-description-lists' and
3651 ;; `org-odt-translate-low-level-headlines' for how this is
3655 ;; Discontinue the list.
3656 (mapconcat 'car close-open-tags
"\n")
3657 ;; Put the table in an indented section.
3658 (let* ((table (org-odt--table table contents info
))
3659 (level (/ (length (mapcar 'car close-open-tags
)) 2))
3660 (style (format "OrgIndentedSection-Level-%d" level
)))
3661 (when table
(org-odt-format-section table style
)))
3662 ;; Continue the list.
3663 (mapconcat 'cdr
(nreverse close-open-tags
) "\n"))))
3668 (defun org-odt-target (target contents info
)
3669 "Transcode a TARGET object from Org to ODT.
3670 CONTENTS is nil. INFO is a plist holding contextual
3672 (org-odt--target "" (org-export-get-reference target info
)))
3677 (defun org-odt-timestamp (timestamp contents info
)
3678 "Transcode a TIMESTAMP object from Org to ODT.
3679 CONTENTS is nil. INFO is a plist used as a communication
3681 (let* ((raw-value (org-element-property :raw-value timestamp
))
3682 (type (org-element-property :type timestamp
)))
3683 (if (not (plist-get info
:odt-use-date-fields
))
3684 (let ((value (org-odt-plain-text
3685 (org-timestamp-translate timestamp
) info
)))
3686 (case (org-element-property :type timestamp
)
3687 ((active active-range
)
3688 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3689 "OrgActiveTimestamp" value
))
3690 ((inactive inactive-range
)
3691 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3692 "OrgInactiveTimestamp" value
))
3696 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3697 "OrgActiveTimestamp"
3698 (format "<%s>" (org-odt--format-timestamp timestamp
))))
3700 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3701 "OrgInactiveTimestamp"
3702 (format "[%s]" (org-odt--format-timestamp timestamp
))))
3704 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3705 "OrgActiveTimestamp"
3706 (format "<%s>–<%s>"
3707 (org-odt--format-timestamp timestamp
)
3708 (org-odt--format-timestamp timestamp
'end
))))
3710 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3711 "OrgInactiveTimestamp"
3712 (format "[%s]–[%s]"
3713 (org-odt--format-timestamp timestamp
)
3714 (org-odt--format-timestamp timestamp
'end
))))
3716 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3718 (org-odt-plain-text (org-timestamp-translate timestamp
)
3724 (defun org-odt-underline (underline contents info
)
3725 "Transcode UNDERLINE from Org to ODT.
3726 CONTENTS is the text with underline markup. INFO is a plist
3727 holding contextual information."
3728 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3729 "Underline" contents
))
3734 (defun org-odt-verbatim (verbatim contents info
)
3735 "Transcode a VERBATIM object from Org to ODT.
3736 CONTENTS is nil. INFO is a plist used as a communication
3738 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3739 "OrgCode" (org-odt--encode-plain-text
3740 (org-element-property :value verbatim
))))
3745 (defun org-odt-verse-block (verse-block contents info
)
3746 "Transcode a VERSE-BLOCK element from Org to ODT.
3747 CONTENTS is verse block contents. INFO is a plist holding
3748 contextual information."
3749 ;; Add line breaks to each line of verse.
3750 (setq contents
(replace-regexp-in-string
3751 "\\(<text:line-break/>\\)?[ \t]*\n"
3752 "<text:line-break/>" contents
))
3753 ;; Replace tabs and spaces.
3754 (setq contents
(org-odt--encode-tabs-and-spaces contents
))
3755 ;; Surround it in a verse environment.
3756 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3757 "OrgVerse" contents
))
3763 ;;;; LaTeX fragments
3765 (defun org-odt--translate-latex-fragments (tree backend info
)
3766 (let ((processing-type (plist-get info
:with-latex
))
3768 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3769 ;; If the desired converter is not available, force verbatim
3771 (case processing-type
3773 (if (and (fboundp 'org-format-latex-mathml-available-p
)
3774 (org-format-latex-mathml-available-p))
3775 (setq processing-type
'mathml
)
3776 (message "LaTeX to MathML converter not available.")
3777 (setq processing-type
'verbatim
)))
3778 ((dvipng imagemagick
)
3779 (unless (and (org-check-external-command "latex" "" t
)
3780 (org-check-external-command
3781 (if (eq processing-type
'dvipng
) "dvipng" "convert") "" t
))
3782 (message "LaTeX to PNG converter not available.")
3783 (setq processing-type
'verbatim
)))
3785 (message "Unknown LaTeX option. Forcing verbatim.")
3786 (setq processing-type
'verbatim
)))
3788 ;; Store normalized value for later use.
3789 (when (plist-get info
:with-latex
)
3790 (plist-put info
:with-latex processing-type
))
3791 (message "Formatting LaTeX using %s" processing-type
)
3793 ;; Convert `latex-fragment's and `latex-environment's.
3794 (when (memq processing-type
'(mathml dvipng imagemagick
))
3795 (org-element-map tree
'(latex-fragment latex-environment
)
3798 (let* ((latex-frag (org-element-property :value latex-
*))
3799 (input-file (plist-get info
:input-file
))
3800 (cache-dir (file-name-directory input-file
))
3801 (cache-subdir (concat
3802 (case processing-type
3803 ((dvipng imagemagick
) "ltxpng/")
3804 (mathml "ltxmathml/"))
3805 (file-name-sans-extension
3806 (file-name-nondirectory input-file
))))
3808 (case processing-type
3809 ((dvipng imagemagick
)
3810 (format "Creating LaTeX Image %d..." count
))
3811 (mathml (format "Creating MathML snippet %d..." count
))))
3812 ;; Get an Org-style link to PNG image or the MathML
3815 (let ((link (with-temp-buffer
3817 (org-format-latex cache-subdir cache-dir
3819 nil processing-type
)
3820 (buffer-substring-no-properties
3821 (point-min) (point-max)))))
3822 (if (org-string-match-p "file:\\([^]]*\\)" link
) link
3823 (message "LaTeX Conversion failed.")
3826 ;; Conversion succeeded. Parse above Org-style link to
3830 (org-element-parse-secondary-string org-link
'(link))
3831 'link
#'identity info t
))
3833 (case (org-element-type latex-
*)
3834 ;; Case 1: LaTeX environment. Mimic
3835 ;; a "standalone image or formula" by
3836 ;; enclosing the `link' in a `paragraph'.
3837 ;; Copy over original attributes, captions to
3838 ;; the enclosing paragraph.
3840 (org-element-adopt-elements
3842 (list :style
"OrgFormula"
3844 (org-element-property :name latex-
*)
3846 (org-element-property :caption latex-
*)))
3848 ;; Case 2: LaTeX fragment. No special action.
3849 (latex-fragment link
))))
3850 ;; Note down the object that link replaces.
3851 (org-element-put-property replacement
:replaces
3852 (list (org-element-type latex-
*)
3853 (list :value latex-frag
)))
3854 ;; Restore blank after initial element or object.
3855 (org-element-put-property
3856 replacement
:post-blank
3857 (org-element-property :post-blank latex-
*))
3859 (org-element-set-element latex-
* replacement
)))))
3864 ;;;; Description lists
3866 ;; This translator is necessary to handle indented tables in a uniform
3867 ;; manner. See comment in `org-odt--table'.
3869 (defun org-odt--translate-description-lists (tree backend info
)
3870 ;; OpenDocument has no notion of a description list. So simulate it
3871 ;; using plain lists. Description lists in the exported document
3872 ;; are typeset in the same manner as they are in a typical HTML
3875 ;; Specifically, a description list like this:
3878 ;; | - term-1 :: definition-1
3879 ;; | - term-2 :: definition-2
3882 ;; gets translated in to the following form:
3891 ;; Further effect is achieved by fixing the OD styles as below:
3893 ;; 1. Set the :type property of the simulated lists to
3894 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3895 ;; that has *no* bullets whatsoever.
3897 ;; 2. The paragraph containing the definition term is styled to be
3900 (org-element-map tree
'plain-list
3902 (when (equal (org-element-property :type el
) 'descriptive
)
3903 (org-element-set-element
3905 (apply 'org-element-adopt-elements
3906 (list 'plain-list
(list :type
'descriptive-1
))
3909 (org-element-adopt-elements
3910 (list 'item
(list :checkbox
(org-element-property
3912 (list 'paragraph
(list :style
"Text_20_body_20_bold")
3913 (or (org-element-property :tag item
) "(no term)"))
3914 (org-element-adopt-elements
3915 (list 'plain-list
(list :type
'descriptive-2
))
3916 (apply 'org-element-adopt-elements
3918 (org-element-contents item
)))))
3919 (org-element-contents el
)))))
3926 ;; Lists that are marked with attribute `:list-table' are called as
3927 ;; list tables. They will be rendered as a table within the exported
3930 ;; Consider an example. The following list table
3932 ;; #+attr_odt :list-table t
3942 ;; will be exported as though it were an Org table like the one show
3945 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3946 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3948 ;; Note that org-tables are NOT multi-line and each line is mapped to
3949 ;; a unique row in the exported document. So if an exported table
3950 ;; needs to contain a single paragraph (with copious text) it needs to
3951 ;; be typed up in a single line. Editing such long lines using the
3952 ;; table editor will be a cumbersome task. Furthermore inclusion of
3953 ;; multi-paragraph text in a table cell is well-nigh impossible.
3955 ;; A LIST-TABLE circumvents above problems.
3957 ;; Note that in the example above the list items could be paragraphs
3958 ;; themselves and the list can be arbitrarily deep.
3960 ;; Inspired by following thread:
3961 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3963 ;; Translate lists to tables
3965 (defun org-odt--translate-list-tables (tree backend info
)
3966 (org-element-map tree
'plain-list
3968 (when (org-export-read-attribute :attr_odt l1-list
:list-table
)
3969 ;; Replace list with table.
3970 (org-element-set-element
3972 ;; Build replacement table.
3973 (apply 'org-element-adopt-elements
3974 (list 'table
'(:type org
:attr_odt
(":style \"GriddedTable\"")))
3975 (org-element-map l1-list
'item
3977 (let* ((l1-item-contents (org-element-contents l1-item
))
3978 l1-item-leading-text l2-list
)
3979 ;; Remove Level-2 list from the Level-item. It
3980 ;; will be subsequently attached as table-cells.
3981 (let ((cur l1-item-contents
) prev
)
3982 (while (and cur
(not (eq (org-element-type (car cur
))
3985 (setq cur
(cdr cur
)))
3988 (setq l2-list
(car cur
)))
3989 (setq l1-item-leading-text l1-item-contents
))
3990 ;; Level-1 items start a table row.
3991 (apply 'org-element-adopt-elements
3992 (list 'table-row
(list :type
'standard
))
3993 ;; Leading text of level-1 item define
3994 ;; the first table-cell.
3995 (apply 'org-element-adopt-elements
3996 (list 'table-cell nil
)
3997 l1-item-leading-text
)
3998 ;; Level-2 items define subsequent
3999 ;; table-cells of the row.
4000 (org-element-map l2-list
'item
4002 (apply 'org-element-adopt-elements
4003 (list 'table-cell nil
)
4004 (org-element-contents l2-item
)))
4012 ;;; Interactive functions
4014 (defun org-odt-create-manifest-file-entry (&rest args
)
4015 (push args org-odt-manifest-file-entries
))
4017 (defun org-odt-write-manifest-file ()
4018 (make-directory (concat org-odt-zip-dir
"META-INF"))
4019 (let ((manifest-file (concat org-odt-zip-dir
"META-INF/manifest.xml")))
4020 (with-current-buffer
4021 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4022 (find-file-noselect manifest-file t
))
4024 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
4025 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4027 (lambda (file-entry)
4028 (let* ((version (nth 2 file-entry
))
4029 (extra (if (not version
) ""
4030 (format " manifest:version=\"%s\"" version
))))
4032 (format org-odt-manifest-file-entry-tag
4033 (nth 0 file-entry
) (nth 1 file-entry
) extra
))))
4034 org-odt-manifest-file-entries
)
4035 (insert "\n</manifest:manifest>"))))
4037 (defmacro org-odt--export-wrap
(out-file &rest body
)
4038 `(let* ((--out-file ,out-file
)
4039 (out-file-type (file-name-extension --out-file
))
4040 (org-odt-xml-files '("META-INF/manifest.xml" "content.xml"
4041 "meta.xml" "styles.xml"))
4042 ;; Initialize temporary workarea. All files that end up in
4043 ;; the exported document get parked/created here.
4044 (org-odt-zip-dir (file-name-as-directory
4045 (make-temp-file (format "%s-" out-file-type
) t
)))
4046 (org-odt-manifest-file-entries nil
)
4047 (--cleanup-xml-buffers
4050 ;; Kill all XML buffers.
4051 (mapc (lambda (file)
4052 (let ((buf (find-buffer-visiting
4053 (concat org-odt-zip-dir file
))))
4055 (with-current-buffer buf
4056 (set-buffer-modified-p nil
)
4057 (kill-buffer buf
)))))
4059 ;; Delete temporary directory and also other embedded
4060 ;; files that get copied there.
4061 (delete-directory org-odt-zip-dir t
)))))
4064 (unless (executable-find "zip")
4065 ;; Not at all OSes ship with zip by default
4066 (error "Executable \"zip\" needed for creating OpenDocument files"))
4067 ;; Do export. This creates a bunch of xml files ready to be
4068 ;; saved and zipped.
4070 ;; Create a manifest entry for content.xml.
4071 (org-odt-create-manifest-file-entry "text/xml" "content.xml")
4072 ;; Write mimetype file
4074 '(("odt" .
"application/vnd.oasis.opendocument.text")
4075 ("odf" .
"application/vnd.oasis.opendocument.formula")))
4076 (mimetype (cdr (assoc-string out-file-type mimetypes t
))))
4078 (error "Unknown OpenDocument backend %S" out-file-type
))
4079 (write-region mimetype nil
(concat org-odt-zip-dir
"mimetype"))
4080 (org-odt-create-manifest-file-entry mimetype
"/" "1.2"))
4081 ;; Write out the manifest entries before zipping
4082 (org-odt-write-manifest-file)
4083 ;; Save all XML files.
4084 (mapc (lambda (file)
4085 (let ((buf (find-buffer-visiting
4086 (concat org-odt-zip-dir file
))))
4088 (with-current-buffer buf
4089 ;; Prettify output if needed.
4090 (when org-odt-prettify-xml
4091 (indent-region (point-min) (point-max)))
4095 (let* ((target --out-file
)
4096 (target-name (file-name-nondirectory target
))
4097 (cmds `(("zip" "-mX0" ,target-name
"mimetype")
4098 ("zip" "-rmTq" ,target-name
"."))))
4099 ;; If a file with same name as the desired output file
4100 ;; exists, remove it.
4101 (when (file-exists-p target
)
4102 (delete-file target
))
4103 ;; Zip up the xml files.
4104 (let ((coding-system-for-write 'no-conversion
) exitcode err-string
)
4105 (message "Creating ODT file...")
4106 ;; Switch temporarily to content.xml. This way Zip
4107 ;; process will inherit `org-odt-zip-dir' as the current
4109 (with-current-buffer
4110 (find-file-noselect (concat org-odt-zip-dir
"content.xml") t
)
4113 (message "Running %s" (mapconcat 'identity cmd
" "))
4115 (with-output-to-string
4117 (apply 'call-process
(car cmd
)
4118 nil standard-output nil
(cdr cmd
)))))
4119 (or (zerop exitcode
)
4120 (error (concat "Unable to create OpenDocument file."
4121 (format " Zip failed with error (%s)"
4124 ;; Move the zip file from temporary work directory to
4125 ;; user-mandated location.
4126 (rename-file (concat org-odt-zip-dir target-name
) target
)
4127 (message "Created %s" (expand-file-name target
))
4128 ;; Cleanup work directory and work files.
4129 (funcall --cleanup-xml-buffers
)
4130 ;; Open the OpenDocument file in archive-mode for
4132 (find-file-noselect target t
)
4133 ;; Return exported file.
4135 ;; Case 1: Conversion desired on exported file. Run the
4136 ;; converter on the OpenDocument file. Return the
4138 (org-odt-preferred-output-format
4139 (or (org-odt-convert target org-odt-preferred-output-format
)
4141 ;; Case 2: No further conversion. Return exported
4142 ;; OpenDocument file.
4145 ;; Cleanup work directory and work files.
4146 (funcall --cleanup-xml-buffers
)
4147 (message "OpenDocument export failed: %s"
4148 (error-message-string err
))))))
4151 ;;;; Export to OpenDocument formula
4154 (defun org-odt-export-as-odf (latex-frag &optional odf-file
)
4155 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4156 Use `org-create-math-formula' to convert LATEX-FRAG first to
4157 MathML. When invoked as an interactive command, use
4158 `org-latex-regexps' to infer LATEX-FRAG from currently active
4159 region. If no LaTeX fragments are found, prompt for it. Push
4160 MathML source to kill ring depending on the value of
4161 `org-export-copy-to-kill-ring'."
4164 (setq frag
(and (setq frag
(and (region-active-p)
4165 (buffer-substring (region-beginning)
4167 (loop for e in org-latex-regexps
4168 thereis
(when (string-match (nth 1 e
) frag
)
4169 (match-string (nth 2 e
) frag
)))))
4170 (read-string "LaTeX Fragment: " frag nil frag
))
4171 ,(let ((odf-filename (expand-file-name
4173 (file-name-sans-extension
4174 (or (file-name-nondirectory buffer-file-name
)))
4176 (file-name-directory buffer-file-name
))))
4177 (read-file-name "ODF filename: " nil odf-filename nil
4178 (file-name-nondirectory odf-filename
)))))
4179 (let ((filename (or odf-file
4182 (file-name-sans-extension
4183 (or (file-name-nondirectory buffer-file-name
)))
4185 (file-name-directory buffer-file-name
)))))
4186 (org-odt--export-wrap
4188 (let* ((buffer (progn
4189 (require 'nxml-mode
)
4190 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4191 (find-file-noselect (concat org-odt-zip-dir
4192 "content.xml") t
))))
4193 (coding-system-for-write 'utf-8
)
4194 (save-buffer-coding-system 'utf-8
))
4196 (set-buffer-file-coding-system coding-system-for-write
)
4197 (let ((mathml (org-create-math-formula latex-frag
)))
4198 (unless mathml
(error "No Math formula created"))
4200 ;; Add MathML to kill ring, if needed.
4201 (when (org-export--copy-to-kill-ring-p)
4202 (org-kill-new (buffer-string))))))))
4205 (defun org-odt-export-as-odf-and-open ()
4206 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4207 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4210 (org-open-file (call-interactively 'org-odt-export-as-odf
) 'system
))
4213 ;;;; Export to OpenDocument Text
4216 (defun org-odt-export-to-odt (&optional async subtreep visible-only ext-plist
)
4217 "Export current buffer to a ODT file.
4219 If narrowing is active in the current buffer, only export its
4222 If a region is active, export that region.
4224 A non-nil optional argument ASYNC means the process should happen
4225 asynchronously. The resulting file should be accessible through
4226 the `org-export-stack' interface.
4228 When optional argument SUBTREEP is non-nil, export the sub-tree
4229 at point, extracting information from the headline properties
4232 When optional argument VISIBLE-ONLY is non-nil, don't export
4233 contents of hidden elements.
4235 EXT-PLIST, when provided, is a property list with external
4236 parameters overriding Org default settings, but still inferior to
4237 file-local settings.
4239 Return output file's name."
4241 (let ((outfile (org-export-output-file-name ".odt" subtreep
)))
4243 (org-export-async-start (lambda (f) (org-export-add-to-stack f
'odt
))
4245 (org-odt--export-wrap
4247 (let* ((org-odt-embedded-images-count 0)
4248 (org-odt-embedded-formulas-count 0)
4249 (org-odt-automatic-styles nil
)
4250 (org-odt-object-counters nil
)
4251 ;; Let `htmlfontify' know that we are interested in
4252 ;; collecting styles.
4253 (hfy-user-sheet-assoc nil
))
4254 ;; Initialize content.xml and kick-off the export
4258 (require 'nxml-mode
)
4259 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4261 (concat org-odt-zip-dir
"content.xml") t
))))
4262 (output (org-export-as
4263 'odt
,subtreep
,visible-only nil
,ext-plist
)))
4264 (with-current-buffer out-buf
4266 (insert output
)))))))
4267 (org-odt--export-wrap
4269 (let* ((org-odt-embedded-images-count 0)
4270 (org-odt-embedded-formulas-count 0)
4271 (org-odt-automatic-styles nil
)
4272 (org-odt-object-counters nil
)
4273 ;; Let `htmlfontify' know that we are interested in collecting
4275 (hfy-user-sheet-assoc nil
))
4276 ;; Initialize content.xml and kick-off the export process.
4277 (let ((output (org-export-as 'odt subtreep visible-only nil ext-plist
))
4279 (require 'nxml-mode
)
4280 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4282 (concat org-odt-zip-dir
"content.xml") t
)))))
4283 (with-current-buffer out-buf
(erase-buffer) (insert output
))))))))
4286 ;;;; Convert between OpenDocument and other formats
4288 (defun org-odt-reachable-p (in-fmt out-fmt
)
4289 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4291 (let ((reachable-formats (org-odt-do-reachable-formats in-fmt
)))
4292 (dolist (e reachable-formats
)
4293 (let ((out-fmt-spec (assoc out-fmt
(cdr e
))))
4295 (throw 'done
(cons (car e
) out-fmt-spec
))))))))
4297 (defun org-odt-do-convert (in-file out-fmt
&optional prefix-arg
)
4298 "Workhorse routine for `org-odt-convert'."
4299 (require 'browse-url
)
4300 (let* ((in-file (expand-file-name (or in-file buffer-file-name
)))
4301 (dummy (or (file-readable-p in-file
)
4302 (error "Cannot read %s" in-file
)))
4303 (in-fmt (file-name-extension in-file
))
4304 (out-fmt (or out-fmt
(error "Output format unspecified")))
4305 (how (or (org-odt-reachable-p in-fmt out-fmt
)
4306 (error "Cannot convert from %s format to %s format?"
4308 (convert-process (car how
))
4309 (out-file (concat (file-name-sans-extension in-file
) "."
4310 (nth 1 (or (cdr how
) out-fmt
))))
4311 (extra-options (or (nth 2 (cdr how
)) ""))
4312 (out-dir (file-name-directory in-file
))
4313 (cmd (format-spec convert-process
4314 `((?i .
,(shell-quote-argument in-file
))
4315 (?I .
,(browse-url-file-url in-file
))
4318 (?O .
,(browse-url-file-url out-file
))
4319 (?d .
, (shell-quote-argument out-dir
))
4320 (?D .
,(browse-url-file-url out-dir
))
4321 (?x .
,extra-options
)))))
4322 (when (file-exists-p out-file
)
4323 (delete-file out-file
))
4325 (message "Executing %s" cmd
)
4326 (let ((cmd-output (shell-command-to-string cmd
)))
4327 (message "%s" cmd-output
))
4330 ((file-exists-p out-file
)
4331 (message "Exported to %s" out-file
)
4333 (message "Opening %s..." out-file
)
4334 (org-open-file out-file
'system
))
4337 (message "Export to %s failed" out-file
)
4340 (defun org-odt-do-reachable-formats (in-fmt)
4341 "Return verbose info about formats to which IN-FMT can be converted.
4342 Return a list where each element is of the
4343 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4344 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4345 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4347 (and org-odt-convert-process
4348 (cadr (assoc-string org-odt-convert-process
4349 org-odt-convert-processes t
))))
4351 (and org-odt-convert-process
4352 (cadr (assoc-string org-odt-convert-process
4353 org-odt-convert-processes t
))
4354 org-odt-convert-capabilities
))
4357 (dolist (c capabilities
)
4358 (when (member in-fmt
(nth 1 c
))
4359 (push (cons converter
(nth 2 c
)) reachable-formats
))))
4362 (defun org-odt-reachable-formats (in-fmt)
4363 "Return list of formats to which IN-FMT can be converted.
4364 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4366 (mapc (lambda (e) (add-to-list 'l e
))
4367 (apply 'append
(mapcar
4368 (lambda (e) (mapcar 'car
(cdr e
)))
4369 (org-odt-do-reachable-formats in-fmt
))))
4372 (defun org-odt-convert-read-params ()
4373 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4374 This is a helper routine for interactive use."
4375 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
4376 (in-file (read-file-name "File to be converted: "
4377 nil buffer-file-name t
))
4378 (in-fmt (file-name-extension in-file
))
4379 (out-fmt-choices (org-odt-reachable-formats in-fmt
))
4381 (or (and out-fmt-choices
4382 (funcall input
"Output format: "
4383 out-fmt-choices nil nil nil
))
4385 "No known converter or no known output formats for %s files"
4387 (list in-file out-fmt
)))
4390 (defun org-odt-convert (&optional in-file out-fmt prefix-arg
)
4391 "Convert IN-FILE to format OUT-FMT using a command line converter.
4392 IN-FILE is the file to be converted. If unspecified, it defaults
4393 to variable `buffer-file-name'. OUT-FMT is the desired output
4394 format. Use `org-odt-convert-process' as the converter.
4395 If PREFIX-ARG is non-nil then the newly converted file is opened
4396 using `org-open-file'."
4398 (append (org-odt-convert-read-params) current-prefix-arg
))
4399 (org-odt-do-convert in-file out-fmt prefix-arg
))
4401 ;;; Library Initializations
4405 ;; Let Emacs open all OpenDocument files in archive mode
4406 (add-to-list 'auto-mode-alist
4407 (cons (concat "\\." (car desc
) "\\'") 'archive-mode
)))
4408 org-odt-file-extensions
)
4413 ;; generated-autoload-file: "org-loaddefs.el"
4416 ;;; ox-odt.el ends here