| blob | e6eac8cc761a4540cab61756135e10f8532faea5 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2017 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
34 ;;; Define Back-End
87 org-odt--translate-description-lists
88 org-odt--translate-list-tables)))
89 :menu-entry
96 :options-alist
101 ;; Other variables.
114 ;; Redefine regular option.
116 ;; Retrieve LaTeX header for fragments.
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
199 org-odt-styles-dir-list)))
202 styles-dir)
203 "Directory that holds auxiliary XML files used by the ODT exporter.
205 This directory contains the following XML files -
207 XML files are used as the default values of
208 `org-odt-styles-file' and `org-odt-content-template-file'.
210 The default value of this variable varies depending on the
211 version of Org in use and is initialized from
212 `org-odt-styles-dir-list'. Note that the user could be using Org
213 from one of: Org own private git repository, GNU ELPA tar or
236 "
238 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
239 </style:style>
240 "
244 "Registry of automatic styles for various OBJECT-TYPEs.
245 The variable has the following form:
246 ((OBJECT-TYPE-A
247 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
248 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
249 (OBJECT-TYPE-B
250 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
251 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
252 ...).
255 OBJECT-PROPS is (typically) a plist created by passing
261 "Running counters for various OBJECT-TYPEs.
262 Use this to generate automatic names and style-names. See
266 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
267 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
268 <style:background-image/>
269 </style:paragraph-properties>
271 </style:style>"
272 "Custom paragraph style for colorized source and example blocks.
274 except that the foreground and background colors are set
288 "Hardcoded image dimensions one for each of the anchor
291 ;; A4 page size is 21.0 by 29.7 cms
292 ;; The default page settings has 2cm margin on each of the sides. So
293 ;; the effective text area is 17.0 by 25.7 cm
302 "Specify how labels are applied and referenced.
304 This is an alist where each element is of the form:
306 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
308 ATTACH-FMT controls how labels and captions are attached to an
309 entity. It may contain following specifiers - %e and %c. %e is
310 replaced with the CATEGORY-NAME. %n is replaced with
312 with CAPTION.
314 REF-MODE and REF-FMT controls how label references are generated.
315 The following XML is generated for a label reference -
318 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
319 %n is replaced with SEQNO.
329 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
331 This is a list where each entry is of the form:
333 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
335 CATEGORY_HANDLE identifies the captionable entity in question.
337 OD-VARIABLE is the OpenDocument sequence counter associated with
338 the entity. These counters are declared within
340 `org-odt-content-template-file'.
342 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
343 how a given entity should be captioned and referenced.
345 CATEGORY-NAME is used for qualifying captions on export.
347 ENUMERATOR-PREDICATE is used for assigning a sequence number to
357 \f
358 ;;; User Configuration Variables
361 "Options for exporting Org mode files to ODT."
366 ;;;; Debugging
369 "Specify whether or not the xml output should be prettified.
370 When this option is turned on, `indent-region' is run on all
371 component xml buffers before they are saved. Turn this off for
372 regular use. Turn this on if you need to examine the xml
373 visually."
379 ;;;; Document schema
390 org-odt-schema-dir-list)
391 "Directory that contains OpenDocument schema files.
393 This directory contains:
394 1. rnc files for OpenDocument schema
396 for auto validation of OpenDocument XML files.
398 Use the customize interface to set this variable. This ensures
399 that `rng-schema-locating-files' is updated and auto-validation
400 of OpenDocument XML takes place based on the value
401 `rng-nxml-auto-validate-flag'.
403 The default value of this variable varies depending on the
404 version of org in use and is initialized from
405 `org-odt-schema-dir-list'. The OASIS schema files are available
406 only in the org's private git repository. It is *not* bundled
407 with GNU ELPA tar or standard Emacs distribution."
413 :set
415 "Set `org-odt-schema-dir'.
416 Also add it to `rng-schema-locating-files'."
426 schema-dir
429 value))
430 nil)))
435 org-odt-schema-dir))))))
438 ;;;; Document styles
442 The exporter embeds the exported content just before
446 under `org-odt-styles-dir' is used."
453 "Default styles file for use with ODT export.
454 Valid values are one of:
455 1. nil
456 2. path to a styles.xml file
457 3. path to a *.odt or a *.ott file
458 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
459 ...))
461 In case of option 1, an in-built styles.xml is used. See
462 `org-odt-styles-dir' for more information.
464 In case of option 3, the specified file is unzipped and the
465 styles.xml embedded therein is used.
467 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
468 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
469 generated odt file. Use relative path for specifying the
470 FILE-MEMBERS. styles.xml must be specified as one of the
471 FILE-MEMBERS.
473 Use options 1, 2 or 3 only if styles.xml alone suffices for
474 achieving the desired formatting. Use option 4, if the styles.xml
475 references additional files like header and footer images for
476 achieving the desired formatting.
479 a per-file basis. For example,
485 :type
497 "Outline levels considered for enumerating captioned entities."
503 ;;;; Document conversion
510 "Specify a list of document converters and their usage.
511 The converters in this list are offered as choices while
512 customizing `org-odt-convert-process'.
514 This variable is a list where each element is of the
515 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
516 of the converter. CONVERTER-CMD is the shell command for the
517 converter and can contain format specifiers. These format
518 specifiers are interpreted as below:
520 %i input file name in full
521 %I input file name as a URL
522 %f format of the output file
523 %o output file name in full
524 %O output file name as a URL
525 %d output dir in full
526 %D output dir as a URL.
527 %x extra options as set in `org-odt-convert-capabilities'."
530 :type
539 During customization, the list of converter names are populated
540 from `org-odt-convert-processes'."
550 org-odt-convert-processes))))
568 "Specify input and output formats of `org-odt-convert-process'.
569 More correctly, specify the set of input and output formats that
570 the user is actually interested in.
572 This variable is an alist where each element is of the
573 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
574 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
575 alist where each element is of the form (OUTPUT-FMT
576 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
578 The variable is interpreted as follows:
579 `org-odt-convert-process' can take any document that is in
580 INPUT-FMT-LIST and produce any document that is in the
581 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
582 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
583 serves dual purposes:
584 - It is used for populating completion candidates during
585 `org-odt-convert' commands.
587 `org-odt-convert-process'.
590 `org-odt-convert-process'.
592 DOCUMENT-CLASS is used to group a set of file formats in
593 INPUT-FMT-LIST in to a single class.
595 Note that this variable inherently captures how LibreOffice based
596 converters work. LibreOffice maps documents of various formats
597 to classes like Text, Web, Spreadsheet, Presentation etc and
598 allow document of a given class (irrespective of its source
599 format) to be converted to any of the export formats associated
600 with that class.
602 See default setting of this variable for an typical
603 configuration."
606 :type
611 :value-type
615 :value-type
624 and then uses `org-odt-convert-process' to convert the
625 resulting document to this format. During customization of this
626 variable, the list of valid values are populated based on
627 `org-odt-convert-capabilities'.
629 You can set this option on per-file basis using file local
630 values. See Info node `(emacs) File Variables'."
641 ;;;###autoload
645 ;;;; Drawers
648 "Function called to format a drawer in ODT code.
650 The function must accept two parameters:
652 CONTENTS the contents of the drawer.
654 The function should return the string to be exported.
656 The default value simply returns the value of CONTENTS."
663 ;;;; Headline
666 'org-odt-format-headline-default-function
667 "Function to format headline text.
669 This function will be called with 5 arguments:
670 TODO the todo keyword (string or nil).
671 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
672 PRIORITY the priority of the headline (integer or nil)
673 TEXT the main headline text (string).
674 TAGS the tags string, separated with colons (string or nil).
676 The function result will be used as headline text."
683 ;;;; Inlinetasks
686 'org-odt-format-inlinetask-default-function
687 "Function called to format an inlinetask in ODT code.
689 The function must accept six parameters:
690 TODO the todo keyword, as a string
691 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
692 PRIORITY the inlinetask priority, as a string
693 NAME the inlinetask name, as a string.
694 TAGS the inlinetask tags, as a string.
695 CONTENTS the contents of the inlinetask, as a string.
697 The function should return the string to be exported."
704 ;;;; LaTeX
707 "Non-nil means process LaTeX math snippets.
709 When set, the exporter will process LaTeX environments and
710 fragments.
712 This option can also be set with the +OPTIONS line,
715 nil Ignore math snippets.
716 `verbatim' Keep everything in verbatim
717 `dvipng' Process the LaTeX fragments to images. This will also
718 include processing of non-math environments.
719 `imagemagick' Convert the LaTeX fragments to pdf files and use
720 imagemagick to convert pdf files to png files.
721 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
722 be loaded.
723 t Synonym for `mathjax'."
735 ;;;; Links
739 "Rules characterizing formula files that can be inlined into ODT.
741 A rule consists in an association whose key is the type of link
742 to consider, and value is a regexp that will be matched against
743 link's path."
752 "Rules characterizing image files that can be inlined into ODT.
754 A rule consists in an association whose key is the type of link
755 to consider, and value is a regexp that will be matched against
756 link's path."
764 "Scaling factor for converting images pixels to inches.
765 Use this for sizing of embedded images. See Info node `(org)
766 Images in ODT export' for more information."
773 ;;;; Src Block
776 "Whether custom styles for colorized source blocks be automatically created.
777 When this option is turned on, the exporter creates custom styles
778 for source blocks based on the advice of `htmlfontify'. Creation
779 of custom styles happen as part of `org-odt-hfy-face-to-css'.
781 When this option is turned off exporter does not create such
782 styles.
784 Use the latter option if you do not want the custom styles to be
785 based on your current display settings. It is necessary that the
786 styles.xml already contains needed styles for colorizing to work.
788 This variable is effective only if `org-odt-fontify-srcblocks' is
789 turned on."
795 "Specify whether or not source blocks need to be fontified.
796 Turn this option on if you want to colorize the source code
797 blocks in the exported file. For colorization to work, you need
798 to make available an enhanced version of `htmlfontify' library."
804 ;;;; Table
817 "Specify how Table Styles should be derived from a Table Template.
818 This is a list where each element is of the
819 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
821 TABLE-STYLE-NAME is the style associated with the table through
824 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
825 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
826 below) that is included in `org-odt-content-template-file'.
828 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
830 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
838 TABLE-CELL-OPTIONS is an alist where each element is of the
839 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
840 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
841 `use-last-row-styles' |
842 `use-first-column-styles' |
843 `use-last-column-styles' |
844 `use-banding-rows-styles' |
845 `use-banding-columns-styles' |
846 `use-first-row-styles'
847 ON-OR-OFF := t | nil
849 For example, with the following configuration
851 \(setq org-odt-table-styles
853 ((use-first-row-styles . t)
854 (use-first-column-styles . t)))
856 ((use-first-column-styles . t)))))
859 style will use the following table-cell styles -
864 as appropriate.
867 use the following table-cell styles -
869 following paragraph styles
871 as appropriate..
873 Note that TABLE-TEMPLATE-NAME corresponds to the
876 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
879 specification for more information. Also consult the
880 implementation filed under `org-odt-get-table-cell-styles'.
883 formatting of numbered display equations. Do not delete this
884 style from the list."
894 use-last-row-styles
895 use-first-column-styles
896 use-last-column-styles
897 use-banding-rows-styles
898 use-banding-columns-styles)
899 :key-type symbol
902 ;;;; Timestamps
905 "Non-nil, if timestamps should be exported as date fields.
907 When nil, export timestamps as plain text.
909 When non-nil, map `org-time-stamp-custom-formats' to a pair of
911 respectively. A timestamp with no time component is formatted
915 This feature is experimental. Most (but not all) of the common
916 %-specifiers in `format-time-string' are supported.
918 formatted as canonical Org timestamps. For finer control, avoid
919 these %-specifiers.
922 etc., are displayed by the application in the default language
923 and country specified in `org-odt-styles-file'. Note that the
925 can localize the week day and month strings in the exported
926 document by setting the default language and country either using
927 the application UI or through a custom styles file.
929 See `org-odt--build-date-styles' for implementation details."
936 \f
937 ;;; Internal functions
939 ;;;; Date
954 ;; LibreOffice does not care about end goes as content
955 ;; within the "<text:date>...</text:date>" field. The
956 ;; displayed date is automagically corrected to match the
957 ;; format requested by "style:data-style-name" attribute. So
958 ;; don't bother about formatting the date contents to be
959 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
960 ;; simple Org-style date should suffice.
985 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
986 iso-date style date)
988 repeater)))))
990 ;;;; Frame
998 extra
1004 style frame-attrs
1016 ;;;; Library wrappers
1023 ;; This is shamelessly stolen from `archive-zip-extract'.
1029 name)))
1034 exit-code command-output)
1043 ;;;; Target
1052 ;;;; Textbox
1055 extra anchor-type)
1061 text)
1062 width nil style extra anchor-type))
1066 ;;;; Table of Contents
1069 "Return a table of contents.
1070 TITLE is the title of the table, as a string, or nil. ENTRIES is
1071 the contents of the table, as a string. DEPTH is an integer
1072 specifying the depth of the table."
1074 "
1075 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1079 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1080 "
1081 title))
1087 "
1088 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1090 <text:index-entry-chapter/>
1091 <text:index-entry-text/>
1092 <text:index-entry-link-end/>
1095 "
1096 </text:table-of-content-source>
1097 <text:index-body>"
1103 title))
1104 entries
1105 "
1106 </text:index-body>
1113 headline-label
1115 ;; Section number.
1117 ;; Todo.
1122 style todo)))
1127 style priority)))
1128 ;; Title.
1129 text
1130 ;; Tags.
1134 "OrgTags"
1142 "Build a table of contents.
1143 DEPTH is an integer specifying the depth of the table. INFO is
1144 a plist containing current export properties. Optional argument
1145 SCOPE, when non-nil, defines the scope of the table. Return the
1146 table of contents as a string, or nil."
1148 ;; When a headline is marked as a radio target, as in the example below:
1149 ;;
1150 ;; ** <<<Some Heading>>>
1151 ;; Some text.
1152 ;;
1153 ;; suppress generation of radio targets. i.e., Radio targets are to
1154 ;; be marked as targets within /document body/ and *not* within
1155 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1156 ;; and one in the document body.
1157 ;;
1158 ;; Likewise, links, footnote references and regular targets are also
1159 ;; suppressed.
1177 style entry)))
1179 depth))))
1182 ;;;; Document styles
1185 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1186 OBJECT-PROPS is (typically) a plist created by passing
1188 `org-odt-parse-block-attributes'.
1190 Use `org-odt-object-counters' to generate an automatic
1191 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1192 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1193 . STYLE-NAME)."
1209 ;;;; Checkbox
1212 "Return check-box string associated to ITEM."
1221 ;;; Template
1224 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1225 ;; to modify the date fields. A date could be modified by
1226 ;; offsetting in days. That's about it. Also, date and time may
1227 ;; have to be emitted as two fields - a date field and a time field
1228 ;; - separately.
1230 ;; One can add Form Controls to date and time fields so that they
1231 ;; can be easily modified. But then, the exported document will
1232 ;; become tightly coupled with LibreOffice and may not function
1233 ;; properly with other OpenDocument applications.
1235 ;; I have a strange feeling that Date styles are a bit flaky at the
1236 ;; moment.
1238 ;; The feature is experimental.
1282 ))
1291 filler-end))
1302 style
1305 output ))))
1308 "Return complete document string after ODT conversion.
1309 CONTENTS is the transcoded contents string. RAW-DATA is the
1310 original parsed data. INFO is a plist holding export options."
1311 ;; Write meta file.
1321 <office:document-meta
1331 ;; Date, if required.
1333 ;; Check if DATE is specified as an Org-timestamp. If yes,
1334 ;; include it as meta information. Otherwise, just use
1335 ;; today's date.
1344 iso-date)))))
1353 subtitle))
1357 ;; Add meta.xml in to manifest.
1360 ;; Update styles file.
1361 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1362 ;; Write styles file.
1366 ;; Non-availability of styles.xml is not a critical
1367 ;; error. For now, throw an error.
1371 org-odt-styles-dir)
1394 ;; create a manifest entry for styles.xml
1397 ;; FIXME: Who is opening an empty styles.xml before this point?
1402 ;; Write custom styles for source blocks
1403 ;; Save STYLES used for colorizing of source blocks.
1404 ;; Update styles.xml with styles that were collected as part of
1405 ;; `org-odt-hfy-face-to-css' callbacks.
1414 ;; Update styles.xml - take care of outline numbering
1416 ;; Don't make automatic backup of styles.xml file. This setting
1417 ;; prevents the backed-up styles.xml file from being zipped in to
1418 ;; odt file. This is more of a hackish fix. Better alternative
1419 ;; would be to fix the zip command so that the output odt file
1420 ;; includes only the needed files and excludes any auto-generated
1421 ;; extra files like backups and auto-saves etc etc. Note that
1422 ;; currently the zip command zips up the entire temp directory so
1423 ;; that any auto-generated files created under the hood ends up in
1424 ;; the resulting odt file.
1427 ;; Outline numbering is retained only upto LEVEL.
1428 ;; To disable outline numbering pass a LEVEL of 0.
1441 ;; Update content.xml.
1444 ;; within the context of the Org buffer. So obtain its
1445 ;; value before moving on to temp-buffer context down below.
1455 org-odt-styles-dir)))
1456 ;; Write automatic styles.
1457 ;; - Position the cursor.
1461 ;; - Dump automatic table styles.
1466 ;; - Dump date-styles.
1472 ;; Update display level.
1473 ;; - Remove existing sequence decls. Also position the cursor.
1478 ;; Update sequence decls according to user preference.
1489 ;; Position the cursor to document body.
1494 ;; Preamble - Title, Author, Date etc.
1504 ;; Switch on or off above vars based on user settings
1508 ;; Title.
1513 ;; Separator.
1515 ;; Subtitle.
1521 subtitle
1523 ;; Separator.
1527 ;; Author only.
1530 "OrgSubtitle"
1532 ;; Separator.
1535 ;; Author and E-mail.
1539 "OrgSubtitle"
1544 ;; Separator.
1546 ;; Date, if required.
1549 ;; Check if DATE is specified as a timestamp.
1556 "OrgSubtitle"
1560 ;; Separator
1562 ;; Table of Contents
1565 with-toc
1568 ;; Contents.
1570 ;; Return contents.
1574 \f
1575 ;;; Transcode Functions
1577 ;;;; Bold
1580 "Transcode BOLD from Org to ODT.
1581 CONTENTS is the text with bold markup. INFO is a plist holding
1582 contextual information."
1587 ;;;; Center Block
1590 "Transcode a CENTER-BLOCK element from Org to ODT.
1591 CONTENTS holds the contents of the center block. INFO is a plist
1592 holding contextual information."
1593 contents)
1596 ;;;; Clock
1599 "Transcode a CLOCK element from Org to ODT.
1600 CONTENTS is nil. INFO is a plist used as a communication
1601 channel."
1614 ;;;; Code
1617 "Transcode a CODE object from Org to ODT.
1618 CONTENTS is nil. INFO is a plist used as a communication
1619 channel."
1625 ;;;; Drawer
1628 "Transcode a DRAWER element from Org to ODT.
1629 CONTENTS holds the contents of the block. INFO is a plist
1630 holding contextual information."
1633 name contents)))
1634 output))
1637 ;;;; Dynamic Block
1640 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1641 CONTENTS holds the contents of the block. INFO is a plist
1642 holding contextual information. See `org-export-data'."
1643 contents)
1646 ;;;; Entity
1649 "Transcode an ENTITY object from Org to ODT.
1650 CONTENTS are the definition itself. INFO is a plist holding
1651 contextual information."
1655 ;;;; Example Block
1658 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1659 CONTENTS is nil. INFO is a plist holding contextual information."
1663 ;;;; Export Snippet
1666 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1667 CONTENTS is nil. INFO is a plist holding contextual information."
1672 ;;;; Export Block
1675 "Transcode a EXPORT-BLOCK element from Org to ODT.
1676 CONTENTS is nil. INFO is a plist holding contextual information."
1681 ;;;; Fixed Width
1684 "Transcode a FIXED-WIDTH element from Org to ODT.
1685 CONTENTS is nil. INFO is a plist holding contextual information."
1689 ;;;; Footnote Definition
1691 ;; Footnote Definitions are ignored.
1694 ;;;; Footnote Reference
1697 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1698 CONTENTS is nil. INFO is a plist holding contextual information."
1706 id note-class
1718 "OrgSuperscript"
1719 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1720 note-class ref-format ref-name n))))))
1722 ;; Insert separator between two footnotes in a row.
1727 ;; Transcode footnote reference.
1735 footnote-reference info))
1739 raw
1742 :transcoders
1745 p c i
1746 "Footnote"
1747 "OrgFootnoteCenter"
1749 info))))
1750 ;; Inline definitions are secondary strings. We
1751 ;; need to wrap them within a paragraph.
1754 def
1757 def)))))
1761 ;;;; Headline
1764 &optional format-function
1766 "Transcode a HEADLINE element using BACKEND.
1767 INFO is a plist holding contextual information."
1790 &key _level _section-number _headline-label
1793 todo todo-type priority text tags))))))
1795 todo todo-type priority text tags
1796 :headline-label headline-label
1797 :level level
1801 "Transcode a HEADLINE element from Org to ODT.
1802 CONTENTS holds the contents of the headline. INFO is a plist
1803 holding contextual information."
1804 ;; Case 1: This is a footnote section: ignore it.
1807 ;; Get level relative to current parsed data.
1810 ;; Get canonical label for the headline.
1812 ;; Extra targets.
1816 ;; Title.
1819 ;; Case 2. This is a deep sub-tree: export it as a list item.
1820 ;; Also export as items headlines for which no section
1821 ;; format has been found.
1823 ;; Build the real contents of the sub-tree.
1827 ;; Choose style based on list type.
1829 ;; If top-level list, re-start numbering. Otherwise,
1830 ;; continue numbering.
1833 headline)))
1843 "Text_20_body"
1845 contents)
1847 "</text:list-header>"
1851 ;; Case 3. Standard headline. Export it as a section.
1855 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1858 level
1861 contents))))))
1865 "Default format function for a headline.
1866 See `org-odt-format-headline-function' for details."
1868 ;; Todo.
1876 style priority)))
1877 ;; Title.
1878 text
1879 ;; Tags.
1882 "<text:tab/>"
1891 ;;;; Horizontal Rule
1894 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1895 CONTENTS is nil. INFO is a plist holding contextual information."
1900 ;;;; Inline Babel Call
1902 ;; Inline Babel Calls are ignored.
1905 ;;;; Inline Src Block
1908 "Return a character not used in string S.
1910 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1916 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1917 CONTENTS holds the contents of the item. INFO is a plist holding
1918 contextual information."
1922 ;;;; Inlinetask
1925 "Transcode an INLINETASK element from Org to ODT.
1926 CONTENTS holds the contents of the block. INFO is a plist
1927 holding contextual information."
1939 todo todo-type priority text tags contents)))
1943 "Default format function for a inlinetasks.
1944 See `org-odt-format-inlinetask-function' for details."
1946 "Text_20_body"
1950 "OrgInlineTaskHeading"
1952 todo todo-type priority name tags))
1953 contents)
1956 ;;;; Italic
1959 "Transcode ITALIC from Org to ODT.
1960 CONTENTS is the text with italic markup. INFO is a plist holding
1961 contextual information."
1966 ;;;; Item
1969 "Transcode an ITEM element from Org to ODT.
1970 CONTENTS holds the contents of the item. INFO is a plist holding
1971 contextual information."
1977 contents
1979 "</text:list-header>"
1982 ;;;; Keyword
1985 "Transcode a KEYWORD element from Org to ODT.
1986 CONTENTS is nil. INFO is a plist holding contextual
1987 information."
1993 ;; FIXME
2005 ;; FIXME
2009 ;;;; Latex Environment
2012 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2013 ;; (defadvice org-format-latex-as-mathml ; FIXME
2014 ;; (after org-odt-protect-latex-fragment activate)
2015 ;; "Encode LaTeX fragment as XML.
2016 ;; Do this when translation to MathML fails."
2017 ;; (unless (> (length ad-return-value) 0)
2018 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2021 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2022 CONTENTS is nil. INFO is a plist holding contextual information."
2028 ;;;; Latex Fragment
2030 ;; (when latex-frag ; FIXME
2031 ;; (setq href (propertize href :title "LaTeX Fragment"
2032 ;; :description latex-frag)))
2033 ;; handle verbatim
2034 ;; provide descriptions
2037 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2038 CONTENTS is nil. INFO is a plist holding contextual information."
2044 ;;;; Line Break
2047 "Transcode a LINE-BREAK object from Org to ODT.
2048 CONTENTS is nil. INFO is a plist holding contextual information."
2052 ;;;; Link
2054 ;;;; Links :: Label references
2064 x))))
2074 counter))
2077 element
2079 info))
2083 ;; Section number.
2087 ;; Separator.
2089 ;; Ordinal.
2091 tag))
2094 "Return a label for ELEMENT.
2096 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2097 element. INFO is a plist used as a communication channel. OP is
2098 either `definition' or `reference', depending on the purpose of
2099 the generated string.
2101 Return value is a string if OP is set to `reference' or a cons
2102 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2103 SHORT-CAPTION are strings."
2109 ;; Get label and caption.
2115 ;; FIXME: We don't use short-caption for now
2131 element))))
2134 seqno)
2139 ;; Compute sequence number of the element.
2141 ;; Localize category string.
2144 ;; Case 1: Handle Label definition.
2148 ;; Sneak in a bookmark. The bookmark is used when the
2149 ;; labeled element is referenced with a link that
2150 ;; provides its own description.
2152 ;; Label definition: Typically formatted as below:
2153 ;; CATEGORY SEQ-NO: LONG CAPTION
2154 ;; with translation for correct punctuation.
2161 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2162 label counter counter seqno))
2164 short-caption))
2165 ;; Case 2: Handle Label reference.
2170 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2171 fmt1
2172 label
2177 ;;;; Links :: Inline Images
2180 "Returns the internal name of the file"
2196 target-file))
2219 ;; Use Imagemagick.
2224 file))))
2229 ;; Use Emacs.
2235 ;; Use hard-coded values.
2237 org-odt-default-image-sizes-alist))
2238 ;; Error out.
2251 ;; ensure that an embedded image fits comfortably within a page
2262 "Return ODT code for an inline image.
2263 LINK is the link pointing to the inline image. INFO is a plist
2264 used as a communication channel."
2277 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2279 ;; Extract attributes from #+ATTR_ODT line.
2283 ;; Convert attributes to a plist.
2285 ;; Handle `:anchor', `:style' and `:attributes' properties.
2295 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2296 ;;
2297 ;; Handle `:width', `:height' and `:scale' properties. Read
2298 ;; them as numbers since we need them for computations.
2300 src-expanded info
2307 nil ; embed-as
2309 ))
2316 ;; Check if this link was created by LaTeX-to-PNG converter.
2320 ;; If yes, note down the type of the element - LaTeX Fragment
2321 ;; or LaTeX environment. It will go in to frame title.
2325 ;; If yes, note down its contents. It will go in to frame
2326 ;; description. This quite useful for debugging.
2329 captions user-frame-params title desc)))
2332 ;;;; Links :: Math formula
2351 ;; Check if this link was created by LaTeX-to-MathML
2352 ;; converter.
2356 ;; If yes, note down the type of the element - LaTeX Fragment
2357 ;; or LaTeX environment. It will go in to frame title.
2361 ;; If yes, note down its contents. It will go in to frame
2362 ;; description. This quite useful for debugging.
2364 width height)
2368 nil nil title desc))
2371 "CaptionedDisplayFormula" href width height
2372 captions nil title desc))
2376 org-odt--enumerable-formula-p))))
2381 "Returns the internal name of the file"
2385 ;; Create a directory for holding formula file. Also enter it in
2386 ;; to manifest.
2390 ;; Copy over the formula file from user directory to zip
2391 ;; directory.
2395 ;; Case 1: Mathml.
2398 ;; Case 2: OpenDocument formula.
2403 ;; Enter the formula file in to manifest.
2405 target-file))
2407 ;;;; Targets
2410 captions user-frame-params
2413 ;; Each element of this alist is of the form (CFG-HANDLE
2414 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2416 ;; CFG-HANDLE is the key to the alist.
2418 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2419 ;; frame params for INNER-FRAME and OUTER-FRAME
2420 ;; respectively. See below.
2422 ;; Configurations that are meant to be applied to
2423 ;; non-captioned image/formula specifies no
2424 ;; OUTER-FRAME-PARAMS.
2426 ;; TERMINOLOGY
2427 ;; ===========
2428 ;; INNER-FRAME :: Frame that directly surrounds an
2429 ;; image/formula.
2431 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2432 ;; frame also contains the caption, if any.
2434 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2435 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2436 ;; that these are the last three arguments
2437 ;; to `org-odt--frame'.
2439 ;; Note that an un-captioned image/formula requires just an
2440 ;; INNER-FRAME, while a captioned image/formula requires
2441 ;; both an INNER and an OUTER-FRAME.
2463 ;; Retrieve inner and outer frame params, from configuration.
2467 ;; User-specified frame params (from #+ATTR_ODT spec)
2471 "Merge default and user frame params."
2476 for d in default
2479 ;; Case 1: Image/Formula has no caption.
2480 ;; There is only one frame, one that surrounds the image
2481 ;; or formula.
2483 ;; Merge user frame params with that from configuration.
2487 ;; Case 2: Image/Formula is captioned or labeled.
2488 ;; There are two frames: The inner one surrounds the
2489 ;; image or formula. The outer one contains the
2490 ;; caption/sequence number.
2492 ;; Merge user frame params with outer frame params.
2494 ;; Short caption, if specified, goes as part of inner frame.
2501 frame-params))
2504 "Illustration"
2508 caption))
2509 width height outer)))))
2512 ;; Element should have a caption or label.
2518 element info
2519 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2520 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2521 ;; processing.)
2526 ;; Link should point to an image file.
2533 element info
2534 ;; Paragraph should have a caption or label. It SHOULD also be a
2535 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2536 ;; processing.)
2541 ;; Link should point to an image file.
2548 element info
2549 ;; Paragraph should have a caption or label.
2553 ;; Link should point to a MathML or ODF file.
2559 paragraph-predicate
2560 link-predicate)
2561 "Test if ELEMENT is a standalone link for the purpose ODT export.
2562 INFO is a plist holding contextual information.
2564 Return non-nil, if ELEMENT is of type paragraph satisfying
2565 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2566 is a link that satisfies LINK-PREDICATE.
2568 Return non-nil, if ELEMENT is of type link satisfying
2569 LINK-PREDICATE and its containing paragraph satisfies
2570 PARAGRAPH-PREDICATE in addition to having no other content save for
2571 leading and trailing whitespaces.
2573 Return nil, otherwise."
2596 ;; DESTINATION is a headline or an element (like paragraph,
2597 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2599 ;; Note that labels that are attached to captioned entities - inline
2600 ;; images, math formulae and tables - get resolved as part of
2601 ;; `org-odt-format-label' and `org-odt--enumerate'.
2603 ;; Create a cross-reference to DESTINATION but make best-efforts to
2604 ;; create a *meaningful* description. Check item numbers, section
2605 ;; number and section title in that order.
2607 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2608 ;; FIXME: Handle footnote-definition footnote-reference?
2620 return x))
2621 ;; Get list item nos.
2626 plain-list)
2629 item info t))))))
2630 ;; Locate top-most listified headline.
2635 return x))
2636 ;; Get listified headline numbers.
2642 el info t)))))))
2643 ;; Combine item numbers from both the listified headlines and
2644 ;; regular list items.
2646 ;; Case 1: Check if all the parents of list item are numbered.
2647 ;; If yes, link to the item proper.
2650 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2651 label
2655 ;; Case 2: Locate a regular and numbered headline in the
2656 ;; hierarchy. Display its section number.
2659 ;; Test if destination is a numbered headline.
2665 return el))))
2666 ;; We found one.
2668 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2669 label
2672 ;; Case 4: Locate a regular headline in the hierarchy. Display
2673 ;; its title.
2677 return el)))
2678 ;; We found one.
2680 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2681 label
2687 "Transcode a LINK object from Org to ODT.
2689 DESC is the description part of the link, or the empty string.
2690 INFO is a plist holding contextual information. See
2691 `org-export-data'."
2694 ;; Ensure DESC really exists, or set it to nil.
2703 ;; Convert & to & for correct XML representation
2706 ;; Link type is handled by a special function.
2708 ;; Image file.
2710 ;; Formula file.
2715 ;; Radio target: Transcode target's contents and use them as
2716 ;; link's description.
2721 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2723 desc))))
2724 ;; Links pointing to a headline: Find destination and build
2725 ;; appropriate referencing command.
2731 ;; Fuzzy link points to a headline. If there's
2732 ;; a description, create a hyperlink. Otherwise, try to
2733 ;; provide a meaningful description.
2742 label desc))))
2743 ;; Fuzzy link points to a target. If there's a description,
2744 ;; create a hyperlink. Otherwise, try to provide
2745 ;; a meaningful description.
2750 ;; Fuzzy link points to some element (e.g., an inline image,
2751 ;; a math formula or a table).
2759 ;; LINK has no description. Create
2760 ;; a cross-reference showing entity's sequence
2761 ;; number.
2763 ;; LINK has description. Insert a hyperlink with
2764 ;; user-provided description.
2769 desc))))))))
2770 ;; Coderef: replace link with the reference name or the
2771 ;; equivalent line number.
2778 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2779 href line-no))))
2780 ;; External link with a description part.
2783 ;; Check if description is a link to an inline image.
2788 desc-element
2790 ;; Format link as a clickable image.
2792 path desc)
2793 ;; Otherwise, format it as a regular link.
2795 path desc))))
2796 ;; External link without a description part.
2799 path path))
2800 ;; No path, only description. Try to do something useful.
2805 ;;;; Node Property
2808 "Transcode a NODE-PROPERTY element from Org to ODT.
2809 CONTENTS is nil. INFO is a plist holding contextual
2810 information."
2817 ;;;; Paragraph
2820 "Return style of PARAGRAPH.
2821 Style is a symbol among `quoted', `centered' and nil."
2831 "Format paragraph according to given styles.
2832 PARAGRAPH is a paragraph type element. CONTENTS is the
2833 transcoded contents of that paragraph, as a string. INFO is
2834 a plist used as a communication channel. DEFAULT, CENTER and
2835 QUOTE are, respectively, style to use when paragraph belongs to
2836 no special environment, a center block, or a quote block."
2842 ;; If PARAGRAPH is a leading paragraph in an item that has
2843 ;; a checkbox, splice checkbox and paragraph contents
2844 ;; together.
2849 contents)))
2852 "Transcode a PARAGRAPH element from Org to ODT.
2853 CONTENTS is the contents of the paragraph, as a string. INFO is
2854 the plist used as a communication channel."
2856 paragraph contents info
2858 "OrgCenter"
2862 ;;;; Plain List
2865 "Transcode a PLAIN-LIST element from Org to ODT.
2866 CONTENTS is the contents of the list. INFO is a plist holding
2867 contextual information."
2869 ;; Choose style based on list type.
2875 ;; If top-level list, re-start numbering. Otherwise,
2876 ;; continue numbering.
2881 contents))
2883 ;;;; Plain Text
2891 line))
2900 "Transcode a TEXT string from Org to ODT.
2901 TEXT is the string to transcode. INFO is a plist holding
2902 contextual information."
2904 ;; Protect &, < and >.
2906 ;; Handle smart quotes. Be sure to provide original string since
2907 ;; OUTPUT may have been modified.
2910 ;; Convert special strings.
2915 ;; Handle break preservation if required.
2919 ;; Return value.
2920 output))
2923 ;;;; Planning
2926 "Transcode a PLANNING element from Org to ODT.
2927 CONTENTS is nil. INFO is a plist used as a communication
2928 channel."
2930 "OrgPlanning"
2952 ;;;; Property Drawer
2955 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2956 CONTENTS holds the contents of the drawer. INFO is a plist
2957 holding contextual information."
2960 contents)))
2963 ;;;; Quote Block
2966 "Transcode a QUOTE-BLOCK element from Org to ODT.
2967 CONTENTS holds the contents of the block. INFO is a plist
2968 holding contextual information."
2969 contents)
2972 ;;;; Section
2977 style
2979 text)))
2983 "Transcode a SECTION element from Org to ODT.
2984 CONTENTS holds the contents of the section. INFO is a plist
2985 holding contextual information."
2986 contents)
2988 ;;;; Radio Target
2991 "Transcode a RADIO-TARGET object from Org to ODT.
2992 TEXT is the text of the target. INFO is a plist holding
2993 contextual information."
2997 ;;;; Special Block
3000 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3001 CONTENTS holds the contents of the block. INFO is a plist
3002 holding contextual information."
3006 ;; Annotation.
3012 ;; FIXME: Is `car' right thing to do below?
3022 contents)))))
3023 ;; Textbox.
3032 style extra anchor))))
3036 ;;;; Src Block
3039 "Create custom style for face FN.
3040 When FN is the default face, use its foreground and background
3042 use its color attribute to create a character style whose name
3043 is obtained from FN. Currently all attributes of FN other than
3044 color are ignored.
3046 The style name for a face FN is derived using the following
3047 operations on the face name in that order - de-dash, CamelCase
3049 `font-lock-function-name-face' is associated with
3063 background-color-val color-val))
3066 "
3113 code
3125 par-style loc))
3128 num-start refs))
3142 ;; Extract code and references.
3146 ;; Does the src block contain labels?
3148 ;; Does it have line numbers?
3153 "Transcode a SRC-BLOCK element from Org to ODT.
3154 CONTENTS holds the contents of the item. INFO is a plist holding
3155 contextual information."
3165 "Text_20_body"
3169 ;;;; Statistics Cookie
3172 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3173 CONTENTS is nil. INFO is a plist holding contextual information."
3179 ;;;; Strike-Through
3182 "Transcode STRIKE-THROUGH from Org to ODT.
3183 CONTENTS is the text with strike-through markup. INFO is a plist
3184 holding contextual information."
3189 ;;;; Subscript
3192 "Transcode a SUBSCRIPT object from Org to ODT.
3193 CONTENTS is the contents of the object. INFO is a plist holding
3194 contextual information."
3199 ;;;; Superscript
3202 "Transcode a SUPERSCRIPT object from Org to ODT.
3203 CONTENTS is the contents of the object. INFO is a plist holding
3204 contextual information."
3209 ;;;; Table Cell
3218 "Retrieve styles applicable to a table cell.
3219 R and C are (zero-based) row and column numbers of the table
3220 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3221 applicable to the current table. It is nil if the table is not
3222 associated with any style attributes.
3224 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3226 When STYLE-SPEC is nil, style the table cell the conventional way
3227 - choose cell borders based on row and column groupings and
3228 choose paragraph alignment based on `org-col-cookies' text
3229 property. See also
3230 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3232 When STYLE-SPEC is non-nil, ignore the above cookie and return
3233 styles congruent with the ODF-1.2 specification."
3239 info)))
3241 ;; LibreOffice - particularly the Writer - honors neither table
3242 ;; templates nor custom table-cell styles. Inorder to retain
3243 ;; inter-operability with LibreOffice, only automatic styles are
3244 ;; used for styling of table-cells. The current implementation is
3245 ;; congruent with ODF-1.2 specification and hence is
3246 ;; future-compatible.
3248 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3249 ;; which recognizes as many as 16 different cell types - is much
3250 ;; richer. Unfortunately it is NOT amenable to easy configuration
3251 ;; by hand.
3278 "Transcode a TABLE-CELL element from Org to ODT.
3279 CONTENTS is nil. INFO is a plist used as a communication
3280 channel."
3287 table-cell info))
3310 table-cell info))))))
3314 custom-style-prefix))
3316 "OrgTblCell"
3332 cell-attributes
3335 contents
3337 paragraph-style contents))))
3344 ;;;; Table Row
3347 "Transcode a TABLE-ROW element from Org to ODT.
3348 CONTENTS is the contents of the row. INFO is a plist used as a
3349 communication channel."
3350 ;; Rules are ignored since table separators are deduced from
3351 ;; borders of the current row.
3357 ;; If the row belongs to the first rowgroup and the
3358 ;; table has more than one row groups, then this row
3359 ;; belongs to the header row group.
3361 ;; Otherwise, it belongs to non-header row group.
3364 ;; Does this row begin a rowgroup?
3367 ;; Actual table row
3369 ;; Does this row end a rowgroup?
3374 ;;;; Table
3387 "Transcode a TABLE element from Org to ODT.
3388 CONTENTS is the contents of the table. INFO is a plist holding
3389 contextual information."
3391 ;; Case 1: table.el doesn't support export to OD format. Strip
3392 ;; such tables from export.
3397 "(ox-odt): Found table.el-type table in the source Org file."
3398 " table.el doesn't support export to ODT format."
3400 ;; Case 2: Native Org tables.
3416 column-style))
3417 out)
3421 ;; caption.
3425 ;; begin table.
3433 ;; column specification.
3435 ;; actual contents.
3437 ;; end table.
3441 "Transcode a TABLE element from Org to ODT.
3442 CONTENTS is the contents of the table. INFO is a plist holding
3443 contextual information.
3445 Use `org-odt--table' to typeset the table. Handle details
3446 pertaining to indentation here."
3459 collect el)))
3463 for el in genealogy
3466 collect
3471 parent-list)
3473 ;; Handle list genealogy.
3475 for el in list-genealogy collect
3494 parent-list info)
3497 ;; Handle low-level headlines.
3499 with step = 'item collect
3507 el info)
3508 "OrgNumberedList"
3519 parent-list info)))
3527 table info)))
3528 ;; OpenDocument schema does not permit table to occur within a
3529 ;; list item.
3531 ;; One solution - the easiest and lightweight, in terms of
3532 ;; implementation - is to put the table in an indented text box
3533 ;; and make the text box part of the list-item. Unfortunately if
3534 ;; the table is big and spans multiple pages, the text box could
3535 ;; overflow. In this case, the following attribute will come
3536 ;; handy.
3538 ;; ,---- From OpenDocument-v1.1.pdf
3539 ;; | 15.27.28 Overflow behavior
3540 ;; |
3541 ;; | For text boxes contained within text document, the
3542 ;; | style:overflow-behavior property specifies the behavior of text
3543 ;; | boxes where the containing text does not fit into the text
3544 ;; | box.
3545 ;; |
3546 ;; | If the attribute's value is clip, the text that does not fit
3547 ;; | into the text box is not displayed.
3548 ;; |
3549 ;; | If the attribute value is auto-create-new-frame, a new frame
3550 ;; | will be created on the next page, with the same position and
3551 ;; | dimensions of the original frame.
3552 ;; |
3553 ;; | If the style:overflow-behavior property's value is
3554 ;; | auto-create-new-frame and the text box has a minimum width or
3555 ;; | height specified, then the text box will grow until the page
3556 ;; | bounds are reached before a new frame is created.
3557 ;; `----
3559 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3560 ;; auto-create-new-frame property and always resorts to clipping
3561 ;; the text box. This results in table being truncated.
3563 ;; So we solve the problem the hard (and fun) way using list
3564 ;; continuations.
3566 ;; The problem only becomes more interesting if you take in to
3567 ;; account the following facts:
3568 ;;
3569 ;; - Description lists are simulated as plain lists.
3570 ;; - Low-level headlines can be listified.
3571 ;; - In Org mode, a table can occur not only as a regular list
3572 ;; item, but also within description lists and low-level
3573 ;; headlines.
3575 ;; See `org-odt-translate-description-lists' and
3576 ;; `org-odt-translate-low-level-headlines' for how this is
3577 ;; tackled.
3580 ;; Discontinue the list.
3582 ;; Put the table in an indented section.
3587 ;; Continue the list.
3591 ;;;; Target
3594 "Transcode a TARGET object from Org to ODT.
3595 CONTENTS is nil. INFO is a plist holding contextual
3596 information."
3600 ;;;; Timestamp
3603 "Transcode a TIMESTAMP object from Org to ODT.
3604 CONTENTS is nil. INFO is a plist used as a communication
3605 channel."
3621 "OrgActiveTimestamp"
3625 "OrgInactiveTimestamp"
3629 "OrgActiveTimestamp"
3635 "OrgInactiveTimestamp"
3641 "OrgDiaryTimestamp"
3643 info)))))))
3646 ;;;; Underline
3649 "Transcode UNDERLINE from Org to ODT.
3650 CONTENTS is the text with underline markup. INFO is a plist
3651 holding contextual information."
3656 ;;;; Verbatim
3659 "Transcode a VERBATIM object from Org to ODT.
3660 CONTENTS is nil. INFO is a plist used as a communication
3661 channel."
3667 ;;;; Verse Block
3670 "Transcode a VERSE-BLOCK element from Org to ODT.
3671 CONTENTS is verse block contents. INFO is a plist holding
3672 contextual information."
3675 ;; Replace leading tabs and spaces.
3677 ;; Add line breaks to each line of verse.
3682 \f
3683 ;;; Filters
3685 ;;;; LaTeX fragments
3690 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3691 ;; If the desired converter is not available, force verbatim
3692 ;; processing.
3710 ;; Store normalized value for later use.
3715 ;; Convert `latex-fragment's and `latex-environment's.
3734 ;; Get an Org-style link to PNG image or the MathML
3735 ;; file.
3739 ;; When converting to a PNG image, make sure to
3740 ;; copy all LaTeX header specifications from the
3741 ;; Org source.
3749 nil display-msg nil
3750 processing-type)
3755 ;; Conversion succeeded. Parse above Org-style link to
3756 ;; a `link' object.
3759 ;;LaTeX environment. Mimic a "standalone image
3760 ;; or formula" by enclosing the `link' in
3761 ;; a `paragraph'. Copy over original
3762 ;; attributes, captions to the enclosing
3763 ;; paragraph.
3768 :name
3770 :caption
3772 link))
3773 ;; LaTeX fragment. No special action.
3775 ;; Note down the object that link replaces.
3779 ;; Restore blank after initial element or object.
3781 replacement :post-blank
3783 ;; Replace now.
3785 info nil nil t)))
3786 tree)
3789 ;;;; Description lists
3791 ;; This translator is necessary to handle indented tables in a uniform
3792 ;; manner. See comment in `org-odt--table'.
3795 ;; OpenDocument has no notion of a description list. So simulate it
3796 ;; using plain lists. Description lists in the exported document
3797 ;; are typeset in the same manner as they are in a typical HTML
3798 ;; document.
3799 ;;
3800 ;; Specifically, a description list like this:
3801 ;;
3802 ;; ,----
3803 ;; | - term-1 :: definition-1
3804 ;; | - term-2 :: definition-2
3805 ;; `----
3806 ;;
3807 ;; gets translated in to the following form:
3808 ;;
3809 ;; ,----
3810 ;; | - term-1
3811 ;; | - definition-1
3812 ;; | - term-2
3813 ;; | - definition-2
3814 ;; `----
3815 ;;
3816 ;; Further effect is achieved by fixing the OD styles as below:
3817 ;;
3818 ;; 1. Set the :type property of the simulated lists to
3819 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3820 ;; that has *no* bullets whatsoever.
3821 ;;
3822 ;; 2. The paragraph containing the definition term is styled to be
3823 ;; in bold.
3824 ;;
3829 el
3845 nil)
3846 info)
3847 tree)
3849 ;;;; List tables
3851 ;; Lists that are marked with attribute `:list-table' are called as
3852 ;; list tables. They will be rendered as a table within the exported
3853 ;; document.
3855 ;; Consider an example. The following list table
3856 ;;
3857 ;; #+attr_odt :list-table t
3858 ;; - Row 1
3859 ;; - 1.1
3860 ;; - 1.2
3861 ;; - 1.3
3862 ;; - Row 2
3863 ;; - 2.1
3864 ;; - 2.2
3865 ;; - 2.3
3866 ;;
3867 ;; will be exported as though it were an Org table like the one show
3868 ;; below.
3869 ;;
3870 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3871 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3872 ;;
3873 ;; Note that org-tables are NOT multi-line and each line is mapped to
3874 ;; a unique row in the exported document. So if an exported table
3875 ;; needs to contain a single paragraph (with copious text) it needs to
3876 ;; be typed up in a single line. Editing such long lines using the
3877 ;; table editor will be a cumbersome task. Furthermore inclusion of
3878 ;; multi-paragraph text in a table cell is well-nigh impossible.
3879 ;;
3880 ;; A LIST-TABLE circumvents above problems.
3881 ;;
3882 ;; Note that in the example above the list items could be paragraphs
3883 ;; themselves and the list can be arbitrarily deep.
3884 ;;
3885 ;; Inspired by following thread:
3886 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3888 ;; Translate lists to tables
3894 ;; Replace list with table.
3896 l1-list
3897 ;; Build replacement table.
3903 l1-item-leading-text l2-list)
3904 ;; Remove Level-2 list from the Level-item. It
3905 ;; will be subsequently attached as table-cells.
3915 ;; Level-1 items start a table row.
3918 ;; Leading text of level-1 item define
3919 ;; the first table-cell.
3922 l1-item-leading-text)
3923 ;; Level-2 items define subsequent
3924 ;; table-cells of the row.
3932 nil)
3933 info)
3934 tree)
3936 \f
3937 ;;; Interactive functions
3950 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3965 ;; Initialize temporary workarea. All files that end up in
3966 ;; the exported document get parked/created here.
3972 ;; Kill all XML buffers.
3980 ;; Delete temporary directory and also other embedded
3981 ;; files that get copied there.
3986 ;; Not at all OSes ship with zip by default
3988 ;; Do export. This creates a bunch of xml files ready to be
3989 ;; saved and zipped.
3991 ;; Create a manifest entry for content.xml.
3993 ;; Write mimetype file
4002 ;; Write out the manifest entries before zipping
4004 ;; Save all XML files.
4010 ;; Prettify output if needed.
4014 ;; Run zip.
4019 ;; If a file with same name as the desired output file
4020 ;; exists, remove it.
4023 ;; Zip up the xml files.
4026 ;; Switch temporarily to content.xml. This way Zip
4027 ;; process will inherit `org-odt-zip-dir' as the current
4028 ;; directory.
4041 err-string)))))
4042 ;; Move the zip file from temporary work directory to
4043 ;; user-mandated location.
4046 ;; Cleanup work directory and work files.
4048 ;; Open the OpenDocument file in archive-mode for
4049 ;; examination.
4051 ;; Return exported file.
4053 ;; Case 1: Conversion desired on exported file. Run the
4054 ;; converter on the OpenDocument file. Return the
4055 ;; converted file.
4058 target))
4059 ;; Case 2: No further conversion. Return exported
4060 ;; OpenDocument file.
4063 ;; Cleanup work directory and work files.
4069 ;;;; Export to OpenDocument formula
4071 ;;;###autoload
4073 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4074 Use `org-create-math-formula' to convert LATEX-FRAG first to
4075 MathML. When invoked as an interactive command, use
4076 `org-latex-regexps' to infer LATEX-FRAG from currently active
4077 region. If no LaTeX fragments are found, prompt for it. Push
4078 MathML source to kill ring depending on the value of
4079 `org-export-copy-to-kill-ring'."
4105 filename
4118 ;; Add MathML to kill ring, if needed.
4122 ;;;###autoload
4124 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4125 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4126 formula file."
4131 ;;;; Export to OpenDocument Text
4133 ;;;###autoload
4135 "Export current buffer to a ODT file.
4137 If narrowing is active in the current buffer, only export its
4138 narrowed part.
4140 If a region is active, export that region.
4142 A non-nil optional argument ASYNC means the process should happen
4143 asynchronously. The resulting file should be accessible through
4144 the `org-export-stack' interface.
4146 When optional argument SUBTREEP is non-nil, export the sub-tree
4147 at point, extracting information from the headline properties
4148 first.
4150 When optional argument VISIBLE-ONLY is non-nil, don't export
4151 contents of hidden elements.
4153 EXT-PLIST, when provided, is a property list with external
4154 parameters overriding Org default settings, but still inferior to
4155 file-local settings.
4157 Return output file's name."
4164 ,outfile
4169 ;; Let `htmlfontify' know that we are interested in
4170 ;; collecting styles.
4172 ;; Initialize content.xml and kick-off the export
4173 ;; process.
4186 outfile
4191 ;; Let `htmlfontify' know that we are interested in collecting
4192 ;; styles.
4194 ;; Initialize content.xml and kick-off the export process.
4204 ;;;; Convert between OpenDocument and other formats
4207 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4216 "Workhorse routine for `org-odt-convert'."
4225 in-fmt out-fmt)))
4253 out-file)
4256 nil))))
4259 "Return verbose info about formats to which IN-FMT can be converted.
4260 Return a list where each element is of the
4261 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4262 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4263 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4267 org-odt-convert-processes t))))
4271 org-odt-convert-processes t))
4272 org-odt-convert-capabilities))
4273 reachable-formats)
4278 reachable-formats))
4281 "Return list of formats to which IN-FMT can be converted.
4282 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4289 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4290 This is a helper routine for interactive use."
4293 nil buffer-file-name t))
4299 out-fmt-choices nil nil nil))
4301 "No known converter or no known output formats for %s files"
4302 in-fmt))))
4305 ;;;###autoload
4307 "Convert IN-FILE to format OUT-FMT using a command line converter.
4308 IN-FILE is the file to be converted. If unspecified, it defaults
4309 to variable `buffer-file-name'. OUT-FMT is the desired output
4310 format. Use `org-odt-convert-process' as the converter. If OPEN
4311 is non-nil then the newly converted file is opened using
4312 `org-open-file'."
4317 ;;; Library Initializations
4320 ;; Let Emacs open all OpenDocument files in archive mode.
4326 ;; Local variables:
4327 ;; generated-autoload-file: "org-loaddefs.el"
4328 ;; End:
4330 ;;; ox-odt.el ends here