| blob | 57a9b6e20db466059b223ac0254a5c614813d1c6 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2013 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
90 org-odt--translate-description-lists
91 org-odt--translate-list-tables)))
92 :menu-entry
99 :options-alist
101 ;; Redefine regular option.
105 ;;; Dependencies
107 ;;; Hooks
109 ;;; Function Declarations
119 \f
120 ;;; Internal Variables
124 "Location of ODT exporter.
125 Use this to infer values of `org-odt-styles-dir' and
130 "Data directory for ODT exporter.
131 Use this to infer values of `org-odt-styles-dir' and
148 "List of directories to search for OpenDocument schema files.
149 Use this list to set the default value of
150 `org-odt-schema-dir'. The entries in this list are
151 populated heuristically based on the values of `org-odt-lib-dir'
164 )
165 "List of directories to search for OpenDocument styles files.
166 See `org-odt-styles-dir'. The entries in this list are populated
167 heuristically based on the values of `org-odt-lib-dir' and
184 styles-dir)
186 org-odt-styles-dir-list)
187 nil)))
190 styles-dir)
191 "Directory that holds auxiliary XML files used by the ODT exporter.
193 This directory contains the following XML files -
195 XML files are used as the default values of
196 `org-odt-styles-file' and
197 `org-odt-content-template-file'.
199 The default value of this variable varies depending on the
200 version of org in use and is initialized from
201 `org-odt-styles-dir-list'. Note that the user could be using org
202 from one of: org's own private git repository, GNU ELPA tar or
225 "
227 <style:table-properties style:rel-width=\"%d%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
228 </style:style>
229 "
233 "Registry of automatic styles for various OBJECT-TYPEs.
234 The variable has the following form:
235 \(\(OBJECT-TYPE-A
236 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
237 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
238 \(OBJECT-TYPE-B
239 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
240 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
241 ...\).
244 OBJECT-PROPS is (typically) a plist created by passing
250 "Running counters for various OBJECT-TYPEs.
251 Use this to generate automatic names and style-names. See
255 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
256 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
257 <style:background-image/>
258 </style:paragraph-properties>
260 </style:style>"
261 "Custom paragraph style for colorized source and example blocks.
263 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."
505 ;;;; Document conversion
512 "Specify a list of document converters and their usage.
513 The converters in this list are offered as choices while
514 customizing `org-odt-convert-process'.
516 This variable is a list where each element is of the
517 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
518 of the converter. CONVERTER-CMD is the shell command for the
519 converter and can contain format specifiers. These format
520 specifiers are interpreted as below:
522 %i input file name in full
523 %I input file name as a URL
524 %f format of the output file
525 %o output file name in full
526 %O output file name as a URL
527 %d output dir in full
528 %D output dir as a URL.
529 %x extra options as set in `org-odt-convert-capabilities'."
532 :type
541 During customization, the list of converter names are populated
542 from `org-odt-convert-processes'."
552 org-odt-convert-processes))))
570 "Specify input and output formats of `org-odt-convert-process'.
571 More correctly, specify the set of input and output formats that
572 the user is actually interested in.
574 This variable is an alist where each element is of the
575 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
576 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
577 alist where each element is of the form (OUTPUT-FMT
578 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
580 The variable is interpreted as follows:
581 `org-odt-convert-process' can take any document that is in
582 INPUT-FMT-LIST and produce any document that is in the
583 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
584 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
585 serves dual purposes:
586 - It is used for populating completion candidates during
587 `org-odt-convert' commands.
589 `org-odt-convert-process'.
592 `org-odt-convert-process'.
594 DOCUMENT-CLASS is used to group a set of file formats in
595 INPUT-FMT-LIST in to a single class.
597 Note that this variable inherently captures how LibreOffice based
598 converters work. LibreOffice maps documents of various formats
599 to classes like Text, Web, Spreadsheet, Presentation etc and
600 allow document of a given class (irrespective of it's source
601 format) to be converted to any of the export formats associated
602 with that class.
604 See default setting of this variable for an typical
605 configuration."
608 :type
613 :value-type
617 :value-type
626 and then uses `org-odt-convert-process' to convert the
627 resulting document to this format. During customization of this
628 variable, the list of valid values are populated based on
629 `org-odt-convert-capabilities'.
631 You can set this option on per-file basis using file local
632 values. See Info node `(emacs) File Variables'."
643 ;;;###autoload
647 ;;;; Drawers
650 "Function called to format a drawer in ODT code.
652 The function must accept two parameters:
654 CONTENTS the contents of the drawer.
656 The function should return the string to be exported.
658 For example, the variable could be set to the following function
659 in order to mimic default behaviour:
661 \(defun org-odt-format-drawer-default \(name contents\)
663 contents\)"
670 ;;;; Headline
673 "Function to format headline text.
675 This function will be called with 5 arguments:
676 TODO the todo keyword \(string or nil\).
677 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
678 PRIORITY the priority of the headline \(integer or nil\)
679 TEXT the main headline text \(string\).
680 TAGS the tags string, separated with colons \(string or nil\).
682 The function result will be used as headline text."
689 ;;;; Inlinetasks
692 "Function called to format an inlinetask in ODT code.
694 The function must accept six parameters:
695 TODO the todo keyword, as a string
696 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
697 PRIORITY the inlinetask priority, as a string
698 NAME the inlinetask name, as a string.
699 TAGS the inlinetask tags, as a string.
700 CONTENTS the contents of the inlinetask, as a string.
702 The function should return the string to be exported."
709 ;;;; LaTeX
712 "Non-nil means process LaTeX math snippets.
714 When set, the exporter will process LaTeX environments and
715 fragments.
717 This option can also be set with the +OPTIONS line,
720 nil Ignore math snippets.
721 `verbatim' Keep everything in verbatim
722 `dvipng' Process the LaTeX fragments to images. This will also
723 include processing of non-math environments.
724 `imagemagick' Convert the LaTeX fragments to pdf files and use
725 imagemagick to convert pdf files to png files.
726 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
727 be loaded.
728 t Synonym for `mathjax'."
740 ;;;; Links
744 "Rules characterizing formula files that can be inlined into ODT.
746 A rule consists in an association whose key is the type of link
747 to consider, and value is a regexp that will be matched against
748 link's path."
755 "Rules characterizing image files that can be inlined into ODT.
757 A rule consists in an association whose key is the type of link
758 to consider, and value is a regexp that will be matched against
759 link's path."
765 "Scaling factor for converting images pixels to inches.
766 Use this for sizing of embedded images. See Info node `(org)
767 Images in ODT export' for more information."
774 ;;;; Src Block
777 "Whether custom styles for colorized source blocks be automatically created.
778 When this option is turned on, the exporter creates custom styles
779 for source blocks based on the advice of `htmlfontify'. Creation
780 of custom styles happen as part of `org-odt-hfy-face-to-css'.
782 When this option is turned off exporter does not create such
783 styles.
785 Use the latter option if you do not want the custom styles to be
786 based on your current display settings. It is necessary that the
787 styles.xml already contains needed styles for colorizing to work.
789 This variable is effective only if
790 `org-odt-fontify-srcblocks' is turned on."
796 "Specify whether or not source blocks need to be fontified.
797 Turn this option on if you want to colorize the source code
798 blocks in the exported file. For colorization to work, you need
799 to make available an enhanced version of `htmlfontify' library."
805 ;;;; Table
818 "Specify how Table Styles should be derived from a Table Template.
819 This is a list where each element is of the
820 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
822 TABLE-STYLE-NAME is the style associated with the table through
825 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
826 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
827 below) that is included in
828 `org-odt-content-template-file'.
830 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
832 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
840 TABLE-CELL-OPTIONS is an alist where each element is of the
841 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
842 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
843 `use-last-row-styles' |
844 `use-first-column-styles' |
845 `use-last-column-styles' |
846 `use-banding-rows-styles' |
847 `use-banding-columns-styles' |
848 `use-first-row-styles'
849 ON-OR-OFF := `t' | `nil'
851 For example, with the following configuration
853 \(setq org-odt-table-styles
855 \(\(use-first-row-styles . t\)
856 \(use-first-column-styles . t\)\)\)
858 \(\(use-first-column-styles . t\)\)\)\)\)
861 style will use the following table-cell styles -
866 as appropriate.
869 use the following table-cell styles -
871 following paragraph styles
873 as appropriate..
875 Note that TABLE-TEMPLATE-NAME corresponds to the
878 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
881 specification for more information. Also consult the
882 implementation filed under `org-odt-get-table-cell-styles'.
885 formatting of numbered display equations. Do not delete this
886 style from the list."
896 use-last-row-styles
897 use-first-column-styles
898 use-last-column-styles
899 use-banding-rows-styles
900 use-banding-columns-styles)
901 :key-type symbol
904 ;;;; Timestamps
907 "Non-nil, if timestamps should be exported as date fields.
909 When nil, export timestamps as plain text.
911 When non-nil, map `org-time-stamp-custom-formats' to a pair of
913 respectively. A timestamp with no time component is formatted
917 This feature is experimental. Most (but not all) of the common
918 %-specifiers in `format-time-string' are supported.
920 formatted as canonical Org timestamps. For finer control, avoid
921 these %-specifiers.
924 etc., are displayed by the application in the default language
925 and country specified in `org-odt-styles-file'. Note that the
927 can localize the week day and month strings in the exported
928 document by setting the default language and country either using
929 the application UI or through a custom styles file.
931 See `org-odt--build-date-styles' for implementation details."
936 \f
937 ;;; Internal functions
939 ;;;; Date
954 ;; LibreOffice does not care about end goes as content
955 ;; within the "<text:date>...</text:date>" field. The
956 ;; displayed date is automagically corrected to match the
957 ;; format requested by "style:data-style-name" attribute. So
958 ;; don't bother about formatting the date contents to be
959 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
960 ;; simple Org-style date should suffice.
985 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
986 iso-date style date)
988 repeater)))))
990 ;;;; Frame
998 extra
1002 style frame-attrs
1014 ;;;; Library wrappers
1021 ;; This is shamelessly stolen from `archive-zip-extract'.
1027 name)))
1032 exit-code command-output)
1040 members))
1042 ;;;; Target
1051 ;;;; Textbox
1054 extra anchor-type)
1060 text)
1061 width nil style extra anchor-type))
1065 ;;;; Table of Contents
1070 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1072 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1079 "
1080 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1082 <text:index-entry-chapter/>
1083 <text:index-entry-text/>
1084 <text:index-entry-link-end/>
1085 </text:table-of-content-entry-template>
1089 </text:table-of-content-source>
1091 <text:index-body>
1094 </text:index-title>
1099 </text:index-body>
1100 </text:table-of-content>
1108 ;; Section number.
1110 ;; Todo.
1115 style todo)))
1120 style priority)))
1121 ;; Title.
1122 text
1123 ;; Tags.
1127 "OrgTags"
1134 headline-label text))
1138 ;; When a headline is marked as a radio target, as in the example below:
1139 ;;
1140 ;; ** <<<Some Heading>>>
1141 ;; Some text.
1142 ;;
1143 ;; suppress generation of radio targets. i.e., Radio targets are to
1144 ;; be marked as targets within /document body/ and *not* within
1145 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1146 ;; and one in the document body.
1147 ;;
1148 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1149 ;; doesn't provide a way to disable memoization. So this doesn't
1150 ;; work.
1151 ;;
1152 ;; FIXME-2: Are there any other objects that need to be suppressed
1153 ;; within TOC?
1173 style entry)))
1178 ;;;; Document styles
1181 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1182 OBJECT-PROPS is (typically) a plist created by passing
1184 `org-odt-parse-block-attributes'.
1186 Use `org-odt-object-counters' to generate an automatic
1187 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1188 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1189 . STYLE-NAME)."
1205 ;;;; Checkbox
1208 "Return check-box string associated to ITEM."
1217 ;;; Template
1220 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1221 ;; to modify the date fields. A date could be modified by
1222 ;; offsetting in days. That's about it. Also, date and time may
1223 ;; have to be emitted as two fields - a date field and a time field
1224 ;; - separately.
1226 ;; One can add Form Controls to date and time fields so that they
1227 ;; can be easily modified. But then, the exported document will
1228 ;; become tightly coupled with LibreOffice and may not function
1229 ;; properly with other OpenDocument applications.
1231 ;; I have a strange feeling that Date styles are a bit flaky at the
1232 ;; moment.
1234 ;; The feature is experimental.
1280 ))
1288 filler-end))
1299 style
1302 output ))))
1305 "Return complete document string after ODT conversion.
1306 CONTENTS is the transcoded contents string. RAW-DATA is the
1307 original parsed data. INFO is a plist holding export options."
1308 ;; Write meta file.
1318 <office:document-meta
1328 ;; Date, if required.
1330 ;; Check if DATE is specified as an Org-timestamp. If yes,
1331 ;; include it as meta information. Otherwise, just use
1332 ;; today's date.
1341 iso-date)))))
1352 ;; Add meta.xml in to manifest.
1355 ;; Update styles file.
1356 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1357 ;; Write styles file.
1360 ;; Non-availability of styles.xml is not a critical
1361 ;; error. For now, throw an error.
1363 org-odt-styles-file
1365 org-odt-styles-dir)
1378 members)))
1388 org-odt-styles-file))))
1390 ;; create a manifest entry for styles.xml
1393 ;; FIXME: Who is opening an empty styles.xml before this point?
1398 ;; Write custom styles for source blocks
1399 ;; Save STYLES used for colorizing of source blocks.
1400 ;; Update styles.xml with styles that were collected as part of
1401 ;; `org-odt-hfy-face-to-css' callbacks.
1410 ;; Update styles.xml - take care of outline numbering
1412 ;; Don't make automatic backup of styles.xml file. This setting
1413 ;; prevents the backed-up styles.xml file from being zipped in to
1414 ;; odt file. This is more of a hackish fix. Better alternative
1415 ;; would be to fix the zip command so that the output odt file
1416 ;; includes only the needed files and excludes any auto-generated
1417 ;; extra files like backups and auto-saves etc etc. Note that
1418 ;; currently the zip command zips up the entire temp directory so
1419 ;; that any auto-generated files created under the hood ends up in
1420 ;; the resulting odt file.
1423 ;; Outline numbering is retained only upto LEVEL.
1424 ;; To disable outline numbering pass a LEVEL of 0.
1437 ;; Update content.xml.
1440 ;; within the context of the Org buffer. So obtain it's
1441 ;; value before moving on to temp-buffer context down below.
1451 org-odt-styles-dir)))
1452 ;; Write automatic styles.
1453 ;; - Position the cursor.
1457 ;; - Dump automatic table styles.
1462 ;; - Dump date-styles.
1468 ;; Update display level.
1469 ;; - Remove existing sequence decls. Also position the cursor.
1474 ;; Update sequence decls according to user preference.
1484 ;; Position the cursor to document body.
1489 ;; Preamble - Title, Author, Date etc.
1496 ;; Switch on or off above vars based on user settings
1500 ;; Title.
1505 ;; Separator.
1509 ;; Author only.
1512 "OrgSubtitle"
1514 ;; Separator.
1517 ;; Author and E-mail.
1521 "OrgSubtitle"
1526 ;; Separator.
1528 ;; Date, if required.
1531 ;; Check if DATE is specified as a timestamp.
1537 "OrgSubtitle"
1541 ;; Separator
1543 ;; Table of Contents
1546 with-toc
1549 ;; Contents.
1551 ;; Return contents.
1555 \f
1556 ;;; Transcode Functions
1558 ;;;; Bold
1561 "Transcode BOLD from Org to ODT.
1562 CONTENTS is the text with bold markup. INFO is a plist holding
1563 contextual information."
1568 ;;;; Center Block
1571 "Transcode a CENTER-BLOCK element from Org to ODT.
1572 CONTENTS holds the contents of the center block. INFO is a plist
1573 holding contextual information."
1574 contents)
1577 ;;;; Clock
1580 "Transcode a CLOCK element from Org to ODT.
1581 CONTENTS is nil. INFO is a plist used as a communication
1582 channel."
1595 ;;;; Code
1598 "Transcode a CODE object from Org to ODT.
1599 CONTENTS is nil. INFO is a plist used as a communication
1600 channel."
1606 ;;;; Comment
1608 ;; Comments are ignored.
1611 ;;;; Comment Block
1613 ;; Comment Blocks are ignored.
1616 ;;;; Drawer
1619 "Transcode a DRAWER element from Org to ODT.
1620 CONTENTS holds the contents of the block. INFO is a plist
1621 holding contextual information."
1625 name contents)
1626 ;; If there's no user defined function: simply
1627 ;; display contents of the drawer.
1628 contents)))
1629 output))
1632 ;;;; Dynamic Block
1635 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1636 CONTENTS holds the contents of the block. INFO is a plist
1637 holding contextual information. See `org-export-data'."
1638 contents)
1641 ;;;; Entity
1644 "Transcode an ENTITY object from Org to ODT.
1645 CONTENTS are the definition itself. INFO is a plist holding
1646 contextual information."
1650 ;;;; Example Block
1653 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1654 CONTENTS is nil. INFO is a plist holding contextual information."
1658 ;;;; Export Snippet
1661 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1662 CONTENTS is nil. INFO is a plist holding contextual information."
1667 ;;;; Export Block
1670 "Transcode a EXPORT-BLOCK element from Org to ODT.
1671 CONTENTS is nil. INFO is a plist holding contextual information."
1676 ;;;; Fixed Width
1679 "Transcode a FIXED-WIDTH element from Org to ODT.
1680 CONTENTS is nil. INFO is a plist holding contextual information."
1684 ;;;; Footnote Definition
1686 ;; Footnote Definitions are ignored.
1689 ;;;; Footnote Reference
1692 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1693 CONTENTS is nil. INFO is a plist holding contextual information."
1703 id note-class
1716 "OrgSuperscript"
1717 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1718 note-class ref-format ref-name n)))))))
1720 ;; Insert separator between two footnotes in a row.
1725 ;; Trancode footnote reference.
1730 ;; Inline definitions are secondary strings.
1731 ;; Non-inline footnotes definitions are full Org data.
1734 footnote-reference info))
1738 raw
1741 :transcoders
1744 p c "Footnote"
1745 "OrgFootnoteCenter"
1747 info))))
1754 ;;;; Headline
1760 ;; Todo.
1764 style todo)))
1769 style priority)))
1770 ;; Title.
1771 text
1772 ;; Tags.
1775 "<text:tab/>"
1784 &optional format-function
1786 "Transcode a HEADLINE element using BACKEND.
1787 INFO is a plist holding contextual information."
1814 todo todo-type priority text tags))))
1817 todo todo-type priority text tags
1822 "Transcode a HEADLINE element from Org to ODT.
1823 CONTENTS holds the contents of the headline. INFO is a plist
1824 holding contextual information."
1825 ;; Case 1: This is a footnote section: ignore it.
1828 ;; Create the headline text.
1830 ;; Get level relative to current parsed data.
1832 ;; Get canonical label for the headline.
1836 ;; Get user-specified labels for the headline.
1839 ;; Extra targets.
1847 ;; Title.
1850 ;; Case 2. This is a deep sub-tree: export it as a list item.
1851 ;; Also export as items headlines for which no section
1852 ;; format has been found.
1854 ;; Build the real contents of the sub-tree.
1858 ;; Choose style based on list type.
1861 ;; If top-level list, re-start numbering. Otherwise,
1862 ;; continue numbering.
1865 headline)))
1875 "Text_20_body"
1877 contents)
1879 "</text:list-header>"
1883 ;; Case 3. Standard headline. Export it as a section.
1889 level
1891 contents))))))
1894 ;;;; Horizontal Rule
1897 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1898 CONTENTS is nil. INFO is a plist holding contextual information."
1903 ;;;; Inline Babel Call
1905 ;; Inline Babel Calls are ignored.
1908 ;;;; Inline Src Block
1911 "Return a character not used in string S.
1913 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1919 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1920 CONTENTS holds the contents of the item. INFO is a plist holding
1921 contextual information."
1928 ;;;; Inlinetask
1931 "Transcode an INLINETASK element from Org to ODT.
1932 CONTENTS holds the contents of the block. INFO is a plist
1933 holding contextual information."
1935 ;; If `org-odt-format-inlinetask-function' is provided, call it
1936 ;; with appropriate arguments.
1943 todo todo-type priority text tags contents)))))
1946 ;; Otherwise, use a default template.
1949 "Text_20_body"
1953 "OrgInlineTaskHeading"
1955 contents)
1958 ;;;; Italic
1961 "Transcode ITALIC from Org to ODT.
1962 CONTENTS is the text with italic markup. INFO is a plist holding
1963 contextual information."
1968 ;;;; Item
1971 "Transcode an ITEM element from Org to ODT.
1972 CONTENTS holds the contents of the item. INFO is a plist holding
1973 contextual information."
1984 contents
1996 ;;;; Keyword
1999 "Transcode a KEYWORD element from Org to ODT.
2000 CONTENTS is nil. INFO is a plist holding contextual information."
2006 ;; FIXME
2017 ;; FIXME
2021 ;;;; Latex Environment
2024 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2025 ;; (defadvice org-format-latex-as-mathml ; FIXME
2026 ;; (after org-odt-protect-latex-fragment activate)
2027 ;; "Encode LaTeX fragment as XML.
2028 ;; Do this when translation to MathML fails."
2029 ;; (unless (> (length ad-return-value) 0)
2030 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2033 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2034 CONTENTS is nil. INFO is a plist holding contextual information."
2040 ;;;; Latex Fragment
2042 ;; (when latex-frag ; FIXME
2043 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2044 ;; :description latex-frag)))
2045 ;; handle verbatim
2046 ;; provide descriptions
2049 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2050 CONTENTS is nil. INFO is a plist holding contextual information."
2057 ;;;; Line Break
2060 "Transcode a LINE-BREAK object from Org to ODT.
2061 CONTENTS is nil. INFO is a plist holding contextual information."
2065 ;;;; Link
2067 ;;;; Links :: Label references
2078 x)))))
2089 counter))
2096 ;; Section number.
2100 ;; Separator.
2102 ;; Ordinal.
2104 tag))
2107 "Return a label for ELEMENT.
2109 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2110 element. INFO is a plist used as a communication channel. OP is
2111 either `definition' or `reference', depending on the purpose of
2112 the generated string.
2114 Return value is a string if OP is set to `reference' or a cons
2115 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2116 SHORT-CAPTION are strings."
2122 ;; Get label and caption.
2126 ;; Transcode captions.
2128 ;; Currently short caption are sneaked in as object names.
2129 ;;
2130 ;; The advantages are:
2131 ;;
2132 ;; - Table Of Contents: Currently, there is no support for
2133 ;; building TOC for figures, listings and tables. See
2134 ;; `org-odt-keyword'. User instead has to rely on
2135 ;; external application for building such indices. Within
2136 ;; LibreOffice, building an "Illustration Index" or "Index
2137 ;; of Tables" will create a table with long captions (only)
2138 ;; and building a table with "Object names" will create a
2139 ;; table with short captions.
2140 ;;
2141 ;; - Easy navigation: In LibreOffice, object names are
2142 ;; offered via the navigation bar. This way one can
2143 ;; quickly locate and jump to object of his choice in the
2144 ;; exported document.
2145 ;;
2146 ;; The main disadvantage is that there cannot be any markups
2147 ;; within object names i.e., one cannot embolden, italicize
2148 ;; or underline text within short caption. So suppress
2149 ;; generation of <text:span >...</text:span> and other
2150 ;; markups by overriding the default translators. We
2151 ;; probably shouldn't be suppressing translators for all
2152 ;; elements in `org-element-all-objects', but for now this
2153 ;; will do.
2159 :transcoders
2161 org-element-all-objects))))
2178 element))))
2181 seqno)
2185 ;; Compute sequence number of the element.
2187 ;; Localize category string.
2190 ;; Case 1: Handle Label definition.
2192 ;; Assign an internal label, if user has not provided one
2197 ;; Sneak in a bookmark. The bookmark is used when the
2198 ;; labeled element is referenced with a link that
2199 ;; provides it's own description.
2201 ;; Label definition: Typically formatted as below:
2202 ;; CATEGORY SEQ-NO: LONG CAPTION
2203 ;; with translation for correct punctuation.
2210 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2211 label counter counter seqno))
2213 short-caption))
2214 ;; Case 2: Handle Label reference.
2221 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2227 ;;;; Links :: Inline Images
2230 "Returns the internal name of the file"
2246 target-file))
2249 user-height scale dpi embed-as)
2269 ;; Use Imagemagick.
2274 file))))
2279 ;; Use Emacs.
2285 ;; Use hard-coded values.
2287 org-odt-default-image-sizes-alist))
2288 ;; Error out.
2301 ;; ensure that an embedded image fits comfortably within a page
2312 "Return ODT code for an inline image.
2313 LINK is the link pointing to the inline image. INFO is a plist
2314 used as a communication channel."
2327 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2329 ;; Extract attributes from #+ATTR_ODT line.
2333 ;; Convert attributes to a plist.
2335 ;; Handle `:anchor', `:style' and `:attributes' properties.
2345 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2346 ;; extrac
2347 ;;
2348 ;; Handle `:width', `:height' and `:scale' properties. Read
2349 ;; them as numbers since we need them for computations.
2351 src-expanded
2358 nil ; embed-as
2360 ))
2367 ;; Check if this link was created by LaTeX-to-PNG converter.
2371 ;; If yes, note down the type of the element - LaTeX Fragment
2372 ;; or LaTeX environment. It will go in to frame title.
2376 ;; If yes, note down it's contents. It will go in to frame
2377 ;; description. This quite useful for debugging.
2380 captions user-frame-params title desc)))
2383 ;;;; Links :: Math formula
2404 ;; Check if this link was created by LaTeX-to-MathML
2405 ;; converter.
2409 ;; If yes, note down the type of the element - LaTeX Fragment
2410 ;; or LaTeX environment. It will go in to frame title.
2414 ;; If yes, note down it's contents. It will go in to frame
2415 ;; description. This quite useful for debugging.
2417 width height)
2421 nil nil title desc))
2424 "CaptionedDisplayFormula" href width height
2425 captions nil title desc))
2429 org-odt--enumerable-formula-p))))
2434 "Returns the internal name of the file"
2438 ;; Create a directory for holding formula file. Also enter it in
2439 ;; to manifest.
2443 ;; Copy over the formula file from user directory to zip
2444 ;; directory.
2448 ;; Case 1: Mathml.
2451 ;; Case 2: OpenDocument formula.
2456 ;; Enter the formula file in to manifest.
2458 target-file))
2460 ;;;; Targets
2463 captions user-frame-params
2466 ;; Each element of this alist is of the form (CFG-HANDLE
2467 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2469 ;; CFG-HANDLE is the key to the alist.
2471 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2472 ;; frame params for INNER-FRAME and OUTER-FRAME
2473 ;; respectively. See below.
2475 ;; Configurations that are meant to be applied to
2476 ;; non-captioned image/formula specifies no
2477 ;; OUTER-FRAME-PARAMS.
2479 ;; TERMINOLOGY
2480 ;; ===========
2481 ;; INNER-FRAME :: Frame that directly surrounds an
2482 ;; image/formula.
2484 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2485 ;; frame also contains the caption, if any.
2487 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2488 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2489 ;; that these are the last three arguments
2490 ;; to `org-odt--frame'.
2492 ;; Note that an un-captioned image/formula requires just an
2493 ;; INNER-FRAME, while a captioned image/formula requires
2494 ;; both an INNER and an OUTER-FRAME.
2516 ;; Retrieve inner and outer frame params, from configuration.
2520 ;; User-specified frame params (from #+ATTR_ODT spec)
2524 "Merge default and user frame params."
2529 for d in default
2532 ;; Case 1: Image/Formula has no caption.
2533 ;; There is only one frame, one that surrounds the image
2534 ;; or formula.
2536 ;; Merge user frame params with that from configuration.
2540 ;; Case 2: Image/Formula is captioned or labeled.
2541 ;; There are two frames: The inner one surrounds the
2542 ;; image or formula. The outer one contains the
2543 ;; caption/sequence number.
2545 ;; Merge user frame params with outer frame params.
2547 ;; Short caption, if specified, goes as part of inner frame.
2554 frame-params))
2557 "Illustration"
2561 caption))
2562 width height outer)))))
2565 ;; Element should have a caption or label.
2571 element info
2572 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2573 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2574 ;; processing.)
2579 ;; Link should point to an image file.
2586 element info
2587 ;; Paragraph should have a caption or label. It SHOULD also be a
2588 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2589 ;; processing.)
2594 ;; Link should point to an image file.
2601 element info
2602 ;; Paragraph should have a caption or label.
2606 ;; Link should point to a MathML or ODF file.
2612 paragraph-predicate
2613 link-predicate)
2614 "Test if ELEMENT is a standalone link for the purpose ODT export.
2615 INFO is a plist holding contextual information.
2617 Return non-nil, if ELEMENT is of type paragraph satisfying
2618 PARAGRAPH-PREDICATE and it's sole content, save for whitespaces,
2619 is a link that satisfies LINK-PREDICATE.
2621 Return non-nil, if ELEMENT is of type link satisfying
2622 LINK-PREDICATE and it's containing paragraph satisfies
2623 PARAGRAPH-PREDICATE inaddtion to having no other content save for
2624 leading and trailing whitespaces.
2626 Return nil, otherwise."
2649 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2650 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2651 ;; attached. Note that labels that are attached to captioned
2652 ;; entities - inline images, math formulae and tables - get resolved
2653 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2655 ;; Create a cross-reference to DESTINATION but make best-efforts to
2656 ;; create a *meaningful* description. Check item numbers, section
2657 ;; number and section title in that order.
2659 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2660 ;; FIXME: Handle footnote-definition footnote-reference?
2676 return x))
2677 ;; Get list item nos.
2682 plain-list)
2685 item info t))))))
2686 ;; Locate top-most listified headline.
2691 return x))
2692 ;; Get listified headline numbers.
2698 el info t)))))))
2699 ;; Combine item numbers from both the listified headlines and
2700 ;; regular list items.
2702 ;; Case 1: Check if all the parents of list item are numbered.
2703 ;; If yes, link to the item proper.
2706 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2711 ;; Case 2: Locate a regular and numbered headline in the
2712 ;; hierarchy. Display it's section number.
2717 return el)))
2718 ;; We found one.
2720 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2724 ;; Case 4: Locate a regular headline in the hierarchy. Display
2725 ;; it's title.
2729 return el)))
2730 ;; We found one.
2732 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2739 "Transcode a LINK object from Org to ODT.
2741 DESC is the description part of the link, or the empty string.
2742 INFO is a plist holding contextual information. See
2743 `org-export-data'."
2746 ;; Ensure DESC really exists, or set it to nil.
2749 link org-odt-inline-image-rules))
2758 ;; Convert & to & for correct XML representation
2760 protocol)
2762 ;; Image file.
2764 link org-odt-inline-image-rules))
2766 ;; Formula file.
2768 link org-odt-inline-formula-rules))
2770 ;; Radio target: Transcode target's contents and use them as
2771 ;; link's description.
2778 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2779 href desc)))))
2780 ;; Links pointing to a headline: Find destination and build
2781 ;; appropriate referencing command.
2787 ;; Case 1: Fuzzy link points nowhere.
2788 ('nil
2790 "Emphasis"
2793 info))))
2794 ;; Case 2: Fuzzy link points to a headline.
2796 ;; If there's a description, create a hyperlink.
2797 ;; Otherwise, try to provide a meaningful description.
2806 label desc))))
2807 ;; Case 3: Fuzzy link points to a target.
2809 ;; If there's a description, create a hyperlink.
2810 ;; Otherwise, try to provide a meaningful description.
2815 desc))))
2816 ;; Case 4: Fuzzy link points to some element (e.g., an
2817 ;; inline image, a math formula or a table).
2824 ;; LINK has no description. Create
2825 ;; a cross-reference showing entity's sequence
2826 ;; number.
2828 ;; LINK has description. Insert a hyperlink with
2829 ;; user-provided description.
2834 desc)))))))))
2835 ;; Coderef: replace link with the reference name or the
2836 ;; equivalent line number.
2843 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2844 href line-no))))
2845 ;; Link type is handled by a special function.
2848 ;; External link with a description part.
2851 ;; Check if description is a link to an inline image.
2856 desc-element org-odt-inline-image-rules))))
2857 ;; Format link as a clickable image.
2859 path desc)
2860 ;; Otherwise, format it as a regular link.
2862 path desc))))
2863 ;; External link without a description part.
2866 path path))
2867 ;; No path, only description. Try to do something useful.
2872 ;;;; Node Property
2875 "Transcode a NODE-PROPERTY element from Org to ODT.
2876 CONTENTS is nil. INFO is a plist holding contextual
2877 information."
2884 ;;;; Paragraph
2887 "Format paragraph according to given styles.
2888 PARAGRAPH is a paragraph type element. CONTENTS is the
2889 transcoded contents of that paragraph, as a string. DEFAULT,
2890 CENTER and QUOTE are, respectively, style to use when paragraph
2891 belongs to no special environment, a center block, or a quote
2892 block."
2899 ;; If this paragraph is a leading paragraph in an item and the
2900 ;; item has a checkbox, splice the checkbox and paragraph contents
2901 ;; together.
2908 "Transcode a PARAGRAPH element from Org to ODT.
2909 CONTENTS is the contents of the paragraph, as a string. INFO is
2910 the plist used as a communication channel."
2912 paragraph contents
2914 "OrgCenter"
2918 ;;;; Plain List
2921 "Transcode a PLAIN-LIST element from Org to ODT.
2922 CONTENTS is the contents of the list. INFO is a plist holding
2923 contextual information."
2925 ;; Choose style based on list type.
2931 ;; If top-level list, re-start numbering. Otherwise,
2932 ;; continue numbering.
2937 contents))
2939 ;;;; Plain Text
2952 line))
2963 "Transcode a TEXT string from Org to ODT.
2964 TEXT is the string to transcode. INFO is a plist holding
2965 contextual information."
2967 ;; Protect &, < and >.
2969 ;; Handle smart quotes. Be sure to provide original string since
2970 ;; OUTPUT may have been modified.
2973 ;; Convert special strings.
2979 org-odt-special-string-regexps))
2980 ;; Handle break preservation if required.
2984 ;; Return value.
2985 output))
2988 ;;;; Planning
2991 "Transcode a PLANNING element from Org to ODT.
2992 CONTENTS is nil. INFO is a plist used as a communication
2993 channel."
2995 "OrgPlanning"
3017 ;;;; Property Drawer
3020 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3021 CONTENTS holds the contents of the drawer. INFO is a plist
3022 holding contextual information."
3025 contents)))
3028 ;;;; Quote Block
3031 "Transcode a QUOTE-BLOCK element from Org to ODT.
3032 CONTENTS holds the contents of the block. INFO is a plist
3033 holding contextual information."
3034 contents)
3037 ;;;; Quote Section
3040 "Transcode a QUOTE-SECTION element from Org to ODT.
3041 CONTENTS is nil. INFO is a plist holding contextual information."
3047 ;;;; Section
3052 style
3054 text)))
3058 "Transcode a SECTION element from Org to ODT.
3059 CONTENTS holds the contents of the section. INFO is a plist
3060 holding contextual information."
3061 contents)
3063 ;;;; Radio Target
3066 "Transcode a RADIO-TARGET object from Org to ODT.
3067 TEXT is the text of the target. INFO is a plist holding
3068 contextual information."
3074 ;;;; Special Block
3077 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3078 CONTENTS holds the contents of the block. INFO is a plist
3079 holding contextual information."
3083 ;; Annotation.
3089 ;; FIXME: Is `car' right thing to do below?
3099 contents)))))
3100 ;; Textbox.
3109 style extra anchor))))
3113 ;;;; Src Block
3116 "Create custom style for face FN.
3117 When FN is the default face, use it's foreground and background
3119 use it's color attribute to create a character style whose name
3120 is obtained from FN. Currently all attributes of FN other than
3121 color are ignored.
3123 The style name for a face FN is derived using the following
3124 operations on the face name in that order - de-dash, CamelCase
3126 `font-lock-function-name-face' is associated with
3141 background-color-val color-val))
3144 "
3175 org-odt-fontify-srcblocks
3192 code
3203 par-style loc))
3206 num-start refs))
3220 ;; Extract code and references.
3224 ;; Does the src block contain labels?
3226 ;; Does it have line numbers?
3233 "Transcode a SRC-BLOCK element from Org to ODT.
3234 CONTENTS holds the contents of the item. INFO is a plist holding
3235 contextual information."
3247 "Text_20_body"
3251 ;;;; Statistics Cookie
3254 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3255 CONTENTS is nil. INFO is a plist holding contextual information."
3261 ;;;; Strike-Through
3264 "Transcode STRIKE-THROUGH from Org to ODT.
3265 CONTENTS is the text with strike-through markup. INFO is a plist
3266 holding contextual information."
3271 ;;;; Subscript
3274 "Transcode a SUBSCRIPT object from Org to ODT.
3275 CONTENTS is the contents of the object. INFO is a plist holding
3276 contextual information."
3281 ;;;; Superscript
3284 "Transcode a SUPERSCRIPT object from Org to ODT.
3285 CONTENTS is the contents of the object. INFO is a plist holding
3286 contextual information."
3291 ;;;; Table Cell
3300 "Retrieve styles applicable to a table cell.
3301 R and C are (zero-based) row and column numbers of the table
3302 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3303 applicable to the current table. It is `nil' if the table is not
3304 associated with any style attributes.
3306 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3308 When STYLE-SPEC is nil, style the table cell the conventional way
3309 - choose cell borders based on row and column groupings and
3310 choose paragraph alignment based on `org-col-cookies' text
3311 property. See also
3312 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3314 When STYLE-SPEC is non-nil, ignore the above cookie and return
3315 styles congruent with the ODF-1.2 specification."
3321 info)))
3323 ;; LibreOffice - particularly the Writer - honors neither table
3324 ;; templates nor custom table-cell styles. Inorder to retain
3325 ;; inter-operability with LibreOffice, only automatic styles are
3326 ;; used for styling of table-cells. The current implementation is
3327 ;; congruent with ODF-1.2 specification and hence is
3328 ;; future-compatible.
3330 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3331 ;; which recognizes as many as 16 different cell types - is much
3332 ;; richer. Unfortunately it is NOT amenable to easy configuration
3333 ;; by hand.
3360 "Transcode a TABLE-CELL element from Org to ODT.
3361 CONTENTS is nil. INFO is a plist used as a communication
3362 channel."
3369 table-cell info))
3392 table-cell info))))))
3396 custom-style-prefix))
3398 "OrgTblCell"
3414 cell-attributes
3417 org-element-all-elements)
3418 contents
3420 paragraph-style contents))))
3427 ;;;; Table Row
3430 "Transcode a TABLE-ROW element from Org to ODT.
3431 CONTENTS is the contents of the row. INFO is a plist used as a
3432 communication channel."
3433 ;; Rules are ignored since table separators are deduced from
3434 ;; borders of the current row.
3440 ;; If the row belongs to the first rowgroup and the
3441 ;; table has more than one row groups, then this row
3442 ;; belongs to the header row group.
3444 ;; Otherwise, it belongs to non-header row group.
3447 ;; Does this row begin a rowgroup?
3450 ;; Actual table row
3452 ;; Does this row end a rowgroup?
3457 ;;;; Table
3470 "Transcode a TABLE element from Org to ODT.
3471 CONTENTS is the contents of the table. INFO is a plist holding
3472 contextual information."
3474 ;; Case 1: table.el doesn't support export to OD format. Strip
3475 ;; such tables from export.
3480 "(ox-odt): Found table.el-type table in the source Org file."
3481 " table.el doesn't support export to ODT format."
3483 ;; Case 2: Native Org tables.
3500 column-style))
3501 out)
3505 ;; caption.
3509 ;; begin table.
3517 ;; column specification.
3519 ;; actual contents.
3521 ;; end table.
3525 "Transcode a TABLE element from Org to ODT.
3526 CONTENTS is the contents of the table. INFO is a plist holding
3527 contextual information.
3529 Use `org-odt--table' to typeset the table. Handle details
3530 pertaining to indentation here."
3545 collect el)))
3551 collect
3556 parent-list)
3558 ;; Handle list genealogy.
3578 parent-list info)
3581 ;; Handle low-level headlines.
3583 with step = 'item collect
3591 el info)
3592 "OrgNumberedList"
3603 parent-list info)))
3611 table info)))
3612 ;; OpenDocument schema does not permit table to occur within a
3613 ;; list item.
3615 ;; One solution - the easiest and lightweight, in terms of
3616 ;; implementation - is to put the table in an indented text box
3617 ;; and make the text box part of the list-item. Unfortunately if
3618 ;; the table is big and spans multiple pages, the text box could
3619 ;; overflow. In this case, the following attribute will come
3620 ;; handy.
3622 ;; ,---- From OpenDocument-v1.1.pdf
3623 ;; | 15.27.28 Overflow behavior
3624 ;; |
3625 ;; | For text boxes contained within text document, the
3626 ;; | style:overflow-behavior property specifies the behavior of text
3627 ;; | boxes where the containing text does not fit into the text
3628 ;; | box.
3629 ;; |
3630 ;; | If the attribute's value is clip, the text that does not fit
3631 ;; | into the text box is not displayed.
3632 ;; |
3633 ;; | If the attribute value is auto-create-new-frame, a new frame
3634 ;; | will be created on the next page, with the same position and
3635 ;; | dimensions of the original frame.
3636 ;; |
3637 ;; | If the style:overflow-behavior property's value is
3638 ;; | auto-create-new-frame and the text box has a minimum width or
3639 ;; | height specified, then the text box will grow until the page
3640 ;; | bounds are reached before a new frame is created.
3641 ;; `----
3643 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3644 ;; auto-create-new-frame property and always resorts to clipping
3645 ;; the text box. This results in table being truncated.
3647 ;; So we solve the problem the hard (and fun) way using list
3648 ;; continuations.
3650 ;; The problem only becomes more interesting if you take in to
3651 ;; account the following facts:
3652 ;;
3653 ;; - Description lists are simulated as plain lists.
3654 ;; - Low-level headlines can be listified.
3655 ;; - In Org-mode, a table can occur not only as a regular list
3656 ;; item, but also within description lists and low-level
3657 ;; headlines.
3659 ;; See `org-odt-translate-description-lists' and
3660 ;; `org-odt-translate-low-level-headlines' for how this is
3661 ;; tackled.
3664 ;; Discontinue the list.
3666 ;; Put the table in an indented section.
3671 ;; Continue the list.
3675 ;;;; Target
3678 "Transcode a TARGET object from Org to ODT.
3679 CONTENTS is nil. INFO is a plist holding contextual
3680 information."
3685 ;;;; Timestamp
3688 "Transcode a TIMESTAMP object from Org to ODT.
3689 CONTENTS is nil. INFO is a plist used as a communication
3690 channel."
3707 "OrgActiveTimestamp"
3711 "OrgInactiveTimestamp"
3715 "OrgActiveTimestamp"
3721 "OrgInactiveTimestamp"
3727 "OrgDiaryTimestamp"
3729 info)))))))
3732 ;;;; Underline
3735 "Transcode UNDERLINE from Org to ODT.
3736 CONTENTS is the text with underline markup. INFO is a plist
3737 holding contextual information."
3742 ;;;; Verbatim
3745 "Transcode a VERBATIM object from Org to ODT.
3746 CONTENTS is nil. INFO is a plist used as a communication
3747 channel."
3753 ;;;; Verse Block
3756 "Transcode a VERSE-BLOCK element from Org to ODT.
3757 CONTENTS is verse block contents. INFO is a plist holding
3758 contextual information."
3759 ;; Add line breaks to each line of verse.
3763 ;; Replace tabs and spaces.
3765 ;; Surround it in a verse environment.
3770 \f
3771 ;;; Filters
3773 ;;;; LaTeX fragments
3778 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3779 ;; If the desired converter is not available, force verbatim
3780 ;; processing.
3798 ;; Store normalized value for later use.
3803 ;; Convert `latex-fragment's and `latex-environment's.
3821 ;; Get an Org-style link to PNG image or the MathML
3822 ;; file.
3827 nil display-msg
3828 nil nil processing-type)
3833 link))))
3835 ;; Conversion succeeded. Parse above Org-style link to a
3836 ;; `link' object.
3842 ;; Orphan the link.
3847 ;; Case 1: LaTeX environment.
3848 ;; Mimic a "standalone image or formula" by
3849 ;; enclosing the `link' in a `paragraph'.
3850 ;; Copy over original attributes, captions to
3851 ;; the enclosing paragraph.
3857 latex-*)
3859 latex-*)))
3860 link))
3861 ;; Case 2: LaTeX fragment.
3862 ;; No special action.
3864 ;; Note down the object that link replaces.
3868 ;; Replace now.
3870 info)))
3871 tree)
3874 ;;;; Description lists
3876 ;; This translator is necessary to handle indented tables in a uniform
3877 ;; manner. See comment in `org-odt--table'.
3880 ;; OpenDocument has no notion of a description list. So simulate it
3881 ;; using plain lists. Description lists in the exported document
3882 ;; are typeset in the same manner as they are in a typical HTML
3883 ;; document.
3884 ;;
3885 ;; Specifically, a description list like this:
3886 ;;
3887 ;; ,----
3888 ;; | - term-1 :: definition-1
3889 ;; | - term-2 :: definition-2
3890 ;; `----
3891 ;;
3892 ;; gets translated in to the following form:
3893 ;;
3894 ;; ,----
3895 ;; | - term-1
3896 ;; | - definition-1
3897 ;; | - term-2
3898 ;; | - definition-2
3899 ;; `----
3900 ;;
3901 ;; Further effect is achieved by fixing the OD styles as below:
3902 ;;
3903 ;; 1. Set the :type property of the simulated lists to
3904 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3905 ;; that has *no* bullets whatsoever.
3906 ;;
3907 ;; 2. The paragraph containing the definition term is styled to be
3908 ;; in bold.
3909 ;;
3914 el
3930 nil)
3931 info)
3932 tree)
3934 ;;;; List tables
3936 ;; Lists that are marked with attribute `:list-table' are called as
3937 ;; list tables. They will be rendered as a table within the exported
3938 ;; document.
3940 ;; Consider an example. The following list table
3941 ;;
3942 ;; #+attr_odt :list-table t
3943 ;; - Row 1
3944 ;; - 1.1
3945 ;; - 1.2
3946 ;; - 1.3
3947 ;; - Row 2
3948 ;; - 2.1
3949 ;; - 2.2
3950 ;; - 2.3
3951 ;;
3952 ;; will be exported as though it were an Org table like the one show
3953 ;; below.
3954 ;;
3955 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3956 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3957 ;;
3958 ;; Note that org-tables are NOT multi-line and each line is mapped to
3959 ;; a unique row in the exported document. So if an exported table
3960 ;; needs to contain a single paragraph (with copious text) it needs to
3961 ;; be typed up in a single line. Editing such long lines using the
3962 ;; table editor will be a cumbersome task. Furthermore inclusion of
3963 ;; multi-paragraph text in a table cell is well-nigh impossible.
3964 ;;
3965 ;; A LIST-TABLE circumvents above problems.
3966 ;;
3967 ;; Note that in the example above the list items could be paragraphs
3968 ;; themselves and the list can be arbitrarily deep.
3969 ;;
3970 ;; Inspired by following thread:
3971 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3973 ;; Translate lists to tables
3979 ;; Replace list with table.
3981 l1-list
3982 ;; Build replacement table.
3988 l1-item-leading-text l2-list)
3989 ;; Remove Level-2 list from the Level-item. It
3990 ;; will be subsequently attached as table-cells.
4000 ;; Level-1 items start a table row.
4003 ;; Leading text of level-1 item define
4004 ;; the first table-cell.
4007 l1-item-leading-text)
4008 ;; Level-2 items define subsequent
4009 ;; table-cells of the row.
4017 nil)
4018 info)
4019 tree)
4021 \f
4022 ;;; Interactive functions
4035 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4044 org-odt-manifest-file-entries)
4052 ;; Initialize temporary workarea. All files that end up in
4053 ;; the exported document get parked/created here.
4060 ;; Kill all XML buffers.
4068 org-odt-xml-files)
4069 ;; Delete temporary directory and also other embedded
4070 ;; files that get copied there.
4075 ;; Not at all OSes ship with zip by default
4077 ;; Do export. This creates a bunch of xml files ready to be
4078 ;; saved and zipped.
4080 ;; Create a manifest entry for content.xml.
4082 ;; Write mimetype file
4091 ;; Write out the manifest entries before zipping
4093 ;; Save all XML files.
4099 ;; Prettify output if needed.
4103 org-odt-xml-files)
4104 ;; Run zip.
4109 ;; If a file with same name as the desired output file
4110 ;; exists, remove it.
4113 ;; Zip up the xml files.
4116 ;; Switch temporarily to content.xml. This way Zip
4117 ;; process will inherit `org-odt-zip-dir' as the current
4118 ;; directory.
4132 err-string)))))
4133 cmds)))
4134 ;; Move the zip file from temporary work directory to
4135 ;; user-mandated location.
4138 ;; Cleanup work directory and work files.
4140 ;; Open the OpenDocument file in archive-mode for
4141 ;; examination.
4143 ;; Return exported file.
4145 ;; Case 1: Conversion desired on exported file. Run the
4146 ;; converter on the OpenDocument file. Return the
4147 ;; converted file.
4150 target))
4151 ;; Case 2: No further conversion. Return exported
4152 ;; OpenDocument file.
4155 ;; Cleanup work directory and work files.
4161 ;;;; Export to OpenDocument formula
4163 ;;;###autoload
4165 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4166 Use `org-create-math-formula' to convert LATEX-FRAG first to
4167 MathML. When invoked as an interactive command, use
4168 `org-latex-regexps' to infer LATEX-FRAG from currently active
4169 region. If no LaTeX fragments are found, prompt for it. Push
4170 MathML source to kill ring depending on the value of
4171 `org-export-copy-to-kill-ring'."
4197 filename
4210 ;; Add MathML to kill ring, if needed.
4214 ;;;###autoload
4216 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4217 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4218 formula file."
4223 ;;;; Export to OpenDocument Text
4225 ;;;###autoload
4227 "Export current buffer to a ODT file.
4229 If narrowing is active in the current buffer, only export its
4230 narrowed part.
4232 If a region is active, export that region.
4234 A non-nil optional argument ASYNC means the process should happen
4235 asynchronously. The resulting file should be accessible through
4236 the `org-export-stack' interface.
4238 When optional argument SUBTREEP is non-nil, export the sub-tree
4239 at point, extracting information from the headline properties
4240 first.
4242 When optional argument VISIBLE-ONLY is non-nil, don't export
4243 contents of hidden elements.
4245 EXT-PLIST, when provided, is a property list with external
4246 parameters overriding Org default settings, but still inferior to
4247 file-local settings.
4249 Return output file's name."
4256 ,outfile
4261 ;; Let `htmlfontify' know that we are interested in
4262 ;; collecting styles.
4264 ;; Initialize content.xml and kick-off the export
4265 ;; process.
4278 outfile
4283 ;; Let `htmlfontify' know that we are interested in collecting
4284 ;; styles.
4286 ;; Initialize content.xml and kick-off the export process.
4296 ;;;; Convert between OpenDocument and other formats
4299 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4308 "Workhorse routine for `org-odt-convert'."
4317 in-fmt out-fmt)))
4345 out-file)
4348 nil))))
4351 "Return verbose info about formats to which IN-FMT can be converted.
4352 Return a list where each element is of the
4353 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4354 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4355 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4359 org-odt-convert-processes t))))
4363 org-odt-convert-processes t))
4364 org-odt-convert-capabilities))
4365 reachable-formats)
4370 reachable-formats))
4373 "Return list of formats to which IN-FMT can be converted.
4374 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4380 l))
4383 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4384 This is a helper routine for interactive use."
4387 nil buffer-file-name t))
4393 out-fmt-choices nil nil nil))
4395 "No known converter or no known output formats for %s files"
4396 in-fmt))))
4399 ;;;###autoload
4401 "Convert IN-FILE to format OUT-FMT using a command line converter.
4402 IN-FILE is the file to be converted. If unspecified, it defaults
4403 to variable `buffer-file-name'. OUT-FMT is the desired output
4404 format. Use `org-odt-convert-process' as the converter.
4405 If PREFIX-ARG is non-nil then the newly converted file is opened
4406 using `org-open-file'."
4411 ;;; Library Initializations
4415 ;; Let Emacs open all OpenDocument files in archive mode
4418 org-odt-file-extensions)
4422 ;; Local variables:
4423 ;; generated-autoload-file: "org-loaddefs.el"
4424 ;; End:
4426 ;;; ox-odt.el ends here