| blob | 37ed03e7ecd881bc193430b7ec1f85dc691eb4fe |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2016 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
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 Declarations
133 \f
134 ;;; Internal Variables
138 "Location of ODT exporter.
139 Use this to infer values of `org-odt-styles-dir' and
144 "Data directory for ODT exporter.
145 Use this to infer values of `org-odt-styles-dir' and
162 "List of directories to search for OpenDocument schema files.
163 Use this list to set the default value of
164 `org-odt-schema-dir'. The entries in this list are
165 populated heuristically based on the values of `org-odt-lib-dir'
178 )
179 "List of directories to search for OpenDocument styles files.
180 See `org-odt-styles-dir'. The entries in this list are populated
181 heuristically based on the values of `org-odt-lib-dir' and
198 styles-dir)
200 org-odt-styles-dir-list)
201 nil)))
204 styles-dir)
205 "Directory that holds auxiliary XML files used by the ODT exporter.
207 This directory contains the following XML files -
209 XML files are used as the default values of
210 `org-odt-styles-file' and `org-odt-content-template-file'.
212 The default value of this variable varies depending on the
213 version of org in use and is initialized from
214 `org-odt-styles-dir-list'. Note that the user could be using org
215 from one of: org's own private git repository, GNU ELPA tar or
238 "
240 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
241 </style:style>
242 "
246 "Registry of automatic styles for various OBJECT-TYPEs.
247 The variable has the following form:
248 ((OBJECT-TYPE-A
249 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
250 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
251 (OBJECT-TYPE-B
252 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
253 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
254 ...).
257 OBJECT-PROPS is (typically) a plist created by passing
263 "Running counters for various OBJECT-TYPEs.
264 Use this to generate automatic names and style-names. See
268 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
269 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
270 <style:background-image/>
271 </style:paragraph-properties>
273 </style:style>"
274 "Custom paragraph style for colorized source and example blocks.
276 except that the foreground and background colors are set
291 "Hardcoded image dimensions one for each of the anchor
294 ;; A4 page size is 21.0 by 29.7 cms
295 ;; The default page settings has 2cm margin on each of the sides. So
296 ;; the effective text area is 17.0 by 25.7 cm
305 "Specify how labels are applied and referenced.
307 This is an alist where each element is of the form:
309 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
311 ATTACH-FMT controls how labels and captions are attached to an
312 entity. It may contain following specifiers - %e and %c. %e is
313 replaced with the CATEGORY-NAME. %n is replaced with
315 with CAPTION.
317 REF-MODE and REF-FMT controls how label references are generated.
318 The following XML is generated for a label reference -
321 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
322 %n is replaced with SEQNO.
332 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
334 This is a list where each entry is of the form:
336 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
338 CATEGORY_HANDLE identifies the captionable entity in question.
340 OD-VARIABLE is the OpenDocument sequence counter associated with
341 the entity. These counters are declared within
343 `org-odt-content-template-file'.
345 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
346 how a given entity should be captioned and referenced.
348 CATEGORY-NAME is used for qualifying captions on export.
350 ENUMERATOR-PREDICATE is used for assigning a sequence number to
360 \f
361 ;;; User Configuration Variables
364 "Options for exporting Org mode files to ODT."
369 ;;;; Debugging
372 "Specify whether or not the xml output should be prettified.
373 When this option is turned on, `indent-region' is run on all
374 component xml buffers before they are saved. Turn this off for
375 regular use. Turn this on if you need to examine the xml
376 visually."
382 ;;;; Document schema
395 schema-dir))
398 schema-dir))
402 schema-dir)
404 org-odt-schema-dir-list)
406 nil)))
407 schema-dir)
408 "Directory that contains OpenDocument schema files.
410 This directory contains:
411 1. rnc files for OpenDocument schema
413 for auto validation of OpenDocument XML files.
415 Use the customize interface to set this variable. This ensures
416 that `rng-schema-locating-files' is updated and auto-validation
417 of OpenDocument XML takes place based on the value
418 `rng-nxml-auto-validate-flag'.
420 The default value of this variable varies depending on the
421 version of org in use and is initialized from
422 `org-odt-schema-dir-list'. The OASIS schema files are available
423 only in the org's private git repository. It is *not* bundled
424 with GNU ELPA tar or standard Emacs distribution."
430 :set
432 "Set `org-odt-schema-dir'.
433 Also add it to `rng-schema-locating-files'."
443 schema-dir
446 value))
447 nil)))
452 org-odt-schema-dir))))))
455 ;;;; Document styles
459 The exporter embeds the exported content just before
463 under `org-odt-styles-dir' is used."
470 "Default styles file for use with ODT export.
471 Valid values are one of:
472 1. nil
473 2. path to a styles.xml file
474 3. path to a *.odt or a *.ott file
475 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
476 ...))
478 In case of option 1, an in-built styles.xml is used. See
479 `org-odt-styles-dir' for more information.
481 In case of option 3, the specified file is unzipped and the
482 styles.xml embedded therein is used.
484 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
485 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
486 generated odt file. Use relative path for specifying the
487 FILE-MEMBERS. styles.xml must be specified as one of the
488 FILE-MEMBERS.
490 Use options 1, 2 or 3 only if styles.xml alone suffices for
491 achieving the desired formatting. Use option 4, if the styles.xml
492 references additional files like header and footer images for
493 achieving the desired formatting.
496 a per-file basis. For example,
502 :type
514 "Outline levels considered for enumerating captioned entities."
520 ;;;; Document conversion
527 "Specify a list of document converters and their usage.
528 The converters in this list are offered as choices while
529 customizing `org-odt-convert-process'.
531 This variable is a list where each element is of the
532 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
533 of the converter. CONVERTER-CMD is the shell command for the
534 converter and can contain format specifiers. These format
535 specifiers are interpreted as below:
537 %i input file name in full
538 %I input file name as a URL
539 %f format of the output file
540 %o output file name in full
541 %O output file name as a URL
542 %d output dir in full
543 %D output dir as a URL.
544 %x extra options as set in `org-odt-convert-capabilities'."
547 :type
556 During customization, the list of converter names are populated
557 from `org-odt-convert-processes'."
567 org-odt-convert-processes))))
585 "Specify input and output formats of `org-odt-convert-process'.
586 More correctly, specify the set of input and output formats that
587 the user is actually interested in.
589 This variable is an alist where each element is of the
590 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
591 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
592 alist where each element is of the form (OUTPUT-FMT
593 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
595 The variable is interpreted as follows:
596 `org-odt-convert-process' can take any document that is in
597 INPUT-FMT-LIST and produce any document that is in the
598 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
599 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
600 serves dual purposes:
601 - It is used for populating completion candidates during
602 `org-odt-convert' commands.
604 `org-odt-convert-process'.
607 `org-odt-convert-process'.
609 DOCUMENT-CLASS is used to group a set of file formats in
610 INPUT-FMT-LIST in to a single class.
612 Note that this variable inherently captures how LibreOffice based
613 converters work. LibreOffice maps documents of various formats
614 to classes like Text, Web, Spreadsheet, Presentation etc and
615 allow document of a given class (irrespective of its source
616 format) to be converted to any of the export formats associated
617 with that class.
619 See default setting of this variable for an typical
620 configuration."
623 :type
628 :value-type
632 :value-type
641 and then uses `org-odt-convert-process' to convert the
642 resulting document to this format. During customization of this
643 variable, the list of valid values are populated based on
644 `org-odt-convert-capabilities'.
646 You can set this option on per-file basis using file local
647 values. See Info node `(emacs) File Variables'."
658 ;;;###autoload
662 ;;;; Drawers
666 "Function called to format a drawer in ODT code.
668 The function must accept two parameters:
670 CONTENTS the contents of the drawer.
672 The function should return the string to be exported.
674 The default value simply returns the value of CONTENTS."
681 ;;;; Headline
684 'org-odt-format-headline-default-function
685 "Function to format headline text.
687 This function will be called with 5 arguments:
688 TODO the todo keyword (string or nil).
689 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
690 PRIORITY the priority of the headline (integer or nil)
691 TEXT the main headline text (string).
692 TAGS the tags string, separated with colons (string or nil).
694 The function result will be used as headline text."
701 ;;;; Inlinetasks
704 'org-odt-format-inlinetask-default-function
705 "Function called to format an inlinetask in ODT code.
707 The function must accept six parameters:
708 TODO the todo keyword, as a string
709 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
710 PRIORITY the inlinetask priority, as a string
711 NAME the inlinetask name, as a string.
712 TAGS the inlinetask tags, as a string.
713 CONTENTS the contents of the inlinetask, as a string.
715 The function should return the string to be exported."
722 ;;;; LaTeX
725 "Non-nil means process LaTeX math snippets.
727 When set, the exporter will process LaTeX environments and
728 fragments.
730 This option can also be set with the +OPTIONS line,
733 nil Ignore math snippets.
734 `verbatim' Keep everything in verbatim
735 `dvipng' Process the LaTeX fragments to images. This will also
736 include processing of non-math environments.
737 `imagemagick' Convert the LaTeX fragments to pdf files and use
738 imagemagick to convert pdf files to png files.
739 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
740 be loaded.
741 t Synonym for `mathjax'."
753 ;;;; Links
757 "Rules characterizing formula files that can be inlined into ODT.
759 A rule consists in an association whose key is the type of link
760 to consider, and value is a regexp that will be matched against
761 link's path."
770 "Rules characterizing image files that can be inlined into ODT.
772 A rule consists in an association whose key is the type of link
773 to consider, and value is a regexp that will be matched against
774 link's path."
782 "Scaling factor for converting images pixels to inches.
783 Use this for sizing of embedded images. See Info node `(org)
784 Images in ODT export' for more information."
791 ;;;; Src Block
794 "Whether custom styles for colorized source blocks be automatically created.
795 When this option is turned on, the exporter creates custom styles
796 for source blocks based on the advice of `htmlfontify'. Creation
797 of custom styles happen as part of `org-odt-hfy-face-to-css'.
799 When this option is turned off exporter does not create such
800 styles.
802 Use the latter option if you do not want the custom styles to be
803 based on your current display settings. It is necessary that the
804 styles.xml already contains needed styles for colorizing to work.
806 This variable is effective only if `org-odt-fontify-srcblocks' is
807 turned on."
813 "Specify whether or not source blocks need to be fontified.
814 Turn this option on if you want to colorize the source code
815 blocks in the exported file. For colorization to work, you need
816 to make available an enhanced version of `htmlfontify' library."
822 ;;;; Table
835 "Specify how Table Styles should be derived from a Table Template.
836 This is a list where each element is of the
837 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
839 TABLE-STYLE-NAME is the style associated with the table through
842 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
843 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
844 below) that is included in `org-odt-content-template-file'.
846 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
848 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
856 TABLE-CELL-OPTIONS is an alist where each element is of the
857 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
858 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
859 `use-last-row-styles' |
860 `use-first-column-styles' |
861 `use-last-column-styles' |
862 `use-banding-rows-styles' |
863 `use-banding-columns-styles' |
864 `use-first-row-styles'
865 ON-OR-OFF := t | nil
867 For example, with the following configuration
869 \(setq org-odt-table-styles
871 ((use-first-row-styles . t)
872 (use-first-column-styles . t)))
874 ((use-first-column-styles . t)))))
877 style will use the following table-cell styles -
882 as appropriate.
885 use the following table-cell styles -
887 following paragraph styles
889 as appropriate..
891 Note that TABLE-TEMPLATE-NAME corresponds to the
894 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
897 specification for more information. Also consult the
898 implementation filed under `org-odt-get-table-cell-styles'.
901 formatting of numbered display equations. Do not delete this
902 style from the list."
912 use-last-row-styles
913 use-first-column-styles
914 use-last-column-styles
915 use-banding-rows-styles
916 use-banding-columns-styles)
917 :key-type symbol
920 ;;;; Timestamps
923 "Non-nil, if timestamps should be exported as date fields.
925 When nil, export timestamps as plain text.
927 When non-nil, map `org-time-stamp-custom-formats' to a pair of
929 respectively. A timestamp with no time component is formatted
933 This feature is experimental. Most (but not all) of the common
934 %-specifiers in `format-time-string' are supported.
936 formatted as canonical Org timestamps. For finer control, avoid
937 these %-specifiers.
940 etc., are displayed by the application in the default language
941 and country specified in `org-odt-styles-file'. Note that the
943 can localize the week day and month strings in the exported
944 document by setting the default language and country either using
945 the application UI or through a custom styles file.
947 See `org-odt--build-date-styles' for implementation details."
954 \f
955 ;;; Internal functions
957 ;;;; Date
972 ;; LibreOffice does not care about end goes as content
973 ;; within the "<text:date>...</text:date>" field. The
974 ;; displayed date is automagically corrected to match the
975 ;; format requested by "style:data-style-name" attribute. So
976 ;; don't bother about formatting the date contents to be
977 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
978 ;; simple Org-style date should suffice.
1003 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1004 iso-date style date)
1006 repeater)))))
1008 ;;;; Frame
1016 extra
1022 style frame-attrs
1034 ;;;; Library wrappers
1041 ;; This is shamelessly stolen from `archive-zip-extract'.
1047 name)))
1052 exit-code command-output)
1060 members))
1062 ;;;; Target
1071 ;;;; Textbox
1074 extra anchor-type)
1080 text)
1081 width nil style extra anchor-type))
1085 ;;;; Table of Contents
1088 "Return a table of contents.
1089 TITLE is the title of the table, as a string, or nil. ENTRIES is
1090 the contents of the table, as a string. DEPTH is an integer
1091 specifying the depth of the table."
1093 "
1094 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1098 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1099 "
1100 title))
1106 "
1107 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1109 <text:index-entry-chapter/>
1110 <text:index-entry-text/>
1111 <text:index-entry-link-end/>
1114 "
1115 </text:table-of-content-source>
1116 <text:index-body>"
1122 title))
1123 entries
1124 "
1125 </text:index-body>
1133 ;; Section number.
1135 ;; Todo.
1140 style todo)))
1145 style priority)))
1146 ;; Title.
1147 text
1148 ;; Tags.
1152 "OrgTags"
1159 headline-label text))
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.
1304 ))
1312 filler-end))
1323 style
1326 output ))))
1329 "Return complete document string after ODT conversion.
1330 CONTENTS is the transcoded contents string. RAW-DATA is the
1331 original parsed data. INFO is a plist holding export options."
1332 ;; Write meta file.
1343 <office:document-meta
1353 ;; Date, if required.
1355 ;; Check if DATE is specified as an Org-timestamp. If yes,
1356 ;; include it as meta information. Otherwise, just use
1357 ;; today's date.
1366 iso-date)))))
1375 subtitle))
1379 ;; Add meta.xml in to manifest.
1382 ;; Update styles file.
1383 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1384 ;; Write styles file.
1388 ;; Non-availability of styles.xml is not a critical
1389 ;; error. For now, throw an error.
1393 org-odt-styles-dir)
1406 members)))
1418 ;; create a manifest entry for styles.xml
1421 ;; FIXME: Who is opening an empty styles.xml before this point?
1426 ;; Write custom styles for source blocks
1427 ;; Save STYLES used for colorizing of source blocks.
1428 ;; Update styles.xml with styles that were collected as part of
1429 ;; `org-odt-hfy-face-to-css' callbacks.
1438 ;; Update styles.xml - take care of outline numbering
1440 ;; Don't make automatic backup of styles.xml file. This setting
1441 ;; prevents the backed-up styles.xml file from being zipped in to
1442 ;; odt file. This is more of a hackish fix. Better alternative
1443 ;; would be to fix the zip command so that the output odt file
1444 ;; includes only the needed files and excludes any auto-generated
1445 ;; extra files like backups and auto-saves etc etc. Note that
1446 ;; currently the zip command zips up the entire temp directory so
1447 ;; that any auto-generated files created under the hood ends up in
1448 ;; the resulting odt file.
1451 ;; Outline numbering is retained only upto LEVEL.
1452 ;; To disable outline numbering pass a LEVEL of 0.
1465 ;; Update content.xml.
1468 ;; within the context of the Org buffer. So obtain its
1469 ;; value before moving on to temp-buffer context down below.
1479 org-odt-styles-dir)))
1480 ;; Write automatic styles.
1481 ;; - Position the cursor.
1485 ;; - Dump automatic table styles.
1490 ;; - Dump date-styles.
1496 ;; Update display level.
1497 ;; - Remove existing sequence decls. Also position the cursor.
1502 ;; Update sequence decls according to user preference.
1513 ;; Position the cursor to document body.
1518 ;; Preamble - Title, Author, Date etc.
1528 ;; Switch on or off above vars based on user settings
1532 ;; Title.
1537 ;; Separator.
1539 ;; Subtitle.
1545 subtitle
1547 ;; Separator.
1551 ;; Author only.
1554 "OrgSubtitle"
1556 ;; Separator.
1559 ;; Author and E-mail.
1563 "OrgSubtitle"
1568 ;; Separator.
1570 ;; Date, if required.
1573 ;; Check if DATE is specified as a timestamp.
1580 "OrgSubtitle"
1584 ;; Separator
1586 ;; Table of Contents
1589 with-toc
1592 ;; Contents.
1594 ;; Return contents.
1598 \f
1599 ;;; Transcode Functions
1601 ;;;; Bold
1604 "Transcode BOLD from Org to ODT.
1605 CONTENTS is the text with bold markup. INFO is a plist holding
1606 contextual information."
1611 ;;;; Center Block
1614 "Transcode a CENTER-BLOCK element from Org to ODT.
1615 CONTENTS holds the contents of the center block. INFO is a plist
1616 holding contextual information."
1617 contents)
1620 ;;;; Clock
1623 "Transcode a CLOCK element from Org to ODT.
1624 CONTENTS is nil. INFO is a plist used as a communication
1625 channel."
1638 ;;;; Code
1641 "Transcode a CODE object from Org to ODT.
1642 CONTENTS is nil. INFO is a plist used as a communication
1643 channel."
1649 ;;;; Comment
1651 ;; Comments are ignored.
1654 ;;;; Comment Block
1656 ;; Comment Blocks are ignored.
1659 ;;;; Drawer
1662 "Transcode a DRAWER element from Org to ODT.
1663 CONTENTS holds the contents of the block. INFO is a plist
1664 holding contextual information."
1667 name contents)))
1668 output))
1671 ;;;; Dynamic Block
1674 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1675 CONTENTS holds the contents of the block. INFO is a plist
1676 holding contextual information. See `org-export-data'."
1677 contents)
1680 ;;;; Entity
1683 "Transcode an ENTITY object from Org to ODT.
1684 CONTENTS are the definition itself. INFO is a plist holding
1685 contextual information."
1689 ;;;; Example Block
1692 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1693 CONTENTS is nil. INFO is a plist holding contextual information."
1697 ;;;; Export Snippet
1700 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1701 CONTENTS is nil. INFO is a plist holding contextual information."
1706 ;;;; Export Block
1709 "Transcode a EXPORT-BLOCK element from Org to ODT.
1710 CONTENTS is nil. INFO is a plist holding contextual information."
1715 ;;;; Fixed Width
1718 "Transcode a FIXED-WIDTH element from Org to ODT.
1719 CONTENTS is nil. INFO is a plist holding contextual information."
1723 ;;;; Footnote Definition
1725 ;; Footnote Definitions are ignored.
1728 ;;;; Footnote Reference
1731 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1732 CONTENTS is nil. INFO is a plist holding contextual information."
1742 id note-class
1755 "OrgSuperscript"
1756 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1757 note-class ref-format ref-name n)))))))
1759 ;; Insert separator between two footnotes in a row.
1764 ;; Transcode footnote reference.
1772 footnote-reference info))
1776 raw
1779 :transcoders
1782 p c i
1783 "Footnote"
1784 "OrgFootnoteCenter"
1786 info))))
1787 ;; Inline definitions are secondary strings. We
1788 ;; need to wrap them within a paragraph.
1790 org-element-all-elements)
1791 def
1794 def)))))
1798 ;;;; Headline
1801 &optional format-function
1803 "Transcode a HEADLINE element using BACKEND.
1804 INFO is a plist holding contextual information."
1827 &key level section-number headline-label
1830 todo todo-type priority text tags))))))
1832 todo todo-type priority text tags
1837 "Transcode a HEADLINE element from Org to ODT.
1838 CONTENTS holds the contents of the headline. INFO is a plist
1839 holding contextual information."
1840 ;; Case 1: This is a footnote section: ignore it.
1843 ;; Create the headline text.
1845 ;; Get level relative to current parsed data.
1848 ;; Get canonical label for the headline.
1850 ;; Extra targets.
1854 ;; Title.
1857 ;; Case 2. This is a deep sub-tree: export it as a list item.
1858 ;; Also export as items headlines for which no section
1859 ;; format has been found.
1861 ;; Build the real contents of the sub-tree.
1865 ;; Choose style based on list type.
1867 ;; If top-level list, re-start numbering. Otherwise,
1868 ;; continue numbering.
1871 headline)))
1881 "Text_20_body"
1883 contents)
1885 "</text:list-header>"
1889 ;; Case 3. Standard headline. Export it as a section.
1893 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1896 level
1899 contents))))))
1903 "Default format function for a headline.
1904 See `org-odt-format-headline-function' for details."
1906 ;; Todo.
1914 style priority)))
1915 ;; Title.
1916 text
1917 ;; Tags.
1920 "<text:tab/>"
1929 ;;;; Horizontal Rule
1932 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1933 CONTENTS is nil. INFO is a plist holding contextual information."
1938 ;;;; Inline Babel Call
1940 ;; Inline Babel Calls are ignored.
1943 ;;;; Inline Src Block
1946 "Return a character not used in string S.
1948 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1954 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1955 CONTENTS holds the contents of the item. INFO is a plist holding
1956 contextual information."
1963 ;;;; Inlinetask
1966 "Transcode an INLINETASK element from Org to ODT.
1967 CONTENTS holds the contents of the block. INFO is a plist
1968 holding contextual information."
1980 todo todo-type priority text tags contents)))
1984 "Default format function for a inlinetasks.
1985 See `org-odt-format-inlinetask-function' for details."
1987 "Text_20_body"
1991 "OrgInlineTaskHeading"
1993 todo todo-type priority name tags))
1994 contents)
1997 ;;;; Italic
2000 "Transcode ITALIC from Org to ODT.
2001 CONTENTS is the text with italic markup. INFO is a plist holding
2002 contextual information."
2007 ;;;; Item
2010 "Transcode an ITEM element from Org to ODT.
2011 CONTENTS holds the contents of the item. INFO is a plist holding
2012 contextual information."
2023 contents
2035 ;;;; Keyword
2038 "Transcode a KEYWORD element from Org to ODT.
2039 CONTENTS is nil. INFO is a plist holding contextual
2040 information."
2046 ;; FIXME
2058 ;; FIXME
2062 ;;;; Latex Environment
2065 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2066 ;; (defadvice org-format-latex-as-mathml ; FIXME
2067 ;; (after org-odt-protect-latex-fragment activate)
2068 ;; "Encode LaTeX fragment as XML.
2069 ;; Do this when translation to MathML fails."
2070 ;; (unless (> (length ad-return-value) 0)
2071 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2074 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2075 CONTENTS is nil. INFO is a plist holding contextual information."
2081 ;;;; Latex Fragment
2083 ;; (when latex-frag ; FIXME
2084 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2085 ;; :description latex-frag)))
2086 ;; handle verbatim
2087 ;; provide descriptions
2090 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2091 CONTENTS is nil. INFO is a plist holding contextual information."
2098 ;;;; Line Break
2101 "Transcode a LINE-BREAK object from Org to ODT.
2102 CONTENTS is nil. INFO is a plist holding contextual information."
2106 ;;;; Link
2108 ;;;; Links :: Label references
2119 x)))))
2130 counter))
2133 element
2135 info))
2139 ;; Section number.
2143 ;; Separator.
2145 ;; Ordinal.
2147 tag))
2150 "Return a label for ELEMENT.
2152 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2153 element. INFO is a plist used as a communication channel. OP is
2154 either `definition' or `reference', depending on the purpose of
2155 the generated string.
2157 Return value is a string if OP is set to `reference' or a cons
2158 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2159 SHORT-CAPTION are strings."
2165 ;; Get label and caption.
2171 ;; FIXME: We don't use short-caption for now
2187 element))))
2190 seqno)
2194 ;; Compute sequence number of the element.
2196 ;; Localize category string.
2199 ;; Case 1: Handle Label definition.
2203 ;; Sneak in a bookmark. The bookmark is used when the
2204 ;; labeled element is referenced with a link that
2205 ;; provides its own description.
2207 ;; Label definition: Typically formatted as below:
2208 ;; CATEGORY SEQ-NO: LONG CAPTION
2209 ;; with translation for correct punctuation.
2216 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2217 label counter counter seqno))
2219 short-caption))
2220 ;; Case 2: Handle Label reference.
2225 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2226 fmt1
2227 label
2232 ;;;; Links :: Inline Images
2235 "Returns the internal name of the file"
2251 target-file))
2274 ;; Use Imagemagick.
2279 file))))
2284 ;; Use Emacs.
2290 ;; Use hard-coded values.
2292 org-odt-default-image-sizes-alist))
2293 ;; Error out.
2306 ;; ensure that an embedded image fits comfortably within a page
2317 "Return ODT code for an inline image.
2318 LINK is the link pointing to the inline image. INFO is a plist
2319 used as a communication channel."
2332 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2334 ;; Extract attributes from #+ATTR_ODT line.
2338 ;; Convert attributes to a plist.
2340 ;; Handle `:anchor', `:style' and `:attributes' properties.
2350 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2351 ;;
2352 ;; Handle `:width', `:height' and `:scale' properties. Read
2353 ;; them as numbers since we need them for computations.
2355 src-expanded info
2362 nil ; embed-as
2364 ))
2371 ;; Check if this link was created by LaTeX-to-PNG converter.
2375 ;; If yes, note down the type of the element - LaTeX Fragment
2376 ;; or LaTeX environment. It will go in to frame title.
2380 ;; If yes, note down its contents. It will go in to frame
2381 ;; description. This quite useful for debugging.
2384 captions user-frame-params title desc)))
2387 ;;;; Links :: Math formula
2408 ;; Check if this link was created by LaTeX-to-MathML
2409 ;; converter.
2413 ;; If yes, note down the type of the element - LaTeX Fragment
2414 ;; or LaTeX environment. It will go in to frame title.
2418 ;; If yes, note down its contents. It will go in to frame
2419 ;; description. This quite useful for debugging.
2421 width height)
2425 nil nil title desc))
2428 "CaptionedDisplayFormula" href width height
2429 captions nil title desc))
2433 org-odt--enumerable-formula-p))))
2438 "Returns the internal name of the file"
2442 ;; Create a directory for holding formula file. Also enter it in
2443 ;; to manifest.
2447 ;; Copy over the formula file from user directory to zip
2448 ;; directory.
2452 ;; Case 1: Mathml.
2455 ;; Case 2: OpenDocument formula.
2460 ;; Enter the formula file in to manifest.
2462 target-file))
2464 ;;;; Targets
2467 captions user-frame-params
2470 ;; Each element of this alist is of the form (CFG-HANDLE
2471 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2473 ;; CFG-HANDLE is the key to the alist.
2475 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2476 ;; frame params for INNER-FRAME and OUTER-FRAME
2477 ;; respectively. See below.
2479 ;; Configurations that are meant to be applied to
2480 ;; non-captioned image/formula specifies no
2481 ;; OUTER-FRAME-PARAMS.
2483 ;; TERMINOLOGY
2484 ;; ===========
2485 ;; INNER-FRAME :: Frame that directly surrounds an
2486 ;; image/formula.
2488 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2489 ;; frame also contains the caption, if any.
2491 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2492 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2493 ;; that these are the last three arguments
2494 ;; to `org-odt--frame'.
2496 ;; Note that an un-captioned image/formula requires just an
2497 ;; INNER-FRAME, while a captioned image/formula requires
2498 ;; both an INNER and an OUTER-FRAME.
2520 ;; Retrieve inner and outer frame params, from configuration.
2524 ;; User-specified frame params (from #+ATTR_ODT spec)
2528 "Merge default and user frame params."
2533 for d in default
2536 ;; Case 1: Image/Formula has no caption.
2537 ;; There is only one frame, one that surrounds the image
2538 ;; or formula.
2540 ;; Merge user frame params with that from configuration.
2544 ;; Case 2: Image/Formula is captioned or labeled.
2545 ;; There are two frames: The inner one surrounds the
2546 ;; image or formula. The outer one contains the
2547 ;; caption/sequence number.
2549 ;; Merge user frame params with outer frame params.
2551 ;; Short caption, if specified, goes as part of inner frame.
2558 frame-params))
2561 "Illustration"
2565 caption))
2566 width height outer)))))
2569 ;; Element should have a caption or label.
2575 element info
2576 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2577 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2578 ;; processing.)
2583 ;; Link should point to an image file.
2590 element info
2591 ;; Paragraph should have a caption or label. It SHOULD also be a
2592 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2593 ;; processing.)
2598 ;; Link should point to an image file.
2605 element info
2606 ;; Paragraph should have a caption or label.
2610 ;; Link should point to a MathML or ODF file.
2616 paragraph-predicate
2617 link-predicate)
2618 "Test if ELEMENT is a standalone link for the purpose ODT export.
2619 INFO is a plist holding contextual information.
2621 Return non-nil, if ELEMENT is of type paragraph satisfying
2622 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2623 is a link that satisfies LINK-PREDICATE.
2625 Return non-nil, if ELEMENT is of type link satisfying
2626 LINK-PREDICATE and its containing paragraph satisfies
2627 PARAGRAPH-PREDICATE in addition to having no other content save for
2628 leading and trailing whitespaces.
2630 Return nil, otherwise."
2653 ;; DESTINATION is a headline or an element (like paragraph,
2654 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2656 ;; Note that labels that are attached to captioned entities - inline
2657 ;; images, math formulae and tables - get resolved as part of
2658 ;; `org-odt-format-label' and `org-odt--enumerate'.
2660 ;; Create a cross-reference to DESTINATION but make best-efforts to
2661 ;; create a *meaningful* description. Check item numbers, section
2662 ;; number and section title in that order.
2664 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2665 ;; FIXME: Handle footnote-definition footnote-reference?
2677 return x))
2678 ;; Get list item nos.
2683 plain-list)
2686 item info t))))))
2687 ;; Locate top-most listified headline.
2692 return x))
2693 ;; Get listified headline numbers.
2699 el info t)))))))
2700 ;; Combine item numbers from both the listified headlines and
2701 ;; regular list items.
2703 ;; Case 1: Check if all the parents of list item are numbered.
2704 ;; If yes, link to the item proper.
2707 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2708 label
2712 ;; Case 2: Locate a regular and numbered headline in the
2713 ;; hierarchy. Display its section number.
2716 ;; Test if destination is a numbered headline.
2722 return el))))
2723 ;; We found one.
2725 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2726 label
2729 ;; Case 4: Locate a regular headline in the hierarchy. Display
2730 ;; its title.
2734 return el)))
2735 ;; We found one.
2737 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2738 label
2744 "Transcode a LINK object from Org to ODT.
2746 DESC is the description part of the link, or the empty string.
2747 INFO is a plist holding contextual information. See
2748 `org-export-data'."
2751 ;; Ensure DESC really exists, or set it to nil.
2760 ;; Convert & to & for correct XML representation
2763 ;; Link type is handled by a special function.
2765 ;; Image file.
2769 ;; Formula file.
2773 ;; Radio target: Transcode target's contents and use them as
2774 ;; link's description.
2779 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2781 desc))))
2782 ;; Links pointing to a headline: Find destination and build
2783 ;; appropriate referencing command.
2789 ;; Fuzzy link points to a headline. If there's
2790 ;; a description, create a hyperlink. Otherwise, try to
2791 ;; provide a meaningful description.
2800 label desc))))
2801 ;; Fuzzy link points to a target. If there's a description,
2802 ;; create a hyperlink. Otherwise, try to provide
2803 ;; a meaningful description.
2808 ;; Fuzzy link points to some element (e.g., an inline image,
2809 ;; a math formula or a table).
2817 ;; LINK has no description. Create
2818 ;; a cross-reference showing entity's sequence
2819 ;; number.
2821 ;; LINK has description. Insert a hyperlink with
2822 ;; user-provided description.
2827 desc))))))))
2828 ;; Coderef: replace link with the reference name or the
2829 ;; equivalent line number.
2836 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2837 href line-no))))
2838 ;; External link with a description part.
2841 ;; Check if description is a link to an inline image.
2846 desc-element
2848 ;; Format link as a clickable image.
2850 path desc)
2851 ;; Otherwise, format it as a regular link.
2853 path desc))))
2854 ;; External link without a description part.
2857 path path))
2858 ;; No path, only description. Try to do something useful.
2863 ;;;; Node Property
2866 "Transcode a NODE-PROPERTY element from Org to ODT.
2867 CONTENTS is nil. INFO is a plist holding contextual
2868 information."
2875 ;;;; Paragraph
2878 "Return style of PARAGRAPH.
2879 Style is a symbol among `quoted', `centered' and nil."
2889 "Format paragraph according to given styles.
2890 PARAGRAPH is a paragraph type element. CONTENTS is the
2891 transcoded contents of that paragraph, as a string. INFO is
2892 a plist used as a communication channel. DEFAULT, CENTER and
2893 QUOTE are, respectively, style to use when paragraph belongs to
2894 no special environment, a center block, or a quote block."
2900 ;; If PARAGRAPH is a leading paragraph in an item that has
2901 ;; a checkbox, splice checkbox and paragraph contents
2902 ;; together.
2907 contents)))
2910 "Transcode a PARAGRAPH element from Org to ODT.
2911 CONTENTS is the contents of the paragraph, as a string. INFO is
2912 the plist used as a communication channel."
2914 paragraph contents info
2916 "OrgCenter"
2920 ;;;; Plain List
2923 "Transcode a PLAIN-LIST element from Org to ODT.
2924 CONTENTS is the contents of the list. INFO is a plist holding
2925 contextual information."
2927 ;; Choose style based on list type.
2933 ;; If top-level list, re-start numbering. Otherwise,
2934 ;; continue numbering.
2939 contents))
2941 ;;;; Plain Text
2954 line))
2965 "Transcode a TEXT string from Org to ODT.
2966 TEXT is the string to transcode. INFO is a plist holding
2967 contextual information."
2969 ;; Protect &, < and >.
2971 ;; Handle smart quotes. Be sure to provide original string since
2972 ;; OUTPUT may have been modified.
2975 ;; Convert special strings.
2981 org-odt-special-string-regexps))
2982 ;; Handle break preservation if required.
2986 ;; Return value.
2987 output))
2990 ;;;; Planning
2993 "Transcode a PLANNING element from Org to ODT.
2994 CONTENTS is nil. INFO is a plist used as a communication
2995 channel."
2997 "OrgPlanning"
3019 ;;;; Property Drawer
3022 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3023 CONTENTS holds the contents of the drawer. INFO is a plist
3024 holding contextual information."
3027 contents)))
3030 ;;;; Quote Block
3033 "Transcode a QUOTE-BLOCK element from Org to ODT.
3034 CONTENTS holds the contents of the block. INFO is a plist
3035 holding contextual information."
3036 contents)
3039 ;;;; Section
3044 style
3046 text)))
3050 "Transcode a SECTION element from Org to ODT.
3051 CONTENTS holds the contents of the section. INFO is a plist
3052 holding contextual information."
3053 contents)
3055 ;;;; Radio Target
3058 "Transcode a RADIO-TARGET object from Org to ODT.
3059 TEXT is the text of the target. INFO is a plist holding
3060 contextual information."
3064 ;;;; Special Block
3067 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3068 CONTENTS holds the contents of the block. INFO is a plist
3069 holding contextual information."
3073 ;; Annotation.
3079 ;; FIXME: Is `car' right thing to do below?
3089 contents)))))
3090 ;; Textbox.
3099 style extra anchor))))
3103 ;;;; Src Block
3106 "Create custom style for face FN.
3107 When FN is the default face, use its foreground and background
3109 use its color attribute to create a character style whose name
3110 is obtained from FN. Currently all attributes of FN other than
3111 color are ignored.
3113 The style name for a face FN is derived using the following
3114 operations on the face name in that order - de-dash, CamelCase
3116 `font-lock-function-name-face' is associated with
3130 background-color-val color-val))
3133 "
3181 code
3192 par-style loc))
3195 num-start refs))
3209 ;; Extract code and references.
3213 ;; Does the src block contain labels?
3215 ;; Does it have line numbers?
3222 "Transcode a SRC-BLOCK element from Org to ODT.
3223 CONTENTS holds the contents of the item. INFO is a plist holding
3224 contextual information."
3236 "Text_20_body"
3240 ;;;; Statistics Cookie
3243 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3244 CONTENTS is nil. INFO is a plist holding contextual information."
3250 ;;;; Strike-Through
3253 "Transcode STRIKE-THROUGH from Org to ODT.
3254 CONTENTS is the text with strike-through markup. INFO is a plist
3255 holding contextual information."
3260 ;;;; Subscript
3263 "Transcode a SUBSCRIPT object from Org to ODT.
3264 CONTENTS is the contents of the object. INFO is a plist holding
3265 contextual information."
3270 ;;;; Superscript
3273 "Transcode a SUPERSCRIPT object from Org to ODT.
3274 CONTENTS is the contents of the object. INFO is a plist holding
3275 contextual information."
3280 ;;;; Table Cell
3289 "Retrieve styles applicable to a table cell.
3290 R and C are (zero-based) row and column numbers of the table
3291 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3292 applicable to the current table. It is nil if the table is not
3293 associated with any style attributes.
3295 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3297 When STYLE-SPEC is nil, style the table cell the conventional way
3298 - choose cell borders based on row and column groupings and
3299 choose paragraph alignment based on `org-col-cookies' text
3300 property. See also
3301 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3303 When STYLE-SPEC is non-nil, ignore the above cookie and return
3304 styles congruent with the ODF-1.2 specification."
3310 info)))
3312 ;; LibreOffice - particularly the Writer - honors neither table
3313 ;; templates nor custom table-cell styles. Inorder to retain
3314 ;; inter-operability with LibreOffice, only automatic styles are
3315 ;; used for styling of table-cells. The current implementation is
3316 ;; congruent with ODF-1.2 specification and hence is
3317 ;; future-compatible.
3319 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3320 ;; which recognizes as many as 16 different cell types - is much
3321 ;; richer. Unfortunately it is NOT amenable to easy configuration
3322 ;; by hand.
3349 "Transcode a TABLE-CELL element from Org to ODT.
3350 CONTENTS is nil. INFO is a plist used as a communication
3351 channel."
3358 table-cell info))
3381 table-cell info))))))
3385 custom-style-prefix))
3387 "OrgTblCell"
3403 cell-attributes
3406 org-element-all-elements)
3407 contents
3409 paragraph-style contents))))
3416 ;;;; Table Row
3419 "Transcode a TABLE-ROW element from Org to ODT.
3420 CONTENTS is the contents of the row. INFO is a plist used as a
3421 communication channel."
3422 ;; Rules are ignored since table separators are deduced from
3423 ;; borders of the current row.
3429 ;; If the row belongs to the first rowgroup and the
3430 ;; table has more than one row groups, then this row
3431 ;; belongs to the header row group.
3433 ;; Otherwise, it belongs to non-header row group.
3436 ;; Does this row begin a rowgroup?
3439 ;; Actual table row
3441 ;; Does this row end a rowgroup?
3446 ;;;; Table
3459 "Transcode a TABLE element from Org to ODT.
3460 CONTENTS is the contents of the table. INFO is a plist holding
3461 contextual information."
3463 ;; Case 1: table.el doesn't support export to OD format. Strip
3464 ;; such tables from export.
3469 "(ox-odt): Found table.el-type table in the source Org file."
3470 " table.el doesn't support export to ODT format."
3472 ;; Case 2: Native Org tables.
3489 column-style))
3490 out)
3494 ;; caption.
3498 ;; begin table.
3506 ;; column specification.
3508 ;; actual contents.
3510 ;; end table.
3514 "Transcode a TABLE element from Org to ODT.
3515 CONTENTS is the contents of the table. INFO is a plist holding
3516 contextual information.
3518 Use `org-odt--table' to typeset the table. Handle details
3519 pertaining to indentation here."
3534 collect el)))
3540 collect
3545 parent-list)
3547 ;; Handle list genealogy.
3567 parent-list info)
3570 ;; Handle low-level headlines.
3572 with step = 'item collect
3580 el info)
3581 "OrgNumberedList"
3592 parent-list info)))
3600 table info)))
3601 ;; OpenDocument schema does not permit table to occur within a
3602 ;; list item.
3604 ;; One solution - the easiest and lightweight, in terms of
3605 ;; implementation - is to put the table in an indented text box
3606 ;; and make the text box part of the list-item. Unfortunately if
3607 ;; the table is big and spans multiple pages, the text box could
3608 ;; overflow. In this case, the following attribute will come
3609 ;; handy.
3611 ;; ,---- From OpenDocument-v1.1.pdf
3612 ;; | 15.27.28 Overflow behavior
3613 ;; |
3614 ;; | For text boxes contained within text document, the
3615 ;; | style:overflow-behavior property specifies the behavior of text
3616 ;; | boxes where the containing text does not fit into the text
3617 ;; | box.
3618 ;; |
3619 ;; | If the attribute's value is clip, the text that does not fit
3620 ;; | into the text box is not displayed.
3621 ;; |
3622 ;; | If the attribute value is auto-create-new-frame, a new frame
3623 ;; | will be created on the next page, with the same position and
3624 ;; | dimensions of the original frame.
3625 ;; |
3626 ;; | If the style:overflow-behavior property's value is
3627 ;; | auto-create-new-frame and the text box has a minimum width or
3628 ;; | height specified, then the text box will grow until the page
3629 ;; | bounds are reached before a new frame is created.
3630 ;; `----
3632 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3633 ;; auto-create-new-frame property and always resorts to clipping
3634 ;; the text box. This results in table being truncated.
3636 ;; So we solve the problem the hard (and fun) way using list
3637 ;; continuations.
3639 ;; The problem only becomes more interesting if you take in to
3640 ;; account the following facts:
3641 ;;
3642 ;; - Description lists are simulated as plain lists.
3643 ;; - Low-level headlines can be listified.
3644 ;; - In Org-mode, a table can occur not only as a regular list
3645 ;; item, but also within description lists and low-level
3646 ;; headlines.
3648 ;; See `org-odt-translate-description-lists' and
3649 ;; `org-odt-translate-low-level-headlines' for how this is
3650 ;; tackled.
3653 ;; Discontinue the list.
3655 ;; Put the table in an indented section.
3660 ;; Continue the list.
3664 ;;;; Target
3667 "Transcode a TARGET object from Org to ODT.
3668 CONTENTS is nil. INFO is a plist holding contextual
3669 information."
3673 ;;;; Timestamp
3676 "Transcode a TIMESTAMP object from Org to ODT.
3677 CONTENTS is nil. INFO is a plist used as a communication
3678 channel."
3695 "OrgActiveTimestamp"
3699 "OrgInactiveTimestamp"
3703 "OrgActiveTimestamp"
3709 "OrgInactiveTimestamp"
3715 "OrgDiaryTimestamp"
3717 info)))))))
3720 ;;;; Underline
3723 "Transcode UNDERLINE from Org to ODT.
3724 CONTENTS is the text with underline markup. INFO is a plist
3725 holding contextual information."
3730 ;;;; Verbatim
3733 "Transcode a VERBATIM object from Org to ODT.
3734 CONTENTS is nil. INFO is a plist used as a communication
3735 channel."
3741 ;;;; Verse Block
3744 "Transcode a VERSE-BLOCK element from Org to ODT.
3745 CONTENTS is verse block contents. INFO is a plist holding
3746 contextual information."
3747 ;; Add line breaks to each line of verse.
3751 ;; Replace tabs and spaces.
3753 ;; Surround it in a verse environment.
3758 \f
3759 ;;; Filters
3761 ;;;; LaTeX fragments
3766 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3767 ;; If the desired converter is not available, force verbatim
3768 ;; processing.
3786 ;; Store normalized value for later use.
3791 ;; Convert `latex-fragment's and `latex-environment's.
3810 ;; Get an Org-style link to PNG image or the MathML
3811 ;; file.
3816 nil display-msg
3817 nil processing-type)
3822 nil))))
3824 ;; Conversion succeeded. Parse above Org-style link to
3825 ;; a `link' object.
3832 ;; Case 1: LaTeX environment. Mimic
3833 ;; a "standalone image or formula" by
3834 ;; enclosing the `link' in a `paragraph'.
3835 ;; Copy over original attributes, captions to
3836 ;; the enclosing paragraph.
3841 :name
3843 :caption
3845 link))
3846 ;; Case 2: LaTeX fragment. No special action.
3848 ;; Note down the object that link replaces.
3852 ;; Restore blank after initial element or object.
3854 replacement :post-blank
3856 ;; Replace now.
3858 info nil nil t)))
3859 tree)
3862 ;;;; Description lists
3864 ;; This translator is necessary to handle indented tables in a uniform
3865 ;; manner. See comment in `org-odt--table'.
3868 ;; OpenDocument has no notion of a description list. So simulate it
3869 ;; using plain lists. Description lists in the exported document
3870 ;; are typeset in the same manner as they are in a typical HTML
3871 ;; document.
3872 ;;
3873 ;; Specifically, a description list like this:
3874 ;;
3875 ;; ,----
3876 ;; | - term-1 :: definition-1
3877 ;; | - term-2 :: definition-2
3878 ;; `----
3879 ;;
3880 ;; gets translated in to the following form:
3881 ;;
3882 ;; ,----
3883 ;; | - term-1
3884 ;; | - definition-1
3885 ;; | - term-2
3886 ;; | - definition-2
3887 ;; `----
3888 ;;
3889 ;; Further effect is achieved by fixing the OD styles as below:
3890 ;;
3891 ;; 1. Set the :type property of the simulated lists to
3892 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3893 ;; that has *no* bullets whatsoever.
3894 ;;
3895 ;; 2. The paragraph containing the definition term is styled to be
3896 ;; in bold.
3897 ;;
3902 el
3918 nil)
3919 info)
3920 tree)
3922 ;;;; List tables
3924 ;; Lists that are marked with attribute `:list-table' are called as
3925 ;; list tables. They will be rendered as a table within the exported
3926 ;; document.
3928 ;; Consider an example. The following list table
3929 ;;
3930 ;; #+attr_odt :list-table t
3931 ;; - Row 1
3932 ;; - 1.1
3933 ;; - 1.2
3934 ;; - 1.3
3935 ;; - Row 2
3936 ;; - 2.1
3937 ;; - 2.2
3938 ;; - 2.3
3939 ;;
3940 ;; will be exported as though it were an Org table like the one show
3941 ;; below.
3942 ;;
3943 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3944 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3945 ;;
3946 ;; Note that org-tables are NOT multi-line and each line is mapped to
3947 ;; a unique row in the exported document. So if an exported table
3948 ;; needs to contain a single paragraph (with copious text) it needs to
3949 ;; be typed up in a single line. Editing such long lines using the
3950 ;; table editor will be a cumbersome task. Furthermore inclusion of
3951 ;; multi-paragraph text in a table cell is well-nigh impossible.
3952 ;;
3953 ;; A LIST-TABLE circumvents above problems.
3954 ;;
3955 ;; Note that in the example above the list items could be paragraphs
3956 ;; themselves and the list can be arbitrarily deep.
3957 ;;
3958 ;; Inspired by following thread:
3959 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3961 ;; Translate lists to tables
3967 ;; Replace list with table.
3969 l1-list
3970 ;; Build replacement table.
3976 l1-item-leading-text l2-list)
3977 ;; Remove Level-2 list from the Level-item. It
3978 ;; will be subsequently attached as table-cells.
3988 ;; Level-1 items start a table row.
3991 ;; Leading text of level-1 item define
3992 ;; the first table-cell.
3995 l1-item-leading-text)
3996 ;; Level-2 items define subsequent
3997 ;; table-cells of the row.
4005 nil)
4006 info)
4007 tree)
4009 \f
4010 ;;; Interactive functions
4023 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4032 org-odt-manifest-file-entries)
4040 ;; Initialize temporary workarea. All files that end up in
4041 ;; the exported document get parked/created here.
4048 ;; Kill all XML buffers.
4056 org-odt-xml-files)
4057 ;; Delete temporary directory and also other embedded
4058 ;; files that get copied there.
4063 ;; Not at all OSes ship with zip by default
4065 ;; Do export. This creates a bunch of xml files ready to be
4066 ;; saved and zipped.
4068 ;; Create a manifest entry for content.xml.
4070 ;; Write mimetype file
4079 ;; Write out the manifest entries before zipping
4081 ;; Save all XML files.
4087 ;; Prettify output if needed.
4091 org-odt-xml-files)
4092 ;; Run zip.
4097 ;; If a file with same name as the desired output file
4098 ;; exists, remove it.
4101 ;; Zip up the xml files.
4104 ;; Switch temporarily to content.xml. This way Zip
4105 ;; process will inherit `org-odt-zip-dir' as the current
4106 ;; directory.
4120 err-string)))
4121 cmds)))
4122 ;; Move the zip file from temporary work directory to
4123 ;; user-mandated location.
4126 ;; Cleanup work directory and work files.
4128 ;; Open the OpenDocument file in archive-mode for
4129 ;; examination.
4131 ;; Return exported file.
4133 ;; Case 1: Conversion desired on exported file. Run the
4134 ;; converter on the OpenDocument file. Return the
4135 ;; converted file.
4138 target))
4139 ;; Case 2: No further conversion. Return exported
4140 ;; OpenDocument file.
4143 ;; Cleanup work directory and work files.
4149 ;;;; Export to OpenDocument formula
4151 ;;;###autoload
4153 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4154 Use `org-create-math-formula' to convert LATEX-FRAG first to
4155 MathML. When invoked as an interactive command, use
4156 `org-latex-regexps' to infer LATEX-FRAG from currently active
4157 region. If no LaTeX fragments are found, prompt for it. Push
4158 MathML source to kill ring depending on the value of
4159 `org-export-copy-to-kill-ring'."
4185 filename
4198 ;; Add MathML to kill ring, if needed.
4202 ;;;###autoload
4204 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4205 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4206 formula file."
4211 ;;;; Export to OpenDocument Text
4213 ;;;###autoload
4215 "Export current buffer to a ODT file.
4217 If narrowing is active in the current buffer, only export its
4218 narrowed part.
4220 If a region is active, export that region.
4222 A non-nil optional argument ASYNC means the process should happen
4223 asynchronously. The resulting file should be accessible through
4224 the `org-export-stack' interface.
4226 When optional argument SUBTREEP is non-nil, export the sub-tree
4227 at point, extracting information from the headline properties
4228 first.
4230 When optional argument VISIBLE-ONLY is non-nil, don't export
4231 contents of hidden elements.
4233 EXT-PLIST, when provided, is a property list with external
4234 parameters overriding Org default settings, but still inferior to
4235 file-local settings.
4237 Return output file's name."
4244 ,outfile
4249 ;; Let `htmlfontify' know that we are interested in
4250 ;; collecting styles.
4252 ;; Initialize content.xml and kick-off the export
4253 ;; process.
4266 outfile
4271 ;; Let `htmlfontify' know that we are interested in collecting
4272 ;; styles.
4274 ;; Initialize content.xml and kick-off the export process.
4284 ;;;; Convert between OpenDocument and other formats
4287 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4296 "Workhorse routine for `org-odt-convert'."
4305 in-fmt out-fmt)))
4333 out-file)
4336 nil))))
4339 "Return verbose info about formats to which IN-FMT can be converted.
4340 Return a list where each element is of the
4341 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4342 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4343 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4347 org-odt-convert-processes t))))
4351 org-odt-convert-processes t))
4352 org-odt-convert-capabilities))
4353 reachable-formats)
4358 reachable-formats))
4361 "Return list of formats to which IN-FMT can be converted.
4362 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4368 l))
4371 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4372 This is a helper routine for interactive use."
4375 nil buffer-file-name t))
4381 out-fmt-choices nil nil nil))
4383 "No known converter or no known output formats for %s files"
4384 in-fmt))))
4387 ;;;###autoload
4389 "Convert IN-FILE to format OUT-FMT using a command line converter.
4390 IN-FILE is the file to be converted. If unspecified, it defaults
4391 to variable `buffer-file-name'. OUT-FMT is the desired output
4392 format. Use `org-odt-convert-process' as the converter.
4393 If PREFIX-ARG is non-nil then the newly converted file is opened
4394 using `org-open-file'."
4399 ;;; Library Initializations
4403 ;; Let Emacs open all OpenDocument files in archive mode
4406 org-odt-file-extensions)
4410 ;; Local variables:
4411 ;; generated-autoload-file: "org-loaddefs.el"
4412 ;; End:
4414 ;;; ox-odt.el ends here