org-odt.el 105 KB

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