| blob | 0eecadb4ab39ca6746201b9e9a34e3adf6ead66f |
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 'org-odt-format-headline-default-function
654 "Function to format headline text.
656 This function will be called with 5 arguments:
657 TODO the todo keyword \(string or nil\).
658 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
659 PRIORITY the priority of the headline \(integer or nil\)
660 TEXT the main headline text \(string\).
661 TAGS the tags string, separated with colons \(string or nil\).
663 The function result will be used as headline text."
670 ;;;; Inlinetasks
673 'org-odt-format-inlinetask-default-function
674 "Function called to format an inlinetask in ODT code.
676 The function must accept six parameters:
677 TODO the todo keyword, as a string
678 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
679 PRIORITY the inlinetask priority, as a string
680 NAME the inlinetask name, as a string.
681 TAGS the inlinetask tags, as a string.
682 CONTENTS the contents of the inlinetask, as a string.
684 The function should return the string to be exported."
691 ;;;; LaTeX
694 "Non-nil means process LaTeX math snippets.
696 When set, the exporter will process LaTeX environments and
697 fragments.
699 This option can also be set with the +OPTIONS line,
702 nil Ignore math snippets.
703 `verbatim' Keep everything in verbatim
704 `dvipng' Process the LaTeX fragments to images. This will also
705 include processing of non-math environments.
706 `imagemagick' Convert the LaTeX fragments to pdf files and use
707 imagemagick to convert pdf files to png files.
708 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
709 be loaded.
710 t Synonym for `mathjax'."
722 ;;;; Links
726 "Rules characterizing formula files that can be inlined into ODT.
728 A rule consists in an association whose key is the type of link
729 to consider, and value is a regexp that will be matched against
730 link's path."
739 "Rules characterizing image files that can be inlined into ODT.
741 A rule consists in an association whose key is the type of link
742 to consider, and value is a regexp that will be matched against
743 link's path."
751 "Scaling factor for converting images pixels to inches.
752 Use this for sizing of embedded images. See Info node `(org)
753 Images in ODT export' for more information."
762 :xref-format
766 :xref-format
770 :xref-format
772 :label-format
776 :xref-format
780 :xref-format
782 "Specify how to format caption and cross-references.
784 Use this, for example, to control various aspects of caption (the
785 numbering format, its position etc.) or to generate page numbers
786 as part of cross-references. For a quick overview of this
787 variable, see examples towards the end of this docstring.
791 cross-reference fields (like page number etc). Use an external
792 application to synchronize these fields to their right values.
793 When using LibreOffice, use Tools -> Update-> Fields / Update
794 All.
796 This variable is an alist of pairs (RULE-TAG . RULE-PLIST).
797 RULE-TAG is a symbol. RULE-PLIST is a property list, the allowed
798 properties of which depend on the value of RULE-TAG. The details
799 are as below.
801 RULE-TAG takes following one of the values:
803 `:TABLE:' `:FIGURE:' `:MATH-FORMULA:' `:DVIPNG-IMAGE:'
804 `:LISTING:' `:TARGET:'.
806 The `:TARGET:' rule specifies how a cross-reference to a
807 HEADLINE, a TARGET or a non-captionable ELEMENT is typeset. Its
808 RULE-PLIST allow a single property `:xref-format'.
810 All RULE-TAGs (except for `:TARGET:') specify how a caption and a
811 cross-reference to the corresponding entity is typeset. Its
812 RULE-PLIST allow following properties.
814 `:caption-position' - a symbol - one of `above' or `below'
815 `:caption-format' - a mixed list of symbols and strings
816 `:xref-format' - a mixed list of symbols and strings
818 `:caption-format' and `:xref-format' are but format
819 specifiers (in disguise) and specify how a caption or a
820 cross-reference is transcoded. Their form and function are
821 better illustrated than described. So, consider the following
822 examples:
824 A `:caption-format' with the following value
828 will result in following caption.
830 Table 1: An Example Table
831 ^^^^^ ^ ^^^^^^^^^^^^^^^^
832 ^ | ^
833 | | |
834 category | caption
835 counter
837 A `:xref-format' with the following value
841 will result in following cross-reference.
843 See Section 3.1 [Tropical Storms], page 24.
844 ^ ^^^^^^^^^^^^^^^ ^^^
845 | | |
846 chapter no. chapter title page number
848 See `org-odt-link--infer-description' (specifically
849 `org-odt--xref-target') and `org-odt-format-label' for
850 implementation details."
851 :type
855 ((:xref-format
873 `(,dc
875 ((:caption-position
878 (:caption-format
884 (:xref-format
895 )))
900 ;;;; Lists
903 "Specify how description lists are rendered.
904 Choose one of HTML or LaTeX style."
910 "Alias `org-odt--translate-description-lists'."
916 ;;;; Src Block
919 "Whether custom styles for colorized source blocks be automatically created.
920 When this option is turned on, the exporter creates custom styles
921 for source blocks based on the advice of `htmlfontify'. Creation
922 of custom styles happen as part of `org-odt-hfy-face-to-css'.
924 When this option is turned off exporter does not create such
925 styles.
927 Use the latter option if you do not want the custom styles to be
928 based on your current display settings. It is necessary that the
929 styles.xml already contains needed styles for colorizing to work.
931 This variable is effective only if
932 `org-odt-fontify-srcblocks' is turned on."
938 "Specify whether or not source blocks need to be fontified.
939 Turn this option on if you want to colorize the source code
940 blocks in the exported file. For colorization to work, you need
941 to make available an enhanced version of `htmlfontify' library."
947 ;;;; Table
960 "Specify how Table Styles should be derived from a Table Template.
961 This is a list where each element is of the
962 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
964 TABLE-STYLE-NAME is the style associated with the table through
967 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
968 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
969 below) that is included in
970 `org-odt-content-template-file'.
972 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
974 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
982 TABLE-CELL-OPTIONS is an alist where each element is of the
983 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
984 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
985 `use-last-row-styles' |
986 `use-first-column-styles' |
987 `use-last-column-styles' |
988 `use-banding-rows-styles' |
989 `use-banding-columns-styles' |
990 `use-first-row-styles'
991 ON-OR-OFF := `t' | `nil'
993 For example, with the following configuration
995 \(setq org-odt-table-styles
997 \(\(use-first-row-styles . t\)
998 \(use-first-column-styles . t\)\)\)
1000 \(\(use-first-column-styles . t\)\)\)\)\)
1003 style will use the following table-cell styles -
1008 as appropriate.
1011 use the following table-cell styles -
1013 following paragraph styles
1015 as appropriate..
1017 Note that TABLE-TEMPLATE-NAME corresponds to the
1020 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
1023 specification for more information. Also consult the
1024 implementation filed under `org-odt-get-table-cell-styles'.
1027 formatting of numbered display equations. Do not delete this
1028 style from the list."
1038 use-last-row-styles
1039 use-first-column-styles
1040 use-last-column-styles
1041 use-banding-rows-styles
1042 use-banding-columns-styles)
1043 :key-type symbol
1046 ;;;; Timestamps
1049 "Non-nil, if timestamps should be exported as date fields.
1051 When nil, export timestamps as plain text.
1053 When non-nil, map `org-time-stamp-custom-formats' to a pair of
1055 respectively. A timestamp with no time component is formatted
1059 This feature is experimental. Most (but not all) of the common
1060 %-specifiers in `format-time-string' are supported.
1062 formatted as canonical Org timestamps. For finer control, avoid
1063 these %-specifiers.
1066 etc., are displayed by the application in the default language
1067 and country specified in `org-odt-styles-file'. Note that the
1069 can localize the week day and month strings in the exported
1070 document by setting the default language and country either using
1071 the application UI or through a custom styles file.
1073 See `org-odt--build-date-styles' for implementation details."
1080 \f
1081 ;;; Internal functions
1083 ;;;; Date
1098 ;; LibreOffice does not care about end goes as content
1099 ;; within the "<text:date>...</text:date>" field. The
1100 ;; displayed date is automagically corrected to match the
1101 ;; format requested by "style:data-style-name" attribute. So
1102 ;; don't bother about formatting the date contents to be
1103 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
1104 ;; simple Org-style date should suffice.
1129 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1130 iso-date style date)
1132 repeater)))))
1134 ;;;; Frame
1143 extra
1148 style frame-attrs
1160 ;;;; Library wrappers :: Arc Mode
1167 ;; This is shamelessly stolen from `archive-zip-extract'.
1173 name)))
1178 exit-code command-output)
1186 members))
1189 ;;;; Library wrappers :: Ox
1197 ;;;; Target
1201 ;; Empty label.
1203 ;; Bookmark pointing to a range of text.
1207 ;; Bookmark at a location.
1213 org-odt-caption-and-xref-settings)
1222 label text))
1224 (format "<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
1225 % label text))))
1228 ;;;; Textbox
1231 extra anchor-type)
1237 text)
1238 width nil style extra anchor-type))
1242 ;;;; Table of Contents
1247 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1249 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1256 "
1257 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1259 <text:index-entry-chapter/>
1260 <text:index-entry-text/>
1261 <text:index-entry-link-end/>
1262 </text:table-of-content-entry-template>
1266 </text:table-of-content-source>
1268 <text:index-body>
1271 </text:index-title>
1276 </text:index-body>
1277 </text:table-of-content>
1285 ;; Section number.
1287 ;; Todo.
1292 style todo)))
1297 style priority)))
1298 ;; Title.
1299 text
1300 ;; Tags.
1304 "OrgTags"
1311 headline-label text))
1315 ;; When a headline is marked as a radio target, as in the example below:
1316 ;;
1317 ;; ** <<<Some Heading>>>
1318 ;; Some text.
1319 ;;
1320 ;; suppress generation of radio targets. i.e., Radio targets are to
1321 ;; be marked as targets within /document body/ and *not* within
1322 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1323 ;; and one in the document body.
1324 ;;
1325 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1326 ;; doesn't provide a way to disable memoization. So this doesn't
1327 ;; work.
1328 ;;
1329 ;; FIXME-2: Are there any other objects that need to be suppressed
1330 ;; within TOC?
1350 style entry)))
1355 ;;;; Document styles
1358 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1359 OBJECT-PROPS is (typically) a plist created by passing
1361 `org-odt-parse-block-attributes'.
1363 Use `org-odt-object-counters' to generate an automatic
1364 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1365 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1366 . STYLE-NAME)."
1382 ;;;; Checkbox
1385 "Return check-box string associated to ITEM."
1394 ;;; Template
1397 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1398 ;; to modify the date fields. A date could be modified by
1399 ;; offsetting in days. That's about it. Also, date and time may
1400 ;; have to be emitted as two fields - a date field and a time field
1401 ;; - separately.
1403 ;; One can add Form Controls to date and time fields so that they
1404 ;; can be easily modified. But then, the exported document will
1405 ;; become tightly coupled with LibreOffice and may not function
1406 ;; properly with other OpenDocument applications.
1408 ;; I have a strange feeling that Date styles are a bit flaky at the
1409 ;; moment.
1411 ;; The feature is experimental.
1457 ))
1465 filler-end))
1476 style
1479 output ))))
1482 "Return complete document string after ODT conversion.
1483 CONTENTS is the transcoded contents string. RAW-DATA is the
1484 original parsed data. INFO is a plist holding export options."
1485 ;; Write meta file.
1495 <office:document-meta
1505 ;; Date, if required.
1507 ;; Check if DATE is specified as an Org-timestamp. If yes,
1508 ;; include it as meta information. Otherwise, just use
1509 ;; today's date.
1518 iso-date)))))
1530 ;; Add meta.xml in to manifest.
1533 ;; Update styles file.
1534 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1535 ;; Write styles file.
1538 ;; Non-availability of styles.xml is not a critical
1539 ;; error. For now, throw an error.
1543 org-odt-styles-dir)
1556 members)))
1568 ;; create a manifest entry for styles.xml
1571 ;; FIXME: Who is opening an empty styles.xml before this point?
1576 ;; Write custom styles for source blocks
1577 ;; Save STYLES used for colorizing of source blocks.
1578 ;; Update styles.xml with styles that were collected as part of
1579 ;; `org-odt-hfy-face-to-css' callbacks.
1588 ;; Update styles.xml - take care of outline numbering
1590 ;; Don't make automatic backup of styles.xml file. This setting
1591 ;; prevents the backed-up styles.xml file from being zipped in to
1592 ;; odt file. This is more of a hackish fix. Better alternative
1593 ;; would be to fix the zip command so that the output odt file
1594 ;; includes only the needed files and excludes any auto-generated
1595 ;; extra files like backups and auto-saves etc etc. Note that
1596 ;; currently the zip command zips up the entire temp directory so
1597 ;; that any auto-generated files created under the hood ends up in
1598 ;; the resulting odt file.
1601 ;; Outline numbering is retained only upto LEVEL.
1602 ;; To disable outline numbering pass a LEVEL of 0.
1615 ;; Update content.xml.
1618 ;; within the context of the Org buffer. So obtain its
1619 ;; value before moving on to temp-buffer context down below.
1629 org-odt-styles-dir)))
1630 ;; Write automatic styles.
1631 ;; - Position the cursor.
1635 ;; - Dump automatic table styles.
1641 ;; - Dump date-styles.
1647 ;; Update display level.
1648 ;; - Remove existing sequence decls. Also position the cursor.
1653 ;; Update sequence decls according to user preference.
1663 ;; Position the cursor to document body.
1668 ;; Preamble - Title, Author, Date etc.
1675 ;; Switch on or off above vars based on user settings
1679 ;; Title.
1684 ;; Separator.
1688 ;; Author only.
1691 "OrgSubtitle"
1693 ;; Separator.
1696 ;; Author and E-mail.
1700 "OrgSubtitle"
1705 ;; Separator.
1707 ;; Date, if required.
1710 ;; Check if DATE is specified as a timestamp.
1716 "OrgSubtitle"
1720 ;; Separator
1722 ;; Table of Contents
1725 with-toc
1728 ;; Contents.
1730 ;; Return contents.
1734 \f
1735 ;;; Transcode Functions
1737 ;;;; Bold
1740 "Transcode BOLD from Org to ODT.
1741 CONTENTS is the text with bold markup. INFO is a plist holding
1742 contextual information."
1744 ;; Internally, `org-odt--translate-description-lists/html'
1745 ;; or `org-odt--translate-description-lists/latex' requests
1746 ;; a custom style for bold.
1748 contents))
1751 ;;;; Center Block
1754 "Transcode a CENTER-BLOCK element from Org to ODT.
1755 CONTENTS holds the contents of the center block. INFO is a plist
1756 holding contextual information."
1757 contents)
1760 ;;;; Clock
1763 "Transcode a CLOCK element from Org to ODT.
1764 CONTENTS is nil. INFO is a plist used as a communication
1765 channel."
1778 ;;;; Code
1781 "Transcode a CODE object from Org to ODT.
1782 CONTENTS is nil. INFO is a plist used as a communication
1783 channel."
1789 ;;;; Comment
1791 ;; Comments are ignored.
1794 ;;;; Comment Block
1796 ;; Comment Blocks are ignored.
1799 ;;;; Drawer
1802 "Transcode a DRAWER element from Org to ODT.
1803 CONTENTS holds the contents of the block. INFO is a plist
1804 holding contextual information."
1807 name contents)))
1808 output))
1811 ;;;; Dynamic Block
1814 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1815 CONTENTS holds the contents of the block. INFO is a plist
1816 holding contextual information. See `org-export-data'."
1817 contents)
1820 ;;;; Entity
1823 "Transcode an ENTITY object from Org to ODT.
1824 CONTENTS are the definition itself. INFO is a plist holding
1825 contextual information."
1829 ;;;; Example Block
1832 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1833 CONTENTS is nil. INFO is a plist holding contextual information."
1837 ;;;; Export Snippet
1840 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1841 CONTENTS is nil. INFO is a plist holding contextual information."
1846 ;;;; Export Block
1849 "Transcode a EXPORT-BLOCK element from Org to ODT.
1850 CONTENTS is nil. INFO is a plist holding contextual information."
1855 ;;;; Fixed Width
1858 "Transcode a FIXED-WIDTH element from Org to ODT.
1859 CONTENTS is nil. INFO is a plist holding contextual information."
1863 ;;;; Footnote Definition
1865 ;; Footnote Definitions are ignored.
1868 ;;;; Footnote Reference
1871 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1872 CONTENTS is nil. INFO is a plist holding contextual information."
1882 id note-class
1895 "OrgSuperscript"
1896 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1897 note-class ref-format ref-name n)))))))
1899 ;; Insert separator between two footnotes in a row.
1904 ;; Transcode footnote reference.
1909 ;; Inline definitions are secondary strings.
1910 ;; Non-inline footnotes definitions are full Org data.
1913 footnote-reference info))
1922 ;;;; Headline
1926 "Default format function for a headline.
1927 See `org-odt-format-headline-function' for details."
1929 ;; Todo.
1933 style todo)))
1938 style priority)))
1939 ;; Title.
1940 text
1941 ;; Tags.
1944 "<text:tab/>"
1954 "Transcode a HEADLINE element using BACKEND.
1955 INFO is a plist holding contextual information."
1981 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."
2110 todo todo-type priority name tags contents)))
2114 "Transcode an INLINETASK element from Org to ODT.
2115 CONTENTS holds the contents of the block. INFO is a plist
2116 holding contextual information."
2118 "Text_20_body"
2122 "OrgInlineTaskHeading"
2124 todo todo-type priority name tags))
2125 contents)
2128 ;;;; Italic
2131 "Transcode ITALIC from Org to ODT.
2132 CONTENTS is the text with italic markup. INFO is a plist holding
2133 contextual information."
2138 ;;;; Item
2141 "Transcode an ITEM element from Org to ODT.
2142 CONTENTS holds the contents of the item. INFO is a plist holding
2143 contextual information."
2154 contents
2166 ;;;; Keyword
2169 "Transcode a KEYWORD element from Org to ODT.
2170 CONTENTS is nil. INFO is a plist holding contextual information."
2176 ;; FIXME
2187 ;; FIXME
2191 ;; Pagebreaks created this way are a mere expedience. These
2192 ;; create extraneous "empty" paragraphs which take up "extra
2193 ;; space". A typographer will chide you for resorting to such
2194 ;; underhanded means to create pagebreaks.
2195 ;;
2196 ;; As an expedience it has it's uses. See
2197 ;; `org-odt-special-block' for a realistic example of how
2198 ;; pagebreak can be to service.
2199 ;;
2200 ;; The right way to create pagebreaks is to create new styles -
2201 ;; custom or automatic - that set the "before/after" pagebreak
2202 ;; of an element (a paragraph, table etc).
2203 ;;
2204 ;; For example, consider pagebreaks created as below.
2205 ;;
2206 ;; Text in first page.
2207 ;;
2208 ;; #+ATTR_ODT: :style "OrgPageBreakDefault"
2209 ;; #+PAGEBREAK:
2210 ;;
2211 ;; This text goes in next page.
2213 ;; Now look at the page that is introduced with forced page
2214 ;; break. You will realize that the first line of text in that
2215 ;; page is a bit displaced from other pages created by
2216 ;; LibreOffice. A keen eye will definitely catch this
2217 ;; aberration.
2224 ;;;; Latex Environment
2227 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2228 ;; (defadvice org-format-latex-as-mathml ; FIXME
2229 ;; (after org-odt-protect-latex-fragment activate)
2230 ;; "Encode LaTeX fragment as XML.
2231 ;; Do this when translation to MathML fails."
2232 ;; (unless (> (length ad-return-value) 0)
2233 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2236 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2237 CONTENTS is nil. INFO is a plist holding contextual information."
2243 ;;;; Latex Fragment
2245 ;; (when latex-frag ; FIXME
2246 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2247 ;; :description latex-frag)))
2248 ;; handle verbatim
2249 ;; provide descriptions
2252 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2253 CONTENTS is nil. INFO is a plist holding contextual information."
2260 ;;;; Line Break
2263 "Transcode a LINE-BREAK object from Org to ODT.
2264 CONTENTS is nil. INFO is a plist holding contextual information."
2268 ;;;; Link
2270 ;;;; Links :: Label references
2281 x)))))
2292 counter))
2299 ;; Section number.
2303 ;; Separator.
2305 ;; Ordinal.
2307 tag))
2310 "Return a label for ELEMENT.
2312 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2313 element. INFO is a plist used as a communication channel. OP is
2314 either `definition' or `reference', depending on the purpose of
2315 the generated string.
2317 Return value is a string if OP is set to `reference' or a cons
2318 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2319 SHORT-CAPTION are strings."
2325 ;; Get label and caption.
2329 ;; Transcode captions.
2331 ;; Currently short caption are sneaked in as object names.
2332 ;;
2333 ;; The advantages are:
2334 ;;
2335 ;; - Table Of Contents: Currently, there is no support for
2336 ;; building TOC for figures, listings and tables. See
2337 ;; `org-odt-keyword'. User instead has to rely on
2338 ;; external application for building such indices. Within
2339 ;; LibreOffice, building an "Illustration Index" or "Index
2340 ;; of Tables" will create a table with long captions (only)
2341 ;; and building a table with "Object names" will create a
2342 ;; table with short captions.
2343 ;;
2344 ;; - Easy navigation: In LibreOffice, object names are
2345 ;; offered via the navigation bar. This way one can
2346 ;; quickly locate and jump to object of his choice in the
2347 ;; exported document.
2348 ;;
2349 ;; The main disadvantage is that there cannot be any markups
2350 ;; within object names i.e., one cannot embolden, italicize
2351 ;; or underline text within short caption. So suppress
2352 ;; generation of <text:span >...</text:span> and other
2353 ;; markups by overriding the default translators. We
2354 ;; probably shouldn't be suppressing translators for all
2355 ;; elements in `org-element-all-objects', but for now this
2356 ;; will do.
2358 ;; Sneaking in short-caption as name attribute is
2359 ;; problematic with LibreOffice > 4.0.4.2. So ignore
2360 ;; short-captions. See following thread:
2361 ;; http://lists.gnu.org/archive/html/emacs-orgmode/2013-12/msg00100.html
2367 :transcoders
2369 org-element-all-objects))))
2386 element))))
2389 seqno)
2393 ;; Compute sequence number of the element.
2395 ;; Localize category string.
2398 ;; Case 1: Handle Label definition.
2400 ;; Assign an internal label, if user has not provided one
2405 ;; Sneak in a bookmark. The bookmark is used when the
2406 ;; labeled element is referenced with a link that
2407 ;; provides its own description.
2409 ;; Label definition: Typically formatted as below:
2410 ;; CATEGORY SEQ-NO: LONG CAPTION
2411 ;; with translation for correct punctuation.
2415 org-odt-caption-and-xref-settings)
2423 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2424 label counter counter seqno))
2428 short-caption))
2429 ;; Case 2: Handle Label reference.
2436 org-odt-caption-and-xref-settings)
2443 org-odt-caption-and-xref-settings)
2450 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2451 % label value))))
2456 ;;;; Links :: Inline Images
2459 "Returns the internal name of the file"
2475 target-file))
2478 user-height scale dpi embed-as)
2498 ;; Use Imagemagick.
2503 file))))
2508 ;; Use Emacs.
2514 ;; Use hard-coded values.
2516 org-odt-default-image-sizes-alist))
2517 ;; Error out.
2530 ;; ensure that an embedded image fits comfortably within a page
2541 "Return ODT code for an inline image.
2542 LINK is the link pointing to the inline image. INFO is a plist
2543 used as a communication channel."
2556 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2558 ;; Extract attributes from #+ATTR_ODT line.
2562 ;; Handle `:anchor', `:style' and `:attributes' properties.
2572 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2573 ;;
2574 ;; Handle `:width', `:height' and `:scale' properties. Read
2575 ;; them as numbers since we need them for computations.
2577 src-expanded info
2581 nil ; embed-as
2583 ))
2590 ;; Check if this link was created by LaTeX-to-PNG converter.
2594 ;; If yes, note down the type of the element - LaTeX Fragment
2595 ;; or LaTeX environment. It will go in to frame title.
2599 ;; If yes, note down its contents. It will go in to frame
2600 ;; description. This quite useful for debugging.
2603 captions user-frame-params title desc)))
2606 ;;;; Links :: Math formula
2627 ;; Check if this link was created by LaTeX-to-MathML
2628 ;; converter.
2632 ;; If yes, note down the type of the element - LaTeX Fragment
2633 ;; or LaTeX environment. It will go in to frame title.
2637 ;; If yes, note down its contents. It will go in to frame
2638 ;; description. This quite useful for debugging.
2640 width height)
2644 nil nil title desc))
2647 "CaptionedDisplayFormula" href width height
2648 captions nil title desc))
2654 "Returns the internal name of the file"
2658 ;; Create a directory for holding formula file. Also enter it in
2659 ;; to manifest.
2663 ;; Copy over the formula file from user directory to zip
2664 ;; directory.
2668 ;; Case 1: Mathml.
2671 ;; Case 2: OpenDocument formula.
2676 ;; Enter the formula file in to manifest.
2678 target-file))
2680 ;;;; Targets
2683 captions user-frame-params
2686 ;; Each element of this alist is of the form (CFG-HANDLE
2687 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2689 ;; CFG-HANDLE is the key to the alist.
2691 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2692 ;; frame params for INNER-FRAME and OUTER-FRAME
2693 ;; respectively. See below.
2695 ;; Configurations that are meant to be applied to
2696 ;; non-captioned image/formula specifies no
2697 ;; OUTER-FRAME-PARAMS.
2699 ;; TERMINOLOGY
2700 ;; ===========
2701 ;; INNER-FRAME :: Frame that directly surrounds an
2702 ;; image/formula.
2704 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2705 ;; frame also contains the caption, if any.
2707 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2708 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2709 ;; that these are the last three arguments
2710 ;; to `org-odt--frame'.
2712 ;; Note that an un-captioned image/formula requires just an
2713 ;; INNER-FRAME, while a captioned image/formula requires
2714 ;; both an INNER and an OUTER-FRAME.
2736 ;; Retrieve inner and outer frame params, from configuration.
2740 ;; User-specified frame params (from #+ATTR_ODT spec)
2744 "Merge default and user frame params."
2749 for d in default
2752 ;; Case 1: Image/Formula has no caption.
2753 ;; There is only one frame, one that surrounds the image
2754 ;; or formula.
2756 ;; Merge user frame params with that from configuration.
2760 ;; Case 2: Image/Formula is captioned or labeled.
2761 ;; There are two frames: The inner one surrounds the
2762 ;; image or formula. The outer one contains the
2763 ;; caption/sequence number.
2765 ;; Merge user frame params with outer frame params.
2767 ;; Short caption, if specified, goes as part of inner frame.
2774 frame-params))
2777 "Illustration"
2781 caption))
2782 width height outer)))))
2785 ;; Element should have a caption or label.
2791 element info
2792 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2793 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2794 ;; processing.)
2799 ;; Link should point to an image file.
2806 element info
2807 ;; Paragraph should have a caption or label. It SHOULD also be a
2808 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2809 ;; processing.)
2814 ;; Link should point to an image file.
2821 element info
2822 ;; Paragraph should have a caption or label.
2826 ;; Link should point to a MathML or ODF file.
2832 paragraph-predicate
2833 link-predicate)
2834 "Test if ELEMENT is a standalone link for the purpose ODT export.
2835 INFO is a plist holding contextual information.
2837 Return non-nil, if ELEMENT is of type paragraph satisfying
2838 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2839 is a link that satisfies LINK-PREDICATE.
2841 Return non-nil, if ELEMENT is of type link satisfying
2842 LINK-PREDICATE and its containing paragraph satisfies
2843 PARAGRAPH-PREDICATE in addition to having no other content save for
2844 leading and trailing whitespaces.
2846 Return nil, otherwise."
2869 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2870 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2871 ;; attached. Note that labels that are attached to captioned
2872 ;; entities - inline images, math formulae and tables - get resolved
2873 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2875 ;; Create a cross-reference to DESTINATION but make best-efforts to
2876 ;; create a *meaningful* description. Check item numbers, section
2877 ;; number and section title in that order.
2879 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2880 ;; FIXME: Handle footnote-definition footnote-reference?
2892 ;; Case 1: Does the user want the cross-references to be typeset
2893 ;; in a custom manner (say for example, generate page numbers
2894 ;; etc.)? If yes, emit the required XML tags but with "???" as
2895 ;; the field value. This (incorrect) field value can be
2896 ;; corrected by using an external Office application. For
2897 ;; example, in case of LibreOffice, the field values can be
2898 ;; synchronized by running Tools->Update->Fields/Update All on
2899 ;; the exported document.
2902 ;; Case 2: Is target an item of a numbered list? If yes, use the
2903 ;; item's number as description. The target need not necessarily
2904 ;; be part of a proper numbered list, it can also be part of a
2905 ;; low-level headline that is deemed as a list for purposes of
2906 ;; export.
2911 return x))
2912 ;; Get list item nos.
2917 plain-list)
2920 item info t))))))
2921 ;; Locate top-most listified headline.
2926 return x))
2927 ;; Get listified headline numbers.
2933 el info t)))))))
2934 ;; Combine item numbers from both the listified headlines and
2935 ;; regular list items.
2937 ;; Case 2.1: Check if all the parents of list item are
2938 ;; numbered. If yes, link to the item proper.
2941 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2946 ;; Case 3: Is the target part of a regular and numbered headline
2947 ;; in the hierarchy? If yes, use the chapter/section number as
2948 ;; description.
2953 return el)))
2954 ;; We found one.
2956 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2960 ;; Case 4: Is the target part of any headline. If yes, use the
2961 ;; chapter/section's title description.
2965 return el)))
2966 ;; We found one.
2968 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2972 ;; Case 5: The target is part of a document that is outside of
2973 ;; any headline. Use "???" as description. (We can use the
2974 ;; label text itself as the description. But, philosophically
2975 ;; speaking, this is in-appropriate. Targets are just labels and
2976 ;; must not generate any content text. So, it makes sense to
2977 ;; insist that the user provide an explicit description.)
2978 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2982 "Transcode a LINK object from Org to ODT.
2984 DESC is the description part of the link, or the empty string.
2985 INFO is a plist holding contextual information. See
2986 `org-export-data'."
2989 ;; Ensure DESC really exists, or set it to nil.
2999 ;; Convert & to & for correct XML representation
3001 protocol)
3003 ;; Image file.
3007 ;; Formula file.
3011 ;; Radio target: Transcode target's contents and use them as
3012 ;; link's description.
3020 ;; Case 1: Honour user's customization.
3022 ;; Case 2: Use the text of the radio target.
3024 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3025 href desc))))))
3026 ;; Links pointing to a headline: Find destination and build
3027 ;; appropriate referencing command.
3033 ;; Case 1: Fuzzy link points nowhere.
3034 ('nil
3040 ;; Case 2: Fuzzy link points to a headline.
3042 ;; If there's a description, create a hyperlink.
3043 ;; Otherwise, try to provide a meaningful description.
3052 label desc))))
3053 ;; Case 3: Fuzzy link points to a target.
3055 ;; If there's a description, create a hyperlink.
3056 ;; Otherwise, try to provide a meaningful description.
3061 desc))))
3062 ;; Case 4: Fuzzy link points to some element (e.g., an
3063 ;; inline image, a math formula or a table).
3070 ;; LINK has no description. Create
3071 ;; a cross-reference showing entity's sequence
3072 ;; number.
3074 ;; LINK has description. Insert a hyperlink with
3075 ;; user-provided description.
3080 desc)))))))))
3081 ;; Coderef: replace link with the reference name or the
3082 ;; equivalent line number.
3089 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3090 href line-no))))
3091 ;; Link type is handled by a special function.
3094 ;; External link with a description part.
3097 ;; Check if description is a link to an inline image.
3103 ;; Format link as a clickable image.
3105 path desc)
3106 ;; Otherwise, format it as a regular link.
3108 path desc))))
3109 ;; External link without a description part.
3112 path path))
3113 ;; No path, only description. Try to do something useful.
3118 ;;;; Node Property
3121 "Transcode a NODE-PROPERTY element from Org to ODT.
3122 CONTENTS is nil. INFO is a plist holding contextual
3123 information."
3130 ;;;; Paragraph
3132 ;; You can customize paragraphs - standalone one and those occurring
3133 ;; within lists - using `:style' and `:p-style' attributes. Try out
3134 ;; the following example and see for yourself what you can achieve.
3135 ;;
3136 ;; #+ATTR_ODT: :style "OrgBulletedList" :p-style "Text_20_body_20_bold"
3137 ;; 1. N1
3138 ;; 1. N11
3139 ;; 2. N12
3140 ;; 2. N2
3141 ;; #+ATTR_ODT: :style "OrgNumberedList" :p-style "Preformatted_20_Text"
3142 ;; * B21
3143 ;;
3144 ;; * B22
3145 ;; - B221
3146 ;;
3147 ;; First paragraph.
3148 ;;
3149 ;; #+ATTR_ODT: :style "OrgBibliographyList" :p-style "Text_20_body"
3150 ;; 1. one
3151 ;; 2. two
3152 ;; 3. three
3153 ;;
3154 ;; #+ATTR_ODT: :style "Text_20_body_20_indent"
3155 ;; Second paragraph.
3156 ;;
3157 ;; - B222
3158 ;; * B23
3159 ;; 3. N3
3162 "Transcode a PARAGRAPH element from Org to ODT.
3163 CONTENTS is the contents of the paragraph, as a string. INFO is
3164 the plist used as a communication channel."
3170 ;; Traverse the parse-tree from root element to this
3171 ;; paragraph. Use the following rule at each element to
3172 ;; calculate the paragraph style applicable at that element.
3174 ;; Case 1: If an element specifies an EXPLICIT STYLE of it's
3175 ;; own via the #+ATTR_ODT line, use it. PARAGRAPH and
3176 ;; SPECIAL-BLOCK use the `:style' attribute for this
3177 ;; purpose, while PLAIN-LIST uses `:p-style' attribute.
3179 ;; Case 2: If an element does not have an explicit style but
3180 ;; has an IMPLICIT, PRE-CONFIGURE STYLE of it's own, use it.
3181 ;; For example, paragraphs within a FOOTNOTE-DEFINITON,
3182 ;; CENTER-BLOCK or QUOTE-BLOCK get pre-configured styles
3183 ;; like "Footnote", "OrgCenter" or "Quotations" resply.
3185 ;; Case 3: If an element specifies neither an IMPLICIT style
3186 ;; or an EXPLICIT style, use the style from it's parent.
3187 ;; For example, a paragraph within a PLAIN-LIST (that
3188 ;; doesn't specify a `:p-style' of it's own) inherit it's
3189 ;; style from the it's parent.
3191 ;; Case 4: If an element has no parent (i.e., root node),
3192 ;; use the fallback style "Text_20_body".
3194 ;; Fallback style.
3196 with footnote-definition-p = nil do
3199 ;; Case 1: Does this node IMPLICITLY or
3200 ;; EXPLICITLY specify a style? Use it.
3211 ;; Case 1: Some paragraphs are "created"
3212 ;; not by the user but by the
3213 ;; pre-processing stage. They use the
3214 ;; `:style' property of the element rather
3215 ;; than the style property from the
3216 ;; attribute line. See
3217 ;; `org-odt--translate-description-lists/latex',
3218 ;; `org-odt--translate-description-lists/html'
3219 ;; `org-odt--translate-latex-fragments'.
3223 ;; NOTE: ITEMs cannot have #+ATTR_ODT
3224 ;; attached to them. See
3225 ;;
3226 ;; http://lists.gnu.org/archive/html/emacs-orgmode/2013-08/msg00586.html
3234 ;; Case 1: Handle SPECIAL-BLOCKs that are
3235 ;; well-known (and treated specially) by
3236 ;; the ODT exporter.
3239 ;; Case 2: Handle user-specified
3240 ;; SPECIAL-BLOCKs not known to the
3241 ;; exporter.
3243 ;; Case 2: Element doesn't specify a style of
3244 ;; it's own. Use the parent style.
3245 style))
3246 finally return style)))
3247 ;; If this paragraph is a leading paragraph in an item and the
3248 ;; item has a checkbox, splice the checkbox and paragraph contents
3249 ;; together.
3256 ;;;; Plain List
3259 "Transcode a PLAIN-LIST element from Org to ODT.
3260 CONTENTS is the contents of the list. INFO is a plist holding
3261 contextual information."
3263 ;; Choose style based on list type.
3269 ;; FIXME: Define and handle `:style' attributes for
3270 ;; description lists.
3273 ;; If top-level list, re-start numbering. Otherwise,
3274 ;; continue numbering.
3279 contents))
3281 ;;;; Plain Text
3294 line))
3305 "Transcode a TEXT string from Org to ODT.
3306 TEXT is the string to transcode. INFO is a plist holding
3307 contextual information."
3309 ;; Protect &, < and >.
3311 ;; Handle smart quotes. Be sure to provide original string since
3312 ;; OUTPUT may have been modified.
3315 ;; Convert special strings.
3321 org-odt-special-string-regexps))
3322 ;; Handle break preservation if required.
3326 ;; Return value.
3327 output))
3330 ;;;; Planning
3333 "Transcode a PLANNING element from Org to ODT.
3334 CONTENTS is nil. INFO is a plist used as a communication
3335 channel."
3337 "OrgPlanning"
3359 ;;;; Property Drawer
3362 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3363 CONTENTS holds the contents of the drawer. INFO is a plist
3364 holding contextual information."
3367 contents)))
3370 ;;;; Quote Block
3373 "Transcode a QUOTE-BLOCK element from Org to ODT.
3374 CONTENTS holds the contents of the block. INFO is a plist
3375 holding contextual information."
3376 contents)
3379 ;;;; Section
3384 style
3386 text)))
3390 "Transcode a SECTION element from Org to ODT.
3391 CONTENTS holds the contents of the section. INFO is a plist
3392 holding contextual information."
3393 contents)
3395 ;;;; Radio Target
3398 "Transcode a RADIO-TARGET object from Org to ODT.
3399 TEXT is the text of the target. INFO is a plist holding
3400 contextual information."
3406 ;;;; Special Block
3409 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3410 CONTENTS holds the contents of the block. INFO is a plist
3411 holding contextual information."
3415 ;; Annotation.
3421 ;; FIXME: Is `car' right thing to do below?
3431 contents)))))
3432 ;; Textbox.
3434 ;; Textboxes an be used for centering tables etc horizontally
3435 ;; and vertically within a page.
3437 ;; In the example below, a landscape and centered table is
3438 ;; created in the middle of what is essentially a portrait
3439 ;; document.
3441 ;; Leading text.
3442 ;;
3443 ;; #+ATTR_ODT: :style "OrgPageBreakLandscape"
3444 ;; #+PAGEBREAK:
3445 ;;
3446 ;; #+ATTR_ODT: :width 5 :style "OrgPageImage" :anchor "page"
3447 ;; #+BEGIN_TEXTBOX
3448 ;; | a | b |
3449 ;; | e | f |
3450 ;; #+END_TEXTBOX
3451 ;;
3452 ;; #+ATTR_ODT: :style "OrgPageBreakDefault"
3453 ;; #+PAGEBREAK:
3454 ;;
3455 ;; Trailing text.
3463 style extra anchor))))
3467 ;;;; Src Block
3470 "Create custom style for face FN.
3471 When FN is the default face, use its foreground and background
3473 use its color attribute to create a character style whose name
3474 is obtained from FN. Currently all attributes of FN other than
3475 color are ignored.
3477 The style name for a face FN is derived using the following
3478 operations on the face name in that order - de-dash, CamelCase
3480 `font-lock-function-name-face' is associated with
3494 background-color-val color-val))
3497 "
3545 code
3556 par-style loc))
3559 num-start refs))
3573 ;; Extract code and references.
3577 ;; Does the src block contain labels?
3579 ;; Does it have line numbers?
3586 "Transcode a SRC-BLOCK element from Org to ODT.
3587 CONTENTS holds the contents of the item. INFO is a plist holding
3588 contextual information."
3597 ;; Is `:textbox' property non-nil?
3599 ;; Yes. Enclose it in a Text Box.
3601 "Text_20_body"
3605 ;;;; Statistics Cookie
3608 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3609 CONTENTS is nil. INFO is a plist holding contextual information."
3615 ;;;; Strike-Through
3618 "Transcode STRIKE-THROUGH from Org to ODT.
3619 CONTENTS is the text with strike-through markup. INFO is a plist
3620 holding contextual information."
3625 ;;;; Subscript
3628 "Transcode a SUBSCRIPT object from Org to ODT.
3629 CONTENTS is the contents of the object. INFO is a plist holding
3630 contextual information."
3635 ;;;; Superscript
3638 "Transcode a SUPERSCRIPT object from Org to ODT.
3639 CONTENTS is the contents of the object. INFO is a plist holding
3640 contextual information."
3645 ;;;; Table Cell
3653 "Retrieve styles applicable to a table cell.
3654 R and C are (zero-based) row and column numbers of the table
3655 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3656 applicable to the current table. It is `nil' if the table is not
3657 associated with any style attributes.
3659 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3661 When STYLE-SPEC is nil, style the table cell the conventional way
3662 - choose cell borders based on row and column groupings and
3663 choose paragraph alignment based on `org-col-cookies' text
3664 property. See also
3665 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3667 When STYLE-SPEC is non-nil, ignore the above cookie and return
3668 styles congruent with the ODF-1.2 specification."
3674 info)))
3676 ;; LibreOffice - particularly the Writer - honors neither table
3677 ;; templates nor custom table-cell styles. Inorder to retain
3678 ;; inter-operability with LibreOffice, only automatic styles are
3679 ;; used for styling of table-cells. The current implementation is
3680 ;; congruent with ODF-1.2 specification and hence is
3681 ;; future-compatible.
3683 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3684 ;; which recognizes as many as 16 different cell types - is much
3685 ;; richer. Unfortunately it is NOT amenable to easy configuration
3686 ;; by hand.
3721 'table-cell
3725 info)))
3728 "Transcode a TABLE-CELL element from Org to ODT.
3729 CONTENTS is nil. INFO is a plist used as a communication
3730 channel."
3739 table-cell info))
3761 table-cell info))))))
3765 custom-style-prefix))
3767 "OrgTblCell"
3782 cell-attributes
3785 org-element-all-elements)
3786 contents
3788 paragraph-style contents))))
3795 ;;;; Table Row
3798 "Transcode a TABLE-ROW element from Org to ODT.
3799 CONTENTS is the contents of the row. INFO is a plist used as a
3800 communication channel."
3801 ;; Rules are ignored since table separators are deduced from
3802 ;; borders of the current row.
3808 ;; If the row belongs to the first rowgroup and the
3809 ;; table has more than one row groups, then this row
3810 ;; belongs to the header row group.
3812 ;; Otherwise, it belongs to non-header row group.
3815 ;; Does this row begin a rowgroup?
3818 ;; Actual table row
3823 row-style contents))
3824 ;; Does this row end a rowgroup?
3829 ;;;; Table
3832 "Transcode a TABLE element from Org to ODT.
3833 CONTENTS is the contents of the table. INFO is a plist holding
3834 contextual information."
3836 ;; Case 1: table.el doesn't support export to OD format. Strip
3837 ;; such tables from export.
3842 "(ox-odt): Found table.el-type table in the source Org file."
3843 " table.el doesn't support export to ODT format."
3845 ;; Case 2: Native Org tables.
3861 column-style))
3862 out)
3866 ;; caption.
3870 ;; begin table.
3878 ;; column specification.
3880 ;; actual contents.
3882 ;; end table.
3886 "Transcode a TABLE element from Org to ODT.
3887 CONTENTS is the contents of the table. INFO is a plist holding
3888 contextual information.
3890 Use `org-odt--table' to typeset the table. Handle details
3891 pertaining to indentation here."
3906 collect el)))
3912 collect
3917 parent-list)
3919 ;; Handle list genealogy.
3939 parent-list info)
3942 ;; Handle low-level headlines.
3944 with step = 'item collect
3952 el info)
3953 "OrgNumberedList"
3964 parent-list info)))
3972 table info)))
3973 ;; OpenDocument schema does not permit table to occur within a
3974 ;; list item.
3976 ;; One solution - the easiest and lightweight, in terms of
3977 ;; implementation - is to put the table in an indented text box
3978 ;; and make the text box part of the list-item. Unfortunately if
3979 ;; the table is big and spans multiple pages, the text box could
3980 ;; overflow. In this case, the following attribute will come
3981 ;; handy.
3983 ;; ,---- From OpenDocument-v1.1.pdf
3984 ;; | 15.27.28 Overflow behavior
3985 ;; |
3986 ;; | For text boxes contained within text document, the
3987 ;; | style:overflow-behavior property specifies the behavior of text
3988 ;; | boxes where the containing text does not fit into the text
3989 ;; | box.
3990 ;; |
3991 ;; | If the attribute's value is clip, the text that does not fit
3992 ;; | into the text box is not displayed.
3993 ;; |
3994 ;; | If the attribute value is auto-create-new-frame, a new frame
3995 ;; | will be created on the next page, with the same position and
3996 ;; | dimensions of the original frame.
3997 ;; |
3998 ;; | If the style:overflow-behavior property's value is
3999 ;; | auto-create-new-frame and the text box has a minimum width or
4000 ;; | height specified, then the text box will grow until the page
4001 ;; | bounds are reached before a new frame is created.
4002 ;; `----
4004 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
4005 ;; auto-create-new-frame property and always resorts to clipping
4006 ;; the text box. This results in table being truncated.
4008 ;; So we solve the problem the hard (and fun) way using list
4009 ;; continuations.
4011 ;; The problem only becomes more interesting if you take in to
4012 ;; account the following facts:
4013 ;;
4014 ;; - Description lists are simulated as plain lists.
4015 ;; - Low-level headlines can be listified.
4016 ;; - In Org-mode, a table can occur not only as a regular list
4017 ;; item, but also within description lists and low-level
4018 ;; headlines.
4020 ;; See `org-odt--translate-description-lists' and
4021 ;; `org-odt-translate-low-level-headlines' for how this is
4022 ;; tackled.
4025 ;; Discontinue the list.
4027 ;; Put the table in an indented section.
4032 ;; Continue the list.
4036 ;;;; Target
4039 "Transcode a TARGET object from Org to ODT.
4040 CONTENTS is nil. INFO is a plist holding contextual
4041 information."
4046 ;;;; Timestamp
4049 "Transcode a TIMESTAMP object from Org to ODT.
4050 CONTENTS is nil. INFO is a plist used as a communication
4051 channel."
4068 "OrgActiveTimestamp"
4072 "OrgInactiveTimestamp"
4076 "OrgActiveTimestamp"
4082 "OrgInactiveTimestamp"
4088 "OrgDiaryTimestamp"
4090 info)))))))
4093 ;;;; Underline
4096 "Transcode UNDERLINE from Org to ODT.
4097 CONTENTS is the text with underline markup. INFO is a plist
4098 holding contextual information."
4103 ;;;; Verbatim
4106 "Transcode a VERBATIM object from Org to ODT.
4107 CONTENTS is nil. INFO is a plist used as a communication
4108 channel."
4114 ;;;; Verse Block
4117 "Transcode a VERSE-BLOCK element from Org to ODT.
4118 CONTENTS is verse block contents. INFO is a plist holding
4119 contextual information."
4120 ;; Add line breaks to each line of verse.
4124 ;; Replace tabs and spaces.
4126 ;; Surround it in a verse environment.
4131 \f
4132 ;;; Filters
4134 ;;;; LaTeX fragments
4139 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
4140 ;; If the desired converter is not available, force verbatim
4141 ;; processing.
4159 ;; Store normalized value for later use.
4164 ;; Convert `latex-fragment's and `latex-environment's.
4182 ;; Get an Org-style link to PNG image or the MathML
4183 ;; file.
4188 nil display-msg
4189 nil processing-type)
4194 link))))
4196 ;; Conversion succeeded. Parse above Org-style link to a
4197 ;; `link' object.
4203 ;; Orphan the link.
4208 ;; Case 1: LaTeX environment.
4209 ;; Mimic a "standalone image or formula" by
4210 ;; enclosing the `link' in a `paragraph'.
4211 ;; Copy over original attributes, captions to
4212 ;; the enclosing paragraph.
4218 latex-*)
4220 latex-*)))
4221 link))
4222 ;; Case 2: LaTeX fragment.
4223 ;; No special action.
4225 ;; Note down the object that link replaces.
4229 ;; Replace now.
4231 info)))
4232 tree)
4235 ;;;; Description lists
4237 ;; This translator is necessary to handle indented tables in a uniform
4238 ;; manner. See comment in `org-odt--table'.
4240 ;; Depending on user option `org-odt-description-list-style',
4241 ;; description lists can be typeset either as in HTML documents or as
4242 ;; in LaTeX documents.
4245 ;; OpenDocument has no notion of a description list. So simulate it
4246 ;; using plain lists. Description lists in the exported document
4247 ;; are typeset in the same manner as they are in a typical HTML
4248 ;; document. See `org-odt--translate-description-lists/latex' for
4249 ;; yet another way of translation.
4250 ;;
4251 ;; Specifically, a description list like this:
4252 ;;
4253 ;; ,----
4254 ;; | - term-1 :: definition-1
4255 ;; |
4256 ;; | paragraph-1
4257 ;; |
4258 ;; | - term-2 :: definition-2
4259 ;; |
4260 ;; | paragraph-2
4261 ;; `----
4262 ;;
4263 ;; gets translated in to the following form:
4264 ;;
4265 ;; ,----
4266 ;; | - term-1
4267 ;; |
4268 ;; | - definition-1
4269 ;; |
4270 ;; | paragraph-1
4271 ;; |
4272 ;; | - term-2
4273 ;; |
4274 ;; | - definition-2
4275 ;; |
4276 ;; | paragraph-2
4277 ;; `----
4278 ;;
4279 ;; Further effect is achieved by fixing the OD styles as below:
4280 ;;
4281 ;; 1. Set the :type property of the simulated lists to
4282 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
4283 ;; that has *no* bullets whatsoever.
4284 ;;
4285 ;; 2. The paragraph containing the definition term is styled to be
4286 ;; in bold.
4287 ;;
4292 el
4309 nil)
4310 info)
4311 tree)
4314 ;; OpenDocument has no notion of a description list. So simulate it
4315 ;; using plain lists. Description lists in the exported document
4316 ;; are typeset in the same manner as they are in a typical LaTeX
4317 ;; style document. See `org-odt--translate-description-lists/html'
4318 ;; for yet another way of translation.
4319 ;;
4320 ;; Specifically, a description list like this:
4321 ;;
4322 ;; ,----
4323 ;; | - term-1 :: definition-1
4324 ;; |
4325 ;; | paragraph-1
4326 ;; |
4327 ;; | - term-2 :: definition-2
4328 ;; |
4329 ;; | paragraph-2
4330 ;; `----
4331 ;;
4332 ;; gets translated in to the following form:
4333 ;;
4334 ;; ,----
4335 ;; | - *term-1* definition-1
4336 ;; |
4337 ;; | - paragraph-1
4338 ;; |
4339 ;; | - *term-2* definition-2
4340 ;; |
4341 ;; | - paragraph-2
4342 ;; `----
4343 ;;
4344 ;; Further effect is achieved by fixing the OD styles as below:
4345 ;;
4346 ;; 1. Set the :type property of the simulated lists to
4347 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
4348 ;; that has *no* bullets whatsoever.
4349 ;;
4350 ;; 2. The paragraph containing the definition term is styled to be
4351 ;; use hanging indent.
4352 ;;
4357 el
4376 item-contents)))))
4378 nil)
4379 info)
4380 tree)
4382 ;;;; List tables
4384 ;; Lists that are marked with attribute `:list-table' are called as
4385 ;; list tables. They will be rendered as a table within the exported
4386 ;; document.
4388 ;; Consider an example. The following list table
4389 ;;
4390 ;; #+ATTR_ODT: :rel-width 80
4391 ;; #+ATTR_ODT: :list-table t
4392 ;; - Row 1
4393 ;; - 1.1
4394 ;; - 1.2
4395 ;; - 1.3
4396 ;; - -----
4397 ;; - Row 2
4398 ;; - 2.1
4399 ;; - 2.2
4400 ;; - 2.3
4401 ;;
4402 ;; will be exported as though it were an Org table like the one show
4403 ;; below.
4404 ;;
4405 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
4406 ;; |-------+-----+-----+-----|
4407 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
4408 ;;
4409 ;; List tables can contain hrule (see example above). They can also
4410 ;; contain table specific attributes.
4411 ;;
4412 ;; Note that org-tables are NOT multi-line and each line is mapped to
4413 ;; a unique row in the exported document. So if an exported table
4414 ;; needs to contain a single paragraph (with copious text) it needs to
4415 ;; be typed up in a single line. Editing such long lines using the
4416 ;; table editor will be a cumbersome task. Furthermore inclusion of
4417 ;; multi-paragraph text in a table cell is well-nigh impossible.
4418 ;;
4419 ;; A LIST-TABLE circumvents above problems.
4420 ;;
4421 ;; Note that in the example above the list items could be paragraphs
4422 ;; themselves and the list can be arbitrarily deep.
4423 ;;
4424 ;; Inspired by following thread:
4425 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
4427 ;; Translate lists to tables
4433 ;; Replace list with table.
4435 l1-list
4436 ;; Build replacement table.
4443 l1-item-leading-text l2-list)
4444 ;; Remove Level-2 list from the Level-item. It
4445 ;; will be subsequently attached as table-cells.
4456 ;; Check for hrule.
4465 ;; Level-1 items start a table row.
4468 ;; No hrule.
4470 ;; Level-1 items start a table row.
4473 ;; Leading text of level-1 item define
4474 ;; the first table-cell.
4477 l1-item-leading-text)
4478 ;; Level-2 items define subsequent
4479 ;; table-cells of the row.
4487 nil)
4488 info)
4489 tree)
4491 \f
4492 ;;; Interactive functions
4505 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4514 org-odt-manifest-file-entries)
4520 ;; XML files created by the exporter.
4523 ;; Encode all the above XML files using utf-8.
4526 ;; Initialize temporary workarea. All files that end up in
4527 ;; the exported document get parked/created here.
4534 ;; Kill all XML buffers.
4542 org-odt-xml-files)
4543 ;; Delete temporary directory and also other embedded
4544 ;; files that get copied there.
4549 ;; Not at all OSes ship with zip by default
4551 ;; Do export. This creates a bunch of xml files ready to be
4552 ;; saved and zipped.
4554 ;; Create a manifest entry for content.xml.
4556 ;; Write mimetype file
4565 ;; Write out the manifest entries before zipping
4567 ;; Save all XML files.
4573 ;; Prettify output if needed.
4577 org-odt-xml-files)
4578 ;; Run zip.
4583 ;; If a file with same name as the desired output file
4584 ;; exists, remove it.
4587 ;; Zip up the xml files.
4590 ;; Switch temporarily to content.xml. This way Zip
4591 ;; process will inherit `org-odt-zip-dir' as the current
4592 ;; directory.
4606 err-string)))))
4607 cmds)))
4608 ;; Move the zip file from temporary work directory to
4609 ;; user-mandated location.
4612 ;; Cleanup work directory and work files.
4614 ;; Open the OpenDocument file in archive-mode for
4615 ;; examination.
4617 ;; Return exported file.
4619 ;; Case 1: Conversion desired on exported file. Run the
4620 ;; converter on the OpenDocument file. Return the
4621 ;; converted file.
4624 target))
4625 ;; Case 2: No further conversion. Return exported
4626 ;; OpenDocument file.
4629 ;; Cleanup work directory and work files.
4635 ;;;; Export to OpenDocument formula
4637 ;;;###autoload
4639 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4640 Use `org-create-math-formula' to convert LATEX-FRAG first to
4641 MathML. When invoked as an interactive command, use
4642 `org-latex-regexps' to infer LATEX-FRAG from currently active
4643 region. If no LaTeX fragments are found, prompt for it. Push
4644 MathML source to kill ring depending on the value of
4645 `org-export-copy-to-kill-ring'."
4671 filename
4682 ;; Add MathML to kill ring, if needed.
4686 ;;;###autoload
4688 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4689 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4690 formula file."
4695 ;;;; Export to OpenDocument Text
4697 ;;;###autoload
4699 "Export current buffer to a ODT file.
4701 If narrowing is active in the current buffer, only export its
4702 narrowed part.
4704 If a region is active, export that region.
4706 A non-nil optional argument ASYNC means the process should happen
4707 asynchronously. The resulting file should be accessible through
4708 the `org-export-stack' interface.
4710 When optional argument SUBTREEP is non-nil, export the sub-tree
4711 at point, extracting information from the headline properties
4712 first.
4714 When optional argument VISIBLE-ONLY is non-nil, don't export
4715 contents of hidden elements.
4717 EXT-PLIST, when provided, is a property list with external
4718 parameters overriding Org default settings, but still inferior to
4719 file-local settings.
4721 Return output file's name."
4728 ,outfile
4733 ;; Let `htmlfontify' know that we are interested in
4734 ;; collecting styles.
4736 ;; Initialize content.xml and kick-off the export
4737 ;; process.
4750 outfile
4755 ;; Let `htmlfontify' know that we are interested in collecting
4756 ;; styles.
4758 ;; Initialize content.xml and kick-off the export process.
4768 ;;;; Convert between OpenDocument and other formats
4771 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4780 "Workhorse routine for `org-odt-convert'."
4789 in-fmt out-fmt)))
4817 out-file)
4820 nil))))
4823 "Return verbose info about formats to which IN-FMT can be converted.
4824 Return a list where each element is of the
4825 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4826 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4827 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4831 org-odt-convert-processes t))))
4835 org-odt-convert-processes t))
4836 org-odt-convert-capabilities))
4837 reachable-formats)
4842 reachable-formats))
4845 "Return list of formats to which IN-FMT can be converted.
4846 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4852 l))
4855 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4856 This is a helper routine for interactive use."
4859 nil buffer-file-name t))
4865 out-fmt-choices nil nil nil))
4867 "No known converter or no known output formats for %s files"
4868 in-fmt))))
4871 ;;;###autoload
4873 "Convert IN-FILE to format OUT-FMT using a command line converter.
4874 IN-FILE is the file to be converted. If unspecified, it defaults
4875 to variable `buffer-file-name'. OUT-FMT is the desired output
4876 format. Use `org-odt-convert-process' as the converter.
4877 If PREFIX-ARG is non-nil then the newly converted file is opened
4878 using `org-open-file'."
4883 ;;; Library Initializations
4887 ;; Let Emacs open all OpenDocument files in archive mode
4890 org-odt-file-extensions)
4894 ;;; ox-odt.el ends here