| blob | 1743854fee22bb483e39a4d26f4ad934efe5e7b8 |
1 ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode
3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
90 org-odt--translate-description-lists
91 org-odt--translate-list-tables)))
92 :menu-entry
99 :options-alist
101 ;; Redefine regular option.
105 ;;; Dependencies
107 ;;; Hooks
109 ;;; Function Declarations
119 \f
120 ;;; Internal Variables
124 "Location of ODT exporter.
125 Use this to infer values of `org-odt-styles-dir' and
130 "Data directory for ODT exporter.
131 Use this to infer values of `org-odt-styles-dir' and
148 "List of directories to search for OpenDocument schema files.
149 Use this list to set the default value of
150 `org-odt-schema-dir'. The entries in this list are
151 populated heuristically based on the values of `org-odt-lib-dir'
164 )
165 "List of directories to search for OpenDocument styles files.
166 See `org-odt-styles-dir'. The entries in this list are populated
167 heuristically based on the values of `org-odt-lib-dir' and
184 styles-dir)
186 org-odt-styles-dir-list)
187 nil)))
190 styles-dir)
191 "Directory that holds auxiliary XML files used by the ODT exporter.
193 This directory contains the following XML files -
195 XML files are used as the default values of
196 `org-odt-styles-file' and
197 `org-odt-content-template-file'.
199 The default value of this variable varies depending on the
200 version of org in use and is initialized from
201 `org-odt-styles-dir-list'. Note that the user could be using org
202 from one of: org's own private git repository, GNU ELPA tar or
225 "
227 <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
228 </style:style>
229 "
233 "Registry of automatic styles for various OBJECT-TYPEs.
234 The variable has the following form:
235 \(\(OBJECT-TYPE-A
236 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
237 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
238 \(OBJECT-TYPE-B
239 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
240 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
241 ...\).
244 OBJECT-PROPS is (typically) a plist created by passing
250 "Running counters for various OBJECT-TYPEs.
251 Use this to generate automatic names and style-names. See
255 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
256 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
257 <style:background-image/>
258 </style:paragraph-properties>
260 </style:style>"
261 "Custom paragraph style for colorized source and example blocks.
263 except that the foreground and background colors are set
277 "Hardcoded image dimensions one for each of the anchor
280 ;; A4 page size is 21.0 by 29.7 cms
281 ;; The default page settings has 2cm margin on each of the sides. So
282 ;; the effective text area is 17.0 by 25.7 cm
291 "Specify how labels are applied and referenced.
293 This is an alist where each element is of the form:
295 \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
297 ATTACH-FMT controls how labels and captions are attached to an
298 entity. It may contain following specifiers - %e and %c. %e is
299 replaced with the CATEGORY-NAME. %n is replaced with
301 with CAPTION.
303 REF-MODE and REF-FMT controls how label references are generated.
304 The following XML is generated for a label reference -
307 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
308 %n is replaced with SEQNO.
318 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
320 This is a list where each entry is of the form:
322 \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
324 CATEGORY_HANDLE identifies the captionable entity in question.
326 OD-VARIABLE is the OpenDocument sequence counter associated with
327 the entity. These counters are declared within
329 `org-odt-content-template-file'.
331 LABEL-STYLE is a key into `org-odt-label-styles' and specifies
332 how a given entity should be captioned and referenced.
334 CATEGORY-NAME is used for qualifying captions on export.
336 ENUMERATOR-PREDICATE is used for assigning a sequence number to
346 \f
347 ;;; User Configuration Variables
350 "Options for exporting Org mode files to ODT."
355 ;;;; Debugging
358 "Specify whether or not the xml output should be prettified.
359 When this option is turned on, `indent-region' is run on all
360 component xml buffers before they are saved. Turn this off for
361 regular use. Turn this on if you need to examine the xml
362 visually."
368 ;;;; Document schema
381 schema-dir))
384 schema-dir))
388 schema-dir)
390 org-odt-schema-dir-list)
392 nil)))
393 schema-dir)
394 "Directory that contains OpenDocument schema files.
396 This directory contains:
397 1. rnc files for OpenDocument schema
399 for auto validation of OpenDocument XML files.
401 Use the customize interface to set this variable. This ensures
402 that `rng-schema-locating-files' is updated and auto-validation
403 of OpenDocument XML takes place based on the value
404 `rng-nxml-auto-validate-flag'.
406 The default value of this variable varies depending on the
407 version of org in use and is initialized from
408 `org-odt-schema-dir-list'. The OASIS schema files are available
409 only in the org's private git repository. It is *not* bundled
410 with GNU ELPA tar or standard Emacs distribution."
416 :set
418 "Set `org-odt-schema-dir'.
419 Also add it to `rng-schema-locating-files'."
429 schema-dir
432 value))
433 nil)))
438 org-odt-schema-dir))))))
441 ;;;; Document styles
445 The exporter embeds the exported content just before
449 under `org-odt-styles-dir' is used."
456 "Default styles file for use with ODT export.
457 Valid values are one of:
458 1. nil
459 2. path to a styles.xml file
460 3. path to a *.odt or a *.ott file
461 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
462 ...))
464 In case of option 1, an in-built styles.xml is used. See
465 `org-odt-styles-dir' for more information.
467 In case of option 3, the specified file is unzipped and the
468 styles.xml embedded therein is used.
470 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
471 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
472 generated odt file. Use relative path for specifying the
473 FILE-MEMBERS. styles.xml must be specified as one of the
474 FILE-MEMBERS.
476 Use options 1, 2 or 3 only if styles.xml alone suffices for
477 achieving the desired formatting. Use option 4, if the styles.xml
478 references additional files like header and footer images for
479 achieving the desired formatting.
482 a per-file basis. For example,
488 :type
500 "Outline levels considered for enumerating captioned entities."
506 ;;;; Document conversion
513 "Specify a list of document converters and their usage.
514 The converters in this list are offered as choices while
515 customizing `org-odt-convert-process'.
517 This variable is a list where each element is of the
518 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
519 of the converter. CONVERTER-CMD is the shell command for the
520 converter and can contain format specifiers. These format
521 specifiers are interpreted as below:
523 %i input file name in full
524 %I input file name as a URL
525 %f format of the output file
526 %o output file name in full
527 %O output file name as a URL
528 %d output dir in full
529 %D output dir as a URL.
530 %x extra options as set in `org-odt-convert-capabilities'."
533 :type
542 During customization, the list of converter names are populated
543 from `org-odt-convert-processes'."
553 org-odt-convert-processes))))
571 "Specify input and output formats of `org-odt-convert-process'.
572 More correctly, specify the set of input and output formats that
573 the user is actually interested in.
575 This variable is an alist where each element is of the
576 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
577 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
578 alist where each element is of the form (OUTPUT-FMT
579 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
581 The variable is interpreted as follows:
582 `org-odt-convert-process' can take any document that is in
583 INPUT-FMT-LIST and produce any document that is in the
584 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
585 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
586 serves dual purposes:
587 - It is used for populating completion candidates during
588 `org-odt-convert' commands.
590 `org-odt-convert-process'.
593 `org-odt-convert-process'.
595 DOCUMENT-CLASS is used to group a set of file formats in
596 INPUT-FMT-LIST in to a single class.
598 Note that this variable inherently captures how LibreOffice based
599 converters work. LibreOffice maps documents of various formats
600 to classes like Text, Web, Spreadsheet, Presentation etc and
601 allow document of a given class (irrespective of its source
602 format) to be converted to any of the export formats associated
603 with that class.
605 See default setting of this variable for an typical
606 configuration."
609 :type
614 :value-type
618 :value-type
627 and then uses `org-odt-convert-process' to convert the
628 resulting document to this format. During customization of this
629 variable, the list of valid values are populated based on
630 `org-odt-convert-capabilities'.
632 You can set this option on per-file basis using file local
633 values. See Info node `(emacs) File Variables'."
644 ;;;###autoload
648 ;;;; Drawers
652 "Function called to format a drawer in ODT code.
654 The function must accept two parameters:
656 CONTENTS the contents of the drawer.
658 The function should return the string to be exported.
660 The default value simply returns the value of CONTENTS."
667 ;;;; Headline
670 "Function to format headline text.
672 This function will be called with 5 arguments:
673 TODO the todo keyword \(string or nil\).
674 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
675 PRIORITY the priority of the headline \(integer or nil\)
676 TEXT the main headline text \(string\).
677 TAGS the tags string, separated with colons \(string or nil\).
679 The function result will be used as headline text."
686 ;;;; Inlinetasks
689 "Function called to format an inlinetask in ODT code.
691 The function must accept six parameters:
692 TODO the todo keyword, as a string
693 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
694 PRIORITY the inlinetask priority, as a string
695 NAME the inlinetask name, as a string.
696 TAGS the inlinetask tags, as a string.
697 CONTENTS the contents of the inlinetask, as a string.
699 The function should return the string to be exported."
706 ;;;; LaTeX
709 "Non-nil means process LaTeX math snippets.
711 When set, the exporter will process LaTeX environments and
712 fragments.
714 This option can also be set with the +OPTIONS line,
717 nil Ignore math snippets.
718 `verbatim' Keep everything in verbatim
719 `dvipng' Process the LaTeX fragments to images. This will also
720 include processing of non-math environments.
721 `imagemagick' Convert the LaTeX fragments to pdf files and use
722 imagemagick to convert pdf files to png files.
723 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
724 be loaded.
725 t Synonym for `mathjax'."
737 ;;;; Links
741 "Rules characterizing formula files that can be inlined into ODT.
743 A rule consists in an association whose key is the type of link
744 to consider, and value is a regexp that will be matched against
745 link's path."
754 "Rules characterizing image files that can be inlined into ODT.
756 A rule consists in an association whose key is the type of link
757 to consider, and value is a regexp that will be matched against
758 link's path."
766 "Scaling factor for converting images pixels to inches.
767 Use this for sizing of embedded images. See Info node `(org)
768 Images in ODT export' for more information."
775 ;;;; Src Block
778 "Whether custom styles for colorized source blocks be automatically created.
779 When this option is turned on, the exporter creates custom styles
780 for source blocks based on the advice of `htmlfontify'. Creation
781 of custom styles happen as part of `org-odt-hfy-face-to-css'.
783 When this option is turned off exporter does not create such
784 styles.
786 Use the latter option if you do not want the custom styles to be
787 based on your current display settings. It is necessary that the
788 styles.xml already contains needed styles for colorizing to work.
790 This variable is effective only if
791 `org-odt-fontify-srcblocks' is turned on."
797 "Specify whether or not source blocks need to be fontified.
798 Turn this option on if you want to colorize the source code
799 blocks in the exported file. For colorization to work, you need
800 to make available an enhanced version of `htmlfontify' library."
806 ;;;; Table
819 "Specify how Table Styles should be derived from a Table Template.
820 This is a list where each element is of the
821 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
823 TABLE-STYLE-NAME is the style associated with the table through
826 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
827 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
828 below) that is included in
829 `org-odt-content-template-file'.
831 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
833 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
841 TABLE-CELL-OPTIONS is an alist where each element is of the
842 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
843 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
844 `use-last-row-styles' |
845 `use-first-column-styles' |
846 `use-last-column-styles' |
847 `use-banding-rows-styles' |
848 `use-banding-columns-styles' |
849 `use-first-row-styles'
850 ON-OR-OFF := `t' | `nil'
852 For example, with the following configuration
854 \(setq org-odt-table-styles
856 \(\(use-first-row-styles . t\)
857 \(use-first-column-styles . t\)\)\)
859 \(\(use-first-column-styles . t\)\)\)\)\)
862 style will use the following table-cell styles -
867 as appropriate.
870 use the following table-cell styles -
872 following paragraph styles
874 as appropriate..
876 Note that TABLE-TEMPLATE-NAME corresponds to the
879 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
882 specification for more information. Also consult the
883 implementation filed under `org-odt-get-table-cell-styles'.
886 formatting of numbered display equations. Do not delete this
887 style from the list."
897 use-last-row-styles
898 use-first-column-styles
899 use-last-column-styles
900 use-banding-rows-styles
901 use-banding-columns-styles)
902 :key-type symbol
905 ;;;; Timestamps
908 "Non-nil, if timestamps should be exported as date fields.
910 When nil, export timestamps as plain text.
912 When non-nil, map `org-time-stamp-custom-formats' to a pair of
914 respectively. A timestamp with no time component is formatted
918 This feature is experimental. Most (but not all) of the common
919 %-specifiers in `format-time-string' are supported.
921 formatted as canonical Org timestamps. For finer control, avoid
922 these %-specifiers.
925 etc., are displayed by the application in the default language
926 and country specified in `org-odt-styles-file'. Note that the
928 can localize the week day and month strings in the exported
929 document by setting the default language and country either using
930 the application UI or through a custom styles file.
932 See `org-odt--build-date-styles' for implementation details."
939 \f
940 ;;; Internal functions
942 ;;;; Date
957 ;; LibreOffice does not care about end goes as content
958 ;; within the "<text:date>...</text:date>" field. The
959 ;; displayed date is automagically corrected to match the
960 ;; format requested by "style:data-style-name" attribute. So
961 ;; don't bother about formatting the date contents to be
962 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
963 ;; simple Org-style date should suffice.
988 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
989 iso-date style date)
991 repeater)))))
993 ;;;; Frame
1001 extra
1005 style frame-attrs
1017 ;;;; Library wrappers
1024 ;; This is shamelessly stolen from `archive-zip-extract'.
1030 name)))
1035 exit-code command-output)
1043 members))
1045 ;;;; Target
1054 ;;;; Textbox
1057 extra anchor-type)
1063 text)
1064 width nil style extra anchor-type))
1068 ;;;; Table of Contents
1073 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1075 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1082 "
1083 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1085 <text:index-entry-chapter/>
1086 <text:index-entry-text/>
1087 <text:index-entry-link-end/>
1088 </text:table-of-content-entry-template>
1092 </text:table-of-content-source>
1094 <text:index-body>
1097 </text:index-title>
1102 </text:index-body>
1103 </text:table-of-content>
1111 ;; Section number.
1113 ;; Todo.
1118 style todo)))
1123 style priority)))
1124 ;; Title.
1125 text
1126 ;; Tags.
1130 "OrgTags"
1137 headline-label text))
1141 ;; When a headline is marked as a radio target, as in the example below:
1142 ;;
1143 ;; ** <<<Some Heading>>>
1144 ;; Some text.
1145 ;;
1146 ;; suppress generation of radio targets. i.e., Radio targets are to
1147 ;; be marked as targets within /document body/ and *not* within
1148 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1149 ;; and one in the document body.
1150 ;;
1151 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1152 ;; doesn't provide a way to disable memoization. So this doesn't
1153 ;; work.
1154 ;;
1155 ;; FIXME-2: Are there any other objects that need to be suppressed
1156 ;; within TOC?
1176 style entry)))
1181 ;;;; Document styles
1184 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1185 OBJECT-PROPS is (typically) a plist created by passing
1187 `org-odt-parse-block-attributes'.
1189 Use `org-odt-object-counters' to generate an automatic
1190 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1191 new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
1192 . STYLE-NAME)."
1208 ;;;; Checkbox
1211 "Return check-box string associated to ITEM."
1220 ;;; Template
1223 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1224 ;; to modify the date fields. A date could be modified by
1225 ;; offsetting in days. That's about it. Also, date and time may
1226 ;; have to be emitted as two fields - a date field and a time field
1227 ;; - separately.
1229 ;; One can add Form Controls to date and time fields so that they
1230 ;; can be easily modified. But then, the exported document will
1231 ;; become tightly coupled with LibreOffice and may not function
1232 ;; properly with other OpenDocument applications.
1234 ;; I have a strange feeling that Date styles are a bit flaky at the
1235 ;; moment.
1237 ;; The feature is experimental.
1283 ))
1291 filler-end))
1302 style
1305 output ))))
1308 "Return complete document string after ODT conversion.
1309 CONTENTS is the transcoded contents string. RAW-DATA is the
1310 original parsed data. INFO is a plist holding export options."
1311 ;; Write meta file.
1321 <office:document-meta
1331 ;; Date, if required.
1333 ;; Check if DATE is specified as an Org-timestamp. If yes,
1334 ;; include it as meta information. Otherwise, just use
1335 ;; today's date.
1344 iso-date)))))
1355 ;; Add meta.xml in to manifest.
1358 ;; Update styles file.
1359 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1360 ;; Write styles file.
1363 ;; Non-availability of styles.xml is not a critical
1364 ;; error. For now, throw an error.
1366 org-odt-styles-file
1368 org-odt-styles-dir)
1381 members)))
1391 org-odt-styles-file))))
1393 ;; create a manifest entry for styles.xml
1396 ;; FIXME: Who is opening an empty styles.xml before this point?
1401 ;; Write custom styles for source blocks
1402 ;; Save STYLES used for colorizing of source blocks.
1403 ;; Update styles.xml with styles that were collected as part of
1404 ;; `org-odt-hfy-face-to-css' callbacks.
1413 ;; Update styles.xml - take care of outline numbering
1415 ;; Don't make automatic backup of styles.xml file. This setting
1416 ;; prevents the backed-up styles.xml file from being zipped in to
1417 ;; odt file. This is more of a hackish fix. Better alternative
1418 ;; would be to fix the zip command so that the output odt file
1419 ;; includes only the needed files and excludes any auto-generated
1420 ;; extra files like backups and auto-saves etc etc. Note that
1421 ;; currently the zip command zips up the entire temp directory so
1422 ;; that any auto-generated files created under the hood ends up in
1423 ;; the resulting odt file.
1426 ;; Outline numbering is retained only upto LEVEL.
1427 ;; To disable outline numbering pass a LEVEL of 0.
1440 ;; Update content.xml.
1443 ;; within the context of the Org buffer. So obtain its
1444 ;; value before moving on to temp-buffer context down below.
1454 org-odt-styles-dir)))
1455 ;; Write automatic styles.
1456 ;; - Position the cursor.
1460 ;; - Dump automatic table styles.
1465 ;; - Dump date-styles.
1471 ;; Update display level.
1472 ;; - Remove existing sequence decls. Also position the cursor.
1477 ;; Update sequence decls according to user preference.
1487 ;; Position the cursor to document body.
1492 ;; Preamble - Title, Author, Date etc.
1499 ;; Switch on or off above vars based on user settings
1503 ;; Title.
1508 ;; Separator.
1512 ;; Author only.
1515 "OrgSubtitle"
1517 ;; Separator.
1520 ;; Author and E-mail.
1524 "OrgSubtitle"
1529 ;; Separator.
1531 ;; Date, if required.
1534 ;; Check if DATE is specified as a timestamp.
1540 "OrgSubtitle"
1544 ;; Separator
1546 ;; Table of Contents
1549 with-toc
1552 ;; Contents.
1554 ;; Return contents.
1558 \f
1559 ;;; Transcode Functions
1561 ;;;; Bold
1564 "Transcode BOLD from Org to ODT.
1565 CONTENTS is the text with bold markup. INFO is a plist holding
1566 contextual information."
1571 ;;;; Center Block
1574 "Transcode a CENTER-BLOCK element from Org to ODT.
1575 CONTENTS holds the contents of the center block. INFO is a plist
1576 holding contextual information."
1577 contents)
1580 ;;;; Clock
1583 "Transcode a CLOCK element from Org to ODT.
1584 CONTENTS is nil. INFO is a plist used as a communication
1585 channel."
1598 ;;;; Code
1601 "Transcode a CODE object from Org to ODT.
1602 CONTENTS is nil. INFO is a plist used as a communication
1603 channel."
1609 ;;;; Comment
1611 ;; Comments are ignored.
1614 ;;;; Comment Block
1616 ;; Comment Blocks are ignored.
1619 ;;;; Drawer
1622 "Transcode a DRAWER element from Org to ODT.
1623 CONTENTS holds the contents of the block. INFO is a plist
1624 holding contextual information."
1627 name contents)))
1628 output))
1631 ;;;; Dynamic Block
1634 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1635 CONTENTS holds the contents of the block. INFO is a plist
1636 holding contextual information. See `org-export-data'."
1637 contents)
1640 ;;;; Entity
1643 "Transcode an ENTITY object from Org to ODT.
1644 CONTENTS are the definition itself. INFO is a plist holding
1645 contextual information."
1649 ;;;; Example Block
1652 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1653 CONTENTS is nil. INFO is a plist holding contextual information."
1657 ;;;; Export Snippet
1660 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1661 CONTENTS is nil. INFO is a plist holding contextual information."
1666 ;;;; Export Block
1669 "Transcode a EXPORT-BLOCK element from Org to ODT.
1670 CONTENTS is nil. INFO is a plist holding contextual information."
1675 ;;;; Fixed Width
1678 "Transcode a FIXED-WIDTH element from Org to ODT.
1679 CONTENTS is nil. INFO is a plist holding contextual information."
1683 ;;;; Footnote Definition
1685 ;; Footnote Definitions are ignored.
1688 ;;;; Footnote Reference
1691 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1692 CONTENTS is nil. INFO is a plist holding contextual information."
1702 id note-class
1715 "OrgSuperscript"
1716 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1717 note-class ref-format ref-name n)))))))
1719 ;; Insert separator between two footnotes in a row.
1724 ;; Transcode footnote reference.
1729 ;; Inline definitions are secondary strings.
1730 ;; Non-inline footnotes definitions are full Org data.
1733 footnote-reference info))
1737 raw
1740 :transcoders
1743 p c "Footnote"
1744 "OrgFootnoteCenter"
1746 info))))
1753 ;;;; Headline
1759 ;; Todo.
1763 style todo)))
1768 style priority)))
1769 ;; Title.
1770 text
1771 ;; Tags.
1774 "<text:tab/>"
1783 &optional format-function
1785 "Transcode a HEADLINE element using BACKEND.
1786 INFO is a plist holding contextual information."
1813 todo todo-type priority text tags))))
1816 todo todo-type priority text tags
1821 "Transcode a HEADLINE element from Org to ODT.
1822 CONTENTS holds the contents of the headline. INFO is a plist
1823 holding contextual information."
1824 ;; Case 1: This is a footnote section: ignore it.
1827 ;; Create the headline text.
1829 ;; Get level relative to current parsed data.
1831 ;; Get canonical label for the headline.
1835 ;; Get user-specified labels for the headline.
1838 ;; Extra targets.
1846 ;; Title.
1849 ;; Case 2. This is a deep sub-tree: export it as a list item.
1850 ;; Also export as items headlines for which no section
1851 ;; format has been found.
1853 ;; Build the real contents of the sub-tree.
1857 ;; Choose style based on list type.
1860 ;; If top-level list, re-start numbering. Otherwise,
1861 ;; continue numbering.
1864 headline)))
1874 "Text_20_body"
1876 contents)
1878 "</text:list-header>"
1882 ;; Case 3. Standard headline. Export it as a section.
1888 level
1890 contents))))))
1893 ;;;; Horizontal Rule
1896 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1897 CONTENTS is nil. INFO is a plist holding contextual information."
1902 ;;;; Inline Babel Call
1904 ;; Inline Babel Calls are ignored.
1907 ;;;; Inline Src Block
1910 "Return a character not used in string S.
1912 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1918 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1919 CONTENTS holds the contents of the item. INFO is a plist holding
1920 contextual information."
1927 ;;;; Inlinetask
1930 "Transcode an INLINETASK element from Org to ODT.
1931 CONTENTS holds the contents of the block. INFO is a plist
1932 holding contextual information."
1934 ;; If `org-odt-format-inlinetask-function' is not 'ignore, call it
1935 ;; with appropriate arguments.
1942 todo todo-type priority text tags contents)))))
1945 ;; Otherwise, use a default template.
1948 "Text_20_body"
1952 "OrgInlineTaskHeading"
1954 contents)
1957 ;;;; Italic
1960 "Transcode ITALIC from Org to ODT.
1961 CONTENTS is the text with italic markup. INFO is a plist holding
1962 contextual information."
1967 ;;;; Item
1970 "Transcode an ITEM element from Org to ODT.
1971 CONTENTS holds the contents of the item. INFO is a plist holding
1972 contextual information."
1983 contents
1995 ;;;; Keyword
1998 "Transcode a KEYWORD element from Org to ODT.
1999 CONTENTS is nil. INFO is a plist holding contextual information."
2005 ;; FIXME
2016 ;; FIXME
2020 ;;;; Latex Environment
2023 ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
2024 ;; (defadvice org-format-latex-as-mathml ; FIXME
2025 ;; (after org-odt-protect-latex-fragment activate)
2026 ;; "Encode LaTeX fragment as XML.
2027 ;; Do this when translation to MathML fails."
2028 ;; (unless (> (length ad-return-value) 0)
2029 ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
2032 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2033 CONTENTS is nil. INFO is a plist holding contextual information."
2039 ;;;; Latex Fragment
2041 ;; (when latex-frag ; FIXME
2042 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2043 ;; :description latex-frag)))
2044 ;; handle verbatim
2045 ;; provide descriptions
2048 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2049 CONTENTS is nil. INFO is a plist holding contextual information."
2056 ;;;; Line Break
2059 "Transcode a LINE-BREAK object from Org to ODT.
2060 CONTENTS is nil. INFO is a plist holding contextual information."
2064 ;;;; Link
2066 ;;;; Links :: Label references
2077 x)))))
2088 counter))
2095 ;; Section number.
2099 ;; Separator.
2101 ;; Ordinal.
2103 tag))
2106 "Return a label for ELEMENT.
2108 ELEMENT is a `link', `table', `src-block' or `paragraph' type
2109 element. INFO is a plist used as a communication channel. OP is
2110 either `definition' or `reference', depending on the purpose of
2111 the generated string.
2113 Return value is a string if OP is set to `reference' or a cons
2114 cell like CAPTION . SHORT-CAPTION) where CAPTION and
2115 SHORT-CAPTION are strings."
2121 ;; Get label and caption.
2125 ;; Transcode captions.
2127 ;; Currently short caption are sneaked in as object names.
2128 ;;
2129 ;; The advantages are:
2130 ;;
2131 ;; - Table Of Contents: Currently, there is no support for
2132 ;; building TOC for figures, listings and tables. See
2133 ;; `org-odt-keyword'. User instead has to rely on
2134 ;; external application for building such indices. Within
2135 ;; LibreOffice, building an "Illustration Index" or "Index
2136 ;; of Tables" will create a table with long captions (only)
2137 ;; and building a table with "Object names" will create a
2138 ;; table with short captions.
2139 ;;
2140 ;; - Easy navigation: In LibreOffice, object names are
2141 ;; offered via the navigation bar. This way one can
2142 ;; quickly locate and jump to object of his choice in the
2143 ;; exported document.
2144 ;;
2145 ;; The main disadvantage is that there cannot be any markups
2146 ;; within object names i.e., one cannot embolden, italicize
2147 ;; or underline text within short caption. So suppress
2148 ;; generation of <text:span >...</text:span> and other
2149 ;; markups by overriding the default translators. We
2150 ;; probably shouldn't be suppressing translators for all
2151 ;; elements in `org-element-all-objects', but for now this
2152 ;; will do.
2158 :transcoders
2160 org-element-all-objects))))
2177 element))))
2180 seqno)
2184 ;; Compute sequence number of the element.
2186 ;; Localize category string.
2189 ;; Case 1: Handle Label definition.
2191 ;; Assign an internal label, if user has not provided one
2196 ;; Sneak in a bookmark. The bookmark is used when the
2197 ;; labeled element is referenced with a link that
2198 ;; provides its own description.
2200 ;; Label definition: Typically formatted as below:
2201 ;; CATEGORY SEQ-NO: LONG CAPTION
2202 ;; with translation for correct punctuation.
2209 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2210 label counter counter seqno))
2212 short-caption))
2213 ;; Case 2: Handle Label reference.
2220 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2226 ;;;; Links :: Inline Images
2229 "Returns the internal name of the file"
2245 target-file))
2248 user-height scale dpi embed-as)
2268 ;; Use Imagemagick.
2273 file))))
2278 ;; Use Emacs.
2284 ;; Use hard-coded values.
2286 org-odt-default-image-sizes-alist))
2287 ;; Error out.
2300 ;; ensure that an embedded image fits comfortably within a page
2311 "Return ODT code for an inline image.
2312 LINK is the link pointing to the inline image. INFO is a plist
2313 used as a communication channel."
2326 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2328 ;; Extract attributes from #+ATTR_ODT line.
2332 ;; Convert attributes to a plist.
2334 ;; Handle `:anchor', `:style' and `:attributes' properties.
2344 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2345 ;;
2346 ;; Handle `:width', `:height' and `:scale' properties. Read
2347 ;; them as numbers since we need them for computations.
2349 src-expanded
2356 nil ; embed-as
2358 ))
2365 ;; Check if this link was created by LaTeX-to-PNG converter.
2369 ;; If yes, note down the type of the element - LaTeX Fragment
2370 ;; or LaTeX environment. It will go in to frame title.
2374 ;; If yes, note down its contents. It will go in to frame
2375 ;; description. This quite useful for debugging.
2378 captions user-frame-params title desc)))
2381 ;;;; Links :: Math formula
2402 ;; Check if this link was created by LaTeX-to-MathML
2403 ;; converter.
2407 ;; If yes, note down the type of the element - LaTeX Fragment
2408 ;; or LaTeX environment. It will go in to frame title.
2412 ;; If yes, note down its contents. It will go in to frame
2413 ;; description. This quite useful for debugging.
2415 width height)
2419 nil nil title desc))
2422 "CaptionedDisplayFormula" href width height
2423 captions nil title desc))
2427 org-odt--enumerable-formula-p))))
2432 "Returns the internal name of the file"
2436 ;; Create a directory for holding formula file. Also enter it in
2437 ;; to manifest.
2441 ;; Copy over the formula file from user directory to zip
2442 ;; directory.
2446 ;; Case 1: Mathml.
2449 ;; Case 2: OpenDocument formula.
2454 ;; Enter the formula file in to manifest.
2456 target-file))
2458 ;;;; Targets
2461 captions user-frame-params
2464 ;; Each element of this alist is of the form (CFG-HANDLE
2465 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2467 ;; CFG-HANDLE is the key to the alist.
2469 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2470 ;; frame params for INNER-FRAME and OUTER-FRAME
2471 ;; respectively. See below.
2473 ;; Configurations that are meant to be applied to
2474 ;; non-captioned image/formula specifies no
2475 ;; OUTER-FRAME-PARAMS.
2477 ;; TERMINOLOGY
2478 ;; ===========
2479 ;; INNER-FRAME :: Frame that directly surrounds an
2480 ;; image/formula.
2482 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2483 ;; frame also contains the caption, if any.
2485 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2486 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2487 ;; that these are the last three arguments
2488 ;; to `org-odt--frame'.
2490 ;; Note that an un-captioned image/formula requires just an
2491 ;; INNER-FRAME, while a captioned image/formula requires
2492 ;; both an INNER and an OUTER-FRAME.
2514 ;; Retrieve inner and outer frame params, from configuration.
2518 ;; User-specified frame params (from #+ATTR_ODT spec)
2522 "Merge default and user frame params."
2527 for d in default
2530 ;; Case 1: Image/Formula has no caption.
2531 ;; There is only one frame, one that surrounds the image
2532 ;; or formula.
2534 ;; Merge user frame params with that from configuration.
2538 ;; Case 2: Image/Formula is captioned or labeled.
2539 ;; There are two frames: The inner one surrounds the
2540 ;; image or formula. The outer one contains the
2541 ;; caption/sequence number.
2543 ;; Merge user frame params with outer frame params.
2545 ;; Short caption, if specified, goes as part of inner frame.
2552 frame-params))
2555 "Illustration"
2559 caption))
2560 width height outer)))))
2563 ;; Element should have a caption or label.
2569 element info
2570 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2571 ;; replacement element. (i.e., It SHOULD NOT 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. It SHOULD also be a
2586 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2587 ;; processing.)
2592 ;; Link should point to an image file.
2599 element info
2600 ;; Paragraph should have a caption or label.
2604 ;; Link should point to a MathML or ODF file.
2610 paragraph-predicate
2611 link-predicate)
2612 "Test if ELEMENT is a standalone link for the purpose ODT export.
2613 INFO is a plist holding contextual information.
2615 Return non-nil, if ELEMENT is of type paragraph satisfying
2616 PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
2617 is a link that satisfies LINK-PREDICATE.
2619 Return non-nil, if ELEMENT is of type link satisfying
2620 LINK-PREDICATE and its containing paragraph satisfies
2621 PARAGRAPH-PREDICATE in addition to having no other content save for
2622 leading and trailing whitespaces.
2624 Return nil, otherwise."
2647 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2648 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2649 ;; attached. Note that labels that are attached to captioned
2650 ;; entities - inline images, math formulae and tables - get resolved
2651 ;; as part of `org-odt-format-label' and `org-odt--enumerate'.
2653 ;; Create a cross-reference to DESTINATION but make best-efforts to
2654 ;; create a *meaningful* description. Check item numbers, section
2655 ;; number and section title in that order.
2657 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2658 ;; FIXME: Handle footnote-definition footnote-reference?
2674 return x))
2675 ;; Get list item nos.
2680 plain-list)
2683 item info t))))))
2684 ;; Locate top-most listified headline.
2689 return x))
2690 ;; Get listified headline numbers.
2696 el info t)))))))
2697 ;; Combine item numbers from both the listified headlines and
2698 ;; regular list items.
2700 ;; Case 1: Check if all the parents of list item are numbered.
2701 ;; If yes, link to the item proper.
2704 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2709 ;; Case 2: Locate a regular and numbered headline in the
2710 ;; hierarchy. Display its section number.
2715 return el)))
2716 ;; We found one.
2718 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2722 ;; Case 4: Locate a regular headline in the hierarchy. Display
2723 ;; its title.
2727 return el)))
2728 ;; We found one.
2730 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2737 "Transcode a LINK object from Org to ODT.
2739 DESC is the description part of the link, or the empty string.
2740 INFO is a plist holding contextual information. See
2741 `org-export-data'."
2744 ;; Ensure DESC really exists, or set it to nil.
2747 link org-odt-inline-image-rules))
2756 ;; Convert & to & for correct XML representation
2758 protocol)
2760 ;; Image file.
2762 link org-odt-inline-image-rules))
2764 ;; Formula file.
2766 link org-odt-inline-formula-rules))
2768 ;; Radio target: Transcode target's contents and use them as
2769 ;; link's description.
2776 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2777 href desc)))))
2778 ;; Links pointing to a headline: Find destination and build
2779 ;; appropriate referencing command.
2785 ;; Case 1: Fuzzy link points nowhere.
2786 ('nil
2788 "Emphasis"
2791 info))))
2792 ;; Case 2: Fuzzy link points to a headline.
2794 ;; If there's a description, create a hyperlink.
2795 ;; Otherwise, try to provide a meaningful description.
2804 label desc))))
2805 ;; Case 3: Fuzzy link points to a target.
2807 ;; If there's a description, create a hyperlink.
2808 ;; Otherwise, try to provide a meaningful description.
2813 desc))))
2814 ;; Case 4: Fuzzy link points to some element (e.g., an
2815 ;; inline image, a math formula or a table).
2822 ;; LINK has no description. Create
2823 ;; a cross-reference showing entity's sequence
2824 ;; number.
2826 ;; LINK has description. Insert a hyperlink with
2827 ;; user-provided description.
2832 desc)))))))))
2833 ;; Coderef: replace link with the reference name or the
2834 ;; equivalent line number.
2841 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2842 href line-no))))
2843 ;; Link type is handled by a special function.
2846 ;; External link with a description part.
2849 ;; Check if description is a link to an inline image.
2854 desc-element org-odt-inline-image-rules))))
2855 ;; Format link as a clickable image.
2857 path desc)
2858 ;; Otherwise, format it as a regular link.
2860 path desc))))
2861 ;; External link without a description part.
2864 path path))
2865 ;; No path, only description. Try to do something useful.
2870 ;;;; Node Property
2873 "Transcode a NODE-PROPERTY element from Org to ODT.
2874 CONTENTS is nil. INFO is a plist holding contextual
2875 information."
2882 ;;;; Paragraph
2885 "Format paragraph according to given styles.
2886 PARAGRAPH is a paragraph type element. CONTENTS is the
2887 transcoded contents of that paragraph, as a string. DEFAULT,
2888 CENTER and QUOTE are, respectively, style to use when paragraph
2889 belongs to no special environment, a center block, or a quote
2890 block."
2897 ;; If this paragraph is a leading paragraph in an item and the
2898 ;; item has a checkbox, splice the checkbox and paragraph contents
2899 ;; together.
2906 "Transcode a PARAGRAPH element from Org to ODT.
2907 CONTENTS is the contents of the paragraph, as a string. INFO is
2908 the plist used as a communication channel."
2910 paragraph contents
2912 "OrgCenter"
2916 ;;;; Plain List
2919 "Transcode a PLAIN-LIST element from Org to ODT.
2920 CONTENTS is the contents of the list. INFO is a plist holding
2921 contextual information."
2923 ;; Choose style based on list type.
2929 ;; If top-level list, re-start numbering. Otherwise,
2930 ;; continue numbering.
2935 contents))
2937 ;;;; Plain Text
2950 line))
2961 "Transcode a TEXT string from Org to ODT.
2962 TEXT is the string to transcode. INFO is a plist holding
2963 contextual information."
2965 ;; Protect &, < and >.
2967 ;; Handle smart quotes. Be sure to provide original string since
2968 ;; OUTPUT may have been modified.
2971 ;; Convert special strings.
2977 org-odt-special-string-regexps))
2978 ;; Handle break preservation if required.
2982 ;; Return value.
2983 output))
2986 ;;;; Planning
2989 "Transcode a PLANNING element from Org to ODT.
2990 CONTENTS is nil. INFO is a plist used as a communication
2991 channel."
2993 "OrgPlanning"
3015 ;;;; Property Drawer
3018 "Transcode a PROPERTY-DRAWER element from Org to ODT.
3019 CONTENTS holds the contents of the drawer. INFO is a plist
3020 holding contextual information."
3023 contents)))
3026 ;;;; Quote Block
3029 "Transcode a QUOTE-BLOCK element from Org to ODT.
3030 CONTENTS holds the contents of the block. INFO is a plist
3031 holding contextual information."
3032 contents)
3035 ;;;; Quote Section
3038 "Transcode a QUOTE-SECTION element from Org to ODT.
3039 CONTENTS is nil. INFO is a plist holding contextual information."
3045 ;;;; Section
3050 style
3052 text)))
3056 "Transcode a SECTION element from Org to ODT.
3057 CONTENTS holds the contents of the section. INFO is a plist
3058 holding contextual information."
3059 contents)
3061 ;;;; Radio Target
3064 "Transcode a RADIO-TARGET object from Org to ODT.
3065 TEXT is the text of the target. INFO is a plist holding
3066 contextual information."
3072 ;;;; Special Block
3075 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3076 CONTENTS holds the contents of the block. INFO is a plist
3077 holding contextual information."
3081 ;; Annotation.
3087 ;; FIXME: Is `car' right thing to do below?
3097 contents)))))
3098 ;; Textbox.
3107 style extra anchor))))
3111 ;;;; Src Block
3114 "Create custom style for face FN.
3115 When FN is the default face, use its foreground and background
3117 use its color attribute to create a character style whose name
3118 is obtained from FN. Currently all attributes of FN other than
3119 color are ignored.
3121 The style name for a face FN is derived using the following
3122 operations on the face name in that order - de-dash, CamelCase
3124 `font-lock-function-name-face' is associated with
3138 background-color-val color-val))
3141 "
3172 org-odt-fontify-srcblocks
3189 code
3200 par-style loc))
3203 num-start refs))
3217 ;; Extract code and references.
3221 ;; Does the src block contain labels?
3223 ;; Does it have line numbers?
3230 "Transcode a SRC-BLOCK element from Org to ODT.
3231 CONTENTS holds the contents of the item. INFO is a plist holding
3232 contextual information."
3244 "Text_20_body"
3248 ;;;; Statistics Cookie
3251 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3252 CONTENTS is nil. INFO is a plist holding contextual information."
3258 ;;;; Strike-Through
3261 "Transcode STRIKE-THROUGH from Org to ODT.
3262 CONTENTS is the text with strike-through markup. INFO is a plist
3263 holding contextual information."
3268 ;;;; Subscript
3271 "Transcode a SUBSCRIPT object from Org to ODT.
3272 CONTENTS is the contents of the object. INFO is a plist holding
3273 contextual information."
3278 ;;;; Superscript
3281 "Transcode a SUPERSCRIPT object from Org to ODT.
3282 CONTENTS is the contents of the object. INFO is a plist holding
3283 contextual information."
3288 ;;;; Table Cell
3297 "Retrieve styles applicable to a table cell.
3298 R and C are (zero-based) row and column numbers of the table
3299 cell. STYLE-SPEC is an entry in `org-odt-table-styles'
3300 applicable to the current table. It is `nil' if the table is not
3301 associated with any style attributes.
3303 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3305 When STYLE-SPEC is nil, style the table cell the conventional way
3306 - choose cell borders based on row and column groupings and
3307 choose paragraph alignment based on `org-col-cookies' text
3308 property. See also
3309 `org-odt-get-paragraph-style-cookie-for-table-cell'.
3311 When STYLE-SPEC is non-nil, ignore the above cookie and return
3312 styles congruent with the ODF-1.2 specification."
3318 info)))
3320 ;; LibreOffice - particularly the Writer - honors neither table
3321 ;; templates nor custom table-cell styles. Inorder to retain
3322 ;; inter-operability with LibreOffice, only automatic styles are
3323 ;; used for styling of table-cells. The current implementation is
3324 ;; congruent with ODF-1.2 specification and hence is
3325 ;; future-compatible.
3327 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3328 ;; which recognizes as many as 16 different cell types - is much
3329 ;; richer. Unfortunately it is NOT amenable to easy configuration
3330 ;; by hand.
3357 "Transcode a TABLE-CELL element from Org to ODT.
3358 CONTENTS is nil. INFO is a plist used as a communication
3359 channel."
3366 table-cell info))
3389 table-cell info))))))
3393 custom-style-prefix))
3395 "OrgTblCell"
3411 cell-attributes
3414 org-element-all-elements)
3415 contents
3417 paragraph-style contents))))
3424 ;;;; Table Row
3427 "Transcode a TABLE-ROW element from Org to ODT.
3428 CONTENTS is the contents of the row. INFO is a plist used as a
3429 communication channel."
3430 ;; Rules are ignored since table separators are deduced from
3431 ;; borders of the current row.
3437 ;; If the row belongs to the first rowgroup and the
3438 ;; table has more than one row groups, then this row
3439 ;; belongs to the header row group.
3441 ;; Otherwise, it belongs to non-header row group.
3444 ;; Does this row begin a rowgroup?
3447 ;; Actual table row
3449 ;; Does this row end a rowgroup?
3454 ;;;; Table
3467 "Transcode a TABLE element from Org to ODT.
3468 CONTENTS is the contents of the table. INFO is a plist holding
3469 contextual information."
3471 ;; Case 1: table.el doesn't support export to OD format. Strip
3472 ;; such tables from export.
3477 "(ox-odt): Found table.el-type table in the source Org file."
3478 " table.el doesn't support export to ODT format."
3480 ;; Case 2: Native Org tables.
3497 column-style))
3498 out)
3502 ;; caption.
3506 ;; begin table.
3514 ;; column specification.
3516 ;; actual contents.
3518 ;; end table.
3522 "Transcode a TABLE element from Org to ODT.
3523 CONTENTS is the contents of the table. INFO is a plist holding
3524 contextual information.
3526 Use `org-odt--table' to typeset the table. Handle details
3527 pertaining to indentation here."
3542 collect el)))
3548 collect
3553 parent-list)
3555 ;; Handle list genealogy.
3575 parent-list info)
3578 ;; Handle low-level headlines.
3580 with step = 'item collect
3588 el info)
3589 "OrgNumberedList"
3600 parent-list info)))
3608 table info)))
3609 ;; OpenDocument schema does not permit table to occur within a
3610 ;; list item.
3612 ;; One solution - the easiest and lightweight, in terms of
3613 ;; implementation - is to put the table in an indented text box
3614 ;; and make the text box part of the list-item. Unfortunately if
3615 ;; the table is big and spans multiple pages, the text box could
3616 ;; overflow. In this case, the following attribute will come
3617 ;; handy.
3619 ;; ,---- From OpenDocument-v1.1.pdf
3620 ;; | 15.27.28 Overflow behavior
3621 ;; |
3622 ;; | For text boxes contained within text document, the
3623 ;; | style:overflow-behavior property specifies the behavior of text
3624 ;; | boxes where the containing text does not fit into the text
3625 ;; | box.
3626 ;; |
3627 ;; | If the attribute's value is clip, the text that does not fit
3628 ;; | into the text box is not displayed.
3629 ;; |
3630 ;; | If the attribute value is auto-create-new-frame, a new frame
3631 ;; | will be created on the next page, with the same position and
3632 ;; | dimensions of the original frame.
3633 ;; |
3634 ;; | If the style:overflow-behavior property's value is
3635 ;; | auto-create-new-frame and the text box has a minimum width or
3636 ;; | height specified, then the text box will grow until the page
3637 ;; | bounds are reached before a new frame is created.
3638 ;; `----
3640 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3641 ;; auto-create-new-frame property and always resorts to clipping
3642 ;; the text box. This results in table being truncated.
3644 ;; So we solve the problem the hard (and fun) way using list
3645 ;; continuations.
3647 ;; The problem only becomes more interesting if you take in to
3648 ;; account the following facts:
3649 ;;
3650 ;; - Description lists are simulated as plain lists.
3651 ;; - Low-level headlines can be listified.
3652 ;; - In Org-mode, a table can occur not only as a regular list
3653 ;; item, but also within description lists and low-level
3654 ;; headlines.
3656 ;; See `org-odt-translate-description-lists' and
3657 ;; `org-odt-translate-low-level-headlines' for how this is
3658 ;; tackled.
3661 ;; Discontinue the list.
3663 ;; Put the table in an indented section.
3668 ;; Continue the list.
3672 ;;;; Target
3675 "Transcode a TARGET object from Org to ODT.
3676 CONTENTS is nil. INFO is a plist holding contextual
3677 information."
3682 ;;;; Timestamp
3685 "Transcode a TIMESTAMP object from Org to ODT.
3686 CONTENTS is nil. INFO is a plist used as a communication
3687 channel."
3704 "OrgActiveTimestamp"
3708 "OrgInactiveTimestamp"
3712 "OrgActiveTimestamp"
3718 "OrgInactiveTimestamp"
3724 "OrgDiaryTimestamp"
3726 info)))))))
3729 ;;;; Underline
3732 "Transcode UNDERLINE from Org to ODT.
3733 CONTENTS is the text with underline markup. INFO is a plist
3734 holding contextual information."
3739 ;;;; Verbatim
3742 "Transcode a VERBATIM object from Org to ODT.
3743 CONTENTS is nil. INFO is a plist used as a communication
3744 channel."
3750 ;;;; Verse Block
3753 "Transcode a VERSE-BLOCK element from Org to ODT.
3754 CONTENTS is verse block contents. INFO is a plist holding
3755 contextual information."
3756 ;; Add line breaks to each line of verse.
3760 ;; Replace tabs and spaces.
3762 ;; Surround it in a verse environment.
3767 \f
3768 ;;; Filters
3770 ;;;; LaTeX fragments
3775 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3776 ;; If the desired converter is not available, force verbatim
3777 ;; processing.
3795 ;; Store normalized value for later use.
3800 ;; Convert `latex-fragment's and `latex-environment's.
3818 ;; Get an Org-style link to PNG image or the MathML
3819 ;; file.
3824 nil display-msg
3825 nil nil processing-type)
3830 link))))
3832 ;; Conversion succeeded. Parse above Org-style link to a
3833 ;; `link' object.
3839 ;; Orphan the link.
3844 ;; Case 1: LaTeX environment.
3845 ;; Mimic a "standalone image or formula" by
3846 ;; enclosing the `link' in a `paragraph'.
3847 ;; Copy over original attributes, captions to
3848 ;; the enclosing paragraph.
3854 latex-*)
3856 latex-*)))
3857 link))
3858 ;; Case 2: LaTeX fragment.
3859 ;; No special action.
3861 ;; Note down the object that link replaces.
3865 ;; Replace now.
3867 info)))
3868 tree)
3871 ;;;; Description lists
3873 ;; This translator is necessary to handle indented tables in a uniform
3874 ;; manner. See comment in `org-odt--table'.
3877 ;; OpenDocument has no notion of a description list. So simulate it
3878 ;; using plain lists. Description lists in the exported document
3879 ;; are typeset in the same manner as they are in a typical HTML
3880 ;; document.
3881 ;;
3882 ;; Specifically, a description list like this:
3883 ;;
3884 ;; ,----
3885 ;; | - term-1 :: definition-1
3886 ;; | - term-2 :: definition-2
3887 ;; `----
3888 ;;
3889 ;; gets translated in to the following form:
3890 ;;
3891 ;; ,----
3892 ;; | - term-1
3893 ;; | - definition-1
3894 ;; | - term-2
3895 ;; | - definition-2
3896 ;; `----
3897 ;;
3898 ;; Further effect is achieved by fixing the OD styles as below:
3899 ;;
3900 ;; 1. Set the :type property of the simulated lists to
3901 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3902 ;; that has *no* bullets whatsoever.
3903 ;;
3904 ;; 2. The paragraph containing the definition term is styled to be
3905 ;; in bold.
3906 ;;
3911 el
3927 nil)
3928 info)
3929 tree)
3931 ;;;; List tables
3933 ;; Lists that are marked with attribute `:list-table' are called as
3934 ;; list tables. They will be rendered as a table within the exported
3935 ;; document.
3937 ;; Consider an example. The following list table
3938 ;;
3939 ;; #+attr_odt :list-table t
3940 ;; - Row 1
3941 ;; - 1.1
3942 ;; - 1.2
3943 ;; - 1.3
3944 ;; - Row 2
3945 ;; - 2.1
3946 ;; - 2.2
3947 ;; - 2.3
3948 ;;
3949 ;; will be exported as though it were an Org table like the one show
3950 ;; below.
3951 ;;
3952 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3953 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3954 ;;
3955 ;; Note that org-tables are NOT multi-line and each line is mapped to
3956 ;; a unique row in the exported document. So if an exported table
3957 ;; needs to contain a single paragraph (with copious text) it needs to
3958 ;; be typed up in a single line. Editing such long lines using the
3959 ;; table editor will be a cumbersome task. Furthermore inclusion of
3960 ;; multi-paragraph text in a table cell is well-nigh impossible.
3961 ;;
3962 ;; A LIST-TABLE circumvents above problems.
3963 ;;
3964 ;; Note that in the example above the list items could be paragraphs
3965 ;; themselves and the list can be arbitrarily deep.
3966 ;;
3967 ;; Inspired by following thread:
3968 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3970 ;; Translate lists to tables
3976 ;; Replace list with table.
3978 l1-list
3979 ;; Build replacement table.
3985 l1-item-leading-text l2-list)
3986 ;; Remove Level-2 list from the Level-item. It
3987 ;; will be subsequently attached as table-cells.
3997 ;; Level-1 items start a table row.
4000 ;; Leading text of level-1 item define
4001 ;; the first table-cell.
4004 l1-item-leading-text)
4005 ;; Level-2 items define subsequent
4006 ;; table-cells of the row.
4014 nil)
4015 info)
4016 tree)
4018 \f
4019 ;;; Interactive functions
4032 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
4041 org-odt-manifest-file-entries)
4049 ;; Initialize temporary workarea. All files that end up in
4050 ;; the exported document get parked/created here.
4057 ;; Kill all XML buffers.
4065 org-odt-xml-files)
4066 ;; Delete temporary directory and also other embedded
4067 ;; files that get copied there.
4072 ;; Not at all OSes ship with zip by default
4074 ;; Do export. This creates a bunch of xml files ready to be
4075 ;; saved and zipped.
4077 ;; Create a manifest entry for content.xml.
4079 ;; Write mimetype file
4088 ;; Write out the manifest entries before zipping
4090 ;; Save all XML files.
4096 ;; Prettify output if needed.
4100 org-odt-xml-files)
4101 ;; Run zip.
4106 ;; If a file with same name as the desired output file
4107 ;; exists, remove it.
4110 ;; Zip up the xml files.
4113 ;; Switch temporarily to content.xml. This way Zip
4114 ;; process will inherit `org-odt-zip-dir' as the current
4115 ;; directory.
4129 err-string)))))
4130 cmds)))
4131 ;; Move the zip file from temporary work directory to
4132 ;; user-mandated location.
4135 ;; Cleanup work directory and work files.
4137 ;; Open the OpenDocument file in archive-mode for
4138 ;; examination.
4140 ;; Return exported file.
4142 ;; Case 1: Conversion desired on exported file. Run the
4143 ;; converter on the OpenDocument file. Return the
4144 ;; converted file.
4147 target))
4148 ;; Case 2: No further conversion. Return exported
4149 ;; OpenDocument file.
4152 ;; Cleanup work directory and work files.
4158 ;;;; Export to OpenDocument formula
4160 ;;;###autoload
4162 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4163 Use `org-create-math-formula' to convert LATEX-FRAG first to
4164 MathML. When invoked as an interactive command, use
4165 `org-latex-regexps' to infer LATEX-FRAG from currently active
4166 region. If no LaTeX fragments are found, prompt for it. Push
4167 MathML source to kill ring depending on the value of
4168 `org-export-copy-to-kill-ring'."
4194 filename
4207 ;; Add MathML to kill ring, if needed.
4211 ;;;###autoload
4213 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4214 Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4215 formula file."
4220 ;;;; Export to OpenDocument Text
4222 ;;;###autoload
4224 "Export current buffer to a ODT file.
4226 If narrowing is active in the current buffer, only export its
4227 narrowed part.
4229 If a region is active, export that region.
4231 A non-nil optional argument ASYNC means the process should happen
4232 asynchronously. The resulting file should be accessible through
4233 the `org-export-stack' interface.
4235 When optional argument SUBTREEP is non-nil, export the sub-tree
4236 at point, extracting information from the headline properties
4237 first.
4239 When optional argument VISIBLE-ONLY is non-nil, don't export
4240 contents of hidden elements.
4242 EXT-PLIST, when provided, is a property list with external
4243 parameters overriding Org default settings, but still inferior to
4244 file-local settings.
4246 Return output file's name."
4253 ,outfile
4258 ;; Let `htmlfontify' know that we are interested in
4259 ;; collecting styles.
4261 ;; Initialize content.xml and kick-off the export
4262 ;; process.
4275 outfile
4280 ;; Let `htmlfontify' know that we are interested in collecting
4281 ;; styles.
4283 ;; Initialize content.xml and kick-off the export process.
4293 ;;;; Convert between OpenDocument and other formats
4296 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4305 "Workhorse routine for `org-odt-convert'."
4314 in-fmt out-fmt)))
4342 out-file)
4345 nil))))
4348 "Return verbose info about formats to which IN-FMT can be converted.
4349 Return a list where each element is of the
4350 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4351 `org-odt-convert-processes' for CONVERTER-PROCESS and see
4352 `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4356 org-odt-convert-processes t))))
4360 org-odt-convert-processes t))
4361 org-odt-convert-capabilities))
4362 reachable-formats)
4367 reachable-formats))
4370 "Return list of formats to which IN-FMT can be converted.
4371 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4377 l))
4380 "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
4381 This is a helper routine for interactive use."
4384 nil buffer-file-name t))
4390 out-fmt-choices nil nil nil))
4392 "No known converter or no known output formats for %s files"
4393 in-fmt))))
4396 ;;;###autoload
4398 "Convert IN-FILE to format OUT-FMT using a command line converter.
4399 IN-FILE is the file to be converted. If unspecified, it defaults
4400 to variable `buffer-file-name'. OUT-FMT is the desired output
4401 format. Use `org-odt-convert-process' as the converter.
4402 If PREFIX-ARG is non-nil then the newly converted file is opened
4403 using `org-open-file'."
4408 ;;; Library Initializations
4412 ;; Let Emacs open all OpenDocument files in archive mode
4415 org-odt-file-extensions)
4419 ;; Local variables:
4420 ;; generated-autoload-file: "org-loaddefs.el"
4421 ;; End:
4423 ;;; ox-odt.el ends here