| blob | 0f0203ad6b039cf1206083eaae068e66c4cc52a3 |
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/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
89 org-odt--translate-description-lists ; Dummy symbol
90 org-odt--translate-list-tables)))
91 :menu-entry
98 :options-alist
100 ;; Other variables.
113 ;; Redefine regular option.
117 ;;; Dependencies
119 ;;; Hooks
121 ;;; Function Declarations
130 \f
131 ;;; Internal Variables
135 "Location of ODT exporter.
136 Use this to infer values of `org-odt-styles-dir' and
140 "Data directory for ODT exporter.
141 Use this to infer values of `org-odt-styles-dir' and
160 )
161 "List of directories to search for OpenDocument schema files.
162 Use this list to set the default value of
163 `org-odt-schema-dir'. The entries in this list are
164 populated heuristically based on the values of `org-odt-lib-dir'
177 )
178 "List of directories to search for OpenDocument styles files.
179 See `org-odt-styles-dir'. The entries in this list are populated
180 heuristically based on the values of `org-odt-lib-dir' and
197 styles-dir)
199 org-odt-styles-dir-list)
200 nil)))
203 styles-dir)
204 "Directory that holds auxiliary XML files used by the ODT exporter.
206 This directory contains the following XML files -
208 XML files are used as the default values of
209 `org-odt-styles-file' and
210 `org-odt-content-template-file'.
212 The default value of this variable varies depending on the
213 version of org in use and is initialized from
214 `org-odt-styles-dir-list'. Note that the user could be using org
215 from one of: org's own private git repository, GNU ELPA tar or
236 "
238 <style:table-properties style:rel-width=\"%d%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
239 </style:style>
240 "
244 "Registry of automatic styles for various OBJECT-TYPEs.
245 The variable has the following form:
246 \(\(OBJECT-TYPE-A
247 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
248 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
249 \(OBJECT-TYPE-B
250 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
251 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
252 ...\).
255 OBJECT-PROPS is (typically) a plist created by passing
261 "Running counters for various OBJECT-TYPEs.
262 Use this to generate automatic names and style-names. See
266 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
267 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
268 <style:background-image/>
269 </style:paragraph-properties>
271 </style:style>"
272 "Custom paragraph style for colorized source and example blocks.
274 except that the foreground and background colors are set
288 "Hardcoded image dimensions one for each of the anchor
291 ;; A4 page size is 21.0 by 29.7 cms
292 ;; The default page settings has 2cm margin on each of the sides. So
293 ;; the effective text area is 17.0 by 25.7 cm
303 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
305 This is a list where each entry is of the form:
307 \(CATEGORY-HANDLE OD-VARIABLE CATEGORY-NAME ENUMERATOR-PREDICATE)
309 CATEGORY_HANDLE identifies the captionable entity in question.
311 OD-VARIABLE is the OpenDocument sequence counter associated with
312 the entity. These counters are declared within
314 `org-odt-content-template-file'.
316 CATEGORY-NAME is used for qualifying captions on export.
318 ENUMERATOR-PREDICATE is used for assigning a sequence number to
328 \f
329 ;;; User Configuration Variables
332 "Options for exporting Org mode files to ODT."
337 ;;;; Debugging
340 "Specify whether or not the xml output should be prettified.
341 When this option is turned on, `indent-region' is run on all
342 component xml buffers before they are saved. Turn this off for
343 regular use. Turn this on if you need to examine the xml
344 visually."
350 ;;;; Document schema
363 schema-dir))
366 schema-dir))
370 schema-dir)
372 org-odt-schema-dir-list)
374 nil)))
375 schema-dir)
376 "Directory that contains OpenDocument schema files.
378 This directory contains:
379 1. rnc files for OpenDocument schema
381 for auto validation of OpenDocument XML files.
383 Use the customize interface to set this variable. This ensures
384 that `rng-schema-locating-files' is updated and auto-validation
385 of OpenDocument XML takes place based on the value
386 `rng-nxml-auto-validate-flag'.
388 The default value of this variable varies depending on the
389 version of org in use and is initialized from
390 `org-odt-schema-dir-list'. The OASIS schema files are available
391 only in the org's private git repository. It is *not* bundled
392 with GNU ELPA tar or standard Emacs distribution."
398 :set
400 "Set `org-odt-schema-dir'.
401 Also add it to `rng-schema-locating-files'."
411 schema-dir
414 value))
415 nil)))
420 org-odt-schema-dir))))))
423 ;;;; Document styles
427 The exporter embeds the exported content just before
431 under `org-odt-styles-dir' is used."
438 "Default styles file for use with ODT export.
439 Valid values are one of:
440 1. nil
441 2. path to a styles.xml file
442 3. path to a *.odt or a *.ott file
443 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
444 ...))
446 In case of option 1, an in-built styles.xml is used. See
447 `org-odt-styles-dir' for more information.
449 In case of option 3, the specified file is unzipped and the
450 styles.xml embedded therein is used.
452 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
453 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
454 generated odt file. Use relative path for specifying the
455 FILE-MEMBERS. styles.xml must be specified as one of the
456 FILE-MEMBERS.
458 Use options 1, 2 or 3 only if styles.xml alone suffices for
459 achieving the desired formatting. Use option 4, if the styles.xml
460 references additional files like header and footer images for
461 achieving the desired formatting.
464 a per-file basis. For example,
470 :type
482 "Outline levels considered for enumerating captioned entities."
488 ;;;; Document conversion
495 "Specify a list of document converters and their usage.
496 The converters in this list are offered as choices while
497 customizing `org-odt-convert-process'.
499 This variable is a list where each element is of the
500 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
501 of the converter. CONVERTER-CMD is the shell command for the
502 converter and can contain format specifiers. These format
503 specifiers are interpreted as below:
505 %i input file name in full
506 %I input file name as a URL
507 %f format of the output file
508 %o output file name in full
509 %O output file name as a URL
510 %d output dir in full
511 %D output dir as a URL.
512 %x extra options as set in `org-odt-convert-capabilities'."
515 :type
524 During customization, the list of converter names are populated
525 from `org-odt-convert-processes'."
535 org-odt-convert-processes))))
554 "Specify input and output formats of `org-odt-convert-process'.
555 More correctly, specify the set of input and output formats that
556 the user is actually interested in.
558 This variable is an alist where each element is of the
559 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
560 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
561 alist where each element is of the form (OUTPUT-FMT
562 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
564 The variable is interpreted as follows:
565 `org-odt-convert-process' can take any document that is in
566 INPUT-FMT-LIST and produce any document that is in the
567 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
568 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
569 serves dual purposes:
570 - It is used for populating completion candidates during
571 `org-odt-convert' commands.
573 `org-odt-convert-process'.
576 `org-odt-convert-process'.
578 DOCUMENT-CLASS is used to group a set of file formats in
579 INPUT-FMT-LIST in to a single class.
581 Note that this variable inherently captures how LibreOffice based
582 converters work. LibreOffice maps documents of various formats
583 to classes like Text, Web, Spreadsheet, Presentation etc and
584 allow document of a given class (irrespective of its source
585 format) to be converted to any of the export formats associated
586 with that class.
588 See default setting of this variable for an typical
589 configuration."
592 :type
597 :value-type
601 :value-type
610 and then uses `org-odt-convert-process' to convert the
611 resulting document to this format. During customization of this
612 variable, the list of valid values are populated based on
613 `org-odt-convert-capabilities'.
615 You can set this option on per-file basis using file local
616 values. See Info node `(emacs) File Variables'."
627 ;;;###autoload
631 ;;;; Drawers
635 "Function called to format a drawer in ODT code.
637 The function must accept two parameters:
639 CONTENTS the contents of the drawer.
641 The function should return the string to be exported.
643 The default value simply returns the value of CONTENTS."
650 ;;;; Headline
653 "Function to format headline text.
655 This function will be called with 5 arguments:
656 TODO the todo keyword \(string or nil\).
657 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
658 PRIORITY the priority of the headline \(integer or nil\)
659 TEXT the main headline text \(string\).
660 TAGS the tags string, separated with colons \(string or nil\).
662 The function result will be used as headline text."
669 ;;;; Inlinetasks
672 "Function called to format an inlinetask in ODT code.
674 The function must accept six parameters:
675 TODO the todo keyword, as a string
676 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
677 PRIORITY the inlinetask priority, as a string
678 NAME the inlinetask name, as a string.
679 TAGS the inlinetask tags, as a string.
680 CONTENTS the contents of the inlinetask, as a string.
682 The function should return the string to be exported."
689 ;;;; LaTeX
692 "Non-nil means process LaTeX math snippets.
694 When set, the exporter will process LaTeX environments and
695 fragments.
697 This option can also be set with the +OPTIONS line,
700 nil Ignore math snippets.
701 `verbatim' Keep everything in verbatim
702 `dvipng' Process the LaTeX fragments to images. This will also
703 include processing of non-math environments.
704 `imagemagick' Convert the LaTeX fragments to pdf files and use
705 imagemagick to convert pdf files to png files.
706 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
707 be loaded.
708 t Synonym for `mathjax'."
720 ;;;; Links
724 "Rules characterizing formula files that can be inlined into ODT.
726 A rule consists in an association whose key is the type of link
727 to consider, and value is a regexp that will be matched against
728 link's path."
737 "Rules characterizing image files that can be inlined into ODT.
739 A rule consists in an association whose key is the type of link
740 to consider, and value is a regexp that will be matched against
741 link's path."
749 "Scaling factor for converting images pixels to inches.
750 Use this for sizing of embedded images. See Info node `(org)
751 Images in ODT export' for more information."
760 :xref-format
764 :xref-format
768 :xref-format
770 :label-format
774 :xref-format
778 :xref-format
780 "Specify how to format caption and cross-references.
782 Use this, for example, to control various aspects of caption (the
783 numbering format, its position etc.) or to generate page numbers
784 as part of cross-references. For a quick overview of this
785 variable, see examples towards the end of this docstring.
789 cross-reference fields (like page number etc). Use an external
790 application to synchronize these fields to their right values.
791 When using LibreOffice, use Tools -> Update-> Fields / Update
792 All.
794 This variable is an alist of pairs (RULE-TAG . RULE-PLIST).
795 RULE-TAG is a symbol. RULE-PLIST is a property list, the allowed
796 properties of which depend on the value of RULE-TAG. The details
797 are as below.
799 RULE-TAG takes following one of the values:
801 `:TABLE:' `:FIGURE:' `:MATH-FORMULA:' `:DVIPNG-IMAGE:'
802 `:LISTING:' `:TARGET:'.
804 The `:TARGET:' rule specifies how a cross-reference to a
805 HEADLINE, a TARGET or a non-captionable ELEMENT is typeset. Its
806 RULE-PLIST allow a single property `:xref-format'.
808 All RULE-TAGs (except for `:TARGET:') specify how a caption and a
809 cross-reference to the corresponding entity is typeset. Its
810 RULE-PLIST allow following properties.
812 `:caption-position' - a symbol - one of `above' or `below'
813 `:caption-format' - a mixed list of symbols and strings
814 `:xref-format' - a mixed list of symbols and strings
816 `:caption-format' and `:xref-format' are but format
817 specifiers (in disguise) and specify how a caption or a
818 cross-reference is transcoded. Their form and function are
819 better illustrated than described. So, consider the following
820 examples:
822 A `:caption-format' with the following value
826 will result in following caption.
828 Table 1: An Example Table
829 ^^^^^ ^ ^^^^^^^^^^^^^^^^
830 ^ | ^
831 | | |
832 category | caption
833 counter
835 A `:xref-format' with the following value
839 will result in following cross-reference.
841 See Section 3.1 [Tropical Storms], page 24.
842 ^ ^^^^^^^^^^^^^^^ ^^^
843 | | |
844 chapter no. chapter title page number
846 See `org-odt-link--infer-description' (specifically
847 `org-odt--xref-target') and `org-odt-format-label' for
848 implementation details."
849 :type
853 ((:xref-format
871 `(,dc
873 ((:caption-position
876 (:caption-format
882 (:xref-format
893 )))
898 ;;;; Lists
901 "Specify how description lists are rendered.
902 Choose one of HTML or LaTeX style."
908 "Alias `org-odt--translate-description-lists'."
914 ;;;; Src Block
917 "Whether custom styles for colorized source blocks be automatically created.
918 When this option is turned on, the exporter creates custom styles
919 for source blocks based on the advice of `htmlfontify'. Creation
920 of custom styles happen as part of `org-odt-hfy-face-to-css'.
922 When this option is turned off exporter does not create such
923 styles.
925 Use the latter option if you do not want the custom styles to be
926 based on your current display settings. It is necessary that the
927 styles.xml already contains needed styles for colorizing to work.
929 This variable is effective only if
930 `org-odt-fontify-srcblocks' is turned on."
936 "Specify whether or not source blocks need to be fontified.
937 Turn this option on if you want to colorize the source code
938 blocks in the exported file. For colorization to work, you need
939 to make available an enhanced version of `htmlfontify' library."
945 ;;;; Table
958 "Specify how Table Styles should be derived from a Table Template.
959 This is a list where each element is of the
960 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
962 TABLE-STYLE-NAME is the style associated with the table through
965 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
966 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
967 below) that is included in
968 `org-odt-content-template-file'.
970 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
972 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
980 TABLE-CELL-OPTIONS is an alist where each element is of the
981 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
982 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
983 `use-last-row-styles' |
984 `use-first-column-styles' |
985 `use-last-column-styles' |
986 `use-banding-rows-styles' |
987 `use-banding-columns-styles' |
988 `use-first-row-styles'
989 ON-OR-OFF := `t' | `nil'
991 For example, with the following configuration
993 \(setq org-odt-table-styles
995 \(\(use-first-row-styles . t\)
996 \(use-first-column-styles . t\)\)\)
998 \(\(use-first-column-styles . t\)\)\)\)\)
1001 style will use the following table-cell styles -
1006 as appropriate.
1009 use the following table-cell styles -
1011 following paragraph styles
1013 as appropriate..
1015 Note that TABLE-TEMPLATE-NAME corresponds to the
1018 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
1021 specification for more information. Also consult the
1022 implementation filed under `org-odt-get-table-cell-styles'.
1025 formatting of numbered display equations. Do not delete this
1026 style from the list."
1036 use-last-row-styles
1037 use-first-column-styles
1038 use-last-column-styles
1039 use-banding-rows-styles
1040 use-banding-columns-styles)
1041 :key-type symbol
1044 ;;;; Timestamps
1047 "Non-nil, if timestamps should be exported as date fields.
1049 When nil, export timestamps as plain text.
1051 When non-nil, map `org-time-stamp-custom-formats' to a pair of
1053 respectively. A timestamp with no time component is formatted
1057 This feature is experimental. Most (but not all) of the common
1058 %-specifiers in `format-time-string' are supported.
1060 formatted as canonical Org timestamps. For finer control, avoid
1061 these %-specifiers.
1064 etc., are displayed by the application in the default language
1065 and country specified in `org-odt-styles-file'. Note that the
1067 can localize the week day and month strings in the exported
1068 document by setting the default language and country either using
1069 the application UI or through a custom styles file.
1071 See `org-odt--build-date-styles' for implementation details."
1078 \f
1079 ;;; Internal functions
1081 ;;;; Date
1096 ;; LibreOffice does not care about end goes as content
1097 ;; within the "<text:date>...</text:date>" field. The
1098 ;; displayed date is automagically corrected to match the
1099 ;; format requested by "style:data-style-name" attribute. So
1100 ;; don't bother about formatting the date contents to be
1101 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
1102 ;; simple Org-style date should suffice.
1127 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1128 iso-date style date)
1130 repeater)))))
1132 ;;;; Frame
1141 extra
1146 style frame-attrs
1158 ;;;; Library wrappers :: Arc Mode
1165 ;; This is shamelessly stolen from `archive-zip-extract'.
1171 name)))
1176 exit-code command-output)
1184 members))
1187 ;;;; Library wrappers :: Ox
1195 ;;;; Target
1199 ;; Empty label.
1201 ;; Bookmark pointing to a range of text.
1205 ;; Bookmark at a location.
1211 org-odt-caption-and-xref-settings)
1220 label text))
1222 (format "<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
1223 % label text))))
1226 ;;;; Textbox
1229 extra anchor-type)
1235 text)
1236 width nil style extra anchor-type))
1240 ;;;; Table of Contents
1245 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1247 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1254 "
1255 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1257 <text:index-entry-chapter/>
1258 <text:index-entry-text/>
1259 <text:index-entry-link-end/>
1260 </text:table-of-content-entry-template>
1264 </text:table-of-content-source>
1266 <text:index-body>
1269 </text:index-title>
1274 </text:index-body>
1275 </text:table-of-content>
1283 ;; Section number.
1285 ;; Todo.
1290 style todo)))
1295 style priority)))
1296 ;; Title.
1297 text
1298 ;; Tags.
1302 "OrgTags"
1309 headline-label text))
1313 ;; When a headline is marked as a radio target, as in the example below:
1314 ;;
1315 ;; ** <<<Some Heading>>>
1316 ;; Some text.
1317 ;;
1318 ;; suppress generation of radio targets. i.e., Radio targets are to
1319 ;; be marked as targets within /document body/ and *not* within
1320 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1321 ;; and one in the document body.
1322 ;;
1323 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1324 ;; doesn't provide a way to disable memoization. So this doesn't
1325 ;; work.
1326 ;;
1327 ;; FIXME-2: Are there any other objects that need to be suppressed
1328 ;; within TOC?
1348 style entry)))
1353 ;;;; Document styles
1356 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1357 OBJECT-PROPS is (typically) a plist created by passing
1359 `org-odt-parse-block-attributes'.
1361 Use `org-odt-object-counters' to generate an automatic
1362 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1363 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1364 . STYLE-NAME)."
1380 ;;;; Checkbox
1383 "Return check-box string associated to ITEM."
1392 ;;; Template
1395 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1396 ;; to modify the date fields. A date could be modified by
1397 ;; offsetting in days. That's about it. Also, date and time may
1398 ;; have to be emitted as two fields - a date field and a time field
1399 ;; - separately.
1401 ;; One can add Form Controls to date and time fields so that they
1402 ;; can be easily modified. But then, the exported document will
1403 ;; become tightly coupled with LibreOffice and may not function
1404 ;; properly with other OpenDocument applications.
1406 ;; I have a strange feeling that Date styles are a bit flaky at the
1407 ;; moment.
1409 ;; The feature is experimental.
1455 ))
1463 filler-end))
1474 style
1477 output ))))
1480 "Return complete document string after ODT conversion.
1481 CONTENTS is the transcoded contents string. RAW-DATA is the
1482 original parsed data. INFO is a plist holding export options."
1483 ;; Write meta file.
1493 <office:document-meta
1503 ;; Date, if required.
1505 ;; Check if DATE is specified as an Org-timestamp. If yes,
1506 ;; include it as meta information. Otherwise, just use
1507 ;; today's date.
1516 iso-date)))))
1528 ;; Add meta.xml in to manifest.
1531 ;; Update styles file.
1532 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1533 ;; Write styles file.
1536 ;; Non-availability of styles.xml is not a critical
1537 ;; error. For now, throw an error.
1539 org-odt-styles-file
1541 org-odt-styles-dir)
1554 members)))
1564 org-odt-styles-file))))
1566 ;; create a manifest entry for styles.xml
1569 ;; FIXME: Who is opening an empty styles.xml before this point?
1574 ;; Write custom styles for source blocks
1575 ;; Save STYLES used for colorizing of source blocks.
1576 ;; Update styles.xml with styles that were collected as part of
1577 ;; `org-odt-hfy-face-to-css' callbacks.
1586 ;; Update styles.xml - take care of outline numbering
1588 ;; Don't make automatic backup of styles.xml file. This setting
1589 ;; prevents the backed-up styles.xml file from being zipped in to
1590 ;; odt file. This is more of a hackish fix. Better alternative
1591 ;; would be to fix the zip command so that the output odt file
1592 ;; includes only the needed files and excludes any auto-generated
1593 ;; extra files like backups and auto-saves etc etc. Note that
1594 ;; currently the zip command zips up the entire temp directory so
1595 ;; that any auto-generated files created under the hood ends up in
1596 ;; the resulting odt file.
1599 ;; Outline numbering is retained only upto LEVEL.
1600 ;; To disable outline numbering pass a LEVEL of 0.
1613 ;; Update content.xml.
1616 ;; within the context of the Org buffer. So obtain its
1617 ;; value before moving on to temp-buffer context down below.
1627 org-odt-styles-dir)))
1628 ;; Write automatic styles.
1629 ;; - Position the cursor.
1633 ;; - Dump automatic table styles.
1639 ;; - Dump date-styles.
1645 ;; Update display level.
1646 ;; - Remove existing sequence decls. Also position the cursor.
1651 ;; Update sequence decls according to user preference.
1661 ;; Position the cursor to document body.
1666 ;; Preamble - Title, Author, Date etc.
1673 ;; Switch on or off above vars based on user settings
1677 ;; Title.
1682 ;; Separator.
1686 ;; Author only.
1689 "OrgSubtitle"
1691 ;; Separator.
1694 ;; Author and E-mail.
1698 "OrgSubtitle"
1703 ;; Separator.
1705 ;; Date, if required.
1708 ;; Check if DATE is specified as a timestamp.
1714 "OrgSubtitle"
1718 ;; Separator
1720 ;; Table of Contents
1723 with-toc
1726 ;; Contents.
1728 ;; Return contents.
1732 \f
1733 ;;; Transcode Functions
1735 ;;;; Bold
1738 "Transcode BOLD from Org to ODT.
1739 CONTENTS is the text with bold markup. INFO is a plist holding
1740 contextual information."
1742 ;; Internally, `org-odt--translate-description-lists/html'
1743 ;; or `org-odt--translate-description-lists/latex' requests
1744 ;; a custom style for bold.
1746 contents))
1749 ;;;; Center Block
1752 "Transcode a CENTER-BLOCK element from Org to ODT.
1753 CONTENTS holds the contents of the center block. INFO is a plist
1754 holding contextual information."
1755 contents)
1758 ;;;; Clock
1761 "Transcode a CLOCK element from Org to ODT.
1762 CONTENTS is nil. INFO is a plist used as a communication
1763 channel."
1776 ;;;; Code
1779 "Transcode a CODE object from Org to ODT.
1780 CONTENTS is nil. INFO is a plist used as a communication
1781 channel."
1787 ;;;; Comment
1789 ;; Comments are ignored.
1792 ;;;; Comment Block
1794 ;; Comment Blocks are ignored.
1797 ;;;; Drawer
1800 "Transcode a DRAWER element from Org to ODT.
1801 CONTENTS holds the contents of the block. INFO is a plist
1802 holding contextual information."
1805 name contents)))
1806 output))
1809 ;;;; Dynamic Block
1812 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1813 CONTENTS holds the contents of the block. INFO is a plist
1814 holding contextual information. See `org-export-data'."
1815 contents)
1818 ;;;; Entity
1821 "Transcode an ENTITY object from Org to ODT.
1822 CONTENTS are the definition itself. INFO is a plist holding
1823 contextual information."
1827 ;;;; Example Block
1830 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1831 CONTENTS is nil. INFO is a plist holding contextual information."
1835 ;;;; Export Snippet
1838 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1839 CONTENTS is nil. INFO is a plist holding contextual information."
1844 ;;;; Export Block
1847 "Transcode a EXPORT-BLOCK element from Org to ODT.
1848 CONTENTS is nil. INFO is a plist holding contextual information."
1853 ;;;; Fixed Width
1856 "Transcode a FIXED-WIDTH element from Org to ODT.
1857 CONTENTS is nil. INFO is a plist holding contextual information."
1861 ;;;; Footnote Definition
1863 ;; Footnote Definitions are ignored.
1866 ;;;; Footnote Reference
1869 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1870 CONTENTS is nil. INFO is a plist holding contextual information."
1880 id note-class
1893 "OrgSuperscript"
1894 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1895 note-class ref-format ref-name n)))))))
1897 ;; Insert separator between two footnotes in a row.
1902 ;; Transcode footnote reference.
1907 ;; Inline definitions are secondary strings.
1908 ;; Non-inline footnotes definitions are full Org data.
1911 footnote-reference info))
1920 ;;;; Headline
1926 ;; Todo.
1930 style todo)))
1935 style priority)))
1936 ;; Title.
1937 text
1938 ;; Tags.
1941 "<text:tab/>"
1950 &optional format-function
1952 "Transcode a HEADLINE element using BACKEND.
1953 INFO is a plist holding contextual information."
1980 todo todo-type priority text tags))))
1983 todo todo-type priority text tags
1988 "Transcode a HEADLINE element from Org to ODT.
1989 CONTENTS holds the contents of the headline. INFO is a plist
1990 holding contextual information."
1991 ;; Case 1: This is a footnote section: ignore it.
1994 ;; Create the headline text.
1996 ;; Get level relative to current parsed data.
1998 ;; Get canonical label for the headline.
2002 ;; Get user-specified labels for the headline.
2005 ;; Extra targets.
2013 ;; Title.
2016 ;; Case 2. This is a deep sub-tree: export it as a list item.
2017 ;; Also export as items headlines for which no section
2018 ;; format has been found.
2020 ;; Build the real contents of the sub-tree.
2024 ;; Choose style based on list type.
2027 ;; If top-level list, re-start numbering. Otherwise,
2028 ;; continue numbering.
2031 headline)))
2041 "Text_20_body"
2043 contents)
2045 "</text:list-header>"
2049 ;; Case 3. Standard headline. Export it as a section.
2055 level
2057 contents))))))
2060 ;;;; Horizontal Rule
2063 "Transcode an HORIZONTAL-RULE object from Org to ODT.
2064 CONTENTS is nil. INFO is a plist holding contextual information."
2069 ;;;; Inline Babel Call
2071 ;; Inline Babel Calls are ignored.
2074 ;;;; Inline Src Block
2077 "Return a character not used in string S.
2079 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
2085 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
2086 CONTENTS holds the contents of the item. INFO is a plist holding
2087 contextual information."
2094 ;;;; Inlinetask
2097 "Transcode an INLINETASK element from Org to ODT.
2098 CONTENTS holds the contents of the block. INFO is a plist
2099 holding contextual information."
2101 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
2102 ;; with appropriate arguments.
2109 todo todo-type priority text tags contents)))))
2112 ;; Otherwise, use a default template.
2115 "Text_20_body"
2119 "OrgInlineTaskHeading"
2121 contents)
2124 ;;;; Italic
2127 "Transcode ITALIC from Org to ODT.
2128 CONTENTS is the text with italic markup. INFO is a plist holding
2129 contextual information."
2134 ;;;; Item
2137 "Transcode an ITEM element from Org to ODT.
2138 CONTENTS holds the contents of the item. INFO is a plist holding
2139 contextual information."
2150 contents
2162 ;;;; Keyword
2165 "Transcode a KEYWORD element from Org to ODT.
2166 CONTENTS is nil. INFO is a plist holding contextual information."
2172 ;; FIXME
2183 ;; FIXME
2187 ;; Pagebreaks created this way are a mere expedience. These
2188 ;; create extraneous "empty" paragraphs which take up "extra
2189 ;; space". A typographer will chide you for resorting to such
2190 ;; underhanded means to create pagebreaks.
2191 ;;
2192 ;; As an expedience it has it's uses. See
2193 ;; `org-odt-special-block' for a realistic example of how
2194 ;; pagebreak can be to service.
2195 ;;
2196 ;; The right way to create pagebreaks is to create new styles -
2197 ;; custom or automatic - that set the "before/after" pagebreak
2198 ;; of an element (a paragraph, table etc).
2199 ;;
2200 ;; For example, consider pagebreaks created as below.
2201 ;;
2202 ;; Text in first page.
2203 ;;
2204 ;; #+ATTR_ODT: :style "OrgPageBreakDefault"
2205 ;; #+PAGEBREAK:
2206 ;;
2207 ;; This text goes in next page.
2209 ;; Now look at the page that is introduced with forced page
2210 ;; break. You will realize that the first line of text in that
2211 ;; page is a bit displaced from other pages created by
2212 ;; LibreOffice. A keen eye will definitely catch this
2213 ;; aberration.
2220 ;;;; Latex Environment
2223 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2224 ;; (defadvice org-format-latex-as-mathml ; FIXME
2225 ;; (after org-odt-protect-latex-fragment activate)
2226 ;; "Encode LaTeX fragment as XML.
2227 ;; Do this when translation to MathML fails."
2228 ;; (unless (> (length ad-return-value) 0)
2229 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2232 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2233 CONTENTS is nil. INFO is a plist holding contextual information."
2239 ;;;; Latex Fragment
2241 ;; (when latex-frag ; FIXME
2242 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2243 ;; :description latex-frag)))
2244 ;; handle verbatim
2245 ;; provide descriptions
2248 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2249 CONTENTS is nil. INFO is a plist holding contextual information."
2256 ;;;; Line Break
2259 "Transcode a LINE-BREAK object from Org to ODT.
2260 CONTENTS is nil. INFO is a plist holding contextual information."
2264 ;;;; Link
2266 ;;;; Links :: Label references
2277 x)))))
2288 counter))
2295 ;; Section number.
2299 ;; Separator.
2301 ;; Ordinal.
2303 tag))
2306 "Return a label for ELEMENT.
2308 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2309 element. INFO is a plist used as a communication channel. OP is
2310 either `definition' or `reference', depending on the purpose of
2311 the generated string.
2313 Return value is a string if OP is set to `reference' or a cons
2314 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2315 SHORT-CAPTION are strings."
2321 ;; Get label and caption.
2325 ;; Transcode captions.
2327 ;; Currently short caption are sneaked in as object names.
2328 ;;
2329 ;; The advantages are:
2330 ;;
2331 ;; - Table Of Contents: Currently, there is no support for
2332 ;; building TOC for figures, listings and tables. See
2333 ;; `org-odt-keyword'. User instead has to rely on
2334 ;; external application for building such indices. Within
2335 ;; LibreOffice, building an "Illustration Index" or "Index
2336 ;; of Tables" will create a table with long captions (only)
2337 ;; and building a table with "Object names" will create a
2338 ;; table with short captions.
2339 ;;
2340 ;; - Easy navigation: In LibreOffice, object names are
2341 ;; offered via the navigation bar. This way one can
2342 ;; quickly locate and jump to object of his choice in the
2343 ;; exported document.
2344 ;;
2345 ;; The main disadvantage is that there cannot be any markups
2346 ;; within object names i.e., one cannot embolden, italicize
2347 ;; or underline text within short caption. So suppress
2348 ;; generation of <text:span >...</text:span> and other
2349 ;; markups by overriding the default translators. We
2350 ;; probably shouldn't be suppressing translators for all
2351 ;; elements in `org-element-all-objects', but for now this
2352 ;; will do.
2354 ;; Sneaking in short-caption as name attribute is
2355 ;; problematic with LibreOffice > 4.0.4.2. So ignore
2356 ;; short-captions. See following thread:
2357 ;; http://lists.gnu.org/archive/html/emacs-orgmode/2013-12/msg00100.html
2363 :transcoders
2365 org-element-all-objects))))
2382 element))))
2385 seqno)
2389 ;; Compute sequence number of the element.
2391 ;; Localize category string.
2394 ;; Case 1: Handle Label definition.
2396 ;; Assign an internal label, if user has not provided one
2401 ;; Sneak in a bookmark. The bookmark is used when the
2402 ;; labeled element is referenced with a link that
2403 ;; provides its own description.
2405 ;; Label definition: Typically formatted as below:
2406 ;; CATEGORY SEQ-NO: LONG CAPTION
2407 ;; with translation for correct punctuation.
2411 org-odt-caption-and-xref-settings)
2419 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2420 label counter counter seqno))
2424 short-caption))
2425 ;; Case 2: Handle Label reference.
2432 org-odt-caption-and-xref-settings)
2439 org-odt-caption-and-xref-settings)
2446 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2447 % label value))))
2452 ;;;; Links :: Inline Images
2455 "Returns the internal name of the file"
2471 target-file))
2474 user-height scale dpi embed-as)
2494 ;; Use Imagemagick.
2499 file))))
2504 ;; Use Emacs.
2510 ;; Use hard-coded values.
2512 org-odt-default-image-sizes-alist))
2513 ;; Error out.
2526 ;; ensure that an embedded image fits comfortably within a page
2537 "Return ODT code for an inline image.
2538 LINK is the link pointing to the inline image. INFO is a plist
2539 used as a communication channel."
2552 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2554 ;; Extract attributes from #+ATTR_ODT line.
2558 ;; Handle `:anchor', `:style' and `:attributes' properties.
2568 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2569 ;;
2570 ;; Handle `:width', `:height' and `:scale' properties. Read
2571 ;; them as numbers since we need them for computations.
2573 src-expanded
2577 nil ; embed-as
2579 ))
2586 ;; Check if this link was created by LaTeX-to-PNG converter.
2590 ;; If yes, note down the type of the element - LaTeX Fragment
2591 ;; or LaTeX environment. It will go in to frame title.
2595 ;; If yes, note down its contents. It will go in to frame
2596 ;; description. This quite useful for debugging.
2599 captions user-frame-params title desc)))
2602 ;;;; Links :: Math formula
2623 ;; Check if this link was created by LaTeX-to-MathML
2624 ;; converter.
2628 ;; If yes, note down the type of the element - LaTeX Fragment
2629 ;; or LaTeX environment. It will go in to frame title.
2633 ;; If yes, note down its contents. It will go in to frame
2634 ;; description. This quite useful for debugging.
2636 width height)
2640 nil nil title desc))
2643 "CaptionedDisplayFormula" href width height
2644 captions nil title desc))
2650 "Returns the internal name of the file"
2654 ;; Create a directory for holding formula file. Also enter it in
2655 ;; to manifest.
2659 ;; Copy over the formula file from user directory to zip
2660 ;; directory.
2664 ;; Case 1: Mathml.
2667 ;; Case 2: OpenDocument formula.
2672 ;; Enter the formula file in to manifest.
2674 target-file))
2676 ;;;; Targets
2679 captions user-frame-params
2682 ;; Each element of this alist is of the form (CFG-HANDLE
2683 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2685 ;; CFG-HANDLE is the key to the alist.
2687 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2688 ;; frame params for INNER-FRAME and OUTER-FRAME
2689 ;; respectively. See below.
2691 ;; Configurations that are meant to be applied to
2692 ;; non-captioned image/formula specifies no
2693 ;; OUTER-FRAME-PARAMS.
2695 ;; TERMINOLOGY
2696 ;; ===========
2697 ;; INNER-FRAME :: Frame that directly surrounds an
2698 ;; image/formula.
2700 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2701 ;; frame also contains the caption, if any.
2703 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2704 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2705 ;; that these are the last three arguments
2706 ;; to `org-odt--frame'.
2708 ;; Note that an un-captioned image/formula requires just an
2709 ;; INNER-FRAME, while a captioned image/formula requires
2710 ;; both an INNER and an OUTER-FRAME.
2732 ;; Retrieve inner and outer frame params, from configuration.
2736 ;; User-specified frame params (from #+ATTR_ODT spec)
2740 "Merge default and user frame params."
2745 for d in default
2748 ;; Case 1: Image/Formula has no caption.
2749 ;; There is only one frame, one that surrounds the image
2750 ;; or formula.
2752 ;; Merge user frame params with that from configuration.
2756 ;; Case 2: Image/Formula is captioned or labeled.
2757 ;; There are two frames: The inner one surrounds the
2758 ;; image or formula. The outer one contains the
2759 ;; caption/sequence number.
2761 ;; Merge user frame params with outer frame params.
2763 ;; Short caption, if specified, goes as part of inner frame.
2770 frame-params))
2773 "Illustration"
2777 caption))
2778 width height outer)))))
2781 ;; Element should have a caption or label.
2787 element info
2788 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2789 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2790 ;; processing.)
2795 ;; Link should point to an image file.
2802 element info
2803 ;; Paragraph should have a caption or label. It SHOULD also be a
2804 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2805 ;; processing.)
2810 ;; Link should point to an image file.
2817 element info
2818 ;; Paragraph should have a caption or label.
2822 ;; Link should point to a MathML or ODF file.
2828 paragraph-predicate
2829 link-predicate)
2830 "Test if ELEMENT is a standalone link for the purpose ODT export.
2831 INFO is a plist holding contextual information.
2833 Return non-nil, if ELEMENT is of type paragraph satisfying
2834 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2835 is a link that satisfies LINK-PREDICATE.
2837 Return non-nil, if ELEMENT is of type link satisfying
2838 LINK-PREDICATE and its containing paragraph satisfies
2839 PARAGRAPH-PREDICATE in addition to having no other content save for
2840 leading and trailing whitespaces.
2842 Return nil, otherwise."
2865 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2866 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2867 ;; attached. Note that labels that are attached to captioned
2868 ;; entities - inline images, math formulae and tables - get resolved
2869 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2871 ;; Create a cross-reference to DESTINATION but make best-efforts to
2872 ;; create a *meaningful* description. Check item numbers, section
2873 ;; number and section title in that order.
2875 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2876 ;; FIXME: Handle footnote-definition footnote-reference?
2888 ;; Case 1: Does the user want the cross-references to be typeset
2889 ;; in a custom manner (say for example, generate page numbers
2890 ;; etc.)? If yes, emit the required XML tags but with "???" as
2891 ;; the field value. This (incorrect) field value can be
2892 ;; corrected by using an external Office application. For
2893 ;; example, in case of LibreOffice, the field values can be
2894 ;; synchronized by running Tools->Update->Fields/Update All on
2895 ;; the exported document.
2898 ;; Case 2: Is target an item of a numbered list? If yes, use the
2899 ;; item's number as description. The target need not necessarily
2900 ;; be part of a proper numbered list, it can also be part of a
2901 ;; low-level headline that is deemed as a list for purposes of
2902 ;; export.
2907 return x))
2908 ;; Get list item nos.
2913 plain-list)
2916 item info t))))))
2917 ;; Locate top-most listified headline.
2922 return x))
2923 ;; Get listified headline numbers.
2929 el info t)))))))
2930 ;; Combine item numbers from both the listified headlines and
2931 ;; regular list items.
2933 ;; Case 2.1: Check if all the parents of list item are
2934 ;; numbered. If yes, link to the item proper.
2937 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2942 ;; Case 3: Is the target part of a regular and numbered headline
2943 ;; in the hierarchy? If yes, use the chapter/section number as
2944 ;; description.
2949 return el)))
2950 ;; We found one.
2952 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2956 ;; Case 4: Is the target part of any headline. If yes, use the
2957 ;; chapter/section's title description.
2961 return el)))
2962 ;; We found one.
2964 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2968 ;; Case 5: The target is part of a document that is outside of
2969 ;; any headline. Use "???" as description. (We can use the
2970 ;; label text itself as the description. But, philosophically
2971 ;; speaking, this is in-appropriate. Targets are just labels and
2972 ;; must not generate any content text. So, it makes sense to
2973 ;; insist that the user provide an explicit description.)
2974 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2978 "Transcode a LINK object from Org to ODT.
2980 DESC is the description part of the link, or the empty string.
2981 INFO is a plist holding contextual information. See
2982 `org-export-data'."
2985 ;; Ensure DESC really exists, or set it to nil.
2988 link org-odt-inline-image-rules))
2995 ;; Convert & to & for correct XML representation
2997 protocol)
2999 ;; Image file.
3001 link org-odt-inline-image-rules))
3003 ;; Formula file.
3005 link org-odt-inline-formula-rules))
3007 ;; Radio target: Transcode target's contents and use them as
3008 ;; link's description.
3016 ;; Case 1: Honour user's customization.
3018 ;; Case 2: Use the text of the radio target.
3020 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3021 href desc))))))
3022 ;; Links pointing to a headline: Find destination and build
3023 ;; appropriate referencing command.
3029 ;; Case 1: Fuzzy link points nowhere.
3030 ('nil
3036 ;; Case 2: Fuzzy link points to a headline.
3038 ;; If there's a description, create a hyperlink.
3039 ;; Otherwise, try to provide a meaningful description.
3048 label desc))))
3049 ;; Case 3: Fuzzy link points to a target.
3051 ;; If there's a description, create a hyperlink.
3052 ;; Otherwise, try to provide a meaningful description.
3057 desc))))
3058 ;; Case 4: Fuzzy link points to some element (e.g., an
3059 ;; inline image, a math formula or a table).
3066 ;; LINK has no description. Create
3067 ;; a cross-reference showing entity's sequence
3068 ;; number.
3070 ;; LINK has description. Insert a hyperlink with
3071 ;; user-provided description.
3076 desc)))))))))
3077 ;; Coderef: replace link with the reference name or the
3078 ;; equivalent line number.
3085 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3086 href line-no))))
3087 ;; Link type is handled by a special function.
3090 ;; External link with a description part.
3093 ;; Check if description is a link to an inline image.
3098 desc-element org-odt-inline-image-rules))))
3099 ;; Format link as a clickable image.
3101 path desc)
3102 ;; Otherwise, format it as a regular link.
3104 path desc))))
3105 ;; External link without a description part.
3108 path path))
3109 ;; No path, only description. Try to do something useful.
3114 ;;;; Node Property
3117 "Transcode a NODE-PROPERTY element from Org to ODT.
3118 CONTENTS is nil. INFO is a plist holding contextual
3119 information."
3126 ;;;; Paragraph
3128 ;; You can customize paragraphs - standalone one and those occurring
3129 ;; within lists - using `:style' and `:p-style' attributes. Try out
3130 ;; the following example and see for yourself what you can achieve.
3131 ;;
3132 ;; #+ATTR_ODT: :style "OrgBulletedList" :p-style "Text_20_body_20_bold"
3133 ;; 1. N1
3134 ;; 1. N11
3135 ;; 2. N12
3136 ;; 2. N2
3137 ;; #+ATTR_ODT: :style "OrgNumberedList" :p-style "Preformatted_20_Text"
3138 ;; * B21
3139 ;;
3140 ;; * B22
3141 ;; - B221
3142 ;;
3143 ;; First paragraph.
3144 ;;
3145 ;; #+ATTR_ODT: :style "OrgBibliographyList" :p-style "Text_20_body"
3146 ;; 1. one
3147 ;; 2. two
3148 ;; 3. three
3149 ;;
3150 ;; #+ATTR_ODT: :style "Text_20_body_20_indent"
3151 ;; Second paragraph.
3152 ;;
3153 ;; - B222
3154 ;; * B23
3155 ;; 3. N3
3158 "Transcode a PARAGRAPH element from Org to ODT.
3159 CONTENTS is the contents of the paragraph, as a string. INFO is
3160 the plist used as a communication channel."
3166 ;; Traverse the parse-tree from root element to this
3167 ;; paragraph. Use the following rule at each element to
3168 ;; calculate the paragraph style applicable at that element.
3170 ;; Case 1: If an element specifies an EXPLICIT STYLE of it's
3171 ;; own via the #+ATTR_ODT line, use it. PARAGRAPH and
3172 ;; SPECIAL-BLOCK use the `:style' attribute for this
3173 ;; purpose, while PLAIN-LIST uses `:p-style' attribute.
3175 ;; Case 2: If an element does not have an explicit style but
3176 ;; has an IMPLICIT, PRE-CONFIGURE STYLE of it's own, use it.
3177 ;; For example, paragraphs within a FOOTNOTE-DEFINITON,
3178 ;; CENTER-BLOCK or QUOTE-BLOCK get pre-configured styles
3179 ;; like "Footnote", "OrgCenter" or "Quotations" resply.
3181 ;; Case 3: If an element specifies neither an IMPLICIT style
3182 ;; or an EXPLICIT style, use the style from it's parent.
3183 ;; For example, a paragraph within a PLAIN-LIST (that
3184 ;; doesn't specify a `:p-style' of it's own) inherit it's
3185 ;; style from the it's parent.
3187 ;; Case 4: If an element has no parent (i.e., root node),
3188 ;; use the fallback style "Text_20_body".
3190 ;; Fallback style.
3192 with footnote-definition-p = nil do
3195 ;; Case 1: Does this node IMPLICITLY or
3196 ;; EXPLICITLY specify a style? Use it.
3207 ;; Case 1: Some paragraphs are "created"
3208 ;; not by the user but by the
3209 ;; pre-processing stage. They use the
3210 ;; `:style' property of the element rather
3211 ;; than the style property from the
3212 ;; attribute line. See
3213 ;; `org-odt--translate-description-lists/latex',
3214 ;; `org-odt--translate-description-lists/html'
3215 ;; `org-odt--translate-latex-fragments'.
3219 ;; NOTE: ITEMs cannot have #+ATTR_ODT
3220 ;; attached to them. See
3221 ;;
3222 ;; http://lists.gnu.org/archive/html/emacs-orgmode/2013-08/msg00586.html
3230 ;; Case 1: Handle SPECIAL-BLOCKs that are
3231 ;; well-known (and treated specially) by
3232 ;; the ODT exporter.
3235 ;; Case 2: Handle user-specified
3236 ;; SPECIAL-BLOCKs not known to the
3237 ;; exporter.
3239 ;; Case 2: Element doesn't specify a style of
3240 ;; it's own. Use the parent style.
3241 style))
3242 finally return style)))
3243 ;; If this paragraph is a leading paragraph in an item and the
3244 ;; item has a checkbox, splice the checkbox and paragraph contents
3245 ;; together.
3252 ;;;; Plain List
3255 "Transcode a PLAIN-LIST element from Org to ODT.
3256 CONTENTS is the contents of the list. INFO is a plist holding
3257 contextual information."
3259 ;; Choose style based on list type.
3265 ;; FIXME: Define and handle `:style' attributes for
3266 ;; description lists.
3269 ;; If top-level list, re-start numbering. Otherwise,
3270 ;; continue numbering.
3275 contents))
3277 ;;;; Plain Text
3290 line))
3301 "Transcode a TEXT string from Org to ODT.
3302 TEXT is the string to transcode. INFO is a plist holding
3303 contextual information."
3305 ;; Protect &, < and >.
3307 ;; Handle smart quotes. Be sure to provide original string since
3308 ;; OUTPUT may have been modified.
3311 ;; Convert special strings.
3317 org-odt-special-string-regexps))
3318 ;; Handle break preservation if required.
3322 ;; Return value.
3323 output))
3326 ;;;; Planning
3329 "Transcode a PLANNING element from Org to ODT.
3330 CONTENTS is nil. INFO is a plist used as a communication
3331 channel."
3333 "OrgPlanning"
3355 ;;;; Property Drawer
3358 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3359 CONTENTS holds the contents of the drawer. INFO is a plist
3360 holding contextual information."
3363 contents)))
3366 ;;;; Quote Block
3369 "Transcode a QUOTE-BLOCK element from Org to ODT.
3370 CONTENTS holds the contents of the block. INFO is a plist
3371 holding contextual information."
3372 contents)
3375 ;;;; Section
3380 style
3382 text)))
3386 "Transcode a SECTION element from Org to ODT.
3387 CONTENTS holds the contents of the section. INFO is a plist
3388 holding contextual information."
3389 contents)
3391 ;;;; Radio Target
3394 "Transcode a RADIO-TARGET object from Org to ODT.
3395 TEXT is the text of the target. INFO is a plist holding
3396 contextual information."
3402 ;;;; Special Block
3405 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3406 CONTENTS holds the contents of the block. INFO is a plist
3407 holding contextual information."
3411 ;; Annotation.
3417 ;; FIXME: Is `car' right thing to do below?
3427 contents)))))
3428 ;; Textbox.
3430 ;; Textboxes an be used for centering tables etc horizontally
3431 ;; and vertically within a page.
3433 ;; In the example below, a landscape and centered table is
3434 ;; created in the middle of what is essentially a portrait
3435 ;; document.
3437 ;; Leading text.
3438 ;;
3439 ;; #+ATTR_ODT: :style "OrgPageBreakLandscape"
3440 ;; #+PAGEBREAK:
3441 ;;
3442 ;; #+ATTR_ODT: :width 5 :style "OrgPageImage" :anchor "page"
3443 ;; #+BEGIN_TEXTBOX
3444 ;; | a | b |
3445 ;; | e | f |
3446 ;; #+END_TEXTBOX
3447 ;;
3448 ;; #+ATTR_ODT: :style "OrgPageBreakDefault"
3449 ;; #+PAGEBREAK:
3450 ;;
3451 ;; Trailing text.
3459 style extra anchor))))
3463 ;;;; Src Block
3466 "Create custom style for face FN.
3467 When FN is the default face, use its foreground and background
3469 use its color attribute to create a character style whose name
3470 is obtained from FN. Currently all attributes of FN other than
3471 color are ignored.
3473 The style name for a face FN is derived using the following
3474 operations on the face name in that order - de-dash, CamelCase
3476 `font-lock-function-name-face' is associated with
3490 background-color-val color-val))
3493 "
3524 org-odt-fontify-srcblocks
3541 code
3552 par-style loc))
3555 num-start refs))
3569 ;; Extract code and references.
3573 ;; Does the src block contain labels?
3575 ;; Does it have line numbers?
3582 "Transcode a SRC-BLOCK element from Org to ODT.
3583 CONTENTS holds the contents of the item. INFO is a plist holding
3584 contextual information."
3593 ;; Is `:textbox' property non-nil?
3595 ;; Yes. Enclose it in a Text Box.
3597 "Text_20_body"
3601 ;;;; Statistics Cookie
3604 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3605 CONTENTS is nil. INFO is a plist holding contextual information."
3611 ;;;; Strike-Through
3614 "Transcode STRIKE-THROUGH from Org to ODT.
3615 CONTENTS is the text with strike-through markup. INFO is a plist
3616 holding contextual information."
3621 ;;;; Subscript
3624 "Transcode a SUBSCRIPT object from Org to ODT.
3625 CONTENTS is the contents of the object. INFO is a plist holding
3626 contextual information."
3631 ;;;; Superscript
3634 "Transcode a SUPERSCRIPT object from Org to ODT.
3635 CONTENTS is the contents of the object. INFO is a plist holding
3636 contextual information."
3641 ;;;; Table Cell
3649 "Retrieve styles applicable to a table cell.
3650 R and C are (zero-based) row and column numbers of the table
3651 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3652 applicable to the current table. It is `nil' if the table is not
3653 associated with any style attributes.
3655 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3657 When STYLE-SPEC is nil, style the table cell the conventional way
3658 - choose cell borders based on row and column groupings and
3659 choose paragraph alignment based on `org-col-cookies' text
3660 property. See also
3661 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3663 When STYLE-SPEC is non-nil, ignore the above cookie and return
3664 styles congruent with the ODF-1.2 specification."
3670 info)))
3672 ;; LibreOffice - particularly the Writer - honors neither table
3673 ;; templates nor custom table-cell styles. Inorder to retain
3674 ;; inter-operability with LibreOffice, only automatic styles are
3675 ;; used for styling of table-cells. The current implementation is
3676 ;; congruent with ODF-1.2 specification and hence is
3677 ;; future-compatible.
3679 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3680 ;; which recognizes as many as 16 different cell types - is much
3681 ;; richer. Unfortunately it is NOT amenable to easy configuration
3682 ;; by hand.
3717 'table-cell
3721 info)))
3724 "Transcode a TABLE-CELL element from Org to ODT.
3725 CONTENTS is nil. INFO is a plist used as a communication
3726 channel."
3735 table-cell info))
3757 table-cell info))))))
3761 custom-style-prefix))
3763 "OrgTblCell"
3778 cell-attributes
3781 org-element-all-elements)
3782 contents
3784 paragraph-style contents))))
3791 ;;;; Table Row
3794 "Transcode a TABLE-ROW element from Org to ODT.
3795 CONTENTS is the contents of the row. INFO is a plist used as a
3796 communication channel."
3797 ;; Rules are ignored since table separators are deduced from
3798 ;; borders of the current row.
3804 ;; If the row belongs to the first rowgroup and the
3805 ;; table has more than one row groups, then this row
3806 ;; belongs to the header row group.
3808 ;; Otherwise, it belongs to non-header row group.
3811 ;; Does this row begin a rowgroup?
3814 ;; Actual table row
3819 row-style contents))
3820 ;; Does this row end a rowgroup?
3825 ;;;; Table
3828 "Transcode a TABLE element from Org to ODT.
3829 CONTENTS is the contents of the table. INFO is a plist holding
3830 contextual information."
3832 ;; Case 1: table.el doesn't support export to OD format. Strip
3833 ;; such tables from export.
3838 "(ox-odt): Found table.el-type table in the source Org file."
3839 " table.el doesn't support export to ODT format."
3841 ;; Case 2: Native Org tables.
3857 column-style))
3858 out)
3862 ;; caption.
3866 ;; begin table.
3874 ;; column specification.
3876 ;; actual contents.
3878 ;; end table.
3882 "Transcode a TABLE element from Org to ODT.
3883 CONTENTS is the contents of the table. INFO is a plist holding
3884 contextual information.
3886 Use `org-odt--table' to typeset the table. Handle details
3887 pertaining to indentation here."
3902 collect el)))
3908 collect
3913 parent-list)
3915 ;; Handle list genealogy.
3935 parent-list info)
3938 ;; Handle low-level headlines.
3940 with step = 'item collect
3948 el info)
3949 "OrgNumberedList"
3960 parent-list info)))
3968 table info)))
3969 ;; OpenDocument schema does not permit table to occur within a
3970 ;; list item.
3972 ;; One solution - the easiest and lightweight, in terms of
3973 ;; implementation - is to put the table in an indented text box
3974 ;; and make the text box part of the list-item. Unfortunately if
3975 ;; the table is big and spans multiple pages, the text box could
3976 ;; overflow. In this case, the following attribute will come
3977 ;; handy.
3979 ;; ,---- From OpenDocument-v1.1.pdf
3980 ;; | 15.27.28 Overflow behavior
3981 ;; |
3982 ;; | For text boxes contained within text document, the
3983 ;; | style:overflow-behavior property specifies the behavior of text
3984 ;; | boxes where the containing text does not fit into the text
3985 ;; | box.
3986 ;; |
3987 ;; | If the attribute's value is clip, the text that does not fit
3988 ;; | into the text box is not displayed.
3989 ;; |
3990 ;; | If the attribute value is auto-create-new-frame, a new frame
3991 ;; | will be created on the next page, with the same position and
3992 ;; | dimensions of the original frame.
3993 ;; |
3994 ;; | If the style:overflow-behavior property's value is
3995 ;; | auto-create-new-frame and the text box has a minimum width or
3996 ;; | height specified, then the text box will grow until the page
3997 ;; | bounds are reached before a new frame is created.
3998 ;; `----
4000 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
4001 ;; auto-create-new-frame property and always resorts to clipping
4002 ;; the text box. This results in table being truncated.
4004 ;; So we solve the problem the hard (and fun) way using list
4005 ;; continuations.
4007 ;; The problem only becomes more interesting if you take in to
4008 ;; account the following facts:
4009 ;;
4010 ;; - Description lists are simulated as plain lists.
4011 ;; - Low-level headlines can be listified.
4012 ;; - In Org-mode, a table can occur not only as a regular list
4013 ;; item, but also within description lists and low-level
4014 ;; headlines.
4016 ;; See `org-odt--translate-description-lists' and
4017 ;; `org-odt-translate-low-level-headlines' for how this is
4018 ;; tackled.
4021 ;; Discontinue the list.
4023 ;; Put the table in an indented section.
4028 ;; Continue the list.
4032 ;;;; Target
4035 "Transcode a TARGET object from Org to ODT.
4036 CONTENTS is nil. INFO is a plist holding contextual
4037 information."
4042 ;;;; Timestamp
4045 "Transcode a TIMESTAMP object from Org to ODT.
4046 CONTENTS is nil. INFO is a plist used as a communication
4047 channel."
4064 "OrgActiveTimestamp"
4068 "OrgInactiveTimestamp"
4072 "OrgActiveTimestamp"
4078 "OrgInactiveTimestamp"
4084 "OrgDiaryTimestamp"
4086 info)))))))
4089 ;;;; Underline
4092 "Transcode UNDERLINE from Org to ODT.
4093 CONTENTS is the text with underline markup. INFO is a plist
4094 holding contextual information."
4099 ;;;; Verbatim
4102 "Transcode a VERBATIM object from Org to ODT.
4103 CONTENTS is nil. INFO is a plist used as a communication
4104 channel."
4110 ;;;; Verse Block
4113 "Transcode a VERSE-BLOCK element from Org to ODT.
4114 CONTENTS is verse block contents. INFO is a plist holding
4115 contextual information."
4116 ;; Add line breaks to each line of verse.
4120 ;; Replace tabs and spaces.
4122 ;; Surround it in a verse environment.
4127 \f
4128 ;;; Filters
4130 ;;;; LaTeX fragments
4135 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
4136 ;; If the desired converter is not available, force verbatim
4137 ;; processing.
4155 ;; Store normalized value for later use.
4160 ;; Convert `latex-fragment's and `latex-environment's.
4178 ;; Get an Org-style link to PNG image or the MathML
4179 ;; file.
4184 nil display-msg
4185 nil processing-type)
4190 link))))
4192 ;; Conversion succeeded. Parse above Org-style link to a
4193 ;; `link' object.
4199 ;; Orphan the link.
4204 ;; Case 1: LaTeX environment.
4205 ;; Mimic a "standalone image or formula" by
4206 ;; enclosing the `link' in a `paragraph'.
4207 ;; Copy over original attributes, captions to
4208 ;; the enclosing paragraph.
4214 latex-*)
4216 latex-*)))
4217 link))
4218 ;; Case 2: LaTeX fragment.
4219 ;; No special action.
4221 ;; Note down the object that link replaces.
4225 ;; Replace now.
4227 info)))
4228 tree)
4231 ;;;; Description lists
4233 ;; This translator is necessary to handle indented tables in a uniform
4234 ;; manner. See comment in `org-odt--table'.
4236 ;; Depending on user option `org-odt-description-list-style',
4237 ;; description lists can be typeset either as in HTML documents or as
4238 ;; in LaTeX documents.
4241 ;; OpenDocument has no notion of a description list. So simulate it
4242 ;; using plain lists. Description lists in the exported document
4243 ;; are typeset in the same manner as they are in a typical HTML
4244 ;; document. See `org-odt--translate-description-lists/latex' for
4245 ;; yet another way of translation.
4246 ;;
4247 ;; Specifically, a description list like this:
4248 ;;
4249 ;; ,----
4250 ;; | - term-1 :: definition-1
4251 ;; |
4252 ;; | paragraph-1
4253 ;; |
4254 ;; | - term-2 :: definition-2
4255 ;; |
4256 ;; | paragraph-2
4257 ;; `----
4258 ;;
4259 ;; gets translated in to the following form:
4260 ;;
4261 ;; ,----
4262 ;; | - term-1
4263 ;; |
4264 ;; | - definition-1
4265 ;; |
4266 ;; | paragraph-1
4267 ;; |
4268 ;; | - term-2
4269 ;; |
4270 ;; | - definition-2
4271 ;; |
4272 ;; | paragraph-2
4273 ;; `----
4274 ;;
4275 ;; Further effect is achieved by fixing the OD styles as below:
4276 ;;
4277 ;; 1. Set the :type property of the simulated lists to
4278 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
4279 ;; that has *no* bullets whatsoever.
4280 ;;
4281 ;; 2. The paragraph containing the definition term is styled to be
4282 ;; in bold.
4283 ;;
4288 el
4305 nil)
4306 info)
4307 tree)
4310 ;; OpenDocument has no notion of a description list. So simulate it
4311 ;; using plain lists. Description lists in the exported document
4312 ;; are typeset in the same manner as they are in a typical LaTeX
4313 ;; style document. See `org-odt--translate-description-lists/html'
4314 ;; for yet another way of translation.
4315 ;;
4316 ;; Specifically, a description list like this:
4317 ;;
4318 ;; ,----
4319 ;; | - term-1 :: definition-1
4320 ;; |
4321 ;; | paragraph-1
4322 ;; |
4323 ;; | - term-2 :: definition-2
4324 ;; |
4325 ;; | paragraph-2
4326 ;; `----
4327 ;;
4328 ;; gets translated in to the following form:
4329 ;;
4330 ;; ,----
4331 ;; | - *term-1* definition-1
4332 ;; |
4333 ;; | - paragraph-1
4334 ;; |
4335 ;; | - *term-2* definition-2
4336 ;; |
4337 ;; | - paragraph-2
4338 ;; `----
4339 ;;
4340 ;; Further effect is achieved by fixing the OD styles as below:
4341 ;;
4342 ;; 1. Set the :type property of the simulated lists to
4343 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
4344 ;; that has *no* bullets whatsoever.
4345 ;;
4346 ;; 2. The paragraph containing the definition term is styled to be
4347 ;; use hanging indent.
4348 ;;
4353 el
4372 item-contents)))))
4374 nil)
4375 info)
4376 tree)
4378 ;;;; List tables
4380 ;; Lists that are marked with attribute `:list-table' are called as
4381 ;; list tables. They will be rendered as a table within the exported
4382 ;; document.
4384 ;; Consider an example. The following list table
4385 ;;
4386 ;; #+ATTR_ODT: :rel-width 80
4387 ;; #+ATTR_ODT: :list-table t
4388 ;; - Row 1
4389 ;; - 1.1
4390 ;; - 1.2
4391 ;; - 1.3
4392 ;; - -----
4393 ;; - Row 2
4394 ;; - 2.1
4395 ;; - 2.2
4396 ;; - 2.3
4397 ;;
4398 ;; will be exported as though it were an Org table like the one show
4399 ;; below.
4400 ;;
4401 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
4402 ;; |-------+-----+-----+-----|
4403 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
4404 ;;
4405 ;; List tables can contain hrule (see example above). They can also
4406 ;; contain table specific attributes.
4407 ;;
4408 ;; Note that org-tables are NOT multi-line and each line is mapped to
4409 ;; a unique row in the exported document. So if an exported table
4410 ;; needs to contain a single paragraph (with copious text) it needs to
4411 ;; be typed up in a single line. Editing such long lines using the
4412 ;; table editor will be a cumbersome task. Furthermore inclusion of
4413 ;; multi-paragraph text in a table cell is well-nigh impossible.
4414 ;;
4415 ;; A LIST-TABLE circumvents above problems.
4416 ;;
4417 ;; Note that in the example above the list items could be paragraphs
4418 ;; themselves and the list can be arbitrarily deep.
4419 ;;
4420 ;; Inspired by following thread:
4421 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
4423 ;; Translate lists to tables
4429 ;; Replace list with table.
4431 l1-list
4432 ;; Build replacement table.
4439 l1-item-leading-text l2-list)
4440 ;; Remove Level-2 list from the Level-item. It
4441 ;; will be subsequently attached as table-cells.
4452 ;; Check for hrule.
4461 ;; Level-1 items start a table row.
4464 ;; No hrule.
4466 ;; Level-1 items start a table row.
4469 ;; Leading text of level-1 item define
4470 ;; the first table-cell.
4473 l1-item-leading-text)
4474 ;; Level-2 items define subsequent
4475 ;; table-cells of the row.
4483 nil)
4484 info)
4485 tree)
4487 \f
4488 ;;; Interactive functions
4501 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4510 org-odt-manifest-file-entries)
4516 ;; XML files created by the exporter.
4519 ;; Encode all the above XML files using utf-8.
4522 ;; Initialize temporary workarea. All files that end up in
4523 ;; the exported document get parked/created here.
4530 ;; Kill all XML buffers.
4538 org-odt-xml-files)
4539 ;; Delete temporary directory and also other embedded
4540 ;; files that get copied there.
4545 ;; Not at all OSes ship with zip by default
4547 ;; Do export. This creates a bunch of xml files ready to be
4548 ;; saved and zipped.
4550 ;; Create a manifest entry for content.xml.
4552 ;; Write mimetype file
4561 ;; Write out the manifest entries before zipping
4563 ;; Save all XML files.
4569 ;; Prettify output if needed.
4573 org-odt-xml-files)
4574 ;; Run zip.
4579 ;; If a file with same name as the desired output file
4580 ;; exists, remove it.
4583 ;; Zip up the xml files.
4586 ;; Switch temporarily to content.xml. This way Zip
4587 ;; process will inherit `org-odt-zip-dir' as the current
4588 ;; directory.
4602 err-string)))))
4603 cmds)))
4604 ;; Move the zip file from temporary work directory to
4605 ;; user-mandated location.
4608 ;; Cleanup work directory and work files.
4610 ;; Open the OpenDocument file in archive-mode for
4611 ;; examination.
4613 ;; Return exported file.
4615 ;; Case 1: Conversion desired on exported file. Run the
4616 ;; converter on the OpenDocument file. Return the
4617 ;; converted file.
4620 target))
4621 ;; Case 2: No further conversion. Return exported
4622 ;; OpenDocument file.
4625 ;; Cleanup work directory and work files.
4631 ;;;; Export to OpenDocument formula
4633 ;;;###autoload
4635 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4636 Use `org-create-math-formula' to convert LATEX-FRAG first to
4637 MathML. When invoked as an interactive command, use
4638 `org-latex-regexps' to infer LATEX-FRAG from currently active
4639 region. If no LaTeX fragments are found, prompt for it. Push
4640 MathML source to kill ring depending on the value of
4641 `org-export-copy-to-kill-ring'."
4667 filename
4678 ;; Add MathML to kill ring, if needed.
4682 ;;;###autoload
4684 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4685 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4686 formula file."
4691 ;;;; Export to OpenDocument Text
4693 ;;;###autoload
4695 "Export current buffer to a ODT file.
4697 If narrowing is active in the current buffer, only export its
4698 narrowed part.
4700 If a region is active, export that region.
4702 A non-nil optional argument ASYNC means the process should happen
4703 asynchronously. The resulting file should be accessible through
4704 the `org-export-stack' interface.
4706 When optional argument SUBTREEP is non-nil, export the sub-tree
4707 at point, extracting information from the headline properties
4708 first.
4710 When optional argument VISIBLE-ONLY is non-nil, don't export
4711 contents of hidden elements.
4713 EXT-PLIST, when provided, is a property list with external
4714 parameters overriding Org default settings, but still inferior to
4715 file-local settings.
4717 Return output file's name."
4724 ,outfile
4729 ;; Let `htmlfontify' know that we are interested in
4730 ;; collecting styles.
4732 ;; Initialize content.xml and kick-off the export
4733 ;; process.
4746 outfile
4751 ;; Let `htmlfontify' know that we are interested in collecting
4752 ;; styles.
4754 ;; Initialize content.xml and kick-off the export process.
4764 ;;;; Convert between OpenDocument and other formats
4767 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4776 "Workhorse routine for `org-odt-convert'."
4785 in-fmt out-fmt)))
4813 out-file)
4816 nil))))
4819 "Return verbose info about formats to which IN-FMT can be converted.
4820 Return a list where each element is of the
4821 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4822 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4823 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4827 org-odt-convert-processes t))))
4831 org-odt-convert-processes t))
4832 org-odt-convert-capabilities))
4833 reachable-formats)
4838 reachable-formats))
4841 "Return list of formats to which IN-FMT can be converted.
4842 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4848 l))
4851 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4852 This is a helper routine for interactive use."
4855 nil buffer-file-name t))
4861 out-fmt-choices nil nil nil))
4863 "No known converter or no known output formats for %s files"
4864 in-fmt))))
4867 ;;;###autoload
4869 "Convert IN-FILE to format OUT-FMT using a command line converter.
4870 IN-FILE is the file to be converted. If unspecified, it defaults
4871 to variable `buffer-file-name'. OUT-FMT is the desired output
4872 format. Use `org-odt-convert-process' as the converter.
4873 If PREFIX-ARG is non-nil then the newly converted file is opened
4874 using `org-open-file'."
4879 ;;; Library Initializations
4883 ;; Let Emacs open all OpenDocument files in archive mode
4886 org-odt-file-extensions)
4890 ;;; ox-odt.el ends here