| blob | a19bab29c16928a653697b4b6ab483b0de2f50e9 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2017 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 <https://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
34 ;;; Define Back-End
87 org-odt--translate-description-lists
88 org-odt--translate-list-tables
89 org-odt--translate-image-links)))
90 :menu-entry
97 :options-alist
102 ;; Other variables.
115 ;; Redefine regular option.
117 ;; Retrieve LaTeX header for fragments.
121 ;;; Dependencies
123 ;;; Hooks
125 ;;; Function and Dynamically Scoped Variables Declarations
141 \f
142 ;;; Internal Variables
146 "Location of ODT exporter.
147 Use this to infer values of `org-odt-styles-dir' and
152 "Data directory for ODT exporter.
153 Use this to infer values of `org-odt-styles-dir' and
170 "List of directories to search for OpenDocument schema files.
171 Use this list to set the default value of
172 `org-odt-schema-dir'. The entries in this list are
173 populated heuristically based on the values of `org-odt-lib-dir'
186 )
187 "List of directories to search for OpenDocument styles files.
188 See `org-odt-styles-dir'. The entries in this list are populated
189 heuristically based on the values of `org-odt-lib-dir' and
200 org-odt-styles-dir-list)))
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 `org-odt-content-template-file'.
211 The default value of this variable varies depending on the
212 version of Org in use and is initialized from
213 `org-odt-styles-dir-list'. Note that the user could be using Org
214 from one of: Org own private git repository, GNU ELPA tar or
237 "
239 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
240 </style:style>
241 "
245 "Registry of automatic styles for various OBJECT-TYPEs.
246 The variable has the following form:
247 ((OBJECT-TYPE-A
248 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
249 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
250 (OBJECT-TYPE-B
251 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
252 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
253 ...).
256 OBJECT-PROPS is (typically) a plist created by passing
262 "Running counters for various OBJECT-TYPEs.
263 Use this to generate automatic names and style-names. See
267 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
268 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
269 <style:background-image/>
270 </style:paragraph-properties>
272 </style:style>"
273 "Custom paragraph style for colorized source and example blocks.
275 except that the foreground and background colors are set
289 "Hardcoded image dimensions one for each of the anchor
292 ;; A4 page size is 21.0 by 29.7 cms
293 ;; The default page settings has 2cm margin on each of the sides. So
294 ;; the effective text area is 17.0 by 25.7 cm
303 "Specify how labels are applied and referenced.
305 This is an alist where each element is of the form:
307 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
309 ATTACH-FMT controls how labels and captions are attached to an
310 entity. It may contain following specifiers - %e and %c. %e is
311 replaced with the CATEGORY-NAME. %n is replaced with
313 with CAPTION.
315 REF-MODE and REF-FMT controls how label references are generated.
316 The following XML is generated for a label reference -
319 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
320 %n is replaced with SEQNO.
330 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
332 This is a list where each entry is of the form:
334 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
336 CATEGORY_HANDLE identifies the captionable entity in question.
338 OD-VARIABLE is the OpenDocument sequence counter associated with
339 the entity. These counters are declared within
341 `org-odt-content-template-file'.
343 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
344 how a given entity should be captioned and referenced.
346 CATEGORY-NAME is used for qualifying captions on export.
348 ENUMERATOR-PREDICATE is used for assigning a sequence number to
358 \f
359 ;;; User Configuration Variables
362 "Options for exporting Org mode files to ODT."
367 ;;;; Debugging
370 "Specify whether or not the xml output should be prettified.
371 When this option is turned on, `indent-region' is run on all
372 component xml buffers before they are saved. Turn this off for
373 regular use. Turn this on if you need to examine the xml
374 visually."
380 ;;;; Document schema
391 org-odt-schema-dir-list)
392 "Directory that contains OpenDocument schema files.
394 This directory contains:
395 1. rnc files for OpenDocument schema
397 for auto validation of OpenDocument XML files.
399 Use the customize interface to set this variable. This ensures
400 that `rng-schema-locating-files' is updated and auto-validation
401 of OpenDocument XML takes place based on the value
402 `rng-nxml-auto-validate-flag'.
404 The default value of this variable varies depending on the
405 version of org in use and is initialized from
406 `org-odt-schema-dir-list'. The OASIS schema files are available
407 only in the org's private git repository. It is *not* bundled
408 with GNU ELPA tar or standard Emacs distribution."
414 :set
416 "Set `org-odt-schema-dir'.
417 Also add it to `rng-schema-locating-files'."
427 schema-dir
430 value))
431 nil)))
436 org-odt-schema-dir))))))
439 ;;;; Document styles
443 The exporter embeds the exported content just before
447 under `org-odt-styles-dir' is used."
454 "Default styles file for use with ODT export.
455 Valid values are one of:
456 1. nil
457 2. path to a styles.xml file
458 3. path to a *.odt or a *.ott file
459 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
460 ...))
462 In case of option 1, an in-built styles.xml is used. See
463 `org-odt-styles-dir' for more information.
465 In case of option 3, the specified file is unzipped and the
466 styles.xml embedded therein is used.
468 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
469 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
470 generated odt file. Use relative path for specifying the
471 FILE-MEMBERS. styles.xml must be specified as one of the
472 FILE-MEMBERS.
474 Use options 1, 2 or 3 only if styles.xml alone suffices for
475 achieving the desired formatting. Use option 4, if the styles.xml
476 references additional files like header and footer images for
477 achieving the desired formatting.
480 a per-file basis. For example,
486 :type
498 "Outline levels considered for enumerating captioned entities."
504 ;;;; Document conversion
511 "Specify a list of document converters and their usage.
512 The converters in this list are offered as choices while
513 customizing `org-odt-convert-process'.
515 This variable is a list where each element is of the
516 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
517 of the converter. CONVERTER-CMD is the shell command for the
518 converter and can contain format specifiers. These format
519 specifiers are interpreted as below:
521 %i input file name in full
522 %I input file name as a URL
523 %f format of the output file
524 %o output file name in full
525 %O output file name as a URL
526 %d output dir in full
527 %D output dir as a URL.
528 %x extra options as set in `org-odt-convert-capabilities'."
531 :type
540 During customization, the list of converter names are populated
541 from `org-odt-convert-processes'."
551 org-odt-convert-processes))))
569 "Specify input and output formats of `org-odt-convert-process'.
570 More correctly, specify the set of input and output formats that
571 the user is actually interested in.
573 This variable is an alist where each element is of the
574 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
575 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
576 alist where each element is of the form (OUTPUT-FMT
577 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
579 The variable is interpreted as follows:
580 `org-odt-convert-process' can take any document that is in
581 INPUT-FMT-LIST and produce any document that is in the
582 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
583 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
584 serves dual purposes:
585 - It is used for populating completion candidates during
586 `org-odt-convert' commands.
588 `org-odt-convert-process'.
591 `org-odt-convert-process'.
593 DOCUMENT-CLASS is used to group a set of file formats in
594 INPUT-FMT-LIST in to a single class.
596 Note that this variable inherently captures how LibreOffice based
597 converters work. LibreOffice maps documents of various formats
598 to classes like Text, Web, Spreadsheet, Presentation etc and
599 allow document of a given class (irrespective of its source
600 format) to be converted to any of the export formats associated
601 with that class.
603 See default setting of this variable for an typical
604 configuration."
607 :type
612 :value-type
616 :value-type
625 and then uses `org-odt-convert-process' to convert the
626 resulting document to this format. During customization of this
627 variable, the list of valid values are populated based on
628 `org-odt-convert-capabilities'.
630 You can set this option on per-file basis using file local
631 values. See Info node `(emacs) File Variables'."
642 ;;;###autoload
646 ;;;; Drawers
649 "Function called to format a drawer in ODT code.
651 The function must accept two parameters:
653 CONTENTS the contents of the drawer.
655 The function should return the string to be exported.
657 The default value simply returns the value of CONTENTS."
664 ;;;; Headline
667 'org-odt-format-headline-default-function
668 "Function to format headline text.
670 This function will be called with 5 arguments:
671 TODO the todo keyword (string or nil).
672 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
673 PRIORITY the priority of the headline (integer or nil)
674 TEXT the main headline text (string).
675 TAGS the tags string, separated with colons (string or nil).
677 The function result will be used as headline text."
684 ;;;; Inlinetasks
687 'org-odt-format-inlinetask-default-function
688 "Function called to format an inlinetask in ODT code.
690 The function must accept six parameters:
691 TODO the todo keyword, as a string
692 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
693 PRIORITY the inlinetask priority, as a string
694 NAME the inlinetask name, as a string.
695 TAGS the inlinetask tags, as a string.
696 CONTENTS the contents of the inlinetask, as a string.
698 The function should return the string to be exported."
705 ;;;; LaTeX
708 "Non-nil means process LaTeX math snippets.
710 When set, the exporter will process LaTeX environments and
711 fragments.
713 This option can also be set with the +OPTIONS line,
716 nil Ignore math snippets.
717 `verbatim' Keep everything in verbatim
718 `dvipng' Process the LaTeX fragments to images. This will also
719 include processing of non-math environments.
720 `imagemagick' Convert the LaTeX fragments to pdf files and use
721 imagemagick to convert pdf files to png files.
722 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
723 be loaded.
724 t Synonym for `mathjax'."
736 ;;;; Links
740 "Rules characterizing formula files that can be inlined into ODT.
742 A rule consists in an association whose key is the type of link
743 to consider, and value is a regexp that will be matched against
744 link's path."
753 "Rules characterizing image files that can be inlined into ODT.
755 A rule consists in an association whose key is the type of link
756 to consider, and value is a regexp that will be matched against
757 link's path."
765 "Scaling factor for converting images pixels to inches.
766 Use this for sizing of embedded images. See Info node `(org)
767 Images in ODT export' for more information."
774 ;;;; Src Block
777 "Whether custom styles for colorized source blocks be automatically created.
778 When this option is turned on, the exporter creates custom styles
779 for source blocks based on the advice of `htmlfontify'. Creation
780 of custom styles happen as part of `org-odt-hfy-face-to-css'.
782 When this option is turned off exporter does not create such
783 styles.
785 Use the latter option if you do not want the custom styles to be
786 based on your current display settings. It is necessary that the
787 styles.xml already contains needed styles for colorizing to work.
789 This variable is effective only if `org-odt-fontify-srcblocks' is
790 turned on."
796 "Specify whether or not source blocks need to be fontified.
797 Turn this option on if you want to colorize the source code
798 blocks in the exported file. For colorization to work, you need
799 to make available an enhanced version of `htmlfontify' library."
805 ;;;; Table
818 "Specify how Table Styles should be derived from a Table Template.
819 This is a list where each element is of the
820 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
822 TABLE-STYLE-NAME is the style associated with the table through
825 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
826 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
827 below) that is included in `org-odt-content-template-file'.
829 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
831 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
839 TABLE-CELL-OPTIONS is an alist where each element is of the
840 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
841 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
842 `use-last-row-styles' |
843 `use-first-column-styles' |
844 `use-last-column-styles' |
845 `use-banding-rows-styles' |
846 `use-banding-columns-styles' |
847 `use-first-row-styles'
848 ON-OR-OFF := t | nil
850 For example, with the following configuration
852 \(setq org-odt-table-styles
854 ((use-first-row-styles . t)
855 (use-first-column-styles . t)))
857 ((use-first-column-styles . t)))))
860 style will use the following table-cell styles -
865 as appropriate.
868 use the following table-cell styles -
870 following paragraph styles
872 as appropriate..
874 Note that TABLE-TEMPLATE-NAME corresponds to the
877 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
880 specification for more information. Also consult the
881 implementation filed under `org-odt-get-table-cell-styles'.
884 formatting of numbered display equations. Do not delete this
885 style from the list."
895 use-last-row-styles
896 use-first-column-styles
897 use-last-column-styles
898 use-banding-rows-styles
899 use-banding-columns-styles)
900 :key-type symbol
903 ;;;; Timestamps
906 "Non-nil, if timestamps should be exported as date fields.
908 When nil, export timestamps as plain text.
910 When non-nil, map `org-time-stamp-custom-formats' to a pair of
912 respectively. A timestamp with no time component is formatted
916 This feature is experimental. Most (but not all) of the common
917 %-specifiers in `format-time-string' are supported.
919 formatted as canonical Org timestamps. For finer control, avoid
920 these %-specifiers.
923 etc., are displayed by the application in the default language
924 and country specified in `org-odt-styles-file'. Note that the
926 can localize the week day and month strings in the exported
927 document by setting the default language and country either using
928 the application UI or through a custom styles file.
930 See `org-odt--build-date-styles' for implementation details."
937 \f
938 ;;; Internal functions
940 ;;;; Date
955 ;; LibreOffice does not care about end goes as content
956 ;; within the "<text:date>...</text:date>" field. The
957 ;; displayed date is automagically corrected to match the
958 ;; format requested by "style:data-style-name" attribute. So
959 ;; don't bother about formatting the date contents to be
960 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
961 ;; simple Org-style date should suffice.
986 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
987 iso-date style date)
989 repeater)))))
991 ;;;; Frame
999 extra
1005 style frame-attrs
1017 ;;;; Library wrappers
1024 ;; This is shamelessly stolen from `archive-zip-extract'.
1030 name)))
1035 exit-code command-output)
1044 ;;;; Target
1053 ;;;; Textbox
1056 extra anchor-type)
1062 text)
1063 width nil style extra anchor-type))
1067 ;;;; Table of Contents
1070 "Return a table of contents.
1071 TITLE is the title of the table, as a string, or nil. ENTRIES is
1072 the contents of the table, as a string. DEPTH is an integer
1073 specifying the depth of the table."
1075 "
1076 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1080 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1081 "
1082 title))
1088 "
1089 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1091 <text:index-entry-chapter/>
1092 <text:index-entry-text/>
1093 <text:index-entry-link-end/>
1096 "
1097 </text:table-of-content-source>
1098 <text:index-body>"
1104 title))
1105 entries
1106 "
1107 </text:index-body>
1114 headline-label
1116 ;; Section number.
1118 ;; Todo.
1123 style todo)))
1128 style priority)))
1129 ;; Title.
1130 text
1131 ;; Tags.
1135 "OrgTags"
1143 "Build a table of contents.
1144 DEPTH is an integer specifying the depth of the table. INFO is
1145 a plist containing current export properties. Optional argument
1146 SCOPE, when non-nil, defines the scope of the table. Return the
1147 table of contents as a string, or nil."
1149 ;; When a headline is marked as a radio target, as in the example below:
1150 ;;
1151 ;; ** <<<Some Heading>>>
1152 ;; Some text.
1153 ;;
1154 ;; suppress generation of radio targets. i.e., Radio targets are to
1155 ;; be marked as targets within /document body/ and *not* within
1156 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1157 ;; and one in the document body.
1158 ;;
1159 ;; Likewise, links, footnote references and regular targets are also
1160 ;; suppressed.
1174 style entry)))
1176 depth))))
1179 ;;;; Document styles
1182 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1183 OBJECT-PROPS is (typically) a plist created by passing
1185 `org-odt-parse-block-attributes'.
1187 Use `org-odt-object-counters' to generate an automatic
1188 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1189 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1190 . STYLE-NAME)."
1206 ;;;; Checkbox
1209 "Return check-box string associated to ITEM."
1218 ;;; Template
1221 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1222 ;; to modify the date fields. A date could be modified by
1223 ;; offsetting in days. That's about it. Also, date and time may
1224 ;; have to be emitted as two fields - a date field and a time field
1225 ;; - separately.
1227 ;; One can add Form Controls to date and time fields so that they
1228 ;; can be easily modified. But then, the exported document will
1229 ;; become tightly coupled with LibreOffice and may not function
1230 ;; properly with other OpenDocument applications.
1232 ;; I have a strange feeling that Date styles are a bit flaky at the
1233 ;; moment.
1235 ;; The feature is experimental.
1279 ))
1288 filler-end))
1299 style
1302 output ))))
1305 "Return complete document string after ODT conversion.
1306 CONTENTS is the transcoded contents string. RAW-DATA is the
1307 original parsed data. INFO is a plist holding export options."
1308 ;; Write meta file.
1318 <office:document-meta
1328 ;; Date, if required.
1330 ;; Check if DATE is specified as an Org-timestamp. If yes,
1331 ;; include it as meta information. Otherwise, just use
1332 ;; today's date.
1341 iso-date)))))
1350 subtitle))
1354 ;; Add meta.xml in to manifest.
1357 ;; Update styles file.
1358 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1359 ;; Write styles file.
1363 ;; Non-availability of styles.xml is not a critical
1364 ;; error. For now, throw an error.
1368 org-odt-styles-dir)
1391 ;; create a manifest entry for styles.xml
1394 ;; FIXME: Who is opening an empty styles.xml before this point?
1399 ;; Write custom styles for source blocks
1400 ;; Save STYLES used for colorizing of source blocks.
1401 ;; Update styles.xml with styles that were collected as part of
1402 ;; `org-odt-hfy-face-to-css' callbacks.
1411 ;; Update styles.xml - take care of outline numbering
1413 ;; Don't make automatic backup of styles.xml file. This setting
1414 ;; prevents the backed-up styles.xml file from being zipped in to
1415 ;; odt file. This is more of a hackish fix. Better alternative
1416 ;; would be to fix the zip command so that the output odt file
1417 ;; includes only the needed files and excludes any auto-generated
1418 ;; extra files like backups and auto-saves etc etc. Note that
1419 ;; currently the zip command zips up the entire temp directory so
1420 ;; that any auto-generated files created under the hood ends up in
1421 ;; the resulting odt file.
1424 ;; Outline numbering is retained only upto LEVEL.
1425 ;; To disable outline numbering pass a LEVEL of 0.
1438 ;; Update content.xml.
1441 ;; within the context of the Org buffer. So obtain its
1442 ;; value before moving on to temp-buffer context down below.
1452 org-odt-styles-dir)))
1453 ;; Write automatic styles.
1454 ;; - Position the cursor.
1458 ;; - Dump automatic table styles.
1463 ;; - Dump date-styles.
1469 ;; Update display level.
1470 ;; - Remove existing sequence decls. Also position the cursor.
1475 ;; Update sequence decls according to user preference.
1486 ;; Position the cursor to document body.
1491 ;; Preamble - Title, Author, Date etc.
1501 ;; Switch on or off above vars based on user settings
1505 ;; Title.
1510 ;; Separator.
1512 ;; Subtitle.
1518 subtitle
1520 ;; Separator.
1524 ;; Author only.
1527 "OrgSubtitle"
1529 ;; Separator.
1532 ;; Author and E-mail.
1536 "OrgSubtitle"
1541 ;; Separator.
1543 ;; Date, if required.
1546 ;; Check if DATE is specified as a timestamp.
1553 "OrgSubtitle"
1557 ;; Separator
1559 ;; Table of Contents
1562 with-toc
1565 ;; Contents.
1567 ;; Return contents.
1571 \f
1572 ;;; Transcode Functions
1574 ;;;; Bold
1577 "Transcode BOLD from Org to ODT.
1578 CONTENTS is the text with bold markup. INFO is a plist holding
1579 contextual information."
1584 ;;;; Center Block
1587 "Transcode a CENTER-BLOCK element from Org to ODT.
1588 CONTENTS holds the contents of the center block. INFO is a plist
1589 holding contextual information."
1590 contents)
1593 ;;;; Clock
1596 "Transcode a CLOCK element from Org to ODT.
1597 CONTENTS is nil. INFO is a plist used as a communication
1598 channel."
1611 ;;;; Code
1614 "Transcode a CODE object from Org to ODT.
1615 CONTENTS is nil. INFO is a plist used as a communication
1616 channel."
1622 ;;;; Drawer
1625 "Transcode a DRAWER element from Org to ODT.
1626 CONTENTS holds the contents of the block. INFO is a plist
1627 holding contextual information."
1630 name contents)))
1631 output))
1634 ;;;; Dynamic Block
1637 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1638 CONTENTS holds the contents of the block. INFO is a plist
1639 holding contextual information. See `org-export-data'."
1640 contents)
1643 ;;;; Entity
1646 "Transcode an ENTITY object from Org to ODT.
1647 CONTENTS are the definition itself. INFO is a plist holding
1648 contextual information."
1652 ;;;; Example Block
1655 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1656 CONTENTS is nil. INFO is a plist holding contextual information."
1660 ;;;; Export Snippet
1663 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1664 CONTENTS is nil. INFO is a plist holding contextual information."
1669 ;;;; Export Block
1672 "Transcode a EXPORT-BLOCK element from Org to ODT.
1673 CONTENTS is nil. INFO is a plist holding contextual information."
1678 ;;;; Fixed Width
1681 "Transcode a FIXED-WIDTH element from Org to ODT.
1682 CONTENTS is nil. INFO is a plist holding contextual information."
1686 ;;;; Footnote Definition
1688 ;; Footnote Definitions are ignored.
1691 ;;;; Footnote Reference
1694 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1695 CONTENTS is nil. INFO is a plist holding contextual information."
1703 id note-class
1715 "OrgSuperscript"
1716 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1717 note-class ref-format ref-name n))))))
1719 ;; Insert separator between two footnotes in a row.
1724 ;; Transcode footnote reference.
1732 footnote-reference info))
1736 raw
1739 :transcoders
1742 p c i
1743 "Footnote"
1744 "OrgFootnoteCenter"
1746 info))))
1747 ;; Inline definitions are secondary strings. We
1748 ;; need to wrap them within a paragraph.
1751 def
1754 def)))))
1758 ;;;; Headline
1761 &optional format-function
1763 "Transcode a HEADLINE element using BACKEND.
1764 INFO is a plist holding contextual information."
1787 &key _level _section-number _headline-label
1790 todo todo-type priority text tags))))))
1792 todo todo-type priority text tags
1793 :headline-label headline-label
1794 :level level
1798 "Transcode a HEADLINE element from Org to ODT.
1799 CONTENTS holds the contents of the headline. INFO is a plist
1800 holding contextual information."
1801 ;; Case 1: This is a footnote section: ignore it.
1804 ;; Get level relative to current parsed data.
1807 ;; Get canonical label for the headline.
1809 ;; Extra targets.
1813 ;; Title.
1816 ;; Case 2. This is a deep sub-tree: export it as a list item.
1817 ;; Also export as items headlines for which no section
1818 ;; format has been found.
1820 ;; Build the real contents of the sub-tree.
1824 ;; Choose style based on list type.
1826 ;; If top-level list, re-start numbering. Otherwise,
1827 ;; continue numbering.
1830 headline)))
1840 "Text_20_body"
1842 contents)
1844 "</text:list-header>"
1848 ;; Case 3. Standard headline. Export it as a section.
1852 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1855 level
1858 contents))))))
1862 "Default format function for a headline.
1863 See `org-odt-format-headline-function' for details."
1865 ;; Todo.
1873 style priority)))
1874 ;; Title.
1875 text
1876 ;; Tags.
1879 "<text:tab/>"
1888 ;;;; Horizontal Rule
1891 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1892 CONTENTS is nil. INFO is a plist holding contextual information."
1897 ;;;; Inline Babel Call
1899 ;; Inline Babel Calls are ignored.
1902 ;;;; Inline Src Block
1905 "Return a character not used in string S.
1907 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1913 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1914 CONTENTS holds the contents of the item. INFO is a plist holding
1915 contextual information."
1919 ;;;; Inlinetask
1922 "Transcode an INLINETASK element from Org to ODT.
1923 CONTENTS holds the contents of the block. INFO is a plist
1924 holding contextual information."
1936 todo todo-type priority text tags contents)))
1940 "Default format function for a inlinetasks.
1941 See `org-odt-format-inlinetask-function' for details."
1943 "Text_20_body"
1947 "OrgInlineTaskHeading"
1949 todo todo-type priority name tags))
1950 contents)
1953 ;;;; Italic
1956 "Transcode ITALIC from Org to ODT.
1957 CONTENTS is the text with italic markup. INFO is a plist holding
1958 contextual information."
1963 ;;;; Item
1966 "Transcode an ITEM element from Org to ODT.
1967 CONTENTS holds the contents of the item. INFO is a plist holding
1968 contextual information."
1974 contents
1976 "</text:list-header>"
1979 ;;;; Keyword
1982 "Transcode a KEYWORD element from Org to ODT.
1983 CONTENTS is nil. INFO is a plist holding contextual
1984 information."
1990 ;; FIXME
2002 ;; FIXME
2006 ;;;; Latex Environment
2009 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2010 ;; (defadvice org-format-latex-as-mathml ; FIXME
2011 ;; (after org-odt-protect-latex-fragment activate)
2012 ;; "Encode LaTeX fragment as XML.
2013 ;; Do this when translation to MathML fails."
2014 ;; (unless (> (length ad-return-value) 0)
2015 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2018 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2019 CONTENTS is nil. INFO is a plist holding contextual information."
2025 ;;;; Latex Fragment
2027 ;; (when latex-frag ; FIXME
2028 ;; (setq href (propertize href :title "LaTeX Fragment"
2029 ;; :description latex-frag)))
2030 ;; handle verbatim
2031 ;; provide descriptions
2034 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2035 CONTENTS is nil. INFO is a plist holding contextual information."
2041 ;;;; Line Break
2044 "Transcode a LINE-BREAK object from Org to ODT.
2045 CONTENTS is nil. INFO is a plist holding contextual information."
2049 ;;;; Link
2051 ;;;; Links :: Label references
2061 x))))
2071 counter))
2074 element
2076 info))
2080 ;; Section number.
2084 ;; Separator.
2086 ;; Ordinal.
2088 tag))
2091 "Return a label for ELEMENT.
2093 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2094 element. INFO is a plist used as a communication channel. OP is
2095 either `definition' or `reference', depending on the purpose of
2096 the generated string.
2098 Return value is a string if OP is set to `reference' or a cons
2099 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2100 SHORT-CAPTION are strings."
2106 ;; Get label and caption.
2112 ;; FIXME: We don't use short-caption for now
2128 element))))
2131 seqno)
2136 ;; Compute sequence number of the element.
2138 ;; Localize category string.
2141 ;; Case 1: Handle Label definition.
2145 ;; Sneak in a bookmark. The bookmark is used when the
2146 ;; labeled element is referenced with a link that
2147 ;; provides its own description.
2149 ;; Label definition: Typically formatted as below:
2150 ;; CATEGORY SEQ-NO: LONG CAPTION
2151 ;; with translation for correct punctuation.
2158 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2159 label counter counter seqno))
2161 short-caption))
2162 ;; Case 2: Handle Label reference.
2167 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2168 fmt1
2169 label
2174 ;;;; Links :: Inline Images
2177 "Returns the internal name of the file"
2193 target-file))
2216 ;; Use Imagemagick.
2221 file))))
2226 ;; Use Emacs.
2232 ;; Use hard-coded values.
2234 org-odt-default-image-sizes-alist))
2235 ;; Error out.
2248 ;; ensure that an embedded image fits comfortably within a page
2259 "Return ODT code for an inline image.
2260 LINK is the link pointing to the inline image. INFO is a plist
2261 used as a communication channel."
2274 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2276 ;; Extract attributes from #+ATTR_ODT line.
2280 ;; Convert attributes to a plist.
2282 ;; Handle `:anchor', `:style' and `:attributes' properties.
2292 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2293 ;;
2294 ;; Handle `:width', `:height' and `:scale' properties. Read
2295 ;; them as numbers since we need them for computations.
2297 src-expanded info
2304 nil ; embed-as
2306 ))
2313 ;; Check if this link was created by LaTeX-to-PNG converter.
2317 ;; If yes, note down the type of the element - LaTeX Fragment
2318 ;; or LaTeX environment. It will go in to frame title.
2322 ;; If yes, note down its contents. It will go in to frame
2323 ;; description. This quite useful for debugging.
2326 captions user-frame-params title desc)))
2329 ;;;; Links :: Math formula
2348 ;; Check if this link was created by LaTeX-to-MathML
2349 ;; converter.
2353 ;; If yes, note down the type of the element - LaTeX Fragment
2354 ;; or LaTeX environment. It will go in to frame title.
2358 ;; If yes, note down its contents. It will go in to frame
2359 ;; description. This quite useful for debugging.
2361 width height)
2365 nil nil title desc))
2368 "CaptionedDisplayFormula" href width height
2369 captions nil title desc))
2373 org-odt--enumerable-formula-p))))
2378 "Returns the internal name of the file"
2382 ;; Create a directory for holding formula file. Also enter it in
2383 ;; to manifest.
2387 ;; Copy over the formula file from user directory to zip
2388 ;; directory.
2392 ;; Case 1: Mathml.
2395 ;; Case 2: OpenDocument formula.
2400 ;; Enter the formula file in to manifest.
2402 target-file))
2404 ;;;; Targets
2407 captions user-frame-params
2410 ;; Each element of this alist is of the form (CFG-HANDLE
2411 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2413 ;; CFG-HANDLE is the key to the alist.
2415 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2416 ;; frame params for INNER-FRAME and OUTER-FRAME
2417 ;; respectively. See below.
2419 ;; Configurations that are meant to be applied to
2420 ;; non-captioned image/formula specifies no
2421 ;; OUTER-FRAME-PARAMS.
2423 ;; TERMINOLOGY
2424 ;; ===========
2425 ;; INNER-FRAME :: Frame that directly surrounds an
2426 ;; image/formula.
2428 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2429 ;; frame also contains the caption, if any.
2431 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2432 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2433 ;; that these are the last three arguments
2434 ;; to `org-odt--frame'.
2436 ;; Note that an un-captioned image/formula requires just an
2437 ;; INNER-FRAME, while a captioned image/formula requires
2438 ;; both an INNER and an OUTER-FRAME.
2460 ;; Retrieve inner and outer frame params, from configuration.
2464 ;; User-specified frame params (from #+ATTR_ODT spec)
2468 "Merge default and user frame params."
2473 for d in default
2476 ;; Case 1: Image/Formula has no caption.
2477 ;; There is only one frame, one that surrounds the image
2478 ;; or formula.
2480 ;; Merge user frame params with that from configuration.
2484 ;; Case 2: Image/Formula is captioned or labeled.
2485 ;; There are two frames: The inner one surrounds the
2486 ;; image or formula. The outer one contains the
2487 ;; caption/sequence number.
2489 ;; Merge user frame params with outer frame params.
2491 ;; Short caption, if specified, goes as part of inner frame.
2498 frame-params))
2501 "Illustration"
2505 caption))
2506 width height outer)))))
2509 ;; Element should have a caption or label.
2515 element info
2516 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2517 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2518 ;; processing.)
2523 ;; Link should point to an image file.
2530 element info
2531 ;; Paragraph should have a caption or label. It SHOULD also be a
2532 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2533 ;; processing.)
2538 ;; Link should point to an image file.
2545 element info
2546 ;; Paragraph should have a caption or label.
2550 ;; Link should point to a MathML or ODF file.
2556 paragraph-predicate
2557 link-predicate)
2558 "Test if ELEMENT is a standalone link for the purpose ODT export.
2559 INFO is a plist holding contextual information.
2561 Return non-nil, if ELEMENT is of type paragraph satisfying
2562 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2563 is a link that satisfies LINK-PREDICATE.
2565 Return non-nil, if ELEMENT is of type link satisfying
2566 LINK-PREDICATE and its containing paragraph satisfies
2567 PARAGRAPH-PREDICATE in addition to having no other content save for
2568 leading and trailing whitespaces.
2570 Return nil, otherwise."
2593 ;; DESTINATION is a headline or an element (like paragraph,
2594 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2596 ;; Note that labels that are attached to captioned entities - inline
2597 ;; images, math formulae and tables - get resolved as part of
2598 ;; `org-odt-format-label' and `org-odt--enumerate'.
2600 ;; Create a cross-reference to DESTINATION but make best-efforts to
2601 ;; create a *meaningful* description. Check item numbers, section
2602 ;; number and section title in that order.
2604 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2605 ;; FIXME: Handle footnote-definition footnote-reference?
2617 return x))
2618 ;; Get list item nos.
2623 plain-list)
2626 item info t))))))
2627 ;; Locate top-most listified headline.
2632 return x))
2633 ;; Get listified headline numbers.
2639 el info t)))))))
2640 ;; Combine item numbers from both the listified headlines and
2641 ;; regular list items.
2643 ;; Case 1: Check if all the parents of list item are numbered.
2644 ;; If yes, link to the item proper.
2647 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2648 label
2652 ;; Case 2: Locate a regular and numbered headline in the
2653 ;; hierarchy. Display its section number.
2656 ;; Test if destination is a numbered headline.
2662 return el))))
2663 ;; We found one.
2665 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2666 label
2669 ;; Case 4: Locate a regular headline in the hierarchy. Display
2670 ;; its title.
2674 return el)))
2675 ;; We found one.
2677 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2678 label
2684 "Transcode a LINK object from Org to ODT.
2686 DESC is the description part of the link, or the empty string.
2687 INFO is a plist holding contextual information. See
2688 `org-export-data'."
2691 ;; Ensure DESC really exists, or set it to nil.
2700 ;; Convert & to & for correct XML representation
2703 ;; Link type is handled by a special function.
2705 ;; Image file.
2707 ;; Formula file.
2712 ;; Radio target: Transcode target's contents and use them as
2713 ;; link's description.
2718 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2720 desc))))
2721 ;; Links pointing to a headline: Find destination and build
2722 ;; appropriate referencing command.
2728 ;; Fuzzy link points to a headline. If there's
2729 ;; a description, create a hyperlink. Otherwise, try to
2730 ;; provide a meaningful description.
2739 label desc))))
2740 ;; Fuzzy link points to a target. If there's a description,
2741 ;; create a hyperlink. Otherwise, try to provide
2742 ;; a meaningful description.
2747 ;; Fuzzy link points to some element (e.g., an inline image,
2748 ;; a math formula or a table).
2756 ;; LINK has no description. Create
2757 ;; a cross-reference showing entity's sequence
2758 ;; number.
2760 ;; LINK has description. Insert a hyperlink with
2761 ;; user-provided description.
2766 desc))))))))
2767 ;; Coderef: replace link with the reference name or the
2768 ;; equivalent line number.
2775 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2776 href line-no))))
2777 ;; External link with a description part.
2780 ;; Check if description is a link to an inline image.
2785 desc-element
2787 ;; Format link as a clickable image.
2789 path desc)
2790 ;; Otherwise, format it as a regular link.
2792 path desc))))
2793 ;; External link without a description part.
2796 path path))
2797 ;; No path, only description. Try to do something useful.
2802 ;;;; Node Property
2805 "Transcode a NODE-PROPERTY element from Org to ODT.
2806 CONTENTS is nil. INFO is a plist holding contextual
2807 information."
2814 ;;;; Paragraph
2817 "Return style of PARAGRAPH.
2818 Style is a symbol among `quoted', `centered' and nil."
2828 "Format paragraph according to given styles.
2829 PARAGRAPH is a paragraph type element. CONTENTS is the
2830 transcoded contents of that paragraph, as a string. INFO is
2831 a plist used as a communication channel. DEFAULT, CENTER and
2832 QUOTE are, respectively, style to use when paragraph belongs to
2833 no special environment, a center block, or a quote block."
2839 ;; If PARAGRAPH is a leading paragraph in an item that has
2840 ;; a checkbox, splice checkbox and paragraph contents
2841 ;; together.
2846 contents)))
2849 "Transcode a PARAGRAPH element from Org to ODT.
2850 CONTENTS is the contents of the paragraph, as a string. INFO is
2851 the plist used as a communication channel."
2853 paragraph contents info
2855 "OrgCenter"
2859 ;;;; Plain List
2862 "Transcode a PLAIN-LIST element from Org to ODT.
2863 CONTENTS is the contents of the list. INFO is a plist holding
2864 contextual information."
2866 ;; Choose style based on list type.
2872 ;; If top-level list, re-start numbering. Otherwise,
2873 ;; continue numbering.
2878 contents))
2880 ;;;; Plain Text
2888 line))
2897 "Transcode a TEXT string from Org to ODT.
2898 TEXT is the string to transcode. INFO is a plist holding
2899 contextual information."
2901 ;; Protect &, < and >.
2903 ;; Handle smart quotes. Be sure to provide original string since
2904 ;; OUTPUT may have been modified.
2907 ;; Convert special strings.
2912 ;; Handle break preservation if required.
2916 ;; Return value.
2917 output))
2920 ;;;; Planning
2923 "Transcode a PLANNING element from Org to ODT.
2924 CONTENTS is nil. INFO is a plist used as a communication
2925 channel."
2927 "OrgPlanning"
2949 ;;;; Property Drawer
2952 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2953 CONTENTS holds the contents of the drawer. INFO is a plist
2954 holding contextual information."
2957 contents)))
2960 ;;;; Quote Block
2963 "Transcode a QUOTE-BLOCK element from Org to ODT.
2964 CONTENTS holds the contents of the block. INFO is a plist
2965 holding contextual information."
2966 contents)
2969 ;;;; Section
2974 style
2976 text)))
2980 "Transcode a SECTION element from Org to ODT.
2981 CONTENTS holds the contents of the section. INFO is a plist
2982 holding contextual information."
2983 contents)
2985 ;;;; Radio Target
2988 "Transcode a RADIO-TARGET object from Org to ODT.
2989 TEXT is the text of the target. INFO is a plist holding
2990 contextual information."
2994 ;;;; Special Block
2997 "Transcode a SPECIAL-BLOCK element from Org to ODT.
2998 CONTENTS holds the contents of the block. INFO is a plist
2999 holding contextual information."
3003 ;; Annotation.
3009 ;; FIXME: Is `car' right thing to do below?
3019 contents)))))
3020 ;; Textbox.
3029 style extra anchor))))
3033 ;;;; Src Block
3036 "Create custom style for face FN.
3037 When FN is the default face, use its foreground and background
3039 use its color attribute to create a character style whose name
3040 is obtained from FN. Currently all attributes of FN other than
3041 color are ignored.
3043 The style name for a face FN is derived using the following
3044 operations on the face name in that order - de-dash, CamelCase
3046 `font-lock-function-name-face' is associated with
3060 background-color-val color-val))
3063 "
3110 code
3122 par-style loc))
3125 num-start refs))
3139 ;; Extract code and references.
3143 ;; Does the src block contain labels?
3145 ;; Does it have line numbers?
3150 "Transcode a SRC-BLOCK element from Org to ODT.
3151 CONTENTS holds the contents of the item. INFO is a plist holding
3152 contextual information."
3162 "Text_20_body"
3166 ;;;; Statistics Cookie
3169 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3170 CONTENTS is nil. INFO is a plist holding contextual information."
3176 ;;;; Strike-Through
3179 "Transcode STRIKE-THROUGH from Org to ODT.
3180 CONTENTS is the text with strike-through markup. INFO is a plist
3181 holding contextual information."
3186 ;;;; Subscript
3189 "Transcode a SUBSCRIPT object from Org to ODT.
3190 CONTENTS is the contents of the object. INFO is a plist holding
3191 contextual information."
3196 ;;;; Superscript
3199 "Transcode a SUPERSCRIPT object from Org to ODT.
3200 CONTENTS is the contents of the object. INFO is a plist holding
3201 contextual information."
3206 ;;;; Table Cell
3215 "Retrieve styles applicable to a table cell.
3216 R and C are (zero-based) row and column numbers of the table
3217 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3218 applicable to the current table. It is nil if the table is not
3219 associated with any style attributes.
3221 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3223 When STYLE-SPEC is nil, style the table cell the conventional way
3224 - choose cell borders based on row and column groupings and
3225 choose paragraph alignment based on `org-col-cookies' text
3226 property. See also
3227 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3229 When STYLE-SPEC is non-nil, ignore the above cookie and return
3230 styles congruent with the ODF-1.2 specification."
3236 info)))
3238 ;; LibreOffice - particularly the Writer - honors neither table
3239 ;; templates nor custom table-cell styles. Inorder to retain
3240 ;; inter-operability with LibreOffice, only automatic styles are
3241 ;; used for styling of table-cells. The current implementation is
3242 ;; congruent with ODF-1.2 specification and hence is
3243 ;; future-compatible.
3245 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3246 ;; which recognizes as many as 16 different cell types - is much
3247 ;; richer. Unfortunately it is NOT amenable to easy configuration
3248 ;; by hand.
3275 "Transcode a TABLE-CELL element from Org to ODT.
3276 CONTENTS is nil. INFO is a plist used as a communication
3277 channel."
3284 table-cell info))
3307 table-cell info))))))
3311 custom-style-prefix))
3313 "OrgTblCell"
3329 cell-attributes
3332 contents
3334 paragraph-style contents))))
3341 ;;;; Table Row
3344 "Transcode a TABLE-ROW element from Org to ODT.
3345 CONTENTS is the contents of the row. INFO is a plist used as a
3346 communication channel."
3347 ;; Rules are ignored since table separators are deduced from
3348 ;; borders of the current row.
3354 ;; If the row belongs to the first rowgroup and the
3355 ;; table has more than one row groups, then this row
3356 ;; belongs to the header row group.
3358 ;; Otherwise, it belongs to non-header row group.
3361 ;; Does this row begin a rowgroup?
3364 ;; Actual table row
3366 ;; Does this row end a rowgroup?
3371 ;;;; Table
3384 "Transcode a TABLE element from Org to ODT.
3385 CONTENTS is the contents of the table. INFO is a plist holding
3386 contextual information."
3388 ;; Case 1: table.el doesn't support export to OD format. Strip
3389 ;; such tables from export.
3394 "(ox-odt): Found table.el-type table in the source Org file."
3395 " table.el doesn't support export to ODT format."
3397 ;; Case 2: Native Org tables.
3413 column-style))
3414 out)
3418 ;; caption.
3422 ;; begin table.
3430 ;; column specification.
3432 ;; actual contents.
3434 ;; end table.
3438 "Transcode a TABLE element from Org to ODT.
3439 CONTENTS is the contents of the table. INFO is a plist holding
3440 contextual information.
3442 Use `org-odt--table' to typeset the table. Handle details
3443 pertaining to indentation here."
3456 collect el)))
3460 for el in genealogy
3463 collect
3468 parent-list)
3470 ;; Handle list genealogy.
3472 for el in list-genealogy collect
3491 parent-list info)
3494 ;; Handle low-level headlines.
3496 with step = 'item collect
3504 el info)
3505 "OrgNumberedList"
3516 parent-list info)))
3524 table info)))
3525 ;; OpenDocument schema does not permit table to occur within a
3526 ;; list item.
3528 ;; One solution - the easiest and lightweight, in terms of
3529 ;; implementation - is to put the table in an indented text box
3530 ;; and make the text box part of the list-item. Unfortunately if
3531 ;; the table is big and spans multiple pages, the text box could
3532 ;; overflow. In this case, the following attribute will come
3533 ;; handy.
3535 ;; ,---- From OpenDocument-v1.1.pdf
3536 ;; | 15.27.28 Overflow behavior
3537 ;; |
3538 ;; | For text boxes contained within text document, the
3539 ;; | style:overflow-behavior property specifies the behavior of text
3540 ;; | boxes where the containing text does not fit into the text
3541 ;; | box.
3542 ;; |
3543 ;; | If the attribute's value is clip, the text that does not fit
3544 ;; | into the text box is not displayed.
3545 ;; |
3546 ;; | If the attribute value is auto-create-new-frame, a new frame
3547 ;; | will be created on the next page, with the same position and
3548 ;; | dimensions of the original frame.
3549 ;; |
3550 ;; | If the style:overflow-behavior property's value is
3551 ;; | auto-create-new-frame and the text box has a minimum width or
3552 ;; | height specified, then the text box will grow until the page
3553 ;; | bounds are reached before a new frame is created.
3554 ;; `----
3556 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3557 ;; auto-create-new-frame property and always resorts to clipping
3558 ;; the text box. This results in table being truncated.
3560 ;; So we solve the problem the hard (and fun) way using list
3561 ;; continuations.
3563 ;; The problem only becomes more interesting if you take in to
3564 ;; account the following facts:
3565 ;;
3566 ;; - Description lists are simulated as plain lists.
3567 ;; - Low-level headlines can be listified.
3568 ;; - In Org mode, a table can occur not only as a regular list
3569 ;; item, but also within description lists and low-level
3570 ;; headlines.
3572 ;; See `org-odt-translate-description-lists' and
3573 ;; `org-odt-translate-low-level-headlines' for how this is
3574 ;; tackled.
3577 ;; Discontinue the list.
3579 ;; Put the table in an indented section.
3584 ;; Continue the list.
3588 ;;;; Target
3591 "Transcode a TARGET object from Org to ODT.
3592 CONTENTS is nil. INFO is a plist holding contextual
3593 information."
3597 ;;;; Timestamp
3600 "Transcode a TIMESTAMP object from Org to ODT.
3601 CONTENTS is nil. INFO is a plist used as a communication
3602 channel."
3618 "OrgActiveTimestamp"
3622 "OrgInactiveTimestamp"
3626 "OrgActiveTimestamp"
3632 "OrgInactiveTimestamp"
3638 "OrgDiaryTimestamp"
3640 info)))))))
3643 ;;;; Underline
3646 "Transcode UNDERLINE from Org to ODT.
3647 CONTENTS is the text with underline markup. INFO is a plist
3648 holding contextual information."
3653 ;;;; Verbatim
3656 "Transcode a VERBATIM object from Org to ODT.
3657 CONTENTS is nil. INFO is a plist used as a communication
3658 channel."
3664 ;;;; Verse Block
3667 "Transcode a VERSE-BLOCK element from Org to ODT.
3668 CONTENTS is verse block contents. INFO is a plist holding
3669 contextual information."
3672 ;; Replace leading tabs and spaces.
3674 ;; Add line breaks to each line of verse.
3679 \f
3680 ;;; Filters
3682 ;;; Images
3687 ;;;; LaTeX fragments
3692 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3693 ;; If the desired converter is not available, force verbatim
3694 ;; processing.
3712 ;; Store normalized value for later use.
3717 ;; Convert `latex-fragment's and `latex-environment's.
3736 ;; Get an Org-style link to PNG image or the MathML
3737 ;; file.
3741 ;; When converting to a PNG image, make sure to
3742 ;; copy all LaTeX header specifications from the
3743 ;; Org source.
3751 nil display-msg nil
3752 processing-type)
3758 ;; Conversion succeeded. Parse above Org-style link to
3759 ;; a `link' object.
3762 ;;LaTeX environment. Mimic a "standalone image
3763 ;; or formula" by enclosing the `link' in
3764 ;; a `paragraph'. Copy over original
3765 ;; attributes, captions to the enclosing
3766 ;; paragraph.
3771 :name
3773 :caption
3775 link))
3776 ;; LaTeX fragment. No special action.
3778 ;; Note down the object that link replaces.
3782 ;; Restore blank after initial element or object.
3784 replacement :post-blank
3786 ;; Replace now.
3788 info nil nil t)))
3789 tree)
3792 ;;;; Description lists
3794 ;; This translator is necessary to handle indented tables in a uniform
3795 ;; manner. See comment in `org-odt--table'.
3798 ;; OpenDocument has no notion of a description list. So simulate it
3799 ;; using plain lists. Description lists in the exported document
3800 ;; are typeset in the same manner as they are in a typical HTML
3801 ;; document.
3802 ;;
3803 ;; Specifically, a description list like this:
3804 ;;
3805 ;; ,----
3806 ;; | - term-1 :: definition-1
3807 ;; | - term-2 :: definition-2
3808 ;; `----
3809 ;;
3810 ;; gets translated in to the following form:
3811 ;;
3812 ;; ,----
3813 ;; | - term-1
3814 ;; | - definition-1
3815 ;; | - term-2
3816 ;; | - definition-2
3817 ;; `----
3818 ;;
3819 ;; Further effect is achieved by fixing the OD styles as below:
3820 ;;
3821 ;; 1. Set the :type property of the simulated lists to
3822 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3823 ;; that has *no* bullets whatsoever.
3824 ;;
3825 ;; 2. The paragraph containing the definition term is styled to be
3826 ;; in bold.
3827 ;;
3832 el
3848 nil)
3849 info)
3850 tree)
3852 ;;;; List tables
3854 ;; Lists that are marked with attribute `:list-table' are called as
3855 ;; list tables. They will be rendered as a table within the exported
3856 ;; document.
3858 ;; Consider an example. The following list table
3859 ;;
3860 ;; #+attr_odt :list-table t
3861 ;; - Row 1
3862 ;; - 1.1
3863 ;; - 1.2
3864 ;; - 1.3
3865 ;; - Row 2
3866 ;; - 2.1
3867 ;; - 2.2
3868 ;; - 2.3
3869 ;;
3870 ;; will be exported as though it were an Org table like the one show
3871 ;; below.
3872 ;;
3873 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3874 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3875 ;;
3876 ;; Note that org-tables are NOT multi-line and each line is mapped to
3877 ;; a unique row in the exported document. So if an exported table
3878 ;; needs to contain a single paragraph (with copious text) it needs to
3879 ;; be typed up in a single line. Editing such long lines using the
3880 ;; table editor will be a cumbersome task. Furthermore inclusion of
3881 ;; multi-paragraph text in a table cell is well-nigh impossible.
3882 ;;
3883 ;; A LIST-TABLE circumvents above problems.
3884 ;;
3885 ;; Note that in the example above the list items could be paragraphs
3886 ;; themselves and the list can be arbitrarily deep.
3887 ;;
3888 ;; Inspired by following thread:
3889 ;; https://lists.gnu.org/r/emacs-orgmode/2011-03/msg01101.html
3891 ;; Translate lists to tables
3897 ;; Replace list with table.
3899 l1-list
3900 ;; Build replacement table.
3906 l1-item-leading-text l2-list)
3907 ;; Remove Level-2 list from the Level-item. It
3908 ;; will be subsequently attached as table-cells.
3918 ;; Level-1 items start a table row.
3921 ;; Leading text of level-1 item define
3922 ;; the first table-cell.
3925 l1-item-leading-text)
3926 ;; Level-2 items define subsequent
3927 ;; table-cells of the row.
3935 nil)
3936 info)
3937 tree)
3939 \f
3940 ;;; Interactive functions
3953 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3968 ;; Initialize temporary workarea. All files that end up in
3969 ;; the exported document get parked/created here.
3975 ;; Kill all XML buffers.
3983 ;; Delete temporary directory and also other embedded
3984 ;; files that get copied there.
3989 ;; Not at all OSes ship with zip by default
3991 ;; Do export. This creates a bunch of xml files ready to be
3992 ;; saved and zipped.
3994 ;; Create a manifest entry for content.xml.
3996 ;; Write mimetype file
4005 ;; Write out the manifest entries before zipping
4007 ;; Save all XML files.
4013 ;; Prettify output if needed.
4017 ;; Run zip.
4022 ;; If a file with same name as the desired output file
4023 ;; exists, remove it.
4026 ;; Zip up the xml files.
4029 ;; Switch temporarily to content.xml. This way Zip
4030 ;; process will inherit `org-odt-zip-dir' as the current
4031 ;; directory.
4044 err-string)))))
4045 ;; Move the zip file from temporary work directory to
4046 ;; user-mandated location.
4049 ;; Cleanup work directory and work files.
4051 ;; Open the OpenDocument file in archive-mode for
4052 ;; examination.
4054 ;; Return exported file.
4056 ;; Case 1: Conversion desired on exported file. Run the
4057 ;; converter on the OpenDocument file. Return the
4058 ;; converted file.
4061 target))
4062 ;; Case 2: No further conversion. Return exported
4063 ;; OpenDocument file.
4066 ;; Cleanup work directory and work files.
4072 ;;;; Export to OpenDocument formula
4074 ;;;###autoload
4076 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4077 Use `org-create-math-formula' to convert LATEX-FRAG first to
4078 MathML. When invoked as an interactive command, use
4079 `org-latex-regexps' to infer LATEX-FRAG from currently active
4080 region. If no LaTeX fragments are found, prompt for it. Push
4081 MathML source to kill ring depending on the value of
4082 `org-export-copy-to-kill-ring'."
4108 filename
4121 ;; Add MathML to kill ring, if needed.
4125 ;;;###autoload
4127 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4128 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4129 formula file."
4134 ;;;; Export to OpenDocument Text
4136 ;;;###autoload
4138 "Export current buffer to a ODT file.
4140 If narrowing is active in the current buffer, only export its
4141 narrowed part.
4143 If a region is active, export that region.
4145 A non-nil optional argument ASYNC means the process should happen
4146 asynchronously. The resulting file should be accessible through
4147 the `org-export-stack' interface.
4149 When optional argument SUBTREEP is non-nil, export the sub-tree
4150 at point, extracting information from the headline properties
4151 first.
4153 When optional argument VISIBLE-ONLY is non-nil, don't export
4154 contents of hidden elements.
4156 EXT-PLIST, when provided, is a property list with external
4157 parameters overriding Org default settings, but still inferior to
4158 file-local settings.
4160 Return output file's name."
4167 ,outfile
4172 ;; Let `htmlfontify' know that we are interested in
4173 ;; collecting styles.
4175 ;; Initialize content.xml and kick-off the export
4176 ;; process.
4189 outfile
4194 ;; Let `htmlfontify' know that we are interested in collecting
4195 ;; styles.
4197 ;; Initialize content.xml and kick-off the export process.
4207 ;;;; Convert between OpenDocument and other formats
4210 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4219 "Workhorse routine for `org-odt-convert'."
4228 in-fmt out-fmt)))
4256 out-file)
4259 nil))))
4262 "Return verbose info about formats to which IN-FMT can be converted.
4263 Return a list where each element is of the
4264 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4265 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4266 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4270 org-odt-convert-processes t))))
4274 org-odt-convert-processes t))
4275 org-odt-convert-capabilities))
4276 reachable-formats)
4281 reachable-formats))
4284 "Return list of formats to which IN-FMT can be converted.
4285 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4292 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4293 This is a helper routine for interactive use."
4296 nil buffer-file-name t))
4302 out-fmt-choices nil nil nil))
4304 "No known converter or no known output formats for %s files"
4305 in-fmt))))
4308 ;;;###autoload
4310 "Convert IN-FILE to format OUT-FMT using a command line converter.
4311 IN-FILE is the file to be converted. If unspecified, it defaults
4312 to variable `buffer-file-name'. OUT-FMT is the desired output
4313 format. Use `org-odt-convert-process' as the converter. If OPEN
4314 is non-nil then the newly converted file is opened using
4315 `org-open-file'."
4320 ;;; Library Initializations
4323 ;; Let Emacs open all OpenDocument files in archive mode.
4329 ;; Local variables:
4330 ;; generated-autoload-file: "org-loaddefs.el"
4331 ;; End:
4333 ;;; ox-odt.el ends here