org-odt.el 104 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801
  1. ;;; org-odt.el --- OpenDocument Text exporter for Org-mode
  2. ;; Copyright (C) 2010-2012 Free Software Foundation, Inc.
  3. ;; Author: Jambunathan K <kjambunathan at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;;; Code:
  19. (eval-when-compile
  20. (require 'cl))
  21. (require 'org-lparse)
  22. (defgroup org-export-odt nil
  23. "Options specific for ODT export of Org-mode files."
  24. :tag "Org Export ODT"
  25. :group 'org-export
  26. :version "24.1")
  27. (defvar org-lparse-dyn-first-heading-pos) ; let bound during org-do-lparse
  28. (defun org-odt-insert-toc ()
  29. (goto-char (point-min))
  30. (cond
  31. ((re-search-forward
  32. "\\(<text:p [^>]*>\\)?\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*\\(</text:p>\\)?"
  33. nil t)
  34. (replace-match ""))
  35. (t
  36. (goto-char org-lparse-dyn-first-heading-pos)))
  37. (insert (org-odt-format-toc)))
  38. (defun org-odt-end-export ()
  39. (org-odt-insert-toc)
  40. (org-odt-fixup-label-references)
  41. ;; remove empty paragraphs
  42. (goto-char (point-min))
  43. (while (re-search-forward
  44. "<text:p\\( text:style-name=\"Text_20_body\"\\)?>[ \r\n\t]*</text:p>"
  45. nil t)
  46. (replace-match ""))
  47. (goto-char (point-min))
  48. ;; Convert whitespace place holders
  49. (goto-char (point-min))
  50. (let (beg end n)
  51. (while (setq beg (next-single-property-change (point) 'org-whitespace))
  52. (setq n (get-text-property beg 'org-whitespace)
  53. end (next-single-property-change beg 'org-whitespace))
  54. (goto-char beg)
  55. (delete-region beg end)
  56. (insert (format "<span style=\"visibility:hidden;\">%s</span>"
  57. (make-string n ?x)))))
  58. ;; Remove empty lines at the beginning of the file.
  59. (goto-char (point-min))
  60. (when (looking-at "\\s-+\n") (replace-match ""))
  61. ;; Remove display properties
  62. (remove-text-properties (point-min) (point-max) '(display t)))
  63. (defvar org-odt-suppress-xref nil)
  64. (defconst org-export-odt-special-string-regexps
  65. '(("\\\\-" . "&#x00ad;\\1") ; shy
  66. ("---\\([^-]\\)" . "&#x2014;\\1") ; mdash
  67. ("--\\([^-]\\)" . "&#x2013;\\1") ; ndash
  68. ("\\.\\.\\." . "&#x2026;")) ; hellip
  69. "Regular expressions for special string conversion.")
  70. (defconst org-odt-lib-dir (file-name-directory load-file-name)
  71. "Location of ODT exporter.
  72. Use this to infer values of `org-odt-styles-dir' and
  73. `org-export-odt-schema-dir'.")
  74. (defvar org-odt-data-dir nil
  75. "Data directory for ODT exporter.
  76. Use this to infer values of `org-odt-styles-dir' and
  77. `org-export-odt-schema-dir'.")
  78. (defconst org-odt-schema-dir-list
  79. (list
  80. (and org-odt-data-dir
  81. (expand-file-name "./schema/" org-odt-data-dir)) ; bail out
  82. (eval-when-compile
  83. (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
  84. (expand-file-name "./schema/" org-odt-data-dir)))
  85. (expand-file-name "../contrib/odt/etc/schema/" org-odt-lib-dir) ; git
  86. )
  87. "List of directories to search for OpenDocument schema files.
  88. Use this list to set the default value of
  89. `org-export-odt-schema-dir'. The entries in this list are
  90. populated heuristically based on the values of `org-odt-lib-dir'
  91. and `org-odt-data-dir'.")
  92. (defcustom org-export-odt-schema-dir
  93. (let* ((schema-dir
  94. (catch 'schema-dir
  95. (message "Debug (org-odt): Searching for OpenDocument schema files...")
  96. (mapc
  97. (lambda (schema-dir)
  98. (when schema-dir
  99. (message "Debug (org-odt): Trying %s..." schema-dir)
  100. (when (and (file-readable-p
  101. (expand-file-name "od-manifest-schema-v1.2-cs01.rnc"
  102. schema-dir))
  103. (file-readable-p
  104. (expand-file-name "od-schema-v1.2-cs01.rnc"
  105. schema-dir))
  106. (file-readable-p
  107. (expand-file-name "schemas.xml" schema-dir)))
  108. (message "Debug (org-odt): Using schema files under %s"
  109. schema-dir)
  110. (throw 'schema-dir schema-dir))))
  111. org-odt-schema-dir-list)
  112. (message "Debug (org-odt): No OpenDocument schema files installed")
  113. nil)))
  114. schema-dir)
  115. "Directory that contains OpenDocument schema files.
  116. This directory contains:
  117. 1. rnc files for OpenDocument schema
  118. 2. a \"schemas.xml\" file that specifies locating rules needed
  119. for auto validation of OpenDocument XML files.
  120. Use the customize interface to set this variable. This ensures
  121. that `rng-schema-locating-files' is updated and auto-validation
  122. of OpenDocument XML takes place based on the value
  123. `rng-nxml-auto-validate-flag'.
  124. The default value of this variable varies depending on the
  125. version of org in use and is initialized from
  126. `org-odt-schema-dir-list'. The OASIS schema files are available
  127. only in the org's private git repository. It is *not* bundled
  128. with GNU ELPA tar or standard Emacs distribution."
  129. :type '(choice
  130. (const :tag "Not set" nil)
  131. (directory :tag "Schema directory"))
  132. :group 'org-export-odt
  133. :version "24.1"
  134. :set
  135. (lambda (var value)
  136. "Set `org-export-odt-schema-dir'.
  137. Also add it to `rng-schema-locating-files'."
  138. (let ((schema-dir value))
  139. (set var
  140. (if (and
  141. (file-readable-p
  142. (expand-file-name "od-manifest-schema-v1.2-cs01.rnc" schema-dir))
  143. (file-readable-p
  144. (expand-file-name "od-schema-v1.2-cs01.rnc" schema-dir))
  145. (file-readable-p
  146. (expand-file-name "schemas.xml" schema-dir)))
  147. schema-dir
  148. (when value
  149. (message "Error (org-odt): %s has no OpenDocument schema files"
  150. value))
  151. nil)))
  152. (when org-export-odt-schema-dir
  153. (eval-after-load 'rng-loc
  154. '(add-to-list 'rng-schema-locating-files
  155. (expand-file-name "schemas.xml"
  156. org-export-odt-schema-dir))))))
  157. (defconst org-odt-styles-dir-list
  158. (list
  159. (and org-odt-data-dir
  160. (expand-file-name "./styles/" org-odt-data-dir)) ; bail out
  161. (eval-when-compile
  162. (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
  163. (expand-file-name "./styles/" org-odt-data-dir)))
  164. (expand-file-name "../etc/styles/" org-odt-lib-dir) ; git
  165. (expand-file-name "./etc/styles/" org-odt-lib-dir) ; elpa
  166. (expand-file-name "./org/" data-directory) ; system
  167. )
  168. "List of directories to search for OpenDocument styles files.
  169. See `org-odt-styles-dir'. The entries in this list are populated
  170. heuristically based on the values of `org-odt-lib-dir' and
  171. `org-odt-data-dir'.")
  172. (defconst org-odt-styles-dir
  173. (let* ((styles-dir
  174. (catch 'styles-dir
  175. (message "Debug (org-odt): Searching for OpenDocument styles files...")
  176. (mapc (lambda (styles-dir)
  177. (when styles-dir
  178. (message "Debug (org-odt): Trying %s..." styles-dir)
  179. (when (and (file-readable-p
  180. (expand-file-name
  181. "OrgOdtContentTemplate.xml" styles-dir))
  182. (file-readable-p
  183. (expand-file-name
  184. "OrgOdtStyles.xml" styles-dir)))
  185. (message "Debug (org-odt): Using styles under %s"
  186. styles-dir)
  187. (throw 'styles-dir styles-dir))))
  188. org-odt-styles-dir-list)
  189. nil)))
  190. (unless styles-dir
  191. (error "Error (org-odt): Cannot find factory styles files. Aborting."))
  192. styles-dir)
  193. "Directory that holds auxiliary XML files used by the ODT exporter.
  194. This directory contains the following XML files -
  195. \"OrgOdtStyles.xml\" and \"OrgOdtContentTemplate.xml\". These
  196. XML files are used as the default values of
  197. `org-export-odt-styles-file' and
  198. `org-export-odt-content-template-file'.
  199. The default value of this variable varies depending on the
  200. version of org in use and is initialized from
  201. `org-odt-styles-dir-list'. Note that the user could be using org
  202. from one of: org's own private git repository, GNU ELPA tar or
  203. standard Emacs.")
  204. (defvar org-odt-file-extensions
  205. '(("odt" . "OpenDocument Text")
  206. ("ott" . "OpenDocument Text Template")
  207. ("odm" . "OpenDocument Master Document")
  208. ("ods" . "OpenDocument Spreadsheet")
  209. ("ots" . "OpenDocument Spreadsheet Template")
  210. ("odg" . "OpenDocument Drawing (Graphics)")
  211. ("otg" . "OpenDocument Drawing Template")
  212. ("odp" . "OpenDocument Presentation")
  213. ("otp" . "OpenDocument Presentation Template")
  214. ("odi" . "OpenDocument Image")
  215. ("odf" . "OpenDocument Formula")
  216. ("odc" . "OpenDocument Chart")))
  217. (mapc
  218. (lambda (desc)
  219. ;; Let Org open all OpenDocument files using system-registered app
  220. (add-to-list 'org-file-apps
  221. (cons (concat "\\." (car desc) "\\'") 'system))
  222. ;; Let Emacs open all OpenDocument files in archive mode
  223. (add-to-list 'auto-mode-alist
  224. (cons (concat "\\." (car desc) "\\'") 'archive-mode)))
  225. org-odt-file-extensions)
  226. ;; register the odt exporter with the pre-processor
  227. (add-to-list 'org-export-backends 'odt)
  228. ;; register the odt exporter with org-lparse library
  229. (org-lparse-register-backend 'odt)
  230. (defun org-odt-unload-function ()
  231. (org-lparse-unregister-backend 'odt)
  232. (remove-hook 'org-export-preprocess-after-blockquote-hook
  233. 'org-export-odt-preprocess-latex-fragments)
  234. nil)
  235. (defcustom org-export-odt-content-template-file nil
  236. "Template file for \"content.xml\".
  237. The exporter embeds the exported content just before
  238. \"</office:text>\" element.
  239. If unspecified, the file named \"OrgOdtContentTemplate.xml\"
  240. under `org-odt-styles-dir' is used."
  241. :type 'file
  242. :group 'org-export-odt
  243. :version "24.1")
  244. (defcustom org-export-odt-styles-file nil
  245. "Default styles file for use with ODT export.
  246. Valid values are one of:
  247. 1. nil
  248. 2. path to a styles.xml file
  249. 3. path to a *.odt or a *.ott file
  250. 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
  251. ...))
  252. In case of option 1, an in-built styles.xml is used. See
  253. `org-odt-styles-dir' for more information.
  254. In case of option 3, the specified file is unzipped and the
  255. styles.xml embedded therein is used.
  256. In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
  257. and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
  258. generated odt file. Use relative path for specifying the
  259. FILE-MEMBERS. styles.xml must be specified as one of the
  260. FILE-MEMBERS.
  261. Use options 1, 2 or 3 only if styles.xml alone suffices for
  262. achieving the desired formatting. Use option 4, if the styles.xml
  263. references additional files like header and footer images for
  264. achieving the desired formatting.
  265. Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
  266. a per-file basis. For example,
  267. #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
  268. #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
  269. :group 'org-export-odt
  270. :version "24.1"
  271. :type
  272. '(choice
  273. (const :tag "Factory settings" nil)
  274. (file :must-match t :tag "styles.xml")
  275. (file :must-match t :tag "ODT or OTT file")
  276. (list :tag "ODT or OTT file + Members"
  277. (file :must-match t :tag "ODF Text or Text Template file")
  278. (cons :tag "Members"
  279. (file :tag " Member" "styles.xml")
  280. (repeat (file :tag "Member"))))))
  281. (eval-after-load 'org-exp
  282. '(add-to-list 'org-export-inbuffer-options-extra
  283. '("ODT_STYLES_FILE" :odt-styles-file)))
  284. (defconst org-export-odt-tmpdir-prefix "%s-")
  285. (defconst org-export-odt-bookmark-prefix "OrgXref.")
  286. (defvar org-export-odt-embed-images t
  287. "Should the images be copied in to the odt file or just linked?")
  288. (defvar org-export-odt-inline-images 'maybe)
  289. (defcustom org-export-odt-inline-image-extensions
  290. '("png" "jpeg" "jpg" "gif")
  291. "Extensions of image files that can be inlined into HTML."
  292. :type '(repeat (string :tag "Extension"))
  293. :group 'org-export-odt
  294. :version "24.1")
  295. (defcustom org-export-odt-pixels-per-inch display-pixels-per-inch
  296. "Scaling factor for converting images pixels to inches.
  297. Use this for sizing of embedded images. See Info node `(org)
  298. Images in ODT export' for more information."
  299. :type 'float
  300. :group 'org-export-odt
  301. :version "24.1")
  302. (defcustom org-export-odt-create-custom-styles-for-srcblocks t
  303. "Whether custom styles for colorized source blocks be automatically created.
  304. When this option is turned on, the exporter creates custom styles
  305. for source blocks based on the advice of `htmlfontify'. Creation
  306. of custom styles happen as part of `org-odt-hfy-face-to-css'.
  307. When this option is turned off exporter does not create such
  308. styles.
  309. Use the latter option if you do not want the custom styles to be
  310. based on your current display settings. It is necessary that the
  311. styles.xml already contains needed styles for colorizing to work.
  312. This variable is effective only if
  313. `org-export-odt-fontify-srcblocks' is turned on."
  314. :group 'org-export-odt
  315. :version "24.1"
  316. :type 'boolean)
  317. (defvar org-export-odt-default-org-styles-alist
  318. '((paragraph . ((default . "Text_20_body")
  319. (fixedwidth . "OrgFixedWidthBlock")
  320. (verse . "OrgVerse")
  321. (quote . "Quotations")
  322. (blockquote . "Quotations")
  323. (center . "OrgCenter")
  324. (left . "OrgLeft")
  325. (right . "OrgRight")
  326. (title . "OrgTitle")
  327. (subtitle . "OrgSubtitle")
  328. (footnote . "Footnote")
  329. (src . "OrgSrcBlock")
  330. (illustration . "Illustration")
  331. (table . "Table")
  332. (definition-term . "Text_20_body_20_bold")
  333. (horizontal-line . "Horizontal_20_Line")))
  334. (character . ((bold . "Bold")
  335. (emphasis . "Emphasis")
  336. (code . "OrgCode")
  337. (verbatim . "OrgCode")
  338. (strike . "Strikethrough")
  339. (underline . "Underline")
  340. (subscript . "OrgSubscript")
  341. (superscript . "OrgSuperscript")))
  342. (list . ((ordered . "OrgNumberedList")
  343. (unordered . "OrgBulletedList")
  344. (description . "OrgDescriptionList"))))
  345. "Default styles for various entities.")
  346. (defvar org-export-odt-org-styles-alist org-export-odt-default-org-styles-alist)
  347. (defun org-odt-get-style-name-for-entity (category &optional entity)
  348. (let ((entity (or entity 'default)))
  349. (or
  350. (cdr (assoc entity (cdr (assoc category
  351. org-export-odt-org-styles-alist))))
  352. (cdr (assoc entity (cdr (assoc category
  353. org-export-odt-default-org-styles-alist))))
  354. (error "Cannot determine style name for entity %s of type %s"
  355. entity category))))
  356. (defcustom org-export-odt-preferred-output-format nil
  357. "Automatically post-process to this format after exporting to \"odt\".
  358. Interactive commands `org-export-as-odt' and
  359. `org-export-as-odt-and-open' export first to \"odt\" format and
  360. then use `org-export-odt-convert-process' to convert the
  361. resulting document to this format. During customization of this
  362. variable, the list of valid values are populated based on
  363. `org-export-odt-convert-capabilities'."
  364. :group 'org-export-odt
  365. :version "24.1"
  366. :type '(choice :convert-widget
  367. (lambda (w)
  368. (apply 'widget-convert (widget-type w)
  369. (eval (car (widget-get w :args)))))
  370. `((const :tag "None" nil)
  371. ,@(mapcar (lambda (c)
  372. `(const :tag ,c ,c))
  373. (org-lparse-reachable-formats "odt")))))
  374. ;;;###autoload
  375. (defun org-export-as-odt-and-open (arg)
  376. "Export the outline as ODT and immediately open it with a browser.
  377. If there is an active region, export only the region.
  378. The prefix ARG specifies how many levels of the outline should become
  379. headlines. The default is 3. Lower levels will become bulleted lists."
  380. (interactive "P")
  381. (org-lparse-and-open
  382. (or org-export-odt-preferred-output-format "odt") "odt" arg))
  383. ;;;###autoload
  384. (defun org-export-as-odt-batch ()
  385. "Call the function `org-lparse-batch'.
  386. This function can be used in batch processing as:
  387. emacs --batch
  388. --load=$HOME/lib/emacs/org.el
  389. --eval \"(setq org-export-headline-levels 2)\"
  390. --visit=MyFile --funcall org-export-as-odt-batch"
  391. (org-lparse-batch "odt"))
  392. ;;; org-export-as-odt
  393. ;;;###autoload
  394. (defun org-export-as-odt (arg &optional hidden ext-plist
  395. to-buffer body-only pub-dir)
  396. "Export the outline as a OpenDocumentText file.
  397. If there is an active region, export only the region. The prefix
  398. ARG specifies how many levels of the outline should become
  399. headlines. The default is 3. Lower levels will become bulleted
  400. lists. HIDDEN is obsolete and does nothing.
  401. EXT-PLIST is a property list with external parameters overriding
  402. org-mode's default settings, but still inferior to file-local
  403. settings. When TO-BUFFER is non-nil, create a buffer with that
  404. name and export to that buffer. If TO-BUFFER is the symbol
  405. `string', don't leave any buffer behind but just return the
  406. resulting XML as a string. When BODY-ONLY is set, don't produce
  407. the file header and footer, simply return the content of
  408. <body>...</body>, without even the body tags themselves. When
  409. PUB-DIR is set, use this as the publishing directory."
  410. (interactive "P")
  411. (org-lparse (or org-export-odt-preferred-output-format "odt")
  412. "odt" arg hidden ext-plist to-buffer body-only pub-dir))
  413. (defvar org-odt-entity-control-callbacks-alist
  414. `((EXPORT
  415. . (org-odt-begin-export org-odt-end-export))
  416. (DOCUMENT-CONTENT
  417. . (org-odt-begin-document-content org-odt-end-document-content))
  418. (DOCUMENT-BODY
  419. . (org-odt-begin-document-body org-odt-end-document-body))
  420. (TOC
  421. . (org-odt-begin-toc org-odt-end-toc))
  422. (ENVIRONMENT
  423. . (org-odt-begin-environment org-odt-end-environment))
  424. (FOOTNOTE-DEFINITION
  425. . (org-odt-begin-footnote-definition org-odt-end-footnote-definition))
  426. (TABLE
  427. . (org-odt-begin-table org-odt-end-table))
  428. (TABLE-ROWGROUP
  429. . (org-odt-begin-table-rowgroup org-odt-end-table-rowgroup))
  430. (LIST
  431. . (org-odt-begin-list org-odt-end-list))
  432. (LIST-ITEM
  433. . (org-odt-begin-list-item org-odt-end-list-item))
  434. (OUTLINE
  435. . (org-odt-begin-outline org-odt-end-outline))
  436. (OUTLINE-TEXT
  437. . (org-odt-begin-outline-text org-odt-end-outline-text))
  438. (PARAGRAPH
  439. . (org-odt-begin-paragraph org-odt-end-paragraph)))
  440. "")
  441. (defvar org-odt-entity-format-callbacks-alist
  442. `((EXTRA-TARGETS . org-lparse-format-extra-targets)
  443. (ORG-TAGS . org-lparse-format-org-tags)
  444. (SECTION-NUMBER . org-lparse-format-section-number)
  445. (HEADLINE . org-odt-format-headline)
  446. (TOC-ENTRY . org-odt-format-toc-entry)
  447. (TOC-ITEM . org-odt-format-toc-item)
  448. (TAGS . org-odt-format-tags)
  449. (SPACES . org-odt-format-spaces)
  450. (TABS . org-odt-format-tabs)
  451. (LINE-BREAK . org-odt-format-line-break)
  452. (FONTIFY . org-odt-format-fontify)
  453. (TODO . org-lparse-format-todo)
  454. (LINK . org-odt-format-link)
  455. (INLINE-IMAGE . org-odt-format-inline-image)
  456. (ORG-LINK . org-odt-format-org-link)
  457. (HEADING . org-odt-format-heading)
  458. (ANCHOR . org-odt-format-anchor)
  459. (TABLE . org-lparse-format-table)
  460. (TABLE-ROW . org-odt-format-table-row)
  461. (TABLE-CELL . org-odt-format-table-cell)
  462. (FOOTNOTES-SECTION . ignore)
  463. (FOOTNOTE-REFERENCE . org-odt-format-footnote-reference)
  464. (HORIZONTAL-LINE . org-odt-format-horizontal-line)
  465. (COMMENT . org-odt-format-comment)
  466. (LINE . org-odt-format-line)
  467. (ORG-ENTITY . org-odt-format-org-entity))
  468. "")
  469. ;;;_. callbacks
  470. ;;;_. control callbacks
  471. ;;;_ , document body
  472. (defun org-odt-begin-office-body ()
  473. ;; automatic styles
  474. (insert-file-contents
  475. (or org-export-odt-content-template-file
  476. (expand-file-name "OrgOdtContentTemplate.xml"
  477. org-odt-styles-dir)))
  478. (goto-char (point-min))
  479. (re-search-forward "</office:text>" nil nil)
  480. (delete-region (match-beginning 0) (point-max)))
  481. ;; Following variable is let bound when `org-do-lparse' is in
  482. ;; progress. See org-html.el.
  483. (defvar org-lparse-toc)
  484. (defun org-odt-format-toc ()
  485. (if (not org-lparse-toc) "" (concat "\n" org-lparse-toc "\n")))
  486. (defun org-odt-format-preamble (opt-plist)
  487. (let* ((title (plist-get opt-plist :title))
  488. (author (plist-get opt-plist :author))
  489. (date (plist-get opt-plist :date))
  490. (iso-date (org-odt-format-date date))
  491. (date (org-odt-format-date date "%d %b %Y"))
  492. (email (plist-get opt-plist :email))
  493. ;; switch on or off above vars based on user settings
  494. (author (and (plist-get opt-plist :author-info) (or author email)))
  495. (email (and (plist-get opt-plist :email-info) email))
  496. (date (and (plist-get opt-plist :time-stamp-file) date)))
  497. (concat
  498. ;; title
  499. (when title
  500. (concat
  501. (org-odt-format-stylized-paragraph
  502. 'title (org-odt-format-tags
  503. '("<text:title>" . "</text:title>") title))
  504. ;; separator
  505. "<text:p text:style-name=\"OrgTitle\"/>"))
  506. (cond
  507. ((and author (not email))
  508. ;; author only
  509. (concat
  510. (org-odt-format-stylized-paragraph
  511. 'subtitle
  512. (org-odt-format-tags
  513. '("<text:initial-creator>" . "</text:initial-creator>")
  514. author))
  515. ;; separator
  516. "<text:p text:style-name=\"OrgSubtitle\"/>"))
  517. ((and author email)
  518. ;; author and email
  519. (concat
  520. (org-odt-format-stylized-paragraph
  521. 'subtitle
  522. (org-odt-format-link
  523. (org-odt-format-tags
  524. '("<text:initial-creator>" . "</text:initial-creator>")
  525. author) (concat "mailto:" email)))
  526. ;; separator
  527. "<text:p text:style-name=\"OrgSubtitle\"/>")))
  528. ;; date
  529. (when date
  530. (concat
  531. (org-odt-format-stylized-paragraph
  532. 'subtitle
  533. (org-odt-format-tags
  534. '("<text:date style:data-style-name=\"%s\" text:date-value=\"%s\">"
  535. . "</text:date>") date "N75" iso-date))
  536. ;; separator
  537. "<text:p text:style-name=\"OrgSubtitle\"/>")))))
  538. (defun org-odt-begin-document-body (opt-plist)
  539. (org-odt-begin-office-body)
  540. (insert (org-odt-format-preamble opt-plist))
  541. (setq org-lparse-dyn-first-heading-pos (point)))
  542. (defvar org-lparse-body-only) ; let bound during org-do-lparse
  543. (defvar org-lparse-to-buffer) ; let bound during org-do-lparse
  544. (defun org-odt-end-document-body (opt-plist)
  545. (unless org-lparse-body-only
  546. (org-lparse-insert-tag "</office:text>")
  547. (org-lparse-insert-tag "</office:body>")))
  548. (defun org-odt-begin-document-content (opt-plist)
  549. (ignore))
  550. (defun org-odt-end-document-content ()
  551. (org-lparse-insert-tag "</office:document-content>"))
  552. (defun org-odt-begin-outline (level1 snumber title tags
  553. target extra-targets class)
  554. (org-lparse-insert
  555. 'HEADING (org-lparse-format
  556. 'HEADLINE title extra-targets tags snumber level1)
  557. level1 target))
  558. (defun org-odt-end-outline ()
  559. (ignore))
  560. (defun org-odt-begin-outline-text (level1 snumber class)
  561. (ignore))
  562. (defun org-odt-end-outline-text ()
  563. (ignore))
  564. (defun org-odt-begin-section (style &optional name)
  565. (let ((default-name (car (org-odt-add-automatic-style "Section"))))
  566. (org-lparse-insert-tag
  567. "<text:section text:style-name=\"%s\" text:name=\"%s\">"
  568. style (or name default-name))))
  569. (defun org-odt-end-section ()
  570. (org-lparse-insert-tag "</text:section>"))
  571. (defun org-odt-begin-paragraph (&optional style)
  572. (org-lparse-insert-tag
  573. "<text:p%s>" (org-odt-get-extra-attrs-for-paragraph-style style)))
  574. (defun org-odt-end-paragraph ()
  575. (org-lparse-insert-tag "</text:p>"))
  576. (defun org-odt-get-extra-attrs-for-paragraph-style (style)
  577. (let (style-name)
  578. (setq style-name
  579. (cond
  580. ((stringp style) style)
  581. ((symbolp style) (org-odt-get-style-name-for-entity
  582. 'paragraph style))))
  583. (unless style-name
  584. (error "Don't know how to handle paragraph style %s" style))
  585. (format " text:style-name=\"%s\"" style-name)))
  586. (defun org-odt-format-stylized-paragraph (style text)
  587. (org-odt-format-tags
  588. '("<text:p%s>" . "</text:p>") text
  589. (org-odt-get-extra-attrs-for-paragraph-style style)))
  590. (defvar org-lparse-opt-plist) ; bound during org-do-lparse
  591. (defun org-odt-format-author (&optional author)
  592. (when (setq author (or author (plist-get org-lparse-opt-plist :author)))
  593. (org-odt-format-tags '("<dc:creator>" . "</dc:creator>") author)))
  594. (defun org-odt-format-date (&optional org-ts fmt)
  595. (save-match-data
  596. (let* ((time
  597. (and (stringp org-ts)
  598. (string-match org-ts-regexp0 org-ts)
  599. (apply 'encode-time
  600. (org-fix-decoded-time
  601. (org-parse-time-string (match-string 0 org-ts) t)))))
  602. date)
  603. (cond
  604. (fmt (format-time-string fmt time))
  605. (t (setq date (format-time-string "%Y-%m-%dT%H:%M:%S%z" time))
  606. (format "%s:%s" (substring date 0 -2) (substring date -2)))))))
  607. (defun org-odt-begin-annotation (&optional author date)
  608. (org-lparse-insert-tag "<office:annotation>")
  609. (when (setq author (org-odt-format-author author))
  610. (insert author))
  611. (insert (org-odt-format-tags
  612. '("<dc:date>" . "</dc:date>")
  613. (org-odt-format-date
  614. (or date (plist-get org-lparse-opt-plist :date)))))
  615. (org-lparse-begin-paragraph))
  616. (defun org-odt-end-annotation ()
  617. (org-lparse-insert-tag "</office:annotation>"))
  618. (defun org-odt-begin-environment (style env-options-plist)
  619. (case style
  620. (annotation
  621. (org-lparse-stash-save-paragraph-state)
  622. (org-odt-begin-annotation (plist-get env-options-plist 'author)
  623. (plist-get env-options-plist 'date)))
  624. ((blockquote verse center quote)
  625. (org-lparse-begin-paragraph style)
  626. (list))
  627. ((fixedwidth native)
  628. (org-lparse-end-paragraph)
  629. (list))
  630. (t (error "Unknown environment %s" style))))
  631. (defun org-odt-end-environment (style env-options-plist)
  632. (case style
  633. (annotation
  634. (org-lparse-end-paragraph)
  635. (org-odt-end-annotation)
  636. (org-lparse-stash-pop-paragraph-state))
  637. ((blockquote verse center quote)
  638. (org-lparse-end-paragraph)
  639. (list))
  640. ((fixedwidth native)
  641. (org-lparse-begin-paragraph)
  642. (list))
  643. (t (error "Unknown environment %s" style))))
  644. (defvar org-lparse-list-stack) ; dynamically bound in org-do-lparse
  645. (defvar org-odt-list-stack-stashed)
  646. (defun org-odt-begin-list (ltype)
  647. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  648. ltype))
  649. (let* ((style-name (org-odt-get-style-name-for-entity 'list ltype))
  650. (extra (concat (if (or org-lparse-list-table-p
  651. (and (= 1 (length org-lparse-list-stack))
  652. (null org-odt-list-stack-stashed)))
  653. " text:continue-numbering=\"false\""
  654. " text:continue-numbering=\"true\"")
  655. (when style-name
  656. (format " text:style-name=\"%s\"" style-name)))))
  657. (case ltype
  658. ((ordered unordered description)
  659. (org-lparse-end-paragraph)
  660. (org-lparse-insert-tag "<text:list%s>" extra))
  661. (t (error "Unknown list type: %s" ltype)))))
  662. (defun org-odt-end-list (ltype)
  663. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  664. ltype))
  665. (if ltype
  666. (org-lparse-insert-tag "</text:list>")
  667. (error "Unknown list type: %s" ltype)))
  668. (defun org-odt-begin-list-item (ltype &optional arg headline)
  669. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  670. ltype))
  671. (case ltype
  672. (ordered
  673. (assert (not headline) t)
  674. (let* ((counter arg) (extra ""))
  675. (org-lparse-insert-tag (if (= (length org-lparse-list-stack)
  676. (length org-odt-list-stack-stashed))
  677. "<text:list-header>" "<text:list-item>"))
  678. (org-lparse-begin-paragraph)))
  679. (unordered
  680. (let* ((id arg) (extra ""))
  681. (org-lparse-insert-tag (if (= (length org-lparse-list-stack)
  682. (length org-odt-list-stack-stashed))
  683. "<text:list-header>" "<text:list-item>"))
  684. (org-lparse-begin-paragraph)
  685. (insert (if headline (org-odt-format-target headline id)
  686. (org-odt-format-bookmark "" id)))))
  687. (description
  688. (assert (not headline) t)
  689. (let ((term (or arg "(no term)")))
  690. (insert
  691. (org-odt-format-tags
  692. '("<text:list-item>" . "</text:list-item>")
  693. (org-odt-format-stylized-paragraph 'definition-term term)))
  694. (org-lparse-begin-list-item 'unordered)
  695. (org-lparse-begin-list 'description)
  696. (org-lparse-begin-list-item 'unordered)))
  697. (t (error "Unknown list type"))))
  698. (defun org-odt-end-list-item (ltype)
  699. (setq ltype (or (org-lparse-html-list-type-to-canonical-list-type ltype)
  700. ltype))
  701. (case ltype
  702. ((ordered unordered)
  703. (org-lparse-insert-tag (if (= (length org-lparse-list-stack)
  704. (length org-odt-list-stack-stashed))
  705. (prog1 "</text:list-header>"
  706. (setq org-odt-list-stack-stashed nil))
  707. "</text:list-item>")))
  708. (description
  709. (org-lparse-end-list-item-1)
  710. (org-lparse-end-list 'description)
  711. (org-lparse-end-list-item-1))
  712. (t (error "Unknown list type"))))
  713. (defun org-odt-discontinue-list ()
  714. (let ((stashed-stack org-lparse-list-stack))
  715. (loop for list-type in stashed-stack
  716. do (org-lparse-end-list-item-1 list-type)
  717. (org-lparse-end-list list-type))
  718. (setq org-odt-list-stack-stashed stashed-stack)))
  719. (defun org-odt-continue-list ()
  720. (setq org-odt-list-stack-stashed (nreverse org-odt-list-stack-stashed))
  721. (loop for list-type in org-odt-list-stack-stashed
  722. do (org-lparse-begin-list list-type)
  723. (org-lparse-begin-list-item list-type)))
  724. ;; Following variables are let bound when table emission is in
  725. ;; progress. See org-lparse.el.
  726. (defvar org-lparse-table-begin-marker)
  727. (defvar org-lparse-table-ncols)
  728. (defvar org-lparse-table-rowgrp-open)
  729. (defvar org-lparse-table-rownum)
  730. (defvar org-lparse-table-cur-rowgrp-is-hdr)
  731. (defvar org-lparse-table-is-styled)
  732. (defvar org-lparse-table-rowgrp-info)
  733. (defvar org-lparse-table-colalign-vector)
  734. (defvar org-odt-table-style nil
  735. "Table style specified by \"#+ATTR_ODT: <style-name>\" line.
  736. This is set during `org-odt-begin-table'.")
  737. (defvar org-odt-table-style-spec nil
  738. "Entry for `org-odt-table-style' in `org-export-odt-table-styles'.")
  739. (defcustom org-export-odt-table-styles
  740. '(("OrgEquation" "OrgEquation"
  741. ((use-first-column-styles . t)
  742. (use-last-column-styles . t))))
  743. "Specify how Table Styles should be derived from a Table Template.
  744. This is a list where each element is of the
  745. form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
  746. TABLE-STYLE-NAME is the style associated with the table through
  747. `org-odt-table-style'.
  748. TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
  749. TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
  750. below) that is included in
  751. `org-export-odt-content-template-file'.
  752. TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
  753. \"TableCell\"
  754. PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
  755. \"TableParagraph\"
  756. TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
  757. \"FirstRow\" | \"LastRow\" |
  758. \"EvenRow\" | \"OddRow\" |
  759. \"EvenColumn\" | \"OddColumn\" | \"\"
  760. where \"+\" above denotes string concatenation.
  761. TABLE-CELL-OPTIONS is an alist where each element is of the
  762. form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
  763. TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
  764. `use-last-row-styles' |
  765. `use-first-column-styles' |
  766. `use-last-column-styles' |
  767. `use-banding-rows-styles' |
  768. `use-banding-columns-styles' |
  769. `use-first-row-styles'
  770. ON-OR-OFF := `t' | `nil'
  771. For example, with the following configuration
  772. \(setq org-export-odt-table-styles
  773. '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
  774. \(\(use-first-row-styles . t\)
  775. \(use-first-column-styles . t\)\)\)
  776. \(\"TableWithHeaderColumns\" \"Custom\"
  777. \(\(use-first-column-styles . t\)\)\)\)\)
  778. 1. A table associated with \"TableWithHeaderRowsAndColumns\"
  779. style will use the following table-cell styles -
  780. \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
  781. \"CustomTableCell\" and the following paragraph styles
  782. \"CustomFirstRowTableParagraph\",
  783. \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
  784. as appropriate.
  785. 2. A table associated with \"TableWithHeaderColumns\" style will
  786. use the following table-cell styles -
  787. \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
  788. following paragraph styles
  789. \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
  790. as appropriate..
  791. Note that TABLE-TEMPLATE-NAME corresponds to the
  792. \"<table:table-template>\" elements contained within
  793. \"<office:styles>\". The entries (TABLE-STYLE-NAME
  794. TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
  795. \"table:template-name\" and \"table:use-first-row-styles\" etc
  796. attributes of \"<table:table>\" element. Refer ODF-1.2
  797. specification for more information. Also consult the
  798. implementation filed under `org-odt-get-table-cell-styles'.
  799. The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
  800. formatting of numbered display equations. Do not delete this
  801. style from the list."
  802. :group 'org-export-odt
  803. :version "24.1"
  804. :type '(choice
  805. (const :tag "None" nil)
  806. (repeat :tag "Table Styles"
  807. (list :tag "Table Style Specification"
  808. (string :tag "Table Style Name")
  809. (string :tag "Table Template Name")
  810. (alist :options (use-first-row-styles
  811. use-last-row-styles
  812. use-first-column-styles
  813. use-last-column-styles
  814. use-banding-rows-styles
  815. use-banding-columns-styles)
  816. :key-type symbol
  817. :value-type (const :tag "True" t))))))
  818. (defvar org-odt-table-style-format
  819. "
  820. <style:style style:name=\"%s\" style:family=\"table\">
  821. <style:table-properties style:rel-width=\"%d%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
  822. </style:style>
  823. "
  824. "Template for auto-generated Table styles.")
  825. (defvar org-odt-automatic-styles '()
  826. "Registry of automatic styles for various OBJECT-TYPEs.
  827. The variable has the following form:
  828. \(\(OBJECT-TYPE-A
  829. \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
  830. \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
  831. \(OBJECT-TYPE-B
  832. \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
  833. \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
  834. ...\).
  835. OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
  836. OBJECT-PROPS is (typically) a plist created by passing
  837. \"#+ATTR_ODT: \" option to `org-lparse-get-block-params'.
  838. Use `org-odt-add-automatic-style' to add update this variable.'")
  839. (defvar org-odt-object-counters nil
  840. "Running counters for various OBJECT-TYPEs.
  841. Use this to generate automatic names and style-names. See
  842. `org-odt-add-automatic-style'.")
  843. (defun org-odt-write-automatic-styles ()
  844. "Write automatic styles to \"content.xml\"."
  845. (with-current-buffer
  846. (find-file-noselect (expand-file-name "content.xml") t)
  847. ;; position the cursor
  848. (goto-char (point-min))
  849. (re-search-forward " </office:automatic-styles>" nil t)
  850. (goto-char (match-beginning 0))
  851. ;; write automatic table styles
  852. (loop for (style-name props) in
  853. (plist-get org-odt-automatic-styles 'Table) do
  854. (when (setq props (or (plist-get props :rel-width) 96))
  855. (insert (format org-odt-table-style-format style-name props))))))
  856. (defun org-odt-add-automatic-style (object-type &optional object-props)
  857. "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
  858. OBJECT-PROPS is (typically) a plist created by passing
  859. \"#+ATTR_ODT: \" option of the object in question to
  860. `org-lparse-get-block-params'.
  861. Use `org-odt-object-counters' to generate an automatic
  862. OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
  863. new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
  864. . STYLE-NAME)."
  865. (assert (stringp object-type))
  866. (let* ((object (intern object-type))
  867. (seqvar object)
  868. (seqno (1+ (or (plist-get org-odt-object-counters seqvar) 0)))
  869. (object-name (format "%s%d" object-type seqno)) style-name)
  870. (setq org-odt-object-counters
  871. (plist-put org-odt-object-counters seqvar seqno))
  872. (when object-props
  873. (setq style-name (format "Org%s" object-name))
  874. (setq org-odt-automatic-styles
  875. (plist-put org-odt-automatic-styles object
  876. (append (list (list style-name object-props))
  877. (plist-get org-odt-automatic-styles object)))))
  878. (cons object-name style-name)))
  879. (defvar org-odt-table-indentedp nil)
  880. (defun org-odt-begin-table (caption label attributes)
  881. (setq org-odt-table-indentedp (not (null org-lparse-list-stack)))
  882. (when org-odt-table-indentedp
  883. ;; Within the Org file, the table is appearing within a list item.
  884. ;; OpenDocument doesn't allow table to appear within list items.
  885. ;; Temporarily terminate the list, emit the table and then
  886. ;; re-continue the list.
  887. (org-odt-discontinue-list)
  888. ;; Put the Table in an indented section.
  889. (let ((level (length org-odt-list-stack-stashed)))
  890. (org-odt-begin-section (format "OrgIndentedSection-Level-%d" level))))
  891. (setq attributes (org-lparse-get-block-params attributes))
  892. (setq org-odt-table-style (plist-get attributes :style))
  893. (setq org-odt-table-style-spec
  894. (assoc org-odt-table-style org-export-odt-table-styles))
  895. (when (or label caption)
  896. (insert
  897. (org-odt-format-stylized-paragraph
  898. 'table (org-odt-format-entity-caption label caption "__Table__"))))
  899. (let ((name-and-style (org-odt-add-automatic-style "Table" attributes)))
  900. (org-lparse-insert-tag
  901. "<table:table table:name=\"%s\" table:style-name=\"%s\">"
  902. (car name-and-style) (or (nth 1 org-odt-table-style-spec)
  903. (cdr name-and-style) "OrgTable")))
  904. (setq org-lparse-table-begin-marker (point)))
  905. (defvar org-lparse-table-colalign-info)
  906. (defun org-odt-end-table ()
  907. (goto-char org-lparse-table-begin-marker)
  908. (loop for level from 0 below org-lparse-table-ncols
  909. do (let* ((col-cookie (and org-lparse-table-is-styled
  910. (cdr (assoc (1+ level)
  911. org-lparse-table-colalign-info))))
  912. (extra-columns (or (nth 1 col-cookie) 0)))
  913. (dotimes (i (1+ extra-columns))
  914. (insert
  915. (org-odt-format-tags
  916. "<table:table-column table:style-name=\"%sColumn\"/>"
  917. "" (or (nth 1 org-odt-table-style-spec) "OrgTable"))))
  918. (insert "\n")))
  919. ;; fill style attributes for table cells
  920. (when org-lparse-table-is-styled
  921. (while (re-search-forward "@@\\(table-cell:p\\|table-cell:style-name\\)@@\\([0-9]+\\)@@\\([0-9]+\\)@@" nil t)
  922. (let* ((spec (match-string 1))
  923. (r (string-to-number (match-string 2)))
  924. (c (string-to-number (match-string 3)))
  925. (cell-styles (org-odt-get-table-cell-styles
  926. r c org-odt-table-style-spec))
  927. (table-cell-style (car cell-styles))
  928. (table-cell-paragraph-style (cdr cell-styles)))
  929. (cond
  930. ((equal spec "table-cell:p")
  931. (replace-match table-cell-paragraph-style t t))
  932. ((equal spec "table-cell:style-name")
  933. (replace-match table-cell-style t t))))))
  934. (goto-char (point-max))
  935. (org-lparse-insert-tag "</table:table>")
  936. (when org-odt-table-indentedp
  937. (org-odt-end-section)
  938. (org-odt-continue-list)))
  939. (defun org-odt-begin-table-rowgroup (&optional is-header-row)
  940. (when org-lparse-table-rowgrp-open
  941. (org-lparse-end 'TABLE-ROWGROUP))
  942. (org-lparse-insert-tag (if is-header-row
  943. "<table:table-header-rows>"
  944. "<table:table-rows>"))
  945. (setq org-lparse-table-rowgrp-open t)
  946. (setq org-lparse-table-cur-rowgrp-is-hdr is-header-row))
  947. (defun org-odt-end-table-rowgroup ()
  948. (when org-lparse-table-rowgrp-open
  949. (setq org-lparse-table-rowgrp-open nil)
  950. (org-lparse-insert-tag
  951. (if org-lparse-table-cur-rowgrp-is-hdr
  952. "</table:table-header-rows>" "</table:table-rows>"))))
  953. (defun org-odt-format-table-row (row)
  954. (org-odt-format-tags
  955. '("<table:table-row>" . "</table:table-row>") row))
  956. (defun org-odt-get-table-cell-styles (r c &optional style-spec)
  957. "Retrieve styles applicable to a table cell.
  958. R and C are (zero-based) row and column numbers of the table
  959. cell. STYLE-SPEC is an entry in `org-export-odt-table-styles'
  960. applicable to the current table. It is `nil' if the table is not
  961. associated with any style attributes.
  962. Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
  963. When STYLE-SPEC is nil, style the table cell the conventional way
  964. - choose cell borders based on row and column groupings and
  965. choose paragraph alignment based on `org-col-cookies' text
  966. property. See also
  967. `org-odt-get-paragraph-style-cookie-for-table-cell'.
  968. When STYLE-SPEC is non-nil, ignore the above cookie and return
  969. styles congruent with the ODF-1.2 specification."
  970. (cond
  971. (style-spec
  972. ;; LibreOffice - particularly the Writer - honors neither table
  973. ;; templates nor custom table-cell styles. Inorder to retain
  974. ;; inter-operability with LibreOffice, only automatic styles are
  975. ;; used for styling of table-cells. The current implementation is
  976. ;; congruent with ODF-1.2 specification and hence is
  977. ;; future-compatible.
  978. ;; Additional Note: LibreOffice's AutoFormat facility for tables -
  979. ;; which recognizes as many as 16 different cell types - is much
  980. ;; richer. Unfortunately it is NOT amenable to easy configuration
  981. ;; by hand.
  982. (let* ((template-name (nth 1 style-spec))
  983. (cell-style-selectors (nth 2 style-spec))
  984. (cell-type
  985. (cond
  986. ((and (cdr (assoc 'use-first-column-styles cell-style-selectors))
  987. (= c 0)) "FirstColumn")
  988. ((and (cdr (assoc 'use-last-column-styles cell-style-selectors))
  989. (= c (1- org-lparse-table-ncols))) "LastColumn")
  990. ((and (cdr (assoc 'use-first-row-styles cell-style-selectors))
  991. (= r 0)) "FirstRow")
  992. ((and (cdr (assoc 'use-last-row-styles cell-style-selectors))
  993. (= r org-lparse-table-rownum))
  994. "LastRow")
  995. ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
  996. (= (% r 2) 1)) "EvenRow")
  997. ((and (cdr (assoc 'use-banding-rows-styles cell-style-selectors))
  998. (= (% r 2) 0)) "OddRow")
  999. ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
  1000. (= (% c 2) 1)) "EvenColumn")
  1001. ((and (cdr (assoc 'use-banding-columns-styles cell-style-selectors))
  1002. (= (% c 2) 0)) "OddColumn")
  1003. (t ""))))
  1004. (cons
  1005. (concat template-name cell-type "TableCell")
  1006. (concat template-name cell-type "TableParagraph"))))
  1007. (t
  1008. (cons
  1009. (concat
  1010. "OrgTblCell"
  1011. (cond
  1012. ((= r 0) "T")
  1013. ((eq (cdr (assoc r org-lparse-table-rowgrp-info)) :start) "T")
  1014. (t ""))
  1015. (when (= r org-lparse-table-rownum) "B")
  1016. (cond
  1017. ((= c 0) "")
  1018. ((or (memq (nth c org-table-colgroup-info) '(:start :startend))
  1019. (memq (nth (1- c) org-table-colgroup-info) '(:end :startend))) "L")
  1020. (t "")))
  1021. (capitalize (aref org-lparse-table-colalign-vector c))))))
  1022. (defun org-odt-get-paragraph-style-cookie-for-table-cell (r c)
  1023. (concat
  1024. (and (not org-odt-table-style-spec)
  1025. (cond
  1026. (org-lparse-table-cur-rowgrp-is-hdr "OrgTableHeading")
  1027. ((and (= c 0) (org-lparse-get 'TABLE-FIRST-COLUMN-AS-LABELS))
  1028. "OrgTableHeading")
  1029. (t "OrgTableContents")))
  1030. (and org-lparse-table-is-styled
  1031. (format "@@table-cell:p@@%03d@@%03d@@" r c))))
  1032. (defun org-odt-get-style-name-cookie-for-table-cell (r c)
  1033. (when org-lparse-table-is-styled
  1034. (format "@@table-cell:style-name@@%03d@@%03d@@" r c)))
  1035. (defun org-odt-format-table-cell (data r c horiz-span)
  1036. (concat
  1037. (let* ((paragraph-style-cookie
  1038. (org-odt-get-paragraph-style-cookie-for-table-cell r c))
  1039. (style-name-cookie
  1040. (org-odt-get-style-name-cookie-for-table-cell r c))
  1041. (extra (and style-name-cookie
  1042. (format " table:style-name=\"%s\"" style-name-cookie)))
  1043. (extra (concat extra
  1044. (and (> horiz-span 0)
  1045. (format " table:number-columns-spanned=\"%d\""
  1046. (1+ horiz-span))))))
  1047. (org-odt-format-tags
  1048. '("<table:table-cell%s>" . "</table:table-cell>")
  1049. (if org-lparse-list-table-p data
  1050. (org-odt-format-stylized-paragraph paragraph-style-cookie data)) extra))
  1051. (let (s)
  1052. (dotimes (i horiz-span)
  1053. (setq s (concat s "\n<table:covered-table-cell/>"))) s)
  1054. "\n"))
  1055. (defun org-odt-begin-footnote-definition (n)
  1056. (org-lparse-begin-paragraph 'footnote))
  1057. (defun org-odt-end-footnote-definition (n)
  1058. (org-lparse-end-paragraph))
  1059. (defun org-odt-begin-toc (lang-specific-heading max-level)
  1060. ;; Strings in `org-export-language-setup' can contain named html
  1061. ;; entities. Replace those with utf-8 equivalents.
  1062. (let ((i 0) entity rpl)
  1063. (while (string-match "&\\([^#].*?\\);" lang-specific-heading i)
  1064. (setq entity (match-string 1 lang-specific-heading))
  1065. (if (not (setq rpl (org-entity-get-representation entity 'utf8)))
  1066. (setq i (match-end 0))
  1067. (setq i (+ (match-beginning 0) (length rpl)))
  1068. (setq lang-specific-heading
  1069. (replace-match rpl t t lang-specific-heading)))))
  1070. (insert
  1071. (format "
  1072. <text:table-of-content text:style-name=\"Sect2\" text:protected=\"true\" text:name=\"Table of Contents1\">
  1073. <text:table-of-content-source text:outline-level=\"%d\">
  1074. <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
  1075. " max-level lang-specific-heading))
  1076. (loop for level from 1 upto 10
  1077. do (insert (format
  1078. "
  1079. <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
  1080. <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
  1081. <text:index-entry-chapter/>
  1082. <text:index-entry-text/>
  1083. <text:index-entry-link-end/>
  1084. </text:table-of-content-entry-template>
  1085. " level level)))
  1086. (insert
  1087. (format "
  1088. </text:table-of-content-source>
  1089. <text:index-body>
  1090. <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
  1091. <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
  1092. </text:index-title>
  1093. " lang-specific-heading)))
  1094. (defun org-odt-end-toc ()
  1095. (insert "
  1096. </text:index-body>
  1097. </text:table-of-content>
  1098. "))
  1099. (defun org-odt-format-toc-entry (snumber todo headline tags href)
  1100. (setq headline (concat
  1101. (and org-export-with-section-numbers
  1102. (concat snumber ". "))
  1103. headline
  1104. (and tags
  1105. (concat
  1106. (org-lparse-format 'SPACES 3)
  1107. (org-lparse-format 'FONTIFY tags "tag")))))
  1108. (when todo
  1109. (setq headline (org-lparse-format 'FONTIFY headline "todo")))
  1110. (let ((org-odt-suppress-xref t))
  1111. (org-odt-format-link headline (concat "#" href))))
  1112. (defun org-odt-format-toc-item (toc-entry level org-last-level)
  1113. (let ((style (format "Contents_20_%d"
  1114. (+ level (or (org-lparse-get 'TOPLEVEL-HLEVEL) 1) -1))))
  1115. (insert "\n" (org-odt-format-stylized-paragraph style toc-entry) "\n")))
  1116. ;; Following variable is let bound during 'ORG-LINK callback. See
  1117. ;; org-html.el
  1118. (defvar org-lparse-link-description-is-image nil)
  1119. (defun org-odt-format-link (desc href &optional attr)
  1120. (cond
  1121. ((and (= (string-to-char href) ?#) (not org-odt-suppress-xref))
  1122. (setq href (substring href 1))
  1123. (let ((xref-format "text"))
  1124. (when (numberp desc)
  1125. (setq desc (format "%d" desc) xref-format "number"))
  1126. (when (listp desc)
  1127. (setq desc (mapconcat 'identity desc ".") xref-format "chapter"))
  1128. (setq href (concat org-export-odt-bookmark-prefix href))
  1129. (org-odt-format-tags
  1130. '("<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">" .
  1131. "</text:bookmark-ref>")
  1132. desc xref-format href)))
  1133. (org-lparse-link-description-is-image
  1134. (org-odt-format-tags
  1135. '("<draw:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</draw:a>")
  1136. desc href (or attr "")))
  1137. (t
  1138. (org-odt-format-tags
  1139. '("<text:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</text:a>")
  1140. desc href (or attr "")))))
  1141. (defun org-odt-format-spaces (n)
  1142. (cond
  1143. ((= n 1) " ")
  1144. ((> n 1) (concat
  1145. " " (org-odt-format-tags "<text:s text:c=\"%d\"/>" "" (1- n))))
  1146. (t "")))
  1147. (defun org-odt-format-tabs (&optional n)
  1148. (let ((tab "<text:tab/>")
  1149. (n (or n 1)))
  1150. (insert tab)))
  1151. (defun org-odt-format-line-break ()
  1152. (org-odt-format-tags "<text:line-break/>" ""))
  1153. (defun org-odt-format-horizontal-line ()
  1154. (org-odt-format-stylized-paragraph 'horizontal-line ""))
  1155. (defun org-odt-encode-plain-text (line &optional no-whitespace-filling)
  1156. (setq line (org-xml-encode-plain-text line))
  1157. (if no-whitespace-filling line
  1158. (org-odt-fill-tabs-and-spaces line)))
  1159. (defun org-odt-format-line (line)
  1160. (case org-lparse-dyn-current-environment
  1161. (fixedwidth (concat
  1162. (org-odt-format-stylized-paragraph
  1163. 'fixedwidth (org-odt-encode-plain-text line)) "\n"))
  1164. (t (concat line "\n"))))
  1165. (defun org-odt-format-comment (fmt &rest args)
  1166. (let ((comment (apply 'format fmt args)))
  1167. (format "\n<!-- %s -->\n" comment)))
  1168. (defun org-odt-format-org-entity (wd)
  1169. (org-entity-get-representation wd 'utf8))
  1170. (defun org-odt-fill-tabs-and-spaces (line)
  1171. (replace-regexp-in-string
  1172. "\\([\t]\\|\\([ ]+\\)\\)" (lambda (s)
  1173. (cond
  1174. ((string= s "\t") (org-odt-format-tabs))
  1175. (t (org-odt-format-spaces (length s))))) line))
  1176. (defcustom org-export-odt-fontify-srcblocks t
  1177. "Specify whether or not source blocks need to be fontified.
  1178. Turn this option on if you want to colorize the source code
  1179. blocks in the exported file. For colorization to work, you need
  1180. to make available an enhanced version of `htmlfontify' library."
  1181. :type 'boolean
  1182. :group 'org-export-odt
  1183. :version "24.1")
  1184. (defun org-odt-format-source-line-with-line-number-and-label
  1185. (line rpllbl num fontifier par-style)
  1186. (let ((keep-label (not (numberp rpllbl)))
  1187. (ref (org-find-text-property-in-string 'org-coderef line)))
  1188. (setq line (concat line (and keep-label ref (format "(%s)" ref))))
  1189. (setq line (funcall fontifier line))
  1190. (when ref
  1191. (setq line (org-odt-format-target line (concat "coderef-" ref))))
  1192. (setq line (org-odt-format-stylized-paragraph par-style line))
  1193. (if (not num) line
  1194. (org-odt-format-tags '("<text:list-item>" . "</text:list-item>") line))))
  1195. (defun org-odt-format-source-code-or-example-plain
  1196. (lines lang caption textareap cols rows num cont rpllbl fmt)
  1197. "Format source or example blocks much like fixedwidth blocks.
  1198. Use this when `org-export-odt-fontify-srcblocks' option is turned
  1199. off."
  1200. (let* ((lines (org-split-string lines "[\r\n]"))
  1201. (line-count (length lines))
  1202. (i 0))
  1203. (mapconcat
  1204. (lambda (line)
  1205. (incf i)
  1206. (org-odt-format-source-line-with-line-number-and-label
  1207. line rpllbl num 'org-odt-encode-plain-text
  1208. (if (= i line-count) "OrgFixedWidthBlockLastLine"
  1209. "OrgFixedWidthBlock")))
  1210. lines "\n")))
  1211. (defvar org-src-block-paragraph-format
  1212. "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
  1213. <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
  1214. <style:background-image/>
  1215. </style:paragraph-properties>
  1216. <style:text-properties fo:color=\"%s\"/>
  1217. </style:style>"
  1218. "Custom paragraph style for colorized source and example blocks.
  1219. This style is much the same as that of \"OrgFixedWidthBlock\"
  1220. except that the foreground and background colors are set
  1221. according to the default face identified by the `htmlfontify'.")
  1222. (defvar hfy-optimisations)
  1223. (declare-function hfy-face-to-style "htmlfontify" (fn))
  1224. (declare-function hfy-face-or-def-to-name "htmlfontify" (fn))
  1225. (defun org-odt-hfy-face-to-css (fn)
  1226. "Create custom style for face FN.
  1227. When FN is the default face, use it's foreground and background
  1228. properties to create \"OrgSrcBlock\" paragraph style. Otherwise
  1229. use it's color attribute to create a character style whose name
  1230. is obtained from FN. Currently all attributes of FN other than
  1231. color are ignored.
  1232. The style name for a face FN is derived using the following
  1233. operations on the face name in that order - de-dash, CamelCase
  1234. and prefix with \"OrgSrc\". For example,
  1235. `font-lock-function-name-face' is associated with
  1236. \"OrgSrcFontLockFunctionNameFace\"."
  1237. (let* ((css-list (hfy-face-to-style fn))
  1238. (style-name ((lambda (fn)
  1239. (concat "OrgSrc"
  1240. (mapconcat
  1241. 'capitalize (split-string
  1242. (hfy-face-or-def-to-name fn) "-")
  1243. ""))) fn))
  1244. (color-val (cdr (assoc "color" css-list)))
  1245. (background-color-val (cdr (assoc "background" css-list)))
  1246. (style (and org-export-odt-create-custom-styles-for-srcblocks
  1247. (cond
  1248. ((eq fn 'default)
  1249. (format org-src-block-paragraph-format
  1250. background-color-val color-val))
  1251. (t
  1252. (format
  1253. "
  1254. <style:style style:name=\"%s\" style:family=\"text\">
  1255. <style:text-properties fo:color=\"%s\"/>
  1256. </style:style>" style-name color-val))))))
  1257. (cons style-name style)))
  1258. (defun org-odt-insert-custom-styles-for-srcblocks (styles)
  1259. "Save STYLES used for colorizing of source blocks.
  1260. Update styles.xml with styles that were collected as part of
  1261. `org-odt-hfy-face-to-css' callbacks."
  1262. (when styles
  1263. (with-current-buffer
  1264. (find-file-noselect (expand-file-name "styles.xml") t)
  1265. (goto-char (point-min))
  1266. (when (re-search-forward "</office:styles>" nil t)
  1267. (goto-char (match-beginning 0))
  1268. (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n")))))
  1269. (defun org-odt-format-source-code-or-example-colored
  1270. (lines lang caption textareap cols rows num cont rpllbl fmt)
  1271. "Format source or example blocks using `htmlfontify-string'.
  1272. Use this routine when `org-export-odt-fontify-srcblocks' option
  1273. is turned on."
  1274. (let* ((lang-m (and lang (or (cdr (assoc lang org-src-lang-modes)) lang)))
  1275. (mode (and lang-m (intern (concat (if (symbolp lang-m)
  1276. (symbol-name lang-m)
  1277. lang-m) "-mode"))))
  1278. (org-inhibit-startup t)
  1279. (org-startup-folded nil)
  1280. (lines (with-temp-buffer
  1281. (insert lines)
  1282. (if (functionp mode) (funcall mode) (fundamental-mode))
  1283. (font-lock-fontify-buffer)
  1284. (buffer-string)))
  1285. (hfy-html-quote-regex "\\([<\"&> ]\\)")
  1286. (hfy-html-quote-map '(("\"" "&quot;")
  1287. ("<" "&lt;")
  1288. ("&" "&amp;")
  1289. (">" "&gt;")
  1290. (" " "<text:s/>")
  1291. (" " "<text:tab/>")))
  1292. (hfy-face-to-css 'org-odt-hfy-face-to-css)
  1293. (hfy-optimisations-1 (copy-seq hfy-optimisations))
  1294. (hfy-optimisations (add-to-list 'hfy-optimisations-1
  1295. 'body-text-only))
  1296. (hfy-begin-span-handler
  1297. (lambda (style text-block text-id text-begins-block-p)
  1298. (insert (format "<text:span text:style-name=\"%s\">" style))))
  1299. (hfy-end-span-handler (lambda nil (insert "</text:span>"))))
  1300. (when (fboundp 'htmlfontify-string)
  1301. (let* ((lines (org-split-string lines "[\r\n]"))
  1302. (line-count (length lines))
  1303. (i 0))
  1304. (mapconcat
  1305. (lambda (line)
  1306. (incf i)
  1307. (org-odt-format-source-line-with-line-number-and-label
  1308. line rpllbl num 'htmlfontify-string
  1309. (if (= i line-count) "OrgSrcBlockLastLine" "OrgSrcBlock")))
  1310. lines "\n")))))
  1311. (defun org-odt-format-source-code-or-example (lines lang caption textareap
  1312. cols rows num cont
  1313. rpllbl fmt)
  1314. "Format source or example blocks for export.
  1315. Use `org-odt-format-source-code-or-example-plain' or
  1316. `org-odt-format-source-code-or-example-colored' depending on the
  1317. value of `org-export-odt-fontify-srcblocks."
  1318. (setq lines (org-export-number-lines
  1319. lines 0 0 num cont rpllbl fmt 'preprocess)
  1320. lines (funcall
  1321. (or (and org-export-odt-fontify-srcblocks
  1322. (or (featurep 'htmlfontify)
  1323. ;; htmlfontify.el was introduced in Emacs 23.2
  1324. ;; So load it with some caution
  1325. (require 'htmlfontify nil t))
  1326. (fboundp 'htmlfontify-string)
  1327. 'org-odt-format-source-code-or-example-colored)
  1328. 'org-odt-format-source-code-or-example-plain)
  1329. lines lang caption textareap cols rows num cont rpllbl fmt))
  1330. (if (not num) lines
  1331. (let ((extra (format " text:continue-numbering=\"%s\""
  1332. (if cont "true" "false"))))
  1333. (org-odt-format-tags
  1334. '("<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>"
  1335. . "</text:list>") lines extra))))
  1336. (defun org-odt-remap-stylenames (style-name)
  1337. (or
  1338. (cdr (assoc style-name '(("timestamp-wrapper" . "OrgTimestampWrapper")
  1339. ("timestamp" . "OrgTimestamp")
  1340. ("timestamp-kwd" . "OrgTimestampKeyword")
  1341. ("tag" . "OrgTag")
  1342. ("todo" . "OrgTodo")
  1343. ("done" . "OrgDone")
  1344. ("target" . "OrgTarget"))))
  1345. style-name))
  1346. (defun org-odt-format-fontify (text style &optional id)
  1347. (let* ((style-name
  1348. (cond
  1349. ((stringp style)
  1350. (org-odt-remap-stylenames style))
  1351. ((symbolp style)
  1352. (org-odt-get-style-name-for-entity 'character style))
  1353. ((listp style)
  1354. (assert (< 1 (length style)))
  1355. (let ((parent-style (pop style)))
  1356. (mapconcat (lambda (s)
  1357. ;; (assert (stringp s) t)
  1358. (org-odt-remap-stylenames s)) style "")
  1359. (org-odt-remap-stylenames parent-style)))
  1360. (t (error "Don't how to handle style %s" style)))))
  1361. (org-odt-format-tags
  1362. '("<text:span text:style-name=\"%s\">" . "</text:span>")
  1363. text style-name)))
  1364. (defun org-odt-relocate-relative-path (path dir)
  1365. (if (file-name-absolute-p path) path
  1366. (file-relative-name (expand-file-name path dir)
  1367. (expand-file-name "eyecandy" dir))))
  1368. (defun org-odt-format-inline-image (thefile)
  1369. (let* ((thelink (if (file-name-absolute-p thefile) thefile
  1370. (org-xml-format-href
  1371. (org-odt-relocate-relative-path
  1372. thefile org-current-export-file))))
  1373. (href
  1374. (org-odt-format-tags
  1375. "<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
  1376. (if org-export-odt-embed-images
  1377. (org-odt-copy-image-file thefile) thelink))))
  1378. (org-export-odt-format-image thefile href)))
  1379. (defvar org-odt-entity-labels-alist nil
  1380. "Associate Labels with the Labeled entities.
  1381. Each element of the alist is of the form (LABEL-NAME
  1382. CATEGORY-NAME SEQNO LABEL-STYLE-NAME). LABEL-NAME is same as
  1383. that specified by \"#+LABEL: ...\" line. CATEGORY-NAME is the
  1384. type of the entity that LABEL-NAME is attached to. CATEGORY-NAME
  1385. can be one of \"Table\", \"Figure\" or \"Equation\". SEQNO is
  1386. the unique number assigned to the referenced entity on a
  1387. per-CATEGORY basis. It is generated sequentially and is 1-based.
  1388. LABEL-STYLE-NAME is a key `org-odt-label-styles'.
  1389. See `org-odt-add-label-definition' and
  1390. `org-odt-fixup-label-references'.")
  1391. (defun org-export-odt-format-formula (src href)
  1392. (save-match-data
  1393. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1394. (caption (and caption (org-xml-format-desc caption)))
  1395. (label (org-find-text-property-in-string 'org-label src))
  1396. (latex-frag (org-find-text-property-in-string 'org-latex-src src))
  1397. (embed-as (or (and latex-frag
  1398. (org-find-text-property-in-string
  1399. 'org-latex-src-embed-type src))
  1400. (if (or caption label) 'paragraph 'character)))
  1401. width height)
  1402. (when latex-frag
  1403. (setq href (org-propertize href :title "LaTeX Fragment"
  1404. :description latex-frag)))
  1405. (cond
  1406. ((eq embed-as 'character)
  1407. (org-odt-format-entity "InlineFormula" href width height))
  1408. (t
  1409. (org-lparse-end-paragraph)
  1410. (org-lparse-insert-list-table
  1411. `((,(org-odt-format-entity
  1412. (if (not (or caption label)) "DisplayFormula"
  1413. "CaptionedDisplayFormula")
  1414. href width height :caption caption :label label)
  1415. ,(if (not (or caption label)) ""
  1416. (let* ((label-props (car org-odt-entity-labels-alist)))
  1417. (setcar (last label-props) "math-label")
  1418. (apply 'org-odt-format-label-definition
  1419. caption label-props)))))
  1420. nil nil nil ":style \"OrgEquation\"" nil '((1 "c" 8) (2 "c" 1)))
  1421. (throw 'nextline nil))))))
  1422. (defvar org-odt-embedded-formulas-count 0)
  1423. (defun org-odt-copy-formula-file (path)
  1424. "Returns the internal name of the file"
  1425. (let* ((src-file (expand-file-name
  1426. path (file-name-directory org-current-export-file)))
  1427. (target-dir (format "Formula-%04d/"
  1428. (incf org-odt-embedded-formulas-count)))
  1429. (target-file (concat target-dir "content.xml")))
  1430. (when (not org-lparse-to-buffer)
  1431. (message "Embedding %s as %s ..."
  1432. (substring-no-properties path) target-file)
  1433. (make-directory target-dir)
  1434. (org-odt-create-manifest-file-entry
  1435. "application/vnd.oasis.opendocument.formula" target-dir "1.2")
  1436. (case (org-odt-is-formula-link-p src-file)
  1437. (mathml
  1438. (copy-file src-file target-file 'overwrite))
  1439. (odf
  1440. (org-odt-zip-extract-one src-file "content.xml" target-dir))
  1441. (t
  1442. (error "%s is not a formula file" src-file)))
  1443. (org-odt-create-manifest-file-entry "text/xml" target-file))
  1444. target-file))
  1445. (defun org-odt-format-inline-formula (thefile)
  1446. (let* ((thelink (if (file-name-absolute-p thefile) thefile
  1447. (org-xml-format-href
  1448. (org-odt-relocate-relative-path
  1449. thefile org-current-export-file))))
  1450. (href
  1451. (org-odt-format-tags
  1452. "<draw:object xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
  1453. (file-name-directory (org-odt-copy-formula-file thefile)))))
  1454. (org-export-odt-format-formula thefile href)))
  1455. (defun org-odt-is-formula-link-p (file)
  1456. (let ((case-fold-search nil))
  1457. (cond
  1458. ((string-match "\\.\\(mathml\\|mml\\)\\'" file)
  1459. 'mathml)
  1460. ((string-match "\\.odf\\'" file)
  1461. 'odf))))
  1462. (defun org-odt-format-org-link (opt-plist type-1 path fragment desc attr
  1463. descp)
  1464. "Make a OpenDocument link.
  1465. OPT-PLIST is an options list.
  1466. TYPE-1 is the device-type of the link (THIS://foo.html).
  1467. PATH is the path of the link (http://THIS#location).
  1468. FRAGMENT is the fragment part of the link, if any (foo.html#THIS).
  1469. DESC is the link description, if any.
  1470. ATTR is a string of other attributes of the a element."
  1471. (declare (special org-lparse-par-open))
  1472. (save-match-data
  1473. (let* ((may-inline-p
  1474. (and (member type-1 '("http" "https" "file"))
  1475. (org-lparse-should-inline-p path descp)
  1476. (not fragment)))
  1477. (type (if (equal type-1 "id") "file" type-1))
  1478. (filename path)
  1479. (thefile path)
  1480. sec-frag sec-nos)
  1481. (cond
  1482. ;; check for inlined images
  1483. ((and (member type '("file"))
  1484. (not fragment)
  1485. (org-file-image-p
  1486. filename org-export-odt-inline-image-extensions)
  1487. (or (eq t org-export-odt-inline-images)
  1488. (and org-export-odt-inline-images (not descp))))
  1489. (org-odt-format-inline-image thefile))
  1490. ;; check for embedded formulas
  1491. ((and (member type '("file"))
  1492. (not fragment)
  1493. (org-odt-is-formula-link-p filename)
  1494. (or (not descp)))
  1495. (org-odt-format-inline-formula thefile))
  1496. ;; code references
  1497. ((string= type "coderef")
  1498. (let* ((ref fragment)
  1499. (lineno-or-ref (cdr (assoc ref org-export-code-refs)))
  1500. (desc (and descp desc))
  1501. (org-odt-suppress-xref nil)
  1502. (href (org-xml-format-href (concat "#coderef-" ref))))
  1503. (cond
  1504. ((and (numberp lineno-or-ref) (not desc))
  1505. (org-odt-format-link lineno-or-ref href))
  1506. ((and (numberp lineno-or-ref) desc
  1507. (string-match (regexp-quote (concat "(" ref ")")) desc))
  1508. (format (replace-match "%s" t t desc)
  1509. (org-odt-format-link lineno-or-ref href)))
  1510. (t
  1511. (setq desc (format
  1512. (if (and desc (string-match
  1513. (regexp-quote (concat "(" ref ")"))
  1514. desc))
  1515. (replace-match "%s" t t desc)
  1516. (or desc "%s"))
  1517. lineno-or-ref))
  1518. (org-odt-format-link (org-xml-format-desc desc) href)))))
  1519. ;; links to headlines
  1520. ((and (string= type "")
  1521. (or (not thefile) (string= thefile ""))
  1522. (plist-get org-lparse-opt-plist :section-numbers)
  1523. (setq sec-frag fragment)
  1524. (or (string-match "\\`sec\\(\\(-[0-9]+\\)+\\)" sec-frag)
  1525. (and (setq sec-frag
  1526. (loop for alias in org-export-target-aliases do
  1527. (when (member fragment (cdr alias))
  1528. (return (car alias)))))
  1529. (string-match "\\`sec\\(\\(-[0-9]+\\)+\\)" sec-frag)))
  1530. (setq sec-nos (org-split-string (match-string 1 sec-frag) "-"))
  1531. (<= (length sec-nos) (plist-get org-lparse-opt-plist
  1532. :headline-levels)))
  1533. (let ((org-odt-suppress-xref nil))
  1534. (org-odt-format-link sec-nos (concat "#" sec-frag) attr)))
  1535. (t
  1536. (when (string= type "file")
  1537. (setq thefile
  1538. (cond
  1539. ((file-name-absolute-p path)
  1540. (concat "file://" (expand-file-name path)))
  1541. (t (org-odt-relocate-relative-path
  1542. thefile org-current-export-file)))))
  1543. (when (and (member type '("" "http" "https" "file")) fragment)
  1544. (setq thefile (concat thefile "#" fragment)))
  1545. (setq thefile (org-xml-format-href thefile))
  1546. (when (not (member type '("" "file")))
  1547. (setq thefile (concat type ":" thefile)))
  1548. (let ((org-odt-suppress-xref nil))
  1549. (org-odt-format-link
  1550. (org-xml-format-desc desc) thefile attr)))))))
  1551. (defun org-odt-format-heading (text level &optional id)
  1552. (let* ((text (if id (org-odt-format-target text id) text)))
  1553. (org-odt-format-tags
  1554. '("<text:h text:style-name=\"Heading_20_%s\" text:outline-level=\"%s\">" .
  1555. "</text:h>") text level level)))
  1556. (defun org-odt-format-headline (title extra-targets tags
  1557. &optional snumber level)
  1558. (concat
  1559. (org-lparse-format 'EXTRA-TARGETS extra-targets)
  1560. ;; No need to generate section numbers. They are auto-generated by
  1561. ;; the application
  1562. ;; (concat (org-lparse-format 'SECTION-NUMBER snumber level) " ")
  1563. title
  1564. (and tags (concat (org-lparse-format 'SPACES 3)
  1565. (org-lparse-format 'ORG-TAGS tags)))))
  1566. (defun org-odt-format-anchor (text name &optional class)
  1567. (org-odt-format-target text name))
  1568. (defun org-odt-format-bookmark (text id)
  1569. (if id
  1570. (org-odt-format-tags "<text:bookmark text:name=\"%s\"/>" text id)
  1571. text))
  1572. (defun org-odt-format-target (text id)
  1573. (let ((name (concat org-export-odt-bookmark-prefix id)))
  1574. (concat
  1575. (and id (org-odt-format-tags
  1576. "<text:bookmark-start text:name=\"%s\"/>" "" name))
  1577. (org-odt-format-bookmark text id)
  1578. (and id (org-odt-format-tags
  1579. "<text:bookmark-end text:name=\"%s\"/>" "" name)))))
  1580. (defun org-odt-format-footnote (n def)
  1581. (let ((id (concat "fn" n))
  1582. (note-class "footnote")
  1583. (par-style "Footnote"))
  1584. (org-odt-format-tags
  1585. '("<text:note text:id=\"%s\" text:note-class=\"%s\">" .
  1586. "</text:note>")
  1587. (concat
  1588. (org-odt-format-tags
  1589. '("<text:note-citation>" . "</text:note-citation>")
  1590. n)
  1591. (org-odt-format-tags
  1592. '("<text:note-body>" . "</text:note-body>")
  1593. def))
  1594. id note-class)))
  1595. (defun org-odt-format-footnote-reference (n def refcnt)
  1596. (if (= refcnt 1)
  1597. (org-odt-format-footnote n def)
  1598. (org-odt-format-footnote-ref n)))
  1599. (defun org-odt-format-footnote-ref (n)
  1600. (let ((note-class "footnote")
  1601. (ref-format "text")
  1602. (ref-name (concat "fn" n)))
  1603. (org-odt-format-tags
  1604. '("<text:span text:style-name=\"%s\">" . "</text:span>")
  1605. (org-odt-format-tags
  1606. '("<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">" . "</text:note-ref>")
  1607. n note-class ref-format ref-name)
  1608. "OrgSuperscript")))
  1609. (defun org-odt-get-image-name (file-name)
  1610. (require 'sha1)
  1611. (file-relative-name
  1612. (expand-file-name
  1613. (concat (sha1 file-name) "." (file-name-extension file-name)) "Pictures")))
  1614. (defun org-export-odt-format-image (src href)
  1615. "Create image tag with source and attributes."
  1616. (save-match-data
  1617. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1618. (caption (and caption (org-xml-format-desc caption)))
  1619. (attr (org-find-text-property-in-string 'org-attributes src))
  1620. (label (org-find-text-property-in-string 'org-label src))
  1621. (latex-frag (org-find-text-property-in-string
  1622. 'org-latex-src src))
  1623. (category (and latex-frag "__DvipngImage__"))
  1624. (attr-plist (org-lparse-get-block-params attr))
  1625. (user-frame-anchor
  1626. (car (assoc-string (plist-get attr-plist :anchor)
  1627. '(("as-char") ("paragraph") ("page")) t)))
  1628. (user-frame-style
  1629. (and user-frame-anchor (plist-get attr-plist :style)))
  1630. (user-frame-attrs
  1631. (and user-frame-anchor (plist-get attr-plist :attributes)))
  1632. (user-frame-params
  1633. (list user-frame-style user-frame-attrs user-frame-anchor))
  1634. (embed-as (cond
  1635. (latex-frag
  1636. (symbol-name
  1637. (case (org-find-text-property-in-string
  1638. 'org-latex-src-embed-type src)
  1639. (paragraph 'paragraph)
  1640. (t 'as-char))))
  1641. (user-frame-anchor)
  1642. (t "paragraph")))
  1643. (size (org-odt-image-size-from-file
  1644. src (plist-get attr-plist :width)
  1645. (plist-get attr-plist :height)
  1646. (plist-get attr-plist :scale) nil embed-as))
  1647. (width (car size)) (height (cdr size)))
  1648. (when latex-frag
  1649. (setq href (org-propertize href :title "LaTeX Fragment"
  1650. :description latex-frag)))
  1651. (let ((frame-style-handle (concat (and (or caption label) "Captioned")
  1652. embed-as "Image")))
  1653. (org-odt-format-entity
  1654. frame-style-handle href width height
  1655. :caption caption :label label :category category
  1656. :user-frame-params user-frame-params)))))
  1657. (defun org-odt-format-object-description (title description)
  1658. (concat (and title (org-odt-format-tags
  1659. '("<svg:title>" . "</svg:title>")
  1660. (org-odt-encode-plain-text title t)))
  1661. (and description (org-odt-format-tags
  1662. '("<svg:desc>" . "</svg:desc>")
  1663. (org-odt-encode-plain-text description t)))))
  1664. (defun org-odt-format-frame (text width height style &optional
  1665. extra anchor-type)
  1666. (let ((frame-attrs
  1667. (concat
  1668. (if width (format " svg:width=\"%0.2fcm\"" width) "")
  1669. (if height (format " svg:height=\"%0.2fcm\"" height) "")
  1670. extra
  1671. (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph")))))
  1672. (org-odt-format-tags
  1673. '("<draw:frame draw:style-name=\"%s\"%s>" . "</draw:frame>")
  1674. (concat text (org-odt-format-object-description
  1675. (get-text-property 0 :title text)
  1676. (get-text-property 0 :description text)))
  1677. style frame-attrs)))
  1678. (defun org-odt-format-textbox (text width height style &optional
  1679. extra anchor-type)
  1680. (org-odt-format-frame
  1681. (org-odt-format-tags
  1682. '("<draw:text-box %s>" . "</draw:text-box>")
  1683. text (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
  1684. (unless width
  1685. (format " fo:min-width=\"%0.2fcm\"" (or width .2)))))
  1686. width nil style extra anchor-type))
  1687. (defun org-odt-format-inlinetask (heading content
  1688. &optional todo priority tags)
  1689. (org-odt-format-stylized-paragraph
  1690. nil (org-odt-format-textbox
  1691. (concat (org-odt-format-stylized-paragraph
  1692. "OrgInlineTaskHeading"
  1693. (org-lparse-format
  1694. 'HEADLINE (concat (org-lparse-format-todo todo) " " heading)
  1695. nil tags))
  1696. content) nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
  1697. (defvar org-odt-entity-frame-styles
  1698. '(("As-CharImage" "__Figure__" ("OrgInlineImage" nil "as-char"))
  1699. ("ParagraphImage" "__Figure__" ("OrgDisplayImage" nil "paragraph"))
  1700. ("PageImage" "__Figure__" ("OrgPageImage" nil "page"))
  1701. ("CaptionedAs-CharImage" "__Figure__"
  1702. ("OrgCaptionedImage"
  1703. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1704. ("OrgInlineImage" nil "as-char"))
  1705. ("CaptionedParagraphImage" "__Figure__"
  1706. ("OrgCaptionedImage"
  1707. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1708. ("OrgImageCaptionFrame" nil "paragraph"))
  1709. ("CaptionedPageImage" "__Figure__"
  1710. ("OrgCaptionedImage"
  1711. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1712. ("OrgPageImageCaptionFrame" nil "page"))
  1713. ("InlineFormula" "__MathFormula__" ("OrgInlineFormula" nil "as-char"))
  1714. ("DisplayFormula" "__MathFormula__" ("OrgDisplayFormula" nil "as-char"))
  1715. ("CaptionedDisplayFormula" "__MathFormula__"
  1716. ("OrgCaptionedFormula" nil "paragraph")
  1717. ("OrgFormulaCaptionFrame" nil "as-char"))))
  1718. (defun org-odt-merge-frame-params(default-frame-params user-frame-params)
  1719. (if (not user-frame-params) default-frame-params
  1720. (assert (= (length default-frame-params) 3))
  1721. (assert (= (length user-frame-params) 3))
  1722. (loop for user-frame-param in user-frame-params
  1723. for default-frame-param in default-frame-params
  1724. collect (or user-frame-param default-frame-param))))
  1725. (defun* org-odt-format-entity (entity href width height
  1726. &key caption label category
  1727. user-frame-params)
  1728. (let* ((entity-style (assoc-string entity org-odt-entity-frame-styles t))
  1729. default-frame-params frame-params)
  1730. (cond
  1731. ((not (or caption label))
  1732. (setq default-frame-params (nth 2 entity-style))
  1733. (setq frame-params (org-odt-merge-frame-params
  1734. default-frame-params user-frame-params))
  1735. (apply 'org-odt-format-frame href width height frame-params))
  1736. (t
  1737. (setq default-frame-params (nth 3 entity-style))
  1738. (setq frame-params (org-odt-merge-frame-params
  1739. default-frame-params user-frame-params))
  1740. (apply 'org-odt-format-textbox
  1741. (org-odt-format-stylized-paragraph
  1742. 'illustration
  1743. (concat
  1744. (apply 'org-odt-format-frame href width height
  1745. (nth 2 entity-style))
  1746. (org-odt-format-entity-caption
  1747. label caption (or category (nth 1 entity-style)))))
  1748. width height frame-params)))))
  1749. (defvar org-odt-embedded-images-count 0)
  1750. (defun org-odt-copy-image-file (path)
  1751. "Returns the internal name of the file"
  1752. (let* ((image-type (file-name-extension path))
  1753. (media-type (format "image/%s" image-type))
  1754. (src-file (expand-file-name
  1755. path (file-name-directory org-current-export-file)))
  1756. (target-dir "Images/")
  1757. (target-file
  1758. (format "%s%04d.%s" target-dir
  1759. (incf org-odt-embedded-images-count) image-type)))
  1760. (when (not org-lparse-to-buffer)
  1761. (message "Embedding %s as %s ..."
  1762. (substring-no-properties path) target-file)
  1763. (when (= 1 org-odt-embedded-images-count)
  1764. (make-directory target-dir)
  1765. (org-odt-create-manifest-file-entry "" target-dir))
  1766. (copy-file src-file target-file 'overwrite)
  1767. (org-odt-create-manifest-file-entry media-type target-file))
  1768. target-file))
  1769. (defvar org-export-odt-image-size-probe-method
  1770. (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
  1771. '(emacs fixed))
  1772. "Ordered list of methods for determining image sizes.")
  1773. (defvar org-export-odt-default-image-sizes-alist
  1774. '(("as-char" . (5 . 0.4))
  1775. ("paragraph" . (5 . 5)))
  1776. "Hardcoded image dimensions one for each of the anchor
  1777. methods.")
  1778. ;; A4 page size is 21.0 by 29.7 cms
  1779. ;; The default page settings has 2cm margin on each of the sides. So
  1780. ;; the effective text area is 17.0 by 25.7 cm
  1781. (defvar org-export-odt-max-image-size '(17.0 . 20.0)
  1782. "Limiting dimensions for an embedded image.")
  1783. (defun org-odt-do-image-size (probe-method file &optional dpi anchor-type)
  1784. (setq dpi (or dpi org-export-odt-pixels-per-inch))
  1785. (setq anchor-type (or anchor-type "paragraph"))
  1786. (flet ((size-in-cms (size-in-pixels)
  1787. (flet ((pixels-to-cms (pixels)
  1788. (let* ((cms-per-inch 2.54)
  1789. (inches (/ pixels dpi)))
  1790. (* cms-per-inch inches))))
  1791. (and size-in-pixels
  1792. (cons (pixels-to-cms (car size-in-pixels))
  1793. (pixels-to-cms (cdr size-in-pixels)))))))
  1794. (case probe-method
  1795. (emacs
  1796. (size-in-cms (ignore-errors ; Emacs could be in batch mode
  1797. (clear-image-cache)
  1798. (image-size (create-image file) 'pixels))))
  1799. (imagemagick
  1800. (size-in-cms
  1801. (let ((dim (shell-command-to-string
  1802. (format "identify -format \"%%w:%%h\" \"%s\"" file))))
  1803. (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
  1804. (cons (string-to-number (match-string 1 dim))
  1805. (string-to-number (match-string 2 dim)))))))
  1806. (t
  1807. (cdr (assoc-string anchor-type
  1808. org-export-odt-default-image-sizes-alist))))))
  1809. (defun org-odt-image-size-from-file (file &optional user-width
  1810. user-height scale dpi embed-as)
  1811. (unless (file-name-absolute-p file)
  1812. (setq file (expand-file-name
  1813. file (file-name-directory org-current-export-file))))
  1814. (let* (size width height)
  1815. (unless (and user-height user-width)
  1816. (loop for probe-method in org-export-odt-image-size-probe-method
  1817. until size
  1818. do (setq size (org-odt-do-image-size
  1819. probe-method file dpi embed-as)))
  1820. (or size (error "Cannot determine Image size. Aborting ..."))
  1821. (setq width (car size) height (cdr size)))
  1822. (cond
  1823. (scale
  1824. (setq width (* width scale) height (* height scale)))
  1825. ((and user-height user-width)
  1826. (setq width user-width height user-height))
  1827. (user-height
  1828. (setq width (* user-height (/ width height)) height user-height))
  1829. (user-width
  1830. (setq height (* user-width (/ height width)) width user-width))
  1831. (t (ignore)))
  1832. ;; ensure that an embedded image fits comfortably within a page
  1833. (let ((max-width (car org-export-odt-max-image-size))
  1834. (max-height (cdr org-export-odt-max-image-size)))
  1835. (when (or (> width max-width) (> height max-height))
  1836. (let* ((scale1 (/ max-width width))
  1837. (scale2 (/ max-height height))
  1838. (scale (min scale1 scale2)))
  1839. (setq width (* scale width) height (* scale height)))))
  1840. (cons width height)))
  1841. (defvar org-odt-entity-counts-plist nil
  1842. "Plist of running counters of SEQNOs for each of the CATEGORY-NAMEs.
  1843. See `org-odt-entity-labels-alist' for known CATEGORY-NAMEs.")
  1844. (defvar org-odt-label-styles
  1845. '(("math-formula" "%c" "text" "(%n)")
  1846. ("math-label" "(%n)" "text" "(%n)")
  1847. ("category-and-value" "%e %n: %c" "category-and-value" "%e %n")
  1848. ("value" "%e %n: %c" "value" "%n"))
  1849. "Specify how labels are applied and referenced.
  1850. This is an alist where each element is of the
  1851. form (LABEL-STYLE-NAME LABEL-ATTACH-FMT LABEL-REF-MODE
  1852. LABEL-REF-FMT).
  1853. LABEL-ATTACH-FMT controls how labels and captions are attached to
  1854. an entity. It may contain following specifiers - %e, %n and %c.
  1855. %e is replaced with the CATEGORY-NAME. %n is replaced with
  1856. \"<text:sequence ...> SEQNO </text:sequence>\". %c is replaced
  1857. with CAPTION. See `org-odt-format-label-definition'.
  1858. LABEL-REF-MODE and LABEL-REF-FMT controls how label references
  1859. are generated. The following XML is generated for a label
  1860. reference - \"<text:sequence-ref
  1861. text:reference-format=\"LABEL-REF-MODE\" ...> LABEL-REF-FMT
  1862. </text:sequence-ref>\". LABEL-REF-FMT may contain following
  1863. specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
  1864. %n is replaced with SEQNO. See
  1865. `org-odt-format-label-reference'.")
  1866. (defcustom org-export-odt-category-strings
  1867. '(("en" "Table" "Figure" "Equation" "Equation"))
  1868. "Specify category strings for various captionable entities.
  1869. Captionable entity can be one of a Table, an Embedded Image, a
  1870. LaTeX fragment (generated with dvipng) or a Math Formula.
  1871. For example, when `org-export-default-language' is \"en\", an
  1872. embedded image will be captioned as \"Figure 1: Orgmode Logo\".
  1873. If you want the images to be captioned instead as \"Illustration
  1874. 1: Orgmode Logo\", then modify the entry for \"en\" as shown
  1875. below.
  1876. \(setq org-export-odt-category-strings
  1877. '\(\(\"en\" \"Table\" \"Illustration\"
  1878. \"Equation\" \"Equation\"\)\)\)"
  1879. :group 'org-export-odt
  1880. :version "24.1"
  1881. :type '(repeat (list (string :tag "Language tag")
  1882. (choice :tag "Table"
  1883. (const :tag "Use Default" nil)
  1884. (string :tag "Category string"))
  1885. (choice :tag "Figure"
  1886. (const :tag "Use Default" nil)
  1887. (string :tag "Category string"))
  1888. (choice :tag "Math Formula"
  1889. (const :tag "Use Default" nil)
  1890. (string :tag "Category string"))
  1891. (choice :tag "Dvipng Image"
  1892. (const :tag "Use Default" nil)
  1893. (string :tag "Category string")))))
  1894. (defvar org-odt-category-map-alist
  1895. '(("__Table__" "Table" "value")
  1896. ("__Figure__" "Illustration" "value")
  1897. ("__MathFormula__" "Text" "math-formula")
  1898. ("__DvipngImage__" "Equation" "value")
  1899. ;; ("__Table__" "Table" "category-and-value")
  1900. ;; ("__Figure__" "Figure" "category-and-value")
  1901. ;; ("__DvipngImage__" "Equation" "category-and-value")
  1902. )
  1903. "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
  1904. This is a list where each entry is of the form \\(CATEGORY-HANDLE
  1905. OD-VARIABLE LABEL-STYLE\\). CATEGORY_HANDLE identifies the
  1906. captionable entity in question. OD-VARIABLE is the OpenDocument
  1907. sequence counter associated with the entity. These counters are
  1908. declared within
  1909. \"<text:sequence-decls>...</text:sequence-decls>\" block of
  1910. `org-export-odt-content-template-file'. LABEL-STYLE is a key
  1911. into `org-odt-label-styles' and specifies how a given entity
  1912. should be captioned and referenced.
  1913. The position of a CATEGORY-HANDLE in this list is used as an
  1914. index in to per-language entry for
  1915. `org-export-odt-category-strings' to retrieve a CATEGORY-NAME.
  1916. This CATEGORY-NAME is then used for qualifying the user-specified
  1917. captions on export.")
  1918. (defun org-odt-add-label-definition (label default-category)
  1919. "Create an entry in `org-odt-entity-labels-alist' and return it."
  1920. (let* ((label-props (assoc default-category org-odt-category-map-alist))
  1921. ;; identify the sequence number
  1922. (counter (nth 1 label-props))
  1923. (sequence-var (intern counter))
  1924. (seqno (1+ (or (plist-get org-odt-entity-counts-plist sequence-var)
  1925. 0)))
  1926. ;; assign an internal label, if user has not provided one
  1927. (label (if label (substring-no-properties label)
  1928. (format "%s-%s" default-category seqno)))
  1929. ;; identify label style
  1930. (label-style (nth 2 label-props))
  1931. ;; grok language setting
  1932. (en-strings (assoc-default "en" org-export-odt-category-strings))
  1933. (lang (plist-get org-lparse-opt-plist :language))
  1934. (lang-strings (assoc-default lang org-export-odt-category-strings))
  1935. ;; retrieve localized category sting
  1936. (pos (- (length org-odt-category-map-alist)
  1937. (length (memq label-props org-odt-category-map-alist))))
  1938. (category (or (nth pos lang-strings) (nth pos en-strings)))
  1939. (label-props (list label category counter seqno label-style)))
  1940. ;; synchronize internal counters
  1941. (setq org-odt-entity-counts-plist
  1942. (plist-put org-odt-entity-counts-plist sequence-var seqno))
  1943. ;; stash label properties for later retrieval
  1944. (push label-props org-odt-entity-labels-alist)
  1945. label-props))
  1946. (defun org-odt-format-label-definition (caption label category counter
  1947. seqno label-style)
  1948. (assert label)
  1949. (format-spec
  1950. (cadr (assoc-string label-style org-odt-label-styles t))
  1951. `((?e . ,category)
  1952. (?n . ,(org-odt-format-tags
  1953. '("<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">" . "</text:sequence>")
  1954. (format "%d" seqno) label counter counter))
  1955. (?c . ,(or caption "")))))
  1956. (defun org-odt-format-label-reference (label category counter
  1957. seqno label-style)
  1958. (assert label)
  1959. (save-match-data
  1960. (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
  1961. (fmt1 (car fmt))
  1962. (fmt2 (cadr fmt)))
  1963. (org-odt-format-tags
  1964. '("<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">"
  1965. . "</text:sequence-ref>")
  1966. (format-spec fmt2 `((?e . ,category)
  1967. (?n . ,(format "%d" seqno)))) fmt1 label))))
  1968. (defun org-odt-fixup-label-references ()
  1969. (goto-char (point-min))
  1970. (while (re-search-forward
  1971. "<text:sequence-ref text:ref-name=\"\\([^\"]+\\)\">[ \t\n]*</text:sequence-ref>"
  1972. nil t)
  1973. (let* ((label (match-string 1))
  1974. (label-def (assoc label org-odt-entity-labels-alist))
  1975. (rpl (and label-def
  1976. (apply 'org-odt-format-label-reference label-def))))
  1977. (if rpl (replace-match rpl t t)
  1978. (org-lparse-warn
  1979. (format "Unable to resolve reference to label \"%s\"" label))))))
  1980. (defun org-odt-format-entity-caption (label caption category)
  1981. (if (not (or label caption)) ""
  1982. (apply 'org-odt-format-label-definition caption
  1983. (org-odt-add-label-definition label category))))
  1984. (defun org-odt-format-tags (tag text &rest args)
  1985. (let ((prefix (when org-lparse-encode-pending "@"))
  1986. (suffix (when org-lparse-encode-pending "@")))
  1987. (apply 'org-lparse-format-tags tag text prefix suffix args)))
  1988. (defvar org-odt-manifest-file-entries nil)
  1989. (defun org-odt-init-outfile (filename)
  1990. (unless (executable-find "zip")
  1991. ;; Not at all OSes ship with zip by default
  1992. (error "Executable \"zip\" needed for creating OpenDocument files"))
  1993. (let* ((outdir (make-temp-file
  1994. (format org-export-odt-tmpdir-prefix org-lparse-backend) t))
  1995. (content-file (expand-file-name "content.xml" outdir)))
  1996. ;; init conten.xml
  1997. (require 'nxml-mode)
  1998. (let ((nxml-auto-insert-xml-declaration-flag nil))
  1999. (find-file-noselect content-file t))
  2000. ;; reset variables
  2001. (setq org-odt-manifest-file-entries nil
  2002. org-odt-embedded-images-count 0
  2003. org-odt-embedded-formulas-count 0
  2004. org-odt-entity-labels-alist nil
  2005. org-odt-list-stack-stashed nil
  2006. org-odt-automatic-styles nil
  2007. org-odt-object-counters nil
  2008. org-odt-entity-counts-plist nil)
  2009. content-file))
  2010. (defcustom org-export-odt-prettify-xml nil
  2011. "Specify whether or not the xml output should be prettified.
  2012. When this option is turned on, `indent-region' is run on all
  2013. component xml buffers before they are saved. Turn this off for
  2014. regular use. Turn this on if you need to examine the xml
  2015. visually."
  2016. :group 'org-export-odt
  2017. :version "24.1"
  2018. :type 'boolean)
  2019. (defvar hfy-user-sheet-assoc) ; bound during org-do-lparse
  2020. (defun org-odt-save-as-outfile (target opt-plist)
  2021. ;; write automatic styles
  2022. (org-odt-write-automatic-styles)
  2023. ;; write meta file
  2024. (org-odt-update-meta-file opt-plist)
  2025. ;; write styles file
  2026. (when (equal org-lparse-backend 'odt)
  2027. (org-odt-update-styles-file opt-plist))
  2028. ;; create mimetype file
  2029. (let ((mimetype (org-odt-write-mimetype-file org-lparse-backend)))
  2030. (org-odt-create-manifest-file-entry mimetype "/" "1.2"))
  2031. ;; create a manifest entry for content.xml
  2032. (org-odt-create-manifest-file-entry "text/xml" "content.xml")
  2033. ;; write out the manifest entries before zipping
  2034. (org-odt-write-manifest-file)
  2035. (let ((xml-files '("mimetype" "META-INF/manifest.xml" "content.xml"
  2036. "meta.xml"))
  2037. (zipdir default-directory))
  2038. (when (equal org-lparse-backend 'odt)
  2039. (push "styles.xml" xml-files))
  2040. (message "Switching to directory %s" (expand-file-name zipdir))
  2041. ;; save all xml files
  2042. (mapc (lambda (file)
  2043. (with-current-buffer
  2044. (find-file-noselect (expand-file-name file) t)
  2045. ;; prettify output if needed
  2046. (when org-export-odt-prettify-xml
  2047. (indent-region (point-min) (point-max)))
  2048. (save-buffer 0)))
  2049. xml-files)
  2050. (let* ((target-name (file-name-nondirectory target))
  2051. (target-dir (file-name-directory target))
  2052. (cmds `(("zip" "-mX0" ,target-name "mimetype")
  2053. ("zip" "-rmTq" ,target-name "."))))
  2054. (when (file-exists-p target)
  2055. ;; FIXME: If the file is locked this throws a cryptic error
  2056. (delete-file target))
  2057. (let ((coding-system-for-write 'no-conversion) exitcode err-string)
  2058. (message "Creating odt file...")
  2059. (mapc
  2060. (lambda (cmd)
  2061. (message "Running %s" (mapconcat 'identity cmd " "))
  2062. (setq err-string
  2063. (with-output-to-string
  2064. (setq exitcode
  2065. (apply 'call-process (car cmd)
  2066. nil standard-output nil (cdr cmd)))))
  2067. (or (zerop exitcode)
  2068. (ignore (message "%s" err-string))
  2069. (error "Unable to create odt file (%S)" exitcode)))
  2070. cmds))
  2071. ;; move the file from outdir to target-dir
  2072. (rename-file target-name target-dir)
  2073. ;; kill all xml buffers
  2074. (mapc (lambda (file)
  2075. (kill-buffer
  2076. (find-file-noselect (expand-file-name file zipdir) t)))
  2077. xml-files)
  2078. (delete-directory zipdir)))
  2079. (message "Created %s" target)
  2080. (set-buffer (find-file-noselect target t)))
  2081. (defconst org-odt-manifest-file-entry-tag
  2082. "
  2083. <manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
  2084. (defun org-odt-create-manifest-file-entry (&rest args)
  2085. (push args org-odt-manifest-file-entries))
  2086. (defun org-odt-write-manifest-file ()
  2087. (make-directory "META-INF")
  2088. (let ((manifest-file (expand-file-name "META-INF/manifest.xml")))
  2089. (with-current-buffer
  2090. (let ((nxml-auto-insert-xml-declaration-flag nil))
  2091. (find-file-noselect manifest-file t))
  2092. (insert
  2093. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  2094. <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
  2095. (mapc
  2096. (lambda (file-entry)
  2097. (let* ((version (nth 2 file-entry))
  2098. (extra (if version
  2099. (format " manifest:version=\"%s\"" version)
  2100. "")))
  2101. (insert
  2102. (format org-odt-manifest-file-entry-tag
  2103. (nth 0 file-entry) (nth 1 file-entry) extra))))
  2104. org-odt-manifest-file-entries)
  2105. (insert "\n</manifest:manifest>"))))
  2106. (defun org-odt-update-meta-file (opt-plist)
  2107. (let ((date (org-odt-format-date (plist-get opt-plist :date)))
  2108. (author (or (plist-get opt-plist :author) ""))
  2109. (email (plist-get opt-plist :email))
  2110. (keywords (plist-get opt-plist :keywords))
  2111. (description (plist-get opt-plist :description))
  2112. (title (plist-get opt-plist :title)))
  2113. (write-region
  2114. (concat
  2115. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  2116. <office:document-meta
  2117. xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
  2118. xmlns:xlink=\"http://www.w3.org/1999/xlink\"
  2119. xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
  2120. xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
  2121. xmlns:ooo=\"http://openoffice.org/2004/office\"
  2122. office:version=\"1.2\">
  2123. <office:meta>" "\n"
  2124. (org-odt-format-author)
  2125. (org-odt-format-tags
  2126. '("\n<meta:initial-creator>" . "</meta:initial-creator>") author)
  2127. (org-odt-format-tags '("\n<dc:date>" . "</dc:date>") date)
  2128. (org-odt-format-tags
  2129. '("\n<meta:creation-date>" . "</meta:creation-date>") date)
  2130. (org-odt-format-tags '("\n<meta:generator>" . "</meta:generator>")
  2131. (when org-export-creator-info
  2132. (format "Org-%s/Emacs-%s"
  2133. org-version emacs-version)))
  2134. (org-odt-format-tags '("\n<meta:keyword>" . "</meta:keyword>") keywords)
  2135. (org-odt-format-tags '("\n<dc:subject>" . "</dc:subject>") description)
  2136. (org-odt-format-tags '("\n<dc:title>" . "</dc:title>") title)
  2137. "\n"
  2138. " </office:meta>" "</office:document-meta>")
  2139. nil (expand-file-name "meta.xml")))
  2140. ;; create a manifest entry for meta.xml
  2141. (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
  2142. (defun org-odt-update-styles-file (opt-plist)
  2143. ;; write styles file
  2144. (let ((styles-file (plist-get opt-plist :odt-styles-file)))
  2145. (org-odt-copy-styles-file (and styles-file
  2146. (read (org-trim styles-file)))))
  2147. ;; Update styles.xml - take care of outline numbering
  2148. (with-current-buffer
  2149. (find-file-noselect (expand-file-name "styles.xml") t)
  2150. ;; Don't make automatic backup of styles.xml file. This setting
  2151. ;; prevents the backed-up styles.xml file from being zipped in to
  2152. ;; odt file. This is more of a hackish fix. Better alternative
  2153. ;; would be to fix the zip command so that the output odt file
  2154. ;; includes only the needed files and excludes any auto-generated
  2155. ;; extra files like backups and auto-saves etc etc. Note that
  2156. ;; currently the zip command zips up the entire temp directory so
  2157. ;; that any auto-generated files created under the hood ends up in
  2158. ;; the resulting odt file.
  2159. (set (make-local-variable 'backup-inhibited) t)
  2160. ;; Import local setting of `org-export-with-section-numbers'
  2161. (org-lparse-bind-local-variables opt-plist)
  2162. (org-odt-configure-outline-numbering
  2163. (if org-export-with-section-numbers org-export-headline-levels 0)))
  2164. ;; Write custom styles for source blocks
  2165. (org-odt-insert-custom-styles-for-srcblocks
  2166. (mapconcat
  2167. (lambda (style)
  2168. (format " %s\n" (cddr style)))
  2169. hfy-user-sheet-assoc "")))
  2170. (defun org-odt-write-mimetype-file (format)
  2171. ;; create mimetype file
  2172. (let ((mimetype
  2173. (case format
  2174. (odt "application/vnd.oasis.opendocument.text")
  2175. (odf "application/vnd.oasis.opendocument.formula")
  2176. (t (error "Unknown OpenDocument backend %S" org-lparse-backend)))))
  2177. (write-region mimetype nil (expand-file-name "mimetype"))
  2178. mimetype))
  2179. (defun org-odt-finalize-outfile ()
  2180. (org-odt-delete-empty-paragraphs))
  2181. (defun org-odt-delete-empty-paragraphs ()
  2182. (goto-char (point-min))
  2183. (let ((open "<text:p[^>]*>")
  2184. (close "</text:p>"))
  2185. (while (re-search-forward (format "%s[ \r\n\t]*%s" open close) nil t)
  2186. (replace-match ""))))
  2187. (defcustom org-export-odt-convert-processes
  2188. '(("LibreOffice"
  2189. "soffice --headless --convert-to %f%x --outdir %d %i")
  2190. ("unoconv"
  2191. "unoconv -f %f -o %d %i"))
  2192. "Specify a list of document converters and their usage.
  2193. The converters in this list are offered as choices while
  2194. customizing `org-export-odt-convert-process'.
  2195. This variable is a list where each element is of the
  2196. form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
  2197. of the converter. CONVERTER-CMD is the shell command for the
  2198. converter and can contain format specifiers. These format
  2199. specifiers are interpreted as below:
  2200. %i input file name in full
  2201. %I input file name as a URL
  2202. %f format of the output file
  2203. %o output file name in full
  2204. %O output file name as a URL
  2205. %d output dir in full
  2206. %D output dir as a URL.
  2207. %x extra options as set in `org-export-odt-convert-capabilities'."
  2208. :group 'org-export-odt
  2209. :version "24.1"
  2210. :type
  2211. '(choice
  2212. (const :tag "None" nil)
  2213. (alist :tag "Converters"
  2214. :key-type (string :tag "Converter Name")
  2215. :value-type (group (string :tag "Command line")))))
  2216. (defcustom org-export-odt-convert-process "LibreOffice"
  2217. "Use this converter to convert from \"odt\" format to other formats.
  2218. During customization, the list of converter names are populated
  2219. from `org-export-odt-convert-processes'."
  2220. :group 'org-export-odt
  2221. :version "24.1"
  2222. :type '(choice :convert-widget
  2223. (lambda (w)
  2224. (apply 'widget-convert (widget-type w)
  2225. (eval (car (widget-get w :args)))))
  2226. `((const :tag "None" nil)
  2227. ,@(mapcar (lambda (c)
  2228. `(const :tag ,(car c) ,(car c)))
  2229. org-export-odt-convert-processes))))
  2230. (defcustom org-export-odt-convert-capabilities
  2231. '(("Text"
  2232. ("odt" "ott" "doc" "rtf" "docx")
  2233. (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
  2234. ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
  2235. ("Web"
  2236. ("html")
  2237. (("pdf" "pdf") ("odt" "odt") ("html" "html")))
  2238. ("Spreadsheet"
  2239. ("ods" "ots" "xls" "csv" "xlsx")
  2240. (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
  2241. ("xls" "xls") ("xlsx" "xlsx")))
  2242. ("Presentation"
  2243. ("odp" "otp" "ppt" "pptx")
  2244. (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
  2245. ("pptx" "pptx") ("odg" "odg"))))
  2246. "Specify input and output formats of `org-export-odt-convert-process'.
  2247. More correctly, specify the set of input and output formats that
  2248. the user is actually interested in.
  2249. This variable is an alist where each element is of the
  2250. form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
  2251. INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
  2252. alist where each element is of the form (OUTPUT-FMT
  2253. OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
  2254. The variable is interpreted as follows:
  2255. `org-export-odt-convert-process' can take any document that is in
  2256. INPUT-FMT-LIST and produce any document that is in the
  2257. OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
  2258. OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
  2259. serves dual purposes:
  2260. - It is used for populating completion candidates during
  2261. `org-export-odt-convert' commands.
  2262. - It is used as the value of \"%f\" specifier in
  2263. `org-export-odt-convert-process'.
  2264. EXTRA-OPTIONS is used as the value of \"%x\" specifier in
  2265. `org-export-odt-convert-process'.
  2266. DOCUMENT-CLASS is used to group a set of file formats in
  2267. INPUT-FMT-LIST in to a single class.
  2268. Note that this variable inherently captures how LibreOffice based
  2269. converters work. LibreOffice maps documents of various formats
  2270. to classes like Text, Web, Spreadsheet, Presentation etc and
  2271. allow document of a given class (irrespective of it's source
  2272. format) to be converted to any of the export formats associated
  2273. with that class.
  2274. See default setting of this variable for an typical
  2275. configuration."
  2276. :group 'org-export-odt
  2277. :version "24.1"
  2278. :type
  2279. '(choice
  2280. (const :tag "None" nil)
  2281. (alist :tag "Capabilities"
  2282. :key-type (string :tag "Document Class")
  2283. :value-type
  2284. (group (repeat :tag "Input formats" (string :tag "Input format"))
  2285. (alist :tag "Output formats"
  2286. :key-type (string :tag "Output format")
  2287. :value-type
  2288. (group (string :tag "Output file extension")
  2289. (choice
  2290. (const :tag "None" nil)
  2291. (string :tag "Extra options"))))))))
  2292. (declare-function org-create-math-formula "org"
  2293. (latex-frag &optional mathml-file))
  2294. ;;;###autoload
  2295. (defun org-export-odt-convert (&optional in-file out-fmt prefix-arg)
  2296. "Convert IN-FILE to format OUT-FMT using a command line converter.
  2297. IN-FILE is the file to be converted. If unspecified, it defaults
  2298. to variable `buffer-file-name'. OUT-FMT is the desired output
  2299. format. Use `org-export-odt-convert-process' as the converter.
  2300. If PREFIX-ARG is non-nil then the newly converted file is opened
  2301. using `org-open-file'."
  2302. (interactive
  2303. (append (org-lparse-convert-read-params) current-prefix-arg))
  2304. (org-lparse-do-convert in-file out-fmt prefix-arg))
  2305. (defun org-odt-get (what &optional opt-plist)
  2306. (case what
  2307. (BACKEND 'odt)
  2308. (EXPORT-DIR (org-export-directory :html opt-plist))
  2309. (FILE-NAME-EXTENSION "odt")
  2310. (EXPORT-BUFFER-NAME "*Org ODT Export*")
  2311. (ENTITY-CONTROL org-odt-entity-control-callbacks-alist)
  2312. (ENTITY-FORMAT org-odt-entity-format-callbacks-alist)
  2313. (INIT-METHOD 'org-odt-init-outfile)
  2314. (FINAL-METHOD 'org-odt-finalize-outfile)
  2315. (SAVE-METHOD 'org-odt-save-as-outfile)
  2316. (CONVERT-METHOD
  2317. (and org-export-odt-convert-process
  2318. (cadr (assoc-string org-export-odt-convert-process
  2319. org-export-odt-convert-processes t))))
  2320. (CONVERT-CAPABILITIES
  2321. (and org-export-odt-convert-process
  2322. (cadr (assoc-string org-export-odt-convert-process
  2323. org-export-odt-convert-processes t))
  2324. org-export-odt-convert-capabilities))
  2325. (TOPLEVEL-HLEVEL 1)
  2326. (SPECIAL-STRING-REGEXPS org-export-odt-special-string-regexps)
  2327. (INLINE-IMAGES 'maybe)
  2328. (INLINE-IMAGE-EXTENSIONS '("png" "jpeg" "jpg" "gif" "svg"))
  2329. (PLAIN-TEXT-MAP '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
  2330. (TABLE-FIRST-COLUMN-AS-LABELS nil)
  2331. (FOOTNOTE-SEPARATOR (org-lparse-format 'FONTIFY "," 'superscript))
  2332. (CODING-SYSTEM-FOR-WRITE 'utf-8)
  2333. (CODING-SYSTEM-FOR-SAVE 'utf-8)
  2334. (t (error "Unknown property: %s" what))))
  2335. (defvar org-lparse-latex-fragment-fallback) ; set by org-do-lparse
  2336. (defun org-export-odt-do-preprocess-latex-fragments ()
  2337. "Convert LaTeX fragments to images."
  2338. (let* ((latex-frag-opt (plist-get org-lparse-opt-plist :LaTeX-fragments))
  2339. (latex-frag-opt ; massage the options
  2340. (or (and (member latex-frag-opt '(mathjax t))
  2341. (not (and (fboundp 'org-format-latex-mathml-available-p)
  2342. (org-format-latex-mathml-available-p)))
  2343. (prog1 org-lparse-latex-fragment-fallback
  2344. (org-lparse-warn
  2345. (concat
  2346. "LaTeX to MathML converter not available. "
  2347. (format "Using %S instead."
  2348. org-lparse-latex-fragment-fallback)))))
  2349. latex-frag-opt))
  2350. cache-dir display-msg)
  2351. (cond
  2352. ((eq latex-frag-opt 'dvipng)
  2353. (setq cache-dir "ltxpng/")
  2354. (setq display-msg "Creating LaTeX image %s"))
  2355. ((member latex-frag-opt '(mathjax t))
  2356. (setq latex-frag-opt 'mathml)
  2357. (setq cache-dir "ltxmathml/")
  2358. (setq display-msg "Creating MathML formula %s")))
  2359. (when (and org-current-export-file)
  2360. (org-format-latex
  2361. (concat cache-dir (file-name-sans-extension
  2362. (file-name-nondirectory org-current-export-file)))
  2363. org-current-export-dir nil display-msg
  2364. nil nil latex-frag-opt))))
  2365. (defadvice org-format-latex-as-mathml
  2366. (after org-odt-protect-latex-fragment activate)
  2367. "Encode LaTeX fragment as XML.
  2368. Do this when translation to MathML fails."
  2369. (when (or (not (> (length ad-return-value) 0))
  2370. (get-text-property 0 'org-protected ad-return-value))
  2371. (setq ad-return-value
  2372. (org-propertize (org-odt-encode-plain-text (ad-get-arg 0))
  2373. 'org-protected t))))
  2374. (defun org-export-odt-preprocess-latex-fragments ()
  2375. (when (equal org-export-current-backend 'odt)
  2376. (org-export-odt-do-preprocess-latex-fragments)))
  2377. (defun org-export-odt-preprocess-label-references ()
  2378. (goto-char (point-min))
  2379. (let (label label-components category value pretty-label)
  2380. (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
  2381. (org-if-unprotected-at (match-beginning 1)
  2382. (replace-match
  2383. (let ((org-lparse-encode-pending t)
  2384. (label (match-string 1)))
  2385. ;; markup generated below is mostly an eye-candy. At
  2386. ;; pre-processing stage, there is no information on which
  2387. ;; entity a label reference points to. The actual markup
  2388. ;; is generated as part of `org-odt-fixup-label-references'
  2389. ;; which gets called at the fag end of export. By this
  2390. ;; time we would have seen and collected all the label
  2391. ;; definitions in `org-odt-entity-labels-alist'.
  2392. (org-odt-format-tags
  2393. '("<text:sequence-ref text:ref-name=\"%s\">" .
  2394. "</text:sequence-ref>")
  2395. "" (org-add-props label '(org-protected t)))) t t)))))
  2396. ;; process latex fragments as part of
  2397. ;; `org-export-preprocess-after-blockquote-hook'. Note that this hook
  2398. ;; is the one that is closest and well before the call to
  2399. ;; `org-export-attach-captions-and-attributes' in
  2400. ;; `org-export-preprocess-string'. The above arrangement permits
  2401. ;; captions, labels and attributes to be attached to png images
  2402. ;; generated out of latex equations.
  2403. (add-hook 'org-export-preprocess-after-blockquote-hook
  2404. 'org-export-odt-preprocess-latex-fragments)
  2405. (defun org-export-odt-preprocess (parameters)
  2406. (org-export-odt-preprocess-label-references))
  2407. (declare-function archive-zip-extract "arc-mode.el" (archive name))
  2408. (defun org-odt-zip-extract-one (archive member &optional target)
  2409. (require 'arc-mode)
  2410. (let* ((target (or target default-directory))
  2411. (archive (expand-file-name archive))
  2412. (archive-zip-extract
  2413. (list "unzip" "-qq" "-o" "-d" target))
  2414. exit-code command-output)
  2415. (setq command-output
  2416. (with-temp-buffer
  2417. (setq exit-code (archive-zip-extract archive member))
  2418. (buffer-string)))
  2419. (unless (zerop exit-code)
  2420. (message command-output)
  2421. (error "Extraction failed"))))
  2422. (defun org-odt-zip-extract (archive members &optional target)
  2423. (when (atom members) (setq members (list members)))
  2424. (mapc (lambda (member)
  2425. (org-odt-zip-extract-one archive member target))
  2426. members))
  2427. (defun org-odt-copy-styles-file (&optional styles-file)
  2428. ;; Non-availability of styles.xml is not a critical error. For now
  2429. ;; throw an error purely for aesthetic reasons.
  2430. (setq styles-file (or styles-file
  2431. org-export-odt-styles-file
  2432. (expand-file-name "OrgOdtStyles.xml"
  2433. org-odt-styles-dir)
  2434. (error "org-odt: Missing styles file?")))
  2435. (cond
  2436. ((listp styles-file)
  2437. (let ((archive (nth 0 styles-file))
  2438. (members (nth 1 styles-file)))
  2439. (org-odt-zip-extract archive members)
  2440. (mapc
  2441. (lambda (member)
  2442. (when (org-file-image-p member)
  2443. (let* ((image-type (file-name-extension member))
  2444. (media-type (format "image/%s" image-type)))
  2445. (org-odt-create-manifest-file-entry media-type member))))
  2446. members)))
  2447. ((and (stringp styles-file) (file-exists-p styles-file))
  2448. (let ((styles-file-type (file-name-extension styles-file)))
  2449. (cond
  2450. ((string= styles-file-type "xml")
  2451. (copy-file styles-file "styles.xml" t))
  2452. ((member styles-file-type '("odt" "ott"))
  2453. (org-odt-zip-extract styles-file "styles.xml")))))
  2454. (t
  2455. (error (format "Invalid specification of styles.xml file: %S"
  2456. org-export-odt-styles-file))))
  2457. ;; create a manifest entry for styles.xml
  2458. (org-odt-create-manifest-file-entry "text/xml" "styles.xml"))
  2459. (defun org-odt-configure-outline-numbering (level)
  2460. "Outline numbering is retained only upto LEVEL.
  2461. To disable outline numbering pass a LEVEL of 0."
  2462. (goto-char (point-min))
  2463. (let ((regex
  2464. "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
  2465. (replacement
  2466. "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
  2467. (while (re-search-forward regex nil t)
  2468. (when (> (string-to-number (match-string 2)) level)
  2469. (replace-match replacement t nil))))
  2470. (save-buffer 0))
  2471. ;;;###autoload
  2472. (defun org-export-as-odf (latex-frag &optional odf-file)
  2473. "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
  2474. Use `org-create-math-formula' to convert LATEX-FRAG first to
  2475. MathML. When invoked as an interactive command, use
  2476. `org-latex-regexps' to infer LATEX-FRAG from currently active
  2477. region. If no LaTeX fragments are found, prompt for it. Push
  2478. MathML source to kill ring, if `org-export-copy-to-kill-ring' is
  2479. non-nil."
  2480. (interactive
  2481. `(,(let (frag)
  2482. (setq frag (and (setq frag (and (region-active-p)
  2483. (buffer-substring (region-beginning)
  2484. (region-end))))
  2485. (loop for e in org-latex-regexps
  2486. thereis (when (string-match (nth 1 e) frag)
  2487. (match-string (nth 2 e) frag)))))
  2488. (read-string "LaTeX Fragment: " frag nil frag))
  2489. ,(let ((odf-filename (expand-file-name
  2490. (concat
  2491. (file-name-sans-extension
  2492. (or (file-name-nondirectory buffer-file-name)))
  2493. "." "odf")
  2494. (file-name-directory buffer-file-name))))
  2495. (read-file-name "ODF filename: " nil odf-filename nil
  2496. (file-name-nondirectory odf-filename)))))
  2497. (let* ((org-lparse-backend 'odf)
  2498. org-lparse-opt-plist
  2499. (filename (or odf-file
  2500. (expand-file-name
  2501. (concat
  2502. (file-name-sans-extension
  2503. (or (file-name-nondirectory buffer-file-name)))
  2504. "." "odf")
  2505. (file-name-directory buffer-file-name))))
  2506. (buffer (find-file-noselect (org-odt-init-outfile filename)))
  2507. (coding-system-for-write 'utf-8)
  2508. (save-buffer-coding-system 'utf-8))
  2509. (set-buffer buffer)
  2510. (set-buffer-file-coding-system coding-system-for-write)
  2511. (let ((mathml (org-create-math-formula latex-frag)))
  2512. (unless mathml (error "No Math formula created"))
  2513. (insert mathml)
  2514. (or (org-export-push-to-kill-ring
  2515. (upcase (symbol-name org-lparse-backend)))
  2516. (message "Exporting... done")))
  2517. (org-odt-save-as-outfile filename nil)))
  2518. ;;;###autoload
  2519. (defun org-export-as-odf-and-open ()
  2520. "Export LaTeX fragment as OpenDocument formula and immediately open it.
  2521. Use `org-export-as-odf' to read LaTeX fragment and OpenDocument
  2522. formula file."
  2523. (interactive)
  2524. (org-lparse-and-open
  2525. nil nil nil (call-interactively 'org-export-as-odf)))
  2526. (provide 'org-odt)
  2527. ;;; org-odt.el ends here