| blob | 5500ebf3e7f31f4fb8bdc104dc2557836143c359 |
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
88 org-odt--translate-description-lists
89 org-odt--translate-list-tables)))
90 :menu-entry
97 :options-alist
99 ;; Other variables.
104 (:odt-create-custom-styles-for-srcblocks
105 nil nil org-odt-create-custom-styles-for-srcblocks)
120 ;; Redefine regular option.
124 ;;; Dependencies
126 ;;; Hooks
128 ;;; Function Declarations
137 \f
138 ;;; Internal Variables
142 "Location of ODT exporter.
143 Use this to infer values of `org-odt-styles-dir' and
148 "Data directory for ODT exporter.
149 Use this to infer values of `org-odt-styles-dir' and
166 "List of directories to search for OpenDocument schema files.
167 Use this list to set the default value of
168 `org-odt-schema-dir'. The entries in this list are
169 populated heuristically based on the values of `org-odt-lib-dir'
182 )
183 "List of directories to search for OpenDocument styles files.
184 See `org-odt-styles-dir'. The entries in this list are populated
185 heuristically based on the values of `org-odt-lib-dir' and
202 styles-dir)
204 org-odt-styles-dir-list)
205 nil)))
208 styles-dir)
209 "Directory that holds auxiliary XML files used by the ODT exporter.
211 This directory contains the following XML files -
213 XML files are used as the default values of
214 `org-odt-styles-file' and
215 `org-odt-content-template-file'.
217 The default value of this variable varies depending on the
218 version of org in use and is initialized from
219 `org-odt-styles-dir-list'. Note that the user could be using org
220 from one of: org's own private git repository, GNU ELPA tar or
243 "
245 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
246 </style:style>
247 "
251 "Registry of automatic styles for various OBJECT-TYPEs.
252 The variable has the following form:
253 \(\(OBJECT-TYPE-A
254 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
255 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
256 \(OBJECT-TYPE-B
257 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
258 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
259 ...\).
262 OBJECT-PROPS is (typically) a plist created by passing
268 "Running counters for various OBJECT-TYPEs.
269 Use this to generate automatic names and style-names. See
273 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
274 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
275 <style:background-image/>
276 </style:paragraph-properties>
278 </style:style>"
279 "Custom paragraph style for colorized source and example blocks.
281 except that the foreground and background colors are set
295 "Hardcoded image dimensions one for each of the anchor
298 ;; A4 page size is 21.0 by 29.7 cms
299 ;; The default page settings has 2cm margin on each of the sides. So
300 ;; the effective text area is 17.0 by 25.7 cm
309 "Specify how labels are applied and referenced.
311 This is an alist where each element is of the form:
313 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
315 ATTACH-FMT controls how labels and captions are attached to an
316 entity. It may contain following specifiers - %e and %c. %e is
317 replaced with the CATEGORY-NAME. %n is replaced with
319 with CAPTION.
321 REF-MODE and REF-FMT controls how label references are generated.
322 The following XML is generated for a label reference -
325 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
326 %n is replaced with SEQNO.
336 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
338 This is a list where each entry is of the form:
340 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
342 CATEGORY_HANDLE identifies the captionable entity in question.
344 OD-VARIABLE is the OpenDocument sequence counter associated with
345 the entity. These counters are declared within
347 `org-odt-content-template-file'.
349 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
350 how a given entity should be captioned and referenced.
352 CATEGORY-NAME is used for qualifying captions on export.
354 ENUMERATOR-PREDICATE is used for assigning a sequence number to
364 \f
365 ;;; User Configuration Variables
368 "Options for exporting Org mode files to ODT."
373 ;;;; Debugging
376 "Specify whether or not the xml output should be prettified.
377 When this option is turned on, `indent-region' is run on all
378 component xml buffers before they are saved. Turn this off for
379 regular use. Turn this on if you need to examine the xml
380 visually."
386 ;;;; Document schema
399 schema-dir))
402 schema-dir))
406 schema-dir)
408 org-odt-schema-dir-list)
410 nil)))
411 schema-dir)
412 "Directory that contains OpenDocument schema files.
414 This directory contains:
415 1. rnc files for OpenDocument schema
417 for auto validation of OpenDocument XML files.
419 Use the customize interface to set this variable. This ensures
420 that `rng-schema-locating-files' is updated and auto-validation
421 of OpenDocument XML takes place based on the value
422 `rng-nxml-auto-validate-flag'.
424 The default value of this variable varies depending on the
425 version of org in use and is initialized from
426 `org-odt-schema-dir-list'. The OASIS schema files are available
427 only in the org's private git repository. It is *not* bundled
428 with GNU ELPA tar or standard Emacs distribution."
434 :set
436 "Set `org-odt-schema-dir'.
437 Also add it to `rng-schema-locating-files'."
447 schema-dir
450 value))
451 nil)))
456 org-odt-schema-dir))))))
459 ;;;; Document styles
463 The exporter embeds the exported content just before
467 under `org-odt-styles-dir' is used."
474 "Default styles file for use with ODT export.
475 Valid values are one of:
476 1. nil
477 2. path to a styles.xml file
478 3. path to a *.odt or a *.ott file
479 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
480 ...))
482 In case of option 1, an in-built styles.xml is used. See
483 `org-odt-styles-dir' for more information.
485 In case of option 3, the specified file is unzipped and the
486 styles.xml embedded therein is used.
488 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
489 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
490 generated odt file. Use relative path for specifying the
491 FILE-MEMBERS. styles.xml must be specified as one of the
492 FILE-MEMBERS.
494 Use options 1, 2 or 3 only if styles.xml alone suffices for
495 achieving the desired formatting. Use option 4, if the styles.xml
496 references additional files like header and footer images for
497 achieving the desired formatting.
500 a per-file basis. For example,
506 :type
518 "Outline levels considered for enumerating captioned entities."
524 ;;;; Document conversion
531 "Specify a list of document converters and their usage.
532 The converters in this list are offered as choices while
533 customizing `org-odt-convert-process'.
535 This variable is a list where each element is of the
536 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
537 of the converter. CONVERTER-CMD is the shell command for the
538 converter and can contain format specifiers. These format
539 specifiers are interpreted as below:
541 %i input file name in full
542 %I input file name as a URL
543 %f format of the output file
544 %o output file name in full
545 %O output file name as a URL
546 %d output dir in full
547 %D output dir as a URL.
548 %x extra options as set in `org-odt-convert-capabilities'."
551 :type
560 During customization, the list of converter names are populated
561 from `org-odt-convert-processes'."
571 org-odt-convert-processes))))
589 "Specify input and output formats of `org-odt-convert-process'.
590 More correctly, specify the set of input and output formats that
591 the user is actually interested in.
593 This variable is an alist where each element is of the
594 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
595 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
596 alist where each element is of the form (OUTPUT-FMT
597 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
599 The variable is interpreted as follows:
600 `org-odt-convert-process' can take any document that is in
601 INPUT-FMT-LIST and produce any document that is in the
602 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
603 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
604 serves dual purposes:
605 - It is used for populating completion candidates during
606 `org-odt-convert' commands.
608 `org-odt-convert-process'.
611 `org-odt-convert-process'.
613 DOCUMENT-CLASS is used to group a set of file formats in
614 INPUT-FMT-LIST in to a single class.
616 Note that this variable inherently captures how LibreOffice based
617 converters work. LibreOffice maps documents of various formats
618 to classes like Text, Web, Spreadsheet, Presentation etc and
619 allow document of a given class (irrespective of its source
620 format) to be converted to any of the export formats associated
621 with that class.
623 See default setting of this variable for an typical
624 configuration."
627 :type
632 :value-type
636 :value-type
645 and then uses `org-odt-convert-process' to convert the
646 resulting document to this format. During customization of this
647 variable, the list of valid values are populated based on
648 `org-odt-convert-capabilities'.
650 You can set this option on per-file basis using file local
651 values. See Info node `(emacs) File Variables'."
662 ;;;###autoload
666 ;;;; Drawers
670 "Function called to format a drawer in ODT code.
672 The function must accept two parameters:
674 CONTENTS the contents of the drawer.
676 The function should return the string to be exported.
678 The default value simply returns the value of CONTENTS."
685 ;;;; Headline
688 "Function to format headline text.
690 This function will be called with 5 arguments:
691 TODO the todo keyword \(string or nil\).
692 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
693 PRIORITY the priority of the headline \(integer or nil\)
694 TEXT the main headline text \(string\).
695 TAGS the tags string, separated with colons \(string or nil\).
697 The function result will be used as headline text."
704 ;;;; Inlinetasks
707 "Function called to format an inlinetask in ODT code.
709 The function must accept six parameters:
710 TODO the todo keyword, as a string
711 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
712 PRIORITY the inlinetask priority, as a string
713 NAME the inlinetask name, as a string.
714 TAGS the inlinetask tags, as a string.
715 CONTENTS the contents of the inlinetask, as a string.
717 The function should return the string to be exported."
724 ;;;; LaTeX
727 "Non-nil means process LaTeX math snippets.
729 When set, the exporter will process LaTeX environments and
730 fragments.
732 This option can also be set with the +OPTIONS line,
735 nil Ignore math snippets.
736 `verbatim' Keep everything in verbatim
737 `dvipng' Process the LaTeX fragments to images. This will also
738 include processing of non-math environments.
739 `imagemagick' Convert the LaTeX fragments to pdf files and use
740 imagemagick to convert pdf files to png files.
741 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
742 be loaded.
743 t Synonym for `mathjax'."
755 ;;;; Links
759 "Rules characterizing formula files that can be inlined into ODT.
761 A rule consists in an association whose key is the type of link
762 to consider, and value is a regexp that will be matched against
763 link's path."
772 "Rules characterizing image files that can be inlined into ODT.
774 A rule consists in an association whose key is the type of link
775 to consider, and value is a regexp that will be matched against
776 link's path."
784 "Scaling factor for converting images pixels to inches.
785 Use this for sizing of embedded images. See Info node `(org)
786 Images in ODT export' for more information."
793 ;;;; Src Block
796 "Whether custom styles for colorized source blocks be automatically created.
797 When this option is turned on, the exporter creates custom styles
798 for source blocks based on the advice of `htmlfontify'. Creation
799 of custom styles happen as part of `org-odt-hfy-face-to-css'.
801 When this option is turned off exporter does not create such
802 styles.
804 Use the latter option if you do not want the custom styles to be
805 based on your current display settings. It is necessary that the
806 styles.xml already contains needed styles for colorizing to work.
808 This variable is effective only if
809 `org-odt-fontify-srcblocks' is turned on."
815 "Specify whether or not source blocks need to be fontified.
816 Turn this option on if you want to colorize the source code
817 blocks in the exported file. For colorization to work, you need
818 to make available an enhanced version of `htmlfontify' library."
824 ;;;; Table
837 "Specify how Table Styles should be derived from a Table Template.
838 This is a list where each element is of the
839 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
841 TABLE-STYLE-NAME is the style associated with the table through
844 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
845 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
846 below) that is included in
847 `org-odt-content-template-file'.
849 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
851 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
859 TABLE-CELL-OPTIONS is an alist where each element is of the
860 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
861 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
862 `use-last-row-styles' |
863 `use-first-column-styles' |
864 `use-last-column-styles' |
865 `use-banding-rows-styles' |
866 `use-banding-columns-styles' |
867 `use-first-row-styles'
868 ON-OR-OFF := `t' | `nil'
870 For example, with the following configuration
872 \(setq org-odt-table-styles
874 \(\(use-first-row-styles . t\)
875 \(use-first-column-styles . t\)\)\)
877 \(\(use-first-column-styles . t\)\)\)\)\)
880 style will use the following table-cell styles -
885 as appropriate.
888 use the following table-cell styles -
890 following paragraph styles
892 as appropriate..
894 Note that TABLE-TEMPLATE-NAME corresponds to the
897 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
900 specification for more information. Also consult the
901 implementation filed under `org-odt-get-table-cell-styles'.
904 formatting of numbered display equations. Do not delete this
905 style from the list."
915 use-last-row-styles
916 use-first-column-styles
917 use-last-column-styles
918 use-banding-rows-styles
919 use-banding-columns-styles)
920 :key-type symbol
923 ;;;; Timestamps
926 "Non-nil, if timestamps should be exported as date fields.
928 When nil, export timestamps as plain text.
930 When non-nil, map `org-time-stamp-custom-formats' to a pair of
932 respectively. A timestamp with no time component is formatted
936 This feature is experimental. Most (but not all) of the common
937 %-specifiers in `format-time-string' are supported.
939 formatted as canonical Org timestamps. For finer control, avoid
940 these %-specifiers.
943 etc., are displayed by the application in the default language
944 and country specified in `org-odt-styles-file'. Note that the
946 can localize the week day and month strings in the exported
947 document by setting the default language and country either using
948 the application UI or through a custom styles file.
950 See `org-odt--build-date-styles' for implementation details."
957 \f
958 ;;; Internal functions
960 ;;;; Date
975 ;; LibreOffice does not care about end goes as content
976 ;; within the "<text:date>...</text:date>" field. The
977 ;; displayed date is automagically corrected to match the
978 ;; format requested by "style:data-style-name" attribute. So
979 ;; don't bother about formatting the date contents to be
980 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
981 ;; simple Org-style date should suffice.
1006 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
1007 iso-date style date)
1009 repeater)))))
1011 ;;;; Frame
1019 extra
1025 style frame-attrs
1037 ;;;; Library wrappers
1044 ;; This is shamelessly stolen from `archive-zip-extract'.
1050 name)))
1055 exit-code command-output)
1063 members))
1065 ;;;; Target
1074 ;;;; Textbox
1077 extra anchor-type)
1083 text)
1084 width nil style extra anchor-type))
1088 ;;;; Table of Contents
1093 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1095 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1102 "
1103 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1105 <text:index-entry-chapter/>
1106 <text:index-entry-text/>
1107 <text:index-entry-link-end/>
1108 </text:table-of-content-entry-template>
1112 </text:table-of-content-source>
1114 <text:index-body>
1117 </text:index-title>
1122 </text:index-body>
1123 </text:table-of-content>
1131 ;; Section number.
1133 ;; Todo.
1138 style todo)))
1143 style priority)))
1144 ;; Title.
1145 text
1146 ;; Tags.
1150 "OrgTags"
1157 headline-label text))
1161 ;; When a headline is marked as a radio target, as in the example below:
1162 ;;
1163 ;; ** <<<Some Heading>>>
1164 ;; Some text.
1165 ;;
1166 ;; suppress generation of radio targets. i.e., Radio targets are to
1167 ;; be marked as targets within /document body/ and *not* within
1168 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1169 ;; and one in the document body.
1170 ;;
1171 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1172 ;; doesn't provide a way to disable memoization. So this doesn't
1173 ;; work.
1174 ;;
1175 ;; FIXME-2: Are there any other objects that need to be suppressed
1176 ;; within TOC?
1196 style entry)))
1201 ;;;; Document styles
1204 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1205 OBJECT-PROPS is (typically) a plist created by passing
1207 `org-odt-parse-block-attributes'.
1209 Use `org-odt-object-counters' to generate an automatic
1210 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1211 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1212 . STYLE-NAME)."
1228 ;;;; Checkbox
1231 "Return check-box string associated to ITEM."
1240 ;;; Template
1243 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1244 ;; to modify the date fields. A date could be modified by
1245 ;; offsetting in days. That's about it. Also, date and time may
1246 ;; have to be emitted as two fields - a date field and a time field
1247 ;; - separately.
1249 ;; One can add Form Controls to date and time fields so that they
1250 ;; can be easily modified. But then, the exported document will
1251 ;; become tightly coupled with LibreOffice and may not function
1252 ;; properly with other OpenDocument applications.
1254 ;; I have a strange feeling that Date styles are a bit flaky at the
1255 ;; moment.
1257 ;; The feature is experimental.
1303 ))
1311 filler-end))
1322 style
1325 output ))))
1328 "Return complete document string after ODT conversion.
1329 CONTENTS is the transcoded contents string. RAW-DATA is the
1330 original parsed data. INFO is a plist holding export options."
1331 ;; Write meta file.
1341 <office:document-meta
1351 ;; Date, if required.
1353 ;; Check if DATE is specified as an Org-timestamp. If yes,
1354 ;; include it as meta information. Otherwise, just use
1355 ;; today's date.
1364 iso-date)))))
1375 ;; Add meta.xml in to manifest.
1378 ;; Update styles file.
1379 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1380 ;; Write styles file.
1383 ;; Non-availability of styles.xml is not a critical
1384 ;; error. For now, throw an error.
1386 org-odt-styles-file
1388 org-odt-styles-dir)
1401 members)))
1411 org-odt-styles-file))))
1413 ;; create a manifest entry for styles.xml
1416 ;; FIXME: Who is opening an empty styles.xml before this point?
1421 ;; Write custom styles for source blocks
1422 ;; Save STYLES used for colorizing of source blocks.
1423 ;; Update styles.xml with styles that were collected as part of
1424 ;; `org-odt-hfy-face-to-css' callbacks.
1433 ;; Update styles.xml - take care of outline numbering
1435 ;; Don't make automatic backup of styles.xml file. This setting
1436 ;; prevents the backed-up styles.xml file from being zipped in to
1437 ;; odt file. This is more of a hackish fix. Better alternative
1438 ;; would be to fix the zip command so that the output odt file
1439 ;; includes only the needed files and excludes any auto-generated
1440 ;; extra files like backups and auto-saves etc etc. Note that
1441 ;; currently the zip command zips up the entire temp directory so
1442 ;; that any auto-generated files created under the hood ends up in
1443 ;; the resulting odt file.
1446 ;; Outline numbering is retained only upto LEVEL.
1447 ;; To disable outline numbering pass a LEVEL of 0.
1460 ;; Update content.xml.
1463 ;; within the context of the Org buffer. So obtain its
1464 ;; value before moving on to temp-buffer context down below.
1474 org-odt-styles-dir)))
1475 ;; Write automatic styles.
1476 ;; - Position the cursor.
1480 ;; - Dump automatic table styles.
1485 ;; - Dump date-styles.
1491 ;; Update display level.
1492 ;; - Remove existing sequence decls. Also position the cursor.
1497 ;; Update sequence decls according to user preference.
1507 ;; Position the cursor to document body.
1512 ;; Preamble - Title, Author, Date etc.
1519 ;; Switch on or off above vars based on user settings
1523 ;; Title.
1528 ;; Separator.
1532 ;; Author only.
1535 "OrgSubtitle"
1537 ;; Separator.
1540 ;; Author and E-mail.
1544 "OrgSubtitle"
1549 ;; Separator.
1551 ;; Date, if required.
1554 ;; Check if DATE is specified as a timestamp.
1560 "OrgSubtitle"
1564 ;; Separator
1566 ;; Table of Contents
1569 with-toc
1572 ;; Contents.
1574 ;; Return contents.
1578 \f
1579 ;;; Transcode Functions
1581 ;;;; Bold
1584 "Transcode BOLD from Org to ODT.
1585 CONTENTS is the text with bold markup. INFO is a plist holding
1586 contextual information."
1591 ;;;; Center Block
1594 "Transcode a CENTER-BLOCK element from Org to ODT.
1595 CONTENTS holds the contents of the center block. INFO is a plist
1596 holding contextual information."
1597 contents)
1600 ;;;; Clock
1603 "Transcode a CLOCK element from Org to ODT.
1604 CONTENTS is nil. INFO is a plist used as a communication
1605 channel."
1618 ;;;; Code
1621 "Transcode a CODE object from Org to ODT.
1622 CONTENTS is nil. INFO is a plist used as a communication
1623 channel."
1629 ;;;; Comment
1631 ;; Comments are ignored.
1634 ;;;; Comment Block
1636 ;; Comment Blocks are ignored.
1639 ;;;; Drawer
1642 "Transcode a DRAWER element from Org to ODT.
1643 CONTENTS holds the contents of the block. INFO is a plist
1644 holding contextual information."
1647 name contents)))
1648 output))
1651 ;;;; Dynamic Block
1654 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1655 CONTENTS holds the contents of the block. INFO is a plist
1656 holding contextual information. See `org-export-data'."
1657 contents)
1660 ;;;; Entity
1663 "Transcode an ENTITY object from Org to ODT.
1664 CONTENTS are the definition itself. INFO is a plist holding
1665 contextual information."
1669 ;;;; Example Block
1672 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1673 CONTENTS is nil. INFO is a plist holding contextual information."
1677 ;;;; Export Snippet
1680 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1681 CONTENTS is nil. INFO is a plist holding contextual information."
1686 ;;;; Fixed Width
1689 "Transcode a FIXED-WIDTH element from Org to ODT.
1690 CONTENTS is nil. INFO is a plist holding contextual information."
1694 ;;;; Footnote Definition
1696 ;; Footnote Definitions are ignored.
1699 ;;;; Footnote Reference
1702 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1703 CONTENTS is nil. INFO is a plist holding contextual information."
1713 id note-class
1726 "OrgSuperscript"
1727 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1728 note-class ref-format ref-name n)))))))
1730 ;; Insert separator between two footnotes in a row.
1735 ;; Transcode footnote reference.
1740 ;; Inline definitions are secondary strings.
1741 ;; Non-inline footnotes definitions are full Org data.
1744 footnote-reference info))
1748 raw
1751 :transcoders
1754 p c i
1755 "Footnote"
1756 "OrgFootnoteCenter"
1758 info))))
1765 ;;;; Headline
1771 ;; Todo.
1775 style todo)))
1780 style priority)))
1781 ;; Title.
1782 text
1783 ;; Tags.
1786 "<text:tab/>"
1795 &optional format-function
1797 "Transcode a HEADLINE element using BACKEND.
1798 INFO is a plist holding contextual information."
1825 todo todo-type priority text tags))))
1828 todo todo-type priority text tags
1833 "Transcode a HEADLINE element from Org to ODT.
1834 CONTENTS holds the contents of the headline. INFO is a plist
1835 holding contextual information."
1836 ;; Case 1: This is a footnote section: ignore it.
1839 ;; Create the headline text.
1841 ;; Get level relative to current parsed data.
1843 ;; Get canonical label for the headline.
1847 ;; Get user-specified labels for the headline.
1850 ;; Extra targets.
1858 ;; Title.
1861 ;; Case 2. This is a deep sub-tree: export it as a list item.
1862 ;; Also export as items headlines for which no section
1863 ;; format has been found.
1865 ;; Build the real contents of the sub-tree.
1869 ;; Choose style based on list type.
1872 ;; If top-level list, re-start numbering. Otherwise,
1873 ;; continue numbering.
1876 headline)))
1886 "Text_20_body"
1888 contents)
1890 "</text:list-header>"
1894 ;; Case 3. Standard headline. Export it as a section.
1900 level
1902 contents))))))
1905 ;;;; Horizontal Rule
1908 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1909 CONTENTS is nil. INFO is a plist holding contextual information."
1914 ;;;; Inline Babel Call
1916 ;; Inline Babel Calls are ignored.
1919 ;;;; Inline Src Block
1922 "Return a character not used in string S.
1924 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1930 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1931 CONTENTS holds the contents of the item. INFO is a plist holding
1932 contextual information."
1939 ;;;; Inlinetask
1942 "Transcode an INLINETASK element from Org to ODT.
1943 CONTENTS holds the contents of the block. INFO is a plist
1944 holding contextual information."
1946 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1947 ;; with appropriate arguments.
1954 todo todo-type priority text tags contents)))))
1957 ;; Otherwise, use a default template.
1960 "Text_20_body"
1964 "OrgInlineTaskHeading"
1966 contents)
1969 ;;;; Italic
1972 "Transcode ITALIC from Org to ODT.
1973 CONTENTS is the text with italic markup. INFO is a plist holding
1974 contextual information."
1979 ;;;; Item
1982 "Transcode an ITEM element from Org to ODT.
1983 CONTENTS holds the contents of the item. INFO is a plist holding
1984 contextual information."
1995 contents
2007 ;;;; Keyword
2010 "Transcode a KEYWORD element from Org to ODT.
2011 CONTENTS is nil. INFO is a plist holding contextual information."
2017 ;; FIXME
2028 ;; FIXME
2032 ;;;; Latex Environment
2035 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2036 ;; (defadvice org-format-latex-as-mathml ; FIXME
2037 ;; (after org-odt-protect-latex-fragment activate)
2038 ;; "Encode LaTeX fragment as XML.
2039 ;; Do this when translation to MathML fails."
2040 ;; (unless (> (length ad-return-value) 0)
2041 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2044 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2045 CONTENTS is nil. INFO is a plist holding contextual information."
2051 ;;;; Latex Fragment
2053 ;; (when latex-frag ; FIXME
2054 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2055 ;; :description latex-frag)))
2056 ;; handle verbatim
2057 ;; provide descriptions
2060 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2061 CONTENTS is nil. INFO is a plist holding contextual information."
2068 ;;;; Line Break
2071 "Transcode a LINE-BREAK object from Org to ODT.
2072 CONTENTS is nil. INFO is a plist holding contextual information."
2076 ;;;; Link
2078 ;;;; Links :: Label references
2089 x)))))
2100 counter))
2107 ;; Section number.
2111 ;; Separator.
2113 ;; Ordinal.
2115 tag))
2118 "Return a label for ELEMENT.
2120 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2121 element. INFO is a plist used as a communication channel. OP is
2122 either `definition' or `reference', depending on the purpose of
2123 the generated string.
2125 Return value is a string if OP is set to `reference' or a cons
2126 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2127 SHORT-CAPTION are strings."
2133 ;; Get label and caption.
2137 ;; FIXME: We don't use short-caption for now
2153 element))))
2156 seqno)
2160 ;; Compute sequence number of the element.
2162 ;; Localize category string.
2165 ;; Case 1: Handle Label definition.
2167 ;; Assign an internal label, if user has not provided one
2172 ;; Sneak in a bookmark. The bookmark is used when the
2173 ;; labeled element is referenced with a link that
2174 ;; provides its own description.
2176 ;; Label definition: Typically formatted as below:
2177 ;; CATEGORY SEQ-NO: LONG CAPTION
2178 ;; with translation for correct punctuation.
2185 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2186 label counter counter seqno))
2188 short-caption))
2189 ;; Case 2: Handle Label reference.
2196 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2202 ;;;; Links :: Inline Images
2205 "Returns the internal name of the file"
2221 target-file))
2224 user-height scale dpi embed-as)
2244 ;; Use Imagemagick.
2249 file))))
2254 ;; Use Emacs.
2260 ;; Use hard-coded values.
2262 org-odt-default-image-sizes-alist))
2263 ;; Error out.
2276 ;; ensure that an embedded image fits comfortably within a page
2287 "Return ODT code for an inline image.
2288 LINK is the link pointing to the inline image. INFO is a plist
2289 used as a communication channel."
2302 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2304 ;; Extract attributes from #+ATTR_ODT line.
2308 ;; Convert attributes to a plist.
2310 ;; Handle `:anchor', `:style' and `:attributes' properties.
2320 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2321 ;;
2322 ;; Handle `:width', `:height' and `:scale' properties. Read
2323 ;; them as numbers since we need them for computations.
2325 src-expanded
2332 nil ; embed-as
2334 ))
2341 ;; Check if this link was created by LaTeX-to-PNG converter.
2345 ;; If yes, note down the type of the element - LaTeX Fragment
2346 ;; or LaTeX environment. It will go in to frame title.
2350 ;; If yes, note down its contents. It will go in to frame
2351 ;; description. This quite useful for debugging.
2354 captions user-frame-params title desc)))
2357 ;;;; Links :: Math formula
2378 ;; Check if this link was created by LaTeX-to-MathML
2379 ;; converter.
2383 ;; If yes, note down the type of the element - LaTeX Fragment
2384 ;; or LaTeX environment. It will go in to frame title.
2388 ;; If yes, note down its contents. It will go in to frame
2389 ;; description. This quite useful for debugging.
2391 width height)
2395 nil nil title desc))
2398 "CaptionedDisplayFormula" href width height
2399 captions nil title desc))
2403 org-odt--enumerable-formula-p))))
2408 "Returns the internal name of the file"
2412 ;; Create a directory for holding formula file. Also enter it in
2413 ;; to manifest.
2417 ;; Copy over the formula file from user directory to zip
2418 ;; directory.
2422 ;; Case 1: Mathml.
2425 ;; Case 2: OpenDocument formula.
2430 ;; Enter the formula file in to manifest.
2432 target-file))
2434 ;;;; Targets
2437 captions user-frame-params
2440 ;; Each element of this alist is of the form (CFG-HANDLE
2441 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2443 ;; CFG-HANDLE is the key to the alist.
2445 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2446 ;; frame params for INNER-FRAME and OUTER-FRAME
2447 ;; respectively. See below.
2449 ;; Configurations that are meant to be applied to
2450 ;; non-captioned image/formula specifies no
2451 ;; OUTER-FRAME-PARAMS.
2453 ;; TERMINOLOGY
2454 ;; ===========
2455 ;; INNER-FRAME :: Frame that directly surrounds an
2456 ;; image/formula.
2458 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2459 ;; frame also contains the caption, if any.
2461 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2462 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2463 ;; that these are the last three arguments
2464 ;; to `org-odt--frame'.
2466 ;; Note that an un-captioned image/formula requires just an
2467 ;; INNER-FRAME, while a captioned image/formula requires
2468 ;; both an INNER and an OUTER-FRAME.
2490 ;; Retrieve inner and outer frame params, from configuration.
2494 ;; User-specified frame params (from #+ATTR_ODT spec)
2498 "Merge default and user frame params."
2503 for d in default
2506 ;; Case 1: Image/Formula has no caption.
2507 ;; There is only one frame, one that surrounds the image
2508 ;; or formula.
2510 ;; Merge user frame params with that from configuration.
2514 ;; Case 2: Image/Formula is captioned or labeled.
2515 ;; There are two frames: The inner one surrounds the
2516 ;; image or formula. The outer one contains the
2517 ;; caption/sequence number.
2519 ;; Merge user frame params with outer frame params.
2521 ;; Short caption, if specified, goes as part of inner frame.
2528 frame-params))
2531 "Illustration"
2535 caption))
2536 width height outer)))))
2539 ;; Element should have a caption or label.
2545 element info
2546 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2547 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2548 ;; processing.)
2553 ;; Link should point to an image file.
2560 element info
2561 ;; Paragraph should have a caption or label. It SHOULD also be a
2562 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2563 ;; processing.)
2568 ;; Link should point to an image file.
2575 element info
2576 ;; Paragraph should have a caption or label.
2580 ;; Link should point to a MathML or ODF file.
2586 paragraph-predicate
2587 link-predicate)
2588 "Test if ELEMENT is a standalone link for the purpose ODT export.
2589 INFO is a plist holding contextual information.
2591 Return non-nil, if ELEMENT is of type paragraph satisfying
2592 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2593 is a link that satisfies LINK-PREDICATE.
2595 Return non-nil, if ELEMENT is of type link satisfying
2596 LINK-PREDICATE and its containing paragraph satisfies
2597 PARAGRAPH-PREDICATE in addition to having no other content save for
2598 leading and trailing whitespaces.
2600 Return nil, otherwise."
2623 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2624 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2625 ;; attached. Note that labels that are attached to captioned
2626 ;; entities - inline images, math formulae and tables - get resolved
2627 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2629 ;; Create a cross-reference to DESTINATION but make best-efforts to
2630 ;; create a *meaningful* description. Check item numbers, section
2631 ;; number and section title in that order.
2633 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2634 ;; FIXME: Handle footnote-definition footnote-reference?
2650 return x))
2651 ;; Get list item nos.
2656 plain-list)
2659 item info t))))))
2660 ;; Locate top-most listified headline.
2665 return x))
2666 ;; Get listified headline numbers.
2672 el info t)))))))
2673 ;; Combine item numbers from both the listified headlines and
2674 ;; regular list items.
2676 ;; Case 1: Check if all the parents of list item are numbered.
2677 ;; If yes, link to the item proper.
2680 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2685 ;; Case 2: Locate a regular and numbered headline in the
2686 ;; hierarchy. Display its section number.
2691 return el)))
2692 ;; We found one.
2694 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2698 ;; Case 4: Locate a regular headline in the hierarchy. Display
2699 ;; its title.
2703 return el)))
2704 ;; We found one.
2706 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2713 "Transcode a LINK object from Org to ODT.
2715 DESC is the description part of the link, or the empty string.
2716 INFO is a plist holding contextual information. See
2717 `org-export-data'."
2720 ;; Ensure DESC really exists, or set it to nil.
2723 link org-odt-inline-image-rules))
2730 ;; Convert & to & for correct XML representation
2732 protocol)
2734 ;; Image file.
2736 link org-odt-inline-image-rules))
2738 ;; Formula file.
2740 link org-odt-inline-formula-rules))
2742 ;; Radio target: Transcode target's contents and use them as
2743 ;; link's description.
2748 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2751 desc))))
2752 ;; Links pointing to a headline: Find destination and build
2753 ;; appropriate referencing command.
2759 ;; Case 1: Fuzzy link points nowhere.
2760 ('nil
2762 "Emphasis"
2765 info))))
2766 ;; Case 2: Fuzzy link points to a headline.
2768 ;; If there's a description, create a hyperlink.
2769 ;; Otherwise, try to provide a meaningful description.
2778 label desc))))
2779 ;; Case 3: Fuzzy link points to a target.
2781 ;; If there's a description, create a hyperlink.
2782 ;; Otherwise, try to provide a meaningful description.
2787 desc))))
2788 ;; Case 4: Fuzzy link points to some element (e.g., an
2789 ;; inline image, a math formula or a table).
2796 ;; LINK has no description. Create
2797 ;; a cross-reference showing entity's sequence
2798 ;; number.
2800 ;; LINK has description. Insert a hyperlink with
2801 ;; user-provided description.
2806 desc)))))))))
2807 ;; Coderef: replace link with the reference name or the
2808 ;; equivalent line number.
2815 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2816 href line-no))))
2817 ;; Link type is handled by a special function.
2820 ;; External link with a description part.
2823 ;; Check if description is a link to an inline image.
2828 desc-element org-odt-inline-image-rules))))
2829 ;; Format link as a clickable image.
2831 path desc)
2832 ;; Otherwise, format it as a regular link.
2834 path desc))))
2835 ;; External link without a description part.
2838 path path))
2839 ;; No path, only description. Try to do something useful.
2844 ;;;; Node Property
2847 "Transcode a NODE-PROPERTY element from Org to ODT.
2848 CONTENTS is nil. INFO is a plist holding contextual
2849 information."
2856 ;;;; Paragraph
2859 "Return style of PARAGRAPH.
2860 Style is a symbol among `quoted', `centered' and nil."
2870 "Format paragraph according to given styles.
2871 PARAGRAPH is a paragraph type element. CONTENTS is the
2872 transcoded contents of that paragraph, as a string. INFO is
2873 a plist used as a communication channel. DEFAULT, CENTER and
2874 QUOTE are, respectively, style to use when paragraph belongs to
2875 no special environment, a center block, or a quote block."
2881 ;; If PARAGRAPH is a leading paragraph in an item that has
2882 ;; a checkbox, splice checkbox and paragraph contents
2883 ;; together.
2888 contents)))
2891 "Transcode a PARAGRAPH element from Org to ODT.
2892 CONTENTS is the contents of the paragraph, as a string. INFO is
2893 the plist used as a communication channel."
2895 paragraph contents info
2897 "OrgCenter"
2901 ;;;; Plain List
2904 "Transcode a PLAIN-LIST element from Org to ODT.
2905 CONTENTS is the contents of the list. INFO is a plist holding
2906 contextual information."
2908 ;; Choose style based on list type.
2914 ;; If top-level list, re-start numbering. Otherwise,
2915 ;; continue numbering.
2920 contents))
2922 ;;;; Plain Text
2935 line))
2946 "Transcode a TEXT string from Org to ODT.
2947 TEXT is the string to transcode. INFO is a plist holding
2948 contextual information."
2950 ;; Protect &, < and >.
2952 ;; Handle smart quotes. Be sure to provide original string since
2953 ;; OUTPUT may have been modified.
2956 ;; Convert special strings.
2962 org-odt-special-string-regexps))
2963 ;; Handle break preservation if required.
2967 ;; Return value.
2968 output))
2971 ;;;; Planning
2974 "Transcode a PLANNING element from Org to ODT.
2975 CONTENTS is nil. INFO is a plist used as a communication
2976 channel."
2978 "OrgPlanning"
3000 ;;;; Property Drawer
3003 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3004 CONTENTS holds the contents of the drawer. INFO is a plist
3005 holding contextual information."
3008 contents)))
3011 ;;;; Quote Block
3014 "Transcode a QUOTE-BLOCK element from Org to ODT.
3015 CONTENTS holds the contents of the block. INFO is a plist
3016 holding contextual information."
3017 contents)
3020 ;;;; Section
3025 style
3027 text)))
3031 "Transcode a SECTION element from Org to ODT.
3032 CONTENTS holds the contents of the section. INFO is a plist
3033 holding contextual information."
3034 contents)
3036 ;;;; Radio Target
3039 "Transcode a RADIO-TARGET object from Org to ODT.
3040 TEXT is the text of the target. INFO is a plist holding
3041 contextual information."
3047 ;;;; Special Block
3050 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3051 CONTENTS holds the contents of the block. INFO is a plist
3052 holding contextual information."
3058 ;; Annotation.
3064 ;; FIXME: Is `car' right thing to do below?
3075 contents)))))
3076 ;; Textbox.
3085 style extra anchor))))
3089 ;;;; Src Block
3092 "Create custom style for face FN.
3093 When FN is the default face, use its foreground and background
3095 use its color attribute to create a character style whose name
3096 is obtained from FN. Currently all attributes of FN other than
3097 color are ignored.
3099 The style name for a face FN is derived using the following
3100 operations on the face name in that order - de-dash, CamelCase
3102 `font-lock-function-name-face' is associated with
3116 background-color-val color-val))
3119 "
3150 org-odt-fontify-srcblocks
3167 code
3178 par-style loc))
3181 num-start refs))
3195 ;; Extract code and references.
3199 ;; Does the src block contain labels?
3201 ;; Does it have line numbers?
3208 "Transcode a SRC-BLOCK element from Org to ODT.
3209 CONTENTS holds the contents of the item. INFO is a plist holding
3210 contextual information."
3222 "Text_20_body"
3226 ;;;; Statistics Cookie
3229 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3230 CONTENTS is nil. INFO is a plist holding contextual information."
3236 ;;;; Strike-Through
3239 "Transcode STRIKE-THROUGH from Org to ODT.
3240 CONTENTS is the text with strike-through markup. INFO is a plist
3241 holding contextual information."
3246 ;;;; Subscript
3249 "Transcode a SUBSCRIPT object from Org to ODT.
3250 CONTENTS is the contents of the object. INFO is a plist holding
3251 contextual information."
3256 ;;;; Superscript
3259 "Transcode a SUPERSCRIPT object from Org to ODT.
3260 CONTENTS is the contents of the object. INFO is a plist holding
3261 contextual information."
3266 ;;;; Table Cell
3275 "Retrieve styles applicable to a table cell.
3276 R and C are (zero-based) row and column numbers of the table
3277 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3278 applicable to the current table. It is `nil' if the table is not
3279 associated with any style attributes.
3281 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3283 When STYLE-SPEC is nil, style the table cell the conventional way
3284 - choose cell borders based on row and column groupings and
3285 choose paragraph alignment based on `org-col-cookies' text
3286 property. See also
3287 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3289 When STYLE-SPEC is non-nil, ignore the above cookie and return
3290 styles congruent with the ODF-1.2 specification."
3296 info)))
3298 ;; LibreOffice - particularly the Writer - honors neither table
3299 ;; templates nor custom table-cell styles. Inorder to retain
3300 ;; inter-operability with LibreOffice, only automatic styles are
3301 ;; used for styling of table-cells. The current implementation is
3302 ;; congruent with ODF-1.2 specification and hence is
3303 ;; future-compatible.
3305 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3306 ;; which recognizes as many as 16 different cell types - is much
3307 ;; richer. Unfortunately it is NOT amenable to easy configuration
3308 ;; by hand.
3335 "Transcode a TABLE-CELL element from Org to ODT.
3336 CONTENTS is nil. INFO is a plist used as a communication
3337 channel."
3344 table-cell info))
3367 table-cell info))))))
3371 custom-style-prefix))
3373 "OrgTblCell"
3389 cell-attributes
3392 org-element-all-elements)
3393 contents
3395 paragraph-style contents))))
3402 ;;;; Table Row
3405 "Transcode a TABLE-ROW element from Org to ODT.
3406 CONTENTS is the contents of the row. INFO is a plist used as a
3407 communication channel."
3408 ;; Rules are ignored since table separators are deduced from
3409 ;; borders of the current row.
3415 ;; If the row belongs to the first rowgroup and the
3416 ;; table has more than one row groups, then this row
3417 ;; belongs to the header row group.
3419 ;; Otherwise, it belongs to non-header row group.
3422 ;; Does this row begin a rowgroup?
3425 ;; Actual table row
3427 ;; Does this row end a rowgroup?
3432 ;;;; Table
3445 "Transcode a TABLE element from Org to ODT.
3446 CONTENTS is the contents of the table. INFO is a plist holding
3447 contextual information."
3449 ;; Case 1: table.el doesn't support export to OD format. Strip
3450 ;; such tables from export.
3455 "(ox-odt): Found table.el-type table in the source Org file."
3456 " table.el doesn't support export to ODT format."
3458 ;; Case 2: Native Org tables.
3475 column-style))
3476 out)
3480 ;; caption.
3484 ;; begin table.
3492 ;; column specification.
3494 ;; actual contents.
3496 ;; end table.
3500 "Transcode a TABLE element from Org to ODT.
3501 CONTENTS is the contents of the table. INFO is a plist holding
3502 contextual information.
3504 Use `org-odt--table' to typeset the table. Handle details
3505 pertaining to indentation here."
3520 collect el)))
3526 collect
3531 parent-list)
3533 ;; Handle list genealogy.
3553 parent-list info)
3556 ;; Handle low-level headlines.
3558 with step = 'item collect
3566 el info)
3567 "OrgNumberedList"
3578 parent-list info)))
3586 table info)))
3587 ;; OpenDocument schema does not permit table to occur within a
3588 ;; list item.
3590 ;; One solution - the easiest and lightweight, in terms of
3591 ;; implementation - is to put the table in an indented text box
3592 ;; and make the text box part of the list-item. Unfortunately if
3593 ;; the table is big and spans multiple pages, the text box could
3594 ;; overflow. In this case, the following attribute will come
3595 ;; handy.
3597 ;; ,---- From OpenDocument-v1.1.pdf
3598 ;; | 15.27.28 Overflow behavior
3599 ;; |
3600 ;; | For text boxes contained within text document, the
3601 ;; | style:overflow-behavior property specifies the behavior of text
3602 ;; | boxes where the containing text does not fit into the text
3603 ;; | box.
3604 ;; |
3605 ;; | If the attribute's value is clip, the text that does not fit
3606 ;; | into the text box is not displayed.
3607 ;; |
3608 ;; | If the attribute value is auto-create-new-frame, a new frame
3609 ;; | will be created on the next page, with the same position and
3610 ;; | dimensions of the original frame.
3611 ;; |
3612 ;; | If the style:overflow-behavior property's value is
3613 ;; | auto-create-new-frame and the text box has a minimum width or
3614 ;; | height specified, then the text box will grow until the page
3615 ;; | bounds are reached before a new frame is created.
3616 ;; `----
3618 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3619 ;; auto-create-new-frame property and always resorts to clipping
3620 ;; the text box. This results in table being truncated.
3622 ;; So we solve the problem the hard (and fun) way using list
3623 ;; continuations.
3625 ;; The problem only becomes more interesting if you take in to
3626 ;; account the following facts:
3627 ;;
3628 ;; - Description lists are simulated as plain lists.
3629 ;; - Low-level headlines can be listified.
3630 ;; - In Org-mode, a table can occur not only as a regular list
3631 ;; item, but also within description lists and low-level
3632 ;; headlines.
3634 ;; See `org-odt-translate-description-lists' and
3635 ;; `org-odt-translate-low-level-headlines' for how this is
3636 ;; tackled.
3639 ;; Discontinue the list.
3641 ;; Put the table in an indented section.
3646 ;; Continue the list.
3650 ;;;; Target
3653 "Transcode a TARGET object from Org to ODT.
3654 CONTENTS is nil. INFO is a plist holding contextual
3655 information."
3660 ;;;; Timestamp
3663 "Transcode a TIMESTAMP object from Org to ODT.
3664 CONTENTS is nil. INFO is a plist used as a communication
3665 channel."
3682 "OrgActiveTimestamp"
3686 "OrgInactiveTimestamp"
3690 "OrgActiveTimestamp"
3696 "OrgInactiveTimestamp"
3702 "OrgDiaryTimestamp"
3704 info)))))))
3707 ;;;; Underline
3710 "Transcode UNDERLINE from Org to ODT.
3711 CONTENTS is the text with underline markup. INFO is a plist
3712 holding contextual information."
3717 ;;;; Verbatim
3720 "Transcode a VERBATIM object from Org to ODT.
3721 CONTENTS is nil. INFO is a plist used as a communication
3722 channel."
3728 ;;;; Verse Block
3731 "Transcode a VERSE-BLOCK element from Org to ODT.
3732 CONTENTS is verse block contents. INFO is a plist holding
3733 contextual information."
3734 ;; Add line breaks to each line of verse.
3738 ;; Replace tabs and spaces.
3740 ;; Surround it in a verse environment.
3745 \f
3746 ;;; Filters
3748 ;;;; LaTeX fragments
3753 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3754 ;; If the desired converter is not available, force verbatim
3755 ;; processing.
3773 ;; Store normalized value for later use.
3778 ;; Convert `latex-fragment's and `latex-environment's.
3796 ;; Get an Org-style link to PNG image or the MathML
3797 ;; file.
3802 nil display-msg
3803 nil nil processing-type)
3808 link))))
3810 ;; Conversion succeeded. Parse above Org-style link to a
3811 ;; `link' object.
3817 ;; Orphan the link.
3822 ;; Case 1: LaTeX environment.
3823 ;; Mimic a "standalone image or formula" by
3824 ;; enclosing the `link' in a `paragraph'.
3825 ;; Copy over original attributes, captions to
3826 ;; the enclosing paragraph.
3832 latex-*)
3834 latex-*)))
3835 link))
3836 ;; Case 2: LaTeX fragment.
3837 ;; No special action.
3839 ;; Note down the object that link replaces.
3843 ;; Replace now.
3845 info)))
3846 tree)
3849 ;;;; Description lists
3851 ;; This translator is necessary to handle indented tables in a uniform
3852 ;; manner. See comment in `org-odt--table'.
3855 ;; OpenDocument has no notion of a description list. So simulate it
3856 ;; using plain lists. Description lists in the exported document
3857 ;; are typeset in the same manner as they are in a typical HTML
3858 ;; document.
3859 ;;
3860 ;; Specifically, a description list like this:
3861 ;;
3862 ;; ,----
3863 ;; | - term-1 :: definition-1
3864 ;; | - term-2 :: definition-2
3865 ;; `----
3866 ;;
3867 ;; gets translated in to the following form:
3868 ;;
3869 ;; ,----
3870 ;; | - term-1
3871 ;; | - definition-1
3872 ;; | - term-2
3873 ;; | - definition-2
3874 ;; `----
3875 ;;
3876 ;; Further effect is achieved by fixing the OD styles as below:
3877 ;;
3878 ;; 1. Set the :type property of the simulated lists to
3879 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3880 ;; that has *no* bullets whatsoever.
3881 ;;
3882 ;; 2. The paragraph containing the definition term is styled to be
3883 ;; in bold.
3884 ;;
3889 el
3905 nil)
3906 info)
3907 tree)
3909 ;;;; List tables
3911 ;; Lists that are marked with attribute `:list-table' are called as
3912 ;; list tables. They will be rendered as a table within the exported
3913 ;; document.
3915 ;; Consider an example. The following list table
3916 ;;
3917 ;; #+attr_odt :list-table t
3918 ;; - Row 1
3919 ;; - 1.1
3920 ;; - 1.2
3921 ;; - 1.3
3922 ;; - Row 2
3923 ;; - 2.1
3924 ;; - 2.2
3925 ;; - 2.3
3926 ;;
3927 ;; will be exported as though it were an Org table like the one show
3928 ;; below.
3929 ;;
3930 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3931 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3932 ;;
3933 ;; Note that org-tables are NOT multi-line and each line is mapped to
3934 ;; a unique row in the exported document. So if an exported table
3935 ;; needs to contain a single paragraph (with copious text) it needs to
3936 ;; be typed up in a single line. Editing such long lines using the
3937 ;; table editor will be a cumbersome task. Furthermore inclusion of
3938 ;; multi-paragraph text in a table cell is well-nigh impossible.
3939 ;;
3940 ;; A LIST-TABLE circumvents above problems.
3941 ;;
3942 ;; Note that in the example above the list items could be paragraphs
3943 ;; themselves and the list can be arbitrarily deep.
3944 ;;
3945 ;; Inspired by following thread:
3946 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3948 ;; Translate lists to tables
3954 ;; Replace list with table.
3956 l1-list
3957 ;; Build replacement table.
3963 l1-item-leading-text l2-list)
3964 ;; Remove Level-2 list from the Level-item. It
3965 ;; will be subsequently attached as table-cells.
3975 ;; Level-1 items start a table row.
3978 ;; Leading text of level-1 item define
3979 ;; the first table-cell.
3982 l1-item-leading-text)
3983 ;; Level-2 items define subsequent
3984 ;; table-cells of the row.
3992 nil)
3993 info)
3994 tree)
3996 \f
3997 ;;; Interactive functions
4010 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4019 org-odt-manifest-file-entries)
4027 ;; Initialize temporary workarea. All files that end up in
4028 ;; the exported document get parked/created here.
4035 ;; Kill all XML buffers.
4043 org-odt-xml-files)
4044 ;; Delete temporary directory and also other embedded
4045 ;; files that get copied there.
4050 ;; Not at all OSes ship with zip by default
4052 ;; Do export. This creates a bunch of xml files ready to be
4053 ;; saved and zipped.
4055 ;; Create a manifest entry for content.xml.
4057 ;; Write mimetype file
4066 ;; Write out the manifest entries before zipping
4068 ;; Save all XML files.
4074 ;; Prettify output if needed.
4078 org-odt-xml-files)
4079 ;; Run zip.
4084 ;; If a file with same name as the desired output file
4085 ;; exists, remove it.
4088 ;; Zip up the xml files.
4091 ;; Switch temporarily to content.xml. This way Zip
4092 ;; process will inherit `org-odt-zip-dir' as the current
4093 ;; directory.
4107 err-string)))))
4108 cmds)))
4109 ;; Move the zip file from temporary work directory to
4110 ;; user-mandated location.
4113 ;; Cleanup work directory and work files.
4115 ;; Open the OpenDocument file in archive-mode for
4116 ;; examination.
4118 ;; Return exported file.
4120 ;; Case 1: Conversion desired on exported file. Run the
4121 ;; converter on the OpenDocument file. Return the
4122 ;; converted file.
4125 target))
4126 ;; Case 2: No further conversion. Return exported
4127 ;; OpenDocument file.
4130 ;; Cleanup work directory and work files.
4136 ;;;; Export to OpenDocument formula
4138 ;;;###autoload
4140 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4141 Use `org-create-math-formula' to convert LATEX-FRAG first to
4142 MathML. When invoked as an interactive command, use
4143 `org-latex-regexps' to infer LATEX-FRAG from currently active
4144 region. If no LaTeX fragments are found, prompt for it. Push
4145 MathML source to kill ring depending on the value of
4146 `org-export-copy-to-kill-ring'."
4172 filename
4185 ;; Add MathML to kill ring, if needed.
4189 ;;;###autoload
4191 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4192 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4193 formula file."
4198 ;;;; Export to OpenDocument Text
4200 ;;;###autoload
4202 "Export current buffer to a ODT file.
4204 If narrowing is active in the current buffer, only export its
4205 narrowed part.
4207 If a region is active, export that region.
4209 A non-nil optional argument ASYNC means the process should happen
4210 asynchronously. The resulting file should be accessible through
4211 the `org-export-stack' interface.
4213 When optional argument SUBTREEP is non-nil, export the sub-tree
4214 at point, extracting information from the headline properties
4215 first.
4217 When optional argument VISIBLE-ONLY is non-nil, don't export
4218 contents of hidden elements.
4220 EXT-PLIST, when provided, is a property list with external
4221 parameters overriding Org default settings, but still inferior to
4222 file-local settings.
4224 Return output file's name."
4231 ,outfile
4236 ;; Let `htmlfontify' know that we are interested in
4237 ;; collecting styles.
4239 ;; Initialize content.xml and kick-off the export
4240 ;; process.
4253 outfile
4258 ;; Let `htmlfontify' know that we are interested in collecting
4259 ;; styles.
4261 ;; Initialize content.xml and kick-off the export process.
4271 ;;;; Convert between OpenDocument and other formats
4274 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4283 "Workhorse routine for `org-odt-convert'."
4292 in-fmt out-fmt)))
4320 out-file)
4323 nil))))
4326 "Return verbose info about formats to which IN-FMT can be converted.
4327 Return a list where each element is of the
4328 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4329 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4330 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4334 org-odt-convert-processes t))))
4338 org-odt-convert-processes t))
4339 org-odt-convert-capabilities))
4340 reachable-formats)
4345 reachable-formats))
4348 "Return list of formats to which IN-FMT can be converted.
4349 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4355 l))
4358 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4359 This is a helper routine for interactive use."
4362 nil buffer-file-name t))
4368 out-fmt-choices nil nil nil))
4370 "No known converter or no known output formats for %s files"
4371 in-fmt))))
4374 ;;;###autoload
4376 "Convert IN-FILE to format OUT-FMT using a command line converter.
4377 IN-FILE is the file to be converted. If unspecified, it defaults
4378 to variable `buffer-file-name'. OUT-FMT is the desired output
4379 format. Use `org-odt-convert-process' as the converter.
4380 If PREFIX-ARG is non-nil then the newly converted file is opened
4381 using `org-open-file'."
4386 ;;; Library Initializations
4390 ;; Let Emacs open all OpenDocument files in archive mode
4393 org-odt-file-extensions)
4397 ;; Local variables:
4398 ;; generated-autoload-file: "org-loaddefs.el"
4399 ;; End:
4401 ;;; ox-odt.el ends here