org-odt.el 78 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112
  1. ;;; org-odt.el --- OpenDocumentText export for Org-mode
  2. ;; Copyright (C) 2010-2011 Jambunathan <kjambunathan at gmail dot com>
  3. ;; Author: Jambunathan K <kjambunathan at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;; Version: 0.8
  7. ;; This file is not (yet) part of GNU Emacs.
  8. ;; However, it is distributed under the same license.
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;;; Code:
  23. (eval-when-compile (require 'cl))
  24. (require 'org-lparse)
  25. (defun org-odt-end-export ()
  26. (org-odt-fixup-label-references)
  27. ;; remove empty paragraphs
  28. (goto-char (point-min))
  29. (while (re-search-forward
  30. "<text:p\\( text:style-name=\"Text_20_body\"\\)?>[ \r\n\t]*</text:p>"
  31. nil t)
  32. (replace-match ""))
  33. (goto-char (point-min))
  34. ;; Convert whitespace place holders
  35. (goto-char (point-min))
  36. (let (beg end n)
  37. (while (setq beg (next-single-property-change (point) 'org-whitespace))
  38. (setq n (get-text-property beg 'org-whitespace)
  39. end (next-single-property-change beg 'org-whitespace))
  40. (goto-char beg)
  41. (delete-region beg end)
  42. (insert (format "<span style=\"visibility:hidden;\">%s</span>"
  43. (make-string n ?x)))))
  44. ;; Remove empty lines at the beginning of the file.
  45. (goto-char (point-min))
  46. (when (looking-at "\\s-+\n") (replace-match ""))
  47. ;; Remove display properties
  48. (remove-text-properties (point-min) (point-max) '(display t)))
  49. (defvar org-odt-suppress-xref nil)
  50. (defconst org-export-odt-special-string-regexps
  51. '(("\\\\-" . "&#x00ad;\\1") ; shy
  52. ("---\\([^-]\\)" . "&#x2014;\\1") ; mdash
  53. ("--\\([^-]\\)" . "&#x2013;\\1") ; ndash
  54. ("\\.\\.\\." . "&#x2026;")) ; hellip
  55. "Regular expressions for special string conversion.")
  56. (defconst org-odt-lib-dir (file-name-directory load-file-name))
  57. (defconst org-odt-data-dir
  58. (let ((dir1 (expand-file-name "../odt" org-odt-lib-dir)) ; git
  59. (dir2 (expand-file-name "./contrib/odt" org-odt-lib-dir))) ; elpa
  60. (cond
  61. ((file-directory-p dir1) dir1)
  62. ((file-directory-p dir2) dir2)
  63. (t (error "Cannot find factory styles file. Check package dir layout"))))
  64. "Directory that holds auxiliary files used by the ODT exporter.
  65. The 'styles' subdir contains the following xml files -
  66. 'OrgOdtStyles.xml' and 'OrgOdtContentTemplate.xml' - which are
  67. used as factory settings of `org-export-odt-styles-file' and
  68. `org-export-odt-content-template-file'.
  69. The 'etc/schema' subdir contains rnc files for validating of
  70. OpenDocument xml files.")
  71. (defvar org-odt-file-extensions
  72. '(("odt" . "OpenDocument Text")
  73. ("ott" . "OpenDocument Text Template")
  74. ("odm" . "OpenDocument Master Document")
  75. ("ods" . "OpenDocument Spreadsheet")
  76. ("ots" . "OpenDocument Spreadsheet Template")
  77. ("odg" . "OpenDocument Drawing (Graphics)")
  78. ("otg" . "OpenDocument Drawing Template")
  79. ("odp" . "OpenDocument Presentation")
  80. ("otp" . "OpenDocument Presentation Template")
  81. ("odi" . "OpenDocument Image")
  82. ("odf" . "OpenDocument Formula")
  83. ("odc" . "OpenDocument Chart")
  84. ("doc" . "Microsoft Text")
  85. ("docx" . "Microsoft Text")
  86. ("xls" . "Microsoft Spreadsheet")
  87. ("xlsx" . "Microsoft Spreadsheet")
  88. ("ppt" . "Microsoft Presentation")
  89. ("pptx" . "Microsoft Presentation")))
  90. (defvar org-odt-ms-file-extensions
  91. '(("doc" . "Microsoft Text")
  92. ("docx" . "Microsoft Text")
  93. ("xls" . "Microsoft Spreadsheet")
  94. ("xlsx" . "Microsoft Spreadsheet")
  95. ("ppt" . "Microsoft Presentation")
  96. ("pptx" . "Microsoft Presentation")))
  97. ;; RelaxNG validation of OpenDocument xml files
  98. (eval-after-load 'rng-nxml
  99. '(setq rng-nxml-auto-validate-flag t))
  100. (eval-after-load 'rng-loc
  101. '(add-to-list 'rng-schema-locating-files
  102. (expand-file-name "etc/schema/schemas.xml" org-odt-data-dir)))
  103. (mapc
  104. (lambda (desc)
  105. ;; Let Org open all OpenDocument files using system-registered app
  106. (add-to-list 'org-file-apps
  107. (cons (concat "\\." (car desc) "\\'") 'system))
  108. ;; Let Emacs open all OpenDocument files in archive mode
  109. (add-to-list 'auto-mode-alist
  110. (cons (concat "\\." (car desc) "\\'") 'archive-mode)))
  111. org-odt-file-extensions)
  112. (mapc
  113. (lambda (desc)
  114. ;; Let Org open all Microsoft files using system-registered app
  115. (add-to-list 'org-file-apps
  116. (cons (concat "\\." (car desc) "\\'") 'system)))
  117. org-odt-ms-file-extensions)
  118. ;; register the odt exporter with the pre-processor
  119. (add-to-list 'org-export-backends 'odt)
  120. ;; register the odt exporter with org-lparse library
  121. (org-lparse-register-backend 'odt)
  122. (defun org-odt-unload-function ()
  123. (org-lparse-unregister-backend 'odt)
  124. (remove-hook 'org-export-preprocess-after-blockquote-hook
  125. 'org-export-odt-preprocess-latex-fragments)
  126. nil)
  127. (defcustom org-export-odt-content-template-file nil
  128. "Template file for \"content.xml\".
  129. The exporter embeds the exported content just before
  130. \"</office:text>\" element.
  131. If unspecified, the file named \"OrgOdtContentTemplate.xml\"
  132. under `org-odt-data-dir' is used."
  133. :type 'file
  134. :group 'org-export-odt)
  135. (defcustom org-export-odt-styles-file nil
  136. "Default styles file for use with ODT export.
  137. Valid values are one of:
  138. 1. nil
  139. 2. path to a styles.xml file
  140. 3. path to a *.odt or a *.ott file
  141. 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
  142. ...))
  143. In case of option 1, an in-built styles.xml is used. See
  144. `org-odt-data-dir' for more information.
  145. In case of option 3, the specified file is unzipped and the
  146. styles.xml embedded therein is used.
  147. In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
  148. and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
  149. generated odt file. Use relative path for specifying the
  150. FILE-MEMBERS. styles.xml must be specified as one of the
  151. FILE-MEMBERS.
  152. Use options 1, 2 or 3 only if styles.xml alone suffices for
  153. achieving the desired formatting. Use option 4, if the styles.xml
  154. references additional files like header and footer images for
  155. achieving the desired formattting."
  156. :group 'org-export-odt
  157. :type
  158. '(choice
  159. (const :tag "Factory settings" nil)
  160. (file :must-match t :tag "styles.xml")
  161. (file :must-match t :tag "ODT or OTT file")
  162. (list :tag "ODT or OTT file + Members"
  163. (file :must-match t :tag "ODF Text or Text Template file")
  164. (cons :tag "Members"
  165. (file :tag " Member" "styles.xml")
  166. (repeat (file :tag "Member"))))))
  167. (defconst org-export-odt-tmpdir-prefix "odt-")
  168. (defconst org-export-odt-bookmark-prefix "OrgXref.")
  169. (defcustom org-export-odt-use-bookmarks-for-internal-links t
  170. "Export Internal links as bookmarks?."
  171. :type 'boolean
  172. :group 'org-export-odt)
  173. (defcustom org-export-odt-embed-images t
  174. "Should the images be copied in to the odt file or just linked?"
  175. :type 'boolean
  176. :group 'org-export-odt)
  177. (defcustom org-odt-export-inline-images 'maybe
  178. "Non-nil means inline images into exported HTML pages.
  179. This is done using an <img> tag. When nil, an anchor with href is used to
  180. link to the image. If this option is `maybe', then images in links with
  181. an empty description will be inlined, while images with a description will
  182. be linked only."
  183. :group 'org-odt-export
  184. :type '(choice (const :tag "Never" nil)
  185. (const :tag "Always" t)
  186. (const :tag "When there is no description" maybe)))
  187. (defcustom org-odt-export-inline-image-extensions
  188. '("png" "jpeg" "jpg" "gif")
  189. "Extensions of image files that can be inlined into HTML."
  190. :type '(repeat (string :tag "Extension"))
  191. :group 'org-odt-export)
  192. (defcustom org-export-odt-pixels-per-inch display-pixels-per-inch
  193. ;; FIXME add docstring
  194. ""
  195. :type 'float
  196. :group 'org-export-odt)
  197. (defvar org-export-odt-default-org-styles-alist
  198. '((paragraph . ((default . "Text_20_body")
  199. (fixedwidth . "OrgFixedWidthBlock")
  200. (verse . "OrgVerse")
  201. (quote . "Quotations")
  202. (blockquote . "Quotations")
  203. (center . "OrgCenter")
  204. (left . "OrgLeft")
  205. (right . "OrgRight")
  206. (title . "Heading_20_1.title")
  207. (footnote . "Footnote")
  208. (src . "OrgSrcBlock")
  209. (illustration . "Illustration")
  210. (table . "Table")
  211. (definition-term . "Text_20_body_20_bold")
  212. (horizontal-line . "Horizontal_20_Line")))
  213. (character . ((bold . "Bold")
  214. (emphasis . "Emphasis")
  215. (code . "OrgCode")
  216. (verbatim . "OrgCode")
  217. (strike . "Strikethrough")
  218. (underline . "Underline")
  219. (subscript . "OrgSubscript")
  220. (superscript . "OrgSuperscript")))
  221. (list . ((ordered . "OrgNumberedList")
  222. (unordered . "OrgBulletedList")
  223. (description . "OrgDescriptionList"))))
  224. "Default styles for various entities.")
  225. (defvar org-export-odt-org-styles-alist org-export-odt-default-org-styles-alist)
  226. (defun org-odt-get-style-name-for-entity (category &optional entity)
  227. (let ((entity (or entity 'default)))
  228. (or
  229. (cdr (assoc entity (cdr (assoc category
  230. org-export-odt-org-styles-alist))))
  231. (cdr (assoc entity (cdr (assoc category
  232. org-export-odt-default-org-styles-alist))))
  233. (error "Cannot determine style name for entity %s of type %s"
  234. entity category))))
  235. (defcustom org-export-odt-preferred-output-format nil
  236. "Automatically post-process to this format after exporting to \"odt\".
  237. Interactive commands `org-export-as-odt' and
  238. `org-export-as-odt-and-open' export first to \"odt\" format and
  239. then use an external converter to convert the resulting document
  240. to this format.
  241. The converter used is that specified with CONVERT-METHOD option
  242. in `org-odt-get'. If the above option is unspecified then
  243. `org-lparse-convert-process' is used.
  244. The format specified here should be listed in OTHER-BACKENDS
  245. option of `org-odt-get' or `org-lparse-convert-capabilities' as
  246. appropriate."
  247. :group 'org-odt
  248. :type '(choice :convert-widget
  249. (lambda (w)
  250. (apply 'widget-convert (widget-type w)
  251. (eval (car (widget-get w :args)))))
  252. `((const :tag "None" nil)
  253. ,@(mapcar (lambda (c)
  254. `(const :tag ,(car c) ,(car c)))
  255. (org-lparse-get-other-backends "odt")))))
  256. ;;;###autoload
  257. (defun org-export-as-odt-and-open (arg)
  258. "Export the outline as ODT and immediately open it with a browser.
  259. If there is an active region, export only the region.
  260. The prefix ARG specifies how many levels of the outline should become
  261. headlines. The default is 3. Lower levels will become bulleted lists."
  262. (interactive "P")
  263. (org-lparse-and-open
  264. (or org-export-odt-preferred-output-format "odt") "odt" arg))
  265. ;;;###autoload
  266. (defun org-export-as-odt-batch ()
  267. "Call the function `org-lparse-batch'.
  268. This function can be used in batch processing as:
  269. emacs --batch
  270. --load=$HOME/lib/emacs/org.el
  271. --eval \"(setq org-export-headline-levels 2)\"
  272. --visit=MyFile --funcall org-export-as-odt-batch"
  273. (org-lparse-batch "odt"))
  274. ;;;###autoload
  275. (defun org-export-as-odt-to-buffer (arg)
  276. "Call `org-lparse-odt` with output to a temporary buffer.
  277. No file is created. The prefix ARG is passed through to `org-lparse-to-buffer'."
  278. (interactive "P")
  279. (org-lparse-to-buffer "odt" arg))
  280. ;;;###autoload
  281. (defun org-replace-region-by-odt (beg end)
  282. "Assume the current region has org-mode syntax, and convert it to ODT.
  283. This can be used in any buffer. For example, you could write an
  284. itemized list in org-mode syntax in an ODT buffer and then use this
  285. command to convert it."
  286. (interactive "r")
  287. (org-replace-region-by "odt" beg end))
  288. ;;;###autoload
  289. (defun org-export-region-as-odt (beg end &optional body-only buffer)
  290. "Convert region from BEG to END in org-mode buffer to ODT.
  291. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  292. contents, and only produce the region of converted text, useful for
  293. cut-and-paste operations.
  294. If BUFFER is a buffer or a string, use/create that buffer as a target
  295. of the converted ODT. If BUFFER is the symbol `string', return the
  296. produced ODT as a string and leave not buffer behind. For example,
  297. a Lisp program could call this function in the following way:
  298. (setq odt (org-export-region-as-odt beg end t 'string))
  299. When called interactively, the output buffer is selected, and shown
  300. in a window. A non-interactive call will only return the buffer."
  301. (interactive "r\nP")
  302. (org-lparse-region "odt" beg end body-only buffer))
  303. ;;; org-export-as-odt
  304. ;;;###autoload
  305. (defun org-export-as-odt (arg &optional hidden ext-plist
  306. to-buffer body-only pub-dir)
  307. "Export the outline as a OpenDocumentText file.
  308. If there is an active region, export only the region. The prefix
  309. ARG specifies how many levels of the outline should become
  310. headlines. The default is 3. Lower levels will become bulleted
  311. lists. HIDDEN is obsolete and does nothing.
  312. EXT-PLIST is a property list with external parameters overriding
  313. org-mode's default settings, but still inferior to file-local
  314. settings. When TO-BUFFER is non-nil, create a buffer with that
  315. name and export to that buffer. If TO-BUFFER is the symbol
  316. `string', don't leave any buffer behind but just return the
  317. resulting XML as a string. When BODY-ONLY is set, don't produce
  318. the file header and footer, simply return the content of
  319. <body>...</body>, without even the body tags themselves. When
  320. PUB-DIR is set, use this as the publishing directory."
  321. (interactive "P")
  322. (org-lparse (or org-export-odt-preferred-output-format "odt")
  323. "odt" arg hidden ext-plist to-buffer body-only pub-dir))
  324. (defvar org-odt-entity-control-callbacks-alist
  325. `((EXPORT
  326. . (org-odt-begin-export org-odt-end-export))
  327. (DOCUMENT-CONTENT
  328. . (org-odt-begin-document-content org-odt-end-document-content))
  329. (DOCUMENT-BODY
  330. . (org-odt-begin-document-body org-odt-end-document-body))
  331. (TOC
  332. . (org-odt-begin-toc org-odt-end-toc))
  333. (ENVIRONMENT
  334. . (org-odt-begin-environment org-odt-end-environment))
  335. (FOOTNOTE-DEFINITION
  336. . (org-odt-begin-footnote-definition org-odt-end-footnote-definition))
  337. (TABLE
  338. . (org-odt-begin-table org-odt-end-table))
  339. (TABLE-ROWGROUP
  340. . (org-odt-begin-table-rowgroup org-odt-end-table-rowgroup))
  341. (LIST
  342. . (org-odt-begin-list org-odt-end-list))
  343. (LIST-ITEM
  344. . (org-odt-begin-list-item org-odt-end-list-item))
  345. (OUTLINE
  346. . (org-odt-begin-outline org-odt-end-outline))
  347. (OUTLINE-TEXT
  348. . (org-odt-begin-outline-text org-odt-end-outline-text))
  349. (PARAGRAPH
  350. . (org-odt-begin-paragraph org-odt-end-paragraph)))
  351. "")
  352. (defvar org-odt-entity-format-callbacks-alist
  353. `((EXTRA-TARGETS . org-lparse-format-extra-targets)
  354. (ORG-TAGS . org-lparse-format-org-tags)
  355. (SECTION-NUMBER . org-lparse-format-section-number)
  356. (HEADLINE . org-odt-format-headline)
  357. (TOC-ENTRY . org-odt-format-toc-entry)
  358. (TOC-ITEM . org-odt-format-toc-item)
  359. (TAGS . org-odt-format-tags)
  360. (SPACES . org-odt-format-spaces)
  361. (TABS . org-odt-format-tabs)
  362. (LINE-BREAK . org-odt-format-line-break)
  363. (FONTIFY . org-odt-format-fontify)
  364. (TODO . org-lparse-format-todo)
  365. (LINK . org-odt-format-link)
  366. (INLINE-IMAGE . org-odt-format-inline-image)
  367. (ORG-LINK . org-odt-format-org-link)
  368. (HEADING . org-odt-format-heading)
  369. (ANCHOR . org-odt-format-anchor)
  370. (TABLE . org-lparse-format-table)
  371. (TABLE-ROW . org-odt-format-table-row)
  372. (TABLE-CELL . org-odt-format-table-cell)
  373. (FOOTNOTES-SECTION . ignore)
  374. (FOOTNOTE-REFERENCE . org-odt-format-footnote-reference)
  375. (HORIZONTAL-LINE . org-odt-format-horizontal-line)
  376. (COMMENT . org-odt-format-comment)
  377. (LINE . org-odt-format-line)
  378. (ORG-ENTITY . org-odt-format-org-entity))
  379. "")
  380. ;;;_. callbacks
  381. ;;;_. control callbacks
  382. ;;;_ , document body
  383. (defun org-odt-begin-office-body ()
  384. ;; automatic styles
  385. (insert-file-contents
  386. (or org-export-odt-content-template-file
  387. (expand-file-name "styles/OrgOdtContentTemplate.xml"
  388. org-odt-data-dir)))
  389. (goto-char (point-min))
  390. (re-search-forward "</office:text>" nil nil)
  391. (delete-region (match-beginning 0) (point-max)))
  392. ;; Following variable is let bound when `org-do-lparse' is in
  393. ;; progress. See org-html.el.
  394. (defvar org-lparse-toc)
  395. (defun org-odt-begin-document-body (opt-plist)
  396. (org-odt-begin-office-body)
  397. (let ((title (plist-get opt-plist :title)))
  398. (when title
  399. (insert
  400. (org-odt-format-stylized-paragraph 'title title))))
  401. ;; insert toc
  402. (when org-lparse-toc
  403. (insert "\n" org-lparse-toc "\n")))
  404. (defvar org-lparse-body-only) ; let bound during org-do-lparse
  405. (defvar org-lparse-to-buffer) ; let bound during org-do-lparse
  406. (defun org-odt-end-document-body (opt-plist)
  407. (unless org-lparse-body-only
  408. (org-lparse-insert-tag "</office:text>")
  409. (org-lparse-insert-tag "</office:body>")))
  410. (defun org-odt-begin-document-content (opt-plist)
  411. (ignore))
  412. (defun org-odt-end-document-content ()
  413. (org-lparse-insert-tag "</office:document-content>"))
  414. (defun org-odt-begin-outline (level1 snumber title tags
  415. target extra-targets class)
  416. (org-lparse-insert
  417. 'HEADING (org-lparse-format
  418. 'HEADLINE title extra-targets tags snumber level1)
  419. level1 target))
  420. (defun org-odt-end-outline ()
  421. (ignore))
  422. (defun org-odt-begin-outline-text (level1 snumber class)
  423. (ignore))
  424. (defun org-odt-end-outline-text ()
  425. (ignore))
  426. (defun org-odt-begin-paragraph (&optional style)
  427. (org-lparse-insert-tag
  428. "<text:p%s>" (org-odt-get-extra-attrs-for-paragraph-style style)))
  429. (defun org-odt-end-paragraph ()
  430. (org-lparse-insert-tag "</text:p>"))
  431. (defun org-odt-get-extra-attrs-for-paragraph-style (style)
  432. (let (style-name)
  433. (setq style-name
  434. (cond
  435. ((stringp style) style)
  436. ((symbolp style) (org-odt-get-style-name-for-entity
  437. 'paragraph style))))
  438. (unless style-name
  439. (error "Don't know how to handle paragraph style %s" style))
  440. (format " text:style-name=\"%s\"" style-name)))
  441. (defun org-odt-format-stylized-paragraph (style text)
  442. (org-odt-format-tags
  443. '("<text:p%s>" . "</text:p>") text
  444. (org-odt-get-extra-attrs-for-paragraph-style style)))
  445. (defun org-odt-begin-environment (style)
  446. (case style
  447. ((blockquote verse center quote)
  448. (org-lparse-begin-paragraph style)
  449. (list))
  450. ((fixedwidth native)
  451. (org-lparse-end-paragraph)
  452. (list))
  453. (t (error "Unknown environment %s" style))))
  454. (defun org-odt-end-environment (style)
  455. (case style
  456. ((blockquote verse center quote)
  457. (org-lparse-end-paragraph)
  458. (list))
  459. ((fixedwidth native)
  460. (org-lparse-begin-paragraph)
  461. (list))
  462. (t (error "Unknown environment %s" style))))
  463. (defvar org-lparse-list-level) ; dynamically bound in org-do-lparse
  464. (defun org-odt-begin-list (ltype)
  465. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  466. ltype))
  467. (let* ((style-name (org-odt-get-style-name-for-entity 'list ltype))
  468. (extra (concat (when (= org-lparse-list-level 1)
  469. " text:continue-numbering=\"false\"")
  470. (when style-name
  471. (format " text:style-name=\"%s\"" style-name)))))
  472. (case ltype
  473. ((ordered unordered description)
  474. (org-lparse-end-paragraph)
  475. (org-lparse-insert-tag "<text:list%s>" extra))
  476. (t (error "Unknown list type: %s" ltype)))))
  477. (defun org-odt-end-list (ltype)
  478. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  479. ltype))
  480. (if ltype
  481. (org-lparse-insert-tag "</text:list>")
  482. (error "Unknown list type: %s" ltype)))
  483. (defun org-odt-begin-list-item (ltype &optional arg headline)
  484. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  485. ltype))
  486. (case ltype
  487. (ordered
  488. (assert (not headline) t)
  489. (let* ((counter arg) (extra ""))
  490. (org-lparse-insert-tag "<text:list-item>")
  491. (org-lparse-begin-paragraph)))
  492. (unordered
  493. (let* ((id arg) (extra ""))
  494. (org-lparse-insert-tag "<text:list-item>")
  495. (org-lparse-begin-paragraph)
  496. (insert (if headline (org-odt-format-target headline id)
  497. (org-odt-format-bookmark "" id)))))
  498. (description
  499. (assert (not headline) t)
  500. (let ((term (or arg "(no term)")))
  501. (insert
  502. (org-odt-format-tags
  503. '("<text:list-item>" . "</text:list-item>")
  504. (org-odt-format-stylized-paragraph 'definition-term term)))
  505. (org-lparse-begin-list-item 'unordered)
  506. (org-lparse-begin-list 'description)
  507. (org-lparse-begin-list-item 'unordered)))
  508. (t (error "Unknown list type"))))
  509. (defun org-odt-end-list-item (ltype)
  510. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  511. ltype))
  512. (case ltype
  513. ((ordered unordered)
  514. (org-lparse-insert-tag "</text:list-item>"))
  515. (description
  516. (org-lparse-end-list-item-1)
  517. (org-lparse-end-list 'description)
  518. (org-lparse-end-list-item-1))
  519. (t (error "Unknown list type"))))
  520. ;; Following variables are let bound when table emission is in
  521. ;; progress. See org-lparse.el.
  522. (defvar org-lparse-table-begin-marker)
  523. (defvar org-lparse-table-ncols)
  524. (defvar org-lparse-table-rowgrp-open)
  525. (defvar org-lparse-table-rownum)
  526. (defvar org-lparse-table-cur-rowgrp-is-hdr)
  527. (defvar org-lparse-table-is-styled)
  528. (defvar org-lparse-table-rowgrp-info)
  529. (defvar org-lparse-table-colalign-vector)
  530. (defvar org-odt-table-style nil
  531. "Table style specified by \"#+ATTR_ODT: <style-name>\" line.
  532. This is set during `org-odt-begin-table'.")
  533. (defvar org-odt-table-style-spec nil
  534. "Entry for `org-odt-table-style' in `org-export-odt-table-styles'.")
  535. (defcustom org-export-odt-table-styles nil
  536. "Specify how Table Styles should be derived from a Table Template.
  537. This is a list where each element is of the
  538. form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
  539. TABLE-STYLE-NAME is the style associated with the table through
  540. `org-odt-table-style'.
  541. TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
  542. TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
  543. below) that is included in
  544. `org-export-odt-content-template-file'.
  545. TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
  546. \"TableCell\"
  547. PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
  548. \"TableParagraph\"
  549. TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
  550. \"FirstRow\" | \"LastRow\" |
  551. \"EvenRow\" | \"OddRow\" |
  552. \"EvenColumn\" | \"OddColumn\" | \"\"
  553. where \"+\" above denotes string concatenation.
  554. TABLE-CELL-OPTIONS is an alist where each element is of the
  555. form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
  556. TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
  557. `use-last-row-styles' |
  558. `use-first-column-styles' |
  559. `use-last-column-styles' |
  560. `use-banding-rows-styles' |
  561. `use-banding-columns-styles' |
  562. `use-first-row-styles'
  563. ON-OR-OFF := `t' | `nil'
  564. For example, with the following configuration
  565. \(setq org-export-odt-table-styles
  566. '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
  567. \(\(use-first-row-styles . t\)
  568. \(use-first-column-styles . t\)\)\)
  569. \(\"TableWithHeaderColumns\" \"Custom\"
  570. \(\(use-first-column-styles . t\)\)\)\)\)
  571. 1. A table associated with \"TableWithHeaderRowsAndColumns\"
  572. style will use the following table-cell styles -
  573. \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
  574. \"CustomTableCell\" and the following paragraph styles
  575. \"CustomFirstRowTableParagraph\",
  576. \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
  577. as appropriate.
  578. 2. A table associated with \"TableWithHeaderColumns\" style will
  579. use the following table-cell styles -
  580. \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
  581. following paragraph styles
  582. \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
  583. as appropriate..
  584. Note that TABLE-TEMPLATE-NAME corresponds to the
  585. \"<table:table-template>\" elements contained within
  586. \"<office:styles>\". The entries (TABLE-STYLE-NAME
  587. TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
  588. \"table:template-name\" and \"table:use-first-row-styles\" etc
  589. attributes of \"<table:table>\" element. Refer ODF-1.2
  590. specification for more information. Also consult the
  591. implementation filed under `org-odt-get-table-cell-styles'."
  592. :group 'org-export-odt
  593. :type '(choice
  594. (const :tag "None" nil)
  595. (repeat :tag "Table Styles"
  596. (list :tag "Table Style Specification"
  597. (string :tag "Table Style Name")
  598. (string :tag "Table Template Name")
  599. (alist :options (use-first-row-styles
  600. use-last-row-styles
  601. use-first-column-styles
  602. use-last-column-styles
  603. use-banding-rows-styles
  604. use-banding-columns-styles)
  605. :key-type symbol
  606. :value-type (const :tag "True" t))))))
  607. (defun org-odt-begin-table (caption label attributes)
  608. (setq org-odt-table-style attributes)
  609. (setq org-odt-table-style-spec
  610. (assoc org-odt-table-style org-export-odt-table-styles))
  611. (when label
  612. (insert
  613. (org-odt-format-stylized-paragraph
  614. 'table (org-odt-format-entity-caption label caption "Table"))))
  615. (org-lparse-insert-tag
  616. "<table:table table:name=\"%s\" table:style-name=\"%s\">"
  617. (or label "") (or (nth 1 org-odt-table-style-spec) "OrgTable"))
  618. (setq org-lparse-table-begin-marker (point)))
  619. (defvar org-lparse-table-colalign-info)
  620. (defun org-odt-end-table ()
  621. (goto-char org-lparse-table-begin-marker)
  622. (loop for level from 0 below org-lparse-table-ncols
  623. do (let* ((col-cookie (and org-lparse-table-is-styled
  624. (cdr (assoc (1+ level)
  625. org-lparse-table-colalign-info))))
  626. (extra-columns (or (nth 1 col-cookie) 0)))
  627. (dotimes (i (1+ extra-columns))
  628. (insert
  629. (org-odt-format-tags
  630. "<table:table-column table:style-name=\"%sColumn\"/>"
  631. "" (or (nth 1 org-odt-table-style-spec) "OrgTable"))))
  632. (insert "\n")))
  633. ;; fill style attributes for table cells
  634. (when org-lparse-table-is-styled
  635. (while (re-search-forward "@@\\(table-cell:p\\|table-cell:style-name\\)@@\\([0-9]+\\)@@\\([0-9]+\\)@@" nil t)
  636. (let* ((spec (match-string 1))
  637. (r (string-to-number (match-string 2)))
  638. (c (string-to-number (match-string 3)))
  639. (cell-styles (org-odt-get-table-cell-styles
  640. r c org-odt-table-style-spec))
  641. (table-cell-style (car cell-styles))
  642. (table-cell-paragraph-style (cdr cell-styles)))
  643. (cond
  644. ((equal spec "table-cell:p")
  645. (replace-match table-cell-paragraph-style t t))
  646. ((equal spec "table-cell:style-name")
  647. (replace-match table-cell-style t t))))))
  648. (goto-char (point-max))
  649. (org-lparse-insert-tag "</table:table>"))
  650. (defun org-odt-begin-table-rowgroup (&optional is-header-row)
  651. (when org-lparse-table-rowgrp-open
  652. (org-lparse-end 'TABLE-ROWGROUP))
  653. (org-lparse-insert-tag (if is-header-row
  654. "<table:table-header-rows>"
  655. "<table:table-rows>"))
  656. (setq org-lparse-table-rowgrp-open t)
  657. (setq org-lparse-table-cur-rowgrp-is-hdr is-header-row))
  658. (defun org-odt-end-table-rowgroup ()
  659. (when org-lparse-table-rowgrp-open
  660. (setq org-lparse-table-rowgrp-open nil)
  661. (org-lparse-insert-tag
  662. (if org-lparse-table-cur-rowgrp-is-hdr
  663. "</table:table-header-rows>" "</table:table-rows>"))))
  664. (defun org-odt-format-table-row (row)
  665. (org-odt-format-tags
  666. '("<table:table-row>" . "</table:table-row>") row))
  667. (defun org-odt-get-table-cell-styles (r c &optional style-spec)
  668. "Retrieve styles applicable to a table cell.
  669. R and C are (zero-based) row and column numbers of the table
  670. cell. STYLE-SPEC is an entry in `org-export-odt-table-styles'
  671. applicable to the current table. It is `nil' if the table is not
  672. associated with any style attributes.
  673. Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
  674. When STYLE-SPEC is nil, style the table cell the conventional way
  675. - choose cell borders based on row and column groupings and
  676. choose paragraph alignment based on `org-col-cookies' text
  677. property. See also
  678. `org-odt-get-paragraph-style-cookie-for-table-cell'.
  679. When STYLE-SPEC is non-nil, ignore the above cookie and return
  680. styles congruent with the ODF-1.2 specification."
  681. (cond
  682. (style-spec
  683. ;; LibreOffice - particularly the Writer - honors neither table
  684. ;; templates nor custom table-cell styles. Inorder to retain
  685. ;; inter-operability with LibreOffice, only automatic styles are
  686. ;; used for styling of table-cells. The current implementation is
  687. ;; congruent with ODF-1.2 specification and hence is
  688. ;; future-compatible.
  689. ;; Additional Note: LibreOffice's AutoFormat facility for tables -
  690. ;; which recognizes as many as 16 different cell types - is much
  691. ;; richer. Unfortunately it is NOT amenable to easy configuration
  692. ;; by hand.
  693. (let* ((template-name (nth 1 style-spec))
  694. (cell-style-selectors (nth 2 style-spec))
  695. (cell-type
  696. (cond
  697. ((and (cdr (assoc 'use-first-column-styles cell-style-selectors))
  698. (= c 0)) "FirstColumn")
  699. ((and (cdr (assoc 'use-last-column-styles cell-style-selectors))
  700. (= c (1- org-lparse-table-ncols))) "LastColumn")
  701. ((and (cdr (assoc 'use-first-row-styles cell-style-selectors))
  702. (= r 0)) "FirstRow")
  703. ((and (cdr (assoc 'use-last-row-styles cell-style-selectors))
  704. (= r org-lparse-table-rownum))
  705. "LastRow")
  706. ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
  707. (= (% r 2) 1)) "EvenRow")
  708. ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
  709. (= (% r 2) 0)) "OddRow")
  710. ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
  711. (= (% c 2) 1)) "EvenColumn")
  712. ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
  713. (= (% c 2) 0)) "OddColumn")
  714. (t ""))))
  715. (cons
  716. (concat template-name cell-type "TableCell")
  717. (concat template-name cell-type "TableParagraph"))))
  718. (t
  719. (cons
  720. (concat
  721. "OrgTblCell"
  722. (cond
  723. ((= r 0) "T")
  724. ((eq (cdr (assoc r org-lparse-table-rowgrp-info)) :start) "T")
  725. (t ""))
  726. (when (= r org-lparse-table-rownum) "B")
  727. (cond
  728. ((= c 0) "")
  729. ((or (memq (nth c org-table-colgroup-info) '(:start :startend))
  730. (memq (nth (1- c) org-table-colgroup-info) '(:end :startend))) "L")
  731. (t "")))
  732. (capitalize (aref org-lparse-table-colalign-vector c))))))
  733. (defun org-odt-get-paragraph-style-cookie-for-table-cell (r c)
  734. (concat
  735. (and (not org-odt-table-style-spec)
  736. (cond
  737. (org-lparse-table-cur-rowgrp-is-hdr "OrgTableHeading")
  738. ((and (= c 0) (org-lparse-get 'TABLE-FIRST-COLUMN-AS-LABELS))
  739. "OrgTableHeading")
  740. (t "OrgTableContents")))
  741. (and org-lparse-table-is-styled
  742. (format "@@table-cell:p@@%03d@@%03d@@" r c))))
  743. (defun org-odt-get-style-name-cookie-for-table-cell (r c)
  744. (when org-lparse-table-is-styled
  745. (format "@@table-cell:style-name@@%03d@@%03d@@" r c)))
  746. (defun org-odt-format-table-cell (data r c horiz-span)
  747. (concat
  748. (let* ((paragraph-style-cookie
  749. (org-odt-get-paragraph-style-cookie-for-table-cell r c))
  750. (style-name-cookie
  751. (org-odt-get-style-name-cookie-for-table-cell r c))
  752. (extra (and style-name-cookie
  753. (format " table:style-name=\"%s\"" style-name-cookie)))
  754. (extra (concat extra
  755. (and (> horiz-span 0)
  756. (format " table:number-columns-spanned=\"%d\""
  757. (1+ horiz-span))))))
  758. (org-odt-format-tags
  759. '("<table:table-cell%s>" . "</table:table-cell>")
  760. (if org-lparse-list-table-p data
  761. (org-odt-format-stylized-paragraph paragraph-style-cookie data)) extra))
  762. (let (s)
  763. (dotimes (i horiz-span)
  764. (setq s (concat s "\n<table:covered-table-cell/>"))) s)
  765. "\n"))
  766. (defun org-odt-begin-footnote-definition (n)
  767. (org-lparse-begin-paragraph 'footnote))
  768. (defun org-odt-end-footnote-definition (n)
  769. (org-lparse-end-paragraph))
  770. (defun org-odt-begin-toc (lang-specific-heading)
  771. (insert
  772. (format "
  773. <text:table-of-content text:style-name=\"Sect2\" text:protected=\"true\" text:name=\"Table of Contents1\">
  774. <text:table-of-content-source text:outline-level=\"10\">
  775. <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
  776. " lang-specific-heading))
  777. (loop for level from 1 upto 10
  778. do (insert (format
  779. "
  780. <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
  781. <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
  782. <text:index-entry-chapter/>
  783. <text:index-entry-text/>
  784. <text:index-entry-link-end/>
  785. </text:table-of-content-entry-template>
  786. " level level)))
  787. (insert
  788. (format "
  789. </text:table-of-content-source>
  790. <text:index-body>
  791. <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
  792. <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
  793. </text:index-title>
  794. " lang-specific-heading)))
  795. (defun org-odt-end-toc ()
  796. (insert "
  797. </text:index-body>
  798. </text:table-of-content>
  799. "))
  800. (defun org-odt-format-toc-entry (snumber todo headline tags href)
  801. (setq headline (concat
  802. (and org-export-with-section-numbers
  803. (concat snumber ". "))
  804. headline
  805. (and tags
  806. (concat
  807. (org-lparse-format 'SPACES 3)
  808. (org-lparse-format 'FONTIFY tags "tag")))))
  809. (when todo
  810. (setq headline (org-lparse-format 'FONTIFY headline "todo")))
  811. (let ((org-odt-suppress-xref t))
  812. (org-odt-format-link headline (concat "#" href))))
  813. (defun org-odt-format-toc-item (toc-entry level org-last-level)
  814. (let ((style (format "Contents_20_%d"
  815. (+ level (or (org-lparse-get 'TOPLEVEL-HLEVEL) 1) -1))))
  816. (insert "\n" (org-odt-format-stylized-paragraph style toc-entry) "\n")))
  817. ;; Following variable is let bound during 'ORG-LINK callback. See
  818. ;; org-html.el
  819. (defvar org-lparse-link-description-is-image nil)
  820. (defun org-odt-format-link (desc href &optional attr)
  821. (cond
  822. ((and (= (string-to-char href) ?#) (not org-odt-suppress-xref))
  823. (setq href (concat org-export-odt-bookmark-prefix (substring href 1)))
  824. (let ((xref-format "text"))
  825. (when (numberp desc)
  826. (setq desc (format "%d" desc) xref-format "number"))
  827. (org-odt-format-tags
  828. '("<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">" .
  829. "</text:bookmark-ref>")
  830. desc xref-format href)))
  831. (org-lparse-link-description-is-image
  832. (org-odt-format-tags
  833. '("<draw:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</draw:a>")
  834. desc href (or attr "")))
  835. (t
  836. (org-odt-format-tags
  837. '("<text:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</text:a>")
  838. desc href (or attr "")))))
  839. (defun org-odt-format-spaces (n)
  840. (cond
  841. ((= n 1) " ")
  842. ((> n 1) (concat
  843. " " (org-odt-format-tags "<text:s text:c=\"%d\"/>" "" (1- n))))
  844. (t "")))
  845. (defun org-odt-format-tabs (&optional n)
  846. (let ((tab "<text:tab/>")
  847. (n (or n 1)))
  848. (insert tab)))
  849. (defun org-odt-format-line-break ()
  850. (org-odt-format-tags "<text:line-break/>" ""))
  851. (defun org-odt-format-horizontal-line ()
  852. (org-odt-format-stylized-paragraph 'horizontal-line ""))
  853. (defun org-odt-format-line (line)
  854. (case org-lparse-dyn-current-environment
  855. (fixedwidth (concat
  856. (org-odt-format-stylized-paragraph
  857. 'fixedwidth (org-odt-fill-tabs-and-spaces
  858. (org-xml-encode-plain-text line))) "\n"))
  859. (t (concat line "\n"))))
  860. (defun org-odt-format-comment (fmt &rest args)
  861. (let ((comment (apply 'format fmt args)))
  862. (format "\n<!-- %s -->\n" comment)))
  863. (defun org-odt-format-org-entity (wd)
  864. (org-entity-get-representation wd 'utf8))
  865. (defun org-odt-fill-tabs-and-spaces (line)
  866. (replace-regexp-in-string
  867. "\\([\t]\\|\\([ ]+\\)\\)" (lambda (s)
  868. (cond
  869. ((string= s "\t") (org-odt-format-tabs))
  870. (t (org-odt-format-spaces (length s))))) line))
  871. (defcustom org-export-odt-use-htmlfontify t
  872. "Specify whether or not source blocks need to be fontified.
  873. Turn this option on if you want to colorize the source code
  874. blocks in the exported file. For colorization to work, you need
  875. to make available an enhanced version of `htmlfontify' library."
  876. :type 'boolean
  877. :group 'org-export-odt)
  878. (defun org-odt-format-source-line-with-line-number-and-label
  879. (line rpllbl num fontifier par-style)
  880. (let ((keep-label (not (numberp rpllbl)))
  881. (ref (org-find-text-property-in-string 'org-coderef line)))
  882. (setq line (concat line (and keep-label ref (format "(%s)" ref))))
  883. (setq line (funcall fontifier line))
  884. (when ref
  885. (setq line (org-odt-format-target line (concat "coderef-" ref))))
  886. (setq line (org-odt-format-stylized-paragraph par-style line))
  887. (when num
  888. (org-odt-format-tags '("<text:list-item>" . "</text:list-item>") line))))
  889. (defun org-odt-format-source-code-or-example-plain
  890. (lines lang caption textareap cols rows num cont rpllbl fmt)
  891. "Format source or example blocks much like fixedwidth blocks.
  892. Use this when `org-export-odt-use-htmlfontify' option is turned
  893. off."
  894. (let* ((lines (org-split-string lines "[\r\n]"))
  895. (line-count (length lines))
  896. (i 0))
  897. (mapconcat
  898. (lambda (line)
  899. (incf i)
  900. (org-odt-format-source-line-with-line-number-and-label
  901. line rpllbl num (lambda (line)
  902. (org-odt-fill-tabs-and-spaces
  903. (org-xml-encode-plain-text line)))
  904. (if (= i line-count) "OrgFixedWidthBlockLastLine" "OrgFixedWidthBlock")))
  905. lines "\n")))
  906. (defvar org-src-block-paragraph-format
  907. "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
  908. <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
  909. <style:background-image/>
  910. </style:paragraph-properties>
  911. <style:text-properties fo:color=\"%s\"/>
  912. </style:style>"
  913. "Custom paragraph style for colorized source and example blocks.
  914. This style is much the same as that of \"OrgFixedWidthBlock\"
  915. except that the foreground and background colors are set
  916. according to the default face identified by the `htmlfontify'.")
  917. (defun org-odt-hfy-face-to-css (fn)
  918. "Create custom style for face FN.
  919. When FN is the default face, use it's foreground and background
  920. properties to create \"OrgSrcBlock\" paragraph style. Otherwise
  921. use it's color attribute to create a character style whose name
  922. is obtained from FN. Currently all attributes of FN other than
  923. color are ignored.
  924. The style name for a face FN is derived using the following
  925. operations on the face name in that order - de-dash, CamelCase
  926. and prefix with \"OrgSrc\". For example,
  927. `font-lock-function-name-face' is associated with
  928. \"OrgSrcFontLockFunctionNameFace\"."
  929. (let* ((css-list (hfy-face-to-style fn))
  930. (style-name ((lambda (fn)
  931. (concat "OrgSrc"
  932. (mapconcat
  933. 'capitalize (split-string
  934. (hfy-face-or-def-to-name fn) "-")
  935. ""))) fn))
  936. (color-val (cdr (assoc "color" css-list)))
  937. (background-color-val (cdr (assoc "background" css-list)))
  938. (style (and org-export-odt-create-custom-styles-for-srcblocks
  939. (cond
  940. ((eq fn 'default)
  941. (format org-src-block-paragraph-format
  942. background-color-val color-val))
  943. (t
  944. (format
  945. "
  946. <style:style style:name=\"%s\" style:family=\"text\">
  947. <style:text-properties fo:color=\"%s\"/>
  948. </style:style>" style-name color-val))))))
  949. (cons style-name style)))
  950. (defcustom org-export-odt-create-custom-styles-for-srcblocks t
  951. "Whether custom styles for colorized source blocks be automatically created.
  952. When this option is turned on, the exporter creates custom styles
  953. for source blocks based on the advice of `htmlfontify'. Creation
  954. of custom styles happen as part of `org-odt-hfy-face-to-css'.
  955. When this option is turned off exporter does not create such
  956. styles.
  957. Use the latter option if you do not want the custom styles to be
  958. based on your current display settings. It is necessary that the
  959. styles.xml already contains needed styles for colorizing to work.
  960. This variable is effective only if
  961. `org-export-odt-use-htmlfontify' is turned on."
  962. :group 'org-export-odt
  963. :type 'boolean)
  964. (defun org-odt-insert-custom-styles-for-srcblocks (styles)
  965. "Save STYLES used for colorizing of source blocks.
  966. Update styles.xml with styles that were collected as part of
  967. `org-odt-hfy-face-to-css' callbacks."
  968. (when styles
  969. (with-current-buffer
  970. (find-file-noselect (expand-file-name "styles.xml") t)
  971. (goto-char (point-min))
  972. (when (re-search-forward "</office:styles>" nil t)
  973. (goto-char (match-beginning 0))
  974. (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n")))))
  975. (defun org-odt-format-source-code-or-example-colored
  976. (lines lang caption textareap cols rows num cont rpllbl fmt)
  977. "Format source or example blocks using `htmlfontify-string'.
  978. Use this routine when `org-export-odt-use-htmlfontify' option is
  979. turned on."
  980. (let* ((lang-m (and lang (or (cdr (assoc lang org-src-lang-modes)) lang)))
  981. (mode (and lang-m (intern (concat (if (symbolp lang-m)
  982. (symbol-name lang-m)
  983. lang-m) "-mode"))))
  984. (org-inhibit-startup t)
  985. (org-startup-folded nil)
  986. (lines (with-temp-buffer
  987. (insert lines)
  988. (if (functionp mode) (funcall mode) (fundamental-mode))
  989. (font-lock-fontify-buffer)
  990. (buffer-string)))
  991. (hfy-html-quote-regex "\\([<\"&> ]\\)")
  992. (hfy-html-quote-map '(("\"" "&quot;")
  993. ("<" "&lt;")
  994. ("&" "&amp;")
  995. (">" "&gt;")
  996. (" " "<text:s/>")
  997. (" " "<text:tab/>")))
  998. (hfy-face-to-css 'org-odt-hfy-face-to-css)
  999. (hfy-optimisations-1 (copy-seq hfy-optimisations))
  1000. (hfy-optimisations (add-to-list 'hfy-optimisations-1
  1001. 'body-text-only))
  1002. (hfy-begin-span-handler
  1003. (lambda (style text-block text-id text-begins-block-p)
  1004. (insert (format "<text:span text:style-name=\"%s\">" style))))
  1005. (hfy-end-span-handler (lambda nil (insert "</text:span>"))))
  1006. (when (fboundp 'htmlfontify-string)
  1007. (let* ((lines (org-split-string lines "[\r\n]"))
  1008. (line-count (length lines))
  1009. (i 0))
  1010. (mapconcat
  1011. (lambda (line)
  1012. (incf i)
  1013. (org-odt-format-source-line-with-line-number-and-label
  1014. line rpllbl num 'htmlfontify-string
  1015. (if (= i line-count) "OrgSrcBlockLastLine" "OrgSrcBlock")))
  1016. lines "\n")))))
  1017. (defun org-odt-format-source-code-or-example (lines lang caption textareap
  1018. cols rows num cont
  1019. rpllbl fmt)
  1020. "Format source or example blocks for export.
  1021. Use `org-odt-format-source-code-or-example-plain' or
  1022. `org-odt-format-source-code-or-example-colored' depending on the
  1023. value of `org-export-odt-use-htmlfontify."
  1024. (setq lines (org-export-number-lines
  1025. lines 0 0 num cont rpllbl fmt 'preprocess)
  1026. lines (funcall
  1027. (or (and org-export-odt-use-htmlfontify
  1028. (or (featurep 'htmlfontify)
  1029. (require 'htmlfontify))
  1030. (fboundp 'htmlfontify-string)
  1031. 'org-odt-format-source-code-or-example-colored)
  1032. 'org-odt-format-source-code-or-example-plain)
  1033. lines lang caption textareap cols rows num cont rpllbl fmt))
  1034. (if (not num) lines
  1035. (let ((extra (format " text:continue-numbering=\"%s\""
  1036. (if cont "true" "false"))))
  1037. (org-odt-format-tags
  1038. '("<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>"
  1039. . "</text:list>") lines extra))))
  1040. (defun org-odt-remap-stylenames (style-name)
  1041. (or
  1042. (cdr (assoc style-name '(("timestamp-wrapper" . "OrgTimestampWrapper")
  1043. ("timestamp" . "OrgTimestamp")
  1044. ("timestamp-kwd" . "OrgTimestampKeyword")
  1045. ("tag" . "OrgTag")
  1046. ("todo" . "OrgTodo")
  1047. ("done" . "OrgDone")
  1048. ("target" . "OrgTarget"))))
  1049. style-name))
  1050. (defun org-odt-format-fontify (text style &optional id)
  1051. (let* ((style-name
  1052. (cond
  1053. ((stringp style)
  1054. (org-odt-remap-stylenames style))
  1055. ((symbolp style)
  1056. (org-odt-get-style-name-for-entity 'character style))
  1057. ((listp style)
  1058. (assert (< 1 (length style)))
  1059. (let ((parent-style (pop style)))
  1060. (mapconcat (lambda (s)
  1061. ;; (assert (stringp s) t)
  1062. (org-odt-remap-stylenames s)) style "")
  1063. (org-odt-remap-stylenames parent-style)))
  1064. (t (error "Don't how to handle style %s" style)))))
  1065. (org-odt-format-tags
  1066. '("<text:span text:style-name=\"%s\">" . "</text:span>")
  1067. text style-name)))
  1068. (defun org-odt-relocate-relative-path (path dir)
  1069. (if (file-name-absolute-p path) path
  1070. (file-relative-name (expand-file-name path dir)
  1071. (expand-file-name "eyecandy" dir))))
  1072. (defun org-odt-format-inline-image (thefile)
  1073. (let* ((thelink (if (file-name-absolute-p thefile) thefile
  1074. (org-xml-format-href
  1075. (org-odt-relocate-relative-path
  1076. thefile org-current-export-file))))
  1077. (href
  1078. (org-odt-format-tags
  1079. "<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
  1080. (if org-export-odt-embed-images
  1081. (org-odt-copy-image-file thefile) thelink))))
  1082. (org-export-odt-format-image thefile href)))
  1083. (defun org-export-odt-format-formula (src href &optional embed-as)
  1084. "Create image tag with source and attributes."
  1085. (save-match-data
  1086. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1087. (caption (and caption (org-xml-format-desc caption)))
  1088. (label (org-find-text-property-in-string 'org-label src))
  1089. (embed-as (or embed-as
  1090. (and (org-find-text-property-in-string
  1091. 'org-latex-src src)
  1092. (org-find-text-property-in-string
  1093. 'org-latex-src-embed-type src))
  1094. 'paragraph))
  1095. width height)
  1096. (cond
  1097. ((eq embed-as 'character)
  1098. (org-odt-format-entity "InlineFormula" href width height))
  1099. (t
  1100. (org-lparse-end-paragraph)
  1101. (org-lparse-insert-list-table
  1102. `((,(org-odt-format-entity
  1103. (if caption "CaptionedDisplayFormula" "DisplayFormula")
  1104. href width height caption nil)
  1105. ,(if (not label) ""
  1106. (org-odt-format-entity-caption label nil "Equation"))))
  1107. nil nil nil "OrgEquation" nil '((1 "c" 8) (2 "c" 1)))
  1108. (throw 'nextline nil))))))
  1109. (defvar org-odt-embedded-formulas-count 0)
  1110. (defun org-odt-copy-formula-file (path)
  1111. "Returns the internal name of the file"
  1112. (let* ((src-file (expand-file-name
  1113. path (file-name-directory org-current-export-file)))
  1114. (target-dir (format "Formula-%04d/"
  1115. (incf org-odt-embedded-formulas-count)))
  1116. (target-file (concat target-dir "content.xml")))
  1117. (when (not org-lparse-to-buffer)
  1118. (message "Embedding %s as %s ..."
  1119. (substring-no-properties path) target-file)
  1120. (make-directory target-dir)
  1121. (org-odt-create-manifest-file-entry
  1122. "application/vnd.oasis.opendocument.formula" target-dir "1.2")
  1123. (copy-file src-file target-file 'overwrite)
  1124. (org-odt-create-manifest-file-entry "text/xml" target-file))
  1125. target-file))
  1126. (defun org-odt-format-inline-formula (thefile)
  1127. (let* ((thelink (if (file-name-absolute-p thefile) thefile
  1128. (org-xml-format-href
  1129. (org-odt-relocate-relative-path
  1130. thefile org-current-export-file))))
  1131. (href
  1132. (org-odt-format-tags
  1133. "<draw:object xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
  1134. (file-name-directory (org-odt-copy-formula-file thefile)))))
  1135. (org-export-odt-format-formula thefile href)))
  1136. (defun org-odt-is-formula-link-p (file)
  1137. (member (downcase (file-name-extension file)) '("mathml")))
  1138. (defun org-odt-format-org-link (opt-plist type-1 path fragment desc attr
  1139. descp)
  1140. "Make an HTML link.
  1141. OPT-PLIST is an options list.
  1142. TYPE is the device-type of the link (THIS://foo.html)
  1143. PATH is the path of the link (http://THIS#locationx)
  1144. FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
  1145. DESC is the link description, if any.
  1146. ATTR is a string of other attributes of the a element.
  1147. MAY-INLINE-P allows inlining it as an image."
  1148. (declare (special org-lparse-par-open))
  1149. (save-match-data
  1150. (let* ((may-inline-p
  1151. (and (member type-1 '("http" "https" "file"))
  1152. (org-lparse-should-inline-p path descp)
  1153. (not fragment)))
  1154. (type (if (equal type-1 "id") "file" type-1))
  1155. (filename path)
  1156. (thefile path))
  1157. (cond
  1158. ;; check for inlined images
  1159. ((and (member type '("file"))
  1160. (not fragment)
  1161. (org-file-image-p
  1162. filename org-odt-export-inline-image-extensions)
  1163. (or (eq t org-odt-export-inline-images)
  1164. (and org-odt-export-inline-images (not descp))))
  1165. (org-odt-format-inline-image thefile))
  1166. ;; check for embedded formulas
  1167. ((and (member type '("file"))
  1168. (not fragment)
  1169. (org-odt-is-formula-link-p filename)
  1170. (or (not descp)))
  1171. (org-odt-format-inline-formula thefile))
  1172. ((string= type "coderef")
  1173. (let* ((ref fragment)
  1174. (lineno-or-ref (cdr (assoc ref org-export-code-refs)))
  1175. (desc (and descp desc))
  1176. (org-odt-suppress-xref nil)
  1177. (href (org-xml-format-href (concat "#coderef-" ref))))
  1178. (cond
  1179. ((and (numberp lineno-or-ref) (not desc))
  1180. (org-odt-format-link lineno-or-ref href))
  1181. ((and (numberp lineno-or-ref) desc
  1182. (string-match (regexp-quote (concat "(" ref ")")) desc))
  1183. (format (replace-match "%s" t t desc)
  1184. (org-odt-format-link lineno-or-ref href)))
  1185. (t
  1186. (setq desc (format
  1187. (if (and desc (string-match
  1188. (regexp-quote (concat "(" ref ")"))
  1189. desc))
  1190. (replace-match "%s" t t desc)
  1191. (or desc "%s"))
  1192. lineno-or-ref))
  1193. (org-odt-format-link (org-xml-format-desc desc) href)))))
  1194. (t
  1195. (when (string= type "file")
  1196. (setq thefile
  1197. (cond
  1198. ((file-name-absolute-p path)
  1199. (concat "file://" (expand-file-name path)))
  1200. (t (org-odt-relocate-relative-path
  1201. thefile org-current-export-file)))))
  1202. (when (and (member type '("" "http" "https" "file")) fragment)
  1203. (setq thefile (concat thefile "#" fragment)))
  1204. (setq thefile (org-xml-format-href thefile))
  1205. (when (not (member type '("" "file")))
  1206. (setq thefile (concat type ":" thefile)))
  1207. (let ((org-odt-suppress-xref nil))
  1208. (org-odt-format-link
  1209. (org-xml-format-desc desc) thefile attr)))))))
  1210. (defun org-odt-format-heading (text level &optional id)
  1211. (let* ((text (if id (org-odt-format-target text id) text)))
  1212. (org-odt-format-tags
  1213. '("<text:h text:style-name=\"Heading_20_%s\" text:outline-level=\"%s\">" .
  1214. "</text:h>") text level level)))
  1215. (defun org-odt-format-headline (title extra-targets tags
  1216. &optional snumber level)
  1217. (concat
  1218. (org-lparse-format 'EXTRA-TARGETS extra-targets)
  1219. ;; No need to generate section numbers. They are auto-generated by
  1220. ;; the application
  1221. ;; (concat (org-lparse-format 'SECTION-NUMBER snumber level) " ")
  1222. title
  1223. (and tags (concat (org-lparse-format 'SPACES 3)
  1224. (org-lparse-format 'ORG-TAGS tags)))))
  1225. (defun org-odt-format-anchor (text name &optional class)
  1226. (org-odt-format-target text name))
  1227. (defun org-odt-format-bookmark (text id)
  1228. (if id
  1229. (org-odt-format-tags "<text:bookmark text:name=\"%s\"/>" text id)
  1230. text))
  1231. (defun org-odt-format-target (text id)
  1232. (let ((name (concat org-export-odt-bookmark-prefix id)))
  1233. (concat
  1234. (and id (org-odt-format-tags
  1235. "<text:bookmark-start text:name=\"%s\"/>" "" name))
  1236. (org-odt-format-bookmark text id)
  1237. (and id (org-odt-format-tags
  1238. "<text:bookmark-end text:name=\"%s\"/>" "" name)))))
  1239. (defun org-odt-format-footnote (n def)
  1240. (let ((id (concat "fn" n))
  1241. (note-class "footnote")
  1242. (par-style "Footnote"))
  1243. (org-odt-format-tags
  1244. '("<text:note text:id=\"%s\" text:note-class=\"%s\">" .
  1245. "</text:note>")
  1246. (concat
  1247. (org-odt-format-tags
  1248. '("<text:note-citation>" . "</text:note-citation>")
  1249. n)
  1250. (org-odt-format-tags
  1251. '("<text:note-body>" . "</text:note-body>")
  1252. def))
  1253. id note-class)))
  1254. (defun org-odt-format-footnote-reference (n def refcnt)
  1255. (if (= refcnt 1)
  1256. (org-odt-format-footnote n def)
  1257. (org-odt-format-footnote-ref n)))
  1258. (defun org-odt-format-footnote-ref (n)
  1259. (let ((note-class "footnote")
  1260. (ref-format "text")
  1261. (ref-name (concat "fn" n)))
  1262. (org-odt-format-tags
  1263. '("<text:span text:style-name=\"%s\">" . "</text:span>")
  1264. (org-odt-format-tags
  1265. '("<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">" . "</text:note-ref>")
  1266. n note-class ref-format ref-name)
  1267. "OrgSuperscript")))
  1268. (defun org-odt-get-image-name (file-name)
  1269. (require 'sha1)
  1270. (file-relative-name
  1271. (expand-file-name
  1272. (concat (sha1 file-name) "." (file-name-extension file-name)) "Pictures")))
  1273. (defun org-export-odt-format-image (src href &optional embed-as)
  1274. "Create image tag with source and attributes."
  1275. (save-match-data
  1276. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1277. (caption (and caption (org-xml-format-desc caption)))
  1278. (attr (org-find-text-property-in-string 'org-attributes src))
  1279. (label (org-find-text-property-in-string 'org-label src))
  1280. (embed-as (or embed-as
  1281. (if (org-find-text-property-in-string
  1282. 'org-latex-src src)
  1283. (or (org-find-text-property-in-string
  1284. 'org-latex-src-embed-type src) 'character)
  1285. 'paragraph)))
  1286. (attr-plist (when attr (read attr)))
  1287. (size (org-odt-image-size-from-file
  1288. src (plist-get attr-plist :width)
  1289. (plist-get attr-plist :height)
  1290. (plist-get attr-plist :scale) nil embed-as))
  1291. (width (car size)) (height (cdr size)))
  1292. (cond
  1293. ((not (or caption label))
  1294. (case embed-as
  1295. (paragraph (org-odt-format-entity "DisplayImage" href width height))
  1296. (character (org-odt-format-entity "InlineImage" href width height))
  1297. (t (error "Unknown value for embed-as %S" embed-as))))
  1298. (t
  1299. (org-odt-format-entity
  1300. "CaptionedDisplayImage" href width height caption label))))))
  1301. (defun org-odt-format-frame (text width height style &optional
  1302. extra anchor-type)
  1303. (let ((frame-attrs
  1304. (concat
  1305. (if width (format " svg:width=\"%0.2fcm\"" width) "")
  1306. (if height (format " svg:height=\"%0.2fcm\"" height) "")
  1307. extra
  1308. (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph")))))
  1309. (org-odt-format-tags
  1310. '("<draw:frame draw:style-name=\"%s\"%s>" . "</draw:frame>")
  1311. text style frame-attrs)))
  1312. (defun org-odt-format-textbox (text width height style &optional
  1313. extra anchor-type)
  1314. (org-odt-format-frame
  1315. (org-odt-format-tags
  1316. '("<draw:text-box %s>" . "</draw:text-box>")
  1317. text (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
  1318. (format " fo:min-width=\"%0.2fcm\"" (or width .2))))
  1319. width nil style extra anchor-type))
  1320. (defun org-odt-format-inlinetask (heading content
  1321. &optional todo priority tags)
  1322. (org-odt-format-stylized-paragraph
  1323. nil (org-odt-format-textbox
  1324. (concat (org-odt-format-stylized-paragraph
  1325. "OrgInlineTaskHeading"
  1326. (org-lparse-format
  1327. 'HEADLINE (concat (org-lparse-format-todo todo) " " heading)
  1328. nil tags))
  1329. content) nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
  1330. (defvar org-odt-entity-frame-styles
  1331. '(("InlineImage" "Figure" ("OrgInlineImage" nil "as-char"))
  1332. ("DisplayImage" "Figure" ("OrgDisplayImage" nil "paragraph"))
  1333. ("CaptionedDisplayImage" "Figure"
  1334. ("OrgCaptionedImage"
  1335. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1336. ("OrgImageCaptionFrame"))
  1337. ("InlineFormula" "Equation" ("OrgInlineFormula" nil "as-char"))
  1338. ("DisplayFormula" "Equation" ("OrgDisplayFormula" nil "as-char"))
  1339. ("CaptionedDisplayFormula" "Equation"
  1340. ("OrgCaptionedFormula" nil "paragraph")
  1341. ("OrgFormulaCaptionFrame" nil "as-char"))))
  1342. (defun org-odt-format-entity (entity href width height &optional caption label)
  1343. (let* ((entity-style (assoc entity org-odt-entity-frame-styles))
  1344. (entity-frame (apply 'org-odt-format-frame
  1345. href width height (nth 2 entity-style))))
  1346. (if (not (or caption label)) entity-frame
  1347. (apply 'org-odt-format-textbox
  1348. (org-odt-format-stylized-paragraph
  1349. 'illustration
  1350. (concat entity-frame (org-odt-format-entity-caption
  1351. label caption (nth 1 entity-style))))
  1352. width height (nth 3 entity-style)))))
  1353. (defvar org-odt-embedded-images-count 0)
  1354. (defun org-odt-copy-image-file (path)
  1355. "Returns the internal name of the file"
  1356. (let* ((image-type (file-name-extension path))
  1357. (media-type (format "image/%s" image-type))
  1358. (src-file (expand-file-name
  1359. path (file-name-directory org-current-export-file)))
  1360. (target-dir "Images/")
  1361. (target-file
  1362. (format "%s%04d.%s" target-dir
  1363. (incf org-odt-embedded-images-count) image-type)))
  1364. (when (not org-lparse-to-buffer)
  1365. (message "Embedding %s as %s ..."
  1366. (substring-no-properties path) target-file)
  1367. (when (= 1 org-odt-embedded-images-count)
  1368. (make-directory target-dir)
  1369. (org-odt-create-manifest-file-entry "" target-dir))
  1370. (copy-file src-file target-file 'overwrite)
  1371. (org-odt-create-manifest-file-entry media-type target-file))
  1372. target-file))
  1373. (defvar org-export-odt-image-size-probe-method
  1374. '(emacs imagemagick force)
  1375. "Ordered list of methods by for determining size of an embedded
  1376. image.")
  1377. (defvar org-export-odt-default-image-sizes-alist
  1378. '(("character" . (5 . 0.4))
  1379. ("paragraph" . (5 . 5)))
  1380. "Hardcoded image dimensions one for each of the anchor
  1381. methods.")
  1382. (defun org-odt-do-image-size (probe-method file &optional dpi anchor-type)
  1383. (setq dpi (or dpi org-export-odt-pixels-per-inch))
  1384. (setq anchor-type (or anchor-type "paragraph"))
  1385. (flet ((size-in-cms (size-in-pixels)
  1386. (flet ((pixels-to-cms (pixels)
  1387. (let* ((cms-per-inch 2.54)
  1388. (inches (/ pixels dpi)))
  1389. (* cms-per-inch inches))))
  1390. (and size-in-pixels
  1391. (cons (pixels-to-cms (car size-in-pixels))
  1392. (pixels-to-cms (cdr size-in-pixels)))))))
  1393. (case probe-method
  1394. (emacs
  1395. (size-in-cms (ignore-errors (image-size (create-image file) 'pixels))))
  1396. (imagemagick
  1397. (size-in-cms
  1398. (let ((dim (shell-command-to-string
  1399. (format "identify -format \"%%w:%%h\" \"%s\"" file))))
  1400. (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
  1401. (cons (string-to-number (match-string 1 dim))
  1402. (string-to-number (match-string 2 dim)))))))
  1403. (t
  1404. (cdr (assoc-string anchor-type
  1405. org-export-odt-default-image-sizes-alist))))))
  1406. (defun org-odt-image-size-from-file (file &optional user-width
  1407. user-height scale dpi embed-as)
  1408. (unless (file-name-absolute-p file)
  1409. (setq file (expand-file-name
  1410. file (file-name-directory org-current-export-file))))
  1411. (let* (size width height)
  1412. (unless (and user-height user-width)
  1413. (loop for probe-method in org-export-odt-image-size-probe-method
  1414. until size
  1415. do (setq size (org-odt-do-image-size
  1416. probe-method file dpi embed-as)))
  1417. (or size (error "Cannot determine Image size. Aborting ..."))
  1418. (setq width (car size) height (cdr size)))
  1419. (cond
  1420. (scale
  1421. (setq width (* width scale) height (* height scale)))
  1422. ((and user-height user-width)
  1423. (setq width user-width height user-height))
  1424. (user-height
  1425. (setq width (* user-height (/ width height)) height user-height))
  1426. (user-width
  1427. (setq height (* user-width (/ height width)) width user-width))
  1428. (t (ignore)))
  1429. (cons width height)))
  1430. (defvar org-odt-entity-labels-alist nil
  1431. "Associate Labels with the Labelled entities.
  1432. Each element of the alist is of the form (LABEL-NAME
  1433. CATEGORY-NAME SEQNO). LABEL-NAME is same as that specified by
  1434. \"#+LABEL: ...\" line. CATEGORY-NAME is the type of the entity
  1435. that LABEL-NAME is attached to. CATEGORY-NAME can be one of
  1436. \"Table\", \"Figure\" or \"Equation\". SEQNO is the unique
  1437. number assigned to the referenced entity on a per-CATEGORY basis.
  1438. It is generated sequentially and is 1-based.
  1439. Update this alist with `org-odt-add-label-definition' and
  1440. retrieve an entry with `org-odt-get-label-definition'.")
  1441. (defvar org-odt-entity-counts-plist nil
  1442. "Plist of running counters of SEQNOs for each of the CATEGORY-NAMEs.
  1443. See `org-odt-entity-labels-alist' for known CATEGORY-NAMEs.")
  1444. (defvar org-odt-label-def-ref-spec
  1445. '(("Equation" "(%n)" "text" "(%n)")
  1446. ("" "%e %n%c" "category-and-value" "%e %n"))
  1447. "Specify how labels are applied and referenced.
  1448. This is an alist where each element is of the form (CATEGORY-NAME
  1449. LABEL-APPLY-FMT LABEL-REF-MODE LABEL-REF-FMT). CATEGORY-NAME is
  1450. as defined in `org-odt-entity-labels-alist'. It can additionally
  1451. be an empty string in which case it is used as a catch-all
  1452. specifier.
  1453. LABEL-APPLY-FMT is used for applying labels and captions. It may
  1454. contain following specifiers - %e, %n and %c. %e is replaced
  1455. with the CATEGORY-NAME. %n is replaced with \"<text:sequence
  1456. ...> SEQNO </text:sequence>\". %c is replaced with CAPTION. See
  1457. `org-odt-format-label-definition'.
  1458. LABEL-REF-MODE and LABEL-REF-FMT are used for generating the
  1459. following label reference - \"<text:sequence-ref
  1460. text:reference-format=\"LABEL-REF-MODE\" ...> LABEL-REF-FMT
  1461. </text:sequence-ref>\". LABEL-REF-FMT may contain following
  1462. specifiers - %e and %n. %e is replaced with the CATEGORY-NAME. %n is
  1463. replaced with SEQNO. See `org-odt-format-label-reference'.")
  1464. (defun org-odt-add-label-definition (label category)
  1465. "Return (SEQNO . LABEL-APPLY-FMT).
  1466. See `org-odt-label-def-ref-spec'."
  1467. (setq label (substring-no-properties label))
  1468. (let (seqno label-props fmt (category-sym (intern category)))
  1469. (setq seqno (1+ (plist-get org-odt-entity-counts-plist category-sym))
  1470. org-odt-entity-counts-plist (plist-put org-odt-entity-counts-plist
  1471. category-sym seqno)
  1472. fmt (cadr (or (assoc-string category org-odt-label-def-ref-spec t)
  1473. (assoc-string "" org-odt-label-def-ref-spec t)))
  1474. label-props (list label category seqno))
  1475. (push label-props org-odt-entity-labels-alist)
  1476. (cons seqno fmt)))
  1477. (defun org-odt-get-label-definition (label)
  1478. "Return (LABEL-NAME CATEGORY-NAME SEQNO LABEL-REF-MODE LABEL-REF-FMT).
  1479. See `org-odt-entity-labels-alist' and
  1480. `org-odt-label-def-ref-spec'."
  1481. (let* ((label-props (assoc label org-odt-entity-labels-alist))
  1482. (category (nth 1 label-props)))
  1483. (unless label-props
  1484. (org-lparse-warn
  1485. (format "Unable to resolve reference to label \"%s\"" label)))
  1486. (when label-props
  1487. (append label-props
  1488. (cddr (or (assoc-string category org-odt-label-def-ref-spec t)
  1489. (assoc-string "" org-odt-label-def-ref-spec t)))))))
  1490. (defun org-odt-format-label-definition (label category caption)
  1491. (assert label)
  1492. (let* ((label-props (org-odt-add-label-definition label category))
  1493. (seqno (car label-props))
  1494. (fmt (cdr label-props)))
  1495. (or (format-spec
  1496. fmt
  1497. `((?e . ,category)
  1498. (?n . ,(org-odt-format-tags
  1499. '("<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">" . "</text:sequence>")
  1500. (format "%d" seqno) label category category))
  1501. (?c . ,(or (and caption (concat ": " caption)) ""))))
  1502. caption "")))
  1503. (defun org-odt-format-label-reference (label category seqno fmt1 fmt2)
  1504. (assert label)
  1505. (save-match-data
  1506. (org-odt-format-tags
  1507. '("<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">"
  1508. . "</text:sequence-ref>")
  1509. (format-spec fmt2 `((?e . ,category)
  1510. (?n . ,(format "%d" seqno)))) fmt1 label)))
  1511. (defun org-odt-fixup-label-references ()
  1512. (goto-char (point-min))
  1513. (while (re-search-forward
  1514. "<text:sequence-ref text:ref-name=\"\\([^\"]+\\)\"/>" nil t)
  1515. (let* ((label (match-string 1))
  1516. (label-def (org-odt-get-label-definition label))
  1517. (rpl (and label-def
  1518. (apply 'org-odt-format-label-reference label-def))))
  1519. (when rpl (replace-match rpl t t)))))
  1520. (defun org-odt-format-entity-caption (label caption category)
  1521. (or (and label (org-odt-format-label-definition label category caption))
  1522. caption ""))
  1523. (defun org-odt-format-tags (tag text &rest args)
  1524. (let ((prefix (when org-lparse-encode-pending "@"))
  1525. (suffix (when org-lparse-encode-pending "@")))
  1526. (apply 'org-lparse-format-tags tag text prefix suffix args)))
  1527. (defun org-odt-init-outfile (filename)
  1528. (unless (executable-find "zip")
  1529. ;; Not at all OSes ship with zip by default
  1530. (error "Executable \"zip\" needed for creating OpenDocument files"))
  1531. (let* ((outdir (make-temp-file org-export-odt-tmpdir-prefix t))
  1532. (content-file (expand-file-name "content.xml" outdir)))
  1533. ;; init conten.xml
  1534. (with-current-buffer (find-file-noselect content-file t))
  1535. ;; reset variables
  1536. (setq org-odt-manifest-file-entries nil
  1537. org-odt-embedded-images-count 0
  1538. org-odt-embedded-formulas-count 0
  1539. org-odt-entity-labels-alist nil
  1540. org-odt-entity-counts-plist (list 'Table 0 'Equation 0 'Figure 0))
  1541. content-file))
  1542. (defcustom org-export-odt-prettify-xml nil
  1543. "Specify whether or not the xml output should be prettified.
  1544. When this option is turned on, `indent-region' is run on all
  1545. component xml buffers before they are saved. Turn this off for
  1546. regular use. Turn this on if you need to examine the xml
  1547. visually."
  1548. :group 'org-export-odt
  1549. :type 'boolean)
  1550. (defvar hfy-user-sheet-assoc) ; bound during org-do-lparse
  1551. (defun org-odt-save-as-outfile (target opt-plist)
  1552. ;; create mimetype file
  1553. (write-region "application/vnd.oasis.opendocument.text" nil
  1554. (expand-file-name "mimetype"))
  1555. ;; write meta file
  1556. (org-odt-update-meta-file opt-plist)
  1557. ;; write styles file
  1558. (org-odt-copy-styles-file)
  1559. ;; Update styles.xml - take care of outline numbering
  1560. (with-current-buffer
  1561. (find-file-noselect (expand-file-name "styles.xml") t)
  1562. ;; Don't make automatic backup of styles.xml file. This setting
  1563. ;; prevents the backedup styles.xml file from being zipped in to
  1564. ;; odt file. This is more of a hackish fix. Better alternative
  1565. ;; would be to fix the zip command so that the output odt file
  1566. ;; includes only the needed files and excludes any auto-generated
  1567. ;; extra files like backups and auto-saves etc etc. Note that
  1568. ;; currently the zip command zips up the entire temp directory so
  1569. ;; that any auto-generated files created under the hood ends up in
  1570. ;; the resulting odt file.
  1571. (set (make-local-variable 'backup-inhibited) t)
  1572. ;; Import local setting of `org-export-with-section-numbers'
  1573. (org-lparse-bind-local-variables opt-plist)
  1574. (org-odt-configure-outline-numbering
  1575. (if org-export-with-section-numbers org-export-headline-levels 0)))
  1576. ;; Write custom stlyes for source blocks
  1577. (org-odt-insert-custom-styles-for-srcblocks
  1578. (mapconcat
  1579. (lambda (style)
  1580. (format " %s\n" (cddr style)))
  1581. hfy-user-sheet-assoc ""))
  1582. ;; create a manifest entry for content.xml
  1583. (org-odt-create-manifest-file-entry
  1584. "application/vnd.oasis.opendocument.text" "/" "1.2")
  1585. (org-odt-create-manifest-file-entry "text/xml" "content.xml")
  1586. ;; write out the manifest entries before zipping
  1587. (org-odt-write-manifest-file)
  1588. (let ((xml-files '("mimetype" "META-INF/manifest.xml" "content.xml"
  1589. "meta.xml" "styles.xml"))
  1590. (zipdir default-directory))
  1591. (message "Switching to directory %s" (expand-file-name zipdir))
  1592. ;; save all xml files
  1593. (mapc (lambda (file)
  1594. (with-current-buffer
  1595. (find-file-noselect (expand-file-name file) t)
  1596. ;; prettify output if needed
  1597. (when org-export-odt-prettify-xml
  1598. (indent-region (point-min) (point-max)))
  1599. (save-buffer 0)))
  1600. xml-files)
  1601. (let* ((target-name (file-name-nondirectory target))
  1602. (target-dir (file-name-directory target))
  1603. (cmds `(("zip" "-mX0" ,target-name "mimetype")
  1604. ("zip" "-rmTq" ,target-name "."))))
  1605. (when (file-exists-p target)
  1606. ;; FIXME: If the file is locked this throws a cryptic error
  1607. (delete-file target))
  1608. (let ((coding-system-for-write 'no-conversion) exitcode err-string)
  1609. (message "Creating odt file...")
  1610. (mapc
  1611. (lambda (cmd)
  1612. (message "Running %s" (mapconcat 'identity cmd " "))
  1613. (setq err-string
  1614. (with-output-to-string
  1615. (setq exitcode
  1616. (apply 'call-process (car cmd)
  1617. nil standard-output nil (cdr cmd)))))
  1618. (or (zerop exitcode)
  1619. (ignore (message "%s" err-string))
  1620. (error "Unable to create odt file (%S)" exitcode)))
  1621. cmds))
  1622. ;; move the file from outdir to target-dir
  1623. (rename-file target-name target-dir)
  1624. ;; kill all xml buffers
  1625. (mapc (lambda (file)
  1626. (kill-buffer
  1627. (find-file-noselect (expand-file-name file zipdir) t)))
  1628. xml-files)
  1629. (delete-directory zipdir)))
  1630. (message "Created %s" target)
  1631. (set-buffer (find-file-noselect target t)))
  1632. (defun org-odt-format-date (date)
  1633. (let ((warning-msg
  1634. "OpenDocument files require that dates be in ISO-8601 format. Please review your DATE options for compatibility."))
  1635. ;; If the user is not careful with the date specification, an
  1636. ;; invalid meta.xml will be emitted.
  1637. ;; For now honor user's diktat and let him off with a warning
  1638. ;; message. This is OK as LibreOffice (and possibly other
  1639. ;; apps) doesn't deem this deviation as critical and continue
  1640. ;; to load the file.
  1641. ;; FIXME: Surely there a better way to handle this. Revisit this
  1642. ;; later.
  1643. (cond
  1644. ((and date (string-match "%" date))
  1645. ;; Honor user's diktat. See comments above
  1646. (org-lparse-warn warning-msg)
  1647. (format-time-string date))
  1648. (date
  1649. ;; Honor user's diktat. See comments above
  1650. (org-lparse-warn warning-msg)
  1651. date)
  1652. (t
  1653. ;; ISO 8601 format
  1654. (let ((stamp (format-time-string "%Y-%m-%dT%H:%M:%S%z")))
  1655. (format "%s:%s" (substring stamp 0 -2) (substring stamp -2)))))))
  1656. (defconst org-odt-manifest-file-entry-tag
  1657. "
  1658. <manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
  1659. (defvar org-odt-manifest-file-entries nil)
  1660. (defun org-odt-create-manifest-file-entry (&rest args)
  1661. (push args org-odt-manifest-file-entries))
  1662. (defun org-odt-write-manifest-file ()
  1663. (make-directory "META-INF")
  1664. (let ((manifest-file (expand-file-name "META-INF/manifest.xml")))
  1665. (write-region
  1666. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  1667. <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n"
  1668. nil manifest-file)
  1669. (mapc
  1670. (lambda (file-entry)
  1671. (let* ((version (nth 2 file-entry))
  1672. (extra (if version
  1673. (format " manifest:version=\"%s\"" version)
  1674. "")))
  1675. (write-region
  1676. (format org-odt-manifest-file-entry-tag
  1677. (nth 0 file-entry) (nth 1 file-entry) extra)
  1678. nil manifest-file t))) org-odt-manifest-file-entries)
  1679. (write-region "\n</manifest:manifest>" nil manifest-file t)))
  1680. (defun org-odt-update-meta-file (opt-plist)
  1681. (let ((date (org-odt-format-date (plist-get opt-plist :date)))
  1682. (author (or (plist-get opt-plist :author) ""))
  1683. (email (plist-get opt-plist :email))
  1684. (keywords (plist-get opt-plist :keywords))
  1685. (description (plist-get opt-plist :description))
  1686. (title (plist-get opt-plist :title)))
  1687. (write-region
  1688. (concat
  1689. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  1690. <office:document-meta
  1691. xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
  1692. xmlns:xlink=\"http://www.w3.org/1999/xlink\"
  1693. xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
  1694. xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
  1695. xmlns:ooo=\"http://openoffice.org/2004/office\"
  1696. office:version=\"1.2\">
  1697. <office:meta>" "\n"
  1698. (org-odt-format-tags '("<dc:creator>" . "</dc:creator>") author)
  1699. (org-odt-format-tags
  1700. '("\n<meta:initial-creator>" . "</meta:initial-creator>") author)
  1701. (org-odt-format-tags '("\n<dc:date>" . "</dc:date>") date)
  1702. (org-odt-format-tags
  1703. '("\n<meta:creation-date>" . "</meta:creation-date>") date)
  1704. (org-odt-format-tags '("\n<meta:generator>" . "</meta:generator>")
  1705. (when org-export-creator-info
  1706. (format "Org-%s/Emacs-%s"
  1707. org-version emacs-version)))
  1708. (org-odt-format-tags '("\n<meta:keyword>" . "</meta:keyword>") keywords)
  1709. (org-odt-format-tags '("\n<dc:subject>" . "</dc:subject>") description)
  1710. (org-odt-format-tags '("\n<dc:title>" . "</dc:title>") title)
  1711. "\n"
  1712. " </office:meta>" "</office:document-meta>")
  1713. nil (expand-file-name "meta.xml")))
  1714. ;; create a manifest entry for meta.xml
  1715. (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
  1716. (defun org-odt-finalize-outfile ()
  1717. (org-odt-delete-empty-paragraphs))
  1718. (defun org-odt-delete-empty-paragraphs ()
  1719. (goto-char (point-min))
  1720. (let ((open "<text:p[^>]*>")
  1721. (close "</text:p>"))
  1722. (while (re-search-forward (format "%s[ \r\n\t]*%s" open close) nil t)
  1723. (replace-match ""))))
  1724. (defun org-odt-get (what &optional opt-plist)
  1725. (case what
  1726. (BACKEND 'odt)
  1727. (EXPORT-DIR (org-export-directory :html opt-plist))
  1728. (FILE-NAME-EXTENSION "odt")
  1729. (EXPORT-BUFFER-NAME "*Org ODT Export*")
  1730. (ENTITY-CONTROL org-odt-entity-control-callbacks-alist)
  1731. (ENTITY-FORMAT org-odt-entity-format-callbacks-alist)
  1732. (INIT-METHOD 'org-odt-init-outfile)
  1733. (FINAL-METHOD 'org-odt-finalize-outfile)
  1734. (SAVE-METHOD 'org-odt-save-as-outfile)
  1735. ;; (OTHER-BACKENDS) ; see note in `org-xhtml-get'
  1736. ;; (CONVERT-METHOD) ; see note in `org-xhtml-get'
  1737. (TOPLEVEL-HLEVEL 1)
  1738. (SPECIAL-STRING-REGEXPS org-export-odt-special-string-regexps)
  1739. (INLINE-IMAGES 'maybe)
  1740. (INLINE-IMAGE-EXTENSIONS '("png" "jpeg" "jpg" "gif" "svg"))
  1741. (PLAIN-TEXT-MAP '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
  1742. (TABLE-FIRST-COLUMN-AS-LABELS nil)
  1743. (FOOTNOTE-SEPARATOR (org-lparse-format 'FONTIFY "," 'superscript))
  1744. (CODING-SYSTEM-FOR-WRITE 'utf-8)
  1745. (CODING-SYSTEM-FOR-SAVE 'utf-8)
  1746. (t (error "Unknown property: %s" what))))
  1747. (defvar org-lparse-latex-fragment-fallback) ; set by org-do-lparse
  1748. (defvar org-lparse-opt-plist) ; bound during org-do-lparse
  1749. (defun org-export-odt-do-preprocess-latex-fragments ()
  1750. "Convert LaTeX fragments to images."
  1751. (let* ((latex-frag-opt (plist-get org-lparse-opt-plist :LaTeX-fragments))
  1752. (latex-frag-opt ; massage the options
  1753. (or (and (member latex-frag-opt '(mathjax t))
  1754. (not (and (fboundp 'org-format-latex-mathml-available-p)
  1755. (org-format-latex-mathml-available-p)))
  1756. (prog1 org-lparse-latex-fragment-fallback
  1757. (org-lparse-warn
  1758. (concat
  1759. "LaTeX to MathML converter not available. "
  1760. (format "Using %S instead."
  1761. org-lparse-latex-fragment-fallback)))))
  1762. latex-frag-opt))
  1763. cache-dir display-msg)
  1764. (cond
  1765. ((eq latex-frag-opt 'dvipng)
  1766. (setq cache-dir "ltxpng/")
  1767. (setq display-msg "Creating LaTeX image %s"))
  1768. ((member latex-frag-opt '(mathjax t))
  1769. (setq latex-frag-opt 'mathml)
  1770. (setq cache-dir "ltxmathml/")
  1771. (setq display-msg "Creating MathML formula %s")))
  1772. (when (and org-current-export-file)
  1773. (org-format-latex
  1774. (concat cache-dir (file-name-sans-extension
  1775. (file-name-nondirectory org-current-export-file)))
  1776. org-current-export-dir nil display-msg
  1777. nil nil latex-frag-opt))))
  1778. (defun org-export-odt-preprocess-latex-fragments ()
  1779. (when (equal org-export-current-backend 'odt)
  1780. (org-export-odt-do-preprocess-latex-fragments)))
  1781. (defun org-export-odt-preprocess-label-references ()
  1782. (goto-char (point-min))
  1783. (let (label label-components category value pretty-label)
  1784. (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
  1785. (org-if-unprotected-at (match-beginning 1)
  1786. (replace-match
  1787. (let ((org-lparse-encode-pending t)
  1788. (label (match-string 1)))
  1789. ;; markup generated below is mostly an eye-candy. At
  1790. ;; pre-processing stage, there is no information on which
  1791. ;; entity a label reference points to. The actual markup
  1792. ;; is generated as part of `org-odt-fixup-label-references'
  1793. ;; which gets called at the fag end of export. By this
  1794. ;; time we would have seen and collected all the label
  1795. ;; definitions in `org-odt-entity-labels-alist'.
  1796. (org-odt-format-tags
  1797. "<text:sequence-ref text:ref-name=\"%s\"/>" "" label)) t t)))))
  1798. ;; process latex fragments as part of
  1799. ;; `org-export-preprocess-after-blockquote-hook'. Note that this hook
  1800. ;; is the one that is closest and well before the call to
  1801. ;; `org-export-attach-captions-and-attributes' in
  1802. ;; `org-export-preprocess-stirng'. The above arrangement permits
  1803. ;; captions, labels and attributes to be attached to png images
  1804. ;; generated out of latex equations.
  1805. (add-hook 'org-export-preprocess-after-blockquote-hook
  1806. 'org-export-odt-preprocess-latex-fragments)
  1807. (defun org-export-odt-preprocess (parameters)
  1808. (org-export-odt-preprocess-label-references))
  1809. (declare-function archive-zip-extract "arc-mode.el" (archive name))
  1810. (defun org-odt-zip-extract-one (archive member &optional target)
  1811. (require 'arc-mode)
  1812. (let* ((target (or target default-directory))
  1813. (archive (expand-file-name archive))
  1814. (archive-zip-extract
  1815. (list "unzip" "-qq" "-o" "-d" target))
  1816. exit-code command-output)
  1817. (setq command-output
  1818. (with-temp-buffer
  1819. (setq exit-code (archive-zip-extract archive member))
  1820. (buffer-string)))
  1821. (unless (zerop exit-code)
  1822. (message command-output)
  1823. (error "Extraction failed"))))
  1824. (defun org-odt-zip-extract (archive members &optional target)
  1825. (when (atom members) (setq members (list members)))
  1826. (mapc (lambda (member)
  1827. (org-odt-zip-extract-one archive member target))
  1828. members))
  1829. (defun org-odt-copy-styles-file (&optional styles-file)
  1830. ;; Non-availability of styles.xml is not a critical error. For now
  1831. ;; throw an error purely for aesthetic reasons.
  1832. (setq styles-file (or styles-file
  1833. org-export-odt-styles-file
  1834. (expand-file-name "styles/OrgOdtStyles.xml"
  1835. org-odt-data-dir)
  1836. (error "org-odt: Missing styles file?")))
  1837. (cond
  1838. ((listp styles-file)
  1839. (let ((archive (nth 0 styles-file))
  1840. (members (nth 1 styles-file)))
  1841. (org-odt-zip-extract archive members)
  1842. (mapc
  1843. (lambda (member)
  1844. (when (org-file-image-p member)
  1845. (let* ((image-type (file-name-extension member))
  1846. (media-type (format "image/%s" image-type)))
  1847. (org-odt-create-manifest-file-entry media-type member))))
  1848. members)))
  1849. ((and (stringp styles-file) (file-exists-p styles-file))
  1850. (let ((styles-file-type (file-name-extension styles-file)))
  1851. (cond
  1852. ((string= styles-file-type "xml")
  1853. (copy-file styles-file "styles.xml" t))
  1854. ((member styles-file-type '("odt" "ott"))
  1855. (org-odt-zip-extract styles-file "styles.xml")))))
  1856. (t
  1857. (error (format "Invalid specification of styles.xml file: %S"
  1858. org-export-odt-styles-file))))
  1859. ;; create a manifest entry for styles.xml
  1860. (org-odt-create-manifest-file-entry "text/xml" "styles.xml"))
  1861. (defvar org-export-odt-factory-settings
  1862. "d4328fb9d1b6cb211d4320ff546829f26700dc5e"
  1863. "SHA1 hash of OrgOdtStyles.xml.")
  1864. (defun org-odt-configure-outline-numbering (level)
  1865. "Outline numbering is retained only upto LEVEL.
  1866. To disable outline numbering pass a LEVEL of 0."
  1867. (goto-char (point-min))
  1868. (let ((regex
  1869. "<text:outline-level-style\\(.*\\)text:level=\"\\([^\"]*\\)\"\\(.*\\)>")
  1870. (replacement
  1871. "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
  1872. (while (re-search-forward regex nil t)
  1873. (when (> (string-to-number (match-string 2)) level)
  1874. (replace-match replacement t nil))))
  1875. (save-buffer 0))
  1876. (provide 'org-odt)
  1877. ;;; org-odt.el ends here