| blob | d33c1c352073b36630782b2d009bcaa052bc53f6 |
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."
463 "Default styles file for use with ODT export.
464 Valid values are one of:
465 1. nil
466 2. path to a styles.xml file
467 3. path to a *.odt or a *.ott file
468 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
469 ...))
471 In case of option 1, an in-built styles.xml is used. See
472 `org-odt-styles-dir' for more information.
474 In case of option 3, the specified file is unzipped and the
475 styles.xml embedded therein is used.
477 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
478 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
479 generated odt file. Use relative path for specifying the
480 FILE-MEMBERS. styles.xml must be specified as one of the
481 FILE-MEMBERS.
483 Use options 1, 2 or 3 only if styles.xml alone suffices for
484 achieving the desired formatting. Use option 4, if the styles.xml
485 references additional files like header and footer images for
486 achieving the desired formatting.
489 a per-file basis. For example,
495 :type
507 "Outline levels considered for enumerating captioned entities."
512 ;;;; Document conversion
519 "Specify a list of document converters and their usage.
520 The converters in this list are offered as choices while
521 customizing `org-odt-convert-process'.
523 This variable is a list where each element is of the
524 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
525 of the converter. CONVERTER-CMD is the shell command for the
526 converter and can contain format specifiers. These format
527 specifiers are interpreted as below:
529 %i input file name in full
530 %I input file name as a URL
531 %f format of the output file
532 %o output file name in full
533 %O output file name as a URL
534 %d output dir in full
535 %D output dir as a URL.
536 %x extra options as set in `org-odt-convert-capabilities'."
539 :type
548 During customization, the list of converter names are populated
549 from `org-odt-convert-processes'."
559 org-odt-convert-processes))))
577 "Specify input and output formats of `org-odt-convert-process'.
578 More correctly, specify the set of input and output formats that
579 the user is actually interested in.
581 This variable is an alist where each element is of the
582 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
583 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
584 alist where each element is of the form (OUTPUT-FMT
585 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
587 The variable is interpreted as follows:
588 `org-odt-convert-process' can take any document that is in
589 INPUT-FMT-LIST and produce any document that is in the
590 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
591 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
592 serves dual purposes:
593 - It is used for populating completion candidates during
594 `org-odt-convert' commands.
596 `org-odt-convert-process'.
599 `org-odt-convert-process'.
601 DOCUMENT-CLASS is used to group a set of file formats in
602 INPUT-FMT-LIST in to a single class.
604 Note that this variable inherently captures how LibreOffice based
605 converters work. LibreOffice maps documents of various formats
606 to classes like Text, Web, Spreadsheet, Presentation etc and
607 allow document of a given class (irrespective of it's source
608 format) to be converted to any of the export formats associated
609 with that class.
611 See default setting of this variable for an typical
612 configuration."
615 :type
620 :value-type
624 :value-type
633 and then uses `org-odt-convert-process' to convert the
634 resulting document to this format. During customization of this
635 variable, the list of valid values are populated based on
636 `org-odt-convert-capabilities'.
638 You can set this option on per-file basis using file local
639 values. See Info node `(emacs) File Variables'."
650 ;;;###autoload
654 ;;;; Drawers
657 "Function called to format a drawer in ODT code.
659 The function must accept two parameters:
661 CONTENTS the contents of the drawer.
663 The function should return the string to be exported.
665 For example, the variable could be set to the following function
666 in order to mimic default behaviour:
668 \(defun org-odt-format-drawer-default \(name contents\)
670 contents\)"
677 ;;;; Headline
680 "Function to format headline text.
682 This function will be called with 5 arguments:
683 TODO the todo keyword \(string or nil\).
684 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
685 PRIORITY the priority of the headline \(integer or nil\)
686 TEXT the main headline text \(string\).
687 TAGS the tags string, separated with colons \(string or nil\).
689 The function result will be used as headline text."
696 ;;;; Inlinetasks
699 "Function called to format an inlinetask in ODT code.
701 The function must accept six parameters:
702 TODO the todo keyword, as a string
703 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
704 PRIORITY the inlinetask priority, as a string
705 NAME the inlinetask name, as a string.
706 TAGS the inlinetask tags, as a string.
707 CONTENTS the contents of the inlinetask, as a string.
709 The function should return the string to be exported."
716 ;;;; LaTeX
719 "Non-nil means process LaTeX math snippets.
721 When set, the exporter will process LaTeX environments and
722 fragments.
724 This option can also be set with the +OPTIONS line,
727 nil Ignore math snippets.
728 `verbatim' Keep everything in verbatim
729 `dvipng' Process the LaTeX fragments to images. This will also
730 include processing of non-math environments.
731 `imagemagick' Convert the LaTeX fragments to pdf files and use
732 imagemagick to convert pdf files to png files.
733 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
734 be loaded.
735 t Synonym for `mathjax'."
747 ;;;; Links
751 "Rules characterizing formula files that can be inlined into ODT.
753 A rule consists in an association whose key is the type of link
754 to consider, and value is a regexp that will be matched against
755 link's path."
762 "Rules characterizing image files that can be inlined into ODT.
764 A rule consists in an association whose key is the type of link
765 to consider, and value is a regexp that will be matched against
766 link's path."
772 "Scaling factor for converting images pixels to inches.
773 Use this for sizing of embedded images. See Info node `(org)
774 Images in ODT export' for more information."
780 ;;;; Src Block
783 "Whether custom styles for colorized source blocks be automatically created.
784 When this option is turned on, the exporter creates custom styles
785 for source blocks based on the advice of `htmlfontify'. Creation
786 of custom styles happen as part of `org-odt-hfy-face-to-css'.
788 When this option is turned off exporter does not create such
789 styles.
791 Use the latter option if you do not want the custom styles to be
792 based on your current display settings. It is necessary that the
793 styles.xml already contains needed styles for colorizing to work.
795 This variable is effective only if
796 `org-odt-fontify-srcblocks' is turned on."
802 "Specify whether or not source blocks need to be fontified.
803 Turn this option on if you want to colorize the source code
804 blocks in the exported file. For colorization to work, you need
805 to make available an enhanced version of `htmlfontify' library."
811 ;;;; Table
824 "Specify how Table Styles should be derived from a Table Template.
825 This is a list where each element is of the
826 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
828 TABLE-STYLE-NAME is the style associated with the table through
831 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
832 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
833 below) that is included in
834 `org-odt-content-template-file'.
836 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
838 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
846 TABLE-CELL-OPTIONS is an alist where each element is of the
847 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
848 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
849 `use-last-row-styles' |
850 `use-first-column-styles' |
851 `use-last-column-styles' |
852 `use-banding-rows-styles' |
853 `use-banding-columns-styles' |
854 `use-first-row-styles'
855 ON-OR-OFF := `t' | `nil'
857 For example, with the following configuration
859 \(setq org-odt-table-styles
861 \(\(use-first-row-styles . t\)
862 \(use-first-column-styles . t\)\)\)
864 \(\(use-first-column-styles . t\)\)\)\)\)
867 style will use the following table-cell styles -
872 as appropriate.
875 use the following table-cell styles -
877 following paragraph styles
879 as appropriate..
881 Note that TABLE-TEMPLATE-NAME corresponds to the
884 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
887 specification for more information. Also consult the
888 implementation filed under `org-odt-get-table-cell-styles'.
891 formatting of numbered display equations. Do not delete this
892 style from the list."
902 use-last-row-styles
903 use-first-column-styles
904 use-last-column-styles
905 use-banding-rows-styles
906 use-banding-columns-styles)
907 :key-type symbol
910 ;;;; Timestamps
913 "Non-nil, if timestamps should be exported as date fields.
915 When nil, export timestamps as plain text.
917 When non-nil, map `org-time-stamp-custom-formats' to a pair of
919 respectively. A timestamp with no time component is formatted
923 This feature is experimental. Most (but not all) of the common
924 %-specifiers in `format-time-string' are supported.
926 formatted as canonical Org timestamps. For finer control, avoid
927 these %-specifiers.
930 etc., are displayed by the application in the default language
931 and country specified in `org-odt-styles-file'. Note that the
933 can localize the week day and month strings in the exported
934 document by setting the default language and country either using
935 the application UI or through a custom styles file.
937 See `org-odt--build-date-styles' for implementation details."
942 \f
943 ;;; Internal functions
945 ;;;; Date
960 ;; LibreOffice does not care about end goes as content
961 ;; within the "<text:date>...</text:date>" field. The
962 ;; displayed date is automagically corrected to match the
963 ;; format requested by "style:data-style-name" attribute. So
964 ;; don't bother about formatting the date contents to be
965 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
966 ;; simple Org-style date should suffice.
991 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
992 iso-date style date)
994 repeater)))))
996 ;;;; Frame
1004 extra
1008 style frame-attrs
1020 ;;;; Library wrappers
1027 ;; This is shamelessly stolen from `archive-zip-extract'.
1033 name)))
1038 exit-code command-output)
1046 members))
1049 ;; See comments in `org-odt-format-label' and `org-odt-toc'.
1052 ;; Override translators.
1053 :translate-alist
1057 ;; Reset data translation cache. FIXME.
1058 ;; :exported-data nil
1059 )))
1062 ;;;; Target
1071 ;;;; Textbox
1074 extra anchor-type)
1080 text)
1081 width nil style extra anchor-type))
1085 ;;;; Table of Contents
1090 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1092 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1099 "
1100 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1102 <text:index-entry-chapter/>
1103 <text:index-entry-text/>
1104 <text:index-entry-link-end/>
1105 </text:table-of-content-entry-template>
1109 </text:table-of-content-source>
1111 <text:index-body>
1114 </text:index-title>
1119 </text:index-body>
1120 </text:table-of-content>
1128 ;; Section number.
1130 ;; Todo.
1135 style todo)))
1140 style priority)))
1141 ;; Title.
1142 text
1143 ;; Tags.
1147 "OrgTags"
1154 headline-label text))
1158 ;; When a headline is marked as a radio target, as in the example below:
1159 ;;
1160 ;; ** <<<Some Heading>>>
1161 ;; Some text.
1162 ;;
1163 ;; suppress generation of radio targets. i.e., Radio targets are to
1164 ;; be marked as targets within /document body/ and *not* within
1165 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1166 ;; and one in the document body.
1167 ;;
1168 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1169 ;; doesn't provide a way to disable memoization. So this doesn't
1170 ;; work.
1171 ;;
1172 ;; FIXME-2: Are there any other objects that need to be suppressed
1173 ;; within TOC?
1180 contents)))
1189 headline translations info
1194 style entry)))
1199 ;;;; Document styles
1202 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1203 OBJECT-PROPS is (typically) a plist created by passing
1205 `org-odt-parse-block-attributes'.
1207 Use `org-odt-object-counters' to generate an automatic
1208 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1209 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1210 . STYLE-NAME)."
1226 ;;;; Checkbox
1229 "Return check-box string associated to ITEM."
1238 ;;; Template
1241 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1242 ;; to modify the date fields. A date could be modified by
1243 ;; offsetting in days. That's about it. Also, date and time may
1244 ;; have to be emitted as two fields - a date field and a time field
1245 ;; - separately.
1247 ;; One can add Form Controls to date and time fields so that they
1248 ;; can be easily modified. But then, the exported document will
1249 ;; become tightly coupled with LibreOffice and may not function
1250 ;; properly with other OpenDocument applications.
1252 ;; I have a strange feeling that Date styles are a bit flaky at the
1253 ;; moment.
1255 ;; The feature is experimental.
1301 ))
1309 filler-end))
1320 style
1323 output ))))
1326 "Return complete document string after ODT conversion.
1327 CONTENTS is the transcoded contents string. RAW-DATA is the
1328 original parsed data. INFO is a plist holding export options."
1329 ;; Write meta file.
1339 <office:document-meta
1349 ;; Date, if required.
1351 ;; Check if DATE is specified as an Org-timestamp. If yes,
1352 ;; include it as meta information. Otherwise, just use
1353 ;; today's date.
1362 iso-date)))))
1373 ;; Add meta.xml in to manifest.
1376 ;; Update styles file.
1377 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1378 ;; Write styles file.
1381 ;; Non-availability of styles.xml is not a critical
1382 ;; error. For now, throw an error.
1384 org-odt-styles-file
1386 org-odt-styles-dir)
1399 members)))
1409 org-odt-styles-file))))
1411 ;; create a manifest entry for styles.xml
1414 ;; FIXME: Who is opening an empty styles.xml before this point?
1419 ;; Write custom styles for source blocks
1420 ;; Save STYLES used for colorizing of source blocks.
1421 ;; Update styles.xml with styles that were collected as part of
1422 ;; `org-odt-hfy-face-to-css' callbacks.
1431 ;; Update styles.xml - take care of outline numbering
1433 ;; Don't make automatic backup of styles.xml file. This setting
1434 ;; prevents the backed-up styles.xml file from being zipped in to
1435 ;; odt file. This is more of a hackish fix. Better alternative
1436 ;; would be to fix the zip command so that the output odt file
1437 ;; includes only the needed files and excludes any auto-generated
1438 ;; extra files like backups and auto-saves etc etc. Note that
1439 ;; currently the zip command zips up the entire temp directory so
1440 ;; that any auto-generated files created under the hood ends up in
1441 ;; the resulting odt file.
1444 ;; Outline numbering is retained only upto LEVEL.
1445 ;; To disable outline numbering pass a LEVEL of 0.
1458 ;; Update content.xml.
1461 ;; within the context of the Org buffer. So obtain it's
1462 ;; value before moving on to temp-buffer context down below.
1472 org-odt-styles-dir)))
1473 ;; Write automatic styles.
1474 ;; - Position the cursor.
1478 ;; - Dump automatic table styles.
1483 ;; - Dump date-styles.
1489 ;; Update display level.
1490 ;; - Remove existing sequence decls. Also position the cursor.
1495 ;; Update sequence decls according to user preference.
1505 ;; Position the cursor to document body.
1510 ;; Preamble - Title, Author, Date etc.
1517 ;; Switch on or off above vars based on user settings
1521 ;; Title.
1526 ;; Separator.
1530 ;; Author only.
1533 "OrgSubtitle"
1535 ;; Separator.
1538 ;; Author and E-mail.
1542 "OrgSubtitle"
1547 ;; Separator.
1549 ;; Date, if required.
1552 ;; Check if DATE is specified as a timestamp.
1558 "OrgSubtitle"
1562 ;; Separator
1564 ;; Table of Contents
1567 with-toc
1570 ;; Contents.
1572 ;; Return contents.
1576 \f
1577 ;;; Transcode Functions
1579 ;;;; Bold
1582 "Transcode BOLD from Org to ODT.
1583 CONTENTS is the text with bold markup. INFO is a plist holding
1584 contextual information."
1589 ;;;; Center Block
1592 "Transcode a CENTER-BLOCK element from Org to ODT.
1593 CONTENTS holds the contents of the center block. INFO is a plist
1594 holding contextual information."
1595 contents)
1598 ;;;; Clock
1601 "Transcode a CLOCK element from Org to ODT.
1602 CONTENTS is nil. INFO is a plist used as a communication
1603 channel."
1616 ;;;; Code
1619 "Transcode a CODE object from Org to ODT.
1620 CONTENTS is nil. INFO is a plist used as a communication
1621 channel."
1627 ;;;; Comment
1629 ;; Comments are ignored.
1632 ;;;; Comment Block
1634 ;; Comment Blocks are ignored.
1637 ;;;; Drawer
1640 "Transcode a DRAWER element from Org to ODT.
1641 CONTENTS holds the contents of the block. INFO is a plist
1642 holding contextual information."
1646 name contents)
1647 ;; If there's no user defined function: simply
1648 ;; display contents of the drawer.
1649 contents)))
1650 output))
1653 ;;;; Dynamic Block
1656 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1657 CONTENTS holds the contents of the block. INFO is a plist
1658 holding contextual information. See `org-export-data'."
1659 contents)
1662 ;;;; Entity
1665 "Transcode an ENTITY object from Org to ODT.
1666 CONTENTS are the definition itself. INFO is a plist holding
1667 contextual information."
1671 ;;;; Example Block
1674 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1675 CONTENTS is nil. INFO is a plist holding contextual information."
1679 ;;;; Export Snippet
1682 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1683 CONTENTS is nil. INFO is a plist holding contextual information."
1688 ;;;; Export Block
1691 "Transcode a EXPORT-BLOCK element from Org to ODT.
1692 CONTENTS is nil. INFO is a plist holding contextual information."
1697 ;;;; Fixed Width
1700 "Transcode a FIXED-WIDTH element from Org to ODT.
1701 CONTENTS is nil. INFO is a plist holding contextual information."
1705 ;;;; Footnote Definition
1707 ;; Footnote Definitions are ignored.
1710 ;;;; Footnote Reference
1713 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1714 CONTENTS is nil. INFO is a plist holding contextual information."
1724 id note-class
1737 "OrgSuperscript"
1738 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1739 note-class ref-format ref-name n)))))))
1741 ;; Insert separator between two footnotes in a row.
1746 ;; Trancode footnote reference.
1751 ;; Inline definitions are secondary strings.
1752 ;; Non-inline footnotes definitions are full Org data.
1755 footnote-reference info))
1764 raw translations info))))
1771 ;;;; Headline
1777 ;; Todo.
1781 style todo)))
1786 style priority)))
1787 ;; Title.
1788 text
1789 ;; Tags.
1792 "<text:tab/>"
1801 &optional format-function
1803 "Transcode a HEADLINE element from Org to ODT.
1804 CONTENTS holds the contents of the headline. INFO is a plist
1805 holding contextual information."
1815 todo translations info)))))
1832 todo todo-type priority text tags))))
1835 todo todo-type priority text tags
1840 "Transcode a HEADLINE element from Org to ODT.
1841 CONTENTS holds the contents of the headline. INFO is a plist
1842 holding contextual information."
1843 ;; Case 1: This is a footnote section: ignore it.
1846 ;; Create the headline text.
1848 ;; Get level relative to current parsed data.
1850 ;; Get canonical label for the headline.
1854 ;; Get user-specified labels for the headline.
1857 ;; Extra targets.
1865 ;; Title.
1868 ;; Case 2. This is a deep sub-tree: export it as a list item.
1869 ;; Also export as items headlines for which no section
1870 ;; format has been found.
1872 ;; Build the real contents of the sub-tree.
1876 ;; Choose style based on list type.
1879 ;; If top-level list, re-start numbering. Otherwise,
1880 ;; continue numbering.
1883 headline)))
1893 "Text_20_body"
1895 contents)
1897 "</text:list-header>"
1901 ;; Case 3. Standard headline. Export it as a section.
1907 level
1909 contents))))))
1912 ;;;; Horizontal Rule
1915 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1916 CONTENTS is nil. INFO is a plist holding contextual information."
1921 ;;;; Inline Babel Call
1923 ;; Inline Babel Calls are ignored.
1926 ;;;; Inline Src Block
1929 "Return a character not used in string S.
1931 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1937 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1938 CONTENTS holds the contents of the item. INFO is a plist holding
1939 contextual information."
1946 ;;;; Inlinetask
1949 "Transcode an INLINETASK element from Org to ODT.
1950 CONTENTS holds the contents of the block. INFO is a plist
1951 holding contextual information."
1953 ;; If `org-odt-format-inlinetask-function' is provided, call it
1954 ;; with appropriate arguments.
1961 todo todo-type priority text tags contents)))))
1964 ;; Otherwise, use a default template.
1967 "Text_20_body"
1971 "OrgInlineTaskHeading"
1973 contents)
1976 ;;;; Italic
1979 "Transcode ITALIC from Org to ODT.
1980 CONTENTS is the text with italic markup. INFO is a plist holding
1981 contextual information."
1986 ;;;; Item
1989 "Transcode an ITEM element from Org to ODT.
1990 CONTENTS holds the contents of the item. INFO is a plist holding
1991 contextual information."
2002 contents
2014 ;;;; Keyword
2017 "Transcode a KEYWORD element from Org to ODT.
2018 CONTENTS is nil. INFO is a plist holding contextual information."
2024 ;; FIXME
2035 ;; FIXME
2039 ;;;; Latex Environment
2042 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2043 ;; (defadvice org-format-latex-as-mathml ; FIXME
2044 ;; (after org-odt-protect-latex-fragment activate)
2045 ;; "Encode LaTeX fragment as XML.
2046 ;; Do this when translation to MathML fails."
2047 ;; (unless (> (length ad-return-value) 0)
2048 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2051 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2052 CONTENTS is nil. INFO is a plist holding contextual information."
2058 ;;;; Latex Fragment
2060 ;; (when latex-frag ; FIXME
2061 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2062 ;; :description latex-frag)))
2063 ;; handle verbatim
2064 ;; provide descriptions
2067 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2068 CONTENTS is nil. INFO is a plist holding contextual information."
2075 ;;;; Line Break
2078 "Transcode a LINE-BREAK object from Org to ODT.
2079 CONTENTS is nil. INFO is a plist holding contextual information."
2083 ;;;; Link
2085 ;;;; Links :: Label references
2096 x)))))
2107 counter))
2114 ;; Section number.
2118 ;; Separator.
2120 ;; Ordinal.
2122 tag))
2130 ;; Get label and caption.
2134 ;; Transcode captions.
2136 ;; Currently short caption are sneaked in as object names.
2137 ;;
2138 ;; The advantages are:
2139 ;;
2140 ;; - Table Of Contents: Currently, there is no support for
2141 ;; building TOC for figures, listings and tables. See
2142 ;; `org-odt-keyword'. User instead has to rely on
2143 ;; external application for building such indices. Within
2144 ;; LibreOffice, building an "Illustration Index" or "Index
2145 ;; of Tables" will create a table with long captions (only)
2146 ;; and building a table with "Object names" will create a
2147 ;; table with short captions.
2148 ;;
2149 ;; - Easy navigation: In LibreOffice, object names are
2150 ;; offered via the navigation bar. This way one can
2151 ;; quickly locate and jump to object of his choice in the
2152 ;; exported document.
2153 ;;
2154 ;; The main disadvantage is that there cannot be any markups
2155 ;; within object names i.e., one cannot embolden, italicize
2156 ;; or underline text within short caption. So suppress
2157 ;; generation of <text:span >...</text:span> and other
2158 ;; markups by overriding the default translators. We
2159 ;; probably shouldn't be suppressing translators for all
2160 ;; elements in `org-element-all-objects', but for now this
2161 ;; will do.
2167 contents)))
2168 org-element-all-objects)
2172 translations info)))))
2187 element))))
2190 seqno)
2194 ;; Compute sequence number of the element.
2196 ;; Localize category string.
2199 ;; Case 1: Handle Label definition.
2201 ;; Assign an internal label, if user has not provided one
2206 ;; Sneak in a bookmark. The bookmark is used when the
2207 ;; labeled element is referenced with a link that
2208 ;; provides it's own description.
2210 ;; Label definition: Typically formatted as below:
2211 ;; CATEGORY SEQ-NO: LONG CAPTION
2216 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2217 label counter counter seqno))
2219 short-caption))
2220 ;; Case 2: Handle Label reference.
2227 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2233 ;;;; Links :: Inline Images
2236 "Returns the internal name of the file"
2252 target-file))
2255 user-height scale dpi embed-as)
2275 ;; Use Imagemagick.
2280 file))))
2285 ;; Use Emacs.
2291 ;; Use hard-coded values.
2293 org-odt-default-image-sizes-alist))
2294 ;; Error out.
2307 ;; ensure that an embedded image fits comfortably within a page
2318 "Return ODT code for an inline image.
2319 LINK is the link pointing to the inline image. INFO is a plist
2320 used as a communication channel."
2333 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2335 ;; Extract attributes from #+ATTR_ODT line.
2339 ;; Convert attributes to a plist.
2341 ;; Handle `:anchor', `:style' and `:attributes' properties.
2351 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2352 ;; extrac
2353 ;;
2354 ;; Handle `:width', `:height' and `:scale' properties. Read
2355 ;; them as numbers since we need them for computations.
2357 src-expanded
2364 nil ; embed-as
2366 ))
2373 ;; Check if this link was created by LaTeX-to-PNG converter.
2377 ;; If yes, note down the type of the element - LaTeX Fragment
2378 ;; or LaTeX environment. It will go in to frame title.
2382 ;; If yes, note down it's contents. It will go in to frame
2383 ;; description. This quite useful for debugging.
2386 captions user-frame-params title desc)))
2389 ;;;; Links :: Math formula
2410 ;; Check if this link was created by LaTeX-to-MathML
2411 ;; converter.
2415 ;; If yes, note down the type of the element - LaTeX Fragment
2416 ;; or LaTeX environment. It will go in to frame title.
2420 ;; If yes, note down it's contents. It will go in to frame
2421 ;; description. This quite useful for debugging.
2423 width height)
2427 nil nil title desc))
2430 "CaptionedDisplayFormula" href width height
2431 captions nil title desc))
2435 org-odt--enumerable-formula-p))))
2440 "Returns the internal name of the file"
2444 ;; Create a directory for holding formula file. Also enter it in
2445 ;; to manifest.
2449 ;; Copy over the formula file from user directory to zip
2450 ;; directory.
2454 ;; Case 1: Mathml.
2457 ;; Case 2: OpenDocument formula.
2462 ;; Enter the formula file in to manifest.
2464 target-file))
2466 ;;;; Targets
2469 captions user-frame-params
2472 ;; Each element of this alist is of the form (CFG-HANDLE
2473 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2475 ;; CFG-HANDLE is the key to the alist.
2477 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2478 ;; frame params for INNER-FRAME and OUTER-FRAME
2479 ;; respectively. See below.
2481 ;; Configurations that are meant to be applied to
2482 ;; non-captioned image/formula specifies no
2483 ;; OUTER-FRAME-PARAMS.
2485 ;; TERMINOLOGY
2486 ;; ===========
2487 ;; INNER-FRAME :: Frame that directly surrounds an
2488 ;; image/formula.
2490 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2491 ;; frame also contains the caption, if any.
2493 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2494 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2495 ;; that these are the last three arguments
2496 ;; to `org-odt--frame'.
2498 ;; Note that an un-captioned image/formula requires just an
2499 ;; INNER-FRAME, while a captioned image/formula requires
2500 ;; both an INNER and an OUTER-FRAME.
2522 ;; Retrieve inner and outer frame params, from configuration.
2526 ;; User-specified frame params (from #+ATTR_ODT spec)
2530 "Merge default and user frame params."
2535 for d in default
2538 ;; Case 1: Image/Formula has no caption.
2539 ;; There is only one frame, one that surrounds the image
2540 ;; or formula.
2542 ;; Merge user frame params with that from configuration.
2546 ;; Case 2: Image/Formula is captioned or labeled.
2547 ;; There are two frames: The inner one surrounds the
2548 ;; image or formula. The outer one contains the
2549 ;; caption/sequence number.
2551 ;; Merge user frame params with outer frame params.
2553 ;; Short caption, if specified, goes as part of inner frame.
2560 frame-params))
2563 "Illustration"
2567 caption))
2568 width height outer)))))
2571 ;; Element should have a caption or label.
2577 element info
2578 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2579 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2580 ;; processing.)
2585 ;; Link should point to an image file.
2592 element info
2593 ;; Paragraph should have a caption or label. It SHOULD also be a
2594 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2595 ;; processing.)
2600 ;; Link should point to an image file.
2607 element info
2608 ;; Paragraph should have a caption or label.
2612 ;; Link should point to a MathML or ODF file.
2618 paragraph-predicate
2619 link-predicate)
2620 "Test if ELEMENT is a standalone link for the purpose ODT export.
2621 INFO is a plist holding contextual information.
2623 Return non-nil, if ELEMENT is of type paragraph satisfying
2624 PARAGRAPH-PREDICATE and it's sole content, save for whitespaces,
2625 is a link that satisfies LINK-PREDICATE.
2627 Return non-nil, if ELEMENT is of type link satisfying
2628 LINK-PREDICATE and it's containing paragraph satisfies
2629 PARAGRAPH-PREDICATE inaddtion to having no other content save for
2630 leading and trailing whitespaces.
2632 Return nil, otherwise."
2655 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2656 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2657 ;; attached. Note that labels that are attached to captioned
2658 ;; entities - inline images, math formulae and tables - get resolved
2659 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2661 ;; Create a cross-reference to DESTINATION but make best-efforts to
2662 ;; create a *meaningful* description. Check item numbers, section
2663 ;; number and section title in that order.
2665 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2666 ;; FIXME: Handle footnote-definition footnote-reference?
2682 return x))
2683 ;; Get list item nos.
2688 plain-list)
2691 item info t))))))
2692 ;; Locate top-most listified headline.
2697 return x))
2698 ;; Get listified headline numbers.
2704 el info t)))))))
2705 ;; Combine item numbers from both the listified headlines and
2706 ;; regular list items.
2708 ;; Case 1: Check if all the parents of list item are numbered.
2709 ;; If yes, link to the item proper.
2712 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2717 ;; Case 2: Locate a regular and numbered headline in the
2718 ;; hierarchy. Display it's section number.
2723 return el)))
2724 ;; We found one.
2726 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2730 ;; Case 4: Locate a regular headline in the hierarchy. Display
2731 ;; it's title.
2735 return el)))
2736 ;; We found one.
2738 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2745 "Transcode a LINK object from Org to ODT.
2747 DESC is the description part of the link, or the empty string.
2748 INFO is a plist holding contextual information. See
2749 `org-export-data'."
2752 ;; Ensure DESC really exists, or set it to nil.
2755 link org-odt-inline-image-rules))
2764 ;; Convert & to & for correct XML representation
2766 protocol)
2768 ;; Image file.
2770 link org-odt-inline-image-rules))
2772 ;; Formula file.
2774 link org-odt-inline-formula-rules))
2776 ;; Radio target: Transcode target's contents and use them as
2777 ;; link's description.
2784 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2785 href desc)))))
2786 ;; Links pointing to a headline: Find destination and build
2787 ;; appropriate referencing command.
2793 ;; Case 1: Fuzzy link points nowhere.
2799 ;; Case 2: Fuzzy link points to an invisible target. Strip it.
2801 ;; Case 3: LINK points to a headline.
2803 ;; Case 3.1: LINK has a custom description that is
2804 ;; different from headline's title. Create a hyperlink.
2809 destination)))))
2811 destination info))
2815 label desc))))
2816 ;; Case 4: LINK points to an Inline image, Math formula or a Table.
2821 ;; Case 4.1: LINK has no description. Create a
2822 ;; cross-reference showing entity's sequence number.
2824 ;; Case 4.2: LINK has description. Insert a hyperlink
2825 ;; with user-provided description.
2828 destination))
2830 ;; Get label and caption.
2834 ;; Case 5: Fuzzy link points to a TARGET.
2836 ;; Case 5.1: LINK has description. Create a hyperlink.
2841 ;; LINK has no description. It points to either a HEADLINE or
2842 ;; an ELEMENT with a #+NAME: LABEL attached to it. LINK to
2843 ;; DESTINATION, but make a best effort to provide
2844 ;; a *meaningful* description.
2846 ;; Coderef: replace link with the reference name or the
2847 ;; equivalent line number.
2854 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2855 href line-no))))
2856 ;; Link type is handled by a special function.
2859 ;; External link with a description part.
2862 ;; Check if description is a link to an inline image.
2867 desc-element org-odt-inline-image-rules))))
2868 ;; Format link as a clickable image.
2870 path desc)
2871 ;; Otherwise, format it as a regular link.
2873 path desc))))
2874 ;; External link without a description part.
2877 path path))
2878 ;; No path, only description. Try to do something useful.
2883 ;;;; Paragraph
2886 "Format paragraph according to given styles.
2887 PARAGRAPH is a paragraph type element. CONTENTS is the
2888 transcoded contents of that paragraph, as a string. DEFAULT,
2889 CENTER and QUOTE are, respectively, style to use when paragraph
2890 belongs to no special environment, a center block, or a quote
2891 block."
2898 ;; If this paragraph is a leading paragraph in an item and the
2899 ;; item has a checkbox, splice the checkbox and paragraph contents
2900 ;; together.
2907 "Transcode a PARAGRAPH element from Org to ODT.
2908 CONTENTS is the contents of the paragraph, as a string. INFO is
2909 the plist used as a communication channel."
2911 paragraph contents
2913 "OrgCenter"
2917 ;;;; Plain List
2920 "Transcode a PLAIN-LIST element from Org to ODT.
2921 CONTENTS is the contents of the list. INFO is a plist holding
2922 contextual information."
2924 ;; Choose style based on list type.
2930 ;; If top-level list, re-start numbering. Otherwise,
2931 ;; continue numbering.
2936 contents))
2938 ;;;; Plain Text
2951 line))
2962 "Transcode a TEXT string from Org to ODT.
2963 TEXT is the string to transcode. INFO is a plist holding
2964 contextual information."
2966 ;; Protect &, < and >.
2968 ;; Handle smart quotes. Be sure to provide original string since
2969 ;; OUTPUT may have been modified.
2971 ;; Convert special strings.
2977 org-odt-special-string-regexps))
2978 ;; Handle break preservation if required.
2982 ;; Return value.
2983 output))
2986 ;;;; Planning
2989 "Transcode a PLANNING element from Org to ODT.
2990 CONTENTS is nil. INFO is a plist used as a communication
2991 channel."
2993 "OrgPlanning"
3015 ;;;; Property Drawer
3018 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3019 CONTENTS is nil. INFO is a plist holding contextual
3020 information."
3021 ;; The property drawer isn't exported but we want separating blank
3022 ;; lines nonetheless.
3026 ;;;; Quote Block
3029 "Transcode a QUOTE-BLOCK element from Org to ODT.
3030 CONTENTS holds the contents of the block. INFO is a plist
3031 holding contextual information."
3032 contents)
3035 ;;;; Quote Section
3038 "Transcode a QUOTE-SECTION element from Org to ODT.
3039 CONTENTS is nil. INFO is a plist holding contextual information."
3045 ;;;; Section
3050 style
3052 text)))
3056 "Transcode a SECTION element from Org to ODT.
3057 CONTENTS holds the contents of the section. INFO is a plist
3058 holding contextual information."
3059 contents)
3061 ;;;; Radio Target
3064 "Transcode a RADIO-TARGET object from Org to ODT.
3065 TEXT is the text of the target. INFO is a plist holding
3066 contextual information."
3072 ;;;; Special Block
3075 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3076 CONTENTS holds the contents of the block. INFO is a plist
3077 holding contextual information."
3081 ;; Annotation.
3087 ;; FIXME: Is `car' right thing to do below?
3097 contents)))))
3098 ;; Textbox.
3107 style extra anchor))))
3111 ;;;; Src Block
3114 "Create custom style for face FN.
3115 When FN is the default face, use it's foreground and background
3117 use it's color attribute to create a character style whose name
3118 is obtained from FN. Currently all attributes of FN other than
3119 color are ignored.
3121 The style name for a face FN is derived using the following
3122 operations on the face name in that order - de-dash, CamelCase
3124 `font-lock-function-name-face' is associated with
3139 background-color-val color-val))
3142 "
3173 org-odt-fontify-srcblocks
3190 code
3201 par-style loc))
3204 num-start refs))
3218 ;; Extract code and references.
3222 ;; Does the src block contain labels?
3224 ;; Does it have line numbers?
3231 "Transcode a SRC-BLOCK element from Org to ODT.
3232 CONTENTS holds the contents of the item. INFO is a plist holding
3233 contextual information."
3245 "Text_20_body"
3249 ;;;; Statistics Cookie
3252 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3253 CONTENTS is nil. INFO is a plist holding contextual information."
3259 ;;;; Strike-Through
3262 "Transcode STRIKE-THROUGH from Org to ODT.
3263 CONTENTS is the text with strike-through markup. INFO is a plist
3264 holding contextual information."
3269 ;;;; Subscript
3272 "Transcode a SUBSCRIPT object from Org to ODT.
3273 CONTENTS is the contents of the object. INFO is a plist holding
3274 contextual information."
3279 ;;;; Superscript
3282 "Transcode a SUPERSCRIPT object from Org to ODT.
3283 CONTENTS is the contents of the object. INFO is a plist holding
3284 contextual information."
3289 ;;;; Table Cell
3298 "Retrieve styles applicable to a table cell.
3299 R and C are (zero-based) row and column numbers of the table
3300 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3301 applicable to the current table. It is `nil' if the table is not
3302 associated with any style attributes.
3304 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3306 When STYLE-SPEC is nil, style the table cell the conventional way
3307 - choose cell borders based on row and column groupings and
3308 choose paragraph alignment based on `org-col-cookies' text
3309 property. See also
3310 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3312 When STYLE-SPEC is non-nil, ignore the above cookie and return
3313 styles congruent with the ODF-1.2 specification."
3319 info)))
3321 ;; LibreOffice - particularly the Writer - honors neither table
3322 ;; templates nor custom table-cell styles. Inorder to retain
3323 ;; inter-operability with LibreOffice, only automatic styles are
3324 ;; used for styling of table-cells. The current implementation is
3325 ;; congruent with ODF-1.2 specification and hence is
3326 ;; future-compatible.
3328 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3329 ;; which recognizes as many as 16 different cell types - is much
3330 ;; richer. Unfortunately it is NOT amenable to easy configuration
3331 ;; by hand.
3358 "Transcode a TABLE-CELL element from Org to ODT.
3359 CONTENTS is nil. INFO is a plist used as a communication
3360 channel."
3367 table-cell info))
3390 table-cell info))))))
3394 custom-style-prefix))
3396 "OrgTblCell"
3412 cell-attributes
3415 org-element-all-elements)
3416 contents
3418 paragraph-style contents))))
3425 ;;;; Table Row
3428 "Transcode a TABLE-ROW element from Org to ODT.
3429 CONTENTS is the contents of the row. INFO is a plist used as a
3430 communication channel."
3431 ;; Rules are ignored since table separators are deduced from
3432 ;; borders of the current row.
3438 ;; If the row belongs to the first rowgroup and the
3439 ;; table has more than one row groups, then this row
3440 ;; belongs to the header row group.
3442 ;; Otherwise, it belongs to non-header row group.
3445 ;; Does this row begin a rowgroup?
3448 ;; Actual table row
3450 ;; Does this row end a rowgroup?
3455 ;;;; Table
3468 "Transcode a TABLE element from Org to ODT.
3469 CONTENTS is the contents of the table. INFO is a plist holding
3470 contextual information."
3472 ;; Case 1: table.el doesn't support export to OD format. Strip
3473 ;; such tables from export.
3478 "(ox-odt): Found table.el-type table in the source Org file."
3479 " table.el doesn't support export to ODT format."
3481 ;; Case 2: Native Org tables.
3498 column-style))
3499 out)
3503 ;; caption.
3507 ;; begin table.
3515 ;; column specification.
3517 ;; actual contents.
3519 ;; end table.
3523 "Transcode a TABLE element from Org to ODT.
3524 CONTENTS is the contents of the table. INFO is a plist holding
3525 contextual information.
3527 Use `org-odt--table' to typeset the table. Handle details
3528 pertaining to indentation here."
3543 collect el)))
3549 collect
3554 parent-list)
3556 ;; Handle list genealogy.
3576 parent-list info)
3579 ;; Handle low-level headlines.
3581 with step = 'item collect
3589 el info)
3590 "OrgNumberedList"
3601 parent-list info)))
3609 table info)))
3610 ;; OpenDocument schema does not permit table to occur within a
3611 ;; list item.
3613 ;; One solution - the easiest and lightweight, in terms of
3614 ;; implementation - is to put the table in an indented text box
3615 ;; and make the text box part of the list-item. Unfortunately if
3616 ;; the table is big and spans multiple pages, the text box could
3617 ;; overflow. In this case, the following attribute will come
3618 ;; handy.
3620 ;; ,---- From OpenDocument-v1.1.pdf
3621 ;; | 15.27.28 Overflow behavior
3622 ;; |
3623 ;; | For text boxes contained within text document, the
3624 ;; | style:overflow-behavior property specifies the behavior of text
3625 ;; | boxes where the containing text does not fit into the text
3626 ;; | box.
3627 ;; |
3628 ;; | If the attribute's value is clip, the text that does not fit
3629 ;; | into the text box is not displayed.
3630 ;; |
3631 ;; | If the attribute value is auto-create-new-frame, a new frame
3632 ;; | will be created on the next page, with the same position and
3633 ;; | dimensions of the original frame.
3634 ;; |
3635 ;; | If the style:overflow-behavior property's value is
3636 ;; | auto-create-new-frame and the text box has a minimum width or
3637 ;; | height specified, then the text box will grow until the page
3638 ;; | bounds are reached before a new frame is created.
3639 ;; `----
3641 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3642 ;; auto-create-new-frame property and always resorts to clipping
3643 ;; the text box. This results in table being truncated.
3645 ;; So we solve the problem the hard (and fun) way using list
3646 ;; continuations.
3648 ;; The problem only becomes more interesting if you take in to
3649 ;; account the following facts:
3650 ;;
3651 ;; - Description lists are simulated as plain lists.
3652 ;; - Low-level headlines can be listified.
3653 ;; - In Org-mode, a table can occur not only as a regular list
3654 ;; item, but also within description lists and low-level
3655 ;; headlines.
3657 ;; See `org-odt-translate-description-lists' and
3658 ;; `org-odt-translate-low-level-headlines' for how this is
3659 ;; tackled.
3662 ;; Discontinue the list.
3664 ;; Put the table in an indented section.
3669 ;; Continue the list.
3673 ;;;; Target
3676 "Transcode a TARGET object from Org to ODT.
3677 CONTENTS is nil. INFO is a plist holding contextual
3678 information."
3683 ;;;; Timestamp
3686 "Transcode a TIMESTAMP object from Org to ODT.
3687 CONTENTS is nil. INFO is a plist used as a communication
3688 channel."
3705 "OrgActiveTimestamp"
3709 "OrgInactiveTimestamp"
3713 "OrgActiveTimestamp"
3719 "OrgInactiveTimestamp"
3725 "OrgDiaryTimestamp"
3727 info)))))))
3730 ;;;; Underline
3733 "Transcode UNDERLINE from Org to ODT.
3734 CONTENTS is the text with underline markup. INFO is a plist
3735 holding contextual information."
3740 ;;;; Verbatim
3743 "Transcode a VERBATIM object from Org to ODT.
3744 CONTENTS is nil. INFO is a plist used as a communication
3745 channel."
3751 ;;;; Verse Block
3754 "Transcode a VERSE-BLOCK element from Org to ODT.
3755 CONTENTS is verse block contents. INFO is a plist holding
3756 contextual information."
3757 ;; Add line breaks to each line of verse.
3761 ;; Replace tabs and spaces.
3763 ;; Surround it in a verse environment.
3768 \f
3769 ;;; Filters
3771 ;;;; LaTeX fragments
3776 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3777 ;; If the desired converter is not available, force verbatim
3778 ;; processing.
3795 ;; Store normalized value for later use.
3800 ;; Convert `latex-fragment's and `latex-environment's.
3818 ;; Get an Org-style link to PNG image or the MathML
3819 ;; file.
3824 nil display-msg
3825 nil nil processing-type)
3830 link))))
3832 ;; Conversion succeeded. Parse above Org-style link to a
3833 ;; `link' object.
3839 ;; Orphan the link.
3844 ;; Case 1: LaTeX environment.
3845 ;; Mimic a "standalone image or formula" by
3846 ;; enclosing the `link' in a `paragraph'.
3847 ;; Copy over original attributes, captions to
3848 ;; the enclosing paragraph.
3854 latex-*)
3856 latex-*)))
3857 link))
3858 ;; Case 2: LaTeX fragment.
3859 ;; No special action.
3861 ;; Note down the object that link replaces.
3865 ;; Replace now.
3867 info)))
3868 tree)
3871 ;;;; Description lists
3873 ;; This translator is necessary to handle indented tables in a uniform
3874 ;; manner. See comment in `org-odt--table'.
3877 ;; OpenDocument has no notion of a description list. So simulate it
3878 ;; using plain lists. Description lists in the exported document
3879 ;; are typeset in the same manner as they are in a typical HTML
3880 ;; document.
3881 ;;
3882 ;; Specifically, a description list like this:
3883 ;;
3884 ;; ,----
3885 ;; | - term-1 :: definition-1
3886 ;; | - term-2 :: definition-2
3887 ;; `----
3888 ;;
3889 ;; gets translated in to the following form:
3890 ;;
3891 ;; ,----
3892 ;; | - term-1
3893 ;; | - definition-1
3894 ;; | - term-2
3895 ;; | - definition-2
3896 ;; `----
3897 ;;
3898 ;; Further effect is achieved by fixing the OD styles as below:
3899 ;;
3900 ;; 1. Set the :type property of the simulated lists to
3901 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3902 ;; that has *no* bullets whatsoever.
3903 ;;
3904 ;; 2. The paragraph containing the definition term is styled to be
3905 ;; in bold.
3906 ;;
3911 el
3927 nil)
3928 info)
3929 tree)
3931 ;;;; List tables
3933 ;; Lists that are marked with attribute `:list-table' are called as
3934 ;; list tables. They will be rendered as a table within the exported
3935 ;; document.
3937 ;; Consider an example. The following list table
3938 ;;
3939 ;; #+attr_odt :list-table t
3940 ;; - Row 1
3941 ;; - 1.1
3942 ;; - 1.2
3943 ;; - 1.3
3944 ;; - Row 2
3945 ;; - 2.1
3946 ;; - 2.2
3947 ;; - 2.3
3948 ;;
3949 ;; will be exported as though it were an Org table like the one show
3950 ;; below.
3951 ;;
3952 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3953 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3954 ;;
3955 ;; Note that org-tables are NOT multi-line and each line is mapped to
3956 ;; a unique row in the exported document. So if an exported table
3957 ;; needs to contain a single paragraph (with copious text) it needs to
3958 ;; be typed up in a single line. Editing such long lines using the
3959 ;; table editor will be a cumbersome task. Furthermore inclusion of
3960 ;; multi-paragraph text in a table cell is well-nigh impossible.
3961 ;;
3962 ;; A LIST-TABLE circumvents above problems.
3963 ;;
3964 ;; Note that in the example above the list items could be paragraphs
3965 ;; themselves and the list can be arbitrarily deep.
3966 ;;
3967 ;; Inspired by following thread:
3968 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3970 ;; Translate lists to tables
3976 ;; Replace list with table.
3978 l1-list
3979 ;; Build replacement table.
3985 l1-item-leading-text l2-list)
3986 ;; Remove Level-2 list from the Level-item. It
3987 ;; will be subsequently attached as table-cells.
3997 ;; Level-1 items start a table row.
4000 ;; Leading text of level-1 item define
4001 ;; the first table-cell.
4004 l1-item-leading-text)
4005 ;; Level-2 items define subsequent
4006 ;; table-cells of the row.
4014 nil)
4015 info)
4016 tree)
4018 \f
4019 ;;; Interactive functions
4032 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4041 org-odt-manifest-file-entries)
4049 ;; Initialize temporary workarea. All files that end up in
4050 ;; the exported document get parked/created here.
4057 ;; Kill all XML buffers.
4065 org-odt-xml-files)
4066 ;; Delete temporary directory and also other embedded
4067 ;; files that get copied there.
4072 ;; Not at all OSes ship with zip by default
4074 ;; Do export. This creates a bunch of xml files ready to be
4075 ;; saved and zipped.
4077 ;; Create a manifest entry for content.xml.
4079 ;; Write mimetype file
4088 ;; Write out the manifest entries before zipping
4090 ;; Save all XML files.
4096 ;; Prettify output if needed.
4100 org-odt-xml-files)
4101 ;; Run zip.
4106 ;; If a file with same name as the desired output file
4107 ;; exists, remove it.
4110 ;; Zip up the xml files.
4113 ;; Switch temporarily to content.xml. This way Zip
4114 ;; process will inherit `org-odt-zip-dir' as the current
4115 ;; directory.
4129 err-string)))))
4130 cmds)))
4131 ;; Move the zip file from temporary work directory to
4132 ;; user-mandated location.
4135 ;; Cleanup work directory and work files.
4137 ;; Open the OpenDocument file in archive-mode for
4138 ;; examination.
4140 ;; Return exported file.
4142 ;; Case 1: Conversion desired on exported file. Run the
4143 ;; converter on the OpenDocument file. Return the
4144 ;; converted file.
4147 target))
4148 ;; Case 2: No further conversion. Return exported
4149 ;; OpenDocument file.
4152 ;; Cleanup work directory and work files.
4158 ;;;; Export to OpenDocument formula
4160 ;;;###autoload
4162 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4163 Use `org-create-math-formula' to convert LATEX-FRAG first to
4164 MathML. When invoked as an interactive command, use
4165 `org-latex-regexps' to infer LATEX-FRAG from currently active
4166 region. If no LaTeX fragments are found, prompt for it. Push
4167 MathML source to kill ring depending on the value of
4168 `org-export-copy-to-kill-ring'."
4194 filename
4207 ;; Add MathML to kill ring, if needed.
4211 ;;;###autoload
4213 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4214 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4215 formula file."
4220 ;;;; Export to OpenDocument Text
4222 ;;;###autoload
4224 "Export current buffer to a ODT file.
4226 If narrowing is active in the current buffer, only export its
4227 narrowed part.
4229 If a region is active, export that region.
4231 A non-nil optional argument ASYNC means the process should happen
4232 asynchronously. The resulting file should be accessible through
4233 the `org-export-stack' interface.
4235 When optional argument SUBTREEP is non-nil, export the sub-tree
4236 at point, extracting information from the headline properties
4237 first.
4239 When optional argument VISIBLE-ONLY is non-nil, don't export
4240 contents of hidden elements.
4242 EXT-PLIST, when provided, is a property list with external
4243 parameters overriding Org default settings, but still inferior to
4244 file-local settings.
4246 Return output file's name."
4253 ,outfile
4258 ;; Let `htmlfontify' know that we are interested in
4259 ;; collecting styles.
4261 ;; Initialize content.xml and kick-off the export
4262 ;; process.
4272 outfile
4277 ;; Let `htmlfontify' know that we are interested in collecting
4278 ;; styles.
4280 ;; Initialize content.xml and kick-off the export process.
4290 ;;;; Convert between OpenDocument and other formats
4293 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4302 "Workhorse routine for `org-odt-convert'."
4311 in-fmt out-fmt)))
4339 out-file)
4342 nil))))
4345 "Return verbose info about formats to which IN-FMT can be converted.
4346 Return a list where each element is of the
4347 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4348 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4349 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4353 org-odt-convert-processes t))))
4357 org-odt-convert-processes t))
4358 org-odt-convert-capabilities))
4359 reachable-formats)
4364 reachable-formats))
4367 "Return list of formats to which IN-FMT can be converted.
4368 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4374 l))
4377 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4378 This is a helper routine for interactive use."
4381 nil buffer-file-name t))
4387 out-fmt-choices nil nil nil))
4389 "No known converter or no known output formats for %s files"
4390 in-fmt))))
4393 ;;;###autoload
4395 "Convert IN-FILE to format OUT-FMT using a command line converter.
4396 IN-FILE is the file to be converted. If unspecified, it defaults
4397 to variable `buffer-file-name'. OUT-FMT is the desired output
4398 format. Use `org-odt-convert-process' as the converter.
4399 If PREFIX-ARG is non-nil then the newly converted file is opened
4400 using `org-open-file'."
4405 ;;; Library Initializations
4409 ;; Let Emacs open all OpenDocument files in archive mode
4412 org-odt-file-extensions)
4416 ;; Local variables:
4417 ;; generated-autoload-file: "org-loaddefs.el"
4418 ;; End:
4420 ;;; ox-odt.el ends here