org-odt.el 83 KB

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