| blob | 373af4a15abcd4179eb134b7196244c53186df0c |
1 ;;; org-e-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 not part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
35 ;;; Define Back-End
89 org-e-odt--translate-description-lists
90 org-e-odt--translate-list-tables)))
91 :menu-entry
98 :options-alist
103 ;;; Dependencies
105 ;;; Hooks
107 ;;; Function Declarations
117 \f
118 ;;; Internal Variables
122 "Location of ODT exporter.
123 Use this to infer values of `org-e-odt-styles-dir' and
128 "Data directory for ODT exporter.
129 Use this to infer values of `org-e-odt-styles-dir' and
146 "List of directories to search for OpenDocument schema files.
147 Use this list to set the default value of
148 `org-e-odt-schema-dir'. The entries in this list are
149 populated heuristically based on the values of `org-e-odt-lib-dir'
162 )
163 "List of directories to search for OpenDocument styles files.
164 See `org-e-odt-styles-dir'. The entries in this list are populated
165 heuristically based on the values of `org-e-odt-lib-dir' and
182 styles-dir)
184 org-e-odt-styles-dir-list)
185 nil)))
188 styles-dir)
189 "Directory that holds auxiliary XML files used by the ODT exporter.
191 This directory contains the following XML files -
193 XML files are used as the default values of
194 `org-e-odt-styles-file' and
195 `org-e-odt-content-template-file'.
197 The default value of this variable varies depending on the
198 version of org in use and is initialized from
199 `org-e-odt-styles-dir-list'. Note that the user could be using org
200 from one of: org's own private git repository, GNU ELPA tar or
223 "
225 <style:table-properties style:rel-width=\"%d%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
226 </style:style>
227 "
231 "Registry of automatic styles for various OBJECT-TYPEs.
232 The variable has the following form:
233 \(\(OBJECT-TYPE-A
234 \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
235 \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
236 \(OBJECT-TYPE-B
237 \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
238 \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
239 ...\).
242 OBJECT-PROPS is (typically) a plist created by passing
248 "Running counters for various OBJECT-TYPEs.
249 Use this to generate automatic names and style-names. See
253 "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
254 <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
255 <style:background-image/>
256 </style:paragraph-properties>
258 </style:style>"
259 "Custom paragraph style for colorized source and example blocks.
261 except that the foreground and background colors are set
275 "Hardcoded image dimensions one for each of the anchor
278 ;; A4 page size is 21.0 by 29.7 cms
279 ;; The default page settings has 2cm margin on each of the sides. So
280 ;; the effective text area is 17.0 by 25.7 cm
289 "Specify how labels are applied and referenced.
290 This is an alist where each element is of the
291 form (LABEL-STYLE-NAME LABEL-ATTACH-FMT LABEL-REF-MODE
292 LABEL-REF-FMT).
294 LABEL-ATTACH-FMT controls how labels and captions are attached to
295 an entity. It may contain following specifiers - %e, %n and %c.
296 %e is replaced with the CATEGORY-NAME. %n is replaced with
298 with CAPTION. See `org-e-odt-format-label-definition'.
300 LABEL-REF-MODE and LABEL-REF-FMT controls how label references
301 are generated. The following XML is generated for a label
305 specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
306 %n is replaced with SEQNO. See
315 ;; ("__Table__" "Table" "category-and-value")
316 ;; ("__Figure__" "Figure" "category-and-value")
317 ;; ("__DvipngImage__" "Equation" "category-and-value")
318 )
319 "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
323 CATEGORY_HANDLE identifies the captionable entity in question.
325 OD-VARIABLE is the OpenDocument sequence counter associated with
326 the entity. These counters are declared within
328 `org-e-odt-content-template-file'.
330 LABEL-STYLE is a key into `org-e-odt-label-styles' and specifies
331 how a given entity should be captioned and referenced.
333 CATEGORY-NAME is used for qualifying captions on export. You can
334 modify the CATEGORY-NAME used in the exported document by
335 modifying `org-export-dictionary'. For example, an embedded
341 `:utf-8'.
343 ENUMERATOR-PREDICATE is used for assigning a sequence number to
353 \f
354 ;;; User Configuration Variables
357 "Options for exporting Org mode files to ODT."
362 ;;;; Debugging
365 "Specify whether or not the xml output should be prettified.
366 When this option is turned on, `indent-region' is run on all
367 component xml buffers before they are saved. Turn this off for
368 regular use. Turn this on if you need to examine the xml
369 visually."
375 ;;;; Document schema
387 schema-dir))
390 schema-dir))
394 schema-dir)
396 org-e-odt-schema-dir-list)
398 nil)))
399 schema-dir)
400 "Directory that contains OpenDocument schema files.
402 This directory contains:
403 1. rnc files for OpenDocument schema
405 for auto validation of OpenDocument XML files.
407 Use the customize interface to set this variable. This ensures
408 that `rng-schema-locating-files' is updated and auto-validation
409 of OpenDocument XML takes place based on the value
410 `rng-nxml-auto-validate-flag'.
412 The default value of this variable varies depending on the
413 version of org in use and is initialized from
414 `org-e-odt-schema-dir-list'. The OASIS schema files are available
415 only in the org's private git repository. It is *not* bundled
416 with GNU ELPA tar or standard Emacs distribution."
422 :set
424 "Set `org-e-odt-schema-dir'.
425 Also add it to `rng-schema-locating-files'."
435 schema-dir
438 value))
439 nil)))
444 org-e-odt-schema-dir))))))
447 ;;;; Document styles
451 The exporter embeds the exported content just before
455 under `org-e-odt-styles-dir' is used."
461 "Default styles file for use with ODT export.
462 Valid values are one of:
463 1. nil
464 2. path to a styles.xml file
465 3. path to a *.odt or a *.ott file
466 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
467 ...))
469 In case of option 1, an in-built styles.xml is used. See
470 `org-e-odt-styles-dir' for more information.
472 In case of option 3, the specified file is unzipped and the
473 styles.xml embedded therein is used.
475 In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
476 and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
477 generated odt file. Use relative path for specifying the
478 FILE-MEMBERS. styles.xml must be specified as one of the
479 FILE-MEMBERS.
481 Use options 1, 2 or 3 only if styles.xml alone suffices for
482 achieving the desired formatting. Use option 4, if the styles.xml
483 references additional files like header and footer images for
484 achieving the desired formatting.
487 a per-file basis. For example,
493 :type
505 "Outline levels considered for enumerating captioned entities."
510 ;;;; Document conversion
517 "Specify a list of document converters and their usage.
518 The converters in this list are offered as choices while
519 customizing `org-e-odt-convert-process'.
521 This variable is a list where each element is of the
522 form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
523 of the converter. CONVERTER-CMD is the shell command for the
524 converter and can contain format specifiers. These format
525 specifiers are interpreted as below:
527 %i input file name in full
528 %I input file name as a URL
529 %f format of the output file
530 %o output file name in full
531 %O output file name as a URL
532 %d output dir in full
533 %D output dir as a URL.
534 %x extra options as set in `org-e-odt-convert-capabilities'."
537 :type
546 During customization, the list of converter names are populated
547 from `org-e-odt-convert-processes'."
557 org-e-odt-convert-processes))))
575 "Specify input and output formats of `org-e-odt-convert-process'.
576 More correctly, specify the set of input and output formats that
577 the user is actually interested in.
579 This variable is an alist where each element is of the
580 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
581 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
582 alist where each element is of the form (OUTPUT-FMT
583 OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
585 The variable is interpreted as follows:
586 `org-e-odt-convert-process' can take any document that is in
587 INPUT-FMT-LIST and produce any document that is in the
588 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
589 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
590 serves dual purposes:
591 - It is used for populating completion candidates during
592 `org-e-odt-convert' commands.
594 `org-e-odt-convert-process'.
597 `org-e-odt-convert-process'.
599 DOCUMENT-CLASS is used to group a set of file formats in
600 INPUT-FMT-LIST in to a single class.
602 Note that this variable inherently captures how LibreOffice based
603 converters work. LibreOffice maps documents of various formats
604 to classes like Text, Web, Spreadsheet, Presentation etc and
605 allow document of a given class (irrespective of it's source
606 format) to be converted to any of the export formats associated
607 with that class.
609 See default setting of this variable for an typical
610 configuration."
613 :type
618 :value-type
622 :value-type
631 and then uses `org-e-odt-convert-process' to convert the
632 resulting document to this format. During customization of this
633 variable, the list of valid values are populated based on
634 `org-e-odt-convert-capabilities'.
636 You can set this option on per-file basis using file local
637 values. See Info node `(emacs) File Variables'."
648 ;;;###autoload
652 ;;;; Drawers
655 "Function called to format a drawer in ODT code.
657 The function must accept two parameters:
659 CONTENTS the contents of the drawer.
661 The function should return the string to be exported.
663 For example, the variable could be set to the following function
664 in order to mimic default behaviour:
666 \(defun org-e-odt-format-drawer-default \(name contents\)
668 contents\)"
673 ;;;; Headline
676 "Function to format headline text.
678 This function will be called with 5 arguments:
679 TODO the todo keyword \(string or nil\).
680 TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
681 PRIORITY the priority of the headline \(integer or nil\)
682 TEXT the main headline text \(string\).
683 TAGS the tags string, separated with colons \(string or nil\).
685 The function result will be used as headline text."
690 ;;;; Inlinetasks
693 "Function called to format an inlinetask in ODT code.
695 The function must accept six parameters:
696 TODO the todo keyword, as a string
697 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
698 PRIORITY the inlinetask priority, as a string
699 NAME the inlinetask name, as a string.
700 TAGS the inlinetask tags, as a string.
701 CONTENTS the contents of the inlinetask, as a string.
703 The function should return the string to be exported."
708 ;;;; Links
712 "Rules characterizing formula files that can be inlined into ODT.
714 A rule consists in an association whose key is the type of link
715 to consider, and value is a regexp that will be matched against
716 link's path."
723 "Rules characterizing image files that can be inlined into ODT.
725 A rule consists in an association whose key is the type of link
726 to consider, and value is a regexp that will be matched against
727 link's path."
733 "Scaling factor for converting images pixels to inches.
734 Use this for sizing of embedded images. See Info node `(org)
735 Images in ODT export' for more information."
741 ;;;; Src Block
744 "Whether custom styles for colorized source blocks be automatically created.
745 When this option is turned on, the exporter creates custom styles
746 for source blocks based on the advice of `htmlfontify'. Creation
747 of custom styles happen as part of `org-e-odt-hfy-face-to-css'.
749 When this option is turned off exporter does not create such
750 styles.
752 Use the latter option if you do not want the custom styles to be
753 based on your current display settings. It is necessary that the
754 styles.xml already contains needed styles for colorizing to work.
756 This variable is effective only if
757 `org-e-odt-fontify-srcblocks' is turned on."
763 "Specify whether or not source blocks need to be fontified.
764 Turn this option on if you want to colorize the source code
765 blocks in the exported file. For colorization to work, you need
766 to make available an enhanced version of `htmlfontify' library."
772 ;;;; Table
785 "Specify how Table Styles should be derived from a Table Template.
786 This is a list where each element is of the
787 form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
789 TABLE-STYLE-NAME is the style associated with the table through
792 TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
793 TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
794 below) that is included in
795 `org-e-odt-content-template-file'.
797 TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
799 PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
807 TABLE-CELL-OPTIONS is an alist where each element is of the
808 form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
809 TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
810 `use-last-row-styles' |
811 `use-first-column-styles' |
812 `use-last-column-styles' |
813 `use-banding-rows-styles' |
814 `use-banding-columns-styles' |
815 `use-first-row-styles'
816 ON-OR-OFF := `t' | `nil'
818 For example, with the following configuration
820 \(setq org-e-odt-table-styles
822 \(\(use-first-row-styles . t\)
823 \(use-first-column-styles . t\)\)\)
825 \(\(use-first-column-styles . t\)\)\)\)\)
828 style will use the following table-cell styles -
833 as appropriate.
836 use the following table-cell styles -
838 following paragraph styles
840 as appropriate..
842 Note that TABLE-TEMPLATE-NAME corresponds to the
845 TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
848 specification for more information. Also consult the
849 implementation filed under `org-e-odt-get-table-cell-styles'.
852 formatting of numbered display equations. Do not delete this
853 style from the list."
863 use-last-row-styles
864 use-first-column-styles
865 use-last-column-styles
866 use-banding-rows-styles
867 use-banding-columns-styles)
868 :key-type symbol
871 ;;;; Timestamps
874 "Non-nil, if timestamps should be exported as date fields.
876 When nil, export timestamps as plain text.
878 When non-nil, map `org-time-stamp-custom-formats' to a pair of
880 respectively. A timestamp with no time component is formatted
884 This feature is experimental. Most (but not all) of the common
885 %-specifiers in `format-time-string' are supported.
887 formatted as canonical Org timestamps. For finer control, avoid
888 these %-specifiers.
891 etc., are displayed by the application in the default language
892 and country specified in `org-e-odt-styles-file'. Note that the
894 can localize the week day and month strings in the exported
895 document by setting the default language and country either using
896 the application UI or through a custom styles file.
898 See `org-e-odt--build-date-styles' for implementation details."
903 \f
904 ;;; Internal functions
906 ;;;; Date
921 ;; LibreOffice does not care about end goes as content
922 ;; within the "<text:date>...</text:date>" field. The
923 ;; displayed date is automagically corrected to match the
924 ;; format requested by "style:data-style-name" attribute. So
925 ;; don't bother about formatting the date contents to be
926 ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
927 ;; simple Org-style date should suffice.
952 (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
953 iso-date style date)
955 repeater)))))
957 ;;;; Frame
965 extra
969 style frame-attrs
981 ;;;; Library wrappers
988 ;; This is shamelessly stolen from `archive-zip-extract'.
994 name)))
999 exit-code command-output)
1007 members))
1010 ;; See comments in `org-e-odt-format-label' and `org-e-odt-toc'.
1013 ;; Override translators.
1014 :translate-alist
1018 ;; Reset data translation cache. FIXME.
1019 ;; :exported-data nil
1020 )))
1023 ;;;; Target
1032 ;;;; Textbox
1035 extra anchor-type)
1041 text)
1042 width nil style extra anchor-type))
1046 ;;;; Table of Contents
1051 <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">
1053 <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
1060 "
1061 <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
1063 <text:index-entry-chapter/>
1064 <text:index-entry-text/>
1065 <text:index-entry-link-end/>
1066 </text:table-of-content-entry-template>
1070 </text:table-of-content-source>
1072 <text:index-body>
1075 </text:index-title>
1080 </text:index-body>
1081 </text:table-of-content>
1089 ;; Section number.
1091 ;; Todo.
1096 style todo)))
1101 style priority)))
1102 ;; Title.
1103 text
1104 ;; Tags.
1108 "OrgTags"
1115 headline-label text))
1119 ;; When a headline is marked as a radio target, as in the example below:
1120 ;;
1121 ;; ** <<<Some Heading>>>
1122 ;; Some text.
1123 ;;
1124 ;; suppress generation of radio targets. i.e., Radio targets are to
1125 ;; be marked as targets within /document body/ and *not* within
1126 ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
1127 ;; and one in the document body.
1128 ;;
1129 ;; FIXME-1: Currently exported headings are memoized. `org-export.el'
1130 ;; doesn't provide a way to disable memoization. So this doesn't
1131 ;; work.
1132 ;;
1133 ;; FIXME-2: Are there any other objects that need to be suppressed
1134 ;; within TOC?
1141 contents)))
1150 headline translations info
1155 style entry)))
1160 ;;;; Document styles
1163 "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
1164 OBJECT-PROPS is (typically) a plist created by passing
1166 `org-e-odt-parse-block-attributes'.
1168 Use `org-e-odt-object-counters' to generate an automatic
1169 OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
1170 new entry in `org-e-odt-automatic-styles'. Return (OBJECT-NAME
1171 . STYLE-NAME)."
1187 ;;;; Checkbox
1190 "Return check-box string associated to ITEM."
1199 ;;; Template
1202 ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
1203 ;; to modify the date fields. A date could be modified by
1204 ;; offsetting in days. That's about it. Also, date and time may
1205 ;; have to be emitted as two fields - a date field and a time field
1206 ;; - separately.
1208 ;; One can add Form Controls to date and time fields so that they
1209 ;; can be easily modified. But then, the exported document will
1210 ;; become tightly coupled with LibreOffice and may not function
1211 ;; properly with other OpenDocument applications.
1213 ;; I have a strange feeling that Date styles are a bit flaky at the
1214 ;; moment.
1216 ;; The feature is experimental.
1262 ))
1270 filler-end))
1281 style
1284 output ))))
1287 "Return complete document string after ODT conversion.
1288 CONTENTS is the transcoded contents string. RAW-DATA is the
1289 original parsed data. INFO is a plist holding export options."
1290 ;; Write meta file.
1300 <office:document-meta
1310 ;; Date, if required.
1312 ;; Check if DATE is specified as an Org-timestamp. If yes,
1313 ;; include it as meta information. Otherwise, just use
1314 ;; today's date.
1323 iso-date)))))
1334 ;; Add meta.xml in to manifest.
1337 ;; Update styles file.
1338 ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
1339 ;; Write styles file.
1342 ;; Non-availability of styles.xml is not a critical
1343 ;; error. For now, throw an error.
1345 org-e-odt-styles-file
1347 org-e-odt-styles-dir)
1360 members)))
1370 org-e-odt-styles-file))))
1372 ;; create a manifest entry for styles.xml
1375 ;; FIXME: Who is opening an empty styles.xml before this point?
1380 ;; Write custom styles for source blocks
1381 ;; Save STYLES used for colorizing of source blocks.
1382 ;; Update styles.xml with styles that were collected as part of
1383 ;; `org-e-odt-hfy-face-to-css' callbacks.
1392 ;; Update styles.xml - take care of outline numbering
1394 ;; Don't make automatic backup of styles.xml file. This setting
1395 ;; prevents the backed-up styles.xml file from being zipped in to
1396 ;; odt file. This is more of a hackish fix. Better alternative
1397 ;; would be to fix the zip command so that the output odt file
1398 ;; includes only the needed files and excludes any auto-generated
1399 ;; extra files like backups and auto-saves etc etc. Note that
1400 ;; currently the zip command zips up the entire temp directory so
1401 ;; that any auto-generated files created under the hood ends up in
1402 ;; the resulting odt file.
1405 ;; Outline numbering is retained only upto LEVEL.
1406 ;; To disable outline numbering pass a LEVEL of 0.
1419 ;; Update content.xml.
1422 ;; within the context of the Org buffer. So obtain it's
1423 ;; value before moving on to temp-buffer context down below.
1433 org-e-odt-styles-dir)))
1434 ;; Write automatic styles.
1435 ;; - Position the cursor.
1439 ;; - Dump automatic table styles.
1444 ;; - Dump date-styles.
1450 ;; Update display level.
1451 ;; - Remove existing sequence decls. Also position the cursor.
1456 ;; Update sequence decls according to user preference.
1466 ;; Position the cursor to document body.
1471 ;; Preamble - Title, Author, Date etc.
1478 ;; Switch on or off above vars based on user settings
1482 ;; Title.
1487 ;; Separator.
1491 ;; Author only.
1494 "OrgSubtitle"
1496 ;; Separator.
1499 ;; Author and E-mail.
1503 "OrgSubtitle"
1508 ;; Separator.
1510 ;; Date, if required.
1513 ;; Check if DATE is specified as a timestamp.
1519 "OrgSubtitle"
1523 ;; Separator
1525 ;; Table of Contents
1528 with-toc
1531 ;; Contents.
1533 ;; Return contents.
1537 \f
1538 ;;; Transcode Functions
1540 ;;;; Bold
1543 "Transcode BOLD from Org to ODT.
1544 CONTENTS is the text with bold markup. INFO is a plist holding
1545 contextual information."
1550 ;;;; Center Block
1553 "Transcode a CENTER-BLOCK element from Org to ODT.
1554 CONTENTS holds the contents of the center block. INFO is a plist
1555 holding contextual information."
1556 contents)
1559 ;;;; Clock
1562 "Transcode a CLOCK element from Org to ODT.
1563 CONTENTS is nil. INFO is a plist used as a communication
1564 channel."
1577 ;;;; Code
1580 "Transcode a CODE object from Org to ODT.
1581 CONTENTS is nil. INFO is a plist used as a communication
1582 channel."
1587 ;;;; Comment
1589 ;; Comments are ignored.
1592 ;;;; Comment Block
1594 ;; Comment Blocks are ignored.
1597 ;;;; Drawer
1600 "Transcode a DRAWER element from Org to ODT.
1601 CONTENTS holds the contents of the block. INFO is a plist
1602 holding contextual information."
1606 name contents)
1607 ;; If there's no user defined function: simply
1608 ;; display contents of the drawer.
1609 contents)))
1610 output))
1613 ;;;; Dynamic Block
1616 "Transcode a DYNAMIC-BLOCK element from Org to ODT.
1617 CONTENTS holds the contents of the block. INFO is a plist
1618 holding contextual information. See `org-export-data'."
1619 contents)
1622 ;;;; Entity
1625 "Transcode an ENTITY object from Org to ODT.
1626 CONTENTS are the definition itself. INFO is a plist holding
1627 contextual information."
1631 ;;;; Example Block
1634 "Transcode a EXAMPLE-BLOCK element from Org to ODT.
1635 CONTENTS is nil. INFO is a plist holding contextual information."
1639 ;;;; Export Snippet
1642 "Transcode a EXPORT-SNIPPET object from Org to ODT.
1643 CONTENTS is nil. INFO is a plist holding contextual information."
1648 ;;;; Export Block
1651 "Transcode a EXPORT-BLOCK element from Org to ODT.
1652 CONTENTS is nil. INFO is a plist holding contextual information."
1657 ;;;; Fixed Width
1660 "Transcode a FIXED-WIDTH element from Org to ODT.
1661 CONTENTS is nil. INFO is a plist holding contextual information."
1665 ;;;; Footnote Definition
1667 ;; Footnote Definitions are ignored.
1670 ;;;; Footnote Reference
1673 "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
1674 CONTENTS is nil. INFO is a plist holding contextual information."
1684 id note-class
1697 "OrgSuperscript"
1698 (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
1699 note-class ref-format ref-name n)))))))
1701 ;; Insert separator between two footnotes in a row.
1706 ;; Trancode footnote reference.
1711 ;; Inline definitions are secondary strings.
1712 ;; Non-inline footnotes definitions are full Org data.
1715 info))
1723 ;;;; Headline
1729 ;; Todo.
1733 style todo)))
1738 style priority)))
1739 ;; Title.
1740 text
1741 ;; Tags.
1744 "<text:tab/>"
1753 &optional format-function
1755 "Transcode an HEADLINE element from Org to ODT.
1756 CONTENTS holds the contents of the headline. INFO is a plist
1757 holding contextual information."
1767 todo translations info)))))
1784 todo todo-type priority text tags))))
1787 todo todo-type priority text tags
1792 "Transcode an HEADLINE element from Org to ODT.
1793 CONTENTS holds the contents of the headline. INFO is a plist
1794 holding contextual information."
1795 ;; Case 1: This is a footnote section: ignore it.
1798 ;; Create the headline text.
1800 ;; Get level relative to current parsed data.
1802 ;; Get canonical label for the headline.
1806 ;; Get user-specified labels for the headline.
1809 ;; Extra targets.
1817 ;; Title.
1820 ;; Case 2. This is a deep sub-tree: export it as a list item.
1821 ;; Also export as items headlines for which no section
1822 ;; format has been found.
1824 ;; Build the real contents of the sub-tree.
1828 ;; Choose style based on list type.
1831 ;; If top-level list, re-start numbering. Otherwise,
1832 ;; continue numbering.
1835 headline)))
1845 "Text_20_body"
1847 contents)
1849 "</text:list-header>"
1853 ;; Case 3. Standard headline. Export it as a section.
1859 level
1861 contents))))))
1864 ;;;; Horizontal Rule
1867 "Transcode an HORIZONTAL-RULE object from Org to ODT.
1868 CONTENTS is nil. INFO is a plist holding contextual information."
1873 ;;;; Inline Babel Call
1875 ;; Inline Babel Calls are ignored.
1878 ;;;; Inline Src Block
1881 "Return a character not used in string S.
1883 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
1889 "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
1890 CONTENTS holds the contents of the item. INFO is a plist holding
1891 contextual information."
1898 ;;;; Inlinetask
1901 "Transcode an INLINETASK element from Org to ODT.
1902 CONTENTS holds the contents of the block. INFO is a plist
1903 holding contextual information."
1905 ;; If `org-e-odt-format-inlinetask-function' is provided, call it
1906 ;; with appropriate arguments.
1913 todo todo-type priority text tags contents)))))
1916 ;; Otherwise, use a default template.
1919 "Text_20_body"
1923 "OrgInlineTaskHeading"
1925 contents)
1928 ;;;; Italic
1931 "Transcode ITALIC from Org to ODT.
1932 CONTENTS is the text with italic markup. INFO is a plist holding
1933 contextual information."
1938 ;;;; Item
1941 "Transcode an ITEM element from Org to ODT.
1942 CONTENTS holds the contents of the item. INFO is a plist holding
1943 contextual information."
1954 contents
1966 ;;;; Keyword
1969 "Transcode a KEYWORD element from Org to ODT.
1970 CONTENTS is nil. INFO is a plist holding contextual information."
1976 ;; FIXME
1988 ;; FIXME
1992 ;;;; Latex Environment
1998 ;; (defadvice org-format-latex-as-mathml ; FIXME
1999 ;; (after org-e-odt-protect-latex-fragment activate)
2000 ;; "Encode LaTeX fragment as XML.
2001 ;; Do this when translation to MathML fails."
2002 ;; (when (or (not (> (length ad-return-value) 0))
2003 ;; (get-text-property 0 'org-protected ad-return-value))
2004 ;; (setq ad-return-value
2005 ;; (org-propertize (org-e-odt--encode-plain-text (ad-get-arg 0))
2006 ;; 'org-protected t))))
2009 "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
2010 CONTENTS is nil. INFO is a plist holding contextual information."
2016 ;;;; Latex Fragment
2018 ;; (when latex-frag ; FIXME
2019 ;; (setq href (org-propertize href :title "LaTeX Fragment"
2020 ;; :description latex-frag)))
2021 ;; handle verbatim
2022 ;; provide descriptions
2025 "Transcode a LATEX-FRAGMENT object from Org to ODT.
2026 CONTENTS is nil. INFO is a plist holding contextual information."
2033 ;;;; Line Break
2036 "Transcode a LINE-BREAK object from Org to ODT.
2037 CONTENTS is nil. INFO is a plist holding contextual information."
2041 ;;;; Link
2043 ;;;; Links :: Label references
2054 x)))))
2066 counter))
2073 ;; Section number.
2077 ;; Separator.
2079 ;; Ordinal.
2081 tag))
2089 ;; Get label and caption.
2093 ;; Transcode captions.
2095 ;; Currently short caption are sneaked in as object names.
2096 ;;
2097 ;; The advantages are:
2098 ;;
2099 ;; - Table Of Contents: Currently, there is no support for
2100 ;; building TOC for figures, listings and tables. See
2101 ;; `org-e-odt-keyword'. User instead has to rely on
2102 ;; external application for building such indices. Within
2103 ;; LibreOffice, building an "Illustration Index" or "Index
2104 ;; of Tables" will create a table with long captions (only)
2105 ;; and building a table with "Object names" will create a
2106 ;; table with short captions.
2107 ;;
2108 ;; - Easy navigation: In LibreOffice, object names are
2109 ;; offered via the navigation bar. This way one can
2110 ;; quickly locate and jump to object of his choice in the
2111 ;; exported document.
2112 ;;
2113 ;; The main disadvantage is that there cannot be any markups
2114 ;; within object names i.e., one cannot embolden, italicize
2115 ;; or underline text within short caption. So suppress
2116 ;; generation of <text:span >...</text:span> and other
2117 ;; markups by overriding the default translators. We
2118 ;; probably shouldn't be suppressing translators for all
2119 ;; elements in `org-element-all-objects', but for now this
2120 ;; will do.
2126 contents)))
2127 org-element-all-objects)
2131 translations info)))))
2146 element))))
2149 seqno)
2153 ;; Compute sequence number of the element.
2155 ;; Localize category string.
2158 ;; Case 1: Handle Label definition.
2160 ;; Assign an internal label, if user has not provided one
2165 ;; Sneak in a bookmark. The bookmark is used when the
2166 ;; labeled element is referenced with a link that
2167 ;; provides it's own description.
2169 ;; Label definition: Typically formatted as below:
2170 ;; CATEGORY SEQ-NO: LONG CAPTION
2175 "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
2176 label counter counter seqno))
2178 short-caption))
2179 ;; Case 2: Handle Label reference.
2186 (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
2192 ;;;; Links :: Inline Images
2195 "Returns the internal name of the file"
2211 target-file))
2214 user-height scale dpi embed-as)
2234 ;; Use Imagemagick.
2239 file))))
2244 ;; Use Emacs.
2250 ;; Use hard-coded values.
2252 org-e-odt-default-image-sizes-alist))
2253 ;; Error out.
2266 ;; ensure that an embedded image fits comfortably within a page
2277 "Return ODT code for an inline image.
2278 LINK is the link pointing to the inline image. INFO is a plist
2279 used as a communication channel."
2292 "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
2294 ;; Extract attributes from #+ATTR_ODT line.
2298 ;; Convert attributes to a plist.
2300 ;; Handle `:anchor', `:style' and `:attributes' properties.
2310 ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
2311 ;; extrac
2312 ;; handle `:width', `:height' and `:scale' properties.
2318 ))
2325 ;; Check if this link was created by LaTeX-to-PNG converter.
2329 ;; If yes, note down the type of the element - LaTeX Fragment
2330 ;; or LaTeX environment. It will go in to frame title.
2334 ;; If yes, note down it's contents. It will go in to frame
2335 ;; description. This quite useful for debugging.
2338 captions user-frame-params title desc)))
2341 ;;;; Links :: Math formula
2362 ;; Check if this link was created by LaTeX-to-MathML
2363 ;; converter.
2367 ;; If yes, note down the type of the element - LaTeX Fragment
2368 ;; or LaTeX environment. It will go in to frame title.
2372 ;; If yes, note down it's contents. It will go in to frame
2373 ;; description. This quite useful for debugging.
2375 width height)
2379 nil nil title desc))
2382 "CaptionedDisplayFormula" href width height
2383 captions nil title desc))
2387 org-e-odt--enumerable-formula-p))))
2392 "Returns the internal name of the file"
2396 ;; Create a directory for holding formula file. Also enter it in
2397 ;; to manifest.
2401 ;; Copy over the formula file from user directory to zip
2402 ;; directory.
2406 ;; Case 1: Mathml.
2409 ;; Case 2: OpenDocument formula.
2414 ;; Enter the formula file in to manifest.
2416 target-file))
2418 ;;;; Targets
2421 captions user-frame-params
2424 ;; Each element of this alist is of the form (CFG-HANDLE
2425 ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
2427 ;; CFG-HANDLE is the key to the alist.
2429 ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
2430 ;; frame params for INNER-FRAME and OUTER-FRAME
2431 ;; respectively. See below.
2433 ;; Configurations that are meant to be applied to
2434 ;; non-captioned image/formula specifies no
2435 ;; OUTER-FRAME-PARAMS.
2437 ;; TERMINOLOGY
2438 ;; ===========
2439 ;; INNER-FRAME :: Frame that directly surrounds an
2440 ;; image/formula.
2442 ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
2443 ;; frame also contains the caption, if any.
2445 ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
2446 ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
2447 ;; that these are the last three arguments
2448 ;; to `org-e-odt--frame'.
2450 ;; Note that an un-captioned image/formula requires just an
2451 ;; INNER-FRAME, while a captioned image/formula requires
2452 ;; both an INNER and an OUTER-FRAME.
2474 ;; Retrieve inner and outer frame params, from configuration.
2478 ;; User-specified frame params (from #+ATTR_ODT spec)
2482 "Merge default and user frame params."
2487 for d in default
2490 ;; Case 1: Image/Formula has no caption.
2491 ;; There is only one frame, one that surrounds the image
2492 ;; or formula.
2494 ;; Merge user frame params with that from configuration.
2498 ;; Case 2: Image/Formula is captioned or labeled.
2499 ;; There are two frames: The inner one surrounds the
2500 ;; image or formula. The outer one contains the
2501 ;; caption/sequence number.
2503 ;; Merge user frame params with outer frame params.
2505 ;; Short caption, if specified, goes as part of inner frame.
2512 frame-params))
2515 "Illustration"
2519 caption))
2520 width height outer)))))
2523 ;; Element should have a caption or label.
2529 element info
2530 ;; Paragraph should have a caption or label. It SHOULD NOT be a
2531 ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
2532 ;; processing.)
2537 ;; Link should point to an image file.
2544 element info
2545 ;; Paragraph should have a caption or label. It SHOULD also be a
2546 ;; replacement element. (i.e., It SHOULD be a result of LaTeX
2547 ;; processing.)
2552 ;; Link should point to an image file.
2559 element info
2560 ;; Paragraph should have a caption or label.
2564 ;; Link should point to a MathML or ODF file.
2570 paragraph-predicate
2571 link-predicate)
2572 "Test if ELEMENT is a standalone link for the purpose ODT export.
2573 INFO is a plist holding contextual information.
2575 Return non-nil, if ELEMENT is of type paragraph satisfying
2576 PARAGRAPH-PREDICATE and it's sole content, save for whitespaces,
2577 is a link that satisfies LINK-PREDICATE.
2579 Return non-nil, if ELEMENT is of type link satisfying
2580 LINK-PREDICATE and it's containing paragraph satisfies
2581 PARAGRAPH-PREDICATE inaddtion to having no other content save for
2582 leading and trailing whitespaces.
2584 Return nil, otherwise."
2607 ;; DESTINATION is a HEADLINE, a "<<target>>" or an element (like
2608 ;; paragraph, verse-block etc) to which a "#+NAME: label" can be
2609 ;; attached. Note that labels that are attached to captioned
2610 ;; entities - inline images, math formulae and tables - get resolved
2611 ;; as part of `org-e-odt-format-label' and `org-e-odt--enumerate'.
2613 ;; Create a cross-reference to DESTINATION but make best-efforts to
2614 ;; create a *meaningful* description. Check item numbers, section
2615 ;; number and section title in that order.
2617 ;; NOTE: Counterpart of `org-export-get-ordinal'.
2618 ;; FIXME: Handle footnote-definition footnote-reference?
2634 return x))
2635 ;; Get list item nos.
2640 plain-list)
2643 item info t))))))
2644 ;; Locate top-most listified headline.
2649 return x))
2650 ;; Get listified headline numbers.
2656 el info t)))))))
2657 ;; Combine item numbers from both the listified headlines and
2658 ;; regular list items.
2660 ;; Case 1: Check if all the parents of list item are numbered.
2661 ;; If yes, link to the item proper.
2664 (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
2669 ;; Case 2: Locate a regular and numbered headline in the
2670 ;; hierarchy. Display it's section number.
2675 return el)))
2676 ;; We found one.
2678 (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2682 ;; Case 4: Locate a regular headline in the hierarchy. Display
2683 ;; it's title.
2687 return el)))
2688 ;; We found one.
2690 (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2697 "Transcode a LINK object from Org to ODT.
2699 DESC is the description part of the link, or the empty string.
2700 INFO is a plist holding contextual information. See
2701 `org-export-data'."
2704 ;; Ensure DESC really exists, or set it to nil.
2707 link org-e-odt-inline-image-rules))
2716 protocol)
2718 ;; Image file.
2720 link org-e-odt-inline-image-rules))
2722 ;; Formula file.
2724 link org-e-odt-inline-formula-rules))
2726 ;; Radio target: Transcode target's contents and use them as
2727 ;; link's description.
2734 "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2735 href desc)))))
2736 ;; Links pointing to an headline: Find destination and build
2737 ;; appropriate referencing command.
2743 ;; Case 1: Fuzzy link points nowhere.
2749 ;; Case 2: Fuzzy link points to an invisible target. Strip it.
2751 ;; Case 3: LINK points to an headline.
2753 ;; Case 3.1: LINK has a custom description that is
2754 ;; different from headline's title. Create a hyperlink.
2759 destination)))))
2761 destination info))
2765 label desc))))
2766 ;; Case 4: LINK points to an Inline image, Math formula or a Table.
2771 ;; Case 4.1: LINK has no description. Create a
2772 ;; cross-reference showing entity's sequence number.
2774 ;; Case 4.2: LINK has description. Insert a hyperlink
2775 ;; with user-provided description.
2778 destination))
2780 ;; Get label and caption.
2784 ;; Case 5: Fuzzy link points to a TARGET.
2786 ;; Case 5.1: LINK has description. Create a hyperlink.
2791 ;; LINK has no description. It points to either a HEADLINE, a
2792 ;; TARGET or an ELEMENT with a #+NAME: LABEL attached to it.
2793 ;; LINK to DESTINATION, but make a best effort to provide a
2794 ;; *meaningful* description.
2796 ;; Coderef: replace link with the reference name or the
2797 ;; equivalent line number.
2804 "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
2805 href line-no))))
2806 ;; Link type is handled by a special function.
2809 ;; External link with a description part.
2812 ;; Check if description is a link to an inline image.
2817 desc-element org-e-odt-inline-image-rules))))
2818 ;; Format link as a clickable image.
2820 path desc)
2821 ;; Otherwise, format it as a regular link.
2823 path desc))))
2824 ;; External link without a description part.
2827 path path))
2828 ;; No path, only description. Try to do something useful.
2833 ;;;; Paragraph
2836 "Transcode a PARAGRAPH element from Org to ODT.
2837 CONTENTS is the contents of the paragraph, as a string. INFO is
2838 the plist used as a communication channel."
2847 ;; If this paragraph is a leading paragraph in an item and the
2848 ;; item has a checkbox, splice the checkbox and paragraph contents
2849 ;; together.
2857 ;;;; Plain List
2860 "Transcode a PLAIN-LIST element from Org to ODT.
2861 CONTENTS is the contents of the list. INFO is a plist holding
2862 contextual information."
2864 ;; Choose style based on list type.
2870 ;; If top-level list, re-start numbering. Otherwise,
2871 ;; continue numbering.
2876 contents))
2878 ;;;; Plain Text
2891 line))
2902 "Transcode a TEXT string from Org to ODT.
2903 TEXT is the string to transcode. INFO is a plist holding
2904 contextual information."
2906 ;; Protect &, < and >.
2908 ;; Handle smart quotes. Be sure to provide original string since
2909 ;; OUTPUT may have been modified.
2911 ;; Convert special strings.
2917 org-e-odt-special-string-regexps))
2918 ;; Handle break preservation if required.
2922 ;; Return value.
2923 output))
2926 ;;;; Planning
2929 "Transcode a PLANNING element from Org to ODT.
2930 CONTENTS is nil. INFO is a plist used as a communication
2931 channel."
2933 "OrgPlanning"
2955 ;;;; Property Drawer
2958 "Transcode a PROPERTY-DRAWER element from Org to ODT.
2959 CONTENTS is nil. INFO is a plist holding contextual
2960 information."
2961 ;; The property drawer isn't exported but we want separating blank
2962 ;; lines nonetheless.
2966 ;;;; Quote Block
2969 "Transcode a QUOTE-BLOCK element from Org to ODT.
2970 CONTENTS holds the contents of the block. INFO is a plist
2971 holding contextual information."
2972 contents)
2975 ;;;; Quote Section
2978 "Transcode a QUOTE-SECTION element from Org to ODT.
2979 CONTENTS is nil. INFO is a plist holding contextual information."
2985 ;;;; Section
2990 style
2992 text)))
2996 "Transcode a SECTION element from Org to ODT.
2997 CONTENTS holds the contents of the section. INFO is a plist
2998 holding contextual information."
2999 contents)
3001 ;;;; Radio Target
3004 "Transcode a RADIO-TARGET object from Org to ODT.
3005 TEXT is the text of the target. INFO is a plist holding
3006 contextual information."
3012 ;;;; Special Block
3015 "Transcode a SPECIAL-BLOCK element from Org to ODT.
3016 CONTENTS holds the contents of the block. INFO is a plist
3017 holding contextual information."
3021 ;; Annotation.
3027 ;; FIXME: Is `car' right thing to do below?
3031 "Text_20_body"
3039 contents)))))
3040 ;; Textbox.
3049 style extra anchor))))
3053 ;;;; Src Block
3056 "Create custom style for face FN.
3057 When FN is the default face, use it's foreground and background
3059 use it's color attribute to create a character style whose name
3060 is obtained from FN. Currently all attributes of FN other than
3061 color are ignored.
3063 The style name for a face FN is derived using the following
3064 operations on the face name in that order - de-dash, CamelCase
3066 `font-lock-function-name-face' is associated with
3081 background-color-val color-val))
3084 "
3115 org-e-odt-fontify-srcblocks
3132 code
3143 par-style loc))
3146 num-start refs))
3160 ;; Extract code and references.
3164 ;; Does the src block contain labels?
3166 ;; Does it have line numbers?
3173 "Transcode a SRC-BLOCK element from Org to ODT.
3174 CONTENTS holds the contents of the item. INFO is a plist holding
3175 contextual information."
3187 "Text_20_body"
3191 ;;;; Statistics Cookie
3194 "Transcode a STATISTICS-COOKIE object from Org to ODT.
3195 CONTENTS is nil. INFO is a plist holding contextual information."
3201 ;;;; Strike-Through
3204 "Transcode STRIKE-THROUGH from Org to ODT.
3205 CONTENTS is the text with strike-through markup. INFO is a plist
3206 holding contextual information."
3211 ;;;; Subscript
3214 "Transcode a SUBSCRIPT object from Org to ODT.
3215 CONTENTS is the contents of the object. INFO is a plist holding
3216 contextual information."
3221 ;;;; Superscript
3224 "Transcode a SUPERSCRIPT object from Org to ODT.
3225 CONTENTS is the contents of the object. INFO is a plist holding
3226 contextual information."
3231 ;;;; Table Cell
3240 "Retrieve styles applicable to a table cell.
3241 R and C are (zero-based) row and column numbers of the table
3242 cell. STYLE-SPEC is an entry in `org-e-odt-table-styles'
3243 applicable to the current table. It is `nil' if the table is not
3244 associated with any style attributes.
3246 Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
3248 When STYLE-SPEC is nil, style the table cell the conventional way
3249 - choose cell borders based on row and column groupings and
3250 choose paragraph alignment based on `org-col-cookies' text
3251 property. See also
3252 `org-e-odt-get-paragraph-style-cookie-for-table-cell'.
3254 When STYLE-SPEC is non-nil, ignore the above cookie and return
3255 styles congruent with the ODF-1.2 specification."
3261 info)))
3263 ;; LibreOffice - particularly the Writer - honors neither table
3264 ;; templates nor custom table-cell styles. Inorder to retain
3265 ;; inter-operability with LibreOffice, only automatic styles are
3266 ;; used for styling of table-cells. The current implementation is
3267 ;; congruent with ODF-1.2 specification and hence is
3268 ;; future-compatible.
3270 ;; Additional Note: LibreOffice's AutoFormat facility for tables -
3271 ;; which recognizes as many as 16 different cell types - is much
3272 ;; richer. Unfortunately it is NOT amenable to easy configuration
3273 ;; by hand.
3300 "Transcode a TABLE-CELL element from Org to ODT.
3301 CONTENTS is nil. INFO is a plist used as a communication
3302 channel."
3309 table-cell info))
3331 table-cell info))))))
3335 custom-style-prefix))
3337 "OrgTblCell"
3353 cell-attributes
3356 org-element-all-elements)
3357 contents
3359 paragraph-style contents))))
3366 ;;;; Table Row
3369 "Transcode a TABLE-ROW element from Org to ODT.
3370 CONTENTS is the contents of the row. INFO is a plist used as a
3371 communication channel."
3372 ;; Rules are ignored since table separators are deduced from
3373 ;; borders of the current row.
3379 ;; If the row belongs to the first rowgroup and the
3380 ;; table has more than one row groups, then this row
3381 ;; belongs to the header row group.
3383 ;; Otherwise, it belongs to non-header row group.
3386 ;; Does this row begin a rowgroup?
3389 ;; Actual table row
3391 ;; Does this row end a rowgroup?
3396 ;;;; Table
3401 table 'table-row
3410 "Transcode a TABLE element from Org to ODT.
3411 CONTENTS is the contents of the table. INFO is a plist holding
3412 contextual information."
3414 ;; Case 1: table.el doesn't support export to OD format. Strip
3415 ;; such tables from export.
3420 "(org-e-odt): Found table.el-type table in the source Org file."
3421 " table.el doesn't support export to ODT format."
3423 ;; Case 2: Native Org tables.
3440 column-style))
3441 out)
3445 ;; caption.
3449 ;; begin table.
3457 ;; column specification.
3459 ;; actual contents.
3461 ;; end table.
3465 "Transcode a TABLE element from Org to ODT.
3466 CONTENTS is the contents of the table. INFO is a plist holding
3467 contextual information.
3469 Use `org-e-odt--table' to typeset the table. Handle details
3470 pertaining to indentation here."
3485 collect el)))
3491 collect
3496 parent-list)
3498 ;; Handle list genealogy.
3518 parent-list info)
3521 ;; Handle low-level headlines.
3523 with step = 'item collect
3531 el info)
3532 "OrgNumberedList"
3543 parent-list info)))
3551 table info)))
3552 ;; OpenDocument schema does not permit table to occur within a
3553 ;; list item.
3555 ;; One solution - the easiest and lightweight, in terms of
3556 ;; implementation - is to put the table in an indented text box
3557 ;; and make the text box part of the list-item. Unfortunately if
3558 ;; the table is big and spans multiple pages, the text box could
3559 ;; overflow. In this case, the following attribute will come
3560 ;; handy.
3562 ;; ,---- From OpenDocument-v1.1.pdf
3563 ;; | 15.27.28 Overflow behavior
3564 ;; |
3565 ;; | For text boxes contained within text document, the
3566 ;; | style:overflow-behavior property specifies the behavior of text
3567 ;; | boxes where the containing text does not fit into the text
3568 ;; | box.
3569 ;; |
3570 ;; | If the attribute's value is clip, the text that does not fit
3571 ;; | into the text box is not displayed.
3572 ;; |
3573 ;; | If the attribute value is auto-create-new-frame, a new frame
3574 ;; | will be created on the next page, with the same position and
3575 ;; | dimensions of the original frame.
3576 ;; |
3577 ;; | If the style:overflow-behavior property's value is
3578 ;; | auto-create-new-frame and the text box has a minimum width or
3579 ;; | height specified, then the text box will grow until the page
3580 ;; | bounds are reached before a new frame is created.
3581 ;; `----
3583 ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
3584 ;; auto-create-new-frame property and always resorts to clipping
3585 ;; the text box. This results in table being truncated.
3587 ;; So we solve the problem the hard (and fun) way using list
3588 ;; continuations.
3590 ;; The problem only becomes more interesting if you take in to
3591 ;; account the following facts:
3592 ;;
3593 ;; - Description lists are simulated as plain lists.
3594 ;; - Low-level headlines can be listified.
3595 ;; - In Org-mode, a table can occur not only as a regular list
3596 ;; item, but also within description lists and low-level
3597 ;; headlines.
3599 ;; See `org-e-odt-translate-description-lists' and
3600 ;; `org-e-odt-translate-low-level-headlines' for how this is
3601 ;; tackled.
3604 ;; Discontinue the list.
3606 ;; Put the table in an indented section.
3611 ;; Continue the list.
3615 ;;;; Target
3618 "Transcode a TARGET object from Org to ODT.
3619 CONTENTS is nil. INFO is a plist holding contextual
3620 information."
3625 ;;;; Timestamp
3628 "Transcode a TIMESTAMP object from Org to ODT.
3629 CONTENTS is nil. INFO is a plist used as a communication
3630 channel."
3647 "OrgActiveTimestamp"
3651 "OrgInactiveTimestamp"
3655 "OrgActiveTimestamp"
3661 "OrgInactiveTimestamp"
3667 "OrgDiaryTimestamp"
3672 ;;;; Underline
3675 "Transcode UNDERLINE from Org to ODT.
3676 CONTENTS is the text with underline markup. INFO is a plist
3677 holding contextual information."
3682 ;;;; Verbatim
3685 "Transcode a VERBATIM object from Org to ODT.
3686 CONTENTS is nil. INFO is a plist used as a communication
3687 channel."
3692 ;;;; Verse Block
3695 "Transcode a VERSE-BLOCK element from Org to ODT.
3696 CONTENTS is verse block contents. INFO is a plist holding
3697 contextual information."
3698 ;; Add line breaks to each line of verse.
3702 ;; Replace tabs and spaces.
3704 ;; Surround it in a verse environment.
3709 \f
3710 ;;; Filters
3712 ;;;; LaTeX fragments
3717 ;; Normalize processing-type to one of dvipng, mathml or verbatim.
3718 ;; If the desired converter is not available, force verbatim
3719 ;; processing.
3736 ;; Store normalized value for later use.
3741 ;; Convert `latex-fragment's and `latex-environment's.
3760 ;; Get an Org-style link to PNG image or the MathML
3761 ;; file.
3766 nil display-msg
3767 nil nil processing-type)
3772 link))))
3774 ;; Conversion succeeded. Parse above Org-style link to a
3775 ;; `link' object.
3781 ;; Orphan the link.
3786 ;; Case 1: LaTeX environment.
3787 ;; Mimic a "standalone image or formula" by
3788 ;; enclosing the `link' in a `paragraph'.
3789 ;; Copy over original attributes, captions to
3790 ;; the enclosing paragraph.
3796 latex-*)
3798 latex-*)))
3799 link))
3800 ;; Case 2: LaTeX fragment.
3801 ;; No special action.
3803 ;; Note down the object that link replaces.
3807 ;; Replace now.
3809 info)))
3810 tree)
3813 ;;;; Description lists
3815 ;; This translator is necessary to handle indented tables in a uniform
3816 ;; manner. See comment in `org-e-odt--table'.
3819 ;; OpenDocument has no notion of a description list. So simulate it
3820 ;; using plain lists. Description lists in the exported document
3821 ;; are typeset in the same manner as they are in a typical HTML
3822 ;; document.
3823 ;;
3824 ;; Specifically, a description list like this:
3825 ;;
3826 ;; ,----
3827 ;; | - term-1 :: definition-1
3828 ;; | - term-2 :: definition-2
3829 ;; `----
3830 ;;
3831 ;; gets translated in to the following form:
3832 ;;
3833 ;; ,----
3834 ;; | - term-1
3835 ;; | - definition-1
3836 ;; | - term-2
3837 ;; | - definition-2
3838 ;; `----
3839 ;;
3840 ;; Further effect is achieved by fixing the OD styles as below:
3841 ;;
3842 ;; 1. Set the :type property of the simulated lists to
3843 ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
3844 ;; that has *no* bullets whatsoever.
3845 ;;
3846 ;; 2. The paragraph containing the definition term is styled to be
3847 ;; in bold.
3848 ;;
3850 tree 'plain-list
3854 el
3870 nil)
3871 info)
3872 tree)
3874 ;;;; List tables
3876 ;; Lists that are marked with attribute `:list-table' are called as
3877 ;; list tables. They will be rendered as a table within the exported
3878 ;; document.
3880 ;; Consider an example. The following list table
3881 ;;
3882 ;; #+attr_odt :list-table t
3883 ;; - Row 1
3884 ;; - 1.1
3885 ;; - 1.2
3886 ;; - 1.3
3887 ;; - Row 2
3888 ;; - 2.1
3889 ;; - 2.2
3890 ;; - 2.3
3891 ;;
3892 ;; will be exported as though it were an Org table like the one show
3893 ;; below.
3894 ;;
3895 ;; | Row 1 | 1.1 | 1.2 | 1.3 |
3896 ;; | Row 2 | 2.1 | 2.2 | 2.3 |
3897 ;;
3898 ;; Note that org-tables are NOT multi-line and each line is mapped to
3899 ;; a unique row in the exported document. So if an exported table
3900 ;; needs to contain a single paragraph (with copious text) it needs to
3901 ;; be typed up in a single line. Editing such long lines using the
3902 ;; table editor will be a cumbersome task. Furthermore inclusion of
3903 ;; multi-paragraph text in a table cell is well-nigh impossible.
3904 ;;
3905 ;; A LIST-TABLE circumvents above problems.
3906 ;;
3907 ;; Note that in the example above the list items could be paragraphs
3908 ;; themselves and the list can be arbitrarily deep.
3909 ;;
3910 ;; Inspired by following thread:
3911 ;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01101.html
3913 ;; Translate lists to tables
3917 tree 'plain-list
3920 ;; Replace list with table.
3922 l1-list
3923 ;; Build replacement table.
3927 l1-list
3928 'item
3931 l1-item-leading-text l2-list)
3932 ;; Remove Level-2 list from the Level-item. It
3933 ;; will be subsequently attached as table-cells.
3943 ;; Level-1 items start a table row.
3946 ;; Leading text of level-1 item define the
3947 ;; first table-cell.
3950 l1-item-leading-text)
3951 ;; Level-2 items define subsequent
3952 ;; table-cells of the row.
3954 l2-list
3955 'item
3962 nil)
3963 info)
3964 tree)
3966 \f
3967 ;;; Interactive functions
3980 <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
3989 org-e-odt-manifest-file-entries)
3997 ;; Initialize temporary workarea. All files that end up in
3998 ;; the exported document get parked/created here.
4005 ;; Kill all XML buffers.
4013 org-e-odt-xml-files)
4014 ;; Delete temporary directory and also other embedded
4015 ;; files that get copied there.
4020 ;; Not at all OSes ship with zip by default
4022 ;; Do export. This creates a bunch of xml files ready to be
4023 ;; saved and zipped.
4025 ;; Create a manifest entry for content.xml.
4027 ;; Write mimetype file
4036 ;; Write out the manifest entries before zipping
4038 ;; Save all XML files.
4044 ;; Prettify output if needed.
4048 org-e-odt-xml-files)
4049 ;; Run zip.
4054 ;; If a file with same name as the desired output file
4055 ;; exists, remove it.
4058 ;; Zip up the xml files.
4061 ;; Switch temporarily to content.xml. This way Zip
4062 ;; process will inherit `org-e-odt-zip-dir' as the current
4063 ;; directory.
4077 err-string)))))
4078 cmds)))
4079 ;; Move the zip file from temporary work directory to
4080 ;; user-mandated location.
4083 ;; Cleanup work directory and work files.
4085 ;; Open the OpenDocument file in archive-mode for
4086 ;; examination.
4088 ;; Return exported file.
4090 ;; Case 1: Conversion desired on exported file. Run the
4091 ;; converter on the OpenDocument file. Return the
4092 ;; converted file.
4095 target))
4096 ;; Case 2: No further conversion. Return exported
4097 ;; OpenDocument file.
4100 ;; Cleanup work directory and work files.
4106 ;;;; Export to OpenDocument formula
4108 ;;;###autoload
4110 "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
4111 Use `org-create-math-formula' to convert LATEX-FRAG first to
4112 MathML. When invoked as an interactive command, use
4113 `org-latex-regexps' to infer LATEX-FRAG from currently active
4114 region. If no LaTeX fragments are found, prompt for it. Push
4115 MathML source to kill ring, if `org-export-copy-to-kill-ring' is
4116 non-nil."
4142 filename
4155 ;; Add MathML to kill ring, if needed.
4159 ;;;###autoload
4161 "Export LaTeX fragment as OpenDocument formula and immediately open it.
4162 Use `org-e-odt-export-as-odf' to read LaTeX fragment and OpenDocument
4163 formula file."
4168 ;;;; Export to OpenDocument Text
4170 ;;;###autoload
4172 "Export current buffer to a ODT file.
4174 If narrowing is active in the current buffer, only export its
4175 narrowed part.
4177 If a region is active, export that region.
4179 A non-nil optional argument ASYNC means the process should happen
4180 asynchronously. The resulting file should be accessible through
4181 the `org-export-stack' interface.
4183 When optional argument SUBTREEP is non-nil, export the sub-tree
4184 at point, extracting information from the headline properties
4185 first.
4187 When optional argument VISIBLE-ONLY is non-nil, don't export
4188 contents of hidden elements.
4190 EXT-PLIST, when provided, is a property list with external
4191 parameters overriding Org default settings, but still inferior to
4192 file-local settings.
4194 Return output file's name."
4201 ,outfile
4206 ;; Let `htmlfontify' know that we are interested in
4207 ;; collecting styles.
4209 ;; Initialize content.xml and kick-off the export
4210 ;; process.
4220 outfile
4225 ;; Let `htmlfontify' know that we are interested in collecting
4226 ;; styles.
4228 ;; Initialize content.xml and kick-off the export process.
4238 ;;;; Convert between OpenDocument and other formats
4241 "Return non-nil if IN-FMT can be converted to OUT-FMT."
4250 "Workhorse routine for `org-e-odt-convert'."
4259 in-fmt out-fmt)))
4287 out-file)
4290 nil))))
4293 "Return verbose info about formats to which IN-FMT can be converted.
4294 Return a list where each element is of the
4295 form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
4296 `org-e-odt-convert-processes' for CONVERTER-PROCESS and see
4297 `org-e-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
4301 org-e-odt-convert-processes t))))
4305 org-e-odt-convert-processes t))
4306 org-e-odt-convert-capabilities))
4307 reachable-formats)
4312 reachable-formats))
4315 "Return list of formats to which IN-FMT can be converted.
4316 The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
4322 l))
4325 "Return IN-FILE and OUT-FMT params for `org-e-odt-do-convert'.
4326 This is a helper routine for interactive use."
4329 nil buffer-file-name t))
4335 out-fmt-choices nil nil nil))
4337 "No known converter or no known output formats for %s files"
4338 in-fmt))))
4341 ;;;###autoload
4343 "Convert IN-FILE to format OUT-FMT using a command line converter.
4344 IN-FILE is the file to be converted. If unspecified, it defaults
4345 to variable `buffer-file-name'. OUT-FMT is the desired output
4346 format. Use `org-e-odt-convert-process' as the converter.
4347 If PREFIX-ARG is non-nil then the newly converted file is opened
4348 using `org-open-file'."
4353 ;;; Library Initializations
4357 ;; Let Emacs open all OpenDocument files in archive mode
4360 org-e-odt-file-extensions)
4364 ;;; org-e-odt.el ends here