| blob | b6f237c420f1568f588b18da06561a50cc037c1d |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2014 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
88 org-odt--translate-description-lists
89 org-odt--translate-list-tables)))
90 :menu-entry
97 :options-alist
99 ;; Other variables.
112 ;; Redefine regular option.
116 ;;; Dependencies
118 ;;; Hooks
120 ;;; Function Declarations
129 \f
130 ;;; Internal Variables
134 "Location of ODT exporter.
135 Use this to infer values of `org-odt-styles-dir' and
140 "Data directory for ODT exporter.
141 Use this to infer values of `org-odt-styles-dir' and
158 "List of directories to search for OpenDocument schema files.
159 Use this list to set the default value of
160 `org-odt-schema-dir'. The entries in this list are
161 populated heuristically based on the values of `org-odt-lib-dir'
174 )
175 "List of directories to search for OpenDocument styles files.
176 See `org-odt-styles-dir'. The entries in this list are populated
177 heuristically based on the values of `org-odt-lib-dir' and
194 styles-dir)
196 org-odt-styles-dir-list)
197 nil)))
200 styles-dir)
201 "Directory that holds auxiliary XML files used by the ODT exporter.
203 This directory contains the following XML files -
205 XML files are used as the default values of
206 `org-odt-styles-file' and
207 `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's 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
391 schema-dir))
394 schema-dir))
398 schema-dir)
400 org-odt-schema-dir-list)
402 nil)))
403 schema-dir)
404 "Directory that contains OpenDocument schema files.
406 This directory contains:
407 1. rnc files for OpenDocument schema
409 for auto validation of OpenDocument XML files.
411 Use the customize interface to set this variable. This ensures
412 that `rng-schema-locating-files' is updated and auto-validation
413 of OpenDocument XML takes place based on the value
414 `rng-nxml-auto-validate-flag'.
416 The default value of this variable varies depending on the
417 version of org in use and is initialized from
418 `org-odt-schema-dir-list'. The OASIS schema files are available
419 only in the org's private git repository. It is *not* bundled
420 with GNU ELPA tar or standard Emacs distribution."
426 :set
428 "Set `org-odt-schema-dir'.
429 Also add it to `rng-schema-locating-files'."
439 schema-dir
442 value))
443 nil)))
448 org-odt-schema-dir))))))
451 ;;;; Document styles
455 The exporter embeds the exported content just before
459 under `org-odt-styles-dir' is used."
466 "Default styles file for use with ODT export.
467 Valid values are one of:
468 1. nil
469 2. path to a styles.xml file
470 3. path to a *.odt or a *.ott file
471 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
472 ...))
474 In case of option 1, an in-built styles.xml is used. See
475 `org-odt-styles-dir' for more information.
477 In case of option 3, the specified file is unzipped and the
478 styles.xml embedded therein is used.
480 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
481 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
482 generated odt file. Use relative path for specifying the
483 FILE-MEMBERS. styles.xml must be specified as one of the
484 FILE-MEMBERS.
486 Use options 1, 2 or 3 only if styles.xml alone suffices for
487 achieving the desired formatting. Use option 4, if the styles.xml
488 references additional files like header and footer images for
489 achieving the desired formatting.
492 a per-file basis. For example,
498 :type
510 "Outline levels considered for enumerating captioned entities."
516 ;;;; Document conversion
523 "Specify a list of document converters and their usage.
524 The converters in this list are offered as choices while
525 customizing `org-odt-convert-process'.
527 This variable is a list where each element is of the
528 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
529 of the converter. CONVERTER-CMD is the shell command for the
530 converter and can contain format specifiers. These format
531 specifiers are interpreted as below:
533 %i input file name in full
534 %I input file name as a URL
535 %f format of the output file
536 %o output file name in full
537 %O output file name as a URL
538 %d output dir in full
539 %D output dir as a URL.
540 %x extra options as set in `org-odt-convert-capabilities'."
543 :type
552 During customization, the list of converter names are populated
553 from `org-odt-convert-processes'."
563 org-odt-convert-processes))))
581 "Specify input and output formats of `org-odt-convert-process'.
582 More correctly, specify the set of input and output formats that
583 the user is actually interested in.
585 This variable is an alist where each element is of the
586 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
587 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
588 alist where each element is of the form (OUTPUT-FMT
589 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
591 The variable is interpreted as follows:
592 `org-odt-convert-process' can take any document that is in
593 INPUT-FMT-LIST and produce any document that is in the
594 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
595 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
596 serves dual purposes:
597 - It is used for populating completion candidates during
598 `org-odt-convert' commands.
600 `org-odt-convert-process'.
603 `org-odt-convert-process'.
605 DOCUMENT-CLASS is used to group a set of file formats in
606 INPUT-FMT-LIST in to a single class.
608 Note that this variable inherently captures how LibreOffice based
609 converters work. LibreOffice maps documents of various formats
610 to classes like Text, Web, Spreadsheet, Presentation etc and
611 allow document of a given class (irrespective of its source
612 format) to be converted to any of the export formats associated
613 with that class.
615 See default setting of this variable for an typical
616 configuration."
619 :type
624 :value-type
628 :value-type
637 and then uses `org-odt-convert-process' to convert the
638 resulting document to this format. During customization of this
639 variable, the list of valid values are populated based on
640 `org-odt-convert-capabilities'.
642 You can set this option on per-file basis using file local
643 values. See Info node `(emacs) File Variables'."
654 ;;;###autoload
658 ;;;; Drawers
662 "Function called to format a drawer in ODT code.
664 The function must accept two parameters:
666 CONTENTS the contents of the drawer.
668 The function should return the string to be exported.
670 The default value simply returns the value of CONTENTS."
677 ;;;; Headline
680 "Function to format headline text.
682 This function will be called with 5 arguments:
683 TODO the todo keyword \(string or nil\).
684 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
685 PRIORITY the priority of the headline \(integer or nil\)
686 TEXT the main headline text \(string\).
687 TAGS the tags string, separated with colons \(string or nil\).
689 The function result will be used as headline text."
696 ;;;; Inlinetasks
699 "Function called to format an inlinetask in ODT code.
701 The function must accept six parameters:
702 TODO the todo keyword, as a string
703 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
704 PRIORITY the inlinetask priority, as a string
705 NAME the inlinetask name, as a string.
706 TAGS the inlinetask tags, as a string.
707 CONTENTS the contents of the inlinetask, as a string.
709 The function should return the string to be exported."
716 ;;;; LaTeX
719 "Non-nil means process LaTeX math snippets.
721 When set, the exporter will process LaTeX environments and
722 fragments.
724 This option can also be set with the +OPTIONS line,
727 nil Ignore math snippets.
728 `verbatim' Keep everything in verbatim
729 `dvipng' Process the LaTeX fragments to images. This will also
730 include processing of non-math environments.
731 `imagemagick' Convert the LaTeX fragments to pdf files and use
732 imagemagick to convert pdf files to png files.
733 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
734 be loaded.
735 t Synonym for `mathjax'."
747 ;;;; Links
751 "Rules characterizing formula 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."
764 "Rules characterizing image files that can be inlined into ODT.
766 A rule consists in an association whose key is the type of link
767 to consider, and value is a regexp that will be matched against
768 link's path."
776 "Scaling factor for converting images pixels to inches.
777 Use this for sizing of embedded images. See Info node `(org)
778 Images in ODT export' for more information."
785 ;;;; Src Block
788 "Whether custom styles for colorized source blocks be automatically created.
789 When this option is turned on, the exporter creates custom styles
790 for source blocks based on the advice of `htmlfontify'. Creation
791 of custom styles happen as part of `org-odt-hfy-face-to-css'.
793 When this option is turned off exporter does not create such
794 styles.
796 Use the latter option if you do not want the custom styles to be
797 based on your current display settings. It is necessary that the
798 styles.xml already contains needed styles for colorizing to work.
800 This variable is effective only if
801 `org-odt-fontify-srcblocks' is turned on."
807 "Specify whether or not source blocks need to be fontified.
808 Turn this option on if you want to colorize the source code
809 blocks in the exported file. For colorization to work, you need
810 to make available an enhanced version of `htmlfontify' library."
816 ;;;; Table
829 "Specify how Table Styles should be derived from a Table Template.
830 This is a list where each element is of the
831 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
833 TABLE-STYLE-NAME is the style associated with the table through
836 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
837 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
838 below) that is included in
839 `org-odt-content-template-file'.
841 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
843 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
851 TABLE-CELL-OPTIONS is an alist where each element is of the
852 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
853 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
854 `use-last-row-styles' |
855 `use-first-column-styles' |
856 `use-last-column-styles' |
857 `use-banding-rows-styles' |
858 `use-banding-columns-styles' |
859 `use-first-row-styles'
860 ON-OR-OFF := `t' | `nil'
862 For example, with the following configuration
864 \(setq org-odt-table-styles
866 \(\(use-first-row-styles . t\)
867 \(use-first-column-styles . t\)\)\)
869 \(\(use-first-column-styles . t\)\)\)\)\)
872 style will use the following table-cell styles -
877 as appropriate.
880 use the following table-cell styles -
882 following paragraph styles
884 as appropriate..
886 Note that TABLE-TEMPLATE-NAME corresponds to the
889 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
892 specification for more information. Also consult the
893 implementation filed under `org-odt-get-table-cell-styles'.
896 formatting of numbered display equations. Do not delete this
897 style from the list."
907 use-last-row-styles
908 use-first-column-styles
909 use-last-column-styles
910 use-banding-rows-styles
911 use-banding-columns-styles)
912 :key-type symbol
915 ;;;; Timestamps
918 "Non-nil, if timestamps should be exported as date fields.
920 When nil, export timestamps as plain text.
922 When non-nil, map `org-time-stamp-custom-formats' to a pair of
924 respectively. A timestamp with no time component is formatted
928 This feature is experimental. Most (but not all) of the common
929 %-specifiers in `format-time-string' are supported.
931 formatted as canonical Org timestamps. For finer control, avoid
932 these %-specifiers.
935 etc., are displayed by the application in the default language
936 and country specified in `org-odt-styles-file'. Note that the
938 can localize the week day and month strings in the exported
939 document by setting the default language and country either using
940 the application UI or through a custom styles file.
942 See `org-odt--build-date-styles' for implementation details."
949 \f
950 ;;; Internal functions
952 ;;;; Date
967 ;; LibreOffice does not care about end goes as content
968 ;; within the "<text:date>...</text:date>" field. The
969 ;; displayed date is automagically corrected to match the
970 ;; format requested by "style:data-style-name" attribute. So
971 ;; don't bother about formatting the date contents to be
972 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
973 ;; simple Org-style date should suffice.
998 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
999 iso-date style date)
1001 repeater)))))
1003 ;;;; Frame
1011 extra
1017 style frame-attrs
1029 ;;;; Library wrappers
1036 ;; This is shamelessly stolen from `archive-zip-extract'.
1042 name)))
1047 exit-code command-output)
1055 members))
1057 ;;;; Target
1066 ;;;; Textbox
1069 extra anchor-type)
1075 text)
1076 width nil style extra anchor-type))
1080 ;;;; Table of Contents
1085 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1087 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1094 "
1095 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1097 <text:index-entry-chapter/>
1098 <text:index-entry-text/>
1099 <text:index-entry-link-end/>
1100 </text:table-of-content-entry-template>
1104 </text:table-of-content-source>
1106 <text:index-body>
1109 </text:index-title>
1114 </text:index-body>
1115 </text:table-of-content>
1123 ;; Section number.
1125 ;; Todo.
1130 style todo)))
1135 style priority)))
1136 ;; Title.
1137 text
1138 ;; Tags.
1142 "OrgTags"
1149 headline-label text))
1153 ;; When a headline is marked as a radio target, as in the example below:
1154 ;;
1155 ;; ** <<<Some Heading>>>
1156 ;; Some text.
1157 ;;
1158 ;; suppress generation of radio targets. i.e., Radio targets are to
1159 ;; be marked as targets within /document body/ and *not* within
1160 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1161 ;; and one in the document body.
1162 ;;
1163 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1164 ;; doesn't provide a way to disable memoization. So this doesn't
1165 ;; work.
1166 ;;
1167 ;; FIXME-2: Are there any other objects that need to be suppressed
1168 ;; within TOC?
1188 style entry)))
1193 ;;;; Document styles
1196 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1197 OBJECT-PROPS is (typically) a plist created by passing
1199 `org-odt-parse-block-attributes'.
1201 Use `org-odt-object-counters' to generate an automatic
1202 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1203 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1204 . STYLE-NAME)."
1220 ;;;; Checkbox
1223 "Return check-box string associated to ITEM."
1232 ;;; Template
1235 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1236 ;; to modify the date fields. A date could be modified by
1237 ;; offsetting in days. That's about it. Also, date and time may
1238 ;; have to be emitted as two fields - a date field and a time field
1239 ;; - separately.
1241 ;; One can add Form Controls to date and time fields so that they
1242 ;; can be easily modified. But then, the exported document will
1243 ;; become tightly coupled with LibreOffice and may not function
1244 ;; properly with other OpenDocument applications.
1246 ;; I have a strange feeling that Date styles are a bit flaky at the
1247 ;; moment.
1249 ;; The feature is experimental.
1295 ))
1303 filler-end))
1314 style
1317 output ))))
1320 "Return complete document string after ODT conversion.
1321 CONTENTS is the transcoded contents string. RAW-DATA is the
1322 original parsed data. INFO is a plist holding export options."
1323 ;; Write meta file.
1333 <office:document-meta
1343 ;; Date, if required.
1345 ;; Check if DATE is specified as an Org-timestamp. If yes,
1346 ;; include it as meta information. Otherwise, just use
1347 ;; today's date.
1356 iso-date)))))
1367 ;; Add meta.xml in to manifest.
1370 ;; Update styles file.
1371 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1372 ;; Write styles file.
1375 ;; Non-availability of styles.xml is not a critical
1376 ;; error. For now, throw an error.
1378 org-odt-styles-file
1380 org-odt-styles-dir)
1393 members)))
1403 org-odt-styles-file))))
1405 ;; create a manifest entry for styles.xml
1408 ;; FIXME: Who is opening an empty styles.xml before this point?
1413 ;; Write custom styles for source blocks
1414 ;; Save STYLES used for colorizing of source blocks.
1415 ;; Update styles.xml with styles that were collected as part of
1416 ;; `org-odt-hfy-face-to-css' callbacks.
1425 ;; Update styles.xml - take care of outline numbering
1427 ;; Don't make automatic backup of styles.xml file. This setting
1428 ;; prevents the backed-up styles.xml file from being zipped in to
1429 ;; odt file. This is more of a hackish fix. Better alternative
1430 ;; would be to fix the zip command so that the output odt file
1431 ;; includes only the needed files and excludes any auto-generated
1432 ;; extra files like backups and auto-saves etc etc. Note that
1433 ;; currently the zip command zips up the entire temp directory so
1434 ;; that any auto-generated files created under the hood ends up in
1435 ;; the resulting odt file.
1438 ;; Outline numbering is retained only upto LEVEL.
1439 ;; To disable outline numbering pass a LEVEL of 0.
1452 ;; Update content.xml.
1455 ;; within the context of the Org buffer. So obtain its
1456 ;; value before moving on to temp-buffer context down below.
1466 org-odt-styles-dir)))
1467 ;; Write automatic styles.
1468 ;; - Position the cursor.
1472 ;; - Dump automatic table styles.
1477 ;; - Dump date-styles.
1483 ;; Update display level.
1484 ;; - Remove existing sequence decls. Also position the cursor.
1489 ;; Update sequence decls according to user preference.
1499 ;; Position the cursor to document body.
1504 ;; Preamble - Title, Author, Date etc.
1511 ;; Switch on or off above vars based on user settings
1515 ;; Title.
1520 ;; Separator.
1524 ;; Author only.
1527 "OrgSubtitle"
1529 ;; Separator.
1532 ;; Author and E-mail.
1536 "OrgSubtitle"
1541 ;; Separator.
1543 ;; Date, if required.
1546 ;; Check if DATE is specified as a timestamp.
1552 "OrgSubtitle"
1556 ;; Separator
1558 ;; Table of Contents
1561 with-toc
1564 ;; Contents.
1566 ;; Return contents.
1570 \f
1571 ;;; Transcode Functions
1573 ;;;; Bold
1576 "Transcode BOLD from Org to ODT.
1577 CONTENTS is the text with bold markup. INFO is a plist holding
1578 contextual information."
1583 ;;;; Center Block
1586 "Transcode a CENTER-BLOCK element from Org to ODT.
1587 CONTENTS holds the contents of the center block. INFO is a plist
1588 holding contextual information."
1589 contents)
1592 ;;;; Clock
1595 "Transcode a CLOCK element from Org to ODT.
1596 CONTENTS is nil. INFO is a plist used as a communication
1597 channel."
1610 ;;;; Code
1613 "Transcode a CODE object from Org to ODT.
1614 CONTENTS is nil. INFO is a plist used as a communication
1615 channel."
1621 ;;;; Comment
1623 ;; Comments are ignored.
1626 ;;;; Comment Block
1628 ;; Comment Blocks are ignored.
1631 ;;;; Drawer
1634 "Transcode a DRAWER element from Org to ODT.
1635 CONTENTS holds the contents of the block. INFO is a plist
1636 holding contextual information."
1639 name contents)))
1640 output))
1643 ;;;; Dynamic Block
1646 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1647 CONTENTS holds the contents of the block. INFO is a plist
1648 holding contextual information. See `org-export-data'."
1649 contents)
1652 ;;;; Entity
1655 "Transcode an ENTITY object from Org to ODT.
1656 CONTENTS are the definition itself. INFO is a plist holding
1657 contextual information."
1661 ;;;; Example Block
1664 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1665 CONTENTS is nil. INFO is a plist holding contextual information."
1669 ;;;; Export Snippet
1672 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1673 CONTENTS is nil. INFO is a plist holding contextual information."
1678 ;;;; Fixed Width
1681 "Transcode a FIXED-WIDTH element from Org to ODT.
1682 CONTENTS is nil. INFO is a plist holding contextual information."
1686 ;;;; Footnote Definition
1688 ;; Footnote Definitions are ignored.
1691 ;;;; Footnote Reference
1694 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1695 CONTENTS is nil. INFO is a plist holding contextual information."
1705 id note-class
1718 "OrgSuperscript"
1719 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1720 note-class ref-format ref-name n)))))))
1722 ;; Insert separator between two footnotes in a row.
1727 ;; Transcode footnote reference.
1732 ;; Inline definitions are secondary strings.
1733 ;; Non-inline footnotes definitions are full Org data.
1736 footnote-reference info))
1740 raw
1743 :transcoders
1746 p c i
1747 "Footnote"
1748 "OrgFootnoteCenter"
1750 info))))
1757 ;;;; Headline
1763 ;; Todo.
1767 style todo)))
1772 style priority)))
1773 ;; Title.
1774 text
1775 ;; Tags.
1778 "<text:tab/>"
1787 &optional format-function
1789 "Transcode a HEADLINE element using BACKEND.
1790 INFO is a plist holding contextual information."
1817 todo todo-type priority text tags))))
1820 todo todo-type priority text tags
1825 "Transcode a HEADLINE element from Org to ODT.
1826 CONTENTS holds the contents of the headline. INFO is a plist
1827 holding contextual information."
1828 ;; Case 1: This is a footnote section: ignore it.
1831 ;; Create the headline text.
1833 ;; Get level relative to current parsed data.
1835 ;; Get canonical label for the headline.
1839 ;; Get user-specified labels for the headline.
1842 ;; Extra targets.
1850 ;; Title.
1853 ;; Case 2. This is a deep sub-tree: export it as a list item.
1854 ;; Also export as items headlines for which no section
1855 ;; format has been found.
1857 ;; Build the real contents of the sub-tree.
1861 ;; Choose style based on list type.
1864 ;; If top-level list, re-start numbering. Otherwise,
1865 ;; continue numbering.
1868 headline)))
1878 "Text_20_body"
1880 contents)
1882 "</text:list-header>"
1886 ;; Case 3. Standard headline. Export it as a section.
1892 level
1894 contents))))))
1897 ;;;; Horizontal Rule
1900 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1901 CONTENTS is nil. INFO is a plist holding contextual information."
1906 ;;;; Inline Babel Call
1908 ;; Inline Babel Calls are ignored.
1911 ;;;; Inline Src Block
1914 "Return a character not used in string S.
1916 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1922 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1923 CONTENTS holds the contents of the item. INFO is a plist holding
1924 contextual information."
1931 ;;;; Inlinetask
1934 "Transcode an INLINETASK element from Org to ODT.
1935 CONTENTS holds the contents of the block. INFO is a plist
1936 holding contextual information."
1938 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1939 ;; with appropriate arguments.
1946 todo todo-type priority text tags contents)))))
1949 ;; Otherwise, use a default template.
1952 "Text_20_body"
1956 "OrgInlineTaskHeading"
1958 contents)
1961 ;;;; Italic
1964 "Transcode ITALIC from Org to ODT.
1965 CONTENTS is the text with italic markup. INFO is a plist holding
1966 contextual information."
1971 ;;;; Item
1974 "Transcode an ITEM element from Org to ODT.
1975 CONTENTS holds the contents of the item. INFO is a plist holding
1976 contextual information."
1987 contents
1999 ;;;; Keyword
2002 "Transcode a KEYWORD element from Org to ODT.
2003 CONTENTS is nil. INFO is a plist holding contextual information."
2009 ;; FIXME
2020 ;; FIXME
2024 ;;;; Latex Environment
2027 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2028 ;; (defadvice org-format-latex-as-mathml ; FIXME
2029 ;; (after org-odt-protect-latex-fragment activate)
2030 ;; "Encode LaTeX fragment as XML.
2031 ;; Do this when translation to MathML fails."
2032 ;; (unless (> (length ad-return-value) 0)
2033 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2036 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2037 CONTENTS is nil. INFO is a plist holding contextual information."
2043 ;;;; Latex Fragment
2045 ;; (when latex-frag ; FIXME
2046 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2047 ;; :description latex-frag)))
2048 ;; handle verbatim
2049 ;; provide descriptions
2052 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2053 CONTENTS is nil. INFO is a plist holding contextual information."
2060 ;;;; Line Break
2063 "Transcode a LINE-BREAK object from Org to ODT.
2064 CONTENTS is nil. INFO is a plist holding contextual information."
2068 ;;;; Link
2070 ;;;; Links :: Label references
2081 x)))))
2092 counter))
2099 ;; Section number.
2103 ;; Separator.
2105 ;; Ordinal.
2107 tag))
2110 "Return a label for ELEMENT.
2112 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2113 element. INFO is a plist used as a communication channel. OP is
2114 either `definition' or `reference', depending on the purpose of
2115 the generated string.
2117 Return value is a string if OP is set to `reference' or a cons
2118 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2119 SHORT-CAPTION are strings."
2125 ;; Get label and caption.
2129 ;; FIXME: We don't use short-caption for now
2145 element))))
2148 seqno)
2152 ;; Compute sequence number of the element.
2154 ;; Localize category string.
2157 ;; Case 1: Handle Label definition.
2159 ;; Assign an internal label, if user has not provided one
2164 ;; Sneak in a bookmark. The bookmark is used when the
2165 ;; labeled element is referenced with a link that
2166 ;; provides its own description.
2168 ;; Label definition: Typically formatted as below:
2169 ;; CATEGORY SEQ-NO: LONG CAPTION
2170 ;; with translation for correct punctuation.
2177 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2178 label counter counter seqno))
2180 short-caption))
2181 ;; Case 2: Handle Label reference.
2188 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2194 ;;;; Links :: Inline Images
2197 "Returns the internal name of the file"
2213 target-file))
2216 user-height scale dpi embed-as)
2236 ;; Use Imagemagick.
2241 file))))
2246 ;; Use Emacs.
2252 ;; Use hard-coded values.
2254 org-odt-default-image-sizes-alist))
2255 ;; Error out.
2268 ;; ensure that an embedded image fits comfortably within a page
2279 "Return ODT code for an inline image.
2280 LINK is the link pointing to the inline image. INFO is a plist
2281 used as a communication channel."
2294 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2296 ;; Extract attributes from #+ATTR_ODT line.
2300 ;; Convert attributes to a plist.
2302 ;; Handle `:anchor', `:style' and `:attributes' properties.
2312 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2313 ;;
2314 ;; Handle `:width', `:height' and `:scale' properties. Read
2315 ;; them as numbers since we need them for computations.
2317 src-expanded
2324 nil ; embed-as
2326 ))
2333 ;; Check if this link was created by LaTeX-to-PNG converter.
2337 ;; If yes, note down the type of the element - LaTeX Fragment
2338 ;; or LaTeX environment. It will go in to frame title.
2342 ;; If yes, note down its contents. It will go in to frame
2343 ;; description. This quite useful for debugging.
2346 captions user-frame-params title desc)))
2349 ;;;; Links :: Math formula
2370 ;; Check if this link was created by LaTeX-to-MathML
2371 ;; converter.
2375 ;; If yes, note down the type of the element - LaTeX Fragment
2376 ;; or LaTeX environment. It will go in to frame title.
2380 ;; If yes, note down its contents. It will go in to frame
2381 ;; description. This quite useful for debugging.
2383 width height)
2387 nil nil title desc))
2390 "CaptionedDisplayFormula" href width height
2391 captions nil title desc))
2395 org-odt--enumerable-formula-p))))
2400 "Returns the internal name of the file"
2404 ;; Create a directory for holding formula file. Also enter it in
2405 ;; to manifest.
2409 ;; Copy over the formula file from user directory to zip
2410 ;; directory.
2414 ;; Case 1: Mathml.
2417 ;; Case 2: OpenDocument formula.
2422 ;; Enter the formula file in to manifest.
2424 target-file))
2426 ;;;; Targets
2429 captions user-frame-params
2432 ;; Each element of this alist is of the form (CFG-HANDLE
2433 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2435 ;; CFG-HANDLE is the key to the alist.
2437 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2438 ;; frame params for INNER-FRAME and OUTER-FRAME
2439 ;; respectively. See below.
2441 ;; Configurations that are meant to be applied to
2442 ;; non-captioned image/formula specifies no
2443 ;; OUTER-FRAME-PARAMS.
2445 ;; TERMINOLOGY
2446 ;; ===========
2447 ;; INNER-FRAME :: Frame that directly surrounds an
2448 ;; image/formula.
2450 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2451 ;; frame also contains the caption, if any.
2453 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2454 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2455 ;; that these are the last three arguments
2456 ;; to `org-odt--frame'.
2458 ;; Note that an un-captioned image/formula requires just an
2459 ;; INNER-FRAME, while a captioned image/formula requires
2460 ;; both an INNER and an OUTER-FRAME.
2482 ;; Retrieve inner and outer frame params, from configuration.
2486 ;; User-specified frame params (from #+ATTR_ODT spec)
2490 "Merge default and user frame params."
2495 for d in default
2498 ;; Case 1: Image/Formula has no caption.
2499 ;; There is only one frame, one that surrounds the image
2500 ;; or formula.
2502 ;; Merge user frame params with that from configuration.
2506 ;; Case 2: Image/Formula is captioned or labeled.
2507 ;; There are two frames: The inner one surrounds the
2508 ;; image or formula. The outer one contains the
2509 ;; caption/sequence number.
2511 ;; Merge user frame params with outer frame params.
2513 ;; Short caption, if specified, goes as part of inner frame.
2520 frame-params))
2523 "Illustration"
2527 caption))
2528 width height outer)))))
2531 ;; Element should have a caption or label.
2537 element info
2538 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2539 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2540 ;; processing.)
2545 ;; Link should point to an image file.
2552 element info
2553 ;; Paragraph should have a caption or label. It SHOULD also be a
2554 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2555 ;; processing.)
2560 ;; Link should point to an image file.
2567 element info
2568 ;; Paragraph should have a caption or label.
2572 ;; Link should point to a MathML or ODF file.
2578 paragraph-predicate
2579 link-predicate)
2580 "Test if ELEMENT is a standalone link for the purpose ODT export.
2581 INFO is a plist holding contextual information.
2583 Return non-nil, if ELEMENT is of type paragraph satisfying
2584 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2585 is a link that satisfies LINK-PREDICATE.
2587 Return non-nil, if ELEMENT is of type link satisfying
2588 LINK-PREDICATE and its containing paragraph satisfies
2589 PARAGRAPH-PREDICATE in addition to having no other content save for
2590 leading and trailing whitespaces.
2592 Return nil, otherwise."
2615 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2616 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2617 ;; attached. Note that labels that are attached to captioned
2618 ;; entities - inline images, math formulae and tables - get resolved
2619 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2621 ;; Create a cross-reference to DESTINATION but make best-efforts to
2622 ;; create a *meaningful* description. Check item numbers, section
2623 ;; number and section title in that order.
2625 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2626 ;; FIXME: Handle footnote-definition footnote-reference?
2642 return x))
2643 ;; Get list item nos.
2648 plain-list)
2651 item info t))))))
2652 ;; Locate top-most listified headline.
2657 return x))
2658 ;; Get listified headline numbers.
2664 el info t)))))))
2665 ;; Combine item numbers from both the listified headlines and
2666 ;; regular list items.
2668 ;; Case 1: Check if all the parents of list item are numbered.
2669 ;; If yes, link to the item proper.
2672 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2677 ;; Case 2: Locate a regular and numbered headline in the
2678 ;; hierarchy. Display its section number.
2683 return el)))
2684 ;; We found one.
2686 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2690 ;; Case 4: Locate a regular headline in the hierarchy. Display
2691 ;; its title.
2695 return el)))
2696 ;; We found one.
2698 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2705 "Transcode a LINK object from Org to ODT.
2707 DESC is the description part of the link, or the empty string.
2708 INFO is a plist holding contextual information. See
2709 `org-export-data'."
2712 ;; Ensure DESC really exists, or set it to nil.
2715 link org-odt-inline-image-rules))
2722 ;; Convert & to & for correct XML representation
2724 protocol)
2726 ;; Image file.
2728 link org-odt-inline-image-rules))
2730 ;; Formula file.
2732 link org-odt-inline-formula-rules))
2734 ;; Radio target: Transcode target's contents and use them as
2735 ;; link's description.
2740 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2743 desc))))
2744 ;; Links pointing to a headline: Find destination and build
2745 ;; appropriate referencing command.
2751 ;; Case 1: Fuzzy link points nowhere.
2752 ('nil
2754 "Emphasis"
2757 info))))
2758 ;; Case 2: Fuzzy link points to a headline.
2760 ;; If there's a description, create a hyperlink.
2761 ;; Otherwise, try to provide a meaningful description.
2770 label desc))))
2771 ;; Case 3: Fuzzy link points to a target.
2773 ;; If there's a description, create a hyperlink.
2774 ;; Otherwise, try to provide a meaningful description.
2779 desc))))
2780 ;; Case 4: Fuzzy link points to some element (e.g., an
2781 ;; inline image, a math formula or a table).
2788 ;; LINK has no description. Create
2789 ;; a cross-reference showing entity's sequence
2790 ;; number.
2792 ;; LINK has description. Insert a hyperlink with
2793 ;; user-provided description.
2798 desc)))))))))
2799 ;; Coderef: replace link with the reference name or the
2800 ;; equivalent line number.
2807 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2808 href line-no))))
2809 ;; Link type is handled by a special function.
2812 ;; External link with a description part.
2815 ;; Check if description is a link to an inline image.
2820 desc-element org-odt-inline-image-rules))))
2821 ;; Format link as a clickable image.
2823 path desc)
2824 ;; Otherwise, format it as a regular link.
2826 path desc))))
2827 ;; External link without a description part.
2830 path path))
2831 ;; No path, only description. Try to do something useful.
2836 ;;;; Node Property
2839 "Transcode a NODE-PROPERTY element from Org to ODT.
2840 CONTENTS is nil. INFO is a plist holding contextual
2841 information."
2848 ;;;; Paragraph
2851 "Return style of PARAGRAPH.
2852 Style is a symbol among `quoted', `centered' and nil."
2862 "Format paragraph according to given styles.
2863 PARAGRAPH is a paragraph type element. CONTENTS is the
2864 transcoded contents of that paragraph, as a string. INFO is
2865 a plist used as a communication channel. DEFAULT, CENTER and
2866 QUOTE are, respectively, style to use when paragraph belongs to
2867 no special environment, a center block, or a quote block."
2873 ;; If PARAGRAPH is a leading paragraph in an item that has
2874 ;; a checkbox, splice checkbox and paragraph contents
2875 ;; together.
2880 contents)))
2883 "Transcode a PARAGRAPH element from Org to ODT.
2884 CONTENTS is the contents of the paragraph, as a string. INFO is
2885 the plist used as a communication channel."
2887 paragraph contents info
2889 "OrgCenter"
2893 ;;;; Plain List
2896 "Transcode a PLAIN-LIST element from Org to ODT.
2897 CONTENTS is the contents of the list. INFO is a plist holding
2898 contextual information."
2900 ;; Choose style based on list type.
2906 ;; If top-level list, re-start numbering. Otherwise,
2907 ;; continue numbering.
2912 contents))
2914 ;;;; Plain Text
2927 line))
2938 "Transcode a TEXT string from Org to ODT.
2939 TEXT is the string to transcode. INFO is a plist holding
2940 contextual information."
2942 ;; Protect &, < and >.
2944 ;; Handle smart quotes. Be sure to provide original string since
2945 ;; OUTPUT may have been modified.
2948 ;; Convert special strings.
2954 org-odt-special-string-regexps))
2955 ;; Handle break preservation if required.
2959 ;; Return value.
2960 output))
2963 ;;;; Planning
2966 "Transcode a PLANNING element from Org to ODT.
2967 CONTENTS is nil. INFO is a plist used as a communication
2968 channel."
2970 "OrgPlanning"
2992 ;;;; Property Drawer
2995 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2996 CONTENTS holds the contents of the drawer. INFO is a plist
2997 holding contextual information."
3000 contents)))
3003 ;;;; Quote Block
3006 "Transcode a QUOTE-BLOCK element from Org to ODT.
3007 CONTENTS holds the contents of the block. INFO is a plist
3008 holding contextual information."
3009 contents)
3012 ;;;; Section
3017 style
3019 text)))
3023 "Transcode a SECTION element from Org to ODT.
3024 CONTENTS holds the contents of the section. INFO is a plist
3025 holding contextual information."
3026 contents)
3028 ;;;; Radio Target
3031 "Transcode a RADIO-TARGET object from Org to ODT.
3032 TEXT is the text of the target. INFO is a plist holding
3033 contextual information."
3039 ;;;; Special Block
3042 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3043 CONTENTS holds the contents of the block. INFO is a plist
3044 holding contextual information."
3050 ;; Annotation.
3056 ;; FIXME: Is `car' right thing to do below?
3067 contents)))))
3068 ;; Textbox.
3077 style extra anchor))))
3081 ;;;; Src Block
3084 "Create custom style for face FN.
3085 When FN is the default face, use its foreground and background
3087 use its color attribute to create a character style whose name
3088 is obtained from FN. Currently all attributes of FN other than
3089 color are ignored.
3091 The style name for a face FN is derived using the following
3092 operations on the face name in that order - de-dash, CamelCase
3094 `font-lock-function-name-face' is associated with
3108 background-color-val color-val))
3111 "
3142 org-odt-fontify-srcblocks
3159 code
3170 par-style loc))
3173 num-start refs))
3187 ;; Extract code and references.
3191 ;; Does the src block contain labels?
3193 ;; Does it have line numbers?
3200 "Transcode a SRC-BLOCK element from Org to ODT.
3201 CONTENTS holds the contents of the item. INFO is a plist holding
3202 contextual information."
3214 "Text_20_body"
3218 ;;;; Statistics Cookie
3221 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3222 CONTENTS is nil. INFO is a plist holding contextual information."
3228 ;;;; Strike-Through
3231 "Transcode STRIKE-THROUGH from Org to ODT.
3232 CONTENTS is the text with strike-through markup. INFO is a plist
3233 holding contextual information."
3238 ;;;; Subscript
3241 "Transcode a SUBSCRIPT object from Org to ODT.
3242 CONTENTS is the contents of the object. INFO is a plist holding
3243 contextual information."
3248 ;;;; Superscript
3251 "Transcode a SUPERSCRIPT object from Org to ODT.
3252 CONTENTS is the contents of the object. INFO is a plist holding
3253 contextual information."
3258 ;;;; Table Cell
3267 "Retrieve styles applicable to a table cell.
3268 R and C are (zero-based) row and column numbers of the table
3269 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3270 applicable to the current table. It is `nil' if the table is not
3271 associated with any style attributes.
3273 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3275 When STYLE-SPEC is nil, style the table cell the conventional way
3276 - choose cell borders based on row and column groupings and
3277 choose paragraph alignment based on `org-col-cookies' text
3278 property. See also
3279 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3281 When STYLE-SPEC is non-nil, ignore the above cookie and return
3282 styles congruent with the ODF-1.2 specification."
3288 info)))
3290 ;; LibreOffice - particularly the Writer - honors neither table
3291 ;; templates nor custom table-cell styles. Inorder to retain
3292 ;; inter-operability with LibreOffice, only automatic styles are
3293 ;; used for styling of table-cells. The current implementation is
3294 ;; congruent with ODF-1.2 specification and hence is
3295 ;; future-compatible.
3297 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3298 ;; which recognizes as many as 16 different cell types - is much
3299 ;; richer. Unfortunately it is NOT amenable to easy configuration
3300 ;; by hand.
3327 "Transcode a TABLE-CELL element from Org to ODT.
3328 CONTENTS is nil. INFO is a plist used as a communication
3329 channel."
3336 table-cell info))
3359 table-cell info))))))
3363 custom-style-prefix))
3365 "OrgTblCell"
3381 cell-attributes
3384 org-element-all-elements)
3385 contents
3387 paragraph-style contents))))
3394 ;;;; Table Row
3397 "Transcode a TABLE-ROW element from Org to ODT.
3398 CONTENTS is the contents of the row. INFO is a plist used as a
3399 communication channel."
3400 ;; Rules are ignored since table separators are deduced from
3401 ;; borders of the current row.
3407 ;; If the row belongs to the first rowgroup and the
3408 ;; table has more than one row groups, then this row
3409 ;; belongs to the header row group.
3411 ;; Otherwise, it belongs to non-header row group.
3414 ;; Does this row begin a rowgroup?
3417 ;; Actual table row
3419 ;; Does this row end a rowgroup?
3424 ;;;; Table
3437 "Transcode a TABLE element from Org to ODT.
3438 CONTENTS is the contents of the table. INFO is a plist holding
3439 contextual information."
3441 ;; Case 1: table.el doesn't support export to OD format. Strip
3442 ;; such tables from export.
3447 "(ox-odt): Found table.el-type table in the source Org file."
3448 " table.el doesn't support export to ODT format."
3450 ;; Case 2: Native Org tables.
3467 column-style))
3468 out)
3472 ;; caption.
3476 ;; begin table.
3484 ;; column specification.
3486 ;; actual contents.
3488 ;; end table.
3492 "Transcode a TABLE element from Org to ODT.
3493 CONTENTS is the contents of the table. INFO is a plist holding
3494 contextual information.
3496 Use `org-odt--table' to typeset the table. Handle details
3497 pertaining to indentation here."
3512 collect el)))
3518 collect
3523 parent-list)
3525 ;; Handle list genealogy.
3545 parent-list info)
3548 ;; Handle low-level headlines.
3550 with step = 'item collect
3558 el info)
3559 "OrgNumberedList"
3570 parent-list info)))
3578 table info)))
3579 ;; OpenDocument schema does not permit table to occur within a
3580 ;; list item.
3582 ;; One solution - the easiest and lightweight, in terms of
3583 ;; implementation - is to put the table in an indented text box
3584 ;; and make the text box part of the list-item. Unfortunately if
3585 ;; the table is big and spans multiple pages, the text box could
3586 ;; overflow. In this case, the following attribute will come
3587 ;; handy.
3589 ;; ,---- From OpenDocument-v1.1.pdf
3590 ;; | 15.27.28 Overflow behavior
3591 ;; |
3592 ;; | For text boxes contained within text document, the
3593 ;; | style:overflow-behavior property specifies the behavior of text
3594 ;; | boxes where the containing text does not fit into the text
3595 ;; | box.
3596 ;; |
3597 ;; | If the attribute's value is clip, the text that does not fit
3598 ;; | into the text box is not displayed.
3599 ;; |
3600 ;; | If the attribute value is auto-create-new-frame, a new frame
3601 ;; | will be created on the next page, with the same position and
3602 ;; | dimensions of the original frame.
3603 ;; |
3604 ;; | If the style:overflow-behavior property's value is
3605 ;; | auto-create-new-frame and the text box has a minimum width or
3606 ;; | height specified, then the text box will grow until the page
3607 ;; | bounds are reached before a new frame is created.
3608 ;; `----
3610 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3611 ;; auto-create-new-frame property and always resorts to clipping
3612 ;; the text box. This results in table being truncated.
3614 ;; So we solve the problem the hard (and fun) way using list
3615 ;; continuations.
3617 ;; The problem only becomes more interesting if you take in to
3618 ;; account the following facts:
3619 ;;
3620 ;; - Description lists are simulated as plain lists.
3621 ;; - Low-level headlines can be listified.
3622 ;; - In Org-mode, a table can occur not only as a regular list
3623 ;; item, but also within description lists and low-level
3624 ;; headlines.
3626 ;; See `org-odt-translate-description-lists' and
3627 ;; `org-odt-translate-low-level-headlines' for how this is
3628 ;; tackled.
3631 ;; Discontinue the list.
3633 ;; Put the table in an indented section.
3638 ;; Continue the list.
3642 ;;;; Target
3645 "Transcode a TARGET object from Org to ODT.
3646 CONTENTS is nil. INFO is a plist holding contextual
3647 information."
3652 ;;;; Timestamp
3655 "Transcode a TIMESTAMP object from Org to ODT.
3656 CONTENTS is nil. INFO is a plist used as a communication
3657 channel."
3674 "OrgActiveTimestamp"
3678 "OrgInactiveTimestamp"
3682 "OrgActiveTimestamp"
3688 "OrgInactiveTimestamp"
3694 "OrgDiaryTimestamp"
3696 info)))))))
3699 ;;;; Underline
3702 "Transcode UNDERLINE from Org to ODT.
3703 CONTENTS is the text with underline markup. INFO is a plist
3704 holding contextual information."
3709 ;;;; Verbatim
3712 "Transcode a VERBATIM object from Org to ODT.
3713 CONTENTS is nil. INFO is a plist used as a communication
3714 channel."
3720 ;;;; Verse Block
3723 "Transcode a VERSE-BLOCK element from Org to ODT.
3724 CONTENTS is verse block contents. INFO is a plist holding
3725 contextual information."
3726 ;; Add line breaks to each line of verse.
3730 ;; Replace tabs and spaces.
3732 ;; Surround it in a verse environment.
3737 \f
3738 ;;; Filters
3740 ;;;; LaTeX fragments
3745 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3746 ;; If the desired converter is not available, force verbatim
3747 ;; processing.
3765 ;; Store normalized value for later use.
3770 ;; Convert `latex-fragment's and `latex-environment's.
3788 ;; Get an Org-style link to PNG image or the MathML
3789 ;; file.
3794 nil display-msg
3795 nil nil processing-type)
3800 link))))
3802 ;; Conversion succeeded. Parse above Org-style link to a
3803 ;; `link' object.
3809 ;; Orphan the link.
3814 ;; Case 1: LaTeX environment.
3815 ;; Mimic a "standalone image or formula" by
3816 ;; enclosing the `link' in a `paragraph'.
3817 ;; Copy over original attributes, captions to
3818 ;; the enclosing paragraph.
3824 latex-*)
3826 latex-*)))
3827 link))
3828 ;; Case 2: LaTeX fragment.
3829 ;; No special action.
3831 ;; Note down the object that link replaces.
3835 ;; Replace now.
3837 info)))
3838 tree)
3841 ;;;; Description lists
3843 ;; This translator is necessary to handle indented tables in a uniform
3844 ;; manner. See comment in `org-odt--table'.
3847 ;; OpenDocument has no notion of a description list. So simulate it
3848 ;; using plain lists. Description lists in the exported document
3849 ;; are typeset in the same manner as they are in a typical HTML
3850 ;; document.
3851 ;;
3852 ;; Specifically, a description list like this:
3853 ;;
3854 ;; ,----
3855 ;; | - term-1 :: definition-1
3856 ;; | - term-2 :: definition-2
3857 ;; `----
3858 ;;
3859 ;; gets translated in to the following form:
3860 ;;
3861 ;; ,----
3862 ;; | - term-1
3863 ;; | - definition-1
3864 ;; | - term-2
3865 ;; | - definition-2
3866 ;; `----
3867 ;;
3868 ;; Further effect is achieved by fixing the OD styles as below:
3869 ;;
3870 ;; 1. Set the :type property of the simulated lists to
3871 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3872 ;; that has *no* bullets whatsoever.
3873 ;;
3874 ;; 2. The paragraph containing the definition term is styled to be
3875 ;; in bold.
3876 ;;
3881 el
3897 nil)
3898 info)
3899 tree)
3901 ;;;; List tables
3903 ;; Lists that are marked with attribute `:list-table' are called as
3904 ;; list tables. They will be rendered as a table within the exported
3905 ;; document.
3907 ;; Consider an example. The following list table
3908 ;;
3909 ;; #+attr_odt :list-table t
3910 ;; - Row 1
3911 ;; - 1.1
3912 ;; - 1.2
3913 ;; - 1.3
3914 ;; - Row 2
3915 ;; - 2.1
3916 ;; - 2.2
3917 ;; - 2.3
3918 ;;
3919 ;; will be exported as though it were an Org table like the one show
3920 ;; below.
3921 ;;
3922 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3923 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3924 ;;
3925 ;; Note that org-tables are NOT multi-line and each line is mapped to
3926 ;; a unique row in the exported document. So if an exported table
3927 ;; needs to contain a single paragraph (with copious text) it needs to
3928 ;; be typed up in a single line. Editing such long lines using the
3929 ;; table editor will be a cumbersome task. Furthermore inclusion of
3930 ;; multi-paragraph text in a table cell is well-nigh impossible.
3931 ;;
3932 ;; A LIST-TABLE circumvents above problems.
3933 ;;
3934 ;; Note that in the example above the list items could be paragraphs
3935 ;; themselves and the list can be arbitrarily deep.
3936 ;;
3937 ;; Inspired by following thread:
3938 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3940 ;; Translate lists to tables
3946 ;; Replace list with table.
3948 l1-list
3949 ;; Build replacement table.
3955 l1-item-leading-text l2-list)
3956 ;; Remove Level-2 list from the Level-item. It
3957 ;; will be subsequently attached as table-cells.
3967 ;; Level-1 items start a table row.
3970 ;; Leading text of level-1 item define
3971 ;; the first table-cell.
3974 l1-item-leading-text)
3975 ;; Level-2 items define subsequent
3976 ;; table-cells of the row.
3984 nil)
3985 info)
3986 tree)
3988 \f
3989 ;;; Interactive functions
4002 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4011 org-odt-manifest-file-entries)
4019 ;; Initialize temporary workarea. All files that end up in
4020 ;; the exported document get parked/created here.
4027 ;; Kill all XML buffers.
4035 org-odt-xml-files)
4036 ;; Delete temporary directory and also other embedded
4037 ;; files that get copied there.
4042 ;; Not at all OSes ship with zip by default
4044 ;; Do export. This creates a bunch of xml files ready to be
4045 ;; saved and zipped.
4047 ;; Create a manifest entry for content.xml.
4049 ;; Write mimetype file
4058 ;; Write out the manifest entries before zipping
4060 ;; Save all XML files.
4066 ;; Prettify output if needed.
4070 org-odt-xml-files)
4071 ;; Run zip.
4076 ;; If a file with same name as the desired output file
4077 ;; exists, remove it.
4080 ;; Zip up the xml files.
4083 ;; Switch temporarily to content.xml. This way Zip
4084 ;; process will inherit `org-odt-zip-dir' as the current
4085 ;; directory.
4099 err-string)))))
4100 cmds)))
4101 ;; Move the zip file from temporary work directory to
4102 ;; user-mandated location.
4105 ;; Cleanup work directory and work files.
4107 ;; Open the OpenDocument file in archive-mode for
4108 ;; examination.
4110 ;; Return exported file.
4112 ;; Case 1: Conversion desired on exported file. Run the
4113 ;; converter on the OpenDocument file. Return the
4114 ;; converted file.
4117 target))
4118 ;; Case 2: No further conversion. Return exported
4119 ;; OpenDocument file.
4122 ;; Cleanup work directory and work files.
4128 ;;;; Export to OpenDocument formula
4130 ;;;###autoload
4132 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4133 Use `org-create-math-formula' to convert LATEX-FRAG first to
4134 MathML. When invoked as an interactive command, use
4135 `org-latex-regexps' to infer LATEX-FRAG from currently active
4136 region. If no LaTeX fragments are found, prompt for it. Push
4137 MathML source to kill ring depending on the value of
4138 `org-export-copy-to-kill-ring'."
4164 filename
4177 ;; Add MathML to kill ring, if needed.
4181 ;;;###autoload
4183 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4184 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4185 formula file."
4190 ;;;; Export to OpenDocument Text
4192 ;;;###autoload
4194 "Export current buffer to a ODT file.
4196 If narrowing is active in the current buffer, only export its
4197 narrowed part.
4199 If a region is active, export that region.
4201 A non-nil optional argument ASYNC means the process should happen
4202 asynchronously. The resulting file should be accessible through
4203 the `org-export-stack' interface.
4205 When optional argument SUBTREEP is non-nil, export the sub-tree
4206 at point, extracting information from the headline properties
4207 first.
4209 When optional argument VISIBLE-ONLY is non-nil, don't export
4210 contents of hidden elements.
4212 EXT-PLIST, when provided, is a property list with external
4213 parameters overriding Org default settings, but still inferior to
4214 file-local settings.
4216 Return output file's name."
4223 ,outfile
4228 ;; Let `htmlfontify' know that we are interested in
4229 ;; collecting styles.
4231 ;; Initialize content.xml and kick-off the export
4232 ;; process.
4245 outfile
4250 ;; Let `htmlfontify' know that we are interested in collecting
4251 ;; styles.
4253 ;; Initialize content.xml and kick-off the export process.
4263 ;;;; Convert between OpenDocument and other formats
4266 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4275 "Workhorse routine for `org-odt-convert'."
4284 in-fmt out-fmt)))
4312 out-file)
4315 nil))))
4318 "Return verbose info about formats to which IN-FMT can be converted.
4319 Return a list where each element is of the
4320 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4321 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4322 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4326 org-odt-convert-processes t))))
4330 org-odt-convert-processes t))
4331 org-odt-convert-capabilities))
4332 reachable-formats)
4337 reachable-formats))
4340 "Return list of formats to which IN-FMT can be converted.
4341 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4347 l))
4350 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4351 This is a helper routine for interactive use."
4354 nil buffer-file-name t))
4360 out-fmt-choices nil nil nil))
4362 "No known converter or no known output formats for %s files"
4363 in-fmt))))
4366 ;;;###autoload
4368 "Convert IN-FILE to format OUT-FMT using a command line converter.
4369 IN-FILE is the file to be converted. If unspecified, it defaults
4370 to variable `buffer-file-name'. OUT-FMT is the desired output
4371 format. Use `org-odt-convert-process' as the converter.
4372 If PREFIX-ARG is non-nil then the newly converted file is opened
4373 using `org-open-file'."
4378 ;;; Library Initializations
4382 ;; Let Emacs open all OpenDocument files in archive mode
4385 org-odt-file-extensions)
4389 ;; Local variables:
4390 ;; generated-autoload-file: "org-loaddefs.el"
4391 ;; End:
4393 ;;; ox-odt.el ends here