| blob | 31b06de91e0076d203a72d0d15cb9f1709ee8604 |
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.
1387 ;; Non-availability of styles.xml is not a critical
1388 ;; error. For now, throw an error.
1392 org-odt-styles-dir)
1405 members)))
1417 ;; create a manifest entry for styles.xml
1420 ;; FIXME: Who is opening an empty styles.xml before this point?
1425 ;; Write custom styles for source blocks
1426 ;; Save STYLES used for colorizing of source blocks.
1427 ;; Update styles.xml with styles that were collected as part of
1428 ;; `org-odt-hfy-face-to-css' callbacks.
1437 ;; Update styles.xml - take care of outline numbering
1439 ;; Don't make automatic backup of styles.xml file. This setting
1440 ;; prevents the backed-up styles.xml file from being zipped in to
1441 ;; odt file. This is more of a hackish fix. Better alternative
1442 ;; would be to fix the zip command so that the output odt file
1443 ;; includes only the needed files and excludes any auto-generated
1444 ;; extra files like backups and auto-saves etc etc. Note that
1445 ;; currently the zip command zips up the entire temp directory so
1446 ;; that any auto-generated files created under the hood ends up in
1447 ;; the resulting odt file.
1450 ;; Outline numbering is retained only upto LEVEL.
1451 ;; To disable outline numbering pass a LEVEL of 0.
1464 ;; Update content.xml.
1467 ;; within the context of the Org buffer. So obtain its
1468 ;; value before moving on to temp-buffer context down below.
1478 org-odt-styles-dir)))
1479 ;; Write automatic styles.
1480 ;; - Position the cursor.
1484 ;; - Dump automatic table styles.
1489 ;; - Dump date-styles.
1495 ;; Update display level.
1496 ;; - Remove existing sequence decls. Also position the cursor.
1501 ;; Update sequence decls according to user preference.
1512 ;; Position the cursor to document body.
1517 ;; Preamble - Title, Author, Date etc.
1527 ;; Switch on or off above vars based on user settings
1531 ;; Title.
1536 ;; Separator.
1538 ;; Subtitle.
1544 subtitle
1546 ;; Separator.
1550 ;; Author only.
1553 "OrgSubtitle"
1555 ;; Separator.
1558 ;; Author and E-mail.
1562 "OrgSubtitle"
1567 ;; Separator.
1569 ;; Date, if required.
1572 ;; Check if DATE is specified as a timestamp.
1579 "OrgSubtitle"
1583 ;; Separator
1585 ;; Table of Contents
1588 with-toc
1591 ;; Contents.
1593 ;; Return contents.
1597 \f
1598 ;;; Transcode Functions
1600 ;;;; Bold
1603 "Transcode BOLD from Org to ODT.
1604 CONTENTS is the text with bold markup. INFO is a plist holding
1605 contextual information."
1610 ;;;; Center Block
1613 "Transcode a CENTER-BLOCK element from Org to ODT.
1614 CONTENTS holds the contents of the center block. INFO is a plist
1615 holding contextual information."
1616 contents)
1619 ;;;; Clock
1622 "Transcode a CLOCK element from Org to ODT.
1623 CONTENTS is nil. INFO is a plist used as a communication
1624 channel."
1637 ;;;; Code
1640 "Transcode a CODE object from Org to ODT.
1641 CONTENTS is nil. INFO is a plist used as a communication
1642 channel."
1648 ;;;; Comment
1650 ;; Comments are ignored.
1653 ;;;; Comment Block
1655 ;; Comment Blocks are ignored.
1658 ;;;; Drawer
1661 "Transcode a DRAWER element from Org to ODT.
1662 CONTENTS holds the contents of the block. INFO is a plist
1663 holding contextual information."
1666 name contents)))
1667 output))
1670 ;;;; Dynamic Block
1673 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1674 CONTENTS holds the contents of the block. INFO is a plist
1675 holding contextual information. See `org-export-data'."
1676 contents)
1679 ;;;; Entity
1682 "Transcode an ENTITY object from Org to ODT.
1683 CONTENTS are the definition itself. INFO is a plist holding
1684 contextual information."
1688 ;;;; Example Block
1691 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1692 CONTENTS is nil. INFO is a plist holding contextual information."
1696 ;;;; Export Snippet
1699 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1700 CONTENTS is nil. INFO is a plist holding contextual information."
1705 ;;;; Export Block
1708 "Transcode a EXPORT-BLOCK element from Org to ODT.
1709 CONTENTS is nil. INFO is a plist holding contextual information."
1714 ;;;; Fixed Width
1717 "Transcode a FIXED-WIDTH element from Org to ODT.
1718 CONTENTS is nil. INFO is a plist holding contextual information."
1722 ;;;; Footnote Definition
1724 ;; Footnote Definitions are ignored.
1727 ;;;; Footnote Reference
1730 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1731 CONTENTS is nil. INFO is a plist holding contextual information."
1741 id note-class
1754 "OrgSuperscript"
1755 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1756 note-class ref-format ref-name n)))))))
1758 ;; Insert separator between two footnotes in a row.
1763 ;; Transcode footnote reference.
1771 footnote-reference info))
1775 raw
1778 :transcoders
1781 p c i
1782 "Footnote"
1783 "OrgFootnoteCenter"
1785 info))))
1786 ;; Inline definitions are secondary strings. We
1787 ;; need to wrap them within a paragraph.
1789 org-element-all-elements)
1790 def
1793 def)))))
1797 ;;;; Headline
1800 &optional format-function
1802 "Transcode a HEADLINE element using BACKEND.
1803 INFO is a plist holding contextual information."
1826 &key level section-number headline-label
1829 todo todo-type priority text tags))))))
1831 todo todo-type priority text tags
1836 "Transcode a HEADLINE element from Org to ODT.
1837 CONTENTS holds the contents of the headline. INFO is a plist
1838 holding contextual information."
1839 ;; Case 1: This is a footnote section: ignore it.
1842 ;; Create the headline text.
1844 ;; Get level relative to current parsed data.
1847 ;; Get canonical label for the headline.
1849 ;; Extra targets.
1853 ;; Title.
1856 ;; Case 2. This is a deep sub-tree: export it as a list item.
1857 ;; Also export as items headlines for which no section
1858 ;; format has been found.
1860 ;; Build the real contents of the sub-tree.
1864 ;; Choose style based on list type.
1866 ;; If top-level list, re-start numbering. Otherwise,
1867 ;; continue numbering.
1870 headline)))
1880 "Text_20_body"
1882 contents)
1884 "</text:list-header>"
1888 ;; Case 3. Standard headline. Export it as a section.
1892 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1895 level
1898 contents))))))
1902 "Default format function for a headline.
1903 See `org-odt-format-headline-function' for details."
1905 ;; Todo.
1913 style priority)))
1914 ;; Title.
1915 text
1916 ;; Tags.
1919 "<text:tab/>"
1928 ;;;; Horizontal Rule
1931 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1932 CONTENTS is nil. INFO is a plist holding contextual information."
1937 ;;;; Inline Babel Call
1939 ;; Inline Babel Calls are ignored.
1942 ;;;; Inline Src Block
1945 "Return a character not used in string S.
1947 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1953 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1954 CONTENTS holds the contents of the item. INFO is a plist holding
1955 contextual information."
1962 ;;;; Inlinetask
1965 "Transcode an INLINETASK element from Org to ODT.
1966 CONTENTS holds the contents of the block. INFO is a plist
1967 holding contextual information."
1979 todo todo-type priority text tags contents)))
1983 "Default format function for a inlinetasks.
1984 See `org-odt-format-inlinetask-function' for details."
1986 "Text_20_body"
1990 "OrgInlineTaskHeading"
1992 todo todo-type priority name tags))
1993 contents)
1996 ;;;; Italic
1999 "Transcode ITALIC from Org to ODT.
2000 CONTENTS is the text with italic markup. INFO is a plist holding
2001 contextual information."
2006 ;;;; Item
2009 "Transcode an ITEM element from Org to ODT.
2010 CONTENTS holds the contents of the item. INFO is a plist holding
2011 contextual information."
2022 contents
2034 ;;;; Keyword
2037 "Transcode a KEYWORD element from Org to ODT.
2038 CONTENTS is nil. INFO is a plist holding contextual
2039 information."
2045 ;; FIXME
2057 ;; FIXME
2061 ;;;; Latex Environment
2064 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2065 ;; (defadvice org-format-latex-as-mathml ; FIXME
2066 ;; (after org-odt-protect-latex-fragment activate)
2067 ;; "Encode LaTeX fragment as XML.
2068 ;; Do this when translation to MathML fails."
2069 ;; (unless (> (length ad-return-value) 0)
2070 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2073 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2074 CONTENTS is nil. INFO is a plist holding contextual information."
2080 ;;;; Latex Fragment
2082 ;; (when latex-frag ; FIXME
2083 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2084 ;; :description latex-frag)))
2085 ;; handle verbatim
2086 ;; provide descriptions
2089 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2090 CONTENTS is nil. INFO is a plist holding contextual information."
2097 ;;;; Line Break
2100 "Transcode a LINE-BREAK object from Org to ODT.
2101 CONTENTS is nil. INFO is a plist holding contextual information."
2105 ;;;; Link
2107 ;;;; Links :: Label references
2118 x)))))
2129 counter))
2132 element
2134 info))
2138 ;; Section number.
2142 ;; Separator.
2144 ;; Ordinal.
2146 tag))
2149 "Return a label for ELEMENT.
2151 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2152 element. INFO is a plist used as a communication channel. OP is
2153 either `definition' or `reference', depending on the purpose of
2154 the generated string.
2156 Return value is a string if OP is set to `reference' or a cons
2157 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2158 SHORT-CAPTION are strings."
2164 ;; Get label and caption.
2170 ;; FIXME: We don't use short-caption for now
2186 element))))
2189 seqno)
2193 ;; Compute sequence number of the element.
2195 ;; Localize category string.
2198 ;; Case 1: Handle Label definition.
2202 ;; Sneak in a bookmark. The bookmark is used when the
2203 ;; labeled element is referenced with a link that
2204 ;; provides its own description.
2206 ;; Label definition: Typically formatted as below:
2207 ;; CATEGORY SEQ-NO: LONG CAPTION
2208 ;; with translation for correct punctuation.
2215 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2216 label counter counter seqno))
2218 short-caption))
2219 ;; Case 2: Handle Label reference.
2224 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2225 fmt1
2226 label
2231 ;;;; Links :: Inline Images
2234 "Returns the internal name of the file"
2250 target-file))
2273 ;; Use Imagemagick.
2278 file))))
2283 ;; Use Emacs.
2289 ;; Use hard-coded values.
2291 org-odt-default-image-sizes-alist))
2292 ;; Error out.
2305 ;; ensure that an embedded image fits comfortably within a page
2316 "Return ODT code for an inline image.
2317 LINK is the link pointing to the inline image. INFO is a plist
2318 used as a communication channel."
2331 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2333 ;; Extract attributes from #+ATTR_ODT line.
2337 ;; Convert attributes to a plist.
2339 ;; Handle `:anchor', `:style' and `:attributes' properties.
2349 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2350 ;;
2351 ;; Handle `:width', `:height' and `:scale' properties. Read
2352 ;; them as numbers since we need them for computations.
2354 src-expanded info
2361 nil ; embed-as
2363 ))
2370 ;; Check if this link was created by LaTeX-to-PNG converter.
2374 ;; If yes, note down the type of the element - LaTeX Fragment
2375 ;; or LaTeX environment. It will go in to frame title.
2379 ;; If yes, note down its contents. It will go in to frame
2380 ;; description. This quite useful for debugging.
2383 captions user-frame-params title desc)))
2386 ;;;; Links :: Math formula
2407 ;; Check if this link was created by LaTeX-to-MathML
2408 ;; converter.
2412 ;; If yes, note down the type of the element - LaTeX Fragment
2413 ;; or LaTeX environment. It will go in to frame title.
2417 ;; If yes, note down its contents. It will go in to frame
2418 ;; description. This quite useful for debugging.
2420 width height)
2424 nil nil title desc))
2427 "CaptionedDisplayFormula" href width height
2428 captions nil title desc))
2432 org-odt--enumerable-formula-p))))
2437 "Returns the internal name of the file"
2441 ;; Create a directory for holding formula file. Also enter it in
2442 ;; to manifest.
2446 ;; Copy over the formula file from user directory to zip
2447 ;; directory.
2451 ;; Case 1: Mathml.
2454 ;; Case 2: OpenDocument formula.
2459 ;; Enter the formula file in to manifest.
2461 target-file))
2463 ;;;; Targets
2466 captions user-frame-params
2469 ;; Each element of this alist is of the form (CFG-HANDLE
2470 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2472 ;; CFG-HANDLE is the key to the alist.
2474 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2475 ;; frame params for INNER-FRAME and OUTER-FRAME
2476 ;; respectively. See below.
2478 ;; Configurations that are meant to be applied to
2479 ;; non-captioned image/formula specifies no
2480 ;; OUTER-FRAME-PARAMS.
2482 ;; TERMINOLOGY
2483 ;; ===========
2484 ;; INNER-FRAME :: Frame that directly surrounds an
2485 ;; image/formula.
2487 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2488 ;; frame also contains the caption, if any.
2490 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2491 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2492 ;; that these are the last three arguments
2493 ;; to `org-odt--frame'.
2495 ;; Note that an un-captioned image/formula requires just an
2496 ;; INNER-FRAME, while a captioned image/formula requires
2497 ;; both an INNER and an OUTER-FRAME.
2519 ;; Retrieve inner and outer frame params, from configuration.
2523 ;; User-specified frame params (from #+ATTR_ODT spec)
2527 "Merge default and user frame params."
2532 for d in default
2535 ;; Case 1: Image/Formula has no caption.
2536 ;; There is only one frame, one that surrounds the image
2537 ;; or formula.
2539 ;; Merge user frame params with that from configuration.
2543 ;; Case 2: Image/Formula is captioned or labeled.
2544 ;; There are two frames: The inner one surrounds the
2545 ;; image or formula. The outer one contains the
2546 ;; caption/sequence number.
2548 ;; Merge user frame params with outer frame params.
2550 ;; Short caption, if specified, goes as part of inner frame.
2557 frame-params))
2560 "Illustration"
2564 caption))
2565 width height outer)))))
2568 ;; Element should have a caption or label.
2574 element info
2575 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2576 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2577 ;; processing.)
2582 ;; Link should point to an image file.
2589 element info
2590 ;; Paragraph should have a caption or label. It SHOULD also be a
2591 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2592 ;; processing.)
2597 ;; Link should point to an image file.
2604 element info
2605 ;; Paragraph should have a caption or label.
2609 ;; Link should point to a MathML or ODF file.
2615 paragraph-predicate
2616 link-predicate)
2617 "Test if ELEMENT is a standalone link for the purpose ODT export.
2618 INFO is a plist holding contextual information.
2620 Return non-nil, if ELEMENT is of type paragraph satisfying
2621 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2622 is a link that satisfies LINK-PREDICATE.
2624 Return non-nil, if ELEMENT is of type link satisfying
2625 LINK-PREDICATE and its containing paragraph satisfies
2626 PARAGRAPH-PREDICATE in addition to having no other content save for
2627 leading and trailing whitespaces.
2629 Return nil, otherwise."
2652 ;; DESTINATION is a headline or an element (like paragraph,
2653 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2655 ;; Note that labels that are attached to captioned entities - inline
2656 ;; images, math formulae and tables - get resolved as part of
2657 ;; `org-odt-format-label' and `org-odt--enumerate'.
2659 ;; Create a cross-reference to DESTINATION but make best-efforts to
2660 ;; create a *meaningful* description. Check item numbers, section
2661 ;; number and section title in that order.
2663 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2664 ;; FIXME: Handle footnote-definition footnote-reference?
2676 return x))
2677 ;; Get list item nos.
2682 plain-list)
2685 item info t))))))
2686 ;; Locate top-most listified headline.
2691 return x))
2692 ;; Get listified headline numbers.
2698 el info t)))))))
2699 ;; Combine item numbers from both the listified headlines and
2700 ;; regular list items.
2702 ;; Case 1: Check if all the parents of list item are numbered.
2703 ;; If yes, link to the item proper.
2706 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2707 label
2711 ;; Case 2: Locate a regular and numbered headline in the
2712 ;; hierarchy. Display its section number.
2715 ;; Test if destination is a numbered headline.
2721 return el))))
2722 ;; We found one.
2724 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2725 label
2728 ;; Case 4: Locate a regular headline in the hierarchy. Display
2729 ;; its title.
2733 return el)))
2734 ;; We found one.
2736 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2737 label
2743 "Transcode a LINK object from Org to ODT.
2745 DESC is the description part of the link, or the empty string.
2746 INFO is a plist holding contextual information. See
2747 `org-export-data'."
2750 ;; Ensure DESC really exists, or set it to nil.
2759 ;; Convert & to & for correct XML representation
2762 ;; Link type is handled by a special function.
2764 ;; Image file.
2768 ;; Formula file.
2772 ;; Radio target: Transcode target's contents and use them as
2773 ;; link's description.
2778 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2780 desc))))
2781 ;; Links pointing to a headline: Find destination and build
2782 ;; appropriate referencing command.
2788 ;; Fuzzy link points to a headline. If there's
2789 ;; a description, create a hyperlink. Otherwise, try to
2790 ;; provide a meaningful description.
2799 label desc))))
2800 ;; Fuzzy link points to a target. If there's a description,
2801 ;; create a hyperlink. Otherwise, try to provide
2802 ;; a meaningful description.
2807 ;; Fuzzy link points to some element (e.g., an inline image,
2808 ;; a math formula or a table).
2816 ;; LINK has no description. Create
2817 ;; a cross-reference showing entity's sequence
2818 ;; number.
2820 ;; LINK has description. Insert a hyperlink with
2821 ;; user-provided description.
2826 desc))))))))
2827 ;; Coderef: replace link with the reference name or the
2828 ;; equivalent line number.
2835 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2836 href line-no))))
2837 ;; External link with a description part.
2840 ;; Check if description is a link to an inline image.
2845 desc-element
2847 ;; Format link as a clickable image.
2849 path desc)
2850 ;; Otherwise, format it as a regular link.
2852 path desc))))
2853 ;; External link without a description part.
2856 path path))
2857 ;; No path, only description. Try to do something useful.
2862 ;;;; Node Property
2865 "Transcode a NODE-PROPERTY element from Org to ODT.
2866 CONTENTS is nil. INFO is a plist holding contextual
2867 information."
2874 ;;;; Paragraph
2877 "Return style of PARAGRAPH.
2878 Style is a symbol among `quoted', `centered' and nil."
2888 "Format paragraph according to given styles.
2889 PARAGRAPH is a paragraph type element. CONTENTS is the
2890 transcoded contents of that paragraph, as a string. INFO is
2891 a plist used as a communication channel. DEFAULT, CENTER and
2892 QUOTE are, respectively, style to use when paragraph belongs to
2893 no special environment, a center block, or a quote block."
2899 ;; If PARAGRAPH is a leading paragraph in an item that has
2900 ;; a checkbox, splice checkbox and paragraph contents
2901 ;; together.
2906 contents)))
2909 "Transcode a PARAGRAPH element from Org to ODT.
2910 CONTENTS is the contents of the paragraph, as a string. INFO is
2911 the plist used as a communication channel."
2913 paragraph contents info
2915 "OrgCenter"
2919 ;;;; Plain List
2922 "Transcode a PLAIN-LIST element from Org to ODT.
2923 CONTENTS is the contents of the list. INFO is a plist holding
2924 contextual information."
2926 ;; Choose style based on list type.
2932 ;; If top-level list, re-start numbering. Otherwise,
2933 ;; continue numbering.
2938 contents))
2940 ;;;; Plain Text
2953 line))
2964 "Transcode a TEXT string from Org to ODT.
2965 TEXT is the string to transcode. INFO is a plist holding
2966 contextual information."
2968 ;; Protect &, < and >.
2970 ;; Handle smart quotes. Be sure to provide original string since
2971 ;; OUTPUT may have been modified.
2974 ;; Convert special strings.
2980 org-odt-special-string-regexps))
2981 ;; Handle break preservation if required.
2985 ;; Return value.
2986 output))
2989 ;;;; Planning
2992 "Transcode a PLANNING element from Org to ODT.
2993 CONTENTS is nil. INFO is a plist used as a communication
2994 channel."
2996 "OrgPlanning"
3018 ;;;; Property Drawer
3021 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3022 CONTENTS holds the contents of the drawer. INFO is a plist
3023 holding contextual information."
3026 contents)))
3029 ;;;; Quote Block
3032 "Transcode a QUOTE-BLOCK element from Org to ODT.
3033 CONTENTS holds the contents of the block. INFO is a plist
3034 holding contextual information."
3035 contents)
3038 ;;;; Section
3043 style
3045 text)))
3049 "Transcode a SECTION element from Org to ODT.
3050 CONTENTS holds the contents of the section. INFO is a plist
3051 holding contextual information."
3052 contents)
3054 ;;;; Radio Target
3057 "Transcode a RADIO-TARGET object from Org to ODT.
3058 TEXT is the text of the target. INFO is a plist holding
3059 contextual information."
3063 ;;;; Special Block
3066 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3067 CONTENTS holds the contents of the block. INFO is a plist
3068 holding contextual information."
3072 ;; Annotation.
3078 ;; FIXME: Is `car' right thing to do below?
3088 contents)))))
3089 ;; Textbox.
3098 style extra anchor))))
3102 ;;;; Src Block
3105 "Create custom style for face FN.
3106 When FN is the default face, use its foreground and background
3108 use its color attribute to create a character style whose name
3109 is obtained from FN. Currently all attributes of FN other than
3110 color are ignored.
3112 The style name for a face FN is derived using the following
3113 operations on the face name in that order - de-dash, CamelCase
3115 `font-lock-function-name-face' is associated with
3129 background-color-val color-val))
3132 "
3180 code
3191 par-style loc))
3194 num-start refs))
3208 ;; Extract code and references.
3212 ;; Does the src block contain labels?
3214 ;; Does it have line numbers?
3221 "Transcode a SRC-BLOCK element from Org to ODT.
3222 CONTENTS holds the contents of the item. INFO is a plist holding
3223 contextual information."
3235 "Text_20_body"
3239 ;;;; Statistics Cookie
3242 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3243 CONTENTS is nil. INFO is a plist holding contextual information."
3249 ;;;; Strike-Through
3252 "Transcode STRIKE-THROUGH from Org to ODT.
3253 CONTENTS is the text with strike-through markup. INFO is a plist
3254 holding contextual information."
3259 ;;;; Subscript
3262 "Transcode a SUBSCRIPT object from Org to ODT.
3263 CONTENTS is the contents of the object. INFO is a plist holding
3264 contextual information."
3269 ;;;; Superscript
3272 "Transcode a SUPERSCRIPT object from Org to ODT.
3273 CONTENTS is the contents of the object. INFO is a plist holding
3274 contextual information."
3279 ;;;; Table Cell
3288 "Retrieve styles applicable to a table cell.
3289 R and C are (zero-based) row and column numbers of the table
3290 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3291 applicable to the current table. It is nil if the table is not
3292 associated with any style attributes.
3294 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3296 When STYLE-SPEC is nil, style the table cell the conventional way
3297 - choose cell borders based on row and column groupings and
3298 choose paragraph alignment based on `org-col-cookies' text
3299 property. See also
3300 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3302 When STYLE-SPEC is non-nil, ignore the above cookie and return
3303 styles congruent with the ODF-1.2 specification."
3309 info)))
3311 ;; LibreOffice - particularly the Writer - honors neither table
3312 ;; templates nor custom table-cell styles. Inorder to retain
3313 ;; inter-operability with LibreOffice, only automatic styles are
3314 ;; used for styling of table-cells. The current implementation is
3315 ;; congruent with ODF-1.2 specification and hence is
3316 ;; future-compatible.
3318 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3319 ;; which recognizes as many as 16 different cell types - is much
3320 ;; richer. Unfortunately it is NOT amenable to easy configuration
3321 ;; by hand.
3348 "Transcode a TABLE-CELL element from Org to ODT.
3349 CONTENTS is nil. INFO is a plist used as a communication
3350 channel."
3357 table-cell info))
3380 table-cell info))))))
3384 custom-style-prefix))
3386 "OrgTblCell"
3402 cell-attributes
3405 org-element-all-elements)
3406 contents
3408 paragraph-style contents))))
3415 ;;;; Table Row
3418 "Transcode a TABLE-ROW element from Org to ODT.
3419 CONTENTS is the contents of the row. INFO is a plist used as a
3420 communication channel."
3421 ;; Rules are ignored since table separators are deduced from
3422 ;; borders of the current row.
3428 ;; If the row belongs to the first rowgroup and the
3429 ;; table has more than one row groups, then this row
3430 ;; belongs to the header row group.
3432 ;; Otherwise, it belongs to non-header row group.
3435 ;; Does this row begin a rowgroup?
3438 ;; Actual table row
3440 ;; Does this row end a rowgroup?
3445 ;;;; Table
3458 "Transcode a TABLE element from Org to ODT.
3459 CONTENTS is the contents of the table. INFO is a plist holding
3460 contextual information."
3462 ;; Case 1: table.el doesn't support export to OD format. Strip
3463 ;; such tables from export.
3468 "(ox-odt): Found table.el-type table in the source Org file."
3469 " table.el doesn't support export to ODT format."
3471 ;; Case 2: Native Org tables.
3488 column-style))
3489 out)
3493 ;; caption.
3497 ;; begin table.
3505 ;; column specification.
3507 ;; actual contents.
3509 ;; end table.
3513 "Transcode a TABLE element from Org to ODT.
3514 CONTENTS is the contents of the table. INFO is a plist holding
3515 contextual information.
3517 Use `org-odt--table' to typeset the table. Handle details
3518 pertaining to indentation here."
3533 collect el)))
3539 collect
3544 parent-list)
3546 ;; Handle list genealogy.
3566 parent-list info)
3569 ;; Handle low-level headlines.
3571 with step = 'item collect
3579 el info)
3580 "OrgNumberedList"
3591 parent-list info)))
3599 table info)))
3600 ;; OpenDocument schema does not permit table to occur within a
3601 ;; list item.
3603 ;; One solution - the easiest and lightweight, in terms of
3604 ;; implementation - is to put the table in an indented text box
3605 ;; and make the text box part of the list-item. Unfortunately if
3606 ;; the table is big and spans multiple pages, the text box could
3607 ;; overflow. In this case, the following attribute will come
3608 ;; handy.
3610 ;; ,---- From OpenDocument-v1.1.pdf
3611 ;; | 15.27.28 Overflow behavior
3612 ;; |
3613 ;; | For text boxes contained within text document, the
3614 ;; | style:overflow-behavior property specifies the behavior of text
3615 ;; | boxes where the containing text does not fit into the text
3616 ;; | box.
3617 ;; |
3618 ;; | If the attribute's value is clip, the text that does not fit
3619 ;; | into the text box is not displayed.
3620 ;; |
3621 ;; | If the attribute value is auto-create-new-frame, a new frame
3622 ;; | will be created on the next page, with the same position and
3623 ;; | dimensions of the original frame.
3624 ;; |
3625 ;; | If the style:overflow-behavior property's value is
3626 ;; | auto-create-new-frame and the text box has a minimum width or
3627 ;; | height specified, then the text box will grow until the page
3628 ;; | bounds are reached before a new frame is created.
3629 ;; `----
3631 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3632 ;; auto-create-new-frame property and always resorts to clipping
3633 ;; the text box. This results in table being truncated.
3635 ;; So we solve the problem the hard (and fun) way using list
3636 ;; continuations.
3638 ;; The problem only becomes more interesting if you take in to
3639 ;; account the following facts:
3640 ;;
3641 ;; - Description lists are simulated as plain lists.
3642 ;; - Low-level headlines can be listified.
3643 ;; - In Org-mode, a table can occur not only as a regular list
3644 ;; item, but also within description lists and low-level
3645 ;; headlines.
3647 ;; See `org-odt-translate-description-lists' and
3648 ;; `org-odt-translate-low-level-headlines' for how this is
3649 ;; tackled.
3652 ;; Discontinue the list.
3654 ;; Put the table in an indented section.
3659 ;; Continue the list.
3663 ;;;; Target
3666 "Transcode a TARGET object from Org to ODT.
3667 CONTENTS is nil. INFO is a plist holding contextual
3668 information."
3672 ;;;; Timestamp
3675 "Transcode a TIMESTAMP object from Org to ODT.
3676 CONTENTS is nil. INFO is a plist used as a communication
3677 channel."
3694 "OrgActiveTimestamp"
3698 "OrgInactiveTimestamp"
3702 "OrgActiveTimestamp"
3708 "OrgInactiveTimestamp"
3714 "OrgDiaryTimestamp"
3716 info)))))))
3719 ;;;; Underline
3722 "Transcode UNDERLINE from Org to ODT.
3723 CONTENTS is the text with underline markup. INFO is a plist
3724 holding contextual information."
3729 ;;;; Verbatim
3732 "Transcode a VERBATIM object from Org to ODT.
3733 CONTENTS is nil. INFO is a plist used as a communication
3734 channel."
3740 ;;;; Verse Block
3743 "Transcode a VERSE-BLOCK element from Org to ODT.
3744 CONTENTS is verse block contents. INFO is a plist holding
3745 contextual information."
3746 ;; Add line breaks to each line of verse.
3750 ;; Replace tabs and spaces.
3752 ;; Surround it in a verse environment.
3757 \f
3758 ;;; Filters
3760 ;;;; LaTeX fragments
3765 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3766 ;; If the desired converter is not available, force verbatim
3767 ;; processing.
3785 ;; Store normalized value for later use.
3790 ;; Convert `latex-fragment's and `latex-environment's.
3809 ;; Get an Org-style link to PNG image or the MathML
3810 ;; file.
3815 nil display-msg
3816 nil processing-type)
3821 nil))))
3823 ;; Conversion succeeded. Parse above Org-style link to
3824 ;; a `link' object.
3831 ;; Case 1: LaTeX environment. Mimic
3832 ;; a "standalone image or formula" by
3833 ;; enclosing the `link' in a `paragraph'.
3834 ;; Copy over original attributes, captions to
3835 ;; the enclosing paragraph.
3840 :name
3842 :caption
3844 link))
3845 ;; Case 2: LaTeX fragment. No special action.
3847 ;; Note down the object that link replaces.
3851 ;; Restore blank after initial element or object.
3853 replacement :post-blank
3855 ;; Replace now.
3857 info nil nil t)))
3858 tree)
3861 ;;;; Description lists
3863 ;; This translator is necessary to handle indented tables in a uniform
3864 ;; manner. See comment in `org-odt--table'.
3867 ;; OpenDocument has no notion of a description list. So simulate it
3868 ;; using plain lists. Description lists in the exported document
3869 ;; are typeset in the same manner as they are in a typical HTML
3870 ;; document.
3871 ;;
3872 ;; Specifically, a description list like this:
3873 ;;
3874 ;; ,----
3875 ;; | - term-1 :: definition-1
3876 ;; | - term-2 :: definition-2
3877 ;; `----
3878 ;;
3879 ;; gets translated in to the following form:
3880 ;;
3881 ;; ,----
3882 ;; | - term-1
3883 ;; | - definition-1
3884 ;; | - term-2
3885 ;; | - definition-2
3886 ;; `----
3887 ;;
3888 ;; Further effect is achieved by fixing the OD styles as below:
3889 ;;
3890 ;; 1. Set the :type property of the simulated lists to
3891 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3892 ;; that has *no* bullets whatsoever.
3893 ;;
3894 ;; 2. The paragraph containing the definition term is styled to be
3895 ;; in bold.
3896 ;;
3901 el
3917 nil)
3918 info)
3919 tree)
3921 ;;;; List tables
3923 ;; Lists that are marked with attribute `:list-table' are called as
3924 ;; list tables. They will be rendered as a table within the exported
3925 ;; document.
3927 ;; Consider an example. The following list table
3928 ;;
3929 ;; #+attr_odt :list-table t
3930 ;; - Row 1
3931 ;; - 1.1
3932 ;; - 1.2
3933 ;; - 1.3
3934 ;; - Row 2
3935 ;; - 2.1
3936 ;; - 2.2
3937 ;; - 2.3
3938 ;;
3939 ;; will be exported as though it were an Org table like the one show
3940 ;; below.
3941 ;;
3942 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3943 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3944 ;;
3945 ;; Note that org-tables are NOT multi-line and each line is mapped to
3946 ;; a unique row in the exported document. So if an exported table
3947 ;; needs to contain a single paragraph (with copious text) it needs to
3948 ;; be typed up in a single line. Editing such long lines using the
3949 ;; table editor will be a cumbersome task. Furthermore inclusion of
3950 ;; multi-paragraph text in a table cell is well-nigh impossible.
3951 ;;
3952 ;; A LIST-TABLE circumvents above problems.
3953 ;;
3954 ;; Note that in the example above the list items could be paragraphs
3955 ;; themselves and the list can be arbitrarily deep.
3956 ;;
3957 ;; Inspired by following thread:
3958 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3960 ;; Translate lists to tables
3966 ;; Replace list with table.
3968 l1-list
3969 ;; Build replacement table.
3975 l1-item-leading-text l2-list)
3976 ;; Remove Level-2 list from the Level-item. It
3977 ;; will be subsequently attached as table-cells.
3987 ;; Level-1 items start a table row.
3990 ;; Leading text of level-1 item define
3991 ;; the first table-cell.
3994 l1-item-leading-text)
3995 ;; Level-2 items define subsequent
3996 ;; table-cells of the row.
4004 nil)
4005 info)
4006 tree)
4008 \f
4009 ;;; Interactive functions
4022 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4031 org-odt-manifest-file-entries)
4039 ;; Initialize temporary workarea. All files that end up in
4040 ;; the exported document get parked/created here.
4047 ;; Kill all XML buffers.
4055 org-odt-xml-files)
4056 ;; Delete temporary directory and also other embedded
4057 ;; files that get copied there.
4062 ;; Not at all OSes ship with zip by default
4064 ;; Do export. This creates a bunch of xml files ready to be
4065 ;; saved and zipped.
4067 ;; Create a manifest entry for content.xml.
4069 ;; Write mimetype file
4078 ;; Write out the manifest entries before zipping
4080 ;; Save all XML files.
4086 ;; Prettify output if needed.
4090 org-odt-xml-files)
4091 ;; Run zip.
4096 ;; If a file with same name as the desired output file
4097 ;; exists, remove it.
4100 ;; Zip up the xml files.
4103 ;; Switch temporarily to content.xml. This way Zip
4104 ;; process will inherit `org-odt-zip-dir' as the current
4105 ;; directory.
4119 err-string)))
4120 cmds)))
4121 ;; Move the zip file from temporary work directory to
4122 ;; user-mandated location.
4125 ;; Cleanup work directory and work files.
4127 ;; Open the OpenDocument file in archive-mode for
4128 ;; examination.
4130 ;; Return exported file.
4132 ;; Case 1: Conversion desired on exported file. Run the
4133 ;; converter on the OpenDocument file. Return the
4134 ;; converted file.
4137 target))
4138 ;; Case 2: No further conversion. Return exported
4139 ;; OpenDocument file.
4142 ;; Cleanup work directory and work files.
4148 ;;;; Export to OpenDocument formula
4150 ;;;###autoload
4152 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4153 Use `org-create-math-formula' to convert LATEX-FRAG first to
4154 MathML. When invoked as an interactive command, use
4155 `org-latex-regexps' to infer LATEX-FRAG from currently active
4156 region. If no LaTeX fragments are found, prompt for it. Push
4157 MathML source to kill ring depending on the value of
4158 `org-export-copy-to-kill-ring'."
4184 filename
4197 ;; Add MathML to kill ring, if needed.
4201 ;;;###autoload
4203 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4204 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4205 formula file."
4210 ;;;; Export to OpenDocument Text
4212 ;;;###autoload
4214 "Export current buffer to a ODT file.
4216 If narrowing is active in the current buffer, only export its
4217 narrowed part.
4219 If a region is active, export that region.
4221 A non-nil optional argument ASYNC means the process should happen
4222 asynchronously. The resulting file should be accessible through
4223 the `org-export-stack' interface.
4225 When optional argument SUBTREEP is non-nil, export the sub-tree
4226 at point, extracting information from the headline properties
4227 first.
4229 When optional argument VISIBLE-ONLY is non-nil, don't export
4230 contents of hidden elements.
4232 EXT-PLIST, when provided, is a property list with external
4233 parameters overriding Org default settings, but still inferior to
4234 file-local settings.
4236 Return output file's name."
4243 ,outfile
4248 ;; Let `htmlfontify' know that we are interested in
4249 ;; collecting styles.
4251 ;; Initialize content.xml and kick-off the export
4252 ;; process.
4265 outfile
4270 ;; Let `htmlfontify' know that we are interested in collecting
4271 ;; styles.
4273 ;; Initialize content.xml and kick-off the export process.
4283 ;;;; Convert between OpenDocument and other formats
4286 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4295 "Workhorse routine for `org-odt-convert'."
4304 in-fmt out-fmt)))
4332 out-file)
4335 nil))))
4338 "Return verbose info about formats to which IN-FMT can be converted.
4339 Return a list where each element is of the
4340 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4341 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4342 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4346 org-odt-convert-processes t))))
4350 org-odt-convert-processes t))
4351 org-odt-convert-capabilities))
4352 reachable-formats)
4357 reachable-formats))
4360 "Return list of formats to which IN-FMT can be converted.
4361 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4367 l))
4370 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4371 This is a helper routine for interactive use."
4374 nil buffer-file-name t))
4380 out-fmt-choices nil nil nil))
4382 "No known converter or no known output formats for %s files"
4383 in-fmt))))
4386 ;;;###autoload
4388 "Convert IN-FILE to format OUT-FMT using a command line converter.
4389 IN-FILE is the file to be converted. If unspecified, it defaults
4390 to variable `buffer-file-name'. OUT-FMT is the desired output
4391 format. Use `org-odt-convert-process' as the converter.
4392 If PREFIX-ARG is non-nil then the newly converted file is opened
4393 using `org-open-file'."
4398 ;;; Library Initializations
4402 ;; Let Emacs open all OpenDocument files in archive mode
4405 org-odt-file-extensions)
4409 ;; Local variables:
4410 ;; generated-autoload-file: "org-loaddefs.el"
4411 ;; End:
4413 ;;; ox-odt.el ends here