org-e-odt.el 142 KB

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