| blob | 29bc87875a1525edce367f32dd7d2bf281995d93 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2015 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
89 org-odt--translate-description-lists
90 org-odt--translate-list-tables)))
91 :menu-entry
98 :options-alist
100 ;; Redefine regular option.
104 ;;; Dependencies
106 ;;; Hooks
108 ;;; Function Declarations
118 \f
119 ;;; Internal Variables
123 "Location of ODT exporter.
124 Use this to infer values of `org-odt-styles-dir' and
129 "Data directory for ODT exporter.
130 Use this to infer values of `org-odt-styles-dir' and
147 "List of directories to search for OpenDocument schema files.
148 Use this list to set the default value of
149 `org-odt-schema-dir'. The entries in this list are
150 populated heuristically based on the values of `org-odt-lib-dir'
163 )
164 "List of directories to search for OpenDocument styles files.
165 See `org-odt-styles-dir'. The entries in this list are populated
166 heuristically based on the values of `org-odt-lib-dir' and
183 styles-dir)
185 org-odt-styles-dir-list)
186 nil)))
189 styles-dir)
190 "Directory that holds auxiliary XML files used by the ODT exporter.
192 This directory contains the following XML files -
194 XML files are used as the default values of
195 `org-odt-styles-file' and
196 `org-odt-content-template-file'.
198 The default value of this variable varies depending on the
199 version of org in use and is initialized from
200 `org-odt-styles-dir-list'. Note that the user could be using org
201 from one of: org's own private git repository, GNU ELPA tar or
224 "
226 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
227 </style:style>
228 "
232 "Registry of automatic styles for various OBJECT-TYPEs.
233 The variable has the following form:
234 \(\(OBJECT-TYPE-A
235 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
236 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
237 \(OBJECT-TYPE-B
238 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
239 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
240 ...\).
243 OBJECT-PROPS is (typically) a plist created by passing
249 "Running counters for various OBJECT-TYPEs.
250 Use this to generate automatic names and style-names. See
254 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
255 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
256 <style:background-image/>
257 </style:paragraph-properties>
259 </style:style>"
260 "Custom paragraph style for colorized source and example blocks.
262 except that the foreground and background colors are set
276 "Hardcoded image dimensions one for each of the anchor
279 ;; A4 page size is 21.0 by 29.7 cms
280 ;; The default page settings has 2cm margin on each of the sides. So
281 ;; the effective text area is 17.0 by 25.7 cm
290 "Specify how labels are applied and referenced.
292 This is an alist where each element is of the form:
294 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
296 ATTACH-FMT controls how labels and captions are attached to an
297 entity. It may contain following specifiers - %e and %c. %e is
298 replaced with the CATEGORY-NAME. %n is replaced with
300 with CAPTION.
302 REF-MODE and REF-FMT controls how label references are generated.
303 The following XML is generated for a label reference -
306 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
307 %n is replaced with SEQNO.
317 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
319 This is a list where each entry is of the form:
321 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
323 CATEGORY_HANDLE identifies the captionable entity in question.
325 OD-VARIABLE is the OpenDocument sequence counter associated with
326 the entity. These counters are declared within
328 `org-odt-content-template-file'.
330 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
331 how a given entity should be captioned and referenced.
333 CATEGORY-NAME is used for qualifying captions on export.
335 ENUMERATOR-PREDICATE is used for assigning a sequence number to
345 \f
346 ;;; User Configuration Variables
349 "Options for exporting Org mode files to ODT."
354 ;;;; Debugging
357 "Specify whether or not the xml output should be prettified.
358 When this option is turned on, `indent-region' is run on all
359 component xml buffers before they are saved. Turn this off for
360 regular use. Turn this on if you need to examine the xml
361 visually."
367 ;;;; Document schema
380 schema-dir))
383 schema-dir))
387 schema-dir)
389 org-odt-schema-dir-list)
391 nil)))
392 schema-dir)
393 "Directory that contains OpenDocument schema files.
395 This directory contains:
396 1. rnc files for OpenDocument schema
398 for auto validation of OpenDocument XML files.
400 Use the customize interface to set this variable. This ensures
401 that `rng-schema-locating-files' is updated and auto-validation
402 of OpenDocument XML takes place based on the value
403 `rng-nxml-auto-validate-flag'.
405 The default value of this variable varies depending on the
406 version of org in use and is initialized from
407 `org-odt-schema-dir-list'. The OASIS schema files are available
408 only in the org's private git repository. It is *not* bundled
409 with GNU ELPA tar or standard Emacs distribution."
415 :set
417 "Set `org-odt-schema-dir'.
418 Also add it to `rng-schema-locating-files'."
428 schema-dir
431 value))
432 nil)))
437 org-odt-schema-dir))))))
440 ;;;; Document styles
444 The exporter embeds the exported content just before
448 under `org-odt-styles-dir' is used."
455 "Default styles file for use with ODT export.
456 Valid values are one of:
457 1. nil
458 2. path to a styles.xml file
459 3. path to a *.odt or a *.ott file
460 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
461 ...))
463 In case of option 1, an in-built styles.xml is used. See
464 `org-odt-styles-dir' for more information.
466 In case of option 3, the specified file is unzipped and the
467 styles.xml embedded therein is used.
469 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
470 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
471 generated odt file. Use relative path for specifying the
472 FILE-MEMBERS. styles.xml must be specified as one of the
473 FILE-MEMBERS.
475 Use options 1, 2 or 3 only if styles.xml alone suffices for
476 achieving the desired formatting. Use option 4, if the styles.xml
477 references additional files like header and footer images for
478 achieving the desired formatting.
481 a per-file basis. For example,
487 :type
499 "Outline levels considered for enumerating captioned entities."
505 ;;;; Document conversion
512 "Specify a list of document converters and their usage.
513 The converters in this list are offered as choices while
514 customizing `org-odt-convert-process'.
516 This variable is a list where each element is of the
517 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
518 of the converter. CONVERTER-CMD is the shell command for the
519 converter and can contain format specifiers. These format
520 specifiers are interpreted as below:
522 %i input file name in full
523 %I input file name as a URL
524 %f format of the output file
525 %o output file name in full
526 %O output file name as a URL
527 %d output dir in full
528 %D output dir as a URL.
529 %x extra options as set in `org-odt-convert-capabilities'."
532 :type
541 During customization, the list of converter names are populated
542 from `org-odt-convert-processes'."
552 org-odt-convert-processes))))
570 "Specify input and output formats of `org-odt-convert-process'.
571 More correctly, specify the set of input and output formats that
572 the user is actually interested in.
574 This variable is an alist where each element is of the
575 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
576 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
577 alist where each element is of the form (OUTPUT-FMT
578 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
580 The variable is interpreted as follows:
581 `org-odt-convert-process' can take any document that is in
582 INPUT-FMT-LIST and produce any document that is in the
583 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
584 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
585 serves dual purposes:
586 - It is used for populating completion candidates during
587 `org-odt-convert' commands.
589 `org-odt-convert-process'.
592 `org-odt-convert-process'.
594 DOCUMENT-CLASS is used to group a set of file formats in
595 INPUT-FMT-LIST in to a single class.
597 Note that this variable inherently captures how LibreOffice based
598 converters work. LibreOffice maps documents of various formats
599 to classes like Text, Web, Spreadsheet, Presentation etc and
600 allow document of a given class (irrespective of its source
601 format) to be converted to any of the export formats associated
602 with that class.
604 See default setting of this variable for an typical
605 configuration."
608 :type
613 :value-type
617 :value-type
626 and then uses `org-odt-convert-process' to convert the
627 resulting document to this format. During customization of this
628 variable, the list of valid values are populated based on
629 `org-odt-convert-capabilities'.
631 You can set this option on per-file basis using file local
632 values. See Info node `(emacs) File Variables'."
643 ;;;###autoload
647 ;;;; Drawers
651 "Function called to format a drawer in ODT code.
653 The function must accept two parameters:
655 CONTENTS the contents of the drawer.
657 The function should return the string to be exported.
659 The default value simply returns the value of CONTENTS."
666 ;;;; Headline
669 "Function to format headline text.
671 This function will be called with 5 arguments:
672 TODO the todo keyword \(string or nil\).
673 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
674 PRIORITY the priority of the headline \(integer or nil\)
675 TEXT the main headline text \(string\).
676 TAGS the tags string, separated with colons \(string or nil\).
678 The function result will be used as headline text."
685 ;;;; Inlinetasks
688 "Function called to format an inlinetask in ODT code.
690 The function must accept six parameters:
691 TODO the todo keyword, as a string
692 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
693 PRIORITY the inlinetask priority, as a string
694 NAME the inlinetask name, as a string.
695 TAGS the inlinetask tags, as a string.
696 CONTENTS the contents of the inlinetask, as a string.
698 The function should return the string to be exported."
705 ;;;; LaTeX
708 "Non-nil means process LaTeX math snippets.
710 When set, the exporter will process LaTeX environments and
711 fragments.
713 This option can also be set with the +OPTIONS line,
716 nil Ignore math snippets.
717 `verbatim' Keep everything in verbatim
718 `dvipng' Process the LaTeX fragments to images. This will also
719 include processing of non-math environments.
720 `imagemagick' Convert the LaTeX fragments to pdf files and use
721 imagemagick to convert pdf files to png files.
722 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
723 be loaded.
724 t Synonym for `mathjax'."
736 ;;;; Links
740 "Rules characterizing formula files that can be inlined into ODT.
742 A rule consists in an association whose key is the type of link
743 to consider, and value is a regexp that will be matched against
744 link's path."
753 "Rules characterizing image files that can be inlined into ODT.
755 A rule consists in an association whose key is the type of link
756 to consider, and value is a regexp that will be matched against
757 link's path."
765 "Scaling factor for converting images pixels to inches.
766 Use this for sizing of embedded images. See Info node `(org)
767 Images in ODT export' for more information."
774 ;;;; Src Block
777 "Whether custom styles for colorized source blocks be automatically created.
778 When this option is turned on, the exporter creates custom styles
779 for source blocks based on the advice of `htmlfontify'. Creation
780 of custom styles happen as part of `org-odt-hfy-face-to-css'.
782 When this option is turned off exporter does not create such
783 styles.
785 Use the latter option if you do not want the custom styles to be
786 based on your current display settings. It is necessary that the
787 styles.xml already contains needed styles for colorizing to work.
789 This variable is effective only if
790 `org-odt-fontify-srcblocks' is turned on."
796 "Specify whether or not source blocks need to be fontified.
797 Turn this option on if you want to colorize the source code
798 blocks in the exported file. For colorization to work, you need
799 to make available an enhanced version of `htmlfontify' library."
805 ;;;; Table
818 "Specify how Table Styles should be derived from a Table Template.
819 This is a list where each element is of the
820 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
822 TABLE-STYLE-NAME is the style associated with the table through
825 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
826 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
827 below) that is included in
828 `org-odt-content-template-file'.
830 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
832 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
840 TABLE-CELL-OPTIONS is an alist where each element is of the
841 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
842 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
843 `use-last-row-styles' |
844 `use-first-column-styles' |
845 `use-last-column-styles' |
846 `use-banding-rows-styles' |
847 `use-banding-columns-styles' |
848 `use-first-row-styles'
849 ON-OR-OFF := `t' | `nil'
851 For example, with the following configuration
853 \(setq org-odt-table-styles
855 \(\(use-first-row-styles . t\)
856 \(use-first-column-styles . t\)\)\)
858 \(\(use-first-column-styles . t\)\)\)\)\)
861 style will use the following table-cell styles -
866 as appropriate.
869 use the following table-cell styles -
871 following paragraph styles
873 as appropriate..
875 Note that TABLE-TEMPLATE-NAME corresponds to the
878 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
881 specification for more information. Also consult the
882 implementation filed under `org-odt-get-table-cell-styles'.
885 formatting of numbered display equations. Do not delete this
886 style from the list."
896 use-last-row-styles
897 use-first-column-styles
898 use-last-column-styles
899 use-banding-rows-styles
900 use-banding-columns-styles)
901 :key-type symbol
904 ;;;; Timestamps
907 "Non-nil, if timestamps should be exported as date fields.
909 When nil, export timestamps as plain text.
911 When non-nil, map `org-time-stamp-custom-formats' to a pair of
913 respectively. A timestamp with no time component is formatted
917 This feature is experimental. Most (but not all) of the common
918 %-specifiers in `format-time-string' are supported.
920 formatted as canonical Org timestamps. For finer control, avoid
921 these %-specifiers.
924 etc., are displayed by the application in the default language
925 and country specified in `org-odt-styles-file'. Note that the
927 can localize the week day and month strings in the exported
928 document by setting the default language and country either using
929 the application UI or through a custom styles file.
931 See `org-odt--build-date-styles' for implementation details."
938 \f
939 ;;; Internal functions
941 ;;;; Date
956 ;; LibreOffice does not care about end goes as content
957 ;; within the "<text:date>...</text:date>" field. The
958 ;; displayed date is automagically corrected to match the
959 ;; format requested by "style:data-style-name" attribute. So
960 ;; don't bother about formatting the date contents to be
961 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
962 ;; simple Org-style date should suffice.
987 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
988 iso-date style date)
990 repeater)))))
992 ;;;; Frame
1000 extra
1006 style frame-attrs
1018 ;;;; Library wrappers
1025 ;; This is shamelessly stolen from `archive-zip-extract'.
1031 name)))
1036 exit-code command-output)
1044 members))
1046 ;;;; Target
1055 ;;;; Textbox
1058 extra anchor-type)
1064 text)
1065 width nil style extra anchor-type))
1069 ;;;; Table of Contents
1074 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1076 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1083 "
1084 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1086 <text:index-entry-chapter/>
1087 <text:index-entry-text/>
1088 <text:index-entry-link-end/>
1089 </text:table-of-content-entry-template>
1093 </text:table-of-content-source>
1095 <text:index-body>
1098 </text:index-title>
1103 </text:index-body>
1104 </text:table-of-content>
1112 ;; Section number.
1114 ;; Todo.
1119 style todo)))
1124 style priority)))
1125 ;; Title.
1126 text
1127 ;; Tags.
1131 "OrgTags"
1138 headline-label text))
1142 ;; When a headline is marked as a radio target, as in the example below:
1143 ;;
1144 ;; ** <<<Some Heading>>>
1145 ;; Some text.
1146 ;;
1147 ;; suppress generation of radio targets. i.e., Radio targets are to
1148 ;; be marked as targets within /document body/ and *not* within
1149 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1150 ;; and one in the document body.
1151 ;;
1152 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1153 ;; doesn't provide a way to disable memoization. So this doesn't
1154 ;; work.
1155 ;;
1156 ;; FIXME-2: Are there any other objects that need to be suppressed
1157 ;; within TOC?
1177 style entry)))
1182 ;;;; Document styles
1185 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1186 OBJECT-PROPS is (typically) a plist created by passing
1188 `org-odt-parse-block-attributes'.
1190 Use `org-odt-object-counters' to generate an automatic
1191 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1192 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1193 . STYLE-NAME)."
1209 ;;;; Checkbox
1212 "Return check-box string associated to ITEM."
1221 ;;; Template
1224 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1225 ;; to modify the date fields. A date could be modified by
1226 ;; offsetting in days. That's about it. Also, date and time may
1227 ;; have to be emitted as two fields - a date field and a time field
1228 ;; - separately.
1230 ;; One can add Form Controls to date and time fields so that they
1231 ;; can be easily modified. But then, the exported document will
1232 ;; become tightly coupled with LibreOffice and may not function
1233 ;; properly with other OpenDocument applications.
1235 ;; I have a strange feeling that Date styles are a bit flaky at the
1236 ;; moment.
1238 ;; The feature is experimental.
1284 ))
1292 filler-end))
1303 style
1306 output ))))
1309 "Return complete document string after ODT conversion.
1310 CONTENTS is the transcoded contents string. RAW-DATA is the
1311 original parsed data. INFO is a plist holding export options."
1312 ;; Write meta file.
1322 <office:document-meta
1332 ;; Date, if required.
1334 ;; Check if DATE is specified as an Org-timestamp. If yes,
1335 ;; include it as meta information. Otherwise, just use
1336 ;; today's date.
1345 iso-date)))))
1356 ;; Add meta.xml in to manifest.
1359 ;; Update styles file.
1360 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1361 ;; Write styles file.
1364 ;; Non-availability of styles.xml is not a critical
1365 ;; error. For now, throw an error.
1367 org-odt-styles-file
1369 org-odt-styles-dir)
1382 members)))
1392 org-odt-styles-file))))
1394 ;; create a manifest entry for styles.xml
1397 ;; FIXME: Who is opening an empty styles.xml before this point?
1402 ;; Write custom styles for source blocks
1403 ;; Save STYLES used for colorizing of source blocks.
1404 ;; Update styles.xml with styles that were collected as part of
1405 ;; `org-odt-hfy-face-to-css' callbacks.
1414 ;; Update styles.xml - take care of outline numbering
1416 ;; Don't make automatic backup of styles.xml file. This setting
1417 ;; prevents the backed-up styles.xml file from being zipped in to
1418 ;; odt file. This is more of a hackish fix. Better alternative
1419 ;; would be to fix the zip command so that the output odt file
1420 ;; includes only the needed files and excludes any auto-generated
1421 ;; extra files like backups and auto-saves etc etc. Note that
1422 ;; currently the zip command zips up the entire temp directory so
1423 ;; that any auto-generated files created under the hood ends up in
1424 ;; the resulting odt file.
1427 ;; Outline numbering is retained only upto LEVEL.
1428 ;; To disable outline numbering pass a LEVEL of 0.
1441 ;; Update content.xml.
1444 ;; within the context of the Org buffer. So obtain its
1445 ;; value before moving on to temp-buffer context down below.
1455 org-odt-styles-dir)))
1456 ;; Write automatic styles.
1457 ;; - Position the cursor.
1461 ;; - Dump automatic table styles.
1466 ;; - Dump date-styles.
1472 ;; Update display level.
1473 ;; - Remove existing sequence decls. Also position the cursor.
1478 ;; Update sequence decls according to user preference.
1488 ;; Position the cursor to document body.
1493 ;; Preamble - Title, Author, Date etc.
1500 ;; Switch on or off above vars based on user settings
1504 ;; Title.
1509 ;; Separator.
1513 ;; Author only.
1516 "OrgSubtitle"
1518 ;; Separator.
1521 ;; Author and E-mail.
1525 "OrgSubtitle"
1530 ;; Separator.
1532 ;; Date, if required.
1535 ;; Check if DATE is specified as a timestamp.
1541 "OrgSubtitle"
1545 ;; Separator
1547 ;; Table of Contents
1550 with-toc
1553 ;; Contents.
1555 ;; Return contents.
1559 \f
1560 ;;; Transcode Functions
1562 ;;;; Bold
1565 "Transcode BOLD from Org to ODT.
1566 CONTENTS is the text with bold markup. INFO is a plist holding
1567 contextual information."
1572 ;;;; Center Block
1575 "Transcode a CENTER-BLOCK element from Org to ODT.
1576 CONTENTS holds the contents of the center block. INFO is a plist
1577 holding contextual information."
1578 contents)
1581 ;;;; Clock
1584 "Transcode a CLOCK element from Org to ODT.
1585 CONTENTS is nil. INFO is a plist used as a communication
1586 channel."
1599 ;;;; Code
1602 "Transcode a CODE object from Org to ODT.
1603 CONTENTS is nil. INFO is a plist used as a communication
1604 channel."
1610 ;;;; Comment
1612 ;; Comments are ignored.
1615 ;;;; Comment Block
1617 ;; Comment Blocks are ignored.
1620 ;;;; Drawer
1623 "Transcode a DRAWER element from Org to ODT.
1624 CONTENTS holds the contents of the block. INFO is a plist
1625 holding contextual information."
1628 name contents)))
1629 output))
1632 ;;;; Dynamic Block
1635 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1636 CONTENTS holds the contents of the block. INFO is a plist
1637 holding contextual information. See `org-export-data'."
1638 contents)
1641 ;;;; Entity
1644 "Transcode an ENTITY object from Org to ODT.
1645 CONTENTS are the definition itself. INFO is a plist holding
1646 contextual information."
1650 ;;;; Example Block
1653 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1654 CONTENTS is nil. INFO is a plist holding contextual information."
1658 ;;;; Export Snippet
1661 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1662 CONTENTS is nil. INFO is a plist holding contextual information."
1667 ;;;; Export Block
1670 "Transcode a EXPORT-BLOCK element from Org to ODT.
1671 CONTENTS is nil. INFO is a plist holding contextual information."
1676 ;;;; Fixed Width
1679 "Transcode a FIXED-WIDTH element from Org to ODT.
1680 CONTENTS is nil. INFO is a plist holding contextual information."
1684 ;;;; Footnote Definition
1686 ;; Footnote Definitions are ignored.
1689 ;;;; Footnote Reference
1692 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1693 CONTENTS is nil. INFO is a plist holding contextual information."
1703 id note-class
1716 "OrgSuperscript"
1717 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1718 note-class ref-format ref-name n)))))))
1720 ;; Insert separator between two footnotes in a row.
1725 ;; Transcode footnote reference.
1730 ;; Inline definitions are secondary strings.
1731 ;; Non-inline footnotes definitions are full Org data.
1734 footnote-reference info))
1738 raw
1741 :transcoders
1744 p c i
1745 "Footnote"
1746 "OrgFootnoteCenter"
1748 info))))
1755 ;;;; Headline
1761 ;; Todo.
1765 style todo)))
1770 style priority)))
1771 ;; Title.
1772 text
1773 ;; Tags.
1776 "<text:tab/>"
1785 &optional format-function
1787 "Transcode a HEADLINE element using BACKEND.
1788 INFO is a plist holding contextual information."
1815 todo todo-type priority text tags))))
1818 todo todo-type priority text tags
1823 "Transcode a HEADLINE element from Org to ODT.
1824 CONTENTS holds the contents of the headline. INFO is a plist
1825 holding contextual information."
1826 ;; Case 1: This is a footnote section: ignore it.
1829 ;; Create the headline text.
1831 ;; Get level relative to current parsed data.
1833 ;; Get canonical label for the headline.
1837 ;; Get user-specified labels for the headline.
1840 ;; Extra targets.
1848 ;; Title.
1851 ;; Case 2. This is a deep sub-tree: export it as a list item.
1852 ;; Also export as items headlines for which no section
1853 ;; format has been found.
1855 ;; Build the real contents of the sub-tree.
1859 ;; Choose style based on list type.
1862 ;; If top-level list, re-start numbering. Otherwise,
1863 ;; continue numbering.
1866 headline)))
1876 "Text_20_body"
1878 contents)
1880 "</text:list-header>"
1884 ;; Case 3. Standard headline. Export it as a section.
1890 level
1892 contents))))))
1895 ;;;; Horizontal Rule
1898 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1899 CONTENTS is nil. INFO is a plist holding contextual information."
1904 ;;;; Inline Babel Call
1906 ;; Inline Babel Calls are ignored.
1909 ;;;; Inline Src Block
1912 "Return a character not used in string S.
1914 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1920 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1921 CONTENTS holds the contents of the item. INFO is a plist holding
1922 contextual information."
1929 ;;;; Inlinetask
1932 "Transcode an INLINETASK element from Org to ODT.
1933 CONTENTS holds the contents of the block. INFO is a plist
1934 holding contextual information."
1936 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1937 ;; with appropriate arguments.
1944 todo todo-type priority text tags contents)))))
1947 ;; Otherwise, use a default template.
1950 "Text_20_body"
1954 "OrgInlineTaskHeading"
1956 contents)
1959 ;;;; Italic
1962 "Transcode ITALIC from Org to ODT.
1963 CONTENTS is the text with italic markup. INFO is a plist holding
1964 contextual information."
1969 ;;;; Item
1972 "Transcode an ITEM element from Org to ODT.
1973 CONTENTS holds the contents of the item. INFO is a plist holding
1974 contextual information."
1985 contents
1997 ;;;; Keyword
2000 "Transcode a KEYWORD element from Org to ODT.
2001 CONTENTS is nil. INFO is a plist holding contextual information."
2007 ;; FIXME
2018 ;; FIXME
2022 ;;;; Latex Environment
2025 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2026 ;; (defadvice org-format-latex-as-mathml ; FIXME
2027 ;; (after org-odt-protect-latex-fragment activate)
2028 ;; "Encode LaTeX fragment as XML.
2029 ;; Do this when translation to MathML fails."
2030 ;; (unless (> (length ad-return-value) 0)
2031 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2034 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2035 CONTENTS is nil. INFO is a plist holding contextual information."
2041 ;;;; Latex Fragment
2043 ;; (when latex-frag ; FIXME
2044 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2045 ;; :description latex-frag)))
2046 ;; handle verbatim
2047 ;; provide descriptions
2050 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2051 CONTENTS is nil. INFO is a plist holding contextual information."
2058 ;;;; Line Break
2061 "Transcode a LINE-BREAK object from Org to ODT.
2062 CONTENTS is nil. INFO is a plist holding contextual information."
2066 ;;;; Link
2068 ;;;; Links :: Label references
2079 x)))))
2090 counter))
2097 ;; Section number.
2101 ;; Separator.
2103 ;; Ordinal.
2105 tag))
2108 "Return a label for ELEMENT.
2110 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2111 element. INFO is a plist used as a communication channel. OP is
2112 either `definition' or `reference', depending on the purpose of
2113 the generated string.
2115 Return value is a string if OP is set to `reference' or a cons
2116 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2117 SHORT-CAPTION are strings."
2123 ;; Get label and caption.
2127 ;; FIXME: We don't use short-caption for now
2143 element))))
2146 seqno)
2150 ;; Compute sequence number of the element.
2152 ;; Localize category string.
2155 ;; Case 1: Handle Label definition.
2157 ;; Assign an internal label, if user has not provided one
2162 ;; Sneak in a bookmark. The bookmark is used when the
2163 ;; labeled element is referenced with a link that
2164 ;; provides its own description.
2166 ;; Label definition: Typically formatted as below:
2167 ;; CATEGORY SEQ-NO: LONG CAPTION
2168 ;; with translation for correct punctuation.
2175 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2176 label counter counter seqno))
2178 short-caption))
2179 ;; Case 2: Handle Label reference.
2186 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2192 ;;;; Links :: Inline Images
2195 "Returns the internal name of the file"
2211 target-file))
2214 user-height scale dpi embed-as)
2234 ;; Use Imagemagick.
2239 file))))
2244 ;; Use Emacs.
2250 ;; Use hard-coded values.
2252 org-odt-default-image-sizes-alist))
2253 ;; Error out.
2266 ;; ensure that an embedded image fits comfortably within a page
2277 "Return ODT code for an inline image.
2278 LINK is the link pointing to the inline image. INFO is a plist
2279 used as a communication channel."
2292 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2294 ;; Extract attributes from #+ATTR_ODT line.
2298 ;; Convert attributes to a plist.
2300 ;; Handle `:anchor', `:style' and `:attributes' properties.
2310 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2311 ;;
2312 ;; Handle `:width', `:height' and `:scale' properties. Read
2313 ;; them as numbers since we need them for computations.
2315 src-expanded
2322 nil ; embed-as
2324 ))
2331 ;; Check if this link was created by LaTeX-to-PNG converter.
2335 ;; If yes, note down the type of the element - LaTeX Fragment
2336 ;; or LaTeX environment. It will go in to frame title.
2340 ;; If yes, note down its contents. It will go in to frame
2341 ;; description. This quite useful for debugging.
2344 captions user-frame-params title desc)))
2347 ;;;; Links :: Math formula
2368 ;; Check if this link was created by LaTeX-to-MathML
2369 ;; converter.
2373 ;; If yes, note down the type of the element - LaTeX Fragment
2374 ;; or LaTeX environment. It will go in to frame title.
2378 ;; If yes, note down its contents. It will go in to frame
2379 ;; description. This quite useful for debugging.
2381 width height)
2385 nil nil title desc))
2388 "CaptionedDisplayFormula" href width height
2389 captions nil title desc))
2393 org-odt--enumerable-formula-p))))
2398 "Returns the internal name of the file"
2402 ;; Create a directory for holding formula file. Also enter it in
2403 ;; to manifest.
2407 ;; Copy over the formula file from user directory to zip
2408 ;; directory.
2412 ;; Case 1: Mathml.
2415 ;; Case 2: OpenDocument formula.
2420 ;; Enter the formula file in to manifest.
2422 target-file))
2424 ;;;; Targets
2427 captions user-frame-params
2430 ;; Each element of this alist is of the form (CFG-HANDLE
2431 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2433 ;; CFG-HANDLE is the key to the alist.
2435 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2436 ;; frame params for INNER-FRAME and OUTER-FRAME
2437 ;; respectively. See below.
2439 ;; Configurations that are meant to be applied to
2440 ;; non-captioned image/formula specifies no
2441 ;; OUTER-FRAME-PARAMS.
2443 ;; TERMINOLOGY
2444 ;; ===========
2445 ;; INNER-FRAME :: Frame that directly surrounds an
2446 ;; image/formula.
2448 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2449 ;; frame also contains the caption, if any.
2451 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2452 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2453 ;; that these are the last three arguments
2454 ;; to `org-odt--frame'.
2456 ;; Note that an un-captioned image/formula requires just an
2457 ;; INNER-FRAME, while a captioned image/formula requires
2458 ;; both an INNER and an OUTER-FRAME.
2480 ;; Retrieve inner and outer frame params, from configuration.
2484 ;; User-specified frame params (from #+ATTR_ODT spec)
2488 "Merge default and user frame params."
2493 for d in default
2496 ;; Case 1: Image/Formula has no caption.
2497 ;; There is only one frame, one that surrounds the image
2498 ;; or formula.
2500 ;; Merge user frame params with that from configuration.
2504 ;; Case 2: Image/Formula is captioned or labeled.
2505 ;; There are two frames: The inner one surrounds the
2506 ;; image or formula. The outer one contains the
2507 ;; caption/sequence number.
2509 ;; Merge user frame params with outer frame params.
2511 ;; Short caption, if specified, goes as part of inner frame.
2518 frame-params))
2521 "Illustration"
2525 caption))
2526 width height outer)))))
2529 ;; Element should have a caption or label.
2535 element info
2536 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2537 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2538 ;; processing.)
2543 ;; Link should point to an image file.
2550 element info
2551 ;; Paragraph should have a caption or label. It SHOULD also be a
2552 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2553 ;; processing.)
2558 ;; Link should point to an image file.
2565 element info
2566 ;; Paragraph should have a caption or label.
2570 ;; Link should point to a MathML or ODF file.
2576 paragraph-predicate
2577 link-predicate)
2578 "Test if ELEMENT is a standalone link for the purpose ODT export.
2579 INFO is a plist holding contextual information.
2581 Return non-nil, if ELEMENT is of type paragraph satisfying
2582 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2583 is a link that satisfies LINK-PREDICATE.
2585 Return non-nil, if ELEMENT is of type link satisfying
2586 LINK-PREDICATE and its containing paragraph satisfies
2587 PARAGRAPH-PREDICATE in addition to having no other content save for
2588 leading and trailing whitespaces.
2590 Return nil, otherwise."
2613 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2614 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2615 ;; attached. Note that labels that are attached to captioned
2616 ;; entities - inline images, math formulae and tables - get resolved
2617 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2619 ;; Create a cross-reference to DESTINATION but make best-efforts to
2620 ;; create a *meaningful* description. Check item numbers, section
2621 ;; number and section title in that order.
2623 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2624 ;; FIXME: Handle footnote-definition footnote-reference?
2640 return x))
2641 ;; Get list item nos.
2646 plain-list)
2649 item info t))))))
2650 ;; Locate top-most listified headline.
2655 return x))
2656 ;; Get listified headline numbers.
2662 el info t)))))))
2663 ;; Combine item numbers from both the listified headlines and
2664 ;; regular list items.
2666 ;; Case 1: Check if all the parents of list item are numbered.
2667 ;; If yes, link to the item proper.
2670 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2675 ;; Case 2: Locate a regular and numbered headline in the
2676 ;; hierarchy. Display its section number.
2681 return el)))
2682 ;; We found one.
2684 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2688 ;; Case 4: Locate a regular headline in the hierarchy. Display
2689 ;; its title.
2693 return el)))
2694 ;; We found one.
2696 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2703 "Transcode a LINK object from Org to ODT.
2705 DESC is the description part of the link, or the empty string.
2706 INFO is a plist holding contextual information. See
2707 `org-export-data'."
2710 ;; Ensure DESC really exists, or set it to nil.
2713 link org-odt-inline-image-rules))
2720 ;; Convert & to & for correct XML representation
2722 protocol)
2724 ;; Image file.
2726 link org-odt-inline-image-rules))
2728 ;; Formula file.
2730 link org-odt-inline-formula-rules))
2732 ;; Radio target: Transcode target's contents and use them as
2733 ;; link's description.
2738 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2741 desc))))
2742 ;; Links pointing to a headline: Find destination and build
2743 ;; appropriate referencing command.
2749 ;; Case 1: Fuzzy link points nowhere.
2750 ('nil
2752 "Emphasis"
2755 info))))
2756 ;; Case 2: Fuzzy link points to a headline.
2758 ;; If there's a description, create a hyperlink.
2759 ;; Otherwise, try to provide a meaningful description.
2768 label desc))))
2769 ;; Case 3: Fuzzy link points to a target.
2771 ;; If there's a description, create a hyperlink.
2772 ;; Otherwise, try to provide a meaningful description.
2777 desc))))
2778 ;; Case 4: Fuzzy link points to some element (e.g., an
2779 ;; inline image, a math formula or a table).
2786 ;; LINK has no description. Create
2787 ;; a cross-reference showing entity's sequence
2788 ;; number.
2790 ;; LINK has description. Insert a hyperlink with
2791 ;; user-provided description.
2796 desc)))))))))
2797 ;; Coderef: replace link with the reference name or the
2798 ;; equivalent line number.
2805 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2806 href line-no))))
2807 ;; Link type is handled by a special function.
2810 ;; External link with a description part.
2813 ;; Check if description is a link to an inline image.
2818 desc-element org-odt-inline-image-rules))))
2819 ;; Format link as a clickable image.
2821 path desc)
2822 ;; Otherwise, format it as a regular link.
2824 path desc))))
2825 ;; External link without a description part.
2828 path path))
2829 ;; No path, only description. Try to do something useful.
2834 ;;;; Paragraph
2837 "Return style of PARAGRAPH.
2838 Style is a symbol among `quoted', `centered' and nil."
2848 "Format paragraph according to given styles.
2849 PARAGRAPH is a paragraph type element. CONTENTS is the
2850 transcoded contents of that paragraph, as a string. INFO is
2851 a plist used as a communication channel. DEFAULT, CENTER and
2852 QUOTE are, respectively, style to use when paragraph belongs to
2853 no special environment, a center block, or a quote block."
2859 ;; If PARAGRAPH is a leading paragraph in an item that has
2860 ;; a checkbox, splice checkbox and paragraph contents
2861 ;; together.
2866 contents)))
2869 "Transcode a PARAGRAPH element from Org to ODT.
2870 CONTENTS is the contents of the paragraph, as a string. INFO is
2871 the plist used as a communication channel."
2873 paragraph contents info
2875 "OrgCenter"
2879 ;;;; Plain List
2882 "Transcode a PLAIN-LIST element from Org to ODT.
2883 CONTENTS is the contents of the list. INFO is a plist holding
2884 contextual information."
2886 ;; Choose style based on list type.
2892 ;; If top-level list, re-start numbering. Otherwise,
2893 ;; continue numbering.
2898 contents))
2900 ;;;; Plain Text
2913 line))
2924 "Transcode a TEXT string from Org to ODT.
2925 TEXT is the string to transcode. INFO is a plist holding
2926 contextual information."
2928 ;; Protect &, < and >.
2930 ;; Handle smart quotes. Be sure to provide original string since
2931 ;; OUTPUT may have been modified.
2934 ;; Convert special strings.
2940 org-odt-special-string-regexps))
2941 ;; Handle break preservation if required.
2945 ;; Return value.
2946 output))
2949 ;;;; Planning
2952 "Transcode a PLANNING element from Org to ODT.
2953 CONTENTS is nil. INFO is a plist used as a communication
2954 channel."
2956 "OrgPlanning"
2978 ;;;; Property Drawer
2981 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2982 CONTENTS is nil. INFO is a plist holding contextual
2983 information."
2984 ;; The property drawer isn't exported but we want separating blank
2985 ;; lines nonetheless.
2989 ;;;; Quote Block
2992 "Transcode a QUOTE-BLOCK element from Org to ODT.
2993 CONTENTS holds the contents of the block. INFO is a plist
2994 holding contextual information."
2995 contents)
2998 ;;;; Quote Section
3001 "Transcode a QUOTE-SECTION element from Org to ODT.
3002 CONTENTS is nil. INFO is a plist holding contextual information."
3008 ;;;; Section
3013 style
3015 text)))
3019 "Transcode a SECTION element from Org to ODT.
3020 CONTENTS holds the contents of the section. INFO is a plist
3021 holding contextual information."
3022 contents)
3024 ;;;; Radio Target
3027 "Transcode a RADIO-TARGET object from Org to ODT.
3028 TEXT is the text of the target. INFO is a plist holding
3029 contextual information."
3035 ;;;; Special Block
3038 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3039 CONTENTS holds the contents of the block. INFO is a plist
3040 holding contextual information."
3044 ;; Annotation.
3050 ;; FIXME: Is `car' right thing to do below?
3060 contents)))))
3061 ;; Textbox.
3070 style extra anchor))))
3074 ;;;; Src Block
3077 "Create custom style for face FN.
3078 When FN is the default face, use its foreground and background
3080 use its color attribute to create a character style whose name
3081 is obtained from FN. Currently all attributes of FN other than
3082 color are ignored.
3084 The style name for a face FN is derived using the following
3085 operations on the face name in that order - de-dash, CamelCase
3087 `font-lock-function-name-face' is associated with
3101 background-color-val color-val))
3104 "
3135 org-odt-fontify-srcblocks
3152 code
3163 par-style loc))
3166 num-start refs))
3180 ;; Extract code and references.
3184 ;; Does the src block contain labels?
3186 ;; Does it have line numbers?
3193 "Transcode a SRC-BLOCK element from Org to ODT.
3194 CONTENTS holds the contents of the item. INFO is a plist holding
3195 contextual information."
3207 "Text_20_body"
3211 ;;;; Statistics Cookie
3214 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3215 CONTENTS is nil. INFO is a plist holding contextual information."
3221 ;;;; Strike-Through
3224 "Transcode STRIKE-THROUGH from Org to ODT.
3225 CONTENTS is the text with strike-through markup. INFO is a plist
3226 holding contextual information."
3231 ;;;; Subscript
3234 "Transcode a SUBSCRIPT object from Org to ODT.
3235 CONTENTS is the contents of the object. INFO is a plist holding
3236 contextual information."
3241 ;;;; Superscript
3244 "Transcode a SUPERSCRIPT object from Org to ODT.
3245 CONTENTS is the contents of the object. INFO is a plist holding
3246 contextual information."
3251 ;;;; Table Cell
3260 "Retrieve styles applicable to a table cell.
3261 R and C are (zero-based) row and column numbers of the table
3262 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3263 applicable to the current table. It is `nil' if the table is not
3264 associated with any style attributes.
3266 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3268 When STYLE-SPEC is nil, style the table cell the conventional way
3269 - choose cell borders based on row and column groupings and
3270 choose paragraph alignment based on `org-col-cookies' text
3271 property. See also
3272 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3274 When STYLE-SPEC is non-nil, ignore the above cookie and return
3275 styles congruent with the ODF-1.2 specification."
3281 info)))
3283 ;; LibreOffice - particularly the Writer - honors neither table
3284 ;; templates nor custom table-cell styles. Inorder to retain
3285 ;; inter-operability with LibreOffice, only automatic styles are
3286 ;; used for styling of table-cells. The current implementation is
3287 ;; congruent with ODF-1.2 specification and hence is
3288 ;; future-compatible.
3290 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3291 ;; which recognizes as many as 16 different cell types - is much
3292 ;; richer. Unfortunately it is NOT amenable to easy configuration
3293 ;; by hand.
3320 "Transcode a TABLE-CELL element from Org to ODT.
3321 CONTENTS is nil. INFO is a plist used as a communication
3322 channel."
3329 table-cell info))
3352 table-cell info))))))
3356 custom-style-prefix))
3358 "OrgTblCell"
3374 cell-attributes
3377 org-element-all-elements)
3378 contents
3380 paragraph-style contents))))
3387 ;;;; Table Row
3390 "Transcode a TABLE-ROW element from Org to ODT.
3391 CONTENTS is the contents of the row. INFO is a plist used as a
3392 communication channel."
3393 ;; Rules are ignored since table separators are deduced from
3394 ;; borders of the current row.
3400 ;; If the row belongs to the first rowgroup and the
3401 ;; table has more than one row groups, then this row
3402 ;; belongs to the header row group.
3404 ;; Otherwise, it belongs to non-header row group.
3407 ;; Does this row begin a rowgroup?
3410 ;; Actual table row
3412 ;; Does this row end a rowgroup?
3417 ;;;; Table
3430 "Transcode a TABLE element from Org to ODT.
3431 CONTENTS is the contents of the table. INFO is a plist holding
3432 contextual information."
3434 ;; Case 1: table.el doesn't support export to OD format. Strip
3435 ;; such tables from export.
3440 "(ox-odt): Found table.el-type table in the source Org file."
3441 " table.el doesn't support export to ODT format."
3443 ;; Case 2: Native Org tables.
3460 column-style))
3461 out)
3465 ;; caption.
3469 ;; begin table.
3477 ;; column specification.
3479 ;; actual contents.
3481 ;; end table.
3485 "Transcode a TABLE element from Org to ODT.
3486 CONTENTS is the contents of the table. INFO is a plist holding
3487 contextual information.
3489 Use `org-odt--table' to typeset the table. Handle details
3490 pertaining to indentation here."
3505 collect el)))
3511 collect
3516 parent-list)
3518 ;; Handle list genealogy.
3538 parent-list info)
3541 ;; Handle low-level headlines.
3543 with step = 'item collect
3551 el info)
3552 "OrgNumberedList"
3563 parent-list info)))
3571 table info)))
3572 ;; OpenDocument schema does not permit table to occur within a
3573 ;; list item.
3575 ;; One solution - the easiest and lightweight, in terms of
3576 ;; implementation - is to put the table in an indented text box
3577 ;; and make the text box part of the list-item. Unfortunately if
3578 ;; the table is big and spans multiple pages, the text box could
3579 ;; overflow. In this case, the following attribute will come
3580 ;; handy.
3582 ;; ,---- From OpenDocument-v1.1.pdf
3583 ;; | 15.27.28 Overflow behavior
3584 ;; |
3585 ;; | For text boxes contained within text document, the
3586 ;; | style:overflow-behavior property specifies the behavior of text
3587 ;; | boxes where the containing text does not fit into the text
3588 ;; | box.
3589 ;; |
3590 ;; | If the attribute's value is clip, the text that does not fit
3591 ;; | into the text box is not displayed.
3592 ;; |
3593 ;; | If the attribute value is auto-create-new-frame, a new frame
3594 ;; | will be created on the next page, with the same position and
3595 ;; | dimensions of the original frame.
3596 ;; |
3597 ;; | If the style:overflow-behavior property's value is
3598 ;; | auto-create-new-frame and the text box has a minimum width or
3599 ;; | height specified, then the text box will grow until the page
3600 ;; | bounds are reached before a new frame is created.
3601 ;; `----
3603 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3604 ;; auto-create-new-frame property and always resorts to clipping
3605 ;; the text box. This results in table being truncated.
3607 ;; So we solve the problem the hard (and fun) way using list
3608 ;; continuations.
3610 ;; The problem only becomes more interesting if you take in to
3611 ;; account the following facts:
3612 ;;
3613 ;; - Description lists are simulated as plain lists.
3614 ;; - Low-level headlines can be listified.
3615 ;; - In Org-mode, a table can occur not only as a regular list
3616 ;; item, but also within description lists and low-level
3617 ;; headlines.
3619 ;; See `org-odt-translate-description-lists' and
3620 ;; `org-odt-translate-low-level-headlines' for how this is
3621 ;; tackled.
3624 ;; Discontinue the list.
3626 ;; Put the table in an indented section.
3631 ;; Continue the list.
3635 ;;;; Target
3638 "Transcode a TARGET object from Org to ODT.
3639 CONTENTS is nil. INFO is a plist holding contextual
3640 information."
3645 ;;;; Timestamp
3648 "Transcode a TIMESTAMP object from Org to ODT.
3649 CONTENTS is nil. INFO is a plist used as a communication
3650 channel."
3667 "OrgActiveTimestamp"
3671 "OrgInactiveTimestamp"
3675 "OrgActiveTimestamp"
3681 "OrgInactiveTimestamp"
3687 "OrgDiaryTimestamp"
3689 info)))))))
3692 ;;;; Underline
3695 "Transcode UNDERLINE from Org to ODT.
3696 CONTENTS is the text with underline markup. INFO is a plist
3697 holding contextual information."
3702 ;;;; Verbatim
3705 "Transcode a VERBATIM object from Org to ODT.
3706 CONTENTS is nil. INFO is a plist used as a communication
3707 channel."
3713 ;;;; Verse Block
3716 "Transcode a VERSE-BLOCK element from Org to ODT.
3717 CONTENTS is verse block contents. INFO is a plist holding
3718 contextual information."
3719 ;; Add line breaks to each line of verse.
3723 ;; Replace tabs and spaces.
3725 ;; Surround it in a verse environment.
3730 \f
3731 ;;; Filters
3733 ;;;; LaTeX fragments
3738 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3739 ;; If the desired converter is not available, force verbatim
3740 ;; processing.
3758 ;; Store normalized value for later use.
3763 ;; Convert `latex-fragment's and `latex-environment's.
3781 ;; Get an Org-style link to PNG image or the MathML
3782 ;; file.
3787 nil display-msg
3788 nil nil processing-type)
3793 link))))
3795 ;; Conversion succeeded. Parse above Org-style link to a
3796 ;; `link' object.
3802 ;; Orphan the link.
3807 ;; Case 1: LaTeX environment.
3808 ;; Mimic a "standalone image or formula" by
3809 ;; enclosing the `link' in a `paragraph'.
3810 ;; Copy over original attributes, captions to
3811 ;; the enclosing paragraph.
3817 latex-*)
3819 latex-*)))
3820 link))
3821 ;; Case 2: LaTeX fragment.
3822 ;; No special action.
3824 ;; Note down the object that link replaces.
3828 ;; Replace now.
3830 info)))
3831 tree)
3834 ;;;; Description lists
3836 ;; This translator is necessary to handle indented tables in a uniform
3837 ;; manner. See comment in `org-odt--table'.
3840 ;; OpenDocument has no notion of a description list. So simulate it
3841 ;; using plain lists. Description lists in the exported document
3842 ;; are typeset in the same manner as they are in a typical HTML
3843 ;; document.
3844 ;;
3845 ;; Specifically, a description list like this:
3846 ;;
3847 ;; ,----
3848 ;; | - term-1 :: definition-1
3849 ;; | - term-2 :: definition-2
3850 ;; `----
3851 ;;
3852 ;; gets translated in to the following form:
3853 ;;
3854 ;; ,----
3855 ;; | - term-1
3856 ;; | - definition-1
3857 ;; | - term-2
3858 ;; | - definition-2
3859 ;; `----
3860 ;;
3861 ;; Further effect is achieved by fixing the OD styles as below:
3862 ;;
3863 ;; 1. Set the :type property of the simulated lists to
3864 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3865 ;; that has *no* bullets whatsoever.
3866 ;;
3867 ;; 2. The paragraph containing the definition term is styled to be
3868 ;; in bold.
3869 ;;
3874 el
3890 nil)
3891 info)
3892 tree)
3894 ;;;; List tables
3896 ;; Lists that are marked with attribute `:list-table' are called as
3897 ;; list tables. They will be rendered as a table within the exported
3898 ;; document.
3900 ;; Consider an example. The following list table
3901 ;;
3902 ;; #+attr_odt :list-table t
3903 ;; - Row 1
3904 ;; - 1.1
3905 ;; - 1.2
3906 ;; - 1.3
3907 ;; - Row 2
3908 ;; - 2.1
3909 ;; - 2.2
3910 ;; - 2.3
3911 ;;
3912 ;; will be exported as though it were an Org table like the one show
3913 ;; below.
3914 ;;
3915 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3916 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3917 ;;
3918 ;; Note that org-tables are NOT multi-line and each line is mapped to
3919 ;; a unique row in the exported document. So if an exported table
3920 ;; needs to contain a single paragraph (with copious text) it needs to
3921 ;; be typed up in a single line. Editing such long lines using the
3922 ;; table editor will be a cumbersome task. Furthermore inclusion of
3923 ;; multi-paragraph text in a table cell is well-nigh impossible.
3924 ;;
3925 ;; A LIST-TABLE circumvents above problems.
3926 ;;
3927 ;; Note that in the example above the list items could be paragraphs
3928 ;; themselves and the list can be arbitrarily deep.
3929 ;;
3930 ;; Inspired by following thread:
3931 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3933 ;; Translate lists to tables
3939 ;; Replace list with table.
3941 l1-list
3942 ;; Build replacement table.
3948 l1-item-leading-text l2-list)
3949 ;; Remove Level-2 list from the Level-item. It
3950 ;; will be subsequently attached as table-cells.
3960 ;; Level-1 items start a table row.
3963 ;; Leading text of level-1 item define
3964 ;; the first table-cell.
3967 l1-item-leading-text)
3968 ;; Level-2 items define subsequent
3969 ;; table-cells of the row.
3977 nil)
3978 info)
3979 tree)
3981 \f
3982 ;;; Interactive functions
3995 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4004 org-odt-manifest-file-entries)
4012 ;; Initialize temporary workarea. All files that end up in
4013 ;; the exported document get parked/created here.
4020 ;; Kill all XML buffers.
4028 org-odt-xml-files)
4029 ;; Delete temporary directory and also other embedded
4030 ;; files that get copied there.
4035 ;; Not at all OSes ship with zip by default
4037 ;; Do export. This creates a bunch of xml files ready to be
4038 ;; saved and zipped.
4040 ;; Create a manifest entry for content.xml.
4042 ;; Write mimetype file
4051 ;; Write out the manifest entries before zipping
4053 ;; Save all XML files.
4059 ;; Prettify output if needed.
4063 org-odt-xml-files)
4064 ;; Run zip.
4069 ;; If a file with same name as the desired output file
4070 ;; exists, remove it.
4073 ;; Zip up the xml files.
4076 ;; Switch temporarily to content.xml. This way Zip
4077 ;; process will inherit `org-odt-zip-dir' as the current
4078 ;; directory.
4092 err-string)))))
4093 cmds)))
4094 ;; Move the zip file from temporary work directory to
4095 ;; user-mandated location.
4098 ;; Cleanup work directory and work files.
4100 ;; Open the OpenDocument file in archive-mode for
4101 ;; examination.
4103 ;; Return exported file.
4105 ;; Case 1: Conversion desired on exported file. Run the
4106 ;; converter on the OpenDocument file. Return the
4107 ;; converted file.
4110 target))
4111 ;; Case 2: No further conversion. Return exported
4112 ;; OpenDocument file.
4115 ;; Cleanup work directory and work files.
4121 ;;;; Export to OpenDocument formula
4123 ;;;###autoload
4125 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4126 Use `org-create-math-formula' to convert LATEX-FRAG first to
4127 MathML. When invoked as an interactive command, use
4128 `org-latex-regexps' to infer LATEX-FRAG from currently active
4129 region. If no LaTeX fragments are found, prompt for it. Push
4130 MathML source to kill ring depending on the value of
4131 `org-export-copy-to-kill-ring'."
4157 filename
4170 ;; Add MathML to kill ring, if needed.
4174 ;;;###autoload
4176 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4177 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4178 formula file."
4183 ;;;; Export to OpenDocument Text
4185 ;;;###autoload
4187 "Export current buffer to a ODT file.
4189 If narrowing is active in the current buffer, only export its
4190 narrowed part.
4192 If a region is active, export that region.
4194 A non-nil optional argument ASYNC means the process should happen
4195 asynchronously. The resulting file should be accessible through
4196 the `org-export-stack' interface.
4198 When optional argument SUBTREEP is non-nil, export the sub-tree
4199 at point, extracting information from the headline properties
4200 first.
4202 When optional argument VISIBLE-ONLY is non-nil, don't export
4203 contents of hidden elements.
4205 EXT-PLIST, when provided, is a property list with external
4206 parameters overriding Org default settings, but still inferior to
4207 file-local settings.
4209 Return output file's name."
4216 ,outfile
4221 ;; Let `htmlfontify' know that we are interested in
4222 ;; collecting styles.
4224 ;; Initialize content.xml and kick-off the export
4225 ;; process.
4238 outfile
4243 ;; Let `htmlfontify' know that we are interested in collecting
4244 ;; styles.
4246 ;; Initialize content.xml and kick-off the export process.
4256 ;;;; Convert between OpenDocument and other formats
4259 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4268 "Workhorse routine for `org-odt-convert'."
4277 in-fmt out-fmt)))
4305 out-file)
4308 nil))))
4311 "Return verbose info about formats to which IN-FMT can be converted.
4312 Return a list where each element is of the
4313 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4314 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4315 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4319 org-odt-convert-processes t))))
4323 org-odt-convert-processes t))
4324 org-odt-convert-capabilities))
4325 reachable-formats)
4330 reachable-formats))
4333 "Return list of formats to which IN-FMT can be converted.
4334 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4340 l))
4343 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4344 This is a helper routine for interactive use."
4347 nil buffer-file-name t))
4353 out-fmt-choices nil nil nil))
4355 "No known converter or no known output formats for %s files"
4356 in-fmt))))
4359 ;;;###autoload
4361 "Convert IN-FILE to format OUT-FMT using a command line converter.
4362 IN-FILE is the file to be converted. If unspecified, it defaults
4363 to variable `buffer-file-name'. OUT-FMT is the desired output
4364 format. Use `org-odt-convert-process' as the converter.
4365 If PREFIX-ARG is non-nil then the newly converted file is opened
4366 using `org-open-file'."
4371 ;;; Library Initializations
4375 ;; Let Emacs open all OpenDocument files in archive mode
4378 org-odt-file-extensions)
4382 ;; Local variables:
4383 ;; generated-autoload-file: "org-loaddefs.el"
4384 ;; End:
4386 ;;; ox-odt.el ends here