| blob | 1ee201ba23f4cb400e608b93647e1512e75cf988 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2015 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
89 org-odt--translate-description-lists
90 org-odt--translate-list-tables)))
91 :menu-entry
98 :options-alist
100 ;; Redefine regular option.
104 ;;; Dependencies
106 ;;; Hooks
108 ;;; Function Declarations
118 \f
119 ;;; Internal Variables
123 "Location of ODT exporter.
124 Use this to infer values of `org-odt-styles-dir' and
129 "Data directory for ODT exporter.
130 Use this to infer values of `org-odt-styles-dir' and
147 "List of directories to search for OpenDocument schema files.
148 Use this list to set the default value of
149 `org-odt-schema-dir'. The entries in this list are
150 populated heuristically based on the values of `org-odt-lib-dir'
163 )
164 "List of directories to search for OpenDocument styles files.
165 See `org-odt-styles-dir'. The entries in this list are populated
166 heuristically based on the values of `org-odt-lib-dir' and
183 styles-dir)
185 org-odt-styles-dir-list)
186 nil)))
189 styles-dir)
190 "Directory that holds auxiliary XML files used by the ODT exporter.
192 This directory contains the following XML files -
194 XML files are used as the default values of
195 `org-odt-styles-file' and
196 `org-odt-content-template-file'.
198 The default value of this variable varies depending on the
199 version of org in use and is initialized from
200 `org-odt-styles-dir-list'. Note that the user could be using org
201 from one of: org's own private git repository, GNU ELPA tar or
224 "
226 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
227 </style:style>
228 "
232 "Registry of automatic styles for various OBJECT-TYPEs.
233 The variable has the following form:
234 ((OBJECT-TYPE-A
235 ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
236 (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
237 (OBJECT-TYPE-B
238 ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
239 (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
240 ...).
243 OBJECT-PROPS is (typically) a plist created by passing
249 "Running counters for various OBJECT-TYPEs.
250 Use this to generate automatic names and style-names. See
254 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
255 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
256 <style:background-image/>
257 </style:paragraph-properties>
259 </style:style>"
260 "Custom paragraph style for colorized source and example blocks.
262 except that the foreground and background colors are set
277 "Hardcoded image dimensions one for each of the anchor
280 ;; A4 page size is 21.0 by 29.7 cms
281 ;; The default page settings has 2cm margin on each of the sides. So
282 ;; the effective text area is 17.0 by 25.7 cm
291 "Specify how labels are applied and referenced.
293 This is an alist where each element is of the form:
295 (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
297 ATTACH-FMT controls how labels and captions are attached to an
298 entity. It may contain following specifiers - %e and %c. %e is
299 replaced with the CATEGORY-NAME. %n is replaced with
301 with CAPTION.
303 REF-MODE and REF-FMT controls how label references are generated.
304 The following XML is generated for a label reference -
307 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
308 %n is replaced with SEQNO.
318 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
320 This is a list where each entry is of the form:
322 (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
324 CATEGORY_HANDLE identifies the captionable entity in question.
326 OD-VARIABLE is the OpenDocument sequence counter associated with
327 the entity. These counters are declared within
329 `org-odt-content-template-file'.
331 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
332 how a given entity should be captioned and referenced.
334 CATEGORY-NAME is used for qualifying captions on export.
336 ENUMERATOR-PREDICATE is used for assigning a sequence number to
346 \f
347 ;;; User Configuration Variables
350 "Options for exporting Org mode files to ODT."
355 ;;;; Debugging
358 "Specify whether or not the xml output should be prettified.
359 When this option is turned on, `indent-region' is run on all
360 component xml buffers before they are saved. Turn this off for
361 regular use. Turn this on if you need to examine the xml
362 visually."
368 ;;;; Document schema
381 schema-dir))
384 schema-dir))
388 schema-dir)
390 org-odt-schema-dir-list)
392 nil)))
393 schema-dir)
394 "Directory that contains OpenDocument schema files.
396 This directory contains:
397 1. rnc files for OpenDocument schema
399 for auto validation of OpenDocument XML files.
401 Use the customize interface to set this variable. This ensures
402 that `rng-schema-locating-files' is updated and auto-validation
403 of OpenDocument XML takes place based on the value
404 `rng-nxml-auto-validate-flag'.
406 The default value of this variable varies depending on the
407 version of org in use and is initialized from
408 `org-odt-schema-dir-list'. The OASIS schema files are available
409 only in the org's private git repository. It is *not* bundled
410 with GNU ELPA tar or standard Emacs distribution."
416 :set
418 "Set `org-odt-schema-dir'.
419 Also add it to `rng-schema-locating-files'."
429 schema-dir
432 value))
433 nil)))
438 org-odt-schema-dir))))))
441 ;;;; Document styles
445 The exporter embeds the exported content just before
449 under `org-odt-styles-dir' is used."
456 "Default styles file for use with ODT export.
457 Valid values are one of:
458 1. nil
459 2. path to a styles.xml file
460 3. path to a *.odt or a *.ott file
461 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
462 ...))
464 In case of option 1, an in-built styles.xml is used. See
465 `org-odt-styles-dir' for more information.
467 In case of option 3, the specified file is unzipped and the
468 styles.xml embedded therein is used.
470 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
471 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
472 generated odt file. Use relative path for specifying the
473 FILE-MEMBERS. styles.xml must be specified as one of the
474 FILE-MEMBERS.
476 Use options 1, 2 or 3 only if styles.xml alone suffices for
477 achieving the desired formatting. Use option 4, if the styles.xml
478 references additional files like header and footer images for
479 achieving the desired formatting.
482 a per-file basis. For example,
488 :type
500 "Outline levels considered for enumerating captioned entities."
506 ;;;; Document conversion
513 "Specify a list of document converters and their usage.
514 The converters in this list are offered as choices while
515 customizing `org-odt-convert-process'.
517 This variable is a list where each element is of the
518 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
519 of the converter. CONVERTER-CMD is the shell command for the
520 converter and can contain format specifiers. These format
521 specifiers are interpreted as below:
523 %i input file name in full
524 %I input file name as a URL
525 %f format of the output file
526 %o output file name in full
527 %O output file name as a URL
528 %d output dir in full
529 %D output dir as a URL.
530 %x extra options as set in `org-odt-convert-capabilities'."
533 :type
542 During customization, the list of converter names are populated
543 from `org-odt-convert-processes'."
553 org-odt-convert-processes))))
571 "Specify input and output formats of `org-odt-convert-process'.
572 More correctly, specify the set of input and output formats that
573 the user is actually interested in.
575 This variable is an alist where each element is of the
576 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
577 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
578 alist where each element is of the form (OUTPUT-FMT
579 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
581 The variable is interpreted as follows:
582 `org-odt-convert-process' can take any document that is in
583 INPUT-FMT-LIST and produce any document that is in the
584 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
585 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
586 serves dual purposes:
587 - It is used for populating completion candidates during
588 `org-odt-convert' commands.
590 `org-odt-convert-process'.
593 `org-odt-convert-process'.
595 DOCUMENT-CLASS is used to group a set of file formats in
596 INPUT-FMT-LIST in to a single class.
598 Note that this variable inherently captures how LibreOffice based
599 converters work. LibreOffice maps documents of various formats
600 to classes like Text, Web, Spreadsheet, Presentation etc and
601 allow document of a given class (irrespective of its source
602 format) to be converted to any of the export formats associated
603 with that class.
605 See default setting of this variable for an typical
606 configuration."
609 :type
614 :value-type
618 :value-type
627 and then uses `org-odt-convert-process' to convert the
628 resulting document to this format. During customization of this
629 variable, the list of valid values are populated based on
630 `org-odt-convert-capabilities'.
632 You can set this option on per-file basis using file local
633 values. See Info node `(emacs) File Variables'."
644 ;;;###autoload
648 ;;;; Drawers
652 "Function called to format a drawer in ODT code.
654 The function must accept two parameters:
656 CONTENTS the contents of the drawer.
658 The function should return the string to be exported.
660 The default value simply returns the value of CONTENTS."
667 ;;;; Headline
670 "Function to format headline text.
672 This function will be called with 5 arguments:
673 TODO the todo keyword (string or nil).
674 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
675 PRIORITY the priority of the headline (integer or nil)
676 TEXT the main headline text (string).
677 TAGS the tags string, separated with colons (string or nil).
679 The function result will be used as headline text."
686 ;;;; Inlinetasks
689 "Function called to format an inlinetask in ODT code.
691 The function must accept six parameters:
692 TODO the todo keyword, as a string
693 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
694 PRIORITY the inlinetask priority, as a string
695 NAME the inlinetask name, as a string.
696 TAGS the inlinetask tags, as a string.
697 CONTENTS the contents of the inlinetask, as a string.
699 The function should return the string to be exported."
706 ;;;; LaTeX
709 "Non-nil means process LaTeX math snippets.
711 When set, the exporter will process LaTeX environments and
712 fragments.
714 This option can also be set with the +OPTIONS line,
717 nil Ignore math snippets.
718 `verbatim' Keep everything in verbatim
719 `dvipng' Process the LaTeX fragments to images. This will also
720 include processing of non-math environments.
721 `imagemagick' Convert the LaTeX fragments to pdf files and use
722 imagemagick to convert pdf files to png files.
723 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
724 be loaded.
725 t Synonym for `mathjax'."
737 ;;;; Links
741 "Rules characterizing formula files that can be inlined into ODT.
743 A rule consists in an association whose key is the type of link
744 to consider, and value is a regexp that will be matched against
745 link's path."
754 "Rules characterizing image files that can be inlined into ODT.
756 A rule consists in an association whose key is the type of link
757 to consider, and value is a regexp that will be matched against
758 link's path."
766 "Scaling factor for converting images pixels to inches.
767 Use this for sizing of embedded images. See Info node `(org)
768 Images in ODT export' for more information."
775 ;;;; Src Block
778 "Whether custom styles for colorized source blocks be automatically created.
779 When this option is turned on, the exporter creates custom styles
780 for source blocks based on the advice of `htmlfontify'. Creation
781 of custom styles happen as part of `org-odt-hfy-face-to-css'.
783 When this option is turned off exporter does not create such
784 styles.
786 Use the latter option if you do not want the custom styles to be
787 based on your current display settings. It is necessary that the
788 styles.xml already contains needed styles for colorizing to work.
790 This variable is effective only if
791 `org-odt-fontify-srcblocks' is turned on."
797 "Specify whether or not source blocks need to be fontified.
798 Turn this option on if you want to colorize the source code
799 blocks in the exported file. For colorization to work, you need
800 to make available an enhanced version of `htmlfontify' library."
806 ;;;; Table
819 "Specify how Table Styles should be derived from a Table Template.
820 This is a list where each element is of the
821 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
823 TABLE-STYLE-NAME is the style associated with the table through
826 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
827 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
828 below) that is included in
829 `org-odt-content-template-file'.
831 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
833 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
841 TABLE-CELL-OPTIONS is an alist where each element is of the
842 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
843 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
844 `use-last-row-styles' |
845 `use-first-column-styles' |
846 `use-last-column-styles' |
847 `use-banding-rows-styles' |
848 `use-banding-columns-styles' |
849 `use-first-row-styles'
850 ON-OR-OFF := t | nil
852 For example, with the following configuration
854 \(setq org-odt-table-styles
856 ((use-first-row-styles . t)
857 (use-first-column-styles . t)))
859 ((use-first-column-styles . t)))))
862 style will use the following table-cell styles -
867 as appropriate.
870 use the following table-cell styles -
872 following paragraph styles
874 as appropriate..
876 Note that TABLE-TEMPLATE-NAME corresponds to the
879 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
882 specification for more information. Also consult the
883 implementation filed under `org-odt-get-table-cell-styles'.
886 formatting of numbered display equations. Do not delete this
887 style from the list."
897 use-last-row-styles
898 use-first-column-styles
899 use-last-column-styles
900 use-banding-rows-styles
901 use-banding-columns-styles)
902 :key-type symbol
905 ;;;; Timestamps
908 "Non-nil, if timestamps should be exported as date fields.
910 When nil, export timestamps as plain text.
912 When non-nil, map `org-time-stamp-custom-formats' to a pair of
914 respectively. A timestamp with no time component is formatted
918 This feature is experimental. Most (but not all) of the common
919 %-specifiers in `format-time-string' are supported.
921 formatted as canonical Org timestamps. For finer control, avoid
922 these %-specifiers.
925 etc., are displayed by the application in the default language
926 and country specified in `org-odt-styles-file'. Note that the
928 can localize the week day and month strings in the exported
929 document by setting the default language and country either using
930 the application UI or through a custom styles file.
932 See `org-odt--build-date-styles' for implementation details."
939 \f
940 ;;; Internal functions
942 ;;;; Date
957 ;; LibreOffice does not care about end goes as content
958 ;; within the "<text:date>...</text:date>" field. The
959 ;; displayed date is automagically corrected to match the
960 ;; format requested by "style:data-style-name" attribute. So
961 ;; don't bother about formatting the date contents to be
962 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
963 ;; simple Org-style date should suffice.
988 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
989 iso-date style date)
991 repeater)))))
993 ;;;; Frame
1001 extra
1007 style frame-attrs
1019 ;;;; Library wrappers
1026 ;; This is shamelessly stolen from `archive-zip-extract'.
1032 name)))
1037 exit-code command-output)
1045 members))
1047 ;;;; Target
1056 ;;;; Textbox
1059 extra anchor-type)
1065 text)
1066 width nil style extra anchor-type))
1070 ;;;; Table of Contents
1075 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1077 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1084 "
1085 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1087 <text:index-entry-chapter/>
1088 <text:index-entry-text/>
1089 <text:index-entry-link-end/>
1090 </text:table-of-content-entry-template>
1094 </text:table-of-content-source>
1096 <text:index-body>
1099 </text:index-title>
1104 </text:index-body>
1105 </text:table-of-content>
1113 ;; Section number.
1115 ;; Todo.
1120 style todo)))
1125 style priority)))
1126 ;; Title.
1127 text
1128 ;; Tags.
1132 "OrgTags"
1139 headline-label text))
1143 ;; When a headline is marked as a radio target, as in the example below:
1144 ;;
1145 ;; ** <<<Some Heading>>>
1146 ;; Some text.
1147 ;;
1148 ;; suppress generation of radio targets. i.e., Radio targets are to
1149 ;; be marked as targets within /document body/ and *not* within
1150 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1151 ;; and one in the document body.
1152 ;;
1153 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1154 ;; doesn't provide a way to disable memoization. So this doesn't
1155 ;; work.
1156 ;;
1157 ;; FIXME-2: Are there any other objects that need to be suppressed
1158 ;; within TOC?
1178 style entry)))
1183 ;;;; Document styles
1186 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1187 OBJECT-PROPS is (typically) a plist created by passing
1189 `org-odt-parse-block-attributes'.
1191 Use `org-odt-object-counters' to generate an automatic
1192 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1193 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1194 . STYLE-NAME)."
1210 ;;;; Checkbox
1213 "Return check-box string associated to ITEM."
1222 ;;; Template
1225 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1226 ;; to modify the date fields. A date could be modified by
1227 ;; offsetting in days. That's about it. Also, date and time may
1228 ;; have to be emitted as two fields - a date field and a time field
1229 ;; - separately.
1231 ;; One can add Form Controls to date and time fields so that they
1232 ;; can be easily modified. But then, the exported document will
1233 ;; become tightly coupled with LibreOffice and may not function
1234 ;; properly with other OpenDocument applications.
1236 ;; I have a strange feeling that Date styles are a bit flaky at the
1237 ;; moment.
1239 ;; The feature is experimental.
1285 ))
1293 filler-end))
1304 style
1307 output ))))
1310 "Return complete document string after ODT conversion.
1311 CONTENTS is the transcoded contents string. RAW-DATA is the
1312 original parsed data. INFO is a plist holding export options."
1313 ;; Write meta file.
1323 <office:document-meta
1333 ;; Date, if required.
1335 ;; Check if DATE is specified as an Org-timestamp. If yes,
1336 ;; include it as meta information. Otherwise, just use
1337 ;; today's date.
1346 iso-date)))))
1357 ;; Add meta.xml in to manifest.
1360 ;; Update styles file.
1361 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1362 ;; Write styles file.
1365 ;; Non-availability of styles.xml is not a critical
1366 ;; error. For now, throw an error.
1368 org-odt-styles-file
1370 org-odt-styles-dir)
1383 members)))
1393 org-odt-styles-file)))
1395 ;; create a manifest entry for styles.xml
1398 ;; FIXME: Who is opening an empty styles.xml before this point?
1403 ;; Write custom styles for source blocks
1404 ;; Save STYLES used for colorizing of source blocks.
1405 ;; Update styles.xml with styles that were collected as part of
1406 ;; `org-odt-hfy-face-to-css' callbacks.
1415 ;; Update styles.xml - take care of outline numbering
1417 ;; Don't make automatic backup of styles.xml file. This setting
1418 ;; prevents the backed-up styles.xml file from being zipped in to
1419 ;; odt file. This is more of a hackish fix. Better alternative
1420 ;; would be to fix the zip command so that the output odt file
1421 ;; includes only the needed files and excludes any auto-generated
1422 ;; extra files like backups and auto-saves etc etc. Note that
1423 ;; currently the zip command zips up the entire temp directory so
1424 ;; that any auto-generated files created under the hood ends up in
1425 ;; the resulting odt file.
1428 ;; Outline numbering is retained only upto LEVEL.
1429 ;; To disable outline numbering pass a LEVEL of 0.
1442 ;; Update content.xml.
1445 ;; within the context of the Org buffer. So obtain its
1446 ;; value before moving on to temp-buffer context down below.
1456 org-odt-styles-dir)))
1457 ;; Write automatic styles.
1458 ;; - Position the cursor.
1462 ;; - Dump automatic table styles.
1467 ;; - Dump date-styles.
1473 ;; Update display level.
1474 ;; - Remove existing sequence decls. Also position the cursor.
1479 ;; Update sequence decls according to user preference.
1489 ;; Position the cursor to document body.
1494 ;; Preamble - Title, Author, Date etc.
1501 ;; Switch on or off above vars based on user settings
1505 ;; Title.
1510 ;; Separator.
1514 ;; Author only.
1517 "OrgSubtitle"
1519 ;; Separator.
1522 ;; Author and E-mail.
1526 "OrgSubtitle"
1531 ;; Separator.
1533 ;; Date, if required.
1536 ;; Check if DATE is specified as a timestamp.
1542 "OrgSubtitle"
1546 ;; Separator
1548 ;; Table of Contents
1551 with-toc
1554 ;; Contents.
1556 ;; Return contents.
1560 \f
1561 ;;; Transcode Functions
1563 ;;;; Bold
1566 "Transcode BOLD from Org to ODT.
1567 CONTENTS is the text with bold markup. INFO is a plist holding
1568 contextual information."
1573 ;;;; Center Block
1576 "Transcode a CENTER-BLOCK element from Org to ODT.
1577 CONTENTS holds the contents of the center block. INFO is a plist
1578 holding contextual information."
1579 contents)
1582 ;;;; Clock
1585 "Transcode a CLOCK element from Org to ODT.
1586 CONTENTS is nil. INFO is a plist used as a communication
1587 channel."
1600 ;;;; Code
1603 "Transcode a CODE object from Org to ODT.
1604 CONTENTS is nil. INFO is a plist used as a communication
1605 channel."
1611 ;;;; Comment
1613 ;; Comments are ignored.
1616 ;;;; Comment Block
1618 ;; Comment Blocks are ignored.
1621 ;;;; Drawer
1624 "Transcode a DRAWER element from Org to ODT.
1625 CONTENTS holds the contents of the block. INFO is a plist
1626 holding contextual information."
1629 name contents)))
1630 output))
1633 ;;;; Dynamic Block
1636 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1637 CONTENTS holds the contents of the block. INFO is a plist
1638 holding contextual information. See `org-export-data'."
1639 contents)
1642 ;;;; Entity
1645 "Transcode an ENTITY object from Org to ODT.
1646 CONTENTS are the definition itself. INFO is a plist holding
1647 contextual information."
1651 ;;;; Example Block
1654 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1655 CONTENTS is nil. INFO is a plist holding contextual information."
1659 ;;;; Export Snippet
1662 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1663 CONTENTS is nil. INFO is a plist holding contextual information."
1668 ;;;; Export Block
1671 "Transcode a EXPORT-BLOCK element from Org to ODT.
1672 CONTENTS is nil. INFO is a plist holding contextual information."
1677 ;;;; Fixed Width
1680 "Transcode a FIXED-WIDTH element from Org to ODT.
1681 CONTENTS is nil. INFO is a plist holding contextual information."
1685 ;;;; Footnote Definition
1687 ;; Footnote Definitions are ignored.
1690 ;;;; Footnote Reference
1693 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1694 CONTENTS is nil. INFO is a plist holding contextual information."
1704 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.
1731 ;; Inline definitions are secondary strings.
1732 ;; Non-inline footnotes definitions are full Org data.
1735 footnote-reference info))
1739 raw
1742 :transcoders
1745 p c i
1746 "Footnote"
1747 "OrgFootnoteCenter"
1749 info))))
1756 ;;;; Headline
1762 ;; Todo.
1766 style todo)))
1771 style priority)))
1772 ;; Title.
1773 text
1774 ;; Tags.
1777 "<text:tab/>"
1786 &optional format-function
1788 "Transcode a HEADLINE element using BACKEND.
1789 INFO is a plist holding contextual information."
1816 todo todo-type priority text tags))))
1819 todo todo-type priority text tags
1824 "Transcode a HEADLINE element from Org to ODT.
1825 CONTENTS holds the contents of the headline. INFO is a plist
1826 holding contextual information."
1827 ;; Case 1: This is a footnote section: ignore it.
1830 ;; Create the headline text.
1832 ;; Get level relative to current parsed data.
1834 ;; Get canonical label for the headline.
1838 ;; Get user-specified labels for the headline.
1841 ;; Extra targets.
1849 ;; Title.
1852 ;; Case 2. This is a deep sub-tree: export it as a list item.
1853 ;; Also export as items headlines for which no section
1854 ;; format has been found.
1856 ;; Build the real contents of the sub-tree.
1860 ;; Choose style based on list type.
1863 ;; If top-level list, re-start numbering. Otherwise,
1864 ;; continue numbering.
1867 headline)))
1877 "Text_20_body"
1879 contents)
1881 "</text:list-header>"
1885 ;; Case 3. Standard headline. Export it as a section.
1891 level
1893 contents))))))
1896 ;;;; Horizontal Rule
1899 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1900 CONTENTS is nil. INFO is a plist holding contextual information."
1905 ;;;; Inline Babel Call
1907 ;; Inline Babel Calls are ignored.
1910 ;;;; Inline Src Block
1913 "Return a character not used in string S.
1915 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1921 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1922 CONTENTS holds the contents of the item. INFO is a plist holding
1923 contextual information."
1930 ;;;; Inlinetask
1933 "Transcode an INLINETASK element from Org to ODT.
1934 CONTENTS holds the contents of the block. INFO is a plist
1935 holding contextual information."
1937 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1938 ;; with appropriate arguments.
1945 todo todo-type priority text tags contents)))))
1948 ;; Otherwise, use a default template.
1951 "Text_20_body"
1955 "OrgInlineTaskHeading"
1957 contents)
1960 ;;;; Italic
1963 "Transcode ITALIC from Org to ODT.
1964 CONTENTS is the text with italic markup. INFO is a plist holding
1965 contextual information."
1970 ;;;; Item
1973 "Transcode an ITEM element from Org to ODT.
1974 CONTENTS holds the contents of the item. INFO is a plist holding
1975 contextual information."
1986 contents
1998 ;;;; Keyword
2001 "Transcode a KEYWORD element from Org to ODT.
2002 CONTENTS is nil. INFO is a plist holding contextual information."
2008 ;; FIXME
2019 ;; FIXME
2023 ;;;; Latex Environment
2026 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2027 ;; (defadvice org-format-latex-as-mathml ; FIXME
2028 ;; (after org-odt-protect-latex-fragment activate)
2029 ;; "Encode LaTeX fragment as XML.
2030 ;; Do this when translation to MathML fails."
2031 ;; (unless (> (length ad-return-value) 0)
2032 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2035 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2036 CONTENTS is nil. INFO is a plist holding contextual information."
2042 ;;;; Latex Fragment
2044 ;; (when latex-frag ; FIXME
2045 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2046 ;; :description latex-frag)))
2047 ;; handle verbatim
2048 ;; provide descriptions
2051 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2052 CONTENTS is nil. INFO is a plist holding contextual information."
2059 ;;;; Line Break
2062 "Transcode a LINE-BREAK object from Org to ODT.
2063 CONTENTS is nil. INFO is a plist holding contextual information."
2067 ;;;; Link
2069 ;;;; Links :: Label references
2080 x)))))
2091 counter))
2098 ;; Section number.
2102 ;; Separator.
2104 ;; Ordinal.
2106 tag))
2109 "Return a label for ELEMENT.
2111 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2112 element. INFO is a plist used as a communication channel. OP is
2113 either `definition' or `reference', depending on the purpose of
2114 the generated string.
2116 Return value is a string if OP is set to `reference' or a cons
2117 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2118 SHORT-CAPTION are strings."
2124 ;; Get label and caption.
2128 ;; FIXME: We don't use short-caption for now
2144 element))))
2147 seqno)
2151 ;; Compute sequence number of the element.
2153 ;; Localize category string.
2156 ;; Case 1: Handle Label definition.
2158 ;; Assign an internal label, if user has not provided one
2163 ;; Sneak in a bookmark. The bookmark is used when the
2164 ;; labeled element is referenced with a link that
2165 ;; provides its own description.
2167 ;; Label definition: Typically formatted as below:
2168 ;; CATEGORY SEQ-NO: LONG CAPTION
2169 ;; with translation for correct punctuation.
2176 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2177 label counter counter seqno))
2179 short-caption))
2180 ;; Case 2: Handle Label reference.
2187 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2193 ;;;; Links :: Inline Images
2196 "Returns the internal name of the file"
2212 target-file))
2215 user-height scale dpi embed-as)
2235 ;; Use Imagemagick.
2240 file))))
2245 ;; Use Emacs.
2251 ;; Use hard-coded values.
2253 org-odt-default-image-sizes-alist))
2254 ;; Error out.
2267 ;; ensure that an embedded image fits comfortably within a page
2278 "Return ODT code for an inline image.
2279 LINK is the link pointing to the inline image. INFO is a plist
2280 used as a communication channel."
2293 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2295 ;; Extract attributes from #+ATTR_ODT line.
2299 ;; Convert attributes to a plist.
2301 ;; Handle `:anchor', `:style' and `:attributes' properties.
2311 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2312 ;;
2313 ;; Handle `:width', `:height' and `:scale' properties. Read
2314 ;; them as numbers since we need them for computations.
2316 src-expanded
2323 nil ; embed-as
2325 ))
2332 ;; Check if this link was created by LaTeX-to-PNG converter.
2336 ;; If yes, note down the type of the element - LaTeX Fragment
2337 ;; or LaTeX environment. It will go in to frame title.
2341 ;; If yes, note down its contents. It will go in to frame
2342 ;; description. This quite useful for debugging.
2345 captions user-frame-params title desc)))
2348 ;;;; Links :: Math formula
2369 ;; Check if this link was created by LaTeX-to-MathML
2370 ;; converter.
2374 ;; If yes, note down the type of the element - LaTeX Fragment
2375 ;; or LaTeX environment. It will go in to frame title.
2379 ;; If yes, note down its contents. It will go in to frame
2380 ;; description. This quite useful for debugging.
2382 width height)
2386 nil nil title desc))
2389 "CaptionedDisplayFormula" href width height
2390 captions nil title desc))
2394 org-odt--enumerable-formula-p))))
2399 "Returns the internal name of the file"
2403 ;; Create a directory for holding formula file. Also enter it in
2404 ;; to manifest.
2408 ;; Copy over the formula file from user directory to zip
2409 ;; directory.
2413 ;; Case 1: Mathml.
2416 ;; Case 2: OpenDocument formula.
2421 ;; Enter the formula file in to manifest.
2423 target-file))
2425 ;;;; Targets
2428 captions user-frame-params
2431 ;; Each element of this alist is of the form (CFG-HANDLE
2432 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2434 ;; CFG-HANDLE is the key to the alist.
2436 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2437 ;; frame params for INNER-FRAME and OUTER-FRAME
2438 ;; respectively. See below.
2440 ;; Configurations that are meant to be applied to
2441 ;; non-captioned image/formula specifies no
2442 ;; OUTER-FRAME-PARAMS.
2444 ;; TERMINOLOGY
2445 ;; ===========
2446 ;; INNER-FRAME :: Frame that directly surrounds an
2447 ;; image/formula.
2449 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2450 ;; frame also contains the caption, if any.
2452 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2453 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2454 ;; that these are the last three arguments
2455 ;; to `org-odt--frame'.
2457 ;; Note that an un-captioned image/formula requires just an
2458 ;; INNER-FRAME, while a captioned image/formula requires
2459 ;; both an INNER and an OUTER-FRAME.
2481 ;; Retrieve inner and outer frame params, from configuration.
2485 ;; User-specified frame params (from #+ATTR_ODT spec)
2489 "Merge default and user frame params."
2494 for d in default
2497 ;; Case 1: Image/Formula has no caption.
2498 ;; There is only one frame, one that surrounds the image
2499 ;; or formula.
2501 ;; Merge user frame params with that from configuration.
2505 ;; Case 2: Image/Formula is captioned or labeled.
2506 ;; There are two frames: The inner one surrounds the
2507 ;; image or formula. The outer one contains the
2508 ;; caption/sequence number.
2510 ;; Merge user frame params with outer frame params.
2512 ;; Short caption, if specified, goes as part of inner frame.
2519 frame-params))
2522 "Illustration"
2526 caption))
2527 width height outer)))))
2530 ;; Element should have a caption or label.
2536 element info
2537 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2538 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2539 ;; processing.)
2544 ;; Link should point to an image file.
2551 element info
2552 ;; Paragraph should have a caption or label. It SHOULD also be a
2553 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2554 ;; processing.)
2559 ;; Link should point to an image file.
2566 element info
2567 ;; Paragraph should have a caption or label.
2571 ;; Link should point to a MathML or ODF file.
2577 paragraph-predicate
2578 link-predicate)
2579 "Test if ELEMENT is a standalone link for the purpose ODT export.
2580 INFO is a plist holding contextual information.
2582 Return non-nil, if ELEMENT is of type paragraph satisfying
2583 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2584 is a link that satisfies LINK-PREDICATE.
2586 Return non-nil, if ELEMENT is of type link satisfying
2587 LINK-PREDICATE and its containing paragraph satisfies
2588 PARAGRAPH-PREDICATE in addition to having no other content save for
2589 leading and trailing whitespaces.
2591 Return nil, otherwise."
2614 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2615 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2616 ;; attached. Note that labels that are attached to captioned
2617 ;; entities - inline images, math formulae and tables - get resolved
2618 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2620 ;; Create a cross-reference to DESTINATION but make best-efforts to
2621 ;; create a *meaningful* description. Check item numbers, section
2622 ;; number and section title in that order.
2624 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2625 ;; FIXME: Handle footnote-definition footnote-reference?
2641 return x))
2642 ;; Get list item nos.
2647 plain-list)
2650 item info t))))))
2651 ;; Locate top-most listified headline.
2656 return x))
2657 ;; Get listified headline numbers.
2663 el info t)))))))
2664 ;; Combine item numbers from both the listified headlines and
2665 ;; regular list items.
2667 ;; Case 1: Check if all the parents of list item are numbered.
2668 ;; If yes, link to the item proper.
2671 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2676 ;; Case 2: Locate a regular and numbered headline in the
2677 ;; hierarchy. Display its section number.
2682 return el)))
2683 ;; We found one.
2685 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2689 ;; Case 4: Locate a regular headline in the hierarchy. Display
2690 ;; its title.
2694 return el)))
2695 ;; We found one.
2697 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2704 "Transcode a LINK object from Org to ODT.
2706 DESC is the description part of the link, or the empty string.
2707 INFO is a plist holding contextual information. See
2708 `org-export-data'."
2711 ;; Ensure DESC really exists, or set it to nil.
2714 link org-odt-inline-image-rules))
2721 ;; Convert & to & for correct XML representation
2723 protocol)
2725 ;; Image file.
2727 link org-odt-inline-image-rules))
2729 ;; Formula file.
2731 link org-odt-inline-formula-rules))
2733 ;; Radio target: Transcode target's contents and use them as
2734 ;; link's description.
2739 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2742 desc))))
2743 ;; Links pointing to a headline: Find destination and build
2744 ;; appropriate referencing command.
2750 ;; Case 1: Fuzzy link points nowhere.
2751 ('nil
2753 "Emphasis"
2756 info))))
2757 ;; Case 2: Fuzzy link points to a headline.
2759 ;; If there's a description, create a hyperlink.
2760 ;; Otherwise, try to provide a meaningful description.
2769 label desc))))
2770 ;; Case 3: Fuzzy link points to a target.
2772 ;; If there's a description, create a hyperlink.
2773 ;; Otherwise, try to provide a meaningful description.
2778 desc))))
2779 ;; Case 4: Fuzzy link points to some element (e.g., an
2780 ;; inline image, a math formula or a table).
2787 ;; LINK has no description. Create
2788 ;; a cross-reference showing entity's sequence
2789 ;; number.
2791 ;; LINK has description. Insert a hyperlink with
2792 ;; user-provided description.
2797 desc)))))))))
2798 ;; Coderef: replace link with the reference name or the
2799 ;; equivalent line number.
2806 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2807 href line-no))))
2808 ;; Link type is handled by a special function.
2811 ;; External link with a description part.
2814 ;; Check if description is a link to an inline image.
2819 desc-element org-odt-inline-image-rules))))
2820 ;; Format link as a clickable image.
2822 path desc)
2823 ;; Otherwise, format it as a regular link.
2825 path desc))))
2826 ;; External link without a description part.
2829 path path))
2830 ;; No path, only description. Try to do something useful.
2835 ;;;; Paragraph
2838 "Return style of PARAGRAPH.
2839 Style is a symbol among `quoted', `centered' and nil."
2849 "Format paragraph according to given styles.
2850 PARAGRAPH is a paragraph type element. CONTENTS is the
2851 transcoded contents of that paragraph, as a string. INFO is
2852 a plist used as a communication channel. DEFAULT, CENTER and
2853 QUOTE are, respectively, style to use when paragraph belongs to
2854 no special environment, a center block, or a quote block."
2860 ;; If PARAGRAPH is a leading paragraph in an item that has
2861 ;; a checkbox, splice checkbox and paragraph contents
2862 ;; together.
2867 contents)))
2870 "Transcode a PARAGRAPH element from Org to ODT.
2871 CONTENTS is the contents of the paragraph, as a string. INFO is
2872 the plist used as a communication channel."
2874 paragraph contents info
2876 "OrgCenter"
2880 ;;;; Plain List
2883 "Transcode a PLAIN-LIST element from Org to ODT.
2884 CONTENTS is the contents of the list. INFO is a plist holding
2885 contextual information."
2887 ;; Choose style based on list type.
2893 ;; If top-level list, re-start numbering. Otherwise,
2894 ;; continue numbering.
2899 contents))
2901 ;;;; Plain Text
2914 line))
2925 "Transcode a TEXT string from Org to ODT.
2926 TEXT is the string to transcode. INFO is a plist holding
2927 contextual information."
2929 ;; Protect &, < and >.
2931 ;; Handle smart quotes. Be sure to provide original string since
2932 ;; OUTPUT may have been modified.
2935 ;; Convert special strings.
2941 org-odt-special-string-regexps))
2942 ;; Handle break preservation if required.
2946 ;; Return value.
2947 output))
2950 ;;;; Planning
2953 "Transcode a PLANNING element from Org to ODT.
2954 CONTENTS is nil. INFO is a plist used as a communication
2955 channel."
2957 "OrgPlanning"
2979 ;;;; Property Drawer
2982 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2983 CONTENTS is nil. INFO is a plist holding contextual
2984 information."
2985 ;; The property drawer isn't exported but we want separating blank
2986 ;; lines nonetheless.
2990 ;;;; Quote Block
2993 "Transcode a QUOTE-BLOCK element from Org to ODT.
2994 CONTENTS holds the contents of the block. INFO is a plist
2995 holding contextual information."
2996 contents)
2999 ;;;; Quote Section
3002 "Transcode a QUOTE-SECTION element from Org to ODT.
3003 CONTENTS is nil. INFO is a plist holding contextual information."
3009 ;;;; Section
3014 style
3016 text)))
3020 "Transcode a SECTION element from Org to ODT.
3021 CONTENTS holds the contents of the section. INFO is a plist
3022 holding contextual information."
3023 contents)
3025 ;;;; Radio Target
3028 "Transcode a RADIO-TARGET object from Org to ODT.
3029 TEXT is the text of the target. INFO is a plist holding
3030 contextual information."
3036 ;;;; Special Block
3039 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3040 CONTENTS holds the contents of the block. INFO is a plist
3041 holding contextual information."
3045 ;; Annotation.
3051 ;; FIXME: Is `car' right thing to do below?
3061 contents)))))
3062 ;; Textbox.
3071 style extra anchor))))
3075 ;;;; Src Block
3078 "Create custom style for face FN.
3079 When FN is the default face, use its foreground and background
3081 use its color attribute to create a character style whose name
3082 is obtained from FN. Currently all attributes of FN other than
3083 color are ignored.
3085 The style name for a face FN is derived using the following
3086 operations on the face name in that order - de-dash, CamelCase
3088 `font-lock-function-name-face' is associated with
3102 background-color-val color-val))
3105 "
3136 org-odt-fontify-srcblocks
3153 code
3164 par-style loc))
3167 num-start refs))
3181 ;; Extract code and references.
3185 ;; Does the src block contain labels?
3187 ;; Does it have line numbers?
3194 "Transcode a SRC-BLOCK element from Org to ODT.
3195 CONTENTS holds the contents of the item. INFO is a plist holding
3196 contextual information."
3208 "Text_20_body"
3212 ;;;; Statistics Cookie
3215 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3216 CONTENTS is nil. INFO is a plist holding contextual information."
3222 ;;;; Strike-Through
3225 "Transcode STRIKE-THROUGH from Org to ODT.
3226 CONTENTS is the text with strike-through markup. INFO is a plist
3227 holding contextual information."
3232 ;;;; Subscript
3235 "Transcode a SUBSCRIPT object from Org to ODT.
3236 CONTENTS is the contents of the object. INFO is a plist holding
3237 contextual information."
3242 ;;;; Superscript
3245 "Transcode a SUPERSCRIPT object from Org to ODT.
3246 CONTENTS is the contents of the object. INFO is a plist holding
3247 contextual information."
3252 ;;;; Table Cell
3261 "Retrieve styles applicable to a table cell.
3262 R and C are (zero-based) row and column numbers of the table
3263 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3264 applicable to the current table. It is nil if the table is not
3265 associated with any style attributes.
3267 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3269 When STYLE-SPEC is nil, style the table cell the conventional way
3270 - choose cell borders based on row and column groupings and
3271 choose paragraph alignment based on `org-col-cookies' text
3272 property. See also
3273 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3275 When STYLE-SPEC is non-nil, ignore the above cookie and return
3276 styles congruent with the ODF-1.2 specification."
3282 info)))
3284 ;; LibreOffice - particularly the Writer - honors neither table
3285 ;; templates nor custom table-cell styles. Inorder to retain
3286 ;; inter-operability with LibreOffice, only automatic styles are
3287 ;; used for styling of table-cells. The current implementation is
3288 ;; congruent with ODF-1.2 specification and hence is
3289 ;; future-compatible.
3291 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3292 ;; which recognizes as many as 16 different cell types - is much
3293 ;; richer. Unfortunately it is NOT amenable to easy configuration
3294 ;; by hand.
3321 "Transcode a TABLE-CELL element from Org to ODT.
3322 CONTENTS is nil. INFO is a plist used as a communication
3323 channel."
3330 table-cell info))
3353 table-cell info))))))
3357 custom-style-prefix))
3359 "OrgTblCell"
3375 cell-attributes
3378 org-element-all-elements)
3379 contents
3381 paragraph-style contents))))
3388 ;;;; Table Row
3391 "Transcode a TABLE-ROW element from Org to ODT.
3392 CONTENTS is the contents of the row. INFO is a plist used as a
3393 communication channel."
3394 ;; Rules are ignored since table separators are deduced from
3395 ;; borders of the current row.
3401 ;; If the row belongs to the first rowgroup and the
3402 ;; table has more than one row groups, then this row
3403 ;; belongs to the header row group.
3405 ;; Otherwise, it belongs to non-header row group.
3408 ;; Does this row begin a rowgroup?
3411 ;; Actual table row
3413 ;; Does this row end a rowgroup?
3418 ;;;; Table
3431 "Transcode a TABLE element from Org to ODT.
3432 CONTENTS is the contents of the table. INFO is a plist holding
3433 contextual information."
3435 ;; Case 1: table.el doesn't support export to OD format. Strip
3436 ;; such tables from export.
3441 "(ox-odt): Found table.el-type table in the source Org file."
3442 " table.el doesn't support export to ODT format."
3444 ;; Case 2: Native Org tables.
3461 column-style))
3462 out)
3466 ;; caption.
3470 ;; begin table.
3478 ;; column specification.
3480 ;; actual contents.
3482 ;; end table.
3486 "Transcode a TABLE element from Org to ODT.
3487 CONTENTS is the contents of the table. INFO is a plist holding
3488 contextual information.
3490 Use `org-odt--table' to typeset the table. Handle details
3491 pertaining to indentation here."
3506 collect el)))
3512 collect
3517 parent-list)
3519 ;; Handle list genealogy.
3539 parent-list info)
3542 ;; Handle low-level headlines.
3544 with step = 'item collect
3552 el info)
3553 "OrgNumberedList"
3564 parent-list info)))
3572 table info)))
3573 ;; OpenDocument schema does not permit table to occur within a
3574 ;; list item.
3576 ;; One solution - the easiest and lightweight, in terms of
3577 ;; implementation - is to put the table in an indented text box
3578 ;; and make the text box part of the list-item. Unfortunately if
3579 ;; the table is big and spans multiple pages, the text box could
3580 ;; overflow. In this case, the following attribute will come
3581 ;; handy.
3583 ;; ,---- From OpenDocument-v1.1.pdf
3584 ;; | 15.27.28 Overflow behavior
3585 ;; |
3586 ;; | For text boxes contained within text document, the
3587 ;; | style:overflow-behavior property specifies the behavior of text
3588 ;; | boxes where the containing text does not fit into the text
3589 ;; | box.
3590 ;; |
3591 ;; | If the attribute's value is clip, the text that does not fit
3592 ;; | into the text box is not displayed.
3593 ;; |
3594 ;; | If the attribute value is auto-create-new-frame, a new frame
3595 ;; | will be created on the next page, with the same position and
3596 ;; | dimensions of the original frame.
3597 ;; |
3598 ;; | If the style:overflow-behavior property's value is
3599 ;; | auto-create-new-frame and the text box has a minimum width or
3600 ;; | height specified, then the text box will grow until the page
3601 ;; | bounds are reached before a new frame is created.
3602 ;; `----
3604 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3605 ;; auto-create-new-frame property and always resorts to clipping
3606 ;; the text box. This results in table being truncated.
3608 ;; So we solve the problem the hard (and fun) way using list
3609 ;; continuations.
3611 ;; The problem only becomes more interesting if you take in to
3612 ;; account the following facts:
3613 ;;
3614 ;; - Description lists are simulated as plain lists.
3615 ;; - Low-level headlines can be listified.
3616 ;; - In Org-mode, a table can occur not only as a regular list
3617 ;; item, but also within description lists and low-level
3618 ;; headlines.
3620 ;; See `org-odt-translate-description-lists' and
3621 ;; `org-odt-translate-low-level-headlines' for how this is
3622 ;; tackled.
3625 ;; Discontinue the list.
3627 ;; Put the table in an indented section.
3632 ;; Continue the list.
3636 ;;;; Target
3639 "Transcode a TARGET object from Org to ODT.
3640 CONTENTS is nil. INFO is a plist holding contextual
3641 information."
3646 ;;;; Timestamp
3649 "Transcode a TIMESTAMP object from Org to ODT.
3650 CONTENTS is nil. INFO is a plist used as a communication
3651 channel."
3668 "OrgActiveTimestamp"
3672 "OrgInactiveTimestamp"
3676 "OrgActiveTimestamp"
3682 "OrgInactiveTimestamp"
3688 "OrgDiaryTimestamp"
3690 info)))))))
3693 ;;;; Underline
3696 "Transcode UNDERLINE from Org to ODT.
3697 CONTENTS is the text with underline markup. INFO is a plist
3698 holding contextual information."
3703 ;;;; Verbatim
3706 "Transcode a VERBATIM object from Org to ODT.
3707 CONTENTS is nil. INFO is a plist used as a communication
3708 channel."
3714 ;;;; Verse Block
3717 "Transcode a VERSE-BLOCK element from Org to ODT.
3718 CONTENTS is verse block contents. INFO is a plist holding
3719 contextual information."
3720 ;; Add line breaks to each line of verse.
3724 ;; Replace tabs and spaces.
3726 ;; Surround it in a verse environment.
3731 \f
3732 ;;; Filters
3734 ;;;; LaTeX fragments
3739 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3740 ;; If the desired converter is not available, force verbatim
3741 ;; processing.
3759 ;; Store normalized value for later use.
3764 ;; Convert `latex-fragment's and `latex-environment's.
3782 ;; Get an Org-style link to PNG image or the MathML
3783 ;; file.
3788 nil display-msg
3789 nil nil processing-type)
3794 link))))
3796 ;; Conversion succeeded. Parse above Org-style link to a
3797 ;; `link' object.
3803 ;; Orphan the link.
3808 ;; Case 1: LaTeX environment.
3809 ;; Mimic a "standalone image or formula" by
3810 ;; enclosing the `link' in a `paragraph'.
3811 ;; Copy over original attributes, captions to
3812 ;; the enclosing paragraph.
3818 latex-*)
3820 latex-*)))
3821 link))
3822 ;; Case 2: LaTeX fragment.
3823 ;; No special action.
3825 ;; Note down the object that link replaces.
3829 ;; Replace now.
3831 info)))
3832 tree)
3835 ;;;; Description lists
3837 ;; This translator is necessary to handle indented tables in a uniform
3838 ;; manner. See comment in `org-odt--table'.
3841 ;; OpenDocument has no notion of a description list. So simulate it
3842 ;; using plain lists. Description lists in the exported document
3843 ;; are typeset in the same manner as they are in a typical HTML
3844 ;; document.
3845 ;;
3846 ;; Specifically, a description list like this:
3847 ;;
3848 ;; ,----
3849 ;; | - term-1 :: definition-1
3850 ;; | - term-2 :: definition-2
3851 ;; `----
3852 ;;
3853 ;; gets translated in to the following form:
3854 ;;
3855 ;; ,----
3856 ;; | - term-1
3857 ;; | - definition-1
3858 ;; | - term-2
3859 ;; | - definition-2
3860 ;; `----
3861 ;;
3862 ;; Further effect is achieved by fixing the OD styles as below:
3863 ;;
3864 ;; 1. Set the :type property of the simulated lists to
3865 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3866 ;; that has *no* bullets whatsoever.
3867 ;;
3868 ;; 2. The paragraph containing the definition term is styled to be
3869 ;; in bold.
3870 ;;
3875 el
3891 nil)
3892 info)
3893 tree)
3895 ;;;; List tables
3897 ;; Lists that are marked with attribute `:list-table' are called as
3898 ;; list tables. They will be rendered as a table within the exported
3899 ;; document.
3901 ;; Consider an example. The following list table
3902 ;;
3903 ;; #+attr_odt :list-table t
3904 ;; - Row 1
3905 ;; - 1.1
3906 ;; - 1.2
3907 ;; - 1.3
3908 ;; - Row 2
3909 ;; - 2.1
3910 ;; - 2.2
3911 ;; - 2.3
3912 ;;
3913 ;; will be exported as though it were an Org table like the one show
3914 ;; below.
3915 ;;
3916 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3917 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3918 ;;
3919 ;; Note that org-tables are NOT multi-line and each line is mapped to
3920 ;; a unique row in the exported document. So if an exported table
3921 ;; needs to contain a single paragraph (with copious text) it needs to
3922 ;; be typed up in a single line. Editing such long lines using the
3923 ;; table editor will be a cumbersome task. Furthermore inclusion of
3924 ;; multi-paragraph text in a table cell is well-nigh impossible.
3925 ;;
3926 ;; A LIST-TABLE circumvents above problems.
3927 ;;
3928 ;; Note that in the example above the list items could be paragraphs
3929 ;; themselves and the list can be arbitrarily deep.
3930 ;;
3931 ;; Inspired by following thread:
3932 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3934 ;; Translate lists to tables
3940 ;; Replace list with table.
3942 l1-list
3943 ;; Build replacement table.
3949 l1-item-leading-text l2-list)
3950 ;; Remove Level-2 list from the Level-item. It
3951 ;; will be subsequently attached as table-cells.
3961 ;; Level-1 items start a table row.
3964 ;; Leading text of level-1 item define
3965 ;; the first table-cell.
3968 l1-item-leading-text)
3969 ;; Level-2 items define subsequent
3970 ;; table-cells of the row.
3978 nil)
3979 info)
3980 tree)
3982 \f
3983 ;;; Interactive functions
3996 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4005 org-odt-manifest-file-entries)
4013 ;; Initialize temporary workarea. All files that end up in
4014 ;; the exported document get parked/created here.
4021 ;; Kill all XML buffers.
4029 org-odt-xml-files)
4030 ;; Delete temporary directory and also other embedded
4031 ;; files that get copied there.
4036 ;; Not at all OSes ship with zip by default
4038 ;; Do export. This creates a bunch of xml files ready to be
4039 ;; saved and zipped.
4041 ;; Create a manifest entry for content.xml.
4043 ;; Write mimetype file
4052 ;; Write out the manifest entries before zipping
4054 ;; Save all XML files.
4060 ;; Prettify output if needed.
4064 org-odt-xml-files)
4065 ;; Run zip.
4070 ;; If a file with same name as the desired output file
4071 ;; exists, remove it.
4074 ;; Zip up the xml files.
4077 ;; Switch temporarily to content.xml. This way Zip
4078 ;; process will inherit `org-odt-zip-dir' as the current
4079 ;; directory.
4093 err-string)))))
4094 cmds)))
4095 ;; Move the zip file from temporary work directory to
4096 ;; user-mandated location.
4099 ;; Cleanup work directory and work files.
4101 ;; Open the OpenDocument file in archive-mode for
4102 ;; examination.
4104 ;; Return exported file.
4106 ;; Case 1: Conversion desired on exported file. Run the
4107 ;; converter on the OpenDocument file. Return the
4108 ;; converted file.
4111 target))
4112 ;; Case 2: No further conversion. Return exported
4113 ;; OpenDocument file.
4116 ;; Cleanup work directory and work files.
4122 ;;;; Export to OpenDocument formula
4124 ;;;###autoload
4126 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4127 Use `org-create-math-formula' to convert LATEX-FRAG first to
4128 MathML. When invoked as an interactive command, use
4129 `org-latex-regexps' to infer LATEX-FRAG from currently active
4130 region. If no LaTeX fragments are found, prompt for it. Push
4131 MathML source to kill ring depending on the value of
4132 `org-export-copy-to-kill-ring'."
4158 filename
4171 ;; Add MathML to kill ring, if needed.
4175 ;;;###autoload
4177 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4178 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4179 formula file."
4184 ;;;; Export to OpenDocument Text
4186 ;;;###autoload
4188 "Export current buffer to a ODT file.
4190 If narrowing is active in the current buffer, only export its
4191 narrowed part.
4193 If a region is active, export that region.
4195 A non-nil optional argument ASYNC means the process should happen
4196 asynchronously. The resulting file should be accessible through
4197 the `org-export-stack' interface.
4199 When optional argument SUBTREEP is non-nil, export the sub-tree
4200 at point, extracting information from the headline properties
4201 first.
4203 When optional argument VISIBLE-ONLY is non-nil, don't export
4204 contents of hidden elements.
4206 EXT-PLIST, when provided, is a property list with external
4207 parameters overriding Org default settings, but still inferior to
4208 file-local settings.
4210 Return output file's name."
4217 ,outfile
4222 ;; Let `htmlfontify' know that we are interested in
4223 ;; collecting styles.
4225 ;; Initialize content.xml and kick-off the export
4226 ;; process.
4239 outfile
4244 ;; Let `htmlfontify' know that we are interested in collecting
4245 ;; styles.
4247 ;; Initialize content.xml and kick-off the export process.
4257 ;;;; Convert between OpenDocument and other formats
4260 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4269 "Workhorse routine for `org-odt-convert'."
4278 in-fmt out-fmt)))
4306 out-file)
4309 nil))))
4312 "Return verbose info about formats to which IN-FMT can be converted.
4313 Return a list where each element is of the
4314 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4315 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4316 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4320 org-odt-convert-processes t))))
4324 org-odt-convert-processes t))
4325 org-odt-convert-capabilities))
4326 reachable-formats)
4331 reachable-formats))
4334 "Return list of formats to which IN-FMT can be converted.
4335 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4341 l))
4344 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4345 This is a helper routine for interactive use."
4348 nil buffer-file-name t))
4354 out-fmt-choices nil nil nil))
4356 "No known converter or no known output formats for %s files"
4357 in-fmt))))
4360 ;;;###autoload
4362 "Convert IN-FILE to format OUT-FMT using a command line converter.
4363 IN-FILE is the file to be converted. If unspecified, it defaults
4364 to variable `buffer-file-name'. OUT-FMT is the desired output
4365 format. Use `org-odt-convert-process' as the converter.
4366 If PREFIX-ARG is non-nil then the newly converted file is opened
4367 using `org-open-file'."
4372 ;;; Library Initializations
4376 ;; Let Emacs open all OpenDocument files in archive mode
4379 org-odt-file-extensions)
4383 ;; Local variables:
4384 ;; generated-autoload-file: "org-loaddefs.el"
4385 ;; End:
4387 ;;; ox-odt.el ends here