| blob | 7e1390ef070aa3d6a03bf4b26edb8e3e3e1a0828 |
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=\"%d%%\" 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.
291 This is an alist where each element is of the
292 form (LABEL-STYLE-NAME LABEL-ATTACH-FMT LABEL-REF-MODE
293 LABEL-REF-FMT).
295 LABEL-ATTACH-FMT controls how labels and captions are attached to
296 an entity. It may contain following specifiers - %e, %n and %c.
297 %e is replaced with the CATEGORY-NAME. %n is replaced with
299 with CAPTION. See `org-odt-format-label-definition'.
301 LABEL-REF-MODE and LABEL-REF-FMT controls how label references
302 are generated. The following XML is generated for a label
306 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
307 %n is replaced with SEQNO. See
316 ;; ("__Table__" "Table" "category-and-value")
317 ;; ("__Figure__" "Figure" "category-and-value")
318 ;; ("__DvipngImage__" "Equation" "category-and-value")
319 )
320 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
324 CATEGORY_HANDLE identifies the captionable entity in question.
326 OD-VARIABLE is the OpenDocument sequence counter associated with
327 the entity. These counters are declared within
329 `org-odt-content-template-file'.
331 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
332 how a given entity should be captioned and referenced.
334 CATEGORY-NAME is used for qualifying captions on export. You can
335 modify the CATEGORY-NAME used in the exported document by
336 modifying `org-export-dictionary'. For example, an embedded
342 `:utf-8'.
344 ENUMERATOR-PREDICATE is used for assigning a sequence number to
354 \f
355 ;;; User Configuration Variables
358 "Options for exporting Org mode files to ODT."
363 ;;;; Debugging
366 "Specify whether or not the xml output should be prettified.
367 When this option is turned on, `indent-region' is run on all
368 component xml buffers before they are saved. Turn this off for
369 regular use. Turn this on if you need to examine the xml
370 visually."
376 ;;;; Document schema
388 schema-dir))
391 schema-dir))
395 schema-dir)
397 org-odt-schema-dir-list)
399 nil)))
400 schema-dir)
401 "Directory that contains OpenDocument schema files.
403 This directory contains:
404 1. rnc files for OpenDocument schema
406 for auto validation of OpenDocument XML files.
408 Use the customize interface to set this variable. This ensures
409 that `rng-schema-locating-files' is updated and auto-validation
410 of OpenDocument XML takes place based on the value
411 `rng-nxml-auto-validate-flag'.
413 The default value of this variable varies depending on the
414 version of org in use and is initialized from
415 `org-odt-schema-dir-list'. The OASIS schema files are available
416 only in the org's private git repository. It is *not* bundled
417 with GNU ELPA tar or standard Emacs distribution."
423 :set
425 "Set `org-odt-schema-dir'.
426 Also add it to `rng-schema-locating-files'."
436 schema-dir
439 value))
440 nil)))
445 org-odt-schema-dir))))))
448 ;;;; Document styles
452 The exporter embeds the exported content just before
456 under `org-odt-styles-dir' is used."
462 "Default styles file for use with ODT export.
463 Valid values are one of:
464 1. nil
465 2. path to a styles.xml file
466 3. path to a *.odt or a *.ott file
467 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
468 ...))
470 In case of option 1, an in-built styles.xml is used. See
471 `org-odt-styles-dir' for more information.
473 In case of option 3, the specified file is unzipped and the
474 styles.xml embedded therein is used.
476 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
477 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
478 generated odt file. Use relative path for specifying the
479 FILE-MEMBERS. styles.xml must be specified as one of the
480 FILE-MEMBERS.
482 Use options 1, 2 or 3 only if styles.xml alone suffices for
483 achieving the desired formatting. Use option 4, if the styles.xml
484 references additional files like header and footer images for
485 achieving the desired formatting.
488 a per-file basis. For example,
494 :type
506 "Outline levels considered for enumerating captioned entities."
511 ;;;; Document conversion
518 "Specify a list of document converters and their usage.
519 The converters in this list are offered as choices while
520 customizing `org-odt-convert-process'.
522 This variable is a list where each element is of the
523 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
524 of the converter. CONVERTER-CMD is the shell command for the
525 converter and can contain format specifiers. These format
526 specifiers are interpreted as below:
528 %i input file name in full
529 %I input file name as a URL
530 %f format of the output file
531 %o output file name in full
532 %O output file name as a URL
533 %d output dir in full
534 %D output dir as a URL.
535 %x extra options as set in `org-odt-convert-capabilities'."
538 :type
547 During customization, the list of converter names are populated
548 from `org-odt-convert-processes'."
558 org-odt-convert-processes))))
576 "Specify input and output formats of `org-odt-convert-process'.
577 More correctly, specify the set of input and output formats that
578 the user is actually interested in.
580 This variable is an alist where each element is of the
581 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
582 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
583 alist where each element is of the form (OUTPUT-FMT
584 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
586 The variable is interpreted as follows:
587 `org-odt-convert-process' can take any document that is in
588 INPUT-FMT-LIST and produce any document that is in the
589 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
590 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
591 serves dual purposes:
592 - It is used for populating completion candidates during
593 `org-odt-convert' commands.
595 `org-odt-convert-process'.
598 `org-odt-convert-process'.
600 DOCUMENT-CLASS is used to group a set of file formats in
601 INPUT-FMT-LIST in to a single class.
603 Note that this variable inherently captures how LibreOffice based
604 converters work. LibreOffice maps documents of various formats
605 to classes like Text, Web, Spreadsheet, Presentation etc and
606 allow document of a given class (irrespective of it's source
607 format) to be converted to any of the export formats associated
608 with that class.
610 See default setting of this variable for an typical
611 configuration."
614 :type
619 :value-type
623 :value-type
632 and then uses `org-odt-convert-process' to convert the
633 resulting document to this format. During customization of this
634 variable, the list of valid values are populated based on
635 `org-odt-convert-capabilities'.
637 You can set this option on per-file basis using file local
638 values. See Info node `(emacs) File Variables'."
649 ;;;###autoload
653 ;;;; Drawers
656 "Function called to format a drawer in ODT code.
658 The function must accept two parameters:
660 CONTENTS the contents of the drawer.
662 The function should return the string to be exported.
664 For example, the variable could be set to the following function
665 in order to mimic default behaviour:
667 \(defun org-odt-format-drawer-default \(name contents\)
669 contents\)"
676 ;;;; Headline
679 "Function to format headline text.
681 This function will be called with 5 arguments:
682 TODO the todo keyword \(string or nil\).
683 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
684 PRIORITY the priority of the headline \(integer or nil\)
685 TEXT the main headline text \(string\).
686 TAGS the tags string, separated with colons \(string or nil\).
688 The function result will be used as headline text."
695 ;;;; Inlinetasks
698 "Function called to format an inlinetask in ODT code.
700 The function must accept six parameters:
701 TODO the todo keyword, as a string
702 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
703 PRIORITY the inlinetask priority, as a string
704 NAME the inlinetask name, as a string.
705 TAGS the inlinetask tags, as a string.
706 CONTENTS the contents of the inlinetask, as a string.
708 The function should return the string to be exported."
715 ;;;; LaTeX
718 "Non-nil means process LaTeX math snippets.
720 When set, the exporter will process LaTeX environments and
721 fragments.
723 This option can also be set with the +OPTIONS line,
726 nil Ignore math snippets.
727 `verbatim' Keep everything in verbatim
728 `dvipng' Process the LaTeX fragments to images. This will also
729 include processing of non-math environments.
730 `imagemagick' Convert the LaTeX fragments to pdf files and use
731 imagemagick to convert pdf files to png files.
732 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
733 be loaded.
734 t Synonym for `mathjax'."
746 ;;;; Links
750 "Rules characterizing formula files that can be inlined into ODT.
752 A rule consists in an association whose key is the type of link
753 to consider, and value is a regexp that will be matched against
754 link's path."
761 "Rules characterizing image files that can be inlined into ODT.
763 A rule consists in an association whose key is the type of link
764 to consider, and value is a regexp that will be matched against
765 link's path."
771 "Scaling factor for converting images pixels to inches.
772 Use this for sizing of embedded images. See Info node `(org)
773 Images in ODT export' for more information."
779 ;;;; Src Block
782 "Whether custom styles for colorized source blocks be automatically created.
783 When this option is turned on, the exporter creates custom styles
784 for source blocks based on the advice of `htmlfontify'. Creation
785 of custom styles happen as part of `org-odt-hfy-face-to-css'.
787 When this option is turned off exporter does not create such
788 styles.
790 Use the latter option if you do not want the custom styles to be
791 based on your current display settings. It is necessary that the
792 styles.xml already contains needed styles for colorizing to work.
794 This variable is effective only if
795 `org-odt-fontify-srcblocks' is turned on."
801 "Specify whether or not source blocks need to be fontified.
802 Turn this option on if you want to colorize the source code
803 blocks in the exported file. For colorization to work, you need
804 to make available an enhanced version of `htmlfontify' library."
810 ;;;; Table
823 "Specify how Table Styles should be derived from a Table Template.
824 This is a list where each element is of the
825 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
827 TABLE-STYLE-NAME is the style associated with the table through
830 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
831 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
832 below) that is included in
833 `org-odt-content-template-file'.
835 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
837 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
845 TABLE-CELL-OPTIONS is an alist where each element is of the
846 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
847 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
848 `use-last-row-styles' |
849 `use-first-column-styles' |
850 `use-last-column-styles' |
851 `use-banding-rows-styles' |
852 `use-banding-columns-styles' |
853 `use-first-row-styles'
854 ON-OR-OFF := `t' | `nil'
856 For example, with the following configuration
858 \(setq org-odt-table-styles
860 \(\(use-first-row-styles . t\)
861 \(use-first-column-styles . t\)\)\)
863 \(\(use-first-column-styles . t\)\)\)\)\)
866 style will use the following table-cell styles -
871 as appropriate.
874 use the following table-cell styles -
876 following paragraph styles
878 as appropriate..
880 Note that TABLE-TEMPLATE-NAME corresponds to the
883 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
886 specification for more information. Also consult the
887 implementation filed under `org-odt-get-table-cell-styles'.
890 formatting of numbered display equations. Do not delete this
891 style from the list."
901 use-last-row-styles
902 use-first-column-styles
903 use-last-column-styles
904 use-banding-rows-styles
905 use-banding-columns-styles)
906 :key-type symbol
909 ;;;; Timestamps
912 "Non-nil, if timestamps should be exported as date fields.
914 When nil, export timestamps as plain text.
916 When non-nil, map `org-time-stamp-custom-formats' to a pair of
918 respectively. A timestamp with no time component is formatted
922 This feature is experimental. Most (but not all) of the common
923 %-specifiers in `format-time-string' are supported.
925 formatted as canonical Org timestamps. For finer control, avoid
926 these %-specifiers.
929 etc., are displayed by the application in the default language
930 and country specified in `org-odt-styles-file'. Note that the
932 can localize the week day and month strings in the exported
933 document by setting the default language and country either using
934 the application UI or through a custom styles file.
936 See `org-odt--build-date-styles' for implementation details."
941 \f
942 ;;; Internal functions
944 ;;;; Date
959 ;; LibreOffice does not care about end goes as content
960 ;; within the "<text:date>...</text:date>" field. The
961 ;; displayed date is automagically corrected to match the
962 ;; format requested by "style:data-style-name" attribute. So
963 ;; don't bother about formatting the date contents to be
964 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
965 ;; simple Org-style date should suffice.
990 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
991 iso-date style date)
993 repeater)))))
995 ;;;; Frame
1003 extra
1007 style frame-attrs
1019 ;;;; Library wrappers
1026 ;; This is shamelessly stolen from `archive-zip-extract'.
1032 name)))
1037 exit-code command-output)
1045 members))
1048 ;; See comments in `org-odt-format-label' and `org-odt-toc'.
1051 ;; Override translators.
1052 :translate-alist
1056 ;; Reset data translation cache. FIXME.
1057 ;; :exported-data nil
1058 )))
1061 ;;;; Target
1070 ;;;; Textbox
1073 extra anchor-type)
1079 text)
1080 width nil style extra anchor-type))
1084 ;;;; Table of Contents
1089 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1091 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1098 "
1099 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1101 <text:index-entry-chapter/>
1102 <text:index-entry-text/>
1103 <text:index-entry-link-end/>
1104 </text:table-of-content-entry-template>
1108 </text:table-of-content-source>
1110 <text:index-body>
1113 </text:index-title>
1118 </text:index-body>
1119 </text:table-of-content>
1127 ;; Section number.
1129 ;; Todo.
1134 style todo)))
1139 style priority)))
1140 ;; Title.
1141 text
1142 ;; Tags.
1146 "OrgTags"
1153 headline-label text))
1157 ;; When a headline is marked as a radio target, as in the example below:
1158 ;;
1159 ;; ** <<<Some Heading>>>
1160 ;; Some text.
1161 ;;
1162 ;; suppress generation of radio targets. i.e., Radio targets are to
1163 ;; be marked as targets within /document body/ and *not* within
1164 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1165 ;; and one in the document body.
1166 ;;
1167 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1168 ;; doesn't provide a way to disable memoization. So this doesn't
1169 ;; work.
1170 ;;
1171 ;; FIXME-2: Are there any other objects that need to be suppressed
1172 ;; within TOC?
1179 contents)))
1188 headline translations info
1193 style entry)))
1198 ;;;; Document styles
1201 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1202 OBJECT-PROPS is (typically) a plist created by passing
1204 `org-odt-parse-block-attributes'.
1206 Use `org-odt-object-counters' to generate an automatic
1207 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1208 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1209 . STYLE-NAME)."
1225 ;;;; Checkbox
1228 "Return check-box string associated to ITEM."
1237 ;;; Template
1240 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1241 ;; to modify the date fields. A date could be modified by
1242 ;; offsetting in days. That's about it. Also, date and time may
1243 ;; have to be emitted as two fields - a date field and a time field
1244 ;; - separately.
1246 ;; One can add Form Controls to date and time fields so that they
1247 ;; can be easily modified. But then, the exported document will
1248 ;; become tightly coupled with LibreOffice and may not function
1249 ;; properly with other OpenDocument applications.
1251 ;; I have a strange feeling that Date styles are a bit flaky at the
1252 ;; moment.
1254 ;; The feature is experimental.
1300 ))
1308 filler-end))
1319 style
1322 output ))))
1325 "Return complete document string after ODT conversion.
1326 CONTENTS is the transcoded contents string. RAW-DATA is the
1327 original parsed data. INFO is a plist holding export options."
1328 ;; Write meta file.
1338 <office:document-meta
1348 ;; Date, if required.
1350 ;; Check if DATE is specified as an Org-timestamp. If yes,
1351 ;; include it as meta information. Otherwise, just use
1352 ;; today's date.
1361 iso-date)))))
1372 ;; Add meta.xml in to manifest.
1375 ;; Update styles file.
1376 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1377 ;; Write styles file.
1380 ;; Non-availability of styles.xml is not a critical
1381 ;; error. For now, throw an error.
1383 org-odt-styles-file
1385 org-odt-styles-dir)
1398 members)))
1408 org-odt-styles-file))))
1410 ;; create a manifest entry for styles.xml
1413 ;; FIXME: Who is opening an empty styles.xml before this point?
1418 ;; Write custom styles for source blocks
1419 ;; Save STYLES used for colorizing of source blocks.
1420 ;; Update styles.xml with styles that were collected as part of
1421 ;; `org-odt-hfy-face-to-css' callbacks.
1430 ;; Update styles.xml - take care of outline numbering
1432 ;; Don't make automatic backup of styles.xml file. This setting
1433 ;; prevents the backed-up styles.xml file from being zipped in to
1434 ;; odt file. This is more of a hackish fix. Better alternative
1435 ;; would be to fix the zip command so that the output odt file
1436 ;; includes only the needed files and excludes any auto-generated
1437 ;; extra files like backups and auto-saves etc etc. Note that
1438 ;; currently the zip command zips up the entire temp directory so
1439 ;; that any auto-generated files created under the hood ends up in
1440 ;; the resulting odt file.
1443 ;; Outline numbering is retained only upto LEVEL.
1444 ;; To disable outline numbering pass a LEVEL of 0.
1457 ;; Update content.xml.
1460 ;; within the context of the Org buffer. So obtain it's
1461 ;; value before moving on to temp-buffer context down below.
1471 org-odt-styles-dir)))
1472 ;; Write automatic styles.
1473 ;; - Position the cursor.
1477 ;; - Dump automatic table styles.
1482 ;; - Dump date-styles.
1488 ;; Update display level.
1489 ;; - Remove existing sequence decls. Also position the cursor.
1494 ;; Update sequence decls according to user preference.
1504 ;; Position the cursor to document body.
1509 ;; Preamble - Title, Author, Date etc.
1516 ;; Switch on or off above vars based on user settings
1520 ;; Title.
1525 ;; Separator.
1529 ;; Author only.
1532 "OrgSubtitle"
1534 ;; Separator.
1537 ;; Author and E-mail.
1541 "OrgSubtitle"
1546 ;; Separator.
1548 ;; Date, if required.
1551 ;; Check if DATE is specified as a timestamp.
1557 "OrgSubtitle"
1561 ;; Separator
1563 ;; Table of Contents
1566 with-toc
1569 ;; Contents.
1571 ;; Return contents.
1575 \f
1576 ;;; Transcode Functions
1578 ;;;; Bold
1581 "Transcode BOLD from Org to ODT.
1582 CONTENTS is the text with bold markup. INFO is a plist holding
1583 contextual information."
1588 ;;;; Center Block
1591 "Transcode a CENTER-BLOCK element from Org to ODT.
1592 CONTENTS holds the contents of the center block. INFO is a plist
1593 holding contextual information."
1594 contents)
1597 ;;;; Clock
1600 "Transcode a CLOCK element from Org to ODT.
1601 CONTENTS is nil. INFO is a plist used as a communication
1602 channel."
1615 ;;;; Code
1618 "Transcode a CODE object from Org to ODT.
1619 CONTENTS is nil. INFO is a plist used as a communication
1620 channel."
1626 ;;;; Comment
1628 ;; Comments are ignored.
1631 ;;;; Comment Block
1633 ;; Comment Blocks are ignored.
1636 ;;;; Drawer
1639 "Transcode a DRAWER element from Org to ODT.
1640 CONTENTS holds the contents of the block. INFO is a plist
1641 holding contextual information."
1645 name contents)
1646 ;; If there's no user defined function: simply
1647 ;; display contents of the drawer.
1648 contents)))
1649 output))
1652 ;;;; Dynamic Block
1655 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1656 CONTENTS holds the contents of the block. INFO is a plist
1657 holding contextual information. See `org-export-data'."
1658 contents)
1661 ;;;; Entity
1664 "Transcode an ENTITY object from Org to ODT.
1665 CONTENTS are the definition itself. INFO is a plist holding
1666 contextual information."
1670 ;;;; Example Block
1673 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1674 CONTENTS is nil. INFO is a plist holding contextual information."
1678 ;;;; Export Snippet
1681 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1682 CONTENTS is nil. INFO is a plist holding contextual information."
1687 ;;;; Export Block
1690 "Transcode a EXPORT-BLOCK element from Org to ODT.
1691 CONTENTS is nil. INFO is a plist holding contextual information."
1696 ;;;; Fixed Width
1699 "Transcode a FIXED-WIDTH element from Org to ODT.
1700 CONTENTS is nil. INFO is a plist holding contextual information."
1704 ;;;; Footnote Definition
1706 ;; Footnote Definitions are ignored.
1709 ;;;; Footnote Reference
1712 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1713 CONTENTS is nil. INFO is a plist holding contextual information."
1723 id note-class
1736 "OrgSuperscript"
1737 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1738 note-class ref-format ref-name n)))))))
1740 ;; Insert separator between two footnotes in a row.
1745 ;; Trancode footnote reference.
1750 ;; Inline definitions are secondary strings.
1751 ;; Non-inline footnotes definitions are full Org data.
1754 footnote-reference info))
1763 raw translations info))))
1770 ;;;; Headline
1776 ;; Todo.
1780 style todo)))
1785 style priority)))
1786 ;; Title.
1787 text
1788 ;; Tags.
1791 "<text:tab/>"
1800 &optional format-function
1802 "Transcode a HEADLINE element from Org to ODT.
1803 CONTENTS holds the contents of the headline. INFO is a plist
1804 holding contextual information."
1814 todo translations info)))))
1831 todo todo-type priority text tags))))
1834 todo todo-type priority text tags
1839 "Transcode a HEADLINE element from Org to ODT.
1840 CONTENTS holds the contents of the headline. INFO is a plist
1841 holding contextual information."
1842 ;; Case 1: This is a footnote section: ignore it.
1845 ;; Create the headline text.
1847 ;; Get level relative to current parsed data.
1849 ;; Get canonical label for the headline.
1853 ;; Get user-specified labels for the headline.
1856 ;; Extra targets.
1864 ;; Title.
1867 ;; Case 2. This is a deep sub-tree: export it as a list item.
1868 ;; Also export as items headlines for which no section
1869 ;; format has been found.
1871 ;; Build the real contents of the sub-tree.
1875 ;; Choose style based on list type.
1878 ;; If top-level list, re-start numbering. Otherwise,
1879 ;; continue numbering.
1882 headline)))
1892 "Text_20_body"
1894 contents)
1896 "</text:list-header>"
1900 ;; Case 3. Standard headline. Export it as a section.
1906 level
1908 contents))))))
1911 ;;;; Horizontal Rule
1914 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1915 CONTENTS is nil. INFO is a plist holding contextual information."
1920 ;;;; Inline Babel Call
1922 ;; Inline Babel Calls are ignored.
1925 ;;;; Inline Src Block
1928 "Return a character not used in string S.
1930 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1936 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1937 CONTENTS holds the contents of the item. INFO is a plist holding
1938 contextual information."
1945 ;;;; Inlinetask
1948 "Transcode an INLINETASK element from Org to ODT.
1949 CONTENTS holds the contents of the block. INFO is a plist
1950 holding contextual information."
1952 ;; If `org-odt-format-inlinetask-function' is provided, call it
1953 ;; with appropriate arguments.
1960 todo todo-type priority text tags contents)))))
1963 ;; Otherwise, use a default template.
1966 "Text_20_body"
1970 "OrgInlineTaskHeading"
1972 contents)
1975 ;;;; Italic
1978 "Transcode ITALIC from Org to ODT.
1979 CONTENTS is the text with italic markup. INFO is a plist holding
1980 contextual information."
1985 ;;;; Item
1988 "Transcode an ITEM element from Org to ODT.
1989 CONTENTS holds the contents of the item. INFO is a plist holding
1990 contextual information."
2001 contents
2013 ;;;; Keyword
2016 "Transcode a KEYWORD element from Org to ODT.
2017 CONTENTS is nil. INFO is a plist holding contextual information."
2023 ;; FIXME
2034 ;; FIXME
2038 ;;;; Latex Environment
2041 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2042 ;; (defadvice org-format-latex-as-mathml ; FIXME
2043 ;; (after org-odt-protect-latex-fragment activate)
2044 ;; "Encode LaTeX fragment as XML.
2045 ;; Do this when translation to MathML fails."
2046 ;; (unless (> (length ad-return-value) 0)
2047 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2050 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2051 CONTENTS is nil. INFO is a plist holding contextual information."
2057 ;;;; Latex Fragment
2059 ;; (when latex-frag ; FIXME
2060 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2061 ;; :description latex-frag)))
2062 ;; handle verbatim
2063 ;; provide descriptions
2066 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2067 CONTENTS is nil. INFO is a plist holding contextual information."
2074 ;;;; Line Break
2077 "Transcode a LINE-BREAK object from Org to ODT.
2078 CONTENTS is nil. INFO is a plist holding contextual information."
2082 ;;;; Link
2084 ;;;; Links :: Label references
2095 x)))))
2106 counter))
2113 ;; Section number.
2117 ;; Separator.
2119 ;; Ordinal.
2121 tag))
2129 ;; Get label and caption.
2133 ;; Transcode captions.
2135 ;; Currently short caption are sneaked in as object names.
2136 ;;
2137 ;; The advantages are:
2138 ;;
2139 ;; - Table Of Contents: Currently, there is no support for
2140 ;; building TOC for figures, listings and tables. See
2141 ;; `org-odt-keyword'. User instead has to rely on
2142 ;; external application for building such indices. Within
2143 ;; LibreOffice, building an "Illustration Index" or "Index
2144 ;; of Tables" will create a table with long captions (only)
2145 ;; and building a table with "Object names" will create a
2146 ;; table with short captions.
2147 ;;
2148 ;; - Easy navigation: In LibreOffice, object names are
2149 ;; offered via the navigation bar. This way one can
2150 ;; quickly locate and jump to object of his choice in the
2151 ;; exported document.
2152 ;;
2153 ;; The main disadvantage is that there cannot be any markups
2154 ;; within object names i.e., one cannot embolden, italicize
2155 ;; or underline text within short caption. So suppress
2156 ;; generation of <text:span >...</text:span> and other
2157 ;; markups by overriding the default translators. We
2158 ;; probably shouldn't be suppressing translators for all
2159 ;; elements in `org-element-all-objects', but for now this
2160 ;; will do.
2166 contents)))
2167 org-element-all-objects)
2171 translations info)))))
2186 element))))
2189 seqno)
2193 ;; Compute sequence number of the element.
2195 ;; Localize category string.
2198 ;; Case 1: Handle Label definition.
2200 ;; Assign an internal label, if user has not provided one
2205 ;; Sneak in a bookmark. The bookmark is used when the
2206 ;; labeled element is referenced with a link that
2207 ;; provides it's own description.
2209 ;; Label definition: Typically formatted as below:
2210 ;; CATEGORY SEQ-NO: LONG CAPTION
2215 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2216 label counter counter seqno))
2218 short-caption))
2219 ;; Case 2: Handle Label reference.
2226 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2232 ;;;; Links :: Inline Images
2235 "Returns the internal name of the file"
2251 target-file))
2254 user-height scale dpi embed-as)
2274 ;; Use Imagemagick.
2279 file))))
2284 ;; Use Emacs.
2290 ;; Use hard-coded values.
2292 org-odt-default-image-sizes-alist))
2293 ;; Error out.
2306 ;; ensure that an embedded image fits comfortably within a page
2317 "Return ODT code for an inline image.
2318 LINK is the link pointing to the inline image. INFO is a plist
2319 used as a communication channel."
2332 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2334 ;; Extract attributes from #+ATTR_ODT line.
2338 ;; Convert attributes to a plist.
2340 ;; Handle `:anchor', `:style' and `:attributes' properties.
2350 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2351 ;; extrac
2352 ;;
2353 ;; Handle `:width', `:height' and `:scale' properties. Read
2354 ;; them as numbers since we need them for computations.
2356 src-expanded
2363 nil ; embed-as
2365 ))
2372 ;; Check if this link was created by LaTeX-to-PNG converter.
2376 ;; If yes, note down the type of the element - LaTeX Fragment
2377 ;; or LaTeX environment. It will go in to frame title.
2381 ;; If yes, note down it's contents. It will go in to frame
2382 ;; description. This quite useful for debugging.
2385 captions user-frame-params title desc)))
2388 ;;;; Links :: Math formula
2409 ;; Check if this link was created by LaTeX-to-MathML
2410 ;; converter.
2414 ;; If yes, note down the type of the element - LaTeX Fragment
2415 ;; or LaTeX environment. It will go in to frame title.
2419 ;; If yes, note down it's contents. It will go in to frame
2420 ;; description. This quite useful for debugging.
2422 width height)
2426 nil nil title desc))
2429 "CaptionedDisplayFormula" href width height
2430 captions nil title desc))
2434 org-odt--enumerable-formula-p))))
2439 "Returns the internal name of the file"
2443 ;; Create a directory for holding formula file. Also enter it in
2444 ;; to manifest.
2448 ;; Copy over the formula file from user directory to zip
2449 ;; directory.
2453 ;; Case 1: Mathml.
2456 ;; Case 2: OpenDocument formula.
2461 ;; Enter the formula file in to manifest.
2463 target-file))
2465 ;;;; Targets
2468 captions user-frame-params
2471 ;; Each element of this alist is of the form (CFG-HANDLE
2472 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2474 ;; CFG-HANDLE is the key to the alist.
2476 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2477 ;; frame params for INNER-FRAME and OUTER-FRAME
2478 ;; respectively. See below.
2480 ;; Configurations that are meant to be applied to
2481 ;; non-captioned image/formula specifies no
2482 ;; OUTER-FRAME-PARAMS.
2484 ;; TERMINOLOGY
2485 ;; ===========
2486 ;; INNER-FRAME :: Frame that directly surrounds an
2487 ;; image/formula.
2489 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2490 ;; frame also contains the caption, if any.
2492 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2493 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2494 ;; that these are the last three arguments
2495 ;; to `org-odt--frame'.
2497 ;; Note that an un-captioned image/formula requires just an
2498 ;; INNER-FRAME, while a captioned image/formula requires
2499 ;; both an INNER and an OUTER-FRAME.
2521 ;; Retrieve inner and outer frame params, from configuration.
2525 ;; User-specified frame params (from #+ATTR_ODT spec)
2529 "Merge default and user frame params."
2534 for d in default
2537 ;; Case 1: Image/Formula has no caption.
2538 ;; There is only one frame, one that surrounds the image
2539 ;; or formula.
2541 ;; Merge user frame params with that from configuration.
2545 ;; Case 2: Image/Formula is captioned or labeled.
2546 ;; There are two frames: The inner one surrounds the
2547 ;; image or formula. The outer one contains the
2548 ;; caption/sequence number.
2550 ;; Merge user frame params with outer frame params.
2552 ;; Short caption, if specified, goes as part of inner frame.
2559 frame-params))
2562 "Illustration"
2566 caption))
2567 width height outer)))))
2570 ;; Element should have a caption or label.
2576 element info
2577 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2578 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2579 ;; processing.)
2584 ;; Link should point to an image file.
2591 element info
2592 ;; Paragraph should have a caption or label. It SHOULD also be a
2593 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2594 ;; processing.)
2599 ;; Link should point to an image file.
2606 element info
2607 ;; Paragraph should have a caption or label.
2611 ;; Link should point to a MathML or ODF file.
2617 paragraph-predicate
2618 link-predicate)
2619 "Test if ELEMENT is a standalone link for the purpose ODT export.
2620 INFO is a plist holding contextual information.
2622 Return non-nil, if ELEMENT is of type paragraph satisfying
2623 PARAGRAPH-PREDICATE and it's sole content, save for whitespaces,
2624 is a link that satisfies LINK-PREDICATE.
2626 Return non-nil, if ELEMENT is of type link satisfying
2627 LINK-PREDICATE and it's containing paragraph satisfies
2628 PARAGRAPH-PREDICATE inaddtion to having no other content save for
2629 leading and trailing whitespaces.
2631 Return nil, otherwise."
2654 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2655 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2656 ;; attached. Note that labels that are attached to captioned
2657 ;; entities - inline images, math formulae and tables - get resolved
2658 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2660 ;; Create a cross-reference to DESTINATION but make best-efforts to
2661 ;; create a *meaningful* description. Check item numbers, section
2662 ;; number and section title in that order.
2664 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2665 ;; FIXME: Handle footnote-definition footnote-reference?
2681 return x))
2682 ;; Get list item nos.
2687 plain-list)
2690 item info t))))))
2691 ;; Locate top-most listified headline.
2696 return x))
2697 ;; Get listified headline numbers.
2703 el info t)))))))
2704 ;; Combine item numbers from both the listified headlines and
2705 ;; regular list items.
2707 ;; Case 1: Check if all the parents of list item are numbered.
2708 ;; If yes, link to the item proper.
2711 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2716 ;; Case 2: Locate a regular and numbered headline in the
2717 ;; hierarchy. Display it's section number.
2722 return el)))
2723 ;; We found one.
2725 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2729 ;; Case 4: Locate a regular headline in the hierarchy. Display
2730 ;; it's title.
2734 return el)))
2735 ;; We found one.
2737 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2744 "Transcode a LINK object from Org to ODT.
2746 DESC is the description part of the link, or the empty string.
2747 INFO is a plist holding contextual information. See
2748 `org-export-data'."
2751 ;; Ensure DESC really exists, or set it to nil.
2754 link org-odt-inline-image-rules))
2763 ;; Convert & to & for correct XML representation
2765 protocol)
2767 ;; Image file.
2769 link org-odt-inline-image-rules))
2771 ;; Formula file.
2773 link org-odt-inline-formula-rules))
2775 ;; Radio target: Transcode target's contents and use them as
2776 ;; link's description.
2783 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2784 href desc)))))
2785 ;; Links pointing to a headline: Find destination and build
2786 ;; appropriate referencing command.
2792 ;; Case 1: Fuzzy link points nowhere.
2798 ;; Case 2: Fuzzy link points to an invisible target. Strip it.
2800 ;; Case 3: LINK points to a headline.
2802 ;; Case 3.1: LINK has a custom description that is
2803 ;; different from headline's title. Create a hyperlink.
2808 destination)))))
2810 destination info))
2814 label desc))))
2815 ;; Case 4: LINK points to an Inline image, Math formula or a Table.
2820 ;; Case 4.1: LINK has no description. Create a
2821 ;; cross-reference showing entity's sequence number.
2823 ;; Case 4.2: LINK has description. Insert a hyperlink
2824 ;; with user-provided description.
2827 destination))
2829 ;; Get label and caption.
2833 ;; Case 5: Fuzzy link points to a TARGET.
2835 ;; Case 5.1: LINK has description. Create a hyperlink.
2840 ;; LINK has no description. It points to either a HEADLINE or
2841 ;; an ELEMENT with a #+NAME: LABEL attached to it. LINK to
2842 ;; DESTINATION, but make a best effort to provide
2843 ;; a *meaningful* description.
2845 ;; Coderef: replace link with the reference name or the
2846 ;; equivalent line number.
2853 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2854 href line-no))))
2855 ;; Link type is handled by a special function.
2858 ;; External link with a description part.
2861 ;; Check if description is a link to an inline image.
2866 desc-element org-odt-inline-image-rules))))
2867 ;; Format link as a clickable image.
2869 path desc)
2870 ;; Otherwise, format it as a regular link.
2872 path desc))))
2873 ;; External link without a description part.
2876 path path))
2877 ;; No path, only description. Try to do something useful.
2882 ;;;; Paragraph
2885 "Format paragraph according to given styles.
2886 PARAGRAPH is a paragraph type element. CONTENTS is the
2887 transcoded contents of that paragraph, as a string. DEFAULT,
2888 CENTER and QUOTE are, respectively, style to use when paragraph
2889 belongs to no special environment, a center block, or a quote
2890 block."
2897 ;; If this paragraph is a leading paragraph in an item and the
2898 ;; item has a checkbox, splice the checkbox and paragraph contents
2899 ;; together.
2906 "Transcode a PARAGRAPH element from Org to ODT.
2907 CONTENTS is the contents of the paragraph, as a string. INFO is
2908 the plist used as a communication channel."
2910 paragraph contents
2912 "OrgCenter"
2916 ;;;; Plain List
2919 "Transcode a PLAIN-LIST element from Org to ODT.
2920 CONTENTS is the contents of the list. INFO is a plist holding
2921 contextual information."
2923 ;; Choose style based on list type.
2929 ;; If top-level list, re-start numbering. Otherwise,
2930 ;; continue numbering.
2935 contents))
2937 ;;;; Plain Text
2950 line))
2961 "Transcode a TEXT string from Org to ODT.
2962 TEXT is the string to transcode. INFO is a plist holding
2963 contextual information."
2965 ;; Protect &, < and >.
2967 ;; Handle smart quotes. Be sure to provide original string since
2968 ;; OUTPUT may have been modified.
2970 ;; Convert special strings.
2976 org-odt-special-string-regexps))
2977 ;; Handle break preservation if required.
2981 ;; Return value.
2982 output))
2985 ;;;; Planning
2988 "Transcode a PLANNING element from Org to ODT.
2989 CONTENTS is nil. INFO is a plist used as a communication
2990 channel."
2992 "OrgPlanning"
3014 ;;;; Property Drawer
3017 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3018 CONTENTS is nil. INFO is a plist holding contextual
3019 information."
3020 ;; The property drawer isn't exported but we want separating blank
3021 ;; lines nonetheless.
3025 ;;;; Quote Block
3028 "Transcode a QUOTE-BLOCK element from Org to ODT.
3029 CONTENTS holds the contents of the block. INFO is a plist
3030 holding contextual information."
3031 contents)
3034 ;;;; Quote Section
3037 "Transcode a QUOTE-SECTION element from Org to ODT.
3038 CONTENTS is nil. INFO is a plist holding contextual information."
3044 ;;;; Section
3049 style
3051 text)))
3055 "Transcode a SECTION element from Org to ODT.
3056 CONTENTS holds the contents of the section. INFO is a plist
3057 holding contextual information."
3058 contents)
3060 ;;;; Radio Target
3063 "Transcode a RADIO-TARGET object from Org to ODT.
3064 TEXT is the text of the target. INFO is a plist holding
3065 contextual information."
3071 ;;;; Special Block
3074 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3075 CONTENTS holds the contents of the block. INFO is a plist
3076 holding contextual information."
3080 ;; Annotation.
3086 ;; FIXME: Is `car' right thing to do below?
3096 contents)))))
3097 ;; Textbox.
3106 style extra anchor))))
3110 ;;;; Src Block
3113 "Create custom style for face FN.
3114 When FN is the default face, use it's foreground and background
3116 use it's color attribute to create a character style whose name
3117 is obtained from FN. Currently all attributes of FN other than
3118 color are ignored.
3120 The style name for a face FN is derived using the following
3121 operations on the face name in that order - de-dash, CamelCase
3123 `font-lock-function-name-face' is associated with
3138 background-color-val color-val))
3141 "
3172 org-odt-fontify-srcblocks
3189 code
3200 par-style loc))
3203 num-start refs))
3217 ;; Extract code and references.
3221 ;; Does the src block contain labels?
3223 ;; Does it have line numbers?
3230 "Transcode a SRC-BLOCK element from Org to ODT.
3231 CONTENTS holds the contents of the item. INFO is a plist holding
3232 contextual information."
3244 "Text_20_body"
3248 ;;;; Statistics Cookie
3251 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3252 CONTENTS is nil. INFO is a plist holding contextual information."
3258 ;;;; Strike-Through
3261 "Transcode STRIKE-THROUGH from Org to ODT.
3262 CONTENTS is the text with strike-through markup. INFO is a plist
3263 holding contextual information."
3268 ;;;; Subscript
3271 "Transcode a SUBSCRIPT object from Org to ODT.
3272 CONTENTS is the contents of the object. INFO is a plist holding
3273 contextual information."
3278 ;;;; Superscript
3281 "Transcode a SUPERSCRIPT object from Org to ODT.
3282 CONTENTS is the contents of the object. INFO is a plist holding
3283 contextual information."
3288 ;;;; Table Cell
3297 "Retrieve styles applicable to a table cell.
3298 R and C are (zero-based) row and column numbers of the table
3299 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3300 applicable to the current table. It is `nil' if the table is not
3301 associated with any style attributes.
3303 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3305 When STYLE-SPEC is nil, style the table cell the conventional way
3306 - choose cell borders based on row and column groupings and
3307 choose paragraph alignment based on `org-col-cookies' text
3308 property. See also
3309 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3311 When STYLE-SPEC is non-nil, ignore the above cookie and return
3312 styles congruent with the ODF-1.2 specification."
3318 info)))
3320 ;; LibreOffice - particularly the Writer - honors neither table
3321 ;; templates nor custom table-cell styles. Inorder to retain
3322 ;; inter-operability with LibreOffice, only automatic styles are
3323 ;; used for styling of table-cells. The current implementation is
3324 ;; congruent with ODF-1.2 specification and hence is
3325 ;; future-compatible.
3327 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3328 ;; which recognizes as many as 16 different cell types - is much
3329 ;; richer. Unfortunately it is NOT amenable to easy configuration
3330 ;; by hand.
3357 "Transcode a TABLE-CELL element from Org to ODT.
3358 CONTENTS is nil. INFO is a plist used as a communication
3359 channel."
3366 table-cell info))
3389 table-cell info))))))
3393 custom-style-prefix))
3395 "OrgTblCell"
3411 cell-attributes
3414 org-element-all-elements)
3415 contents
3417 paragraph-style contents))))
3424 ;;;; Table Row
3427 "Transcode a TABLE-ROW element from Org to ODT.
3428 CONTENTS is the contents of the row. INFO is a plist used as a
3429 communication channel."
3430 ;; Rules are ignored since table separators are deduced from
3431 ;; borders of the current row.
3437 ;; If the row belongs to the first rowgroup and the
3438 ;; table has more than one row groups, then this row
3439 ;; belongs to the header row group.
3441 ;; Otherwise, it belongs to non-header row group.
3444 ;; Does this row begin a rowgroup?
3447 ;; Actual table row
3449 ;; Does this row end a rowgroup?
3454 ;;;; Table
3467 "Transcode a TABLE element from Org to ODT.
3468 CONTENTS is the contents of the table. INFO is a plist holding
3469 contextual information."
3471 ;; Case 1: table.el doesn't support export to OD format. Strip
3472 ;; such tables from export.
3477 "(ox-odt): Found table.el-type table in the source Org file."
3478 " table.el doesn't support export to ODT format."
3480 ;; Case 2: Native Org tables.
3497 column-style))
3498 out)
3502 ;; caption.
3506 ;; begin table.
3514 ;; column specification.
3516 ;; actual contents.
3518 ;; end table.
3522 "Transcode a TABLE element from Org to ODT.
3523 CONTENTS is the contents of the table. INFO is a plist holding
3524 contextual information.
3526 Use `org-odt--table' to typeset the table. Handle details
3527 pertaining to indentation here."
3542 collect el)))
3548 collect
3553 parent-list)
3555 ;; Handle list genealogy.
3575 parent-list info)
3578 ;; Handle low-level headlines.
3580 with step = 'item collect
3588 el info)
3589 "OrgNumberedList"
3600 parent-list info)))
3608 table info)))
3609 ;; OpenDocument schema does not permit table to occur within a
3610 ;; list item.
3612 ;; One solution - the easiest and lightweight, in terms of
3613 ;; implementation - is to put the table in an indented text box
3614 ;; and make the text box part of the list-item. Unfortunately if
3615 ;; the table is big and spans multiple pages, the text box could
3616 ;; overflow. In this case, the following attribute will come
3617 ;; handy.
3619 ;; ,---- From OpenDocument-v1.1.pdf
3620 ;; | 15.27.28 Overflow behavior
3621 ;; |
3622 ;; | For text boxes contained within text document, the
3623 ;; | style:overflow-behavior property specifies the behavior of text
3624 ;; | boxes where the containing text does not fit into the text
3625 ;; | box.
3626 ;; |
3627 ;; | If the attribute's value is clip, the text that does not fit
3628 ;; | into the text box is not displayed.
3629 ;; |
3630 ;; | If the attribute value is auto-create-new-frame, a new frame
3631 ;; | will be created on the next page, with the same position and
3632 ;; | dimensions of the original frame.
3633 ;; |
3634 ;; | If the style:overflow-behavior property's value is
3635 ;; | auto-create-new-frame and the text box has a minimum width or
3636 ;; | height specified, then the text box will grow until the page
3637 ;; | bounds are reached before a new frame is created.
3638 ;; `----
3640 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3641 ;; auto-create-new-frame property and always resorts to clipping
3642 ;; the text box. This results in table being truncated.
3644 ;; So we solve the problem the hard (and fun) way using list
3645 ;; continuations.
3647 ;; The problem only becomes more interesting if you take in to
3648 ;; account the following facts:
3649 ;;
3650 ;; - Description lists are simulated as plain lists.
3651 ;; - Low-level headlines can be listified.
3652 ;; - In Org-mode, a table can occur not only as a regular list
3653 ;; item, but also within description lists and low-level
3654 ;; headlines.
3656 ;; See `org-odt-translate-description-lists' and
3657 ;; `org-odt-translate-low-level-headlines' for how this is
3658 ;; tackled.
3661 ;; Discontinue the list.
3663 ;; Put the table in an indented section.
3668 ;; Continue the list.
3672 ;;;; Target
3675 "Transcode a TARGET object from Org to ODT.
3676 CONTENTS is nil. INFO is a plist holding contextual
3677 information."
3682 ;;;; Timestamp
3685 "Transcode a TIMESTAMP object from Org to ODT.
3686 CONTENTS is nil. INFO is a plist used as a communication
3687 channel."
3704 "OrgActiveTimestamp"
3708 "OrgInactiveTimestamp"
3712 "OrgActiveTimestamp"
3718 "OrgInactiveTimestamp"
3724 "OrgDiaryTimestamp"
3726 info)))))))
3729 ;;;; Underline
3732 "Transcode UNDERLINE from Org to ODT.
3733 CONTENTS is the text with underline markup. INFO is a plist
3734 holding contextual information."
3739 ;;;; Verbatim
3742 "Transcode a VERBATIM object from Org to ODT.
3743 CONTENTS is nil. INFO is a plist used as a communication
3744 channel."
3750 ;;;; Verse Block
3753 "Transcode a VERSE-BLOCK element from Org to ODT.
3754 CONTENTS is verse block contents. INFO is a plist holding
3755 contextual information."
3756 ;; Add line breaks to each line of verse.
3760 ;; Replace tabs and spaces.
3762 ;; Surround it in a verse environment.
3767 \f
3768 ;;; Filters
3770 ;;;; LaTeX fragments
3775 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3776 ;; If the desired converter is not available, force verbatim
3777 ;; processing.
3794 ;; Store normalized value for later use.
3799 ;; Convert `latex-fragment's and `latex-environment's.
3817 ;; Get an Org-style link to PNG image or the MathML
3818 ;; file.
3823 nil display-msg
3824 nil nil processing-type)
3829 link))))
3831 ;; Conversion succeeded. Parse above Org-style link to a
3832 ;; `link' object.
3838 ;; Orphan the link.
3843 ;; Case 1: LaTeX environment.
3844 ;; Mimic a "standalone image or formula" by
3845 ;; enclosing the `link' in a `paragraph'.
3846 ;; Copy over original attributes, captions to
3847 ;; the enclosing paragraph.
3853 latex-*)
3855 latex-*)))
3856 link))
3857 ;; Case 2: LaTeX fragment.
3858 ;; No special action.
3860 ;; Note down the object that link replaces.
3864 ;; Replace now.
3866 info)))
3867 tree)
3870 ;;;; Description lists
3872 ;; This translator is necessary to handle indented tables in a uniform
3873 ;; manner. See comment in `org-odt--table'.
3876 ;; OpenDocument has no notion of a description list. So simulate it
3877 ;; using plain lists. Description lists in the exported document
3878 ;; are typeset in the same manner as they are in a typical HTML
3879 ;; document.
3880 ;;
3881 ;; Specifically, a description list like this:
3882 ;;
3883 ;; ,----
3884 ;; | - term-1 :: definition-1
3885 ;; | - term-2 :: definition-2
3886 ;; `----
3887 ;;
3888 ;; gets translated in to the following form:
3889 ;;
3890 ;; ,----
3891 ;; | - term-1
3892 ;; | - definition-1
3893 ;; | - term-2
3894 ;; | - definition-2
3895 ;; `----
3896 ;;
3897 ;; Further effect is achieved by fixing the OD styles as below:
3898 ;;
3899 ;; 1. Set the :type property of the simulated lists to
3900 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3901 ;; that has *no* bullets whatsoever.
3902 ;;
3903 ;; 2. The paragraph containing the definition term is styled to be
3904 ;; in bold.
3905 ;;
3910 el
3926 nil)
3927 info)
3928 tree)
3930 ;;;; List tables
3932 ;; Lists that are marked with attribute `:list-table' are called as
3933 ;; list tables. They will be rendered as a table within the exported
3934 ;; document.
3936 ;; Consider an example. The following list table
3937 ;;
3938 ;; #+attr_odt :list-table t
3939 ;; - Row 1
3940 ;; - 1.1
3941 ;; - 1.2
3942 ;; - 1.3
3943 ;; - Row 2
3944 ;; - 2.1
3945 ;; - 2.2
3946 ;; - 2.3
3947 ;;
3948 ;; will be exported as though it were an Org table like the one show
3949 ;; below.
3950 ;;
3951 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3952 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3953 ;;
3954 ;; Note that org-tables are NOT multi-line and each line is mapped to
3955 ;; a unique row in the exported document. So if an exported table
3956 ;; needs to contain a single paragraph (with copious text) it needs to
3957 ;; be typed up in a single line. Editing such long lines using the
3958 ;; table editor will be a cumbersome task. Furthermore inclusion of
3959 ;; multi-paragraph text in a table cell is well-nigh impossible.
3960 ;;
3961 ;; A LIST-TABLE circumvents above problems.
3962 ;;
3963 ;; Note that in the example above the list items could be paragraphs
3964 ;; themselves and the list can be arbitrarily deep.
3965 ;;
3966 ;; Inspired by following thread:
3967 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3969 ;; Translate lists to tables
3975 ;; Replace list with table.
3977 l1-list
3978 ;; Build replacement table.
3984 l1-item-leading-text l2-list)
3985 ;; Remove Level-2 list from the Level-item. It
3986 ;; will be subsequently attached as table-cells.
3996 ;; Level-1 items start a table row.
3999 ;; Leading text of level-1 item define
4000 ;; the first table-cell.
4003 l1-item-leading-text)
4004 ;; Level-2 items define subsequent
4005 ;; table-cells of the row.
4013 nil)
4014 info)
4015 tree)
4017 \f
4018 ;;; Interactive functions
4031 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4040 org-odt-manifest-file-entries)
4048 ;; Initialize temporary workarea. All files that end up in
4049 ;; the exported document get parked/created here.
4056 ;; Kill all XML buffers.
4064 org-odt-xml-files)
4065 ;; Delete temporary directory and also other embedded
4066 ;; files that get copied there.
4071 ;; Not at all OSes ship with zip by default
4073 ;; Do export. This creates a bunch of xml files ready to be
4074 ;; saved and zipped.
4076 ;; Create a manifest entry for content.xml.
4078 ;; Write mimetype file
4087 ;; Write out the manifest entries before zipping
4089 ;; Save all XML files.
4095 ;; Prettify output if needed.
4099 org-odt-xml-files)
4100 ;; Run zip.
4105 ;; If a file with same name as the desired output file
4106 ;; exists, remove it.
4109 ;; Zip up the xml files.
4112 ;; Switch temporarily to content.xml. This way Zip
4113 ;; process will inherit `org-odt-zip-dir' as the current
4114 ;; directory.
4128 err-string)))))
4129 cmds)))
4130 ;; Move the zip file from temporary work directory to
4131 ;; user-mandated location.
4134 ;; Cleanup work directory and work files.
4136 ;; Open the OpenDocument file in archive-mode for
4137 ;; examination.
4139 ;; Return exported file.
4141 ;; Case 1: Conversion desired on exported file. Run the
4142 ;; converter on the OpenDocument file. Return the
4143 ;; converted file.
4146 target))
4147 ;; Case 2: No further conversion. Return exported
4148 ;; OpenDocument file.
4151 ;; Cleanup work directory and work files.
4157 ;;;; Export to OpenDocument formula
4159 ;;;###autoload
4161 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4162 Use `org-create-math-formula' to convert LATEX-FRAG first to
4163 MathML. When invoked as an interactive command, use
4164 `org-latex-regexps' to infer LATEX-FRAG from currently active
4165 region. If no LaTeX fragments are found, prompt for it. Push
4166 MathML source to kill ring depending on the value of
4167 `org-export-copy-to-kill-ring'."
4193 filename
4206 ;; Add MathML to kill ring, if needed.
4210 ;;;###autoload
4212 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4213 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4214 formula file."
4219 ;;;; Export to OpenDocument Text
4221 ;;;###autoload
4223 "Export current buffer to a ODT file.
4225 If narrowing is active in the current buffer, only export its
4226 narrowed part.
4228 If a region is active, export that region.
4230 A non-nil optional argument ASYNC means the process should happen
4231 asynchronously. The resulting file should be accessible through
4232 the `org-export-stack' interface.
4234 When optional argument SUBTREEP is non-nil, export the sub-tree
4235 at point, extracting information from the headline properties
4236 first.
4238 When optional argument VISIBLE-ONLY is non-nil, don't export
4239 contents of hidden elements.
4241 EXT-PLIST, when provided, is a property list with external
4242 parameters overriding Org default settings, but still inferior to
4243 file-local settings.
4245 Return output file's name."
4252 ,outfile
4257 ;; Let `htmlfontify' know that we are interested in
4258 ;; collecting styles.
4260 ;; Initialize content.xml and kick-off the export
4261 ;; process.
4271 outfile
4276 ;; Let `htmlfontify' know that we are interested in collecting
4277 ;; styles.
4279 ;; Initialize content.xml and kick-off the export process.
4289 ;;;; Convert between OpenDocument and other formats
4292 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4301 "Workhorse routine for `org-odt-convert'."
4310 in-fmt out-fmt)))
4338 out-file)
4341 nil))))
4344 "Return verbose info about formats to which IN-FMT can be converted.
4345 Return a list where each element is of the
4346 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4347 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4348 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4352 org-odt-convert-processes t))))
4356 org-odt-convert-processes t))
4357 org-odt-convert-capabilities))
4358 reachable-formats)
4363 reachable-formats))
4366 "Return list of formats to which IN-FMT can be converted.
4367 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4373 l))
4376 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4377 This is a helper routine for interactive use."
4380 nil buffer-file-name t))
4386 out-fmt-choices nil nil nil))
4388 "No known converter or no known output formats for %s files"
4389 in-fmt))))
4392 ;;;###autoload
4394 "Convert IN-FILE to format OUT-FMT using a command line converter.
4395 IN-FILE is the file to be converted. If unspecified, it defaults
4396 to variable `buffer-file-name'. OUT-FMT is the desired output
4397 format. Use `org-odt-convert-process' as the converter.
4398 If PREFIX-ARG is non-nil then the newly converted file is opened
4399 using `org-open-file'."
4404 ;;; Library Initializations
4408 ;; Let Emacs open all OpenDocument files in archive mode
4411 org-odt-file-extensions)
4415 ;; Local variables:
4416 ;; generated-autoload-file: "org-loaddefs.el"
4417 ;; End:
4419 ;;; ox-odt.el ends here