org-odt.el 105 KB

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