| blob | eb359a47a5e27e95b3e1e1d276d7d7c04e52e617 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2014 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 ;; Other variables.
105 (:odt-create-custom-styles-for-srcblocks
106 nil nil org-odt-create-custom-styles-for-srcblocks)
121 ;; Redefine regular option.
125 ;;; Dependencies
127 ;;; Hooks
129 ;;; Function Declarations
138 \f
139 ;;; Internal Variables
143 "Location of ODT exporter.
144 Use this to infer values of `org-odt-styles-dir' and
149 "Data directory for ODT exporter.
150 Use this to infer values of `org-odt-styles-dir' and
167 "List of directories to search for OpenDocument schema files.
168 Use this list to set the default value of
169 `org-odt-schema-dir'. The entries in this list are
170 populated heuristically based on the values of `org-odt-lib-dir'
183 )
184 "List of directories to search for OpenDocument styles files.
185 See `org-odt-styles-dir'. The entries in this list are populated
186 heuristically based on the values of `org-odt-lib-dir' and
203 styles-dir)
205 org-odt-styles-dir-list)
206 nil)))
209 styles-dir)
210 "Directory that holds auxiliary XML files used by the ODT exporter.
212 This directory contains the following XML files -
214 XML files are used as the default values of
215 `org-odt-styles-file' and
216 `org-odt-content-template-file'.
218 The default value of this variable varies depending on the
219 version of org in use and is initialized from
220 `org-odt-styles-dir-list'. Note that the user could be using org
221 from one of: org's own private git repository, GNU ELPA tar or
244 "
246 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
247 </style:style>
248 "
252 "Registry of automatic styles for various OBJECT-TYPEs.
253 The variable has the following form:
254 \(\(OBJECT-TYPE-A
255 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
256 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
257 \(OBJECT-TYPE-B
258 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
259 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
260 ...\).
263 OBJECT-PROPS is (typically) a plist created by passing
269 "Running counters for various OBJECT-TYPEs.
270 Use this to generate automatic names and style-names. See
274 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
275 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
276 <style:background-image/>
277 </style:paragraph-properties>
279 </style:style>"
280 "Custom paragraph style for colorized source and example blocks.
282 except that the foreground and background colors are set
296 "Hardcoded image dimensions one for each of the anchor
299 ;; A4 page size is 21.0 by 29.7 cms
300 ;; The default page settings has 2cm margin on each of the sides. So
301 ;; the effective text area is 17.0 by 25.7 cm
310 "Specify how labels are applied and referenced.
312 This is an alist where each element is of the form:
314 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
316 ATTACH-FMT controls how labels and captions are attached to an
317 entity. It may contain following specifiers - %e and %c. %e is
318 replaced with the CATEGORY-NAME. %n is replaced with
320 with CAPTION.
322 REF-MODE and REF-FMT controls how label references are generated.
323 The following XML is generated for a label reference -
326 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
327 %n is replaced with SEQNO.
337 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
339 This is a list where each entry is of the form:
341 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
343 CATEGORY_HANDLE identifies the captionable entity in question.
345 OD-VARIABLE is the OpenDocument sequence counter associated with
346 the entity. These counters are declared within
348 `org-odt-content-template-file'.
350 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
351 how a given entity should be captioned and referenced.
353 CATEGORY-NAME is used for qualifying captions on export.
355 ENUMERATOR-PREDICATE is used for assigning a sequence number to
365 \f
366 ;;; User Configuration Variables
369 "Options for exporting Org mode files to ODT."
374 ;;;; Debugging
377 "Specify whether or not the xml output should be prettified.
378 When this option is turned on, `indent-region' is run on all
379 component xml buffers before they are saved. Turn this off for
380 regular use. Turn this on if you need to examine the xml
381 visually."
387 ;;;; Document schema
400 schema-dir))
403 schema-dir))
407 schema-dir)
409 org-odt-schema-dir-list)
411 nil)))
412 schema-dir)
413 "Directory that contains OpenDocument schema files.
415 This directory contains:
416 1. rnc files for OpenDocument schema
418 for auto validation of OpenDocument XML files.
420 Use the customize interface to set this variable. This ensures
421 that `rng-schema-locating-files' is updated and auto-validation
422 of OpenDocument XML takes place based on the value
423 `rng-nxml-auto-validate-flag'.
425 The default value of this variable varies depending on the
426 version of org in use and is initialized from
427 `org-odt-schema-dir-list'. The OASIS schema files are available
428 only in the org's private git repository. It is *not* bundled
429 with GNU ELPA tar or standard Emacs distribution."
435 :set
437 "Set `org-odt-schema-dir'.
438 Also add it to `rng-schema-locating-files'."
448 schema-dir
451 value))
452 nil)))
457 org-odt-schema-dir))))))
460 ;;;; Document styles
464 The exporter embeds the exported content just before
468 under `org-odt-styles-dir' is used."
475 "Default styles file for use with ODT export.
476 Valid values are one of:
477 1. nil
478 2. path to a styles.xml file
479 3. path to a *.odt or a *.ott file
480 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
481 ...))
483 In case of option 1, an in-built styles.xml is used. See
484 `org-odt-styles-dir' for more information.
486 In case of option 3, the specified file is unzipped and the
487 styles.xml embedded therein is used.
489 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
490 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
491 generated odt file. Use relative path for specifying the
492 FILE-MEMBERS. styles.xml must be specified as one of the
493 FILE-MEMBERS.
495 Use options 1, 2 or 3 only if styles.xml alone suffices for
496 achieving the desired formatting. Use option 4, if the styles.xml
497 references additional files like header and footer images for
498 achieving the desired formatting.
501 a per-file basis. For example,
507 :type
519 "Outline levels considered for enumerating captioned entities."
525 ;;;; Document conversion
532 "Specify a list of document converters and their usage.
533 The converters in this list are offered as choices while
534 customizing `org-odt-convert-process'.
536 This variable is a list where each element is of the
537 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
538 of the converter. CONVERTER-CMD is the shell command for the
539 converter and can contain format specifiers. These format
540 specifiers are interpreted as below:
542 %i input file name in full
543 %I input file name as a URL
544 %f format of the output file
545 %o output file name in full
546 %O output file name as a URL
547 %d output dir in full
548 %D output dir as a URL.
549 %x extra options as set in `org-odt-convert-capabilities'."
552 :type
561 During customization, the list of converter names are populated
562 from `org-odt-convert-processes'."
572 org-odt-convert-processes))))
590 "Specify input and output formats of `org-odt-convert-process'.
591 More correctly, specify the set of input and output formats that
592 the user is actually interested in.
594 This variable is an alist where each element is of the
595 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
596 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
597 alist where each element is of the form (OUTPUT-FMT
598 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
600 The variable is interpreted as follows:
601 `org-odt-convert-process' can take any document that is in
602 INPUT-FMT-LIST and produce any document that is in the
603 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
604 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
605 serves dual purposes:
606 - It is used for populating completion candidates during
607 `org-odt-convert' commands.
609 `org-odt-convert-process'.
612 `org-odt-convert-process'.
614 DOCUMENT-CLASS is used to group a set of file formats in
615 INPUT-FMT-LIST in to a single class.
617 Note that this variable inherently captures how LibreOffice based
618 converters work. LibreOffice maps documents of various formats
619 to classes like Text, Web, Spreadsheet, Presentation etc and
620 allow document of a given class (irrespective of its source
621 format) to be converted to any of the export formats associated
622 with that class.
624 See default setting of this variable for an typical
625 configuration."
628 :type
633 :value-type
637 :value-type
646 and then uses `org-odt-convert-process' to convert the
647 resulting document to this format. During customization of this
648 variable, the list of valid values are populated based on
649 `org-odt-convert-capabilities'.
651 You can set this option on per-file basis using file local
652 values. See Info node `(emacs) File Variables'."
663 ;;;###autoload
667 ;;;; Drawers
671 "Function called to format a drawer in ODT code.
673 The function must accept two parameters:
675 CONTENTS the contents of the drawer.
677 The function should return the string to be exported.
679 The default value simply returns the value of CONTENTS."
686 ;;;; Headline
689 "Function to format headline text.
691 This function will be called with 5 arguments:
692 TODO the todo keyword \(string or nil\).
693 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
694 PRIORITY the priority of the headline \(integer or nil\)
695 TEXT the main headline text \(string\).
696 TAGS the tags string, separated with colons \(string or nil\).
698 The function result will be used as headline text."
705 ;;;; Inlinetasks
708 "Function called to format an inlinetask in ODT code.
710 The function must accept six parameters:
711 TODO the todo keyword, as a string
712 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
713 PRIORITY the inlinetask priority, as a string
714 NAME the inlinetask name, as a string.
715 TAGS the inlinetask tags, as a string.
716 CONTENTS the contents of the inlinetask, as a string.
718 The function should return the string to be exported."
725 ;;;; LaTeX
728 "Non-nil means process LaTeX math snippets.
730 When set, the exporter will process LaTeX environments and
731 fragments.
733 This option can also be set with the +OPTIONS line,
736 nil Ignore math snippets.
737 `verbatim' Keep everything in verbatim
738 `dvipng' Process the LaTeX fragments to images. This will also
739 include processing of non-math environments.
740 `imagemagick' Convert the LaTeX fragments to pdf files and use
741 imagemagick to convert pdf files to png files.
742 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
743 be loaded.
744 t Synonym for `mathjax'."
756 ;;;; Links
760 "Rules characterizing formula files that can be inlined into ODT.
762 A rule consists in an association whose key is the type of link
763 to consider, and value is a regexp that will be matched against
764 link's path."
773 "Rules characterizing image files that can be inlined into ODT.
775 A rule consists in an association whose key is the type of link
776 to consider, and value is a regexp that will be matched against
777 link's path."
785 "Scaling factor for converting images pixels to inches.
786 Use this for sizing of embedded images. See Info node `(org)
787 Images in ODT export' for more information."
794 ;;;; Src Block
797 "Whether custom styles for colorized source blocks be automatically created.
798 When this option is turned on, the exporter creates custom styles
799 for source blocks based on the advice of `htmlfontify'. Creation
800 of custom styles happen as part of `org-odt-hfy-face-to-css'.
802 When this option is turned off exporter does not create such
803 styles.
805 Use the latter option if you do not want the custom styles to be
806 based on your current display settings. It is necessary that the
807 styles.xml already contains needed styles for colorizing to work.
809 This variable is effective only if
810 `org-odt-fontify-srcblocks' is turned on."
816 "Specify whether or not source blocks need to be fontified.
817 Turn this option on if you want to colorize the source code
818 blocks in the exported file. For colorization to work, you need
819 to make available an enhanced version of `htmlfontify' library."
825 ;;;; Table
838 "Specify how Table Styles should be derived from a Table Template.
839 This is a list where each element is of the
840 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
842 TABLE-STYLE-NAME is the style associated with the table through
845 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
846 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
847 below) that is included in
848 `org-odt-content-template-file'.
850 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
852 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
860 TABLE-CELL-OPTIONS is an alist where each element is of the
861 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
862 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
863 `use-last-row-styles' |
864 `use-first-column-styles' |
865 `use-last-column-styles' |
866 `use-banding-rows-styles' |
867 `use-banding-columns-styles' |
868 `use-first-row-styles'
869 ON-OR-OFF := `t' | `nil'
871 For example, with the following configuration
873 \(setq org-odt-table-styles
875 \(\(use-first-row-styles . t\)
876 \(use-first-column-styles . t\)\)\)
878 \(\(use-first-column-styles . t\)\)\)\)\)
881 style will use the following table-cell styles -
886 as appropriate.
889 use the following table-cell styles -
891 following paragraph styles
893 as appropriate..
895 Note that TABLE-TEMPLATE-NAME corresponds to the
898 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
901 specification for more information. Also consult the
902 implementation filed under `org-odt-get-table-cell-styles'.
905 formatting of numbered display equations. Do not delete this
906 style from the list."
916 use-last-row-styles
917 use-first-column-styles
918 use-last-column-styles
919 use-banding-rows-styles
920 use-banding-columns-styles)
921 :key-type symbol
924 ;;;; Timestamps
927 "Non-nil, if timestamps should be exported as date fields.
929 When nil, export timestamps as plain text.
931 When non-nil, map `org-time-stamp-custom-formats' to a pair of
933 respectively. A timestamp with no time component is formatted
937 This feature is experimental. Most (but not all) of the common
938 %-specifiers in `format-time-string' are supported.
940 formatted as canonical Org timestamps. For finer control, avoid
941 these %-specifiers.
944 etc., are displayed by the application in the default language
945 and country specified in `org-odt-styles-file'. Note that the
947 can localize the week day and month strings in the exported
948 document by setting the default language and country either using
949 the application UI or through a custom styles file.
951 See `org-odt--build-date-styles' for implementation details."
958 \f
959 ;;; Internal functions
961 ;;;; Date
976 ;; LibreOffice does not care about end goes as content
977 ;; within the "<text:date>...</text:date>" field. The
978 ;; displayed date is automagically corrected to match the
979 ;; format requested by "style:data-style-name" attribute. So
980 ;; don't bother about formatting the date contents to be
981 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
982 ;; simple Org-style date should suffice.
1007 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1008 iso-date style date)
1010 repeater)))))
1012 ;;;; Frame
1020 extra
1026 style frame-attrs
1038 ;;;; Library wrappers
1045 ;; This is shamelessly stolen from `archive-zip-extract'.
1051 name)))
1056 exit-code command-output)
1064 members))
1066 ;;;; Target
1075 ;;;; Textbox
1078 extra anchor-type)
1084 text)
1085 width nil style extra anchor-type))
1089 ;;;; Table of Contents
1094 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1096 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1103 "
1104 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1106 <text:index-entry-chapter/>
1107 <text:index-entry-text/>
1108 <text:index-entry-link-end/>
1109 </text:table-of-content-entry-template>
1113 </text:table-of-content-source>
1115 <text:index-body>
1118 </text:index-title>
1123 </text:index-body>
1124 </text:table-of-content>
1132 ;; Section number.
1134 ;; Todo.
1139 style todo)))
1144 style priority)))
1145 ;; Title.
1146 text
1147 ;; Tags.
1151 "OrgTags"
1158 headline-label text))
1162 ;; When a headline is marked as a radio target, as in the example below:
1163 ;;
1164 ;; ** <<<Some Heading>>>
1165 ;; Some text.
1166 ;;
1167 ;; suppress generation of radio targets. i.e., Radio targets are to
1168 ;; be marked as targets within /document body/ and *not* within
1169 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1170 ;; and one in the document body.
1171 ;;
1172 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1173 ;; doesn't provide a way to disable memoization. So this doesn't
1174 ;; work.
1175 ;;
1176 ;; FIXME-2: Are there any other objects that need to be suppressed
1177 ;; within TOC?
1197 style entry)))
1202 ;;;; Document styles
1205 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1206 OBJECT-PROPS is (typically) a plist created by passing
1208 `org-odt-parse-block-attributes'.
1210 Use `org-odt-object-counters' to generate an automatic
1211 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1212 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1213 . STYLE-NAME)."
1229 ;;;; Checkbox
1232 "Return check-box string associated to ITEM."
1241 ;;; Template
1244 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1245 ;; to modify the date fields. A date could be modified by
1246 ;; offsetting in days. That's about it. Also, date and time may
1247 ;; have to be emitted as two fields - a date field and a time field
1248 ;; - separately.
1250 ;; One can add Form Controls to date and time fields so that they
1251 ;; can be easily modified. But then, the exported document will
1252 ;; become tightly coupled with LibreOffice and may not function
1253 ;; properly with other OpenDocument applications.
1255 ;; I have a strange feeling that Date styles are a bit flaky at the
1256 ;; moment.
1258 ;; The feature is experimental.
1304 ))
1312 filler-end))
1323 style
1326 output ))))
1329 "Return complete document string after ODT conversion.
1330 CONTENTS is the transcoded contents string. RAW-DATA is the
1331 original parsed data. INFO is a plist holding export options."
1332 ;; Write meta file.
1342 <office:document-meta
1352 ;; Date, if required.
1354 ;; Check if DATE is specified as an Org-timestamp. If yes,
1355 ;; include it as meta information. Otherwise, just use
1356 ;; today's date.
1365 iso-date)))))
1376 ;; Add meta.xml in to manifest.
1379 ;; Update styles file.
1380 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1381 ;; Write styles file.
1384 ;; Non-availability of styles.xml is not a critical
1385 ;; error. For now, throw an error.
1387 org-odt-styles-file
1389 org-odt-styles-dir)
1402 members)))
1412 org-odt-styles-file))))
1414 ;; create a manifest entry for styles.xml
1417 ;; FIXME: Who is opening an empty styles.xml before this point?
1422 ;; Write custom styles for source blocks
1423 ;; Save STYLES used for colorizing of source blocks.
1424 ;; Update styles.xml with styles that were collected as part of
1425 ;; `org-odt-hfy-face-to-css' callbacks.
1434 ;; Update styles.xml - take care of outline numbering
1436 ;; Don't make automatic backup of styles.xml file. This setting
1437 ;; prevents the backed-up styles.xml file from being zipped in to
1438 ;; odt file. This is more of a hackish fix. Better alternative
1439 ;; would be to fix the zip command so that the output odt file
1440 ;; includes only the needed files and excludes any auto-generated
1441 ;; extra files like backups and auto-saves etc etc. Note that
1442 ;; currently the zip command zips up the entire temp directory so
1443 ;; that any auto-generated files created under the hood ends up in
1444 ;; the resulting odt file.
1447 ;; Outline numbering is retained only upto LEVEL.
1448 ;; To disable outline numbering pass a LEVEL of 0.
1461 ;; Update content.xml.
1464 ;; within the context of the Org buffer. So obtain its
1465 ;; value before moving on to temp-buffer context down below.
1475 org-odt-styles-dir)))
1476 ;; Write automatic styles.
1477 ;; - Position the cursor.
1481 ;; - Dump automatic table styles.
1486 ;; - Dump date-styles.
1492 ;; Update display level.
1493 ;; - Remove existing sequence decls. Also position the cursor.
1498 ;; Update sequence decls according to user preference.
1508 ;; Position the cursor to document body.
1513 ;; Preamble - Title, Author, Date etc.
1520 ;; Switch on or off above vars based on user settings
1524 ;; Title.
1529 ;; Separator.
1533 ;; Author only.
1536 "OrgSubtitle"
1538 ;; Separator.
1541 ;; Author and E-mail.
1545 "OrgSubtitle"
1550 ;; Separator.
1552 ;; Date, if required.
1555 ;; Check if DATE is specified as a timestamp.
1561 "OrgSubtitle"
1565 ;; Separator
1567 ;; Table of Contents
1570 with-toc
1573 ;; Contents.
1575 ;; Return contents.
1579 \f
1580 ;;; Transcode Functions
1582 ;;;; Bold
1585 "Transcode BOLD from Org to ODT.
1586 CONTENTS is the text with bold markup. INFO is a plist holding
1587 contextual information."
1592 ;;;; Center Block
1595 "Transcode a CENTER-BLOCK element from Org to ODT.
1596 CONTENTS holds the contents of the center block. INFO is a plist
1597 holding contextual information."
1598 contents)
1601 ;;;; Clock
1604 "Transcode a CLOCK element from Org to ODT.
1605 CONTENTS is nil. INFO is a plist used as a communication
1606 channel."
1619 ;;;; Code
1622 "Transcode a CODE object from Org to ODT.
1623 CONTENTS is nil. INFO is a plist used as a communication
1624 channel."
1630 ;;;; Comment
1632 ;; Comments are ignored.
1635 ;;;; Comment Block
1637 ;; Comment Blocks are ignored.
1640 ;;;; Drawer
1643 "Transcode a DRAWER element from Org to ODT.
1644 CONTENTS holds the contents of the block. INFO is a plist
1645 holding contextual information."
1648 name contents)))
1649 output))
1652 ;;;; Dynamic Block
1655 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1656 CONTENTS holds the contents of the block. INFO is a plist
1657 holding contextual information. See `org-export-data'."
1658 contents)
1661 ;;;; Entity
1664 "Transcode an ENTITY object from Org to ODT.
1665 CONTENTS are the definition itself. INFO is a plist holding
1666 contextual information."
1670 ;;;; Example Block
1673 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1674 CONTENTS is nil. INFO is a plist holding contextual information."
1678 ;;;; Export Snippet
1681 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1682 CONTENTS is nil. INFO is a plist holding contextual information."
1687 ;;;; Export Block
1690 "Transcode a EXPORT-BLOCK element from Org to ODT.
1691 CONTENTS is nil. INFO is a plist holding contextual information."
1696 ;;;; Fixed Width
1699 "Transcode a FIXED-WIDTH element from Org to ODT.
1700 CONTENTS is nil. INFO is a plist holding contextual information."
1704 ;;;; Footnote Definition
1706 ;; Footnote Definitions are ignored.
1709 ;;;; Footnote Reference
1712 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1713 CONTENTS is nil. INFO is a plist holding contextual information."
1723 id note-class
1736 "OrgSuperscript"
1737 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1738 note-class ref-format ref-name n)))))))
1740 ;; Insert separator between two footnotes in a row.
1745 ;; Transcode footnote reference.
1750 ;; Inline definitions are secondary strings.
1751 ;; Non-inline footnotes definitions are full Org data.
1754 footnote-reference info))
1758 raw
1761 :transcoders
1764 p c "Footnote"
1765 "OrgFootnoteCenter"
1767 info))))
1774 ;;;; Headline
1780 ;; Todo.
1784 style todo)))
1789 style priority)))
1790 ;; Title.
1791 text
1792 ;; Tags.
1795 "<text:tab/>"
1804 &optional format-function
1806 "Transcode a HEADLINE element using BACKEND.
1807 INFO is a plist holding contextual information."
1834 todo todo-type priority text tags))))
1837 todo todo-type priority text tags
1842 "Transcode a HEADLINE element from Org to ODT.
1843 CONTENTS holds the contents of the headline. INFO is a plist
1844 holding contextual information."
1845 ;; Case 1: This is a footnote section: ignore it.
1848 ;; Create the headline text.
1850 ;; Get level relative to current parsed data.
1852 ;; Get canonical label for the headline.
1856 ;; Get user-specified labels for the headline.
1859 ;; Extra targets.
1867 ;; Title.
1870 ;; Case 2. This is a deep sub-tree: export it as a list item.
1871 ;; Also export as items headlines for which no section
1872 ;; format has been found.
1874 ;; Build the real contents of the sub-tree.
1878 ;; Choose style based on list type.
1881 ;; If top-level list, re-start numbering. Otherwise,
1882 ;; continue numbering.
1885 headline)))
1895 "Text_20_body"
1897 contents)
1899 "</text:list-header>"
1903 ;; Case 3. Standard headline. Export it as a section.
1909 level
1911 contents))))))
1914 ;;;; Horizontal Rule
1917 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1918 CONTENTS is nil. INFO is a plist holding contextual information."
1923 ;;;; Inline Babel Call
1925 ;; Inline Babel Calls are ignored.
1928 ;;;; Inline Src Block
1931 "Return a character not used in string S.
1933 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1939 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1940 CONTENTS holds the contents of the item. INFO is a plist holding
1941 contextual information."
1948 ;;;; Inlinetask
1951 "Transcode an INLINETASK element from Org to ODT.
1952 CONTENTS holds the contents of the block. INFO is a plist
1953 holding contextual information."
1955 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1956 ;; with appropriate arguments.
1963 todo todo-type priority text tags contents)))))
1966 ;; Otherwise, use a default template.
1969 "Text_20_body"
1973 "OrgInlineTaskHeading"
1975 contents)
1978 ;;;; Italic
1981 "Transcode ITALIC from Org to ODT.
1982 CONTENTS is the text with italic markup. INFO is a plist holding
1983 contextual information."
1988 ;;;; Item
1991 "Transcode an ITEM element from Org to ODT.
1992 CONTENTS holds the contents of the item. INFO is a plist holding
1993 contextual information."
2004 contents
2016 ;;;; Keyword
2019 "Transcode a KEYWORD element from Org to ODT.
2020 CONTENTS is nil. INFO is a plist holding contextual information."
2026 ;; FIXME
2037 ;; FIXME
2041 ;;;; Latex Environment
2044 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2045 ;; (defadvice org-format-latex-as-mathml ; FIXME
2046 ;; (after org-odt-protect-latex-fragment activate)
2047 ;; "Encode LaTeX fragment as XML.
2048 ;; Do this when translation to MathML fails."
2049 ;; (unless (> (length ad-return-value) 0)
2050 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2053 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2054 CONTENTS is nil. INFO is a plist holding contextual information."
2060 ;;;; Latex Fragment
2062 ;; (when latex-frag ; FIXME
2063 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2064 ;; :description latex-frag)))
2065 ;; handle verbatim
2066 ;; provide descriptions
2069 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2070 CONTENTS is nil. INFO is a plist holding contextual information."
2077 ;;;; Line Break
2080 "Transcode a LINE-BREAK object from Org to ODT.
2081 CONTENTS is nil. INFO is a plist holding contextual information."
2085 ;;;; Link
2087 ;;;; Links :: Label references
2098 x)))))
2109 counter))
2116 ;; Section number.
2120 ;; Separator.
2122 ;; Ordinal.
2124 tag))
2127 "Return a label for ELEMENT.
2129 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2130 element. INFO is a plist used as a communication channel. OP is
2131 either `definition' or `reference', depending on the purpose of
2132 the generated string.
2134 Return value is a string if OP is set to `reference' or a cons
2135 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2136 SHORT-CAPTION are strings."
2142 ;; Get label and caption.
2146 ;; FIXME: We don't use short-caption for now
2162 element))))
2165 seqno)
2169 ;; Compute sequence number of the element.
2171 ;; Localize category string.
2174 ;; Case 1: Handle Label definition.
2176 ;; Assign an internal label, if user has not provided one
2181 ;; Sneak in a bookmark. The bookmark is used when the
2182 ;; labeled element is referenced with a link that
2183 ;; provides its own description.
2185 ;; Label definition: Typically formatted as below:
2186 ;; CATEGORY SEQ-NO: LONG CAPTION
2187 ;; with translation for correct punctuation.
2194 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2195 label counter counter seqno))
2197 short-caption))
2198 ;; Case 2: Handle Label reference.
2205 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2211 ;;;; Links :: Inline Images
2214 "Returns the internal name of the file"
2230 target-file))
2233 user-height scale dpi embed-as)
2253 ;; Use Imagemagick.
2258 file))))
2263 ;; Use Emacs.
2269 ;; Use hard-coded values.
2271 org-odt-default-image-sizes-alist))
2272 ;; Error out.
2285 ;; ensure that an embedded image fits comfortably within a page
2296 "Return ODT code for an inline image.
2297 LINK is the link pointing to the inline image. INFO is a plist
2298 used as a communication channel."
2311 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2313 ;; Extract attributes from #+ATTR_ODT line.
2317 ;; Convert attributes to a plist.
2319 ;; Handle `:anchor', `:style' and `:attributes' properties.
2329 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2330 ;;
2331 ;; Handle `:width', `:height' and `:scale' properties. Read
2332 ;; them as numbers since we need them for computations.
2334 src-expanded
2341 nil ; embed-as
2343 ))
2350 ;; Check if this link was created by LaTeX-to-PNG converter.
2354 ;; If yes, note down the type of the element - LaTeX Fragment
2355 ;; or LaTeX environment. It will go in to frame title.
2359 ;; If yes, note down its contents. It will go in to frame
2360 ;; description. This quite useful for debugging.
2363 captions user-frame-params title desc)))
2366 ;;;; Links :: Math formula
2387 ;; Check if this link was created by LaTeX-to-MathML
2388 ;; converter.
2392 ;; If yes, note down the type of the element - LaTeX Fragment
2393 ;; or LaTeX environment. It will go in to frame title.
2397 ;; If yes, note down its contents. It will go in to frame
2398 ;; description. This quite useful for debugging.
2400 width height)
2404 nil nil title desc))
2407 "CaptionedDisplayFormula" href width height
2408 captions nil title desc))
2412 org-odt--enumerable-formula-p))))
2417 "Returns the internal name of the file"
2421 ;; Create a directory for holding formula file. Also enter it in
2422 ;; to manifest.
2426 ;; Copy over the formula file from user directory to zip
2427 ;; directory.
2431 ;; Case 1: Mathml.
2434 ;; Case 2: OpenDocument formula.
2439 ;; Enter the formula file in to manifest.
2441 target-file))
2443 ;;;; Targets
2446 captions user-frame-params
2449 ;; Each element of this alist is of the form (CFG-HANDLE
2450 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2452 ;; CFG-HANDLE is the key to the alist.
2454 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2455 ;; frame params for INNER-FRAME and OUTER-FRAME
2456 ;; respectively. See below.
2458 ;; Configurations that are meant to be applied to
2459 ;; non-captioned image/formula specifies no
2460 ;; OUTER-FRAME-PARAMS.
2462 ;; TERMINOLOGY
2463 ;; ===========
2464 ;; INNER-FRAME :: Frame that directly surrounds an
2465 ;; image/formula.
2467 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2468 ;; frame also contains the caption, if any.
2470 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2471 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2472 ;; that these are the last three arguments
2473 ;; to `org-odt--frame'.
2475 ;; Note that an un-captioned image/formula requires just an
2476 ;; INNER-FRAME, while a captioned image/formula requires
2477 ;; both an INNER and an OUTER-FRAME.
2499 ;; Retrieve inner and outer frame params, from configuration.
2503 ;; User-specified frame params (from #+ATTR_ODT spec)
2507 "Merge default and user frame params."
2512 for d in default
2515 ;; Case 1: Image/Formula has no caption.
2516 ;; There is only one frame, one that surrounds the image
2517 ;; or formula.
2519 ;; Merge user frame params with that from configuration.
2523 ;; Case 2: Image/Formula is captioned or labeled.
2524 ;; There are two frames: The inner one surrounds the
2525 ;; image or formula. The outer one contains the
2526 ;; caption/sequence number.
2528 ;; Merge user frame params with outer frame params.
2530 ;; Short caption, if specified, goes as part of inner frame.
2537 frame-params))
2540 "Illustration"
2544 caption))
2545 width height outer)))))
2548 ;; Element should have a caption or label.
2554 element info
2555 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2556 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2557 ;; processing.)
2562 ;; Link should point to an image file.
2569 element info
2570 ;; Paragraph should have a caption or label. It SHOULD also be a
2571 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2572 ;; processing.)
2577 ;; Link should point to an image file.
2584 element info
2585 ;; Paragraph should have a caption or label.
2589 ;; Link should point to a MathML or ODF file.
2595 paragraph-predicate
2596 link-predicate)
2597 "Test if ELEMENT is a standalone link for the purpose ODT export.
2598 INFO is a plist holding contextual information.
2600 Return non-nil, if ELEMENT is of type paragraph satisfying
2601 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2602 is a link that satisfies LINK-PREDICATE.
2604 Return non-nil, if ELEMENT is of type link satisfying
2605 LINK-PREDICATE and its containing paragraph satisfies
2606 PARAGRAPH-PREDICATE in addition to having no other content save for
2607 leading and trailing whitespaces.
2609 Return nil, otherwise."
2632 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2633 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2634 ;; attached. Note that labels that are attached to captioned
2635 ;; entities - inline images, math formulae and tables - get resolved
2636 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2638 ;; Create a cross-reference to DESTINATION but make best-efforts to
2639 ;; create a *meaningful* description. Check item numbers, section
2640 ;; number and section title in that order.
2642 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2643 ;; FIXME: Handle footnote-definition footnote-reference?
2659 return x))
2660 ;; Get list item nos.
2665 plain-list)
2668 item info t))))))
2669 ;; Locate top-most listified headline.
2674 return x))
2675 ;; Get listified headline numbers.
2681 el info t)))))))
2682 ;; Combine item numbers from both the listified headlines and
2683 ;; regular list items.
2685 ;; Case 1: Check if all the parents of list item are numbered.
2686 ;; If yes, link to the item proper.
2689 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2694 ;; Case 2: Locate a regular and numbered headline in the
2695 ;; hierarchy. Display its section number.
2700 return el)))
2701 ;; We found one.
2703 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2707 ;; Case 4: Locate a regular headline in the hierarchy. Display
2708 ;; its title.
2712 return el)))
2713 ;; We found one.
2715 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2722 "Transcode a LINK object from Org to ODT.
2724 DESC is the description part of the link, or the empty string.
2725 INFO is a plist holding contextual information. See
2726 `org-export-data'."
2729 ;; Ensure DESC really exists, or set it to nil.
2732 link org-odt-inline-image-rules))
2739 ;; Convert & to & for correct XML representation
2741 protocol)
2743 ;; Image file.
2745 link org-odt-inline-image-rules))
2747 ;; Formula file.
2749 link org-odt-inline-formula-rules))
2751 ;; Radio target: Transcode target's contents and use them as
2752 ;; link's description.
2757 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2760 desc))))
2761 ;; Links pointing to a headline: Find destination and build
2762 ;; appropriate referencing command.
2768 ;; Case 1: Fuzzy link points nowhere.
2769 ('nil
2771 "Emphasis"
2774 info))))
2775 ;; Case 2: Fuzzy link points to a headline.
2777 ;; If there's a description, create a hyperlink.
2778 ;; Otherwise, try to provide a meaningful description.
2787 label desc))))
2788 ;; Case 3: Fuzzy link points to a target.
2790 ;; If there's a description, create a hyperlink.
2791 ;; Otherwise, try to provide a meaningful description.
2796 desc))))
2797 ;; Case 4: Fuzzy link points to some element (e.g., an
2798 ;; inline image, a math formula or a table).
2805 ;; LINK has no description. Create
2806 ;; a cross-reference showing entity's sequence
2807 ;; number.
2809 ;; LINK has description. Insert a hyperlink with
2810 ;; user-provided description.
2815 desc)))))))))
2816 ;; Coderef: replace link with the reference name or the
2817 ;; equivalent line number.
2824 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2825 href line-no))))
2826 ;; Link type is handled by a special function.
2829 ;; External link with a description part.
2832 ;; Check if description is a link to an inline image.
2837 desc-element org-odt-inline-image-rules))))
2838 ;; Format link as a clickable image.
2840 path desc)
2841 ;; Otherwise, format it as a regular link.
2843 path desc))))
2844 ;; External link without a description part.
2847 path path))
2848 ;; No path, only description. Try to do something useful.
2853 ;;;; Node Property
2856 "Transcode a NODE-PROPERTY element from Org to ODT.
2857 CONTENTS is nil. INFO is a plist holding contextual
2858 information."
2865 ;;;; Paragraph
2868 "Format paragraph according to given styles.
2869 PARAGRAPH is a paragraph type element. CONTENTS is the
2870 transcoded contents of that paragraph, as a string. DEFAULT,
2871 CENTER and QUOTE are, respectively, style to use when paragraph
2872 belongs to no special environment, a center block, or a quote
2873 block."
2880 ;; If this paragraph is a leading paragraph in an item and the
2881 ;; item has a checkbox, splice the checkbox and paragraph contents
2882 ;; together.
2889 "Transcode a PARAGRAPH element from Org to ODT.
2890 CONTENTS is the contents of the paragraph, as a string. INFO is
2891 the plist used as a communication channel."
2893 paragraph contents
2895 "OrgCenter"
2899 ;;;; Plain List
2902 "Transcode a PLAIN-LIST element from Org to ODT.
2903 CONTENTS is the contents of the list. INFO is a plist holding
2904 contextual information."
2906 ;; Choose style based on list type.
2912 ;; If top-level list, re-start numbering. Otherwise,
2913 ;; continue numbering.
2918 contents))
2920 ;;;; Plain Text
2933 line))
2944 "Transcode a TEXT string from Org to ODT.
2945 TEXT is the string to transcode. INFO is a plist holding
2946 contextual information."
2948 ;; Protect &, < and >.
2950 ;; Handle smart quotes. Be sure to provide original string since
2951 ;; OUTPUT may have been modified.
2954 ;; Convert special strings.
2960 org-odt-special-string-regexps))
2961 ;; Handle break preservation if required.
2965 ;; Return value.
2966 output))
2969 ;;;; Planning
2972 "Transcode a PLANNING element from Org to ODT.
2973 CONTENTS is nil. INFO is a plist used as a communication
2974 channel."
2976 "OrgPlanning"
2998 ;;;; Property Drawer
3001 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3002 CONTENTS holds the contents of the drawer. INFO is a plist
3003 holding contextual information."
3006 contents)))
3009 ;;;; Quote Block
3012 "Transcode a QUOTE-BLOCK element from Org to ODT.
3013 CONTENTS holds the contents of the block. INFO is a plist
3014 holding contextual information."
3015 contents)
3018 ;;;; Section
3023 style
3025 text)))
3029 "Transcode a SECTION element from Org to ODT.
3030 CONTENTS holds the contents of the section. INFO is a plist
3031 holding contextual information."
3032 contents)
3034 ;;;; Radio Target
3037 "Transcode a RADIO-TARGET object from Org to ODT.
3038 TEXT is the text of the target. INFO is a plist holding
3039 contextual information."
3045 ;;;; Special Block
3048 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3049 CONTENTS holds the contents of the block. INFO is a plist
3050 holding contextual information."
3054 ;; Annotation.
3060 ;; FIXME: Is `car' right thing to do below?
3070 contents)))))
3071 ;; Textbox.
3080 style extra anchor))))
3084 ;;;; Src Block
3087 "Create custom style for face FN.
3088 When FN is the default face, use its foreground and background
3090 use its color attribute to create a character style whose name
3091 is obtained from FN. Currently all attributes of FN other than
3092 color are ignored.
3094 The style name for a face FN is derived using the following
3095 operations on the face name in that order - de-dash, CamelCase
3097 `font-lock-function-name-face' is associated with
3111 background-color-val color-val))
3114 "
3145 org-odt-fontify-srcblocks
3162 code
3173 par-style loc))
3176 num-start refs))
3190 ;; Extract code and references.
3194 ;; Does the src block contain labels?
3196 ;; Does it have line numbers?
3203 "Transcode a SRC-BLOCK element from Org to ODT.
3204 CONTENTS holds the contents of the item. INFO is a plist holding
3205 contextual information."
3217 "Text_20_body"
3221 ;;;; Statistics Cookie
3224 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3225 CONTENTS is nil. INFO is a plist holding contextual information."
3231 ;;;; Strike-Through
3234 "Transcode STRIKE-THROUGH from Org to ODT.
3235 CONTENTS is the text with strike-through markup. INFO is a plist
3236 holding contextual information."
3241 ;;;; Subscript
3244 "Transcode a SUBSCRIPT object from Org to ODT.
3245 CONTENTS is the contents of the object. INFO is a plist holding
3246 contextual information."
3251 ;;;; Superscript
3254 "Transcode a SUPERSCRIPT object from Org to ODT.
3255 CONTENTS is the contents of the object. INFO is a plist holding
3256 contextual information."
3261 ;;;; Table Cell
3270 "Retrieve styles applicable to a table cell.
3271 R and C are (zero-based) row and column numbers of the table
3272 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3273 applicable to the current table. It is `nil' if the table is not
3274 associated with any style attributes.
3276 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3278 When STYLE-SPEC is nil, style the table cell the conventional way
3279 - choose cell borders based on row and column groupings and
3280 choose paragraph alignment based on `org-col-cookies' text
3281 property. See also
3282 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3284 When STYLE-SPEC is non-nil, ignore the above cookie and return
3285 styles congruent with the ODF-1.2 specification."
3291 info)))
3293 ;; LibreOffice - particularly the Writer - honors neither table
3294 ;; templates nor custom table-cell styles. Inorder to retain
3295 ;; inter-operability with LibreOffice, only automatic styles are
3296 ;; used for styling of table-cells. The current implementation is
3297 ;; congruent with ODF-1.2 specification and hence is
3298 ;; future-compatible.
3300 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3301 ;; which recognizes as many as 16 different cell types - is much
3302 ;; richer. Unfortunately it is NOT amenable to easy configuration
3303 ;; by hand.
3330 "Transcode a TABLE-CELL element from Org to ODT.
3331 CONTENTS is nil. INFO is a plist used as a communication
3332 channel."
3339 table-cell info))
3362 table-cell info))))))
3366 custom-style-prefix))
3368 "OrgTblCell"
3384 cell-attributes
3387 org-element-all-elements)
3388 contents
3390 paragraph-style contents))))
3397 ;;;; Table Row
3400 "Transcode a TABLE-ROW element from Org to ODT.
3401 CONTENTS is the contents of the row. INFO is a plist used as a
3402 communication channel."
3403 ;; Rules are ignored since table separators are deduced from
3404 ;; borders of the current row.
3410 ;; If the row belongs to the first rowgroup and the
3411 ;; table has more than one row groups, then this row
3412 ;; belongs to the header row group.
3414 ;; Otherwise, it belongs to non-header row group.
3417 ;; Does this row begin a rowgroup?
3420 ;; Actual table row
3422 ;; Does this row end a rowgroup?
3427 ;;;; Table
3440 "Transcode a TABLE element from Org to ODT.
3441 CONTENTS is the contents of the table. INFO is a plist holding
3442 contextual information."
3444 ;; Case 1: table.el doesn't support export to OD format. Strip
3445 ;; such tables from export.
3450 "(ox-odt): Found table.el-type table in the source Org file."
3451 " table.el doesn't support export to ODT format."
3453 ;; Case 2: Native Org tables.
3470 column-style))
3471 out)
3475 ;; caption.
3479 ;; begin table.
3487 ;; column specification.
3489 ;; actual contents.
3491 ;; end table.
3495 "Transcode a TABLE element from Org to ODT.
3496 CONTENTS is the contents of the table. INFO is a plist holding
3497 contextual information.
3499 Use `org-odt--table' to typeset the table. Handle details
3500 pertaining to indentation here."
3515 collect el)))
3521 collect
3526 parent-list)
3528 ;; Handle list genealogy.
3548 parent-list info)
3551 ;; Handle low-level headlines.
3553 with step = 'item collect
3561 el info)
3562 "OrgNumberedList"
3573 parent-list info)))
3581 table info)))
3582 ;; OpenDocument schema does not permit table to occur within a
3583 ;; list item.
3585 ;; One solution - the easiest and lightweight, in terms of
3586 ;; implementation - is to put the table in an indented text box
3587 ;; and make the text box part of the list-item. Unfortunately if
3588 ;; the table is big and spans multiple pages, the text box could
3589 ;; overflow. In this case, the following attribute will come
3590 ;; handy.
3592 ;; ,---- From OpenDocument-v1.1.pdf
3593 ;; | 15.27.28 Overflow behavior
3594 ;; |
3595 ;; | For text boxes contained within text document, the
3596 ;; | style:overflow-behavior property specifies the behavior of text
3597 ;; | boxes where the containing text does not fit into the text
3598 ;; | box.
3599 ;; |
3600 ;; | If the attribute's value is clip, the text that does not fit
3601 ;; | into the text box is not displayed.
3602 ;; |
3603 ;; | If the attribute value is auto-create-new-frame, a new frame
3604 ;; | will be created on the next page, with the same position and
3605 ;; | dimensions of the original frame.
3606 ;; |
3607 ;; | If the style:overflow-behavior property's value is
3608 ;; | auto-create-new-frame and the text box has a minimum width or
3609 ;; | height specified, then the text box will grow until the page
3610 ;; | bounds are reached before a new frame is created.
3611 ;; `----
3613 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3614 ;; auto-create-new-frame property and always resorts to clipping
3615 ;; the text box. This results in table being truncated.
3617 ;; So we solve the problem the hard (and fun) way using list
3618 ;; continuations.
3620 ;; The problem only becomes more interesting if you take in to
3621 ;; account the following facts:
3622 ;;
3623 ;; - Description lists are simulated as plain lists.
3624 ;; - Low-level headlines can be listified.
3625 ;; - In Org-mode, a table can occur not only as a regular list
3626 ;; item, but also within description lists and low-level
3627 ;; headlines.
3629 ;; See `org-odt-translate-description-lists' and
3630 ;; `org-odt-translate-low-level-headlines' for how this is
3631 ;; tackled.
3634 ;; Discontinue the list.
3636 ;; Put the table in an indented section.
3641 ;; Continue the list.
3645 ;;;; Target
3648 "Transcode a TARGET object from Org to ODT.
3649 CONTENTS is nil. INFO is a plist holding contextual
3650 information."
3655 ;;;; Timestamp
3658 "Transcode a TIMESTAMP object from Org to ODT.
3659 CONTENTS is nil. INFO is a plist used as a communication
3660 channel."
3677 "OrgActiveTimestamp"
3681 "OrgInactiveTimestamp"
3685 "OrgActiveTimestamp"
3691 "OrgInactiveTimestamp"
3697 "OrgDiaryTimestamp"
3699 info)))))))
3702 ;;;; Underline
3705 "Transcode UNDERLINE from Org to ODT.
3706 CONTENTS is the text with underline markup. INFO is a plist
3707 holding contextual information."
3712 ;;;; Verbatim
3715 "Transcode a VERBATIM object from Org to ODT.
3716 CONTENTS is nil. INFO is a plist used as a communication
3717 channel."
3723 ;;;; Verse Block
3726 "Transcode a VERSE-BLOCK element from Org to ODT.
3727 CONTENTS is verse block contents. INFO is a plist holding
3728 contextual information."
3729 ;; Add line breaks to each line of verse.
3733 ;; Replace tabs and spaces.
3735 ;; Surround it in a verse environment.
3740 \f
3741 ;;; Filters
3743 ;;;; LaTeX fragments
3748 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3749 ;; If the desired converter is not available, force verbatim
3750 ;; processing.
3768 ;; Store normalized value for later use.
3773 ;; Convert `latex-fragment's and `latex-environment's.
3791 ;; Get an Org-style link to PNG image or the MathML
3792 ;; file.
3797 nil display-msg
3798 nil nil processing-type)
3803 link))))
3805 ;; Conversion succeeded. Parse above Org-style link to a
3806 ;; `link' object.
3812 ;; Orphan the link.
3817 ;; Case 1: LaTeX environment.
3818 ;; Mimic a "standalone image or formula" by
3819 ;; enclosing the `link' in a `paragraph'.
3820 ;; Copy over original attributes, captions to
3821 ;; the enclosing paragraph.
3827 latex-*)
3829 latex-*)))
3830 link))
3831 ;; Case 2: LaTeX fragment.
3832 ;; No special action.
3834 ;; Note down the object that link replaces.
3838 ;; Replace now.
3840 info)))
3841 tree)
3844 ;;;; Description lists
3846 ;; This translator is necessary to handle indented tables in a uniform
3847 ;; manner. See comment in `org-odt--table'.
3850 ;; OpenDocument has no notion of a description list. So simulate it
3851 ;; using plain lists. Description lists in the exported document
3852 ;; are typeset in the same manner as they are in a typical HTML
3853 ;; document.
3854 ;;
3855 ;; Specifically, a description list like this:
3856 ;;
3857 ;; ,----
3858 ;; | - term-1 :: definition-1
3859 ;; | - term-2 :: definition-2
3860 ;; `----
3861 ;;
3862 ;; gets translated in to the following form:
3863 ;;
3864 ;; ,----
3865 ;; | - term-1
3866 ;; | - definition-1
3867 ;; | - term-2
3868 ;; | - definition-2
3869 ;; `----
3870 ;;
3871 ;; Further effect is achieved by fixing the OD styles as below:
3872 ;;
3873 ;; 1. Set the :type property of the simulated lists to
3874 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3875 ;; that has *no* bullets whatsoever.
3876 ;;
3877 ;; 2. The paragraph containing the definition term is styled to be
3878 ;; in bold.
3879 ;;
3884 el
3900 nil)
3901 info)
3902 tree)
3904 ;;;; List tables
3906 ;; Lists that are marked with attribute `:list-table' are called as
3907 ;; list tables. They will be rendered as a table within the exported
3908 ;; document.
3910 ;; Consider an example. The following list table
3911 ;;
3912 ;; #+attr_odt :list-table t
3913 ;; - Row 1
3914 ;; - 1.1
3915 ;; - 1.2
3916 ;; - 1.3
3917 ;; - Row 2
3918 ;; - 2.1
3919 ;; - 2.2
3920 ;; - 2.3
3921 ;;
3922 ;; will be exported as though it were an Org table like the one show
3923 ;; below.
3924 ;;
3925 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3926 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3927 ;;
3928 ;; Note that org-tables are NOT multi-line and each line is mapped to
3929 ;; a unique row in the exported document. So if an exported table
3930 ;; needs to contain a single paragraph (with copious text) it needs to
3931 ;; be typed up in a single line. Editing such long lines using the
3932 ;; table editor will be a cumbersome task. Furthermore inclusion of
3933 ;; multi-paragraph text in a table cell is well-nigh impossible.
3934 ;;
3935 ;; A LIST-TABLE circumvents above problems.
3936 ;;
3937 ;; Note that in the example above the list items could be paragraphs
3938 ;; themselves and the list can be arbitrarily deep.
3939 ;;
3940 ;; Inspired by following thread:
3941 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3943 ;; Translate lists to tables
3949 ;; Replace list with table.
3951 l1-list
3952 ;; Build replacement table.
3958 l1-item-leading-text l2-list)
3959 ;; Remove Level-2 list from the Level-item. It
3960 ;; will be subsequently attached as table-cells.
3970 ;; Level-1 items start a table row.
3973 ;; Leading text of level-1 item define
3974 ;; the first table-cell.
3977 l1-item-leading-text)
3978 ;; Level-2 items define subsequent
3979 ;; table-cells of the row.
3987 nil)
3988 info)
3989 tree)
3991 \f
3992 ;;; Interactive functions
4005 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4014 org-odt-manifest-file-entries)
4022 ;; Initialize temporary workarea. All files that end up in
4023 ;; the exported document get parked/created here.
4030 ;; Kill all XML buffers.
4038 org-odt-xml-files)
4039 ;; Delete temporary directory and also other embedded
4040 ;; files that get copied there.
4045 ;; Not at all OSes ship with zip by default
4047 ;; Do export. This creates a bunch of xml files ready to be
4048 ;; saved and zipped.
4050 ;; Create a manifest entry for content.xml.
4052 ;; Write mimetype file
4061 ;; Write out the manifest entries before zipping
4063 ;; Save all XML files.
4069 ;; Prettify output if needed.
4073 org-odt-xml-files)
4074 ;; Run zip.
4079 ;; If a file with same name as the desired output file
4080 ;; exists, remove it.
4083 ;; Zip up the xml files.
4086 ;; Switch temporarily to content.xml. This way Zip
4087 ;; process will inherit `org-odt-zip-dir' as the current
4088 ;; directory.
4102 err-string)))))
4103 cmds)))
4104 ;; Move the zip file from temporary work directory to
4105 ;; user-mandated location.
4108 ;; Cleanup work directory and work files.
4110 ;; Open the OpenDocument file in archive-mode for
4111 ;; examination.
4113 ;; Return exported file.
4115 ;; Case 1: Conversion desired on exported file. Run the
4116 ;; converter on the OpenDocument file. Return the
4117 ;; converted file.
4120 target))
4121 ;; Case 2: No further conversion. Return exported
4122 ;; OpenDocument file.
4125 ;; Cleanup work directory and work files.
4131 ;;;; Export to OpenDocument formula
4133 ;;;###autoload
4135 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4136 Use `org-create-math-formula' to convert LATEX-FRAG first to
4137 MathML. When invoked as an interactive command, use
4138 `org-latex-regexps' to infer LATEX-FRAG from currently active
4139 region. If no LaTeX fragments are found, prompt for it. Push
4140 MathML source to kill ring depending on the value of
4141 `org-export-copy-to-kill-ring'."
4167 filename
4180 ;; Add MathML to kill ring, if needed.
4184 ;;;###autoload
4186 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4187 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4188 formula file."
4193 ;;;; Export to OpenDocument Text
4195 ;;;###autoload
4197 "Export current buffer to a ODT file.
4199 If narrowing is active in the current buffer, only export its
4200 narrowed part.
4202 If a region is active, export that region.
4204 A non-nil optional argument ASYNC means the process should happen
4205 asynchronously. The resulting file should be accessible through
4206 the `org-export-stack' interface.
4208 When optional argument SUBTREEP is non-nil, export the sub-tree
4209 at point, extracting information from the headline properties
4210 first.
4212 When optional argument VISIBLE-ONLY is non-nil, don't export
4213 contents of hidden elements.
4215 EXT-PLIST, when provided, is a property list with external
4216 parameters overriding Org default settings, but still inferior to
4217 file-local settings.
4219 Return output file's name."
4226 ,outfile
4231 ;; Let `htmlfontify' know that we are interested in
4232 ;; collecting styles.
4234 ;; Initialize content.xml and kick-off the export
4235 ;; process.
4248 outfile
4253 ;; Let `htmlfontify' know that we are interested in collecting
4254 ;; styles.
4256 ;; Initialize content.xml and kick-off the export process.
4266 ;;;; Convert between OpenDocument and other formats
4269 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4278 "Workhorse routine for `org-odt-convert'."
4287 in-fmt out-fmt)))
4315 out-file)
4318 nil))))
4321 "Return verbose info about formats to which IN-FMT can be converted.
4322 Return a list where each element is of the
4323 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4324 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4325 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4329 org-odt-convert-processes t))))
4333 org-odt-convert-processes t))
4334 org-odt-convert-capabilities))
4335 reachable-formats)
4340 reachable-formats))
4343 "Return list of formats to which IN-FMT can be converted.
4344 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4350 l))
4353 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4354 This is a helper routine for interactive use."
4357 nil buffer-file-name t))
4363 out-fmt-choices nil nil nil))
4365 "No known converter or no known output formats for %s files"
4366 in-fmt))))
4369 ;;;###autoload
4371 "Convert IN-FILE to format OUT-FMT using a command line converter.
4372 IN-FILE is the file to be converted. If unspecified, it defaults
4373 to variable `buffer-file-name'. OUT-FMT is the desired output
4374 format. Use `org-odt-convert-process' as the converter.
4375 If PREFIX-ARG is non-nil then the newly converted file is opened
4376 using `org-open-file'."
4381 ;;; Library Initializations
4385 ;; Let Emacs open all OpenDocument files in archive mode
4388 org-odt-file-extensions)
4392 ;; Local variables:
4393 ;; generated-autoload-file: "org-loaddefs.el"
4394 ;; End:
4396 ;;; ox-odt.el ends here