| blob | 99c1353ce803f4d9efda390e0d17df93a5efb41f |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
89 org-odt--translate-description-lists
90 org-odt--translate-list-tables)))
91 :menu-entry
98 :options-alist
100 ;; Redefine regular option.
104 ;;; Dependencies
106 ;;; Hooks
108 ;;; Function Declarations
118 \f
119 ;;; Internal Variables
123 "Location of ODT exporter.
124 Use this to infer values of `org-odt-styles-dir' and
129 "Data directory for ODT exporter.
130 Use this to infer values of `org-odt-styles-dir' and
147 "List of directories to search for OpenDocument schema files.
148 Use this list to set the default value of
149 `org-odt-schema-dir'. The entries in this list are
150 populated heuristically based on the values of `org-odt-lib-dir'
163 )
164 "List of directories to search for OpenDocument styles files.
165 See `org-odt-styles-dir'. The entries in this list are populated
166 heuristically based on the values of `org-odt-lib-dir' and
183 styles-dir)
185 org-odt-styles-dir-list)
186 nil)))
189 styles-dir)
190 "Directory that holds auxiliary XML files used by the ODT exporter.
192 This directory contains the following XML files -
194 XML files are used as the default values of
195 `org-odt-styles-file' and
196 `org-odt-content-template-file'.
198 The default value of this variable varies depending on the
199 version of org in use and is initialized from
200 `org-odt-styles-dir-list'. Note that the user could be using org
201 from one of: org's own private git repository, GNU ELPA tar or
224 "
226 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
227 </style:style>
228 "
232 "Registry of automatic styles for various OBJECT-TYPEs.
233 The variable has the following form:
234 \(\(OBJECT-TYPE-A
235 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
236 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
237 \(OBJECT-TYPE-B
238 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
239 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
240 ...\).
243 OBJECT-PROPS is (typically) a plist created by passing
249 "Running counters for various OBJECT-TYPEs.
250 Use this to generate automatic names and style-names. See
254 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
255 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
256 <style:background-image/>
257 </style:paragraph-properties>
259 </style:style>"
260 "Custom paragraph style for colorized source and example blocks.
262 except that the foreground and background colors are set
276 "Hardcoded image dimensions one for each of the anchor
279 ;; A4 page size is 21.0 by 29.7 cms
280 ;; The default page settings has 2cm margin on each of the sides. So
281 ;; the effective text area is 17.0 by 25.7 cm
290 "Specify how labels are applied and referenced.
292 This is an alist where each element is of the form:
294 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
296 ATTACH-FMT controls how labels and captions are attached to an
297 entity. It may contain following specifiers - %e and %c. %e is
298 replaced with the CATEGORY-NAME. %n is replaced with
300 with CAPTION.
302 REF-MODE and REF-FMT controls how label references are generated.
303 The following XML is generated for a label reference -
306 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
307 %n is replaced with SEQNO.
317 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
319 This is a list where each entry is of the form:
321 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
323 CATEGORY_HANDLE identifies the captionable entity in question.
325 OD-VARIABLE is the OpenDocument sequence counter associated with
326 the entity. These counters are declared within
328 `org-odt-content-template-file'.
330 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
331 how a given entity should be captioned and referenced.
333 CATEGORY-NAME is used for qualifying captions on export.
335 ENUMERATOR-PREDICATE is used for assigning a sequence number to
345 \f
346 ;;; User Configuration Variables
349 "Options for exporting Org mode files to ODT."
354 ;;;; Debugging
357 "Specify whether or not the xml output should be prettified.
358 When this option is turned on, `indent-region' is run on all
359 component xml buffers before they are saved. Turn this off for
360 regular use. Turn this on if you need to examine the xml
361 visually."
367 ;;;; Document schema
380 schema-dir))
383 schema-dir))
387 schema-dir)
389 org-odt-schema-dir-list)
391 nil)))
392 schema-dir)
393 "Directory that contains OpenDocument schema files.
395 This directory contains:
396 1. rnc files for OpenDocument schema
398 for auto validation of OpenDocument XML files.
400 Use the customize interface to set this variable. This ensures
401 that `rng-schema-locating-files' is updated and auto-validation
402 of OpenDocument XML takes place based on the value
403 `rng-nxml-auto-validate-flag'.
405 The default value of this variable varies depending on the
406 version of org in use and is initialized from
407 `org-odt-schema-dir-list'. The OASIS schema files are available
408 only in the org's private git repository. It is *not* bundled
409 with GNU ELPA tar or standard Emacs distribution."
415 :set
417 "Set `org-odt-schema-dir'.
418 Also add it to `rng-schema-locating-files'."
428 schema-dir
431 value))
432 nil)))
437 org-odt-schema-dir))))))
440 ;;;; Document styles
444 The exporter embeds the exported content just before
448 under `org-odt-styles-dir' is used."
455 "Default styles file for use with ODT export.
456 Valid values are one of:
457 1. nil
458 2. path to a styles.xml file
459 3. path to a *.odt or a *.ott file
460 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
461 ...))
463 In case of option 1, an in-built styles.xml is used. See
464 `org-odt-styles-dir' for more information.
466 In case of option 3, the specified file is unzipped and the
467 styles.xml embedded therein is used.
469 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
470 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
471 generated odt file. Use relative path for specifying the
472 FILE-MEMBERS. styles.xml must be specified as one of the
473 FILE-MEMBERS.
475 Use options 1, 2 or 3 only if styles.xml alone suffices for
476 achieving the desired formatting. Use option 4, if the styles.xml
477 references additional files like header and footer images for
478 achieving the desired formatting.
481 a per-file basis. For example,
487 :type
499 "Outline levels considered for enumerating captioned entities."
505 ;;;; Document conversion
512 "Specify a list of document converters and their usage.
513 The converters in this list are offered as choices while
514 customizing `org-odt-convert-process'.
516 This variable is a list where each element is of the
517 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
518 of the converter. CONVERTER-CMD is the shell command for the
519 converter and can contain format specifiers. These format
520 specifiers are interpreted as below:
522 %i input file name in full
523 %I input file name as a URL
524 %f format of the output file
525 %o output file name in full
526 %O output file name as a URL
527 %d output dir in full
528 %D output dir as a URL.
529 %x extra options as set in `org-odt-convert-capabilities'."
532 :type
541 During customization, the list of converter names are populated
542 from `org-odt-convert-processes'."
552 org-odt-convert-processes))))
570 "Specify input and output formats of `org-odt-convert-process'.
571 More correctly, specify the set of input and output formats that
572 the user is actually interested in.
574 This variable is an alist where each element is of the
575 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
576 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
577 alist where each element is of the form (OUTPUT-FMT
578 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
580 The variable is interpreted as follows:
581 `org-odt-convert-process' can take any document that is in
582 INPUT-FMT-LIST and produce any document that is in the
583 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
584 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
585 serves dual purposes:
586 - It is used for populating completion candidates during
587 `org-odt-convert' commands.
589 `org-odt-convert-process'.
592 `org-odt-convert-process'.
594 DOCUMENT-CLASS is used to group a set of file formats in
595 INPUT-FMT-LIST in to a single class.
597 Note that this variable inherently captures how LibreOffice based
598 converters work. LibreOffice maps documents of various formats
599 to classes like Text, Web, Spreadsheet, Presentation etc and
600 allow document of a given class (irrespective of it's source
601 format) to be converted to any of the export formats associated
602 with that class.
604 See default setting of this variable for an typical
605 configuration."
608 :type
613 :value-type
617 :value-type
626 and then uses `org-odt-convert-process' to convert the
627 resulting document to this format. During customization of this
628 variable, the list of valid values are populated based on
629 `org-odt-convert-capabilities'.
631 You can set this option on per-file basis using file local
632 values. See Info node `(emacs) File Variables'."
643 ;;;###autoload
647 ;;;; Drawers
651 "Function called to format a drawer in ODT code.
653 The function must accept two parameters:
655 CONTENTS the contents of the drawer.
657 The function should return the string to be exported.
659 The default value simply returns the value of CONTENTS."
666 ;;;; Headline
669 "Function to format headline text.
671 This function will be called with 5 arguments:
672 TODO the todo keyword \(string or nil\).
673 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
674 PRIORITY the priority of the headline \(integer or nil\)
675 TEXT the main headline text \(string\).
676 TAGS the tags string, separated with colons \(string or nil\).
678 The function result will be used as headline text."
685 ;;;; Inlinetasks
688 "Function called to format an inlinetask in ODT code.
690 The function must accept six parameters:
691 TODO the todo keyword, as a string
692 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
693 PRIORITY the inlinetask priority, as a string
694 NAME the inlinetask name, as a string.
695 TAGS the inlinetask tags, as a string.
696 CONTENTS the contents of the inlinetask, as a string.
698 The function should return the string to be exported."
705 ;;;; LaTeX
708 "Non-nil means process LaTeX math snippets.
710 When set, the exporter will process LaTeX environments and
711 fragments.
713 This option can also be set with the +OPTIONS line,
716 nil Ignore math snippets.
717 `verbatim' Keep everything in verbatim
718 `dvipng' Process the LaTeX fragments to images. This will also
719 include processing of non-math environments.
720 `imagemagick' Convert the LaTeX fragments to pdf files and use
721 imagemagick to convert pdf files to png files.
722 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
723 be loaded.
724 t Synonym for `mathjax'."
736 ;;;; Links
740 "Rules characterizing formula files that can be inlined into ODT.
742 A rule consists in an association whose key is the type of link
743 to consider, and value is a regexp that will be matched against
744 link's path."
753 "Rules characterizing image files that can be inlined into ODT.
755 A rule consists in an association whose key is the type of link
756 to consider, and value is a regexp that will be matched against
757 link's path."
765 "Scaling factor for converting images pixels to inches.
766 Use this for sizing of embedded images. See Info node `(org)
767 Images in ODT export' for more information."
774 ;;;; Src Block
777 "Whether custom styles for colorized source blocks be automatically created.
778 When this option is turned on, the exporter creates custom styles
779 for source blocks based on the advice of `htmlfontify'. Creation
780 of custom styles happen as part of `org-odt-hfy-face-to-css'.
782 When this option is turned off exporter does not create such
783 styles.
785 Use the latter option if you do not want the custom styles to be
786 based on your current display settings. It is necessary that the
787 styles.xml already contains needed styles for colorizing to work.
789 This variable is effective only if
790 `org-odt-fontify-srcblocks' is turned on."
796 "Specify whether or not source blocks need to be fontified.
797 Turn this option on if you want to colorize the source code
798 blocks in the exported file. For colorization to work, you need
799 to make available an enhanced version of `htmlfontify' library."
805 ;;;; Table
818 "Specify how Table Styles should be derived from a Table Template.
819 This is a list where each element is of the
820 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
822 TABLE-STYLE-NAME is the style associated with the table through
825 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
826 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
827 below) that is included in
828 `org-odt-content-template-file'.
830 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
832 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
840 TABLE-CELL-OPTIONS is an alist where each element is of the
841 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
842 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
843 `use-last-row-styles' |
844 `use-first-column-styles' |
845 `use-last-column-styles' |
846 `use-banding-rows-styles' |
847 `use-banding-columns-styles' |
848 `use-first-row-styles'
849 ON-OR-OFF := `t' | `nil'
851 For example, with the following configuration
853 \(setq org-odt-table-styles
855 \(\(use-first-row-styles . t\)
856 \(use-first-column-styles . t\)\)\)
858 \(\(use-first-column-styles . t\)\)\)\)\)
861 style will use the following table-cell styles -
866 as appropriate.
869 use the following table-cell styles -
871 following paragraph styles
873 as appropriate..
875 Note that TABLE-TEMPLATE-NAME corresponds to the
878 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
881 specification for more information. Also consult the
882 implementation filed under `org-odt-get-table-cell-styles'.
885 formatting of numbered display equations. Do not delete this
886 style from the list."
896 use-last-row-styles
897 use-first-column-styles
898 use-last-column-styles
899 use-banding-rows-styles
900 use-banding-columns-styles)
901 :key-type symbol
904 ;;;; Timestamps
907 "Non-nil, if timestamps should be exported as date fields.
909 When nil, export timestamps as plain text.
911 When non-nil, map `org-time-stamp-custom-formats' to a pair of
913 respectively. A timestamp with no time component is formatted
917 This feature is experimental. Most (but not all) of the common
918 %-specifiers in `format-time-string' are supported.
920 formatted as canonical Org timestamps. For finer control, avoid
921 these %-specifiers.
924 etc., are displayed by the application in the default language
925 and country specified in `org-odt-styles-file'. Note that the
927 can localize the week day and month strings in the exported
928 document by setting the default language and country either using
929 the application UI or through a custom styles file.
931 See `org-odt--build-date-styles' for implementation details."
938 \f
939 ;;; Internal functions
941 ;;;; Date
956 ;; LibreOffice does not care about end goes as content
957 ;; within the "<text:date>...</text:date>" field. The
958 ;; displayed date is automagically corrected to match the
959 ;; format requested by "style:data-style-name" attribute. So
960 ;; don't bother about formatting the date contents to be
961 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
962 ;; simple Org-style date should suffice.
987 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
988 iso-date style date)
990 repeater)))))
992 ;;;; Frame
1000 extra
1004 style frame-attrs
1016 ;;;; Library wrappers
1023 ;; This is shamelessly stolen from `archive-zip-extract'.
1029 name)))
1034 exit-code command-output)
1042 members))
1044 ;;;; Target
1053 ;;;; Textbox
1056 extra anchor-type)
1062 text)
1063 width nil style extra anchor-type))
1067 ;;;; Table of Contents
1072 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1074 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1081 "
1082 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1084 <text:index-entry-chapter/>
1085 <text:index-entry-text/>
1086 <text:index-entry-link-end/>
1087 </text:table-of-content-entry-template>
1091 </text:table-of-content-source>
1093 <text:index-body>
1096 </text:index-title>
1101 </text:index-body>
1102 </text:table-of-content>
1110 ;; Section number.
1112 ;; Todo.
1117 style todo)))
1122 style priority)))
1123 ;; Title.
1124 text
1125 ;; Tags.
1129 "OrgTags"
1136 headline-label text))
1140 ;; When a headline is marked as a radio target, as in the example below:
1141 ;;
1142 ;; ** <<<Some Heading>>>
1143 ;; Some text.
1144 ;;
1145 ;; suppress generation of radio targets. i.e., Radio targets are to
1146 ;; be marked as targets within /document body/ and *not* within
1147 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1148 ;; and one in the document body.
1149 ;;
1150 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1151 ;; doesn't provide a way to disable memoization. So this doesn't
1152 ;; work.
1153 ;;
1154 ;; FIXME-2: Are there any other objects that need to be suppressed
1155 ;; within TOC?
1175 style entry)))
1180 ;;;; Document styles
1183 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1184 OBJECT-PROPS is (typically) a plist created by passing
1186 `org-odt-parse-block-attributes'.
1188 Use `org-odt-object-counters' to generate an automatic
1189 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1190 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1191 . STYLE-NAME)."
1207 ;;;; Checkbox
1210 "Return check-box string associated to ITEM."
1219 ;;; Template
1222 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1223 ;; to modify the date fields. A date could be modified by
1224 ;; offsetting in days. That's about it. Also, date and time may
1225 ;; have to be emitted as two fields - a date field and a time field
1226 ;; - separately.
1228 ;; One can add Form Controls to date and time fields so that they
1229 ;; can be easily modified. But then, the exported document will
1230 ;; become tightly coupled with LibreOffice and may not function
1231 ;; properly with other OpenDocument applications.
1233 ;; I have a strange feeling that Date styles are a bit flaky at the
1234 ;; moment.
1236 ;; The feature is experimental.
1282 ))
1290 filler-end))
1301 style
1304 output ))))
1307 "Return complete document string after ODT conversion.
1308 CONTENTS is the transcoded contents string. RAW-DATA is the
1309 original parsed data. INFO is a plist holding export options."
1310 ;; Write meta file.
1320 <office:document-meta
1330 ;; Date, if required.
1332 ;; Check if DATE is specified as an Org-timestamp. If yes,
1333 ;; include it as meta information. Otherwise, just use
1334 ;; today's date.
1343 iso-date)))))
1354 ;; Add meta.xml in to manifest.
1357 ;; Update styles file.
1358 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1359 ;; Write styles file.
1362 ;; Non-availability of styles.xml is not a critical
1363 ;; error. For now, throw an error.
1365 org-odt-styles-file
1367 org-odt-styles-dir)
1380 members)))
1390 org-odt-styles-file))))
1392 ;; create a manifest entry for styles.xml
1395 ;; FIXME: Who is opening an empty styles.xml before this point?
1400 ;; Write custom styles for source blocks
1401 ;; Save STYLES used for colorizing of source blocks.
1402 ;; Update styles.xml with styles that were collected as part of
1403 ;; `org-odt-hfy-face-to-css' callbacks.
1412 ;; Update styles.xml - take care of outline numbering
1414 ;; Don't make automatic backup of styles.xml file. This setting
1415 ;; prevents the backed-up styles.xml file from being zipped in to
1416 ;; odt file. This is more of a hackish fix. Better alternative
1417 ;; would be to fix the zip command so that the output odt file
1418 ;; includes only the needed files and excludes any auto-generated
1419 ;; extra files like backups and auto-saves etc etc. Note that
1420 ;; currently the zip command zips up the entire temp directory so
1421 ;; that any auto-generated files created under the hood ends up in
1422 ;; the resulting odt file.
1425 ;; Outline numbering is retained only upto LEVEL.
1426 ;; To disable outline numbering pass a LEVEL of 0.
1439 ;; Update content.xml.
1442 ;; within the context of the Org buffer. So obtain it's
1443 ;; value before moving on to temp-buffer context down below.
1453 org-odt-styles-dir)))
1454 ;; Write automatic styles.
1455 ;; - Position the cursor.
1459 ;; - Dump automatic table styles.
1464 ;; - Dump date-styles.
1470 ;; Update display level.
1471 ;; - Remove existing sequence decls. Also position the cursor.
1476 ;; Update sequence decls according to user preference.
1486 ;; Position the cursor to document body.
1491 ;; Preamble - Title, Author, Date etc.
1498 ;; Switch on or off above vars based on user settings
1502 ;; Title.
1507 ;; Separator.
1511 ;; Author only.
1514 "OrgSubtitle"
1516 ;; Separator.
1519 ;; Author and E-mail.
1523 "OrgSubtitle"
1528 ;; Separator.
1530 ;; Date, if required.
1533 ;; Check if DATE is specified as a timestamp.
1539 "OrgSubtitle"
1543 ;; Separator
1545 ;; Table of Contents
1548 with-toc
1551 ;; Contents.
1553 ;; Return contents.
1557 \f
1558 ;;; Transcode Functions
1560 ;;;; Bold
1563 "Transcode BOLD from Org to ODT.
1564 CONTENTS is the text with bold markup. INFO is a plist holding
1565 contextual information."
1570 ;;;; Center Block
1573 "Transcode a CENTER-BLOCK element from Org to ODT.
1574 CONTENTS holds the contents of the center block. INFO is a plist
1575 holding contextual information."
1576 contents)
1579 ;;;; Clock
1582 "Transcode a CLOCK element from Org to ODT.
1583 CONTENTS is nil. INFO is a plist used as a communication
1584 channel."
1597 ;;;; Code
1600 "Transcode a CODE object from Org to ODT.
1601 CONTENTS is nil. INFO is a plist used as a communication
1602 channel."
1608 ;;;; Comment
1610 ;; Comments are ignored.
1613 ;;;; Comment Block
1615 ;; Comment Blocks are ignored.
1618 ;;;; Drawer
1621 "Transcode a DRAWER element from Org to ODT.
1622 CONTENTS holds the contents of the block. INFO is a plist
1623 holding contextual information."
1626 name contents)))
1627 output))
1630 ;;;; Dynamic Block
1633 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1634 CONTENTS holds the contents of the block. INFO is a plist
1635 holding contextual information. See `org-export-data'."
1636 contents)
1639 ;;;; Entity
1642 "Transcode an ENTITY object from Org to ODT.
1643 CONTENTS are the definition itself. INFO is a plist holding
1644 contextual information."
1648 ;;;; Example Block
1651 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1652 CONTENTS is nil. INFO is a plist holding contextual information."
1656 ;;;; Export Snippet
1659 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1660 CONTENTS is nil. INFO is a plist holding contextual information."
1665 ;;;; Export Block
1668 "Transcode a EXPORT-BLOCK element from Org to ODT.
1669 CONTENTS is nil. INFO is a plist holding contextual information."
1674 ;;;; Fixed Width
1677 "Transcode a FIXED-WIDTH element from Org to ODT.
1678 CONTENTS is nil. INFO is a plist holding contextual information."
1682 ;;;; Footnote Definition
1684 ;; Footnote Definitions are ignored.
1687 ;;;; Footnote Reference
1690 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1691 CONTENTS is nil. INFO is a plist holding contextual information."
1701 id note-class
1714 "OrgSuperscript"
1715 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1716 note-class ref-format ref-name n)))))))
1718 ;; Insert separator between two footnotes in a row.
1723 ;; Trancode footnote reference.
1728 ;; Inline definitions are secondary strings.
1729 ;; Non-inline footnotes definitions are full Org data.
1732 footnote-reference info))
1736 raw
1739 :transcoders
1742 p c "Footnote"
1743 "OrgFootnoteCenter"
1745 info))))
1752 ;;;; Headline
1758 ;; Todo.
1762 style todo)))
1767 style priority)))
1768 ;; Title.
1769 text
1770 ;; Tags.
1773 "<text:tab/>"
1782 &optional format-function
1784 "Transcode a HEADLINE element using BACKEND.
1785 INFO is a plist holding contextual information."
1812 todo todo-type priority text tags))))
1815 todo todo-type priority text tags
1820 "Transcode a HEADLINE element from Org to ODT.
1821 CONTENTS holds the contents of the headline. INFO is a plist
1822 holding contextual information."
1823 ;; Case 1: This is a footnote section: ignore it.
1826 ;; Create the headline text.
1828 ;; Get level relative to current parsed data.
1830 ;; Get canonical label for the headline.
1834 ;; Get user-specified labels for the headline.
1837 ;; Extra targets.
1845 ;; Title.
1848 ;; Case 2. This is a deep sub-tree: export it as a list item.
1849 ;; Also export as items headlines for which no section
1850 ;; format has been found.
1852 ;; Build the real contents of the sub-tree.
1856 ;; Choose style based on list type.
1859 ;; If top-level list, re-start numbering. Otherwise,
1860 ;; continue numbering.
1863 headline)))
1873 "Text_20_body"
1875 contents)
1877 "</text:list-header>"
1881 ;; Case 3. Standard headline. Export it as a section.
1887 level
1889 contents))))))
1892 ;;;; Horizontal Rule
1895 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1896 CONTENTS is nil. INFO is a plist holding contextual information."
1901 ;;;; Inline Babel Call
1903 ;; Inline Babel Calls are ignored.
1906 ;;;; Inline Src Block
1909 "Return a character not used in string S.
1911 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1917 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1918 CONTENTS holds the contents of the item. INFO is a plist holding
1919 contextual information."
1926 ;;;; Inlinetask
1929 "Transcode an INLINETASK element from Org to ODT.
1930 CONTENTS holds the contents of the block. INFO is a plist
1931 holding contextual information."
1933 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1934 ;; with appropriate arguments.
1941 todo todo-type priority text tags contents)))))
1944 ;; Otherwise, use a default template.
1947 "Text_20_body"
1951 "OrgInlineTaskHeading"
1953 contents)
1956 ;;;; Italic
1959 "Transcode ITALIC from Org to ODT.
1960 CONTENTS is the text with italic markup. INFO is a plist holding
1961 contextual information."
1966 ;;;; Item
1969 "Transcode an ITEM element from Org to ODT.
1970 CONTENTS holds the contents of the item. INFO is a plist holding
1971 contextual information."
1982 contents
1994 ;;;; Keyword
1997 "Transcode a KEYWORD element from Org to ODT.
1998 CONTENTS is nil. INFO is a plist holding contextual information."
2004 ;; FIXME
2015 ;; FIXME
2019 ;;;; Latex Environment
2022 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2023 ;; (defadvice org-format-latex-as-mathml ; FIXME
2024 ;; (after org-odt-protect-latex-fragment activate)
2025 ;; "Encode LaTeX fragment as XML.
2026 ;; Do this when translation to MathML fails."
2027 ;; (unless (> (length ad-return-value) 0)
2028 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2031 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2032 CONTENTS is nil. INFO is a plist holding contextual information."
2038 ;;;; Latex Fragment
2040 ;; (when latex-frag ; FIXME
2041 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2042 ;; :description latex-frag)))
2043 ;; handle verbatim
2044 ;; provide descriptions
2047 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2048 CONTENTS is nil. INFO is a plist holding contextual information."
2055 ;;;; Line Break
2058 "Transcode a LINE-BREAK object from Org to ODT.
2059 CONTENTS is nil. INFO is a plist holding contextual information."
2063 ;;;; Link
2065 ;;;; Links :: Label references
2076 x)))))
2087 counter))
2094 ;; Section number.
2098 ;; Separator.
2100 ;; Ordinal.
2102 tag))
2105 "Return a label for ELEMENT.
2107 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2108 element. INFO is a plist used as a communication channel. OP is
2109 either `definition' or `reference', depending on the purpose of
2110 the generated string.
2112 Return value is a string if OP is set to `reference' or a cons
2113 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2114 SHORT-CAPTION are strings."
2120 ;; Get label and caption.
2124 ;; Transcode captions.
2126 ;; Currently short caption are sneaked in as object names.
2127 ;;
2128 ;; The advantages are:
2129 ;;
2130 ;; - Table Of Contents: Currently, there is no support for
2131 ;; building TOC for figures, listings and tables. See
2132 ;; `org-odt-keyword'. User instead has to rely on
2133 ;; external application for building such indices. Within
2134 ;; LibreOffice, building an "Illustration Index" or "Index
2135 ;; of Tables" will create a table with long captions (only)
2136 ;; and building a table with "Object names" will create a
2137 ;; table with short captions.
2138 ;;
2139 ;; - Easy navigation: In LibreOffice, object names are
2140 ;; offered via the navigation bar. This way one can
2141 ;; quickly locate and jump to object of his choice in the
2142 ;; exported document.
2143 ;;
2144 ;; The main disadvantage is that there cannot be any markups
2145 ;; within object names i.e., one cannot embolden, italicize
2146 ;; or underline text within short caption. So suppress
2147 ;; generation of <text:span >...</text:span> and other
2148 ;; markups by overriding the default translators. We
2149 ;; probably shouldn't be suppressing translators for all
2150 ;; elements in `org-element-all-objects', but for now this
2151 ;; will do.
2157 :transcoders
2159 org-element-all-objects))))
2176 element))))
2179 seqno)
2183 ;; Compute sequence number of the element.
2185 ;; Localize category string.
2188 ;; Case 1: Handle Label definition.
2190 ;; Assign an internal label, if user has not provided one
2195 ;; Sneak in a bookmark. The bookmark is used when the
2196 ;; labeled element is referenced with a link that
2197 ;; provides it's own description.
2199 ;; Label definition: Typically formatted as below:
2200 ;; CATEGORY SEQ-NO: LONG CAPTION
2201 ;; with translation for correct punctuation.
2208 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2209 label counter counter seqno))
2211 short-caption))
2212 ;; Case 2: Handle Label reference.
2219 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2225 ;;;; Links :: Inline Images
2228 "Returns the internal name of the file"
2244 target-file))
2247 user-height scale dpi embed-as)
2267 ;; Use Imagemagick.
2272 file))))
2277 ;; Use Emacs.
2283 ;; Use hard-coded values.
2285 org-odt-default-image-sizes-alist))
2286 ;; Error out.
2299 ;; ensure that an embedded image fits comfortably within a page
2310 "Return ODT code for an inline image.
2311 LINK is the link pointing to the inline image. INFO is a plist
2312 used as a communication channel."
2325 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2327 ;; Extract attributes from #+ATTR_ODT line.
2331 ;; Convert attributes to a plist.
2333 ;; Handle `:anchor', `:style' and `:attributes' properties.
2343 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2344 ;; extrac
2345 ;;
2346 ;; Handle `:width', `:height' and `:scale' properties. Read
2347 ;; them as numbers since we need them for computations.
2349 src-expanded
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 it's 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 it's 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 it's 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 it's containing paragraph satisfies
2621 PARAGRAPH-PREDICATE inaddtion to having no other content save for
2622 leading and trailing whitespaces.
2624 Return nil, otherwise."
2647 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2648 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2649 ;; attached. Note that labels that are attached to captioned
2650 ;; entities - inline images, math formulae and tables - get resolved
2651 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2653 ;; Create a cross-reference to DESTINATION but make best-efforts to
2654 ;; create a *meaningful* description. Check item numbers, section
2655 ;; number and section title in that order.
2657 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2658 ;; 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>"
2709 ;; Case 2: Locate a regular and numbered headline in the
2710 ;; hierarchy. Display it's section number.
2715 return el)))
2716 ;; We found one.
2718 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2722 ;; Case 4: Locate a regular headline in the hierarchy. Display
2723 ;; it's title.
2727 return el)))
2728 ;; We found one.
2730 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2737 "Transcode a LINK object from Org to ODT.
2739 DESC is the description part of the link, or the empty string.
2740 INFO is a plist holding contextual information. See
2741 `org-export-data'."
2744 ;; Ensure DESC really exists, or set it to nil.
2747 link org-odt-inline-image-rules))
2756 ;; Convert & to & for correct XML representation
2758 protocol)
2760 ;; Image file.
2762 link org-odt-inline-image-rules))
2764 ;; Formula file.
2766 link org-odt-inline-formula-rules))
2768 ;; Radio target: Transcode target's contents and use them as
2769 ;; link's description.
2776 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2777 href desc)))))
2778 ;; Links pointing to a headline: Find destination and build
2779 ;; appropriate referencing command.
2785 ;; Case 1: Fuzzy link points nowhere.
2786 ('nil
2788 "Emphasis"
2791 info))))
2792 ;; Case 2: Fuzzy link points to a headline.
2794 ;; If there's a description, create a hyperlink.
2795 ;; 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.
2813 desc))))
2814 ;; Case 4: Fuzzy link points to some element (e.g., an
2815 ;; inline image, a math formula or a table).
2822 ;; LINK has no description. Create
2823 ;; a cross-reference showing entity's sequence
2824 ;; number.
2826 ;; LINK has description. Insert a hyperlink with
2827 ;; user-provided description.
2832 desc)))))))))
2833 ;; Coderef: replace link with the reference name or the
2834 ;; equivalent line number.
2841 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2842 href line-no))))
2843 ;; Link type is handled by a special function.
2846 ;; External link with a description part.
2849 ;; Check if description is a link to an inline image.
2854 desc-element org-odt-inline-image-rules))))
2855 ;; Format link as a clickable image.
2857 path desc)
2858 ;; Otherwise, format it as a regular link.
2860 path desc))))
2861 ;; External link without a description part.
2864 path path))
2865 ;; No path, only description. Try to do something useful.
2870 ;;;; Paragraph
2873 "Format paragraph according to given styles.
2874 PARAGRAPH is a paragraph type element. CONTENTS is the
2875 transcoded contents of that paragraph, as a string. DEFAULT,
2876 CENTER and QUOTE are, respectively, style to use when paragraph
2877 belongs to no special environment, a center block, or a quote
2878 block."
2885 ;; If this paragraph is a leading paragraph in an item and the
2886 ;; item has a checkbox, splice the checkbox and paragraph contents
2887 ;; together.
2894 "Transcode a PARAGRAPH element from Org to ODT.
2895 CONTENTS is the contents of the paragraph, as a string. INFO is
2896 the plist used as a communication channel."
2898 paragraph contents
2900 "OrgCenter"
2904 ;;;; Plain List
2907 "Transcode a PLAIN-LIST element from Org to ODT.
2908 CONTENTS is the contents of the list. INFO is a plist holding
2909 contextual information."
2911 ;; Choose style based on list type.
2917 ;; If top-level list, re-start numbering. Otherwise,
2918 ;; continue numbering.
2923 contents))
2925 ;;;; Plain Text
2938 line))
2949 "Transcode a TEXT string from Org to ODT.
2950 TEXT is the string to transcode. INFO is a plist holding
2951 contextual information."
2953 ;; Protect &, < and >.
2955 ;; Handle smart quotes. Be sure to provide original string since
2956 ;; OUTPUT may have been modified.
2959 ;; Convert special strings.
2965 org-odt-special-string-regexps))
2966 ;; Handle break preservation if required.
2970 ;; Return value.
2971 output))
2974 ;;;; Planning
2977 "Transcode a PLANNING element from Org to ODT.
2978 CONTENTS is nil. INFO is a plist used as a communication
2979 channel."
2981 "OrgPlanning"
3003 ;;;; Property Drawer
3006 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3007 CONTENTS is nil. INFO is a plist holding contextual
3008 information."
3009 ;; The property drawer isn't exported but we want separating blank
3010 ;; lines nonetheless.
3014 ;;;; Quote Block
3017 "Transcode a QUOTE-BLOCK element from Org to ODT.
3018 CONTENTS holds the contents of the block. INFO is a plist
3019 holding contextual information."
3020 contents)
3023 ;;;; Quote Section
3026 "Transcode a QUOTE-SECTION element from Org to ODT.
3027 CONTENTS is nil. INFO is a plist holding contextual information."
3033 ;;;; Section
3038 style
3040 text)))
3044 "Transcode a SECTION element from Org to ODT.
3045 CONTENTS holds the contents of the section. INFO is a plist
3046 holding contextual information."
3047 contents)
3049 ;;;; Radio Target
3052 "Transcode a RADIO-TARGET object from Org to ODT.
3053 TEXT is the text of the target. INFO is a plist holding
3054 contextual information."
3060 ;;;; Special Block
3063 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3064 CONTENTS holds the contents of the block. INFO is a plist
3065 holding contextual information."
3069 ;; Annotation.
3075 ;; FIXME: Is `car' right thing to do below?
3085 contents)))))
3086 ;; Textbox.
3095 style extra anchor))))
3099 ;;;; Src Block
3102 "Create custom style for face FN.
3103 When FN is the default face, use it's foreground and background
3105 use it's color attribute to create a character style whose name
3106 is obtained from FN. Currently all attributes of FN other than
3107 color are ignored.
3109 The style name for a face FN is derived using the following
3110 operations on the face name in that order - de-dash, CamelCase
3112 `font-lock-function-name-face' is associated with
3126 background-color-val color-val))
3129 "
3160 org-odt-fontify-srcblocks
3177 code
3188 par-style loc))
3191 num-start refs))
3205 ;; Extract code and references.
3209 ;; Does the src block contain labels?
3211 ;; Does it have line numbers?
3218 "Transcode a SRC-BLOCK element from Org to ODT.
3219 CONTENTS holds the contents of the item. INFO is a plist holding
3220 contextual information."
3232 "Text_20_body"
3236 ;;;; Statistics Cookie
3239 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3240 CONTENTS is nil. INFO is a plist holding contextual information."
3246 ;;;; Strike-Through
3249 "Transcode STRIKE-THROUGH from Org to ODT.
3250 CONTENTS is the text with strike-through markup. INFO is a plist
3251 holding contextual information."
3256 ;;;; Subscript
3259 "Transcode a SUBSCRIPT object from Org to ODT.
3260 CONTENTS is the contents of the object. INFO is a plist holding
3261 contextual information."
3266 ;;;; Superscript
3269 "Transcode a SUPERSCRIPT object from Org to ODT.
3270 CONTENTS is the contents of the object. INFO is a plist holding
3271 contextual information."
3276 ;;;; Table Cell
3285 "Retrieve styles applicable to a table cell.
3286 R and C are (zero-based) row and column numbers of the table
3287 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3288 applicable to the current table. It is `nil' if the table is not
3289 associated with any style attributes.
3291 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3293 When STYLE-SPEC is nil, style the table cell the conventional way
3294 - choose cell borders based on row and column groupings and
3295 choose paragraph alignment based on `org-col-cookies' text
3296 property. See also
3297 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3299 When STYLE-SPEC is non-nil, ignore the above cookie and return
3300 styles congruent with the ODF-1.2 specification."
3306 info)))
3308 ;; LibreOffice - particularly the Writer - honors neither table
3309 ;; templates nor custom table-cell styles. Inorder to retain
3310 ;; inter-operability with LibreOffice, only automatic styles are
3311 ;; used for styling of table-cells. The current implementation is
3312 ;; congruent with ODF-1.2 specification and hence is
3313 ;; future-compatible.
3315 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3316 ;; which recognizes as many as 16 different cell types - is much
3317 ;; richer. Unfortunately it is NOT amenable to easy configuration
3318 ;; by hand.
3345 "Transcode a TABLE-CELL element from Org to ODT.
3346 CONTENTS is nil. INFO is a plist used as a communication
3347 channel."
3354 table-cell info))
3377 table-cell info))))))
3381 custom-style-prefix))
3383 "OrgTblCell"
3399 cell-attributes
3402 org-element-all-elements)
3403 contents
3405 paragraph-style contents))))
3412 ;;;; Table Row
3415 "Transcode a TABLE-ROW element from Org to ODT.
3416 CONTENTS is the contents of the row. INFO is a plist used as a
3417 communication channel."
3418 ;; Rules are ignored since table separators are deduced from
3419 ;; borders of the current row.
3425 ;; If the row belongs to the first rowgroup and the
3426 ;; table has more than one row groups, then this row
3427 ;; belongs to the header row group.
3429 ;; Otherwise, it belongs to non-header row group.
3432 ;; Does this row begin a rowgroup?
3435 ;; Actual table row
3437 ;; Does this row end a rowgroup?
3442 ;;;; Table
3455 "Transcode a TABLE element from Org to ODT.
3456 CONTENTS is the contents of the table. INFO is a plist holding
3457 contextual information."
3459 ;; Case 1: table.el doesn't support export to OD format. Strip
3460 ;; such tables from export.
3465 "(ox-odt): Found table.el-type table in the source Org file."
3466 " table.el doesn't support export to ODT format."
3468 ;; Case 2: Native Org tables.
3485 column-style))
3486 out)
3490 ;; caption.
3494 ;; begin table.
3502 ;; column specification.
3504 ;; actual contents.
3506 ;; end table.
3510 "Transcode a TABLE element from Org to ODT.
3511 CONTENTS is the contents of the table. INFO is a plist holding
3512 contextual information.
3514 Use `org-odt--table' to typeset the table. Handle details
3515 pertaining to indentation here."
3530 collect el)))
3536 collect
3541 parent-list)
3543 ;; Handle list genealogy.
3563 parent-list info)
3566 ;; Handle low-level headlines.
3568 with step = 'item collect
3576 el info)
3577 "OrgNumberedList"
3588 parent-list info)))
3596 table info)))
3597 ;; OpenDocument schema does not permit table to occur within a
3598 ;; list item.
3600 ;; One solution - the easiest and lightweight, in terms of
3601 ;; implementation - is to put the table in an indented text box
3602 ;; and make the text box part of the list-item. Unfortunately if
3603 ;; the table is big and spans multiple pages, the text box could
3604 ;; overflow. In this case, the following attribute will come
3605 ;; handy.
3607 ;; ,---- From OpenDocument-v1.1.pdf
3608 ;; | 15.27.28 Overflow behavior
3609 ;; |
3610 ;; | For text boxes contained within text document, the
3611 ;; | style:overflow-behavior property specifies the behavior of text
3612 ;; | boxes where the containing text does not fit into the text
3613 ;; | box.
3614 ;; |
3615 ;; | If the attribute's value is clip, the text that does not fit
3616 ;; | into the text box is not displayed.
3617 ;; |
3618 ;; | If the attribute value is auto-create-new-frame, a new frame
3619 ;; | will be created on the next page, with the same position and
3620 ;; | dimensions of the original frame.
3621 ;; |
3622 ;; | If the style:overflow-behavior property's value is
3623 ;; | auto-create-new-frame and the text box has a minimum width or
3624 ;; | height specified, then the text box will grow until the page
3625 ;; | bounds are reached before a new frame is created.
3626 ;; `----
3628 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3629 ;; auto-create-new-frame property and always resorts to clipping
3630 ;; the text box. This results in table being truncated.
3632 ;; So we solve the problem the hard (and fun) way using list
3633 ;; continuations.
3635 ;; The problem only becomes more interesting if you take in to
3636 ;; account the following facts:
3637 ;;
3638 ;; - Description lists are simulated as plain lists.
3639 ;; - Low-level headlines can be listified.
3640 ;; - In Org-mode, a table can occur not only as a regular list
3641 ;; item, but also within description lists and low-level
3642 ;; headlines.
3644 ;; See `org-odt-translate-description-lists' and
3645 ;; `org-odt-translate-low-level-headlines' for how this is
3646 ;; tackled.
3649 ;; Discontinue the list.
3651 ;; Put the table in an indented section.
3656 ;; Continue the list.
3660 ;;;; Target
3663 "Transcode a TARGET object from Org to ODT.
3664 CONTENTS is nil. INFO is a plist holding contextual
3665 information."
3670 ;;;; Timestamp
3673 "Transcode a TIMESTAMP object from Org to ODT.
3674 CONTENTS is nil. INFO is a plist used as a communication
3675 channel."
3692 "OrgActiveTimestamp"
3696 "OrgInactiveTimestamp"
3700 "OrgActiveTimestamp"
3706 "OrgInactiveTimestamp"
3712 "OrgDiaryTimestamp"
3714 info)))))))
3717 ;;;; Underline
3720 "Transcode UNDERLINE from Org to ODT.
3721 CONTENTS is the text with underline markup. INFO is a plist
3722 holding contextual information."
3727 ;;;; Verbatim
3730 "Transcode a VERBATIM object from Org to ODT.
3731 CONTENTS is nil. INFO is a plist used as a communication
3732 channel."
3738 ;;;; Verse Block
3741 "Transcode a VERSE-BLOCK element from Org to ODT.
3742 CONTENTS is verse block contents. INFO is a plist holding
3743 contextual information."
3744 ;; Add line breaks to each line of verse.
3748 ;; Replace tabs and spaces.
3750 ;; Surround it in a verse environment.
3755 \f
3756 ;;; Filters
3758 ;;;; LaTeX fragments
3763 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3764 ;; If the desired converter is not available, force verbatim
3765 ;; processing.
3783 ;; Store normalized value for later use.
3788 ;; Convert `latex-fragment's and `latex-environment's.
3806 ;; Get an Org-style link to PNG image or the MathML
3807 ;; file.
3812 nil display-msg
3813 nil nil processing-type)
3818 link))))
3820 ;; Conversion succeeded. Parse above Org-style link to a
3821 ;; `link' object.
3827 ;; Orphan the link.
3832 ;; Case 1: LaTeX environment.
3833 ;; Mimic a "standalone image or formula" by
3834 ;; enclosing the `link' in a `paragraph'.
3835 ;; Copy over original attributes, captions to
3836 ;; the enclosing paragraph.
3842 latex-*)
3844 latex-*)))
3845 link))
3846 ;; Case 2: LaTeX fragment.
3847 ;; No special action.
3849 ;; Note down the object that link replaces.
3853 ;; Replace now.
3855 info)))
3856 tree)
3859 ;;;; Description lists
3861 ;; This translator is necessary to handle indented tables in a uniform
3862 ;; manner. See comment in `org-odt--table'.
3865 ;; OpenDocument has no notion of a description list. So simulate it
3866 ;; using plain lists. Description lists in the exported document
3867 ;; are typeset in the same manner as they are in a typical HTML
3868 ;; document.
3869 ;;
3870 ;; Specifically, a description list like this:
3871 ;;
3872 ;; ,----
3873 ;; | - term-1 :: definition-1
3874 ;; | - term-2 :: definition-2
3875 ;; `----
3876 ;;
3877 ;; gets translated in to the following form:
3878 ;;
3879 ;; ,----
3880 ;; | - term-1
3881 ;; | - definition-1
3882 ;; | - term-2
3883 ;; | - definition-2
3884 ;; `----
3885 ;;
3886 ;; Further effect is achieved by fixing the OD styles as below:
3887 ;;
3888 ;; 1. Set the :type property of the simulated lists to
3889 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3890 ;; that has *no* bullets whatsoever.
3891 ;;
3892 ;; 2. The paragraph containing the definition term is styled to be
3893 ;; in bold.
3894 ;;
3899 el
3915 nil)
3916 info)
3917 tree)
3919 ;;;; List tables
3921 ;; Lists that are marked with attribute `:list-table' are called as
3922 ;; list tables. They will be rendered as a table within the exported
3923 ;; document.
3925 ;; Consider an example. The following list table
3926 ;;
3927 ;; #+attr_odt :list-table t
3928 ;; - Row 1
3929 ;; - 1.1
3930 ;; - 1.2
3931 ;; - 1.3
3932 ;; - Row 2
3933 ;; - 2.1
3934 ;; - 2.2
3935 ;; - 2.3
3936 ;;
3937 ;; will be exported as though it were an Org table like the one show
3938 ;; below.
3939 ;;
3940 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3941 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3942 ;;
3943 ;; Note that org-tables are NOT multi-line and each line is mapped to
3944 ;; a unique row in the exported document. So if an exported table
3945 ;; needs to contain a single paragraph (with copious text) it needs to
3946 ;; be typed up in a single line. Editing such long lines using the
3947 ;; table editor will be a cumbersome task. Furthermore inclusion of
3948 ;; multi-paragraph text in a table cell is well-nigh impossible.
3949 ;;
3950 ;; A LIST-TABLE circumvents above problems.
3951 ;;
3952 ;; Note that in the example above the list items could be paragraphs
3953 ;; themselves and the list can be arbitrarily deep.
3954 ;;
3955 ;; Inspired by following thread:
3956 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3958 ;; Translate lists to tables
3964 ;; Replace list with table.
3966 l1-list
3967 ;; Build replacement table.
3973 l1-item-leading-text l2-list)
3974 ;; Remove Level-2 list from the Level-item. It
3975 ;; will be subsequently attached as table-cells.
3985 ;; Level-1 items start a table row.
3988 ;; Leading text of level-1 item define
3989 ;; the first table-cell.
3992 l1-item-leading-text)
3993 ;; Level-2 items define subsequent
3994 ;; table-cells of the row.
4002 nil)
4003 info)
4004 tree)
4006 \f
4007 ;;; Interactive functions
4020 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4029 org-odt-manifest-file-entries)
4037 ;; Initialize temporary workarea. All files that end up in
4038 ;; the exported document get parked/created here.
4045 ;; Kill all XML buffers.
4053 org-odt-xml-files)
4054 ;; Delete temporary directory and also other embedded
4055 ;; files that get copied there.
4060 ;; Not at all OSes ship with zip by default
4062 ;; Do export. This creates a bunch of xml files ready to be
4063 ;; saved and zipped.
4065 ;; Create a manifest entry for content.xml.
4067 ;; Write mimetype file
4076 ;; Write out the manifest entries before zipping
4078 ;; Save all XML files.
4084 ;; Prettify output if needed.
4088 org-odt-xml-files)
4089 ;; Run zip.
4094 ;; If a file with same name as the desired output file
4095 ;; exists, remove it.
4098 ;; Zip up the xml files.
4101 ;; Switch temporarily to content.xml. This way Zip
4102 ;; process will inherit `org-odt-zip-dir' as the current
4103 ;; directory.
4117 err-string)))))
4118 cmds)))
4119 ;; Move the zip file from temporary work directory to
4120 ;; user-mandated location.
4123 ;; Cleanup work directory and work files.
4125 ;; Open the OpenDocument file in archive-mode for
4126 ;; examination.
4128 ;; Return exported file.
4130 ;; Case 1: Conversion desired on exported file. Run the
4131 ;; converter on the OpenDocument file. Return the
4132 ;; converted file.
4135 target))
4136 ;; Case 2: No further conversion. Return exported
4137 ;; OpenDocument file.
4140 ;; Cleanup work directory and work files.
4146 ;;;; Export to OpenDocument formula
4148 ;;;###autoload
4150 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4151 Use `org-create-math-formula' to convert LATEX-FRAG first to
4152 MathML. When invoked as an interactive command, use
4153 `org-latex-regexps' to infer LATEX-FRAG from currently active
4154 region. If no LaTeX fragments are found, prompt for it. Push
4155 MathML source to kill ring depending on the value of
4156 `org-export-copy-to-kill-ring'."
4182 filename
4195 ;; Add MathML to kill ring, if needed.
4199 ;;;###autoload
4201 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4202 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4203 formula file."
4208 ;;;; Export to OpenDocument Text
4210 ;;;###autoload
4212 "Export current buffer to a ODT file.
4214 If narrowing is active in the current buffer, only export its
4215 narrowed part.
4217 If a region is active, export that region.
4219 A non-nil optional argument ASYNC means the process should happen
4220 asynchronously. The resulting file should be accessible through
4221 the `org-export-stack' interface.
4223 When optional argument SUBTREEP is non-nil, export the sub-tree
4224 at point, extracting information from the headline properties
4225 first.
4227 When optional argument VISIBLE-ONLY is non-nil, don't export
4228 contents of hidden elements.
4230 EXT-PLIST, when provided, is a property list with external
4231 parameters overriding Org default settings, but still inferior to
4232 file-local settings.
4234 Return output file's name."
4241 ,outfile
4246 ;; Let `htmlfontify' know that we are interested in
4247 ;; collecting styles.
4249 ;; Initialize content.xml and kick-off the export
4250 ;; process.
4263 outfile
4268 ;; Let `htmlfontify' know that we are interested in collecting
4269 ;; styles.
4271 ;; Initialize content.xml and kick-off the export process.
4281 ;;;; Convert between OpenDocument and other formats
4284 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4293 "Workhorse routine for `org-odt-convert'."
4302 in-fmt out-fmt)))
4330 out-file)
4333 nil))))
4336 "Return verbose info about formats to which IN-FMT can be converted.
4337 Return a list where each element is of the
4338 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4339 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4340 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4344 org-odt-convert-processes t))))
4348 org-odt-convert-processes t))
4349 org-odt-convert-capabilities))
4350 reachable-formats)
4355 reachable-formats))
4358 "Return list of formats to which IN-FMT can be converted.
4359 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4365 l))
4368 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4369 This is a helper routine for interactive use."
4372 nil buffer-file-name t))
4378 out-fmt-choices nil nil nil))
4380 "No known converter or no known output formats for %s files"
4381 in-fmt))))
4384 ;;;###autoload
4386 "Convert IN-FILE to format OUT-FMT using a command line converter.
4387 IN-FILE is the file to be converted. If unspecified, it defaults
4388 to variable `buffer-file-name'. OUT-FMT is the desired output
4389 format. Use `org-odt-convert-process' as the converter.
4390 If PREFIX-ARG is non-nil then the newly converted file is opened
4391 using `org-open-file'."
4396 ;;; Library Initializations
4400 ;; Let Emacs open all OpenDocument files in archive mode
4403 org-odt-file-extensions)
4407 ;; Local variables:
4408 ;; generated-autoload-file: "org-loaddefs.el"
4409 ;; End:
4411 ;;; ox-odt.el ends here