| blob | 364a106bff604592dec00c3a6c113c51593a8123 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2017 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
34 ;;; Define Back-End
87 org-odt--translate-description-lists
88 org-odt--translate-list-tables
89 org-odt--translate-image-links)))
90 :menu-entry
97 :options-alist
102 ;; Other variables.
115 ;; Redefine regular option.
119 ;;; Dependencies
121 ;;; Hooks
123 ;;; Function and Dynamically Scoped Variables Declarations
139 \f
140 ;;; Internal Variables
144 "Location of ODT exporter.
145 Use this to infer values of `org-odt-styles-dir' and
150 "Data directory for ODT exporter.
151 Use this to infer values of `org-odt-styles-dir' and
168 "List of directories to search for OpenDocument schema files.
169 Use this list to set the default value of
170 `org-odt-schema-dir'. The entries in this list are
171 populated heuristically based on the values of `org-odt-lib-dir'
184 )
185 "List of directories to search for OpenDocument styles files.
186 See `org-odt-styles-dir'. The entries in this list are populated
187 heuristically based on the values of `org-odt-lib-dir' and
198 org-odt-styles-dir-list)))
201 styles-dir)
202 "Directory that holds auxiliary XML files used by the ODT exporter.
204 This directory contains the following XML files -
206 XML files are used as the default values of
207 `org-odt-styles-file' and `org-odt-content-template-file'.
209 The default value of this variable varies depending on the
210 version of Org in use and is initialized from
211 `org-odt-styles-dir-list'. Note that the user could be using Org
212 from one of: Org own private git repository, GNU ELPA tar or
235 "
237 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
238 </style:style>
239 "
243 "Registry of automatic styles for various OBJECT-TYPEs.
244 The variable has the following form:
245 ((OBJECT-TYPE-A
246 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
247 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
248 (OBJECT-TYPE-B
249 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
250 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
251 ...).
254 OBJECT-PROPS is (typically) a plist created by passing
260 "Running counters for various OBJECT-TYPEs.
261 Use this to generate automatic names and style-names. See
265 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
266 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
267 <style:background-image/>
268 </style:paragraph-properties>
270 </style:style>"
271 "Custom paragraph style for colorized source and example blocks.
273 except that the foreground and background colors are set
287 "Hardcoded image dimensions one for each of the anchor
290 ;; A4 page size is 21.0 by 29.7 cms
291 ;; The default page settings has 2cm margin on each of the sides. So
292 ;; the effective text area is 17.0 by 25.7 cm
301 "Specify how labels are applied and referenced.
303 This is an alist where each element is of the form:
305 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
307 ATTACH-FMT controls how labels and captions are attached to an
308 entity. It may contain following specifiers - %e and %c. %e is
309 replaced with the CATEGORY-NAME. %n is replaced with
311 with CAPTION.
313 REF-MODE and REF-FMT controls how label references are generated.
314 The following XML is generated for a label reference -
317 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
318 %n is replaced with SEQNO.
328 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
330 This is a list where each entry is of the form:
332 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
334 CATEGORY_HANDLE identifies the captionable entity in question.
336 OD-VARIABLE is the OpenDocument sequence counter associated with
337 the entity. These counters are declared within
339 `org-odt-content-template-file'.
341 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
342 how a given entity should be captioned and referenced.
344 CATEGORY-NAME is used for qualifying captions on export.
346 ENUMERATOR-PREDICATE is used for assigning a sequence number to
356 \f
357 ;;; User Configuration Variables
360 "Options for exporting Org mode files to ODT."
365 ;;;; Debugging
368 "Specify whether or not the xml output should be prettified.
369 When this option is turned on, `indent-region' is run on all
370 component xml buffers before they are saved. Turn this off for
371 regular use. Turn this on if you need to examine the xml
372 visually."
378 ;;;; Document schema
389 org-odt-schema-dir-list)
390 "Directory that contains OpenDocument schema files.
392 This directory contains:
393 1. rnc files for OpenDocument schema
395 for auto validation of OpenDocument XML files.
397 Use the customize interface to set this variable. This ensures
398 that `rng-schema-locating-files' is updated and auto-validation
399 of OpenDocument XML takes place based on the value
400 `rng-nxml-auto-validate-flag'.
402 The default value of this variable varies depending on the
403 version of org in use and is initialized from
404 `org-odt-schema-dir-list'. The OASIS schema files are available
405 only in the org's private git repository. It is *not* bundled
406 with GNU ELPA tar or standard Emacs distribution."
412 :set
414 "Set `org-odt-schema-dir'.
415 Also add it to `rng-schema-locating-files'."
425 schema-dir
428 value))
429 nil)))
434 org-odt-schema-dir))))))
437 ;;;; Document styles
441 The exporter embeds the exported content just before
445 under `org-odt-styles-dir' is used."
452 "Default styles file for use with ODT export.
453 Valid values are one of:
454 1. nil
455 2. path to a styles.xml file
456 3. path to a *.odt or a *.ott file
457 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
458 ...))
460 In case of option 1, an in-built styles.xml is used. See
461 `org-odt-styles-dir' for more information.
463 In case of option 3, the specified file is unzipped and the
464 styles.xml embedded therein is used.
466 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
467 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
468 generated odt file. Use relative path for specifying the
469 FILE-MEMBERS. styles.xml must be specified as one of the
470 FILE-MEMBERS.
472 Use options 1, 2 or 3 only if styles.xml alone suffices for
473 achieving the desired formatting. Use option 4, if the styles.xml
474 references additional files like header and footer images for
475 achieving the desired formatting.
478 a per-file basis. For example,
484 :type
496 "Outline levels considered for enumerating captioned entities."
502 ;;;; Document conversion
509 "Specify a list of document converters and their usage.
510 The converters in this list are offered as choices while
511 customizing `org-odt-convert-process'.
513 This variable is a list where each element is of the
514 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
515 of the converter. CONVERTER-CMD is the shell command for the
516 converter and can contain format specifiers. These format
517 specifiers are interpreted as below:
519 %i input file name in full
520 %I input file name as a URL
521 %f format of the output file
522 %o output file name in full
523 %O output file name as a URL
524 %d output dir in full
525 %D output dir as a URL.
526 %x extra options as set in `org-odt-convert-capabilities'."
529 :type
538 During customization, the list of converter names are populated
539 from `org-odt-convert-processes'."
549 org-odt-convert-processes))))
567 "Specify input and output formats of `org-odt-convert-process'.
568 More correctly, specify the set of input and output formats that
569 the user is actually interested in.
571 This variable is an alist where each element is of the
572 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
573 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
574 alist where each element is of the form (OUTPUT-FMT
575 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
577 The variable is interpreted as follows:
578 `org-odt-convert-process' can take any document that is in
579 INPUT-FMT-LIST and produce any document that is in the
580 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
581 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
582 serves dual purposes:
583 - It is used for populating completion candidates during
584 `org-odt-convert' commands.
586 `org-odt-convert-process'.
589 `org-odt-convert-process'.
591 DOCUMENT-CLASS is used to group a set of file formats in
592 INPUT-FMT-LIST in to a single class.
594 Note that this variable inherently captures how LibreOffice based
595 converters work. LibreOffice maps documents of various formats
596 to classes like Text, Web, Spreadsheet, Presentation etc and
597 allow document of a given class (irrespective of its source
598 format) to be converted to any of the export formats associated
599 with that class.
601 See default setting of this variable for an typical
602 configuration."
605 :type
610 :value-type
614 :value-type
623 and then uses `org-odt-convert-process' to convert the
624 resulting document to this format. During customization of this
625 variable, the list of valid values are populated based on
626 `org-odt-convert-capabilities'.
628 You can set this option on per-file basis using file local
629 values. See Info node `(emacs) File Variables'."
640 ;;;###autoload
644 ;;;; Drawers
647 "Function called to format a drawer in ODT code.
649 The function must accept two parameters:
651 CONTENTS the contents of the drawer.
653 The function should return the string to be exported.
655 The default value simply returns the value of CONTENTS."
662 ;;;; Headline
665 'org-odt-format-headline-default-function
666 "Function to format headline text.
668 This function will be called with 5 arguments:
669 TODO the todo keyword (string or nil).
670 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
671 PRIORITY the priority of the headline (integer or nil)
672 TEXT the main headline text (string).
673 TAGS the tags string, separated with colons (string or nil).
675 The function result will be used as headline text."
682 ;;;; Inlinetasks
685 'org-odt-format-inlinetask-default-function
686 "Function called to format an inlinetask in ODT code.
688 The function must accept six parameters:
689 TODO the todo keyword, as a string
690 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
691 PRIORITY the inlinetask priority, as a string
692 NAME the inlinetask name, as a string.
693 TAGS the inlinetask tags, as a string.
694 CONTENTS the contents of the inlinetask, as a string.
696 The function should return the string to be exported."
703 ;;;; LaTeX
706 "Non-nil means process LaTeX math snippets.
708 When set, the exporter will process LaTeX environments and
709 fragments.
711 This option can also be set with the +OPTIONS line,
714 nil Ignore math snippets.
715 `verbatim' Keep everything in verbatim
716 `dvipng' Process the LaTeX fragments to images. This will also
717 include processing of non-math environments.
718 `imagemagick' Convert the LaTeX fragments to pdf files and use
719 imagemagick to convert pdf files to png files.
720 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
721 be loaded.
722 t Synonym for `mathjax'."
734 ;;;; Links
738 "Rules characterizing formula files that can be inlined into ODT.
740 A rule consists in an association whose key is the type of link
741 to consider, and value is a regexp that will be matched against
742 link's path."
751 "Rules characterizing image files that can be inlined into ODT.
753 A rule consists in an association whose key is the type of link
754 to consider, and value is a regexp that will be matched against
755 link's path."
763 "Scaling factor for converting images pixels to inches.
764 Use this for sizing of embedded images. See Info node `(org)
765 Images in ODT export' for more information."
772 ;;;; Src Block
775 "Whether custom styles for colorized source blocks be automatically created.
776 When this option is turned on, the exporter creates custom styles
777 for source blocks based on the advice of `htmlfontify'. Creation
778 of custom styles happen as part of `org-odt-hfy-face-to-css'.
780 When this option is turned off exporter does not create such
781 styles.
783 Use the latter option if you do not want the custom styles to be
784 based on your current display settings. It is necessary that the
785 styles.xml already contains needed styles for colorizing to work.
787 This variable is effective only if `org-odt-fontify-srcblocks' is
788 turned on."
794 "Specify whether or not source blocks need to be fontified.
795 Turn this option on if you want to colorize the source code
796 blocks in the exported file. For colorization to work, you need
797 to make available an enhanced version of `htmlfontify' library."
803 ;;;; Table
816 "Specify how Table Styles should be derived from a Table Template.
817 This is a list where each element is of the
818 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
820 TABLE-STYLE-NAME is the style associated with the table through
823 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
824 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
825 below) that is included in `org-odt-content-template-file'.
827 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
829 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
837 TABLE-CELL-OPTIONS is an alist where each element is of the
838 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
839 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
840 `use-last-row-styles' |
841 `use-first-column-styles' |
842 `use-last-column-styles' |
843 `use-banding-rows-styles' |
844 `use-banding-columns-styles' |
845 `use-first-row-styles'
846 ON-OR-OFF := t | nil
848 For example, with the following configuration
850 \(setq org-odt-table-styles
852 ((use-first-row-styles . t)
853 (use-first-column-styles . t)))
855 ((use-first-column-styles . t)))))
858 style will use the following table-cell styles -
863 as appropriate.
866 use the following table-cell styles -
868 following paragraph styles
870 as appropriate..
872 Note that TABLE-TEMPLATE-NAME corresponds to the
875 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
878 specification for more information. Also consult the
879 implementation filed under `org-odt-get-table-cell-styles'.
882 formatting of numbered display equations. Do not delete this
883 style from the list."
893 use-last-row-styles
894 use-first-column-styles
895 use-last-column-styles
896 use-banding-rows-styles
897 use-banding-columns-styles)
898 :key-type symbol
901 ;;;; Timestamps
904 "Non-nil, if timestamps should be exported as date fields.
906 When nil, export timestamps as plain text.
908 When non-nil, map `org-time-stamp-custom-formats' to a pair of
910 respectively. A timestamp with no time component is formatted
914 This feature is experimental. Most (but not all) of the common
915 %-specifiers in `format-time-string' are supported.
917 formatted as canonical Org timestamps. For finer control, avoid
918 these %-specifiers.
921 etc., are displayed by the application in the default language
922 and country specified in `org-odt-styles-file'. Note that the
924 can localize the week day and month strings in the exported
925 document by setting the default language and country either using
926 the application UI or through a custom styles file.
928 See `org-odt--build-date-styles' for implementation details."
935 \f
936 ;;; Internal functions
938 ;;;; Date
953 ;; LibreOffice does not care about end goes as content
954 ;; within the "<text:date>...</text:date>" field. The
955 ;; displayed date is automagically corrected to match the
956 ;; format requested by "style:data-style-name" attribute. So
957 ;; don't bother about formatting the date contents to be
958 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
959 ;; simple Org-style date should suffice.
984 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
985 iso-date style date)
987 repeater)))))
989 ;;;; Frame
997 extra
1003 style frame-attrs
1015 ;;;; Library wrappers
1022 ;; This is shamelessly stolen from `archive-zip-extract'.
1028 name)))
1033 exit-code command-output)
1042 ;;;; Target
1051 ;;;; Textbox
1054 extra anchor-type)
1060 text)
1061 width nil style extra anchor-type))
1065 ;;;; Table of Contents
1068 "Return a table of contents.
1069 TITLE is the title of the table, as a string, or nil. ENTRIES is
1070 the contents of the table, as a string. DEPTH is an integer
1071 specifying the depth of the table."
1073 "
1074 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1078 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1079 "
1080 title))
1086 "
1087 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1089 <text:index-entry-chapter/>
1090 <text:index-entry-text/>
1091 <text:index-entry-link-end/>
1094 "
1095 </text:table-of-content-source>
1096 <text:index-body>"
1102 title))
1103 entries
1104 "
1105 </text:index-body>
1112 headline-label
1114 ;; Section number.
1116 ;; Todo.
1121 style todo)))
1126 style priority)))
1127 ;; Title.
1128 text
1129 ;; Tags.
1133 "OrgTags"
1141 "Build a table of contents.
1142 DEPTH is an integer specifying the depth of the table. INFO is
1143 a plist containing current export properties. Optional argument
1144 SCOPE, when non-nil, defines the scope of the table. Return the
1145 table of contents as a string, or nil."
1147 ;; When a headline is marked as a radio target, as in the example below:
1148 ;;
1149 ;; ** <<<Some Heading>>>
1150 ;; Some text.
1151 ;;
1152 ;; suppress generation of radio targets. i.e., Radio targets are to
1153 ;; be marked as targets within /document body/ and *not* within
1154 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1155 ;; and one in the document body.
1156 ;;
1157 ;; Likewise, links, footnote references and regular targets are also
1158 ;; suppressed.
1176 style entry)))
1178 depth))))
1181 ;;;; Document styles
1184 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1185 OBJECT-PROPS is (typically) a plist created by passing
1187 `org-odt-parse-block-attributes'.
1189 Use `org-odt-object-counters' to generate an automatic
1190 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1191 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1192 . STYLE-NAME)."
1208 ;;;; Checkbox
1211 "Return check-box string associated to ITEM."
1220 ;;; Template
1223 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1224 ;; to modify the date fields. A date could be modified by
1225 ;; offsetting in days. That's about it. Also, date and time may
1226 ;; have to be emitted as two fields - a date field and a time field
1227 ;; - separately.
1229 ;; One can add Form Controls to date and time fields so that they
1230 ;; can be easily modified. But then, the exported document will
1231 ;; become tightly coupled with LibreOffice and may not function
1232 ;; properly with other OpenDocument applications.
1234 ;; I have a strange feeling that Date styles are a bit flaky at the
1235 ;; moment.
1237 ;; The feature is experimental.
1281 ))
1290 filler-end))
1301 style
1304 output ))))
1307 "Return complete document string after ODT conversion.
1308 CONTENTS is the transcoded contents string. RAW-DATA is the
1309 original parsed data. INFO is a plist holding export options."
1310 ;; Write meta file.
1320 <office:document-meta
1330 ;; Date, if required.
1332 ;; Check if DATE is specified as an Org-timestamp. If yes,
1333 ;; include it as meta information. Otherwise, just use
1334 ;; today's date.
1343 iso-date)))))
1352 subtitle))
1356 ;; Add meta.xml in to manifest.
1359 ;; Update styles file.
1360 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1361 ;; Write styles file.
1365 ;; Non-availability of styles.xml is not a critical
1366 ;; error. For now, throw an error.
1370 org-odt-styles-dir)
1393 ;; create a manifest entry for styles.xml
1396 ;; FIXME: Who is opening an empty styles.xml before this point?
1401 ;; Write custom styles for source blocks
1402 ;; Save STYLES used for colorizing of source blocks.
1403 ;; Update styles.xml with styles that were collected as part of
1404 ;; `org-odt-hfy-face-to-css' callbacks.
1413 ;; Update styles.xml - take care of outline numbering
1415 ;; Don't make automatic backup of styles.xml file. This setting
1416 ;; prevents the backed-up styles.xml file from being zipped in to
1417 ;; odt file. This is more of a hackish fix. Better alternative
1418 ;; would be to fix the zip command so that the output odt file
1419 ;; includes only the needed files and excludes any auto-generated
1420 ;; extra files like backups and auto-saves etc etc. Note that
1421 ;; currently the zip command zips up the entire temp directory so
1422 ;; that any auto-generated files created under the hood ends up in
1423 ;; the resulting odt file.
1426 ;; Outline numbering is retained only upto LEVEL.
1427 ;; To disable outline numbering pass a LEVEL of 0.
1440 ;; Update content.xml.
1443 ;; within the context of the Org buffer. So obtain its
1444 ;; value before moving on to temp-buffer context down below.
1454 org-odt-styles-dir)))
1455 ;; Write automatic styles.
1456 ;; - Position the cursor.
1460 ;; - Dump automatic table styles.
1465 ;; - Dump date-styles.
1471 ;; Update display level.
1472 ;; - Remove existing sequence decls. Also position the cursor.
1477 ;; Update sequence decls according to user preference.
1488 ;; Position the cursor to document body.
1493 ;; Preamble - Title, Author, Date etc.
1503 ;; Switch on or off above vars based on user settings
1507 ;; Title.
1512 ;; Separator.
1514 ;; Subtitle.
1520 subtitle
1522 ;; Separator.
1526 ;; Author only.
1529 "OrgSubtitle"
1531 ;; Separator.
1534 ;; Author and E-mail.
1538 "OrgSubtitle"
1543 ;; Separator.
1545 ;; Date, if required.
1548 ;; Check if DATE is specified as a timestamp.
1555 "OrgSubtitle"
1559 ;; Separator
1561 ;; Table of Contents
1564 with-toc
1567 ;; Contents.
1569 ;; Return contents.
1573 \f
1574 ;;; Transcode Functions
1576 ;;;; Bold
1579 "Transcode BOLD from Org to ODT.
1580 CONTENTS is the text with bold markup. INFO is a plist holding
1581 contextual information."
1586 ;;;; Center Block
1589 "Transcode a CENTER-BLOCK element from Org to ODT.
1590 CONTENTS holds the contents of the center block. INFO is a plist
1591 holding contextual information."
1592 contents)
1595 ;;;; Clock
1598 "Transcode a CLOCK element from Org to ODT.
1599 CONTENTS is nil. INFO is a plist used as a communication
1600 channel."
1613 ;;;; Code
1616 "Transcode a CODE object from Org to ODT.
1617 CONTENTS is nil. INFO is a plist used as a communication
1618 channel."
1624 ;;;; Drawer
1627 "Transcode a DRAWER element from Org to ODT.
1628 CONTENTS holds the contents of the block. INFO is a plist
1629 holding contextual information."
1632 name contents)))
1633 output))
1636 ;;;; Dynamic Block
1639 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1640 CONTENTS holds the contents of the block. INFO is a plist
1641 holding contextual information. See `org-export-data'."
1642 contents)
1645 ;;;; Entity
1648 "Transcode an ENTITY object from Org to ODT.
1649 CONTENTS are the definition itself. INFO is a plist holding
1650 contextual information."
1654 ;;;; Example Block
1657 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1658 CONTENTS is nil. INFO is a plist holding contextual information."
1662 ;;;; Export Snippet
1665 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1666 CONTENTS is nil. INFO is a plist holding contextual information."
1671 ;;;; Export Block
1674 "Transcode a EXPORT-BLOCK element from Org to ODT.
1675 CONTENTS is nil. INFO is a plist holding contextual information."
1680 ;;;; Fixed Width
1683 "Transcode a FIXED-WIDTH element from Org to ODT.
1684 CONTENTS is nil. INFO is a plist holding contextual information."
1688 ;;;; Footnote Definition
1690 ;; Footnote Definitions are ignored.
1693 ;;;; Footnote Reference
1696 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1697 CONTENTS is nil. INFO is a plist holding contextual information."
1705 id note-class
1717 "OrgSuperscript"
1718 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1719 note-class ref-format ref-name n))))))
1721 ;; Insert separator between two footnotes in a row.
1726 ;; Transcode footnote reference.
1734 footnote-reference info))
1738 raw
1741 :transcoders
1744 p c i
1745 "Footnote"
1746 "OrgFootnoteCenter"
1748 info))))
1749 ;; Inline definitions are secondary strings. We
1750 ;; need to wrap them within a paragraph.
1753 def
1756 def)))))
1760 ;;;; Headline
1763 &optional format-function
1765 "Transcode a HEADLINE element using BACKEND.
1766 INFO is a plist holding contextual information."
1789 &key _level _section-number _headline-label
1792 todo todo-type priority text tags))))))
1794 todo todo-type priority text tags
1795 :headline-label headline-label
1796 :level level
1800 "Transcode a HEADLINE element from Org to ODT.
1801 CONTENTS holds the contents of the headline. INFO is a plist
1802 holding contextual information."
1803 ;; Case 1: This is a footnote section: ignore it.
1806 ;; Get level relative to current parsed data.
1809 ;; Get canonical label for the headline.
1811 ;; Extra targets.
1815 ;; Title.
1818 ;; Case 2. This is a deep sub-tree: export it as a list item.
1819 ;; Also export as items headlines for which no section
1820 ;; format has been found.
1822 ;; Build the real contents of the sub-tree.
1826 ;; Choose style based on list type.
1828 ;; If top-level list, re-start numbering. Otherwise,
1829 ;; continue numbering.
1832 headline)))
1842 "Text_20_body"
1844 contents)
1846 "</text:list-header>"
1850 ;; Case 3. Standard headline. Export it as a section.
1854 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1857 level
1860 contents))))))
1864 "Default format function for a headline.
1865 See `org-odt-format-headline-function' for details."
1867 ;; Todo.
1875 style priority)))
1876 ;; Title.
1877 text
1878 ;; Tags.
1881 "<text:tab/>"
1890 ;;;; Horizontal Rule
1893 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1894 CONTENTS is nil. INFO is a plist holding contextual information."
1899 ;;;; Inline Babel Call
1901 ;; Inline Babel Calls are ignored.
1904 ;;;; Inline Src Block
1907 "Return a character not used in string S.
1909 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1915 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1916 CONTENTS holds the contents of the item. INFO is a plist holding
1917 contextual information."
1921 ;;;; Inlinetask
1924 "Transcode an INLINETASK element from Org to ODT.
1925 CONTENTS holds the contents of the block. INFO is a plist
1926 holding contextual information."
1938 todo todo-type priority text tags contents)))
1942 "Default format function for a inlinetasks.
1943 See `org-odt-format-inlinetask-function' for details."
1945 "Text_20_body"
1949 "OrgInlineTaskHeading"
1951 todo todo-type priority name tags))
1952 contents)
1955 ;;;; Italic
1958 "Transcode ITALIC from Org to ODT.
1959 CONTENTS is the text with italic markup. INFO is a plist holding
1960 contextual information."
1965 ;;;; Item
1968 "Transcode an ITEM element from Org to ODT.
1969 CONTENTS holds the contents of the item. INFO is a plist holding
1970 contextual information."
1976 contents
1978 "</text:list-header>"
1981 ;;;; Keyword
1984 "Transcode a KEYWORD element from Org to ODT.
1985 CONTENTS is nil. INFO is a plist holding contextual
1986 information."
1992 ;; FIXME
2004 ;; FIXME
2008 ;;;; Latex Environment
2011 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2012 ;; (defadvice org-format-latex-as-mathml ; FIXME
2013 ;; (after org-odt-protect-latex-fragment activate)
2014 ;; "Encode LaTeX fragment as XML.
2015 ;; Do this when translation to MathML fails."
2016 ;; (unless (> (length ad-return-value) 0)
2017 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2020 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2021 CONTENTS is nil. INFO is a plist holding contextual information."
2027 ;;;; Latex Fragment
2029 ;; (when latex-frag ; FIXME
2030 ;; (setq href (propertize href :title "LaTeX Fragment"
2031 ;; :description latex-frag)))
2032 ;; handle verbatim
2033 ;; provide descriptions
2036 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2037 CONTENTS is nil. INFO is a plist holding contextual information."
2043 ;;;; Line Break
2046 "Transcode a LINE-BREAK object from Org to ODT.
2047 CONTENTS is nil. INFO is a plist holding contextual information."
2051 ;;;; Link
2053 ;;;; Links :: Label references
2063 x))))
2073 counter))
2076 element
2078 info))
2082 ;; Section number.
2086 ;; Separator.
2088 ;; Ordinal.
2090 tag))
2093 "Return a label for ELEMENT.
2095 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2096 element. INFO is a plist used as a communication channel. OP is
2097 either `definition' or `reference', depending on the purpose of
2098 the generated string.
2100 Return value is a string if OP is set to `reference' or a cons
2101 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2102 SHORT-CAPTION are strings."
2108 ;; Get label and caption.
2114 ;; FIXME: We don't use short-caption for now
2130 element))))
2133 seqno)
2138 ;; Compute sequence number of the element.
2140 ;; Localize category string.
2143 ;; Case 1: Handle Label definition.
2147 ;; Sneak in a bookmark. The bookmark is used when the
2148 ;; labeled element is referenced with a link that
2149 ;; provides its own description.
2151 ;; Label definition: Typically formatted as below:
2152 ;; CATEGORY SEQ-NO: LONG CAPTION
2153 ;; with translation for correct punctuation.
2160 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2161 label counter counter seqno))
2163 short-caption))
2164 ;; Case 2: Handle Label reference.
2169 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2170 fmt1
2171 label
2176 ;;;; Links :: Inline Images
2179 "Returns the internal name of the file"
2195 target-file))
2218 ;; Use Imagemagick.
2223 file))))
2228 ;; Use Emacs.
2234 ;; Use hard-coded values.
2236 org-odt-default-image-sizes-alist))
2237 ;; Error out.
2250 ;; ensure that an embedded image fits comfortably within a page
2261 "Return ODT code for an inline image.
2262 LINK is the link pointing to the inline image. INFO is a plist
2263 used as a communication channel."
2276 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2278 ;; Extract attributes from #+ATTR_ODT line.
2282 ;; Convert attributes to a plist.
2284 ;; Handle `:anchor', `:style' and `:attributes' properties.
2294 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2295 ;;
2296 ;; Handle `:width', `:height' and `:scale' properties. Read
2297 ;; them as numbers since we need them for computations.
2299 src-expanded info
2306 nil ; embed-as
2308 ))
2315 ;; Check if this link was created by LaTeX-to-PNG converter.
2319 ;; If yes, note down the type of the element - LaTeX Fragment
2320 ;; or LaTeX environment. It will go in to frame title.
2324 ;; If yes, note down its contents. It will go in to frame
2325 ;; description. This quite useful for debugging.
2328 captions user-frame-params title desc)))
2331 ;;;; Links :: Math formula
2350 ;; Check if this link was created by LaTeX-to-MathML
2351 ;; converter.
2355 ;; If yes, note down the type of the element - LaTeX Fragment
2356 ;; or LaTeX environment. It will go in to frame title.
2360 ;; If yes, note down its contents. It will go in to frame
2361 ;; description. This quite useful for debugging.
2363 width height)
2367 nil nil title desc))
2370 "CaptionedDisplayFormula" href width height
2371 captions nil title desc))
2375 org-odt--enumerable-formula-p))))
2380 "Returns the internal name of the file"
2384 ;; Create a directory for holding formula file. Also enter it in
2385 ;; to manifest.
2389 ;; Copy over the formula file from user directory to zip
2390 ;; directory.
2394 ;; Case 1: Mathml.
2397 ;; Case 2: OpenDocument formula.
2402 ;; Enter the formula file in to manifest.
2404 target-file))
2406 ;;;; Targets
2409 captions user-frame-params
2412 ;; Each element of this alist is of the form (CFG-HANDLE
2413 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2415 ;; CFG-HANDLE is the key to the alist.
2417 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2418 ;; frame params for INNER-FRAME and OUTER-FRAME
2419 ;; respectively. See below.
2421 ;; Configurations that are meant to be applied to
2422 ;; non-captioned image/formula specifies no
2423 ;; OUTER-FRAME-PARAMS.
2425 ;; TERMINOLOGY
2426 ;; ===========
2427 ;; INNER-FRAME :: Frame that directly surrounds an
2428 ;; image/formula.
2430 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2431 ;; frame also contains the caption, if any.
2433 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2434 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2435 ;; that these are the last three arguments
2436 ;; to `org-odt--frame'.
2438 ;; Note that an un-captioned image/formula requires just an
2439 ;; INNER-FRAME, while a captioned image/formula requires
2440 ;; both an INNER and an OUTER-FRAME.
2462 ;; Retrieve inner and outer frame params, from configuration.
2466 ;; User-specified frame params (from #+ATTR_ODT spec)
2470 "Merge default and user frame params."
2475 for d in default
2478 ;; Case 1: Image/Formula has no caption.
2479 ;; There is only one frame, one that surrounds the image
2480 ;; or formula.
2482 ;; Merge user frame params with that from configuration.
2486 ;; Case 2: Image/Formula is captioned or labeled.
2487 ;; There are two frames: The inner one surrounds the
2488 ;; image or formula. The outer one contains the
2489 ;; caption/sequence number.
2491 ;; Merge user frame params with outer frame params.
2493 ;; Short caption, if specified, goes as part of inner frame.
2500 frame-params))
2503 "Illustration"
2507 caption))
2508 width height outer)))))
2511 ;; Element should have a caption or label.
2517 element info
2518 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2519 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2520 ;; processing.)
2525 ;; Link should point to an image file.
2532 element info
2533 ;; Paragraph should have a caption or label. It SHOULD also be a
2534 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2535 ;; processing.)
2540 ;; Link should point to an image file.
2547 element info
2548 ;; Paragraph should have a caption or label.
2552 ;; Link should point to a MathML or ODF file.
2558 paragraph-predicate
2559 link-predicate)
2560 "Test if ELEMENT is a standalone link for the purpose ODT export.
2561 INFO is a plist holding contextual information.
2563 Return non-nil, if ELEMENT is of type paragraph satisfying
2564 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2565 is a link that satisfies LINK-PREDICATE.
2567 Return non-nil, if ELEMENT is of type link satisfying
2568 LINK-PREDICATE and its containing paragraph satisfies
2569 PARAGRAPH-PREDICATE in addition to having no other content save for
2570 leading and trailing whitespaces.
2572 Return nil, otherwise."
2595 ;; DESTINATION is a headline or an element (like paragraph,
2596 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2598 ;; Note that labels that are attached to captioned entities - inline
2599 ;; images, math formulae and tables - get resolved as part of
2600 ;; `org-odt-format-label' and `org-odt--enumerate'.
2602 ;; Create a cross-reference to DESTINATION but make best-efforts to
2603 ;; create a *meaningful* description. Check item numbers, section
2604 ;; number and section title in that order.
2606 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2607 ;; FIXME: Handle footnote-definition footnote-reference?
2619 return x))
2620 ;; Get list item nos.
2625 plain-list)
2628 item info t))))))
2629 ;; Locate top-most listified headline.
2634 return x))
2635 ;; Get listified headline numbers.
2641 el info t)))))))
2642 ;; Combine item numbers from both the listified headlines and
2643 ;; regular list items.
2645 ;; Case 1: Check if all the parents of list item are numbered.
2646 ;; If yes, link to the item proper.
2649 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2650 label
2654 ;; Case 2: Locate a regular and numbered headline in the
2655 ;; hierarchy. Display its section number.
2658 ;; Test if destination is a numbered headline.
2664 return el))))
2665 ;; We found one.
2667 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2668 label
2671 ;; Case 4: Locate a regular headline in the hierarchy. Display
2672 ;; its title.
2676 return el)))
2677 ;; We found one.
2679 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2680 label
2686 "Transcode a LINK object from Org to ODT.
2688 DESC is the description part of the link, or the empty string.
2689 INFO is a plist holding contextual information. See
2690 `org-export-data'."
2693 ;; Ensure DESC really exists, or set it to nil.
2702 ;; Convert & to & for correct XML representation
2705 ;; Link type is handled by a special function.
2707 ;; Image file.
2709 ;; Formula file.
2714 ;; Radio target: Transcode target's contents and use them as
2715 ;; link's description.
2720 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2722 desc))))
2723 ;; Links pointing to a headline: Find destination and build
2724 ;; appropriate referencing command.
2730 ;; Fuzzy link points to a headline. If there's
2731 ;; a description, create a hyperlink. Otherwise, try to
2732 ;; provide a meaningful description.
2741 label desc))))
2742 ;; Fuzzy link points to a target. If there's a description,
2743 ;; create a hyperlink. Otherwise, try to provide
2744 ;; a meaningful description.
2749 ;; Fuzzy link points to some element (e.g., an inline image,
2750 ;; a math formula or a table).
2758 ;; LINK has no description. Create
2759 ;; a cross-reference showing entity's sequence
2760 ;; number.
2762 ;; LINK has description. Insert a hyperlink with
2763 ;; user-provided description.
2768 desc))))))))
2769 ;; Coderef: replace link with the reference name or the
2770 ;; equivalent line number.
2777 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2778 href line-no))))
2779 ;; External link with a description part.
2782 ;; Check if description is a link to an inline image.
2787 desc-element
2789 ;; Format link as a clickable image.
2791 path desc)
2792 ;; Otherwise, format it as a regular link.
2794 path desc))))
2795 ;; External link without a description part.
2798 path path))
2799 ;; No path, only description. Try to do something useful.
2804 ;;;; Node Property
2807 "Transcode a NODE-PROPERTY element from Org to ODT.
2808 CONTENTS is nil. INFO is a plist holding contextual
2809 information."
2816 ;;;; Paragraph
2819 "Return style of PARAGRAPH.
2820 Style is a symbol among `quoted', `centered' and nil."
2830 "Format paragraph according to given styles.
2831 PARAGRAPH is a paragraph type element. CONTENTS is the
2832 transcoded contents of that paragraph, as a string. INFO is
2833 a plist used as a communication channel. DEFAULT, CENTER and
2834 QUOTE are, respectively, style to use when paragraph belongs to
2835 no special environment, a center block, or a quote block."
2841 ;; If PARAGRAPH is a leading paragraph in an item that has
2842 ;; a checkbox, splice checkbox and paragraph contents
2843 ;; together.
2848 contents)))
2851 "Transcode a PARAGRAPH element from Org to ODT.
2852 CONTENTS is the contents of the paragraph, as a string. INFO is
2853 the plist used as a communication channel."
2855 paragraph contents info
2857 "OrgCenter"
2861 ;;;; Plain List
2864 "Transcode a PLAIN-LIST element from Org to ODT.
2865 CONTENTS is the contents of the list. INFO is a plist holding
2866 contextual information."
2868 ;; Choose style based on list type.
2874 ;; If top-level list, re-start numbering. Otherwise,
2875 ;; continue numbering.
2880 contents))
2882 ;;;; Plain Text
2890 line))
2899 "Transcode a TEXT string from Org to ODT.
2900 TEXT is the string to transcode. INFO is a plist holding
2901 contextual information."
2903 ;; Protect &, < and >.
2905 ;; Handle smart quotes. Be sure to provide original string since
2906 ;; OUTPUT may have been modified.
2909 ;; Convert special strings.
2914 ;; Handle break preservation if required.
2918 ;; Return value.
2919 output))
2922 ;;;; Planning
2925 "Transcode a PLANNING element from Org to ODT.
2926 CONTENTS is nil. INFO is a plist used as a communication
2927 channel."
2929 "OrgPlanning"
2951 ;;;; Property Drawer
2954 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2955 CONTENTS holds the contents of the drawer. INFO is a plist
2956 holding contextual information."
2959 contents)))
2962 ;;;; Quote Block
2965 "Transcode a QUOTE-BLOCK element from Org to ODT.
2966 CONTENTS holds the contents of the block. INFO is a plist
2967 holding contextual information."
2968 contents)
2971 ;;;; Section
2976 style
2978 text)))
2982 "Transcode a SECTION element from Org to ODT.
2983 CONTENTS holds the contents of the section. INFO is a plist
2984 holding contextual information."
2985 contents)
2987 ;;;; Radio Target
2990 "Transcode a RADIO-TARGET object from Org to ODT.
2991 TEXT is the text of the target. INFO is a plist holding
2992 contextual information."
2996 ;;;; Special Block
2999 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3000 CONTENTS holds the contents of the block. INFO is a plist
3001 holding contextual information."
3005 ;; Annotation.
3011 ;; FIXME: Is `car' right thing to do below?
3021 contents)))))
3022 ;; Textbox.
3031 style extra anchor))))
3035 ;;;; Src Block
3038 "Create custom style for face FN.
3039 When FN is the default face, use its foreground and background
3041 use its color attribute to create a character style whose name
3042 is obtained from FN. Currently all attributes of FN other than
3043 color are ignored.
3045 The style name for a face FN is derived using the following
3046 operations on the face name in that order - de-dash, CamelCase
3048 `font-lock-function-name-face' is associated with
3062 background-color-val color-val))
3065 "
3112 code
3124 par-style loc))
3127 num-start refs))
3141 ;; Extract code and references.
3145 ;; Does the src block contain labels?
3147 ;; Does it have line numbers?
3152 "Transcode a SRC-BLOCK element from Org to ODT.
3153 CONTENTS holds the contents of the item. INFO is a plist holding
3154 contextual information."
3164 "Text_20_body"
3168 ;;;; Statistics Cookie
3171 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3172 CONTENTS is nil. INFO is a plist holding contextual information."
3178 ;;;; Strike-Through
3181 "Transcode STRIKE-THROUGH from Org to ODT.
3182 CONTENTS is the text with strike-through markup. INFO is a plist
3183 holding contextual information."
3188 ;;;; Subscript
3191 "Transcode a SUBSCRIPT object from Org to ODT.
3192 CONTENTS is the contents of the object. INFO is a plist holding
3193 contextual information."
3198 ;;;; Superscript
3201 "Transcode a SUPERSCRIPT object from Org to ODT.
3202 CONTENTS is the contents of the object. INFO is a plist holding
3203 contextual information."
3208 ;;;; Table Cell
3217 "Retrieve styles applicable to a table cell.
3218 R and C are (zero-based) row and column numbers of the table
3219 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3220 applicable to the current table. It is nil if the table is not
3221 associated with any style attributes.
3223 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3225 When STYLE-SPEC is nil, style the table cell the conventional way
3226 - choose cell borders based on row and column groupings and
3227 choose paragraph alignment based on `org-col-cookies' text
3228 property. See also
3229 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3231 When STYLE-SPEC is non-nil, ignore the above cookie and return
3232 styles congruent with the ODF-1.2 specification."
3238 info)))
3240 ;; LibreOffice - particularly the Writer - honors neither table
3241 ;; templates nor custom table-cell styles. Inorder to retain
3242 ;; inter-operability with LibreOffice, only automatic styles are
3243 ;; used for styling of table-cells. The current implementation is
3244 ;; congruent with ODF-1.2 specification and hence is
3245 ;; future-compatible.
3247 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3248 ;; which recognizes as many as 16 different cell types - is much
3249 ;; richer. Unfortunately it is NOT amenable to easy configuration
3250 ;; by hand.
3277 "Transcode a TABLE-CELL element from Org to ODT.
3278 CONTENTS is nil. INFO is a plist used as a communication
3279 channel."
3286 table-cell info))
3309 table-cell info))))))
3313 custom-style-prefix))
3315 "OrgTblCell"
3331 cell-attributes
3334 contents
3336 paragraph-style contents))))
3343 ;;;; Table Row
3346 "Transcode a TABLE-ROW element from Org to ODT.
3347 CONTENTS is the contents of the row. INFO is a plist used as a
3348 communication channel."
3349 ;; Rules are ignored since table separators are deduced from
3350 ;; borders of the current row.
3356 ;; If the row belongs to the first rowgroup and the
3357 ;; table has more than one row groups, then this row
3358 ;; belongs to the header row group.
3360 ;; Otherwise, it belongs to non-header row group.
3363 ;; Does this row begin a rowgroup?
3366 ;; Actual table row
3368 ;; Does this row end a rowgroup?
3373 ;;;; Table
3386 "Transcode a TABLE element from Org to ODT.
3387 CONTENTS is the contents of the table. INFO is a plist holding
3388 contextual information."
3390 ;; Case 1: table.el doesn't support export to OD format. Strip
3391 ;; such tables from export.
3396 "(ox-odt): Found table.el-type table in the source Org file."
3397 " table.el doesn't support export to ODT format."
3399 ;; Case 2: Native Org tables.
3415 column-style))
3416 out)
3420 ;; caption.
3424 ;; begin table.
3432 ;; column specification.
3434 ;; actual contents.
3436 ;; end table.
3440 "Transcode a TABLE element from Org to ODT.
3441 CONTENTS is the contents of the table. INFO is a plist holding
3442 contextual information.
3444 Use `org-odt--table' to typeset the table. Handle details
3445 pertaining to indentation here."
3458 collect el)))
3462 for el in genealogy
3465 collect
3470 parent-list)
3472 ;; Handle list genealogy.
3474 for el in list-genealogy collect
3493 parent-list info)
3496 ;; Handle low-level headlines.
3498 with step = 'item collect
3506 el info)
3507 "OrgNumberedList"
3518 parent-list info)))
3526 table info)))
3527 ;; OpenDocument schema does not permit table to occur within a
3528 ;; list item.
3530 ;; One solution - the easiest and lightweight, in terms of
3531 ;; implementation - is to put the table in an indented text box
3532 ;; and make the text box part of the list-item. Unfortunately if
3533 ;; the table is big and spans multiple pages, the text box could
3534 ;; overflow. In this case, the following attribute will come
3535 ;; handy.
3537 ;; ,---- From OpenDocument-v1.1.pdf
3538 ;; | 15.27.28 Overflow behavior
3539 ;; |
3540 ;; | For text boxes contained within text document, the
3541 ;; | style:overflow-behavior property specifies the behavior of text
3542 ;; | boxes where the containing text does not fit into the text
3543 ;; | box.
3544 ;; |
3545 ;; | If the attribute's value is clip, the text that does not fit
3546 ;; | into the text box is not displayed.
3547 ;; |
3548 ;; | If the attribute value is auto-create-new-frame, a new frame
3549 ;; | will be created on the next page, with the same position and
3550 ;; | dimensions of the original frame.
3551 ;; |
3552 ;; | If the style:overflow-behavior property's value is
3553 ;; | auto-create-new-frame and the text box has a minimum width or
3554 ;; | height specified, then the text box will grow until the page
3555 ;; | bounds are reached before a new frame is created.
3556 ;; `----
3558 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3559 ;; auto-create-new-frame property and always resorts to clipping
3560 ;; the text box. This results in table being truncated.
3562 ;; So we solve the problem the hard (and fun) way using list
3563 ;; continuations.
3565 ;; The problem only becomes more interesting if you take in to
3566 ;; account the following facts:
3567 ;;
3568 ;; - Description lists are simulated as plain lists.
3569 ;; - Low-level headlines can be listified.
3570 ;; - In Org mode, a table can occur not only as a regular list
3571 ;; item, but also within description lists and low-level
3572 ;; headlines.
3574 ;; See `org-odt-translate-description-lists' and
3575 ;; `org-odt-translate-low-level-headlines' for how this is
3576 ;; tackled.
3579 ;; Discontinue the list.
3581 ;; Put the table in an indented section.
3586 ;; Continue the list.
3590 ;;;; Target
3593 "Transcode a TARGET object from Org to ODT.
3594 CONTENTS is nil. INFO is a plist holding contextual
3595 information."
3599 ;;;; Timestamp
3602 "Transcode a TIMESTAMP object from Org to ODT.
3603 CONTENTS is nil. INFO is a plist used as a communication
3604 channel."
3620 "OrgActiveTimestamp"
3624 "OrgInactiveTimestamp"
3628 "OrgActiveTimestamp"
3634 "OrgInactiveTimestamp"
3640 "OrgDiaryTimestamp"
3642 info)))))))
3645 ;;;; Underline
3648 "Transcode UNDERLINE from Org to ODT.
3649 CONTENTS is the text with underline markup. INFO is a plist
3650 holding contextual information."
3655 ;;;; Verbatim
3658 "Transcode a VERBATIM object from Org to ODT.
3659 CONTENTS is nil. INFO is a plist used as a communication
3660 channel."
3666 ;;;; Verse Block
3669 "Transcode a VERSE-BLOCK element from Org to ODT.
3670 CONTENTS is verse block contents. INFO is a plist holding
3671 contextual information."
3674 ;; Replace leading tabs and spaces.
3676 ;; Add line breaks to each line of verse.
3681 \f
3682 ;;; Filters
3684 ;;; Images
3689 ;;;; LaTeX fragments
3694 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3695 ;; If the desired converter is not available, force verbatim
3696 ;; processing.
3714 ;; Store normalized value for later use.
3719 ;; Convert `latex-fragment's and `latex-environment's.
3738 ;; Get an Org-style link to PNG image or the MathML
3739 ;; file.
3744 nil display-msg nil
3745 processing-type)
3750 nil))))
3752 ;; Conversion succeeded. Parse above Org-style link to
3753 ;; a `link' object.
3760 ;; Case 1: LaTeX environment. Mimic
3761 ;; a "standalone image or formula" by
3762 ;; enclosing the `link' in a `paragraph'.
3763 ;; Copy over original attributes, captions to
3764 ;; the enclosing paragraph.
3769 :name
3771 :caption
3773 link))
3774 ;; Case 2: LaTeX fragment. No special action.
3776 ;; Note down the object that link replaces.
3780 ;; Restore blank after initial element or object.
3782 replacement :post-blank
3784 ;; Replace now.
3786 info nil nil t)))
3787 tree)
3790 ;;;; Description lists
3792 ;; This translator is necessary to handle indented tables in a uniform
3793 ;; manner. See comment in `org-odt--table'.
3796 ;; OpenDocument has no notion of a description list. So simulate it
3797 ;; using plain lists. Description lists in the exported document
3798 ;; are typeset in the same manner as they are in a typical HTML
3799 ;; document.
3800 ;;
3801 ;; Specifically, a description list like this:
3802 ;;
3803 ;; ,----
3804 ;; | - term-1 :: definition-1
3805 ;; | - term-2 :: definition-2
3806 ;; `----
3807 ;;
3808 ;; gets translated in to the following form:
3809 ;;
3810 ;; ,----
3811 ;; | - term-1
3812 ;; | - definition-1
3813 ;; | - term-2
3814 ;; | - definition-2
3815 ;; `----
3816 ;;
3817 ;; Further effect is achieved by fixing the OD styles as below:
3818 ;;
3819 ;; 1. Set the :type property of the simulated lists to
3820 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3821 ;; that has *no* bullets whatsoever.
3822 ;;
3823 ;; 2. The paragraph containing the definition term is styled to be
3824 ;; in bold.
3825 ;;
3830 el
3846 nil)
3847 info)
3848 tree)
3850 ;;;; List tables
3852 ;; Lists that are marked with attribute `:list-table' are called as
3853 ;; list tables. They will be rendered as a table within the exported
3854 ;; document.
3856 ;; Consider an example. The following list table
3857 ;;
3858 ;; #+attr_odt :list-table t
3859 ;; - Row 1
3860 ;; - 1.1
3861 ;; - 1.2
3862 ;; - 1.3
3863 ;; - Row 2
3864 ;; - 2.1
3865 ;; - 2.2
3866 ;; - 2.3
3867 ;;
3868 ;; will be exported as though it were an Org table like the one show
3869 ;; below.
3870 ;;
3871 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3872 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3873 ;;
3874 ;; Note that org-tables are NOT multi-line and each line is mapped to
3875 ;; a unique row in the exported document. So if an exported table
3876 ;; needs to contain a single paragraph (with copious text) it needs to
3877 ;; be typed up in a single line. Editing such long lines using the
3878 ;; table editor will be a cumbersome task. Furthermore inclusion of
3879 ;; multi-paragraph text in a table cell is well-nigh impossible.
3880 ;;
3881 ;; A LIST-TABLE circumvents above problems.
3882 ;;
3883 ;; Note that in the example above the list items could be paragraphs
3884 ;; themselves and the list can be arbitrarily deep.
3885 ;;
3886 ;; Inspired by following thread:
3887 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3889 ;; Translate lists to tables
3895 ;; Replace list with table.
3897 l1-list
3898 ;; Build replacement table.
3904 l1-item-leading-text l2-list)
3905 ;; Remove Level-2 list from the Level-item. It
3906 ;; will be subsequently attached as table-cells.
3916 ;; Level-1 items start a table row.
3919 ;; Leading text of level-1 item define
3920 ;; the first table-cell.
3923 l1-item-leading-text)
3924 ;; Level-2 items define subsequent
3925 ;; table-cells of the row.
3933 nil)
3934 info)
3935 tree)
3937 \f
3938 ;;; Interactive functions
3951 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3966 ;; Initialize temporary workarea. All files that end up in
3967 ;; the exported document get parked/created here.
3973 ;; Kill all XML buffers.
3981 ;; Delete temporary directory and also other embedded
3982 ;; files that get copied there.
3987 ;; Not at all OSes ship with zip by default
3989 ;; Do export. This creates a bunch of xml files ready to be
3990 ;; saved and zipped.
3992 ;; Create a manifest entry for content.xml.
3994 ;; Write mimetype file
4003 ;; Write out the manifest entries before zipping
4005 ;; Save all XML files.
4011 ;; Prettify output if needed.
4015 ;; Run zip.
4020 ;; If a file with same name as the desired output file
4021 ;; exists, remove it.
4024 ;; Zip up the xml files.
4027 ;; Switch temporarily to content.xml. This way Zip
4028 ;; process will inherit `org-odt-zip-dir' as the current
4029 ;; directory.
4042 err-string)))))
4043 ;; Move the zip file from temporary work directory to
4044 ;; user-mandated location.
4047 ;; Cleanup work directory and work files.
4049 ;; Open the OpenDocument file in archive-mode for
4050 ;; examination.
4052 ;; Return exported file.
4054 ;; Case 1: Conversion desired on exported file. Run the
4055 ;; converter on the OpenDocument file. Return the
4056 ;; converted file.
4059 target))
4060 ;; Case 2: No further conversion. Return exported
4061 ;; OpenDocument file.
4064 ;; Cleanup work directory and work files.
4070 ;;;; Export to OpenDocument formula
4072 ;;;###autoload
4074 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4075 Use `org-create-math-formula' to convert LATEX-FRAG first to
4076 MathML. When invoked as an interactive command, use
4077 `org-latex-regexps' to infer LATEX-FRAG from currently active
4078 region. If no LaTeX fragments are found, prompt for it. Push
4079 MathML source to kill ring depending on the value of
4080 `org-export-copy-to-kill-ring'."
4106 filename
4119 ;; Add MathML to kill ring, if needed.
4123 ;;;###autoload
4125 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4126 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4127 formula file."
4132 ;;;; Export to OpenDocument Text
4134 ;;;###autoload
4136 "Export current buffer to a ODT file.
4138 If narrowing is active in the current buffer, only export its
4139 narrowed part.
4141 If a region is active, export that region.
4143 A non-nil optional argument ASYNC means the process should happen
4144 asynchronously. The resulting file should be accessible through
4145 the `org-export-stack' interface.
4147 When optional argument SUBTREEP is non-nil, export the sub-tree
4148 at point, extracting information from the headline properties
4149 first.
4151 When optional argument VISIBLE-ONLY is non-nil, don't export
4152 contents of hidden elements.
4154 EXT-PLIST, when provided, is a property list with external
4155 parameters overriding Org default settings, but still inferior to
4156 file-local settings.
4158 Return output file's name."
4165 ,outfile
4170 ;; Let `htmlfontify' know that we are interested in
4171 ;; collecting styles.
4173 ;; Initialize content.xml and kick-off the export
4174 ;; process.
4187 outfile
4192 ;; Let `htmlfontify' know that we are interested in collecting
4193 ;; styles.
4195 ;; Initialize content.xml and kick-off the export process.
4205 ;;;; Convert between OpenDocument and other formats
4208 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4217 "Workhorse routine for `org-odt-convert'."
4226 in-fmt out-fmt)))
4254 out-file)
4257 nil))))
4260 "Return verbose info about formats to which IN-FMT can be converted.
4261 Return a list where each element is of the
4262 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4263 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4264 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4268 org-odt-convert-processes t))))
4272 org-odt-convert-processes t))
4273 org-odt-convert-capabilities))
4274 reachable-formats)
4279 reachable-formats))
4282 "Return list of formats to which IN-FMT can be converted.
4283 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4290 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4291 This is a helper routine for interactive use."
4294 nil buffer-file-name t))
4300 out-fmt-choices nil nil nil))
4302 "No known converter or no known output formats for %s files"
4303 in-fmt))))
4306 ;;;###autoload
4308 "Convert IN-FILE to format OUT-FMT using a command line converter.
4309 IN-FILE is the file to be converted. If unspecified, it defaults
4310 to variable `buffer-file-name'. OUT-FMT is the desired output
4311 format. Use `org-odt-convert-process' as the converter. If OPEN
4312 is non-nil then the newly converted file is opened using
4313 `org-open-file'."
4318 ;;; Library Initializations
4321 ;; Let Emacs open all OpenDocument files in archive mode.
4327 ;; Local variables:
4328 ;; generated-autoload-file: "org-loaddefs.el"
4329 ;; End:
4331 ;;; ox-odt.el ends here