ox-odt.el 158 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340
  1. ;;; ox-odt.el --- OpenDocument Text Exporter for Org Mode -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2010-2019 Free Software Foundation, Inc.
  3. ;; Author: Jambunathan K <kjambunathan at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;;; Code:
  19. (require 'cl-lib)
  20. (require 'format-spec)
  21. (require 'org-compat)
  22. (require 'org-macs)
  23. (require 'ox)
  24. (require 'table nil 'noerror)
  25. ;;; Define Back-End
  26. (org-export-define-backend 'odt
  27. '((bold . org-odt-bold)
  28. (center-block . org-odt-center-block)
  29. (clock . org-odt-clock)
  30. (code . org-odt-code)
  31. (drawer . org-odt-drawer)
  32. (dynamic-block . org-odt-dynamic-block)
  33. (entity . org-odt-entity)
  34. (example-block . org-odt-example-block)
  35. (export-block . org-odt-export-block)
  36. (export-snippet . org-odt-export-snippet)
  37. (fixed-width . org-odt-fixed-width)
  38. (footnote-definition . org-odt-footnote-definition)
  39. (footnote-reference . org-odt-footnote-reference)
  40. (headline . org-odt-headline)
  41. (horizontal-rule . org-odt-horizontal-rule)
  42. (inline-src-block . org-odt-inline-src-block)
  43. (inlinetask . org-odt-inlinetask)
  44. (italic . org-odt-italic)
  45. (item . org-odt-item)
  46. (keyword . org-odt-keyword)
  47. (latex-environment . org-odt-latex-environment)
  48. (latex-fragment . org-odt-latex-fragment)
  49. (line-break . org-odt-line-break)
  50. (link . org-odt-link)
  51. (node-property . org-odt-node-property)
  52. (paragraph . org-odt-paragraph)
  53. (plain-list . org-odt-plain-list)
  54. (plain-text . org-odt-plain-text)
  55. (planning . org-odt-planning)
  56. (property-drawer . org-odt-property-drawer)
  57. (quote-block . org-odt-quote-block)
  58. (radio-target . org-odt-radio-target)
  59. (section . org-odt-section)
  60. (special-block . org-odt-special-block)
  61. (src-block . org-odt-src-block)
  62. (statistics-cookie . org-odt-statistics-cookie)
  63. (strike-through . org-odt-strike-through)
  64. (subscript . org-odt-subscript)
  65. (superscript . org-odt-superscript)
  66. (table . org-odt-table)
  67. (table-cell . org-odt-table-cell)
  68. (table-row . org-odt-table-row)
  69. (target . org-odt-target)
  70. (template . org-odt-template)
  71. (timestamp . org-odt-timestamp)
  72. (underline . org-odt-underline)
  73. (verbatim . org-odt-verbatim)
  74. (verse-block . org-odt-verse-block))
  75. :filters-alist '((:filter-parse-tree
  76. . (org-odt--translate-latex-fragments
  77. org-odt--translate-description-lists
  78. org-odt--translate-list-tables
  79. org-odt--translate-image-links)))
  80. :menu-entry
  81. '(?o "Export to ODT"
  82. ((?o "As ODT file" org-odt-export-to-odt)
  83. (?O "As ODT file and open"
  84. (lambda (a s v b)
  85. (if a (org-odt-export-to-odt t s v)
  86. (org-open-file (org-odt-export-to-odt nil s v) 'system))))))
  87. :options-alist
  88. '((:odt-styles-file "ODT_STYLES_FILE" nil nil t)
  89. (:description "DESCRIPTION" nil nil newline)
  90. (:keywords "KEYWORDS" nil nil space)
  91. (:subtitle "SUBTITLE" nil nil parse)
  92. ;; Other variables.
  93. (:odt-content-template-file nil nil org-odt-content-template-file)
  94. (:odt-display-outline-level nil nil org-odt-display-outline-level)
  95. (:odt-fontify-srcblocks nil nil org-odt-fontify-srcblocks)
  96. (:odt-format-drawer-function nil nil org-odt-format-drawer-function)
  97. (:odt-format-headline-function nil nil org-odt-format-headline-function)
  98. (:odt-format-inlinetask-function nil nil org-odt-format-inlinetask-function)
  99. (:odt-inline-formula-rules nil nil org-odt-inline-formula-rules)
  100. (:odt-inline-image-rules nil nil org-odt-inline-image-rules)
  101. (:odt-pixels-per-inch nil nil org-odt-pixels-per-inch)
  102. (:odt-styles-file nil nil org-odt-styles-file)
  103. (:odt-table-styles nil nil org-odt-table-styles)
  104. (:odt-use-date-fields nil nil org-odt-use-date-fields)
  105. ;; Redefine regular option.
  106. (:with-latex nil "tex" org-odt-with-latex)
  107. ;; Retrieve LaTeX header for fragments.
  108. (:latex-header "LATEX_HEADER" nil nil newline)))
  109. ;;; Dependencies
  110. ;;; Hooks
  111. ;;; Function and Dynamically Scoped Variables Declarations
  112. (declare-function hfy-face-to-style "htmlfontify" (fn))
  113. (declare-function hfy-face-or-def-to-name "htmlfontify" (fn))
  114. (declare-function archive-zip-extract "arc-mode" (archive name))
  115. (declare-function org-create-math-formula "org" (latex-frag &optional mathml-file))
  116. (declare-function browse-url-file-url "browse-url" (file))
  117. (defvar nxml-auto-insert-xml-declaration-flag) ; nxml-mode.el
  118. (defvar archive-zip-extract) ; arc-mode.el
  119. (defvar hfy-end-span-handler) ; htmlfontify.el
  120. (defvar hfy-begin-span-handler) ; htmlfontify.el
  121. (defvar hfy-face-to-css) ; htmlfontify.el
  122. (defvar hfy-html-quote-map) ; htmlfontify.el
  123. (defvar hfy-html-quote-regex) ; htmlfontify.el
  124. ;;; Internal Variables
  125. (defconst org-odt-lib-dir
  126. (file-name-directory (or load-file-name (buffer-file-name)))
  127. "Location of ODT exporter.
  128. Use this to infer values of `org-odt-styles-dir' and
  129. `org-odt-schema-dir'.")
  130. (defvar org-odt-data-dir
  131. (expand-file-name "../../etc/" org-odt-lib-dir)
  132. "Data directory for ODT exporter.
  133. Use this to infer values of `org-odt-styles-dir' and
  134. `org-odt-schema-dir'.")
  135. (defconst org-odt-special-string-regexps
  136. '(("\\\\-" . "&#x00ad;\\1") ; shy
  137. ("---\\([^-]\\)" . "&#x2014;\\1") ; mdash
  138. ("--\\([^-]\\)" . "&#x2013;\\1") ; ndash
  139. ("\\.\\.\\." . "&#x2026;")) ; hellip
  140. "Regular expressions for special string conversion.")
  141. (defconst org-odt-schema-dir-list
  142. (list
  143. (and org-odt-data-dir
  144. (expand-file-name "./schema/" org-odt-data-dir)) ; bail out
  145. (eval-when-compile
  146. (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
  147. (expand-file-name "./schema/" org-odt-data-dir))))
  148. "List of directories to search for OpenDocument schema files.
  149. Use this list to set the default value of
  150. `org-odt-schema-dir'. The entries in this list are
  151. populated heuristically based on the values of `org-odt-lib-dir'
  152. and `org-odt-data-dir'.")
  153. (defconst org-odt-styles-dir-list
  154. (list
  155. (and org-odt-data-dir
  156. (expand-file-name "./styles/" org-odt-data-dir)) ; bail out
  157. (eval-when-compile
  158. (and (boundp 'org-odt-data-dir) org-odt-data-dir ; see make install
  159. (expand-file-name "./styles/" org-odt-data-dir)))
  160. (expand-file-name "../etc/styles/" org-odt-lib-dir) ; git
  161. (expand-file-name "./etc/styles/" org-odt-lib-dir) ; elpa
  162. (expand-file-name "./org/" data-directory) ; system
  163. )
  164. "List of directories to search for OpenDocument styles files.
  165. See `org-odt-styles-dir'. The entries in this list are populated
  166. heuristically based on the values of `org-odt-lib-dir' and
  167. `org-odt-data-dir'.")
  168. (defconst org-odt-styles-dir
  169. (let ((styles-dir
  170. (cl-find-if
  171. (lambda (dir)
  172. (and dir
  173. (file-readable-p
  174. (expand-file-name "OrgOdtContentTemplate.xml" dir))
  175. (file-readable-p (expand-file-name "OrgOdtStyles.xml" dir))))
  176. org-odt-styles-dir-list)))
  177. (unless styles-dir
  178. (error "Error (ox-odt): Cannot find factory styles files, aborting"))
  179. styles-dir)
  180. "Directory that holds auxiliary XML files used by the ODT exporter.
  181. This directory contains the following XML files -
  182. \"OrgOdtStyles.xml\" and \"OrgOdtContentTemplate.xml\". These
  183. XML files are used as the default values of
  184. `org-odt-styles-file' and `org-odt-content-template-file'.
  185. The default value of this variable varies depending on the
  186. version of Org in use and is initialized from
  187. `org-odt-styles-dir-list'. Note that the user could be using Org
  188. from one of: Org own private git repository, GNU ELPA tar or
  189. standard Emacs.")
  190. (defconst org-odt-bookmark-prefix "OrgXref.")
  191. (defconst org-odt-manifest-file-entry-tag
  192. "\n<manifest:file-entry manifest:media-type=\"%s\" manifest:full-path=\"%s\"%s/>")
  193. (defconst org-odt-file-extensions
  194. '(("odt" . "OpenDocument Text")
  195. ("ott" . "OpenDocument Text Template")
  196. ("odm" . "OpenDocument Master Document")
  197. ("ods" . "OpenDocument Spreadsheet")
  198. ("ots" . "OpenDocument Spreadsheet Template")
  199. ("odg" . "OpenDocument Drawing (Graphics)")
  200. ("otg" . "OpenDocument Drawing Template")
  201. ("odp" . "OpenDocument Presentation")
  202. ("otp" . "OpenDocument Presentation Template")
  203. ("odi" . "OpenDocument Image")
  204. ("odf" . "OpenDocument Formula")
  205. ("odc" . "OpenDocument Chart")))
  206. (defconst org-odt-table-style-format
  207. "
  208. <style:style style:name=\"%s\" style:family=\"table\">
  209. <style:table-properties style:rel-width=\"%s%%\" fo:margin-top=\"0cm\" fo:margin-bottom=\"0.20cm\" table:align=\"center\"/>
  210. </style:style>
  211. "
  212. "Template for auto-generated Table styles.")
  213. (defvar org-odt-automatic-styles '()
  214. "Registry of automatic styles for various OBJECT-TYPEs.
  215. The variable has the following form:
  216. ((OBJECT-TYPE-A
  217. ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
  218. (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
  219. (OBJECT-TYPE-B
  220. ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
  221. (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
  222. ...).
  223. OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
  224. OBJECT-PROPS is (typically) a plist created by passing
  225. \"#+ATTR_ODT: \" option to `org-odt-parse-block-attributes'.
  226. Use `org-odt-add-automatic-style' to add update this variable.'")
  227. (defvar org-odt-object-counters nil
  228. "Running counters for various OBJECT-TYPEs.
  229. Use this to generate automatic names and style-names. See
  230. `org-odt-add-automatic-style'.")
  231. (defvar org-odt-src-block-paragraph-format
  232. "<style:style style:name=\"OrgSrcBlock\" style:family=\"paragraph\" style:parent-style-name=\"Preformatted_20_Text\">
  233. <style:paragraph-properties fo:background-color=\"%s\" fo:padding=\"0.049cm\" fo:border=\"0.51pt solid #000000\" style:shadow=\"none\">
  234. <style:background-image/>
  235. </style:paragraph-properties>
  236. <style:text-properties fo:color=\"%s\"/>
  237. </style:style>"
  238. "Custom paragraph style for colorized source and example blocks.
  239. This style is much the same as that of \"OrgFixedWidthBlock\"
  240. except that the foreground and background colors are set
  241. according to the default face identified by the `htmlfontify'.")
  242. (defvar hfy-optimizations)
  243. (defvar org-odt-embedded-formulas-count 0)
  244. (defvar org-odt-embedded-images-count 0)
  245. (defvar org-odt-image-size-probe-method
  246. (append (and (executable-find "identify") '(imagemagick)) ; See Bug#10675
  247. '(emacs fixed))
  248. "Ordered list of methods for determining image sizes.")
  249. (defvar org-odt-default-image-sizes-alist
  250. '(("as-char" . (5 . 0.4))
  251. ("paragraph" . (5 . 5)))
  252. "Hardcoded image dimensions one for each of the anchor
  253. methods.")
  254. ;; A4 page size is 21.0 by 29.7 cms
  255. ;; The default page settings has 2cm margin on each of the sides. So
  256. ;; the effective text area is 17.0 by 25.7 cm
  257. (defvar org-odt-max-image-size '(17.0 . 20.0)
  258. "Limiting dimensions for an embedded image.")
  259. (defconst org-odt-label-styles
  260. '(("math-formula" "%c" "text" "(%n)")
  261. ("math-label" "(%n)" "text" "(%n)")
  262. ("category-and-value" "%e %n: %c" "category-and-value" "%e %n")
  263. ("value" "%e %n: %c" "value" "%n"))
  264. "Specify how labels are applied and referenced.
  265. This is an alist where each element is of the form:
  266. (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
  267. ATTACH-FMT controls how labels and captions are attached to an
  268. entity. It may contain following specifiers - %e and %c. %e is
  269. replaced with the CATEGORY-NAME. %n is replaced with
  270. \"<text:sequence ...> SEQNO </text:sequence>\". %c is replaced
  271. with CAPTION.
  272. REF-MODE and REF-FMT controls how label references are generated.
  273. The following XML is generated for a label reference -
  274. \"<text:sequence-ref text:reference-format=\"REF-MODE\" ...>
  275. REF-FMT </text:sequence-ref>\". REF-FMT may contain following
  276. specifiers - %e and %n. %e is replaced with the CATEGORY-NAME.
  277. %n is replaced with SEQNO.
  278. See also `org-odt-format-label'.")
  279. (defvar org-odt-category-map-alist
  280. '(("__Table__" "Table" "value" "Table" org-odt--enumerable-p)
  281. ("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)
  282. ("__MathFormula__" "Text" "math-formula" "Equation" org-odt--enumerable-formula-p)
  283. ("__DvipngImage__" "Equation" "value" "Equation" org-odt--enumerable-latex-image-p)
  284. ("__Listing__" "Listing" "value" "Listing" org-odt--enumerable-p))
  285. "Map a CATEGORY-HANDLE to OD-VARIABLE and LABEL-STYLE.
  286. This is a list where each entry is of the form:
  287. (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
  288. CATEGORY_HANDLE identifies the captionable entity in question.
  289. OD-VARIABLE is the OpenDocument sequence counter associated with
  290. the entity. These counters are declared within
  291. \"<text:sequence-decls>...</text:sequence-decls>\" block of
  292. `org-odt-content-template-file'.
  293. LABEL-STYLE is a key into `org-odt-label-styles' and specifies
  294. how a given entity should be captioned and referenced.
  295. CATEGORY-NAME is used for qualifying captions on export.
  296. ENUMERATOR-PREDICATE is used for assigning a sequence number to
  297. the entity. See `org-odt--enumerate'.")
  298. (defvar org-odt-manifest-file-entries nil)
  299. (defvar hfy-user-sheet-assoc)
  300. (defvar org-odt-zip-dir nil
  301. "Temporary work directory for OpenDocument exporter.")
  302. ;;; User Configuration Variables
  303. (defgroup org-export-odt nil
  304. "Options for exporting Org mode files to ODT."
  305. :tag "Org Export ODT"
  306. :group 'org-export)
  307. ;;;; Debugging
  308. (defcustom org-odt-prettify-xml nil
  309. "Specify whether or not the xml output should be prettified.
  310. When this option is turned on, `indent-region' is run on all
  311. component xml buffers before they are saved. Turn this off for
  312. regular use. Turn this on if you need to examine the xml
  313. visually."
  314. :group 'org-export-odt
  315. :version "24.1"
  316. :type 'boolean)
  317. ;;;; Document schema
  318. (require 'rng-loc)
  319. (defcustom org-odt-schema-dir
  320. (cl-find-if
  321. (lambda (dir)
  322. (and dir
  323. (file-expand-wildcards
  324. (expand-file-name "od-manifest-schema*.rnc" dir))
  325. (file-expand-wildcards (expand-file-name "od-schema*.rnc" dir))
  326. (file-readable-p (expand-file-name "schemas.xml" dir))))
  327. org-odt-schema-dir-list)
  328. "Directory that contains OpenDocument schema files.
  329. This directory contains:
  330. 1. rnc files for OpenDocument schema
  331. 2. a \"schemas.xml\" file that specifies locating rules needed
  332. for auto validation of OpenDocument XML files.
  333. Use the customize interface to set this variable. This ensures
  334. that `rng-schema-locating-files' is updated and auto-validation
  335. of OpenDocument XML takes place based on the value
  336. `rng-nxml-auto-validate-flag'.
  337. The default value of this variable varies depending on the
  338. version of org in use and is initialized from
  339. `org-odt-schema-dir-list'. The OASIS schema files are available
  340. only in the org's private git repository. It is *not* bundled
  341. with GNU ELPA tar or standard Emacs distribution."
  342. :type '(choice
  343. (const :tag "Not set" nil)
  344. (directory :tag "Schema directory"))
  345. :group 'org-export-odt
  346. :version "24.1"
  347. :set
  348. (lambda (var value)
  349. "Set `org-odt-schema-dir'.
  350. Also add it to `rng-schema-locating-files'."
  351. (let ((schema-dir value))
  352. (set var
  353. (if (and
  354. (file-expand-wildcards
  355. (expand-file-name "od-manifest-schema*.rnc" schema-dir))
  356. (file-expand-wildcards
  357. (expand-file-name "od-schema*.rnc" schema-dir))
  358. (file-readable-p
  359. (expand-file-name "schemas.xml" schema-dir)))
  360. schema-dir
  361. (when value
  362. (message "Error (ox-odt): %s has no OpenDocument schema files"
  363. value))
  364. nil)))
  365. (when org-odt-schema-dir
  366. (eval-after-load 'rng-loc
  367. '(add-to-list 'rng-schema-locating-files
  368. (expand-file-name "schemas.xml"
  369. org-odt-schema-dir))))))
  370. ;;;; Document styles
  371. (defcustom org-odt-content-template-file nil
  372. "Template file for \"content.xml\".
  373. The exporter embeds the exported content just before
  374. \"</office:text>\" element.
  375. If unspecified, the file named \"OrgOdtContentTemplate.xml\"
  376. under `org-odt-styles-dir' is used."
  377. :type '(choice (const nil)
  378. (file))
  379. :group 'org-export-odt
  380. :version "24.3")
  381. (defcustom org-odt-styles-file nil
  382. "Default styles file for use with ODT export.
  383. Valid values are one of:
  384. 1. nil
  385. 2. path to a styles.xml file
  386. 3. path to a *.odt or a *.ott file
  387. 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
  388. ...))
  389. In case of option 1, an in-built styles.xml is used. See
  390. `org-odt-styles-dir' for more information.
  391. In case of option 3, the specified file is unzipped and the
  392. styles.xml embedded therein is used.
  393. In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
  394. and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
  395. generated odt file. Use relative path for specifying the
  396. FILE-MEMBERS. styles.xml must be specified as one of the
  397. FILE-MEMBERS.
  398. Use options 1, 2 or 3 only if styles.xml alone suffices for
  399. achieving the desired formatting. Use option 4, if the styles.xml
  400. references additional files like header and footer images for
  401. achieving the desired formatting.
  402. Use \"#+ODT_STYLES_FILE: ...\" directive to set this variable on
  403. a per-file basis. For example,
  404. #+ODT_STYLES_FILE: \"/path/to/styles.xml\" or
  405. #+ODT_STYLES_FILE: (\"/path/to/file.ott\" (\"styles.xml\" \"image/hdr.png\"))."
  406. :group 'org-export-odt
  407. :version "24.1"
  408. :type
  409. '(choice
  410. (const :tag "Factory settings" nil)
  411. (file :must-match t :tag "styles.xml")
  412. (file :must-match t :tag "ODT or OTT file")
  413. (list :tag "ODT or OTT file + Members"
  414. (file :must-match t :tag "ODF Text or Text Template file")
  415. (cons :tag "Members"
  416. (file :tag " Member" "styles.xml")
  417. (repeat (file :tag "Member"))))))
  418. (defcustom org-odt-display-outline-level 2
  419. "Outline levels considered for enumerating captioned entities."
  420. :group 'org-export-odt
  421. :version "24.4"
  422. :package-version '(Org . "8.0")
  423. :type 'integer)
  424. ;;;; Document conversion
  425. (defcustom org-odt-convert-processes
  426. '(("LibreOffice"
  427. "soffice --headless --convert-to %f%x --outdir %d %i")
  428. ("unoconv"
  429. "unoconv -f %f -o %d %i"))
  430. "Specify a list of document converters and their usage.
  431. The converters in this list are offered as choices while
  432. customizing `org-odt-convert-process'.
  433. This variable is a list where each element is of the
  434. form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name
  435. of the converter. CONVERTER-CMD is the shell command for the
  436. converter and can contain format specifiers. These format
  437. specifiers are interpreted as below:
  438. %i input file name in full
  439. %I input file name as a URL
  440. %f format of the output file
  441. %o output file name in full
  442. %O output file name as a URL
  443. %d output dir in full
  444. %D output dir as a URL.
  445. %x extra options as set in `org-odt-convert-capabilities'."
  446. :group 'org-export-odt
  447. :version "24.1"
  448. :type
  449. '(choice
  450. (const :tag "None" nil)
  451. (alist :tag "Converters"
  452. :key-type (string :tag "Converter Name")
  453. :value-type (group (string :tag "Command line")))))
  454. (defcustom org-odt-convert-process "LibreOffice"
  455. "Use this converter to convert from \"odt\" format to other formats.
  456. During customization, the list of converter names are populated
  457. from `org-odt-convert-processes'."
  458. :group 'org-export-odt
  459. :version "24.1"
  460. :type '(choice :convert-widget
  461. (lambda (w)
  462. (apply 'widget-convert (widget-type w)
  463. (eval (car (widget-get w :args)))))
  464. `((const :tag "None" nil)
  465. ,@(mapcar (lambda (c)
  466. `(const :tag ,(car c) ,(car c)))
  467. org-odt-convert-processes))))
  468. (defcustom org-odt-convert-capabilities
  469. '(("Text"
  470. ("odt" "ott" "doc" "rtf" "docx")
  471. (("pdf" "pdf") ("odt" "odt") ("rtf" "rtf") ("ott" "ott")
  472. ("doc" "doc" ":\"MS Word 97\"") ("docx" "docx") ("html" "html")))
  473. ("Web"
  474. ("html")
  475. (("pdf" "pdf") ("odt" "odt") ("html" "html")))
  476. ("Spreadsheet"
  477. ("ods" "ots" "xls" "csv" "xlsx")
  478. (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv") ("ods" "ods")
  479. ("xls" "xls") ("xlsx" "xlsx")))
  480. ("Presentation"
  481. ("odp" "otp" "ppt" "pptx")
  482. (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("otp" "otp") ("ppt" "ppt")
  483. ("pptx" "pptx") ("odg" "odg"))))
  484. "Specify input and output formats of `org-odt-convert-process'.
  485. More correctly, specify the set of input and output formats that
  486. the user is actually interested in.
  487. This variable is an alist where each element is of the
  488. form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
  489. INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
  490. alist where each element is of the form (OUTPUT-FMT
  491. OUTPUT-FILE-EXTENSION EXTRA-OPTIONS).
  492. The variable is interpreted as follows:
  493. `org-odt-convert-process' can take any document that is in
  494. INPUT-FMT-LIST and produce any document that is in the
  495. OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
  496. OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
  497. serves dual purposes:
  498. - It is used for populating completion candidates during
  499. `org-odt-convert' commands.
  500. - It is used as the value of \"%f\" specifier in
  501. `org-odt-convert-process'.
  502. EXTRA-OPTIONS is used as the value of \"%x\" specifier in
  503. `org-odt-convert-process'.
  504. DOCUMENT-CLASS is used to group a set of file formats in
  505. INPUT-FMT-LIST in to a single class.
  506. Note that this variable inherently captures how LibreOffice based
  507. converters work. LibreOffice maps documents of various formats
  508. to classes like Text, Web, Spreadsheet, Presentation etc and
  509. allow document of a given class (irrespective of its source
  510. format) to be converted to any of the export formats associated
  511. with that class.
  512. See default setting of this variable for a typical configuration."
  513. :group 'org-export-odt
  514. :version "24.1"
  515. :type
  516. '(choice
  517. (const :tag "None" nil)
  518. (alist :tag "Capabilities"
  519. :key-type (string :tag "Document Class")
  520. :value-type
  521. (group (repeat :tag "Input formats" (string :tag "Input format"))
  522. (alist :tag "Output formats"
  523. :key-type (string :tag "Output format")
  524. :value-type
  525. (group (string :tag "Output file extension")
  526. (choice
  527. (const :tag "None" nil)
  528. (string :tag "Extra options"))))))))
  529. (defcustom org-odt-preferred-output-format nil
  530. "Automatically post-process to this format after exporting to \"odt\".
  531. Command `org-odt-export-to-odt' exports first to \"odt\" format
  532. and then uses `org-odt-convert-process' to convert the
  533. resulting document to this format. During customization of this
  534. variable, the list of valid values are populated based on
  535. `org-odt-convert-capabilities'.
  536. You can set this option on per-file basis using file local
  537. values. See Info node `(emacs) File Variables'."
  538. :group 'org-export-odt
  539. :version "24.1"
  540. :type '(choice :convert-widget
  541. (lambda (w)
  542. (apply 'widget-convert (widget-type w)
  543. (eval (car (widget-get w :args)))))
  544. `((const :tag "None" nil)
  545. ,@(mapcar (lambda (c)
  546. `(const :tag ,c ,c))
  547. (org-odt-reachable-formats "odt")))))
  548. ;;;###autoload
  549. (put 'org-odt-preferred-output-format 'safe-local-variable 'stringp)
  550. ;;;; Drawers
  551. (defcustom org-odt-format-drawer-function (lambda (_name contents) contents)
  552. "Function called to format a drawer in ODT code.
  553. The function must accept two parameters:
  554. NAME the drawer name, like \"LOGBOOK\"
  555. CONTENTS the contents of the drawer.
  556. The function should return the string to be exported.
  557. The default value simply returns the value of CONTENTS."
  558. :group 'org-export-odt
  559. :version "26.1"
  560. :package-version '(Org . "8.3")
  561. :type 'function)
  562. ;;;; Headline
  563. (defcustom org-odt-format-headline-function
  564. 'org-odt-format-headline-default-function
  565. "Function to format headline text.
  566. This function will be called with 5 arguments:
  567. TODO the todo keyword (string or nil).
  568. TODO-TYPE the type of todo (symbol: `todo', `done', nil)
  569. PRIORITY the priority of the headline (integer or nil)
  570. TEXT the main headline text (string).
  571. TAGS the tags string, separated with colons (string or nil).
  572. The function result will be used as headline text."
  573. :group 'org-export-odt
  574. :version "26.1"
  575. :package-version '(Org . "8.3")
  576. :type 'function)
  577. ;;;; Inlinetasks
  578. (defcustom org-odt-format-inlinetask-function
  579. 'org-odt-format-inlinetask-default-function
  580. "Function called to format an inlinetask in ODT code.
  581. The function must accept six parameters:
  582. TODO the todo keyword, as a string
  583. TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
  584. PRIORITY the inlinetask priority, as a string
  585. NAME the inlinetask name, as a string.
  586. TAGS the inlinetask tags, as a string.
  587. CONTENTS the contents of the inlinetask, as a string.
  588. The function should return the string to be exported."
  589. :group 'org-export-odt
  590. :version "26.1"
  591. :package-version '(Org . "8.3")
  592. :type 'function)
  593. ;;;; LaTeX
  594. (defcustom org-odt-with-latex org-export-with-latex
  595. "Non-nil means process LaTeX math snippets.
  596. When set, the exporter will process LaTeX environments and
  597. fragments.
  598. This option can also be set with the +OPTIONS line,
  599. e.g. \"tex:mathjax\". Allowed values are:
  600. nil Ignore math snippets.
  601. `verbatim' Keep everything in verbatim
  602. `dvipng' Process the LaTeX fragments to images. This will also
  603. include processing of non-math environments.
  604. `imagemagick' Convert the LaTeX fragments to pdf files and use
  605. imagemagick to convert pdf files to png files.
  606. `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
  607. be loaded.
  608. Any other symbol is a synonym for `mathjax'."
  609. :group 'org-export-odt
  610. :version "24.4"
  611. :package-version '(Org . "8.0")
  612. :type '(choice
  613. (const :tag "Do not process math in any way" nil)
  614. (const :tag "Leave math verbatim" verbatim)
  615. (const :tag "Use dvipng to make images" dvipng)
  616. (const :tag "Use imagemagick to make images" imagemagick)
  617. (other :tag "Use MathJax to display math" mathjax)))
  618. ;;;; Links
  619. (defcustom org-odt-inline-formula-rules
  620. '(("file" . "\\.\\(mathml\\|mml\\|odf\\)\\'"))
  621. "Rules characterizing formula files that can be inlined into ODT.
  622. A rule consists in an association whose key is the type of link
  623. to consider, and value is a regexp that will be matched against
  624. link's path."
  625. :group 'org-export-odt
  626. :version "24.4"
  627. :package-version '(Org . "8.0")
  628. :type '(alist :key-type (string :tag "Type")
  629. :value-type (regexp :tag "Path")))
  630. (defcustom org-odt-inline-image-rules
  631. '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
  632. "Rules characterizing image files that can be inlined into ODT.
  633. A rule consists in an association whose key is the type of link
  634. to consider, and value is a regexp that will be matched against
  635. link's path."
  636. :group 'org-export-odt
  637. :version "26.1"
  638. :package-version '(Org . "8.3")
  639. :type '(alist :key-type (string :tag "Type")
  640. :value-type (regexp :tag "Path")))
  641. (defcustom org-odt-pixels-per-inch 96.0
  642. "Scaling factor for converting images pixels to inches.
  643. Use this for sizing of embedded images. See Info node `(org)
  644. Images in ODT export' for more information."
  645. :type 'float
  646. :group 'org-export-odt
  647. :version "24.4"
  648. :package-version '(Org . "8.1"))
  649. ;;;; Src Block
  650. (defcustom org-odt-create-custom-styles-for-srcblocks t
  651. "Whether custom styles for colorized source blocks be automatically created.
  652. When this option is turned on, the exporter creates custom styles
  653. for source blocks based on the advice of `htmlfontify'. Creation
  654. of custom styles happen as part of `org-odt-hfy-face-to-css'.
  655. When this option is turned off exporter does not create such
  656. styles.
  657. Use the latter option if you do not want the custom styles to be
  658. based on your current display settings. It is necessary that the
  659. styles.xml already contains needed styles for colorizing to work.
  660. This variable is effective only if `org-odt-fontify-srcblocks' is
  661. turned on."
  662. :group 'org-export-odt
  663. :version "24.1"
  664. :type 'boolean)
  665. (defcustom org-odt-fontify-srcblocks t
  666. "Specify whether or not source blocks need to be fontified.
  667. Turn this option on if you want to colorize the source code
  668. blocks in the exported file. For colorization to work, you need
  669. to make available an enhanced version of `htmlfontify' library."
  670. :type 'boolean
  671. :group 'org-export-odt
  672. :version "24.1")
  673. ;;;; Table
  674. (defcustom org-odt-table-styles
  675. '(("OrgEquation" "OrgEquation"
  676. ((use-first-column-styles . t)
  677. (use-last-column-styles . t)))
  678. ("TableWithHeaderRowAndColumn" "Custom"
  679. ((use-first-row-styles . t)
  680. (use-first-column-styles . t)))
  681. ("TableWithFirstRowandLastRow" "Custom"
  682. ((use-first-row-styles . t)
  683. (use-last-row-styles . t)))
  684. ("GriddedTable" "Custom" nil))
  685. "Specify how Table Styles should be derived from a Table Template.
  686. This is a list where each element is of the
  687. form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
  688. TABLE-STYLE-NAME is the style associated with the table through
  689. \"#+ATTR_ODT: :style TABLE-STYLE-NAME\" line.
  690. TABLE-TEMPLATE-NAME is a set of - upto 9 - automatic
  691. TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
  692. below) that is included in `org-odt-content-template-file'.
  693. TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
  694. \"TableCell\"
  695. PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
  696. \"TableParagraph\"
  697. TABLE-CELL-TYPE := \"FirstRow\" | \"LastColumn\" |
  698. \"FirstRow\" | \"LastRow\" |
  699. \"EvenRow\" | \"OddRow\" |
  700. \"EvenColumn\" | \"OddColumn\" | \"\"
  701. where \"+\" above denotes string concatenation.
  702. TABLE-CELL-OPTIONS is an alist where each element is of the
  703. form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
  704. TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
  705. `use-last-row-styles' |
  706. `use-first-column-styles' |
  707. `use-last-column-styles' |
  708. `use-banding-rows-styles' |
  709. `use-banding-columns-styles' |
  710. `use-first-row-styles'
  711. ON-OR-OFF := t | nil
  712. For example, with the following configuration
  713. \(setq org-odt-table-styles
  714. \\='((\"TableWithHeaderRowsAndColumns\" \"Custom\"
  715. ((use-first-row-styles . t)
  716. (use-first-column-styles . t)))
  717. (\"TableWithHeaderColumns\" \"Custom\"
  718. ((use-first-column-styles . t)))))
  719. 1. A table associated with \"TableWithHeaderRowsAndColumns\"
  720. style will use the following table-cell styles -
  721. \"CustomFirstRowTableCell\", \"CustomFirstColumnTableCell\",
  722. \"CustomTableCell\" and the following paragraph styles
  723. \"CustomFirstRowTableParagraph\",
  724. \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
  725. as appropriate.
  726. 2. A table associated with \"TableWithHeaderColumns\" style will
  727. use the following table-cell styles -
  728. \"CustomFirstColumnTableCell\", \"CustomTableCell\" and the
  729. following paragraph styles
  730. \"CustomFirstColumnTableParagraph\", \"CustomTableParagraph\"
  731. as appropriate..
  732. Note that TABLE-TEMPLATE-NAME corresponds to the
  733. \"<table:table-template>\" elements contained within
  734. \"<office:styles>\". The entries (TABLE-STYLE-NAME
  735. TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
  736. \"table:template-name\" and \"table:use-first-row-styles\" etc
  737. attributes of \"<table:table>\" element. Refer ODF-1.2
  738. specification for more information. Also consult the
  739. implementation filed under `org-odt-get-table-cell-styles'.
  740. The TABLE-STYLE-NAME \"OrgEquation\" is used internally for
  741. formatting of numbered display equations. Do not delete this
  742. style from the list."
  743. :group 'org-export-odt
  744. :version "24.1"
  745. :type '(choice
  746. (const :tag "None" nil)
  747. (repeat :tag "Table Styles"
  748. (list :tag "Table Style Specification"
  749. (string :tag "Table Style Name")
  750. (string :tag "Table Template Name")
  751. (alist :options (use-first-row-styles
  752. use-last-row-styles
  753. use-first-column-styles
  754. use-last-column-styles
  755. use-banding-rows-styles
  756. use-banding-columns-styles)
  757. :key-type symbol
  758. :value-type (const :tag "True" t))))))
  759. ;;;; Timestamps
  760. (defcustom org-odt-use-date-fields nil
  761. "Non-nil, if timestamps should be exported as date fields.
  762. When nil, export timestamps as plain text.
  763. When non-nil, map `org-time-stamp-custom-formats' to a pair of
  764. OpenDocument date-styles with names \"OrgDate1\" and \"OrgDate2\"
  765. respectively. A timestamp with no time component is formatted
  766. with style \"OrgDate1\" while one with explicit hour and minutes
  767. is formatted with style \"OrgDate2\".
  768. This feature is experimental. Most (but not all) of the common
  769. %-specifiers in `format-time-string' are supported.
  770. Specifically, locale-dependent specifiers like \"%c\", \"%x\" are
  771. formatted as canonical Org timestamps. For finer control, avoid
  772. these %-specifiers.
  773. Textual specifiers like \"%b\", \"%h\", \"%B\", \"%a\", \"%A\"
  774. etc., are displayed by the application in the default language
  775. and country specified in `org-odt-styles-file'. Note that the
  776. default styles file uses language \"en\" and country \"GB\". You
  777. can localize the week day and month strings in the exported
  778. document by setting the default language and country either using
  779. the application UI or through a custom styles file.
  780. See `org-odt--build-date-styles' for implementation details."
  781. :group 'org-export-odt
  782. :version "24.4"
  783. :package-version '(Org . "8.0")
  784. :type 'boolean)
  785. ;;; Internal functions
  786. ;;;; Date
  787. (defun org-odt--format-timestamp (timestamp &optional end iso-date-p)
  788. (let* ((format-timestamp
  789. (lambda (timestamp format &optional end utc)
  790. (if timestamp
  791. (org-timestamp-format timestamp format end utc)
  792. (format-time-string format nil utc))))
  793. (has-time-p (or (not timestamp)
  794. (org-timestamp-has-time-p timestamp)))
  795. (iso-date (let ((format (if has-time-p "%Y-%m-%dT%H:%M:%S"
  796. "%Y-%m-%dT%H:%M:%S")))
  797. (funcall format-timestamp timestamp format end))))
  798. (if iso-date-p iso-date
  799. (let* ((style (if has-time-p "OrgDate2" "OrgDate1"))
  800. ;; LibreOffice does not care about end goes as content
  801. ;; within the "<text:date>...</text:date>" field. The
  802. ;; displayed date is automagically corrected to match the
  803. ;; format requested by "style:data-style-name" attribute. So
  804. ;; don't bother about formatting the date contents to be
  805. ;; compatible with "OrgDate1" and "OrgDateTime" styles. A
  806. ;; simple Org-style date should suffice.
  807. (date (let* ((formats
  808. (if org-display-custom-times
  809. (cons (substring
  810. (car org-time-stamp-custom-formats) 1 -1)
  811. (substring
  812. (cdr org-time-stamp-custom-formats) 1 -1))
  813. '("%Y-%m-%d %a" . "%Y-%m-%d %a %H:%M")))
  814. (format (if has-time-p (cdr formats) (car formats))))
  815. (funcall format-timestamp timestamp format end)))
  816. (repeater (let ((repeater-type (org-element-property
  817. :repeater-type timestamp))
  818. (repeater-value (org-element-property
  819. :repeater-value timestamp))
  820. (repeater-unit (org-element-property
  821. :repeater-unit timestamp)))
  822. (concat
  823. (cl-case repeater-type
  824. (catchup "++") (restart ".+") (cumulate "+"))
  825. (when repeater-value
  826. (number-to-string repeater-value))
  827. (cl-case repeater-unit
  828. (hour "h") (day "d") (week "w") (month "m")
  829. (year "y"))))))
  830. (concat
  831. (format "<text:date text:date-value=\"%s\" style:data-style-name=\"%s\" text:fixed=\"true\">%s</text:date>"
  832. iso-date style date)
  833. (and (not (string= repeater "")) " ")
  834. repeater)))))
  835. ;;;; Frame
  836. (defun org-odt--frame (text width height style &optional extra
  837. anchor-type &rest title-and-desc)
  838. (let ((frame-attrs
  839. (concat
  840. (if width (format " svg:width=\"%0.2fcm\"" width) "")
  841. (if height (format " svg:height=\"%0.2fcm\"" height) "")
  842. extra
  843. (format " text:anchor-type=\"%s\"" (or anchor-type "paragraph"))
  844. (format " draw:name=\"%s\""
  845. (car (org-odt-add-automatic-style "Frame"))))))
  846. (format
  847. "\n<draw:frame draw:style-name=\"%s\"%s>\n%s\n</draw:frame>"
  848. style frame-attrs
  849. (concat text
  850. (let ((title (car title-and-desc))
  851. (desc (cadr title-and-desc)))
  852. (concat (when title
  853. (format "<svg:title>%s</svg:title>"
  854. (org-odt--encode-plain-text title t)))
  855. (when desc
  856. (format "<svg:desc>%s</svg:desc>"
  857. (org-odt--encode-plain-text desc t)))))))))
  858. ;;;; Library wrappers
  859. (defun org-odt--zip-extract (archive members target)
  860. (when (atom members) (setq members (list members)))
  861. (require 'arc-mode)
  862. (dolist (member members)
  863. (let* ((--quote-file-name
  864. ;; This is shamelessly stolen from `archive-zip-extract'.
  865. (lambda (name)
  866. (if (or (not (memq system-type '(windows-nt ms-dos)))
  867. (and (boundp 'w32-quote-process-args)
  868. (null w32-quote-process-args)))
  869. (shell-quote-argument name)
  870. name)))
  871. (target (funcall --quote-file-name target))
  872. (archive (expand-file-name archive))
  873. (archive-zip-extract
  874. (list "unzip" "-qq" "-o" "-d" target))
  875. exit-code command-output)
  876. (setq command-output
  877. (with-temp-buffer
  878. (setq exit-code (archive-zip-extract archive member))
  879. (buffer-string)))
  880. (unless (zerop exit-code)
  881. (message command-output)
  882. (error "Extraction failed")))))
  883. ;;;; Target
  884. (defun org-odt--target (text id)
  885. (if (not id) text
  886. (concat
  887. (format "\n<text:bookmark-start text:name=\"OrgXref.%s\"/>" id)
  888. (format "\n<text:bookmark text:name=\"%s\"/>" id) text
  889. (format "\n<text:bookmark-end text:name=\"OrgXref.%s\"/>" id))))
  890. ;;;; Textbox
  891. (defun org-odt--textbox (text width height style &optional
  892. extra anchor-type)
  893. (org-odt--frame
  894. (format "\n<draw:text-box %s>%s\n</draw:text-box>"
  895. (concat (format " fo:min-height=\"%0.2fcm\"" (or height .2))
  896. (and (not width)
  897. (format " fo:min-width=\"%0.2fcm\"" (or width .2))))
  898. text)
  899. width nil style extra anchor-type))
  900. ;;;; Table of Contents
  901. (defun org-odt--format-toc (title entries depth)
  902. "Return a table of contents.
  903. TITLE is the title of the table, as a string, or nil. ENTRIES is
  904. the contents of the table, as a string. DEPTH is an integer
  905. specifying the depth of the table."
  906. (concat
  907. "
  908. <text:table-of-content text:style-name=\"OrgIndexSection\" text:protected=\"true\" text:name=\"Table of Contents\">\n"
  909. (format " <text:table-of-content-source text:outline-level=\"%d\">" depth)
  910. (and title
  911. (format "
  912. <text:index-title-template text:style-name=\"Contents_20_Heading\">%s</text:index-title-template>
  913. "
  914. title))
  915. (let ((levels (number-sequence 1 10)))
  916. (mapconcat
  917. (lambda (level)
  918. (format
  919. "
  920. <text:table-of-content-entry-template text:outline-level=\"%d\" text:style-name=\"Contents_20_%d\">
  921. <text:index-entry-link-start text:style-name=\"Internet_20_link\"/>
  922. <text:index-entry-chapter/>
  923. <text:index-entry-text/>
  924. <text:index-entry-link-end/>
  925. </text:table-of-content-entry-template>\n"
  926. level level)) levels ""))
  927. "
  928. </text:table-of-content-source>
  929. <text:index-body>"
  930. (and title
  931. (format "
  932. <text:index-title text:style-name=\"Sect1\" text:name=\"Table of Contents1_Head\">
  933. <text:p text:style-name=\"Contents_20_Heading\">%s</text:p>
  934. </text:index-title>\n"
  935. title))
  936. entries
  937. "
  938. </text:index-body>
  939. </text:table-of-content>"))
  940. (cl-defun org-odt-format-toc-headline
  941. (todo _todo-type priority text tags
  942. &key _level section-number headline-label &allow-other-keys)
  943. (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
  944. headline-label
  945. (concat
  946. ;; Section number.
  947. (and section-number (concat section-number ". "))
  948. ;; Todo.
  949. (when todo
  950. (let ((style (if (member todo org-done-keywords)
  951. "OrgDone" "OrgTodo")))
  952. (format "<text:span text:style-name=\"%s\">%s</text:span> "
  953. style todo)))
  954. (when priority
  955. (let* ((style (format "OrgPriority-%s" priority))
  956. (priority (format "[#%c]" priority)))
  957. (format "<text:span text:style-name=\"%s\">%s</text:span> "
  958. style priority)))
  959. ;; Title.
  960. text
  961. ;; Tags.
  962. (when tags
  963. (concat
  964. (format " <text:span text:style-name=\"%s\">[%s]</text:span>"
  965. "OrgTags"
  966. (mapconcat
  967. (lambda (tag)
  968. (format
  969. "<text:span text:style-name=\"%s\">%s</text:span>"
  970. "OrgTag" tag)) tags " : ")))))))
  971. (defun org-odt-toc (depth info &optional scope)
  972. "Build a table of contents.
  973. DEPTH is an integer specifying the depth of the table. INFO is
  974. a plist containing current export properties. Optional argument
  975. SCOPE, when non-nil, defines the scope of the table. Return the
  976. table of contents as a string, or nil."
  977. (cl-assert (wholenump depth))
  978. ;; When a headline is marked as a radio target, as in the example below:
  979. ;;
  980. ;; ** <<<Some Heading>>>
  981. ;; Some text.
  982. ;;
  983. ;; suppress generation of radio targets. i.e., Radio targets are to
  984. ;; be marked as targets within /document body/ and *not* within
  985. ;; /TOC/, as otherwise there will be duplicated anchors one in TOC
  986. ;; and one in the document body.
  987. ;;
  988. ;; Likewise, links, footnote references and regular targets are also
  989. ;; suppressed.
  990. (let* ((headlines (org-export-collect-headlines info depth scope))
  991. (backend (org-export-toc-entry-backend
  992. (org-export-backend-name (plist-get info :back-end)))))
  993. (when headlines
  994. (org-odt--format-toc
  995. (and (not scope) (org-export-translate "Table of Contents" :utf-8 info))
  996. (mapconcat
  997. (lambda (headline)
  998. (let* ((entry (org-odt-format-headline--wrap
  999. headline backend info 'org-odt-format-toc-headline))
  1000. (level (org-export-get-relative-level headline info))
  1001. (style (format "Contents_20_%d" level)))
  1002. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1003. style entry)))
  1004. headlines "\n")
  1005. depth))))
  1006. ;;;; Document styles
  1007. (defun org-odt-add-automatic-style (object-type &optional object-props)
  1008. "Create an automatic style of type OBJECT-TYPE with param OBJECT-PROPS.
  1009. OBJECT-PROPS is (typically) a plist created by passing
  1010. \"#+ATTR_ODT: \" option of the object in question to
  1011. `org-odt-parse-block-attributes'.
  1012. Use `org-odt-object-counters' to generate an automatic
  1013. OBJECT-NAME and STYLE-NAME. If OBJECT-PROPS is non-nil, add a
  1014. new entry in `org-odt-automatic-styles'. Return (OBJECT-NAME
  1015. . STYLE-NAME)."
  1016. (cl-assert (stringp object-type))
  1017. (let* ((object (intern object-type))
  1018. (seqvar object)
  1019. (seqno (1+ (or (plist-get org-odt-object-counters seqvar) 0)))
  1020. (object-name (format "%s%d" object-type seqno)) style-name)
  1021. (setq org-odt-object-counters
  1022. (plist-put org-odt-object-counters seqvar seqno))
  1023. (when object-props
  1024. (setq style-name (format "Org%s" object-name))
  1025. (setq org-odt-automatic-styles
  1026. (plist-put org-odt-automatic-styles object
  1027. (append (list (list style-name object-props))
  1028. (plist-get org-odt-automatic-styles object)))))
  1029. (cons object-name style-name)))
  1030. ;;;; Checkbox
  1031. (defun org-odt--checkbox (item)
  1032. "Return check-box string associated to ITEM."
  1033. (let ((checkbox (org-element-property :checkbox item)))
  1034. (if (not checkbox) ""
  1035. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1036. "OrgCode" (cl-case checkbox
  1037. (on "[&#x2713;] ") ; CHECK MARK
  1038. (off "[ ] ")
  1039. (trans "[-] "))))))
  1040. ;;; Template
  1041. (defun org-odt--build-date-styles (fmt style)
  1042. ;; In LibreOffice 3.4.6, there doesn't seem to be a convenient way
  1043. ;; to modify the date fields. A date could be modified by
  1044. ;; offsetting in days. That's about it. Also, date and time may
  1045. ;; have to be emitted as two fields - a date field and a time field
  1046. ;; - separately.
  1047. ;; One can add Form Controls to date and time fields so that they
  1048. ;; can be easily modified. But then, the exported document will
  1049. ;; become tightly coupled with LibreOffice and may not function
  1050. ;; properly with other OpenDocument applications.
  1051. ;; I have a strange feeling that Date styles are a bit flaky at the
  1052. ;; moment.
  1053. ;; The feature is experimental.
  1054. (when (and fmt style)
  1055. (let* ((fmt-alist
  1056. '(("%A" . "<number:day-of-week number:style=\"long\"/>")
  1057. ("%B" . "<number:month number:textual=\"true\" number:style=\"long\"/>")
  1058. ("%H" . "<number:hours number:style=\"long\"/>")
  1059. ("%M" . "<number:minutes number:style=\"long\"/>")
  1060. ("%S" . "<number:seconds number:style=\"long\"/>")
  1061. ("%V" . "<number:week-of-year/>")
  1062. ("%Y" . "<number:year number:style=\"long\"/>")
  1063. ("%a" . "<number:day-of-week number:style=\"short\"/>")
  1064. ("%b" . "<number:month number:textual=\"true\" number:style=\"short\"/>")
  1065. ("%d" . "<number:day number:style=\"long\"/>")
  1066. ("%e" . "<number:day number:style=\"short\"/>")
  1067. ("%h" . "<number:month number:textual=\"true\" number:style=\"short\"/>")
  1068. ("%k" . "<number:hours number:style=\"short\"/>")
  1069. ("%m" . "<number:month number:style=\"long\"/>")
  1070. ("%p" . "<number:am-pm/>")
  1071. ("%y" . "<number:year number:style=\"short\"/>")))
  1072. (case-fold-search nil)
  1073. (re (mapconcat 'identity (mapcar 'car fmt-alist) "\\|"))
  1074. match rpl (start 0) (filler-beg 0) filler-end filler output)
  1075. (dolist (pair
  1076. '(("\\(?:%[[:digit:]]*N\\)" . "") ; strip ns, us and ns
  1077. ("%C" . "Y") ; replace century with year
  1078. ("%D" . "%m/%d/%y")
  1079. ("%G" . "Y") ; year corresponding to iso week
  1080. ("%I" . "%H") ; hour on a 12-hour clock
  1081. ("%R" . "%H:%M")
  1082. ("%T" . "%H:%M:%S")
  1083. ("%U\\|%W" . "%V") ; week no. starting on Sun./Mon.
  1084. ("%Z" . "") ; time zone name
  1085. ("%c" . "%Y-%M-%d %a %H:%M" ) ; locale's date and time format
  1086. ("%g" . "%y")
  1087. ("%X" . "%x" ) ; locale's pref. time format
  1088. ("%j" . "") ; day of the year
  1089. ("%l" . "%k") ; like %I blank-padded
  1090. ("%s" . "") ; no. of secs since 1970-01-01 00:00:00 +0000
  1091. ("%n" . "<text:line-break/>")
  1092. ("%r" . "%I:%M:%S %p")
  1093. ("%t" . "<text:tab/>")
  1094. ("%u\\|%w" . "") ; numeric day of week - Mon (1-7), Sun(0-6)
  1095. ("%x" . "%Y-%M-%d %a") ; locale's pref. time format
  1096. ("%z" . "") ; time zone in numeric form
  1097. ))
  1098. (setq fmt (replace-regexp-in-string (car pair) (cdr pair) fmt t t)))
  1099. (while (string-match re fmt start)
  1100. (setq match (match-string 0 fmt))
  1101. (setq rpl (assoc-default match fmt-alist))
  1102. (setq start (match-end 0))
  1103. (setq filler-end (match-beginning 0))
  1104. (setq filler (substring fmt (prog1 filler-beg
  1105. (setq filler-beg (match-end 0)))
  1106. filler-end))
  1107. (setq filler (and (not (string= filler ""))
  1108. (format "<number:text>%s</number:text>"
  1109. (org-odt--encode-plain-text filler))))
  1110. (setq output (concat output "\n" filler "\n" rpl)))
  1111. (setq filler (substring fmt filler-beg))
  1112. (unless (string= filler "")
  1113. (setq output (concat output
  1114. (format "\n<number:text>%s</number:text>"
  1115. (org-odt--encode-plain-text filler)))))
  1116. (format "\n<number:date-style style:name=\"%s\" %s>%s\n</number:date-style>"
  1117. style
  1118. (concat " number:automatic-order=\"true\""
  1119. " number:format-source=\"fixed\"")
  1120. output ))))
  1121. (defun org-odt-template (contents info)
  1122. "Return complete document string after ODT conversion.
  1123. CONTENTS is the transcoded contents string. RAW-DATA is the
  1124. original parsed data. INFO is a plist holding export options."
  1125. ;; Write meta file.
  1126. (let ((title (org-export-data (plist-get info :title) info))
  1127. (subtitle (org-export-data (plist-get info :subtitle) info))
  1128. (author (let ((author (plist-get info :author)))
  1129. (if (not author) "" (org-export-data author info))))
  1130. (keywords (or (plist-get info :keywords) ""))
  1131. (description (or (plist-get info :description) "")))
  1132. (write-region
  1133. (concat
  1134. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  1135. <office:document-meta
  1136. xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\"
  1137. xmlns:xlink=\"http://www.w3.org/1999/xlink\"
  1138. xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
  1139. xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\"
  1140. xmlns:ooo=\"http://openoffice.org/2004/office\"
  1141. office:version=\"1.2\">
  1142. <office:meta>\n"
  1143. (format "<dc:creator>%s</dc:creator>\n" author)
  1144. (format "<meta:initial-creator>%s</meta:initial-creator>\n" author)
  1145. ;; Date, if required.
  1146. (when (plist-get info :with-date)
  1147. ;; Check if DATE is specified as an Org-timestamp. If yes,
  1148. ;; include it as meta information. Otherwise, just use
  1149. ;; today's date.
  1150. (let* ((date (let ((date (plist-get info :date)))
  1151. (and (not (cdr date))
  1152. (eq (org-element-type (car date)) 'timestamp)
  1153. (car date)))))
  1154. (let ((iso-date (org-odt--format-timestamp date nil 'iso-date)))
  1155. (concat
  1156. (format "<dc:date>%s</dc:date>\n" iso-date)
  1157. (format "<meta:creation-date>%s</meta:creation-date>\n"
  1158. iso-date)))))
  1159. (format "<meta:generator>%s</meta:generator>\n"
  1160. (plist-get info :creator))
  1161. (format "<meta:keyword>%s</meta:keyword>\n" keywords)
  1162. (format "<dc:subject>%s</dc:subject>\n" description)
  1163. (format "<dc:title>%s</dc:title>\n" title)
  1164. (when (org-string-nw-p subtitle)
  1165. (format
  1166. "<meta:user-defined meta:name=\"subtitle\">%s</meta:user-defined>\n"
  1167. subtitle))
  1168. "\n"
  1169. " </office:meta>\n" "</office:document-meta>")
  1170. nil (concat org-odt-zip-dir "meta.xml"))
  1171. ;; Add meta.xml in to manifest.
  1172. (org-odt-create-manifest-file-entry "text/xml" "meta.xml"))
  1173. ;; Update styles file.
  1174. ;; Copy styles.xml. Also dump htmlfontify styles, if there is any.
  1175. ;; Write styles file.
  1176. (let* ((styles-file
  1177. (pcase (plist-get info :odt-styles-file)
  1178. (`nil (expand-file-name "OrgOdtStyles.xml" org-odt-styles-dir))
  1179. ((and s (pred (string-match-p "\\`(.*)\\'")))
  1180. (condition-case nil
  1181. (read s)
  1182. (error (user-error "Invalid styles file specification: %S" s))))
  1183. (filename (org-strip-quotes filename)))))
  1184. (cond
  1185. ;; Non-availability of styles.xml is not a critical error. For
  1186. ;; now, throw an error.
  1187. ((null styles-file) (error "Missing styles file"))
  1188. ((listp styles-file)
  1189. (let ((archive (nth 0 styles-file))
  1190. (members (nth 1 styles-file)))
  1191. (org-odt--zip-extract archive members org-odt-zip-dir)
  1192. (dolist (member members)
  1193. (when (org-file-image-p member)
  1194. (let* ((image-type (file-name-extension member))
  1195. (media-type (format "image/%s" image-type)))
  1196. (org-odt-create-manifest-file-entry media-type member))))))
  1197. ((file-exists-p styles-file)
  1198. (let ((styles-file-type (file-name-extension styles-file)))
  1199. (cond
  1200. ((string= styles-file-type "xml")
  1201. (copy-file styles-file (concat org-odt-zip-dir "styles.xml") t))
  1202. ((member styles-file-type '("odt" "ott"))
  1203. (org-odt--zip-extract styles-file "styles.xml" org-odt-zip-dir)))))
  1204. (t
  1205. (error "Invalid specification of styles.xml file: %S"
  1206. (plist-get info :odt-styles-file))))
  1207. ;; create a manifest entry for styles.xml
  1208. (org-odt-create-manifest-file-entry "text/xml" "styles.xml")
  1209. ;; FIXME: Who is opening an empty styles.xml before this point?
  1210. (with-current-buffer
  1211. (find-file-noselect (concat org-odt-zip-dir "styles.xml") t)
  1212. (revert-buffer t t)
  1213. ;; Write custom styles for source blocks
  1214. ;; Save STYLES used for colorizing of source blocks.
  1215. ;; Update styles.xml with styles that were collected as part of
  1216. ;; `org-odt-hfy-face-to-css' callbacks.
  1217. (let ((styles (mapconcat (lambda (style) (format " %s\n" (cddr style)))
  1218. hfy-user-sheet-assoc "")))
  1219. (when styles
  1220. (goto-char (point-min))
  1221. (when (re-search-forward "</office:styles>" nil t)
  1222. (goto-char (match-beginning 0))
  1223. (insert "\n<!-- Org Htmlfontify Styles -->\n" styles "\n"))))
  1224. ;; Update styles.xml - take care of outline numbering
  1225. ;; Don't make automatic backup of styles.xml file. This setting
  1226. ;; prevents the backed-up styles.xml file from being zipped in to
  1227. ;; odt file. This is more of a hackish fix. Better alternative
  1228. ;; would be to fix the zip command so that the output odt file
  1229. ;; includes only the needed files and excludes any auto-generated
  1230. ;; extra files like backups and auto-saves etc etc. Note that
  1231. ;; currently the zip command zips up the entire temp directory so
  1232. ;; that any auto-generated files created under the hood ends up in
  1233. ;; the resulting odt file.
  1234. (setq-local backup-inhibited t)
  1235. ;; Outline numbering is retained only upto LEVEL.
  1236. ;; To disable outline numbering pass a LEVEL of 0.
  1237. (goto-char (point-min))
  1238. (let ((regex
  1239. "<text:outline-level-style\\([^>]*\\)text:level=\"\\([^\"]*\\)\"\\([^>]*\\)>")
  1240. (replacement
  1241. "<text:outline-level-style\\1text:level=\"\\2\" style:num-format=\"\">"))
  1242. (while (re-search-forward regex nil t)
  1243. (unless (let ((sec-num (plist-get info :section-numbers))
  1244. (level (string-to-number (match-string 2))))
  1245. (if (wholenump sec-num) (<= level sec-num) sec-num))
  1246. (replace-match replacement t nil))))
  1247. (save-buffer 0)))
  1248. ;; Update content.xml.
  1249. (let* ( ;; `org-display-custom-times' should be accessed right
  1250. ;; within the context of the Org buffer. So obtain its
  1251. ;; value before moving on to temp-buffer context down below.
  1252. (custom-time-fmts
  1253. (if org-display-custom-times
  1254. (cons (substring (car org-time-stamp-custom-formats) 1 -1)
  1255. (substring (cdr org-time-stamp-custom-formats) 1 -1))
  1256. '("%Y-%M-%d %a" . "%Y-%M-%d %a %H:%M"))))
  1257. (with-temp-buffer
  1258. (insert-file-contents
  1259. (or (plist-get info :odt-content-template-file)
  1260. (expand-file-name "OrgOdtContentTemplate.xml"
  1261. org-odt-styles-dir)))
  1262. ;; Write automatic styles.
  1263. ;; - Position the cursor.
  1264. (goto-char (point-min))
  1265. (re-search-forward " </office:automatic-styles>" nil t)
  1266. (goto-char (match-beginning 0))
  1267. ;; - Dump automatic table styles.
  1268. (cl-loop for (style-name props) in
  1269. (plist-get org-odt-automatic-styles 'Table) do
  1270. (when (setq props (or (plist-get props :rel-width) "96"))
  1271. (insert (format org-odt-table-style-format style-name props))))
  1272. ;; - Dump date-styles.
  1273. (when (plist-get info :odt-use-date-fields)
  1274. (insert (org-odt--build-date-styles (car custom-time-fmts)
  1275. "OrgDate1")
  1276. (org-odt--build-date-styles (cdr custom-time-fmts)
  1277. "OrgDate2")))
  1278. ;; Update display level.
  1279. ;; - Remove existing sequence decls. Also position the cursor.
  1280. (goto-char (point-min))
  1281. (when (re-search-forward "<text:sequence-decls" nil t)
  1282. (delete-region (match-beginning 0)
  1283. (re-search-forward "</text:sequence-decls>" nil nil)))
  1284. ;; Update sequence decls according to user preference.
  1285. (insert
  1286. (format
  1287. "\n<text:sequence-decls>\n%s\n</text:sequence-decls>"
  1288. (mapconcat
  1289. (lambda (x)
  1290. (format
  1291. "<text:sequence-decl text:display-outline-level=\"%d\" text:name=\"%s\"/>"
  1292. (plist-get info :odt-display-outline-level)
  1293. (nth 1 x)))
  1294. org-odt-category-map-alist "\n")))
  1295. ;; Position the cursor to document body.
  1296. (goto-char (point-min))
  1297. (re-search-forward "</office:text>" nil nil)
  1298. (goto-char (match-beginning 0))
  1299. ;; Preamble - Title, Author, Date etc.
  1300. (insert
  1301. (let* ((title (and (plist-get info :with-title)
  1302. (org-export-data (plist-get info :title) info)))
  1303. (subtitle (when title
  1304. (org-export-data (plist-get info :subtitle) info)))
  1305. (author (and (plist-get info :with-author)
  1306. (let ((auth (plist-get info :author)))
  1307. (and auth (org-export-data auth info)))))
  1308. (email (plist-get info :email))
  1309. ;; Switch on or off above vars based on user settings
  1310. (author (and (plist-get info :with-author) (or author email)))
  1311. (email (and (plist-get info :with-email) email)))
  1312. (concat
  1313. ;; Title.
  1314. (when (org-string-nw-p title)
  1315. (concat
  1316. (format "\n<text:p text:style-name=\"%s\">%s</text:p>\n"
  1317. "OrgTitle" (format "\n<text:title>%s</text:title>" title))
  1318. ;; Separator.
  1319. "\n<text:p text:style-name=\"OrgTitle\"/>\n"
  1320. ;; Subtitle.
  1321. (when (org-string-nw-p subtitle)
  1322. (concat
  1323. (format "<text:p text:style-name=\"OrgSubtitle\">\n%s\n</text:p>\n"
  1324. (concat
  1325. "<text:user-defined style:data-style-name=\"N0\" text:name=\"subtitle\">\n"
  1326. subtitle
  1327. "</text:user-defined>\n"))
  1328. ;; Separator.
  1329. "<text:p text:style-name=\"OrgSubtitle\"/>\n"))))
  1330. (cond
  1331. ((and author (not email))
  1332. ;; Author only.
  1333. (concat
  1334. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1335. "OrgSubtitle"
  1336. (format "<text:initial-creator>%s</text:initial-creator>" author))
  1337. ;; Separator.
  1338. "\n<text:p text:style-name=\"OrgSubtitle\"/>"))
  1339. ((and author email)
  1340. ;; Author and E-mail.
  1341. (concat
  1342. (format
  1343. "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1344. "OrgSubtitle"
  1345. (format
  1346. "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
  1347. (concat "mailto:" email)
  1348. (format "<text:initial-creator>%s</text:initial-creator>" author)))
  1349. ;; Separator.
  1350. "\n<text:p text:style-name=\"OrgSubtitle\"/>")))
  1351. ;; Date, if required.
  1352. (when (plist-get info :with-date)
  1353. (let* ((date (plist-get info :date))
  1354. ;; Check if DATE is specified as a timestamp.
  1355. (timestamp (and (not (cdr date))
  1356. (eq (org-element-type (car date)) 'timestamp)
  1357. (car date))))
  1358. (when date
  1359. (concat
  1360. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1361. "OrgSubtitle"
  1362. (if (and (plist-get info :odt-use-date-fields) timestamp)
  1363. (org-odt--format-timestamp (car date))
  1364. (org-export-data date info)))
  1365. ;; Separator
  1366. "<text:p text:style-name=\"OrgSubtitle\"/>")))))))
  1367. ;; Table of Contents
  1368. (let* ((with-toc (plist-get info :with-toc))
  1369. (depth (and with-toc (if (wholenump with-toc)
  1370. with-toc
  1371. (plist-get info :headline-levels)))))
  1372. (when depth (insert (or (org-odt-toc depth info) ""))))
  1373. ;; Contents.
  1374. (insert contents)
  1375. ;; Return contents.
  1376. (buffer-substring-no-properties (point-min) (point-max)))))
  1377. ;;; Transcode Functions
  1378. ;;;; Bold
  1379. (defun org-odt-bold (_bold contents _info)
  1380. "Transcode BOLD from Org to ODT.
  1381. CONTENTS is the text with bold markup. INFO is a plist holding
  1382. contextual information."
  1383. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1384. "Bold" contents))
  1385. ;;;; Center Block
  1386. (defun org-odt-center-block (_center-block contents _info)
  1387. "Transcode a CENTER-BLOCK element from Org to ODT.
  1388. CONTENTS holds the contents of the center block. INFO is a plist
  1389. holding contextual information."
  1390. contents)
  1391. ;;;; Clock
  1392. (defun org-odt-clock (clock contents info)
  1393. "Transcode a CLOCK element from Org to ODT.
  1394. CONTENTS is nil. INFO is a plist used as a communication
  1395. channel."
  1396. (let ((timestamp (org-element-property :value clock))
  1397. (duration (org-element-property :duration clock)))
  1398. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1399. (if (eq (org-element-type (org-export-get-next-element clock info))
  1400. 'clock) "OrgClock" "OrgClockLastLine")
  1401. (concat
  1402. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1403. "OrgClockKeyword" org-clock-string)
  1404. (org-odt-timestamp timestamp contents info)
  1405. (and duration (format " (%s)" duration))))))
  1406. ;;;; Code
  1407. (defun org-odt-code (code _contents _info)
  1408. "Transcode a CODE object from Org to ODT.
  1409. CONTENTS is nil. INFO is a plist used as a communication
  1410. channel."
  1411. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1412. "OrgCode" (org-odt--encode-plain-text
  1413. (org-element-property :value code))))
  1414. ;;;; Drawer
  1415. (defun org-odt-drawer (drawer contents info)
  1416. "Transcode a DRAWER element from Org to ODT.
  1417. CONTENTS holds the contents of the block. INFO is a plist
  1418. holding contextual information."
  1419. (let* ((name (org-element-property :drawer-name drawer))
  1420. (output (funcall (plist-get info :odt-format-drawer-function)
  1421. name contents)))
  1422. output))
  1423. ;;;; Dynamic Block
  1424. (defun org-odt-dynamic-block (_dynamic-block contents _info)
  1425. "Transcode a DYNAMIC-BLOCK element from Org to ODT.
  1426. CONTENTS holds the contents of the block. INFO is a plist
  1427. holding contextual information. See `org-export-data'."
  1428. contents)
  1429. ;;;; Entity
  1430. (defun org-odt-entity (entity _contents _info)
  1431. "Transcode an ENTITY object from Org to ODT.
  1432. CONTENTS are the definition itself. INFO is a plist holding
  1433. contextual information."
  1434. (org-element-property :utf-8 entity))
  1435. ;;;; Example Block
  1436. (defun org-odt-example-block (example-block _contents info)
  1437. "Transcode a EXAMPLE-BLOCK element from Org to ODT.
  1438. CONTENTS is nil. INFO is a plist holding contextual information."
  1439. (org-odt-format-code example-block info))
  1440. ;;;; Export Snippet
  1441. (defun org-odt-export-snippet (export-snippet _contents _info)
  1442. "Transcode a EXPORT-SNIPPET object from Org to ODT.
  1443. CONTENTS is nil. INFO is a plist holding contextual information."
  1444. (when (eq (org-export-snippet-backend export-snippet) 'odt)
  1445. (org-element-property :value export-snippet)))
  1446. ;;;; Export Block
  1447. (defun org-odt-export-block (export-block _contents _info)
  1448. "Transcode a EXPORT-BLOCK element from Org to ODT.
  1449. CONTENTS is nil. INFO is a plist holding contextual information."
  1450. (when (string= (org-element-property :type export-block) "ODT")
  1451. (org-remove-indentation (org-element-property :value export-block))))
  1452. ;;;; Fixed Width
  1453. (defun org-odt-fixed-width (fixed-width _contents info)
  1454. "Transcode a FIXED-WIDTH element from Org to ODT.
  1455. CONTENTS is nil. INFO is a plist holding contextual information."
  1456. (org-odt-do-format-code (org-element-property :value fixed-width) info))
  1457. ;;;; Footnote Definition
  1458. ;; Footnote Definitions are ignored.
  1459. ;;;; Footnote Reference
  1460. (defun org-odt-footnote-reference (footnote-reference _contents info)
  1461. "Transcode a FOOTNOTE-REFERENCE element from Org to ODT.
  1462. CONTENTS is nil. INFO is a plist holding contextual information."
  1463. (let ((--format-footnote-definition
  1464. (lambda (n def)
  1465. (setq n (format "%d" n))
  1466. (let ((id (concat "fn" n))
  1467. (note-class "footnote"))
  1468. (format
  1469. "<text:note text:id=\"%s\" text:note-class=\"%s\">%s</text:note>"
  1470. id note-class
  1471. (concat
  1472. (format "<text:note-citation>%s</text:note-citation>" n)
  1473. (format "<text:note-body>%s</text:note-body>" def))))))
  1474. (--format-footnote-reference
  1475. (lambda (n)
  1476. (setq n (format "%d" n))
  1477. (let ((note-class "footnote")
  1478. (ref-format "text")
  1479. (ref-name (concat "fn" n)))
  1480. (format
  1481. "<text:span text:style-name=\"%s\">%s</text:span>"
  1482. "OrgSuperscript"
  1483. (format "<text:note-ref text:note-class=\"%s\" text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:note-ref>"
  1484. note-class ref-format ref-name n))))))
  1485. (concat
  1486. ;; Insert separator between two footnotes in a row.
  1487. (let ((prev (org-export-get-previous-element footnote-reference info)))
  1488. (and (eq (org-element-type prev) 'footnote-reference)
  1489. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1490. "OrgSuperscript" ",")))
  1491. ;; Transcode footnote reference.
  1492. (let ((n (org-export-get-footnote-number footnote-reference info nil t)))
  1493. (cond
  1494. ((not
  1495. (org-export-footnote-first-reference-p footnote-reference info nil t))
  1496. (funcall --format-footnote-reference n))
  1497. (t
  1498. (let* ((raw (org-export-get-footnote-definition
  1499. footnote-reference info))
  1500. (def
  1501. (let ((def (org-trim
  1502. (org-export-data-with-backend
  1503. raw
  1504. (org-export-create-backend
  1505. :parent 'odt
  1506. :transcoders
  1507. '((paragraph . (lambda (p c i)
  1508. (org-odt--format-paragraph
  1509. p c i
  1510. "Footnote"
  1511. "OrgFootnoteCenter"
  1512. "OrgFootnoteQuotations")))))
  1513. info))))
  1514. ;; Inline definitions are secondary strings. We
  1515. ;; need to wrap them within a paragraph.
  1516. (if (eq (org-element-class (car (org-element-contents raw)))
  1517. 'element)
  1518. def
  1519. (format
  1520. "\n<text:p text:style-name=\"Footnote\">%s</text:p>"
  1521. def)))))
  1522. (funcall --format-footnote-definition n def))))))))
  1523. ;;;; Headline
  1524. (defun org-odt-format-headline--wrap (headline backend info
  1525. &optional format-function
  1526. &rest extra-keys)
  1527. "Transcode a HEADLINE element using BACKEND.
  1528. INFO is a plist holding contextual information."
  1529. (setq backend (or backend (plist-get info :back-end)))
  1530. (let* ((level (+ (org-export-get-relative-level headline info)))
  1531. (headline-number (org-export-get-headline-number headline info))
  1532. (section-number (and (org-export-numbered-headline-p headline info)
  1533. (mapconcat 'number-to-string
  1534. headline-number ".")))
  1535. (todo (and (plist-get info :with-todo-keywords)
  1536. (let ((todo (org-element-property :todo-keyword headline)))
  1537. (and todo
  1538. (org-export-data-with-backend todo backend info)))))
  1539. (todo-type (and todo (org-element-property :todo-type headline)))
  1540. (priority (and (plist-get info :with-priority)
  1541. (org-element-property :priority headline)))
  1542. (text (org-export-data-with-backend
  1543. (org-element-property :title headline) backend info))
  1544. (tags (and (plist-get info :with-tags)
  1545. (org-export-get-tags headline info)))
  1546. (headline-label (org-export-get-reference headline info))
  1547. (format-function
  1548. (if (functionp format-function) format-function
  1549. (cl-function
  1550. (lambda (todo todo-type priority text tags
  1551. &key _level _section-number _headline-label
  1552. &allow-other-keys)
  1553. (funcall (plist-get info :odt-format-headline-function)
  1554. todo todo-type priority text tags))))))
  1555. (apply format-function
  1556. todo todo-type priority text tags
  1557. :headline-label headline-label
  1558. :level level
  1559. :section-number section-number extra-keys)))
  1560. (defun org-odt-headline (headline contents info)
  1561. "Transcode a HEADLINE element from Org to ODT.
  1562. CONTENTS holds the contents of the headline. INFO is a plist
  1563. holding contextual information."
  1564. ;; Case 1: This is a footnote section: ignore it.
  1565. (unless (org-element-property :footnote-section-p headline)
  1566. (let* ((full-text (org-odt-format-headline--wrap headline nil info))
  1567. ;; Get level relative to current parsed data.
  1568. (level (org-export-get-relative-level headline info))
  1569. (numbered (org-export-numbered-headline-p headline info))
  1570. ;; Get canonical label for the headline.
  1571. (id (org-export-get-reference headline info))
  1572. ;; Extra targets.
  1573. (extra-targets
  1574. (let ((id (org-element-property :ID headline)))
  1575. (if id (org-odt--target "" (concat "ID-" id)) "")))
  1576. ;; Title.
  1577. (anchored-title (org-odt--target full-text id)))
  1578. (cond
  1579. ;; Case 2. This is a deep sub-tree: export it as a list item.
  1580. ;; Also export as items headlines for which no section
  1581. ;; format has been found.
  1582. ((org-export-low-level-p headline info)
  1583. ;; Build the real contents of the sub-tree.
  1584. (concat
  1585. (and (org-export-first-sibling-p headline info)
  1586. (format "\n<text:list text:style-name=\"%s\" %s>"
  1587. ;; Choose style based on list type.
  1588. (if numbered "OrgNumberedList" "OrgBulletedList")
  1589. ;; If top-level list, re-start numbering. Otherwise,
  1590. ;; continue numbering.
  1591. (format "text:continue-numbering=\"%s\""
  1592. (let* ((parent (org-export-get-parent-headline
  1593. headline)))
  1594. (if (and parent
  1595. (org-export-low-level-p parent info))
  1596. "true" "false")))))
  1597. (let ((headline-has-table-p
  1598. (let ((section (assq 'section (org-element-contents headline))))
  1599. (assq 'table (and section (org-element-contents section))))))
  1600. (format "\n<text:list-item>\n%s\n%s"
  1601. (concat
  1602. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1603. "Text_20_body"
  1604. (concat extra-targets anchored-title))
  1605. contents)
  1606. (if headline-has-table-p
  1607. "</text:list-header>"
  1608. "</text:list-item>")))
  1609. (and (org-export-last-sibling-p headline info)
  1610. "</text:list>")))
  1611. ;; Case 3. Standard headline. Export it as a section.
  1612. (t
  1613. (concat
  1614. (format
  1615. "\n<text:h text:style-name=\"%s\" text:outline-level=\"%s\" text:is-list-header=\"%s\">%s</text:h>"
  1616. (format "Heading_20_%s%s"
  1617. level (if numbered "" "_unnumbered"))
  1618. level
  1619. (if numbered "false" "true")
  1620. (concat extra-targets anchored-title))
  1621. contents))))))
  1622. (defun org-odt-format-headline-default-function
  1623. (todo todo-type priority text tags)
  1624. "Default format function for a headline.
  1625. See `org-odt-format-headline-function' for details."
  1626. (concat
  1627. ;; Todo.
  1628. (when todo
  1629. (let ((style (if (eq todo-type 'done) "OrgDone" "OrgTodo")))
  1630. (format "<text:span text:style-name=\"%s\">%s</text:span> " style todo)))
  1631. (when priority
  1632. (let* ((style (format "OrgPriority-%c" priority))
  1633. (priority (format "[#%c]" priority)))
  1634. (format "<text:span text:style-name=\"%s\">%s</text:span> "
  1635. style priority)))
  1636. ;; Title.
  1637. text
  1638. ;; Tags.
  1639. (when tags
  1640. (concat
  1641. "<text:tab/>"
  1642. (format "<text:span text:style-name=\"%s\">[%s]</text:span>"
  1643. "OrgTags" (mapconcat
  1644. (lambda (tag)
  1645. (format
  1646. "<text:span text:style-name=\"%s\">%s</text:span>"
  1647. "OrgTag" tag)) tags " : "))))))
  1648. ;;;; Horizontal Rule
  1649. (defun org-odt-horizontal-rule (_horizontal-rule _contents _info)
  1650. "Transcode an HORIZONTAL-RULE object from Org to ODT.
  1651. CONTENTS is nil. INFO is a plist holding contextual information."
  1652. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1653. "Horizontal_20_Line" ""))
  1654. ;;;; Inline Babel Call
  1655. ;; Inline Babel Calls are ignored.
  1656. ;;;; Inline Src Block
  1657. (defun org-odt--find-verb-separator (s)
  1658. "Return a character not used in string S.
  1659. This is used to choose a separator for constructs like \\verb."
  1660. (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
  1661. (cl-loop for c across ll
  1662. when (not (string-match (regexp-quote (char-to-string c)) s))
  1663. return (char-to-string c))))
  1664. (defun org-odt-inline-src-block (_inline-src-block _contents _info)
  1665. "Transcode an INLINE-SRC-BLOCK element from Org to ODT.
  1666. CONTENTS holds the contents of the item. INFO is a plist holding
  1667. contextual information."
  1668. (error "FIXME"))
  1669. ;;;; Inlinetask
  1670. (defun org-odt-inlinetask (inlinetask contents info)
  1671. "Transcode an INLINETASK element from Org to ODT.
  1672. CONTENTS holds the contents of the block. INFO is a plist
  1673. holding contextual information."
  1674. (let* ((todo
  1675. (and (plist-get info :with-todo-keywords)
  1676. (let ((todo (org-element-property :todo-keyword inlinetask)))
  1677. (and todo (org-export-data todo info)))))
  1678. (todo-type (and todo (org-element-property :todo-type inlinetask)))
  1679. (priority (and (plist-get info :with-priority)
  1680. (org-element-property :priority inlinetask)))
  1681. (text (org-export-data (org-element-property :title inlinetask) info))
  1682. (tags (and (plist-get info :with-tags)
  1683. (org-export-get-tags inlinetask info))))
  1684. (funcall (plist-get info :odt-format-inlinetask-function)
  1685. todo todo-type priority text tags contents)))
  1686. (defun org-odt-format-inlinetask-default-function
  1687. (todo todo-type priority name tags contents)
  1688. "Default format function for inlinetasks.
  1689. See `org-odt-format-inlinetask-function' for details."
  1690. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1691. "Text_20_body"
  1692. (org-odt--textbox
  1693. (concat
  1694. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  1695. "OrgInlineTaskHeading"
  1696. (org-odt-format-headline-default-function
  1697. todo todo-type priority name tags))
  1698. contents)
  1699. nil nil "OrgInlineTaskFrame" " style:rel-width=\"100%\"")))
  1700. ;;;; Italic
  1701. (defun org-odt-italic (_italic contents _info)
  1702. "Transcode ITALIC from Org to ODT.
  1703. CONTENTS is the text with italic markup. INFO is a plist holding
  1704. contextual information."
  1705. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1706. "Emphasis" contents))
  1707. ;;;; Item
  1708. (defun org-odt-item (item contents info)
  1709. "Transcode an ITEM element from Org to ODT.
  1710. CONTENTS holds the contents of the item. INFO is a plist holding
  1711. contextual information."
  1712. (let* ((plain-list (org-export-get-parent item))
  1713. (type (org-element-property :type plain-list)))
  1714. (unless (memq type '(ordered unordered descriptive-1 descriptive-2))
  1715. (error "Unknown list type: %S" type))
  1716. (format "\n<text:list-item>\n%s\n%s"
  1717. contents
  1718. (if (org-element-map item 'table #'identity info 'first-match)
  1719. "</text:list-header>"
  1720. "</text:list-item>"))))
  1721. ;;;; Keyword
  1722. (defun org-odt-keyword (keyword _contents info)
  1723. "Transcode a KEYWORD element from Org to ODT.
  1724. CONTENTS is nil. INFO is a plist holding contextual
  1725. information."
  1726. (let ((key (org-element-property :key keyword))
  1727. (value (org-element-property :value keyword)))
  1728. (cond
  1729. ((string= key "ODT") value)
  1730. ((string= key "INDEX")
  1731. ;; FIXME
  1732. (ignore))
  1733. ((string= key "TOC")
  1734. (let ((case-fold-search t))
  1735. (cond
  1736. ((string-match-p "\\<headlines\\>" value)
  1737. (let ((depth (or (and (string-match "\\<[0-9]+\\>" value)
  1738. (string-to-number (match-string 0 value)))
  1739. (plist-get info :headline-levels)))
  1740. (localp (string-match-p "\\<local\\>" value)))
  1741. (org-odt-toc depth info (and localp keyword))))
  1742. ((string-match-p "tables\\|figures\\|listings" value)
  1743. ;; FIXME
  1744. (ignore))))))))
  1745. ;;;; Latex Environment
  1746. ;; (eval-after-load 'ox-odt '(ad-deactivate 'org-format-latex-as-mathml))
  1747. ;; (defadvice org-format-latex-as-mathml ; FIXME
  1748. ;; (after org-odt-protect-latex-fragment activate)
  1749. ;; "Encode LaTeX fragment as XML.
  1750. ;; Do this when translation to MathML fails."
  1751. ;; (unless (> (length ad-return-value) 0)
  1752. ;; (setq ad-return-value (org-odt--encode-plain-text (ad-get-arg 0)))))
  1753. (defun org-odt-latex-environment (latex-environment _contents info)
  1754. "Transcode a LATEX-ENVIRONMENT element from Org to ODT.
  1755. CONTENTS is nil. INFO is a plist holding contextual information."
  1756. (let* ((latex-frag (org-remove-indentation
  1757. (org-element-property :value latex-environment))))
  1758. (org-odt-do-format-code latex-frag info)))
  1759. ;;;; Latex Fragment
  1760. ;; (when latex-frag ; FIXME
  1761. ;; (setq href (propertize href :title "LaTeX Fragment"
  1762. ;; :description latex-frag)))
  1763. ;; handle verbatim
  1764. ;; provide descriptions
  1765. (defun org-odt-latex-fragment (latex-fragment _contents _info)
  1766. "Transcode a LATEX-FRAGMENT object from Org to ODT.
  1767. CONTENTS is nil. INFO is a plist holding contextual information."
  1768. (let ((latex-frag (org-element-property :value latex-fragment)))
  1769. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  1770. "OrgCode" (org-odt--encode-plain-text latex-frag t))))
  1771. ;;;; Line Break
  1772. (defun org-odt-line-break (_line-break _contents _info)
  1773. "Transcode a LINE-BREAK object from Org to ODT.
  1774. CONTENTS is nil. INFO is a plist holding contextual information."
  1775. "<text:line-break/>")
  1776. ;;;; Link
  1777. ;;;; Links :: Label references
  1778. (defun org-odt--enumerate (element info &optional predicate n)
  1779. (when predicate (cl-assert (funcall predicate element info)))
  1780. (let* ((--numbered-parent-headline-at-<=-n
  1781. (lambda (element n info)
  1782. (cl-loop for x in (org-element-lineage element)
  1783. thereis (and (eq (org-element-type x) 'headline)
  1784. (<= (org-export-get-relative-level x info) n)
  1785. (org-export-numbered-headline-p x info)
  1786. x))))
  1787. (--enumerate
  1788. (lambda (element scope info &optional predicate)
  1789. (let ((counter 0))
  1790. (org-element-map (or scope (plist-get info :parse-tree))
  1791. (org-element-type element)
  1792. (lambda (el)
  1793. (and (or (not predicate) (funcall predicate el info))
  1794. (cl-incf counter)
  1795. (eq element el)
  1796. counter))
  1797. info 'first-match))))
  1798. (scope (funcall --numbered-parent-headline-at-<=-n
  1799. element
  1800. (or n (plist-get info :odt-display-outline-level))
  1801. info))
  1802. (ordinal (funcall --enumerate element scope info predicate))
  1803. (tag
  1804. (concat
  1805. ;; Section number.
  1806. (and scope
  1807. (mapconcat 'number-to-string
  1808. (org-export-get-headline-number scope info) "."))
  1809. ;; Separator.
  1810. (and scope ".")
  1811. ;; Ordinal.
  1812. (number-to-string ordinal))))
  1813. tag))
  1814. (defun org-odt-format-label (element info op)
  1815. "Return a label for ELEMENT.
  1816. ELEMENT is a `link', `table', `src-block' or `paragraph' type
  1817. element. INFO is a plist used as a communication channel. OP is
  1818. either `definition' or `reference', depending on the purpose of
  1819. the generated string.
  1820. Return value is a string if OP is set to `reference' or a cons
  1821. cell like CAPTION . SHORT-CAPTION) where CAPTION and
  1822. SHORT-CAPTION are strings."
  1823. (cl-assert (memq (org-element-type element) '(link table src-block paragraph)))
  1824. (let* ((element-or-parent
  1825. (cl-case (org-element-type element)
  1826. (link (org-export-get-parent-element element))
  1827. (t element)))
  1828. ;; Get label and caption.
  1829. (label (and (or (org-element-property :name element)
  1830. (org-element-property :name element-or-parent))
  1831. (org-export-get-reference element-or-parent info)))
  1832. (caption (let ((c (org-export-get-caption element-or-parent)))
  1833. (and c (org-export-data c info))))
  1834. ;; FIXME: We don't use short-caption for now
  1835. (short-caption nil))
  1836. (when (or label caption)
  1837. (let* ((default-category
  1838. (cl-case (org-element-type element)
  1839. (table "__Table__")
  1840. (src-block "__Listing__")
  1841. ((link paragraph)
  1842. (cond
  1843. ((org-odt--enumerable-latex-image-p element info)
  1844. "__DvipngImage__")
  1845. ((org-odt--enumerable-image-p element info)
  1846. "__Figure__")
  1847. ((org-odt--enumerable-formula-p element info)
  1848. "__MathFormula__")
  1849. (t (error "Don't know how to format label for link: %S"
  1850. element))))
  1851. (t (error "Don't know how to format label for element type: %s"
  1852. (org-element-type element)))))
  1853. seqno)
  1854. (cl-assert default-category)
  1855. (pcase-let
  1856. ((`(,counter ,label-style ,category ,predicate)
  1857. (assoc-default default-category org-odt-category-map-alist)))
  1858. ;; Compute sequence number of the element.
  1859. (setq seqno (org-odt--enumerate element info predicate))
  1860. ;; Localize category string.
  1861. (setq category (org-export-translate category :utf-8 info))
  1862. (cl-case op
  1863. ;; Case 1: Handle Label definition.
  1864. (definition
  1865. (cons
  1866. (concat
  1867. ;; Sneak in a bookmark. The bookmark is used when the
  1868. ;; labeled element is referenced with a link that
  1869. ;; provides its own description.
  1870. (format "\n<text:bookmark text:name=\"%s\"/>" label)
  1871. ;; Label definition: Typically formatted as below:
  1872. ;; CATEGORY SEQ-NO: LONG CAPTION
  1873. ;; with translation for correct punctuation.
  1874. (format-spec
  1875. (org-export-translate
  1876. (cadr (assoc-string label-style org-odt-label-styles t))
  1877. :utf-8 info)
  1878. `((?e . ,category)
  1879. (?n . ,(format
  1880. "<text:sequence text:ref-name=\"%s\" text:name=\"%s\" text:formula=\"ooow:%s+1\" style:num-format=\"1\">%s</text:sequence>"
  1881. label counter counter seqno))
  1882. (?c . ,(or caption "")))))
  1883. short-caption))
  1884. ;; Case 2: Handle Label reference.
  1885. (reference
  1886. (let* ((fmt (cddr (assoc-string label-style org-odt-label-styles t)))
  1887. (fmt1 (car fmt))
  1888. (fmt2 (cadr fmt)))
  1889. (format "<text:sequence-ref text:reference-format=\"%s\" text:ref-name=\"%s\">%s</text:sequence-ref>"
  1890. fmt1
  1891. label
  1892. (format-spec fmt2 `((?e . ,category) (?n . ,seqno))))))
  1893. (t (error "Unknown %S on label" op))))))))
  1894. ;;;; Links :: Inline Images
  1895. (defun org-odt--copy-image-file (path)
  1896. "Returns the internal name of the file"
  1897. (let* ((image-type (file-name-extension path))
  1898. (media-type (format "image/%s" image-type))
  1899. (target-dir "Images/")
  1900. (target-file
  1901. (format "%s%04d.%s" target-dir
  1902. (cl-incf org-odt-embedded-images-count) image-type)))
  1903. (message "Embedding %s as %s..."
  1904. (substring-no-properties path) target-file)
  1905. (when (= 1 org-odt-embedded-images-count)
  1906. (make-directory (concat org-odt-zip-dir target-dir))
  1907. (org-odt-create-manifest-file-entry "" target-dir))
  1908. (copy-file path (concat org-odt-zip-dir target-file) 'overwrite)
  1909. (org-odt-create-manifest-file-entry media-type target-file)
  1910. target-file))
  1911. ;; For --without-x builds.
  1912. (declare-function clear-image-cache "image.c" (&optional filter))
  1913. (declare-function image-size "image.c" (spec &optional pixels frame))
  1914. (defun org-odt--image-size
  1915. (file info &optional user-width user-height scale dpi embed-as)
  1916. (let* ((--pixels-to-cms
  1917. (function (lambda (pixels dpi)
  1918. (let ((cms-per-inch 2.54)
  1919. (inches (/ pixels dpi)))
  1920. (* cms-per-inch inches)))))
  1921. (--size-in-cms
  1922. (function
  1923. (lambda (size-in-pixels dpi)
  1924. (and size-in-pixels
  1925. (cons (funcall --pixels-to-cms (car size-in-pixels) dpi)
  1926. (funcall --pixels-to-cms (cdr size-in-pixels) dpi))))))
  1927. (dpi (or dpi (plist-get info :odt-pixels-per-inch)))
  1928. (anchor-type (or embed-as "paragraph"))
  1929. (user-width (and (not scale) user-width))
  1930. (user-height (and (not scale) user-height))
  1931. (size
  1932. (and
  1933. (not (and user-height user-width))
  1934. (or
  1935. ;; Use Imagemagick.
  1936. (and (executable-find "identify")
  1937. (let ((size-in-pixels
  1938. (let ((dim (shell-command-to-string
  1939. (format "identify -format \"%%w:%%h\" \"%s\""
  1940. file))))
  1941. (when (string-match "\\([0-9]+\\):\\([0-9]+\\)" dim)
  1942. (cons (string-to-number (match-string 1 dim))
  1943. (string-to-number (match-string 2 dim)))))))
  1944. (funcall --size-in-cms size-in-pixels dpi)))
  1945. ;; Use Emacs.
  1946. (let ((size-in-pixels
  1947. (ignore-errors ; Emacs could be in batch mode
  1948. (clear-image-cache)
  1949. (image-size (create-image file) 'pixels))))
  1950. (funcall --size-in-cms size-in-pixels dpi))
  1951. ;; Use hard-coded values.
  1952. (cdr (assoc-string anchor-type
  1953. org-odt-default-image-sizes-alist))
  1954. ;; Error out.
  1955. (error "Cannot determine image size, aborting"))))
  1956. (width (car size)) (height (cdr size)))
  1957. (cond
  1958. (scale
  1959. (setq width (* width scale) height (* height scale)))
  1960. ((and user-height user-width)
  1961. (setq width user-width height user-height))
  1962. (user-height
  1963. (setq width (* user-height (/ width height)) height user-height))
  1964. (user-width
  1965. (setq height (* user-width (/ height width)) width user-width))
  1966. (t (ignore)))
  1967. ;; ensure that an embedded image fits comfortably within a page
  1968. (let ((max-width (car org-odt-max-image-size))
  1969. (max-height (cdr org-odt-max-image-size)))
  1970. (when (or (> width max-width) (> height max-height))
  1971. (let* ((scale1 (/ max-width width))
  1972. (scale2 (/ max-height height))
  1973. (scale (min scale1 scale2)))
  1974. (setq width (* scale width) height (* scale height)))))
  1975. (cons width height)))
  1976. (defun org-odt-link--inline-image (element info)
  1977. "Return ODT code for an inline image.
  1978. LINK is the link pointing to the inline image. INFO is a plist
  1979. used as a communication channel."
  1980. (cl-assert (eq (org-element-type element) 'link))
  1981. (let* ((src (let* ((type (org-element-property :type element))
  1982. (raw-path (org-element-property :path element)))
  1983. (cond ((member type '("http" "https"))
  1984. (concat type ":" raw-path))
  1985. ((file-name-absolute-p raw-path)
  1986. (expand-file-name raw-path))
  1987. (t raw-path))))
  1988. (src-expanded (if (file-name-absolute-p src) src
  1989. (expand-file-name src (file-name-directory
  1990. (plist-get info :input-file)))))
  1991. (href (format
  1992. "\n<draw:image xlink:href=\"%s\" xlink:type=\"simple\" xlink:show=\"embed\" xlink:actuate=\"onLoad\"/>"
  1993. (org-odt--copy-image-file src-expanded)))
  1994. ;; Extract attributes from #+ATTR_ODT line.
  1995. (attr-from (cl-case (org-element-type element)
  1996. (link (org-export-get-parent-element element))
  1997. (t element)))
  1998. ;; Convert attributes to a plist.
  1999. (attr-plist (org-export-read-attribute :attr_odt attr-from))
  2000. ;; Handle `:anchor', `:style' and `:attributes' properties.
  2001. (user-frame-anchor
  2002. (car (assoc-string (plist-get attr-plist :anchor)
  2003. '(("as-char") ("paragraph") ("page")) t)))
  2004. (user-frame-style
  2005. (and user-frame-anchor (plist-get attr-plist :style)))
  2006. (user-frame-attrs
  2007. (and user-frame-anchor (plist-get attr-plist :attributes)))
  2008. (user-frame-params
  2009. (list user-frame-style user-frame-attrs user-frame-anchor))
  2010. ;; (embed-as (or embed-as user-frame-anchor "paragraph"))
  2011. ;;
  2012. ;; Handle `:width', `:height' and `:scale' properties. Read
  2013. ;; them as numbers since we need them for computations.
  2014. (size (org-odt--image-size
  2015. src-expanded info
  2016. (let ((width (plist-get attr-plist :width)))
  2017. (and width (read width)))
  2018. (let ((length (plist-get attr-plist :length)))
  2019. (and length (read length)))
  2020. (let ((scale (plist-get attr-plist :scale)))
  2021. (and scale (read scale)))
  2022. nil ; embed-as
  2023. "paragraph" ; FIXME
  2024. ))
  2025. (width (car size)) (height (cdr size))
  2026. (standalone-link-p (org-odt--standalone-link-p element info))
  2027. (embed-as (if standalone-link-p "paragraph" "as-char"))
  2028. (captions (org-odt-format-label element info 'definition))
  2029. (caption (car captions))
  2030. (entity (concat (and caption "Captioned") embed-as "Image"))
  2031. ;; Check if this link was created by LaTeX-to-PNG converter.
  2032. (replaces (org-element-property
  2033. :replaces (if (not standalone-link-p) element
  2034. (org-export-get-parent-element element))))
  2035. ;; If yes, note down the type of the element - LaTeX Fragment
  2036. ;; or LaTeX environment. It will go in to frame title.
  2037. (title (and replaces (capitalize
  2038. (symbol-name (org-element-type replaces)))))
  2039. ;; If yes, note down its contents. It will go in to frame
  2040. ;; description. This quite useful for debugging.
  2041. (desc (and replaces (org-element-property :value replaces))))
  2042. (org-odt--render-image/formula entity href width height
  2043. captions user-frame-params title desc)))
  2044. ;;;; Links :: Math formula
  2045. (defun org-odt-link--inline-formula (element info)
  2046. (let* ((src (let ((raw-path (org-element-property :path element)))
  2047. (cond
  2048. ((file-name-absolute-p raw-path)
  2049. (expand-file-name raw-path))
  2050. (t raw-path))))
  2051. (src-expanded (if (file-name-absolute-p src) src
  2052. (expand-file-name src (file-name-directory
  2053. (plist-get info :input-file)))))
  2054. (href
  2055. (format
  2056. "\n<draw:object %s xlink:href=\"%s\" xlink:type=\"simple\"/>"
  2057. " xlink:show=\"embed\" xlink:actuate=\"onLoad\""
  2058. (file-name-directory (org-odt--copy-formula-file src-expanded))))
  2059. (standalone-link-p (org-odt--standalone-link-p element info))
  2060. (embed-as (if standalone-link-p 'paragraph 'character))
  2061. (captions (org-odt-format-label element info 'definition))
  2062. ;; Check if this link was created by LaTeX-to-MathML
  2063. ;; converter.
  2064. (replaces (org-element-property
  2065. :replaces (if (not standalone-link-p) element
  2066. (org-export-get-parent-element element))))
  2067. ;; If yes, note down the type of the element - LaTeX Fragment
  2068. ;; or LaTeX environment. It will go in to frame title.
  2069. (title (and replaces (capitalize
  2070. (symbol-name (org-element-type replaces)))))
  2071. ;; If yes, note down its contents. It will go in to frame
  2072. ;; description. This quite useful for debugging.
  2073. (desc (and replaces (org-element-property :value replaces)))
  2074. width height)
  2075. (cond
  2076. ((eq embed-as 'character)
  2077. (org-odt--render-image/formula "InlineFormula" href width height
  2078. nil nil title desc))
  2079. (t
  2080. (let* ((equation (org-odt--render-image/formula
  2081. "CaptionedDisplayFormula" href width height
  2082. captions nil title desc))
  2083. (label
  2084. (let* ((org-odt-category-map-alist
  2085. '(("__MathFormula__" "Text" "math-label" "Equation"
  2086. org-odt--enumerable-formula-p))))
  2087. (car (org-odt-format-label element info 'definition)))))
  2088. (concat equation "<text:tab/>" label))))))
  2089. (defun org-odt--copy-formula-file (src-file)
  2090. "Returns the internal name of the file"
  2091. (let* ((target-dir (format "Formula-%04d/"
  2092. (cl-incf org-odt-embedded-formulas-count)))
  2093. (target-file (concat target-dir "content.xml")))
  2094. ;; Create a directory for holding formula file. Also enter it in
  2095. ;; to manifest.
  2096. (make-directory (concat org-odt-zip-dir target-dir))
  2097. (org-odt-create-manifest-file-entry
  2098. "application/vnd.oasis.opendocument.formula" target-dir "1.2")
  2099. ;; Copy over the formula file from user directory to zip
  2100. ;; directory.
  2101. (message "Embedding %s as %s..." src-file target-file)
  2102. (let ((ext (file-name-extension src-file)))
  2103. (cond
  2104. ;; Case 1: Mathml.
  2105. ((member ext '("mathml" "mml"))
  2106. (copy-file src-file (concat org-odt-zip-dir target-file) 'overwrite))
  2107. ;; Case 2: OpenDocument formula.
  2108. ((string= ext "odf")
  2109. (org-odt--zip-extract src-file "content.xml"
  2110. (concat org-odt-zip-dir target-dir)))
  2111. (t (error "%s is not a formula file" src-file))))
  2112. ;; Enter the formula file in to manifest.
  2113. (org-odt-create-manifest-file-entry "text/xml" target-file)
  2114. target-file))
  2115. ;;;; Targets
  2116. (defun org-odt--render-image/formula (cfg-key href width height &optional
  2117. captions user-frame-params
  2118. &rest title-and-desc)
  2119. (let* ((frame-cfg-alist
  2120. ;; Each element of this alist is of the form (CFG-HANDLE
  2121. ;; INNER-FRAME-PARAMS OUTER-FRAME-PARAMS).
  2122. ;; CFG-HANDLE is the key to the alist.
  2123. ;; INNER-FRAME-PARAMS and OUTER-FRAME-PARAMS specify the
  2124. ;; frame params for INNER-FRAME and OUTER-FRAME
  2125. ;; respectively. See below.
  2126. ;; Configurations that are meant to be applied to
  2127. ;; non-captioned image/formula specifies no
  2128. ;; OUTER-FRAME-PARAMS.
  2129. ;; TERMINOLOGY
  2130. ;; ===========
  2131. ;; INNER-FRAME :: Frame that directly surrounds an
  2132. ;; image/formula.
  2133. ;; OUTER-FRAME :: Frame that encloses the INNER-FRAME. This
  2134. ;; frame also contains the caption, if any.
  2135. ;; FRAME-PARAMS :: List of the form (FRAME-STYLE-NAME
  2136. ;; FRAME-ATTRIBUTES FRAME-ANCHOR). Note
  2137. ;; that these are the last three arguments
  2138. ;; to `org-odt--frame'.
  2139. ;; Note that an un-captioned image/formula requires just an
  2140. ;; INNER-FRAME, while a captioned image/formula requires
  2141. ;; both an INNER and an OUTER-FRAME.
  2142. '(("As-CharImage" ("OrgInlineImage" nil "as-char"))
  2143. ("ParagraphImage" ("OrgDisplayImage" nil "paragraph"))
  2144. ("PageImage" ("OrgPageImage" nil "page"))
  2145. ("CaptionedAs-CharImage"
  2146. ("OrgCaptionedImage"
  2147. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  2148. ("OrgInlineImage" nil "as-char"))
  2149. ("CaptionedParagraphImage"
  2150. ("OrgCaptionedImage"
  2151. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  2152. ("OrgImageCaptionFrame" nil "paragraph"))
  2153. ("CaptionedPageImage"
  2154. ("OrgCaptionedImage"
  2155. " style:rel-width=\"100%\" style:rel-height=\"scale\"" "paragraph")
  2156. ("OrgPageImageCaptionFrame" nil "page"))
  2157. ("InlineFormula" ("OrgInlineFormula" nil "as-char"))
  2158. ("DisplayFormula" ("OrgDisplayFormula" nil "as-char"))
  2159. ("CaptionedDisplayFormula"
  2160. ("OrgCaptionedFormula" nil "paragraph")
  2161. ("OrgFormulaCaptionFrame" nil "paragraph"))))
  2162. (caption (car captions)) (short-caption (cdr captions))
  2163. ;; Retrieve inner and outer frame params, from configuration.
  2164. (frame-cfg (assoc-string cfg-key frame-cfg-alist t))
  2165. (inner (nth 1 frame-cfg))
  2166. (outer (nth 2 frame-cfg))
  2167. ;; User-specified frame params (from #+ATTR_ODT spec)
  2168. (user user-frame-params)
  2169. (--merge-frame-params (function
  2170. (lambda (default user)
  2171. "Merge default and user frame params."
  2172. (if (not user) default
  2173. (cl-assert (= (length default) 3))
  2174. (cl-assert (= (length user) 3))
  2175. (cl-loop for u in user
  2176. for d in default
  2177. collect (or u d)))))))
  2178. (cond
  2179. ;; Case 1: Image/Formula has no caption.
  2180. ;; There is only one frame, one that surrounds the image
  2181. ;; or formula.
  2182. ((not caption)
  2183. ;; Merge user frame params with that from configuration.
  2184. (setq inner (funcall --merge-frame-params inner user))
  2185. (apply 'org-odt--frame href width height
  2186. (append inner title-and-desc)))
  2187. ;; Case 2: Image/Formula is captioned or labeled.
  2188. ;; There are two frames: The inner one surrounds the
  2189. ;; image or formula. The outer one contains the
  2190. ;; caption/sequence number.
  2191. (t
  2192. ;; Merge user frame params with outer frame params.
  2193. (setq outer (funcall --merge-frame-params outer user))
  2194. ;; Short caption, if specified, goes as part of inner frame.
  2195. (setq inner (let ((frame-params (copy-sequence inner)))
  2196. (setcar (cdr frame-params)
  2197. (concat
  2198. (cadr frame-params)
  2199. (when short-caption
  2200. (format " draw:name=\"%s\" " short-caption))))
  2201. frame-params))
  2202. (apply 'org-odt--textbox
  2203. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2204. "Illustration"
  2205. (concat
  2206. (apply 'org-odt--frame href width height
  2207. (append inner title-and-desc))
  2208. caption))
  2209. width height outer)))))
  2210. (defun org-odt--enumerable-p (element _info)
  2211. ;; Element should have a caption or label.
  2212. (or (org-element-property :caption element)
  2213. (org-element-property :name element)))
  2214. (defun org-odt--enumerable-image-p (element info)
  2215. (org-odt--standalone-link-p
  2216. element info
  2217. ;; Paragraph should have a caption or label. It SHOULD NOT be a
  2218. ;; replacement element. (i.e., It SHOULD NOT be a result of LaTeX
  2219. ;; processing.)
  2220. (lambda (p)
  2221. (and (not (org-element-property :replaces p))
  2222. (or (org-element-property :caption p)
  2223. (org-element-property :name p))))
  2224. ;; Link should point to an image file.
  2225. (lambda (l)
  2226. (cl-assert (eq (org-element-type l) 'link))
  2227. (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
  2228. (defun org-odt--enumerable-latex-image-p (element info)
  2229. (org-odt--standalone-link-p
  2230. element info
  2231. ;; Paragraph should have a caption or label. It SHOULD also be a
  2232. ;; replacement element. (i.e., It SHOULD be a result of LaTeX
  2233. ;; processing.)
  2234. (lambda (p)
  2235. (and (org-element-property :replaces p)
  2236. (or (org-element-property :caption p)
  2237. (org-element-property :name p))))
  2238. ;; Link should point to an image file.
  2239. (lambda (l)
  2240. (cl-assert (eq (org-element-type l) 'link))
  2241. (org-export-inline-image-p l (plist-get info :odt-inline-image-rules)))))
  2242. (defun org-odt--enumerable-formula-p (element info)
  2243. (org-odt--standalone-link-p
  2244. element info
  2245. ;; Paragraph should have a caption or label.
  2246. (lambda (p)
  2247. (or (org-element-property :caption p)
  2248. (org-element-property :name p)))
  2249. ;; Link should point to a MathML or ODF file.
  2250. (lambda (l)
  2251. (cl-assert (eq (org-element-type l) 'link))
  2252. (org-export-inline-image-p l (plist-get info :odt-inline-formula-rules)))))
  2253. (defun org-odt--standalone-link-p (element _info &optional
  2254. paragraph-predicate
  2255. link-predicate)
  2256. "Test if ELEMENT is a standalone link for the purpose ODT export.
  2257. INFO is a plist holding contextual information.
  2258. Return non-nil, if ELEMENT is of type paragraph satisfying
  2259. PARAGRAPH-PREDICATE and its sole content, save for whitespaces,
  2260. is a link that satisfies LINK-PREDICATE.
  2261. Return non-nil, if ELEMENT is of type link satisfying
  2262. LINK-PREDICATE and its containing paragraph satisfies
  2263. PARAGRAPH-PREDICATE in addition to having no other content save for
  2264. leading and trailing whitespaces.
  2265. Return nil, otherwise."
  2266. (let ((p (cl-case (org-element-type element)
  2267. (paragraph element)
  2268. (link (and (or (not link-predicate)
  2269. (funcall link-predicate element))
  2270. (org-export-get-parent element)))
  2271. (t nil))))
  2272. (when (and p (eq (org-element-type p) 'paragraph))
  2273. (when (or (not paragraph-predicate)
  2274. (funcall paragraph-predicate p))
  2275. (let ((contents (org-element-contents p)))
  2276. (cl-loop for x in contents
  2277. with inline-image-count = 0
  2278. always (cl-case (org-element-type x)
  2279. (plain-text
  2280. (not (org-string-nw-p x)))
  2281. (link
  2282. (and (or (not link-predicate)
  2283. (funcall link-predicate x))
  2284. (= (cl-incf inline-image-count) 1)))
  2285. (t nil))))))))
  2286. (defun org-odt-link--infer-description (destination info)
  2287. ;; DESTINATION is a headline or an element (like paragraph,
  2288. ;; verse-block etc) to which a "#+NAME: label" can be attached.
  2289. ;; Note that labels that are attached to captioned entities - inline
  2290. ;; images, math formulae and tables - get resolved as part of
  2291. ;; `org-odt-format-label' and `org-odt--enumerate'.
  2292. ;; Create a cross-reference to DESTINATION but make best-efforts to
  2293. ;; create a *meaningful* description. Check item numbers, section
  2294. ;; number and section title in that order.
  2295. ;; NOTE: Counterpart of `org-export-get-ordinal'.
  2296. ;; FIXME: Handle footnote-definition footnote-reference?
  2297. (let* ((genealogy (org-element-lineage destination))
  2298. (data (reverse genealogy))
  2299. (label (let ((type (org-element-type destination)))
  2300. (if (memq type '(headline target))
  2301. (org-export-get-reference destination info)
  2302. (error "FIXME: Unable to resolve %S" destination)))))
  2303. (or
  2304. (let* ( ;; Locate top-level list.
  2305. (top-level-list
  2306. (cl-loop for x on data
  2307. when (eq (org-element-type (car x)) 'plain-list)
  2308. return x))
  2309. ;; Get list item nos.
  2310. (item-numbers
  2311. (cl-loop for (plain-list item . rest) on top-level-list by #'cddr
  2312. until (not (eq (org-element-type plain-list) 'plain-list))
  2313. collect (when (eq (org-element-property :type
  2314. plain-list)
  2315. 'ordered)
  2316. (1+ (length (org-export-get-previous-element
  2317. item info t))))))
  2318. ;; Locate top-most listified headline.
  2319. (listified-headlines
  2320. (cl-loop for x on data
  2321. when (and (eq (org-element-type (car x)) 'headline)
  2322. (org-export-low-level-p (car x) info))
  2323. return x))
  2324. ;; Get listified headline numbers.
  2325. (listified-headline-nos
  2326. (cl-loop for el in listified-headlines
  2327. when (eq (org-element-type el) 'headline)
  2328. collect (when (org-export-numbered-headline-p el info)
  2329. (1+ (length (org-export-get-previous-element
  2330. el info t)))))))
  2331. ;; Combine item numbers from both the listified headlines and
  2332. ;; regular list items.
  2333. ;; Case 1: Check if all the parents of list item are numbered.
  2334. ;; If yes, link to the item proper.
  2335. (let ((item-numbers (append listified-headline-nos item-numbers)))
  2336. (when (and item-numbers (not (memq nil item-numbers)))
  2337. (format "<text:bookmark-ref text:reference-format=\"number-all-superior\" text:ref-name=\"%s\">%s</text:bookmark-ref>"
  2338. label
  2339. (mapconcat (lambda (n) (if (not n) " "
  2340. (concat (number-to-string n) ".")))
  2341. item-numbers "")))))
  2342. ;; Case 2: Locate a regular and numbered headline in the
  2343. ;; hierarchy. Display its section number.
  2344. (let ((headline
  2345. (and
  2346. ;; Test if destination is a numbered headline.
  2347. (org-export-numbered-headline-p destination info)
  2348. (cl-loop for el in (cons destination genealogy)
  2349. when (and (eq (org-element-type el) 'headline)
  2350. (not (org-export-low-level-p el info))
  2351. (org-export-numbered-headline-p el info))
  2352. return el))))
  2353. ;; We found one.
  2354. (when headline
  2355. (format "<text:bookmark-ref text:reference-format=\"chapter\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
  2356. label
  2357. (mapconcat 'number-to-string (org-export-get-headline-number
  2358. headline info) "."))))
  2359. ;; Case 4: Locate a regular headline in the hierarchy. Display
  2360. ;; its title.
  2361. (let ((headline (cl-loop for el in (cons destination genealogy)
  2362. when (and (eq (org-element-type el) 'headline)
  2363. (not (org-export-low-level-p el info)))
  2364. return el)))
  2365. ;; We found one.
  2366. (when headline
  2367. (format "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
  2368. label
  2369. (let ((title (org-element-property :title headline)))
  2370. (org-export-data title info)))))
  2371. (error "FIXME?"))))
  2372. (defun org-odt-link (link desc info)
  2373. "Transcode a LINK object from Org to ODT.
  2374. DESC is the description part of the link, or the empty string.
  2375. INFO is a plist holding contextual information. See
  2376. `org-export-data'."
  2377. (let* ((type (org-element-property :type link))
  2378. (raw-path (org-element-property :path link))
  2379. ;; Ensure DESC really exists, or set it to nil.
  2380. (desc (and (not (string= desc "")) desc))
  2381. (imagep (org-export-inline-image-p
  2382. link (plist-get info :odt-inline-image-rules)))
  2383. (path (cond
  2384. ((member type '("http" "https" "ftp" "mailto"))
  2385. (concat type ":" raw-path))
  2386. ((string= type "file") (org-export-file-uri raw-path))
  2387. (t raw-path)))
  2388. ;; Convert & to &amp; for correct XML representation
  2389. (path (replace-regexp-in-string "&" "&amp;" path)))
  2390. (cond
  2391. ;; Link type is handled by a special function.
  2392. ((org-export-custom-protocol-maybe link desc 'odt))
  2393. ;; Image file.
  2394. ((and (not desc) imagep) (org-odt-link--inline-image link info))
  2395. ;; Formula file.
  2396. ((and (not desc)
  2397. (org-export-inline-image-p
  2398. link (plist-get info :odt-inline-formula-rules)))
  2399. (org-odt-link--inline-formula link info))
  2400. ;; Radio target: Transcode target's contents and use them as
  2401. ;; link's description.
  2402. ((string= type "radio")
  2403. (let ((destination (org-export-resolve-radio-link link info)))
  2404. (if (not destination) desc
  2405. (format
  2406. "<text:bookmark-ref text:reference-format=\"text\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
  2407. (org-export-get-reference destination info)
  2408. desc))))
  2409. ;; Links pointing to a headline: Find destination and build
  2410. ;; appropriate referencing command.
  2411. ((member type '("custom-id" "fuzzy" "id"))
  2412. (let ((destination (if (string= type "fuzzy")
  2413. (org-export-resolve-fuzzy-link link info)
  2414. (org-export-resolve-id-link link info))))
  2415. (cl-case (org-element-type destination)
  2416. ;; Fuzzy link points to a headline. If there's
  2417. ;; a description, create a hyperlink. Otherwise, try to
  2418. ;; provide a meaningful description.
  2419. (headline
  2420. (if (not desc) (org-odt-link--infer-description destination info)
  2421. (let ((label
  2422. (or (and (string= type "custom-id")
  2423. (org-element-property :CUSTOM_ID destination))
  2424. (org-export-get-reference destination info))))
  2425. (format
  2426. "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
  2427. label desc))))
  2428. ;; Fuzzy link points to a target. If there's a description,
  2429. ;; create a hyperlink. Otherwise, try to provide
  2430. ;; a meaningful description.
  2431. (target
  2432. (format "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
  2433. (org-export-get-reference destination info)
  2434. (or desc (org-export-get-ordinal destination info))))
  2435. ;; Fuzzy link points to some element (e.g., an inline image,
  2436. ;; a math formula or a table).
  2437. (otherwise
  2438. (let ((label-reference
  2439. (ignore-errors
  2440. (org-odt-format-label destination info 'reference))))
  2441. (cond
  2442. ((not label-reference)
  2443. (org-odt-link--infer-description destination info))
  2444. ;; LINK has no description. Create
  2445. ;; a cross-reference showing entity's sequence
  2446. ;; number.
  2447. ((not desc) label-reference)
  2448. ;; LINK has description. Insert a hyperlink with
  2449. ;; user-provided description.
  2450. (t
  2451. (format
  2452. "<text:a xlink:type=\"simple\" xlink:href=\"#%s\">%s</text:a>"
  2453. (org-export-get-reference destination info)
  2454. desc))))))))
  2455. ;; Coderef: replace link with the reference name or the
  2456. ;; equivalent line number.
  2457. ((string= type "coderef")
  2458. (let* ((line-no (format "%d" (org-export-resolve-coderef path info)))
  2459. (href (concat "coderef-" path)))
  2460. (format
  2461. (org-export-get-coderef-format path desc)
  2462. (format
  2463. "<text:bookmark-ref text:reference-format=\"number\" text:ref-name=\"OrgXref.%s\">%s</text:bookmark-ref>"
  2464. href line-no))))
  2465. ;; External link with a description part.
  2466. ((and path desc)
  2467. (let ((link-contents (org-element-contents link)))
  2468. ;; Check if description is a link to an inline image.
  2469. (if (and (not (cdr link-contents))
  2470. (let ((desc-element (car link-contents)))
  2471. (and (eq (org-element-type desc-element) 'link)
  2472. (org-export-inline-image-p
  2473. desc-element
  2474. (plist-get info :odt-inline-image-rules)))))
  2475. ;; Format link as a clickable image.
  2476. (format "\n<draw:a xlink:type=\"simple\" xlink:href=\"%s\">\n%s\n</draw:a>"
  2477. path desc)
  2478. ;; Otherwise, format it as a regular link.
  2479. (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
  2480. path desc))))
  2481. ;; External link without a description part.
  2482. (path
  2483. (format "<text:a xlink:type=\"simple\" xlink:href=\"%s\">%s</text:a>"
  2484. path path))
  2485. ;; No path, only description. Try to do something useful.
  2486. (t (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2487. "Emphasis" desc)))))
  2488. ;;;; Node Property
  2489. (defun org-odt-node-property (node-property _contents _info)
  2490. "Transcode a NODE-PROPERTY element from Org to ODT.
  2491. CONTENTS is nil. INFO is a plist holding contextual
  2492. information."
  2493. (org-odt--encode-plain-text
  2494. (format "%s:%s"
  2495. (org-element-property :key node-property)
  2496. (let ((value (org-element-property :value node-property)))
  2497. (if value (concat " " value) "")))))
  2498. ;;;; Paragraph
  2499. (defun org-odt--paragraph-style (paragraph)
  2500. "Return style of PARAGRAPH.
  2501. Style is a symbol among `quoted', `centered' and nil."
  2502. (let ((up paragraph))
  2503. (while (and (setq up (org-element-property :parent up))
  2504. (not (memq (org-element-type up)
  2505. '(center-block quote-block section)))))
  2506. (cl-case (org-element-type up)
  2507. (center-block 'centered)
  2508. (quote-block 'quoted))))
  2509. (defun org-odt--format-paragraph (paragraph contents info default center quote)
  2510. "Format paragraph according to given styles.
  2511. PARAGRAPH is a paragraph type element. CONTENTS is the
  2512. transcoded contents of that paragraph, as a string. INFO is
  2513. a plist used as a communication channel. DEFAULT, CENTER and
  2514. QUOTE are, respectively, style to use when paragraph belongs to
  2515. no special environment, a center block, or a quote block."
  2516. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2517. (cl-case (org-odt--paragraph-style paragraph)
  2518. (quoted quote)
  2519. (centered center)
  2520. (otherwise default))
  2521. ;; If PARAGRAPH is a leading paragraph in an item that has
  2522. ;; a checkbox, splice checkbox and paragraph contents
  2523. ;; together.
  2524. (concat (let ((parent (org-element-property :parent paragraph)))
  2525. (and (eq (org-element-type parent) 'item)
  2526. (not (org-export-get-previous-element paragraph info))
  2527. (org-odt--checkbox parent)))
  2528. contents)))
  2529. (defun org-odt-paragraph (paragraph contents info)
  2530. "Transcode a PARAGRAPH element from Org to ODT.
  2531. CONTENTS is the contents of the paragraph, as a string. INFO is
  2532. the plist used as a communication channel."
  2533. (org-odt--format-paragraph
  2534. paragraph contents info
  2535. (or (org-element-property :style paragraph) "Text_20_body")
  2536. "OrgCenter"
  2537. "Quotations"))
  2538. ;;;; Plain List
  2539. (defun org-odt-plain-list (plain-list contents _info)
  2540. "Transcode a PLAIN-LIST element from Org to ODT.
  2541. CONTENTS is the contents of the list. INFO is a plist holding
  2542. contextual information."
  2543. (format "\n<text:list text:style-name=\"%s\" %s>\n%s</text:list>"
  2544. ;; Choose style based on list type.
  2545. (cl-case (org-element-property :type plain-list)
  2546. (ordered "OrgNumberedList")
  2547. (unordered "OrgBulletedList")
  2548. (descriptive-1 "OrgDescriptionList")
  2549. (descriptive-2 "OrgDescriptionList"))
  2550. ;; If top-level list, re-start numbering. Otherwise,
  2551. ;; continue numbering.
  2552. (format "text:continue-numbering=\"%s\""
  2553. (let* ((parent (org-export-get-parent plain-list)))
  2554. (if (and parent (eq (org-element-type parent) 'item))
  2555. "true" "false")))
  2556. contents))
  2557. ;;;; Plain Text
  2558. (defun org-odt--encode-tabs-and-spaces (line)
  2559. (replace-regexp-in-string
  2560. "\\(\t\\| \\{2,\\}\\)"
  2561. (lambda (s)
  2562. (if (string= s "\t") "<text:tab/>"
  2563. (format " <text:s text:c=\"%d\"/>" (1- (length s)))))
  2564. line))
  2565. (defun org-odt--encode-plain-text (text &optional no-whitespace-filling)
  2566. (dolist (pair '(("&" . "&amp;") ("<" . "&lt;") (">" . "&gt;")))
  2567. (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t)))
  2568. (if no-whitespace-filling text
  2569. (org-odt--encode-tabs-and-spaces text)))
  2570. (defun org-odt-plain-text (text info)
  2571. "Transcode a TEXT string from Org to ODT.
  2572. TEXT is the string to transcode. INFO is a plist holding
  2573. contextual information."
  2574. (let ((output text))
  2575. ;; Protect &, < and >.
  2576. (setq output (org-odt--encode-plain-text output t))
  2577. ;; Handle smart quotes. Be sure to provide original string since
  2578. ;; OUTPUT may have been modified.
  2579. (when (plist-get info :with-smart-quotes)
  2580. (setq output (org-export-activate-smart-quotes output :utf-8 info text)))
  2581. ;; Convert special strings.
  2582. (when (plist-get info :with-special-strings)
  2583. (dolist (pair org-odt-special-string-regexps)
  2584. (setq output
  2585. (replace-regexp-in-string (car pair) (cdr pair) output t nil))))
  2586. ;; Handle break preservation if required.
  2587. (when (plist-get info :preserve-breaks)
  2588. (setq output (replace-regexp-in-string
  2589. "\\(\\\\\\\\\\)?[ \t]*\n" "<text:line-break/>" output t)))
  2590. ;; Return value.
  2591. output))
  2592. ;;;; Planning
  2593. (defun org-odt-planning (planning contents info)
  2594. "Transcode a PLANNING element from Org to ODT.
  2595. CONTENTS is nil. INFO is a plist used as a communication
  2596. channel."
  2597. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2598. "OrgPlanning"
  2599. (concat
  2600. (let ((closed (org-element-property :closed planning)))
  2601. (when closed
  2602. (concat
  2603. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2604. "OrgClosedKeyword" org-closed-string)
  2605. (org-odt-timestamp closed contents info))))
  2606. (let ((deadline (org-element-property :deadline planning)))
  2607. (when deadline
  2608. (concat
  2609. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2610. "OrgDeadlineKeyword" org-deadline-string)
  2611. (org-odt-timestamp deadline contents info))))
  2612. (let ((scheduled (org-element-property :scheduled planning)))
  2613. (when scheduled
  2614. (concat
  2615. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2616. "OrgScheduledKeyword" org-deadline-string)
  2617. (org-odt-timestamp scheduled contents info)))))))
  2618. ;;;; Property Drawer
  2619. (defun org-odt-property-drawer (_property-drawer contents _info)
  2620. "Transcode a PROPERTY-DRAWER element from Org to ODT.
  2621. CONTENTS holds the contents of the drawer. INFO is a plist
  2622. holding contextual information."
  2623. (and (org-string-nw-p contents)
  2624. (format "<text:p text:style-name=\"OrgFixedWidthBlock\">%s</text:p>"
  2625. contents)))
  2626. ;;;; Quote Block
  2627. (defun org-odt-quote-block (_quote-block contents _info)
  2628. "Transcode a QUOTE-BLOCK element from Org to ODT.
  2629. CONTENTS holds the contents of the block. INFO is a plist
  2630. holding contextual information."
  2631. contents)
  2632. ;;;; Section
  2633. (defun org-odt-format-section (text style &optional name)
  2634. (let ((default-name (car (org-odt-add-automatic-style "Section"))))
  2635. (format "\n<text:section text:style-name=\"%s\" %s>\n%s\n</text:section>"
  2636. style
  2637. (format "text:name=\"%s\"" (or name default-name))
  2638. text)))
  2639. (defun org-odt-section (_section contents _info) ; FIXME
  2640. "Transcode a SECTION element from Org to ODT.
  2641. CONTENTS holds the contents of the section. INFO is a plist
  2642. holding contextual information."
  2643. contents)
  2644. ;;;; Radio Target
  2645. (defun org-odt-radio-target (radio-target text info)
  2646. "Transcode a RADIO-TARGET object from Org to ODT.
  2647. TEXT is the text of the target. INFO is a plist holding
  2648. contextual information."
  2649. (org-odt--target text (org-export-get-reference radio-target info)))
  2650. ;;;; Special Block
  2651. (defun org-odt-special-block (special-block contents info)
  2652. "Transcode a SPECIAL-BLOCK element from Org to ODT.
  2653. CONTENTS holds the contents of the block. INFO is a plist
  2654. holding contextual information."
  2655. (let ((type (org-element-property :type special-block))
  2656. (attributes (org-export-read-attribute :attr_odt special-block)))
  2657. (cond
  2658. ;; Annotation.
  2659. ((string= type "annotation")
  2660. (let* ((author (or (plist-get attributes :author)
  2661. (let ((author (plist-get info :author)))
  2662. (and author (org-export-data author info)))))
  2663. (date (or (plist-get attributes :date)
  2664. ;; FIXME: Is `car' right thing to do below?
  2665. (car (plist-get info :date)))))
  2666. (format "\n<text:p>%s</text:p>"
  2667. (format "<office:annotation>\n%s\n</office:annotation>"
  2668. (concat
  2669. (and author
  2670. (format "<dc:creator>%s</dc:creator>" author))
  2671. (and date
  2672. (format "<dc:date>%s</dc:date>"
  2673. (org-odt--format-timestamp date nil 'iso-date)))
  2674. contents)))))
  2675. ;; Textbox.
  2676. ((string= type "textbox")
  2677. (let ((width (plist-get attributes :width))
  2678. (height (plist-get attributes :height))
  2679. (style (plist-get attributes :style))
  2680. (extra (plist-get attributes :extra))
  2681. (anchor (plist-get attributes :anchor)))
  2682. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2683. "Text_20_body" (org-odt--textbox contents width height
  2684. style extra anchor))))
  2685. (t contents))))
  2686. ;;;; Src Block
  2687. (defun org-odt-hfy-face-to-css (fn)
  2688. "Create custom style for face FN.
  2689. When FN is the default face, use its foreground and background
  2690. properties to create \"OrgSrcBlock\" paragraph style. Otherwise
  2691. use its color attribute to create a character style whose name
  2692. is obtained from FN. Currently all attributes of FN other than
  2693. color are ignored.
  2694. The style name for a face FN is derived using the following
  2695. operations on the face name in that order - de-dash, CamelCase
  2696. and prefix with \"OrgSrc\". For example,
  2697. `font-lock-function-name-face' is associated with
  2698. \"OrgSrcFontLockFunctionNameFace\"."
  2699. (let* ((css-list (hfy-face-to-style fn))
  2700. (style-name (concat "OrgSrc"
  2701. (mapconcat
  2702. 'capitalize (split-string
  2703. (hfy-face-or-def-to-name fn) "-")
  2704. "")))
  2705. (color-val (cdr (assoc "color" css-list)))
  2706. (background-color-val (cdr (assoc "background" css-list)))
  2707. (style (and org-odt-create-custom-styles-for-srcblocks
  2708. (cond
  2709. ((eq fn 'default)
  2710. (format org-odt-src-block-paragraph-format
  2711. background-color-val color-val))
  2712. (t
  2713. (format
  2714. "
  2715. <style:style style:name=\"%s\" style:family=\"text\">
  2716. <style:text-properties fo:color=\"%s\"/>
  2717. </style:style>" style-name color-val))))))
  2718. (cons style-name style)))
  2719. (defun org-odt-htmlfontify-string (line)
  2720. (let* ((hfy-html-quote-regex "\\([<\"&> \t]\\)")
  2721. (hfy-html-quote-map '(("\"" "&quot;")
  2722. ("<" "&lt;")
  2723. ("&" "&amp;")
  2724. (">" "&gt;")
  2725. (" " "<text:s/>")
  2726. ("\t" "<text:tab/>")))
  2727. (hfy-face-to-css 'org-odt-hfy-face-to-css)
  2728. (hfy-optimizations-1 (copy-sequence hfy-optimizations))
  2729. (hfy-optimizations (cl-pushnew 'body-text-only hfy-optimizations-1))
  2730. (hfy-begin-span-handler
  2731. (lambda (style _text-block _text-id _text-begins-block-p)
  2732. (insert (format "<text:span text:style-name=\"%s\">" style))))
  2733. (hfy-end-span-handler (lambda () (insert "</text:span>"))))
  2734. (with-no-warnings (htmlfontify-string line))))
  2735. (defun org-odt-do-format-code
  2736. (code info &optional lang refs retain-labels num-start)
  2737. (let* ((lang (or (assoc-default lang org-src-lang-modes) lang))
  2738. (lang-mode (and lang (intern (format "%s-mode" lang))))
  2739. (code-lines (org-split-string code "\n"))
  2740. (code-length (length code-lines))
  2741. (use-htmlfontify-p (and (functionp lang-mode)
  2742. (plist-get info :odt-fontify-srcblocks)
  2743. (require 'htmlfontify nil t)
  2744. (fboundp 'htmlfontify-string)))
  2745. (code (if (not use-htmlfontify-p) code
  2746. (with-temp-buffer
  2747. (insert code)
  2748. (funcall lang-mode)
  2749. (org-font-lock-ensure)
  2750. (buffer-string))))
  2751. (fontifier (if use-htmlfontify-p 'org-odt-htmlfontify-string
  2752. 'org-odt--encode-plain-text))
  2753. (par-style (if use-htmlfontify-p "OrgSrcBlock"
  2754. "OrgFixedWidthBlock"))
  2755. (i 0))
  2756. (cl-assert (= code-length (length (org-split-string code "\n"))))
  2757. (setq code
  2758. (org-export-format-code
  2759. code
  2760. (lambda (loc line-num ref)
  2761. (setq par-style
  2762. (concat par-style (and (= (cl-incf i) code-length)
  2763. "LastLine")))
  2764. (setq loc (concat loc (and ref retain-labels (format " (%s)" ref))))
  2765. (setq loc (funcall fontifier loc))
  2766. (when ref
  2767. (setq loc (org-odt--target loc (concat "coderef-" ref))))
  2768. (cl-assert par-style)
  2769. (setq loc (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2770. par-style loc))
  2771. (if (not line-num) loc
  2772. (format "\n<text:list-item>%s\n</text:list-item>" loc)))
  2773. num-start refs))
  2774. (cond
  2775. ((not num-start) code)
  2776. ((= num-start 0)
  2777. (format
  2778. "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
  2779. " text:continue-numbering=\"false\"" code))
  2780. (t
  2781. (format
  2782. "\n<text:list text:style-name=\"OrgSrcBlockNumberedLine\"%s>%s</text:list>"
  2783. " text:continue-numbering=\"true\"" code)))))
  2784. (defun org-odt-format-code (element info)
  2785. (let* ((lang (org-element-property :language element))
  2786. ;; Extract code and references.
  2787. (code-info (org-export-unravel-code element))
  2788. (code (car code-info))
  2789. (refs (cdr code-info))
  2790. ;; Does the source block contain labels?
  2791. (retain-labels (org-element-property :retain-labels element))
  2792. ;; Does it have line numbers?
  2793. (num-start (org-export-get-loc element info)))
  2794. (org-odt-do-format-code code info lang refs retain-labels num-start)))
  2795. (defun org-odt-src-block (src-block _contents info)
  2796. "Transcode a SRC-BLOCK element from Org to ODT.
  2797. CONTENTS holds the contents of the item. INFO is a plist holding
  2798. contextual information."
  2799. (let* ((attributes (org-export-read-attribute :attr_odt src-block))
  2800. (caption (car (org-odt-format-label src-block info 'definition))))
  2801. (concat
  2802. (and caption
  2803. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2804. "Listing" caption))
  2805. (let ((--src-block (org-odt-format-code src-block info)))
  2806. (if (not (plist-get attributes :textbox)) --src-block
  2807. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2808. "Text_20_body"
  2809. (org-odt--textbox --src-block nil nil nil)))))))
  2810. ;;;; Statistics Cookie
  2811. (defun org-odt-statistics-cookie (statistics-cookie _contents _info)
  2812. "Transcode a STATISTICS-COOKIE object from Org to ODT.
  2813. CONTENTS is nil. INFO is a plist holding contextual information."
  2814. (let ((cookie-value (org-element-property :value statistics-cookie)))
  2815. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2816. "OrgCode" cookie-value)))
  2817. ;;;; Strike-Through
  2818. (defun org-odt-strike-through (_strike-through contents _info)
  2819. "Transcode STRIKE-THROUGH from Org to ODT.
  2820. CONTENTS is the text with strike-through markup. INFO is a plist
  2821. holding contextual information."
  2822. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2823. "Strikethrough" contents))
  2824. ;;;; Subscript
  2825. (defun org-odt-subscript (_subscript contents _info)
  2826. "Transcode a SUBSCRIPT object from Org to ODT.
  2827. CONTENTS is the contents of the object. INFO is a plist holding
  2828. contextual information."
  2829. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2830. "OrgSubscript" contents))
  2831. ;;;; Superscript
  2832. (defun org-odt-superscript (_superscript contents _info)
  2833. "Transcode a SUPERSCRIPT object from Org to ODT.
  2834. CONTENTS is the contents of the object. INFO is a plist holding
  2835. contextual information."
  2836. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  2837. "OrgSuperscript" contents))
  2838. ;;;; Table Cell
  2839. (defun org-odt-table-style-spec (element info)
  2840. (let* ((table (org-export-get-parent-table element))
  2841. (table-attributes (org-export-read-attribute :attr_odt table))
  2842. (table-style (plist-get table-attributes :style)))
  2843. (assoc table-style (plist-get info :odt-table-styles))))
  2844. (defun org-odt-get-table-cell-styles (table-cell info)
  2845. "Retrieve styles applicable to a table cell.
  2846. R and C are (zero-based) row and column numbers of the table
  2847. cell. STYLE-SPEC is an entry in `org-odt-table-styles'
  2848. applicable to the current table. It is nil if the table is not
  2849. associated with any style attributes.
  2850. Return a cons of (TABLE-CELL-STYLE-NAME . PARAGRAPH-STYLE-NAME).
  2851. When STYLE-SPEC is nil, style the table cell the conventional way
  2852. - choose cell borders based on row and column groupings and
  2853. choose paragraph alignment based on `org-col-cookies' text
  2854. property. See also
  2855. `org-odt-get-paragraph-style-cookie-for-table-cell'.
  2856. When STYLE-SPEC is non-nil, ignore the above cookie and return
  2857. styles congruent with the ODF-1.2 specification."
  2858. (let* ((table-cell-address (org-export-table-cell-address table-cell info))
  2859. (r (car table-cell-address)) (c (cdr table-cell-address))
  2860. (style-spec (org-odt-table-style-spec table-cell info))
  2861. (table-dimensions (org-export-table-dimensions
  2862. (org-export-get-parent-table table-cell)
  2863. info)))
  2864. (when style-spec
  2865. ;; LibreOffice - particularly the Writer - honors neither table
  2866. ;; templates nor custom table-cell styles. Inorder to retain
  2867. ;; inter-operability with LibreOffice, only automatic styles are
  2868. ;; used for styling of table-cells. The current implementation is
  2869. ;; congruent with ODF-1.2 specification and hence is
  2870. ;; future-compatible.
  2871. ;; Additional Note: LibreOffice's AutoFormat facility for tables -
  2872. ;; which recognizes as many as 16 different cell types - is much
  2873. ;; richer. Unfortunately it is NOT amenable to easy configuration
  2874. ;; by hand.
  2875. (let* ((template-name (nth 1 style-spec))
  2876. (cell-style-selectors (nth 2 style-spec))
  2877. (cell-type
  2878. (cond
  2879. ((and (cdr (assq 'use-first-column-styles cell-style-selectors))
  2880. (= c 0)) "FirstColumn")
  2881. ((and (cdr (assq 'use-last-column-styles cell-style-selectors))
  2882. (= (1+ c) (cdr table-dimensions)))
  2883. "LastColumn")
  2884. ((and (cdr (assq 'use-first-row-styles cell-style-selectors))
  2885. (= r 0)) "FirstRow")
  2886. ((and (cdr (assq 'use-last-row-styles cell-style-selectors))
  2887. (= (1+ r) (car table-dimensions)))
  2888. "LastRow")
  2889. ((and (cdr (assq 'use-banding-rows-styles cell-style-selectors))
  2890. (= (% r 2) 1)) "EvenRow")
  2891. ((and (cdr (assq 'use-banding-rows-styles cell-style-selectors))
  2892. (= (% r 2) 0)) "OddRow")
  2893. ((and (cdr (assq 'use-banding-columns-styles cell-style-selectors))
  2894. (= (% c 2) 1)) "EvenColumn")
  2895. ((and (cdr (assq 'use-banding-columns-styles cell-style-selectors))
  2896. (= (% c 2) 0)) "OddColumn")
  2897. (t ""))))
  2898. (concat template-name cell-type)))))
  2899. (defun org-odt-table-cell (table-cell contents info)
  2900. "Transcode a TABLE-CELL element from Org to ODT.
  2901. CONTENTS is nil. INFO is a plist used as a communication
  2902. channel."
  2903. (let* ((table-cell-address (org-export-table-cell-address table-cell info))
  2904. (r (car table-cell-address))
  2905. (c (cdr table-cell-address))
  2906. (horiz-span (or (org-export-table-cell-width table-cell info) 0))
  2907. (table-row (org-export-get-parent table-cell))
  2908. (custom-style-prefix (org-odt-get-table-cell-styles
  2909. table-cell info))
  2910. (paragraph-style
  2911. (or
  2912. (and custom-style-prefix
  2913. (format "%sTableParagraph" custom-style-prefix))
  2914. (concat
  2915. (cond
  2916. ((and (= 1 (org-export-table-row-group table-row info))
  2917. (org-export-table-has-header-p
  2918. (org-export-get-parent-table table-row) info))
  2919. "OrgTableHeading")
  2920. ((let* ((table (org-export-get-parent-table table-cell))
  2921. (table-attrs (org-export-read-attribute :attr_odt table))
  2922. (table-header-columns
  2923. (let ((cols (plist-get table-attrs :header-columns)))
  2924. (and cols (read cols)))))
  2925. (<= c (cond ((wholenump table-header-columns)
  2926. (- table-header-columns 1))
  2927. (table-header-columns 0)
  2928. (t -1))))
  2929. "OrgTableHeading")
  2930. (t "OrgTableContents"))
  2931. (capitalize (symbol-name (org-export-table-cell-alignment
  2932. table-cell info))))))
  2933. (cell-style-name
  2934. (or
  2935. (and custom-style-prefix (format "%sTableCell"
  2936. custom-style-prefix))
  2937. (concat
  2938. "OrgTblCell"
  2939. (when (or (org-export-table-row-starts-rowgroup-p table-row info)
  2940. (zerop r)) "T")
  2941. (when (org-export-table-row-ends-rowgroup-p table-row info) "B")
  2942. (when (and (org-export-table-cell-starts-colgroup-p table-cell info)
  2943. (not (zerop c)) ) "L"))))
  2944. (cell-attributes
  2945. (concat
  2946. (format " table:style-name=\"%s\"" cell-style-name)
  2947. (and (> horiz-span 0)
  2948. (format " table:number-columns-spanned=\"%d\""
  2949. (1+ horiz-span))))))
  2950. (unless contents (setq contents ""))
  2951. (concat
  2952. (cl-assert paragraph-style)
  2953. (format "\n<table:table-cell%s>\n%s\n</table:table-cell>"
  2954. cell-attributes
  2955. (let ((table-cell-contents (org-element-contents table-cell)))
  2956. (if (eq (org-element-class (car table-cell-contents)) 'element)
  2957. contents
  2958. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  2959. paragraph-style contents))))
  2960. (let (s)
  2961. (dotimes (_ horiz-span s)
  2962. (setq s (concat s "\n<table:covered-table-cell/>"))))
  2963. "\n")))
  2964. ;;;; Table Row
  2965. (defun org-odt-table-row (table-row contents info)
  2966. "Transcode a TABLE-ROW element from Org to ODT.
  2967. CONTENTS is the contents of the row. INFO is a plist used as a
  2968. communication channel."
  2969. ;; Rules are ignored since table separators are deduced from
  2970. ;; borders of the current row.
  2971. (when (eq (org-element-property :type table-row) 'standard)
  2972. (let* ((rowgroup-tags
  2973. (if (and (= 1 (org-export-table-row-group table-row info))
  2974. (org-export-table-has-header-p
  2975. (org-export-get-parent-table table-row) info))
  2976. ;; If the row belongs to the first rowgroup and the
  2977. ;; table has more than one row groups, then this row
  2978. ;; belongs to the header row group.
  2979. '("\n<table:table-header-rows>" . "\n</table:table-header-rows>")
  2980. ;; Otherwise, it belongs to non-header row group.
  2981. '("\n<table:table-rows>" . "\n</table:table-rows>"))))
  2982. (concat
  2983. ;; Does this row begin a rowgroup?
  2984. (when (org-export-table-row-starts-rowgroup-p table-row info)
  2985. (car rowgroup-tags))
  2986. ;; Actual table row
  2987. (format "\n<table:table-row>\n%s\n</table:table-row>" contents)
  2988. ;; Does this row end a rowgroup?
  2989. (when (org-export-table-row-ends-rowgroup-p table-row info)
  2990. (cdr rowgroup-tags))))))
  2991. ;;;; Table
  2992. (defun org-odt-table-first-row-data-cells (table info)
  2993. (let ((table-row
  2994. (org-element-map table 'table-row
  2995. (lambda (row)
  2996. (unless (eq (org-element-property :type row) 'rule) row))
  2997. info 'first-match))
  2998. (special-column-p (org-export-table-has-special-column-p table)))
  2999. (if (not special-column-p) (org-element-contents table-row)
  3000. (cdr (org-element-contents table-row)))))
  3001. (defun org-odt--table (table contents info)
  3002. "Transcode a TABLE element from Org to ODT.
  3003. CONTENTS is the contents of the table. INFO is a plist holding
  3004. contextual information."
  3005. (cl-case (org-element-property :type table)
  3006. ;; Case 1: table.el doesn't support export to OD format. Strip
  3007. ;; such tables from export.
  3008. (table.el
  3009. (prog1 nil
  3010. (message
  3011. (concat
  3012. "(ox-odt): Found table.el-type table in the source Org file."
  3013. " table.el doesn't support export to ODT format."
  3014. " Stripping the table from export."))))
  3015. ;; Case 2: Native Org tables.
  3016. (otherwise
  3017. (let* ((captions (org-odt-format-label table info 'definition))
  3018. (caption (car captions)) (short-caption (cdr captions))
  3019. (attributes (org-export-read-attribute :attr_odt table))
  3020. (custom-table-style (nth 1 (org-odt-table-style-spec table info)))
  3021. (table-column-specs
  3022. (lambda (table info)
  3023. (let* ((table-style (or custom-table-style "OrgTable"))
  3024. (column-style (format "%sColumn" table-style)))
  3025. (mapconcat
  3026. (lambda (table-cell)
  3027. (let ((width (1+ (or (org-export-table-cell-width
  3028. table-cell info) 0)))
  3029. (s (format
  3030. "\n<table:table-column table:style-name=\"%s\"/>"
  3031. column-style))
  3032. out)
  3033. (dotimes (_ width out) (setq out (concat s out)))))
  3034. (org-odt-table-first-row-data-cells table info) "\n")))))
  3035. (concat
  3036. ;; caption.
  3037. (when caption
  3038. (format "\n<text:p text:style-name=\"%s\">%s</text:p>"
  3039. "Table" caption))
  3040. ;; begin table.
  3041. (let* ((automatic-name
  3042. (org-odt-add-automatic-style "Table" attributes)))
  3043. (format
  3044. "\n<table:table table:style-name=\"%s\"%s>"
  3045. (or custom-table-style (cdr automatic-name) "OrgTable")
  3046. (concat (when short-caption
  3047. (format " table:name=\"%s\"" short-caption)))))
  3048. ;; column specification.
  3049. (funcall table-column-specs table info)
  3050. ;; actual contents.
  3051. "\n" contents
  3052. ;; end table.
  3053. "</table:table>")))))
  3054. (defun org-odt-table (table contents info)
  3055. "Transcode a TABLE element from Org to ODT.
  3056. CONTENTS is the contents of the table. INFO is a plist holding
  3057. contextual information.
  3058. Use `org-odt--table' to typeset the table. Handle details
  3059. pertaining to indentation here."
  3060. (let* ((--element-preceded-by-table-p
  3061. (lambda (element info)
  3062. (cl-loop for el in (org-export-get-previous-element element info t)
  3063. thereis (eq (org-element-type el) 'table))))
  3064. (--walk-list-genealogy-and-collect-tags
  3065. (lambda (table info)
  3066. (let* ((genealogy (org-element-lineage table))
  3067. (list-genealogy
  3068. (when (eq (org-element-type (car genealogy)) 'item)
  3069. (cl-loop for el in genealogy
  3070. when (memq (org-element-type el)
  3071. '(item plain-list))
  3072. collect el)))
  3073. (llh-genealogy
  3074. (apply #'nconc
  3075. (cl-loop
  3076. for el in genealogy
  3077. when (and (eq (org-element-type el) 'headline)
  3078. (org-export-low-level-p el info))
  3079. collect
  3080. (list el
  3081. (assq 'headline
  3082. (org-element-contents
  3083. (org-export-get-parent el)))))))
  3084. parent-list)
  3085. (nconc
  3086. ;; Handle list genealogy.
  3087. (cl-loop
  3088. for el in list-genealogy collect
  3089. (cl-case (org-element-type el)
  3090. (plain-list
  3091. (setq parent-list el)
  3092. (cons "</text:list>"
  3093. (format "\n<text:list text:style-name=\"%s\" %s>"
  3094. (cl-case (org-element-property :type el)
  3095. (ordered "OrgNumberedList")
  3096. (unordered "OrgBulletedList")
  3097. (descriptive-1 "OrgDescriptionList")
  3098. (descriptive-2 "OrgDescriptionList"))
  3099. "text:continue-numbering=\"true\"")))
  3100. (item
  3101. (cond
  3102. ((not parent-list)
  3103. (if (funcall --element-preceded-by-table-p table info)
  3104. '("</text:list-header>" . "<text:list-header>")
  3105. '("</text:list-item>" . "<text:list-header>")))
  3106. ((funcall --element-preceded-by-table-p
  3107. parent-list info)
  3108. '("</text:list-header>" . "<text:list-header>"))
  3109. (t '("</text:list-item>" . "<text:list-item>"))))))
  3110. ;; Handle low-level headlines.
  3111. (cl-loop for el in llh-genealogy
  3112. with step = 'item collect
  3113. (cl-case step
  3114. (plain-list
  3115. (setq step 'item) ; Flip-flop
  3116. (setq parent-list el)
  3117. (cons "</text:list>"
  3118. (format "\n<text:list text:style-name=\"%s\" %s>"
  3119. (if (org-export-numbered-headline-p
  3120. el info)
  3121. "OrgNumberedList"
  3122. "OrgBulletedList")
  3123. "text:continue-numbering=\"true\"")))
  3124. (item
  3125. (setq step 'plain-list) ; Flip-flop
  3126. (cond
  3127. ((not parent-list)
  3128. (if (funcall --element-preceded-by-table-p table info)
  3129. '("</text:list-header>" . "<text:list-header>")
  3130. '("</text:list-item>" . "<text:list-header>")))
  3131. ((let ((section? (org-export-get-previous-element
  3132. parent-list info)))
  3133. (and section?
  3134. (eq (org-element-type section?) 'section)
  3135. (assq 'table (org-element-contents section?))))
  3136. '("</text:list-header>" . "<text:list-header>"))
  3137. (t
  3138. '("</text:list-item>" . "<text:list-item>"))))))))))
  3139. (close-open-tags (funcall --walk-list-genealogy-and-collect-tags
  3140. table info)))
  3141. ;; OpenDocument schema does not permit table to occur within a
  3142. ;; list item.
  3143. ;; One solution - the easiest and lightweight, in terms of
  3144. ;; implementation - is to put the table in an indented text box
  3145. ;; and make the text box part of the list-item. Unfortunately if
  3146. ;; the table is big and spans multiple pages, the text box could
  3147. ;; overflow. In this case, the following attribute will come
  3148. ;; handy.
  3149. ;; ,---- From OpenDocument-v1.1.pdf
  3150. ;; | 15.27.28 Overflow behavior
  3151. ;; |
  3152. ;; | For text boxes contained within text document, the
  3153. ;; | style:overflow-behavior property specifies the behavior of text
  3154. ;; | boxes where the containing text does not fit into the text
  3155. ;; | box.
  3156. ;; |
  3157. ;; | If the attribute's value is clip, the text that does not fit
  3158. ;; | into the text box is not displayed.
  3159. ;; |
  3160. ;; | If the attribute value is auto-create-new-frame, a new frame
  3161. ;; | will be created on the next page, with the same position and
  3162. ;; | dimensions of the original frame.
  3163. ;; |
  3164. ;; | If the style:overflow-behavior property's value is
  3165. ;; | auto-create-new-frame and the text box has a minimum width or
  3166. ;; | height specified, then the text box will grow until the page
  3167. ;; | bounds are reached before a new frame is created.
  3168. ;; `----
  3169. ;; Unfortunately, LibreOffice-3.4.6 doesn't honor
  3170. ;; auto-create-new-frame property and always resorts to clipping
  3171. ;; the text box. This results in table being truncated.
  3172. ;; So we solve the problem the hard (and fun) way using list
  3173. ;; continuations.
  3174. ;; The problem only becomes more interesting if you take in to
  3175. ;; account the following facts:
  3176. ;;
  3177. ;; - Description lists are simulated as plain lists.
  3178. ;; - Low-level headlines can be listified.
  3179. ;; - In Org mode, a table can occur not only as a regular list
  3180. ;; item, but also within description lists and low-level
  3181. ;; headlines.
  3182. ;; See `org-odt-translate-description-lists' and
  3183. ;; `org-odt-translate-low-level-headlines' for how this is
  3184. ;; tackled.
  3185. (concat "\n"
  3186. ;; Discontinue the list.
  3187. (mapconcat 'car close-open-tags "\n")
  3188. ;; Put the table in an indented section.
  3189. (let* ((table (org-odt--table table contents info))
  3190. (level (/ (length (mapcar 'car close-open-tags)) 2))
  3191. (style (format "OrgIndentedSection-Level-%d" level)))
  3192. (when table (org-odt-format-section table style)))
  3193. ;; Continue the list.
  3194. (mapconcat 'cdr (nreverse close-open-tags) "\n"))))
  3195. ;;;; Target
  3196. (defun org-odt-target (target _contents info)
  3197. "Transcode a TARGET object from Org to ODT.
  3198. CONTENTS is nil. INFO is a plist holding contextual
  3199. information."
  3200. (org-odt--target "" (org-export-get-reference target info)))
  3201. ;;;; Timestamp
  3202. (defun org-odt-timestamp (timestamp _contents info)
  3203. "Transcode a TIMESTAMP object from Org to ODT.
  3204. CONTENTS is nil. INFO is a plist used as a communication
  3205. channel."
  3206. (let ((type (org-element-property :type timestamp)))
  3207. (if (not (plist-get info :odt-use-date-fields))
  3208. (let ((value (org-odt-plain-text
  3209. (org-timestamp-translate timestamp) info)))
  3210. (cl-case (org-element-property :type timestamp)
  3211. ((active active-range)
  3212. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3213. "OrgActiveTimestamp" value))
  3214. ((inactive inactive-range)
  3215. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3216. "OrgInactiveTimestamp" value))
  3217. (otherwise value)))
  3218. (cl-case type
  3219. (active
  3220. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3221. "OrgActiveTimestamp"
  3222. (format "&lt;%s&gt;" (org-odt--format-timestamp timestamp))))
  3223. (inactive
  3224. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3225. "OrgInactiveTimestamp"
  3226. (format "[%s]" (org-odt--format-timestamp timestamp))))
  3227. (active-range
  3228. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3229. "OrgActiveTimestamp"
  3230. (format "&lt;%s&gt;&#x2013;&lt;%s&gt;"
  3231. (org-odt--format-timestamp timestamp)
  3232. (org-odt--format-timestamp timestamp 'end))))
  3233. (inactive-range
  3234. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3235. "OrgInactiveTimestamp"
  3236. (format "[%s]&#x2013;[%s]"
  3237. (org-odt--format-timestamp timestamp)
  3238. (org-odt--format-timestamp timestamp 'end))))
  3239. (otherwise
  3240. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3241. "OrgDiaryTimestamp"
  3242. (org-odt-plain-text (org-timestamp-translate timestamp)
  3243. info)))))))
  3244. ;;;; Underline
  3245. (defun org-odt-underline (_underline contents _info)
  3246. "Transcode UNDERLINE from Org to ODT.
  3247. CONTENTS is the text with underline markup. INFO is a plist
  3248. holding contextual information."
  3249. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3250. "Underline" contents))
  3251. ;;;; Verbatim
  3252. (defun org-odt-verbatim (verbatim _contents _info)
  3253. "Transcode a VERBATIM object from Org to ODT.
  3254. CONTENTS is nil. INFO is a plist used as a communication
  3255. channel."
  3256. (format "<text:span text:style-name=\"%s\">%s</text:span>"
  3257. "OrgCode" (org-odt--encode-plain-text
  3258. (org-element-property :value verbatim))))
  3259. ;;;; Verse Block
  3260. (defun org-odt-verse-block (_verse-block contents _info)
  3261. "Transcode a VERSE-BLOCK element from Org to ODT.
  3262. CONTENTS is verse block contents. INFO is a plist holding
  3263. contextual information."
  3264. (format "\n<text:p text:style-name=\"OrgVerse\">%s</text:p>"
  3265. (replace-regexp-in-string
  3266. ;; Replace leading tabs and spaces.
  3267. "^[ \t]+" #'org-odt--encode-tabs-and-spaces
  3268. ;; Add line breaks to each line of verse.
  3269. (replace-regexp-in-string
  3270. "\\(<text:line-break/>\\)?[ \t]*$" "<text:line-break/>" contents))))
  3271. ;;; Filters
  3272. ;;; Images
  3273. (defun org-odt--translate-image-links (data _backend info)
  3274. (org-export-insert-image-links data info org-odt-inline-image-rules))
  3275. ;;;; LaTeX fragments
  3276. (defun org-odt--translate-latex-fragments (tree _backend info)
  3277. (let ((processing-type (plist-get info :with-latex))
  3278. (count 0))
  3279. ;; Normalize processing-type to one of dvipng, mathml or verbatim.
  3280. ;; If the desired converter is not available, force verbatim
  3281. ;; processing.
  3282. (cl-case processing-type
  3283. ((t mathml)
  3284. (if (and (fboundp 'org-format-latex-mathml-available-p)
  3285. (org-format-latex-mathml-available-p))
  3286. (setq processing-type 'mathml)
  3287. (message "LaTeX to MathML converter not available.")
  3288. (setq processing-type 'verbatim)))
  3289. ((dvipng imagemagick)
  3290. (unless (and (org-check-external-command "latex" "" t)
  3291. (org-check-external-command
  3292. (if (eq processing-type 'dvipng) "dvipng" "convert") "" t))
  3293. (message "LaTeX to PNG converter not available.")
  3294. (setq processing-type 'verbatim)))
  3295. (otherwise
  3296. (message "Unknown LaTeX option. Forcing verbatim.")
  3297. (setq processing-type 'verbatim)))
  3298. ;; Store normalized value for later use.
  3299. (when (plist-get info :with-latex)
  3300. (plist-put info :with-latex processing-type))
  3301. (message "Formatting LaTeX using %s" processing-type)
  3302. ;; Convert `latex-fragment's and `latex-environment's.
  3303. (when (memq processing-type '(mathml dvipng imagemagick))
  3304. (org-element-map tree '(latex-fragment latex-environment)
  3305. (lambda (latex-*)
  3306. (cl-incf count)
  3307. (let* ((latex-frag (org-element-property :value latex-*))
  3308. (input-file (plist-get info :input-file))
  3309. (cache-dir (file-name-directory input-file))
  3310. (cache-subdir (concat
  3311. (cl-case processing-type
  3312. ((dvipng imagemagick) "ltxpng/")
  3313. (mathml "ltxmathml/"))
  3314. (file-name-sans-extension
  3315. (file-name-nondirectory input-file))))
  3316. (display-msg
  3317. (cl-case processing-type
  3318. ((dvipng imagemagick)
  3319. (format "Creating LaTeX Image %d..." count))
  3320. (mathml (format "Creating MathML snippet %d..." count))))
  3321. ;; Get an Org-style link to PNG image or the MathML
  3322. ;; file.
  3323. (link
  3324. (with-temp-buffer
  3325. (insert latex-frag)
  3326. ;; When converting to a PNG image, make sure to
  3327. ;; copy all LaTeX header specifications from the
  3328. ;; Org source.
  3329. (unless (eq processing-type 'mathml)
  3330. (let ((h (plist-get info :latex-header)))
  3331. (when h
  3332. (insert "\n"
  3333. (replace-regexp-in-string
  3334. "^" "#+LATEX_HEADER: " h)))))
  3335. (org-format-latex cache-subdir nil nil cache-dir
  3336. nil display-msg nil
  3337. processing-type)
  3338. (goto-char (point-min))
  3339. (skip-chars-forward " \t\n")
  3340. (org-element-link-parser))))
  3341. (if (not (eq 'link (org-element-type link)))
  3342. (message "LaTeX Conversion failed.")
  3343. ;; Conversion succeeded. Parse above Org-style link to
  3344. ;; a `link' object.
  3345. (let ((replacement
  3346. (cl-case (org-element-type latex-*)
  3347. ;;LaTeX environment. Mimic a "standalone image
  3348. ;; or formula" by enclosing the `link' in
  3349. ;; a `paragraph'. Copy over original
  3350. ;; attributes, captions to the enclosing
  3351. ;; paragraph.
  3352. (latex-environment
  3353. (org-element-adopt-elements
  3354. (list 'paragraph
  3355. (list :style "OrgFormula"
  3356. :name
  3357. (org-element-property :name latex-*)
  3358. :caption
  3359. (org-element-property :caption latex-*)))
  3360. link))
  3361. ;; LaTeX fragment. No special action.
  3362. (latex-fragment link))))
  3363. ;; Note down the object that link replaces.
  3364. (org-element-put-property replacement :replaces
  3365. (list (org-element-type latex-*)
  3366. (list :value latex-frag)))
  3367. ;; Restore blank after initial element or object.
  3368. (org-element-put-property
  3369. replacement :post-blank
  3370. (org-element-property :post-blank latex-*))
  3371. ;; Replace now.
  3372. (org-element-set-element latex-* replacement)))))
  3373. info nil nil t)))
  3374. tree)
  3375. ;;;; Description lists
  3376. ;; This translator is necessary to handle indented tables in a uniform
  3377. ;; manner. See comment in `org-odt--table'.
  3378. (defun org-odt--translate-description-lists (tree _backend info)
  3379. ;; OpenDocument has no notion of a description list. So simulate it
  3380. ;; using plain lists. Description lists in the exported document
  3381. ;; are typeset in the same manner as they are in a typical HTML
  3382. ;; document.
  3383. ;;
  3384. ;; Specifically, a description list like this:
  3385. ;;
  3386. ;; ,----
  3387. ;; | - term-1 :: definition-1
  3388. ;; | - term-2 :: definition-2
  3389. ;; `----
  3390. ;;
  3391. ;; gets translated in to the following form:
  3392. ;;
  3393. ;; ,----
  3394. ;; | - term-1
  3395. ;; | - definition-1
  3396. ;; | - term-2
  3397. ;; | - definition-2
  3398. ;; `----
  3399. ;;
  3400. ;; Further effect is achieved by fixing the OD styles as below:
  3401. ;;
  3402. ;; 1. Set the :type property of the simulated lists to
  3403. ;; `descriptive-1' and `descriptive-2'. Map these to list-styles
  3404. ;; that has *no* bullets whatsoever.
  3405. ;;
  3406. ;; 2. The paragraph containing the definition term is styled to be
  3407. ;; in bold.
  3408. ;;
  3409. (org-element-map tree 'plain-list
  3410. (lambda (el)
  3411. (when (eq (org-element-property :type el) 'descriptive)
  3412. (org-element-set-element
  3413. el
  3414. (apply 'org-element-adopt-elements
  3415. (list 'plain-list (list :type 'descriptive-1))
  3416. (mapcar
  3417. (lambda (item)
  3418. (org-element-adopt-elements
  3419. (list 'item (list :checkbox (org-element-property
  3420. :checkbox item)))
  3421. (list 'paragraph (list :style "Text_20_body_20_bold")
  3422. (or (org-element-property :tag item) "(no term)"))
  3423. (org-element-adopt-elements
  3424. (list 'plain-list (list :type 'descriptive-2))
  3425. (apply 'org-element-adopt-elements
  3426. (list 'item nil)
  3427. (org-element-contents item)))))
  3428. (org-element-contents el)))))
  3429. nil)
  3430. info)
  3431. tree)
  3432. ;;;; List tables
  3433. ;; Lists that are marked with attribute `:list-table' are called as
  3434. ;; list tables. They will be rendered as a table within the exported
  3435. ;; document.
  3436. ;; Consider an example. The following list table
  3437. ;;
  3438. ;; #+attr_odt :list-table t
  3439. ;; - Row 1
  3440. ;; - 1.1
  3441. ;; - 1.2
  3442. ;; - 1.3
  3443. ;; - Row 2
  3444. ;; - 2.1
  3445. ;; - 2.2
  3446. ;; - 2.3
  3447. ;;
  3448. ;; will be exported as though it were an Org table like the one show
  3449. ;; below.
  3450. ;;
  3451. ;; | Row 1 | 1.1 | 1.2 | 1.3 |
  3452. ;; | Row 2 | 2.1 | 2.2 | 2.3 |
  3453. ;;
  3454. ;; Note that org-tables are NOT multi-line and each line is mapped to
  3455. ;; a unique row in the exported document. So if an exported table
  3456. ;; needs to contain a single paragraph (with copious text) it needs to
  3457. ;; be typed up in a single line. Editing such long lines using the
  3458. ;; table editor will be a cumbersome task. Furthermore inclusion of
  3459. ;; multi-paragraph text in a table cell is well-nigh impossible.
  3460. ;;
  3461. ;; A LIST-TABLE circumvents above problems.
  3462. ;;
  3463. ;; Note that in the example above the list items could be paragraphs
  3464. ;; themselves and the list can be arbitrarily deep.
  3465. ;;
  3466. ;; Inspired by following thread:
  3467. ;; https://lists.gnu.org/r/emacs-orgmode/2011-03/msg01101.html
  3468. ;; Translate lists to tables
  3469. (defun org-odt--translate-list-tables (tree _backend info)
  3470. (org-element-map tree 'plain-list
  3471. (lambda (l1-list)
  3472. (when (org-export-read-attribute :attr_odt l1-list :list-table)
  3473. ;; Replace list with table.
  3474. (org-element-set-element
  3475. l1-list
  3476. ;; Build replacement table.
  3477. (apply 'org-element-adopt-elements
  3478. (list 'table '(:type org :attr_odt (":style \"GriddedTable\"")))
  3479. (org-element-map l1-list 'item
  3480. (lambda (l1-item)
  3481. (let* ((l1-item-contents (org-element-contents l1-item))
  3482. l1-item-leading-text l2-list)
  3483. ;; Remove Level-2 list from the Level-item. It
  3484. ;; will be subsequently attached as table-cells.
  3485. (let ((cur l1-item-contents) prev)
  3486. (while (and cur (not (eq (org-element-type (car cur))
  3487. 'plain-list)))
  3488. (setq prev cur)
  3489. (setq cur (cdr cur)))
  3490. (when prev
  3491. (setcdr prev nil)
  3492. (setq l2-list (car cur)))
  3493. (setq l1-item-leading-text l1-item-contents))
  3494. ;; Level-1 items start a table row.
  3495. (apply 'org-element-adopt-elements
  3496. (list 'table-row (list :type 'standard))
  3497. ;; Leading text of level-1 item define
  3498. ;; the first table-cell.
  3499. (apply 'org-element-adopt-elements
  3500. (list 'table-cell nil)
  3501. l1-item-leading-text)
  3502. ;; Level-2 items define subsequent
  3503. ;; table-cells of the row.
  3504. (org-element-map l2-list 'item
  3505. (lambda (l2-item)
  3506. (apply 'org-element-adopt-elements
  3507. (list 'table-cell nil)
  3508. (org-element-contents l2-item)))
  3509. info nil 'item))))
  3510. info nil 'item))))
  3511. nil)
  3512. info)
  3513. tree)
  3514. ;;; Interactive functions
  3515. (defun org-odt-create-manifest-file-entry (&rest args)
  3516. (push args org-odt-manifest-file-entries))
  3517. (defun org-odt-write-manifest-file ()
  3518. (make-directory (concat org-odt-zip-dir "META-INF"))
  3519. (let ((manifest-file (concat org-odt-zip-dir "META-INF/manifest.xml")))
  3520. (with-current-buffer
  3521. (let ((nxml-auto-insert-xml-declaration-flag nil))
  3522. (find-file-noselect manifest-file t))
  3523. (insert
  3524. "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
  3525. <manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\" manifest:version=\"1.2\">\n")
  3526. (dolist (file-entry org-odt-manifest-file-entries)
  3527. (let* ((version (nth 2 file-entry))
  3528. (extra (if (not version) ""
  3529. (format " manifest:version=\"%s\"" version))))
  3530. (insert
  3531. (format org-odt-manifest-file-entry-tag
  3532. (nth 0 file-entry) (nth 1 file-entry) extra))))
  3533. (insert "\n</manifest:manifest>"))))
  3534. (defmacro org-odt--export-wrap (out-file &rest body)
  3535. `(let* ((--out-file ,out-file)
  3536. (out-file-type (file-name-extension --out-file))
  3537. (org-odt-xml-files '("META-INF/manifest.xml" "content.xml"
  3538. "meta.xml" "styles.xml"))
  3539. ;; Initialize temporary workarea. All files that end up in
  3540. ;; the exported document get parked/created here.
  3541. (org-odt-zip-dir (file-name-as-directory
  3542. (make-temp-file (format "%s-" out-file-type) t)))
  3543. (org-odt-manifest-file-entries nil)
  3544. (--cleanup-xml-buffers
  3545. (lambda ()
  3546. ;; Kill all XML buffers.
  3547. (dolist (file org-odt-xml-files)
  3548. (let ((buf (find-buffer-visiting
  3549. (concat org-odt-zip-dir file))))
  3550. (when buf
  3551. (with-current-buffer buf
  3552. (set-buffer-modified-p nil)
  3553. (kill-buffer buf)))))
  3554. ;; Delete temporary directory and also other embedded
  3555. ;; files that get copied there.
  3556. (delete-directory org-odt-zip-dir t))))
  3557. (condition-case err
  3558. (progn
  3559. (unless (executable-find "zip")
  3560. ;; Not at all OSes ship with zip by default
  3561. (error "Executable \"zip\" needed for creating OpenDocument files"))
  3562. ;; Do export. This creates a bunch of xml files ready to be
  3563. ;; saved and zipped.
  3564. (progn ,@body)
  3565. ;; Create a manifest entry for content.xml.
  3566. (org-odt-create-manifest-file-entry "text/xml" "content.xml")
  3567. ;; Write mimetype file
  3568. (let* ((mimetypes
  3569. '(("odt" . "application/vnd.oasis.opendocument.text")
  3570. ("odf" . "application/vnd.oasis.opendocument.formula")))
  3571. (mimetype (cdr (assoc-string out-file-type mimetypes t))))
  3572. (unless mimetype
  3573. (error "Unknown OpenDocument backend %S" out-file-type))
  3574. (write-region mimetype nil (concat org-odt-zip-dir "mimetype"))
  3575. (org-odt-create-manifest-file-entry mimetype "/" "1.2"))
  3576. ;; Write out the manifest entries before zipping
  3577. (org-odt-write-manifest-file)
  3578. ;; Save all XML files.
  3579. (dolist (file org-odt-xml-files)
  3580. (let ((buf (find-buffer-visiting
  3581. (concat org-odt-zip-dir file))))
  3582. (when buf
  3583. (with-current-buffer buf
  3584. ;; Prettify output if needed.
  3585. (when org-odt-prettify-xml
  3586. (indent-region (point-min) (point-max)))
  3587. (save-buffer 0)))))
  3588. ;; Run zip.
  3589. (let* ((target --out-file)
  3590. (target-name (file-name-nondirectory target))
  3591. (cmds `(("zip" "-mX0" ,target-name "mimetype")
  3592. ("zip" "-rmTq" ,target-name "."))))
  3593. ;; If a file with same name as the desired output file
  3594. ;; exists, remove it.
  3595. (when (file-exists-p target)
  3596. (delete-file target))
  3597. ;; Zip up the xml files.
  3598. (let ((coding-system-for-write 'no-conversion) exitcode err-string)
  3599. (message "Creating ODT file...")
  3600. ;; Switch temporarily to content.xml. This way Zip
  3601. ;; process will inherit `org-odt-zip-dir' as the current
  3602. ;; directory.
  3603. (with-current-buffer
  3604. (find-file-noselect (concat org-odt-zip-dir "content.xml") t)
  3605. (dolist (cmd cmds)
  3606. (message "Running %s" (mapconcat 'identity cmd " "))
  3607. (setq err-string
  3608. (with-output-to-string
  3609. (setq exitcode
  3610. (apply 'call-process (car cmd)
  3611. nil standard-output nil (cdr cmd)))))
  3612. (or (zerop exitcode)
  3613. (error (concat "Unable to create OpenDocument file."
  3614. " Zip failed with error (%s)")
  3615. err-string)))))
  3616. ;; Move the zip file from temporary work directory to
  3617. ;; user-mandated location.
  3618. (rename-file (concat org-odt-zip-dir target-name) target)
  3619. (message "Created %s" (expand-file-name target))
  3620. ;; Cleanup work directory and work files.
  3621. (funcall --cleanup-xml-buffers)
  3622. ;; Open the OpenDocument file in archive-mode for
  3623. ;; examination.
  3624. (find-file-noselect target t)
  3625. ;; Return exported file.
  3626. (cond
  3627. ;; Case 1: Conversion desired on exported file. Run the
  3628. ;; converter on the OpenDocument file. Return the
  3629. ;; converted file.
  3630. (org-odt-preferred-output-format
  3631. (or (org-odt-convert target org-odt-preferred-output-format)
  3632. target))
  3633. ;; Case 2: No further conversion. Return exported
  3634. ;; OpenDocument file.
  3635. (t target))))
  3636. (error
  3637. ;; Cleanup work directory and work files.
  3638. (funcall --cleanup-xml-buffers)
  3639. (message "OpenDocument export failed: %s"
  3640. (error-message-string err))))))
  3641. ;;;; Export to OpenDocument formula
  3642. ;;;###autoload
  3643. (defun org-odt-export-as-odf (latex-frag &optional odf-file)
  3644. "Export LATEX-FRAG as OpenDocument formula file ODF-FILE.
  3645. Use `org-create-math-formula' to convert LATEX-FRAG first to
  3646. MathML. When invoked as an interactive command, use
  3647. `org-latex-regexps' to infer LATEX-FRAG from currently active
  3648. region. If no LaTeX fragments are found, prompt for it. Push
  3649. MathML source to kill ring depending on the value of
  3650. `org-export-copy-to-kill-ring'."
  3651. (interactive
  3652. `(,(let (frag)
  3653. (setq frag (and (setq frag (and (region-active-p)
  3654. (buffer-substring (region-beginning)
  3655. (region-end))))
  3656. (cl-loop for e in org-latex-regexps
  3657. thereis (when (string-match (nth 1 e) frag)
  3658. (match-string (nth 2 e) frag)))))
  3659. (read-string "LaTeX Fragment: " frag nil frag))
  3660. ,(let ((odf-filename (expand-file-name
  3661. (concat
  3662. (file-name-sans-extension
  3663. (or (file-name-nondirectory buffer-file-name)))
  3664. "." "odf")
  3665. (file-name-directory buffer-file-name))))
  3666. (read-file-name "ODF filename: " nil odf-filename nil
  3667. (file-name-nondirectory odf-filename)))))
  3668. (let ((filename (or odf-file
  3669. (expand-file-name
  3670. (concat
  3671. (file-name-sans-extension
  3672. (or (file-name-nondirectory buffer-file-name)))
  3673. "." "odf")
  3674. (file-name-directory buffer-file-name)))))
  3675. (org-odt--export-wrap
  3676. filename
  3677. (let* ((buffer (progn
  3678. (require 'nxml-mode)
  3679. (let ((nxml-auto-insert-xml-declaration-flag nil))
  3680. (find-file-noselect (concat org-odt-zip-dir
  3681. "content.xml") t))))
  3682. (coding-system-for-write 'utf-8)
  3683. (save-buffer-coding-system 'utf-8))
  3684. (set-buffer buffer)
  3685. (set-buffer-file-coding-system coding-system-for-write)
  3686. (let ((mathml (org-create-math-formula latex-frag)))
  3687. (unless mathml (error "No Math formula created"))
  3688. (insert mathml)
  3689. ;; Add MathML to kill ring, if needed.
  3690. (when (org-export--copy-to-kill-ring-p)
  3691. (org-kill-new (buffer-string))))))))
  3692. ;;;###autoload
  3693. (defun org-odt-export-as-odf-and-open ()
  3694. "Export LaTeX fragment as OpenDocument formula and immediately open it.
  3695. Use `org-odt-export-as-odf' to read LaTeX fragment and OpenDocument
  3696. formula file."
  3697. (interactive)
  3698. (org-open-file (call-interactively 'org-odt-export-as-odf) 'system))
  3699. ;;;; Export to OpenDocument Text
  3700. ;;;###autoload
  3701. (defun org-odt-export-to-odt (&optional async subtreep visible-only ext-plist)
  3702. "Export current buffer to a ODT file.
  3703. If narrowing is active in the current buffer, only export its
  3704. narrowed part.
  3705. If a region is active, export that region.
  3706. A non-nil optional argument ASYNC means the process should happen
  3707. asynchronously. The resulting file should be accessible through
  3708. the `org-export-stack' interface.
  3709. When optional argument SUBTREEP is non-nil, export the sub-tree
  3710. at point, extracting information from the headline properties
  3711. first.
  3712. When optional argument VISIBLE-ONLY is non-nil, don't export
  3713. contents of hidden elements.
  3714. EXT-PLIST, when provided, is a property list with external
  3715. parameters overriding Org default settings, but still inferior to
  3716. file-local settings.
  3717. Return output file's name."
  3718. (interactive)
  3719. (let ((outfile (org-export-output-file-name ".odt" subtreep)))
  3720. (if async
  3721. (org-export-async-start (lambda (f) (org-export-add-to-stack f 'odt))
  3722. `(expand-file-name
  3723. (org-odt--export-wrap
  3724. ,outfile
  3725. (let* ((org-odt-embedded-images-count 0)
  3726. (org-odt-embedded-formulas-count 0)
  3727. (org-odt-automatic-styles nil)
  3728. (org-odt-object-counters nil)
  3729. ;; Let `htmlfontify' know that we are interested in
  3730. ;; collecting styles.
  3731. (hfy-user-sheet-assoc nil))
  3732. ;; Initialize content.xml and kick-off the export
  3733. ;; process.
  3734. (let ((out-buf
  3735. (progn
  3736. (require 'nxml-mode)
  3737. (let ((nxml-auto-insert-xml-declaration-flag nil))
  3738. (find-file-noselect
  3739. (concat org-odt-zip-dir "content.xml") t))))
  3740. (output (org-export-as
  3741. 'odt ,subtreep ,visible-only nil ,ext-plist)))
  3742. (with-current-buffer out-buf
  3743. (erase-buffer)
  3744. (insert output)))))))
  3745. (org-odt--export-wrap
  3746. outfile
  3747. (let* ((org-odt-embedded-images-count 0)
  3748. (org-odt-embedded-formulas-count 0)
  3749. (org-odt-automatic-styles nil)
  3750. (org-odt-object-counters nil)
  3751. ;; Let `htmlfontify' know that we are interested in collecting
  3752. ;; styles.
  3753. (hfy-user-sheet-assoc nil))
  3754. ;; Initialize content.xml and kick-off the export process.
  3755. (let ((output (org-export-as 'odt subtreep visible-only nil ext-plist))
  3756. (out-buf (progn
  3757. (require 'nxml-mode)
  3758. (let ((nxml-auto-insert-xml-declaration-flag nil))
  3759. (find-file-noselect
  3760. (concat org-odt-zip-dir "content.xml") t)))))
  3761. (with-current-buffer out-buf (erase-buffer) (insert output))))))))
  3762. ;;;; Convert between OpenDocument and other formats
  3763. (defun org-odt-reachable-p (in-fmt out-fmt)
  3764. "Return non-nil if IN-FMT can be converted to OUT-FMT."
  3765. (catch 'done
  3766. (let ((reachable-formats (org-odt-do-reachable-formats in-fmt)))
  3767. (dolist (e reachable-formats)
  3768. (let ((out-fmt-spec (assoc out-fmt (cdr e))))
  3769. (when out-fmt-spec
  3770. (throw 'done (cons (car e) out-fmt-spec))))))))
  3771. (defun org-odt-do-convert (in-file out-fmt &optional open)
  3772. "Workhorse routine for `org-odt-convert'."
  3773. (require 'browse-url)
  3774. (let* ((in-file (let ((f (expand-file-name (or in-file buffer-file-name))))
  3775. (if (file-readable-p f) f
  3776. (error "Cannot read %s" in-file))))
  3777. (in-fmt (file-name-extension in-file))
  3778. (out-fmt (or out-fmt (error "Output format unspecified")))
  3779. (how (or (org-odt-reachable-p in-fmt out-fmt)
  3780. (error "Cannot convert from %s format to %s format?"
  3781. in-fmt out-fmt)))
  3782. (convert-process (car how))
  3783. (out-file (concat (file-name-sans-extension in-file) "."
  3784. (nth 1 (or (cdr how) out-fmt))))
  3785. (extra-options (or (nth 2 (cdr how)) ""))
  3786. (out-dir (file-name-directory in-file))
  3787. (cmd (format-spec convert-process
  3788. `((?i . ,(shell-quote-argument in-file))
  3789. (?I . ,(browse-url-file-url in-file))
  3790. (?f . ,out-fmt)
  3791. (?o . ,out-file)
  3792. (?O . ,(browse-url-file-url out-file))
  3793. (?d . , (shell-quote-argument out-dir))
  3794. (?D . ,(browse-url-file-url out-dir))
  3795. (?x . ,extra-options)))))
  3796. (when (file-exists-p out-file)
  3797. (delete-file out-file))
  3798. (message "Executing %s" cmd)
  3799. (let ((cmd-output (shell-command-to-string cmd)))
  3800. (message "%s" cmd-output))
  3801. (cond
  3802. ((file-exists-p out-file)
  3803. (message "Exported to %s" out-file)
  3804. (when open
  3805. (message "Opening %s..." out-file)
  3806. (org-open-file out-file 'system))
  3807. out-file)
  3808. (t
  3809. (message "Export to %s failed" out-file)
  3810. nil))))
  3811. (defun org-odt-do-reachable-formats (in-fmt)
  3812. "Return verbose info about formats to which IN-FMT can be converted.
  3813. Return a list where each element is of the
  3814. form (CONVERTER-PROCESS . OUTPUT-FMT-ALIST). See
  3815. `org-odt-convert-processes' for CONVERTER-PROCESS and see
  3816. `org-odt-convert-capabilities' for OUTPUT-FMT-ALIST."
  3817. (let* ((converter
  3818. (and org-odt-convert-process
  3819. (cadr (assoc-string org-odt-convert-process
  3820. org-odt-convert-processes t))))
  3821. (capabilities
  3822. (and org-odt-convert-process
  3823. (cadr (assoc-string org-odt-convert-process
  3824. org-odt-convert-processes t))
  3825. org-odt-convert-capabilities))
  3826. reachable-formats)
  3827. (when converter
  3828. (dolist (c capabilities)
  3829. (when (member in-fmt (nth 1 c))
  3830. (push (cons converter (nth 2 c)) reachable-formats))))
  3831. reachable-formats))
  3832. (defun org-odt-reachable-formats (in-fmt)
  3833. "Return list of formats to which IN-FMT can be converted.
  3834. The list of the form (OUTPUT-FMT-1 OUTPUT-FMT-2 ...)."
  3835. (copy-sequence
  3836. (apply #'append (mapcar
  3837. (lambda (e) (mapcar #'car (cdr e)))
  3838. (org-odt-do-reachable-formats in-fmt)))))
  3839. (defun org-odt-convert-read-params ()
  3840. "Return IN-FILE and OUT-FMT params for `org-odt-do-convert'.
  3841. This is a helper routine for interactive use."
  3842. (let* ((input (if (featurep 'ido) 'ido-completing-read 'completing-read))
  3843. (in-file (read-file-name "File to be converted: "
  3844. nil buffer-file-name t))
  3845. (in-fmt (file-name-extension in-file))
  3846. (out-fmt-choices (org-odt-reachable-formats in-fmt))
  3847. (out-fmt
  3848. (or (and out-fmt-choices
  3849. (funcall input "Output format: "
  3850. out-fmt-choices nil nil nil))
  3851. (error
  3852. "No known converter or no known output formats for %s files"
  3853. in-fmt))))
  3854. (list in-file out-fmt)))
  3855. ;;;###autoload
  3856. (defun org-odt-convert (&optional in-file out-fmt open)
  3857. "Convert IN-FILE to format OUT-FMT using a command line converter.
  3858. IN-FILE is the file to be converted. If unspecified, it defaults
  3859. to variable `buffer-file-name'. OUT-FMT is the desired output
  3860. format. Use `org-odt-convert-process' as the converter. If OPEN
  3861. is non-nil then the newly converted file is opened using
  3862. `org-open-file'."
  3863. (interactive
  3864. (append (org-odt-convert-read-params) current-prefix-arg))
  3865. (org-odt-do-convert in-file out-fmt open))
  3866. ;;; Library Initializations
  3867. (dolist (desc org-odt-file-extensions)
  3868. ;; Let Emacs open all OpenDocument files in archive mode.
  3869. (add-to-list 'auto-mode-alist
  3870. (cons (concat "\\." (car desc) "\\'") 'archive-mode)))
  3871. (provide 'ox-odt)
  3872. ;; Local variables:
  3873. ;; generated-autoload-file: "org-loaddefs.el"
  3874. ;; End:
  3875. ;;; ox-odt.el ends here