| blob | 326e8b7e53e2afad3f60b0102a5f5f9b2ec4dbfc |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2015 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
36 ;;; Define Back-End
91 org-odt--translate-latex-fragments
92 org-odt--translate-description-lists ; Dummy symbol
93 org-odt--translate-list-tables)))
94 :menu-entry
101 :options-alist
103 ;; Other variables.
116 ;; Redefine regular option.
120 ;;; Dependencies
122 ;;; Hooks
124 ;;; Function Declarations
133 \f
134 ;;; Internal Variables
138 "Location of ODT exporter.
139 Use this to infer values of `org-odt-styles-dir' and
143 "Data directory for ODT exporter.
144 Use this to infer values of `org-odt-styles-dir' and
163 )
164 "List of directories to search for OpenDocument schema files.
165 Use this list to set the default value of
166 `org-odt-schema-dir'. The entries in this list are
167 populated heuristically based on the values of `org-odt-lib-dir'
180 )
181 "List of directories to search for OpenDocument styles files.
182 See `org-odt-styles-dir'. The entries in this list are populated
183 heuristically based on the values of `org-odt-lib-dir' and
200 styles-dir)
202 org-odt-styles-dir-list)
203 nil)))
206 styles-dir)
207 "Directory that holds auxiliary XML files used by the ODT exporter.
209 This directory contains the following XML files -
211 XML files are used as the default values of
212 `org-odt-styles-file' and `org-odt-content-template-file'.
214 The default value of this variable varies depending on the
215 version of org in use and is initialized from
216 `org-odt-styles-dir-list'. Note that the user could be using org
217 from one of: org's own private git repository, GNU ELPA tar or
238 "
240 <style:table-properties style:rel-width=\"%d%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
241 </style:style>
242 "
246 "Registry of automatic styles for various OBJECT-TYPEs.
247 The variable has the following form:
248 \(\(OBJECT-TYPE-A
249 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
250 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
251 \(OBJECT-TYPE-B
252 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
253 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
254 ...\).
257 OBJECT-PROPS is (typically) a plist created by passing
263 "Running counters for various OBJECT-TYPEs.
264 Use this to generate automatic names and style-names. See
268 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
269 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
270 <style:background-image/>
271 </style:paragraph-properties>
273 </style:style>"
274 "Custom paragraph style for colorized source and example blocks.
276 except that the foreground and background colors are set
290 "Hardcoded image dimensions one for each of the anchor
293 ;; A4 page size is 21.0 by 29.7 cms
294 ;; The default page settings has 2cm margin on each of the sides. So
295 ;; the effective text area is 17.0 by 25.7 cm
305 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
307 This is a list where each entry is of the form:
309 \(CATEGORY-HANDLE OD-VARIABLE CATEGORY-NAME ENUMERATOR-PREDICATE)
311 CATEGORY_HANDLE identifies the captionable entity in question.
313 OD-VARIABLE is the OpenDocument sequence counter associated with
314 the entity. These counters are declared within
316 `org-odt-content-template-file'.
318 CATEGORY-NAME is used for qualifying captions on export.
320 ENUMERATOR-PREDICATE is used for assigning a sequence number to
330 \f
331 ;;; User Configuration Variables
334 "Options for exporting Org mode files to ODT."
339 ;;;; Debugging
342 "Specify whether or not the xml output should be prettified.
343 When this option is turned on, `indent-region' is run on all
344 component xml buffers before they are saved. Turn this off for
345 regular use. Turn this on if you need to examine the xml
346 visually."
352 ;;;; Document schema
365 schema-dir))
368 schema-dir))
372 schema-dir)
374 org-odt-schema-dir-list)
376 nil)))
377 schema-dir)
378 "Directory that contains OpenDocument schema files.
380 This directory contains:
381 1. rnc files for OpenDocument schema
383 for auto validation of OpenDocument XML files.
385 Use the customize interface to set this variable. This ensures
386 that `rng-schema-locating-files' is updated and auto-validation
387 of OpenDocument XML takes place based on the value
388 `rng-nxml-auto-validate-flag'.
390 The default value of this variable varies depending on the
391 version of org in use and is initialized from
392 `org-odt-schema-dir-list'. The OASIS schema files are available
393 only in the org's private git repository. It is *not* bundled
394 with GNU ELPA tar or standard Emacs distribution."
400 :set
402 "Set `org-odt-schema-dir'.
403 Also add it to `rng-schema-locating-files'."
413 schema-dir
416 value))
417 nil)))
422 org-odt-schema-dir))))))
425 ;;;; Document styles
429 The exporter embeds the exported content just before
433 under `org-odt-styles-dir' is used."
440 "Default styles file for use with ODT export.
441 Valid values are one of:
442 1. nil
443 2. path to a styles.xml file
444 3. path to a *.odt or a *.ott file
445 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
446 ...))
448 In case of option 1, an in-built styles.xml is used. See
449 `org-odt-styles-dir' for more information.
451 In case of option 3, the specified file is unzipped and the
452 styles.xml embedded therein is used.
454 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
455 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
456 generated odt file. Use relative path for specifying the
457 FILE-MEMBERS. styles.xml must be specified as one of the
458 FILE-MEMBERS.
460 Use options 1, 2 or 3 only if styles.xml alone suffices for
461 achieving the desired formatting. Use option 4, if the styles.xml
462 references additional files like header and footer images for
463 achieving the desired formatting.
466 a per-file basis. For example,
472 :type
484 "Outline levels considered for enumerating captioned entities."
490 ;;;; Document conversion
497 "Specify a list of document converters and their usage.
498 The converters in this list are offered as choices while
499 customizing `org-odt-convert-process'.
501 This variable is a list where each element is of the
502 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
503 of the converter. CONVERTER-CMD is the shell command for the
504 converter and can contain format specifiers. These format
505 specifiers are interpreted as below:
507 %i input file name in full
508 %I input file name as a URL
509 %f format of the output file
510 %o output file name in full
511 %O output file name as a URL
512 %d output dir in full
513 %D output dir as a URL.
514 %x extra options as set in `org-odt-convert-capabilities'."
517 :type
526 During customization, the list of converter names are populated
527 from `org-odt-convert-processes'."
537 org-odt-convert-processes))))
556 "Specify input and output formats of `org-odt-convert-process'.
557 More correctly, specify the set of input and output formats that
558 the user is actually interested in.
560 This variable is an alist where each element is of the
561 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
562 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
563 alist where each element is of the form (OUTPUT-FMT
564 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
566 The variable is interpreted as follows:
567 `org-odt-convert-process' can take any document that is in
568 INPUT-FMT-LIST and produce any document that is in the
569 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
570 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
571 serves dual purposes:
572 - It is used for populating completion candidates during
573 `org-odt-convert' commands.
575 `org-odt-convert-process'.
578 `org-odt-convert-process'.
580 DOCUMENT-CLASS is used to group a set of file formats in
581 INPUT-FMT-LIST in to a single class.
583 Note that this variable inherently captures how LibreOffice based
584 converters work. LibreOffice maps documents of various formats
585 to classes like Text, Web, Spreadsheet, Presentation etc and
586 allow document of a given class (irrespective of its source
587 format) to be converted to any of the export formats associated
588 with that class.
590 See default setting of this variable for an typical
591 configuration."
594 :type
599 :value-type
603 :value-type
612 and then uses `org-odt-convert-process' to convert the
613 resulting document to this format. During customization of this
614 variable, the list of valid values are populated based on
615 `org-odt-convert-capabilities'.
617 You can set this option on per-file basis using file local
618 values. See Info node `(emacs) File Variables'."
629 ;;;###autoload
633 ;;;; Drawers
637 "Function called to format a drawer in ODT code.
639 The function must accept two parameters:
641 CONTENTS the contents of the drawer.
643 The function should return the string to be exported.
645 The default value simply returns the value of CONTENTS."
652 ;;;; Headline
655 'org-odt-format-headline-default-function
656 "Function to format headline text.
658 This function will be called with 5 arguments:
659 TODO the todo keyword \(string or nil\).
660 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
661 PRIORITY the priority of the headline \(integer or nil\)
662 TEXT the main headline text \(string\).
663 TAGS the tags string, separated with colons \(string or nil\).
665 The function result will be used as headline text."
672 ;;;; Inlinetasks
675 'org-odt-format-inlinetask-default-function
676 "Function called to format an inlinetask in ODT code.
678 The function must accept six parameters:
679 TODO the todo keyword, as a string
680 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
681 PRIORITY the inlinetask priority, as a string
682 NAME the inlinetask name, as a string.
683 TAGS the inlinetask tags, as a string.
684 CONTENTS the contents of the inlinetask, as a string.
686 The function should return the string to be exported."
693 ;;;; LaTeX
696 "Non-nil means process LaTeX math snippets.
698 When set, the exporter will process LaTeX environments and
699 fragments.
701 This option can also be set with the +OPTIONS line,
704 nil Ignore math snippets.
705 `verbatim' Keep everything in verbatim
706 `dvipng' Process the LaTeX fragments to images. This will also
707 include processing of non-math environments.
708 `imagemagick' Convert the LaTeX fragments to pdf files and use
709 imagemagick to convert pdf files to png files.
710 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
711 be loaded.
712 t Synonym for `mathjax'."
724 ;;;; Links
728 "Rules characterizing formula files that can be inlined into ODT.
730 A rule consists in an association whose key is the type of link
731 to consider, and value is a regexp that will be matched against
732 link's path."
741 "Rules characterizing image files that can be inlined into ODT.
743 A rule consists in an association whose key is the type of link
744 to consider, and value is a regexp that will be matched against
745 link's path."
753 "Scaling factor for converting images pixels to inches.
754 Use this for sizing of embedded images. See Info node `(org)
755 Images in ODT export' for more information."
764 :xref-format
768 :xref-format
772 :xref-format
774 :label-format
778 :xref-format
782 :xref-format
784 "Specify how to format caption and cross-references.
786 Use this, for example, to control various aspects of caption (the
787 numbering format, its position etc.) or to generate page numbers
788 as part of cross-references. For a quick overview of this
789 variable, see examples towards the end of this docstring.
793 cross-reference fields (like page number etc). Use an external
794 application to synchronize these fields to their right values.
795 When using LibreOffice, use Tools -> Update-> Fields / Update
796 All.
798 This variable is an alist of pairs (RULE-TAG . RULE-PLIST).
799 RULE-TAG is a symbol. RULE-PLIST is a property list, the allowed
800 properties of which depend on the value of RULE-TAG. The details
801 are as below.
803 RULE-TAG takes following one of the values:
805 `:TABLE:' `:FIGURE:' `:MATH-FORMULA:' `:DVIPNG-IMAGE:'
806 `:LISTING:' `:TARGET:'.
808 The `:TARGET:' rule specifies how a cross-reference to a
809 HEADLINE, a TARGET or a non-captionable ELEMENT is typeset. Its
810 RULE-PLIST allow a single property `:xref-format'.
812 All RULE-TAGs (except for `:TARGET:') specify how a caption and a
813 cross-reference to the corresponding entity is typeset. Its
814 RULE-PLIST allow following properties.
816 `:caption-position' - a symbol - one of `above' or `below'
817 `:caption-format' - a mixed list of symbols and strings
818 `:xref-format' - a mixed list of symbols and strings
820 `:caption-format' and `:xref-format' are but format
821 specifiers (in disguise) and specify how a caption or a
822 cross-reference is transcoded. Their form and function are
823 better illustrated than described. So, consider the following
824 examples:
826 A `:caption-format' with the following value
830 will result in following caption.
832 Table 1: An Example Table
833 ^^^^^ ^ ^^^^^^^^^^^^^^^^
834 ^ | ^
835 | | |
836 category | caption
837 counter
839 A `:xref-format' with the following value
843 will result in following cross-reference.
845 See Section 3.1 [Tropical Storms], page 24.
846 ^ ^^^^^^^^^^^^^^^ ^^^
847 | | |
848 chapter no. chapter title page number
850 See `org-odt-link--infer-description' (specifically
851 `org-odt--xref-target') and `org-odt-format-label' for
852 implementation details."
853 :type
857 ((:xref-format
875 `(,dc
877 ((:caption-position
880 (:caption-format
886 (:xref-format
897 )))
902 ;;;; Lists
905 "Specify how description lists are rendered.
906 Choose one of HTML or LaTeX style."
912 "Alias `org-odt--translate-description-lists'."
918 ;;;; Src Block
921 "Whether custom styles for colorized source blocks be automatically created.
922 When this option is turned on, the exporter creates custom styles
923 for source blocks based on the advice of `htmlfontify'. Creation
924 of custom styles happen as part of `org-odt-hfy-face-to-css'.
926 When this option is turned off exporter does not create such
927 styles.
929 Use the latter option if you do not want the custom styles to be
930 based on your current display settings. It is necessary that the
931 styles.xml already contains needed styles for colorizing to work.
933 This variable is effective only if `org-odt-fontify-srcblocks' is
934 turned on."
940 "Specify whether or not source blocks need to be fontified.
941 Turn this option on if you want to colorize the source code
942 blocks in the exported file. For colorization to work, you need
943 to make available an enhanced version of `htmlfontify' library."
949 ;;;; Table
962 "Specify how Table Styles should be derived from a Table Template.
963 This is a list where each element is of the
964 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
966 TABLE-STYLE-NAME is the style associated with the table through
969 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
970 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
971 below) that is included in `org-odt-content-template-file'.
973 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
975 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
983 TABLE-CELL-OPTIONS is an alist where each element is of the
984 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
985 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
986 `use-last-row-styles' |
987 `use-first-column-styles' |
988 `use-last-column-styles' |
989 `use-banding-rows-styles' |
990 `use-banding-columns-styles' |
991 `use-first-row-styles'
992 ON-OR-OFF := `t' | `nil'
994 For example, with the following configuration
996 \(setq org-odt-table-styles
998 \(\(use-first-row-styles . t\)
999 \(use-first-column-styles . t\)\)\)
1001 \(\(use-first-column-styles . t\)\)\)\)\)
1004 style will use the following table-cell styles -
1009 as appropriate.
1012 use the following table-cell styles -
1014 following paragraph styles
1016 as appropriate..
1018 Note that TABLE-TEMPLATE-NAME corresponds to the
1021 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
1024 specification for more information. Also consult the
1025 implementation filed under `org-odt-get-table-cell-styles'.
1028 formatting of numbered display equations. Do not delete this
1029 style from the list."
1039 use-last-row-styles
1040 use-first-column-styles
1041 use-last-column-styles
1042 use-banding-rows-styles
1043 use-banding-columns-styles)
1044 :key-type symbol
1047 ;;;; Timestamps
1050 "Non-nil, if timestamps should be exported as date fields.
1052 When nil, export timestamps as plain text.
1054 When non-nil, map `org-time-stamp-custom-formats' to a pair of
1056 respectively. A timestamp with no time component is formatted
1060 This feature is experimental. Most (but not all) of the common
1061 %-specifiers in `format-time-string' are supported.
1063 formatted as canonical Org timestamps. For finer control, avoid
1064 these %-specifiers.
1067 etc., are displayed by the application in the default language
1068 and country specified in `org-odt-styles-file'. Note that the
1070 can localize the week day and month strings in the exported
1071 document by setting the default language and country either using
1072 the application UI or through a custom styles file.
1074 See `org-odt--build-date-styles' for implementation details."
1081 \f
1082 ;;; Internal functions
1084 ;;;; Date
1099 ;; LibreOffice does not care about end goes as content
1100 ;; within the "<text:date>...</text:date>" field. The
1101 ;; displayed date is automagically corrected to match the
1102 ;; format requested by "style:data-style-name" attribute. So
1103 ;; don't bother about formatting the date contents to be
1104 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
1105 ;; simple Org-style date should suffice.
1130 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1131 iso-date style date)
1133 repeater)))))
1135 ;;;; Frame
1144 extra
1149 style frame-attrs
1161 ;;;; Library wrappers :: Arc Mode
1168 ;; This is shamelessly stolen from `archive-zip-extract'.
1174 name)))
1179 exit-code command-output)
1187 members))
1190 ;;;; Library wrappers :: Ox
1198 ;;;; Target
1202 ;; Empty label.
1204 ;; Bookmark pointing to a range of text.
1208 ;; Bookmark at a location.
1214 org-odt-caption-and-xref-settings)
1223 label text))
1225 (format "<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
1226 % label text))))
1229 ;;;; Textbox
1232 extra anchor-type)
1238 text)
1239 width nil style extra anchor-type))
1243 ;;;; Table of Contents
1248 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1250 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1257 "
1258 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1260 <text:index-entry-chapter/>
1261 <text:index-entry-text/>
1262 <text:index-entry-link-end/>
1263 </text:table-of-content-entry-template>
1267 </text:table-of-content-source>
1269 <text:index-body>
1272 </text:index-title>
1277 </text:index-body>
1278 </text:table-of-content>
1286 ;; Section number.
1288 ;; Todo.
1293 style todo)))
1298 style priority)))
1299 ;; Title.
1300 text
1301 ;; Tags.
1305 "OrgTags"
1312 headline-label text))
1316 ;; When a headline is marked as a radio target, as in the example below:
1317 ;;
1318 ;; ** <<<Some Heading>>>
1319 ;; Some text.
1320 ;;
1321 ;; suppress generation of radio targets. i.e., Radio targets are to
1322 ;; be marked as targets within /document body/ and *not* within
1323 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1324 ;; and one in the document body.
1325 ;;
1326 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1327 ;; doesn't provide a way to disable memoization. So this doesn't
1328 ;; work.
1329 ;;
1330 ;; FIXME-2: Are there any other objects that need to be suppressed
1331 ;; within TOC?
1351 style entry)))
1356 ;;;; Document styles
1359 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1360 OBJECT-PROPS is (typically) a plist created by passing
1362 `org-odt-parse-block-attributes'.
1364 Use `org-odt-object-counters' to generate an automatic
1365 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1366 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1367 . STYLE-NAME)."
1383 ;;;; Checkbox
1386 "Return check-box string associated to ITEM."
1395 ;;; Template
1398 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1399 ;; to modify the date fields. A date could be modified by
1400 ;; offsetting in days. That's about it. Also, date and time may
1401 ;; have to be emitted as two fields - a date field and a time field
1402 ;; - separately.
1404 ;; One can add Form Controls to date and time fields so that they
1405 ;; can be easily modified. But then, the exported document will
1406 ;; become tightly coupled with LibreOffice and may not function
1407 ;; properly with other OpenDocument applications.
1409 ;; I have a strange feeling that Date styles are a bit flaky at the
1410 ;; moment.
1412 ;; The feature is experimental.
1458 ))
1466 filler-end))
1477 style
1480 output ))))
1483 "Return complete document string after ODT conversion.
1484 CONTENTS is the transcoded contents string. RAW-DATA is the
1485 original parsed data. INFO is a plist holding export options."
1486 ;; Write meta file.
1496 <office:document-meta
1506 ;; Date, if required.
1508 ;; Check if DATE is specified as an Org-timestamp. If yes,
1509 ;; include it as meta information. Otherwise, just use
1510 ;; today's date.
1519 iso-date)))))
1531 ;; Add meta.xml in to manifest.
1534 ;; Update styles file.
1535 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1536 ;; Write styles file.
1539 ;; Non-availability of styles.xml is not a critical
1540 ;; error. For now, throw an error.
1544 org-odt-styles-dir)
1557 members)))
1569 ;; create a manifest entry for styles.xml
1572 ;; FIXME: Who is opening an empty styles.xml before this point?
1577 ;; Write custom styles for source blocks
1578 ;; Save STYLES used for colorizing of source blocks.
1579 ;; Update styles.xml with styles that were collected as part of
1580 ;; `org-odt-hfy-face-to-css' callbacks.
1589 ;; Update styles.xml - take care of outline numbering
1591 ;; Don't make automatic backup of styles.xml file. This setting
1592 ;; prevents the backed-up styles.xml file from being zipped in to
1593 ;; odt file. This is more of a hackish fix. Better alternative
1594 ;; would be to fix the zip command so that the output odt file
1595 ;; includes only the needed files and excludes any auto-generated
1596 ;; extra files like backups and auto-saves etc etc. Note that
1597 ;; currently the zip command zips up the entire temp directory so
1598 ;; that any auto-generated files created under the hood ends up in
1599 ;; the resulting odt file.
1602 ;; Outline numbering is retained only upto LEVEL.
1603 ;; To disable outline numbering pass a LEVEL of 0.
1616 ;; Update content.xml.
1619 ;; within the context of the Org buffer. So obtain its
1620 ;; value before moving on to temp-buffer context down below.
1630 org-odt-styles-dir)))
1631 ;; Write automatic styles.
1632 ;; - Position the cursor.
1636 ;; - Dump automatic table styles.
1642 ;; - Dump date-styles.
1648 ;; Update display level.
1649 ;; - Remove existing sequence decls. Also position the cursor.
1654 ;; Update sequence decls according to user preference.
1664 ;; Position the cursor to document body.
1669 ;; Preamble - Title, Author, Date etc.
1677 ;; Switch on or off above vars based on user settings
1681 ;; Title.
1686 ;; Separator.
1690 ;; Author only.
1693 "OrgSubtitle"
1695 ;; Separator.
1698 ;; Author and E-mail.
1702 "OrgSubtitle"
1707 ;; Separator.
1709 ;; Date, if required.
1712 ;; Check if DATE is specified as a timestamp.
1716 ;; Use DATE as subtitle.
1725 ;; Separator
1727 ;; Table of Contents
1730 with-toc
1733 ;; Contents.
1735 ;; Return contents.
1739 \f
1740 ;;; Transcode Functions
1742 ;;;; Bold
1745 "Transcode BOLD from Org to ODT.
1746 CONTENTS is the text with bold markup. INFO is a plist holding
1747 contextual information."
1749 ;; Internally, `org-odt--translate-description-lists/html'
1750 ;; or `org-odt--translate-description-lists/latex' requests
1751 ;; a custom style for bold.
1753 contents))
1756 ;;;; Center Block
1759 "Transcode a CENTER-BLOCK element from Org to ODT.
1760 CONTENTS holds the contents of the center block. INFO is a plist
1761 holding contextual information."
1762 contents)
1765 ;;;; Clock
1768 "Transcode a CLOCK element from Org to ODT.
1769 CONTENTS is nil. INFO is a plist used as a communication
1770 channel."
1783 ;;;; Code
1786 "Transcode a CODE object from Org to ODT.
1787 CONTENTS is nil. INFO is a plist used as a communication
1788 channel."
1794 ;;;; Comment
1796 ;; Comments are ignored.
1799 ;;;; Comment Block
1801 ;; Comment Blocks are ignored.
1804 ;;;; Drawer
1807 "Transcode a DRAWER element from Org to ODT.
1808 CONTENTS holds the contents of the block. INFO is a plist
1809 holding contextual information."
1812 name contents)))
1813 output))
1816 ;;;; Dynamic Block
1819 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1820 CONTENTS holds the contents of the block. INFO is a plist
1821 holding contextual information. See `org-export-data'."
1822 contents)
1825 ;;;; Entity
1828 "Transcode an ENTITY object from Org to ODT.
1829 CONTENTS are the definition itself. INFO is a plist holding
1830 contextual information."
1834 ;;;; Example Block
1837 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1838 CONTENTS is nil. INFO is a plist holding contextual information."
1842 ;;;; Export Snippet
1845 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1846 CONTENTS is nil. INFO is a plist holding contextual information."
1851 ;;;; Export Block
1854 "Transcode a EXPORT-BLOCK element from Org to ODT.
1855 CONTENTS is nil. INFO is a plist holding contextual information."
1860 ;;;; Fixed Width
1863 "Transcode a FIXED-WIDTH element from Org to ODT.
1864 CONTENTS is nil. INFO is a plist holding contextual information."
1868 ;;;; Footnote Definition
1870 ;; Footnote Definitions are ignored.
1873 ;;;; Footnote Reference
1881 id note-class
1887 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1888 CONTENTS is nil. INFO is a plist holding contextual information."
1898 "OrgSuperscript"
1899 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1900 note-class ref-format ref-name n)))))))
1902 ;; Insert separator between two footnotes in a row.
1907 ;; Transcode footnote reference.
1913 ;; Inline definitions are secondary strings.
1914 ;; Non-inline footnotes definitions are full Org data.
1917 footnote-reference info))
1926 ;;;; Citation Reference
1929 "Transcode a CITATION element from Org to ODT.
1930 CONTENTS is nil. INFO is a plist holding contextual information."
1931 ;; Just interpret the citation object.
1932 ;; Citation processors (like ox-jabref.el) may handle citation
1933 ;; by registering their own transcoders.
1936 ;;;; Headline
1940 "Default format function for a headline.
1941 See `org-odt-format-headline-function' for details."
1943 ;; Todo.
1947 style todo)))
1952 style priority)))
1953 ;; Title.
1954 text
1955 ;; Tags.
1958 "<text:tab/>"
1968 "Transcode a HEADLINE element using BACKEND.
1969 INFO is a plist holding contextual information."
1995 todo todo-type priority text tags))))))
1997 todo todo-type priority text tags
2002 "Transcode a HEADLINE element from Org to ODT.
2003 CONTENTS holds the contents of the headline. INFO is a plist
2004 holding contextual information."
2005 ;; Case 1: This is a footnote section: ignore it.
2008 ;; Create the headline text.
2010 ;; Get level relative to current parsed data.
2012 ;; Get canonical label for the headline.
2016 ;; Get user-specified labels for the headline.
2019 ;; Extra targets.
2027 ;; Title.
2030 ;; Case 2. This is a deep sub-tree: export it as a list item.
2031 ;; Also export as items headlines for which no section
2032 ;; format has been found.
2034 ;; Build the real contents of the sub-tree.
2038 ;; Choose style based on list type.
2041 ;; If top-level list, re-start numbering. Otherwise,
2042 ;; continue numbering.
2045 headline)))
2055 "Text_20_body"
2057 contents)
2059 "</text:list-header>"
2063 ;; Case 3. Standard headline. Export it as a section.
2069 level
2071 contents))))))
2074 ;;;; Horizontal Rule
2077 "Transcode an HORIZONTAL-RULE object from Org to ODT.
2078 CONTENTS is nil. INFO is a plist holding contextual information."
2083 ;;;; Inline Babel Call
2085 ;; Inline Babel Calls are ignored.
2088 ;;;; Inline Src Block
2091 "Return a character not used in string S.
2093 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
2099 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
2100 CONTENTS holds the contents of the item. INFO is a plist holding
2101 contextual information."
2108 ;;;; Inlinetask
2111 "Transcode an INLINETASK element from Org to ODT.
2112 CONTENTS holds the contents of the block. INFO is a plist
2113 holding contextual information."
2124 todo todo-type priority name tags contents)))
2128 "Transcode an INLINETASK element from Org to ODT.
2129 CONTENTS holds the contents of the block. INFO is a plist
2130 holding contextual information."
2132 "Text_20_body"
2136 "OrgInlineTaskHeading"
2138 todo todo-type priority name tags))
2139 contents)
2142 ;;;; Italic
2145 "Transcode ITALIC from Org to ODT.
2146 CONTENTS is the text with italic markup. INFO is a plist holding
2147 contextual information."
2152 ;;;; Item
2155 "Transcode an ITEM element from Org to ODT.
2156 CONTENTS holds the contents of the item. INFO is a plist holding
2157 contextual information."
2168 contents
2180 ;;;; Keyword
2183 "Transcode a KEYWORD element from Org to ODT.
2184 CONTENTS is nil. INFO is a plist holding contextual information."
2190 ;; FIXME
2201 ;; FIXME
2203 ;; Handle BIBLIOGRAPHY. Ignore it.
2205 ;; Citation Processors (see ox-jabref.el) may handle this by
2206 ;; registering their own transcoders.
2210 ;; Pagebreaks created this way are a mere expedience. These
2211 ;; create extraneous "empty" paragraphs which take up "extra
2212 ;; space". A typographer will chide you for resorting to such
2213 ;; underhanded means to create pagebreaks.
2214 ;;
2215 ;; As an expedience it has it's uses. See
2216 ;; `org-odt-special-block' for a realistic example of how
2217 ;; pagebreak can be to service.
2218 ;;
2219 ;; The right way to create pagebreaks is to create new styles -
2220 ;; custom or automatic - that set the "before/after" pagebreak
2221 ;; of an element (a paragraph, table etc).
2222 ;;
2223 ;; For example, consider pagebreaks created as below.
2224 ;;
2225 ;; Text in first page.
2226 ;;
2227 ;; #+ATTR_ODT: :style "OrgPageBreakDefault"
2228 ;; #+PAGEBREAK:
2229 ;;
2230 ;; This text goes in next page.
2232 ;; Now look at the page that is introduced with forced page
2233 ;; break. You will realize that the first line of text in that
2234 ;; page is a bit displaced from other pages created by
2235 ;; LibreOffice. A keen eye will definitely catch this
2236 ;; aberration.
2243 ;;;; Latex Environment
2246 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2247 ;; (defadvice org-format-latex-as-mathml ; FIXME
2248 ;; (after org-odt-protect-latex-fragment activate)
2249 ;; "Encode LaTeX fragment as XML.
2250 ;; Do this when translation to MathML fails."
2251 ;; (unless (> (length ad-return-value) 0)
2252 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2255 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2256 CONTENTS is nil. INFO is a plist holding contextual information."
2262 ;;;; Latex Fragment
2264 ;; (when latex-frag ; FIXME
2265 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2266 ;; :description latex-frag)))
2267 ;; handle verbatim
2268 ;; provide descriptions
2271 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2272 CONTENTS is nil. INFO is a plist holding contextual information."
2278 ;;;; Line Break
2281 "Transcode a LINE-BREAK object from Org to ODT.
2282 CONTENTS is nil. INFO is a plist holding contextual information."
2286 ;;;; Link
2288 ;;;; Links :: Label references
2299 x)))))
2310 counter))
2317 ;; Section number.
2321 ;; Separator.
2323 ;; Ordinal.
2325 tag))
2328 "Return a label for ELEMENT.
2330 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2331 element. INFO is a plist used as a communication channel. OP is
2332 either `definition' or `reference', depending on the purpose of
2333 the generated string.
2335 Return value is a string if OP is set to `reference' or a cons
2336 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2337 SHORT-CAPTION are strings."
2343 ;; Get label and caption.
2347 ;; Transcode captions.
2349 ;; Currently short caption are sneaked in as object names.
2350 ;;
2351 ;; The advantages are:
2352 ;;
2353 ;; - Table Of Contents: Currently, there is no support for
2354 ;; building TOC for figures, listings and tables. See
2355 ;; `org-odt-keyword'. User instead has to rely on
2356 ;; external application for building such indices. Within
2357 ;; LibreOffice, building an "Illustration Index" or "Index
2358 ;; of Tables" will create a table with long captions (only)
2359 ;; and building a table with "Object names" will create a
2360 ;; table with short captions.
2361 ;;
2362 ;; - Easy navigation: In LibreOffice, object names are
2363 ;; offered via the navigation bar. This way one can
2364 ;; quickly locate and jump to object of his choice in the
2365 ;; exported document.
2366 ;;
2367 ;; The main disadvantage is that there cannot be any markups
2368 ;; within object names i.e., one cannot embolden, italicize
2369 ;; or underline text within short caption. So suppress
2370 ;; generation of <text:span >...</text:span> and other
2371 ;; markups by overriding the default translators. We
2372 ;; probably shouldn't be suppressing translators for all
2373 ;; elements in `org-element-all-objects', but for now this
2374 ;; will do.
2376 ;; Sneaking in short-caption as name attribute is
2377 ;; problematic with LibreOffice > 4.0.4.2. So ignore
2378 ;; short-captions. See following thread:
2379 ;; http://lists.gnu.org/archive/html/emacs-orgmode/2013-12/msg00100.html
2385 :transcoders
2387 org-element-all-objects))))
2404 element))))
2407 seqno)
2411 ;; Compute sequence number of the element.
2413 ;; Localize category string.
2416 ;; Case 1: Handle Label definition.
2418 ;; Assign an internal label, if user has not provided one
2423 ;; Sneak in a bookmark. The bookmark is used when the
2424 ;; labeled element is referenced with a link that
2425 ;; provides its own description.
2427 ;; Label definition: Typically formatted as below:
2428 ;; CATEGORY SEQ-NO: LONG CAPTION
2429 ;; with translation for correct punctuation.
2433 org-odt-caption-and-xref-settings)
2441 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2442 label counter counter seqno))
2446 short-caption))
2447 ;; Case 2: Handle Label reference.
2454 org-odt-caption-and-xref-settings)
2461 org-odt-caption-and-xref-settings)
2468 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2469 % label value))))
2474 ;;;; Links :: Inline Images
2477 "Returns the internal name of the file"
2493 target-file))
2496 user-height scale dpi embed-as)
2516 ;; Use Imagemagick.
2521 file))))
2526 ;; Use Emacs.
2532 ;; Use hard-coded values.
2534 org-odt-default-image-sizes-alist))
2535 ;; Error out.
2548 ;; ensure that an embedded image fits comfortably within a page
2559 "Return ODT code for an inline image.
2560 LINK is the link pointing to the inline image. INFO is a plist
2561 used as a communication channel."
2574 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2576 ;; Extract attributes from #+ATTR_ODT line.
2580 ;; Handle `:anchor', `:style' and `:attributes' properties.
2590 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2591 ;;
2592 ;; Handle `:width', `:height' and `:scale' properties. Read
2593 ;; them as numbers since we need them for computations.
2595 src-expanded info
2599 nil ; embed-as
2601 ))
2608 ;; Check if this link was created by LaTeX-to-PNG converter.
2612 ;; If yes, note down the type of the element - LaTeX Fragment
2613 ;; or LaTeX environment. It will go in to frame title.
2617 ;; If yes, note down its contents. It will go in to frame
2618 ;; description. This quite useful for debugging.
2621 captions user-frame-params title desc)))
2624 ;;;; Links :: Math formula
2645 ;; Check if this link was created by LaTeX-to-MathML
2646 ;; converter.
2650 ;; If yes, note down the type of the element - LaTeX Fragment
2651 ;; or LaTeX environment. It will go in to frame title.
2655 ;; If yes, note down its contents. It will go in to frame
2656 ;; description. This quite useful for debugging.
2658 width height)
2662 nil nil title desc))
2665 "CaptionedDisplayFormula" href width height
2666 captions nil title desc))
2672 "Returns the internal name of the file"
2676 ;; Create a directory for holding formula file. Also enter it in
2677 ;; to manifest.
2681 ;; Copy over the formula file from user directory to zip
2682 ;; directory.
2686 ;; Case 1: Mathml.
2689 ;; Case 2: OpenDocument formula.
2694 ;; Enter the formula file in to manifest.
2696 target-file))
2698 ;;;; Targets
2701 captions user-frame-params
2704 ;; Each element of this alist is of the form (CFG-HANDLE
2705 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2707 ;; CFG-HANDLE is the key to the alist.
2709 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2710 ;; frame params for INNER-FRAME and OUTER-FRAME
2711 ;; respectively. See below.
2713 ;; Configurations that are meant to be applied to
2714 ;; non-captioned image/formula specifies no
2715 ;; OUTER-FRAME-PARAMS.
2717 ;; TERMINOLOGY
2718 ;; ===========
2719 ;; INNER-FRAME :: Frame that directly surrounds an
2720 ;; image/formula.
2722 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2723 ;; frame also contains the caption, if any.
2725 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2726 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2727 ;; that these are the last three arguments
2728 ;; to `org-odt--frame'.
2730 ;; Note that an un-captioned image/formula requires just an
2731 ;; INNER-FRAME, while a captioned image/formula requires
2732 ;; both an INNER and an OUTER-FRAME.
2754 ;; Retrieve inner and outer frame params, from configuration.
2758 ;; User-specified frame params (from #+ATTR_ODT spec)
2762 "Merge default and user frame params."
2767 for d in default
2770 ;; Case 1: Image/Formula has no caption.
2771 ;; There is only one frame, one that surrounds the image
2772 ;; or formula.
2774 ;; Merge user frame params with that from configuration.
2778 ;; Case 2: Image/Formula is captioned or labeled.
2779 ;; There are two frames: The inner one surrounds the
2780 ;; image or formula. The outer one contains the
2781 ;; caption/sequence number.
2783 ;; Merge user frame params with outer frame params.
2785 ;; Short caption, if specified, goes as part of inner frame.
2792 frame-params))
2795 "Illustration"
2799 caption))
2800 width height outer)))))
2803 ;; Element should have a caption or label.
2809 element info
2810 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2811 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2812 ;; processing.)
2817 ;; Link should point to an image file.
2824 element info
2825 ;; Paragraph should have a caption or label. It SHOULD also be a
2826 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2827 ;; processing.)
2832 ;; Link should point to an image file.
2839 element info
2840 ;; Paragraph should have a caption or label.
2844 ;; Link should point to a MathML or ODF file.
2850 paragraph-predicate
2851 link-predicate)
2852 "Test if ELEMENT is a standalone link for the purpose ODT export.
2853 INFO is a plist holding contextual information.
2855 Return non-nil, if ELEMENT is of type paragraph satisfying
2856 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2857 is a link that satisfies LINK-PREDICATE.
2859 Return non-nil, if ELEMENT is of type link satisfying
2860 LINK-PREDICATE and its containing paragraph satisfies
2861 PARAGRAPH-PREDICATE in addition to having no other content save for
2862 leading and trailing whitespaces.
2864 Return nil, otherwise."
2887 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2888 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2889 ;; attached. Note that labels that are attached to captioned
2890 ;; entities - inline images, math formulae and tables - get resolved
2891 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2893 ;; Create a cross-reference to DESTINATION but make best-efforts to
2894 ;; create a *meaningful* description. Check item numbers, section
2895 ;; number and section title in that order.
2897 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2898 ;; FIXME: Handle footnote-definition footnote-reference?
2910 ;; Case 1: Does the user want the cross-references to be typeset
2911 ;; in a custom manner (say for example, generate page numbers
2912 ;; etc.)? If yes, emit the required XML tags but with "???" as
2913 ;; the field value. This (incorrect) field value can be
2914 ;; corrected by using an external Office application. For
2915 ;; example, in case of LibreOffice, the field values can be
2916 ;; synchronized by running Tools->Update->Fields/Update All on
2917 ;; the exported document.
2920 ;; Case 2: Is target an item of a numbered list? If yes, use the
2921 ;; item's number as description. The target need not necessarily
2922 ;; be part of a proper numbered list, it can also be part of a
2923 ;; low-level headline that is deemed as a list for purposes of
2924 ;; export.
2929 return x))
2930 ;; Get list item nos.
2935 plain-list)
2938 item info t))))))
2939 ;; Locate top-most listified headline.
2944 return x))
2945 ;; Get listified headline numbers.
2951 el info t)))))))
2952 ;; Combine item numbers from both the listified headlines and
2953 ;; regular list items.
2955 ;; Case 2.1: Check if all the parents of list item are
2956 ;; numbered. If yes, link to the item proper.
2959 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2964 ;; Case 3: Is the target part of a regular and numbered headline
2965 ;; in the hierarchy? If yes, use the chapter/section number as
2966 ;; description.
2971 return el)))
2972 ;; We found one.
2974 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2978 ;; Case 4: Is the target part of any headline. If yes, use the
2979 ;; chapter/section's title description.
2983 return el)))
2984 ;; We found one.
2986 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2990 ;; Case 5: The target is part of a document that is outside of
2991 ;; any headline. Use "???" as description. (We can use the
2992 ;; label text itself as the description. But, philosophically
2993 ;; speaking, this is in-appropriate. Targets are just labels and
2994 ;; must not generate any content text. So, it makes sense to
2995 ;; insist that the user provide an explicit description.)
2996 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3000 "Transcode a LINK object from Org to ODT.
3002 DESC is the description part of the link, or the empty string.
3003 INFO is a plist holding contextual information. See
3004 `org-export-data'."
3007 ;; Ensure DESC really exists, or set it to nil.
3017 ;; Convert & to & for correct XML representation
3020 ;; Link type is handled by a special function.
3022 ;; Image file.
3026 ;; Formula file.
3030 ;; Radio target: Transcode target's contents and use them as
3031 ;; link's description.
3039 ;; Case 1: Honour user's customization.
3041 ;; Case 2: Use the text of the radio target.
3043 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3044 href desc))))))
3045 ;; Links pointing to a headline: Find destination and build
3046 ;; appropriate referencing command.
3052 ;; Case 1: Fuzzy link points nowhere.
3053 ('nil
3059 ;; Case 2: Fuzzy link points to a headline.
3061 ;; If there's a description, create a hyperlink.
3062 ;; Otherwise, try to provide a meaningful description.
3071 label desc))))
3072 ;; Case 3: Fuzzy link points to a target.
3074 ;; If there's a description, create a hyperlink.
3075 ;; Otherwise, try to provide a meaningful description.
3080 desc))))
3081 ;; Case 4: Fuzzy link points to some element (e.g., an
3082 ;; inline image, a math formula or a table).
3089 ;; LINK has no description. Create
3090 ;; a cross-reference showing entity's sequence
3091 ;; number.
3093 ;; LINK has description. Insert a hyperlink with
3094 ;; user-provided description.
3099 desc)))))))))
3100 ;; Coderef: replace link with the reference name or the
3101 ;; equivalent line number.
3108 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
3109 href line-no))))
3110 ;; External link with a description part.
3113 ;; Check if description is a link to an inline image.
3119 ;; Format link as a clickable image.
3121 path desc)
3122 ;; Otherwise, format it as a regular link.
3124 path desc))))
3125 ;; External link without a description part.
3128 path path))
3129 ;; No path, only description. Try to do something useful.
3134 ;;;; Node Property
3137 "Transcode a NODE-PROPERTY element from Org to ODT.
3138 CONTENTS is nil. INFO is a plist holding contextual
3139 information."
3146 ;;;; Paragraph
3148 ;; You can customize paragraphs - standalone one and those occurring
3149 ;; within lists - using `:style' and `:p-style' attributes. Try out
3150 ;; the following example and see for yourself what you can achieve.
3151 ;;
3152 ;; #+ATTR_ODT: :style "OrgBulletedList" :p-style "Text_20_body_20_bold"
3153 ;; 1. N1
3154 ;; 1. N11
3155 ;; 2. N12
3156 ;; 2. N2
3157 ;; #+ATTR_ODT: :style "OrgNumberedList" :p-style "Preformatted_20_Text"
3158 ;; * B21
3159 ;;
3160 ;; * B22
3161 ;; - B221
3162 ;;
3163 ;; First paragraph.
3164 ;;
3165 ;; #+ATTR_ODT: :style "OrgBibliographyList" :p-style "Text_20_body"
3166 ;; 1. one
3167 ;; 2. two
3168 ;; 3. three
3169 ;;
3170 ;; #+ATTR_ODT: :style "Text_20_body_20_indent"
3171 ;; Second paragraph.
3172 ;;
3173 ;; - B222
3174 ;; * B23
3175 ;; 3. N3
3178 "Transcode a PARAGRAPH element from Org to ODT.
3179 CONTENTS is the contents of the paragraph, as a string. INFO is
3180 the plist used as a communication channel."
3186 ;; Traverse the parse-tree from root element to this
3187 ;; paragraph. Use the following rule at each element to
3188 ;; calculate the paragraph style applicable at that element.
3190 ;; Case 1: If an element specifies an EXPLICIT STYLE of it's
3191 ;; own via the #+ATTR_ODT line, use it. PARAGRAPH and
3192 ;; SPECIAL-BLOCK use the `:style' attribute for this
3193 ;; purpose, while PLAIN-LIST uses `:p-style' attribute.
3195 ;; Case 2: If an element does not have an explicit style but
3196 ;; has an IMPLICIT, PRE-CONFIGURE STYLE of it's own, use it.
3197 ;; For example, paragraphs within a FOOTNOTE-DEFINITON,
3198 ;; CENTER-BLOCK or QUOTE-BLOCK get pre-configured styles
3199 ;; like "Footnote", "OrgCenter" or "Quotations" resply.
3201 ;; Case 3: If an element specifies neither an IMPLICIT style
3202 ;; or an EXPLICIT style, use the style from it's parent.
3203 ;; For example, a paragraph within a PLAIN-LIST (that
3204 ;; doesn't specify a `:p-style' of it's own) inherit it's
3205 ;; style from the it's parent.
3207 ;; Case 4: If an element has no parent (i.e., root node),
3208 ;; use the fallback style "Text_20_body".
3210 ;; Fallback style.
3212 with footnote-definition-p = nil do
3215 ;; Case 1: Does this node IMPLICITLY or
3216 ;; EXPLICITLY specify a style? Use it.
3227 ;; Case 1: Some paragraphs are "created"
3228 ;; not by the user but by the
3229 ;; pre-processing stage. They use the
3230 ;; `:style' property of the element rather
3231 ;; than the style property from the
3232 ;; attribute line. See
3233 ;; `org-odt--translate-description-lists/latex',
3234 ;; `org-odt--translate-description-lists/html'
3235 ;; `org-odt--translate-latex-fragments'.
3239 ;; NOTE: ITEMs cannot have #+ATTR_ODT
3240 ;; attached to them. See
3241 ;;
3242 ;; http://lists.gnu.org/archive/html/emacs-orgmode/2013-08/msg00586.html
3250 ;; Case 1: Handle SPECIAL-BLOCKs that are
3251 ;; well-known (and treated specially) by
3252 ;; the ODT exporter.
3255 ;; Case 2: Handle user-specified
3256 ;; SPECIAL-BLOCKs not known to the
3257 ;; exporter.
3259 ;; Case 2: Element doesn't specify a style of
3260 ;; it's own. Use the parent style.
3261 style))
3262 finally return style)))
3263 ;; If this paragraph is a leading paragraph in an item and the
3264 ;; item has a checkbox, splice the checkbox and paragraph contents
3265 ;; together.
3272 ;;;; Plain List
3275 "Transcode a PLAIN-LIST element from Org to ODT.
3276 CONTENTS is the contents of the list. INFO is a plist holding
3277 contextual information."
3279 ;; Choose style based on list type.
3285 ;; FIXME: Define and handle `:style' attributes for
3286 ;; description lists.
3289 ;; If top-level list, re-start numbering. Otherwise,
3290 ;; continue numbering.
3295 contents))
3297 ;;;; Plain Text
3310 line))
3321 "Transcode a TEXT string from Org to ODT.
3322 TEXT is the string to transcode. INFO is a plist holding
3323 contextual information."
3325 ;; Protect &, < and >.
3327 ;; Handle smart quotes. Be sure to provide original string since
3328 ;; OUTPUT may have been modified.
3331 ;; Convert special strings.
3337 org-odt-special-string-regexps))
3338 ;; Handle break preservation if required.
3342 ;; Return value.
3343 output))
3346 ;;;; Planning
3349 "Transcode a PLANNING element from Org to ODT.
3350 CONTENTS is nil. INFO is a plist used as a communication
3351 channel."
3353 "OrgPlanning"
3375 ;;;; Property Drawer
3378 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3379 CONTENTS holds the contents of the drawer. INFO is a plist
3380 holding contextual information."
3383 contents)))
3386 ;;;; Quote Block
3389 "Transcode a QUOTE-BLOCK element from Org to ODT.
3390 CONTENTS holds the contents of the block. INFO is a plist
3391 holding contextual information."
3392 contents)
3395 ;;;; Section
3400 style
3402 text)))
3406 "Transcode a SECTION element from Org to ODT.
3407 CONTENTS holds the contents of the section. INFO is a plist
3408 holding contextual information."
3409 contents)
3411 ;;;; Radio Target
3414 "Transcode a RADIO-TARGET object from Org to ODT.
3415 TEXT is the text of the target. INFO is a plist holding
3416 contextual information."
3422 ;;;; Special Block
3425 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3426 CONTENTS holds the contents of the block. INFO is a plist
3427 holding contextual information."
3431 ;; Annotation.
3437 ;; FIXME: Is `car' right thing to do below?
3447 contents)))))
3448 ;; Textbox.
3450 ;; Textboxes an be used for centering tables etc horizontally
3451 ;; and vertically within a page.
3453 ;; In the example below, a landscape and centered table is
3454 ;; created in the middle of what is essentially a portrait
3455 ;; document.
3457 ;; Leading text.
3458 ;;
3459 ;; #+ATTR_ODT: :style "OrgPageBreakLandscape"
3460 ;; #+PAGEBREAK:
3461 ;;
3462 ;; #+ATTR_ODT: :width 5 :style "OrgPageImage" :anchor "page"
3463 ;; #+BEGIN_TEXTBOX
3464 ;; | a | b |
3465 ;; | e | f |
3466 ;; #+END_TEXTBOX
3467 ;;
3468 ;; #+ATTR_ODT: :style "OrgPageBreakDefault"
3469 ;; #+PAGEBREAK:
3470 ;;
3471 ;; Trailing text.
3479 style extra anchor))))
3483 ;;;; Src Block
3486 "Create custom style for face FN.
3487 When FN is the default face, use its foreground and background
3489 use its color attribute to create a character style whose name
3490 is obtained from FN. Currently all attributes of FN other than
3491 color are ignored.
3493 The style name for a face FN is derived using the following
3494 operations on the face name in that order - de-dash, CamelCase
3496 `font-lock-function-name-face' is associated with
3510 background-color-val color-val))
3513 "
3561 code
3572 par-style loc))
3575 num-start refs))
3589 ;; Extract code and references.
3593 ;; Does the src block contain labels?
3595 ;; Does it have line numbers?
3602 "Transcode a SRC-BLOCK element from Org to ODT.
3603 CONTENTS holds the contents of the item. INFO is a plist holding
3604 contextual information."
3613 ;; Is `:textbox' property non-nil?
3615 ;; Yes. Enclose it in a Text Box.
3617 "Text_20_body"
3621 ;;;; Statistics Cookie
3624 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3625 CONTENTS is nil. INFO is a plist holding contextual information."
3631 ;;;; Strike-Through
3634 "Transcode STRIKE-THROUGH from Org to ODT.
3635 CONTENTS is the text with strike-through markup. INFO is a plist
3636 holding contextual information."
3641 ;;;; Subscript
3644 "Transcode a SUBSCRIPT object from Org to ODT.
3645 CONTENTS is the contents of the object. INFO is a plist holding
3646 contextual information."
3651 ;;;; Superscript
3654 "Transcode a SUPERSCRIPT object from Org to ODT.
3655 CONTENTS is the contents of the object. INFO is a plist holding
3656 contextual information."
3661 ;;;; Table Cell
3669 "Retrieve styles applicable to a table cell.
3670 R and C are (zero-based) row and column numbers of the table
3671 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3672 applicable to the current table. It is nil if the table is not
3673 associated with any style attributes.
3675 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3677 When STYLE-SPEC is nil, style the table cell the conventional way
3678 - choose cell borders based on row and column groupings and
3679 choose paragraph alignment based on `org-col-cookies' text
3680 property. See also
3681 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3683 When STYLE-SPEC is non-nil, ignore the above cookie and return
3684 styles congruent with the ODF-1.2 specification."
3690 info)))
3692 ;; LibreOffice - particularly the Writer - honors neither table
3693 ;; templates nor custom table-cell styles. Inorder to retain
3694 ;; inter-operability with LibreOffice, only automatic styles are
3695 ;; used for styling of table-cells. The current implementation is
3696 ;; congruent with ODF-1.2 specification and hence is
3697 ;; future-compatible.
3699 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3700 ;; which recognizes as many as 16 different cell types - is much
3701 ;; richer. Unfortunately it is NOT amenable to easy configuration
3702 ;; by hand.
3737 'table-cell
3741 info)))
3744 "Transcode a TABLE-CELL element from Org to ODT.
3745 CONTENTS is nil. INFO is a plist used as a communication
3746 channel."
3755 table-cell info))
3777 table-cell info))))))
3781 custom-style-prefix))
3783 "OrgTblCell"
3798 cell-attributes
3801 org-element-all-elements)
3802 contents
3804 paragraph-style contents))))
3811 ;;;; Table Row
3814 "Transcode a TABLE-ROW element from Org to ODT.
3815 CONTENTS is the contents of the row. INFO is a plist used as a
3816 communication channel."
3817 ;; Rules are ignored since table separators are deduced from
3818 ;; borders of the current row.
3824 ;; If the row belongs to the first rowgroup and the
3825 ;; table has more than one row groups, then this row
3826 ;; belongs to the header row group.
3828 ;; Otherwise, it belongs to non-header row group.
3831 ;; Does this row begin a rowgroup?
3834 ;; Actual table row
3839 row-style contents))
3840 ;; Does this row end a rowgroup?
3845 ;;;; Table
3848 "Transcode a TABLE element from Org to ODT.
3849 CONTENTS is the contents of the table. INFO is a plist holding
3850 contextual information."
3852 ;; Case 1: table.el doesn't support export to OD format. Strip
3853 ;; such tables from export.
3858 "(ox-odt): Found table.el-type table in the source Org file."
3859 " table.el doesn't support export to ODT format."
3861 ;; Case 2: Native Org tables.
3877 column-style))
3878 out)
3882 ;; caption.
3886 ;; begin table.
3894 ;; column specification.
3896 ;; actual contents.
3898 ;; end table.
3902 "Transcode a TABLE element from Org to ODT.
3903 CONTENTS is the contents of the table. INFO is a plist holding
3904 contextual information.
3906 Use `org-odt--table' to typeset the table. Handle details
3907 pertaining to indentation here."
3922 collect el)))
3928 collect
3933 parent-list)
3935 ;; Handle list genealogy.
3955 parent-list info)
3958 ;; Handle low-level headlines.
3960 with step = 'item collect
3968 el info)
3969 "OrgNumberedList"
3980 parent-list info)))
3988 table info)))
3989 ;; OpenDocument schema does not permit table to occur within a
3990 ;; list item.
3992 ;; One solution - the easiest and lightweight, in terms of
3993 ;; implementation - is to put the table in an indented text box
3994 ;; and make the text box part of the list-item. Unfortunately if
3995 ;; the table is big and spans multiple pages, the text box could
3996 ;; overflow. In this case, the following attribute will come
3997 ;; handy.
3999 ;; ,---- From OpenDocument-v1.1.pdf
4000 ;; | 15.27.28 Overflow behavior
4001 ;; |
4002 ;; | For text boxes contained within text document, the
4003 ;; | style:overflow-behavior property specifies the behavior of text
4004 ;; | boxes where the containing text does not fit into the text
4005 ;; | box.
4006 ;; |
4007 ;; | If the attribute's value is clip, the text that does not fit
4008 ;; | into the text box is not displayed.
4009 ;; |
4010 ;; | If the attribute value is auto-create-new-frame, a new frame
4011 ;; | will be created on the next page, with the same position and
4012 ;; | dimensions of the original frame.
4013 ;; |
4014 ;; | If the style:overflow-behavior property's value is
4015 ;; | auto-create-new-frame and the text box has a minimum width or
4016 ;; | height specified, then the text box will grow until the page
4017 ;; | bounds are reached before a new frame is created.
4018 ;; `----
4020 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
4021 ;; auto-create-new-frame property and always resorts to clipping
4022 ;; the text box. This results in table being truncated.
4024 ;; So we solve the problem the hard (and fun) way using list
4025 ;; continuations.
4027 ;; The problem only becomes more interesting if you take in to
4028 ;; account the following facts:
4029 ;;
4030 ;; - Description lists are simulated as plain lists.
4031 ;; - Low-level headlines can be listified.
4032 ;; - In Org-mode, a table can occur not only as a regular list
4033 ;; item, but also within description lists and low-level
4034 ;; headlines.
4036 ;; See `org-odt--translate-description-lists' and
4037 ;; `org-odt-translate-low-level-headlines' for how this is
4038 ;; tackled.
4041 ;; Discontinue the list.
4043 ;; Put the table in an indented section.
4048 ;; Continue the list.
4052 ;;;; Target
4055 "Transcode a TARGET object from Org to ODT.
4056 CONTENTS is nil. INFO is a plist holding contextual
4057 information."
4062 ;;;; Timestamp
4065 "Transcode a TIMESTAMP object from Org to ODT.
4066 CONTENTS is nil. INFO is a plist used as a communication
4067 channel."
4084 "OrgActiveTimestamp"
4088 "OrgInactiveTimestamp"
4092 "OrgActiveTimestamp"
4098 "OrgInactiveTimestamp"
4104 "OrgDiaryTimestamp"
4106 info)))))))
4109 ;;;; Underline
4112 "Transcode UNDERLINE from Org to ODT.
4113 CONTENTS is the text with underline markup. INFO is a plist
4114 holding contextual information."
4119 ;;;; Verbatim
4122 "Transcode a VERBATIM object from Org to ODT.
4123 CONTENTS is nil. INFO is a plist used as a communication
4124 channel."
4130 ;;;; Verse Block
4133 "Transcode a VERSE-BLOCK element from Org to ODT.
4134 CONTENTS is verse block contents. INFO is a plist holding
4135 contextual information."
4136 ;; Add line breaks to each line of verse.
4140 ;; Replace tabs and spaces.
4142 ;; Surround it in a verse environment.
4147 \f
4148 ;;; Filters
4151 "Collect cite keys (in reverse order) in to INFO.
4153 Modify INFO plist by appending a `:citations-alist' property.
4154 The value of this property is a list where each element is of the
4155 form (CITE-KEY . CITATION), with CITATION
4156 being the first element that references CITE-KEY. The list is
4157 sorted in reverse order of appearance of CITE-KEYs in the
4158 exported file."
4168 cite-keys))))
4169 info)
4170 ;; Modify INFO by side-effects.
4172 tree)
4174 ;;;; LaTeX fragments
4179 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
4180 ;; If the desired converter is not available, force verbatim
4181 ;; processing.
4199 ;; Store normalized value for later use.
4204 ;; Convert `latex-fragment's and `latex-environment's.
4224 ;; Get an Org-style link to PNG image or the MathML
4225 ;; file.
4230 nil display-msg
4231 nil processing-type)
4237 ;; Conversion succeeded. Parse above Org-style link to a
4238 ;; `link' object.
4244 ;; Orphan the link.
4249 ;; Case 1: LaTeX environment.
4250 ;; Mimic a "standalone image or formula" by
4251 ;; enclosing the `link' in a `paragraph'.
4252 ;; Copy over original attributes, captions to
4253 ;; the enclosing paragraph.
4259 latex-*)
4261 latex-*)))
4262 link))
4263 ;; Case 2: LaTeX fragment.
4264 ;; No special action.
4266 ;; Restore the blanks after the initial element or object.
4268 replacement :post-blank
4270 ;; Note down the object that link replaces.
4274 ;; Replace now.
4276 info)))
4277 tree)
4280 ;;;; Description lists
4282 ;; This translator is necessary to handle indented tables in a uniform
4283 ;; manner. See comment in `org-odt--table'.
4285 ;; Depending on user option `org-odt-description-list-style',
4286 ;; description lists can be typeset either as in HTML documents or as
4287 ;; in LaTeX documents.
4290 ;; OpenDocument has no notion of a description list. So simulate it
4291 ;; using plain lists. Description lists in the exported document
4292 ;; are typeset in the same manner as they are in a typical HTML
4293 ;; document. See `org-odt--translate-description-lists/latex' for
4294 ;; yet another way of translation.
4295 ;;
4296 ;; Specifically, a description list like this:
4297 ;;
4298 ;; ,----
4299 ;; | - term-1 :: definition-1
4300 ;; |
4301 ;; | paragraph-1
4302 ;; |
4303 ;; | - term-2 :: definition-2
4304 ;; |
4305 ;; | paragraph-2
4306 ;; `----
4307 ;;
4308 ;; gets translated in to the following form:
4309 ;;
4310 ;; ,----
4311 ;; | - term-1
4312 ;; |
4313 ;; | - definition-1
4314 ;; |
4315 ;; | paragraph-1
4316 ;; |
4317 ;; | - term-2
4318 ;; |
4319 ;; | - definition-2
4320 ;; |
4321 ;; | paragraph-2
4322 ;; `----
4323 ;;
4324 ;; Further effect is achieved by fixing the OD styles as below:
4325 ;;
4326 ;; 1. Set the :type property of the simulated lists to
4327 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
4328 ;; that has *no* bullets whatsoever.
4329 ;;
4330 ;; 2. The paragraph containing the definition term is styled to be
4331 ;; in bold.
4332 ;;
4337 el
4354 nil)
4355 info)
4356 tree)
4359 ;; OpenDocument has no notion of a description list. So simulate it
4360 ;; using plain lists. Description lists in the exported document
4361 ;; are typeset in the same manner as they are in a typical LaTeX
4362 ;; style document. See `org-odt--translate-description-lists/html'
4363 ;; for yet another way of translation.
4364 ;;
4365 ;; Specifically, a description list like this:
4366 ;;
4367 ;; ,----
4368 ;; | - term-1 :: definition-1
4369 ;; |
4370 ;; | paragraph-1
4371 ;; |
4372 ;; | - term-2 :: definition-2
4373 ;; |
4374 ;; | paragraph-2
4375 ;; `----
4376 ;;
4377 ;; gets translated in to the following form:
4378 ;;
4379 ;; ,----
4380 ;; | - *term-1* definition-1
4381 ;; |
4382 ;; | - paragraph-1
4383 ;; |
4384 ;; | - *term-2* definition-2
4385 ;; |
4386 ;; | - paragraph-2
4387 ;; `----
4388 ;;
4389 ;; Further effect is achieved by fixing the OD styles as below:
4390 ;;
4391 ;; 1. Set the :type property of the simulated lists to
4392 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
4393 ;; that has *no* bullets whatsoever.
4394 ;;
4395 ;; 2. The paragraph containing the definition term is styled to be
4396 ;; use hanging indent.
4397 ;;
4402 el
4421 item-contents)))))
4423 nil)
4424 info)
4425 tree)
4427 ;;;; List tables
4429 ;; Lists that are marked with attribute `:list-table' are called as
4430 ;; list tables. They will be rendered as a table within the exported
4431 ;; document.
4433 ;; Consider an example. The following list table
4434 ;;
4435 ;; #+ATTR_ODT: :rel-width 80
4436 ;; #+ATTR_ODT: :list-table t
4437 ;; - Row 1
4438 ;; - 1.1
4439 ;; - 1.2
4440 ;; - 1.3
4441 ;; - -----
4442 ;; - Row 2
4443 ;; - 2.1
4444 ;; - 2.2
4445 ;; - 2.3
4446 ;;
4447 ;; will be exported as though it were an Org table like the one show
4448 ;; below.
4449 ;;
4450 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
4451 ;; |-------+-----+-----+-----|
4452 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
4453 ;;
4454 ;; List tables can contain hrule (see example above). They can also
4455 ;; contain table specific attributes.
4456 ;;
4457 ;; Note that org-tables are NOT multi-line and each line is mapped to
4458 ;; a unique row in the exported document. So if an exported table
4459 ;; needs to contain a single paragraph (with copious text) it needs to
4460 ;; be typed up in a single line. Editing such long lines using the
4461 ;; table editor will be a cumbersome task. Furthermore inclusion of
4462 ;; multi-paragraph text in a table cell is well-nigh impossible.
4463 ;;
4464 ;; A LIST-TABLE circumvents above problems.
4465 ;;
4466 ;; Note that in the example above the list items could be paragraphs
4467 ;; themselves and the list can be arbitrarily deep.
4468 ;;
4469 ;; Inspired by following thread:
4470 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
4472 ;; Translate lists to tables
4478 ;; Replace list with table.
4480 l1-list
4481 ;; Build replacement table.
4488 l1-item-leading-text l2-list)
4489 ;; Remove Level-2 list from the Level-item. It
4490 ;; will be subsequently attached as table-cells.
4501 ;; Check for hrule.
4510 ;; Level-1 items start a table row.
4513 ;; No hrule.
4515 ;; Level-1 items start a table row.
4518 ;; Leading text of level-1 item define
4519 ;; the first table-cell.
4522 l1-item-leading-text)
4523 ;; Level-2 items define subsequent
4524 ;; table-cells of the row.
4532 nil)
4533 info)
4534 tree)
4537 \f
4538 ;;; Interactive functions
4551 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4560 org-odt-manifest-file-entries)
4566 ;; XML files created by the exporter.
4569 ;; Encode all the above XML files using utf-8.
4572 ;; Initialize temporary workarea. All files that end up in
4573 ;; the exported document get parked/created here.
4580 ;; Kill all XML buffers.
4588 org-odt-xml-files)
4589 ;; Delete temporary directory and also other embedded
4590 ;; files that get copied there.
4595 ;; Not at all OSes ship with zip by default
4597 ;; Do export. This creates a bunch of xml files ready to be
4598 ;; saved and zipped.
4600 ;; Create a manifest entry for content.xml.
4602 ;; Write mimetype file
4611 ;; Write out the manifest entries before zipping
4613 ;; Save all XML files.
4619 ;; Prettify output if needed.
4623 org-odt-xml-files)
4624 ;; Run zip.
4629 ;; If a file with same name as the desired output file
4630 ;; exists, remove it.
4633 ;; Zip up the xml files.
4636 ;; Switch temporarily to content.xml. This way Zip
4637 ;; process will inherit `org-odt-zip-dir' as the current
4638 ;; directory.
4652 err-string)))))
4653 cmds)))
4654 ;; Move the zip file from temporary work directory to
4655 ;; user-mandated location.
4658 ;; Cleanup work directory and work files.
4660 ;; Open the OpenDocument file in archive-mode for
4661 ;; examination.
4663 ;; Return exported file.
4665 ;; Case 1: Conversion desired on exported file. Run the
4666 ;; converter on the OpenDocument file. Return the
4667 ;; converted file.
4670 target))
4671 ;; Case 2: No further conversion. Return exported
4672 ;; OpenDocument file.
4675 ;; Cleanup work directory and work files.
4681 ;;;; Export to OpenDocument formula
4683 ;;;###autoload
4685 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4686 Use `org-create-math-formula' to convert LATEX-FRAG first to
4687 MathML. When invoked as an interactive command, use
4688 `org-latex-regexps' to infer LATEX-FRAG from currently active
4689 region. If no LaTeX fragments are found, prompt for it. Push
4690 MathML source to kill ring depending on the value of
4691 `org-export-copy-to-kill-ring'."
4717 filename
4728 ;; Add MathML to kill ring, if needed.
4732 ;;;###autoload
4734 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4735 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4736 formula file."
4741 ;;;; Export to OpenDocument Text
4743 ;;;###autoload
4745 "Export current buffer to a ODT file.
4747 If narrowing is active in the current buffer, only export its
4748 narrowed part.
4750 If a region is active, export that region.
4752 A non-nil optional argument ASYNC means the process should happen
4753 asynchronously. The resulting file should be accessible through
4754 the `org-export-stack' interface.
4756 When optional argument SUBTREEP is non-nil, export the sub-tree
4757 at point, extracting information from the headline properties
4758 first.
4760 When optional argument VISIBLE-ONLY is non-nil, don't export
4761 contents of hidden elements.
4763 EXT-PLIST, when provided, is a property list with external
4764 parameters overriding Org default settings, but still inferior to
4765 file-local settings.
4767 Return output file's name."
4774 ,outfile
4779 ;; Let `htmlfontify' know that we are interested in
4780 ;; collecting styles.
4782 ;; Initialize content.xml and kick-off the export
4783 ;; process.
4796 outfile
4801 ;; Let `htmlfontify' know that we are interested in collecting
4802 ;; styles.
4804 ;; Initialize content.xml and kick-off the export process.
4814 ;;;; Convert between OpenDocument and other formats
4817 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4826 "Workhorse routine for `org-odt-convert'."
4835 in-fmt out-fmt)))
4863 out-file)
4866 nil))))
4869 "Return verbose info about formats to which IN-FMT can be converted.
4870 Return a list where each element is of the
4871 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4872 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4873 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4877 org-odt-convert-processes t))))
4881 org-odt-convert-processes t))
4882 org-odt-convert-capabilities))
4883 reachable-formats)
4888 reachable-formats))
4891 "Return list of formats to which IN-FMT can be converted.
4892 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4898 l))
4901 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4902 This is a helper routine for interactive use."
4905 nil buffer-file-name t))
4911 out-fmt-choices nil nil nil))
4913 "No known converter or no known output formats for %s files"
4914 in-fmt))))
4917 ;;;###autoload
4919 "Convert IN-FILE to format OUT-FMT using a command line converter.
4920 IN-FILE is the file to be converted. If unspecified, it defaults
4921 to variable `buffer-file-name'. OUT-FMT is the desired output
4922 format. Use `org-odt-convert-process' as the converter.
4923 If PREFIX-ARG is non-nil then the newly converted file is opened
4924 using `org-open-file'."
4929 ;;; Library Initializations
4933 ;; Let Emacs open all OpenDocument files in archive mode
4936 org-odt-file-extensions)
4940 ;;; ox-odt.el ends here