ox-odt.el 159 KB

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