1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2014 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
)
101 (:odt-content-template-file nil nil org-odt-content-template-file
)
102 (:odt-display-outline-level nil nil org-odt-display-outline-level
)
103 (:odt-fontify-srcblocks nil nil org-odt-fontify-srcblocks
)
104 (:odt-format-drawer-function nil nil org-odt-format-drawer-function
)
105 (:odt-format-headline-function nil nil org-odt-format-headline-function
)
106 (:odt-format-inlinetask-function nil nil org-odt-format-inlinetask-function
)
107 (:odt-inline-formula-rules nil nil org-odt-inline-formula-rules
)
108 (:odt-inline-image-rules nil nil org-odt-inline-image-rules
)
109 (:odt-pixels-per-inch nil nil org-odt-pixels-per-inch
)
110 (:odt-styles-file nil nil org-odt-styles-file
)
111 (:odt-table-styles nil nil org-odt-table-styles
)
112 (:odt-use-date-fields nil nil org-odt-use-date-fields
)
113 ;; Redefine regular option.
114 (:with-latex nil
"tex" org-odt-with-latex
)))
121 ;;; Function Declarations
123 (declare-function hfy-face-to-style
"htmlfontify" (fn))
124 (declare-function hfy-face-or-def-to-name
"htmlfontify" (fn))
125 (declare-function archive-zip-extract
"arc-mode" (archive name
))
126 (declare-function org-create-math-formula
"org" (latex-frag &optional mathml-file
))
127 (declare-function browse-url-file-url
"browse-url" (file))
131 ;;; Internal Variables
133 (defconst org-odt-lib-dir
134 (file-name-directory (or load-file-name
(buffer-file-name)))
135 "Location of ODT exporter.
136 Use this to infer values of `org-odt-styles-dir' and
137 `org-odt-schema-dir'.")
139 (defvar org-odt-data-dir
140 (expand-file-name "../../etc/" org-odt-lib-dir
)
141 "Data directory for ODT exporter.
142 Use this to infer values of `org-odt-styles-dir' and
143 `org-odt-schema-dir'.")
145 (defconst org-odt-special-string-regexps
146 '(("\\\\-" .
"­\\1") ; shy
147 ("---\\([^-]\\)" .
"—\\1") ; mdash
148 ("--\\([^-]\\)" .
"–\\1") ; ndash
149 ("\\.\\.\\." .
"…")) ; hellip
150 "Regular expressions for special string conversion.")
152 (defconst org-odt-schema-dir-list
154 (and org-odt-data-dir
155 (expand-file-name "./schema/" org-odt-data-dir
)) ; bail out
157 (and (boundp 'org-odt-data-dir
) org-odt-data-dir
; see make install
158 (expand-file-name "./schema/" org-odt-data-dir
))))
159 "List of directories to search for OpenDocument schema files.
160 Use this list to set the default value of
161 `org-odt-schema-dir'. The entries in this list are
162 populated heuristically based on the values of `org-odt-lib-dir'
163 and `org-odt-data-dir'.")
165 (defconst org-odt-styles-dir-list
167 (and org-odt-data-dir
168 (expand-file-name "./styles/" org-odt-data-dir
)) ; bail out
170 (and (boundp 'org-odt-data-dir
) org-odt-data-dir
; see make install
171 (expand-file-name "./styles/" org-odt-data-dir
)))
172 (expand-file-name "../../etc/styles/" org-odt-lib-dir
) ; git
173 (expand-file-name "./etc/styles/" org-odt-lib-dir
) ; elpa
174 (expand-file-name "./org/" data-directory
) ; system
176 "List of directories to search for OpenDocument styles files.
177 See `org-odt-styles-dir'. The entries in this list are populated
178 heuristically based on the values of `org-odt-lib-dir' and
179 `org-odt-data-dir'.")
181 (defconst org-odt-styles-dir
184 (message "Debug (ox-odt): Searching for OpenDocument styles files...")
185 (mapc (lambda (styles-dir)
187 (message "Debug (ox-odt): Trying %s..." styles-dir
)
188 (when (and (file-readable-p
190 "OrgOdtContentTemplate.xml" styles-dir
))
193 "OrgOdtStyles.xml" styles-dir
)))
194 (message "Debug (ox-odt): Using styles under %s"
196 (throw 'styles-dir styles-dir
))))
197 org-odt-styles-dir-list
)
200 (error "Error (ox-odt): Cannot find factory styles files, aborting"))
202 "Directory that holds auxiliary XML files used by the ODT exporter.
204 This directory contains the following XML files -
205 \"OrgOdtStyles.xml\" and \"OrgOdtContentTemplate.xml\". These
206 XML files are used as the default values of
207 `org-odt-styles-file' and `org-odt-content-template-file'.
209 The default value of this variable varies depending on the
210 version of org in use and is initialized from
211 `org-odt-styles-dir-list'. Note that the user could be using org
212 from one of: org's own private git repository, GNU ELPA tar or
215 (defconst org-odt-bookmark-prefix
"OrgXref.")
217 (defconst org-odt-manifest-file-entry-tag
218 "\n<manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
220 (defconst org-odt-file-extensions
221 '(("odt" .
"OpenDocument Text")
222 ("ott" .
"OpenDocument Text Template")
223 ("odm" .
"OpenDocument Master Document")
224 ("ods" .
"OpenDocument Spreadsheet")
225 ("ots" .
"OpenDocument Spreadsheet Template")
226 ("odg" .
"OpenDocument Drawing (Graphics)")
227 ("otg" .
"OpenDocument Drawing Template")
228 ("odp" .
"OpenDocument Presentation")
229 ("otp" .
"OpenDocument Presentation Template")
230 ("odi" .
"OpenDocument Image")
231 ("odf" .
"OpenDocument Formula")
232 ("odc" .
"OpenDocument Chart")))
234 (defconst org-odt-table-style-format
236 <style:style style:name=\"%s\" style:family=\"table\">
237 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
240 "Template for auto-generated Table styles.")
242 (defvar org-odt-automatic-styles
'()
243 "Registry of automatic styles for various OBJECT-TYPEs.
244 The variable has the following form:
246 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
247 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
249 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
250 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
253 OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
254 OBJECT-PROPS is (typically) a plist created by passing
255 \"#+ATTR_ODT: \" option to `org-odt-parse-block-attributes'.
257 Use `org-odt-add-automatic-style' to add update this variable.'")
259 (defvar org-odt-object-counters nil
260 "Running counters for various OBJECT-TYPEs.
261 Use this to generate automatic names and style-names. See
262 `org-odt-add-automatic-style'.")
264 (defvar org-odt-src-block-paragraph-format
265 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
266 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
267 <style:background-image/>
268 </style:paragraph-properties>
269 <style:text-properties fo:color=\"%s\"/>
271 "Custom paragraph style for colorized source and example blocks.
272 This style is much the same as that of \"OrgFixedWidthBlock\"
273 except that the foreground and background colors are set
274 according to the default face identified by the `htmlfontify'.")
276 (defvar hfy-optimisations
)
277 (defvar org-odt-embedded-formulas-count
0)
278 (defvar org-odt-embedded-images-count
0)
279 (defvar org-odt-image-size-probe-method
280 (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
282 "Ordered list of methods for determining image sizes.")
284 (defvar org-odt-default-image-sizes-alist
285 '(("as-char" .
(5 .
0.4))
286 ("paragraph" .
(5 .
5)))
287 "Hardcoded image dimensions one for each of the anchor
290 ;; A4 page size is 21.0 by 29.7 cms
291 ;; The default page settings has 2cm margin on each of the sides. So
292 ;; the effective text area is 17.0 by 25.7 cm
293 (defvar org-odt-max-image-size
'(17.0 .
20.0)
294 "Limiting dimensions for an embedded image.")
296 (defconst org-odt-label-styles
297 '(("math-formula" "%c" "text" "(%n)")
298 ("math-label" "(%n)" "text" "(%n)")
299 ("category-and-value" "%e %n: %c" "category-and-value" "%e %n")
300 ("value" "%e %n: %c" "value" "%n"))
301 "Specify how labels are applied and referenced.
303 This is an alist where each element is of the form:
305 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
307 ATTACH-FMT controls how labels and captions are attached to an
308 entity. It may contain following specifiers - %e and %c. %e is
309 replaced with the CATEGORY-NAME. %n is replaced with
310 \"<text:sequence ...> SEQNO </text:sequence>\". %c is replaced
313 REF-MODE and REF-FMT controls how label references are generated.
314 The following XML is generated for a label reference -
315 \"<text:sequence-ref text:reference-format=\"REF-MODE\" ...>
316 REF-FMT </text:sequence-ref>\". REF-FMT may contain following
317 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
318 %n is replaced with SEQNO.
320 See also `org-odt-format-label'.")
322 (defvar org-odt-category-map-alist
323 '(("__Table__" "Table" "value" "Table" org-odt--enumerable-p
)
324 ("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p
)
325 ("__MathFormula__" "Text" "math-formula" "Equation" org-odt--enumerable-formula-p
)
326 ("__DvipngImage__" "Equation" "value" "Equation" org-odt--enumerable-latex-image-p
)
327 ("__Listing__" "Listing" "value" "Listing" org-odt--enumerable-p
))
328 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
330 This is a list where each entry is of the form:
332 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
334 CATEGORY_HANDLE identifies the captionable entity in question.
336 OD-VARIABLE is the OpenDocument sequence counter associated with
337 the entity. These counters are declared within
338 \"<text:sequence-decls>...</text:sequence-decls>\" block of
339 `org-odt-content-template-file'.
341 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
342 how a given entity should be captioned and referenced.
344 CATEGORY-NAME is used for qualifying captions on export.
346 ENUMERATOR-PREDICATE is used for assigning a sequence number to
347 the entity. See `org-odt--enumerate'.")
349 (defvar org-odt-manifest-file-entries nil
)
350 (defvar hfy-user-sheet-assoc
)
352 (defvar org-odt-zip-dir nil
353 "Temporary work directory for OpenDocument exporter.")
357 ;;; User Configuration Variables
359 (defgroup org-export-odt nil
360 "Options for exporting Org mode files to ODT."
361 :tag
"Org Export ODT"
367 (defcustom org-odt-prettify-xml nil
368 "Specify whether or not the xml output should be prettified.
369 When this option is turned on, `indent-region' is run on all
370 component xml buffers before they are saved. Turn this off for
371 regular use. Turn this on if you need to examine the xml
373 :group
'org-export-odt
381 (defcustom org-odt-schema-dir
384 (message "Debug (ox-odt): Searching for OpenDocument schema files...")
388 (message "Debug (ox-odt): Trying %s..." schema-dir
)
389 (when (and (file-expand-wildcards
390 (expand-file-name "od-manifest-schema*.rnc"
392 (file-expand-wildcards
393 (expand-file-name "od-schema*.rnc"
396 (expand-file-name "schemas.xml" schema-dir
)))
397 (message "Debug (ox-odt): Using schema files under %s"
399 (throw 'schema-dir schema-dir
))))
400 org-odt-schema-dir-list
)
401 (message "Debug (ox-odt): No OpenDocument schema files installed")
404 "Directory that contains OpenDocument schema files.
406 This directory contains:
407 1. rnc files for OpenDocument schema
408 2. a \"schemas.xml\" file that specifies locating rules needed
409 for auto validation of OpenDocument XML files.
411 Use the customize interface to set this variable. This ensures
412 that `rng-schema-locating-files' is updated and auto-validation
413 of OpenDocument XML takes place based on the value
414 `rng-nxml-auto-validate-flag'.
416 The default value of this variable varies depending on the
417 version of org in use and is initialized from
418 `org-odt-schema-dir-list'. The OASIS schema files are available
419 only in the org's private git repository. It is *not* bundled
420 with GNU ELPA tar or standard Emacs distribution."
422 (const :tag
"Not set" nil
)
423 (directory :tag
"Schema directory"))
424 :group
'org-export-odt
428 "Set `org-odt-schema-dir'.
429 Also add it to `rng-schema-locating-files'."
430 (let ((schema-dir value
))
433 (file-expand-wildcards
434 (expand-file-name "od-manifest-schema*.rnc" schema-dir
))
435 (file-expand-wildcards
436 (expand-file-name "od-schema*.rnc" schema-dir
))
438 (expand-file-name "schemas.xml" schema-dir
)))
441 (message "Error (ox-odt): %s has no OpenDocument schema files"
444 (when org-odt-schema-dir
445 (eval-after-load 'rng-loc
446 '(add-to-list 'rng-schema-locating-files
447 (expand-file-name "schemas.xml"
448 org-odt-schema-dir
))))))
453 (defcustom org-odt-content-template-file nil
454 "Template file for \"content.xml\".
455 The exporter embeds the exported content just before
456 \"</office:text>\" element.
458 If unspecified, the file named \"OrgOdtContentTemplate.xml\"
459 under `org-odt-styles-dir' is used."
460 :type
'(choice (const nil
)
462 :group
'org-export-odt
465 (defcustom org-odt-styles-file nil
466 "Default styles file for use with ODT export.
467 Valid values are one of:
469 2. path to a styles.xml file
470 3. path to a *.odt or a *.ott file
471 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
474 In case of option 1, an in-built styles.xml is used. See
475 `org-odt-styles-dir' for more information.
477 In case of option 3, the specified file is unzipped and the
478 styles.xml embedded therein is used.
480 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
481 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
482 generated odt file. Use relative path for specifying the
483 FILE-MEMBERS. styles.xml must be specified as one of the
486 Use options 1, 2 or 3 only if styles.xml alone suffices for
487 achieving the desired formatting. Use option 4, if the styles.xml
488 references additional files like header and footer images for
489 achieving the desired formatting.
491 Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
492 a per-file basis. For example,
494 #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
495 #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
496 :group
'org-export-odt
500 (const :tag
"Factory settings" nil
)
501 (file :must-match t
:tag
"styles.xml")
502 (file :must-match t
:tag
"ODT or OTT file")
503 (list :tag
"ODT or OTT file + Members"
504 (file :must-match t
:tag
"ODF Text or Text Template file")
506 (file :tag
" Member" "styles.xml")
507 (repeat (file :tag
"Member"))))))
509 (defcustom org-odt-display-outline-level
2
510 "Outline levels considered for enumerating captioned entities."
511 :group
'org-export-odt
513 :package-version
'(Org .
"8.0")
516 ;;;; Document conversion
518 (defcustom org-odt-convert-processes
520 "soffice --headless --convert-to %f%x --outdir %d %i")
522 "unoconv -f %f -o %d %i"))
523 "Specify a list of document converters and their usage.
524 The converters in this list are offered as choices while
525 customizing `org-odt-convert-process'.
527 This variable is a list where each element is of the
528 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
529 of the converter. CONVERTER-CMD is the shell command for the
530 converter and can contain format specifiers. These format
531 specifiers are interpreted as below:
533 %i input file name in full
534 %I input file name as a URL
535 %f format of the output file
536 %o output file name in full
537 %O output file name as a URL
538 %d output dir in full
539 %D output dir as a URL.
540 %x extra options as set in `org-odt-convert-capabilities'."
541 :group
'org-export-odt
545 (const :tag
"None" nil
)
546 (alist :tag
"Converters"
547 :key-type
(string :tag
"Converter Name")
548 :value-type
(group (string :tag
"Command line")))))
550 (defcustom org-odt-convert-process
"LibreOffice"
551 "Use this converter to convert from \"odt\" format to other formats.
552 During customization, the list of converter names are populated
553 from `org-odt-convert-processes'."
554 :group
'org-export-odt
556 :type
'(choice :convert-widget
558 (apply 'widget-convert
(widget-type w
)
559 (eval (car (widget-get w
:args
)))))
560 `((const :tag
"None" nil
)
561 ,@(mapcar (lambda (c)
562 `(const :tag
,(car c
) ,(car c
)))
563 org-odt-convert-processes
))))
565 (defcustom org-odt-convert-capabilities
567 ("odt" "ott" "doc" "rtf" "docx")
568 (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
569 ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
572 (("pdf" "pdf") ("odt" "odt") ("html" "html")))
574 ("ods" "ots" "xls" "csv" "xlsx")
575 (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
576 ("xls" "xls") ("xlsx" "xlsx")))
578 ("odp" "otp" "ppt" "pptx")
579 (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
580 ("pptx" "pptx") ("odg" "odg"))))
581 "Specify input and output formats of `org-odt-convert-process'.
582 More correctly, specify the set of input and output formats that
583 the user is actually interested in.
585 This variable is an alist where each element is of the
586 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
587 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
588 alist where each element is of the form (OUTPUT-FMT
589 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
591 The variable is interpreted as follows:
592 `org-odt-convert-process' can take any document that is in
593 INPUT-FMT-LIST and produce any document that is in the
594 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
595 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
596 serves dual purposes:
597 - It is used for populating completion candidates during
598 `org-odt-convert' commands.
599 - It is used as the value of \"%f\" specifier in
600 `org-odt-convert-process'.
602 EXTRA-OPTIONS is used as the value of \"%x\" specifier in
603 `org-odt-convert-process'.
605 DOCUMENT-CLASS is used to group a set of file formats in
606 INPUT-FMT-LIST in to a single class.
608 Note that this variable inherently captures how LibreOffice based
609 converters work. LibreOffice maps documents of various formats
610 to classes like Text, Web, Spreadsheet, Presentation etc and
611 allow document of a given class (irrespective of its source
612 format) to be converted to any of the export formats associated
615 See default setting of this variable for an typical
617 :group
'org-export-odt
621 (const :tag
"None" nil
)
622 (alist :tag
"Capabilities"
623 :key-type
(string :tag
"Document Class")
625 (group (repeat :tag
"Input formats" (string :tag
"Input format"))
626 (alist :tag
"Output formats"
627 :key-type
(string :tag
"Output format")
629 (group (string :tag
"Output file extension")
631 (const :tag
"None" nil
)
632 (string :tag
"Extra options"))))))))
634 (defcustom org-odt-preferred-output-format nil
635 "Automatically post-process to this format after exporting to \"odt\".
636 Command `org-odt-export-to-odt' exports first to \"odt\" format
637 and then uses `org-odt-convert-process' to convert the
638 resulting document to this format. During customization of this
639 variable, the list of valid values are populated based on
640 `org-odt-convert-capabilities'.
642 You can set this option on per-file basis using file local
643 values. See Info node `(emacs) File Variables'."
644 :group
'org-export-odt
646 :type
'(choice :convert-widget
648 (apply 'widget-convert
(widget-type w
)
649 (eval (car (widget-get w
:args
)))))
650 `((const :tag
"None" nil
)
651 ,@(mapcar (lambda (c)
653 (org-odt-reachable-formats "odt")))))
655 (put 'org-odt-preferred-output-format
'safe-local-variable
'stringp
)
660 (defcustom org-odt-format-drawer-function
661 (lambda (name contents
) contents
)
662 "Function called to format a drawer in ODT code.
664 The function must accept two parameters:
665 NAME the drawer name, like \"LOGBOOK\"
666 CONTENTS the contents of the drawer.
668 The function should return the string to be exported.
670 The default value simply returns the value of CONTENTS."
671 :group
'org-export-odt
673 :package-version
'(Org .
"8.3")
679 (defcustom org-odt-format-headline-function
680 'org-odt-format-headline-default-function
681 "Function to format headline text.
683 This function will be called with 5 arguments:
684 TODO the todo keyword \(string or nil\).
685 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
686 PRIORITY the priority of the headline \(integer or nil\)
687 TEXT the main headline text \(string\).
688 TAGS the tags string, separated with colons \(string or nil\).
690 The function result will be used as headline text."
691 :group
'org-export-odt
693 :package-version
'(Org .
"8.3")
699 (defcustom org-odt-format-inlinetask-function
700 'org-odt-format-inlinetask-default-function
701 "Function called to format an inlinetask in ODT code.
703 The function must accept six parameters:
704 TODO the todo keyword, as a string
705 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
706 PRIORITY the inlinetask priority, as a string
707 NAME the inlinetask name, as a string.
708 TAGS the inlinetask tags, as a string.
709 CONTENTS the contents of the inlinetask, as a string.
711 The function should return the string to be exported."
712 :group
'org-export-odt
714 :package-version
'(Org .
"8.3")
720 (defcustom org-odt-with-latex org-export-with-latex
721 "Non-nil means process LaTeX math snippets.
723 When set, the exporter will process LaTeX environments and
726 This option can also be set with the +OPTIONS line,
727 e.g. \"tex:mathjax\". Allowed values are:
729 nil Ignore math snippets.
730 `verbatim' Keep everything in verbatim
731 `dvipng' Process the LaTeX fragments to images. This will also
732 include processing of non-math environments.
733 `imagemagick' Convert the LaTeX fragments to pdf files and use
734 imagemagick to convert pdf files to png files.
735 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
737 t Synonym for `mathjax'."
738 :group
'org-export-odt
740 :package-version
'(Org .
"8.0")
742 (const :tag
"Do not process math in any way" nil
)
743 (const :tag
"Use dvipng to make images" dvipng
)
744 (const :tag
"Use imagemagick to make images" imagemagick
)
745 (const :tag
"Use MathJax to display math" mathjax
)
746 (const :tag
"Leave math verbatim" verbatim
)))
751 (defcustom org-odt-inline-formula-rules
752 '(("file" .
"\\.\\(mathml\\|mml\\|odf\\)\\'"))
753 "Rules characterizing formula files that can be inlined into ODT.
755 A rule consists in an association whose key is the type of link
756 to consider, and value is a regexp that will be matched against
758 :group
'org-export-odt
760 :package-version
'(Org .
"8.0")
761 :type
'(alist :key-type
(string :tag
"Type")
762 :value-type
(regexp :tag
"Path")))
764 (defcustom org-odt-inline-image-rules
765 '(("file" .
"\\.\\(jpeg\\|jpg\\|png\\|gif\\)\\'"))
766 "Rules characterizing image files that can be inlined into ODT.
768 A rule consists in an association whose key is the type of link
769 to consider, and value is a regexp that will be matched against
771 :group
'org-export-odt
773 :package-version
'(Org .
"8.0")
774 :type
'(alist :key-type
(string :tag
"Type")
775 :value-type
(regexp :tag
"Path")))
777 (defcustom org-odt-pixels-per-inch
96.0
778 "Scaling factor for converting images pixels to inches.
779 Use this for sizing of embedded images. See Info node `(org)
780 Images in ODT export' for more information."
782 :group
'org-export-odt
784 :package-version
'(Org .
"8.1"))
789 (defcustom org-odt-create-custom-styles-for-srcblocks t
790 "Whether custom styles for colorized source blocks be automatically created.
791 When this option is turned on, the exporter creates custom styles
792 for source blocks based on the advice of `htmlfontify'. Creation
793 of custom styles happen as part of `org-odt-hfy-face-to-css'.
795 When this option is turned off exporter does not create such
798 Use the latter option if you do not want the custom styles to be
799 based on your current display settings. It is necessary that the
800 styles.xml already contains needed styles for colorizing to work.
802 This variable is effective only if `org-odt-fontify-srcblocks' is
804 :group
'org-export-odt
808 (defcustom org-odt-fontify-srcblocks t
809 "Specify whether or not source blocks need to be fontified.
810 Turn this option on if you want to colorize the source code
811 blocks in the exported file. For colorization to work, you need
812 to make available an enhanced version of `htmlfontify' library."
814 :group
'org-export-odt
820 (defcustom org-odt-table-styles
821 '(("OrgEquation" "OrgEquation"
822 ((use-first-column-styles . t
)
823 (use-last-column-styles . t
)))
824 ("TableWithHeaderRowAndColumn" "Custom"
825 ((use-first-row-styles . t
)
826 (use-first-column-styles . t
)))
827 ("TableWithFirstRowandLastRow" "Custom"
828 ((use-first-row-styles . t
)
829 (use-last-row-styles . t
)))
830 ("GriddedTable" "Custom" nil
))
831 "Specify how Table Styles should be derived from a Table Template.
832 This is a list where each element is of the
833 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
835 TABLE-STYLE-NAME is the style associated with the table through
836 \"#+ATTR_ODT: :style TABLE-STYLE-NAME\" line.
838 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
839 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
840 below) that is included in `org-odt-content-template-file'.
842 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
844 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
846 TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
847 \"FirstRow\" | \"LastRow\" |
848 \"EvenRow\" | \"OddRow\" |
849 \"EvenColumn\" | \"OddColumn\" | \"\"
850 where \"+\" above denotes string concatenation.
852 TABLE-CELL-OPTIONS is an alist where each element is of the
853 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
854 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
855 `use-last-row-styles' |
856 `use-first-column-styles' |
857 `use-last-column-styles' |
858 `use-banding-rows-styles' |
859 `use-banding-columns-styles' |
860 `use-first-row-styles'
861 ON-OR-OFF := `t' | `nil'
863 For example, with the following configuration
865 \(setq org-odt-table-styles
866 '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
867 \(\(use-first-row-styles . t\)
868 \(use-first-column-styles . t\)\)\)
869 \(\"TableWithHeaderColumns\" \"Custom\"
870 \(\(use-first-column-styles . t\)\)\)\)\)
872 1. A table associated with \"TableWithHeaderRowsAndColumns\"
873 style will use the following table-cell styles -
874 \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
875 \"CustomTableCell\" and the following paragraph styles
876 \"CustomFirstRowTableParagraph\",
877 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
880 2. A table associated with \"TableWithHeaderColumns\" style will
881 use the following table-cell styles -
882 \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
883 following paragraph styles
884 \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
887 Note that TABLE-TEMPLATE-NAME corresponds to the
888 \"<table:table-template>\" elements contained within
889 \"<office:styles>\". The entries (TABLE-STYLE-NAME
890 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
891 \"table:template-name\" and \"table:use-first-row-styles\" etc
892 attributes of \"<table:table>\" element. Refer ODF-1.2
893 specification for more information. Also consult the
894 implementation filed under `org-odt-get-table-cell-styles'.
896 The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
897 formatting of numbered display equations. Do not delete this
898 style from the list."
899 :group
'org-export-odt
902 (const :tag
"None" nil
)
903 (repeat :tag
"Table Styles"
904 (list :tag
"Table Style Specification"
905 (string :tag
"Table Style Name")
906 (string :tag
"Table Template Name")
907 (alist :options
(use-first-row-styles
909 use-first-column-styles
910 use-last-column-styles
911 use-banding-rows-styles
912 use-banding-columns-styles
)
914 :value-type
(const :tag
"True" t
))))))
918 (defcustom org-odt-use-date-fields nil
919 "Non-nil, if timestamps should be exported as date fields.
921 When nil, export timestamps as plain text.
923 When non-nil, map `org-time-stamp-custom-formats' to a pair of
924 OpenDocument date-styles with names \"OrgDate1\" and \"OrgDate2\"
925 respectively. A timestamp with no time component is formatted
926 with style \"OrgDate1\" while one with explicit hour and minutes
927 is formatted with style \"OrgDate2\".
929 This feature is experimental. Most (but not all) of the common
930 %-specifiers in `format-time-string' are supported.
931 Specifically, locale-dependent specifiers like \"%c\", \"%x\" are
932 formatted as canonical Org timestamps. For finer control, avoid
935 Textual specifiers like \"%b\", \"%h\", \"%B\", \"%a\", \"%A\"
936 etc., are displayed by the application in the default language
937 and country specified in `org-odt-styles-file'. Note that the
938 default styles file uses language \"en\" and country \"GB\". You
939 can localize the week day and month strings in the exported
940 document by setting the default language and country either using
941 the application UI or through a custom styles file.
943 See `org-odt--build-date-styles' for implementation details."
944 :group
'org-export-odt
946 :package-version
'(Org .
"8.0")
951 ;;; Internal functions
955 (defun org-odt--format-timestamp (timestamp &optional end iso-date-p
)
956 (let* ((format-timestamp
957 (lambda (timestamp format
&optional end utc
)
959 (org-timestamp-format timestamp format end utc
)
960 (format-time-string format nil utc
))))
961 (has-time-p (or (not timestamp
)
962 (org-timestamp-has-time-p timestamp
)))
963 (iso-date (let ((format (if has-time-p
"%Y-%m-%dT%H:%M:%S"
964 "%Y-%m-%dT%H:%M:%S")))
965 (funcall format-timestamp timestamp format end
))))
966 (if iso-date-p iso-date
967 (let* ((style (if has-time-p
"OrgDate2" "OrgDate1"))
968 ;; LibreOffice does not care about end goes as content
969 ;; within the "<text:date>...</text:date>" field. The
970 ;; displayed date is automagically corrected to match the
971 ;; format requested by "style:data-style-name" attribute. So
972 ;; don't bother about formatting the date contents to be
973 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
974 ;; simple Org-style date should suffice.
975 (date (let* ((formats
976 (if org-display-custom-times
978 (car org-time-stamp-custom-formats
) 1 -
1)
980 (cdr org-time-stamp-custom-formats
) 1 -
1))
981 '("%Y-%m-%d %a" .
"%Y-%m-%d %a %H:%M")))
982 (format (if has-time-p
(cdr formats
) (car formats
))))
983 (funcall format-timestamp timestamp format end
)))
984 (repeater (let ((repeater-type (org-element-property
985 :repeater-type timestamp
))
986 (repeater-value (org-element-property
987 :repeater-value timestamp
))
988 (repeater-unit (org-element-property
989 :repeater-unit timestamp
)))
992 (catchup "++") (restart ".+") (cumulate "+"))
994 (number-to-string repeater-value
))
996 (hour "h") (day "d") (week "w") (month "m")
999 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1000 iso-date style date
)
1001 (and (not (string= repeater
"")) " ")
1006 (defun org-odt--frame (text width height style
&optional extra
1007 anchor-type
&rest title-and-desc
)
1010 (if width
(format " svg:width=\"%0.2fcm\"" width
) "")
1011 (if height
(format " svg:height=\"%0.2fcm\"" height
) "")
1013 (format " text:anchor-type=\"%s\"" (or anchor-type
"paragraph"))
1014 (format " draw:name=\"%s\""
1015 (car (org-odt-add-automatic-style "Frame"))))))
1017 "\n<draw:frame draw:style-name=\"%s\"%s>\n%s\n</draw:frame>"
1020 (let ((title (car title-and-desc
))
1021 (desc (cadr title-and-desc
)))
1023 (format "<svg:title>%s</svg:title>"
1024 (org-odt--encode-plain-text title t
)))
1026 (format "<svg:desc>%s</svg:desc>"
1027 (org-odt--encode-plain-text desc t
)))))))))
1030 ;;;; Library wrappers
1032 (defun org-odt--zip-extract (archive members target
)
1033 (when (atom members
) (setq members
(list members
)))
1034 (mapc (lambda (member)
1036 (let* ((--quote-file-name
1037 ;; This is shamelessly stolen from `archive-zip-extract'.
1039 (if (or (not (memq system-type
'(windows-nt ms-dos
)))
1040 (and (boundp 'w32-quote-process-args
)
1041 (null w32-quote-process-args
)))
1042 (shell-quote-argument name
)
1044 (target (funcall --quote-file-name target
))
1045 (archive (expand-file-name archive
))
1046 (archive-zip-extract
1047 (list "unzip" "-qq" "-o" "-d" target
))
1048 exit-code command-output
)
1049 (setq command-output
1051 (setq exit-code
(archive-zip-extract archive member
))
1053 (unless (zerop exit-code
)
1054 (message command-output
)
1055 (error "Extraction failed"))))
1060 (defun org-odt--target (text id
)
1063 (format "\n<text:bookmark-start text:name=\"OrgXref.%s\"/>" id
)
1064 (format "\n<text:bookmark text:name=\"%s\"/>" id
) text
1065 (format "\n<text:bookmark-end text:name=\"OrgXref.%s\"/>" id
))))
1069 (defun org-odt--textbox (text width height style
&optional
1072 (format "\n<draw:text-box %s>%s\n</draw:text-box>"
1073 (concat (format " fo:min-height=\"%0.2fcm\"" (or height
.2))
1075 (format " fo:min-width=\"%0.2fcm\"" (or width
.2))))
1077 width nil style extra anchor-type
))
1081 ;;;; Table of Contents
1083 (defun org-odt--format-toc (title entries depth
)
1084 "Return a table of contents.
1085 TITLE is the title of the table, as a string, or nil. ENTRIES is
1086 the contents of the table, as a string. DEPTH is an integer
1087 specifying the depth of the table."
1090 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1091 (format " <text:table-of-content-source text:outline-level=\"%d\">" depth
)
1094 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1098 (let ((levels (number-sequence 1 10)))
1103 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1104 <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
1105 <text:index-entry-chapter/>
1106 <text:index-entry-text/>
1107 <text:index-entry-link-end/>
1108 </text:table-of-content-entry-template>\n"
1109 level level
)) levels
""))
1111 </text:table-of-content-source>
1115 <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
1116 <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
1117 </text:index-title>\n"
1122 </text:table-of-content>"))
1124 (defun* org-odt-format-toc-headline
1125 (todo todo-type priority text tags
1126 &key level section-number headline-label
&allow-other-keys
)
1130 (and section-number
(concat section-number
". "))
1133 (let ((style (if (member todo org-done-keywords
)
1134 "OrgDone" "OrgTodo")))
1135 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1138 (let* ((style (format "OrgPriority-%s" priority
))
1139 (priority (format "[#%c]" priority
)))
1140 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1147 (format " <text:span text:style-name=\"%s\">[%s]</text:span>"
1152 "<text:span text:style-name=\"%s\">%s</text:span>"
1153 "OrgTag" tag
)) tags
" : "))))))
1154 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
1155 headline-label text
))
1157 (defun org-odt-toc (depth info
&optional scope
)
1158 "Build a table of contents.
1159 DEPTH is an integer specifying the depth of the table. INFO is
1160 a plist containing current export properties. Optional argument
1161 SCOPE, when non-nil, defines the scope of the table. Return the
1162 table of contents as a string, or nil."
1163 (assert (wholenump depth
))
1164 ;; When a headline is marked as a radio target, as in the example below:
1166 ;; ** <<<Some Heading>>>
1169 ;; suppress generation of radio targets. i.e., Radio targets are to
1170 ;; be marked as targets within /document body/ and *not* within
1171 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1172 ;; and one in the document body.
1174 ;; FIXME: Are there any other objects that need to be suppressed
1176 (let* ((headlines (org-export-collect-headlines info depth scope
))
1177 (backend (org-export-create-backend
1178 :parent
(org-export-backend-name (plist-get info
:back-end
))
1179 :transcoders
(mapcar
1180 (lambda (type) (cons type
(lambda (d c i
) c
)))
1181 (list 'radio-target
)))))
1183 (org-odt--format-toc
1184 (and (not scope
) (org-export-translate "Table of Contents" :utf-8 info
))
1187 (let* ((entry (org-odt-format-headline--wrap
1188 headline backend info
'org-odt-format-toc-headline
))
1189 (level (org-export-get-relative-level headline info
))
1190 (style (format "Contents_20_%d" level
)))
1191 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1197 ;;;; Document styles
1199 (defun org-odt-add-automatic-style (object-type &optional object-props
)
1200 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1201 OBJECT-PROPS is (typically) a plist created by passing
1202 \"#+ATTR_ODT: \" option of the object in question to
1203 `org-odt-parse-block-attributes'.
1205 Use `org-odt-object-counters' to generate an automatic
1206 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1207 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1209 (assert (stringp object-type
))
1210 (let* ((object (intern object-type
))
1212 (seqno (1+ (or (plist-get org-odt-object-counters seqvar
) 0)))
1213 (object-name (format "%s%d" object-type seqno
)) style-name
)
1214 (setq org-odt-object-counters
1215 (plist-put org-odt-object-counters seqvar seqno
))
1217 (setq style-name
(format "Org%s" object-name
))
1218 (setq org-odt-automatic-styles
1219 (plist-put org-odt-automatic-styles object
1220 (append (list (list style-name object-props
))
1221 (plist-get org-odt-automatic-styles object
)))))
1222 (cons object-name style-name
)))
1226 (defun org-odt--checkbox (item)
1227 "Return check-box string associated to ITEM."
1228 (let ((checkbox (org-element-property :checkbox item
)))
1229 (if (not checkbox
) ""
1230 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1231 "OrgCode" (case checkbox
1232 (on "[✓] ") ; CHECK MARK
1238 (defun org-odt--build-date-styles (fmt style
)
1239 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1240 ;; to modify the date fields. A date could be modified by
1241 ;; offsetting in days. That's about it. Also, date and time may
1242 ;; have to be emitted as two fields - a date field and a time field
1245 ;; One can add Form Controls to date and time fields so that they
1246 ;; can be easily modified. But then, the exported document will
1247 ;; become tightly coupled with LibreOffice and may not function
1248 ;; properly with other OpenDocument applications.
1250 ;; I have a strange feeling that Date styles are a bit flaky at the
1253 ;; The feature is experimental.
1254 (when (and fmt style
)
1256 '(("%A" .
"<number:day-of-week number:style=\"long\"/>")
1257 ("%B" .
"<number:month number:textual=\"true\" number:style=\"long\"/>")
1258 ("%H" .
"<number:hours number:style=\"long\"/>")
1259 ("%M" .
"<number:minutes number:style=\"long\"/>")
1260 ("%S" .
"<number:seconds number:style=\"long\"/>")
1261 ("%V" .
"<number:week-of-year/>")
1262 ("%Y" .
"<number:year number:style=\"long\"/>")
1263 ("%a" .
"<number:day-of-week number:style=\"short\"/>")
1264 ("%b" .
"<number:month number:textual=\"true\" number:style=\"short\"/>")
1265 ("%d" .
"<number:day number:style=\"long\"/>")
1266 ("%e" .
"<number:day number:style=\"short\"/>")
1267 ("%h" .
"<number:month number:textual=\"true\" number:style=\"short\"/>")
1268 ("%k" .
"<number:hours number:style=\"short\"/>")
1269 ("%m" .
"<number:month number:style=\"long\"/>")
1270 ("%p" .
"<number:am-pm/>")
1271 ("%y" .
"<number:year number:style=\"short\"/>")))
1272 (case-fold-search nil
)
1273 (re (mapconcat 'identity
(mapcar 'car fmt-alist
) "\\|"))
1274 match rpl
(start 0) (filler-beg 0) filler-end filler output
)
1277 (setq fmt
(replace-regexp-in-string (car pair
) (cdr pair
) fmt t t
)))
1278 '(("\\(?:%[[:digit:]]*N\\)" .
"") ; strip ns, us and ns
1279 ("%C" .
"Y") ; replace century with year
1281 ("%G" .
"Y") ; year corresponding to iso week
1282 ("%I" .
"%H") ; hour on a 12-hour clock
1285 ("%U\\|%W" .
"%V") ; week no. starting on Sun./Mon.
1286 ("%Z" .
"") ; time zone name
1287 ("%c" .
"%Y-%M-%d %a %H:%M" ) ; locale's date and time format
1289 ("%X" .
"%x" ) ; locale's pref. time format
1290 ("%j" .
"") ; day of the year
1291 ("%l" .
"%k") ; like %I blank-padded
1292 ("%s" .
"") ; no. of secs since 1970-01-01 00:00:00 +0000
1293 ("%n" .
"<text:line-break/>")
1294 ("%r" .
"%I:%M:%S %p")
1295 ("%t" .
"<text:tab/>")
1296 ("%u\\|%w" .
"") ; numeric day of week - Mon (1-7), Sun(0-6)
1297 ("%x" .
"%Y-%M-%d %a") ; locale's pref. time format
1298 ("%z" .
"") ; time zone in numeric form
1300 (while (string-match re fmt start
)
1301 (setq match
(match-string 0 fmt
))
1302 (setq rpl
(assoc-default match fmt-alist
))
1303 (setq start
(match-end 0))
1304 (setq filler-end
(match-beginning 0))
1305 (setq filler
(substring fmt
(prog1 filler-beg
1306 (setq filler-beg
(match-end 0)))
1308 (setq filler
(and (not (string= filler
""))
1309 (format "<number:text>%s</number:text>"
1310 (org-odt--encode-plain-text filler
))))
1311 (setq output
(concat output
"\n" filler
"\n" rpl
)))
1312 (setq filler
(substring fmt filler-beg
))
1313 (unless (string= filler
"")
1314 (setq output
(concat output
1315 (format "\n<number:text>%s</number:text>"
1316 (org-odt--encode-plain-text filler
)))))
1317 (format "\n<number:date-style style:name=\"%s\" %s>%s\n</number:date-style>"
1319 (concat " number:automatic-order=\"true\""
1320 " number:format-source=\"fixed\"")
1323 (defun org-odt-template (contents info
)
1324 "Return complete document string after ODT conversion.
1325 CONTENTS is the transcoded contents string. RAW-DATA is the
1326 original parsed data. INFO is a plist holding export options."
1328 (let ((title (org-export-data (plist-get info
:title
) info
))
1329 (author (let ((author (plist-get info
:author
)))
1330 (if (not author
) "" (org-export-data author info
))))
1331 (email (plist-get info
:email
))
1332 (keywords (plist-get info
:keywords
))
1333 (description (plist-get info
:description
)))
1336 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
1337 <office:document-meta
1338 xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
1339 xmlns:xlink=\"http://www.w3.org/1999/xlink\"
1340 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
1341 xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
1342 xmlns:ooo=\"http://openoffice.org/2004/office\"
1343 office:version=\"1.2\">
1345 (format "<dc:creator>%s</dc:creator>\n" author
)
1346 (format "<meta:initial-creator>%s</meta:initial-creator>\n" author
)
1347 ;; Date, if required.
1348 (when (plist-get info
:with-date
)
1349 ;; Check if DATE is specified as an Org-timestamp. If yes,
1350 ;; include it as meta information. Otherwise, just use
1352 (let* ((date (let ((date (plist-get info
:date
)))
1353 (and (not (cdr date
))
1354 (eq (org-element-type (car date
)) 'timestamp
)
1356 (let ((iso-date (org-odt--format-timestamp date nil
'iso-date
)))
1358 (format "<dc:date>%s</dc:date>\n" iso-date
)
1359 (format "<meta:creation-date>%s</meta:creation-date>\n"
1361 (format "<meta:generator>%s</meta:generator>\n"
1362 (let ((creator-info (plist-get info
:with-creator
)))
1363 (if (or (not creator-info
) (eq creator-info
'comment
)) ""
1364 (plist-get info
:creator
))))
1365 (format "<meta:keyword>%s</meta:keyword>\n" keywords
)
1366 (format "<dc:subject>%s</dc:subject>\n" description
)
1367 (format "<dc:title>%s</dc:title>\n" title
)
1369 " </office:meta>\n" "</office:document-meta>")
1370 nil
(concat org-odt-zip-dir
"meta.xml"))
1371 ;; Add meta.xml in to manifest.
1372 (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
1374 ;; Update styles file.
1375 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1376 ;; Write styles file.
1377 (let* ((styles-file (plist-get info
:odt-styles-file
))
1378 (styles-file (and styles-file
(read (org-trim styles-file
))))
1379 ;; Non-availability of styles.xml is not a critical
1380 ;; error. For now, throw an error.
1381 (styles-file (or styles-file
1382 (plist-get info
:odt-styles-file
)
1383 (expand-file-name "OrgOdtStyles.xml"
1385 (error "org-odt: Missing styles file?"))))
1387 ((listp styles-file
)
1388 (let ((archive (nth 0 styles-file
))
1389 (members (nth 1 styles-file
)))
1390 (org-odt--zip-extract archive members org-odt-zip-dir
)
1393 (when (org-file-image-p member
)
1394 (let* ((image-type (file-name-extension member
))
1395 (media-type (format "image/%s" image-type
)))
1396 (org-odt-create-manifest-file-entry media-type member
))))
1398 ((and (stringp styles-file
) (file-exists-p styles-file
))
1399 (let ((styles-file-type (file-name-extension styles-file
)))
1401 ((string= styles-file-type
"xml")
1402 (copy-file styles-file
(concat org-odt-zip-dir
"styles.xml") t
))
1403 ((member styles-file-type
'("odt" "ott"))
1404 (org-odt--zip-extract styles-file
"styles.xml" org-odt-zip-dir
)))))
1406 (error (format "Invalid specification of styles.xml file: %S"
1407 (plist-get info
:odt-styles-file
)))))
1409 ;; create a manifest entry for styles.xml
1410 (org-odt-create-manifest-file-entry "text/xml" "styles.xml")
1412 ;; FIXME: Who is opening an empty styles.xml before this point?
1413 (with-current-buffer
1414 (find-file-noselect (concat org-odt-zip-dir
"styles.xml") t
)
1417 ;; Write custom styles for source blocks
1418 ;; Save STYLES used for colorizing of source blocks.
1419 ;; Update styles.xml with styles that were collected as part of
1420 ;; `org-odt-hfy-face-to-css' callbacks.
1421 (let ((styles (mapconcat (lambda (style) (format " %s\n" (cddr style
)))
1422 hfy-user-sheet-assoc
"")))
1424 (goto-char (point-min))
1425 (when (re-search-forward "</office:styles>" nil t
)
1426 (goto-char (match-beginning 0))
1427 (insert "\n<!-- Org Htmlfontify Styles -->\n" styles
"\n"))))
1429 ;; Update styles.xml - take care of outline numbering
1431 ;; Don't make automatic backup of styles.xml file. This setting
1432 ;; prevents the backed-up styles.xml file from being zipped in to
1433 ;; odt file. This is more of a hackish fix. Better alternative
1434 ;; would be to fix the zip command so that the output odt file
1435 ;; includes only the needed files and excludes any auto-generated
1436 ;; extra files like backups and auto-saves etc etc. Note that
1437 ;; currently the zip command zips up the entire temp directory so
1438 ;; that any auto-generated files created under the hood ends up in
1439 ;; the resulting odt file.
1440 (set (make-local-variable 'backup-inhibited
) t
)
1442 ;; Outline numbering is retained only upto LEVEL.
1443 ;; To disable outline numbering pass a LEVEL of 0.
1445 (goto-char (point-min))
1447 "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
1449 "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
1450 (while (re-search-forward regex nil t
)
1451 (unless (let ((sec-num (plist-get info
:section-numbers
))
1452 (level (string-to-number (match-string 2))))
1453 (if (wholenump sec-num
) (<= level sec-num
) sec-num
))
1454 (replace-match replacement t nil
))))
1456 ;; Update content.xml.
1458 (let* ( ;; `org-display-custom-times' should be accessed right
1459 ;; within the context of the Org buffer. So obtain its
1460 ;; value before moving on to temp-buffer context down below.
1462 (if org-display-custom-times
1463 (cons (substring (car org-time-stamp-custom-formats
) 1 -
1)
1464 (substring (cdr org-time-stamp-custom-formats
) 1 -
1))
1465 '("%Y-%M-%d %a" .
"%Y-%M-%d %a %H:%M"))))
1467 (insert-file-contents
1468 (or (plist-get info
:odt-content-template-file
)
1469 (expand-file-name "OrgOdtContentTemplate.xml"
1470 org-odt-styles-dir
)))
1471 ;; Write automatic styles.
1472 ;; - Position the cursor.
1473 (goto-char (point-min))
1474 (re-search-forward " </office:automatic-styles>" nil t
)
1475 (goto-char (match-beginning 0))
1476 ;; - Dump automatic table styles.
1477 (loop for
(style-name props
) in
1478 (plist-get org-odt-automatic-styles
'Table
) do
1479 (when (setq props
(or (plist-get props
:rel-width
) "96"))
1480 (insert (format org-odt-table-style-format style-name props
))))
1481 ;; - Dump date-styles.
1482 (when (plist-get info
:odt-use-date-fields
)
1483 (insert (org-odt--build-date-styles (car custom-time-fmts
)
1485 (org-odt--build-date-styles (cdr custom-time-fmts
)
1487 ;; Update display level.
1488 ;; - Remove existing sequence decls. Also position the cursor.
1489 (goto-char (point-min))
1490 (when (re-search-forward "<text:sequence-decls" nil t
)
1491 (delete-region (match-beginning 0)
1492 (re-search-forward "</text:sequence-decls>" nil nil
)))
1493 ;; Update sequence decls according to user preference.
1496 "\n<text:sequence-decls>\n%s\n</text:sequence-decls>"
1500 "<text:sequence-decl text:display-outline-level=\"%d\" text:name=\"%s\"/>"
1501 (plist-get info
:odt-display-outline-level
)
1503 org-odt-category-map-alist
"\n")))
1504 ;; Position the cursor to document body.
1505 (goto-char (point-min))
1506 (re-search-forward "</office:text>" nil nil
)
1507 (goto-char (match-beginning 0))
1509 ;; Preamble - Title, Author, Date etc.
1511 (let* ((title (org-export-data (plist-get info
:title
) info
))
1512 (author (and (plist-get info
:with-author
)
1513 (let ((auth (plist-get info
:author
)))
1514 (and auth
(org-export-data auth info
)))))
1515 (email (plist-get info
:email
))
1516 ;; Switch on or off above vars based on user settings
1517 (author (and (plist-get info
:with-author
) (or author email
)))
1518 (email (and (plist-get info
:with-email
) email
)))
1521 (when (org-string-nw-p title
)
1523 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1524 "OrgTitle" (format "\n<text:title>%s</text:title>" title
))
1526 "\n<text:p text:style-name=\"OrgTitle\"/>"))
1528 ((and author
(not email
))
1531 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1533 (format "<text:initial-creator>%s</text:initial-creator>" author
))
1535 "\n<text:p text:style-name=\"OrgSubtitle\"/>"))
1537 ;; Author and E-mail.
1540 "\n<text:p text:style-name=\"%s\">%s</text:p>"
1543 "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
1544 (concat "mailto:" email
)
1545 (format "<text:initial-creator>%s</text:initial-creator>" author
)))
1547 "\n<text:p text:style-name=\"OrgSubtitle\"/>")))
1548 ;; Date, if required.
1549 (when (plist-get info
:with-date
)
1550 (let* ((date (plist-get info
:date
))
1551 ;; Check if DATE is specified as a timestamp.
1552 (timestamp (and (not (cdr date
))
1553 (eq (org-element-type (car date
)) 'timestamp
)
1556 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1558 (if (and (plist-get info
:odt-use-date-fields
) timestamp
)
1559 (org-odt--format-timestamp (car date
))
1560 (org-export-data (plist-get info
:date
) info
)))
1562 "<text:p text:style-name=\"OrgSubtitle\"/>"))))))
1563 ;; Table of Contents
1564 (let* ((with-toc (plist-get info
:with-toc
))
1565 (depth (and with-toc
(if (wholenump with-toc
)
1567 (plist-get info
:headline-levels
)))))
1568 (when depth
(insert (or (org-odt-toc depth info
) ""))))
1572 (buffer-substring-no-properties (point-min) (point-max)))))
1576 ;;; Transcode Functions
1580 (defun org-odt-bold (bold contents info
)
1581 "Transcode BOLD from Org to ODT.
1582 CONTENTS is the text with bold markup. INFO is a plist holding
1583 contextual information."
1584 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1590 (defun org-odt-center-block (center-block contents info
)
1591 "Transcode a CENTER-BLOCK element from Org to ODT.
1592 CONTENTS holds the contents of the center block. INFO is a plist
1593 holding contextual information."
1599 (defun org-odt-clock (clock contents info
)
1600 "Transcode a CLOCK element from Org to ODT.
1601 CONTENTS is nil. INFO is a plist used as a communication
1603 (let ((timestamp (org-element-property :value clock
))
1604 (duration (org-element-property :duration clock
)))
1605 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1606 (if (eq (org-element-type (org-export-get-next-element clock info
))
1607 'clock
) "OrgClock" "OrgClockLastLine")
1609 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1610 "OrgClockKeyword" org-clock-string
)
1611 (org-odt-timestamp timestamp contents info
)
1612 (and duration
(format " (%s)" duration
))))))
1617 (defun org-odt-code (code contents info
)
1618 "Transcode a CODE object from Org to ODT.
1619 CONTENTS is nil. INFO is a plist used as a communication
1621 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1622 "OrgCode" (org-odt--encode-plain-text
1623 (org-element-property :value code
))))
1628 ;; Comments are ignored.
1633 ;; Comment Blocks are ignored.
1638 (defun org-odt-drawer (drawer contents info
)
1639 "Transcode a DRAWER element from Org to ODT.
1640 CONTENTS holds the contents of the block. INFO is a plist
1641 holding contextual information."
1642 (let* ((name (org-element-property :drawer-name drawer
))
1643 (output (funcall (plist-get info
:odt-format-drawer-function
)
1650 (defun org-odt-dynamic-block (dynamic-block contents info
)
1651 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1652 CONTENTS holds the contents of the block. INFO is a plist
1653 holding contextual information. See `org-export-data'."
1659 (defun org-odt-entity (entity contents info
)
1660 "Transcode an ENTITY object from Org to ODT.
1661 CONTENTS are the definition itself. INFO is a plist holding
1662 contextual information."
1663 (org-element-property :utf-8 entity
))
1668 (defun org-odt-example-block (example-block contents info
)
1669 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1670 CONTENTS is nil. INFO is a plist holding contextual information."
1671 (org-odt-format-code example-block info
))
1676 (defun org-odt-export-snippet (export-snippet contents info
)
1677 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1678 CONTENTS is nil. INFO is a plist holding contextual information."
1679 (when (eq (org-export-snippet-backend export-snippet
) 'odt
)
1680 (org-element-property :value export-snippet
)))
1685 (defun org-odt-export-block (export-block contents info
)
1686 "Transcode a EXPORT-BLOCK element from Org to ODT.
1687 CONTENTS is nil. INFO is a plist holding contextual information."
1688 (when (string= (org-element-property :type export-block
) "ODT")
1689 (org-remove-indentation (org-element-property :value export-block
))))
1694 (defun org-odt-fixed-width (fixed-width contents info
)
1695 "Transcode a FIXED-WIDTH element from Org to ODT.
1696 CONTENTS is nil. INFO is a plist holding contextual information."
1697 (org-odt-do-format-code (org-element-property :value fixed-width
) info
))
1700 ;;;; Footnote Definition
1702 ;; Footnote Definitions are ignored.
1705 ;;;; Footnote Reference
1707 (defun org-odt-footnote-reference (footnote-reference contents info
)
1708 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1709 CONTENTS is nil. INFO is a plist holding contextual information."
1710 (let ((--format-footnote-definition
1713 (setq n
(format "%d" n
))
1714 (let ((id (concat "fn" n
))
1715 (note-class "footnote")
1716 (par-style "Footnote"))
1718 "<text:note text:id=\"%s\" text:note-class=\"%s\">%s</text:note>"
1721 (format "<text:note-citation>%s</text:note-citation>" n
)
1722 (format "<text:note-body>%s</text:note-body>" def
)))))))
1723 (--format-footnote-reference
1726 (setq n
(format "%d" n
))
1727 (let ((note-class "footnote")
1729 (ref-name (concat "fn" n
)))
1731 "<text:span text:style-name=\"%s\">%s</text:span>"
1733 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1734 note-class ref-format ref-name n
)))))))
1736 ;; Insert separator between two footnotes in a row.
1737 (let ((prev (org-export-get-previous-element footnote-reference info
)))
1738 (and (eq (org-element-type prev
) 'footnote-reference
)
1739 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1740 "OrgSuperscript" ",")))
1741 ;; Transcode footnote reference.
1742 (let ((n (org-export-get-footnote-number footnote-reference info
)))
1744 ((not (org-export-footnote-first-reference-p footnote-reference info
))
1745 (funcall --format-footnote-reference n
))
1746 ;; Inline definitions are secondary strings.
1747 ;; Non-inline footnotes definitions are full Org data.
1749 (let* ((raw (org-export-get-footnote-definition
1750 footnote-reference info
))
1752 (let ((def (org-trim
1753 (org-export-data-with-backend
1755 (org-export-create-backend
1758 '((paragraph .
(lambda (p c i
)
1759 (org-odt--format-paragraph
1763 "OrgFootnoteQuotations")))))
1765 (if (eq (org-element-type raw
) 'org-data
) def
1766 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1768 (funcall --format-footnote-definition n def
))))))))
1773 (defun org-odt-format-headline--wrap (headline backend info
1774 &optional format-function
1776 "Transcode a HEADLINE element using BACKEND.
1777 INFO is a plist holding contextual information."
1778 (setq backend
(or backend
(plist-get info
:back-end
)))
1779 (let* ((level (+ (org-export-get-relative-level headline info
)))
1780 (headline-number (org-export-get-headline-number headline info
))
1781 (section-number (and (org-export-numbered-headline-p headline info
)
1782 (mapconcat 'number-to-string
1783 headline-number
".")))
1784 (todo (and (plist-get info
:with-todo-keywords
)
1785 (let ((todo (org-element-property :todo-keyword headline
)))
1787 (org-export-data-with-backend todo backend info
)))))
1788 (todo-type (and todo
(org-element-property :todo-type headline
)))
1789 (priority (and (plist-get info
:with-priority
)
1790 (org-element-property :priority headline
)))
1791 (text (org-export-data-with-backend
1792 (org-element-property :title headline
) backend info
))
1793 (tags (and (plist-get info
:with-tags
)
1794 (org-export-get-tags headline info
)))
1795 (headline-label (org-export-get-headline-id headline info
))
1797 (if (functionp format-function
) format-function
1799 (lambda (todo todo-type priority text tags
1800 &key level section-number headline-label
1802 (funcall (plist-get info
:odt-format-headline-function
)
1803 todo todo-type priority text tags
))))))
1804 (apply format-function
1805 todo todo-type priority text tags
1806 :headline-label headline-label
:level level
1807 :section-number section-number extra-keys
)))
1809 (defun org-odt-headline (headline contents info
)
1810 "Transcode a HEADLINE element from Org to ODT.
1811 CONTENTS holds the contents of the headline. INFO is a plist
1812 holding contextual information."
1813 ;; Case 1: This is a footnote section: ignore it.
1814 (unless (org-element-property :footnote-section-p headline
)
1815 (let* ((text (org-export-data (org-element-property :title headline
) info
))
1816 ;; Create the headline text.
1817 (full-text (org-odt-format-headline--wrap headline nil info
))
1818 ;; Get level relative to current parsed data.
1819 (level (org-export-get-relative-level headline info
))
1820 (numbered (org-export-numbered-headline-p headline info
))
1821 ;; Get canonical label for the headline.
1822 (id (org-export-get-headline-id headline info
))
1823 ;; Get user-specified labels for the headline.
1824 (extra-ids (list (org-element-property :CUSTOM_ID headline
)
1825 (org-element-property :ID headline
)))
1828 (mapconcat (lambda (x)
1830 (let ((x (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
1832 "" (org-export-solidify-link-text x
)))))
1835 (anchored-title (org-odt--target full-text id
)))
1837 ;; Case 2. This is a deep sub-tree: export it as a list item.
1838 ;; Also export as items headlines for which no section
1839 ;; format has been found.
1840 ((org-export-low-level-p headline info
)
1841 ;; Build the real contents of the sub-tree.
1843 (and (org-export-first-sibling-p headline info
)
1844 (format "\n<text:list text:style-name=\"%s\" %s>"
1845 ;; Choose style based on list type.
1846 (if numbered
"OrgNumberedList" "OrgBulletedList")
1847 ;; If top-level list, re-start numbering. Otherwise,
1848 ;; continue numbering.
1849 (format "text:continue-numbering=\"%s\""
1850 (let* ((parent (org-export-get-parent-headline
1853 (org-export-low-level-p parent info
))
1855 (let ((headline-has-table-p
1856 (let ((section (assq 'section
(org-element-contents headline
))))
1857 (assq 'table
(and section
(org-element-contents section
))))))
1858 (format "\n<text:list-item>\n%s\n%s"
1860 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1862 (concat extra-targets anchored-title
))
1864 (if headline-has-table-p
1865 "</text:list-header>"
1866 "</text:list-item>")))
1867 (and (org-export-last-sibling-p headline info
)
1869 ;; Case 3. Standard headline. Export it as a section.
1873 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1874 (format "Heading_20_%s%s"
1875 level
(if numbered
"" "_unnumbered"))
1877 (if numbered
"false" "true")
1878 (concat extra-targets anchored-title
))
1881 (defun org-odt-format-headline-default-function
1882 (todo todo-type priority text tags
)
1883 "Default format function for a headline.
1884 See `org-odt-format-headline-function' for details."
1888 (let ((style (if (eq todo-type
'done
) "OrgDone" "OrgTodo")))
1889 (format "<text:span text:style-name=\"%s\">%s</text:span> " style todo
)))
1891 (let* ((style (format "OrgPriority-%s" priority
))
1892 (priority (format "[#%c]" priority
)))
1893 (format "<text:span text:style-name=\"%s\">%s</text:span> "
1901 (format "<text:span text:style-name=\"%s\">[%s]</text:span>"
1902 "OrgTags" (mapconcat
1905 "<text:span text:style-name=\"%s\">%s</text:span>"
1906 "OrgTag" tag
)) tags
" : "))))))
1909 ;;;; Horizontal Rule
1911 (defun org-odt-horizontal-rule (horizontal-rule contents info
)
1912 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1913 CONTENTS is nil. INFO is a plist holding contextual information."
1914 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1915 "Horizontal_20_Line" ""))
1918 ;;;; Inline Babel Call
1920 ;; Inline Babel Calls are ignored.
1923 ;;;; Inline Src Block
1925 (defun org-odt--find-verb-separator (s)
1926 "Return a character not used in string S.
1927 This is used to choose a separator for constructs like \\verb."
1928 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1929 (loop for c across ll
1930 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
1931 return
(char-to-string c
))))
1933 (defun org-odt-inline-src-block (inline-src-block contents info
)
1934 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1935 CONTENTS holds the contents of the item. INFO is a plist holding
1936 contextual information."
1937 (let* ((org-lang (org-element-property :language inline-src-block
))
1938 (code (org-element-property :value inline-src-block
))
1939 (separator (org-odt--find-verb-separator code
)))
1945 (defun org-odt-inlinetask (inlinetask contents info
)
1946 "Transcode an INLINETASK element from Org to ODT.
1947 CONTENTS holds the contents of the block. INFO is a plist
1948 holding contextual information."
1950 (and (plist-get info
:with-todo-keywords
)
1951 (let ((todo (org-element-property :todo-keyword inlinetask
)))
1952 (and todo
(org-export-data todo info
)))))
1953 (todo-type (and todo
(org-element-property :todo-type inlinetask
)))
1954 (priority (and (plist-get info
:with-priority
)
1955 (org-element-property :priority inlinetask
)))
1956 (text (org-export-data (org-element-property :title inlinetask
) info
))
1957 (tags (and (plist-get info
:with-tags
)
1958 (org-export-get-tags inlinetask info
))))
1959 (funcall (plist-get info
:odt-format-inlinetask-function
)
1960 todo todo-type priority text tags contents
)))
1962 (defun org-odt-format-inlinetask-default-function
1963 (todo todo-type priority name tags contents
)
1964 "Default format function for a inlinetasks.
1965 See `org-odt-format-inlinetask-function' for details."
1966 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1970 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
1971 "OrgInlineTaskHeading"
1972 (org-odt-format-headline-default-function
1973 todo todo-type priority name tags
))
1975 nil nil
"OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
1979 (defun org-odt-italic (italic contents info
)
1980 "Transcode ITALIC from Org to ODT.
1981 CONTENTS is the text with italic markup. INFO is a plist holding
1982 contextual information."
1983 (format "<text:span text:style-name=\"%s\">%s</text:span>"
1984 "Emphasis" contents
))
1989 (defun org-odt-item (item contents info
)
1990 "Transcode an ITEM element from Org to ODT.
1991 CONTENTS holds the contents of the item. INFO is a plist holding
1992 contextual information."
1993 (let* ((plain-list (org-export-get-parent item
))
1994 (type (org-element-property :type plain-list
))
1995 (counter (org-element-property :counter item
))
1996 (tag (let ((tag (org-element-property :tag item
)))
1998 (concat (org-odt--checkbox item
)
1999 (org-export-data tag info
))))))
2001 ((ordered unordered descriptive-1 descriptive-2
)
2002 (format "\n<text:list-item>\n%s\n%s"
2004 (let* ((--element-has-a-table-p
2006 (lambda (element info
)
2007 (loop for el in
(org-element-contents element
)
2008 thereis
(eq (org-element-type el
) 'table
))))))
2010 ((funcall --element-has-a-table-p item info
)
2011 "</text:list-header>")
2012 (t "</text:list-item>")))))
2013 (t (error "Unknown list type: %S" type
)))))
2017 (defun org-odt-keyword (keyword contents info
)
2018 "Transcode a KEYWORD element from Org to ODT.
2019 CONTENTS is nil. INFO is a plist holding contextual
2021 (let ((key (org-element-property :key keyword
))
2022 (value (org-element-property :value keyword
)))
2024 ((string= key
"ODT") value
)
2025 ((string= key
"INDEX")
2028 ((string= key
"TOC")
2029 (let ((case-fold-search t
))
2031 ((org-string-match-p "\\<headlines\\>" value
)
2032 (let ((depth (or (and (string-match "\\<[0-9]+\\>" value
)
2033 (string-to-number (match-string 0 value
)))
2034 (plist-get info
:headline-levels
)))
2035 (localp (org-string-match-p "\\<local\\>" value
)))
2036 (org-odt-toc depth info
(and localp keyword
))))
2037 ((org-string-match-p "tables\\|figures\\|listings" value
)
2042 ;;;; Latex Environment
2045 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2046 ;; (defadvice org-format-latex-as-mathml ; FIXME
2047 ;; (after org-odt-protect-latex-fragment activate)
2048 ;; "Encode LaTeX fragment as XML.
2049 ;; Do this when translation to MathML fails."
2050 ;; (unless (> (length ad-return-value) 0)
2051 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2053 (defun org-odt-latex-environment (latex-environment contents info
)
2054 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2055 CONTENTS is nil. INFO is a plist holding contextual information."
2056 (let* ((latex-frag (org-remove-indentation
2057 (org-element-property :value latex-environment
))))
2058 (org-odt-do-format-code latex-frag info
)))
2063 ;; (when latex-frag ; FIXME
2064 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2065 ;; :description latex-frag)))
2067 ;; provide descriptions
2069 (defun org-odt-latex-fragment (latex-fragment contents info
)
2070 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2071 CONTENTS is nil. INFO is a plist holding contextual information."
2072 (let* ((latex-frag (org-element-property :value latex-fragment
))
2073 (processing-type (plist-get info
:with-latex
)))
2074 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2075 "OrgCode" (org-odt--encode-plain-text latex-frag t
))))
2080 (defun org-odt-line-break (line-break contents info
)
2081 "Transcode a LINE-BREAK object from Org to ODT.
2082 CONTENTS is nil. INFO is a plist holding contextual information."
2083 "<text:line-break/>")
2088 ;;;; Links :: Label references
2090 (defun org-odt--enumerate (element info
&optional predicate n
)
2091 (when predicate
(assert (funcall predicate element info
)))
2092 (let* ((--numbered-parent-headline-at-<=-n
2094 (lambda (element n info
)
2095 (loop for x in
(org-element-lineage element
)
2096 thereis
(and (eq (org-element-type x
) 'headline
)
2097 (<= (org-export-get-relative-level x info
) n
)
2098 (org-export-numbered-headline-p x info
)
2102 (lambda (element scope info
&optional predicate
)
2104 (org-element-map (or scope
(plist-get info
:parse-tree
))
2105 (org-element-type element
)
2107 (and (or (not predicate
) (funcall predicate el info
))
2111 info
'first-match
)))))
2112 (scope (funcall --numbered-parent-headline-at-
<=-n
2114 (or n
(plist-get info
:odt-display-outline-level
))
2116 (ordinal (funcall --enumerate element scope info predicate
))
2121 (mapconcat 'number-to-string
2122 (org-export-get-headline-number scope info
) "."))
2126 (number-to-string ordinal
))))
2129 (defun org-odt-format-label (element info op
)
2130 "Return a label for ELEMENT.
2132 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2133 element. INFO is a plist used as a communication channel. OP is
2134 either `definition' or `reference', depending on the purpose of
2135 the generated string.
2137 Return value is a string if OP is set to `reference' or a cons
2138 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2139 SHORT-CAPTION are strings."
2140 (assert (memq (org-element-type element
) '(link table src-block paragraph
)))
2141 (let* ((caption-from
2142 (case (org-element-type element
)
2143 (link (org-export-get-parent-element element
))
2145 ;; Get label and caption.
2146 (label (org-element-property :name caption-from
))
2147 (caption (org-export-get-caption caption-from
))
2148 (caption (and caption
(org-export-data caption info
)))
2149 ;; FIXME: We don't use short-caption for now
2150 (short-caption nil
))
2151 (when (or label caption
)
2152 (let* ((default-category
2153 (case (org-element-type element
)
2155 (src-block "__Listing__")
2158 ((org-odt--enumerable-latex-image-p element info
)
2160 ((org-odt--enumerable-image-p element info
)
2162 ((org-odt--enumerable-formula-p element info
)
2164 (t (error "Don't know how to format label for link: %S"
2166 (t (error "Don't know how to format label for element type: %s"
2167 (org-element-type element
)))))
2169 (assert default-category
)
2170 (destructuring-bind (counter label-style category predicate
)
2171 (assoc-default default-category org-odt-category-map-alist
)
2172 ;; Compute sequence number of the element.
2173 (setq seqno
(org-odt--enumerate element info predicate
))
2174 ;; Localize category string.
2175 (setq category
(org-export-translate category
:utf-8 info
))
2177 ;; Case 1: Handle Label definition.
2179 ;; Assign an internal label, if user has not provided one
2180 (setq label
(org-export-solidify-link-text
2181 (or label
(format "%s-%s" default-category seqno
))))
2184 ;; Sneak in a bookmark. The bookmark is used when the
2185 ;; labeled element is referenced with a link that
2186 ;; provides its own description.
2187 (format "\n<text:bookmark text:name=\"%s\"/>" label
)
2188 ;; Label definition: Typically formatted as below:
2189 ;; CATEGORY SEQ-NO: LONG CAPTION
2190 ;; with translation for correct punctuation.
2192 (org-export-translate
2193 (cadr (assoc-string label-style org-odt-label-styles t
))
2197 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2198 label counter counter seqno
))
2199 (?c .
,(or caption
"")))))
2201 ;; Case 2: Handle Label reference.
2204 (setq label
(org-export-solidify-link-text label
))
2205 (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t
)))
2208 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2209 fmt1 label
(format-spec fmt2
`((?e .
,category
)
2211 (t (error "Unknown %S on label" op
))))))))
2214 ;;;; Links :: Inline Images
2216 (defun org-odt--copy-image-file (path)
2217 "Returns the internal name of the file"
2218 (let* ((image-type (file-name-extension path
))
2219 (media-type (format "image/%s" image-type
))
2220 (target-dir "Images/")
2222 (format "%s%04d.%s" target-dir
2223 (incf org-odt-embedded-images-count
) image-type
)))
2224 (message "Embedding %s as %s..."
2225 (substring-no-properties path
) target-file
)
2227 (when (= 1 org-odt-embedded-images-count
)
2228 (make-directory (concat org-odt-zip-dir target-dir
))
2229 (org-odt-create-manifest-file-entry "" target-dir
))
2231 (copy-file path
(concat org-odt-zip-dir target-file
) 'overwrite
)
2232 (org-odt-create-manifest-file-entry media-type target-file
)
2235 (defun org-odt--image-size
2236 (file info
&optional user-width user-height scale dpi embed-as
)
2237 (let* ((--pixels-to-cms
2238 (function (lambda (pixels dpi
)
2239 (let ((cms-per-inch 2.54)
2240 (inches (/ pixels dpi
)))
2241 (* cms-per-inch inches
)))))
2244 (lambda (size-in-pixels dpi
)
2246 (cons (funcall --pixels-to-cms
(car size-in-pixels
) dpi
)
2247 (funcall --pixels-to-cms
(cdr size-in-pixels
) dpi
))))))
2248 (dpi (or dpi
(plist-get info
:odt-pixels-per-inch
)))
2249 (anchor-type (or embed-as
"paragraph"))
2250 (user-width (and (not scale
) user-width
))
2251 (user-height (and (not scale
) user-height
))
2254 (not (and user-height user-width
))
2257 (and (executable-find "identify")
2258 (let ((size-in-pixels
2259 (let ((dim (shell-command-to-string
2260 (format "identify -format \"%%w:%%h\" \"%s\""
2262 (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim
)
2263 (cons (string-to-number (match-string 1 dim
))
2264 (string-to-number (match-string 2 dim
)))))))
2265 (funcall --size-in-cms size-in-pixels dpi
)))
2267 (let ((size-in-pixels
2268 (ignore-errors ; Emacs could be in batch mode
2270 (image-size (create-image file
) 'pixels
))))
2271 (funcall --size-in-cms size-in-pixels dpi
))
2272 ;; Use hard-coded values.
2273 (cdr (assoc-string anchor-type
2274 org-odt-default-image-sizes-alist
))
2276 (error "Cannot determine image size, aborting"))))
2277 (width (car size
)) (height (cdr size
)))
2280 (setq width
(* width scale
) height
(* height scale
)))
2281 ((and user-height user-width
)
2282 (setq width user-width height user-height
))
2284 (setq width
(* user-height
(/ width height
)) height user-height
))
2286 (setq height
(* user-width
(/ height width
)) width user-width
))
2288 ;; ensure that an embedded image fits comfortably within a page
2289 (let ((max-width (car org-odt-max-image-size
))
2290 (max-height (cdr org-odt-max-image-size
)))
2291 (when (or (> width max-width
) (> height max-height
))
2292 (let* ((scale1 (/ max-width width
))
2293 (scale2 (/ max-height height
))
2294 (scale (min scale1 scale2
)))
2295 (setq width
(* scale width
) height
(* scale height
)))))
2296 (cons width height
)))
2298 (defun org-odt-link--inline-image (element info
)
2299 "Return ODT code for an inline image.
2300 LINK is the link pointing to the inline image. INFO is a plist
2301 used as a communication channel."
2302 (assert (eq (org-element-type element
) 'link
))
2303 (let* ((src (let* ((type (org-element-property :type element
))
2304 (raw-path (org-element-property :path element
)))
2305 (cond ((member type
'("http" "https"))
2306 (concat type
":" raw-path
))
2307 ((file-name-absolute-p raw-path
)
2308 (expand-file-name raw-path
))
2310 (src-expanded (if (file-name-absolute-p src
) src
2311 (expand-file-name src
(file-name-directory
2312 (plist-get info
:input-file
)))))
2314 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2315 (org-odt--copy-image-file src-expanded
)))
2316 ;; Extract attributes from #+ATTR_ODT line.
2317 (attr-from (case (org-element-type element
)
2318 (link (org-export-get-parent-element element
))
2320 ;; Convert attributes to a plist.
2321 (attr-plist (org-export-read-attribute :attr_odt attr-from
))
2322 ;; Handle `:anchor', `:style' and `:attributes' properties.
2324 (car (assoc-string (plist-get attr-plist
:anchor
)
2325 '(("as-char") ("paragraph") ("page")) t
)))
2327 (and user-frame-anchor
(plist-get attr-plist
:style
)))
2329 (and user-frame-anchor
(plist-get attr-plist
:attributes
)))
2331 (list user-frame-style user-frame-attrs user-frame-anchor
))
2332 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2334 ;; Handle `:width', `:height' and `:scale' properties. Read
2335 ;; them as numbers since we need them for computations.
2336 (size (org-odt--image-size
2338 (let ((width (plist-get attr-plist
:width
)))
2339 (and width
(read width
)))
2340 (let ((length (plist-get attr-plist
:length
)))
2341 (and length
(read length
)))
2342 (let ((scale (plist-get attr-plist
:scale
)))
2343 (and scale
(read scale
)))
2347 (width (car size
)) (height (cdr size
))
2348 (standalone-link-p (org-odt--standalone-link-p element info
))
2349 (embed-as (if standalone-link-p
"paragraph" "as-char"))
2350 (captions (org-odt-format-label element info
'definition
))
2351 (caption (car captions
)) (short-caption (cdr captions
))
2352 (entity (concat (and caption
"Captioned") embed-as
"Image"))
2353 ;; Check if this link was created by LaTeX-to-PNG converter.
2354 (replaces (org-element-property
2355 :replaces
(if (not standalone-link-p
) element
2356 (org-export-get-parent-element element
))))
2357 ;; If yes, note down the type of the element - LaTeX Fragment
2358 ;; or LaTeX environment. It will go in to frame title.
2359 (title (and replaces
(capitalize
2360 (symbol-name (org-element-type replaces
)))))
2362 ;; If yes, note down its contents. It will go in to frame
2363 ;; description. This quite useful for debugging.
2364 (desc (and replaces
(org-element-property :value replaces
))))
2365 (org-odt--render-image/formula entity href width height
2366 captions user-frame-params title desc
)))
2369 ;;;; Links :: Math formula
2371 (defun org-odt-link--inline-formula (element info
)
2372 (let* ((src (let* ((type (org-element-property :type element
))
2373 (raw-path (org-element-property :path element
)))
2375 ((file-name-absolute-p raw-path
)
2376 (expand-file-name raw-path
))
2378 (src-expanded (if (file-name-absolute-p src
) src
2379 (expand-file-name src
(file-name-directory
2380 (plist-get info
:input-file
)))))
2383 "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
2384 " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
2385 (file-name-directory (org-odt--copy-formula-file src-expanded
))))
2386 (standalone-link-p (org-odt--standalone-link-p element info
))
2387 (embed-as (if standalone-link-p
'paragraph
'character
))
2388 (captions (org-odt-format-label element info
'definition
))
2389 (caption (car captions
)) (short-caption (cdr captions
))
2390 ;; Check if this link was created by LaTeX-to-MathML
2392 (replaces (org-element-property
2393 :replaces
(if (not standalone-link-p
) element
2394 (org-export-get-parent-element element
))))
2395 ;; If yes, note down the type of the element - LaTeX Fragment
2396 ;; or LaTeX environment. It will go in to frame title.
2397 (title (and replaces
(capitalize
2398 (symbol-name (org-element-type replaces
)))))
2400 ;; If yes, note down its contents. It will go in to frame
2401 ;; description. This quite useful for debugging.
2402 (desc (and replaces
(org-element-property :value replaces
)))
2405 ((eq embed-as
'character
)
2406 (org-odt--render-image/formula
"InlineFormula" href width height
2407 nil nil title desc
))
2409 (let* ((equation (org-odt--render-image/formula
2410 "CaptionedDisplayFormula" href width height
2411 captions nil title desc
))
2413 (let* ((org-odt-category-map-alist
2414 '(("__MathFormula__" "Text" "math-label" "Equation"
2415 org-odt--enumerable-formula-p
))))
2416 (car (org-odt-format-label element info
'definition
)))))
2417 (concat equation
"<text:tab/>" label
))))))
2419 (defun org-odt--copy-formula-file (src-file)
2420 "Returns the internal name of the file"
2421 (let* ((target-dir (format "Formula-%04d/"
2422 (incf org-odt-embedded-formulas-count
)))
2423 (target-file (concat target-dir
"content.xml")))
2424 ;; Create a directory for holding formula file. Also enter it in
2426 (make-directory (concat org-odt-zip-dir target-dir
))
2427 (org-odt-create-manifest-file-entry
2428 "application/vnd.oasis.opendocument.formula" target-dir
"1.2")
2429 ;; Copy over the formula file from user directory to zip
2431 (message "Embedding %s as %s..." src-file target-file
)
2432 (let ((case-fold-search nil
))
2435 ((string-match "\\.\\(mathml\\|mml\\)\\'" src-file
)
2436 (copy-file src-file
(concat org-odt-zip-dir target-file
) 'overwrite
))
2437 ;; Case 2: OpenDocument formula.
2438 ((string-match "\\.odf\\'" src-file
)
2439 (org-odt--zip-extract src-file
"content.xml"
2440 (concat org-odt-zip-dir target-dir
)))
2441 (t (error "%s is not a formula file" src-file
))))
2442 ;; Enter the formula file in to manifest.
2443 (org-odt-create-manifest-file-entry "text/xml" target-file
)
2448 (defun org-odt--render-image/formula
(cfg-key href width height
&optional
2449 captions user-frame-params
2450 &rest title-and-desc
)
2451 (let* ((frame-cfg-alist
2452 ;; Each element of this alist is of the form (CFG-HANDLE
2453 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2455 ;; CFG-HANDLE is the key to the alist.
2457 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2458 ;; frame params for INNER-FRAME and OUTER-FRAME
2459 ;; respectively. See below.
2461 ;; Configurations that are meant to be applied to
2462 ;; non-captioned image/formula specifies no
2463 ;; OUTER-FRAME-PARAMS.
2467 ;; INNER-FRAME :: Frame that directly surrounds an
2470 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2471 ;; frame also contains the caption, if any.
2473 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2474 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2475 ;; that these are the last three arguments
2476 ;; to `org-odt--frame'.
2478 ;; Note that an un-captioned image/formula requires just an
2479 ;; INNER-FRAME, while a captioned image/formula requires
2480 ;; both an INNER and an OUTER-FRAME.
2481 '(("As-CharImage" ("OrgInlineImage" nil
"as-char"))
2482 ("ParagraphImage" ("OrgDisplayImage" nil
"paragraph"))
2483 ("PageImage" ("OrgPageImage" nil
"page"))
2484 ("CaptionedAs-CharImage"
2485 ("OrgCaptionedImage"
2486 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2487 ("OrgInlineImage" nil
"as-char"))
2488 ("CaptionedParagraphImage"
2489 ("OrgCaptionedImage"
2490 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2491 ("OrgImageCaptionFrame" nil
"paragraph"))
2492 ("CaptionedPageImage"
2493 ("OrgCaptionedImage"
2494 " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
2495 ("OrgPageImageCaptionFrame" nil
"page"))
2496 ("InlineFormula" ("OrgInlineFormula" nil
"as-char"))
2497 ("DisplayFormula" ("OrgDisplayFormula" nil
"as-char"))
2498 ("CaptionedDisplayFormula"
2499 ("OrgCaptionedFormula" nil
"paragraph")
2500 ("OrgFormulaCaptionFrame" nil
"paragraph"))))
2501 (caption (car captions
)) (short-caption (cdr captions
))
2502 ;; Retrieve inner and outer frame params, from configuration.
2503 (frame-cfg (assoc-string cfg-key frame-cfg-alist t
))
2504 (inner (nth 1 frame-cfg
))
2505 (outer (nth 2 frame-cfg
))
2506 ;; User-specified frame params (from #+ATTR_ODT spec)
2507 (user user-frame-params
)
2508 (--merge-frame-params (function
2509 (lambda (default user
)
2510 "Merge default and user frame params."
2511 (if (not user
) default
2512 (assert (= (length default
) 3))
2513 (assert (= (length user
) 3))
2516 collect
(or u d
)))))))
2518 ;; Case 1: Image/Formula has no caption.
2519 ;; There is only one frame, one that surrounds the image
2522 ;; Merge user frame params with that from configuration.
2523 (setq inner
(funcall --merge-frame-params inner user
))
2524 (apply 'org-odt--frame href width height
2525 (append inner title-and-desc
)))
2526 ;; Case 2: Image/Formula is captioned or labeled.
2527 ;; There are two frames: The inner one surrounds the
2528 ;; image or formula. The outer one contains the
2529 ;; caption/sequence number.
2531 ;; Merge user frame params with outer frame params.
2532 (setq outer
(funcall --merge-frame-params outer user
))
2533 ;; Short caption, if specified, goes as part of inner frame.
2534 (setq inner
(let ((frame-params (copy-sequence inner
)))
2535 (setcar (cdr frame-params
)
2539 (format " draw:name=\"%s\" " short-caption
))))
2541 (apply 'org-odt--textbox
2542 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2545 (apply 'org-odt--frame href width height
2546 (append inner title-and-desc
))
2548 width height outer
)))))
2550 (defun org-odt--enumerable-p (element info
)
2551 ;; Element should have a caption or label.
2552 (or (org-element-property :caption element
)
2553 (org-element-property :name element
)))
2555 (defun org-odt--enumerable-image-p (element info
)
2556 (org-odt--standalone-link-p
2558 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2559 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2562 (and (not (org-element-property :replaces p
))
2563 (or (org-element-property :caption p
)
2564 (org-element-property :name p
))))
2565 ;; Link should point to an image file.
2567 (assert (eq (org-element-type l
) 'link
))
2568 (org-export-inline-image-p l
(plist-get info
:odt-inline-image-rules
)))))
2570 (defun org-odt--enumerable-latex-image-p (element info
)
2571 (org-odt--standalone-link-p
2573 ;; Paragraph should have a caption or label. It SHOULD also be a
2574 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2577 (and (org-element-property :replaces p
)
2578 (or (org-element-property :caption p
)
2579 (org-element-property :name p
))))
2580 ;; Link should point to an image file.
2582 (assert (eq (org-element-type l
) 'link
))
2583 (org-export-inline-image-p l
(plist-get info
:odt-inline-image-rules
)))))
2585 (defun org-odt--enumerable-formula-p (element info
)
2586 (org-odt--standalone-link-p
2588 ;; Paragraph should have a caption or label.
2590 (or (org-element-property :caption p
)
2591 (org-element-property :name p
)))
2592 ;; Link should point to a MathML or ODF file.
2594 (assert (eq (org-element-type l
) 'link
))
2595 (org-export-inline-image-p l
(plist-get info
:odt-inline-formula-rules
)))))
2597 (defun org-odt--standalone-link-p (element info
&optional
2600 "Test if ELEMENT is a standalone link for the purpose ODT export.
2601 INFO is a plist holding contextual information.
2603 Return non-nil, if ELEMENT is of type paragraph satisfying
2604 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2605 is a link that satisfies LINK-PREDICATE.
2607 Return non-nil, if ELEMENT is of type link satisfying
2608 LINK-PREDICATE and its containing paragraph satisfies
2609 PARAGRAPH-PREDICATE in addition to having no other content save for
2610 leading and trailing whitespaces.
2612 Return nil, otherwise."
2613 (let ((p (case (org-element-type element
)
2615 (link (and (or (not link-predicate
)
2616 (funcall link-predicate element
))
2617 (org-export-get-parent element
)))
2619 (when (and p
(eq (org-element-type p
) 'paragraph
))
2620 (when (or (not paragraph-predicate
)
2621 (funcall paragraph-predicate p
))
2622 (let ((contents (org-element-contents p
)))
2623 (loop for x in contents
2624 with inline-image-count
= 0
2625 always
(case (org-element-type x
)
2627 (not (org-string-nw-p x
)))
2629 (and (or (not link-predicate
)
2630 (funcall link-predicate x
))
2631 (= (incf inline-image-count
) 1)))
2634 (defun org-odt-link--infer-description (destination info
)
2635 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2636 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2637 ;; attached. Note that labels that are attached to captioned
2638 ;; entities - inline images, math formulae and tables - get resolved
2639 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2641 ;; Create a cross-reference to DESTINATION but make best-efforts to
2642 ;; create a *meaningful* description. Check item numbers, section
2643 ;; number and section title in that order.
2645 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2646 ;; FIXME: Handle footnote-definition footnote-reference?
2647 (let* ((genealogy (org-element-lineage destination
))
2648 (data (reverse genealogy
))
2649 (label (case (org-element-type destination
)
2650 (headline (org-export-get-headline-id destination info
))
2652 (org-element-property :value destination
))
2653 (t (error "FIXME: Resolve %S" destination
)))))
2655 (let* ( ;; Locate top-level list.
2658 when
(eq (org-element-type (car x
)) 'plain-list
)
2660 ;; Get list item nos.
2662 (loop for
(plain-list item . rest
) on top-level-list by
#'cddr
2663 until
(not (eq (org-element-type plain-list
) 'plain-list
))
2664 collect
(when (eq (org-element-property :type
2667 (1+ (length (org-export-get-previous-element
2669 ;; Locate top-most listified headline.
2670 (listified-headlines
2672 when
(and (eq (org-element-type (car x
)) 'headline
)
2673 (org-export-low-level-p (car x
) info
))
2675 ;; Get listified headline numbers.
2676 (listified-headline-nos
2677 (loop for el in listified-headlines
2678 when
(eq (org-element-type el
) 'headline
)
2679 collect
(when (org-export-numbered-headline-p el info
)
2680 (1+ (length (org-export-get-previous-element
2682 ;; Combine item numbers from both the listified headlines and
2683 ;; regular list items.
2685 ;; Case 1: Check if all the parents of list item are numbered.
2686 ;; If yes, link to the item proper.
2687 (let ((item-numbers (append listified-headline-nos item-numbers
)))
2688 (when (and item-numbers
(not (memq nil item-numbers
)))
2689 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2690 (org-export-solidify-link-text label
)
2691 (mapconcat (lambda (n) (if (not n
) " "
2692 (concat (number-to-string n
) ".")))
2693 item-numbers
"")))))
2694 ;; Case 2: Locate a regular and numbered headline in the
2695 ;; hierarchy. Display its section number.
2698 ;; Test if destination is a numbered headline.
2699 (org-export-numbered-headline-p destination info
)
2700 (loop for el in
(cons destination genealogy
)
2701 when
(and (eq (org-element-type el
) 'headline
)
2702 (not (org-export-low-level-p el info
))
2703 (org-export-numbered-headline-p el info
))
2707 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2708 (org-export-solidify-link-text label
)
2709 (mapconcat 'number-to-string
(org-export-get-headline-number
2710 headline info
) "."))))
2711 ;; Case 4: Locate a regular headline in the hierarchy. Display
2713 (let ((headline (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
)))
2719 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2720 (org-export-solidify-link-text label
)
2721 (let ((title (org-element-property :title headline
)))
2722 (org-export-data title info
)))))
2725 (defun org-odt-link (link desc info
)
2726 "Transcode a LINK object from Org to ODT.
2728 DESC is the description part of the link, or the empty string.
2729 INFO is a plist holding contextual information. See
2731 (let* ((type (org-element-property :type link
))
2732 (raw-path (org-element-property :path link
))
2733 ;; Ensure DESC really exists, or set it to nil.
2734 (desc (and (not (string= desc
"")) desc
))
2735 (imagep (org-export-inline-image-p
2736 link
(plist-get info
:odt-inline-image-rules
)))
2738 ((member type
'("http" "https" "ftp" "mailto"))
2739 (concat type
":" raw-path
))
2740 ((and (string= type
"file") (file-name-absolute-p raw-path
))
2741 (concat "file:" raw-path
))
2743 ;; Convert & to & for correct XML representation
2744 (path (replace-regexp-in-string "&" "&" path
)))
2746 ;; Link type is handled by a special function.
2747 ((org-export-custom-protocol-maybe link desc info
))
2749 ((and (not desc
) (org-export-inline-image-p
2750 link
(plist-get info
:odt-inline-image-rules
)))
2751 (org-odt-link--inline-image link info
))
2753 ((and (not desc
) (org-export-inline-image-p
2754 link
(plist-get info
:odt-inline-formula-rules
)))
2755 (org-odt-link--inline-formula link info
))
2756 ;; Radio target: Transcode target's contents and use them as
2757 ;; link's description.
2758 ((string= type
"radio")
2759 (let ((destination (org-export-resolve-radio-link link info
)))
2760 (if (not destination
) desc
2762 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2763 (org-export-solidify-link-text
2764 (org-element-property :value destination
))
2766 ;; Links pointing to a headline: Find destination and build
2767 ;; appropriate referencing command.
2768 ((member type
'("custom-id" "fuzzy" "id"))
2769 (let ((destination (if (string= type
"fuzzy")
2770 (org-export-resolve-fuzzy-link link info
)
2771 (org-export-resolve-id-link link info
))))
2772 (case (org-element-type destination
)
2773 ;; Case 1: Fuzzy link points nowhere.
2775 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2778 (org-export-data (org-element-property :raw-link link
)
2780 ;; Case 2: Fuzzy link points to a headline.
2782 ;; If there's a description, create a hyperlink.
2783 ;; Otherwise, try to provide a meaningful description.
2784 (if (not desc
) (org-odt-link--infer-description destination info
)
2785 (let ((label (or (and (string= type
"custom-id")
2786 (org-element-property :CUSTOM_ID destination
))
2787 (org-export-get-headline-id destination info
))))
2789 "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2791 ;; Case 3: Fuzzy link points to a target.
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
)
2796 (let ((label (org-element-property :value destination
)))
2797 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2798 (org-export-solidify-link-text label
)
2800 ;; Case 4: Fuzzy link points to some element (e.g., an
2801 ;; inline image, a math formula or a table).
2803 (let ((label-reference
2804 (ignore-errors (org-odt-format-label
2805 destination info
'reference
))))
2806 (cond ((not label-reference
)
2807 (org-odt-link--infer-description destination info
))
2808 ;; LINK has no description. Create
2809 ;; a cross-reference showing entity's sequence
2811 ((not desc
) label-reference
)
2812 ;; LINK has description. Insert a hyperlink with
2813 ;; user-provided description.
2815 (let ((label (org-element-property :name destination
)))
2816 (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
2817 (org-export-solidify-link-text label
)
2819 ;; Coderef: replace link with the reference name or the
2820 ;; equivalent line number.
2821 ((string= type
"coderef")
2822 (let* ((line-no (format "%d" (org-export-resolve-coderef path info
)))
2823 (href (concat "coderef-" path
)))
2825 (org-export-get-coderef-format path desc
)
2827 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2829 ;; External link with a description part.
2831 (let ((link-contents (org-element-contents link
)))
2832 ;; Check if description is a link to an inline image.
2833 (if (and (not (cdr link-contents
))
2834 (let ((desc-element (car link-contents
)))
2835 (and (eq (org-element-type desc-element
) 'link
)
2836 (org-export-inline-image-p
2838 (plist-get info
:odt-inline-image-rules
)))))
2839 ;; Format link as a clickable image.
2840 (format "\n<draw:a xlink:type=\"simple\" xlink:href=\"%s\">\n%s\n</draw:a>"
2842 ;; Otherwise, format it as a regular link.
2843 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2845 ;; External link without a description part.
2847 (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
2849 ;; No path, only description. Try to do something useful.
2850 (t (format "<text:span text:style-name=\"%s\">%s</text:span>"
2851 "Emphasis" desc
)))))
2856 (defun org-odt-node-property (node-property contents info
)
2857 "Transcode a NODE-PROPERTY element from Org to ODT.
2858 CONTENTS is nil. INFO is a plist holding contextual
2860 (org-odt--encode-plain-text
2862 (org-element-property :key node-property
)
2863 (let ((value (org-element-property :value node-property
)))
2864 (if value
(concat " " value
) "")))))
2868 (defun org-odt--paragraph-style (paragraph)
2869 "Return style of PARAGRAPH.
2870 Style is a symbol among `quoted', `centered' and nil."
2871 (let ((up paragraph
))
2872 (while (and (setq up
(org-element-property :parent up
))
2873 (not (memq (org-element-type up
)
2874 '(center-block quote-block section
)))))
2875 (case (org-element-type up
)
2876 (center-block 'centered
)
2877 (quote-block 'quoted
))))
2879 (defun org-odt--format-paragraph (paragraph contents info default center quote
)
2880 "Format paragraph according to given styles.
2881 PARAGRAPH is a paragraph type element. CONTENTS is the
2882 transcoded contents of that paragraph, as a string. INFO is
2883 a plist used as a communication channel. DEFAULT, CENTER and
2884 QUOTE are, respectively, style to use when paragraph belongs to
2885 no special environment, a center block, or a quote block."
2886 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2887 (case (org-odt--paragraph-style paragraph
)
2890 (otherwise default
))
2891 ;; If PARAGRAPH is a leading paragraph in an item that has
2892 ;; a checkbox, splice checkbox and paragraph contents
2894 (concat (let ((parent (org-element-property :parent paragraph
)))
2895 (and (eq (org-element-type parent
) 'item
)
2896 (not (org-export-get-previous-element paragraph info
))
2897 (org-odt--checkbox parent
)))
2900 (defun org-odt-paragraph (paragraph contents info
)
2901 "Transcode a PARAGRAPH element from Org to ODT.
2902 CONTENTS is the contents of the paragraph, as a string. INFO is
2903 the plist used as a communication channel."
2904 (org-odt--format-paragraph
2905 paragraph contents info
2906 (or (org-element-property :style paragraph
) "Text_20_body")
2913 (defun org-odt-plain-list (plain-list contents info
)
2914 "Transcode a PLAIN-LIST element from Org to ODT.
2915 CONTENTS is the contents of the list. INFO is a plist holding
2916 contextual information."
2917 (format "\n<text:list text:style-name=\"%s\" %s>\n%s</text:list>"
2918 ;; Choose style based on list type.
2919 (case (org-element-property :type plain-list
)
2920 (ordered "OrgNumberedList")
2921 (unordered "OrgBulletedList")
2922 (descriptive-1 "OrgDescriptionList")
2923 (descriptive-2 "OrgDescriptionList"))
2924 ;; If top-level list, re-start numbering. Otherwise,
2925 ;; continue numbering.
2926 (format "text:continue-numbering=\"%s\""
2927 (let* ((parent (org-export-get-parent plain-list
)))
2928 (if (and parent
(eq (org-element-type parent
) 'item
))
2934 (defun org-odt--encode-tabs-and-spaces (line)
2935 (replace-regexp-in-string
2936 "\\([\t]\\|\\([ ]+\\)\\)"
2939 ((string= s
"\t") "<text:tab/>")
2940 (t (let ((n (length s
)))
2943 ((> n
1) (concat " " (format "<text:s text:c=\"%d\"/>" (1- n
))))
2947 (defun org-odt--encode-plain-text (text &optional no-whitespace-filling
)
2950 (setq text
(replace-regexp-in-string (car pair
) (cdr pair
) text t t
)))
2951 '(("&" .
"&") ("<" .
"<") (">" .
">")))
2952 (if no-whitespace-filling text
2953 (org-odt--encode-tabs-and-spaces text
)))
2955 (defun org-odt-plain-text (text info
)
2956 "Transcode a TEXT string from Org to ODT.
2957 TEXT is the string to transcode. INFO is a plist holding
2958 contextual information."
2959 (let ((output text
))
2960 ;; Protect &, < and >.
2961 (setq output
(org-odt--encode-plain-text output t
))
2962 ;; Handle smart quotes. Be sure to provide original string since
2963 ;; OUTPUT may have been modified.
2964 (when (plist-get info
:with-smart-quotes
)
2965 (setq output
(org-export-activate-smart-quotes output
:utf-8 info text
)))
2966 ;; Convert special strings.
2967 (when (plist-get info
:with-special-strings
)
2971 (replace-regexp-in-string (car pair
) (cdr pair
) output t nil
)))
2972 org-odt-special-string-regexps
))
2973 ;; Handle break preservation if required.
2974 (when (plist-get info
:preserve-breaks
)
2975 (setq output
(replace-regexp-in-string
2976 "\\(\\\\\\\\\\)?[ \t]*\n" "<text:line-break/>" output t
)))
2983 (defun org-odt-planning (planning contents info
)
2984 "Transcode a PLANNING element from Org to ODT.
2985 CONTENTS is nil. INFO is a plist used as a communication
2987 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
2990 (let ((closed (org-element-property :closed planning
)))
2993 (format "<text:span text:style-name=\"%s\">%s</text:span>"
2994 "OrgClosedKeyword" org-closed-string
)
2995 (org-odt-timestamp closed contents info
))))
2996 (let ((deadline (org-element-property :deadline planning
)))
2999 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3000 "OrgDeadlineKeyword" org-deadline-string
)
3001 (org-odt-timestamp deadline contents info
))))
3002 (let ((scheduled (org-element-property :scheduled planning
)))
3005 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3006 "OrgScheduledKeyword" org-deadline-string
)
3007 (org-odt-timestamp scheduled contents info
)))))))
3010 ;;;; Property Drawer
3012 (defun org-odt-property-drawer (property-drawer contents info
)
3013 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3014 CONTENTS holds the contents of the drawer. INFO is a plist
3015 holding contextual information."
3016 (and (org-string-nw-p contents
)
3017 (format "<text:p text:style-name=\"OrgFixedWidthBlock\">%s</text:p>"
3023 (defun org-odt-quote-block (quote-block contents info
)
3024 "Transcode a QUOTE-BLOCK element from Org to ODT.
3025 CONTENTS holds the contents of the block. INFO is a plist
3026 holding contextual information."
3032 (defun org-odt-format-section (text style
&optional name
)
3033 (let ((default-name (car (org-odt-add-automatic-style "Section"))))
3034 (format "\n<text:section text:style-name=\"%s\" %s>\n%s\n</text:section>"
3036 (format "text:name=\"%s\"" (or name default-name
))
3040 (defun org-odt-section (section contents info
) ; FIXME
3041 "Transcode a SECTION element from Org to ODT.
3042 CONTENTS holds the contents of the section. INFO is a plist
3043 holding contextual information."
3048 (defun org-odt-radio-target (radio-target text info
)
3049 "Transcode a RADIO-TARGET object from Org to ODT.
3050 TEXT is the text of the target. INFO is a plist holding
3051 contextual information."
3053 text
(org-export-solidify-link-text
3054 (org-element-property :value radio-target
))))
3059 (defun org-odt-special-block (special-block contents info
)
3060 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3061 CONTENTS holds the contents of the block. INFO is a plist
3062 holding contextual information."
3063 (let ((type (org-element-property :type special-block
))
3064 (attributes (org-export-read-attribute :attr_odt special-block
)))
3067 ((string= type
"annotation")
3068 (let* ((author (or (plist-get attributes
:author
)
3069 (let ((author (plist-get info
:author
)))
3070 (and author
(org-export-data author info
)))))
3071 (date (or (plist-get attributes
:date
)
3072 ;; FIXME: Is `car' right thing to do below?
3073 (car (plist-get info
:date
)))))
3074 (format "\n<text:p>%s</text:p>"
3075 (format "<office:annotation>\n%s\n</office:annotation>"
3078 (format "<dc:creator>%s</dc:creator>" author
))
3080 (format "<dc:date>%s</dc:date>"
3081 (org-odt--format-timestamp date nil
'iso-date
)))
3084 ((string= type
"textbox")
3085 (let ((width (plist-get attributes
:width
))
3086 (height (plist-get attributes
:height
))
3087 (style (plist-get attributes
:style
))
3088 (extra (plist-get attributes
:extra
))
3089 (anchor (plist-get attributes
:anchor
)))
3090 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3091 "Text_20_body" (org-odt--textbox contents width height
3092 style extra anchor
))))
3098 (defun org-odt-hfy-face-to-css (fn)
3099 "Create custom style for face FN.
3100 When FN is the default face, use its foreground and background
3101 properties to create \"OrgSrcBlock\" paragraph style. Otherwise
3102 use its color attribute to create a character style whose name
3103 is obtained from FN. Currently all attributes of FN other than
3106 The style name for a face FN is derived using the following
3107 operations on the face name in that order - de-dash, CamelCase
3108 and prefix with \"OrgSrc\". For example,
3109 `font-lock-function-name-face' is associated with
3110 \"OrgSrcFontLockFunctionNameFace\"."
3111 (let* ((css-list (hfy-face-to-style fn
))
3112 (style-name (concat "OrgSrc"
3114 'capitalize
(split-string
3115 (hfy-face-or-def-to-name fn
) "-")
3117 (color-val (cdr (assoc "color" css-list
)))
3118 (background-color-val (cdr (assoc "background" css-list
)))
3119 (style (and org-odt-create-custom-styles-for-srcblocks
3122 (format org-odt-src-block-paragraph-format
3123 background-color-val color-val
))
3127 <style:style style:name=\"%s\" style:family=\"text\">
3128 <style:text-properties fo:color=\"%s\"/>
3129 </style:style>" style-name color-val
))))))
3130 (cons style-name style
)))
3132 (defun org-odt-htmlfontify-string (line)
3133 (let* ((hfy-html-quote-regex "\\([<\"&> ]\\)")
3134 (hfy-html-quote-map '(("\"" """)
3139 (" " "<text:tab/>")))
3140 (hfy-face-to-css 'org-odt-hfy-face-to-css
)
3141 (hfy-optimisations-1 (copy-sequence hfy-optimisations
))
3142 (hfy-optimisations (add-to-list 'hfy-optimisations-1
3144 (hfy-begin-span-handler
3145 (lambda (style text-block text-id text-begins-block-p
)
3146 (insert (format "<text:span text:style-name=\"%s\">" style
))))
3147 (hfy-end-span-handler (lambda nil
(insert "</text:span>"))))
3148 (org-no-warnings (htmlfontify-string line
))))
3150 (defun org-odt-do-format-code
3151 (code info
&optional lang refs retain-labels num-start
)
3152 (let* ((lang (or (assoc-default lang org-src-lang-modes
) lang
))
3153 (lang-mode (and lang
(intern (format "%s-mode" lang
))))
3154 (code-lines (org-split-string code
"\n"))
3155 (code-length (length code-lines
))
3156 (use-htmlfontify-p (and (functionp lang-mode
)
3157 (plist-get info
:odt-fontify-srcblocks
)
3158 (require 'htmlfontify nil t
)
3159 (fboundp 'htmlfontify-string
)))
3160 (code (if (not use-htmlfontify-p
) code
3166 (fontifier (if use-htmlfontify-p
'org-odt-htmlfontify-string
3167 'org-odt--encode-plain-text
))
3168 (par-style (if use-htmlfontify-p
"OrgSrcBlock"
3169 "OrgFixedWidthBlock"))
3171 (assert (= code-length
(length (org-split-string code
"\n"))))
3173 (org-export-format-code
3175 (lambda (loc line-num ref
)
3177 (concat par-style
(and (= (incf i
) code-length
) "LastLine")))
3179 (setq loc
(concat loc
(and ref retain-labels
(format " (%s)" ref
))))
3180 (setq loc
(funcall fontifier loc
))
3182 (setq loc
(org-odt--target loc
(concat "coderef-" ref
))))
3184 (setq loc
(format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3186 (if (not line-num
) loc
3187 (format "\n<text:list-item>%s\n</text:list-item>" loc
)))
3190 ((not num-start
) code
)
3193 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3194 " text:continue-numbering=\"false\"" code
))
3197 "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
3198 " text:continue-numbering=\"true\"" code
)))))
3200 (defun org-odt-format-code (element info
)
3201 (let* ((lang (org-element-property :language element
))
3202 ;; Extract code and references.
3203 (code-info (org-export-unravel-code element
))
3204 (code (car code-info
))
3205 (refs (cdr code-info
))
3206 ;; Does the src block contain labels?
3207 (retain-labels (org-element-property :retain-labels element
))
3208 ;; Does it have line numbers?
3209 (num-start (case (org-element-property :number-lines element
)
3210 (continued (org-export-get-loc element info
))
3212 (org-odt-do-format-code code info lang refs retain-labels num-start
)))
3214 (defun org-odt-src-block (src-block contents info
)
3215 "Transcode a SRC-BLOCK element from Org to ODT.
3216 CONTENTS holds the contents of the item. INFO is a plist holding
3217 contextual information."
3218 (let* ((lang (org-element-property :language src-block
))
3219 (attributes (org-export-read-attribute :attr_odt src-block
))
3220 (captions (org-odt-format-label src-block info
'definition
))
3221 (caption (car captions
)) (short-caption (cdr captions
)))
3224 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3226 (let ((--src-block (org-odt-format-code src-block info
)))
3227 (if (not (plist-get attributes
:textbox
)) --src-block
3228 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3230 (org-odt--textbox --src-block nil nil nil
)))))))
3233 ;;;; Statistics Cookie
3235 (defun org-odt-statistics-cookie (statistics-cookie contents info
)
3236 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3237 CONTENTS is nil. INFO is a plist holding contextual information."
3238 (let ((cookie-value (org-element-property :value statistics-cookie
)))
3239 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3240 "OrgCode" cookie-value
)))
3245 (defun org-odt-strike-through (strike-through contents info
)
3246 "Transcode STRIKE-THROUGH from Org to ODT.
3247 CONTENTS is the text with strike-through markup. INFO is a plist
3248 holding contextual information."
3249 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3250 "Strikethrough" contents
))
3255 (defun org-odt-subscript (subscript contents info
)
3256 "Transcode a SUBSCRIPT object from Org to ODT.
3257 CONTENTS is the contents of the object. INFO is a plist holding
3258 contextual information."
3259 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3260 "OrgSubscript" contents
))
3265 (defun org-odt-superscript (superscript contents info
)
3266 "Transcode a SUPERSCRIPT object from Org to ODT.
3267 CONTENTS is the contents of the object. INFO is a plist holding
3268 contextual information."
3269 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3270 "OrgSuperscript" contents
))
3275 (defun org-odt-table-style-spec (element info
)
3276 (let* ((table (org-export-get-parent-table element
))
3277 (table-attributes (org-export-read-attribute :attr_odt table
))
3278 (table-style (plist-get table-attributes
:style
)))
3279 (assoc table-style
(plist-get info
:odt-table-styles
))))
3281 (defun org-odt-get-table-cell-styles (table-cell info
)
3282 "Retrieve styles applicable to a table cell.
3283 R and C are (zero-based) row and column numbers of the table
3284 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3285 applicable to the current table. It is nil if the table is not
3286 associated with any style attributes.
3288 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3290 When STYLE-SPEC is nil, style the table cell the conventional way
3291 - choose cell borders based on row and column groupings and
3292 choose paragraph alignment based on `org-col-cookies' text
3294 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3296 When STYLE-SPEC is non-nil, ignore the above cookie and return
3297 styles congruent with the ODF-1.2 specification."
3298 (let* ((table-cell-address (org-export-table-cell-address table-cell info
))
3299 (r (car table-cell-address
)) (c (cdr table-cell-address
))
3300 (style-spec (org-odt-table-style-spec table-cell info
))
3301 (table-dimensions (org-export-table-dimensions
3302 (org-export-get-parent-table table-cell
)
3305 ;; LibreOffice - particularly the Writer - honors neither table
3306 ;; templates nor custom table-cell styles. Inorder to retain
3307 ;; inter-operability with LibreOffice, only automatic styles are
3308 ;; used for styling of table-cells. The current implementation is
3309 ;; congruent with ODF-1.2 specification and hence is
3310 ;; future-compatible.
3312 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3313 ;; which recognizes as many as 16 different cell types - is much
3314 ;; richer. Unfortunately it is NOT amenable to easy configuration
3316 (let* ((template-name (nth 1 style-spec
))
3317 (cell-style-selectors (nth 2 style-spec
))
3320 ((and (cdr (assoc 'use-first-column-styles cell-style-selectors
))
3321 (= c
0)) "FirstColumn")
3322 ((and (cdr (assoc 'use-last-column-styles cell-style-selectors
))
3323 (= (1+ c
) (cdr table-dimensions
)))
3325 ((and (cdr (assoc 'use-first-row-styles cell-style-selectors
))
3326 (= r
0)) "FirstRow")
3327 ((and (cdr (assoc 'use-last-row-styles cell-style-selectors
))
3328 (= (1+ r
) (car table-dimensions
)))
3330 ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors
))
3331 (= (% r
2) 1)) "EvenRow")
3332 ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors
))
3333 (= (% r
2) 0)) "OddRow")
3334 ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors
))
3335 (= (% c
2) 1)) "EvenColumn")
3336 ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors
))
3337 (= (% c
2) 0)) "OddColumn")
3339 (concat template-name cell-type
)))))
3341 (defun org-odt-table-cell (table-cell contents info
)
3342 "Transcode a TABLE-CELL element from Org to ODT.
3343 CONTENTS is nil. INFO is a plist used as a communication
3345 (let* ((table-cell-address (org-export-table-cell-address table-cell info
))
3346 (r (car table-cell-address
))
3347 (c (cdr table-cell-address
))
3348 (horiz-span (or (org-export-table-cell-width table-cell info
) 0))
3349 (table-row (org-export-get-parent table-cell
))
3350 (custom-style-prefix (org-odt-get-table-cell-styles
3354 (and custom-style-prefix
3355 (format "%sTableParagraph" custom-style-prefix
))
3358 ((and (= 1 (org-export-table-row-group table-row info
))
3359 (org-export-table-has-header-p
3360 (org-export-get-parent-table table-row
) info
))
3362 ((let* ((table (org-export-get-parent-table table-cell
))
3363 (table-attrs (org-export-read-attribute :attr_odt table
))
3364 (table-header-columns
3365 (let ((cols (plist-get table-attrs
:header-columns
)))
3366 (and cols
(read cols
)))))
3367 (<= c
(cond ((wholenump table-header-columns
)
3368 (- table-header-columns
1))
3369 (table-header-columns 0)
3372 (t "OrgTableContents"))
3373 (capitalize (symbol-name (org-export-table-cell-alignment
3374 table-cell info
))))))
3377 (and custom-style-prefix
(format "%sTableCell"
3378 custom-style-prefix
))
3381 (when (or (org-export-table-row-starts-rowgroup-p table-row info
)
3383 (when (org-export-table-row-ends-rowgroup-p table-row info
) "B")
3384 (when (and (org-export-table-cell-starts-colgroup-p table-cell info
)
3385 (not (zerop c
)) ) "L"))))
3388 (format " table:style-name=\"%s\"" cell-style-name
)
3389 (and (> horiz-span
0)
3390 (format " table:number-columns-spanned=\"%d\""
3391 (1+ horiz-span
))))))
3392 (unless contents
(setq contents
""))
3394 (assert paragraph-style
)
3395 (format "\n<table:table-cell%s>\n%s\n</table:table-cell>"
3397 (let ((table-cell-contents (org-element-contents table-cell
)))
3398 (if (memq (org-element-type (car table-cell-contents
))
3399 org-element-all-elements
)
3401 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3402 paragraph-style contents
))))
3404 (dotimes (i horiz-span s
)
3405 (setq s
(concat s
"\n<table:covered-table-cell/>"))))
3411 (defun org-odt-table-row (table-row contents info
)
3412 "Transcode a TABLE-ROW element from Org to ODT.
3413 CONTENTS is the contents of the row. INFO is a plist used as a
3414 communication channel."
3415 ;; Rules are ignored since table separators are deduced from
3416 ;; borders of the current row.
3417 (when (eq (org-element-property :type table-row
) 'standard
)
3418 (let* ((rowgroup-tags
3419 (if (and (= 1 (org-export-table-row-group table-row info
))
3420 (org-export-table-has-header-p
3421 (org-export-get-parent-table table-row
) info
))
3422 ;; If the row belongs to the first rowgroup and the
3423 ;; table has more than one row groups, then this row
3424 ;; belongs to the header row group.
3425 '("\n<table:table-header-rows>" .
"\n</table:table-header-rows>")
3426 ;; Otherwise, it belongs to non-header row group.
3427 '("\n<table:table-rows>" .
"\n</table:table-rows>"))))
3429 ;; Does this row begin a rowgroup?
3430 (when (org-export-table-row-starts-rowgroup-p table-row info
)
3431 (car rowgroup-tags
))
3433 (format "\n<table:table-row>\n%s\n</table:table-row>" contents
)
3434 ;; Does this row end a rowgroup?
3435 (when (org-export-table-row-ends-rowgroup-p table-row info
)
3436 (cdr rowgroup-tags
))))))
3441 (defun org-odt-table-first-row-data-cells (table info
)
3443 (org-element-map table
'table-row
3445 (unless (eq (org-element-property :type row
) 'rule
) row
))
3447 (special-column-p (org-export-table-has-special-column-p table
)))
3448 (if (not special-column-p
) (org-element-contents table-row
)
3449 (cdr (org-element-contents table-row
)))))
3451 (defun org-odt--table (table contents info
)
3452 "Transcode a TABLE element from Org to ODT.
3453 CONTENTS is the contents of the table. INFO is a plist holding
3454 contextual information."
3455 (case (org-element-property :type table
)
3456 ;; Case 1: table.el doesn't support export to OD format. Strip
3457 ;; such tables from export.
3462 "(ox-odt): Found table.el-type table in the source Org file."
3463 " table.el doesn't support export to ODT format."
3464 " Stripping the table from export."))))
3465 ;; Case 2: Native Org tables.
3467 (let* ((captions (org-odt-format-label table info
'definition
))
3468 (caption (car captions
)) (short-caption (cdr captions
))
3469 (attributes (org-export-read-attribute :attr_odt table
))
3470 (custom-table-style (nth 1 (org-odt-table-style-spec table info
)))
3473 (lambda (table info
)
3474 (let* ((table-style (or custom-table-style
"OrgTable"))
3475 (column-style (format "%sColumn" table-style
)))
3477 (lambda (table-cell)
3478 (let ((width (1+ (or (org-export-table-cell-width
3479 table-cell info
) 0)))
3481 "\n<table:table-column table:style-name=\"%s\"/>"
3484 (dotimes (i width out
) (setq out
(concat s out
)))))
3485 (org-odt-table-first-row-data-cells table info
) "\n"))))))
3489 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3492 (let* ((automatic-name
3493 (org-odt-add-automatic-style "Table" attributes
)))
3495 "\n<table:table table:style-name=\"%s\"%s>"
3496 (or custom-table-style
(cdr automatic-name
) "OrgTable")
3497 (concat (when short-caption
3498 (format " table:name=\"%s\"" short-caption
)))))
3499 ;; column specification.
3500 (funcall table-column-specs table info
)
3504 "</table:table>")))))
3506 (defun org-odt-table (table contents info
)
3507 "Transcode a TABLE element from Org to ODT.
3508 CONTENTS is the contents of the table. INFO is a plist holding
3509 contextual information.
3511 Use `org-odt--table' to typeset the table. Handle details
3512 pertaining to indentation here."
3513 (let* ((--element-preceded-by-table-p
3515 (lambda (element info
)
3516 (loop for el in
(org-export-get-previous-element element info t
)
3517 thereis
(eq (org-element-type el
) 'table
)))))
3518 (--walk-list-genealogy-and-collect-tags
3520 (lambda (table info
)
3521 (let* ((genealogy (org-element-lineage table
))
3523 (when (eq (org-element-type (car genealogy
)) 'item
)
3524 (loop for el in genealogy
3525 when
(memq (org-element-type el
)
3530 (loop for el in genealogy
3531 when
(and (eq (org-element-type el
) 'headline
)
3532 (org-export-low-level-p el info
))
3536 (org-element-contents
3537 (org-export-get-parent el
)))))))
3540 ;; Handle list genealogy.
3541 (loop for el in list-genealogy collect
3542 (case (org-element-type el
)
3544 (setq parent-list el
)
3545 (cons "</text:list>"
3546 (format "\n<text:list text:style-name=\"%s\" %s>"
3547 (case (org-element-property :type el
)
3548 (ordered "OrgNumberedList")
3549 (unordered "OrgBulletedList")
3550 (descriptive-1 "OrgDescriptionList")
3551 (descriptive-2 "OrgDescriptionList"))
3552 "text:continue-numbering=\"true\"")))
3556 (if (funcall --element-preceded-by-table-p table info
)
3557 '("</text:list-header>" .
"<text:list-header>")
3558 '("</text:list-item>" .
"<text:list-header>")))
3559 ((funcall --element-preceded-by-table-p
3561 '("</text:list-header>" .
"<text:list-header>"))
3562 (t '("</text:list-item>" .
"<text:list-item>"))))))
3563 ;; Handle low-level headlines.
3564 (loop for el in llh-genealogy
3565 with step
= 'item collect
3568 (setq step
'item
) ; Flip-flop
3569 (setq parent-list el
)
3570 (cons "</text:list>"
3571 (format "\n<text:list text:style-name=\"%s\" %s>"
3572 (if (org-export-numbered-headline-p
3576 "text:continue-numbering=\"true\"")))
3578 (setq step
'plain-list
) ; Flip-flop
3581 (if (funcall --element-preceded-by-table-p table info
)
3582 '("</text:list-header>" .
"<text:list-header>")
3583 '("</text:list-item>" .
"<text:list-header>")))
3584 ((let ((section?
(org-export-get-previous-element
3587 (eq (org-element-type section?
) 'section
)
3588 (assq 'table
(org-element-contents section?
))))
3589 '("</text:list-header>" .
"<text:list-header>"))
3591 '("</text:list-item>" .
"<text:list-item>")))))))))))
3592 (close-open-tags (funcall --walk-list-genealogy-and-collect-tags
3594 ;; OpenDocument schema does not permit table to occur within a
3597 ;; One solution - the easiest and lightweight, in terms of
3598 ;; implementation - is to put the table in an indented text box
3599 ;; and make the text box part of the list-item. Unfortunately if
3600 ;; the table is big and spans multiple pages, the text box could
3601 ;; overflow. In this case, the following attribute will come
3604 ;; ,---- From OpenDocument-v1.1.pdf
3605 ;; | 15.27.28 Overflow behavior
3607 ;; | For text boxes contained within text document, the
3608 ;; | style:overflow-behavior property specifies the behavior of text
3609 ;; | boxes where the containing text does not fit into the text
3612 ;; | If the attribute's value is clip, the text that does not fit
3613 ;; | into the text box is not displayed.
3615 ;; | If the attribute value is auto-create-new-frame, a new frame
3616 ;; | will be created on the next page, with the same position and
3617 ;; | dimensions of the original frame.
3619 ;; | If the style:overflow-behavior property's value is
3620 ;; | auto-create-new-frame and the text box has a minimum width or
3621 ;; | height specified, then the text box will grow until the page
3622 ;; | bounds are reached before a new frame is created.
3625 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3626 ;; auto-create-new-frame property and always resorts to clipping
3627 ;; the text box. This results in table being truncated.
3629 ;; So we solve the problem the hard (and fun) way using list
3632 ;; The problem only becomes more interesting if you take in to
3633 ;; account the following facts:
3635 ;; - Description lists are simulated as plain lists.
3636 ;; - Low-level headlines can be listified.
3637 ;; - In Org-mode, a table can occur not only as a regular list
3638 ;; item, but also within description lists and low-level
3641 ;; See `org-odt-translate-description-lists' and
3642 ;; `org-odt-translate-low-level-headlines' for how this is
3646 ;; Discontinue the list.
3647 (mapconcat 'car close-open-tags
"\n")
3648 ;; Put the table in an indented section.
3649 (let* ((table (org-odt--table table contents info
))
3650 (level (/ (length (mapcar 'car close-open-tags
)) 2))
3651 (style (format "OrgIndentedSection-Level-%d" level
)))
3652 (when table
(org-odt-format-section table style
)))
3653 ;; Continue the list.
3654 (mapconcat 'cdr
(nreverse close-open-tags
) "\n"))))
3659 (defun org-odt-target (target contents info
)
3660 "Transcode a TARGET object from Org to ODT.
3661 CONTENTS is nil. INFO is a plist holding contextual
3663 (let ((value (org-element-property :value target
)))
3664 (org-odt--target "" (org-export-solidify-link-text value
))))
3669 (defun org-odt-timestamp (timestamp contents info
)
3670 "Transcode a TIMESTAMP object from Org to ODT.
3671 CONTENTS is nil. INFO is a plist used as a communication
3673 (let* ((raw-value (org-element-property :raw-value timestamp
))
3674 (type (org-element-property :type timestamp
)))
3675 (if (not (plist-get info
:odt-use-date-fields
))
3676 (let ((value (org-odt-plain-text
3677 (org-timestamp-translate timestamp
) info
)))
3678 (case (org-element-property :type timestamp
)
3679 ((active active-range
)
3680 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3681 "OrgActiveTimestamp" value
))
3682 ((inactive inactive-range
)
3683 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3684 "OrgInactiveTimestamp" value
))
3688 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3689 "OrgActiveTimestamp"
3690 (format "<%s>" (org-odt--format-timestamp timestamp
))))
3692 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3693 "OrgInactiveTimestamp"
3694 (format "[%s]" (org-odt--format-timestamp timestamp
))))
3696 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3697 "OrgActiveTimestamp"
3698 (format "<%s>–<%s>"
3699 (org-odt--format-timestamp timestamp
)
3700 (org-odt--format-timestamp timestamp
'end
))))
3702 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3703 "OrgInactiveTimestamp"
3704 (format "[%s]–[%s]"
3705 (org-odt--format-timestamp timestamp
)
3706 (org-odt--format-timestamp timestamp
'end
))))
3708 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3710 (org-odt-plain-text (org-timestamp-translate timestamp
)
3716 (defun org-odt-underline (underline contents info
)
3717 "Transcode UNDERLINE from Org to ODT.
3718 CONTENTS is the text with underline markup. INFO is a plist
3719 holding contextual information."
3720 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3721 "Underline" contents
))
3726 (defun org-odt-verbatim (verbatim contents info
)
3727 "Transcode a VERBATIM object from Org to ODT.
3728 CONTENTS is nil. INFO is a plist used as a communication
3730 (format "<text:span text:style-name=\"%s\">%s</text:span>"
3731 "OrgCode" (org-odt--encode-plain-text
3732 (org-element-property :value verbatim
))))
3737 (defun org-odt-verse-block (verse-block contents info
)
3738 "Transcode a VERSE-BLOCK element from Org to ODT.
3739 CONTENTS is verse block contents. INFO is a plist holding
3740 contextual information."
3741 ;; Add line breaks to each line of verse.
3742 (setq contents
(replace-regexp-in-string
3743 "\\(<text:line-break/>\\)?[ \t]*\n"
3744 "<text:line-break/>" contents
))
3745 ;; Replace tabs and spaces.
3746 (setq contents
(org-odt--encode-tabs-and-spaces contents
))
3747 ;; Surround it in a verse environment.
3748 (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
3749 "OrgVerse" contents
))
3755 ;;;; LaTeX fragments
3757 (defun org-odt--translate-latex-fragments (tree backend info
)
3758 (let ((processing-type (plist-get info
:with-latex
))
3760 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3761 ;; If the desired converter is not available, force verbatim
3763 (case processing-type
3765 (if (and (fboundp 'org-format-latex-mathml-available-p
)
3766 (org-format-latex-mathml-available-p))
3767 (setq processing-type
'mathml
)
3768 (message "LaTeX to MathML converter not available.")
3769 (setq processing-type
'verbatim
)))
3770 ((dvipng imagemagick
)
3771 (unless (and (org-check-external-command "latex" "" t
)
3772 (org-check-external-command
3773 (if (eq processing-type
'dvipng
) "dvipng" "convert") "" t
))
3774 (message "LaTeX to PNG converter not available.")
3775 (setq processing-type
'verbatim
)))
3777 (message "Unknown LaTeX option. Forcing verbatim.")
3778 (setq processing-type
'verbatim
)))
3780 ;; Store normalized value for later use.
3781 (when (plist-get info
:with-latex
)
3782 (plist-put info
:with-latex processing-type
))
3783 (message "Formatting LaTeX using %s" processing-type
)
3785 ;; Convert `latex-fragment's and `latex-environment's.
3786 (when (memq processing-type
'(mathml dvipng imagemagick
))
3787 (org-element-map tree
'(latex-fragment latex-environment
)
3790 (let* ((latex-frag (org-element-property :value latex-
*))
3791 (input-file (plist-get info
:input-file
))
3792 (cache-dir (file-name-directory input-file
))
3793 (cache-subdir (concat
3794 (case processing-type
3795 ((dvipng imagemagick
) "ltxpng/")
3796 (mathml "ltxmathml/"))
3797 (file-name-sans-extension
3798 (file-name-nondirectory input-file
))))
3800 (case processing-type
3801 ((dvipng imagemagick
) (format "Creating LaTeX Image %d..." count
))
3802 (mathml (format "Creating MathML snippet %d..." count
))))
3803 ;; Get an Org-style link to PNG image or the MathML
3806 (let ((link (with-temp-buffer
3808 (org-format-latex cache-subdir cache-dir
3810 nil processing-type
)
3811 (buffer-substring-no-properties
3812 (point-min) (point-max)))))
3813 (if (not (string-match "file:\\([^]]*\\)" link
))
3814 (prog1 nil
(message "LaTeX Conversion failed."))
3817 ;; Conversion succeeded. Parse above Org-style link to a
3819 (let* ((link (car (org-element-map (with-temp-buffer
3822 (org-element-parse-buffer))
3825 (org-element-put-property link
:parent nil
)
3828 (case (org-element-type latex-
*)
3829 ;; Case 1: LaTeX environment.
3830 ;; Mimic a "standalone image or formula" by
3831 ;; enclosing the `link' in a `paragraph'.
3832 ;; Copy over original attributes, captions to
3833 ;; the enclosing paragraph.
3835 (org-element-adopt-elements
3837 (list :style
"OrgFormula"
3838 :name
(org-element-property :name
3840 :caption
(org-element-property :caption
3843 ;; Case 2: LaTeX fragment.
3844 ;; No special action.
3845 (latex-fragment link
))))
3846 ;; Note down the object that link replaces.
3847 (org-element-put-property replacement
:replaces
3848 (list (org-element-type latex-
*)
3849 (list :value latex-frag
)))
3851 (org-element-set-element latex-
* replacement
))))))
3856 ;;;; Description lists
3858 ;; This translator is necessary to handle indented tables in a uniform
3859 ;; manner. See comment in `org-odt--table'.
3861 (defun org-odt--translate-description-lists (tree backend info
)
3862 ;; OpenDocument has no notion of a description list. So simulate it
3863 ;; using plain lists. Description lists in the exported document
3864 ;; are typeset in the same manner as they are in a typical HTML
3867 ;; Specifically, a description list like this:
3870 ;; | - term-1 :: definition-1
3871 ;; | - term-2 :: definition-2
3874 ;; gets translated in to the following form:
3883 ;; Further effect is achieved by fixing the OD styles as below:
3885 ;; 1. Set the :type property of the simulated lists to
3886 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3887 ;; that has *no* bullets whatsoever.
3889 ;; 2. The paragraph containing the definition term is styled to be
3892 (org-element-map tree
'plain-list
3894 (when (equal (org-element-property :type el
) 'descriptive
)
3895 (org-element-set-element
3897 (apply 'org-element-adopt-elements
3898 (list 'plain-list
(list :type
'descriptive-1
))
3901 (org-element-adopt-elements
3902 (list 'item
(list :checkbox
(org-element-property
3904 (list 'paragraph
(list :style
"Text_20_body_20_bold")
3905 (or (org-element-property :tag item
) "(no term)"))
3906 (org-element-adopt-elements
3907 (list 'plain-list
(list :type
'descriptive-2
))
3908 (apply 'org-element-adopt-elements
3910 (org-element-contents item
)))))
3911 (org-element-contents el
)))))
3918 ;; Lists that are marked with attribute `:list-table' are called as
3919 ;; list tables. They will be rendered as a table within the exported
3922 ;; Consider an example. The following list table
3924 ;; #+attr_odt :list-table t
3934 ;; will be exported as though it were an Org table like the one show
3937 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3938 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3940 ;; Note that org-tables are NOT multi-line and each line is mapped to
3941 ;; a unique row in the exported document. So if an exported table
3942 ;; needs to contain a single paragraph (with copious text) it needs to
3943 ;; be typed up in a single line. Editing such long lines using the
3944 ;; table editor will be a cumbersome task. Furthermore inclusion of
3945 ;; multi-paragraph text in a table cell is well-nigh impossible.
3947 ;; A LIST-TABLE circumvents above problems.
3949 ;; Note that in the example above the list items could be paragraphs
3950 ;; themselves and the list can be arbitrarily deep.
3952 ;; Inspired by following thread:
3953 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3955 ;; Translate lists to tables
3957 (defun org-odt--translate-list-tables (tree backend info
)
3958 (org-element-map tree
'plain-list
3960 (when (org-export-read-attribute :attr_odt l1-list
:list-table
)
3961 ;; Replace list with table.
3962 (org-element-set-element
3964 ;; Build replacement table.
3965 (apply 'org-element-adopt-elements
3966 (list 'table
'(:type org
:attr_odt
(":style \"GriddedTable\"")))
3967 (org-element-map l1-list
'item
3969 (let* ((l1-item-contents (org-element-contents l1-item
))
3970 l1-item-leading-text l2-list
)
3971 ;; Remove Level-2 list from the Level-item. It
3972 ;; will be subsequently attached as table-cells.
3973 (let ((cur l1-item-contents
) prev
)
3974 (while (and cur
(not (eq (org-element-type (car cur
))
3977 (setq cur
(cdr cur
)))
3980 (setq l2-list
(car cur
)))
3981 (setq l1-item-leading-text l1-item-contents
))
3982 ;; Level-1 items start a table row.
3983 (apply 'org-element-adopt-elements
3984 (list 'table-row
(list :type
'standard
))
3985 ;; Leading text of level-1 item define
3986 ;; the first table-cell.
3987 (apply 'org-element-adopt-elements
3988 (list 'table-cell nil
)
3989 l1-item-leading-text
)
3990 ;; Level-2 items define subsequent
3991 ;; table-cells of the row.
3992 (org-element-map l2-list
'item
3994 (apply 'org-element-adopt-elements
3995 (list 'table-cell nil
)
3996 (org-element-contents l2-item
)))
4004 ;;; Interactive functions
4006 (defun org-odt-create-manifest-file-entry (&rest args
)
4007 (push args org-odt-manifest-file-entries
))
4009 (defun org-odt-write-manifest-file ()
4010 (make-directory (concat org-odt-zip-dir
"META-INF"))
4011 (let ((manifest-file (concat org-odt-zip-dir
"META-INF/manifest.xml")))
4012 (with-current-buffer
4013 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4014 (find-file-noselect manifest-file t
))
4016 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
4017 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4019 (lambda (file-entry)
4020 (let* ((version (nth 2 file-entry
))
4021 (extra (if (not version
) ""
4022 (format " manifest:version=\"%s\"" version
))))
4024 (format org-odt-manifest-file-entry-tag
4025 (nth 0 file-entry
) (nth 1 file-entry
) extra
))))
4026 org-odt-manifest-file-entries
)
4027 (insert "\n</manifest:manifest>"))))
4029 (defmacro org-odt--export-wrap
(out-file &rest body
)
4030 `(let* ((--out-file ,out-file
)
4031 (out-file-type (file-name-extension --out-file
))
4032 (org-odt-xml-files '("META-INF/manifest.xml" "content.xml"
4033 "meta.xml" "styles.xml"))
4034 ;; Initialize temporary workarea. All files that end up in
4035 ;; the exported document get parked/created here.
4036 (org-odt-zip-dir (file-name-as-directory
4037 (make-temp-file (format "%s-" out-file-type
) t
)))
4038 (org-odt-manifest-file-entries nil
)
4039 (--cleanup-xml-buffers
4042 ;; Kill all XML buffers.
4043 (mapc (lambda (file)
4044 (let ((buf (find-buffer-visiting
4045 (concat org-odt-zip-dir file
))))
4047 (with-current-buffer buf
4048 (set-buffer-modified-p nil
)
4049 (kill-buffer buf
)))))
4051 ;; Delete temporary directory and also other embedded
4052 ;; files that get copied there.
4053 (delete-directory org-odt-zip-dir t
)))))
4056 (unless (executable-find "zip")
4057 ;; Not at all OSes ship with zip by default
4058 (error "Executable \"zip\" needed for creating OpenDocument files"))
4059 ;; Do export. This creates a bunch of xml files ready to be
4060 ;; saved and zipped.
4062 ;; Create a manifest entry for content.xml.
4063 (org-odt-create-manifest-file-entry "text/xml" "content.xml")
4064 ;; Write mimetype file
4066 '(("odt" .
"application/vnd.oasis.opendocument.text")
4067 ("odf" .
"application/vnd.oasis.opendocument.formula")))
4068 (mimetype (cdr (assoc-string out-file-type mimetypes t
))))
4070 (error "Unknown OpenDocument backend %S" out-file-type
))
4071 (write-region mimetype nil
(concat org-odt-zip-dir
"mimetype"))
4072 (org-odt-create-manifest-file-entry mimetype
"/" "1.2"))
4073 ;; Write out the manifest entries before zipping
4074 (org-odt-write-manifest-file)
4075 ;; Save all XML files.
4076 (mapc (lambda (file)
4077 (let ((buf (find-buffer-visiting
4078 (concat org-odt-zip-dir file
))))
4080 (with-current-buffer buf
4081 ;; Prettify output if needed.
4082 (when org-odt-prettify-xml
4083 (indent-region (point-min) (point-max)))
4087 (let* ((target --out-file
)
4088 (target-name (file-name-nondirectory target
))
4089 (cmds `(("zip" "-mX0" ,target-name
"mimetype")
4090 ("zip" "-rmTq" ,target-name
"."))))
4091 ;; If a file with same name as the desired output file
4092 ;; exists, remove it.
4093 (when (file-exists-p target
)
4094 (delete-file target
))
4095 ;; Zip up the xml files.
4096 (let ((coding-system-for-write 'no-conversion
) exitcode err-string
)
4097 (message "Creating ODT file...")
4098 ;; Switch temporarily to content.xml. This way Zip
4099 ;; process will inherit `org-odt-zip-dir' as the current
4101 (with-current-buffer
4102 (find-file-noselect (concat org-odt-zip-dir
"content.xml") t
)
4105 (message "Running %s" (mapconcat 'identity cmd
" "))
4107 (with-output-to-string
4109 (apply 'call-process
(car cmd
)
4110 nil standard-output nil
(cdr cmd
)))))
4111 (or (zerop exitcode
)
4112 (error (concat "Unable to create OpenDocument file."
4113 (format " Zip failed with error (%s)"
4116 ;; Move the zip file from temporary work directory to
4117 ;; user-mandated location.
4118 (rename-file (concat org-odt-zip-dir target-name
) target
)
4119 (message "Created %s" (expand-file-name target
))
4120 ;; Cleanup work directory and work files.
4121 (funcall --cleanup-xml-buffers
)
4122 ;; Open the OpenDocument file in archive-mode for
4124 (find-file-noselect target t
)
4125 ;; Return exported file.
4127 ;; Case 1: Conversion desired on exported file. Run the
4128 ;; converter on the OpenDocument file. Return the
4130 (org-odt-preferred-output-format
4131 (or (org-odt-convert target org-odt-preferred-output-format
)
4133 ;; Case 2: No further conversion. Return exported
4134 ;; OpenDocument file.
4137 ;; Cleanup work directory and work files.
4138 (funcall --cleanup-xml-buffers
)
4139 (message "OpenDocument export failed: %s"
4140 (error-message-string err
))))))
4143 ;;;; Export to OpenDocument formula
4146 (defun org-odt-export-as-odf (latex-frag &optional odf-file
)
4147 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4148 Use `org-create-math-formula' to convert LATEX-FRAG first to
4149 MathML. When invoked as an interactive command, use
4150 `org-latex-regexps' to infer LATEX-FRAG from currently active
4151 region. If no LaTeX fragments are found, prompt for it. Push
4152 MathML source to kill ring depending on the value of
4153 `org-export-copy-to-kill-ring'."
4156 (setq frag
(and (setq frag
(and (region-active-p)
4157 (buffer-substring (region-beginning)
4159 (loop for e in org-latex-regexps
4160 thereis
(when (string-match (nth 1 e
) frag
)
4161 (match-string (nth 2 e
) frag
)))))
4162 (read-string "LaTeX Fragment: " frag nil frag
))
4163 ,(let ((odf-filename (expand-file-name
4165 (file-name-sans-extension
4166 (or (file-name-nondirectory buffer-file-name
)))
4168 (file-name-directory buffer-file-name
))))
4169 (read-file-name "ODF filename: " nil odf-filename nil
4170 (file-name-nondirectory odf-filename
)))))
4171 (let ((filename (or odf-file
4174 (file-name-sans-extension
4175 (or (file-name-nondirectory buffer-file-name
)))
4177 (file-name-directory buffer-file-name
)))))
4178 (org-odt--export-wrap
4180 (let* ((buffer (progn
4181 (require 'nxml-mode
)
4182 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4183 (find-file-noselect (concat org-odt-zip-dir
4184 "content.xml") t
))))
4185 (coding-system-for-write 'utf-8
)
4186 (save-buffer-coding-system 'utf-8
))
4188 (set-buffer-file-coding-system coding-system-for-write
)
4189 (let ((mathml (org-create-math-formula latex-frag
)))
4190 (unless mathml
(error "No Math formula created"))
4192 ;; Add MathML to kill ring, if needed.
4193 (when (org-export--copy-to-kill-ring-p)
4194 (org-kill-new (buffer-string))))))))
4197 (defun org-odt-export-as-odf-and-open ()
4198 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4199 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4202 (org-open-file (call-interactively 'org-odt-export-as-odf
) 'system
))
4205 ;;;; Export to OpenDocument Text
4208 (defun org-odt-export-to-odt (&optional async subtreep visible-only ext-plist
)
4209 "Export current buffer to a ODT file.
4211 If narrowing is active in the current buffer, only export its
4214 If a region is active, export that region.
4216 A non-nil optional argument ASYNC means the process should happen
4217 asynchronously. The resulting file should be accessible through
4218 the `org-export-stack' interface.
4220 When optional argument SUBTREEP is non-nil, export the sub-tree
4221 at point, extracting information from the headline properties
4224 When optional argument VISIBLE-ONLY is non-nil, don't export
4225 contents of hidden elements.
4227 EXT-PLIST, when provided, is a property list with external
4228 parameters overriding Org default settings, but still inferior to
4229 file-local settings.
4231 Return output file's name."
4233 (let ((outfile (org-export-output-file-name ".odt" subtreep
)))
4235 (org-export-async-start (lambda (f) (org-export-add-to-stack f
'odt
))
4237 (org-odt--export-wrap
4239 (let* ((org-odt-embedded-images-count 0)
4240 (org-odt-embedded-formulas-count 0)
4241 (org-odt-automatic-styles nil
)
4242 (org-odt-object-counters nil
)
4243 ;; Let `htmlfontify' know that we are interested in
4244 ;; collecting styles.
4245 (hfy-user-sheet-assoc nil
))
4246 ;; Initialize content.xml and kick-off the export
4250 (require 'nxml-mode
)
4251 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4253 (concat org-odt-zip-dir
"content.xml") t
))))
4254 (output (org-export-as
4255 'odt
,subtreep
,visible-only nil
,ext-plist
)))
4256 (with-current-buffer out-buf
4258 (insert output
)))))))
4259 (org-odt--export-wrap
4261 (let* ((org-odt-embedded-images-count 0)
4262 (org-odt-embedded-formulas-count 0)
4263 (org-odt-automatic-styles nil
)
4264 (org-odt-object-counters nil
)
4265 ;; Let `htmlfontify' know that we are interested in collecting
4267 (hfy-user-sheet-assoc nil
))
4268 ;; Initialize content.xml and kick-off the export process.
4269 (let ((output (org-export-as 'odt subtreep visible-only nil ext-plist
))
4271 (require 'nxml-mode
)
4272 (let ((nxml-auto-insert-xml-declaration-flag nil
))
4274 (concat org-odt-zip-dir
"content.xml") t
)))))
4275 (with-current-buffer out-buf
(erase-buffer) (insert output
))))))))
4278 ;;;; Convert between OpenDocument and other formats
4280 (defun org-odt-reachable-p (in-fmt out-fmt
)
4281 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4283 (let ((reachable-formats (org-odt-do-reachable-formats in-fmt
)))
4284 (dolist (e reachable-formats
)
4285 (let ((out-fmt-spec (assoc out-fmt
(cdr e
))))
4287 (throw 'done
(cons (car e
) out-fmt-spec
))))))))
4289 (defun org-odt-do-convert (in-file out-fmt
&optional prefix-arg
)
4290 "Workhorse routine for `org-odt-convert'."
4291 (require 'browse-url
)
4292 (let* ((in-file (expand-file-name (or in-file buffer-file-name
)))
4293 (dummy (or (file-readable-p in-file
)
4294 (error "Cannot read %s" in-file
)))
4295 (in-fmt (file-name-extension in-file
))
4296 (out-fmt (or out-fmt
(error "Output format unspecified")))
4297 (how (or (org-odt-reachable-p in-fmt out-fmt
)
4298 (error "Cannot convert from %s format to %s format?"
4300 (convert-process (car how
))
4301 (out-file (concat (file-name-sans-extension in-file
) "."
4302 (nth 1 (or (cdr how
) out-fmt
))))
4303 (extra-options (or (nth 2 (cdr how
)) ""))
4304 (out-dir (file-name-directory in-file
))
4305 (cmd (format-spec convert-process
4306 `((?i .
,(shell-quote-argument in-file
))
4307 (?I .
,(browse-url-file-url in-file
))
4310 (?O .
,(browse-url-file-url out-file
))
4311 (?d .
, (shell-quote-argument out-dir
))
4312 (?D .
,(browse-url-file-url out-dir
))
4313 (?x .
,extra-options
)))))
4314 (when (file-exists-p out-file
)
4315 (delete-file out-file
))
4317 (message "Executing %s" cmd
)
4318 (let ((cmd-output (shell-command-to-string cmd
)))
4319 (message "%s" cmd-output
))
4322 ((file-exists-p out-file
)
4323 (message "Exported to %s" out-file
)
4325 (message "Opening %s..." out-file
)
4326 (org-open-file out-file
'system
))
4329 (message "Export to %s failed" out-file
)
4332 (defun org-odt-do-reachable-formats (in-fmt)
4333 "Return verbose info about formats to which IN-FMT can be converted.
4334 Return a list where each element is of the
4335 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4336 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4337 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4339 (and org-odt-convert-process
4340 (cadr (assoc-string org-odt-convert-process
4341 org-odt-convert-processes t
))))
4343 (and org-odt-convert-process
4344 (cadr (assoc-string org-odt-convert-process
4345 org-odt-convert-processes t
))
4346 org-odt-convert-capabilities
))
4349 (dolist (c capabilities
)
4350 (when (member in-fmt
(nth 1 c
))
4351 (push (cons converter
(nth 2 c
)) reachable-formats
))))
4354 (defun org-odt-reachable-formats (in-fmt)
4355 "Return list of formats to which IN-FMT can be converted.
4356 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4358 (mapc (lambda (e) (add-to-list 'l e
))
4359 (apply 'append
(mapcar
4360 (lambda (e) (mapcar 'car
(cdr e
)))
4361 (org-odt-do-reachable-formats in-fmt
))))
4364 (defun org-odt-convert-read-params ()
4365 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4366 This is a helper routine for interactive use."
4367 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
4368 (in-file (read-file-name "File to be converted: "
4369 nil buffer-file-name t
))
4370 (in-fmt (file-name-extension in-file
))
4371 (out-fmt-choices (org-odt-reachable-formats in-fmt
))
4373 (or (and out-fmt-choices
4374 (funcall input
"Output format: "
4375 out-fmt-choices nil nil nil
))
4377 "No known converter or no known output formats for %s files"
4379 (list in-file out-fmt
)))
4382 (defun org-odt-convert (&optional in-file out-fmt prefix-arg
)
4383 "Convert IN-FILE to format OUT-FMT using a command line converter.
4384 IN-FILE is the file to be converted. If unspecified, it defaults
4385 to variable `buffer-file-name'. OUT-FMT is the desired output
4386 format. Use `org-odt-convert-process' as the converter.
4387 If PREFIX-ARG is non-nil then the newly converted file is opened
4388 using `org-open-file'."
4390 (append (org-odt-convert-read-params) current-prefix-arg
))
4391 (org-odt-do-convert in-file out-fmt prefix-arg
))
4393 ;;; Library Initializations
4397 ;; Let Emacs open all OpenDocument files in archive mode
4398 (add-to-list 'auto-mode-alist
4399 (cons (concat "\\." (car desc
) "\\'") 'archive-mode
)))
4400 org-odt-file-extensions
)
4405 ;; generated-autoload-file: "org-loaddefs.el"
4408 ;;; ox-odt.el ends here