| blob | ce5f9d4ab626c6ea6354b01bc5fe04326c946b28 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2015 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
89 org-odt--translate-description-lists
90 org-odt--translate-list-tables)))
91 :menu-entry
98 :options-alist
103 ;; Other variables.
116 ;; Redefine regular option.
120 ;;; Dependencies
122 ;;; Hooks
124 ;;; Function and Dynamically Scoped Variables Declarations
140 \f
141 ;;; Internal Variables
145 "Location of ODT exporter.
146 Use this to infer values of `org-odt-styles-dir' and
151 "Data directory for ODT exporter.
152 Use this to infer values of `org-odt-styles-dir' and
169 "List of directories to search for OpenDocument schema files.
170 Use this list to set the default value of
171 `org-odt-schema-dir'. The entries in this list are
172 populated heuristically based on the values of `org-odt-lib-dir'
185 )
186 "List of directories to search for OpenDocument styles files.
187 See `org-odt-styles-dir'. The entries in this list are populated
188 heuristically based on the values of `org-odt-lib-dir' and
205 styles-dir)
209 styles-dir)
210 "Directory that holds auxiliary XML files used by the ODT exporter.
212 This directory contains the following XML files -
214 XML files are used as the default values of
215 `org-odt-styles-file' and `org-odt-content-template-file'.
217 The default value of this variable varies depending on the
218 version of org in use and is initialized from
219 `org-odt-styles-dir-list'. Note that the user could be using org
220 from one of: org's own private git repository, GNU ELPA tar or
243 "
245 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
246 </style:style>
247 "
251 "Registry of automatic styles for various OBJECT-TYPEs.
252 The variable has the following form:
253 ((OBJECT-TYPE-A
254 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
255 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
256 (OBJECT-TYPE-B
257 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
258 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
259 ...).
262 OBJECT-PROPS is (typically) a plist created by passing
268 "Running counters for various OBJECT-TYPEs.
269 Use this to generate automatic names and style-names. See
273 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
274 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
275 <style:background-image/>
276 </style:paragraph-properties>
278 </style:style>"
279 "Custom paragraph style for colorized source and example blocks.
281 except that the foreground and background colors are set
296 "Hardcoded image dimensions one for each of the anchor
299 ;; A4 page size is 21.0 by 29.7 cms
300 ;; The default page settings has 2cm margin on each of the sides. So
301 ;; the effective text area is 17.0 by 25.7 cm
310 "Specify how labels are applied and referenced.
312 This is an alist where each element is of the form:
314 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
316 ATTACH-FMT controls how labels and captions are attached to an
317 entity. It may contain following specifiers - %e and %c. %e is
318 replaced with the CATEGORY-NAME. %n is replaced with
320 with CAPTION.
322 REF-MODE and REF-FMT controls how label references are generated.
323 The following XML is generated for a label reference -
326 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
327 %n is replaced with SEQNO.
337 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
339 This is a list where each entry is of the form:
341 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
343 CATEGORY_HANDLE identifies the captionable entity in question.
345 OD-VARIABLE is the OpenDocument sequence counter associated with
346 the entity. These counters are declared within
348 `org-odt-content-template-file'.
350 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
351 how a given entity should be captioned and referenced.
353 CATEGORY-NAME is used for qualifying captions on export.
355 ENUMERATOR-PREDICATE is used for assigning a sequence number to
365 \f
366 ;;; User Configuration Variables
369 "Options for exporting Org mode files to ODT."
374 ;;;; Debugging
377 "Specify whether or not the xml output should be prettified.
378 When this option is turned on, `indent-region' is run on all
379 component xml buffers before they are saved. Turn this off for
380 regular use. Turn this on if you need to examine the xml
381 visually."
387 ;;;; Document schema
399 schema-dir))
402 schema-dir))
406 schema-dir)
409 nil)))
410 schema-dir)
411 "Directory that contains OpenDocument schema files.
413 This directory contains:
414 1. rnc files for OpenDocument schema
416 for auto validation of OpenDocument XML files.
418 Use the customize interface to set this variable. This ensures
419 that `rng-schema-locating-files' is updated and auto-validation
420 of OpenDocument XML takes place based on the value
421 `rng-nxml-auto-validate-flag'.
423 The default value of this variable varies depending on the
424 version of org in use and is initialized from
425 `org-odt-schema-dir-list'. The OASIS schema files are available
426 only in the org's private git repository. It is *not* bundled
427 with GNU ELPA tar or standard Emacs distribution."
433 :set
435 "Set `org-odt-schema-dir'.
436 Also add it to `rng-schema-locating-files'."
446 schema-dir
449 value))
450 nil)))
455 org-odt-schema-dir))))))
458 ;;;; Document styles
462 The exporter embeds the exported content just before
466 under `org-odt-styles-dir' is used."
473 "Default styles file for use with ODT export.
474 Valid values are one of:
475 1. nil
476 2. path to a styles.xml file
477 3. path to a *.odt or a *.ott file
478 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
479 ...))
481 In case of option 1, an in-built styles.xml is used. See
482 `org-odt-styles-dir' for more information.
484 In case of option 3, the specified file is unzipped and the
485 styles.xml embedded therein is used.
487 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
488 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
489 generated odt file. Use relative path for specifying the
490 FILE-MEMBERS. styles.xml must be specified as one of the
491 FILE-MEMBERS.
493 Use options 1, 2 or 3 only if styles.xml alone suffices for
494 achieving the desired formatting. Use option 4, if the styles.xml
495 references additional files like header and footer images for
496 achieving the desired formatting.
499 a per-file basis. For example,
505 :type
517 "Outline levels considered for enumerating captioned entities."
523 ;;;; Document conversion
530 "Specify a list of document converters and their usage.
531 The converters in this list are offered as choices while
532 customizing `org-odt-convert-process'.
534 This variable is a list where each element is of the
535 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
536 of the converter. CONVERTER-CMD is the shell command for the
537 converter and can contain format specifiers. These format
538 specifiers are interpreted as below:
540 %i input file name in full
541 %I input file name as a URL
542 %f format of the output file
543 %o output file name in full
544 %O output file name as a URL
545 %d output dir in full
546 %D output dir as a URL.
547 %x extra options as set in `org-odt-convert-capabilities'."
550 :type
559 During customization, the list of converter names are populated
560 from `org-odt-convert-processes'."
570 org-odt-convert-processes))))
588 "Specify input and output formats of `org-odt-convert-process'.
589 More correctly, specify the set of input and output formats that
590 the user is actually interested in.
592 This variable is an alist where each element is of the
593 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
594 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
595 alist where each element is of the form (OUTPUT-FMT
596 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
598 The variable is interpreted as follows:
599 `org-odt-convert-process' can take any document that is in
600 INPUT-FMT-LIST and produce any document that is in the
601 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
602 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
603 serves dual purposes:
604 - It is used for populating completion candidates during
605 `org-odt-convert' commands.
607 `org-odt-convert-process'.
610 `org-odt-convert-process'.
612 DOCUMENT-CLASS is used to group a set of file formats in
613 INPUT-FMT-LIST in to a single class.
615 Note that this variable inherently captures how LibreOffice based
616 converters work. LibreOffice maps documents of various formats
617 to classes like Text, Web, Spreadsheet, Presentation etc and
618 allow document of a given class (irrespective of its source
619 format) to be converted to any of the export formats associated
620 with that class.
622 See default setting of this variable for an typical
623 configuration."
626 :type
631 :value-type
635 :value-type
644 and then uses `org-odt-convert-process' to convert the
645 resulting document to this format. During customization of this
646 variable, the list of valid values are populated based on
647 `org-odt-convert-capabilities'.
649 You can set this option on per-file basis using file local
650 values. See Info node `(emacs) File Variables'."
661 ;;;###autoload
665 ;;;; Drawers
668 "Function called to format a drawer in ODT code.
670 The function must accept two parameters:
672 CONTENTS the contents of the drawer.
674 The function should return the string to be exported.
676 The default value simply returns the value of CONTENTS."
683 ;;;; Headline
686 'org-odt-format-headline-default-function
687 "Function to format headline text.
689 This function will be called with 5 arguments:
690 TODO the todo keyword (string or nil).
691 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
692 PRIORITY the priority of the headline (integer or nil)
693 TEXT the main headline text (string).
694 TAGS the tags string, separated with colons (string or nil).
696 The function result will be used as headline text."
703 ;;;; Inlinetasks
706 'org-odt-format-inlinetask-default-function
707 "Function called to format an inlinetask in ODT code.
709 The function must accept six parameters:
710 TODO the todo keyword, as a string
711 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
712 PRIORITY the inlinetask priority, as a string
713 NAME the inlinetask name, as a string.
714 TAGS the inlinetask tags, as a string.
715 CONTENTS the contents of the inlinetask, as a string.
717 The function should return the string to be exported."
724 ;;;; LaTeX
727 "Non-nil means process LaTeX math snippets.
729 When set, the exporter will process LaTeX environments and
730 fragments.
732 This option can also be set with the +OPTIONS line,
735 nil Ignore math snippets.
736 `verbatim' Keep everything in verbatim
737 `dvipng' Process the LaTeX fragments to images. This will also
738 include processing of non-math environments.
739 `imagemagick' Convert the LaTeX fragments to pdf files and use
740 imagemagick to convert pdf files to png files.
741 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
742 be loaded.
743 t Synonym for `mathjax'."
755 ;;;; Links
759 "Rules characterizing formula files that can be inlined into ODT.
761 A rule consists in an association whose key is the type of link
762 to consider, and value is a regexp that will be matched against
763 link's path."
772 "Rules characterizing image files that can be inlined into ODT.
774 A rule consists in an association whose key is the type of link
775 to consider, and value is a regexp that will be matched against
776 link's path."
784 "Scaling factor for converting images pixels to inches.
785 Use this for sizing of embedded images. See Info node `(org)
786 Images in ODT export' for more information."
793 ;;;; Src Block
796 "Whether custom styles for colorized source blocks be automatically created.
797 When this option is turned on, the exporter creates custom styles
798 for source blocks based on the advice of `htmlfontify'. Creation
799 of custom styles happen as part of `org-odt-hfy-face-to-css'.
801 When this option is turned off exporter does not create such
802 styles.
804 Use the latter option if you do not want the custom styles to be
805 based on your current display settings. It is necessary that the
806 styles.xml already contains needed styles for colorizing to work.
808 This variable is effective only if `org-odt-fontify-srcblocks' is
809 turned on."
815 "Specify whether or not source blocks need to be fontified.
816 Turn this option on if you want to colorize the source code
817 blocks in the exported file. For colorization to work, you need
818 to make available an enhanced version of `htmlfontify' library."
824 ;;;; Table
837 "Specify how Table Styles should be derived from a Table Template.
838 This is a list where each element is of the
839 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
841 TABLE-STYLE-NAME is the style associated with the table through
844 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
845 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
846 below) that is included in `org-odt-content-template-file'.
848 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
850 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
858 TABLE-CELL-OPTIONS is an alist where each element is of the
859 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
860 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
861 `use-last-row-styles' |
862 `use-first-column-styles' |
863 `use-last-column-styles' |
864 `use-banding-rows-styles' |
865 `use-banding-columns-styles' |
866 `use-first-row-styles'
867 ON-OR-OFF := t | nil
869 For example, with the following configuration
871 \(setq org-odt-table-styles
873 ((use-first-row-styles . t)
874 (use-first-column-styles . t)))
876 ((use-first-column-styles . t)))))
879 style will use the following table-cell styles -
884 as appropriate.
887 use the following table-cell styles -
889 following paragraph styles
891 as appropriate..
893 Note that TABLE-TEMPLATE-NAME corresponds to the
896 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
899 specification for more information. Also consult the
900 implementation filed under `org-odt-get-table-cell-styles'.
903 formatting of numbered display equations. Do not delete this
904 style from the list."
914 use-last-row-styles
915 use-first-column-styles
916 use-last-column-styles
917 use-banding-rows-styles
918 use-banding-columns-styles)
919 :key-type symbol
922 ;;;; Timestamps
925 "Non-nil, if timestamps should be exported as date fields.
927 When nil, export timestamps as plain text.
929 When non-nil, map `org-time-stamp-custom-formats' to a pair of
931 respectively. A timestamp with no time component is formatted
935 This feature is experimental. Most (but not all) of the common
936 %-specifiers in `format-time-string' are supported.
938 formatted as canonical Org timestamps. For finer control, avoid
939 these %-specifiers.
942 etc., are displayed by the application in the default language
943 and country specified in `org-odt-styles-file'. Note that the
945 can localize the week day and month strings in the exported
946 document by setting the default language and country either using
947 the application UI or through a custom styles file.
949 See `org-odt--build-date-styles' for implementation details."
956 \f
957 ;;; Internal functions
959 ;;;; Date
974 ;; LibreOffice does not care about end goes as content
975 ;; within the "<text:date>...</text:date>" field. The
976 ;; displayed date is automagically corrected to match the
977 ;; format requested by "style:data-style-name" attribute. So
978 ;; don't bother about formatting the date contents to be
979 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
980 ;; simple Org-style date should suffice.
1005 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1006 iso-date style date)
1008 repeater)))))
1010 ;;;; Frame
1018 extra
1024 style frame-attrs
1036 ;;;; Library wrappers
1043 ;; This is shamelessly stolen from `archive-zip-extract'.
1049 name)))
1054 exit-code command-output)
1063 ;;;; Target
1072 ;;;; Textbox
1075 extra anchor-type)
1081 text)
1082 width nil style extra anchor-type))
1086 ;;;; Table of Contents
1089 "Return a table of contents.
1090 TITLE is the title of the table, as a string, or nil. ENTRIES is
1091 the contents of the table, as a string. DEPTH is an integer
1092 specifying the depth of the table."
1094 "
1095 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1099 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1100 "
1101 title))
1107 "
1108 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1110 <text:index-entry-chapter/>
1111 <text:index-entry-text/>
1112 <text:index-entry-link-end/>
1115 "
1116 </text:table-of-content-source>
1117 <text:index-body>"
1123 title))
1124 entries
1125 "
1126 </text:index-body>
1133 headline-label
1135 ;; Section number.
1137 ;; Todo.
1142 style todo)))
1147 style priority)))
1148 ;; Title.
1149 text
1150 ;; Tags.
1154 "OrgTags"
1162 "Build a table of contents.
1163 DEPTH is an integer specifying the depth of the table. INFO is
1164 a plist containing current export properties. Optional argument
1165 SCOPE, when non-nil, defines the scope of the table. Return the
1166 table of contents as a string, or nil."
1168 ;; When a headline is marked as a radio target, as in the example below:
1169 ;;
1170 ;; ** <<<Some Heading>>>
1171 ;; Some text.
1172 ;;
1173 ;; suppress generation of radio targets. i.e., Radio targets are to
1174 ;; be marked as targets within /document body/ and *not* within
1175 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1176 ;; and one in the document body.
1177 ;;
1178 ;; Likewise, links, footnote references and regular targets are also
1179 ;; suppressed.
1197 style entry)))
1199 depth))))
1202 ;;;; Document styles
1205 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1206 OBJECT-PROPS is (typically) a plist created by passing
1208 `org-odt-parse-block-attributes'.
1210 Use `org-odt-object-counters' to generate an automatic
1211 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1212 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1213 . STYLE-NAME)."
1229 ;;;; Checkbox
1232 "Return check-box string associated to ITEM."
1241 ;;; Template
1244 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1245 ;; to modify the date fields. A date could be modified by
1246 ;; offsetting in days. That's about it. Also, date and time may
1247 ;; have to be emitted as two fields - a date field and a time field
1248 ;; - separately.
1250 ;; One can add Form Controls to date and time fields so that they
1251 ;; can be easily modified. But then, the exported document will
1252 ;; become tightly coupled with LibreOffice and may not function
1253 ;; properly with other OpenDocument applications.
1255 ;; I have a strange feeling that Date styles are a bit flaky at the
1256 ;; moment.
1258 ;; The feature is experimental.
1302 ))
1311 filler-end))
1322 style
1325 output ))))
1328 "Return complete document string after ODT conversion.
1329 CONTENTS is the transcoded contents string. RAW-DATA is the
1330 original parsed data. INFO is a plist holding export options."
1331 ;; Write meta file.
1341 <office:document-meta
1351 ;; Date, if required.
1353 ;; Check if DATE is specified as an Org-timestamp. If yes,
1354 ;; include it as meta information. Otherwise, just use
1355 ;; today's date.
1364 iso-date)))))
1373 subtitle))
1377 ;; Add meta.xml in to manifest.
1380 ;; Update styles file.
1381 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1382 ;; Write styles file.
1385 ;; Non-availability of styles.xml is not a critical
1386 ;; error. For now, throw an error.
1390 org-odt-styles-dir)
1413 ;; create a manifest entry for styles.xml
1416 ;; FIXME: Who is opening an empty styles.xml before this point?
1421 ;; Write custom styles for source blocks
1422 ;; Save STYLES used for colorizing of source blocks.
1423 ;; Update styles.xml with styles that were collected as part of
1424 ;; `org-odt-hfy-face-to-css' callbacks.
1433 ;; Update styles.xml - take care of outline numbering
1435 ;; Don't make automatic backup of styles.xml file. This setting
1436 ;; prevents the backed-up styles.xml file from being zipped in to
1437 ;; odt file. This is more of a hackish fix. Better alternative
1438 ;; would be to fix the zip command so that the output odt file
1439 ;; includes only the needed files and excludes any auto-generated
1440 ;; extra files like backups and auto-saves etc etc. Note that
1441 ;; currently the zip command zips up the entire temp directory so
1442 ;; that any auto-generated files created under the hood ends up in
1443 ;; the resulting odt file.
1446 ;; Outline numbering is retained only upto LEVEL.
1447 ;; To disable outline numbering pass a LEVEL of 0.
1460 ;; Update content.xml.
1463 ;; within the context of the Org buffer. So obtain its
1464 ;; value before moving on to temp-buffer context down below.
1474 org-odt-styles-dir)))
1475 ;; Write automatic styles.
1476 ;; - Position the cursor.
1480 ;; - Dump automatic table styles.
1485 ;; - Dump date-styles.
1491 ;; Update display level.
1492 ;; - Remove existing sequence decls. Also position the cursor.
1497 ;; Update sequence decls according to user preference.
1508 ;; Position the cursor to document body.
1513 ;; Preamble - Title, Author, Date etc.
1523 ;; Switch on or off above vars based on user settings
1527 ;; Title.
1532 ;; Separator.
1534 ;; Subtitle.
1540 subtitle
1542 ;; Separator.
1546 ;; Author only.
1549 "OrgSubtitle"
1551 ;; Separator.
1554 ;; Author and E-mail.
1558 "OrgSubtitle"
1563 ;; Separator.
1565 ;; Date, if required.
1568 ;; Check if DATE is specified as a timestamp.
1575 "OrgSubtitle"
1579 ;; Separator
1581 ;; Table of Contents
1584 with-toc
1587 ;; Contents.
1589 ;; Return contents.
1593 \f
1594 ;;; Transcode Functions
1596 ;;;; Bold
1599 "Transcode BOLD from Org to ODT.
1600 CONTENTS is the text with bold markup. INFO is a plist holding
1601 contextual information."
1606 ;;;; Center Block
1609 "Transcode a CENTER-BLOCK element from Org to ODT.
1610 CONTENTS holds the contents of the center block. INFO is a plist
1611 holding contextual information."
1612 contents)
1615 ;;;; Clock
1618 "Transcode a CLOCK element from Org to ODT.
1619 CONTENTS is nil. INFO is a plist used as a communication
1620 channel."
1633 ;;;; Code
1636 "Transcode a CODE object from Org to ODT.
1637 CONTENTS is nil. INFO is a plist used as a communication
1638 channel."
1644 ;;;; Drawer
1647 "Transcode a DRAWER element from Org to ODT.
1648 CONTENTS holds the contents of the block. INFO is a plist
1649 holding contextual information."
1652 name contents)))
1653 output))
1656 ;;;; Dynamic Block
1659 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1660 CONTENTS holds the contents of the block. INFO is a plist
1661 holding contextual information. See `org-export-data'."
1662 contents)
1665 ;;;; Entity
1668 "Transcode an ENTITY object from Org to ODT.
1669 CONTENTS are the definition itself. INFO is a plist holding
1670 contextual information."
1674 ;;;; Example Block
1677 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1678 CONTENTS is nil. INFO is a plist holding contextual information."
1682 ;;;; Export Snippet
1685 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1686 CONTENTS is nil. INFO is a plist holding contextual information."
1691 ;;;; Export Block
1694 "Transcode a EXPORT-BLOCK element from Org to ODT.
1695 CONTENTS is nil. INFO is a plist holding contextual information."
1700 ;;;; Fixed Width
1703 "Transcode a FIXED-WIDTH element from Org to ODT.
1704 CONTENTS is nil. INFO is a plist holding contextual information."
1708 ;;;; Footnote Definition
1710 ;; Footnote Definitions are ignored.
1713 ;;;; Footnote Reference
1716 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1717 CONTENTS is nil. INFO is a plist holding contextual information."
1725 id note-class
1737 "OrgSuperscript"
1738 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1739 note-class ref-format ref-name n))))))
1741 ;; Insert separator between two footnotes in a row.
1746 ;; Transcode footnote reference.
1754 footnote-reference info))
1758 raw
1761 :transcoders
1764 p c i
1765 "Footnote"
1766 "OrgFootnoteCenter"
1768 info))))
1769 ;; Inline definitions are secondary strings. We
1770 ;; need to wrap them within a paragraph.
1772 org-element-all-elements)
1773 def
1776 def)))))
1780 ;;;; Headline
1783 &optional format-function
1785 "Transcode a HEADLINE element using BACKEND.
1786 INFO is a plist holding contextual information."
1809 &key _level _section-number _headline-label
1812 todo todo-type priority text tags))))))
1814 todo todo-type priority text tags
1815 :headline-label headline-label
1816 :level level
1820 "Transcode a HEADLINE element from Org to ODT.
1821 CONTENTS holds the contents of the headline. INFO is a plist
1822 holding contextual information."
1823 ;; Case 1: This is a footnote section: ignore it.
1826 ;; Get level relative to current parsed data.
1829 ;; Get canonical label for the headline.
1831 ;; Extra targets.
1835 ;; Title.
1838 ;; Case 2. This is a deep sub-tree: export it as a list item.
1839 ;; Also export as items headlines for which no section
1840 ;; format has been found.
1842 ;; Build the real contents of the sub-tree.
1846 ;; Choose style based on list type.
1848 ;; If top-level list, re-start numbering. Otherwise,
1849 ;; continue numbering.
1852 headline)))
1862 "Text_20_body"
1864 contents)
1866 "</text:list-header>"
1870 ;; Case 3. Standard headline. Export it as a section.
1874 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1877 level
1880 contents))))))
1884 "Default format function for a headline.
1885 See `org-odt-format-headline-function' for details."
1887 ;; Todo.
1895 style priority)))
1896 ;; Title.
1897 text
1898 ;; Tags.
1901 "<text:tab/>"
1910 ;;;; Horizontal Rule
1913 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1914 CONTENTS is nil. INFO is a plist holding contextual information."
1919 ;;;; Inline Babel Call
1921 ;; Inline Babel Calls are ignored.
1924 ;;;; Inline Src Block
1927 "Return a character not used in string S.
1929 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1935 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1936 CONTENTS holds the contents of the item. INFO is a plist holding
1937 contextual information."
1941 ;;;; Inlinetask
1944 "Transcode an INLINETASK element from Org to ODT.
1945 CONTENTS holds the contents of the block. INFO is a plist
1946 holding contextual information."
1958 todo todo-type priority text tags contents)))
1962 "Default format function for a inlinetasks.
1963 See `org-odt-format-inlinetask-function' for details."
1965 "Text_20_body"
1969 "OrgInlineTaskHeading"
1971 todo todo-type priority name tags))
1972 contents)
1975 ;;;; Italic
1978 "Transcode ITALIC from Org to ODT.
1979 CONTENTS is the text with italic markup. INFO is a plist holding
1980 contextual information."
1985 ;;;; Item
1988 "Transcode an ITEM element from Org to ODT.
1989 CONTENTS holds the contents of the item. INFO is a plist holding
1990 contextual information."
1996 contents
1998 "</text:list-header>"
2001 ;;;; Keyword
2004 "Transcode a KEYWORD element from Org to ODT.
2005 CONTENTS is nil. INFO is a plist holding contextual
2006 information."
2012 ;; FIXME
2024 ;; FIXME
2028 ;;;; Latex Environment
2031 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2032 ;; (defadvice org-format-latex-as-mathml ; FIXME
2033 ;; (after org-odt-protect-latex-fragment activate)
2034 ;; "Encode LaTeX fragment as XML.
2035 ;; Do this when translation to MathML fails."
2036 ;; (unless (> (length ad-return-value) 0)
2037 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2040 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2041 CONTENTS is nil. INFO is a plist holding contextual information."
2047 ;;;; Latex Fragment
2049 ;; (when latex-frag ; FIXME
2050 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2051 ;; :description latex-frag)))
2052 ;; handle verbatim
2053 ;; provide descriptions
2056 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2057 CONTENTS is nil. INFO is a plist holding contextual information."
2063 ;;;; Line Break
2066 "Transcode a LINE-BREAK object from Org to ODT.
2067 CONTENTS is nil. INFO is a plist holding contextual information."
2071 ;;;; Link
2073 ;;;; Links :: Label references
2083 x))))
2093 counter))
2096 element
2098 info))
2102 ;; Section number.
2106 ;; Separator.
2108 ;; Ordinal.
2110 tag))
2113 "Return a label for ELEMENT.
2115 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2116 element. INFO is a plist used as a communication channel. OP is
2117 either `definition' or `reference', depending on the purpose of
2118 the generated string.
2120 Return value is a string if OP is set to `reference' or a cons
2121 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2122 SHORT-CAPTION are strings."
2128 ;; Get label and caption.
2134 ;; FIXME: We don't use short-caption for now
2150 element))))
2153 seqno)
2157 ;; Compute sequence number of the element.
2159 ;; Localize category string.
2162 ;; Case 1: Handle Label definition.
2166 ;; Sneak in a bookmark. The bookmark is used when the
2167 ;; labeled element is referenced with a link that
2168 ;; provides its own description.
2170 ;; Label definition: Typically formatted as below:
2171 ;; CATEGORY SEQ-NO: LONG CAPTION
2172 ;; with translation for correct punctuation.
2179 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2180 label counter counter seqno))
2182 short-caption))
2183 ;; Case 2: Handle Label reference.
2188 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2189 fmt1
2190 label
2195 ;;;; Links :: Inline Images
2198 "Returns the internal name of the file"
2214 target-file))
2237 ;; Use Imagemagick.
2242 file))))
2247 ;; Use Emacs.
2253 ;; Use hard-coded values.
2255 org-odt-default-image-sizes-alist))
2256 ;; Error out.
2269 ;; ensure that an embedded image fits comfortably within a page
2280 "Return ODT code for an inline image.
2281 LINK is the link pointing to the inline image. INFO is a plist
2282 used as a communication channel."
2295 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2297 ;; Extract attributes from #+ATTR_ODT line.
2301 ;; Convert attributes to a plist.
2303 ;; Handle `:anchor', `:style' and `:attributes' properties.
2313 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2314 ;;
2315 ;; Handle `:width', `:height' and `:scale' properties. Read
2316 ;; them as numbers since we need them for computations.
2318 src-expanded info
2325 nil ; embed-as
2327 ))
2334 ;; Check if this link was created by LaTeX-to-PNG converter.
2338 ;; If yes, note down the type of the element - LaTeX Fragment
2339 ;; or LaTeX environment. It will go in to frame title.
2343 ;; If yes, note down its contents. It will go in to frame
2344 ;; description. This quite useful for debugging.
2347 captions user-frame-params title desc)))
2350 ;;;; Links :: Math formula
2369 ;; Check if this link was created by LaTeX-to-MathML
2370 ;; converter.
2374 ;; If yes, note down the type of the element - LaTeX Fragment
2375 ;; or LaTeX environment. It will go in to frame title.
2379 ;; If yes, note down its contents. It will go in to frame
2380 ;; description. This quite useful for debugging.
2382 width height)
2386 nil nil title desc))
2389 "CaptionedDisplayFormula" href width height
2390 captions nil title desc))
2394 org-odt--enumerable-formula-p))))
2399 "Returns the internal name of the file"
2403 ;; Create a directory for holding formula file. Also enter it in
2404 ;; to manifest.
2408 ;; Copy over the formula file from user directory to zip
2409 ;; directory.
2413 ;; Case 1: Mathml.
2416 ;; Case 2: OpenDocument formula.
2421 ;; Enter the formula file in to manifest.
2423 target-file))
2425 ;;;; Targets
2428 captions user-frame-params
2431 ;; Each element of this alist is of the form (CFG-HANDLE
2432 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2434 ;; CFG-HANDLE is the key to the alist.
2436 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2437 ;; frame params for INNER-FRAME and OUTER-FRAME
2438 ;; respectively. See below.
2440 ;; Configurations that are meant to be applied to
2441 ;; non-captioned image/formula specifies no
2442 ;; OUTER-FRAME-PARAMS.
2444 ;; TERMINOLOGY
2445 ;; ===========
2446 ;; INNER-FRAME :: Frame that directly surrounds an
2447 ;; image/formula.
2449 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2450 ;; frame also contains the caption, if any.
2452 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2453 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2454 ;; that these are the last three arguments
2455 ;; to `org-odt--frame'.
2457 ;; Note that an un-captioned image/formula requires just an
2458 ;; INNER-FRAME, while a captioned image/formula requires
2459 ;; both an INNER and an OUTER-FRAME.
2481 ;; Retrieve inner and outer frame params, from configuration.
2485 ;; User-specified frame params (from #+ATTR_ODT spec)
2489 "Merge default and user frame params."
2494 for d in default
2497 ;; Case 1: Image/Formula has no caption.
2498 ;; There is only one frame, one that surrounds the image
2499 ;; or formula.
2501 ;; Merge user frame params with that from configuration.
2505 ;; Case 2: Image/Formula is captioned or labeled.
2506 ;; There are two frames: The inner one surrounds the
2507 ;; image or formula. The outer one contains the
2508 ;; caption/sequence number.
2510 ;; Merge user frame params with outer frame params.
2512 ;; Short caption, if specified, goes as part of inner frame.
2519 frame-params))
2522 "Illustration"
2526 caption))
2527 width height outer)))))
2530 ;; Element should have a caption or label.
2536 element info
2537 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2538 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2539 ;; processing.)
2544 ;; Link should point to an image file.
2551 element info
2552 ;; Paragraph should have a caption or label. It SHOULD also be a
2553 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2554 ;; processing.)
2559 ;; Link should point to an image file.
2566 element info
2567 ;; Paragraph should have a caption or label.
2571 ;; Link should point to a MathML or ODF file.
2577 paragraph-predicate
2578 link-predicate)
2579 "Test if ELEMENT is a standalone link for the purpose ODT export.
2580 INFO is a plist holding contextual information.
2582 Return non-nil, if ELEMENT is of type paragraph satisfying
2583 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2584 is a link that satisfies LINK-PREDICATE.
2586 Return non-nil, if ELEMENT is of type link satisfying
2587 LINK-PREDICATE and its containing paragraph satisfies
2588 PARAGRAPH-PREDICATE in addition to having no other content save for
2589 leading and trailing whitespaces.
2591 Return nil, otherwise."
2614 ;; DESTINATION is a headline or an element (like paragraph,
2615 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2617 ;; Note that labels that are attached to captioned entities - inline
2618 ;; images, math formulae and tables - get resolved as part of
2619 ;; `org-odt-format-label' and `org-odt--enumerate'.
2621 ;; Create a cross-reference to DESTINATION but make best-efforts to
2622 ;; create a *meaningful* description. Check item numbers, section
2623 ;; number and section title in that order.
2625 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2626 ;; FIXME: Handle footnote-definition footnote-reference?
2638 return x))
2639 ;; Get list item nos.
2644 plain-list)
2647 item info t))))))
2648 ;; Locate top-most listified headline.
2653 return x))
2654 ;; Get listified headline numbers.
2660 el info t)))))))
2661 ;; Combine item numbers from both the listified headlines and
2662 ;; regular list items.
2664 ;; Case 1: Check if all the parents of list item are numbered.
2665 ;; If yes, link to the item proper.
2668 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2669 label
2673 ;; Case 2: Locate a regular and numbered headline in the
2674 ;; hierarchy. Display its section number.
2677 ;; Test if destination is a numbered headline.
2683 return el))))
2684 ;; We found one.
2686 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2687 label
2690 ;; Case 4: Locate a regular headline in the hierarchy. Display
2691 ;; its title.
2695 return el)))
2696 ;; We found one.
2698 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2699 label
2705 "Transcode a LINK object from Org to ODT.
2707 DESC is the description part of the link, or the empty string.
2708 INFO is a plist holding contextual information. See
2709 `org-export-data'."
2712 ;; Ensure DESC really exists, or set it to nil.
2721 ;; Convert & to & for correct XML representation
2724 ;; Link type is handled by a special function.
2726 ;; Image file.
2728 ;; Formula file.
2733 ;; Radio target: Transcode target's contents and use them as
2734 ;; link's description.
2739 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2741 desc))))
2742 ;; Links pointing to a headline: Find destination and build
2743 ;; appropriate referencing command.
2749 ;; Fuzzy link points to a headline. If there's
2750 ;; a description, create a hyperlink. Otherwise, try to
2751 ;; provide a meaningful description.
2760 label desc))))
2761 ;; Fuzzy link points to a target. If there's a description,
2762 ;; create a hyperlink. Otherwise, try to provide
2763 ;; a meaningful description.
2768 ;; Fuzzy link points to some element (e.g., an inline image,
2769 ;; a math formula or a table).
2777 ;; LINK has no description. Create
2778 ;; a cross-reference showing entity's sequence
2779 ;; number.
2781 ;; LINK has description. Insert a hyperlink with
2782 ;; user-provided description.
2787 desc))))))))
2788 ;; Coderef: replace link with the reference name or the
2789 ;; equivalent line number.
2796 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2797 href line-no))))
2798 ;; External link with a description part.
2801 ;; Check if description is a link to an inline image.
2806 desc-element
2808 ;; Format link as a clickable image.
2810 path desc)
2811 ;; Otherwise, format it as a regular link.
2813 path desc))))
2814 ;; External link without a description part.
2817 path path))
2818 ;; No path, only description. Try to do something useful.
2823 ;;;; Node Property
2826 "Transcode a NODE-PROPERTY element from Org to ODT.
2827 CONTENTS is nil. INFO is a plist holding contextual
2828 information."
2835 ;;;; Paragraph
2838 "Return style of PARAGRAPH.
2839 Style is a symbol among `quoted', `centered' and nil."
2849 "Format paragraph according to given styles.
2850 PARAGRAPH is a paragraph type element. CONTENTS is the
2851 transcoded contents of that paragraph, as a string. INFO is
2852 a plist used as a communication channel. DEFAULT, CENTER and
2853 QUOTE are, respectively, style to use when paragraph belongs to
2854 no special environment, a center block, or a quote block."
2860 ;; If PARAGRAPH is a leading paragraph in an item that has
2861 ;; a checkbox, splice checkbox and paragraph contents
2862 ;; together.
2867 contents)))
2870 "Transcode a PARAGRAPH element from Org to ODT.
2871 CONTENTS is the contents of the paragraph, as a string. INFO is
2872 the plist used as a communication channel."
2874 paragraph contents info
2876 "OrgCenter"
2880 ;;;; Plain List
2883 "Transcode a PLAIN-LIST element from Org to ODT.
2884 CONTENTS is the contents of the list. INFO is a plist holding
2885 contextual information."
2887 ;; Choose style based on list type.
2893 ;; If top-level list, re-start numbering. Otherwise,
2894 ;; continue numbering.
2899 contents))
2901 ;;;; Plain Text
2914 line))
2923 "Transcode a TEXT string from Org to ODT.
2924 TEXT is the string to transcode. INFO is a plist holding
2925 contextual information."
2927 ;; Protect &, < and >.
2929 ;; Handle smart quotes. Be sure to provide original string since
2930 ;; OUTPUT may have been modified.
2933 ;; Convert special strings.
2938 ;; Handle break preservation if required.
2942 ;; Return value.
2943 output))
2946 ;;;; Planning
2949 "Transcode a PLANNING element from Org to ODT.
2950 CONTENTS is nil. INFO is a plist used as a communication
2951 channel."
2953 "OrgPlanning"
2975 ;;;; Property Drawer
2978 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2979 CONTENTS holds the contents of the drawer. INFO is a plist
2980 holding contextual information."
2983 contents)))
2986 ;;;; Quote Block
2989 "Transcode a QUOTE-BLOCK element from Org to ODT.
2990 CONTENTS holds the contents of the block. INFO is a plist
2991 holding contextual information."
2992 contents)
2995 ;;;; Section
3000 style
3002 text)))
3006 "Transcode a SECTION element from Org to ODT.
3007 CONTENTS holds the contents of the section. INFO is a plist
3008 holding contextual information."
3009 contents)
3011 ;;;; Radio Target
3014 "Transcode a RADIO-TARGET object from Org to ODT.
3015 TEXT is the text of the target. INFO is a plist holding
3016 contextual information."
3020 ;;;; Special Block
3023 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3024 CONTENTS holds the contents of the block. INFO is a plist
3025 holding contextual information."
3029 ;; Annotation.
3035 ;; FIXME: Is `car' right thing to do below?
3045 contents)))))
3046 ;; Textbox.
3055 style extra anchor))))
3059 ;;;; Src Block
3062 "Create custom style for face FN.
3063 When FN is the default face, use its foreground and background
3065 use its color attribute to create a character style whose name
3066 is obtained from FN. Currently all attributes of FN other than
3067 color are ignored.
3069 The style name for a face FN is derived using the following
3070 operations on the face name in that order - de-dash, CamelCase
3072 `font-lock-function-name-face' is associated with
3086 background-color-val color-val))
3089 "
3136 code
3147 par-style loc))
3150 num-start refs))
3164 ;; Extract code and references.
3168 ;; Does the src block contain labels?
3170 ;; Does it have line numbers?
3177 "Transcode a SRC-BLOCK element from Org to ODT.
3178 CONTENTS holds the contents of the item. INFO is a plist holding
3179 contextual information."
3189 "Text_20_body"
3193 ;;;; Statistics Cookie
3196 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3197 CONTENTS is nil. INFO is a plist holding contextual information."
3203 ;;;; Strike-Through
3206 "Transcode STRIKE-THROUGH from Org to ODT.
3207 CONTENTS is the text with strike-through markup. INFO is a plist
3208 holding contextual information."
3213 ;;;; Subscript
3216 "Transcode a SUBSCRIPT object from Org to ODT.
3217 CONTENTS is the contents of the object. INFO is a plist holding
3218 contextual information."
3223 ;;;; Superscript
3226 "Transcode a SUPERSCRIPT object from Org to ODT.
3227 CONTENTS is the contents of the object. INFO is a plist holding
3228 contextual information."
3233 ;;;; Table Cell
3242 "Retrieve styles applicable to a table cell.
3243 R and C are (zero-based) row and column numbers of the table
3244 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3245 applicable to the current table. It is nil if the table is not
3246 associated with any style attributes.
3248 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3250 When STYLE-SPEC is nil, style the table cell the conventional way
3251 - choose cell borders based on row and column groupings and
3252 choose paragraph alignment based on `org-col-cookies' text
3253 property. See also
3254 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3256 When STYLE-SPEC is non-nil, ignore the above cookie and return
3257 styles congruent with the ODF-1.2 specification."
3263 info)))
3265 ;; LibreOffice - particularly the Writer - honors neither table
3266 ;; templates nor custom table-cell styles. Inorder to retain
3267 ;; inter-operability with LibreOffice, only automatic styles are
3268 ;; used for styling of table-cells. The current implementation is
3269 ;; congruent with ODF-1.2 specification and hence is
3270 ;; future-compatible.
3272 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3273 ;; which recognizes as many as 16 different cell types - is much
3274 ;; richer. Unfortunately it is NOT amenable to easy configuration
3275 ;; by hand.
3302 "Transcode a TABLE-CELL element from Org to ODT.
3303 CONTENTS is nil. INFO is a plist used as a communication
3304 channel."
3311 table-cell info))
3334 table-cell info))))))
3338 custom-style-prefix))
3340 "OrgTblCell"
3356 cell-attributes
3359 org-element-all-elements)
3360 contents
3362 paragraph-style contents))))
3369 ;;;; Table Row
3372 "Transcode a TABLE-ROW element from Org to ODT.
3373 CONTENTS is the contents of the row. INFO is a plist used as a
3374 communication channel."
3375 ;; Rules are ignored since table separators are deduced from
3376 ;; borders of the current row.
3382 ;; If the row belongs to the first rowgroup and the
3383 ;; table has more than one row groups, then this row
3384 ;; belongs to the header row group.
3386 ;; Otherwise, it belongs to non-header row group.
3389 ;; Does this row begin a rowgroup?
3392 ;; Actual table row
3394 ;; Does this row end a rowgroup?
3399 ;;;; Table
3412 "Transcode a TABLE element from Org to ODT.
3413 CONTENTS is the contents of the table. INFO is a plist holding
3414 contextual information."
3416 ;; Case 1: table.el doesn't support export to OD format. Strip
3417 ;; such tables from export.
3422 "(ox-odt): Found table.el-type table in the source Org file."
3423 " table.el doesn't support export to ODT format."
3425 ;; Case 2: Native Org tables.
3441 column-style))
3442 out)
3446 ;; caption.
3450 ;; begin table.
3458 ;; column specification.
3460 ;; actual contents.
3462 ;; end table.
3466 "Transcode a TABLE element from Org to ODT.
3467 CONTENTS is the contents of the table. INFO is a plist holding
3468 contextual information.
3470 Use `org-odt--table' to typeset the table. Handle details
3471 pertaining to indentation here."
3486 collect el)))
3492 collect
3497 parent-list)
3499 ;; Handle list genealogy.
3519 parent-list info)
3522 ;; Handle low-level headlines.
3524 with step = 'item collect
3532 el info)
3533 "OrgNumberedList"
3544 parent-list info)))
3552 table info)))
3553 ;; OpenDocument schema does not permit table to occur within a
3554 ;; list item.
3556 ;; One solution - the easiest and lightweight, in terms of
3557 ;; implementation - is to put the table in an indented text box
3558 ;; and make the text box part of the list-item. Unfortunately if
3559 ;; the table is big and spans multiple pages, the text box could
3560 ;; overflow. In this case, the following attribute will come
3561 ;; handy.
3563 ;; ,---- From OpenDocument-v1.1.pdf
3564 ;; | 15.27.28 Overflow behavior
3565 ;; |
3566 ;; | For text boxes contained within text document, the
3567 ;; | style:overflow-behavior property specifies the behavior of text
3568 ;; | boxes where the containing text does not fit into the text
3569 ;; | box.
3570 ;; |
3571 ;; | If the attribute's value is clip, the text that does not fit
3572 ;; | into the text box is not displayed.
3573 ;; |
3574 ;; | If the attribute value is auto-create-new-frame, a new frame
3575 ;; | will be created on the next page, with the same position and
3576 ;; | dimensions of the original frame.
3577 ;; |
3578 ;; | If the style:overflow-behavior property's value is
3579 ;; | auto-create-new-frame and the text box has a minimum width or
3580 ;; | height specified, then the text box will grow until the page
3581 ;; | bounds are reached before a new frame is created.
3582 ;; `----
3584 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3585 ;; auto-create-new-frame property and always resorts to clipping
3586 ;; the text box. This results in table being truncated.
3588 ;; So we solve the problem the hard (and fun) way using list
3589 ;; continuations.
3591 ;; The problem only becomes more interesting if you take in to
3592 ;; account the following facts:
3593 ;;
3594 ;; - Description lists are simulated as plain lists.
3595 ;; - Low-level headlines can be listified.
3596 ;; - In Org-mode, a table can occur not only as a regular list
3597 ;; item, but also within description lists and low-level
3598 ;; headlines.
3600 ;; See `org-odt-translate-description-lists' and
3601 ;; `org-odt-translate-low-level-headlines' for how this is
3602 ;; tackled.
3605 ;; Discontinue the list.
3607 ;; Put the table in an indented section.
3612 ;; Continue the list.
3616 ;;;; Target
3619 "Transcode a TARGET object from Org to ODT.
3620 CONTENTS is nil. INFO is a plist holding contextual
3621 information."
3625 ;;;; Timestamp
3628 "Transcode a TIMESTAMP object from Org to ODT.
3629 CONTENTS is nil. INFO is a plist used as a communication
3630 channel."
3646 "OrgActiveTimestamp"
3650 "OrgInactiveTimestamp"
3654 "OrgActiveTimestamp"
3660 "OrgInactiveTimestamp"
3666 "OrgDiaryTimestamp"
3668 info)))))))
3671 ;;;; Underline
3674 "Transcode UNDERLINE from Org to ODT.
3675 CONTENTS is the text with underline markup. INFO is a plist
3676 holding contextual information."
3681 ;;;; Verbatim
3684 "Transcode a VERBATIM object from Org to ODT.
3685 CONTENTS is nil. INFO is a plist used as a communication
3686 channel."
3692 ;;;; Verse Block
3695 "Transcode a VERSE-BLOCK element from Org to ODT.
3696 CONTENTS is verse block contents. INFO is a plist holding
3697 contextual information."
3698 ;; Add line breaks to each line of verse.
3702 ;; Replace tabs and spaces.
3704 ;; Surround it in a verse environment.
3709 \f
3710 ;;; Filters
3712 ;;;; LaTeX fragments
3717 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3718 ;; If the desired converter is not available, force verbatim
3719 ;; processing.
3737 ;; Store normalized value for later use.
3742 ;; Convert `latex-fragment's and `latex-environment's.
3761 ;; Get an Org-style link to PNG image or the MathML
3762 ;; file.
3767 nil display-msg
3768 nil processing-type)
3773 nil))))
3775 ;; Conversion succeeded. Parse above Org-style link to
3776 ;; a `link' object.
3783 ;; Case 1: LaTeX environment. Mimic
3784 ;; a "standalone image or formula" by
3785 ;; enclosing the `link' in a `paragraph'.
3786 ;; Copy over original attributes, captions to
3787 ;; the enclosing paragraph.
3792 :name
3794 :caption
3796 link))
3797 ;; Case 2: LaTeX fragment. No special action.
3799 ;; Note down the object that link replaces.
3803 ;; Restore blank after initial element or object.
3805 replacement :post-blank
3807 ;; Replace now.
3809 info nil nil t)))
3810 tree)
3813 ;;;; Description lists
3815 ;; This translator is necessary to handle indented tables in a uniform
3816 ;; manner. See comment in `org-odt--table'.
3819 ;; OpenDocument has no notion of a description list. So simulate it
3820 ;; using plain lists. Description lists in the exported document
3821 ;; are typeset in the same manner as they are in a typical HTML
3822 ;; document.
3823 ;;
3824 ;; Specifically, a description list like this:
3825 ;;
3826 ;; ,----
3827 ;; | - term-1 :: definition-1
3828 ;; | - term-2 :: definition-2
3829 ;; `----
3830 ;;
3831 ;; gets translated in to the following form:
3832 ;;
3833 ;; ,----
3834 ;; | - term-1
3835 ;; | - definition-1
3836 ;; | - term-2
3837 ;; | - definition-2
3838 ;; `----
3839 ;;
3840 ;; Further effect is achieved by fixing the OD styles as below:
3841 ;;
3842 ;; 1. Set the :type property of the simulated lists to
3843 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3844 ;; that has *no* bullets whatsoever.
3845 ;;
3846 ;; 2. The paragraph containing the definition term is styled to be
3847 ;; in bold.
3848 ;;
3853 el
3869 nil)
3870 info)
3871 tree)
3873 ;;;; List tables
3875 ;; Lists that are marked with attribute `:list-table' are called as
3876 ;; list tables. They will be rendered as a table within the exported
3877 ;; document.
3879 ;; Consider an example. The following list table
3880 ;;
3881 ;; #+attr_odt :list-table t
3882 ;; - Row 1
3883 ;; - 1.1
3884 ;; - 1.2
3885 ;; - 1.3
3886 ;; - Row 2
3887 ;; - 2.1
3888 ;; - 2.2
3889 ;; - 2.3
3890 ;;
3891 ;; will be exported as though it were an Org table like the one show
3892 ;; below.
3893 ;;
3894 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3895 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3896 ;;
3897 ;; Note that org-tables are NOT multi-line and each line is mapped to
3898 ;; a unique row in the exported document. So if an exported table
3899 ;; needs to contain a single paragraph (with copious text) it needs to
3900 ;; be typed up in a single line. Editing such long lines using the
3901 ;; table editor will be a cumbersome task. Furthermore inclusion of
3902 ;; multi-paragraph text in a table cell is well-nigh impossible.
3903 ;;
3904 ;; A LIST-TABLE circumvents above problems.
3905 ;;
3906 ;; Note that in the example above the list items could be paragraphs
3907 ;; themselves and the list can be arbitrarily deep.
3908 ;;
3909 ;; Inspired by following thread:
3910 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3912 ;; Translate lists to tables
3918 ;; Replace list with table.
3920 l1-list
3921 ;; Build replacement table.
3927 l1-item-leading-text l2-list)
3928 ;; Remove Level-2 list from the Level-item. It
3929 ;; will be subsequently attached as table-cells.
3939 ;; Level-1 items start a table row.
3942 ;; Leading text of level-1 item define
3943 ;; the first table-cell.
3946 l1-item-leading-text)
3947 ;; Level-2 items define subsequent
3948 ;; table-cells of the row.
3956 nil)
3957 info)
3958 tree)
3960 \f
3961 ;;; Interactive functions
3974 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3989 ;; Initialize temporary workarea. All files that end up in
3990 ;; the exported document get parked/created here.
3996 ;; Kill all XML buffers.
4004 ;; Delete temporary directory and also other embedded
4005 ;; files that get copied there.
4010 ;; Not at all OSes ship with zip by default
4012 ;; Do export. This creates a bunch of xml files ready to be
4013 ;; saved and zipped.
4015 ;; Create a manifest entry for content.xml.
4017 ;; Write mimetype file
4026 ;; Write out the manifest entries before zipping
4028 ;; Save all XML files.
4034 ;; Prettify output if needed.
4038 ;; Run zip.
4043 ;; If a file with same name as the desired output file
4044 ;; exists, remove it.
4047 ;; Zip up the xml files.
4050 ;; Switch temporarily to content.xml. This way Zip
4051 ;; process will inherit `org-odt-zip-dir' as the current
4052 ;; directory.
4065 err-string)))))
4066 ;; Move the zip file from temporary work directory to
4067 ;; user-mandated location.
4070 ;; Cleanup work directory and work files.
4072 ;; Open the OpenDocument file in archive-mode for
4073 ;; examination.
4075 ;; Return exported file.
4077 ;; Case 1: Conversion desired on exported file. Run the
4078 ;; converter on the OpenDocument file. Return the
4079 ;; converted file.
4082 target))
4083 ;; Case 2: No further conversion. Return exported
4084 ;; OpenDocument file.
4087 ;; Cleanup work directory and work files.
4093 ;;;; Export to OpenDocument formula
4095 ;;;###autoload
4097 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4098 Use `org-create-math-formula' to convert LATEX-FRAG first to
4099 MathML. When invoked as an interactive command, use
4100 `org-latex-regexps' to infer LATEX-FRAG from currently active
4101 region. If no LaTeX fragments are found, prompt for it. Push
4102 MathML source to kill ring depending on the value of
4103 `org-export-copy-to-kill-ring'."
4129 filename
4142 ;; Add MathML to kill ring, if needed.
4146 ;;;###autoload
4148 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4149 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4150 formula file."
4155 ;;;; Export to OpenDocument Text
4157 ;;;###autoload
4159 "Export current buffer to a ODT file.
4161 If narrowing is active in the current buffer, only export its
4162 narrowed part.
4164 If a region is active, export that region.
4166 A non-nil optional argument ASYNC means the process should happen
4167 asynchronously. The resulting file should be accessible through
4168 the `org-export-stack' interface.
4170 When optional argument SUBTREEP is non-nil, export the sub-tree
4171 at point, extracting information from the headline properties
4172 first.
4174 When optional argument VISIBLE-ONLY is non-nil, don't export
4175 contents of hidden elements.
4177 EXT-PLIST, when provided, is a property list with external
4178 parameters overriding Org default settings, but still inferior to
4179 file-local settings.
4181 Return output file's name."
4188 ,outfile
4193 ;; Let `htmlfontify' know that we are interested in
4194 ;; collecting styles.
4196 ;; Initialize content.xml and kick-off the export
4197 ;; process.
4210 outfile
4215 ;; Let `htmlfontify' know that we are interested in collecting
4216 ;; styles.
4218 ;; Initialize content.xml and kick-off the export process.
4228 ;;;; Convert between OpenDocument and other formats
4231 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4240 "Workhorse routine for `org-odt-convert'."
4249 in-fmt out-fmt)))
4277 out-file)
4280 nil))))
4283 "Return verbose info about formats to which IN-FMT can be converted.
4284 Return a list where each element is of the
4285 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4286 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4287 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4291 org-odt-convert-processes t))))
4295 org-odt-convert-processes t))
4296 org-odt-convert-capabilities))
4297 reachable-formats)
4302 reachable-formats))
4305 "Return list of formats to which IN-FMT can be converted.
4306 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4313 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4314 This is a helper routine for interactive use."
4317 nil buffer-file-name t))
4323 out-fmt-choices nil nil nil))
4325 "No known converter or no known output formats for %s files"
4326 in-fmt))))
4329 ;;;###autoload
4331 "Convert IN-FILE to format OUT-FMT using a command line converter.
4332 IN-FILE is the file to be converted. If unspecified, it defaults
4333 to variable `buffer-file-name'. OUT-FMT is the desired output
4334 format. Use `org-odt-convert-process' as the converter. If OPEN
4335 is non-nil then the newly converted file is opened using
4336 `org-open-file'."
4341 ;;; Library Initializations
4344 ;; Let Emacs open all OpenDocument files in archive mode.
4350 ;; Local variables:
4351 ;; generated-autoload-file: "org-loaddefs.el"
4352 ;; End:
4354 ;;; ox-odt.el ends here