org-e-odt.el 156 KB

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