| blob | 163f5804cdad8ba1bf142a6945b1630a9fd7b5f4 |
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
290 "Hardcoded image dimensions one for each of the anchor
293 ;; A4 page size is 21.0 by 29.7 cms
294 ;; The default page settings has 2cm margin on each of the sides. So
295 ;; the effective text area is 17.0 by 25.7 cm
304 "Specify how labels are applied and referenced.
306 This is an alist where each element is of the form:
308 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
310 ATTACH-FMT controls how labels and captions are attached to an
311 entity. It may contain following specifiers - %e and %c. %e is
312 replaced with the CATEGORY-NAME. %n is replaced with
314 with CAPTION.
316 REF-MODE and REF-FMT controls how label references are generated.
317 The following XML is generated for a label reference -
320 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
321 %n is replaced with SEQNO.
331 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
333 This is a list where each entry is of the form:
335 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
337 CATEGORY_HANDLE identifies the captionable entity in question.
339 OD-VARIABLE is the OpenDocument sequence counter associated with
340 the entity. These counters are declared within
342 `org-odt-content-template-file'.
344 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
345 how a given entity should be captioned and referenced.
347 CATEGORY-NAME is used for qualifying captions on export.
349 ENUMERATOR-PREDICATE is used for assigning a sequence number to
359 \f
360 ;;; User Configuration Variables
363 "Options for exporting Org mode files to ODT."
368 ;;;; Debugging
371 "Specify whether or not the xml output should be prettified.
372 When this option is turned on, `indent-region' is run on all
373 component xml buffers before they are saved. Turn this off for
374 regular use. Turn this on if you need to examine the xml
375 visually."
381 ;;;; Document schema
394 schema-dir))
397 schema-dir))
401 schema-dir)
403 org-odt-schema-dir-list)
405 nil)))
406 schema-dir)
407 "Directory that contains OpenDocument schema files.
409 This directory contains:
410 1. rnc files for OpenDocument schema
412 for auto validation of OpenDocument XML files.
414 Use the customize interface to set this variable. This ensures
415 that `rng-schema-locating-files' is updated and auto-validation
416 of OpenDocument XML takes place based on the value
417 `rng-nxml-auto-validate-flag'.
419 The default value of this variable varies depending on the
420 version of org in use and is initialized from
421 `org-odt-schema-dir-list'. The OASIS schema files are available
422 only in the org's private git repository. It is *not* bundled
423 with GNU ELPA tar or standard Emacs distribution."
429 :set
431 "Set `org-odt-schema-dir'.
432 Also add it to `rng-schema-locating-files'."
442 schema-dir
445 value))
446 nil)))
451 org-odt-schema-dir))))))
454 ;;;; Document styles
458 The exporter embeds the exported content just before
462 under `org-odt-styles-dir' is used."
469 "Default styles file for use with ODT export.
470 Valid values are one of:
471 1. nil
472 2. path to a styles.xml file
473 3. path to a *.odt or a *.ott file
474 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
475 ...))
477 In case of option 1, an in-built styles.xml is used. See
478 `org-odt-styles-dir' for more information.
480 In case of option 3, the specified file is unzipped and the
481 styles.xml embedded therein is used.
483 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
484 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
485 generated odt file. Use relative path for specifying the
486 FILE-MEMBERS. styles.xml must be specified as one of the
487 FILE-MEMBERS.
489 Use options 1, 2 or 3 only if styles.xml alone suffices for
490 achieving the desired formatting. Use option 4, if the styles.xml
491 references additional files like header and footer images for
492 achieving the desired formatting.
495 a per-file basis. For example,
501 :type
513 "Outline levels considered for enumerating captioned entities."
519 ;;;; Document conversion
526 "Specify a list of document converters and their usage.
527 The converters in this list are offered as choices while
528 customizing `org-odt-convert-process'.
530 This variable is a list where each element is of the
531 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
532 of the converter. CONVERTER-CMD is the shell command for the
533 converter and can contain format specifiers. These format
534 specifiers are interpreted as below:
536 %i input file name in full
537 %I input file name as a URL
538 %f format of the output file
539 %o output file name in full
540 %O output file name as a URL
541 %d output dir in full
542 %D output dir as a URL.
543 %x extra options as set in `org-odt-convert-capabilities'."
546 :type
555 During customization, the list of converter names are populated
556 from `org-odt-convert-processes'."
566 org-odt-convert-processes))))
584 "Specify input and output formats of `org-odt-convert-process'.
585 More correctly, specify the set of input and output formats that
586 the user is actually interested in.
588 This variable is an alist where each element is of the
589 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
590 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
591 alist where each element is of the form (OUTPUT-FMT
592 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
594 The variable is interpreted as follows:
595 `org-odt-convert-process' can take any document that is in
596 INPUT-FMT-LIST and produce any document that is in the
597 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
598 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
599 serves dual purposes:
600 - It is used for populating completion candidates during
601 `org-odt-convert' commands.
603 `org-odt-convert-process'.
606 `org-odt-convert-process'.
608 DOCUMENT-CLASS is used to group a set of file formats in
609 INPUT-FMT-LIST in to a single class.
611 Note that this variable inherently captures how LibreOffice based
612 converters work. LibreOffice maps documents of various formats
613 to classes like Text, Web, Spreadsheet, Presentation etc and
614 allow document of a given class (irrespective of its source
615 format) to be converted to any of the export formats associated
616 with that class.
618 See default setting of this variable for an typical
619 configuration."
622 :type
627 :value-type
631 :value-type
640 and then uses `org-odt-convert-process' to convert the
641 resulting document to this format. During customization of this
642 variable, the list of valid values are populated based on
643 `org-odt-convert-capabilities'.
645 You can set this option on per-file basis using file local
646 values. See Info node `(emacs) File Variables'."
657 ;;;###autoload
661 ;;;; Drawers
665 "Function called to format a drawer in ODT code.
667 The function must accept two parameters:
669 CONTENTS the contents of the drawer.
671 The function should return the string to be exported.
673 The default value simply returns the value of CONTENTS."
680 ;;;; Headline
683 'org-odt-format-headline-default-function
684 "Function to format headline text.
686 This function will be called with 5 arguments:
687 TODO the todo keyword \(string or nil\).
688 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
689 PRIORITY the priority of the headline \(integer or nil\)
690 TEXT the main headline text \(string\).
691 TAGS the tags string, separated with colons \(string or nil\).
693 The function result will be used as headline text."
700 ;;;; Inlinetasks
703 'org-odt-format-inlinetask-default-function
704 "Function called to format an inlinetask in ODT code.
706 The function must accept six parameters:
707 TODO the todo keyword, as a string
708 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
709 PRIORITY the inlinetask priority, as a string
710 NAME the inlinetask name, as a string.
711 TAGS the inlinetask tags, as a string.
712 CONTENTS the contents of the inlinetask, as a string.
714 The function should return the string to be exported."
721 ;;;; LaTeX
724 "Non-nil means process LaTeX math snippets.
726 When set, the exporter will process LaTeX environments and
727 fragments.
729 This option can also be set with the +OPTIONS line,
732 nil Ignore math snippets.
733 `verbatim' Keep everything in verbatim
734 `dvipng' Process the LaTeX fragments to images. This will also
735 include processing of non-math environments.
736 `imagemagick' Convert the LaTeX fragments to pdf files and use
737 imagemagick to convert pdf files to png files.
738 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
739 be loaded.
740 t Synonym for `mathjax'."
752 ;;;; Links
756 "Rules characterizing formula files that can be inlined into ODT.
758 A rule consists in an association whose key is the type of link
759 to consider, and value is a regexp that will be matched against
760 link's path."
769 "Rules characterizing image files that can be inlined into ODT.
771 A rule consists in an association whose key is the type of link
772 to consider, and value is a regexp that will be matched against
773 link's path."
781 "Scaling factor for converting images pixels to inches.
782 Use this for sizing of embedded images. See Info node `(org)
783 Images in ODT export' for more information."
790 ;;;; Src Block
793 "Whether custom styles for colorized source blocks be automatically created.
794 When this option is turned on, the exporter creates custom styles
795 for source blocks based on the advice of `htmlfontify'. Creation
796 of custom styles happen as part of `org-odt-hfy-face-to-css'.
798 When this option is turned off exporter does not create such
799 styles.
801 Use the latter option if you do not want the custom styles to be
802 based on your current display settings. It is necessary that the
803 styles.xml already contains needed styles for colorizing to work.
805 This variable is effective only if `org-odt-fontify-srcblocks' is
806 turned on."
812 "Specify whether or not source blocks need to be fontified.
813 Turn this option on if you want to colorize the source code
814 blocks in the exported file. For colorization to work, you need
815 to make available an enhanced version of `htmlfontify' library."
821 ;;;; Table
834 "Specify how Table Styles should be derived from a Table Template.
835 This is a list where each element is of the
836 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
838 TABLE-STYLE-NAME is the style associated with the table through
841 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
842 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
843 below) that is included in `org-odt-content-template-file'.
845 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
847 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
855 TABLE-CELL-OPTIONS is an alist where each element is of the
856 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
857 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
858 `use-last-row-styles' |
859 `use-first-column-styles' |
860 `use-last-column-styles' |
861 `use-banding-rows-styles' |
862 `use-banding-columns-styles' |
863 `use-first-row-styles'
864 ON-OR-OFF := `t' | `nil'
866 For example, with the following configuration
868 \(setq org-odt-table-styles
870 \(\(use-first-row-styles . t\)
871 \(use-first-column-styles . t\)\)\)
873 \(\(use-first-column-styles . t\)\)\)\)\)
876 style will use the following table-cell styles -
881 as appropriate.
884 use the following table-cell styles -
886 following paragraph styles
888 as appropriate..
890 Note that TABLE-TEMPLATE-NAME corresponds to the
893 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
896 specification for more information. Also consult the
897 implementation filed under `org-odt-get-table-cell-styles'.
900 formatting of numbered display equations. Do not delete this
901 style from the list."
911 use-last-row-styles
912 use-first-column-styles
913 use-last-column-styles
914 use-banding-rows-styles
915 use-banding-columns-styles)
916 :key-type symbol
919 ;;;; Timestamps
922 "Non-nil, if timestamps should be exported as date fields.
924 When nil, export timestamps as plain text.
926 When non-nil, map `org-time-stamp-custom-formats' to a pair of
928 respectively. A timestamp with no time component is formatted
932 This feature is experimental. Most (but not all) of the common
933 %-specifiers in `format-time-string' are supported.
935 formatted as canonical Org timestamps. For finer control, avoid
936 these %-specifiers.
939 etc., are displayed by the application in the default language
940 and country specified in `org-odt-styles-file'. Note that the
942 can localize the week day and month strings in the exported
943 document by setting the default language and country either using
944 the application UI or through a custom styles file.
946 See `org-odt--build-date-styles' for implementation details."
953 \f
954 ;;; Internal functions
956 ;;;; Date
971 ;; LibreOffice does not care about end goes as content
972 ;; within the "<text:date>...</text:date>" field. The
973 ;; displayed date is automagically corrected to match the
974 ;; format requested by "style:data-style-name" attribute. So
975 ;; don't bother about formatting the date contents to be
976 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
977 ;; simple Org-style date should suffice.
1002 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1003 iso-date style date)
1005 repeater)))))
1007 ;;;; Frame
1015 extra
1021 style frame-attrs
1033 ;;;; Library wrappers
1040 ;; This is shamelessly stolen from `archive-zip-extract'.
1046 name)))
1051 exit-code command-output)
1059 members))
1061 ;;;; Target
1070 ;;;; Textbox
1073 extra anchor-type)
1079 text)
1080 width nil style extra anchor-type))
1084 ;;;; Table of Contents
1087 "Return a table of contents.
1088 TITLE is the title of the table, as a string, or nil. ENTRIES is
1089 the contents of the table, as a string. DEPTH is an integer
1090 specifying the depth of the table."
1092 "
1093 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
1097 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1098 "
1099 title))
1105 "
1106 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1108 <text:index-entry-chapter/>
1109 <text:index-entry-text/>
1110 <text:index-entry-link-end/>
1113 "
1114 </text:table-of-content-source>
1115 <text:index-body>"
1121 title))
1122 entries
1123 "
1124 </text:index-body>
1132 ;; Section number.
1134 ;; Todo.
1139 style todo)))
1144 style priority)))
1145 ;; Title.
1146 text
1147 ;; Tags.
1151 "OrgTags"
1158 headline-label text))
1161 "Build a table of contents.
1162 DEPTH is an integer specifying the depth of the table. INFO is
1163 a plist containing current export properties. Optional argument
1164 SCOPE, when non-nil, defines the scope of the table. Return the
1165 table of contents as a string, or nil."
1167 ;; When a headline is marked as a radio target, as in the example below:
1168 ;;
1169 ;; ** <<<Some Heading>>>
1170 ;; Some text.
1171 ;;
1172 ;; suppress generation of radio targets. i.e., Radio targets are to
1173 ;; be marked as targets within /document body/ and *not* within
1174 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1175 ;; and one in the document body.
1176 ;;
1177 ;; FIXME: Are there any other objects that need to be suppressed
1178 ;; within TOC?
1195 style entry)))
1197 depth))))
1200 ;;;; Document styles
1203 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1204 OBJECT-PROPS is (typically) a plist created by passing
1206 `org-odt-parse-block-attributes'.
1208 Use `org-odt-object-counters' to generate an automatic
1209 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1210 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1211 . STYLE-NAME)."
1227 ;;;; Checkbox
1230 "Return check-box string associated to ITEM."
1239 ;;; Template
1242 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1243 ;; to modify the date fields. A date could be modified by
1244 ;; offsetting in days. That's about it. Also, date and time may
1245 ;; have to be emitted as two fields - a date field and a time field
1246 ;; - separately.
1248 ;; One can add Form Controls to date and time fields so that they
1249 ;; can be easily modified. But then, the exported document will
1250 ;; become tightly coupled with LibreOffice and may not function
1251 ;; properly with other OpenDocument applications.
1253 ;; I have a strange feeling that Date styles are a bit flaky at the
1254 ;; moment.
1256 ;; The feature is experimental.
1302 ))
1310 filler-end))
1321 style
1324 output ))))
1327 "Return complete document string after ODT conversion.
1328 CONTENTS is the transcoded contents string. RAW-DATA is the
1329 original parsed data. INFO is a plist holding export options."
1330 ;; Write meta file.
1341 <office:document-meta
1351 ;; Date, if required.
1353 ;; Check if DATE is specified as an Org-timestamp. If yes,
1354 ;; include it as meta information. Otherwise, just use
1355 ;; today's date.
1364 iso-date)))))
1373 subtitle))
1377 ;; Add meta.xml in to manifest.
1380 ;; Update styles file.
1381 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1382 ;; Write styles file.
1385 ;; Non-availability of styles.xml is not a critical
1386 ;; error. For now, throw an error.
1390 org-odt-styles-dir)
1403 members)))
1415 ;; create a manifest entry for styles.xml
1418 ;; FIXME: Who is opening an empty styles.xml before this point?
1423 ;; Write custom styles for source blocks
1424 ;; Save STYLES used for colorizing of source blocks.
1425 ;; Update styles.xml with styles that were collected as part of
1426 ;; `org-odt-hfy-face-to-css' callbacks.
1435 ;; Update styles.xml - take care of outline numbering
1437 ;; Don't make automatic backup of styles.xml file. This setting
1438 ;; prevents the backed-up styles.xml file from being zipped in to
1439 ;; odt file. This is more of a hackish fix. Better alternative
1440 ;; would be to fix the zip command so that the output odt file
1441 ;; includes only the needed files and excludes any auto-generated
1442 ;; extra files like backups and auto-saves etc etc. Note that
1443 ;; currently the zip command zips up the entire temp directory so
1444 ;; that any auto-generated files created under the hood ends up in
1445 ;; the resulting odt file.
1448 ;; Outline numbering is retained only upto LEVEL.
1449 ;; To disable outline numbering pass a LEVEL of 0.
1462 ;; Update content.xml.
1465 ;; within the context of the Org buffer. So obtain its
1466 ;; value before moving on to temp-buffer context down below.
1476 org-odt-styles-dir)))
1477 ;; Write automatic styles.
1478 ;; - Position the cursor.
1482 ;; - Dump automatic table styles.
1487 ;; - Dump date-styles.
1493 ;; Update display level.
1494 ;; - Remove existing sequence decls. Also position the cursor.
1499 ;; Update sequence decls according to user preference.
1510 ;; Position the cursor to document body.
1515 ;; Preamble - Title, Author, Date etc.
1525 ;; Switch on or off above vars based on user settings
1529 ;; Title.
1534 ;; Separator.
1536 ;; Subtitle.
1542 subtitle
1544 ;; Separator.
1548 ;; Author only.
1551 "OrgSubtitle"
1553 ;; Separator.
1556 ;; Author and E-mail.
1560 "OrgSubtitle"
1565 ;; Separator.
1567 ;; Date, if required.
1570 ;; Check if DATE is specified as a timestamp.
1577 "OrgSubtitle"
1581 ;; Separator
1583 ;; Table of Contents
1586 with-toc
1589 ;; Contents.
1591 ;; Return contents.
1595 \f
1596 ;;; Transcode Functions
1598 ;;;; Bold
1601 "Transcode BOLD from Org to ODT.
1602 CONTENTS is the text with bold markup. INFO is a plist holding
1603 contextual information."
1608 ;;;; Center Block
1611 "Transcode a CENTER-BLOCK element from Org to ODT.
1612 CONTENTS holds the contents of the center block. INFO is a plist
1613 holding contextual information."
1614 contents)
1617 ;;;; Clock
1620 "Transcode a CLOCK element from Org to ODT.
1621 CONTENTS is nil. INFO is a plist used as a communication
1622 channel."
1635 ;;;; Code
1638 "Transcode a CODE object from Org to ODT.
1639 CONTENTS is nil. INFO is a plist used as a communication
1640 channel."
1646 ;;;; Comment
1648 ;; Comments are ignored.
1651 ;;;; Comment Block
1653 ;; Comment Blocks are ignored.
1656 ;;;; Drawer
1659 "Transcode a DRAWER element from Org to ODT.
1660 CONTENTS holds the contents of the block. INFO is a plist
1661 holding contextual information."
1664 name contents)))
1665 output))
1668 ;;;; Dynamic Block
1671 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1672 CONTENTS holds the contents of the block. INFO is a plist
1673 holding contextual information. See `org-export-data'."
1674 contents)
1677 ;;;; Entity
1680 "Transcode an ENTITY object from Org to ODT.
1681 CONTENTS are the definition itself. INFO is a plist holding
1682 contextual information."
1686 ;;;; Example Block
1689 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1690 CONTENTS is nil. INFO is a plist holding contextual information."
1694 ;;;; Export Snippet
1697 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1698 CONTENTS is nil. INFO is a plist holding contextual information."
1703 ;;;; Export Block
1706 "Transcode a EXPORT-BLOCK element from Org to ODT.
1707 CONTENTS is nil. INFO is a plist holding contextual information."
1712 ;;;; Fixed Width
1715 "Transcode a FIXED-WIDTH element from Org to ODT.
1716 CONTENTS is nil. INFO is a plist holding contextual information."
1720 ;;;; Footnote Definition
1722 ;; Footnote Definitions are ignored.
1725 ;;;; Footnote Reference
1728 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1729 CONTENTS is nil. INFO is a plist holding contextual information."
1739 id note-class
1752 "OrgSuperscript"
1753 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1754 note-class ref-format ref-name n)))))))
1756 ;; Insert separator between two footnotes in a row.
1761 ;; Transcode footnote reference.
1767 ;; Inline definitions are secondary strings.
1768 ;; Non-inline footnotes definitions are full Org data.
1771 footnote-reference info))
1775 raw
1778 :transcoders
1781 p c i
1782 "Footnote"
1783 "OrgFootnoteCenter"
1785 info))))
1792 ;;;; Headline
1795 &optional format-function
1797 "Transcode a HEADLINE element using BACKEND.
1798 INFO is a plist holding contextual information."
1821 &key level section-number headline-label
1824 todo todo-type priority text tags))))))
1826 todo todo-type priority text tags
1831 "Transcode a HEADLINE element from Org to ODT.
1832 CONTENTS holds the contents of the headline. INFO is a plist
1833 holding contextual information."
1834 ;; Case 1: This is a footnote section: ignore it.
1837 ;; Create the headline text.
1839 ;; Get level relative to current parsed data.
1842 ;; Get canonical label for the headline.
1844 ;; Extra targets.
1848 ;; Title.
1851 ;; Case 2. This is a deep sub-tree: export it as a list item.
1852 ;; Also export as items headlines for which no section
1853 ;; format has been found.
1855 ;; Build the real contents of the sub-tree.
1859 ;; 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.
1887 "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
1890 level
1893 contents))))))
1897 "Default format function for a headline.
1898 See `org-odt-format-headline-function' for details."
1900 ;; Todo.
1908 style priority)))
1909 ;; Title.
1910 text
1911 ;; Tags.
1914 "<text:tab/>"
1923 ;;;; Horizontal Rule
1926 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1927 CONTENTS is nil. INFO is a plist holding contextual information."
1932 ;;;; Inline Babel Call
1934 ;; Inline Babel Calls are ignored.
1937 ;;;; Inline Src Block
1940 "Return a character not used in string S.
1942 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1948 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1949 CONTENTS holds the contents of the item. INFO is a plist holding
1950 contextual information."
1957 ;;;; Inlinetask
1960 "Transcode an INLINETASK element from Org to ODT.
1961 CONTENTS holds the contents of the block. INFO is a plist
1962 holding contextual information."
1974 todo todo-type priority text tags contents)))
1978 "Default format function for a inlinetasks.
1979 See `org-odt-format-inlinetask-function' for details."
1981 "Text_20_body"
1985 "OrgInlineTaskHeading"
1987 todo todo-type priority name tags))
1988 contents)
1991 ;;;; Italic
1994 "Transcode ITALIC from Org to ODT.
1995 CONTENTS is the text with italic markup. INFO is a plist holding
1996 contextual information."
2001 ;;;; Item
2004 "Transcode an ITEM element from Org to ODT.
2005 CONTENTS holds the contents of the item. INFO is a plist holding
2006 contextual information."
2017 contents
2029 ;;;; Keyword
2032 "Transcode a KEYWORD element from Org to ODT.
2033 CONTENTS is nil. INFO is a plist holding contextual
2034 information."
2040 ;; FIXME
2052 ;; FIXME
2056 ;;;; Latex Environment
2059 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2060 ;; (defadvice org-format-latex-as-mathml ; FIXME
2061 ;; (after org-odt-protect-latex-fragment activate)
2062 ;; "Encode LaTeX fragment as XML.
2063 ;; Do this when translation to MathML fails."
2064 ;; (unless (> (length ad-return-value) 0)
2065 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2068 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2069 CONTENTS is nil. INFO is a plist holding contextual information."
2075 ;;;; Latex Fragment
2077 ;; (when latex-frag ; FIXME
2078 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2079 ;; :description latex-frag)))
2080 ;; handle verbatim
2081 ;; provide descriptions
2084 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2085 CONTENTS is nil. INFO is a plist holding contextual information."
2092 ;;;; Line Break
2095 "Transcode a LINE-BREAK object from Org to ODT.
2096 CONTENTS is nil. INFO is a plist holding contextual information."
2100 ;;;; Link
2102 ;;;; Links :: Label references
2113 x)))))
2124 counter))
2127 element
2129 info))
2133 ;; Section number.
2137 ;; Separator.
2139 ;; Ordinal.
2141 tag))
2144 "Return a label for ELEMENT.
2146 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2147 element. INFO is a plist used as a communication channel. OP is
2148 either `definition' or `reference', depending on the purpose of
2149 the generated string.
2151 Return value is a string if OP is set to `reference' or a cons
2152 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2153 SHORT-CAPTION are strings."
2159 ;; Get label and caption.
2165 ;; FIXME: We don't use short-caption for now
2181 element))))
2184 seqno)
2188 ;; Compute sequence number of the element.
2190 ;; Localize category string.
2193 ;; Case 1: Handle Label definition.
2197 ;; Sneak in a bookmark. The bookmark is used when the
2198 ;; labeled element is referenced with a link that
2199 ;; provides its 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.
2219 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2220 fmt1
2221 label
2226 ;;;; Links :: Inline Images
2229 "Returns the internal name of the file"
2245 target-file))
2268 ;; Use Imagemagick.
2273 file))))
2278 ;; Use Emacs.
2284 ;; Use hard-coded values.
2286 org-odt-default-image-sizes-alist))
2287 ;; Error out.
2300 ;; ensure that an embedded image fits comfortably within a page
2311 "Return ODT code for an inline image.
2312 LINK is the link pointing to the inline image. INFO is a plist
2313 used as a communication channel."
2326 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2328 ;; Extract attributes from #+ATTR_ODT line.
2332 ;; Convert attributes to a plist.
2334 ;; Handle `:anchor', `:style' and `:attributes' properties.
2344 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2345 ;;
2346 ;; Handle `:width', `:height' and `:scale' properties. Read
2347 ;; them as numbers since we need them for computations.
2349 src-expanded info
2356 nil ; embed-as
2358 ))
2365 ;; Check if this link was created by LaTeX-to-PNG converter.
2369 ;; If yes, note down the type of the element - LaTeX Fragment
2370 ;; or LaTeX environment. It will go in to frame title.
2374 ;; If yes, note down its contents. It will go in to frame
2375 ;; description. This quite useful for debugging.
2378 captions user-frame-params title desc)))
2381 ;;;; Links :: Math formula
2402 ;; Check if this link was created by LaTeX-to-MathML
2403 ;; converter.
2407 ;; If yes, note down the type of the element - LaTeX Fragment
2408 ;; or LaTeX environment. It will go in to frame title.
2412 ;; If yes, note down its contents. It will go in to frame
2413 ;; description. This quite useful for debugging.
2415 width height)
2419 nil nil title desc))
2422 "CaptionedDisplayFormula" href width height
2423 captions nil title desc))
2427 org-odt--enumerable-formula-p))))
2432 "Returns the internal name of the file"
2436 ;; Create a directory for holding formula file. Also enter it in
2437 ;; to manifest.
2441 ;; Copy over the formula file from user directory to zip
2442 ;; directory.
2446 ;; Case 1: Mathml.
2449 ;; Case 2: OpenDocument formula.
2454 ;; Enter the formula file in to manifest.
2456 target-file))
2458 ;;;; Targets
2461 captions user-frame-params
2464 ;; Each element of this alist is of the form (CFG-HANDLE
2465 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2467 ;; CFG-HANDLE is the key to the alist.
2469 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2470 ;; frame params for INNER-FRAME and OUTER-FRAME
2471 ;; respectively. See below.
2473 ;; Configurations that are meant to be applied to
2474 ;; non-captioned image/formula specifies no
2475 ;; OUTER-FRAME-PARAMS.
2477 ;; TERMINOLOGY
2478 ;; ===========
2479 ;; INNER-FRAME :: Frame that directly surrounds an
2480 ;; image/formula.
2482 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2483 ;; frame also contains the caption, if any.
2485 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2486 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2487 ;; that these are the last three arguments
2488 ;; to `org-odt--frame'.
2490 ;; Note that an un-captioned image/formula requires just an
2491 ;; INNER-FRAME, while a captioned image/formula requires
2492 ;; both an INNER and an OUTER-FRAME.
2514 ;; Retrieve inner and outer frame params, from configuration.
2518 ;; User-specified frame params (from #+ATTR_ODT spec)
2522 "Merge default and user frame params."
2527 for d in default
2530 ;; Case 1: Image/Formula has no caption.
2531 ;; There is only one frame, one that surrounds the image
2532 ;; or formula.
2534 ;; Merge user frame params with that from configuration.
2538 ;; Case 2: Image/Formula is captioned or labeled.
2539 ;; There are two frames: The inner one surrounds the
2540 ;; image or formula. The outer one contains the
2541 ;; caption/sequence number.
2543 ;; Merge user frame params with outer frame params.
2545 ;; Short caption, if specified, goes as part of inner frame.
2552 frame-params))
2555 "Illustration"
2559 caption))
2560 width height outer)))))
2563 ;; Element should have a caption or label.
2569 element info
2570 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2571 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2572 ;; processing.)
2577 ;; Link should point to an image file.
2584 element info
2585 ;; Paragraph should have a caption or label. It SHOULD also be a
2586 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2587 ;; processing.)
2592 ;; Link should point to an image file.
2599 element info
2600 ;; Paragraph should have a caption or label.
2604 ;; Link should point to a MathML or ODF file.
2610 paragraph-predicate
2611 link-predicate)
2612 "Test if ELEMENT is a standalone link for the purpose ODT export.
2613 INFO is a plist holding contextual information.
2615 Return non-nil, if ELEMENT is of type paragraph satisfying
2616 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2617 is a link that satisfies LINK-PREDICATE.
2619 Return non-nil, if ELEMENT is of type link satisfying
2620 LINK-PREDICATE and its containing paragraph satisfies
2621 PARAGRAPH-PREDICATE in addition to having no other content save for
2622 leading and trailing whitespaces.
2624 Return nil, otherwise."
2647 ;; DESTINATION is a headline or an element (like paragraph,
2648 ;; verse-block etc) to which a "#+NAME: label" can be attached.
2650 ;; Note that labels that are attached to captioned entities - inline
2651 ;; images, math formulae and tables - get resolved as part of
2652 ;; `org-odt-format-label' and `org-odt--enumerate'.
2654 ;; Create a cross-reference to DESTINATION but make best-efforts to
2655 ;; create a *meaningful* description. Check item numbers, section
2656 ;; number and section title in that order.
2658 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2659 ;; FIXME: Handle footnote-definition footnote-reference?
2671 return x))
2672 ;; Get list item nos.
2677 plain-list)
2680 item info t))))))
2681 ;; Locate top-most listified headline.
2686 return x))
2687 ;; Get listified headline numbers.
2693 el info t)))))))
2694 ;; Combine item numbers from both the listified headlines and
2695 ;; regular list items.
2697 ;; Case 1: Check if all the parents of list item are numbered.
2698 ;; If yes, link to the item proper.
2701 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2702 label
2706 ;; Case 2: Locate a regular and numbered headline in the
2707 ;; hierarchy. Display its section number.
2710 ;; Test if destination is a numbered headline.
2716 return el))))
2717 ;; We found one.
2719 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2720 label
2723 ;; Case 4: Locate a regular headline in the hierarchy. Display
2724 ;; its title.
2728 return el)))
2729 ;; We found one.
2731 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2732 label
2738 "Transcode a LINK object from Org to ODT.
2740 DESC is the description part of the link, or the empty string.
2741 INFO is a plist holding contextual information. See
2742 `org-export-data'."
2745 ;; Ensure DESC really exists, or set it to nil.
2754 ;; Convert & to & for correct XML representation
2757 ;; Link type is handled by a special function.
2759 ;; Image file.
2763 ;; Formula file.
2767 ;; Radio target: Transcode target's contents and use them as
2768 ;; link's description.
2773 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2775 desc))))
2776 ;; Links pointing to a headline: Find destination and build
2777 ;; appropriate referencing command.
2783 ;; Case 1: Fuzzy link points nowhere.
2784 ('nil
2786 "Emphasis"
2789 info))))
2790 ;; Case 2: Fuzzy link points to a headline.
2792 ;; If there's a description, create a hyperlink.
2793 ;; Otherwise, try to provide a meaningful description.
2801 label desc))))
2802 ;; Case 3: Fuzzy link points to a target.
2804 ;; If there's a description, create a hyperlink.
2805 ;; Otherwise, try to provide a meaningful description.
2809 ;; Case 4: Fuzzy link points to some element (e.g., an
2810 ;; inline image, a math formula or a table).
2818 ;; LINK has no description. Create
2819 ;; a cross-reference showing entity's sequence
2820 ;; number.
2822 ;; LINK has description. Insert a hyperlink with
2823 ;; user-provided description.
2828 desc))))))))
2829 ;; Coderef: replace link with the reference name or the
2830 ;; equivalent line number.
2837 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2838 href line-no))))
2839 ;; External link with a description part.
2842 ;; Check if description is a link to an inline image.
2847 desc-element
2849 ;; Format link as a clickable image.
2851 path desc)
2852 ;; Otherwise, format it as a regular link.
2854 path desc))))
2855 ;; External link without a description part.
2858 path path))
2859 ;; No path, only description. Try to do something useful.
2864 ;;;; Node Property
2867 "Transcode a NODE-PROPERTY element from Org to ODT.
2868 CONTENTS is nil. INFO is a plist holding contextual
2869 information."
2876 ;;;; Paragraph
2879 "Return style of PARAGRAPH.
2880 Style is a symbol among `quoted', `centered' and nil."
2890 "Format paragraph according to given styles.
2891 PARAGRAPH is a paragraph type element. CONTENTS is the
2892 transcoded contents of that paragraph, as a string. INFO is
2893 a plist used as a communication channel. DEFAULT, CENTER and
2894 QUOTE are, respectively, style to use when paragraph belongs to
2895 no special environment, a center block, or a quote block."
2901 ;; If PARAGRAPH is a leading paragraph in an item that has
2902 ;; a checkbox, splice checkbox and paragraph contents
2903 ;; together.
2908 contents)))
2911 "Transcode a PARAGRAPH element from Org to ODT.
2912 CONTENTS is the contents of the paragraph, as a string. INFO is
2913 the plist used as a communication channel."
2915 paragraph contents info
2917 "OrgCenter"
2921 ;;;; Plain List
2924 "Transcode a PLAIN-LIST element from Org to ODT.
2925 CONTENTS is the contents of the list. INFO is a plist holding
2926 contextual information."
2928 ;; Choose style based on list type.
2934 ;; If top-level list, re-start numbering. Otherwise,
2935 ;; continue numbering.
2940 contents))
2942 ;;;; Plain Text
2955 line))
2966 "Transcode a TEXT string from Org to ODT.
2967 TEXT is the string to transcode. INFO is a plist holding
2968 contextual information."
2970 ;; Protect &, < and >.
2972 ;; Handle smart quotes. Be sure to provide original string since
2973 ;; OUTPUT may have been modified.
2976 ;; Convert special strings.
2982 org-odt-special-string-regexps))
2983 ;; Handle break preservation if required.
2987 ;; Return value.
2988 output))
2991 ;;;; Planning
2994 "Transcode a PLANNING element from Org to ODT.
2995 CONTENTS is nil. INFO is a plist used as a communication
2996 channel."
2998 "OrgPlanning"
3020 ;;;; Property Drawer
3023 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3024 CONTENTS holds the contents of the drawer. INFO is a plist
3025 holding contextual information."
3028 contents)))
3031 ;;;; Quote Block
3034 "Transcode a QUOTE-BLOCK element from Org to ODT.
3035 CONTENTS holds the contents of the block. INFO is a plist
3036 holding contextual information."
3037 contents)
3040 ;;;; Section
3045 style
3047 text)))
3051 "Transcode a SECTION element from Org to ODT.
3052 CONTENTS holds the contents of the section. INFO is a plist
3053 holding contextual information."
3054 contents)
3056 ;;;; Radio Target
3059 "Transcode a RADIO-TARGET object from Org to ODT.
3060 TEXT is the text of the target. INFO is a plist holding
3061 contextual information."
3065 ;;;; Special Block
3068 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3069 CONTENTS holds the contents of the block. INFO is a plist
3070 holding contextual information."
3074 ;; Annotation.
3080 ;; FIXME: Is `car' right thing to do below?
3090 contents)))))
3091 ;; Textbox.
3100 style extra anchor))))
3104 ;;;; Src Block
3107 "Create custom style for face FN.
3108 When FN is the default face, use its foreground and background
3110 use its color attribute to create a character style whose name
3111 is obtained from FN. Currently all attributes of FN other than
3112 color are ignored.
3114 The style name for a face FN is derived using the following
3115 operations on the face name in that order - de-dash, CamelCase
3117 `font-lock-function-name-face' is associated with
3131 background-color-val color-val))
3134 "
3182 code
3193 par-style loc))
3196 num-start refs))
3210 ;; Extract code and references.
3214 ;; Does the src block contain labels?
3216 ;; Does it have line numbers?
3223 "Transcode a SRC-BLOCK element from Org to ODT.
3224 CONTENTS holds the contents of the item. INFO is a plist holding
3225 contextual information."
3237 "Text_20_body"
3241 ;;;; Statistics Cookie
3244 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3245 CONTENTS is nil. INFO is a plist holding contextual information."
3251 ;;;; Strike-Through
3254 "Transcode STRIKE-THROUGH from Org to ODT.
3255 CONTENTS is the text with strike-through markup. INFO is a plist
3256 holding contextual information."
3261 ;;;; Subscript
3264 "Transcode a SUBSCRIPT object from Org to ODT.
3265 CONTENTS is the contents of the object. INFO is a plist holding
3266 contextual information."
3271 ;;;; Superscript
3274 "Transcode a SUPERSCRIPT object from Org to ODT.
3275 CONTENTS is the contents of the object. INFO is a plist holding
3276 contextual information."
3281 ;;;; Table Cell
3290 "Retrieve styles applicable to a table cell.
3291 R and C are (zero-based) row and column numbers of the table
3292 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3293 applicable to the current table. It is nil if the table is not
3294 associated with any style attributes.
3296 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3298 When STYLE-SPEC is nil, style the table cell the conventional way
3299 - choose cell borders based on row and column groupings and
3300 choose paragraph alignment based on `org-col-cookies' text
3301 property. See also
3302 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3304 When STYLE-SPEC is non-nil, ignore the above cookie and return
3305 styles congruent with the ODF-1.2 specification."
3311 info)))
3313 ;; LibreOffice - particularly the Writer - honors neither table
3314 ;; templates nor custom table-cell styles. Inorder to retain
3315 ;; inter-operability with LibreOffice, only automatic styles are
3316 ;; used for styling of table-cells. The current implementation is
3317 ;; congruent with ODF-1.2 specification and hence is
3318 ;; future-compatible.
3320 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3321 ;; which recognizes as many as 16 different cell types - is much
3322 ;; richer. Unfortunately it is NOT amenable to easy configuration
3323 ;; by hand.
3350 "Transcode a TABLE-CELL element from Org to ODT.
3351 CONTENTS is nil. INFO is a plist used as a communication
3352 channel."
3359 table-cell info))
3382 table-cell info))))))
3386 custom-style-prefix))
3388 "OrgTblCell"
3404 cell-attributes
3407 org-element-all-elements)
3408 contents
3410 paragraph-style contents))))
3417 ;;;; Table Row
3420 "Transcode a TABLE-ROW element from Org to ODT.
3421 CONTENTS is the contents of the row. INFO is a plist used as a
3422 communication channel."
3423 ;; Rules are ignored since table separators are deduced from
3424 ;; borders of the current row.
3430 ;; If the row belongs to the first rowgroup and the
3431 ;; table has more than one row groups, then this row
3432 ;; belongs to the header row group.
3434 ;; Otherwise, it belongs to non-header row group.
3437 ;; Does this row begin a rowgroup?
3440 ;; Actual table row
3442 ;; Does this row end a rowgroup?
3447 ;;;; Table
3460 "Transcode a TABLE element from Org to ODT.
3461 CONTENTS is the contents of the table. INFO is a plist holding
3462 contextual information."
3464 ;; Case 1: table.el doesn't support export to OD format. Strip
3465 ;; such tables from export.
3470 "(ox-odt): Found table.el-type table in the source Org file."
3471 " table.el doesn't support export to ODT format."
3473 ;; Case 2: Native Org tables.
3490 column-style))
3491 out)
3495 ;; caption.
3499 ;; begin table.
3507 ;; column specification.
3509 ;; actual contents.
3511 ;; end table.
3515 "Transcode a TABLE element from Org to ODT.
3516 CONTENTS is the contents of the table. INFO is a plist holding
3517 contextual information.
3519 Use `org-odt--table' to typeset the table. Handle details
3520 pertaining to indentation here."
3535 collect el)))
3541 collect
3546 parent-list)
3548 ;; Handle list genealogy.
3568 parent-list info)
3571 ;; Handle low-level headlines.
3573 with step = 'item collect
3581 el info)
3582 "OrgNumberedList"
3593 parent-list info)))
3601 table info)))
3602 ;; OpenDocument schema does not permit table to occur within a
3603 ;; list item.
3605 ;; One solution - the easiest and lightweight, in terms of
3606 ;; implementation - is to put the table in an indented text box
3607 ;; and make the text box part of the list-item. Unfortunately if
3608 ;; the table is big and spans multiple pages, the text box could
3609 ;; overflow. In this case, the following attribute will come
3610 ;; handy.
3612 ;; ,---- From OpenDocument-v1.1.pdf
3613 ;; | 15.27.28 Overflow behavior
3614 ;; |
3615 ;; | For text boxes contained within text document, the
3616 ;; | style:overflow-behavior property specifies the behavior of text
3617 ;; | boxes where the containing text does not fit into the text
3618 ;; | box.
3619 ;; |
3620 ;; | If the attribute's value is clip, the text that does not fit
3621 ;; | into the text box is not displayed.
3622 ;; |
3623 ;; | If the attribute value is auto-create-new-frame, a new frame
3624 ;; | will be created on the next page, with the same position and
3625 ;; | dimensions of the original frame.
3626 ;; |
3627 ;; | If the style:overflow-behavior property's value is
3628 ;; | auto-create-new-frame and the text box has a minimum width or
3629 ;; | height specified, then the text box will grow until the page
3630 ;; | bounds are reached before a new frame is created.
3631 ;; `----
3633 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3634 ;; auto-create-new-frame property and always resorts to clipping
3635 ;; the text box. This results in table being truncated.
3637 ;; So we solve the problem the hard (and fun) way using list
3638 ;; continuations.
3640 ;; The problem only becomes more interesting if you take in to
3641 ;; account the following facts:
3642 ;;
3643 ;; - Description lists are simulated as plain lists.
3644 ;; - Low-level headlines can be listified.
3645 ;; - In Org-mode, a table can occur not only as a regular list
3646 ;; item, but also within description lists and low-level
3647 ;; headlines.
3649 ;; See `org-odt-translate-description-lists' and
3650 ;; `org-odt-translate-low-level-headlines' for how this is
3651 ;; tackled.
3654 ;; Discontinue the list.
3656 ;; Put the table in an indented section.
3661 ;; Continue the list.
3665 ;;;; Target
3668 "Transcode a TARGET object from Org to ODT.
3669 CONTENTS is nil. INFO is a plist holding contextual
3670 information."
3674 ;;;; Timestamp
3677 "Transcode a TIMESTAMP object from Org to ODT.
3678 CONTENTS is nil. INFO is a plist used as a communication
3679 channel."
3696 "OrgActiveTimestamp"
3700 "OrgInactiveTimestamp"
3704 "OrgActiveTimestamp"
3710 "OrgInactiveTimestamp"
3716 "OrgDiaryTimestamp"
3718 info)))))))
3721 ;;;; Underline
3724 "Transcode UNDERLINE from Org to ODT.
3725 CONTENTS is the text with underline markup. INFO is a plist
3726 holding contextual information."
3731 ;;;; Verbatim
3734 "Transcode a VERBATIM object from Org to ODT.
3735 CONTENTS is nil. INFO is a plist used as a communication
3736 channel."
3742 ;;;; Verse Block
3745 "Transcode a VERSE-BLOCK element from Org to ODT.
3746 CONTENTS is verse block contents. INFO is a plist holding
3747 contextual information."
3748 ;; Add line breaks to each line of verse.
3752 ;; Replace tabs and spaces.
3754 ;; Surround it in a verse environment.
3759 \f
3760 ;;; Filters
3762 ;;;; LaTeX fragments
3767 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3768 ;; If the desired converter is not available, force verbatim
3769 ;; processing.
3787 ;; Store normalized value for later use.
3792 ;; Convert `latex-fragment's and `latex-environment's.
3811 ;; Get an Org-style link to PNG image or the MathML
3812 ;; file.
3817 nil display-msg
3818 nil processing-type)
3823 nil))))
3825 ;; Conversion succeeded. Parse above Org-style link to
3826 ;; a `link' object.
3833 ;; Case 1: LaTeX environment. Mimic
3834 ;; a "standalone image or formula" by
3835 ;; enclosing the `link' in a `paragraph'.
3836 ;; Copy over original attributes, captions to
3837 ;; the enclosing paragraph.
3842 :name
3844 :caption
3846 link))
3847 ;; Case 2: LaTeX fragment. No special action.
3849 ;; Note down the object that link replaces.
3853 ;; Restore blank after initial element or object.
3855 replacement :post-blank
3857 ;; Replace now.
3859 info nil nil t)))
3860 tree)
3863 ;;;; Description lists
3865 ;; This translator is necessary to handle indented tables in a uniform
3866 ;; manner. See comment in `org-odt--table'.
3869 ;; OpenDocument has no notion of a description list. So simulate it
3870 ;; using plain lists. Description lists in the exported document
3871 ;; are typeset in the same manner as they are in a typical HTML
3872 ;; document.
3873 ;;
3874 ;; Specifically, a description list like this:
3875 ;;
3876 ;; ,----
3877 ;; | - term-1 :: definition-1
3878 ;; | - term-2 :: definition-2
3879 ;; `----
3880 ;;
3881 ;; gets translated in to the following form:
3882 ;;
3883 ;; ,----
3884 ;; | - term-1
3885 ;; | - definition-1
3886 ;; | - term-2
3887 ;; | - definition-2
3888 ;; `----
3889 ;;
3890 ;; Further effect is achieved by fixing the OD styles as below:
3891 ;;
3892 ;; 1. Set the :type property of the simulated lists to
3893 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3894 ;; that has *no* bullets whatsoever.
3895 ;;
3896 ;; 2. The paragraph containing the definition term is styled to be
3897 ;; in bold.
3898 ;;
3903 el
3919 nil)
3920 info)
3921 tree)
3923 ;;;; List tables
3925 ;; Lists that are marked with attribute `:list-table' are called as
3926 ;; list tables. They will be rendered as a table within the exported
3927 ;; document.
3929 ;; Consider an example. The following list table
3930 ;;
3931 ;; #+attr_odt :list-table t
3932 ;; - Row 1
3933 ;; - 1.1
3934 ;; - 1.2
3935 ;; - 1.3
3936 ;; - Row 2
3937 ;; - 2.1
3938 ;; - 2.2
3939 ;; - 2.3
3940 ;;
3941 ;; will be exported as though it were an Org table like the one show
3942 ;; below.
3943 ;;
3944 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3945 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3946 ;;
3947 ;; Note that org-tables are NOT multi-line and each line is mapped to
3948 ;; a unique row in the exported document. So if an exported table
3949 ;; needs to contain a single paragraph (with copious text) it needs to
3950 ;; be typed up in a single line. Editing such long lines using the
3951 ;; table editor will be a cumbersome task. Furthermore inclusion of
3952 ;; multi-paragraph text in a table cell is well-nigh impossible.
3953 ;;
3954 ;; A LIST-TABLE circumvents above problems.
3955 ;;
3956 ;; Note that in the example above the list items could be paragraphs
3957 ;; themselves and the list can be arbitrarily deep.
3958 ;;
3959 ;; Inspired by following thread:
3960 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3962 ;; Translate lists to tables
3968 ;; Replace list with table.
3970 l1-list
3971 ;; Build replacement table.
3977 l1-item-leading-text l2-list)
3978 ;; Remove Level-2 list from the Level-item. It
3979 ;; will be subsequently attached as table-cells.
3989 ;; Level-1 items start a table row.
3992 ;; Leading text of level-1 item define
3993 ;; the first table-cell.
3996 l1-item-leading-text)
3997 ;; Level-2 items define subsequent
3998 ;; table-cells of the row.
4006 nil)
4007 info)
4008 tree)
4010 \f
4011 ;;; Interactive functions
4024 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4033 org-odt-manifest-file-entries)
4041 ;; Initialize temporary workarea. All files that end up in
4042 ;; the exported document get parked/created here.
4049 ;; Kill all XML buffers.
4057 org-odt-xml-files)
4058 ;; Delete temporary directory and also other embedded
4059 ;; files that get copied there.
4064 ;; Not at all OSes ship with zip by default
4066 ;; Do export. This creates a bunch of xml files ready to be
4067 ;; saved and zipped.
4069 ;; Create a manifest entry for content.xml.
4071 ;; Write mimetype file
4080 ;; Write out the manifest entries before zipping
4082 ;; Save all XML files.
4088 ;; Prettify output if needed.
4092 org-odt-xml-files)
4093 ;; Run zip.
4098 ;; If a file with same name as the desired output file
4099 ;; exists, remove it.
4102 ;; Zip up the xml files.
4105 ;; Switch temporarily to content.xml. This way Zip
4106 ;; process will inherit `org-odt-zip-dir' as the current
4107 ;; directory.
4121 err-string)))))
4122 cmds)))
4123 ;; Move the zip file from temporary work directory to
4124 ;; user-mandated location.
4127 ;; Cleanup work directory and work files.
4129 ;; Open the OpenDocument file in archive-mode for
4130 ;; examination.
4132 ;; Return exported file.
4134 ;; Case 1: Conversion desired on exported file. Run the
4135 ;; converter on the OpenDocument file. Return the
4136 ;; converted file.
4139 target))
4140 ;; Case 2: No further conversion. Return exported
4141 ;; OpenDocument file.
4144 ;; Cleanup work directory and work files.
4150 ;;;; Export to OpenDocument formula
4152 ;;;###autoload
4154 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4155 Use `org-create-math-formula' to convert LATEX-FRAG first to
4156 MathML. When invoked as an interactive command, use
4157 `org-latex-regexps' to infer LATEX-FRAG from currently active
4158 region. If no LaTeX fragments are found, prompt for it. Push
4159 MathML source to kill ring depending on the value of
4160 `org-export-copy-to-kill-ring'."
4186 filename
4199 ;; Add MathML to kill ring, if needed.
4203 ;;;###autoload
4205 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4206 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4207 formula file."
4212 ;;;; Export to OpenDocument Text
4214 ;;;###autoload
4216 "Export current buffer to a ODT file.
4218 If narrowing is active in the current buffer, only export its
4219 narrowed part.
4221 If a region is active, export that region.
4223 A non-nil optional argument ASYNC means the process should happen
4224 asynchronously. The resulting file should be accessible through
4225 the `org-export-stack' interface.
4227 When optional argument SUBTREEP is non-nil, export the sub-tree
4228 at point, extracting information from the headline properties
4229 first.
4231 When optional argument VISIBLE-ONLY is non-nil, don't export
4232 contents of hidden elements.
4234 EXT-PLIST, when provided, is a property list with external
4235 parameters overriding Org default settings, but still inferior to
4236 file-local settings.
4238 Return output file's name."
4245 ,outfile
4250 ;; Let `htmlfontify' know that we are interested in
4251 ;; collecting styles.
4253 ;; Initialize content.xml and kick-off the export
4254 ;; process.
4267 outfile
4272 ;; Let `htmlfontify' know that we are interested in collecting
4273 ;; styles.
4275 ;; Initialize content.xml and kick-off the export process.
4285 ;;;; Convert between OpenDocument and other formats
4288 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4297 "Workhorse routine for `org-odt-convert'."
4306 in-fmt out-fmt)))
4334 out-file)
4337 nil))))
4340 "Return verbose info about formats to which IN-FMT can be converted.
4341 Return a list where each element is of the
4342 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4343 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4344 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4348 org-odt-convert-processes t))))
4352 org-odt-convert-processes t))
4353 org-odt-convert-capabilities))
4354 reachable-formats)
4359 reachable-formats))
4362 "Return list of formats to which IN-FMT can be converted.
4363 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4369 l))
4372 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4373 This is a helper routine for interactive use."
4376 nil buffer-file-name t))
4382 out-fmt-choices nil nil nil))
4384 "No known converter or no known output formats for %s files"
4385 in-fmt))))
4388 ;;;###autoload
4390 "Convert IN-FILE to format OUT-FMT using a command line converter.
4391 IN-FILE is the file to be converted. If unspecified, it defaults
4392 to variable `buffer-file-name'. OUT-FMT is the desired output
4393 format. Use `org-odt-convert-process' as the converter.
4394 If PREFIX-ARG is non-nil then the newly converted file is opened
4395 using `org-open-file'."
4400 ;;; Library Initializations
4404 ;; Let Emacs open all OpenDocument files in archive mode
4407 org-odt-file-extensions)
4411 ;; Local variables:
4412 ;; generated-autoload-file: "org-loaddefs.el"
4413 ;; End:
4415 ;;; ox-odt.el ends here