| blob | 29a0b857307264bdc6dab691e6fb5c12f60c939c |
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:
35 ;;; Define Back-End
88 org-odt--translate-description-lists
89 org-odt--translate-list-tables)))
90 :menu-entry
97 :options-alist
102 ;; Other variables.
115 ;; Redefine regular option.
119 ;;; Dependencies
121 ;;; Hooks
123 ;;; Function and Dynamically Scoped Variables Declarations
139 \f
140 ;;; Internal Variables
144 "Location of ODT exporter.
145 Use this to infer values of `org-odt-styles-dir' and
150 "Data directory for ODT exporter.
151 Use this to infer values of `org-odt-styles-dir' and
168 "List of directories to search for OpenDocument schema files.
169 Use this list to set the default value of
170 `org-odt-schema-dir'. The entries in this list are
171 populated heuristically based on the values of `org-odt-lib-dir'
184 )
185 "List of directories to search for OpenDocument styles files.
186 See `org-odt-styles-dir'. The entries in this list are populated
187 heuristically based on the values of `org-odt-lib-dir' and
204 styles-dir)
208 styles-dir)
209 "Directory that holds auxiliary XML files used by the ODT exporter.
211 This directory contains the following XML files -
213 XML files are used as the default values of
214 `org-odt-styles-file' and `org-odt-content-template-file'.
216 The default value of this variable varies depending on the
217 version of org in use and is initialized from
218 `org-odt-styles-dir-list'. Note that the user could be using org
219 from one of: org's own private git repository, GNU ELPA tar or
242 "
244 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
245 </style:style>
246 "
250 "Registry of automatic styles for various OBJECT-TYPEs.
251 The variable has the following form:
252 ((OBJECT-TYPE-A
253 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
254 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
255 (OBJECT-TYPE-B
256 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
257 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
258 ...).
261 OBJECT-PROPS is (typically) a plist created by passing
267 "Running counters for various OBJECT-TYPEs.
268 Use this to generate automatic names and style-names. See
272 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
273 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
274 <style:background-image/>
275 </style:paragraph-properties>
277 </style:style>"
278 "Custom paragraph style for colorized source and example blocks.
280 except that the foreground and background colors are set
294 "Hardcoded image dimensions one for each of the anchor
297 ;; A4 page size is 21.0 by 29.7 cms
298 ;; The default page settings has 2cm margin on each of the sides. So
299 ;; the effective text area is 17.0 by 25.7 cm
308 "Specify how labels are applied and referenced.
310 This is an alist where each element is of the form:
312 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
314 ATTACH-FMT controls how labels and captions are attached to an
315 entity. It may contain following specifiers - %e and %c. %e is
316 replaced with the CATEGORY-NAME. %n is replaced with
318 with CAPTION.
320 REF-MODE and REF-FMT controls how label references are generated.
321 The following XML is generated for a label reference -
324 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
325 %n is replaced with SEQNO.
335 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
337 This is a list where each entry is of the form:
339 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
341 CATEGORY_HANDLE identifies the captionable entity in question.
343 OD-VARIABLE is the OpenDocument sequence counter associated with
344 the entity. These counters are declared within
346 `org-odt-content-template-file'.
348 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
349 how a given entity should be captioned and referenced.
351 CATEGORY-NAME is used for qualifying captions on export.
353 ENUMERATOR-PREDICATE is used for assigning a sequence number to
363 \f
364 ;;; User Configuration Variables
367 "Options for exporting Org mode files to ODT."
372 ;;;; Debugging
375 "Specify whether or not the xml output should be prettified.
376 When this option is turned on, `indent-region' is run on all
377 component xml buffers before they are saved. Turn this off for
378 regular use. Turn this on if you need to examine the xml
379 visually."
385 ;;;; Document schema
397 schema-dir))
400 schema-dir))
404 schema-dir)
407 nil)))
408 schema-dir)
409 "Directory that contains OpenDocument schema files.
411 This directory contains:
412 1. rnc files for OpenDocument schema
414 for auto validation of OpenDocument XML files.
416 Use the customize interface to set this variable. This ensures
417 that `rng-schema-locating-files' is updated and auto-validation
418 of OpenDocument XML takes place based on the value
419 `rng-nxml-auto-validate-flag'.
421 The default value of this variable varies depending on the
422 version of org in use and is initialized from
423 `org-odt-schema-dir-list'. The OASIS schema files are available
424 only in the org's private git repository. It is *not* bundled
425 with GNU ELPA tar or standard Emacs distribution."
431 :set
433 "Set `org-odt-schema-dir'.
434 Also add it to `rng-schema-locating-files'."
444 schema-dir
447 value))
448 nil)))
453 org-odt-schema-dir))))))
456 ;;;; Document styles
460 The exporter embeds the exported content just before
464 under `org-odt-styles-dir' is used."
471 "Default styles file for use with ODT export.
472 Valid values are one of:
473 1. nil
474 2. path to a styles.xml file
475 3. path to a *.odt or a *.ott file
476 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
477 ...))
479 In case of option 1, an in-built styles.xml is used. See
480 `org-odt-styles-dir' for more information.
482 In case of option 3, the specified file is unzipped and the
483 styles.xml embedded therein is used.
485 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
486 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
487 generated odt file. Use relative path for specifying the
488 FILE-MEMBERS. styles.xml must be specified as one of the
489 FILE-MEMBERS.
491 Use options 1, 2 or 3 only if styles.xml alone suffices for
492 achieving the desired formatting. Use option 4, if the styles.xml
493 references additional files like header and footer images for
494 achieving the desired formatting.
497 a per-file basis. For example,
503 :type
515 "Outline levels considered for enumerating captioned entities."
521 ;;;; Document conversion
528 "Specify a list of document converters and their usage.
529 The converters in this list are offered as choices while
530 customizing `org-odt-convert-process'.
532 This variable is a list where each element is of the
533 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
534 of the converter. CONVERTER-CMD is the shell command for the
535 converter and can contain format specifiers. These format
536 specifiers are interpreted as below:
538 %i input file name in full
539 %I input file name as a URL
540 %f format of the output file
541 %o output file name in full
542 %O output file name as a URL
543 %d output dir in full
544 %D output dir as a URL.
545 %x extra options as set in `org-odt-convert-capabilities'."
548 :type
557 During customization, the list of converter names are populated
558 from `org-odt-convert-processes'."
568 org-odt-convert-processes))))
586 "Specify input and output formats of `org-odt-convert-process'.
587 More correctly, specify the set of input and output formats that
588 the user is actually interested in.
590 This variable is an alist where each element is of the
591 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
592 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
593 alist where each element is of the form (OUTPUT-FMT
594 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
596 The variable is interpreted as follows:
597 `org-odt-convert-process' can take any document that is in
598 INPUT-FMT-LIST and produce any document that is in the
599 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
600 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
601 serves dual purposes:
602 - It is used for populating completion candidates during
603 `org-odt-convert' commands.
605 `org-odt-convert-process'.
608 `org-odt-convert-process'.
610 DOCUMENT-CLASS is used to group a set of file formats in
611 INPUT-FMT-LIST in to a single class.
613 Note that this variable inherently captures how LibreOffice based
614 converters work. LibreOffice maps documents of various formats
615 to classes like Text, Web, Spreadsheet, Presentation etc and
616 allow document of a given class (irrespective of its source
617 format) to be converted to any of the export formats associated
618 with that class.
620 See default setting of this variable for an typical
621 configuration."
624 :type
629 :value-type
633 :value-type
642 and then uses `org-odt-convert-process' to convert the
643 resulting document to this format. During customization of this
644 variable, the list of valid values are populated based on
645 `org-odt-convert-capabilities'.
647 You can set this option on per-file basis using file local
648 values. See Info node `(emacs) File Variables'."
659 ;;;###autoload
663 ;;;; Drawers
666 "Function called to format a drawer in ODT code.
668 The function must accept two parameters:
670 CONTENTS the contents of the drawer.
672 The function should return the string to be exported.
674 The default value simply returns the value of CONTENTS."
681 ;;;; Headline
684 'org-odt-format-headline-default-function
685 "Function to format headline text.
687 This function will be called with 5 arguments:
688 TODO the todo keyword (string or nil).
689 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
690 PRIORITY the priority of the headline (integer or nil)
691 TEXT the main headline text (string).
692 TAGS the tags string, separated with colons (string or nil).
694 The function result will be used as headline text."
701 ;;;; Inlinetasks
704 'org-odt-format-inlinetask-default-function
705 "Function called to format an inlinetask in ODT code.
707 The function must accept six parameters:
708 TODO the todo keyword, as a string
709 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
710 PRIORITY the inlinetask priority, as a string
711 NAME the inlinetask name, as a string.
712 TAGS the inlinetask tags, as a string.
713 CONTENTS the contents of the inlinetask, as a string.
715 The function should return the string to be exported."
722 ;;;; LaTeX
725 "Non-nil means process LaTeX math snippets.
727 When set, the exporter will process LaTeX environments and
728 fragments.
730 This option can also be set with the +OPTIONS line,
733 nil Ignore math snippets.
734 `verbatim' Keep everything in verbatim
735 `dvipng' Process the LaTeX fragments to images. This will also
736 include processing of non-math environments.
737 `imagemagick' Convert the LaTeX fragments to pdf files and use
738 imagemagick to convert pdf files to png files.
739 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
740 be loaded.
741 t Synonym for `mathjax'."
753 ;;;; Links
757 "Rules characterizing formula files that can be inlined into ODT.
759 A rule consists in an association whose key is the type of link
760 to consider, and value is a regexp that will be matched against
761 link's path."
770 "Rules characterizing image files that can be inlined into ODT.
772 A rule consists in an association whose key is the type of link
773 to consider, and value is a regexp that will be matched against
774 link's path."
782 "Scaling factor for converting images pixels to inches.
783 Use this for sizing of embedded images. See Info node `(org)
784 Images in ODT export' for more information."
791 ;;;; Src Block
794 "Whether custom styles for colorized source blocks be automatically created.
795 When this option is turned on, the exporter creates custom styles
796 for source blocks based on the advice of `htmlfontify'. Creation
797 of custom styles happen as part of `org-odt-hfy-face-to-css'.
799 When this option is turned off exporter does not create such
800 styles.
802 Use the latter option if you do not want the custom styles to be
803 based on your current display settings. It is necessary that the
804 styles.xml already contains needed styles for colorizing to work.
806 This variable is effective only if `org-odt-fontify-srcblocks' is
807 turned on."
813 "Specify whether or not source blocks need to be fontified.
814 Turn this option on if you want to colorize the source code
815 blocks in the exported file. For colorization to work, you need
816 to make available an enhanced version of `htmlfontify' library."
822 ;;;; Table
835 "Specify how Table Styles should be derived from a Table Template.
836 This is a list where each element is of the
837 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
839 TABLE-STYLE-NAME is the style associated with the table through
842 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
843 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
844 below) that is included in `org-odt-content-template-file'.
846 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
848 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
856 TABLE-CELL-OPTIONS is an alist where each element is of the
857 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
858 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
859 `use-last-row-styles' |
860 `use-first-column-styles' |
861 `use-last-column-styles' |
862 `use-banding-rows-styles' |
863 `use-banding-columns-styles' |
864 `use-first-row-styles'
865 ON-OR-OFF := t | nil
867 For example, with the following configuration
869 \(setq org-odt-table-styles
871 ((use-first-row-styles . t)
872 (use-first-column-styles . t)))
874 ((use-first-column-styles . t)))))
877 style will use the following table-cell styles -
882 as appropriate.
885 use the following table-cell styles -
887 following paragraph styles
889 as appropriate..
891 Note that TABLE-TEMPLATE-NAME corresponds to the
894 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
897 specification for more information. Also consult the
898 implementation filed under `org-odt-get-table-cell-styles'.
901 formatting of numbered display equations. Do not delete this
902 style from the list."
912 use-last-row-styles
913 use-first-column-styles
914 use-last-column-styles
915 use-banding-rows-styles
916 use-banding-columns-styles)
917 :key-type symbol
920 ;;;; Timestamps
923 "Non-nil, if timestamps should be exported as date fields.
925 When nil, export timestamps as plain text.
927 When non-nil, map `org-time-stamp-custom-formats' to a pair of
929 respectively. A timestamp with no time component is formatted
933 This feature is experimental. Most (but not all) of the common
934 %-specifiers in `format-time-string' are supported.
936 formatted as canonical Org timestamps. For finer control, avoid
937 these %-specifiers.
940 etc., are displayed by the application in the default language
941 and country specified in `org-odt-styles-file'. Note that the
943 can localize the week day and month strings in the exported
944 document by setting the default language and country either using
945 the application UI or through a custom styles file.
947 See `org-odt--build-date-styles' for implementation details."
954 \f
955 ;;; Internal functions
957 ;;;; Date
972 ;; LibreOffice does not care about end goes as content
973 ;; within the "<text:date>...</text:date>" field. The
974 ;; displayed date is automagically corrected to match the
975 ;; format requested by "style:data-style-name" attribute. So
976 ;; don't bother about formatting the date contents to be
977 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
978 ;; simple Org-style date should suffice.
1003 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1004 iso-date style date)
1006 repeater)))))
1008 ;;;; Frame
1016 extra
1022 style frame-attrs
1034 ;;;; Library wrappers
1041 ;; This is shamelessly stolen from `archive-zip-extract'.
1047 name)))
1052 exit-code command-output)
1061 ;;;; Target
1070 ;;;; Textbox
1073 extra anchor-type)
1079 text)
1080 width nil style extra anchor-type))
1084 ;;;; Table of Contents
1087 "Return a table of contents.
1088 TITLE is the title of the table, as a string, or nil. ENTRIES is
1089 the contents of the table, as a string. DEPTH is an integer
1090 specifying the depth of the table."
1092 "
1093 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1097 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1098 "
1099 title))
1105 "
1106 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1108 <text:index-entry-chapter/>
1109 <text:index-entry-text/>
1110 <text:index-entry-link-end/>
1113 "
1114 </text:table-of-content-source>
1115 <text:index-body>"
1121 title))
1122 entries
1123 "
1124 </text:index-body>
1131 headline-label
1133 ;; Section number.
1135 ;; Todo.
1140 style todo)))
1145 style priority)))
1146 ;; Title.
1147 text
1148 ;; Tags.
1152 "OrgTags"
1160 "Build a table of contents.
1161 DEPTH is an integer specifying the depth of the table. INFO is
1162 a plist containing current export properties. Optional argument
1163 SCOPE, when non-nil, defines the scope of the table. Return the
1164 table of contents as a string, or nil."
1166 ;; When a headline is marked as a radio target, as in the example below:
1167 ;;
1168 ;; ** <<<Some Heading>>>
1169 ;; Some text.
1170 ;;
1171 ;; suppress generation of radio targets. i.e., Radio targets are to
1172 ;; be marked as targets within /document body/ and *not* within
1173 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1174 ;; and one in the document body.
1175 ;;
1176 ;; Likewise, links, footnote references and regular targets are also
1177 ;; suppressed.
1195 style entry)))
1197 depth))))
1200 ;;;; Document styles
1203 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1204 OBJECT-PROPS is (typically) a plist created by passing
1206 `org-odt-parse-block-attributes'.
1208 Use `org-odt-object-counters' to generate an automatic
1209 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1210 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1211 . STYLE-NAME)."
1227 ;;;; Checkbox
1230 "Return check-box string associated to ITEM."
1239 ;;; Template
1242 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1243 ;; to modify the date fields. A date could be modified by
1244 ;; offsetting in days. That's about it. Also, date and time may
1245 ;; have to be emitted as two fields - a date field and a time field
1246 ;; - separately.
1248 ;; One can add Form Controls to date and time fields so that they
1249 ;; can be easily modified. But then, the exported document will
1250 ;; become tightly coupled with LibreOffice and may not function
1251 ;; properly with other OpenDocument applications.
1253 ;; I have a strange feeling that Date styles are a bit flaky at the
1254 ;; moment.
1256 ;; The feature is experimental.
1300 ))
1309 filler-end))
1320 style
1323 output ))))
1326 "Return complete document string after ODT conversion.
1327 CONTENTS is the transcoded contents string. RAW-DATA is the
1328 original parsed data. INFO is a plist holding export options."
1329 ;; Write meta file.
1339 <office:document-meta
1349 ;; Date, if required.
1351 ;; Check if DATE is specified as an Org-timestamp. If yes,
1352 ;; include it as meta information. Otherwise, just use
1353 ;; today's date.
1362 iso-date)))))
1371 subtitle))
1375 ;; Add meta.xml in to manifest.
1378 ;; Update styles file.
1379 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1380 ;; Write styles file.
1384 ;; Non-availability of styles.xml is not a critical
1385 ;; error. For now, throw an error.
1389 org-odt-styles-dir)
1412 ;; create a manifest entry for styles.xml
1415 ;; FIXME: Who is opening an empty styles.xml before this point?
1420 ;; Write custom styles for source blocks
1421 ;; Save STYLES used for colorizing of source blocks.
1422 ;; Update styles.xml with styles that were collected as part of
1423 ;; `org-odt-hfy-face-to-css' callbacks.
1432 ;; Update styles.xml - take care of outline numbering
1434 ;; Don't make automatic backup of styles.xml file. This setting
1435 ;; prevents the backed-up styles.xml file from being zipped in to
1436 ;; odt file. This is more of a hackish fix. Better alternative
1437 ;; would be to fix the zip command so that the output odt file
1438 ;; includes only the needed files and excludes any auto-generated
1439 ;; extra files like backups and auto-saves etc etc. Note that
1440 ;; currently the zip command zips up the entire temp directory so
1441 ;; that any auto-generated files created under the hood ends up in
1442 ;; the resulting odt file.
1445 ;; Outline numbering is retained only upto LEVEL.
1446 ;; To disable outline numbering pass a LEVEL of 0.
1459 ;; Update content.xml.
1462 ;; within the context of the Org buffer. So obtain its
1463 ;; value before moving on to temp-buffer context down below.
1473 org-odt-styles-dir)))
1474 ;; Write automatic styles.
1475 ;; - Position the cursor.
1479 ;; - Dump automatic table styles.
1484 ;; - Dump date-styles.
1490 ;; Update display level.
1491 ;; - Remove existing sequence decls. Also position the cursor.
1496 ;; Update sequence decls according to user preference.
1507 ;; Position the cursor to document body.
1512 ;; Preamble - Title, Author, Date etc.
1522 ;; Switch on or off above vars based on user settings
1526 ;; Title.
1531 ;; Separator.
1533 ;; Subtitle.
1539 subtitle
1541 ;; Separator.
1545 ;; Author only.
1548 "OrgSubtitle"
1550 ;; Separator.
1553 ;; Author and E-mail.
1557 "OrgSubtitle"
1562 ;; Separator.
1564 ;; Date, if required.
1567 ;; Check if DATE is specified as a timestamp.
1574 "OrgSubtitle"
1578 ;; Separator
1580 ;; Table of Contents
1583 with-toc
1586 ;; Contents.
1588 ;; Return contents.
1592 \f
1593 ;;; Transcode Functions
1595 ;;;; Bold
1598 "Transcode BOLD from Org to ODT.
1599 CONTENTS is the text with bold markup. INFO is a plist holding
1600 contextual information."
1605 ;;;; Center Block
1608 "Transcode a CENTER-BLOCK element from Org to ODT.
1609 CONTENTS holds the contents of the center block. INFO is a plist
1610 holding contextual information."
1611 contents)
1614 ;;;; Clock
1617 "Transcode a CLOCK element from Org to ODT.
1618 CONTENTS is nil. INFO is a plist used as a communication
1619 channel."
1632 ;;;; Code
1635 "Transcode a CODE object from Org to ODT.
1636 CONTENTS is nil. INFO is a plist used as a communication
1637 channel."
1643 ;;;; Drawer
1646 "Transcode a DRAWER element from Org to ODT.
1647 CONTENTS holds the contents of the block. INFO is a plist
1648 holding contextual information."
1651 name contents)))
1652 output))
1655 ;;;; Dynamic Block
1658 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1659 CONTENTS holds the contents of the block. INFO is a plist
1660 holding contextual information. See `org-export-data'."
1661 contents)
1664 ;;;; Entity
1667 "Transcode an ENTITY object from Org to ODT.
1668 CONTENTS are the definition itself. INFO is a plist holding
1669 contextual information."
1673 ;;;; Example Block
1676 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1677 CONTENTS is nil. INFO is a plist holding contextual information."
1681 ;;;; Export Snippet
1684 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1685 CONTENTS is nil. INFO is a plist holding contextual information."
1690 ;;;; Export Block
1693 "Transcode a EXPORT-BLOCK element from Org to ODT.
1694 CONTENTS is nil. INFO is a plist holding contextual information."
1699 ;;;; Fixed Width
1702 "Transcode a FIXED-WIDTH element from Org to ODT.
1703 CONTENTS is nil. INFO is a plist holding contextual information."
1707 ;;;; Footnote Definition
1709 ;; Footnote Definitions are ignored.
1712 ;;;; Footnote Reference
1715 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1716 CONTENTS is nil. INFO is a plist holding contextual information."
1724 id note-class
1736 "OrgSuperscript"
1737 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1738 note-class ref-format ref-name n))))))
1740 ;; Insert separator between two footnotes in a row.
1745 ;; Transcode footnote reference.
1753 footnote-reference info))
1757 raw
1760 :transcoders
1763 p c i
1764 "Footnote"
1765 "OrgFootnoteCenter"
1767 info))))
1768 ;; Inline definitions are secondary strings. We
1769 ;; need to wrap them within a paragraph.
1771 org-element-all-elements)
1772 def
1775 def)))))
1779 ;;;; Headline
1782 &optional format-function
1784 "Transcode a HEADLINE element using BACKEND.
1785 INFO is a plist holding contextual information."
1808 &key _level _section-number _headline-label
1811 todo todo-type priority text tags))))))
1813 todo todo-type priority text tags
1814 :headline-label headline-label
1815 :level level
1819 "Transcode a HEADLINE element from Org to ODT.
1820 CONTENTS holds the contents of the headline. INFO is a plist
1821 holding contextual information."
1822 ;; Case 1: This is a footnote section: ignore it.
1825 ;; Get level relative to current parsed data.
1828 ;; Get canonical label for the headline.
1830 ;; Extra targets.
1834 ;; Title.
1837 ;; Case 2. This is a deep sub-tree: export it as a list item.
1838 ;; Also export as items headlines for which no section
1839 ;; format has been found.
1841 ;; Build the real contents of the sub-tree.
1845 ;; Choose style based on list type.
1847 ;; If top-level list, re-start numbering. Otherwise,
1848 ;; continue numbering.
1851 headline)))
1861 "Text_20_body"
1863 contents)
1865 "</text:list-header>"
1869 ;; Case 3. Standard headline. Export it as a section.
1873 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1876 level
1879 contents))))))
1883 "Default format function for a headline.
1884 See `org-odt-format-headline-function' for details."
1886 ;; Todo.
1894 style priority)))
1895 ;; Title.
1896 text
1897 ;; Tags.
1900 "<text:tab/>"
1909 ;;;; Horizontal Rule
1912 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1913 CONTENTS is nil. INFO is a plist holding contextual information."
1918 ;;;; Inline Babel Call
1920 ;; Inline Babel Calls are ignored.
1923 ;;;; Inline Src Block
1926 "Return a character not used in string S.
1928 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1934 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1935 CONTENTS holds the contents of the item. INFO is a plist holding
1936 contextual information."
1940 ;;;; Inlinetask
1943 "Transcode an INLINETASK element from Org to ODT.
1944 CONTENTS holds the contents of the block. INFO is a plist
1945 holding contextual information."
1957 todo todo-type priority text tags contents)))
1961 "Default format function for a inlinetasks.
1962 See `org-odt-format-inlinetask-function' for details."
1964 "Text_20_body"
1968 "OrgInlineTaskHeading"
1970 todo todo-type priority name tags))
1971 contents)
1974 ;;;; Italic
1977 "Transcode ITALIC from Org to ODT.
1978 CONTENTS is the text with italic markup. INFO is a plist holding
1979 contextual information."
1984 ;;;; Item
1987 "Transcode an ITEM element from Org to ODT.
1988 CONTENTS holds the contents of the item. INFO is a plist holding
1989 contextual information."
1995 contents
1997 "</text:list-header>"
2000 ;;;; Keyword
2003 "Transcode a KEYWORD element from Org to ODT.
2004 CONTENTS is nil. INFO is a plist holding contextual
2005 information."
2011 ;; FIXME
2023 ;; FIXME
2027 ;;;; Latex Environment
2030 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2031 ;; (defadvice org-format-latex-as-mathml ; FIXME
2032 ;; (after org-odt-protect-latex-fragment activate)
2033 ;; "Encode LaTeX fragment as XML.
2034 ;; Do this when translation to MathML fails."
2035 ;; (unless (> (length ad-return-value) 0)
2036 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2039 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2040 CONTENTS is nil. INFO is a plist holding contextual information."
2046 ;;;; Latex Fragment
2048 ;; (when latex-frag ; FIXME
2049 ;; (setq href (propertize href :title "LaTeX Fragment"
2050 ;; :description latex-frag)))
2051 ;; handle verbatim
2052 ;; provide descriptions
2055 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2056 CONTENTS is nil. INFO is a plist holding contextual information."
2062 ;;;; Line Break
2065 "Transcode a LINE-BREAK object from Org to ODT.
2066 CONTENTS is nil. INFO is a plist holding contextual information."
2070 ;;;; Link
2072 ;;;; Links :: Label references
2082 x))))
2092 counter))
2095 element
2097 info))
2101 ;; Section number.
2105 ;; Separator.
2107 ;; Ordinal.
2109 tag))
2112 "Return a label for ELEMENT.
2114 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2115 element. INFO is a plist used as a communication channel. OP is
2116 either `definition' or `reference', depending on the purpose of
2117 the generated string.
2119 Return value is a string if OP is set to `reference' or a cons
2120 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2121 SHORT-CAPTION are strings."
2127 ;; Get label and caption.
2133 ;; FIXME: We don't use short-caption for now
2149 element))))
2152 seqno)
2156 ;; Compute sequence number of the element.
2158 ;; Localize category string.
2161 ;; Case 1: Handle Label definition.
2165 ;; Sneak in a bookmark. The bookmark is used when the
2166 ;; labeled element is referenced with a link that
2167 ;; provides its own description.
2169 ;; Label definition: Typically formatted as below:
2170 ;; CATEGORY SEQ-NO: LONG CAPTION
2171 ;; with translation for correct punctuation.
2178 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2179 label counter counter seqno))
2181 short-caption))
2182 ;; Case 2: Handle Label reference.
2187 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2188 fmt1
2189 label
2194 ;;;; Links :: Inline Images
2197 "Returns the internal name of the file"
2213 target-file))
2236 ;; Use Imagemagick.
2241 file))))
2246 ;; Use Emacs.
2252 ;; Use hard-coded values.
2254 org-odt-default-image-sizes-alist))
2255 ;; Error out.
2268 ;; ensure that an embedded image fits comfortably within a page
2279 "Return ODT code for an inline image.
2280 LINK is the link pointing to the inline image. INFO is a plist
2281 used as a communication channel."
2294 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2296 ;; Extract attributes from #+ATTR_ODT line.
2300 ;; Convert attributes to a plist.
2302 ;; Handle `:anchor', `:style' and `:attributes' properties.
2312 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2313 ;;
2314 ;; Handle `:width', `:height' and `:scale' properties. Read
2315 ;; them as numbers since we need them for computations.
2317 src-expanded info
2324 nil ; embed-as
2326 ))
2333 ;; Check if this link was created by LaTeX-to-PNG converter.
2337 ;; If yes, note down the type of the element - LaTeX Fragment
2338 ;; or LaTeX environment. It will go in to frame title.
2342 ;; If yes, note down its contents. It will go in to frame
2343 ;; description. This quite useful for debugging.
2346 captions user-frame-params title desc)))
2349 ;;;; Links :: Math formula
2368 ;; Check if this link was created by LaTeX-to-MathML
2369 ;; converter.
2373 ;; If yes, note down the type of the element - LaTeX Fragment
2374 ;; or LaTeX environment. It will go in to frame title.
2378 ;; If yes, note down its contents. It will go in to frame
2379 ;; description. This quite useful for debugging.
2381 width height)
2385 nil nil title desc))
2388 "CaptionedDisplayFormula" href width height
2389 captions nil title desc))
2393 org-odt--enumerable-formula-p))))
2398 "Returns the internal name of the file"
2402 ;; Create a directory for holding formula file. Also enter it in
2403 ;; to manifest.
2407 ;; Copy over the formula file from user directory to zip
2408 ;; directory.
2412 ;; Case 1: Mathml.
2415 ;; Case 2: OpenDocument formula.
2420 ;; Enter the formula file in to manifest.
2422 target-file))
2424 ;;;; Targets
2427 captions user-frame-params
2430 ;; Each element of this alist is of the form (CFG-HANDLE
2431 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2433 ;; CFG-HANDLE is the key to the alist.
2435 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2436 ;; frame params for INNER-FRAME and OUTER-FRAME
2437 ;; respectively. See below.
2439 ;; Configurations that are meant to be applied to
2440 ;; non-captioned image/formula specifies no
2441 ;; OUTER-FRAME-PARAMS.
2443 ;; TERMINOLOGY
2444 ;; ===========
2445 ;; INNER-FRAME :: Frame that directly surrounds an
2446 ;; image/formula.
2448 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2449 ;; frame also contains the caption, if any.
2451 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2452 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2453 ;; that these are the last three arguments
2454 ;; to `org-odt--frame'.
2456 ;; Note that an un-captioned image/formula requires just an
2457 ;; INNER-FRAME, while a captioned image/formula requires
2458 ;; both an INNER and an OUTER-FRAME.
2480 ;; Retrieve inner and outer frame params, from configuration.
2484 ;; User-specified frame params (from #+ATTR_ODT spec)
2488 "Merge default and user frame params."
2493 for d in default
2496 ;; Case 1: Image/Formula has no caption.
2497 ;; There is only one frame, one that surrounds the image
2498 ;; or formula.
2500 ;; Merge user frame params with that from configuration.
2504 ;; Case 2: Image/Formula is captioned or labeled.
2505 ;; There are two frames: The inner one surrounds the
2506 ;; image or formula. The outer one contains the
2507 ;; caption/sequence number.
2509 ;; Merge user frame params with outer frame params.
2511 ;; Short caption, if specified, goes as part of inner frame.
2518 frame-params))
2521 "Illustration"
2525 caption))
2526 width height outer)))))
2529 ;; Element should have a caption or label.
2535 element info
2536 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2537 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2538 ;; processing.)
2543 ;; Link should point to an image file.
2550 element info
2551 ;; Paragraph should have a caption or label. It SHOULD also be a
2552 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2553 ;; processing.)
2558 ;; Link should point to an image file.
2565 element info
2566 ;; Paragraph should have a caption or label.
2570 ;; Link should point to a MathML or ODF file.
2576 paragraph-predicate
2577 link-predicate)
2578 "Test if ELEMENT is a standalone link for the purpose ODT export.
2579 INFO is a plist holding contextual information.
2581 Return non-nil, if ELEMENT is of type paragraph satisfying
2582 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2583 is a link that satisfies LINK-PREDICATE.
2585 Return non-nil, if ELEMENT is of type link satisfying
2586 LINK-PREDICATE and its containing paragraph satisfies
2587 PARAGRAPH-PREDICATE in addition to having no other content save for
2588 leading and trailing whitespaces.
2590 Return nil, otherwise."
2613 ;; DESTINATION is a headline or an element (like paragraph,
2614 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2616 ;; Note that labels that are attached to captioned entities - inline
2617 ;; images, math formulae and tables - get resolved as part of
2618 ;; `org-odt-format-label' and `org-odt--enumerate'.
2620 ;; Create a cross-reference to DESTINATION but make best-efforts to
2621 ;; create a *meaningful* description. Check item numbers, section
2622 ;; number and section title in that order.
2624 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2625 ;; FIXME: Handle footnote-definition footnote-reference?
2637 return x))
2638 ;; Get list item nos.
2643 plain-list)
2646 item info t))))))
2647 ;; Locate top-most listified headline.
2652 return x))
2653 ;; Get listified headline numbers.
2659 el info t)))))))
2660 ;; Combine item numbers from both the listified headlines and
2661 ;; regular list items.
2663 ;; Case 1: Check if all the parents of list item are numbered.
2664 ;; If yes, link to the item proper.
2667 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2668 label
2672 ;; Case 2: Locate a regular and numbered headline in the
2673 ;; hierarchy. Display its section number.
2676 ;; Test if destination is a numbered headline.
2682 return el))))
2683 ;; We found one.
2685 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2686 label
2689 ;; Case 4: Locate a regular headline in the hierarchy. Display
2690 ;; its title.
2694 return el)))
2695 ;; We found one.
2697 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2698 label
2704 "Transcode a LINK object from Org to ODT.
2706 DESC is the description part of the link, or the empty string.
2707 INFO is a plist holding contextual information. See
2708 `org-export-data'."
2711 ;; Ensure DESC really exists, or set it to nil.
2720 ;; Convert & to & for correct XML representation
2723 ;; Link type is handled by a special function.
2725 ;; Image file.
2727 ;; Formula file.
2732 ;; Radio target: Transcode target's contents and use them as
2733 ;; link's description.
2738 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2740 desc))))
2741 ;; Links pointing to a headline: Find destination and build
2742 ;; appropriate referencing command.
2748 ;; Fuzzy link points to a headline. If there's
2749 ;; a description, create a hyperlink. Otherwise, try to
2750 ;; provide a meaningful description.
2759 label desc))))
2760 ;; Fuzzy link points to a target. If there's a description,
2761 ;; create a hyperlink. Otherwise, try to provide
2762 ;; a meaningful description.
2767 ;; Fuzzy link points to some element (e.g., an inline image,
2768 ;; a math formula or a table).
2776 ;; LINK has no description. Create
2777 ;; a cross-reference showing entity's sequence
2778 ;; number.
2780 ;; LINK has description. Insert a hyperlink with
2781 ;; user-provided description.
2786 desc))))))))
2787 ;; Coderef: replace link with the reference name or the
2788 ;; equivalent line number.
2795 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2796 href line-no))))
2797 ;; External link with a description part.
2800 ;; Check if description is a link to an inline image.
2805 desc-element
2807 ;; Format link as a clickable image.
2809 path desc)
2810 ;; Otherwise, format it as a regular link.
2812 path desc))))
2813 ;; External link without a description part.
2816 path path))
2817 ;; No path, only description. Try to do something useful.
2822 ;;;; Node Property
2825 "Transcode a NODE-PROPERTY element from Org to ODT.
2826 CONTENTS is nil. INFO is a plist holding contextual
2827 information."
2834 ;;;; Paragraph
2837 "Return style of PARAGRAPH.
2838 Style is a symbol among `quoted', `centered' and nil."
2848 "Format paragraph according to given styles.
2849 PARAGRAPH is a paragraph type element. CONTENTS is the
2850 transcoded contents of that paragraph, as a string. INFO is
2851 a plist used as a communication channel. DEFAULT, CENTER and
2852 QUOTE are, respectively, style to use when paragraph belongs to
2853 no special environment, a center block, or a quote block."
2859 ;; If PARAGRAPH is a leading paragraph in an item that has
2860 ;; a checkbox, splice checkbox and paragraph contents
2861 ;; together.
2866 contents)))
2869 "Transcode a PARAGRAPH element from Org to ODT.
2870 CONTENTS is the contents of the paragraph, as a string. INFO is
2871 the plist used as a communication channel."
2873 paragraph contents info
2875 "OrgCenter"
2879 ;;;; Plain List
2882 "Transcode a PLAIN-LIST element from Org to ODT.
2883 CONTENTS is the contents of the list. INFO is a plist holding
2884 contextual information."
2886 ;; Choose style based on list type.
2892 ;; If top-level list, re-start numbering. Otherwise,
2893 ;; continue numbering.
2898 contents))
2900 ;;;; Plain Text
2913 line))
2922 "Transcode a TEXT string from Org to ODT.
2923 TEXT is the string to transcode. INFO is a plist holding
2924 contextual information."
2926 ;; Protect &, < and >.
2928 ;; Handle smart quotes. Be sure to provide original string since
2929 ;; OUTPUT may have been modified.
2932 ;; Convert special strings.
2937 ;; Handle break preservation if required.
2941 ;; Return value.
2942 output))
2945 ;;;; Planning
2948 "Transcode a PLANNING element from Org to ODT.
2949 CONTENTS is nil. INFO is a plist used as a communication
2950 channel."
2952 "OrgPlanning"
2974 ;;;; Property Drawer
2977 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2978 CONTENTS holds the contents of the drawer. INFO is a plist
2979 holding contextual information."
2982 contents)))
2985 ;;;; Quote Block
2988 "Transcode a QUOTE-BLOCK element from Org to ODT.
2989 CONTENTS holds the contents of the block. INFO is a plist
2990 holding contextual information."
2991 contents)
2994 ;;;; Section
2999 style
3001 text)))
3005 "Transcode a SECTION element from Org to ODT.
3006 CONTENTS holds the contents of the section. INFO is a plist
3007 holding contextual information."
3008 contents)
3010 ;;;; Radio Target
3013 "Transcode a RADIO-TARGET object from Org to ODT.
3014 TEXT is the text of the target. INFO is a plist holding
3015 contextual information."
3019 ;;;; Special Block
3022 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3023 CONTENTS holds the contents of the block. INFO is a plist
3024 holding contextual information."
3028 ;; Annotation.
3034 ;; FIXME: Is `car' right thing to do below?
3044 contents)))))
3045 ;; Textbox.
3054 style extra anchor))))
3058 ;;;; Src Block
3061 "Create custom style for face FN.
3062 When FN is the default face, use its foreground and background
3064 use its color attribute to create a character style whose name
3065 is obtained from FN. Currently all attributes of FN other than
3066 color are ignored.
3068 The style name for a face FN is derived using the following
3069 operations on the face name in that order - de-dash, CamelCase
3071 `font-lock-function-name-face' is associated with
3085 background-color-val color-val))
3088 "
3135 code
3146 par-style loc))
3149 num-start refs))
3163 ;; Extract code and references.
3167 ;; Does the src block contain labels?
3169 ;; Does it have line numbers?
3174 "Transcode a SRC-BLOCK element from Org to ODT.
3175 CONTENTS holds the contents of the item. INFO is a plist holding
3176 contextual information."
3186 "Text_20_body"
3190 ;;;; Statistics Cookie
3193 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3194 CONTENTS is nil. INFO is a plist holding contextual information."
3200 ;;;; Strike-Through
3203 "Transcode STRIKE-THROUGH from Org to ODT.
3204 CONTENTS is the text with strike-through markup. INFO is a plist
3205 holding contextual information."
3210 ;;;; Subscript
3213 "Transcode a SUBSCRIPT object from Org to ODT.
3214 CONTENTS is the contents of the object. INFO is a plist holding
3215 contextual information."
3220 ;;;; Superscript
3223 "Transcode a SUPERSCRIPT object from Org to ODT.
3224 CONTENTS is the contents of the object. INFO is a plist holding
3225 contextual information."
3230 ;;;; Table Cell
3239 "Retrieve styles applicable to a table cell.
3240 R and C are (zero-based) row and column numbers of the table
3241 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3242 applicable to the current table. It is nil if the table is not
3243 associated with any style attributes.
3245 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3247 When STYLE-SPEC is nil, style the table cell the conventional way
3248 - choose cell borders based on row and column groupings and
3249 choose paragraph alignment based on `org-col-cookies' text
3250 property. See also
3251 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3253 When STYLE-SPEC is non-nil, ignore the above cookie and return
3254 styles congruent with the ODF-1.2 specification."
3260 info)))
3262 ;; LibreOffice - particularly the Writer - honors neither table
3263 ;; templates nor custom table-cell styles. Inorder to retain
3264 ;; inter-operability with LibreOffice, only automatic styles are
3265 ;; used for styling of table-cells. The current implementation is
3266 ;; congruent with ODF-1.2 specification and hence is
3267 ;; future-compatible.
3269 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3270 ;; which recognizes as many as 16 different cell types - is much
3271 ;; richer. Unfortunately it is NOT amenable to easy configuration
3272 ;; by hand.
3299 "Transcode a TABLE-CELL element from Org to ODT.
3300 CONTENTS is nil. INFO is a plist used as a communication
3301 channel."
3308 table-cell info))
3331 table-cell info))))))
3335 custom-style-prefix))
3337 "OrgTblCell"
3353 cell-attributes
3356 org-element-all-elements)
3357 contents
3359 paragraph-style contents))))
3366 ;;;; Table Row
3369 "Transcode a TABLE-ROW element from Org to ODT.
3370 CONTENTS is the contents of the row. INFO is a plist used as a
3371 communication channel."
3372 ;; Rules are ignored since table separators are deduced from
3373 ;; borders of the current row.
3379 ;; If the row belongs to the first rowgroup and the
3380 ;; table has more than one row groups, then this row
3381 ;; belongs to the header row group.
3383 ;; Otherwise, it belongs to non-header row group.
3386 ;; Does this row begin a rowgroup?
3389 ;; Actual table row
3391 ;; Does this row end a rowgroup?
3396 ;;;; Table
3409 "Transcode a TABLE element from Org to ODT.
3410 CONTENTS is the contents of the table. INFO is a plist holding
3411 contextual information."
3413 ;; Case 1: table.el doesn't support export to OD format. Strip
3414 ;; such tables from export.
3419 "(ox-odt): Found table.el-type table in the source Org file."
3420 " table.el doesn't support export to ODT format."
3422 ;; Case 2: Native Org tables.
3438 column-style))
3439 out)
3443 ;; caption.
3447 ;; begin table.
3455 ;; column specification.
3457 ;; actual contents.
3459 ;; end table.
3463 "Transcode a TABLE element from Org to ODT.
3464 CONTENTS is the contents of the table. INFO is a plist holding
3465 contextual information.
3467 Use `org-odt--table' to typeset the table. Handle details
3468 pertaining to indentation here."
3483 collect el)))
3489 collect
3494 parent-list)
3496 ;; Handle list genealogy.
3516 parent-list info)
3519 ;; Handle low-level headlines.
3521 with step = 'item collect
3529 el info)
3530 "OrgNumberedList"
3541 parent-list info)))
3549 table info)))
3550 ;; OpenDocument schema does not permit table to occur within a
3551 ;; list item.
3553 ;; One solution - the easiest and lightweight, in terms of
3554 ;; implementation - is to put the table in an indented text box
3555 ;; and make the text box part of the list-item. Unfortunately if
3556 ;; the table is big and spans multiple pages, the text box could
3557 ;; overflow. In this case, the following attribute will come
3558 ;; handy.
3560 ;; ,---- From OpenDocument-v1.1.pdf
3561 ;; | 15.27.28 Overflow behavior
3562 ;; |
3563 ;; | For text boxes contained within text document, the
3564 ;; | style:overflow-behavior property specifies the behavior of text
3565 ;; | boxes where the containing text does not fit into the text
3566 ;; | box.
3567 ;; |
3568 ;; | If the attribute's value is clip, the text that does not fit
3569 ;; | into the text box is not displayed.
3570 ;; |
3571 ;; | If the attribute value is auto-create-new-frame, a new frame
3572 ;; | will be created on the next page, with the same position and
3573 ;; | dimensions of the original frame.
3574 ;; |
3575 ;; | If the style:overflow-behavior property's value is
3576 ;; | auto-create-new-frame and the text box has a minimum width or
3577 ;; | height specified, then the text box will grow until the page
3578 ;; | bounds are reached before a new frame is created.
3579 ;; `----
3581 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3582 ;; auto-create-new-frame property and always resorts to clipping
3583 ;; the text box. This results in table being truncated.
3585 ;; So we solve the problem the hard (and fun) way using list
3586 ;; continuations.
3588 ;; The problem only becomes more interesting if you take in to
3589 ;; account the following facts:
3590 ;;
3591 ;; - Description lists are simulated as plain lists.
3592 ;; - Low-level headlines can be listified.
3593 ;; - In Org-mode, a table can occur not only as a regular list
3594 ;; item, but also within description lists and low-level
3595 ;; headlines.
3597 ;; See `org-odt-translate-description-lists' and
3598 ;; `org-odt-translate-low-level-headlines' for how this is
3599 ;; tackled.
3602 ;; Discontinue the list.
3604 ;; Put the table in an indented section.
3609 ;; Continue the list.
3613 ;;;; Target
3616 "Transcode a TARGET object from Org to ODT.
3617 CONTENTS is nil. INFO is a plist holding contextual
3618 information."
3622 ;;;; Timestamp
3625 "Transcode a TIMESTAMP object from Org to ODT.
3626 CONTENTS is nil. INFO is a plist used as a communication
3627 channel."
3643 "OrgActiveTimestamp"
3647 "OrgInactiveTimestamp"
3651 "OrgActiveTimestamp"
3657 "OrgInactiveTimestamp"
3663 "OrgDiaryTimestamp"
3665 info)))))))
3668 ;;;; Underline
3671 "Transcode UNDERLINE from Org to ODT.
3672 CONTENTS is the text with underline markup. INFO is a plist
3673 holding contextual information."
3678 ;;;; Verbatim
3681 "Transcode a VERBATIM object from Org to ODT.
3682 CONTENTS is nil. INFO is a plist used as a communication
3683 channel."
3689 ;;;; Verse Block
3692 "Transcode a VERSE-BLOCK element from Org to ODT.
3693 CONTENTS is verse block contents. INFO is a plist holding
3694 contextual information."
3695 ;; Add line breaks to each line of verse.
3699 ;; Replace tabs and spaces.
3701 ;; Surround it in a verse environment.
3706 \f
3707 ;;; Filters
3709 ;;;; LaTeX fragments
3714 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3715 ;; If the desired converter is not available, force verbatim
3716 ;; processing.
3734 ;; Store normalized value for later use.
3739 ;; Convert `latex-fragment's and `latex-environment's.
3758 ;; Get an Org-style link to PNG image or the MathML
3759 ;; file.
3764 nil display-msg
3765 nil processing-type)
3770 nil))))
3772 ;; Conversion succeeded. Parse above Org-style link to
3773 ;; a `link' object.
3780 ;; Case 1: LaTeX environment. Mimic
3781 ;; a "standalone image or formula" by
3782 ;; enclosing the `link' in a `paragraph'.
3783 ;; Copy over original attributes, captions to
3784 ;; the enclosing paragraph.
3789 :name
3791 :caption
3793 link))
3794 ;; Case 2: LaTeX fragment. No special action.
3796 ;; Note down the object that link replaces.
3800 ;; Restore blank after initial element or object.
3802 replacement :post-blank
3804 ;; Replace now.
3806 info nil nil t)))
3807 tree)
3810 ;;;; Description lists
3812 ;; This translator is necessary to handle indented tables in a uniform
3813 ;; manner. See comment in `org-odt--table'.
3816 ;; OpenDocument has no notion of a description list. So simulate it
3817 ;; using plain lists. Description lists in the exported document
3818 ;; are typeset in the same manner as they are in a typical HTML
3819 ;; document.
3820 ;;
3821 ;; Specifically, a description list like this:
3822 ;;
3823 ;; ,----
3824 ;; | - term-1 :: definition-1
3825 ;; | - term-2 :: definition-2
3826 ;; `----
3827 ;;
3828 ;; gets translated in to the following form:
3829 ;;
3830 ;; ,----
3831 ;; | - term-1
3832 ;; | - definition-1
3833 ;; | - term-2
3834 ;; | - definition-2
3835 ;; `----
3836 ;;
3837 ;; Further effect is achieved by fixing the OD styles as below:
3838 ;;
3839 ;; 1. Set the :type property of the simulated lists to
3840 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3841 ;; that has *no* bullets whatsoever.
3842 ;;
3843 ;; 2. The paragraph containing the definition term is styled to be
3844 ;; in bold.
3845 ;;
3850 el
3866 nil)
3867 info)
3868 tree)
3870 ;;;; List tables
3872 ;; Lists that are marked with attribute `:list-table' are called as
3873 ;; list tables. They will be rendered as a table within the exported
3874 ;; document.
3876 ;; Consider an example. The following list table
3877 ;;
3878 ;; #+attr_odt :list-table t
3879 ;; - Row 1
3880 ;; - 1.1
3881 ;; - 1.2
3882 ;; - 1.3
3883 ;; - Row 2
3884 ;; - 2.1
3885 ;; - 2.2
3886 ;; - 2.3
3887 ;;
3888 ;; will be exported as though it were an Org table like the one show
3889 ;; below.
3890 ;;
3891 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3892 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3893 ;;
3894 ;; Note that org-tables are NOT multi-line and each line is mapped to
3895 ;; a unique row in the exported document. So if an exported table
3896 ;; needs to contain a single paragraph (with copious text) it needs to
3897 ;; be typed up in a single line. Editing such long lines using the
3898 ;; table editor will be a cumbersome task. Furthermore inclusion of
3899 ;; multi-paragraph text in a table cell is well-nigh impossible.
3900 ;;
3901 ;; A LIST-TABLE circumvents above problems.
3902 ;;
3903 ;; Note that in the example above the list items could be paragraphs
3904 ;; themselves and the list can be arbitrarily deep.
3905 ;;
3906 ;; Inspired by following thread:
3907 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3909 ;; Translate lists to tables
3915 ;; Replace list with table.
3917 l1-list
3918 ;; Build replacement table.
3924 l1-item-leading-text l2-list)
3925 ;; Remove Level-2 list from the Level-item. It
3926 ;; will be subsequently attached as table-cells.
3936 ;; Level-1 items start a table row.
3939 ;; Leading text of level-1 item define
3940 ;; the first table-cell.
3943 l1-item-leading-text)
3944 ;; Level-2 items define subsequent
3945 ;; table-cells of the row.
3953 nil)
3954 info)
3955 tree)
3957 \f
3958 ;;; Interactive functions
3971 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3986 ;; Initialize temporary workarea. All files that end up in
3987 ;; the exported document get parked/created here.
3993 ;; Kill all XML buffers.
4001 ;; Delete temporary directory and also other embedded
4002 ;; files that get copied there.
4007 ;; Not at all OSes ship with zip by default
4009 ;; Do export. This creates a bunch of xml files ready to be
4010 ;; saved and zipped.
4012 ;; Create a manifest entry for content.xml.
4014 ;; Write mimetype file
4023 ;; Write out the manifest entries before zipping
4025 ;; Save all XML files.
4031 ;; Prettify output if needed.
4035 ;; Run zip.
4040 ;; If a file with same name as the desired output file
4041 ;; exists, remove it.
4044 ;; Zip up the xml files.
4047 ;; Switch temporarily to content.xml. This way Zip
4048 ;; process will inherit `org-odt-zip-dir' as the current
4049 ;; directory.
4062 err-string)))))
4063 ;; Move the zip file from temporary work directory to
4064 ;; user-mandated location.
4067 ;; Cleanup work directory and work files.
4069 ;; Open the OpenDocument file in archive-mode for
4070 ;; examination.
4072 ;; Return exported file.
4074 ;; Case 1: Conversion desired on exported file. Run the
4075 ;; converter on the OpenDocument file. Return the
4076 ;; converted file.
4079 target))
4080 ;; Case 2: No further conversion. Return exported
4081 ;; OpenDocument file.
4084 ;; Cleanup work directory and work files.
4090 ;;;; Export to OpenDocument formula
4092 ;;;###autoload
4094 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4095 Use `org-create-math-formula' to convert LATEX-FRAG first to
4096 MathML. When invoked as an interactive command, use
4097 `org-latex-regexps' to infer LATEX-FRAG from currently active
4098 region. If no LaTeX fragments are found, prompt for it. Push
4099 MathML source to kill ring depending on the value of
4100 `org-export-copy-to-kill-ring'."
4126 filename
4139 ;; Add MathML to kill ring, if needed.
4143 ;;;###autoload
4145 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4146 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4147 formula file."
4152 ;;;; Export to OpenDocument Text
4154 ;;;###autoload
4156 "Export current buffer to a ODT file.
4158 If narrowing is active in the current buffer, only export its
4159 narrowed part.
4161 If a region is active, export that region.
4163 A non-nil optional argument ASYNC means the process should happen
4164 asynchronously. The resulting file should be accessible through
4165 the `org-export-stack' interface.
4167 When optional argument SUBTREEP is non-nil, export the sub-tree
4168 at point, extracting information from the headline properties
4169 first.
4171 When optional argument VISIBLE-ONLY is non-nil, don't export
4172 contents of hidden elements.
4174 EXT-PLIST, when provided, is a property list with external
4175 parameters overriding Org default settings, but still inferior to
4176 file-local settings.
4178 Return output file's name."
4185 ,outfile
4190 ;; Let `htmlfontify' know that we are interested in
4191 ;; collecting styles.
4193 ;; Initialize content.xml and kick-off the export
4194 ;; process.
4207 outfile
4212 ;; Let `htmlfontify' know that we are interested in collecting
4213 ;; styles.
4215 ;; Initialize content.xml and kick-off the export process.
4225 ;;;; Convert between OpenDocument and other formats
4228 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4237 "Workhorse routine for `org-odt-convert'."
4246 in-fmt out-fmt)))
4274 out-file)
4277 nil))))
4280 "Return verbose info about formats to which IN-FMT can be converted.
4281 Return a list where each element is of the
4282 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4283 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4284 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4288 org-odt-convert-processes t))))
4292 org-odt-convert-processes t))
4293 org-odt-convert-capabilities))
4294 reachable-formats)
4299 reachable-formats))
4302 "Return list of formats to which IN-FMT can be converted.
4303 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4310 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4311 This is a helper routine for interactive use."
4314 nil buffer-file-name t))
4320 out-fmt-choices nil nil nil))
4322 "No known converter or no known output formats for %s files"
4323 in-fmt))))
4326 ;;;###autoload
4328 "Convert IN-FILE to format OUT-FMT using a command line converter.
4329 IN-FILE is the file to be converted. If unspecified, it defaults
4330 to variable `buffer-file-name'. OUT-FMT is the desired output
4331 format. Use `org-odt-convert-process' as the converter. If OPEN
4332 is non-nil then the newly converted file is opened using
4333 `org-open-file'."
4338 ;;; Library Initializations
4341 ;; Let Emacs open all OpenDocument files in archive mode.
4347 ;; Local variables:
4348 ;; generated-autoload-file: "org-loaddefs.el"
4349 ;; End:
4351 ;;; ox-odt.el ends here