| blob | c98d9c39314d5a486fc79f4942ff481f8a49d101 |
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
103 ;; Other variables.
116 ;; Redefine regular option.
120 ;;; Dependencies
122 ;;; Hooks
124 ;;; Function Declarations
133 \f
134 ;;; Internal Variables
138 "Location of ODT exporter.
139 Use this to infer values of `org-odt-styles-dir' and
144 "Data directory for ODT exporter.
145 Use this to infer values of `org-odt-styles-dir' and
162 "List of directories to search for OpenDocument schema files.
163 Use this list to set the default value of
164 `org-odt-schema-dir'. The entries in this list are
165 populated heuristically based on the values of `org-odt-lib-dir'
178 )
179 "List of directories to search for OpenDocument styles files.
180 See `org-odt-styles-dir'. The entries in this list are populated
181 heuristically based on the values of `org-odt-lib-dir' and
198 styles-dir)
200 org-odt-styles-dir-list)
201 nil)))
204 styles-dir)
205 "Directory that holds auxiliary XML files used by the ODT exporter.
207 This directory contains the following XML files -
209 XML files are used as the default values of
210 `org-odt-styles-file' and `org-odt-content-template-file'.
212 The default value of this variable varies depending on the
213 version of org in use and is initialized from
214 `org-odt-styles-dir-list'. Note that the user could be using org
215 from one of: org's own private git repository, GNU ELPA tar or
238 "
240 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
241 </style:style>
242 "
246 "Registry of automatic styles for various OBJECT-TYPEs.
247 The variable has the following form:
248 \(\(OBJECT-TYPE-A
249 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
250 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
251 \(OBJECT-TYPE-B
252 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
253 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
254 ...\).
257 OBJECT-PROPS is (typically) a plist created by passing
263 "Running counters for various OBJECT-TYPEs.
264 Use this to generate automatic names and style-names. See
268 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
269 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
270 <style:background-image/>
271 </style:paragraph-properties>
273 </style:style>"
274 "Custom paragraph style for colorized source and example blocks.
276 except that the foreground and background colors are set
291 "Hardcoded image dimensions one for each of the anchor
294 ;; A4 page size is 21.0 by 29.7 cms
295 ;; The default page settings has 2cm margin on each of the sides. So
296 ;; the effective text area is 17.0 by 25.7 cm
305 "Specify how labels are applied and referenced.
307 This is an alist where each element is of the form:
309 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
311 ATTACH-FMT controls how labels and captions are attached to an
312 entity. It may contain following specifiers - %e and %c. %e is
313 replaced with the CATEGORY-NAME. %n is replaced with
315 with CAPTION.
317 REF-MODE and REF-FMT controls how label references are generated.
318 The following XML is generated for a label reference -
321 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
322 %n is replaced with SEQNO.
332 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
334 This is a list where each entry is of the form:
336 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
338 CATEGORY_HANDLE identifies the captionable entity in question.
340 OD-VARIABLE is the OpenDocument sequence counter associated with
341 the entity. These counters are declared within
343 `org-odt-content-template-file'.
345 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
346 how a given entity should be captioned and referenced.
348 CATEGORY-NAME is used for qualifying captions on export.
350 ENUMERATOR-PREDICATE is used for assigning a sequence number to
360 \f
361 ;;; User Configuration Variables
364 "Options for exporting Org mode files to ODT."
369 ;;;; Debugging
372 "Specify whether or not the xml output should be prettified.
373 When this option is turned on, `indent-region' is run on all
374 component xml buffers before they are saved. Turn this off for
375 regular use. Turn this on if you need to examine the xml
376 visually."
382 ;;;; Document schema
395 schema-dir))
398 schema-dir))
402 schema-dir)
404 org-odt-schema-dir-list)
406 nil)))
407 schema-dir)
408 "Directory that contains OpenDocument schema files.
410 This directory contains:
411 1. rnc files for OpenDocument schema
413 for auto validation of OpenDocument XML files.
415 Use the customize interface to set this variable. This ensures
416 that `rng-schema-locating-files' is updated and auto-validation
417 of OpenDocument XML takes place based on the value
418 `rng-nxml-auto-validate-flag'.
420 The default value of this variable varies depending on the
421 version of org in use and is initialized from
422 `org-odt-schema-dir-list'. The OASIS schema files are available
423 only in the org's private git repository. It is *not* bundled
424 with GNU ELPA tar or standard Emacs distribution."
430 :set
432 "Set `org-odt-schema-dir'.
433 Also add it to `rng-schema-locating-files'."
443 schema-dir
446 value))
447 nil)))
452 org-odt-schema-dir))))))
455 ;;;; Document styles
459 The exporter embeds the exported content just before
463 under `org-odt-styles-dir' is used."
470 "Default styles file for use with ODT export.
471 Valid values are one of:
472 1. nil
473 2. path to a styles.xml file
474 3. path to a *.odt or a *.ott file
475 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
476 ...))
478 In case of option 1, an in-built styles.xml is used. See
479 `org-odt-styles-dir' for more information.
481 In case of option 3, the specified file is unzipped and the
482 styles.xml embedded therein is used.
484 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
485 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
486 generated odt file. Use relative path for specifying the
487 FILE-MEMBERS. styles.xml must be specified as one of the
488 FILE-MEMBERS.
490 Use options 1, 2 or 3 only if styles.xml alone suffices for
491 achieving the desired formatting. Use option 4, if the styles.xml
492 references additional files like header and footer images for
493 achieving the desired formatting.
496 a per-file basis. For example,
502 :type
514 "Outline levels considered for enumerating captioned entities."
520 ;;;; Document conversion
527 "Specify a list of document converters and their usage.
528 The converters in this list are offered as choices while
529 customizing `org-odt-convert-process'.
531 This variable is a list where each element is of the
532 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
533 of the converter. CONVERTER-CMD is the shell command for the
534 converter and can contain format specifiers. These format
535 specifiers are interpreted as below:
537 %i input file name in full
538 %I input file name as a URL
539 %f format of the output file
540 %o output file name in full
541 %O output file name as a URL
542 %d output dir in full
543 %D output dir as a URL.
544 %x extra options as set in `org-odt-convert-capabilities'."
547 :type
556 During customization, the list of converter names are populated
557 from `org-odt-convert-processes'."
567 org-odt-convert-processes))))
585 "Specify input and output formats of `org-odt-convert-process'.
586 More correctly, specify the set of input and output formats that
587 the user is actually interested in.
589 This variable is an alist where each element is of the
590 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
591 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
592 alist where each element is of the form (OUTPUT-FMT
593 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
595 The variable is interpreted as follows:
596 `org-odt-convert-process' can take any document that is in
597 INPUT-FMT-LIST and produce any document that is in the
598 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
599 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
600 serves dual purposes:
601 - It is used for populating completion candidates during
602 `org-odt-convert' commands.
604 `org-odt-convert-process'.
607 `org-odt-convert-process'.
609 DOCUMENT-CLASS is used to group a set of file formats in
610 INPUT-FMT-LIST in to a single class.
612 Note that this variable inherently captures how LibreOffice based
613 converters work. LibreOffice maps documents of various formats
614 to classes like Text, Web, Spreadsheet, Presentation etc and
615 allow document of a given class (irrespective of its source
616 format) to be converted to any of the export formats associated
617 with that class.
619 See default setting of this variable for an typical
620 configuration."
623 :type
628 :value-type
632 :value-type
641 and then uses `org-odt-convert-process' to convert the
642 resulting document to this format. During customization of this
643 variable, the list of valid values are populated based on
644 `org-odt-convert-capabilities'.
646 You can set this option on per-file basis using file local
647 values. See Info node `(emacs) File Variables'."
658 ;;;###autoload
662 ;;;; Drawers
666 "Function called to format a drawer in ODT code.
668 The function must accept two parameters:
670 CONTENTS the contents of the drawer.
672 The function should return the string to be exported.
674 The default value simply returns the value of CONTENTS."
681 ;;;; Headline
684 'org-odt-format-headline-default-function
685 "Function to format headline text.
687 This function will be called with 5 arguments:
688 TODO the todo keyword \(string or nil\).
689 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
690 PRIORITY the priority of the headline \(integer or nil\)
691 TEXT the main headline text \(string\).
692 TAGS the tags string, separated with colons \(string or nil\).
694 The function result will be used as headline text."
701 ;;;; Inlinetasks
704 'org-odt-format-inlinetask-default-function
705 "Function called to format an inlinetask in ODT code.
707 The function must accept six parameters:
708 TODO the todo keyword, as a string
709 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
710 PRIORITY the inlinetask priority, as a string
711 NAME the inlinetask name, as a string.
712 TAGS the inlinetask tags, as a string.
713 CONTENTS the contents of the inlinetask, as a string.
715 The function should return the string to be exported."
722 ;;;; LaTeX
725 "Non-nil means process LaTeX math snippets.
727 When set, the exporter will process LaTeX environments and
728 fragments.
730 This option can also be set with the +OPTIONS line,
733 nil Ignore math snippets.
734 `verbatim' Keep everything in verbatim
735 `dvipng' Process the LaTeX fragments to images. This will also
736 include processing of non-math environments.
737 `imagemagick' Convert the LaTeX fragments to pdf files and use
738 imagemagick to convert pdf files to png files.
739 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
740 be loaded.
741 t Synonym for `mathjax'."
753 ;;;; Links
757 "Rules characterizing formula files that can be inlined into ODT.
759 A rule consists in an association whose key is the type of link
760 to consider, and value is a regexp that will be matched against
761 link's path."
770 "Rules characterizing image files that can be inlined into ODT.
772 A rule consists in an association whose key is the type of link
773 to consider, and value is a regexp that will be matched against
774 link's path."
782 "Scaling factor for converting images pixels to inches.
783 Use this for sizing of embedded images. See Info node `(org)
784 Images in ODT export' for more information."
791 ;;;; Src Block
794 "Whether custom styles for colorized source blocks be automatically created.
795 When this option is turned on, the exporter creates custom styles
796 for source blocks based on the advice of `htmlfontify'. Creation
797 of custom styles happen as part of `org-odt-hfy-face-to-css'.
799 When this option is turned off exporter does not create such
800 styles.
802 Use the latter option if you do not want the custom styles to be
803 based on your current display settings. It is necessary that the
804 styles.xml already contains needed styles for colorizing to work.
806 This variable is effective only if `org-odt-fontify-srcblocks' is
807 turned on."
813 "Specify whether or not source blocks need to be fontified.
814 Turn this option on if you want to colorize the source code
815 blocks in the exported file. For colorization to work, you need
816 to make available an enhanced version of `htmlfontify' library."
822 ;;;; Table
835 "Specify how Table Styles should be derived from a Table Template.
836 This is a list where each element is of the
837 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
839 TABLE-STYLE-NAME is the style associated with the table through
842 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
843 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
844 below) that is included in `org-odt-content-template-file'.
846 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
848 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
856 TABLE-CELL-OPTIONS is an alist where each element is of the
857 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
858 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
859 `use-last-row-styles' |
860 `use-first-column-styles' |
861 `use-last-column-styles' |
862 `use-banding-rows-styles' |
863 `use-banding-columns-styles' |
864 `use-first-row-styles'
865 ON-OR-OFF := t | nil
867 For example, with the following configuration
869 \(setq org-odt-table-styles
871 \(\(use-first-row-styles . t\)
872 \(use-first-column-styles . t\)\)\)
874 \(\(use-first-column-styles . t\)\)\)\)\)
877 style will use the following table-cell styles -
882 as appropriate.
885 use the following table-cell styles -
887 following paragraph styles
889 as appropriate..
891 Note that TABLE-TEMPLATE-NAME corresponds to the
894 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
897 specification for more information. Also consult the
898 implementation filed under `org-odt-get-table-cell-styles'.
901 formatting of numbered display equations. Do not delete this
902 style from the list."
912 use-last-row-styles
913 use-first-column-styles
914 use-last-column-styles
915 use-banding-rows-styles
916 use-banding-columns-styles)
917 :key-type symbol
920 ;;;; Timestamps
923 "Non-nil, if timestamps should be exported as date fields.
925 When nil, export timestamps as plain text.
927 When non-nil, map `org-time-stamp-custom-formats' to a pair of
929 respectively. A timestamp with no time component is formatted
933 This feature is experimental. Most (but not all) of the common
934 %-specifiers in `format-time-string' are supported.
936 formatted as canonical Org timestamps. For finer control, avoid
937 these %-specifiers.
940 etc., are displayed by the application in the default language
941 and country specified in `org-odt-styles-file'. Note that the
943 can localize the week day and month strings in the exported
944 document by setting the default language and country either using
945 the application UI or through a custom styles file.
947 See `org-odt--build-date-styles' for implementation details."
954 \f
955 ;;; Internal functions
957 ;;;; Date
972 ;; LibreOffice does not care about end goes as content
973 ;; within the "<text:date>...</text:date>" field. The
974 ;; displayed date is automagically corrected to match the
975 ;; format requested by "style:data-style-name" attribute. So
976 ;; don't bother about formatting the date contents to be
977 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
978 ;; simple Org-style date should suffice.
1003 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1004 iso-date style date)
1006 repeater)))))
1008 ;;;; Frame
1016 extra
1022 style frame-attrs
1034 ;;;; Library wrappers
1041 ;; This is shamelessly stolen from `archive-zip-extract'.
1047 name)))
1052 exit-code command-output)
1060 members))
1062 ;;;; Target
1071 ;;;; Textbox
1074 extra anchor-type)
1080 text)
1081 width nil style extra anchor-type))
1085 ;;;; Table of Contents
1088 "Return a table of contents.
1089 TITLE is the title of the table, as a string, or nil. ENTRIES is
1090 the contents of the table, as a string. DEPTH is an integer
1091 specifying the depth of the table."
1093 "
1094 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1098 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1099 "
1100 title))
1106 "
1107 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1109 <text:index-entry-chapter/>
1110 <text:index-entry-text/>
1111 <text:index-entry-link-end/>
1114 "
1115 </text:table-of-content-source>
1116 <text:index-body>"
1122 title))
1123 entries
1124 "
1125 </text:index-body>
1133 ;; Section number.
1135 ;; Todo.
1140 style todo)))
1145 style priority)))
1146 ;; Title.
1147 text
1148 ;; Tags.
1152 "OrgTags"
1159 headline-label text))
1162 "Build a table of contents.
1163 DEPTH is an integer specifying the depth of the table. INFO is
1164 a plist containing current export properties. Optional argument
1165 SCOPE, when non-nil, defines the scope of the table. Return the
1166 table of contents as a string, or nil."
1168 ;; When a headline is marked as a radio target, as in the example below:
1169 ;;
1170 ;; ** <<<Some Heading>>>
1171 ;; Some text.
1172 ;;
1173 ;; suppress generation of radio targets. i.e., Radio targets are to
1174 ;; be marked as targets within /document body/ and *not* within
1175 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1176 ;; and one in the document body.
1177 ;;
1178 ;; FIXME: Are there any other objects that need to be suppressed
1179 ;; within TOC?
1196 style entry)))
1198 depth))))
1201 ;;;; Document styles
1204 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1205 OBJECT-PROPS is (typically) a plist created by passing
1207 `org-odt-parse-block-attributes'.
1209 Use `org-odt-object-counters' to generate an automatic
1210 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1211 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1212 . STYLE-NAME)."
1228 ;;;; Checkbox
1231 "Return check-box string associated to ITEM."
1240 ;;; Template
1243 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1244 ;; to modify the date fields. A date could be modified by
1245 ;; offsetting in days. That's about it. Also, date and time may
1246 ;; have to be emitted as two fields - a date field and a time field
1247 ;; - separately.
1249 ;; One can add Form Controls to date and time fields so that they
1250 ;; can be easily modified. But then, the exported document will
1251 ;; become tightly coupled with LibreOffice and may not function
1252 ;; properly with other OpenDocument applications.
1254 ;; I have a strange feeling that Date styles are a bit flaky at the
1255 ;; moment.
1257 ;; The feature is experimental.
1303 ))
1311 filler-end))
1322 style
1325 output ))))
1328 "Return complete document string after ODT conversion.
1329 CONTENTS is the transcoded contents string. RAW-DATA is the
1330 original parsed data. INFO is a plist holding export options."
1331 ;; Write meta file.
1342 <office:document-meta
1352 ;; Date, if required.
1354 ;; Check if DATE is specified as an Org-timestamp. If yes,
1355 ;; include it as meta information. Otherwise, just use
1356 ;; today's date.
1365 iso-date)))))
1374 subtitle))
1378 ;; Add meta.xml in to manifest.
1381 ;; Update styles file.
1382 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1383 ;; Write styles file.
1386 ;; Non-availability of styles.xml is not a critical
1387 ;; error. For now, throw an error.
1391 org-odt-styles-dir)
1404 members)))
1416 ;; create a manifest entry for styles.xml
1419 ;; FIXME: Who is opening an empty styles.xml before this point?
1424 ;; Write custom styles for source blocks
1425 ;; Save STYLES used for colorizing of source blocks.
1426 ;; Update styles.xml with styles that were collected as part of
1427 ;; `org-odt-hfy-face-to-css' callbacks.
1436 ;; Update styles.xml - take care of outline numbering
1438 ;; Don't make automatic backup of styles.xml file. This setting
1439 ;; prevents the backed-up styles.xml file from being zipped in to
1440 ;; odt file. This is more of a hackish fix. Better alternative
1441 ;; would be to fix the zip command so that the output odt file
1442 ;; includes only the needed files and excludes any auto-generated
1443 ;; extra files like backups and auto-saves etc etc. Note that
1444 ;; currently the zip command zips up the entire temp directory so
1445 ;; that any auto-generated files created under the hood ends up in
1446 ;; the resulting odt file.
1449 ;; Outline numbering is retained only upto LEVEL.
1450 ;; To disable outline numbering pass a LEVEL of 0.
1463 ;; Update content.xml.
1466 ;; within the context of the Org buffer. So obtain its
1467 ;; value before moving on to temp-buffer context down below.
1477 org-odt-styles-dir)))
1478 ;; Write automatic styles.
1479 ;; - Position the cursor.
1483 ;; - Dump automatic table styles.
1488 ;; - Dump date-styles.
1494 ;; Update display level.
1495 ;; - Remove existing sequence decls. Also position the cursor.
1500 ;; Update sequence decls according to user preference.
1511 ;; Position the cursor to document body.
1516 ;; Preamble - Title, Author, Date etc.
1526 ;; Switch on or off above vars based on user settings
1530 ;; Title.
1535 ;; Separator.
1537 ;; Subtitle.
1543 subtitle
1545 ;; Separator.
1549 ;; Author only.
1552 "OrgSubtitle"
1554 ;; Separator.
1557 ;; Author and E-mail.
1561 "OrgSubtitle"
1566 ;; Separator.
1568 ;; Date, if required.
1571 ;; Check if DATE is specified as a timestamp.
1578 "OrgSubtitle"
1582 ;; Separator
1584 ;; Table of Contents
1587 with-toc
1590 ;; Contents.
1592 ;; Return contents.
1596 \f
1597 ;;; Transcode Functions
1599 ;;;; Bold
1602 "Transcode BOLD from Org to ODT.
1603 CONTENTS is the text with bold markup. INFO is a plist holding
1604 contextual information."
1609 ;;;; Center Block
1612 "Transcode a CENTER-BLOCK element from Org to ODT.
1613 CONTENTS holds the contents of the center block. INFO is a plist
1614 holding contextual information."
1615 contents)
1618 ;;;; Clock
1621 "Transcode a CLOCK element from Org to ODT.
1622 CONTENTS is nil. INFO is a plist used as a communication
1623 channel."
1636 ;;;; Code
1639 "Transcode a CODE object from Org to ODT.
1640 CONTENTS is nil. INFO is a plist used as a communication
1641 channel."
1647 ;;;; Comment
1649 ;; Comments are ignored.
1652 ;;;; Comment Block
1654 ;; Comment Blocks are ignored.
1657 ;;;; Drawer
1660 "Transcode a DRAWER element from Org to ODT.
1661 CONTENTS holds the contents of the block. INFO is a plist
1662 holding contextual information."
1665 name contents)))
1666 output))
1669 ;;;; Dynamic Block
1672 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1673 CONTENTS holds the contents of the block. INFO is a plist
1674 holding contextual information. See `org-export-data'."
1675 contents)
1678 ;;;; Entity
1681 "Transcode an ENTITY object from Org to ODT.
1682 CONTENTS are the definition itself. INFO is a plist holding
1683 contextual information."
1687 ;;;; Example Block
1690 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1691 CONTENTS is nil. INFO is a plist holding contextual information."
1695 ;;;; Export Snippet
1698 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1699 CONTENTS is nil. INFO is a plist holding contextual information."
1704 ;;;; Export Block
1707 "Transcode a EXPORT-BLOCK element from Org to ODT.
1708 CONTENTS is nil. INFO is a plist holding contextual information."
1713 ;;;; Fixed Width
1716 "Transcode a FIXED-WIDTH element from Org to ODT.
1717 CONTENTS is nil. INFO is a plist holding contextual information."
1721 ;;;; Footnote Definition
1723 ;; Footnote Definitions are ignored.
1726 ;;;; Footnote Reference
1729 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1730 CONTENTS is nil. INFO is a plist holding contextual information."
1740 id note-class
1753 "OrgSuperscript"
1754 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1755 note-class ref-format ref-name n)))))))
1757 ;; Insert separator between two footnotes in a row.
1762 ;; Transcode footnote reference.
1770 footnote-reference info))
1774 raw
1777 :transcoders
1780 p c i
1781 "Footnote"
1782 "OrgFootnoteCenter"
1784 info))))
1785 ;; Inline definitions are secondary strings. We
1786 ;; need to wrap them within a paragraph.
1789 def
1795 ;;;; Headline
1798 &optional format-function
1800 "Transcode a HEADLINE element using BACKEND.
1801 INFO is a plist holding contextual information."
1824 &key level section-number headline-label
1827 todo todo-type priority text tags))))))
1829 todo todo-type priority text tags
1834 "Transcode a HEADLINE element from Org to ODT.
1835 CONTENTS holds the contents of the headline. INFO is a plist
1836 holding contextual information."
1837 ;; Case 1: This is a footnote section: ignore it.
1840 ;; Create the headline text.
1842 ;; Get level relative to current parsed data.
1845 ;; Get canonical label for the headline.
1847 ;; Extra targets.
1851 ;; Title.
1854 ;; Case 2. This is a deep sub-tree: export it as a list item.
1855 ;; Also export as items headlines for which no section
1856 ;; format has been found.
1858 ;; Build the real contents of the sub-tree.
1862 ;; Choose style based on list type.
1864 ;; If top-level list, re-start numbering. Otherwise,
1865 ;; continue numbering.
1868 headline)))
1878 "Text_20_body"
1880 contents)
1882 "</text:list-header>"
1886 ;; Case 3. Standard headline. Export it as a section.
1890 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1893 level
1896 contents))))))
1900 "Default format function for a headline.
1901 See `org-odt-format-headline-function' for details."
1903 ;; Todo.
1911 style priority)))
1912 ;; Title.
1913 text
1914 ;; Tags.
1917 "<text:tab/>"
1926 ;;;; Horizontal Rule
1929 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1930 CONTENTS is nil. INFO is a plist holding contextual information."
1935 ;;;; Inline Babel Call
1937 ;; Inline Babel Calls are ignored.
1940 ;;;; Inline Src Block
1943 "Return a character not used in string S.
1945 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1951 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1952 CONTENTS holds the contents of the item. INFO is a plist holding
1953 contextual information."
1960 ;;;; Inlinetask
1963 "Transcode an INLINETASK element from Org to ODT.
1964 CONTENTS holds the contents of the block. INFO is a plist
1965 holding contextual information."
1977 todo todo-type priority text tags contents)))
1981 "Default format function for a inlinetasks.
1982 See `org-odt-format-inlinetask-function' for details."
1984 "Text_20_body"
1988 "OrgInlineTaskHeading"
1990 todo todo-type priority name tags))
1991 contents)
1994 ;;;; Italic
1997 "Transcode ITALIC from Org to ODT.
1998 CONTENTS is the text with italic markup. INFO is a plist holding
1999 contextual information."
2004 ;;;; Item
2007 "Transcode an ITEM element from Org to ODT.
2008 CONTENTS holds the contents of the item. INFO is a plist holding
2009 contextual information."
2020 contents
2032 ;;;; Keyword
2035 "Transcode a KEYWORD element from Org to ODT.
2036 CONTENTS is nil. INFO is a plist holding contextual
2037 information."
2043 ;; FIXME
2055 ;; FIXME
2059 ;;;; Latex Environment
2062 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2063 ;; (defadvice org-format-latex-as-mathml ; FIXME
2064 ;; (after org-odt-protect-latex-fragment activate)
2065 ;; "Encode LaTeX fragment as XML.
2066 ;; Do this when translation to MathML fails."
2067 ;; (unless (> (length ad-return-value) 0)
2068 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2071 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2072 CONTENTS is nil. INFO is a plist holding contextual information."
2078 ;;;; Latex Fragment
2080 ;; (when latex-frag ; FIXME
2081 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2082 ;; :description latex-frag)))
2083 ;; handle verbatim
2084 ;; provide descriptions
2087 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2088 CONTENTS is nil. INFO is a plist holding contextual information."
2095 ;;;; Line Break
2098 "Transcode a LINE-BREAK object from Org to ODT.
2099 CONTENTS is nil. INFO is a plist holding contextual information."
2103 ;;;; Link
2105 ;;;; Links :: Label references
2116 x)))))
2127 counter))
2130 element
2132 info))
2136 ;; Section number.
2140 ;; Separator.
2142 ;; Ordinal.
2144 tag))
2147 "Return a label for ELEMENT.
2149 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2150 element. INFO is a plist used as a communication channel. OP is
2151 either `definition' or `reference', depending on the purpose of
2152 the generated string.
2154 Return value is a string if OP is set to `reference' or a cons
2155 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2156 SHORT-CAPTION are strings."
2162 ;; Get label and caption.
2168 ;; FIXME: We don't use short-caption for now
2184 element))))
2187 seqno)
2191 ;; Compute sequence number of the element.
2193 ;; Localize category string.
2196 ;; Case 1: Handle Label definition.
2200 ;; Sneak in a bookmark. The bookmark is used when the
2201 ;; labeled element is referenced with a link that
2202 ;; provides its own description.
2204 ;; Label definition: Typically formatted as below:
2205 ;; CATEGORY SEQ-NO: LONG CAPTION
2206 ;; with translation for correct punctuation.
2213 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2214 label counter counter seqno))
2216 short-caption))
2217 ;; Case 2: Handle Label reference.
2222 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2223 fmt1
2224 label
2229 ;;;; Links :: Inline Images
2232 "Returns the internal name of the file"
2248 target-file))
2271 ;; Use Imagemagick.
2276 file))))
2281 ;; Use Emacs.
2287 ;; Use hard-coded values.
2289 org-odt-default-image-sizes-alist))
2290 ;; Error out.
2303 ;; ensure that an embedded image fits comfortably within a page
2314 "Return ODT code for an inline image.
2315 LINK is the link pointing to the inline image. INFO is a plist
2316 used as a communication channel."
2329 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2331 ;; Extract attributes from #+ATTR_ODT line.
2335 ;; Convert attributes to a plist.
2337 ;; Handle `:anchor', `:style' and `:attributes' properties.
2347 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2348 ;;
2349 ;; Handle `:width', `:height' and `:scale' properties. Read
2350 ;; them as numbers since we need them for computations.
2352 src-expanded info
2359 nil ; embed-as
2361 ))
2368 ;; Check if this link was created by LaTeX-to-PNG converter.
2372 ;; If yes, note down the type of the element - LaTeX Fragment
2373 ;; or LaTeX environment. It will go in to frame title.
2377 ;; If yes, note down its contents. It will go in to frame
2378 ;; description. This quite useful for debugging.
2381 captions user-frame-params title desc)))
2384 ;;;; Links :: Math formula
2405 ;; Check if this link was created by LaTeX-to-MathML
2406 ;; converter.
2410 ;; If yes, note down the type of the element - LaTeX Fragment
2411 ;; or LaTeX environment. It will go in to frame title.
2415 ;; If yes, note down its contents. It will go in to frame
2416 ;; description. This quite useful for debugging.
2418 width height)
2422 nil nil title desc))
2425 "CaptionedDisplayFormula" href width height
2426 captions nil title desc))
2430 org-odt--enumerable-formula-p))))
2435 "Returns the internal name of the file"
2439 ;; Create a directory for holding formula file. Also enter it in
2440 ;; to manifest.
2444 ;; Copy over the formula file from user directory to zip
2445 ;; directory.
2449 ;; Case 1: Mathml.
2452 ;; Case 2: OpenDocument formula.
2457 ;; Enter the formula file in to manifest.
2459 target-file))
2461 ;;;; Targets
2464 captions user-frame-params
2467 ;; Each element of this alist is of the form (CFG-HANDLE
2468 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2470 ;; CFG-HANDLE is the key to the alist.
2472 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2473 ;; frame params for INNER-FRAME and OUTER-FRAME
2474 ;; respectively. See below.
2476 ;; Configurations that are meant to be applied to
2477 ;; non-captioned image/formula specifies no
2478 ;; OUTER-FRAME-PARAMS.
2480 ;; TERMINOLOGY
2481 ;; ===========
2482 ;; INNER-FRAME :: Frame that directly surrounds an
2483 ;; image/formula.
2485 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2486 ;; frame also contains the caption, if any.
2488 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2489 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2490 ;; that these are the last three arguments
2491 ;; to `org-odt--frame'.
2493 ;; Note that an un-captioned image/formula requires just an
2494 ;; INNER-FRAME, while a captioned image/formula requires
2495 ;; both an INNER and an OUTER-FRAME.
2517 ;; Retrieve inner and outer frame params, from configuration.
2521 ;; User-specified frame params (from #+ATTR_ODT spec)
2525 "Merge default and user frame params."
2530 for d in default
2533 ;; Case 1: Image/Formula has no caption.
2534 ;; There is only one frame, one that surrounds the image
2535 ;; or formula.
2537 ;; Merge user frame params with that from configuration.
2541 ;; Case 2: Image/Formula is captioned or labeled.
2542 ;; There are two frames: The inner one surrounds the
2543 ;; image or formula. The outer one contains the
2544 ;; caption/sequence number.
2546 ;; Merge user frame params with outer frame params.
2548 ;; Short caption, if specified, goes as part of inner frame.
2555 frame-params))
2558 "Illustration"
2562 caption))
2563 width height outer)))))
2566 ;; Element should have a caption or label.
2572 element info
2573 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2574 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2575 ;; processing.)
2580 ;; Link should point to an image file.
2587 element info
2588 ;; Paragraph should have a caption or label. It SHOULD also be a
2589 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2590 ;; processing.)
2595 ;; Link should point to an image file.
2602 element info
2603 ;; Paragraph should have a caption or label.
2607 ;; Link should point to a MathML or ODF file.
2613 paragraph-predicate
2614 link-predicate)
2615 "Test if ELEMENT is a standalone link for the purpose ODT export.
2616 INFO is a plist holding contextual information.
2618 Return non-nil, if ELEMENT is of type paragraph satisfying
2619 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2620 is a link that satisfies LINK-PREDICATE.
2622 Return non-nil, if ELEMENT is of type link satisfying
2623 LINK-PREDICATE and its containing paragraph satisfies
2624 PARAGRAPH-PREDICATE in addition to having no other content save for
2625 leading and trailing whitespaces.
2627 Return nil, otherwise."
2650 ;; DESTINATION is a headline or an element (like paragraph,
2651 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2653 ;; Note that labels that are attached to captioned entities - inline
2654 ;; images, math formulae and tables - get resolved as part of
2655 ;; `org-odt-format-label' and `org-odt--enumerate'.
2657 ;; Create a cross-reference to DESTINATION but make best-efforts to
2658 ;; create a *meaningful* description. Check item numbers, section
2659 ;; number and section title in that order.
2661 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2662 ;; FIXME: Handle footnote-definition footnote-reference?
2674 return x))
2675 ;; Get list item nos.
2680 plain-list)
2683 item info t))))))
2684 ;; Locate top-most listified headline.
2689 return x))
2690 ;; Get listified headline numbers.
2696 el info t)))))))
2697 ;; Combine item numbers from both the listified headlines and
2698 ;; regular list items.
2700 ;; Case 1: Check if all the parents of list item are numbered.
2701 ;; If yes, link to the item proper.
2704 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2705 label
2709 ;; Case 2: Locate a regular and numbered headline in the
2710 ;; hierarchy. Display its section number.
2713 ;; Test if destination is a numbered headline.
2719 return el))))
2720 ;; We found one.
2722 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2723 label
2726 ;; Case 4: Locate a regular headline in the hierarchy. Display
2727 ;; its title.
2731 return el)))
2732 ;; We found one.
2734 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2735 label
2741 "Transcode a LINK object from Org to ODT.
2743 DESC is the description part of the link, or the empty string.
2744 INFO is a plist holding contextual information. See
2745 `org-export-data'."
2748 ;; Ensure DESC really exists, or set it to nil.
2757 ;; Convert & to & for correct XML representation
2760 ;; Link type is handled by a special function.
2762 ;; Image file.
2766 ;; Formula file.
2770 ;; Radio target: Transcode target's contents and use them as
2771 ;; link's description.
2776 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2778 desc))))
2779 ;; Links pointing to a headline: Find destination and build
2780 ;; appropriate referencing command.
2786 ;; Case 1: Fuzzy link points nowhere.
2787 ('nil
2789 "Emphasis"
2792 info))))
2793 ;; Case 2: Fuzzy link points to a headline.
2795 ;; If there's a description, create a hyperlink.
2796 ;; Otherwise, try to provide a meaningful description.
2804 label desc))))
2805 ;; Case 3: Fuzzy link points to a target.
2807 ;; If there's a description, create a hyperlink.
2808 ;; Otherwise, try to provide a meaningful description.
2812 ;; Case 4: Fuzzy link points to some element (e.g., an
2813 ;; inline image, a math formula or a table).
2821 ;; LINK has no description. Create
2822 ;; a cross-reference showing entity's sequence
2823 ;; number.
2825 ;; LINK has description. Insert a hyperlink with
2826 ;; user-provided description.
2831 desc))))))))
2832 ;; Coderef: replace link with the reference name or the
2833 ;; equivalent line number.
2840 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2841 href line-no))))
2842 ;; External link with a description part.
2845 ;; Check if description is a link to an inline image.
2850 desc-element
2852 ;; Format link as a clickable image.
2854 path desc)
2855 ;; Otherwise, format it as a regular link.
2857 path desc))))
2858 ;; External link without a description part.
2861 path path))
2862 ;; No path, only description. Try to do something useful.
2867 ;;;; Node Property
2870 "Transcode a NODE-PROPERTY element from Org to ODT.
2871 CONTENTS is nil. INFO is a plist holding contextual
2872 information."
2879 ;;;; Paragraph
2882 "Return style of PARAGRAPH.
2883 Style is a symbol among `quoted', `centered' and nil."
2893 "Format paragraph according to given styles.
2894 PARAGRAPH is a paragraph type element. CONTENTS is the
2895 transcoded contents of that paragraph, as a string. INFO is
2896 a plist used as a communication channel. DEFAULT, CENTER and
2897 QUOTE are, respectively, style to use when paragraph belongs to
2898 no special environment, a center block, or a quote block."
2904 ;; If PARAGRAPH is a leading paragraph in an item that has
2905 ;; a checkbox, splice checkbox and paragraph contents
2906 ;; together.
2911 contents)))
2914 "Transcode a PARAGRAPH element from Org to ODT.
2915 CONTENTS is the contents of the paragraph, as a string. INFO is
2916 the plist used as a communication channel."
2918 paragraph contents info
2920 "OrgCenter"
2924 ;;;; Plain List
2927 "Transcode a PLAIN-LIST element from Org to ODT.
2928 CONTENTS is the contents of the list. INFO is a plist holding
2929 contextual information."
2931 ;; Choose style based on list type.
2937 ;; If top-level list, re-start numbering. Otherwise,
2938 ;; continue numbering.
2943 contents))
2945 ;;;; Plain Text
2958 line))
2969 "Transcode a TEXT string from Org to ODT.
2970 TEXT is the string to transcode. INFO is a plist holding
2971 contextual information."
2973 ;; Protect &, < and >.
2975 ;; Handle smart quotes. Be sure to provide original string since
2976 ;; OUTPUT may have been modified.
2979 ;; Convert special strings.
2985 org-odt-special-string-regexps))
2986 ;; Handle break preservation if required.
2990 ;; Return value.
2991 output))
2994 ;;;; Planning
2997 "Transcode a PLANNING element from Org to ODT.
2998 CONTENTS is nil. INFO is a plist used as a communication
2999 channel."
3001 "OrgPlanning"
3023 ;;;; Property Drawer
3026 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3027 CONTENTS holds the contents of the drawer. INFO is a plist
3028 holding contextual information."
3031 contents)))
3034 ;;;; Quote Block
3037 "Transcode a QUOTE-BLOCK element from Org to ODT.
3038 CONTENTS holds the contents of the block. INFO is a plist
3039 holding contextual information."
3040 contents)
3043 ;;;; Section
3048 style
3050 text)))
3054 "Transcode a SECTION element from Org to ODT.
3055 CONTENTS holds the contents of the section. INFO is a plist
3056 holding contextual information."
3057 contents)
3059 ;;;; Radio Target
3062 "Transcode a RADIO-TARGET object from Org to ODT.
3063 TEXT is the text of the target. INFO is a plist holding
3064 contextual information."
3068 ;;;; Special Block
3071 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3072 CONTENTS holds the contents of the block. INFO is a plist
3073 holding contextual information."
3077 ;; Annotation.
3083 ;; FIXME: Is `car' right thing to do below?
3093 contents)))))
3094 ;; Textbox.
3103 style extra anchor))))
3107 ;;;; Src Block
3110 "Create custom style for face FN.
3111 When FN is the default face, use its foreground and background
3113 use its color attribute to create a character style whose name
3114 is obtained from FN. Currently all attributes of FN other than
3115 color are ignored.
3117 The style name for a face FN is derived using the following
3118 operations on the face name in that order - de-dash, CamelCase
3120 `font-lock-function-name-face' is associated with
3134 background-color-val color-val))
3137 "
3185 code
3196 par-style loc))
3199 num-start refs))
3213 ;; Extract code and references.
3217 ;; Does the src block contain labels?
3219 ;; Does it have line numbers?
3226 "Transcode a SRC-BLOCK element from Org to ODT.
3227 CONTENTS holds the contents of the item. INFO is a plist holding
3228 contextual information."
3240 "Text_20_body"
3244 ;;;; Statistics Cookie
3247 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3248 CONTENTS is nil. INFO is a plist holding contextual information."
3254 ;;;; Strike-Through
3257 "Transcode STRIKE-THROUGH from Org to ODT.
3258 CONTENTS is the text with strike-through markup. INFO is a plist
3259 holding contextual information."
3264 ;;;; Subscript
3267 "Transcode a SUBSCRIPT object from Org to ODT.
3268 CONTENTS is the contents of the object. INFO is a plist holding
3269 contextual information."
3274 ;;;; Superscript
3277 "Transcode a SUPERSCRIPT object from Org to ODT.
3278 CONTENTS is the contents of the object. INFO is a plist holding
3279 contextual information."
3284 ;;;; Table Cell
3293 "Retrieve styles applicable to a table cell.
3294 R and C are (zero-based) row and column numbers of the table
3295 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3296 applicable to the current table. It is nil if the table is not
3297 associated with any style attributes.
3299 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3301 When STYLE-SPEC is nil, style the table cell the conventional way
3302 - choose cell borders based on row and column groupings and
3303 choose paragraph alignment based on `org-col-cookies' text
3304 property. See also
3305 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3307 When STYLE-SPEC is non-nil, ignore the above cookie and return
3308 styles congruent with the ODF-1.2 specification."
3314 info)))
3316 ;; LibreOffice - particularly the Writer - honors neither table
3317 ;; templates nor custom table-cell styles. Inorder to retain
3318 ;; inter-operability with LibreOffice, only automatic styles are
3319 ;; used for styling of table-cells. The current implementation is
3320 ;; congruent with ODF-1.2 specification and hence is
3321 ;; future-compatible.
3323 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3324 ;; which recognizes as many as 16 different cell types - is much
3325 ;; richer. Unfortunately it is NOT amenable to easy configuration
3326 ;; by hand.
3353 "Transcode a TABLE-CELL element from Org to ODT.
3354 CONTENTS is nil. INFO is a plist used as a communication
3355 channel."
3362 table-cell info))
3385 table-cell info))))))
3389 custom-style-prefix))
3391 "OrgTblCell"
3407 cell-attributes
3410 org-element-all-elements)
3411 contents
3413 paragraph-style contents))))
3420 ;;;; Table Row
3423 "Transcode a TABLE-ROW element from Org to ODT.
3424 CONTENTS is the contents of the row. INFO is a plist used as a
3425 communication channel."
3426 ;; Rules are ignored since table separators are deduced from
3427 ;; borders of the current row.
3433 ;; If the row belongs to the first rowgroup and the
3434 ;; table has more than one row groups, then this row
3435 ;; belongs to the header row group.
3437 ;; Otherwise, it belongs to non-header row group.
3440 ;; Does this row begin a rowgroup?
3443 ;; Actual table row
3445 ;; Does this row end a rowgroup?
3450 ;;;; Table
3463 "Transcode a TABLE element from Org to ODT.
3464 CONTENTS is the contents of the table. INFO is a plist holding
3465 contextual information."
3467 ;; Case 1: table.el doesn't support export to OD format. Strip
3468 ;; such tables from export.
3473 "(ox-odt): Found table.el-type table in the source Org file."
3474 " table.el doesn't support export to ODT format."
3476 ;; Case 2: Native Org tables.
3493 column-style))
3494 out)
3498 ;; caption.
3502 ;; begin table.
3510 ;; column specification.
3512 ;; actual contents.
3514 ;; end table.
3518 "Transcode a TABLE element from Org to ODT.
3519 CONTENTS is the contents of the table. INFO is a plist holding
3520 contextual information.
3522 Use `org-odt--table' to typeset the table. Handle details
3523 pertaining to indentation here."
3538 collect el)))
3544 collect
3549 parent-list)
3551 ;; Handle list genealogy.
3571 parent-list info)
3574 ;; Handle low-level headlines.
3576 with step = 'item collect
3584 el info)
3585 "OrgNumberedList"
3596 parent-list info)))
3604 table info)))
3605 ;; OpenDocument schema does not permit table to occur within a
3606 ;; list item.
3608 ;; One solution - the easiest and lightweight, in terms of
3609 ;; implementation - is to put the table in an indented text box
3610 ;; and make the text box part of the list-item. Unfortunately if
3611 ;; the table is big and spans multiple pages, the text box could
3612 ;; overflow. In this case, the following attribute will come
3613 ;; handy.
3615 ;; ,---- From OpenDocument-v1.1.pdf
3616 ;; | 15.27.28 Overflow behavior
3617 ;; |
3618 ;; | For text boxes contained within text document, the
3619 ;; | style:overflow-behavior property specifies the behavior of text
3620 ;; | boxes where the containing text does not fit into the text
3621 ;; | box.
3622 ;; |
3623 ;; | If the attribute's value is clip, the text that does not fit
3624 ;; | into the text box is not displayed.
3625 ;; |
3626 ;; | If the attribute value is auto-create-new-frame, a new frame
3627 ;; | will be created on the next page, with the same position and
3628 ;; | dimensions of the original frame.
3629 ;; |
3630 ;; | If the style:overflow-behavior property's value is
3631 ;; | auto-create-new-frame and the text box has a minimum width or
3632 ;; | height specified, then the text box will grow until the page
3633 ;; | bounds are reached before a new frame is created.
3634 ;; `----
3636 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3637 ;; auto-create-new-frame property and always resorts to clipping
3638 ;; the text box. This results in table being truncated.
3640 ;; So we solve the problem the hard (and fun) way using list
3641 ;; continuations.
3643 ;; The problem only becomes more interesting if you take in to
3644 ;; account the following facts:
3645 ;;
3646 ;; - Description lists are simulated as plain lists.
3647 ;; - Low-level headlines can be listified.
3648 ;; - In Org-mode, a table can occur not only as a regular list
3649 ;; item, but also within description lists and low-level
3650 ;; headlines.
3652 ;; See `org-odt-translate-description-lists' and
3653 ;; `org-odt-translate-low-level-headlines' for how this is
3654 ;; tackled.
3657 ;; Discontinue the list.
3659 ;; Put the table in an indented section.
3664 ;; Continue the list.
3668 ;;;; Target
3671 "Transcode a TARGET object from Org to ODT.
3672 CONTENTS is nil. INFO is a plist holding contextual
3673 information."
3677 ;;;; Timestamp
3680 "Transcode a TIMESTAMP object from Org to ODT.
3681 CONTENTS is nil. INFO is a plist used as a communication
3682 channel."
3699 "OrgActiveTimestamp"
3703 "OrgInactiveTimestamp"
3707 "OrgActiveTimestamp"
3713 "OrgInactiveTimestamp"
3719 "OrgDiaryTimestamp"
3721 info)))))))
3724 ;;;; Underline
3727 "Transcode UNDERLINE from Org to ODT.
3728 CONTENTS is the text with underline markup. INFO is a plist
3729 holding contextual information."
3734 ;;;; Verbatim
3737 "Transcode a VERBATIM object from Org to ODT.
3738 CONTENTS is nil. INFO is a plist used as a communication
3739 channel."
3745 ;;;; Verse Block
3748 "Transcode a VERSE-BLOCK element from Org to ODT.
3749 CONTENTS is verse block contents. INFO is a plist holding
3750 contextual information."
3751 ;; Add line breaks to each line of verse.
3755 ;; Replace tabs and spaces.
3757 ;; Surround it in a verse environment.
3762 \f
3763 ;;; Filters
3765 ;;;; LaTeX fragments
3770 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3771 ;; If the desired converter is not available, force verbatim
3772 ;; processing.
3790 ;; Store normalized value for later use.
3795 ;; Convert `latex-fragment's and `latex-environment's.
3814 ;; Get an Org-style link to PNG image or the MathML
3815 ;; file.
3820 nil display-msg
3821 nil processing-type)
3826 nil))))
3828 ;; Conversion succeeded. Parse above Org-style link to
3829 ;; a `link' object.
3836 ;; Case 1: LaTeX environment. Mimic
3837 ;; a "standalone image or formula" by
3838 ;; enclosing the `link' in a `paragraph'.
3839 ;; Copy over original attributes, captions to
3840 ;; the enclosing paragraph.
3845 :name
3847 :caption
3849 link))
3850 ;; Case 2: LaTeX fragment. No special action.
3852 ;; Note down the object that link replaces.
3856 ;; Restore blank after initial element or object.
3858 replacement :post-blank
3860 ;; Replace now.
3862 info nil nil t)))
3863 tree)
3866 ;;;; Description lists
3868 ;; This translator is necessary to handle indented tables in a uniform
3869 ;; manner. See comment in `org-odt--table'.
3872 ;; OpenDocument has no notion of a description list. So simulate it
3873 ;; using plain lists. Description lists in the exported document
3874 ;; are typeset in the same manner as they are in a typical HTML
3875 ;; document.
3876 ;;
3877 ;; Specifically, a description list like this:
3878 ;;
3879 ;; ,----
3880 ;; | - term-1 :: definition-1
3881 ;; | - term-2 :: definition-2
3882 ;; `----
3883 ;;
3884 ;; gets translated in to the following form:
3885 ;;
3886 ;; ,----
3887 ;; | - term-1
3888 ;; | - definition-1
3889 ;; | - term-2
3890 ;; | - definition-2
3891 ;; `----
3892 ;;
3893 ;; Further effect is achieved by fixing the OD styles as below:
3894 ;;
3895 ;; 1. Set the :type property of the simulated lists to
3896 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3897 ;; that has *no* bullets whatsoever.
3898 ;;
3899 ;; 2. The paragraph containing the definition term is styled to be
3900 ;; in bold.
3901 ;;
3906 el
3922 nil)
3923 info)
3924 tree)
3926 ;;;; List tables
3928 ;; Lists that are marked with attribute `:list-table' are called as
3929 ;; list tables. They will be rendered as a table within the exported
3930 ;; document.
3932 ;; Consider an example. The following list table
3933 ;;
3934 ;; #+attr_odt :list-table t
3935 ;; - Row 1
3936 ;; - 1.1
3937 ;; - 1.2
3938 ;; - 1.3
3939 ;; - Row 2
3940 ;; - 2.1
3941 ;; - 2.2
3942 ;; - 2.3
3943 ;;
3944 ;; will be exported as though it were an Org table like the one show
3945 ;; below.
3946 ;;
3947 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3948 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3949 ;;
3950 ;; Note that org-tables are NOT multi-line and each line is mapped to
3951 ;; a unique row in the exported document. So if an exported table
3952 ;; needs to contain a single paragraph (with copious text) it needs to
3953 ;; be typed up in a single line. Editing such long lines using the
3954 ;; table editor will be a cumbersome task. Furthermore inclusion of
3955 ;; multi-paragraph text in a table cell is well-nigh impossible.
3956 ;;
3957 ;; A LIST-TABLE circumvents above problems.
3958 ;;
3959 ;; Note that in the example above the list items could be paragraphs
3960 ;; themselves and the list can be arbitrarily deep.
3961 ;;
3962 ;; Inspired by following thread:
3963 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3965 ;; Translate lists to tables
3971 ;; Replace list with table.
3973 l1-list
3974 ;; Build replacement table.
3980 l1-item-leading-text l2-list)
3981 ;; Remove Level-2 list from the Level-item. It
3982 ;; will be subsequently attached as table-cells.
3992 ;; Level-1 items start a table row.
3995 ;; Leading text of level-1 item define
3996 ;; the first table-cell.
3999 l1-item-leading-text)
4000 ;; Level-2 items define subsequent
4001 ;; table-cells of the row.
4009 nil)
4010 info)
4011 tree)
4013 \f
4014 ;;; Interactive functions
4027 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4036 org-odt-manifest-file-entries)
4044 ;; Initialize temporary workarea. All files that end up in
4045 ;; the exported document get parked/created here.
4052 ;; Kill all XML buffers.
4060 org-odt-xml-files)
4061 ;; Delete temporary directory and also other embedded
4062 ;; files that get copied there.
4067 ;; Not at all OSes ship with zip by default
4069 ;; Do export. This creates a bunch of xml files ready to be
4070 ;; saved and zipped.
4072 ;; Create a manifest entry for content.xml.
4074 ;; Write mimetype file
4083 ;; Write out the manifest entries before zipping
4085 ;; Save all XML files.
4091 ;; Prettify output if needed.
4095 org-odt-xml-files)
4096 ;; Run zip.
4101 ;; If a file with same name as the desired output file
4102 ;; exists, remove it.
4105 ;; Zip up the xml files.
4108 ;; Switch temporarily to content.xml. This way Zip
4109 ;; process will inherit `org-odt-zip-dir' as the current
4110 ;; directory.
4124 err-string)))))
4125 cmds)))
4126 ;; Move the zip file from temporary work directory to
4127 ;; user-mandated location.
4130 ;; Cleanup work directory and work files.
4132 ;; Open the OpenDocument file in archive-mode for
4133 ;; examination.
4135 ;; Return exported file.
4137 ;; Case 1: Conversion desired on exported file. Run the
4138 ;; converter on the OpenDocument file. Return the
4139 ;; converted file.
4142 target))
4143 ;; Case 2: No further conversion. Return exported
4144 ;; OpenDocument file.
4147 ;; Cleanup work directory and work files.
4153 ;;;; Export to OpenDocument formula
4155 ;;;###autoload
4157 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4158 Use `org-create-math-formula' to convert LATEX-FRAG first to
4159 MathML. When invoked as an interactive command, use
4160 `org-latex-regexps' to infer LATEX-FRAG from currently active
4161 region. If no LaTeX fragments are found, prompt for it. Push
4162 MathML source to kill ring depending on the value of
4163 `org-export-copy-to-kill-ring'."
4189 filename
4202 ;; Add MathML to kill ring, if needed.
4206 ;;;###autoload
4208 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4209 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4210 formula file."
4215 ;;;; Export to OpenDocument Text
4217 ;;;###autoload
4219 "Export current buffer to a ODT file.
4221 If narrowing is active in the current buffer, only export its
4222 narrowed part.
4224 If a region is active, export that region.
4226 A non-nil optional argument ASYNC means the process should happen
4227 asynchronously. The resulting file should be accessible through
4228 the `org-export-stack' interface.
4230 When optional argument SUBTREEP is non-nil, export the sub-tree
4231 at point, extracting information from the headline properties
4232 first.
4234 When optional argument VISIBLE-ONLY is non-nil, don't export
4235 contents of hidden elements.
4237 EXT-PLIST, when provided, is a property list with external
4238 parameters overriding Org default settings, but still inferior to
4239 file-local settings.
4241 Return output file's name."
4248 ,outfile
4253 ;; Let `htmlfontify' know that we are interested in
4254 ;; collecting styles.
4256 ;; Initialize content.xml and kick-off the export
4257 ;; process.
4270 outfile
4275 ;; Let `htmlfontify' know that we are interested in collecting
4276 ;; styles.
4278 ;; Initialize content.xml and kick-off the export process.
4288 ;;;; Convert between OpenDocument and other formats
4291 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4300 "Workhorse routine for `org-odt-convert'."
4309 in-fmt out-fmt)))
4337 out-file)
4340 nil))))
4343 "Return verbose info about formats to which IN-FMT can be converted.
4344 Return a list where each element is of the
4345 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4346 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4347 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4351 org-odt-convert-processes t))))
4355 org-odt-convert-processes t))
4356 org-odt-convert-capabilities))
4357 reachable-formats)
4362 reachable-formats))
4365 "Return list of formats to which IN-FMT can be converted.
4366 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4372 l))
4375 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4376 This is a helper routine for interactive use."
4379 nil buffer-file-name t))
4385 out-fmt-choices nil nil nil))
4387 "No known converter or no known output formats for %s files"
4388 in-fmt))))
4391 ;;;###autoload
4393 "Convert IN-FILE to format OUT-FMT using a command line converter.
4394 IN-FILE is the file to be converted. If unspecified, it defaults
4395 to variable `buffer-file-name'. OUT-FMT is the desired output
4396 format. Use `org-odt-convert-process' as the converter.
4397 If PREFIX-ARG is non-nil then the newly converted file is opened
4398 using `org-open-file'."
4403 ;;; Library Initializations
4407 ;; Let Emacs open all OpenDocument files in archive mode
4410 org-odt-file-extensions)
4414 ;; Local variables:
4415 ;; generated-autoload-file: "org-loaddefs.el"
4416 ;; End:
4418 ;;; ox-odt.el ends here