| blob | edc883bd8021bcc81f756f583e0de7b6c53b9d17 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2016 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:
34 ;;; Define Back-End
87 org-odt--translate-description-lists
88 org-odt--translate-list-tables)))
89 :menu-entry
96 :options-alist
101 ;; Other variables.
114 ;; Redefine regular option.
118 ;;; Dependencies
120 ;;; Hooks
122 ;;; Function and Dynamically Scoped Variables Declarations
138 \f
139 ;;; Internal Variables
143 "Location of ODT exporter.
144 Use this to infer values of `org-odt-styles-dir' and
149 "Data directory for ODT exporter.
150 Use this to infer values of `org-odt-styles-dir' and
167 "List of directories to search for OpenDocument schema files.
168 Use this list to set the default value of
169 `org-odt-schema-dir'. The entries in this list are
170 populated heuristically based on the values of `org-odt-lib-dir'
183 )
184 "List of directories to search for OpenDocument styles files.
185 See `org-odt-styles-dir'. The entries in this list are populated
186 heuristically based on the values of `org-odt-lib-dir' and
197 org-odt-styles-dir-list)))
200 styles-dir)
201 "Directory that holds auxiliary XML files used by the ODT exporter.
203 This directory contains the following XML files -
205 XML files are used as the default values of
206 `org-odt-styles-file' and `org-odt-content-template-file'.
208 The default value of this variable varies depending on the
209 version of Org in use and is initialized from
210 `org-odt-styles-dir-list'. Note that the user could be using Org
211 from one of: Org own private git repository, GNU ELPA tar or
234 "
236 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
237 </style:style>
238 "
242 "Registry of automatic styles for various OBJECT-TYPEs.
243 The variable has the following form:
244 ((OBJECT-TYPE-A
245 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
246 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
247 (OBJECT-TYPE-B
248 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
249 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
250 ...).
253 OBJECT-PROPS is (typically) a plist created by passing
259 "Running counters for various OBJECT-TYPEs.
260 Use this to generate automatic names and style-names. See
264 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
265 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
266 <style:background-image/>
267 </style:paragraph-properties>
269 </style:style>"
270 "Custom paragraph style for colorized source and example blocks.
272 except that the foreground and background colors are set
286 "Hardcoded image dimensions one for each of the anchor
289 ;; A4 page size is 21.0 by 29.7 cms
290 ;; The default page settings has 2cm margin on each of the sides. So
291 ;; the effective text area is 17.0 by 25.7 cm
300 "Specify how labels are applied and referenced.
302 This is an alist where each element is of the form:
304 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
306 ATTACH-FMT controls how labels and captions are attached to an
307 entity. It may contain following specifiers - %e and %c. %e is
308 replaced with the CATEGORY-NAME. %n is replaced with
310 with CAPTION.
312 REF-MODE and REF-FMT controls how label references are generated.
313 The following XML is generated for a label reference -
316 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
317 %n is replaced with SEQNO.
327 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
329 This is a list where each entry is of the form:
331 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
333 CATEGORY_HANDLE identifies the captionable entity in question.
335 OD-VARIABLE is the OpenDocument sequence counter associated with
336 the entity. These counters are declared within
338 `org-odt-content-template-file'.
340 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
341 how a given entity should be captioned and referenced.
343 CATEGORY-NAME is used for qualifying captions on export.
345 ENUMERATOR-PREDICATE is used for assigning a sequence number to
355 \f
356 ;;; User Configuration Variables
359 "Options for exporting Org mode files to ODT."
364 ;;;; Debugging
367 "Specify whether or not the xml output should be prettified.
368 When this option is turned on, `indent-region' is run on all
369 component xml buffers before they are saved. Turn this off for
370 regular use. Turn this on if you need to examine the xml
371 visually."
377 ;;;; Document schema
388 org-odt-schema-dir-list)
389 "Directory that contains OpenDocument schema files.
391 This directory contains:
392 1. rnc files for OpenDocument schema
394 for auto validation of OpenDocument XML files.
396 Use the customize interface to set this variable. This ensures
397 that `rng-schema-locating-files' is updated and auto-validation
398 of OpenDocument XML takes place based on the value
399 `rng-nxml-auto-validate-flag'.
401 The default value of this variable varies depending on the
402 version of org in use and is initialized from
403 `org-odt-schema-dir-list'. The OASIS schema files are available
404 only in the org's private git repository. It is *not* bundled
405 with GNU ELPA tar or standard Emacs distribution."
411 :set
413 "Set `org-odt-schema-dir'.
414 Also add it to `rng-schema-locating-files'."
424 schema-dir
427 value))
428 nil)))
433 org-odt-schema-dir))))))
436 ;;;; Document styles
440 The exporter embeds the exported content just before
444 under `org-odt-styles-dir' is used."
451 "Default styles file for use with ODT export.
452 Valid values are one of:
453 1. nil
454 2. path to a styles.xml file
455 3. path to a *.odt or a *.ott file
456 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
457 ...))
459 In case of option 1, an in-built styles.xml is used. See
460 `org-odt-styles-dir' for more information.
462 In case of option 3, the specified file is unzipped and the
463 styles.xml embedded therein is used.
465 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
466 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
467 generated odt file. Use relative path for specifying the
468 FILE-MEMBERS. styles.xml must be specified as one of the
469 FILE-MEMBERS.
471 Use options 1, 2 or 3 only if styles.xml alone suffices for
472 achieving the desired formatting. Use option 4, if the styles.xml
473 references additional files like header and footer images for
474 achieving the desired formatting.
477 a per-file basis. For example,
483 :type
495 "Outline levels considered for enumerating captioned entities."
501 ;;;; Document conversion
508 "Specify a list of document converters and their usage.
509 The converters in this list are offered as choices while
510 customizing `org-odt-convert-process'.
512 This variable is a list where each element is of the
513 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
514 of the converter. CONVERTER-CMD is the shell command for the
515 converter and can contain format specifiers. These format
516 specifiers are interpreted as below:
518 %i input file name in full
519 %I input file name as a URL
520 %f format of the output file
521 %o output file name in full
522 %O output file name as a URL
523 %d output dir in full
524 %D output dir as a URL.
525 %x extra options as set in `org-odt-convert-capabilities'."
528 :type
537 During customization, the list of converter names are populated
538 from `org-odt-convert-processes'."
548 org-odt-convert-processes))))
566 "Specify input and output formats of `org-odt-convert-process'.
567 More correctly, specify the set of input and output formats that
568 the user is actually interested in.
570 This variable is an alist where each element is of the
571 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
572 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
573 alist where each element is of the form (OUTPUT-FMT
574 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
576 The variable is interpreted as follows:
577 `org-odt-convert-process' can take any document that is in
578 INPUT-FMT-LIST and produce any document that is in the
579 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
580 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
581 serves dual purposes:
582 - It is used for populating completion candidates during
583 `org-odt-convert' commands.
585 `org-odt-convert-process'.
588 `org-odt-convert-process'.
590 DOCUMENT-CLASS is used to group a set of file formats in
591 INPUT-FMT-LIST in to a single class.
593 Note that this variable inherently captures how LibreOffice based
594 converters work. LibreOffice maps documents of various formats
595 to classes like Text, Web, Spreadsheet, Presentation etc and
596 allow document of a given class (irrespective of its source
597 format) to be converted to any of the export formats associated
598 with that class.
600 See default setting of this variable for an typical
601 configuration."
604 :type
609 :value-type
613 :value-type
622 and then uses `org-odt-convert-process' to convert the
623 resulting document to this format. During customization of this
624 variable, the list of valid values are populated based on
625 `org-odt-convert-capabilities'.
627 You can set this option on per-file basis using file local
628 values. See Info node `(emacs) File Variables'."
639 ;;;###autoload
643 ;;;; Drawers
646 "Function called to format a drawer in ODT code.
648 The function must accept two parameters:
650 CONTENTS the contents of the drawer.
652 The function should return the string to be exported.
654 The default value simply returns the value of CONTENTS."
661 ;;;; Headline
664 'org-odt-format-headline-default-function
665 "Function to format headline text.
667 This function will be called with 5 arguments:
668 TODO the todo keyword (string or nil).
669 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
670 PRIORITY the priority of the headline (integer or nil)
671 TEXT the main headline text (string).
672 TAGS the tags string, separated with colons (string or nil).
674 The function result will be used as headline text."
681 ;;;; Inlinetasks
684 'org-odt-format-inlinetask-default-function
685 "Function called to format an inlinetask in ODT code.
687 The function must accept six parameters:
688 TODO the todo keyword, as a string
689 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
690 PRIORITY the inlinetask priority, as a string
691 NAME the inlinetask name, as a string.
692 TAGS the inlinetask tags, as a string.
693 CONTENTS the contents of the inlinetask, as a string.
695 The function should return the string to be exported."
702 ;;;; LaTeX
705 "Non-nil means process LaTeX math snippets.
707 When set, the exporter will process LaTeX environments and
708 fragments.
710 This option can also be set with the +OPTIONS line,
713 nil Ignore math snippets.
714 `verbatim' Keep everything in verbatim
715 `dvipng' Process the LaTeX fragments to images. This will also
716 include processing of non-math environments.
717 `imagemagick' Convert the LaTeX fragments to pdf files and use
718 imagemagick to convert pdf files to png files.
719 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
720 be loaded.
721 t Synonym for `mathjax'."
733 ;;;; Links
737 "Rules characterizing formula files that can be inlined into ODT.
739 A rule consists in an association whose key is the type of link
740 to consider, and value is a regexp that will be matched against
741 link's path."
750 "Rules characterizing image files that can be inlined into ODT.
752 A rule consists in an association whose key is the type of link
753 to consider, and value is a regexp that will be matched against
754 link's path."
762 "Scaling factor for converting images pixels to inches.
763 Use this for sizing of embedded images. See Info node `(org)
764 Images in ODT export' for more information."
771 ;;;; Src Block
774 "Whether custom styles for colorized source blocks be automatically created.
775 When this option is turned on, the exporter creates custom styles
776 for source blocks based on the advice of `htmlfontify'. Creation
777 of custom styles happen as part of `org-odt-hfy-face-to-css'.
779 When this option is turned off exporter does not create such
780 styles.
782 Use the latter option if you do not want the custom styles to be
783 based on your current display settings. It is necessary that the
784 styles.xml already contains needed styles for colorizing to work.
786 This variable is effective only if `org-odt-fontify-srcblocks' is
787 turned on."
793 "Specify whether or not source blocks need to be fontified.
794 Turn this option on if you want to colorize the source code
795 blocks in the exported file. For colorization to work, you need
796 to make available an enhanced version of `htmlfontify' library."
802 ;;;; Table
815 "Specify how Table Styles should be derived from a Table Template.
816 This is a list where each element is of the
817 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
819 TABLE-STYLE-NAME is the style associated with the table through
822 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
823 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
824 below) that is included in `org-odt-content-template-file'.
826 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
828 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
836 TABLE-CELL-OPTIONS is an alist where each element is of the
837 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
838 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
839 `use-last-row-styles' |
840 `use-first-column-styles' |
841 `use-last-column-styles' |
842 `use-banding-rows-styles' |
843 `use-banding-columns-styles' |
844 `use-first-row-styles'
845 ON-OR-OFF := t | nil
847 For example, with the following configuration
849 \(setq org-odt-table-styles
851 ((use-first-row-styles . t)
852 (use-first-column-styles . t)))
854 ((use-first-column-styles . t)))))
857 style will use the following table-cell styles -
862 as appropriate.
865 use the following table-cell styles -
867 following paragraph styles
869 as appropriate..
871 Note that TABLE-TEMPLATE-NAME corresponds to the
874 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
877 specification for more information. Also consult the
878 implementation filed under `org-odt-get-table-cell-styles'.
881 formatting of numbered display equations. Do not delete this
882 style from the list."
892 use-last-row-styles
893 use-first-column-styles
894 use-last-column-styles
895 use-banding-rows-styles
896 use-banding-columns-styles)
897 :key-type symbol
900 ;;;; Timestamps
903 "Non-nil, if timestamps should be exported as date fields.
905 When nil, export timestamps as plain text.
907 When non-nil, map `org-time-stamp-custom-formats' to a pair of
909 respectively. A timestamp with no time component is formatted
913 This feature is experimental. Most (but not all) of the common
914 %-specifiers in `format-time-string' are supported.
916 formatted as canonical Org timestamps. For finer control, avoid
917 these %-specifiers.
920 etc., are displayed by the application in the default language
921 and country specified in `org-odt-styles-file'. Note that the
923 can localize the week day and month strings in the exported
924 document by setting the default language and country either using
925 the application UI or through a custom styles file.
927 See `org-odt--build-date-styles' for implementation details."
934 \f
935 ;;; Internal functions
937 ;;;; Date
952 ;; LibreOffice does not care about end goes as content
953 ;; within the "<text:date>...</text:date>" field. The
954 ;; displayed date is automagically corrected to match the
955 ;; format requested by "style:data-style-name" attribute. So
956 ;; don't bother about formatting the date contents to be
957 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
958 ;; simple Org-style date should suffice.
983 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
984 iso-date style date)
986 repeater)))))
988 ;;;; Frame
996 extra
1002 style frame-attrs
1014 ;;;; Library wrappers
1021 ;; This is shamelessly stolen from `archive-zip-extract'.
1027 name)))
1032 exit-code command-output)
1041 ;;;; Target
1050 ;;;; Textbox
1053 extra anchor-type)
1059 text)
1060 width nil style extra anchor-type))
1064 ;;;; Table of Contents
1067 "Return a table of contents.
1068 TITLE is the title of the table, as a string, or nil. ENTRIES is
1069 the contents of the table, as a string. DEPTH is an integer
1070 specifying the depth of the table."
1072 "
1073 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1077 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1078 "
1079 title))
1085 "
1086 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1088 <text:index-entry-chapter/>
1089 <text:index-entry-text/>
1090 <text:index-entry-link-end/>
1093 "
1094 </text:table-of-content-source>
1095 <text:index-body>"
1101 title))
1102 entries
1103 "
1104 </text:index-body>
1111 headline-label
1113 ;; Section number.
1115 ;; Todo.
1120 style todo)))
1125 style priority)))
1126 ;; Title.
1127 text
1128 ;; Tags.
1132 "OrgTags"
1140 "Build a table of contents.
1141 DEPTH is an integer specifying the depth of the table. INFO is
1142 a plist containing current export properties. Optional argument
1143 SCOPE, when non-nil, defines the scope of the table. Return the
1144 table of contents as a string, or nil."
1146 ;; When a headline is marked as a radio target, as in the example below:
1147 ;;
1148 ;; ** <<<Some Heading>>>
1149 ;; Some text.
1150 ;;
1151 ;; suppress generation of radio targets. i.e., Radio targets are to
1152 ;; be marked as targets within /document body/ and *not* within
1153 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1154 ;; and one in the document body.
1155 ;;
1156 ;; Likewise, links, footnote references and regular targets are also
1157 ;; suppressed.
1175 style entry)))
1177 depth))))
1180 ;;;; Document styles
1183 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1184 OBJECT-PROPS is (typically) a plist created by passing
1186 `org-odt-parse-block-attributes'.
1188 Use `org-odt-object-counters' to generate an automatic
1189 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1190 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1191 . STYLE-NAME)."
1207 ;;;; Checkbox
1210 "Return check-box string associated to ITEM."
1219 ;;; Template
1222 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1223 ;; to modify the date fields. A date could be modified by
1224 ;; offsetting in days. That's about it. Also, date and time may
1225 ;; have to be emitted as two fields - a date field and a time field
1226 ;; - separately.
1228 ;; One can add Form Controls to date and time fields so that they
1229 ;; can be easily modified. But then, the exported document will
1230 ;; become tightly coupled with LibreOffice and may not function
1231 ;; properly with other OpenDocument applications.
1233 ;; I have a strange feeling that Date styles are a bit flaky at the
1234 ;; moment.
1236 ;; The feature is experimental.
1280 ))
1289 filler-end))
1300 style
1303 output ))))
1306 "Return complete document string after ODT conversion.
1307 CONTENTS is the transcoded contents string. RAW-DATA is the
1308 original parsed data. INFO is a plist holding export options."
1309 ;; Write meta file.
1319 <office:document-meta
1329 ;; Date, if required.
1331 ;; Check if DATE is specified as an Org-timestamp. If yes,
1332 ;; include it as meta information. Otherwise, just use
1333 ;; today's date.
1342 iso-date)))))
1351 subtitle))
1355 ;; Add meta.xml in to manifest.
1358 ;; Update styles file.
1359 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1360 ;; Write styles file.
1364 ;; Non-availability of styles.xml is not a critical
1365 ;; error. For now, throw an error.
1369 org-odt-styles-dir)
1392 ;; create a manifest entry for styles.xml
1395 ;; FIXME: Who is opening an empty styles.xml before this point?
1400 ;; Write custom styles for source blocks
1401 ;; Save STYLES used for colorizing of source blocks.
1402 ;; Update styles.xml with styles that were collected as part of
1403 ;; `org-odt-hfy-face-to-css' callbacks.
1412 ;; Update styles.xml - take care of outline numbering
1414 ;; Don't make automatic backup of styles.xml file. This setting
1415 ;; prevents the backed-up styles.xml file from being zipped in to
1416 ;; odt file. This is more of a hackish fix. Better alternative
1417 ;; would be to fix the zip command so that the output odt file
1418 ;; includes only the needed files and excludes any auto-generated
1419 ;; extra files like backups and auto-saves etc etc. Note that
1420 ;; currently the zip command zips up the entire temp directory so
1421 ;; that any auto-generated files created under the hood ends up in
1422 ;; the resulting odt file.
1425 ;; Outline numbering is retained only upto LEVEL.
1426 ;; To disable outline numbering pass a LEVEL of 0.
1439 ;; Update content.xml.
1442 ;; within the context of the Org buffer. So obtain its
1443 ;; value before moving on to temp-buffer context down below.
1453 org-odt-styles-dir)))
1454 ;; Write automatic styles.
1455 ;; - Position the cursor.
1459 ;; - Dump automatic table styles.
1464 ;; - Dump date-styles.
1470 ;; Update display level.
1471 ;; - Remove existing sequence decls. Also position the cursor.
1476 ;; Update sequence decls according to user preference.
1487 ;; Position the cursor to document body.
1492 ;; Preamble - Title, Author, Date etc.
1502 ;; Switch on or off above vars based on user settings
1506 ;; Title.
1511 ;; Separator.
1513 ;; Subtitle.
1519 subtitle
1521 ;; Separator.
1525 ;; Author only.
1528 "OrgSubtitle"
1530 ;; Separator.
1533 ;; Author and E-mail.
1537 "OrgSubtitle"
1542 ;; Separator.
1544 ;; Date, if required.
1547 ;; Check if DATE is specified as a timestamp.
1554 "OrgSubtitle"
1558 ;; Separator
1560 ;; Table of Contents
1563 with-toc
1566 ;; Contents.
1568 ;; Return contents.
1572 \f
1573 ;;; Transcode Functions
1575 ;;;; Bold
1578 "Transcode BOLD from Org to ODT.
1579 CONTENTS is the text with bold markup. INFO is a plist holding
1580 contextual information."
1585 ;;;; Center Block
1588 "Transcode a CENTER-BLOCK element from Org to ODT.
1589 CONTENTS holds the contents of the center block. INFO is a plist
1590 holding contextual information."
1591 contents)
1594 ;;;; Clock
1597 "Transcode a CLOCK element from Org to ODT.
1598 CONTENTS is nil. INFO is a plist used as a communication
1599 channel."
1612 ;;;; Code
1615 "Transcode a CODE object from Org to ODT.
1616 CONTENTS is nil. INFO is a plist used as a communication
1617 channel."
1623 ;;;; Drawer
1626 "Transcode a DRAWER element from Org to ODT.
1627 CONTENTS holds the contents of the block. INFO is a plist
1628 holding contextual information."
1631 name contents)))
1632 output))
1635 ;;;; Dynamic Block
1638 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1639 CONTENTS holds the contents of the block. INFO is a plist
1640 holding contextual information. See `org-export-data'."
1641 contents)
1644 ;;;; Entity
1647 "Transcode an ENTITY object from Org to ODT.
1648 CONTENTS are the definition itself. INFO is a plist holding
1649 contextual information."
1653 ;;;; Example Block
1656 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1657 CONTENTS is nil. INFO is a plist holding contextual information."
1661 ;;;; Export Snippet
1664 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1665 CONTENTS is nil. INFO is a plist holding contextual information."
1670 ;;;; Export Block
1673 "Transcode a EXPORT-BLOCK element from Org to ODT.
1674 CONTENTS is nil. INFO is a plist holding contextual information."
1679 ;;;; Fixed Width
1682 "Transcode a FIXED-WIDTH element from Org to ODT.
1683 CONTENTS is nil. INFO is a plist holding contextual information."
1687 ;;;; Footnote Definition
1689 ;; Footnote Definitions are ignored.
1692 ;;;; Footnote Reference
1695 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1696 CONTENTS is nil. INFO is a plist holding contextual information."
1704 id note-class
1716 "OrgSuperscript"
1717 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1718 note-class ref-format ref-name n))))))
1720 ;; Insert separator between two footnotes in a row.
1725 ;; Transcode footnote reference.
1733 footnote-reference info))
1737 raw
1740 :transcoders
1743 p c i
1744 "Footnote"
1745 "OrgFootnoteCenter"
1747 info))))
1748 ;; Inline definitions are secondary strings. We
1749 ;; need to wrap them within a paragraph.
1751 org-element-all-elements)
1752 def
1755 def)))))
1759 ;;;; Headline
1762 &optional format-function
1764 "Transcode a HEADLINE element using BACKEND.
1765 INFO is a plist holding contextual information."
1788 &key _level _section-number _headline-label
1791 todo todo-type priority text tags))))))
1793 todo todo-type priority text tags
1794 :headline-label headline-label
1795 :level level
1799 "Transcode a HEADLINE element from Org to ODT.
1800 CONTENTS holds the contents of the headline. INFO is a plist
1801 holding contextual information."
1802 ;; Case 1: This is a footnote section: ignore it.
1805 ;; Get level relative to current parsed data.
1808 ;; Get canonical label for the headline.
1810 ;; Extra targets.
1814 ;; Title.
1817 ;; Case 2. This is a deep sub-tree: export it as a list item.
1818 ;; Also export as items headlines for which no section
1819 ;; format has been found.
1821 ;; Build the real contents of the sub-tree.
1825 ;; Choose style based on list type.
1827 ;; If top-level list, re-start numbering. Otherwise,
1828 ;; continue numbering.
1831 headline)))
1841 "Text_20_body"
1843 contents)
1845 "</text:list-header>"
1849 ;; Case 3. Standard headline. Export it as a section.
1853 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1856 level
1859 contents))))))
1863 "Default format function for a headline.
1864 See `org-odt-format-headline-function' for details."
1866 ;; Todo.
1874 style priority)))
1875 ;; Title.
1876 text
1877 ;; Tags.
1880 "<text:tab/>"
1889 ;;;; Horizontal Rule
1892 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1893 CONTENTS is nil. INFO is a plist holding contextual information."
1898 ;;;; Inline Babel Call
1900 ;; Inline Babel Calls are ignored.
1903 ;;;; Inline Src Block
1906 "Return a character not used in string S.
1908 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1914 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1915 CONTENTS holds the contents of the item. INFO is a plist holding
1916 contextual information."
1920 ;;;; Inlinetask
1923 "Transcode an INLINETASK element from Org to ODT.
1924 CONTENTS holds the contents of the block. INFO is a plist
1925 holding contextual information."
1937 todo todo-type priority text tags contents)))
1941 "Default format function for a inlinetasks.
1942 See `org-odt-format-inlinetask-function' for details."
1944 "Text_20_body"
1948 "OrgInlineTaskHeading"
1950 todo todo-type priority name tags))
1951 contents)
1954 ;;;; Italic
1957 "Transcode ITALIC from Org to ODT.
1958 CONTENTS is the text with italic markup. INFO is a plist holding
1959 contextual information."
1964 ;;;; Item
1967 "Transcode an ITEM element from Org to ODT.
1968 CONTENTS holds the contents of the item. INFO is a plist holding
1969 contextual information."
1975 contents
1977 "</text:list-header>"
1980 ;;;; Keyword
1983 "Transcode a KEYWORD element from Org to ODT.
1984 CONTENTS is nil. INFO is a plist holding contextual
1985 information."
1991 ;; FIXME
2003 ;; FIXME
2007 ;;;; Latex Environment
2010 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2011 ;; (defadvice org-format-latex-as-mathml ; FIXME
2012 ;; (after org-odt-protect-latex-fragment activate)
2013 ;; "Encode LaTeX fragment as XML.
2014 ;; Do this when translation to MathML fails."
2015 ;; (unless (> (length ad-return-value) 0)
2016 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2019 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2020 CONTENTS is nil. INFO is a plist holding contextual information."
2026 ;;;; Latex Fragment
2028 ;; (when latex-frag ; FIXME
2029 ;; (setq href (propertize href :title "LaTeX Fragment"
2030 ;; :description latex-frag)))
2031 ;; handle verbatim
2032 ;; provide descriptions
2035 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2036 CONTENTS is nil. INFO is a plist holding contextual information."
2042 ;;;; Line Break
2045 "Transcode a LINE-BREAK object from Org to ODT.
2046 CONTENTS is nil. INFO is a plist holding contextual information."
2050 ;;;; Link
2052 ;;;; Links :: Label references
2062 x))))
2072 counter))
2075 element
2077 info))
2081 ;; Section number.
2085 ;; Separator.
2087 ;; Ordinal.
2089 tag))
2092 "Return a label for ELEMENT.
2094 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2095 element. INFO is a plist used as a communication channel. OP is
2096 either `definition' or `reference', depending on the purpose of
2097 the generated string.
2099 Return value is a string if OP is set to `reference' or a cons
2100 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2101 SHORT-CAPTION are strings."
2107 ;; Get label and caption.
2113 ;; FIXME: We don't use short-caption for now
2129 element))))
2132 seqno)
2137 ;; Compute sequence number of the element.
2139 ;; Localize category string.
2142 ;; Case 1: Handle Label definition.
2146 ;; Sneak in a bookmark. The bookmark is used when the
2147 ;; labeled element is referenced with a link that
2148 ;; provides its own description.
2150 ;; Label definition: Typically formatted as below:
2151 ;; CATEGORY SEQ-NO: LONG CAPTION
2152 ;; with translation for correct punctuation.
2159 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2160 label counter counter seqno))
2162 short-caption))
2163 ;; Case 2: Handle Label reference.
2168 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2169 fmt1
2170 label
2175 ;;;; Links :: Inline Images
2178 "Returns the internal name of the file"
2194 target-file))
2217 ;; Use Imagemagick.
2222 file))))
2227 ;; Use Emacs.
2233 ;; Use hard-coded values.
2235 org-odt-default-image-sizes-alist))
2236 ;; Error out.
2249 ;; ensure that an embedded image fits comfortably within a page
2260 "Return ODT code for an inline image.
2261 LINK is the link pointing to the inline image. INFO is a plist
2262 used as a communication channel."
2275 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2277 ;; Extract attributes from #+ATTR_ODT line.
2281 ;; Convert attributes to a plist.
2283 ;; Handle `:anchor', `:style' and `:attributes' properties.
2293 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2294 ;;
2295 ;; Handle `:width', `:height' and `:scale' properties. Read
2296 ;; them as numbers since we need them for computations.
2298 src-expanded info
2305 nil ; embed-as
2307 ))
2314 ;; Check if this link was created by LaTeX-to-PNG converter.
2318 ;; If yes, note down the type of the element - LaTeX Fragment
2319 ;; or LaTeX environment. It will go in to frame title.
2323 ;; If yes, note down its contents. It will go in to frame
2324 ;; description. This quite useful for debugging.
2327 captions user-frame-params title desc)))
2330 ;;;; Links :: Math formula
2349 ;; Check if this link was created by LaTeX-to-MathML
2350 ;; converter.
2354 ;; If yes, note down the type of the element - LaTeX Fragment
2355 ;; or LaTeX environment. It will go in to frame title.
2359 ;; If yes, note down its contents. It will go in to frame
2360 ;; description. This quite useful for debugging.
2362 width height)
2366 nil nil title desc))
2369 "CaptionedDisplayFormula" href width height
2370 captions nil title desc))
2374 org-odt--enumerable-formula-p))))
2379 "Returns the internal name of the file"
2383 ;; Create a directory for holding formula file. Also enter it in
2384 ;; to manifest.
2388 ;; Copy over the formula file from user directory to zip
2389 ;; directory.
2393 ;; Case 1: Mathml.
2396 ;; Case 2: OpenDocument formula.
2401 ;; Enter the formula file in to manifest.
2403 target-file))
2405 ;;;; Targets
2408 captions user-frame-params
2411 ;; Each element of this alist is of the form (CFG-HANDLE
2412 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2414 ;; CFG-HANDLE is the key to the alist.
2416 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2417 ;; frame params for INNER-FRAME and OUTER-FRAME
2418 ;; respectively. See below.
2420 ;; Configurations that are meant to be applied to
2421 ;; non-captioned image/formula specifies no
2422 ;; OUTER-FRAME-PARAMS.
2424 ;; TERMINOLOGY
2425 ;; ===========
2426 ;; INNER-FRAME :: Frame that directly surrounds an
2427 ;; image/formula.
2429 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2430 ;; frame also contains the caption, if any.
2432 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2433 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2434 ;; that these are the last three arguments
2435 ;; to `org-odt--frame'.
2437 ;; Note that an un-captioned image/formula requires just an
2438 ;; INNER-FRAME, while a captioned image/formula requires
2439 ;; both an INNER and an OUTER-FRAME.
2461 ;; Retrieve inner and outer frame params, from configuration.
2465 ;; User-specified frame params (from #+ATTR_ODT spec)
2469 "Merge default and user frame params."
2474 for d in default
2477 ;; Case 1: Image/Formula has no caption.
2478 ;; There is only one frame, one that surrounds the image
2479 ;; or formula.
2481 ;; Merge user frame params with that from configuration.
2485 ;; Case 2: Image/Formula is captioned or labeled.
2486 ;; There are two frames: The inner one surrounds the
2487 ;; image or formula. The outer one contains the
2488 ;; caption/sequence number.
2490 ;; Merge user frame params with outer frame params.
2492 ;; Short caption, if specified, goes as part of inner frame.
2499 frame-params))
2502 "Illustration"
2506 caption))
2507 width height outer)))))
2510 ;; Element should have a caption or label.
2516 element info
2517 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2518 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2519 ;; processing.)
2524 ;; Link should point to an image file.
2531 element info
2532 ;; Paragraph should have a caption or label. It SHOULD also be a
2533 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2534 ;; processing.)
2539 ;; Link should point to an image file.
2546 element info
2547 ;; Paragraph should have a caption or label.
2551 ;; Link should point to a MathML or ODF file.
2557 paragraph-predicate
2558 link-predicate)
2559 "Test if ELEMENT is a standalone link for the purpose ODT export.
2560 INFO is a plist holding contextual information.
2562 Return non-nil, if ELEMENT is of type paragraph satisfying
2563 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2564 is a link that satisfies LINK-PREDICATE.
2566 Return non-nil, if ELEMENT is of type link satisfying
2567 LINK-PREDICATE and its containing paragraph satisfies
2568 PARAGRAPH-PREDICATE in addition to having no other content save for
2569 leading and trailing whitespaces.
2571 Return nil, otherwise."
2594 ;; DESTINATION is a headline or an element (like paragraph,
2595 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2597 ;; Note that labels that are attached to captioned entities - inline
2598 ;; images, math formulae and tables - get resolved as part of
2599 ;; `org-odt-format-label' and `org-odt--enumerate'.
2601 ;; Create a cross-reference to DESTINATION but make best-efforts to
2602 ;; create a *meaningful* description. Check item numbers, section
2603 ;; number and section title in that order.
2605 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2606 ;; FIXME: Handle footnote-definition footnote-reference?
2618 return x))
2619 ;; Get list item nos.
2624 plain-list)
2627 item info t))))))
2628 ;; Locate top-most listified headline.
2633 return x))
2634 ;; Get listified headline numbers.
2640 el info t)))))))
2641 ;; Combine item numbers from both the listified headlines and
2642 ;; regular list items.
2644 ;; Case 1: Check if all the parents of list item are numbered.
2645 ;; If yes, link to the item proper.
2648 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2649 label
2653 ;; Case 2: Locate a regular and numbered headline in the
2654 ;; hierarchy. Display its section number.
2657 ;; Test if destination is a numbered headline.
2663 return el))))
2664 ;; We found one.
2666 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2667 label
2670 ;; Case 4: Locate a regular headline in the hierarchy. Display
2671 ;; its title.
2675 return el)))
2676 ;; We found one.
2678 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2679 label
2685 "Transcode a LINK object from Org to ODT.
2687 DESC is the description part of the link, or the empty string.
2688 INFO is a plist holding contextual information. See
2689 `org-export-data'."
2692 ;; Ensure DESC really exists, or set it to nil.
2701 ;; Convert & to & for correct XML representation
2704 ;; Link type is handled by a special function.
2706 ;; Image file.
2708 ;; Formula file.
2713 ;; Radio target: Transcode target's contents and use them as
2714 ;; link's description.
2719 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2721 desc))))
2722 ;; Links pointing to a headline: Find destination and build
2723 ;; appropriate referencing command.
2729 ;; Fuzzy link points to a headline. If there's
2730 ;; a description, create a hyperlink. Otherwise, try to
2731 ;; provide a meaningful description.
2740 label desc))))
2741 ;; Fuzzy link points to a target. If there's a description,
2742 ;; create a hyperlink. Otherwise, try to provide
2743 ;; a meaningful description.
2748 ;; Fuzzy link points to some element (e.g., an inline image,
2749 ;; a math formula or a table).
2757 ;; LINK has no description. Create
2758 ;; a cross-reference showing entity's sequence
2759 ;; number.
2761 ;; LINK has description. Insert a hyperlink with
2762 ;; user-provided description.
2767 desc))))))))
2768 ;; Coderef: replace link with the reference name or the
2769 ;; equivalent line number.
2776 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2777 href line-no))))
2778 ;; External link with a description part.
2781 ;; Check if description is a link to an inline image.
2786 desc-element
2788 ;; Format link as a clickable image.
2790 path desc)
2791 ;; Otherwise, format it as a regular link.
2793 path desc))))
2794 ;; External link without a description part.
2797 path path))
2798 ;; No path, only description. Try to do something useful.
2803 ;;;; Node Property
2806 "Transcode a NODE-PROPERTY element from Org to ODT.
2807 CONTENTS is nil. INFO is a plist holding contextual
2808 information."
2815 ;;;; Paragraph
2818 "Return style of PARAGRAPH.
2819 Style is a symbol among `quoted', `centered' and nil."
2829 "Format paragraph according to given styles.
2830 PARAGRAPH is a paragraph type element. CONTENTS is the
2831 transcoded contents of that paragraph, as a string. INFO is
2832 a plist used as a communication channel. DEFAULT, CENTER and
2833 QUOTE are, respectively, style to use when paragraph belongs to
2834 no special environment, a center block, or a quote block."
2840 ;; If PARAGRAPH is a leading paragraph in an item that has
2841 ;; a checkbox, splice checkbox and paragraph contents
2842 ;; together.
2847 contents)))
2850 "Transcode a PARAGRAPH element from Org to ODT.
2851 CONTENTS is the contents of the paragraph, as a string. INFO is
2852 the plist used as a communication channel."
2854 paragraph contents info
2856 "OrgCenter"
2860 ;;;; Plain List
2863 "Transcode a PLAIN-LIST element from Org to ODT.
2864 CONTENTS is the contents of the list. INFO is a plist holding
2865 contextual information."
2867 ;; Choose style based on list type.
2873 ;; If top-level list, re-start numbering. Otherwise,
2874 ;; continue numbering.
2879 contents))
2881 ;;;; Plain Text
2894 line))
2903 "Transcode a TEXT string from Org to ODT.
2904 TEXT is the string to transcode. INFO is a plist holding
2905 contextual information."
2907 ;; Protect &, < and >.
2909 ;; Handle smart quotes. Be sure to provide original string since
2910 ;; OUTPUT may have been modified.
2913 ;; Convert special strings.
2918 ;; Handle break preservation if required.
2922 ;; Return value.
2923 output))
2926 ;;;; Planning
2929 "Transcode a PLANNING element from Org to ODT.
2930 CONTENTS is nil. INFO is a plist used as a communication
2931 channel."
2933 "OrgPlanning"
2955 ;;;; Property Drawer
2958 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2959 CONTENTS holds the contents of the drawer. INFO is a plist
2960 holding contextual information."
2963 contents)))
2966 ;;;; Quote Block
2969 "Transcode a QUOTE-BLOCK element from Org to ODT.
2970 CONTENTS holds the contents of the block. INFO is a plist
2971 holding contextual information."
2972 contents)
2975 ;;;; Section
2980 style
2982 text)))
2986 "Transcode a SECTION element from Org to ODT.
2987 CONTENTS holds the contents of the section. INFO is a plist
2988 holding contextual information."
2989 contents)
2991 ;;;; Radio Target
2994 "Transcode a RADIO-TARGET object from Org to ODT.
2995 TEXT is the text of the target. INFO is a plist holding
2996 contextual information."
3000 ;;;; Special Block
3003 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3004 CONTENTS holds the contents of the block. INFO is a plist
3005 holding contextual information."
3009 ;; Annotation.
3015 ;; FIXME: Is `car' right thing to do below?
3025 contents)))))
3026 ;; Textbox.
3035 style extra anchor))))
3039 ;;;; Src Block
3042 "Create custom style for face FN.
3043 When FN is the default face, use its foreground and background
3045 use its color attribute to create a character style whose name
3046 is obtained from FN. Currently all attributes of FN other than
3047 color are ignored.
3049 The style name for a face FN is derived using the following
3050 operations on the face name in that order - de-dash, CamelCase
3052 `font-lock-function-name-face' is associated with
3066 background-color-val color-val))
3069 "
3116 code
3128 par-style loc))
3131 num-start refs))
3145 ;; Extract code and references.
3149 ;; Does the src block contain labels?
3151 ;; Does it have line numbers?
3156 "Transcode a SRC-BLOCK element from Org to ODT.
3157 CONTENTS holds the contents of the item. INFO is a plist holding
3158 contextual information."
3168 "Text_20_body"
3172 ;;;; Statistics Cookie
3175 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3176 CONTENTS is nil. INFO is a plist holding contextual information."
3182 ;;;; Strike-Through
3185 "Transcode STRIKE-THROUGH from Org to ODT.
3186 CONTENTS is the text with strike-through markup. INFO is a plist
3187 holding contextual information."
3192 ;;;; Subscript
3195 "Transcode a SUBSCRIPT object from Org to ODT.
3196 CONTENTS is the contents of the object. INFO is a plist holding
3197 contextual information."
3202 ;;;; Superscript
3205 "Transcode a SUPERSCRIPT object from Org to ODT.
3206 CONTENTS is the contents of the object. INFO is a plist holding
3207 contextual information."
3212 ;;;; Table Cell
3221 "Retrieve styles applicable to a table cell.
3222 R and C are (zero-based) row and column numbers of the table
3223 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3224 applicable to the current table. It is nil if the table is not
3225 associated with any style attributes.
3227 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3229 When STYLE-SPEC is nil, style the table cell the conventional way
3230 - choose cell borders based on row and column groupings and
3231 choose paragraph alignment based on `org-col-cookies' text
3232 property. See also
3233 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3235 When STYLE-SPEC is non-nil, ignore the above cookie and return
3236 styles congruent with the ODF-1.2 specification."
3242 info)))
3244 ;; LibreOffice - particularly the Writer - honors neither table
3245 ;; templates nor custom table-cell styles. Inorder to retain
3246 ;; inter-operability with LibreOffice, only automatic styles are
3247 ;; used for styling of table-cells. The current implementation is
3248 ;; congruent with ODF-1.2 specification and hence is
3249 ;; future-compatible.
3251 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3252 ;; which recognizes as many as 16 different cell types - is much
3253 ;; richer. Unfortunately it is NOT amenable to easy configuration
3254 ;; by hand.
3281 "Transcode a TABLE-CELL element from Org to ODT.
3282 CONTENTS is nil. INFO is a plist used as a communication
3283 channel."
3290 table-cell info))
3313 table-cell info))))))
3317 custom-style-prefix))
3319 "OrgTblCell"
3335 cell-attributes
3338 org-element-all-elements)
3339 contents
3341 paragraph-style contents))))
3348 ;;;; Table Row
3351 "Transcode a TABLE-ROW element from Org to ODT.
3352 CONTENTS is the contents of the row. INFO is a plist used as a
3353 communication channel."
3354 ;; Rules are ignored since table separators are deduced from
3355 ;; borders of the current row.
3361 ;; If the row belongs to the first rowgroup and the
3362 ;; table has more than one row groups, then this row
3363 ;; belongs to the header row group.
3365 ;; Otherwise, it belongs to non-header row group.
3368 ;; Does this row begin a rowgroup?
3371 ;; Actual table row
3373 ;; Does this row end a rowgroup?
3378 ;;;; Table
3391 "Transcode a TABLE element from Org to ODT.
3392 CONTENTS is the contents of the table. INFO is a plist holding
3393 contextual information."
3395 ;; Case 1: table.el doesn't support export to OD format. Strip
3396 ;; such tables from export.
3401 "(ox-odt): Found table.el-type table in the source Org file."
3402 " table.el doesn't support export to ODT format."
3404 ;; Case 2: Native Org tables.
3420 column-style))
3421 out)
3425 ;; caption.
3429 ;; begin table.
3437 ;; column specification.
3439 ;; actual contents.
3441 ;; end table.
3445 "Transcode a TABLE element from Org to ODT.
3446 CONTENTS is the contents of the table. INFO is a plist holding
3447 contextual information.
3449 Use `org-odt--table' to typeset the table. Handle details
3450 pertaining to indentation here."
3463 collect el)))
3467 for el in genealogy
3470 collect
3475 parent-list)
3477 ;; Handle list genealogy.
3479 for el in list-genealogy collect
3498 parent-list info)
3501 ;; Handle low-level headlines.
3503 with step = 'item collect
3511 el info)
3512 "OrgNumberedList"
3523 parent-list info)))
3531 table info)))
3532 ;; OpenDocument schema does not permit table to occur within a
3533 ;; list item.
3535 ;; One solution - the easiest and lightweight, in terms of
3536 ;; implementation - is to put the table in an indented text box
3537 ;; and make the text box part of the list-item. Unfortunately if
3538 ;; the table is big and spans multiple pages, the text box could
3539 ;; overflow. In this case, the following attribute will come
3540 ;; handy.
3542 ;; ,---- From OpenDocument-v1.1.pdf
3543 ;; | 15.27.28 Overflow behavior
3544 ;; |
3545 ;; | For text boxes contained within text document, the
3546 ;; | style:overflow-behavior property specifies the behavior of text
3547 ;; | boxes where the containing text does not fit into the text
3548 ;; | box.
3549 ;; |
3550 ;; | If the attribute's value is clip, the text that does not fit
3551 ;; | into the text box is not displayed.
3552 ;; |
3553 ;; | If the attribute value is auto-create-new-frame, a new frame
3554 ;; | will be created on the next page, with the same position and
3555 ;; | dimensions of the original frame.
3556 ;; |
3557 ;; | If the style:overflow-behavior property's value is
3558 ;; | auto-create-new-frame and the text box has a minimum width or
3559 ;; | height specified, then the text box will grow until the page
3560 ;; | bounds are reached before a new frame is created.
3561 ;; `----
3563 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3564 ;; auto-create-new-frame property and always resorts to clipping
3565 ;; the text box. This results in table being truncated.
3567 ;; So we solve the problem the hard (and fun) way using list
3568 ;; continuations.
3570 ;; The problem only becomes more interesting if you take in to
3571 ;; account the following facts:
3572 ;;
3573 ;; - Description lists are simulated as plain lists.
3574 ;; - Low-level headlines can be listified.
3575 ;; - In Org-mode, a table can occur not only as a regular list
3576 ;; item, but also within description lists and low-level
3577 ;; headlines.
3579 ;; See `org-odt-translate-description-lists' and
3580 ;; `org-odt-translate-low-level-headlines' for how this is
3581 ;; tackled.
3584 ;; Discontinue the list.
3586 ;; Put the table in an indented section.
3591 ;; Continue the list.
3595 ;;;; Target
3598 "Transcode a TARGET object from Org to ODT.
3599 CONTENTS is nil. INFO is a plist holding contextual
3600 information."
3604 ;;;; Timestamp
3607 "Transcode a TIMESTAMP object from Org to ODT.
3608 CONTENTS is nil. INFO is a plist used as a communication
3609 channel."
3625 "OrgActiveTimestamp"
3629 "OrgInactiveTimestamp"
3633 "OrgActiveTimestamp"
3639 "OrgInactiveTimestamp"
3645 "OrgDiaryTimestamp"
3647 info)))))))
3650 ;;;; Underline
3653 "Transcode UNDERLINE from Org to ODT.
3654 CONTENTS is the text with underline markup. INFO is a plist
3655 holding contextual information."
3660 ;;;; Verbatim
3663 "Transcode a VERBATIM object from Org to ODT.
3664 CONTENTS is nil. INFO is a plist used as a communication
3665 channel."
3671 ;;;; Verse Block
3674 "Transcode a VERSE-BLOCK element from Org to ODT.
3675 CONTENTS is verse block contents. INFO is a plist holding
3676 contextual information."
3677 ;; Add line breaks to each line of verse.
3681 ;; Replace tabs and spaces.
3683 ;; Surround it in a verse environment.
3688 \f
3689 ;;; Filters
3691 ;;;; LaTeX fragments
3696 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3697 ;; If the desired converter is not available, force verbatim
3698 ;; processing.
3716 ;; Store normalized value for later use.
3721 ;; Convert `latex-fragment's and `latex-environment's.
3740 ;; Get an Org-style link to PNG image or the MathML
3741 ;; file.
3746 nil display-msg
3747 nil processing-type)
3752 nil))))
3754 ;; Conversion succeeded. Parse above Org-style link to
3755 ;; a `link' object.
3762 ;; Case 1: LaTeX environment. Mimic
3763 ;; a "standalone image or formula" by
3764 ;; enclosing the `link' in a `paragraph'.
3765 ;; Copy over original attributes, captions to
3766 ;; the enclosing paragraph.
3771 :name
3773 :caption
3775 link))
3776 ;; Case 2: 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/archive/html/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