org-odt.el 101 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750
  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. (insert
  1061. (format "
  1062. <text:table-of-content text:style-name=\"Sect2\" text:protected=\"true\" text:name=\"Table of Contents1\">
  1063. <text:table-of-content-source text:outline-level=\"%d\">
  1064. <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
  1065. " max-level lang-specific-heading))
  1066. (loop for level from 1 upto 10
  1067. do (insert (format
  1068. "
  1069. <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
  1070. <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
  1071. <text:index-entry-chapter/>
  1072. <text:index-entry-text/>
  1073. <text:index-entry-link-end/>
  1074. </text:table-of-content-entry-template>
  1075. " level level)))
  1076. (insert
  1077. (format "
  1078. </text:table-of-content-source>
  1079. <text:index-body>
  1080. <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
  1081. <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
  1082. </text:index-title>
  1083. " lang-specific-heading)))
  1084. (defun org-odt-end-toc ()
  1085. (insert "
  1086. </text:index-body>
  1087. </text:table-of-content>
  1088. "))
  1089. (defun org-odt-format-toc-entry (snumber todo headline tags href)
  1090. (setq headline (concat
  1091. (and org-export-with-section-numbers
  1092. (concat snumber ". "))
  1093. headline
  1094. (and tags
  1095. (concat
  1096. (org-lparse-format 'SPACES 3)
  1097. (org-lparse-format 'FONTIFY tags "tag")))))
  1098. (when todo
  1099. (setq headline (org-lparse-format 'FONTIFY headline "todo")))
  1100. (let ((org-odt-suppress-xref t))
  1101. (org-odt-format-link headline (concat "#" href))))
  1102. (defun org-odt-format-toc-item (toc-entry level org-last-level)
  1103. (let ((style (format "Contents_20_%d"
  1104. (+ level (or (org-lparse-get 'TOPLEVEL-HLEVEL) 1) -1))))
  1105. (insert "\n" (org-odt-format-stylized-paragraph style toc-entry) "\n")))
  1106. ;; Following variable is let bound during 'ORG-LINK callback. See
  1107. ;; org-html.el
  1108. (defvar org-lparse-link-description-is-image nil)
  1109. (defun org-odt-format-link (desc href &optional attr)
  1110. (cond
  1111. ((and (= (string-to-char href) ?#) (not org-odt-suppress-xref))
  1112. (setq href (concat org-export-odt-bookmark-prefix (substring href 1)))
  1113. (let ((xref-format "text"))
  1114. (when (numberp desc)
  1115. (setq desc (format "%d" desc) xref-format "number"))
  1116. (org-odt-format-tags
  1117. '("<text:bookmark-ref text:reference-format=\"%s\" text:ref-name=\"%s\">" .
  1118. "</text:bookmark-ref>")
  1119. desc xref-format href)))
  1120. (org-lparse-link-description-is-image
  1121. (org-odt-format-tags
  1122. '("<draw:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</draw:a>")
  1123. desc href (or attr "")))
  1124. (t
  1125. (org-odt-format-tags
  1126. '("<text:a xlink:type=\"simple\" xlink:href=\"%s\" %s>" . "</text:a>")
  1127. desc href (or attr "")))))
  1128. (defun org-odt-format-spaces (n)
  1129. (cond
  1130. ((= n 1) " ")
  1131. ((> n 1) (concat
  1132. " " (org-odt-format-tags "<text:s text:c=\"%d\"/>" "" (1- n))))
  1133. (t "")))
  1134. (defun org-odt-format-tabs (&optional n)
  1135. (let ((tab "<text:tab/>")
  1136. (n (or n 1)))
  1137. (insert tab)))
  1138. (defun org-odt-format-line-break ()
  1139. (org-odt-format-tags "<text:line-break/>" ""))
  1140. (defun org-odt-format-horizontal-line ()
  1141. (org-odt-format-stylized-paragraph 'horizontal-line ""))
  1142. (defun org-odt-encode-plain-text (line &optional no-whitespace-filling)
  1143. (setq line (org-xml-encode-plain-text line))
  1144. (if no-whitespace-filling line
  1145. (org-odt-fill-tabs-and-spaces line)))
  1146. (defun org-odt-format-line (line)
  1147. (case org-lparse-dyn-current-environment
  1148. (fixedwidth (concat
  1149. (org-odt-format-stylized-paragraph
  1150. 'fixedwidth (org-odt-encode-plain-text line)) "\n"))
  1151. (t (concat line "\n"))))
  1152. (defun org-odt-format-comment (fmt &rest args)
  1153. (let ((comment (apply 'format fmt args)))
  1154. (format "\n<!-- %s -->\n" comment)))
  1155. (defun org-odt-format-org-entity (wd)
  1156. (org-entity-get-representation wd 'utf8))
  1157. (defun org-odt-fill-tabs-and-spaces (line)
  1158. (replace-regexp-in-string
  1159. "\\([\t]\\|\\([ ]+\\)\\)" (lambda (s)
  1160. (cond
  1161. ((string= s "\t") (org-odt-format-tabs))
  1162. (t (org-odt-format-spaces (length s))))) line))
  1163. (defcustom org-export-odt-fontify-srcblocks t
  1164. "Specify whether or not source blocks need to be fontified.
  1165. Turn this option on if you want to colorize the source code
  1166. blocks in the exported file. For colorization to work, you need
  1167. to make available an enhanced version of `htmlfontify' library."
  1168. :type 'boolean
  1169. :group 'org-export-odt
  1170. :version "24.1")
  1171. (defun org-odt-format-source-line-with-line-number-and-label
  1172. (line rpllbl num fontifier par-style)
  1173. (let ((keep-label (not (numberp rpllbl)))
  1174. (ref (org-find-text-property-in-string 'org-coderef line)))
  1175. (setq line (concat line (and keep-label ref (format "(%s)" ref))))
  1176. (setq line (funcall fontifier line))
  1177. (when ref
  1178. (setq line (org-odt-format-target line (concat "coderef-" ref))))
  1179. (setq line (org-odt-format-stylized-paragraph par-style line))
  1180. (if (not num) line
  1181. (org-odt-format-tags '("<text:list-item>" . "</text:list-item>") line))))
  1182. (defun org-odt-format-source-code-or-example-plain
  1183. (lines lang caption textareap cols rows num cont rpllbl fmt)
  1184. "Format source or example blocks much like fixedwidth blocks.
  1185. Use this when `org-export-odt-fontify-srcblocks' option is turned
  1186. off."
  1187. (let* ((lines (org-split-string lines "[\r\n]"))
  1188. (line-count (length lines))
  1189. (i 0))
  1190. (mapconcat
  1191. (lambda (line)
  1192. (incf i)
  1193. (org-odt-format-source-line-with-line-number-and-label
  1194. line rpllbl num 'org-odt-encode-plain-text
  1195. (if (= i line-count) "OrgFixedWidthBlockLastLine"
  1196. "OrgFixedWidthBlock")))
  1197. lines "\n")))
  1198. (defvar org-src-block-paragraph-format
  1199. "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
  1200. <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
  1201. <style:background-image/>
  1202. </style:paragraph-properties>
  1203. <style:text-properties fo:color=\"%s\"/>
  1204. </style:style>"
  1205. "Custom paragraph style for colorized source and example blocks.
  1206. This style is much the same as that of \"OrgFixedWidthBlock\"
  1207. except that the foreground and background colors are set
  1208. according to the default face identified by the `htmlfontify'.")
  1209. (defvar hfy-optimisations)
  1210. (declare-function hfy-face-to-style "htmlfontify" (fn))
  1211. (declare-function hfy-face-or-def-to-name "htmlfontify" (fn))
  1212. (defun org-odt-hfy-face-to-css (fn)
  1213. "Create custom style for face FN.
  1214. When FN is the default face, use it's foreground and background
  1215. properties to create \"OrgSrcBlock\" paragraph style. Otherwise
  1216. use it's color attribute to create a character style whose name
  1217. is obtained from FN. Currently all attributes of FN other than
  1218. color are ignored.
  1219. The style name for a face FN is derived using the following
  1220. operations on the face name in that order - de-dash, CamelCase
  1221. and prefix with \"OrgSrc\". For example,
  1222. `font-lock-function-name-face' is associated with
  1223. \"OrgSrcFontLockFunctionNameFace\"."
  1224. (let* ((css-list (hfy-face-to-style fn))
  1225. (style-name ((lambda (fn)
  1226. (concat "OrgSrc"
  1227. (mapconcat
  1228. 'capitalize (split-string
  1229. (hfy-face-or-def-to-name fn) "-")
  1230. ""))) fn))
  1231. (color-val (cdr (assoc "color" css-list)))
  1232. (background-color-val (cdr (assoc "background" css-list)))
  1233. (style (and org-export-odt-create-custom-styles-for-srcblocks
  1234. (cond
  1235. ((eq fn 'default)
  1236. (format org-src-block-paragraph-format
  1237. background-color-val color-val))
  1238. (t
  1239. (format
  1240. "
  1241. <style:style style:name=\"%s\" style:family=\"text\">
  1242. <style:text-properties fo:color=\"%s\"/>
  1243. </style:style>" style-name color-val))))))
  1244. (cons style-name style)))
  1245. (defun org-odt-insert-custom-styles-for-srcblocks (styles)
  1246. "Save STYLES used for colorizing of source blocks.
  1247. Update styles.xml with styles that were collected as part of
  1248. `org-odt-hfy-face-to-css' callbacks."
  1249. (when styles
  1250. (with-current-buffer
  1251. (find-file-noselect (expand-file-name "styles.xml") t)
  1252. (goto-char (point-min))
  1253. (when (re-search-forward "</office:styles>" nil t)
  1254. (goto-char (match-beginning 0))
  1255. (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n")))))
  1256. (defun org-odt-format-source-code-or-example-colored
  1257. (lines lang caption textareap cols rows num cont rpllbl fmt)
  1258. "Format source or example blocks using `htmlfontify-string'.
  1259. Use this routine when `org-export-odt-fontify-srcblocks' option
  1260. is turned on."
  1261. (let* ((lang-m (and lang (or (cdr (assoc lang org-src-lang-modes)) lang)))
  1262. (mode (and lang-m (intern (concat (if (symbolp lang-m)
  1263. (symbol-name lang-m)
  1264. lang-m) "-mode"))))
  1265. (org-inhibit-startup t)
  1266. (org-startup-folded nil)
  1267. (lines (with-temp-buffer
  1268. (insert lines)
  1269. (if (functionp mode) (funcall mode) (fundamental-mode))
  1270. (font-lock-fontify-buffer)
  1271. (buffer-string)))
  1272. (hfy-html-quote-regex "\\([<\"&> ]\\)")
  1273. (hfy-html-quote-map '(("\"" "&quot;")
  1274. ("<" "&lt;")
  1275. ("&" "&amp;")
  1276. (">" "&gt;")
  1277. (" " "<text:s/>")
  1278. (" " "<text:tab/>")))
  1279. (hfy-face-to-css 'org-odt-hfy-face-to-css)
  1280. (hfy-optimisations-1 (copy-seq hfy-optimisations))
  1281. (hfy-optimisations (add-to-list 'hfy-optimisations-1
  1282. 'body-text-only))
  1283. (hfy-begin-span-handler
  1284. (lambda (style text-block text-id text-begins-block-p)
  1285. (insert (format "<text:span text:style-name=\"%s\">" style))))
  1286. (hfy-end-span-handler (lambda nil (insert "</text:span>"))))
  1287. (when (fboundp 'htmlfontify-string)
  1288. (let* ((lines (org-split-string lines "[\r\n]"))
  1289. (line-count (length lines))
  1290. (i 0))
  1291. (mapconcat
  1292. (lambda (line)
  1293. (incf i)
  1294. (org-odt-format-source-line-with-line-number-and-label
  1295. line rpllbl num 'htmlfontify-string
  1296. (if (= i line-count) "OrgSrcBlockLastLine" "OrgSrcBlock")))
  1297. lines "\n")))))
  1298. (defun org-odt-format-source-code-or-example (lines lang caption textareap
  1299. cols rows num cont
  1300. rpllbl fmt)
  1301. "Format source or example blocks for export.
  1302. Use `org-odt-format-source-code-or-example-plain' or
  1303. `org-odt-format-source-code-or-example-colored' depending on the
  1304. value of `org-export-odt-fontify-srcblocks."
  1305. (setq lines (org-export-number-lines
  1306. lines 0 0 num cont rpllbl fmt 'preprocess)
  1307. lines (funcall
  1308. (or (and org-export-odt-fontify-srcblocks
  1309. (or (featurep 'htmlfontify)
  1310. ;; htmlfontify.el was introduced in Emacs 23.2
  1311. ;; So load it with some caution
  1312. (require 'htmlfontify nil t))
  1313. (fboundp 'htmlfontify-string)
  1314. 'org-odt-format-source-code-or-example-colored)
  1315. 'org-odt-format-source-code-or-example-plain)
  1316. lines lang caption textareap cols rows num cont rpllbl fmt))
  1317. (if (not num) lines
  1318. (let ((extra (format " text:continue-numbering=\"%s\""
  1319. (if cont "true" "false"))))
  1320. (org-odt-format-tags
  1321. '("<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>"
  1322. . "</text:list>") lines extra))))
  1323. (defun org-odt-remap-stylenames (style-name)
  1324. (or
  1325. (cdr (assoc style-name '(("timestamp-wrapper" . "OrgTimestampWrapper")
  1326. ("timestamp" . "OrgTimestamp")
  1327. ("timestamp-kwd" . "OrgTimestampKeyword")
  1328. ("tag" . "OrgTag")
  1329. ("todo" . "OrgTodo")
  1330. ("done" . "OrgDone")
  1331. ("target" . "OrgTarget"))))
  1332. style-name))
  1333. (defun org-odt-format-fontify (text style &optional id)
  1334. (let* ((style-name
  1335. (cond
  1336. ((stringp style)
  1337. (org-odt-remap-stylenames style))
  1338. ((symbolp style)
  1339. (org-odt-get-style-name-for-entity 'character style))
  1340. ((listp style)
  1341. (assert (< 1 (length style)))
  1342. (let ((parent-style (pop style)))
  1343. (mapconcat (lambda (s)
  1344. ;; (assert (stringp s) t)
  1345. (org-odt-remap-stylenames s)) style "")
  1346. (org-odt-remap-stylenames parent-style)))
  1347. (t (error "Don't how to handle style %s" style)))))
  1348. (org-odt-format-tags
  1349. '("<text:span text:style-name=\"%s\">" . "</text:span>")
  1350. text style-name)))
  1351. (defun org-odt-relocate-relative-path (path dir)
  1352. (if (file-name-absolute-p path) path
  1353. (file-relative-name (expand-file-name path dir)
  1354. (expand-file-name "eyecandy" dir))))
  1355. (defun org-odt-format-inline-image (thefile)
  1356. (let* ((thelink (if (file-name-absolute-p thefile) thefile
  1357. (org-xml-format-href
  1358. (org-odt-relocate-relative-path
  1359. thefile org-current-export-file))))
  1360. (href
  1361. (org-odt-format-tags
  1362. "<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
  1363. (if org-export-odt-embed-images
  1364. (org-odt-copy-image-file thefile) thelink))))
  1365. (org-export-odt-format-image thefile href)))
  1366. (defun org-export-odt-format-formula (src href)
  1367. (save-match-data
  1368. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1369. (caption (and caption (org-xml-format-desc caption)))
  1370. (label (org-find-text-property-in-string 'org-label src))
  1371. (latex-frag (org-find-text-property-in-string 'org-latex-src src))
  1372. (embed-as (or (and latex-frag
  1373. (org-find-text-property-in-string
  1374. 'org-latex-src-embed-type src))
  1375. (if (or caption label) 'paragraph 'character)))
  1376. width height)
  1377. (when latex-frag
  1378. (setq href (org-propertize href :title "LaTeX Fragment"
  1379. :description latex-frag)))
  1380. (cond
  1381. ((eq embed-as 'character)
  1382. (org-odt-format-entity "InlineFormula" href width height))
  1383. (t
  1384. (org-lparse-end-paragraph)
  1385. (org-lparse-insert-list-table
  1386. `((,(org-odt-format-entity
  1387. (if caption "CaptionedDisplayFormula" "DisplayFormula")
  1388. href width height :caption caption :label nil)
  1389. ,(if (not label) ""
  1390. (org-odt-format-entity-caption label nil "__MathFormula__"))))
  1391. nil nil nil ":style \"OrgEquation\"" nil '((1 "c" 8) (2 "c" 1)))
  1392. (throw 'nextline nil))))))
  1393. (defvar org-odt-embedded-formulas-count 0)
  1394. (defun org-odt-copy-formula-file (path)
  1395. "Returns the internal name of the file"
  1396. (let* ((src-file (expand-file-name
  1397. path (file-name-directory org-current-export-file)))
  1398. (target-dir (format "Formula-%04d/"
  1399. (incf org-odt-embedded-formulas-count)))
  1400. (target-file (concat target-dir "content.xml")))
  1401. (when (not org-lparse-to-buffer)
  1402. (message "Embedding %s as %s ..."
  1403. (substring-no-properties path) target-file)
  1404. (make-directory target-dir)
  1405. (org-odt-create-manifest-file-entry
  1406. "application/vnd.oasis.opendocument.formula" target-dir "1.2")
  1407. (case (org-odt-is-formula-link-p src-file)
  1408. (mathml
  1409. (copy-file src-file target-file 'overwrite))
  1410. (odf
  1411. (org-odt-zip-extract-one src-file "content.xml" target-dir))
  1412. (t
  1413. (error "%s is not a formula file" src-file)))
  1414. (org-odt-create-manifest-file-entry "text/xml" target-file))
  1415. target-file))
  1416. (defun org-odt-format-inline-formula (thefile)
  1417. (let* ((thelink (if (file-name-absolute-p thefile) thefile
  1418. (org-xml-format-href
  1419. (org-odt-relocate-relative-path
  1420. thefile org-current-export-file))))
  1421. (href
  1422. (org-odt-format-tags
  1423. "<draw:object xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>" ""
  1424. (file-name-directory (org-odt-copy-formula-file thefile)))))
  1425. (org-export-odt-format-formula thefile href)))
  1426. (defun org-odt-is-formula-link-p (file)
  1427. (let ((case-fold-search nil))
  1428. (cond
  1429. ((string-match "\\.\\(mathml\\|mml\\)\\'" file)
  1430. 'mathml)
  1431. ((string-match "\\.odf\\'" file)
  1432. 'odf))))
  1433. (defun org-odt-format-org-link (opt-plist type-1 path fragment desc attr
  1434. descp)
  1435. "Make a OpenDocument link.
  1436. OPT-PLIST is an options list.
  1437. TYPE-1 is the device-type of the link (THIS://foo.html).
  1438. PATH is the path of the link (http://THIS#location).
  1439. FRAGMENT is the fragment part of the link, if any (foo.html#THIS).
  1440. DESC is the link description, if any.
  1441. ATTR is a string of other attributes of the a element."
  1442. (declare (special org-lparse-par-open))
  1443. (save-match-data
  1444. (let* ((may-inline-p
  1445. (and (member type-1 '("http" "https" "file"))
  1446. (org-lparse-should-inline-p path descp)
  1447. (not fragment)))
  1448. (type (if (equal type-1 "id") "file" type-1))
  1449. (filename path)
  1450. (thefile path))
  1451. (cond
  1452. ;; check for inlined images
  1453. ((and (member type '("file"))
  1454. (not fragment)
  1455. (org-file-image-p
  1456. filename org-export-odt-inline-image-extensions)
  1457. (or (eq t org-export-odt-inline-images)
  1458. (and org-export-odt-inline-images (not descp))))
  1459. (org-odt-format-inline-image thefile))
  1460. ;; check for embedded formulas
  1461. ((and (member type '("file"))
  1462. (not fragment)
  1463. (org-odt-is-formula-link-p filename)
  1464. (or (not descp)))
  1465. (org-odt-format-inline-formula thefile))
  1466. ((string= type "coderef")
  1467. (let* ((ref fragment)
  1468. (lineno-or-ref (cdr (assoc ref org-export-code-refs)))
  1469. (desc (and descp desc))
  1470. (org-odt-suppress-xref nil)
  1471. (href (org-xml-format-href (concat "#coderef-" ref))))
  1472. (cond
  1473. ((and (numberp lineno-or-ref) (not desc))
  1474. (org-odt-format-link lineno-or-ref href))
  1475. ((and (numberp lineno-or-ref) desc
  1476. (string-match (regexp-quote (concat "(" ref ")")) desc))
  1477. (format (replace-match "%s" t t desc)
  1478. (org-odt-format-link lineno-or-ref href)))
  1479. (t
  1480. (setq desc (format
  1481. (if (and desc (string-match
  1482. (regexp-quote (concat "(" ref ")"))
  1483. desc))
  1484. (replace-match "%s" t t desc)
  1485. (or desc "%s"))
  1486. lineno-or-ref))
  1487. (org-odt-format-link (org-xml-format-desc desc) href)))))
  1488. (t
  1489. (when (string= type "file")
  1490. (setq thefile
  1491. (cond
  1492. ((file-name-absolute-p path)
  1493. (concat "file://" (expand-file-name path)))
  1494. (t (org-odt-relocate-relative-path
  1495. thefile org-current-export-file)))))
  1496. (when (and (member type '("" "http" "https" "file")) fragment)
  1497. (setq thefile (concat thefile "#" fragment)))
  1498. (setq thefile (org-xml-format-href thefile))
  1499. (when (not (member type '("" "file")))
  1500. (setq thefile (concat type ":" thefile)))
  1501. (let ((org-odt-suppress-xref nil))
  1502. (org-odt-format-link
  1503. (org-xml-format-desc desc) thefile attr)))))))
  1504. (defun org-odt-format-heading (text level &optional id)
  1505. (let* ((text (if id (org-odt-format-target text id) text)))
  1506. (org-odt-format-tags
  1507. '("<text:h text:style-name=\"Heading_20_%s\" text:outline-level=\"%s\">" .
  1508. "</text:h>") text level level)))
  1509. (defun org-odt-format-headline (title extra-targets tags
  1510. &optional snumber level)
  1511. (concat
  1512. (org-lparse-format 'EXTRA-TARGETS extra-targets)
  1513. ;; No need to generate section numbers. They are auto-generated by
  1514. ;; the application
  1515. ;; (concat (org-lparse-format 'SECTION-NUMBER snumber level) " ")
  1516. title
  1517. (and tags (concat (org-lparse-format 'SPACES 3)
  1518. (org-lparse-format 'ORG-TAGS tags)))))
  1519. (defun org-odt-format-anchor (text name &optional class)
  1520. (org-odt-format-target text name))
  1521. (defun org-odt-format-bookmark (text id)
  1522. (if id
  1523. (org-odt-format-tags "<text:bookmark text:name=\"%s\"/>" text id)
  1524. text))
  1525. (defun org-odt-format-target (text id)
  1526. (let ((name (concat org-export-odt-bookmark-prefix id)))
  1527. (concat
  1528. (and id (org-odt-format-tags
  1529. "<text:bookmark-start text:name=\"%s\"/>" "" name))
  1530. (org-odt-format-bookmark text id)
  1531. (and id (org-odt-format-tags
  1532. "<text:bookmark-end text:name=\"%s\"/>" "" name)))))
  1533. (defun org-odt-format-footnote (n def)
  1534. (let ((id (concat "fn" n))
  1535. (note-class "footnote")
  1536. (par-style "Footnote"))
  1537. (org-odt-format-tags
  1538. '("<text:note text:id=\"%s\" text:note-class=\"%s\">" .
  1539. "</text:note>")
  1540. (concat
  1541. (org-odt-format-tags
  1542. '("<text:note-citation>" . "</text:note-citation>")
  1543. n)
  1544. (org-odt-format-tags
  1545. '("<text:note-body>" . "</text:note-body>")
  1546. def))
  1547. id note-class)))
  1548. (defun org-odt-format-footnote-reference (n def refcnt)
  1549. (if (= refcnt 1)
  1550. (org-odt-format-footnote n def)
  1551. (org-odt-format-footnote-ref n)))
  1552. (defun org-odt-format-footnote-ref (n)
  1553. (let ((note-class "footnote")
  1554. (ref-format "text")
  1555. (ref-name (concat "fn" n)))
  1556. (org-odt-format-tags
  1557. '("<text:span text:style-name=\"%s\">" . "</text:span>")
  1558. (org-odt-format-tags
  1559. '("<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">" . "</text:note-ref>")
  1560. n note-class ref-format ref-name)
  1561. "OrgSuperscript")))
  1562. (defun org-odt-get-image-name (file-name)
  1563. (require 'sha1)
  1564. (file-relative-name
  1565. (expand-file-name
  1566. (concat (sha1 file-name) "." (file-name-extension file-name)) "Pictures")))
  1567. (defun org-export-odt-format-image (src href)
  1568. "Create image tag with source and attributes."
  1569. (save-match-data
  1570. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1571. (caption (and caption (org-xml-format-desc caption)))
  1572. (attr (org-find-text-property-in-string 'org-attributes src))
  1573. (label (org-find-text-property-in-string 'org-label src))
  1574. (latex-frag (org-find-text-property-in-string
  1575. 'org-latex-src src))
  1576. (category (and latex-frag "__DvipngImage__"))
  1577. (attr-plist (org-lparse-get-block-params attr))
  1578. (user-frame-anchor
  1579. (car (assoc-string (plist-get attr-plist :anchor)
  1580. '(("as-char") ("paragraph") ("page")) t)))
  1581. (user-frame-style
  1582. (and user-frame-anchor (plist-get attr-plist :style)))
  1583. (user-frame-attrs
  1584. (and user-frame-anchor (plist-get attr-plist :attributes)))
  1585. (user-frame-params
  1586. (list user-frame-style user-frame-attrs user-frame-anchor))
  1587. (embed-as (cond
  1588. (latex-frag
  1589. (symbol-name
  1590. (case (org-find-text-property-in-string
  1591. 'org-latex-src-embed-type src)
  1592. (paragraph 'paragraph)
  1593. (t 'as-char))))
  1594. (user-frame-anchor)
  1595. (t "paragraph")))
  1596. (size (org-odt-image-size-from-file
  1597. src (plist-get attr-plist :width)
  1598. (plist-get attr-plist :height)
  1599. (plist-get attr-plist :scale) nil embed-as))
  1600. (width (car size)) (height (cdr size)))
  1601. (when latex-frag
  1602. (setq href (org-propertize href :title "LaTeX Fragment"
  1603. :description latex-frag)))
  1604. (let ((frame-style-handle (concat (and (or caption label) "Captioned")
  1605. embed-as "Image")))
  1606. (org-odt-format-entity
  1607. frame-style-handle href width height
  1608. :caption caption :label label :category category
  1609. :user-frame-params user-frame-params)))))
  1610. (defun org-odt-format-object-description (title description)
  1611. (concat (and title (org-odt-format-tags
  1612. '("<svg:title>" . "</svg:title>")
  1613. (org-odt-encode-plain-text title t)))
  1614. (and description (org-odt-format-tags
  1615. '("<svg:desc>" . "</svg:desc>")
  1616. (org-odt-encode-plain-text description t)))))
  1617. (defun org-odt-format-frame (text width height style &optional
  1618. extra anchor-type)
  1619. (let ((frame-attrs
  1620. (concat
  1621. (if width (format " svg:width=\"%0.2fcm\"" width) "")
  1622. (if height (format " svg:height=\"%0.2fcm\"" height) "")
  1623. extra
  1624. (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph")))))
  1625. (org-odt-format-tags
  1626. '("<draw:frame draw:style-name=\"%s\"%s>" . "</draw:frame>")
  1627. (concat text (org-odt-format-object-description
  1628. (get-text-property 0 :title text)
  1629. (get-text-property 0 :description text)))
  1630. style frame-attrs)))
  1631. (defun org-odt-format-textbox (text width height style &optional
  1632. extra anchor-type)
  1633. (org-odt-format-frame
  1634. (org-odt-format-tags
  1635. '("<draw:text-box %s>" . "</draw:text-box>")
  1636. text (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
  1637. (unless width
  1638. (format " fo:min-width=\"%0.2fcm\"" (or width .2)))))
  1639. width nil style extra anchor-type))
  1640. (defun org-odt-format-inlinetask (heading content
  1641. &optional todo priority tags)
  1642. (org-odt-format-stylized-paragraph
  1643. nil (org-odt-format-textbox
  1644. (concat (org-odt-format-stylized-paragraph
  1645. "OrgInlineTaskHeading"
  1646. (org-lparse-format
  1647. 'HEADLINE (concat (org-lparse-format-todo todo) " " heading)
  1648. nil tags))
  1649. content) nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
  1650. (defvar org-odt-entity-frame-styles
  1651. '(("As-CharImage" "__Figure__" ("OrgInlineImage" nil "as-char"))
  1652. ("ParagraphImage" "__Figure__" ("OrgDisplayImage" nil "paragraph"))
  1653. ("PageImage" "__Figure__" ("OrgPageImage" nil "page"))
  1654. ("CaptionedAs-CharImage" "__Figure__"
  1655. ("OrgCaptionedImage"
  1656. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1657. ("OrgInlineImage" nil "as-char"))
  1658. ("CaptionedParagraphImage" "__Figure__"
  1659. ("OrgCaptionedImage"
  1660. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1661. ("OrgImageCaptionFrame" nil "paragraph"))
  1662. ("CaptionedPageImage" "__Figure__"
  1663. ("OrgCaptionedImage"
  1664. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  1665. ("OrgPageImageCaptionFrame" nil "page"))
  1666. ("InlineFormula" "__MathFormula__" ("OrgInlineFormula" nil "as-char"))
  1667. ("DisplayFormula" "__MathFormula__" ("OrgDisplayFormula" nil "as-char"))
  1668. ("CaptionedDisplayFormula" "__MathFormula__"
  1669. ("OrgCaptionedFormula" nil "paragraph")
  1670. ("OrgFormulaCaptionFrame" nil "as-char"))))
  1671. (defun org-odt-merge-frame-params(default-frame-params user-frame-params)
  1672. (if (not user-frame-params) default-frame-params
  1673. (assert (= (length default-frame-params) 3))
  1674. (assert (= (length user-frame-params) 3))
  1675. (loop for user-frame-param in user-frame-params
  1676. for default-frame-param in default-frame-params
  1677. collect (or user-frame-param default-frame-param))))
  1678. (defun* org-odt-format-entity (entity href width height
  1679. &key caption label category
  1680. user-frame-params)
  1681. (let* ((entity-style (assoc-string entity org-odt-entity-frame-styles t))
  1682. default-frame-params frame-params)
  1683. (cond
  1684. ((not (or caption label))
  1685. (setq default-frame-params (nth 2 entity-style))
  1686. (setq frame-params (org-odt-merge-frame-params
  1687. default-frame-params user-frame-params))
  1688. (apply 'org-odt-format-frame href width height frame-params))
  1689. (t
  1690. (setq default-frame-params (nth 3 entity-style))
  1691. (setq frame-params (org-odt-merge-frame-params
  1692. default-frame-params user-frame-params))
  1693. (apply 'org-odt-format-textbox
  1694. (org-odt-format-stylized-paragraph
  1695. 'illustration
  1696. (concat
  1697. (apply 'org-odt-format-frame href width height
  1698. (nth 2 entity-style))
  1699. (org-odt-format-entity-caption
  1700. label caption (or category (nth 1 entity-style)))))
  1701. width height frame-params)))))
  1702. (defvar org-odt-embedded-images-count 0)
  1703. (defun org-odt-copy-image-file (path)
  1704. "Returns the internal name of the file"
  1705. (let* ((image-type (file-name-extension path))
  1706. (media-type (format "image/%s" image-type))
  1707. (src-file (expand-file-name
  1708. path (file-name-directory org-current-export-file)))
  1709. (target-dir "Images/")
  1710. (target-file
  1711. (format "%s%04d.%s" target-dir
  1712. (incf org-odt-embedded-images-count) image-type)))
  1713. (when (not org-lparse-to-buffer)
  1714. (message "Embedding %s as %s ..."
  1715. (substring-no-properties path) target-file)
  1716. (when (= 1 org-odt-embedded-images-count)
  1717. (make-directory target-dir)
  1718. (org-odt-create-manifest-file-entry "" target-dir))
  1719. (copy-file src-file target-file 'overwrite)
  1720. (org-odt-create-manifest-file-entry media-type target-file))
  1721. target-file))
  1722. (defvar org-export-odt-image-size-probe-method
  1723. (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
  1724. '(emacs fixed))
  1725. "Ordered list of methods for determining image sizes.")
  1726. (defvar org-export-odt-default-image-sizes-alist
  1727. '(("as-char" . (5 . 0.4))
  1728. ("paragraph" . (5 . 5)))
  1729. "Hardcoded image dimensions one for each of the anchor
  1730. methods.")
  1731. ;; A4 page size is 21.0 by 29.7 cms
  1732. ;; The default page settings has 2cm margin on each of the sides. So
  1733. ;; the effective text area is 17.0 by 25.7 cm
  1734. (defvar org-export-odt-max-image-size '(17.0 . 20.0)
  1735. "Limiting dimensions for an embedded image.")
  1736. (defun org-odt-do-image-size (probe-method file &optional dpi anchor-type)
  1737. (setq dpi (or dpi org-export-odt-pixels-per-inch))
  1738. (setq anchor-type (or anchor-type "paragraph"))
  1739. (flet ((size-in-cms (size-in-pixels)
  1740. (flet ((pixels-to-cms (pixels)
  1741. (let* ((cms-per-inch 2.54)
  1742. (inches (/ pixels dpi)))
  1743. (* cms-per-inch inches))))
  1744. (and size-in-pixels
  1745. (cons (pixels-to-cms (car size-in-pixels))
  1746. (pixels-to-cms (cdr size-in-pixels)))))))
  1747. (case probe-method
  1748. (emacs
  1749. (size-in-cms (ignore-errors ; Emacs could be in batch mode
  1750. (clear-image-cache)
  1751. (image-size (create-image file) 'pixels))))
  1752. (imagemagick
  1753. (size-in-cms
  1754. (let ((dim (shell-command-to-string
  1755. (format "identify -format \"%%w:%%h\" \"%s\"" file))))
  1756. (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
  1757. (cons (string-to-number (match-string 1 dim))
  1758. (string-to-number (match-string 2 dim)))))))
  1759. (t
  1760. (cdr (assoc-string anchor-type
  1761. org-export-odt-default-image-sizes-alist))))))
  1762. (defun org-odt-image-size-from-file (file &optional user-width
  1763. user-height scale dpi embed-as)
  1764. (unless (file-name-absolute-p file)
  1765. (setq file (expand-file-name
  1766. file (file-name-directory org-current-export-file))))
  1767. (let* (size width height)
  1768. (unless (and user-height user-width)
  1769. (loop for probe-method in org-export-odt-image-size-probe-method
  1770. until size
  1771. do (setq size (org-odt-do-image-size
  1772. probe-method file dpi embed-as)))
  1773. (or size (error "Cannot determine Image size. Aborting ..."))
  1774. (setq width (car size) height (cdr size)))
  1775. (cond
  1776. (scale
  1777. (setq width (* width scale) height (* height scale)))
  1778. ((and user-height user-width)
  1779. (setq width user-width height user-height))
  1780. (user-height
  1781. (setq width (* user-height (/ width height)) height user-height))
  1782. (user-width
  1783. (setq height (* user-width (/ height width)) width user-width))
  1784. (t (ignore)))
  1785. ;; ensure that an embedded image fits comfortably within a page
  1786. (let ((max-width (car org-export-odt-max-image-size))
  1787. (max-height (cdr org-export-odt-max-image-size)))
  1788. (when (or (> width max-width) (> height max-height))
  1789. (let* ((scale1 (/ max-width width))
  1790. (scale2 (/ max-height height))
  1791. (scale (min scale1 scale2)))
  1792. (setq width (* scale width) height (* scale height)))))
  1793. (cons width height)))
  1794. (defvar org-odt-entity-labels-alist nil
  1795. "Associate Labels with the Labeled entities.
  1796. Each element of the alist is of the form (LABEL-NAME
  1797. CATEGORY-NAME SEQNO LABEL-STYLE-NAME). LABEL-NAME is same as
  1798. that specified by \"#+LABEL: ...\" line. CATEGORY-NAME is the
  1799. type of the entity that LABEL-NAME is attached to. CATEGORY-NAME
  1800. can be one of \"Table\", \"Figure\" or \"Equation\". SEQNO is
  1801. the unique number assigned to the referenced entity on a
  1802. per-CATEGORY basis. It is generated sequentially and is 1-based.
  1803. LABEL-STYLE-NAME is a key `org-odt-label-styles'.
  1804. See `org-odt-add-label-definition' and
  1805. `org-odt-fixup-label-references'.")
  1806. (defvar org-odt-entity-counts-plist nil
  1807. "Plist of running counters of SEQNOs for each of the CATEGORY-NAMEs.
  1808. See `org-odt-entity-labels-alist' for known CATEGORY-NAMEs.")
  1809. (defvar org-odt-label-styles
  1810. '(("text" "(%n)" "text" "(%n)")
  1811. ("category-and-value" "%e %n%c" "category-and-value" "%e %n")
  1812. ("value" "%e %n%c" "value" "%n"))
  1813. "Specify how labels are applied and referenced.
  1814. This is an alist where each element is of the
  1815. form (LABEL-STYLE-NAME LABEL-ATTACH-FMT LABEL-REF-MODE
  1816. LABEL-REF-FMT).
  1817. LABEL-ATTACH-FMT controls how labels and captions are attached to
  1818. an entity. It may contain following specifiers - %e, %n and %c.
  1819. %e is replaced with the CATEGORY-NAME. %n is replaced with
  1820. \"<text:sequence ...> SEQNO </text:sequence>\". %c is replaced
  1821. with CAPTION. See `org-odt-format-label-definition'.
  1822. LABEL-REF-MODE and LABEL-REF-FMT controls how label references
  1823. are generated. The following XML is generated for a label
  1824. reference - \"<text:sequence-ref
  1825. text:reference-format=\"LABEL-REF-MODE\" ...> LABEL-REF-FMT
  1826. </text:sequence-ref>\". LABEL-REF-FMT may contain following
  1827. specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
  1828. %n is replaced with SEQNO. See
  1829. `org-odt-format-label-reference'.")
  1830. (defvar org-odt-category-map-alist
  1831. '(("__Table__" "Table" "value")
  1832. ("__Figure__" "Figure" "value")
  1833. ("__MathFormula__" "Equation" "text")
  1834. ("__DvipngImage__" "Equation" "value")
  1835. ;; ("__Table__" "Table" "category-and-value")
  1836. ;; ("__Figure__" "Figure" "category-and-value")
  1837. ;; ("__DvipngImage__" "Equation" "category-and-value")
  1838. )
  1839. "Map a CATEGORY-HANDLE to CATEGORY-NAME and LABEL-STYLE.
  1840. This is an alist where each element is of the form
  1841. \\(CATEGORY-HANDLE CATEGORY-NAME LABEL-STYLE\\). CATEGORY_HANDLE
  1842. could either be one of the internal handles (as seen above) or be
  1843. derived from the \"#+LABEL:<label-name>\" specification. See
  1844. `org-export-odt-get-category-from-label'. CATEGORY-NAME and
  1845. LABEL-STYLE are used for generating ODT labels. See
  1846. `org-odt-label-styles'.")
  1847. (defvar org-export-odt-user-categories
  1848. '("Illustration" "Table" "Text" "Drawing" "Equation" "Figure"))
  1849. (defvar org-export-odt-get-category-from-label nil
  1850. "Should category of label be inferred from label itself.
  1851. When this option is non-nil, a label is parsed in to two
  1852. component parts delimited by a \":\" (colon) as shown here -
  1853. #+LABEL:[CATEGORY-HANDLE:]EXTRA. The CATEGORY-HANDLE is mapped
  1854. to a CATEGORY-NAME and LABEL-STYLE using
  1855. `org-odt-category-map-alist'. (If no such map is provided and
  1856. CATEGORY-NAME is set to CATEGORY-HANDLE and LABEL-STYLE is set to
  1857. \"category-and-value\"). If CATEGORY-NAME so obtained is listed
  1858. under `org-export-odt-user-categories' then the user specified
  1859. styles are used. Otherwise styles as determined by the internal
  1860. CATEGORY-HANDLE is used. See
  1861. `org-odt-get-label-category-and-style' for details.")
  1862. (defun org-odt-get-label-category-and-style (label default-category)
  1863. "See `org-export-odt-get-category-from-label'."
  1864. (let ((default-category-map
  1865. (assoc default-category org-odt-category-map-alist))
  1866. user-category user-category-map category)
  1867. (cond
  1868. ((not org-export-odt-get-category-from-label)
  1869. default-category-map)
  1870. ((not (setq user-category
  1871. (save-match-data
  1872. (and (string-match "\\`\\(.*\\):.+" label)
  1873. (match-string 1 label)))))
  1874. default-category-map)
  1875. (t
  1876. (setq user-category-map
  1877. (or (assoc user-category org-odt-category-map-alist)
  1878. (list nil user-category "category-and-value"))
  1879. category (nth 1 user-category-map))
  1880. (if (member category org-export-odt-user-categories)
  1881. user-category-map
  1882. default-category-map)))))
  1883. (defun org-odt-add-label-definition (label default-category)
  1884. "Create an entry in `org-odt-entity-labels-alist' and return it."
  1885. (setq label (substring-no-properties label))
  1886. (let* ((label-props (org-odt-get-label-category-and-style
  1887. label default-category))
  1888. (category (nth 1 label-props))
  1889. (counter category)
  1890. (label-style (nth 2 label-props))
  1891. (sequence-var (intern (mapconcat
  1892. 'downcase
  1893. (org-split-string counter) "-")))
  1894. (seqno (1+ (or (plist-get org-odt-entity-counts-plist sequence-var)
  1895. 0)))
  1896. (label-props (list label category seqno label-style)))
  1897. (setq org-odt-entity-counts-plist
  1898. (plist-put org-odt-entity-counts-plist sequence-var seqno))
  1899. (push label-props org-odt-entity-labels-alist)
  1900. label-props))
  1901. (defun org-odt-format-label-definition (caption label category seqno label-style)
  1902. (assert label)
  1903. (format-spec
  1904. (cadr (assoc-string label-style org-odt-label-styles t))
  1905. `((?e . ,category)
  1906. (?n . ,(org-odt-format-tags
  1907. '("<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">" . "</text:sequence>")
  1908. (format "%d" seqno) label category category))
  1909. (?c . ,(or (and caption (concat ": " caption)) "")))))
  1910. (defun org-odt-format-label-reference (label category seqno label-style)
  1911. (assert label)
  1912. (save-match-data
  1913. (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
  1914. (fmt1 (car fmt))
  1915. (fmt2 (cadr fmt)))
  1916. (org-odt-format-tags
  1917. '("<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">"
  1918. . "</text:sequence-ref>")
  1919. (format-spec fmt2 `((?e . ,category)
  1920. (?n . ,(format "%d" seqno)))) fmt1 label))))
  1921. (defun org-odt-fixup-label-references ()
  1922. (goto-char (point-min))
  1923. (while (re-search-forward
  1924. "<text:sequence-ref text:ref-name=\"\\([^\"]+\\)\">[ \t\n]*</text:sequence-ref>"
  1925. nil t)
  1926. (let* ((label (match-string 1))
  1927. (label-def (assoc label org-odt-entity-labels-alist))
  1928. (rpl (and label-def
  1929. (apply 'org-odt-format-label-reference label-def))))
  1930. (if rpl (replace-match rpl t t)
  1931. (org-lparse-warn
  1932. (format "Unable to resolve reference to label \"%s\"" label))))))
  1933. (defun org-odt-format-entity-caption (label caption category)
  1934. (or (and label
  1935. (apply 'org-odt-format-label-definition
  1936. caption (org-odt-add-label-definition label category)))
  1937. caption ""))
  1938. (defun org-odt-format-tags (tag text &rest args)
  1939. (let ((prefix (when org-lparse-encode-pending "@"))
  1940. (suffix (when org-lparse-encode-pending "@")))
  1941. (apply 'org-lparse-format-tags tag text prefix suffix args)))
  1942. (defvar org-odt-manifest-file-entries nil)
  1943. (defun org-odt-init-outfile (filename)
  1944. (unless (executable-find "zip")
  1945. ;; Not at all OSes ship with zip by default
  1946. (error "Executable \"zip\" needed for creating OpenDocument files"))
  1947. (let* ((outdir (make-temp-file
  1948. (format org-export-odt-tmpdir-prefix org-lparse-backend) t))
  1949. (content-file (expand-file-name "content.xml" outdir)))
  1950. ;; init conten.xml
  1951. (with-current-buffer (find-file-noselect content-file t))
  1952. ;; reset variables
  1953. (setq org-odt-manifest-file-entries nil
  1954. org-odt-embedded-images-count 0
  1955. org-odt-embedded-formulas-count 0
  1956. org-odt-entity-labels-alist nil
  1957. org-odt-list-stack-stashed nil
  1958. org-odt-automatic-styles nil
  1959. org-odt-object-counters nil
  1960. org-odt-entity-counts-plist nil)
  1961. content-file))
  1962. (defcustom org-export-odt-prettify-xml nil
  1963. "Specify whether or not the xml output should be prettified.
  1964. When this option is turned on, `indent-region' is run on all
  1965. component xml buffers before they are saved. Turn this off for
  1966. regular use. Turn this on if you need to examine the xml
  1967. visually."
  1968. :group 'org-export-odt
  1969. :version "24.1"
  1970. :type 'boolean)
  1971. (defvar hfy-user-sheet-assoc) ; bound during org-do-lparse
  1972. (defun org-odt-save-as-outfile (target opt-plist)
  1973. ;; write automatic styles
  1974. (org-odt-write-automatic-styles)
  1975. ;; write meta file
  1976. (org-odt-update-meta-file opt-plist)
  1977. ;; write styles file
  1978. (when (equal org-lparse-backend 'odt)
  1979. (org-odt-update-styles-file opt-plist))
  1980. ;; create mimetype file
  1981. (let ((mimetype (org-odt-write-mimetype-file org-lparse-backend)))
  1982. (org-odt-create-manifest-file-entry mimetype "/" "1.2"))
  1983. ;; create a manifest entry for content.xml
  1984. (org-odt-create-manifest-file-entry "text/xml" "content.xml")
  1985. ;; write out the manifest entries before zipping
  1986. (org-odt-write-manifest-file)
  1987. (let ((xml-files '("mimetype" "META-INF/manifest.xml" "content.xml"
  1988. "meta.xml"))
  1989. (zipdir default-directory))
  1990. (when (equal org-lparse-backend 'odt)
  1991. (push "styles.xml" xml-files))
  1992. (message "Switching to directory %s" (expand-file-name zipdir))
  1993. ;; save all xml files
  1994. (mapc (lambda (file)
  1995. (with-current-buffer
  1996. (find-file-noselect (expand-file-name file) t)
  1997. ;; prettify output if needed
  1998. (when org-export-odt-prettify-xml
  1999. (indent-region (point-min) (point-max)))
  2000. (save-buffer 0)))
  2001. xml-files)
  2002. (let* ((target-name (file-name-nondirectory target))
  2003. (target-dir (file-name-directory target))
  2004. (cmds `(("zip" "-mX0" ,target-name "mimetype")
  2005. ("zip" "-rmTq" ,target-name "."))))
  2006. (when (file-exists-p target)
  2007. ;; FIXME: If the file is locked this throws a cryptic error
  2008. (delete-file target))
  2009. (let ((coding-system-for-write 'no-conversion) exitcode err-string)
  2010. (message "Creating odt file...")
  2011. (mapc
  2012. (lambda (cmd)
  2013. (message "Running %s" (mapconcat 'identity cmd " "))
  2014. (setq err-string
  2015. (with-output-to-string
  2016. (setq exitcode
  2017. (apply 'call-process (car cmd)
  2018. nil standard-output nil (cdr cmd)))))
  2019. (or (zerop exitcode)
  2020. (ignore (message "%s" err-string))
  2021. (error "Unable to create odt file (%S)" exitcode)))
  2022. cmds))
  2023. ;; move the file from outdir to target-dir
  2024. (rename-file target-name target-dir)
  2025. ;; kill all xml buffers
  2026. (mapc (lambda (file)
  2027. (kill-buffer
  2028. (find-file-noselect (expand-file-name file zipdir) t)))
  2029. xml-files)
  2030. (delete-directory zipdir)))
  2031. (message "Created %s" target)
  2032. (set-buffer (find-file-noselect target t)))
  2033. (defconst org-odt-manifest-file-entry-tag
  2034. "
  2035. <manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
  2036. (defun org-odt-create-manifest-file-entry (&rest args)
  2037. (push args org-odt-manifest-file-entries))
  2038. (defun org-odt-write-manifest-file ()
  2039. (make-directory "META-INF")
  2040. (let ((manifest-file (expand-file-name "META-INF/manifest.xml")))
  2041. (with-current-buffer
  2042. (find-file-noselect manifest-file t)
  2043. (insert
  2044. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  2045. <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
  2046. (mapc
  2047. (lambda (file-entry)
  2048. (let* ((version (nth 2 file-entry))
  2049. (extra (if version
  2050. (format " manifest:version=\"%s\"" version)
  2051. "")))
  2052. (insert
  2053. (format org-odt-manifest-file-entry-tag
  2054. (nth 0 file-entry) (nth 1 file-entry) extra))))
  2055. org-odt-manifest-file-entries)
  2056. (insert "\n</manifest:manifest>"))))
  2057. (defun org-odt-update-meta-file (opt-plist)
  2058. (let ((date (org-odt-format-date (plist-get opt-plist :date)))
  2059. (author (or (plist-get opt-plist :author) ""))
  2060. (email (plist-get opt-plist :email))
  2061. (keywords (plist-get opt-plist :keywords))
  2062. (description (plist-get opt-plist :description))
  2063. (title (plist-get opt-plist :title)))
  2064. (write-region
  2065. (concat
  2066. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  2067. <office:document-meta
  2068. xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
  2069. xmlns:xlink=\"http://www.w3.org/1999/xlink\"
  2070. xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
  2071. xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
  2072. xmlns:ooo=\"http://openoffice.org/2004/office\"
  2073. office:version=\"1.2\">
  2074. <office:meta>" "\n"
  2075. (org-odt-format-author)
  2076. (org-odt-format-tags
  2077. '("\n<meta:initial-creator>" . "</meta:initial-creator>") author)
  2078. (org-odt-format-tags '("\n<dc:date>" . "</dc:date>") date)
  2079. (org-odt-format-tags
  2080. '("\n<meta:creation-date>" . "</meta:creation-date>") date)
  2081. (org-odt-format-tags '("\n<meta:generator>" . "</meta:generator>")
  2082. (when org-export-creator-info
  2083. (format "Org-%s/Emacs-%s"
  2084. org-version emacs-version)))
  2085. (org-odt-format-tags '("\n<meta:keyword>" . "</meta:keyword>") keywords)
  2086. (org-odt-format-tags '("\n<dc:subject>" . "</dc:subject>") description)
  2087. (org-odt-format-tags '("\n<dc:title>" . "</dc:title>") title)
  2088. "\n"
  2089. " </office:meta>" "</office:document-meta>")
  2090. nil (expand-file-name "meta.xml")))
  2091. ;; create a manifest entry for meta.xml
  2092. (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
  2093. (defun org-odt-update-styles-file (opt-plist)
  2094. ;; write styles file
  2095. (let ((styles-file (plist-get opt-plist :odt-styles-file)))
  2096. (org-odt-copy-styles-file (and styles-file
  2097. (read (org-trim styles-file)))))
  2098. ;; Update styles.xml - take care of outline numbering
  2099. (with-current-buffer
  2100. (find-file-noselect (expand-file-name "styles.xml") t)
  2101. ;; Don't make automatic backup of styles.xml file. This setting
  2102. ;; prevents the backed-up styles.xml file from being zipped in to
  2103. ;; odt file. This is more of a hackish fix. Better alternative
  2104. ;; would be to fix the zip command so that the output odt file
  2105. ;; includes only the needed files and excludes any auto-generated
  2106. ;; extra files like backups and auto-saves etc etc. Note that
  2107. ;; currently the zip command zips up the entire temp directory so
  2108. ;; that any auto-generated files created under the hood ends up in
  2109. ;; the resulting odt file.
  2110. (set (make-local-variable 'backup-inhibited) t)
  2111. ;; Import local setting of `org-export-with-section-numbers'
  2112. (org-lparse-bind-local-variables opt-plist)
  2113. (org-odt-configure-outline-numbering
  2114. (if org-export-with-section-numbers org-export-headline-levels 0)))
  2115. ;; Write custom styles for source blocks
  2116. (org-odt-insert-custom-styles-for-srcblocks
  2117. (mapconcat
  2118. (lambda (style)
  2119. (format " %s\n" (cddr style)))
  2120. hfy-user-sheet-assoc "")))
  2121. (defun org-odt-write-mimetype-file (format)
  2122. ;; create mimetype file
  2123. (let ((mimetype
  2124. (case format
  2125. (odt "application/vnd.oasis.opendocument.text")
  2126. (odf "application/vnd.oasis.opendocument.formula")
  2127. (t (error "Unknown OpenDocument backend %S" org-lparse-backend)))))
  2128. (write-region mimetype nil (expand-file-name "mimetype"))
  2129. mimetype))
  2130. (defun org-odt-finalize-outfile ()
  2131. (org-odt-delete-empty-paragraphs))
  2132. (defun org-odt-delete-empty-paragraphs ()
  2133. (goto-char (point-min))
  2134. (let ((open "<text:p[^>]*>")
  2135. (close "</text:p>"))
  2136. (while (re-search-forward (format "%s[ \r\n\t]*%s" open close) nil t)
  2137. (replace-match ""))))
  2138. (defcustom org-export-odt-convert-processes
  2139. '(("LibreOffice"
  2140. "soffice --headless --convert-to %f%x --outdir %d %i")
  2141. ("unoconv"
  2142. "unoconv -f %f -o %d %i"))
  2143. "Specify a list of document converters and their usage.
  2144. The converters in this list are offered as choices while
  2145. customizing `org-export-odt-convert-process'.
  2146. This variable is a list where each element is of the
  2147. form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
  2148. of the converter. CONVERTER-CMD is the shell command for the
  2149. converter and can contain format specifiers. These format
  2150. specifiers are interpreted as below:
  2151. %i input file name in full
  2152. %I input file name as a URL
  2153. %f format of the output file
  2154. %o output file name in full
  2155. %O output file name as a URL
  2156. %d output dir in full
  2157. %D output dir as a URL.
  2158. %x extra options as set in `org-export-odt-convert-capabilities'."
  2159. :group 'org-export-odt
  2160. :version "24.1"
  2161. :type
  2162. '(choice
  2163. (const :tag "None" nil)
  2164. (alist :tag "Converters"
  2165. :key-type (string :tag "Converter Name")
  2166. :value-type (group (string :tag "Command line")))))
  2167. (defcustom org-export-odt-convert-process "LibreOffice"
  2168. "Use this converter to convert from \"odt\" format to other formats.
  2169. During customization, the list of converter names are populated
  2170. from `org-export-odt-convert-processes'."
  2171. :group 'org-export-odt
  2172. :version "24.1"
  2173. :type '(choice :convert-widget
  2174. (lambda (w)
  2175. (apply 'widget-convert (widget-type w)
  2176. (eval (car (widget-get w :args)))))
  2177. `((const :tag "None" nil)
  2178. ,@(mapcar (lambda (c)
  2179. `(const :tag ,(car c) ,(car c)))
  2180. org-export-odt-convert-processes))))
  2181. (defcustom org-export-odt-convert-capabilities
  2182. '(("Text"
  2183. ("odt" "ott" "doc" "rtf" "docx")
  2184. (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
  2185. ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
  2186. ("Web"
  2187. ("html")
  2188. (("pdf" "pdf") ("odt" "odt") ("html" "html")))
  2189. ("Spreadsheet"
  2190. ("ods" "ots" "xls" "csv" "xlsx")
  2191. (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
  2192. ("xls" "xls") ("xlsx" "xlsx")))
  2193. ("Presentation"
  2194. ("odp" "otp" "ppt" "pptx")
  2195. (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
  2196. ("pptx" "pptx") ("odg" "odg"))))
  2197. "Specify input and output formats of `org-export-odt-convert-process'.
  2198. More correctly, specify the set of input and output formats that
  2199. the user is actually interested in.
  2200. This variable is an alist where each element is of the
  2201. form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
  2202. INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
  2203. alist where each element is of the form (OUTPUT-FMT
  2204. OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
  2205. The variable is interpreted as follows:
  2206. `org-export-odt-convert-process' can take any document that is in
  2207. INPUT-FMT-LIST and produce any document that is in the
  2208. OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
  2209. OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
  2210. serves dual purposes:
  2211. - It is used for populating completion candidates during
  2212. `org-export-odt-convert' commands.
  2213. - It is used as the value of \"%f\" specifier in
  2214. `org-export-odt-convert-process'.
  2215. EXTRA-OPTIONS is used as the value of \"%x\" specifier in
  2216. `org-export-odt-convert-process'.
  2217. DOCUMENT-CLASS is used to group a set of file formats in
  2218. INPUT-FMT-LIST in to a single class.
  2219. Note that this variable inherently captures how LibreOffice based
  2220. converters work. LibreOffice maps documents of various formats
  2221. to classes like Text, Web, Spreadsheet, Presentation etc and
  2222. allow document of a given class (irrespective of it's source
  2223. format) to be converted to any of the export formats associated
  2224. with that class.
  2225. See default setting of this variable for an typical
  2226. configuration."
  2227. :group 'org-export-odt
  2228. :version "24.1"
  2229. :type
  2230. '(choice
  2231. (const :tag "None" nil)
  2232. (alist :tag "Capabilities"
  2233. :key-type (string :tag "Document Class")
  2234. :value-type
  2235. (group (repeat :tag "Input formats" (string :tag "Input format"))
  2236. (alist :tag "Output formats"
  2237. :key-type (string :tag "Output format")
  2238. :value-type
  2239. (group (string :tag "Output file extension")
  2240. (choice
  2241. (const :tag "None" nil)
  2242. (string :tag "Extra options"))))))))
  2243. (declare-function org-create-math-formula "org"
  2244. (latex-frag &optional mathml-file))
  2245. ;;;###autoload
  2246. (defun org-export-odt-convert (&optional in-file out-fmt prefix-arg)
  2247. "Convert IN-FILE to format OUT-FMT using a command line converter.
  2248. IN-FILE is the file to be converted. If unspecified, it defaults
  2249. to variable `buffer-file-name'. OUT-FMT is the desired output
  2250. format. Use `org-export-odt-convert-process' as the converter.
  2251. If PREFIX-ARG is non-nil then the newly converted file is opened
  2252. using `org-open-file'."
  2253. (interactive
  2254. (append (org-lparse-convert-read-params) current-prefix-arg))
  2255. (org-lparse-do-convert in-file out-fmt prefix-arg))
  2256. (defun org-odt-get (what &optional opt-plist)
  2257. (case what
  2258. (BACKEND 'odt)
  2259. (EXPORT-DIR (org-export-directory :html opt-plist))
  2260. (FILE-NAME-EXTENSION "odt")
  2261. (EXPORT-BUFFER-NAME "*Org ODT Export*")
  2262. (ENTITY-CONTROL org-odt-entity-control-callbacks-alist)
  2263. (ENTITY-FORMAT org-odt-entity-format-callbacks-alist)
  2264. (INIT-METHOD 'org-odt-init-outfile)
  2265. (FINAL-METHOD 'org-odt-finalize-outfile)
  2266. (SAVE-METHOD 'org-odt-save-as-outfile)
  2267. (CONVERT-METHOD
  2268. (and org-export-odt-convert-process
  2269. (cadr (assoc-string org-export-odt-convert-process
  2270. org-export-odt-convert-processes t))))
  2271. (CONVERT-CAPABILITIES
  2272. (and org-export-odt-convert-process
  2273. (cadr (assoc-string org-export-odt-convert-process
  2274. org-export-odt-convert-processes t))
  2275. org-export-odt-convert-capabilities))
  2276. (TOPLEVEL-HLEVEL 1)
  2277. (SPECIAL-STRING-REGEXPS org-export-odt-special-string-regexps)
  2278. (INLINE-IMAGES 'maybe)
  2279. (INLINE-IMAGE-EXTENSIONS '("png" "jpeg" "jpg" "gif" "svg"))
  2280. (PLAIN-TEXT-MAP '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
  2281. (TABLE-FIRST-COLUMN-AS-LABELS nil)
  2282. (FOOTNOTE-SEPARATOR (org-lparse-format 'FONTIFY "," 'superscript))
  2283. (CODING-SYSTEM-FOR-WRITE 'utf-8)
  2284. (CODING-SYSTEM-FOR-SAVE 'utf-8)
  2285. (t (error "Unknown property: %s" what))))
  2286. (defvar org-lparse-latex-fragment-fallback) ; set by org-do-lparse
  2287. (defun org-export-odt-do-preprocess-latex-fragments ()
  2288. "Convert LaTeX fragments to images."
  2289. (let* ((latex-frag-opt (plist-get org-lparse-opt-plist :LaTeX-fragments))
  2290. (latex-frag-opt ; massage the options
  2291. (or (and (member latex-frag-opt '(mathjax t))
  2292. (not (and (fboundp 'org-format-latex-mathml-available-p)
  2293. (org-format-latex-mathml-available-p)))
  2294. (prog1 org-lparse-latex-fragment-fallback
  2295. (org-lparse-warn
  2296. (concat
  2297. "LaTeX to MathML converter not available. "
  2298. (format "Using %S instead."
  2299. org-lparse-latex-fragment-fallback)))))
  2300. latex-frag-opt))
  2301. cache-dir display-msg)
  2302. (cond
  2303. ((eq latex-frag-opt 'dvipng)
  2304. (setq cache-dir "ltxpng/")
  2305. (setq display-msg "Creating LaTeX image %s"))
  2306. ((member latex-frag-opt '(mathjax t))
  2307. (setq latex-frag-opt 'mathml)
  2308. (setq cache-dir "ltxmathml/")
  2309. (setq display-msg "Creating MathML formula %s")))
  2310. (when (and org-current-export-file)
  2311. (org-format-latex
  2312. (concat cache-dir (file-name-sans-extension
  2313. (file-name-nondirectory org-current-export-file)))
  2314. org-current-export-dir nil display-msg
  2315. nil nil latex-frag-opt))))
  2316. (defadvice org-format-latex-as-mathml
  2317. (after org-odt-protect-latex-fragment activate)
  2318. "Encode LaTeX fragment as XML.
  2319. Do this when translation to MathML fails."
  2320. (when (or (not (> (length ad-return-value) 0))
  2321. (get-text-property 0 'org-protected ad-return-value))
  2322. (setq ad-return-value
  2323. (org-propertize (org-odt-encode-plain-text (ad-get-arg 0))
  2324. 'org-protected t))))
  2325. (defun org-export-odt-preprocess-latex-fragments ()
  2326. (when (equal org-export-current-backend 'odt)
  2327. (org-export-odt-do-preprocess-latex-fragments)))
  2328. (defun org-export-odt-preprocess-label-references ()
  2329. (goto-char (point-min))
  2330. (let (label label-components category value pretty-label)
  2331. (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
  2332. (org-if-unprotected-at (match-beginning 1)
  2333. (replace-match
  2334. (let ((org-lparse-encode-pending t)
  2335. (label (match-string 1)))
  2336. ;; markup generated below is mostly an eye-candy. At
  2337. ;; pre-processing stage, there is no information on which
  2338. ;; entity a label reference points to. The actual markup
  2339. ;; is generated as part of `org-odt-fixup-label-references'
  2340. ;; which gets called at the fag end of export. By this
  2341. ;; time we would have seen and collected all the label
  2342. ;; definitions in `org-odt-entity-labels-alist'.
  2343. (org-odt-format-tags
  2344. '("<text:sequence-ref text:ref-name=\"%s\">" .
  2345. "</text:sequence-ref>")
  2346. "" (org-add-props label '(org-protected t)))) t t)))))
  2347. ;; process latex fragments as part of
  2348. ;; `org-export-preprocess-after-blockquote-hook'. Note that this hook
  2349. ;; is the one that is closest and well before the call to
  2350. ;; `org-export-attach-captions-and-attributes' in
  2351. ;; `org-export-preprocess-string'. The above arrangement permits
  2352. ;; captions, labels and attributes to be attached to png images
  2353. ;; generated out of latex equations.
  2354. (add-hook 'org-export-preprocess-after-blockquote-hook
  2355. 'org-export-odt-preprocess-latex-fragments)
  2356. (defun org-export-odt-preprocess (parameters)
  2357. (org-export-odt-preprocess-label-references))
  2358. (declare-function archive-zip-extract "arc-mode.el" (archive name))
  2359. (defun org-odt-zip-extract-one (archive member &optional target)
  2360. (require 'arc-mode)
  2361. (let* ((target (or target default-directory))
  2362. (archive (expand-file-name archive))
  2363. (archive-zip-extract
  2364. (list "unzip" "-qq" "-o" "-d" target))
  2365. exit-code command-output)
  2366. (setq command-output
  2367. (with-temp-buffer
  2368. (setq exit-code (archive-zip-extract archive member))
  2369. (buffer-string)))
  2370. (unless (zerop exit-code)
  2371. (message command-output)
  2372. (error "Extraction failed"))))
  2373. (defun org-odt-zip-extract (archive members &optional target)
  2374. (when (atom members) (setq members (list members)))
  2375. (mapc (lambda (member)
  2376. (org-odt-zip-extract-one archive member target))
  2377. members))
  2378. (defun org-odt-copy-styles-file (&optional styles-file)
  2379. ;; Non-availability of styles.xml is not a critical error. For now
  2380. ;; throw an error purely for aesthetic reasons.
  2381. (setq styles-file (or styles-file
  2382. org-export-odt-styles-file
  2383. (expand-file-name "OrgOdtStyles.xml"
  2384. org-odt-styles-dir)
  2385. (error "org-odt: Missing styles file?")))
  2386. (cond
  2387. ((listp styles-file)
  2388. (let ((archive (nth 0 styles-file))
  2389. (members (nth 1 styles-file)))
  2390. (org-odt-zip-extract archive members)
  2391. (mapc
  2392. (lambda (member)
  2393. (when (org-file-image-p member)
  2394. (let* ((image-type (file-name-extension member))
  2395. (media-type (format "image/%s" image-type)))
  2396. (org-odt-create-manifest-file-entry media-type member))))
  2397. members)))
  2398. ((and (stringp styles-file) (file-exists-p styles-file))
  2399. (let ((styles-file-type (file-name-extension styles-file)))
  2400. (cond
  2401. ((string= styles-file-type "xml")
  2402. (copy-file styles-file "styles.xml" t))
  2403. ((member styles-file-type '("odt" "ott"))
  2404. (org-odt-zip-extract styles-file "styles.xml")))))
  2405. (t
  2406. (error (format "Invalid specification of styles.xml file: %S"
  2407. org-export-odt-styles-file))))
  2408. ;; create a manifest entry for styles.xml
  2409. (org-odt-create-manifest-file-entry "text/xml" "styles.xml"))
  2410. (defun org-odt-configure-outline-numbering (level)
  2411. "Outline numbering is retained only upto LEVEL.
  2412. To disable outline numbering pass a LEVEL of 0."
  2413. (goto-char (point-min))
  2414. (let ((regex
  2415. "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
  2416. (replacement
  2417. "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
  2418. (while (re-search-forward regex nil t)
  2419. (when (> (string-to-number (match-string 2)) level)
  2420. (replace-match replacement t nil))))
  2421. (save-buffer 0))
  2422. ;;;###autoload
  2423. (defun org-export-as-odf (latex-frag &optional odf-file)
  2424. "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
  2425. Use `org-create-math-formula' to convert LATEX-FRAG first to
  2426. MathML. When invoked as an interactive command, use
  2427. `org-latex-regexps' to infer LATEX-FRAG from currently active
  2428. region. If no LaTeX fragments are found, prompt for it. Push
  2429. MathML source to kill ring, if `org-export-copy-to-kill-ring' is
  2430. non-nil."
  2431. (interactive
  2432. `(,(let (frag)
  2433. (setq frag (and (setq frag (and (region-active-p)
  2434. (buffer-substring (region-beginning)
  2435. (region-end))))
  2436. (loop for e in org-latex-regexps
  2437. thereis (when (string-match (nth 1 e) frag)
  2438. (match-string (nth 2 e) frag)))))
  2439. (read-string "LaTeX Fragment: " frag nil frag))
  2440. ,(let ((odf-filename (expand-file-name
  2441. (concat
  2442. (file-name-sans-extension
  2443. (or (file-name-nondirectory buffer-file-name)))
  2444. "." "odf")
  2445. (file-name-directory buffer-file-name))))
  2446. (read-file-name "ODF filename: " nil odf-filename nil
  2447. (file-name-nondirectory odf-filename)))))
  2448. (let* ((org-lparse-backend 'odf)
  2449. org-lparse-opt-plist
  2450. (filename (or odf-file
  2451. (expand-file-name
  2452. (concat
  2453. (file-name-sans-extension
  2454. (or (file-name-nondirectory buffer-file-name)))
  2455. "." "odf")
  2456. (file-name-directory buffer-file-name))))
  2457. (buffer (find-file-noselect (org-odt-init-outfile filename)))
  2458. (coding-system-for-write 'utf-8)
  2459. (save-buffer-coding-system 'utf-8))
  2460. (set-buffer buffer)
  2461. (set-buffer-file-coding-system coding-system-for-write)
  2462. (let ((mathml (org-create-math-formula latex-frag)))
  2463. (unless mathml (error "No Math formula created"))
  2464. (insert mathml)
  2465. (or (org-export-push-to-kill-ring
  2466. (upcase (symbol-name org-lparse-backend)))
  2467. (message "Exporting... done")))
  2468. (org-odt-save-as-outfile filename nil)))
  2469. ;;;###autoload
  2470. (defun org-export-as-odf-and-open ()
  2471. "Export LaTeX fragment as OpenDocument formula and immediately open it.
  2472. Use `org-export-as-odf' to read LaTeX fragment and OpenDocument
  2473. formula file."
  2474. (interactive)
  2475. (org-lparse-and-open
  2476. nil nil nil (call-interactively 'org-export-as-odf)))
  2477. (provide 'org-odt)
  2478. ;;; org-odt.el ends here