ox-latex.el 129 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704
  1. ;;; ox-latex.el --- LaTeX Back-End for Org Export Engine -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2011-2017 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This file is part of GNU Emacs.
  6. ;; GNU Emacs is free software: you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation, either version 3 of the License, or
  9. ;; (at your option) any later version.
  10. ;; GNU Emacs is distributed in the hope that it will be useful,
  11. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. ;; GNU General Public License for more details.
  14. ;; You should have received a copy of the GNU General Public License
  15. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;;
  18. ;; See Org manual for details.
  19. ;;; Code:
  20. (require 'cl-lib)
  21. (require 'ox)
  22. (require 'ox-publish)
  23. (defvar org-latex-default-packages-alist)
  24. (defvar org-latex-packages-alist)
  25. (defvar orgtbl-exp-regexp)
  26. ;;; Define Back-End
  27. (org-export-define-backend 'latex
  28. '((bold . org-latex-bold)
  29. (center-block . org-latex-center-block)
  30. (clock . org-latex-clock)
  31. (code . org-latex-code)
  32. (drawer . org-latex-drawer)
  33. (dynamic-block . org-latex-dynamic-block)
  34. (entity . org-latex-entity)
  35. (example-block . org-latex-example-block)
  36. (export-block . org-latex-export-block)
  37. (export-snippet . org-latex-export-snippet)
  38. (fixed-width . org-latex-fixed-width)
  39. (footnote-definition . org-latex-footnote-definition)
  40. (footnote-reference . org-latex-footnote-reference)
  41. (headline . org-latex-headline)
  42. (horizontal-rule . org-latex-horizontal-rule)
  43. (inline-src-block . org-latex-inline-src-block)
  44. (inlinetask . org-latex-inlinetask)
  45. (italic . org-latex-italic)
  46. (item . org-latex-item)
  47. (keyword . org-latex-keyword)
  48. (latex-environment . org-latex-latex-environment)
  49. (latex-fragment . org-latex-latex-fragment)
  50. (line-break . org-latex-line-break)
  51. (link . org-latex-link)
  52. (node-property . org-latex-node-property)
  53. (paragraph . org-latex-paragraph)
  54. (plain-list . org-latex-plain-list)
  55. (plain-text . org-latex-plain-text)
  56. (planning . org-latex-planning)
  57. (property-drawer . org-latex-property-drawer)
  58. (quote-block . org-latex-quote-block)
  59. (radio-target . org-latex-radio-target)
  60. (section . org-latex-section)
  61. (special-block . org-latex-special-block)
  62. (src-block . org-latex-src-block)
  63. (statistics-cookie . org-latex-statistics-cookie)
  64. (strike-through . org-latex-strike-through)
  65. (subscript . org-latex-subscript)
  66. (superscript . org-latex-superscript)
  67. (table . org-latex-table)
  68. (table-cell . org-latex-table-cell)
  69. (table-row . org-latex-table-row)
  70. (target . org-latex-target)
  71. (template . org-latex-template)
  72. (timestamp . org-latex-timestamp)
  73. (underline . org-latex-underline)
  74. (verbatim . org-latex-verbatim)
  75. (verse-block . org-latex-verse-block)
  76. ;; Pseudo objects and elements.
  77. (latex-math-block . org-latex-math-block)
  78. (latex-matrices . org-latex-matrices))
  79. :menu-entry
  80. '(?l "Export to LaTeX"
  81. ((?L "As LaTeX buffer" org-latex-export-as-latex)
  82. (?l "As LaTeX file" org-latex-export-to-latex)
  83. (?p "As PDF file" org-latex-export-to-pdf)
  84. (?o "As PDF file and open"
  85. (lambda (a s v b)
  86. (if a (org-latex-export-to-pdf t s v b)
  87. (org-open-file (org-latex-export-to-pdf nil s v b)))))))
  88. :filters-alist '((:filter-options . org-latex-math-block-options-filter)
  89. (:filter-paragraph . org-latex-clean-invalid-line-breaks)
  90. (:filter-parse-tree org-latex-math-block-tree-filter
  91. org-latex-matrices-tree-filter)
  92. (:filter-verse-block . org-latex-clean-invalid-line-breaks))
  93. :options-alist
  94. '((:latex-class "LATEX_CLASS" nil org-latex-default-class t)
  95. (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t)
  96. (:latex-header "LATEX_HEADER" nil nil newline)
  97. (:latex-header-extra "LATEX_HEADER_EXTRA" nil nil newline)
  98. (:description "DESCRIPTION" nil nil parse)
  99. (:keywords "KEYWORDS" nil nil parse)
  100. (:subtitle "SUBTITLE" nil nil parse)
  101. ;; Other variables.
  102. (:latex-active-timestamp-format nil nil org-latex-active-timestamp-format)
  103. (:latex-caption-above nil nil org-latex-caption-above)
  104. (:latex-classes nil nil org-latex-classes)
  105. (:latex-default-figure-position nil nil org-latex-default-figure-position)
  106. (:latex-default-table-environment nil nil org-latex-default-table-environment)
  107. (:latex-default-table-mode nil nil org-latex-default-table-mode)
  108. (:latex-diary-timestamp-format nil nil org-latex-diary-timestamp-format)
  109. (:latex-footnote-defined-format nil nil org-latex-footnote-defined-format)
  110. (:latex-footnote-separator nil nil org-latex-footnote-separator)
  111. (:latex-format-drawer-function nil nil org-latex-format-drawer-function)
  112. (:latex-format-headline-function nil nil org-latex-format-headline-function)
  113. (:latex-format-inlinetask-function nil nil org-latex-format-inlinetask-function)
  114. (:latex-hyperref-template nil nil org-latex-hyperref-template t)
  115. (:latex-image-default-height nil nil org-latex-image-default-height)
  116. (:latex-image-default-option nil nil org-latex-image-default-option)
  117. (:latex-image-default-width nil nil org-latex-image-default-width)
  118. (:latex-images-centered nil nil org-latex-images-centered)
  119. (:latex-inactive-timestamp-format nil nil org-latex-inactive-timestamp-format)
  120. (:latex-inline-image-rules nil nil org-latex-inline-image-rules)
  121. (:latex-link-with-unknown-path-format nil nil org-latex-link-with-unknown-path-format)
  122. (:latex-listings nil nil org-latex-listings)
  123. (:latex-listings-langs nil nil org-latex-listings-langs)
  124. (:latex-listings-options nil nil org-latex-listings-options)
  125. (:latex-minted-langs nil nil org-latex-minted-langs)
  126. (:latex-minted-options nil nil org-latex-minted-options)
  127. (:latex-prefer-user-labels nil nil org-latex-prefer-user-labels)
  128. (:latex-subtitle-format nil nil org-latex-subtitle-format)
  129. (:latex-subtitle-separate nil nil org-latex-subtitle-separate)
  130. (:latex-table-scientific-notation nil nil org-latex-table-scientific-notation)
  131. (:latex-tables-booktabs nil nil org-latex-tables-booktabs)
  132. (:latex-tables-centered nil nil org-latex-tables-centered)
  133. (:latex-text-markup-alist nil nil org-latex-text-markup-alist)
  134. (:latex-title-command nil nil org-latex-title-command)
  135. (:latex-toc-command nil nil org-latex-toc-command)
  136. (:latex-compiler "LATEX_COMPILER" nil org-latex-compiler)
  137. ;; Redefine regular options.
  138. (:date "DATE" nil "\\today" parse)))
  139. ;;; Internal Variables
  140. (defconst org-latex-babel-language-alist
  141. '(("af" . "afrikaans")
  142. ("bg" . "bulgarian")
  143. ("bt-br" . "brazilian")
  144. ("ca" . "catalan")
  145. ("cs" . "czech")
  146. ("cy" . "welsh")
  147. ("da" . "danish")
  148. ("de" . "germanb")
  149. ("de-at" . "naustrian")
  150. ("de-de" . "ngerman")
  151. ("el" . "greek")
  152. ("en" . "english")
  153. ("en-au" . "australian")
  154. ("en-ca" . "canadian")
  155. ("en-gb" . "british")
  156. ("en-ie" . "irish")
  157. ("en-nz" . "newzealand")
  158. ("en-us" . "american")
  159. ("es" . "spanish")
  160. ("et" . "estonian")
  161. ("eu" . "basque")
  162. ("fi" . "finnish")
  163. ("fr" . "frenchb")
  164. ("fr-ca" . "canadien")
  165. ("gl" . "galician")
  166. ("hr" . "croatian")
  167. ("hu" . "hungarian")
  168. ("id" . "indonesian")
  169. ("is" . "icelandic")
  170. ("it" . "italian")
  171. ("la" . "latin")
  172. ("ms" . "malay")
  173. ("nl" . "dutch")
  174. ("nb" . "norsk")
  175. ("nn" . "nynorsk")
  176. ("no" . "norsk")
  177. ("pl" . "polish")
  178. ("pt" . "portuguese")
  179. ("ro" . "romanian")
  180. ("ru" . "russian")
  181. ("sa" . "sanskrit")
  182. ("sb" . "uppersorbian")
  183. ("sk" . "slovak")
  184. ("sl" . "slovene")
  185. ("sq" . "albanian")
  186. ("sr" . "serbian")
  187. ("sv" . "swedish")
  188. ("ta" . "tamil")
  189. ("tr" . "turkish")
  190. ("uk" . "ukrainian"))
  191. "Alist between language code and corresponding Babel option.")
  192. (defconst org-latex-polyglossia-language-alist
  193. '(("am" "amharic")
  194. ("ast" "asturian")
  195. ("ar" "arabic")
  196. ("bo" "tibetan")
  197. ("bn" "bengali")
  198. ("bg" "bulgarian")
  199. ("br" "breton")
  200. ("bt-br" "brazilian")
  201. ("ca" "catalan")
  202. ("cop" "coptic")
  203. ("cs" "czech")
  204. ("cy" "welsh")
  205. ("da" "danish")
  206. ("de" "german" "german")
  207. ("de-at" "german" "austrian")
  208. ("de-de" "german" "german")
  209. ("dv" "divehi")
  210. ("el" "greek")
  211. ("en" "english" "usmax")
  212. ("en-au" "english" "australian")
  213. ("en-gb" "english" "uk")
  214. ("en-nz" "english" "newzealand")
  215. ("en-us" "english" "usmax")
  216. ("eo" "esperanto")
  217. ("es" "spanish")
  218. ("et" "estonian")
  219. ("eu" "basque")
  220. ("fa" "farsi")
  221. ("fi" "finnish")
  222. ("fr" "french")
  223. ("fu" "friulan")
  224. ("ga" "irish")
  225. ("gd" "scottish")
  226. ("gl" "galician")
  227. ("he" "hebrew")
  228. ("hi" "hindi")
  229. ("hr" "croatian")
  230. ("hu" "magyar")
  231. ("hy" "armenian")
  232. ("id" "bahasai")
  233. ("ia" "interlingua")
  234. ("is" "icelandic")
  235. ("it" "italian")
  236. ("kn" "kannada")
  237. ("la" "latin" "modern")
  238. ("la-modern" "latin" "modern")
  239. ("la-classic" "latin" "classic")
  240. ("la-medieval" "latin" "medieval")
  241. ("lo" "lao")
  242. ("lt" "lithuanian")
  243. ("lv" "latvian")
  244. ("mr" "maranthi")
  245. ("ml" "malayalam")
  246. ("nl" "dutch")
  247. ("nb" "norsk")
  248. ("nn" "nynorsk")
  249. ("nko" "nko")
  250. ("no" "norsk")
  251. ("oc" "occitan")
  252. ("pl" "polish")
  253. ("pms" "piedmontese")
  254. ("pt" "portuges")
  255. ("rm" "romansh")
  256. ("ro" "romanian")
  257. ("ru" "russian")
  258. ("sa" "sanskrit")
  259. ("hsb" "usorbian")
  260. ("dsb" "lsorbian")
  261. ("sk" "slovak")
  262. ("sl" "slovenian")
  263. ("se" "samin")
  264. ("sq" "albanian")
  265. ("sr" "serbian")
  266. ("sv" "swedish")
  267. ("syr" "syriac")
  268. ("ta" "tamil")
  269. ("te" "telugu")
  270. ("th" "thai")
  271. ("tk" "turkmen")
  272. ("tr" "turkish")
  273. ("uk" "ukrainian")
  274. ("ur" "urdu")
  275. ("vi" "vietnamese"))
  276. "Alist between language code and corresponding Polyglossia option")
  277. (defconst org-latex-table-matrix-macros '(("bordermatrix" . "\\cr")
  278. ("qbordermatrix" . "\\cr")
  279. ("kbordermatrix" . "\\\\"))
  280. "Alist between matrix macros and their row ending.")
  281. (defconst org-latex-math-environments-re
  282. (format
  283. "\\`[ \t]*\\\\begin{%s\\*?}"
  284. (regexp-opt
  285. '("equation" "eqnarray" "math" "displaymath"
  286. "align" "gather" "multline" "flalign" "alignat"
  287. "xalignat" "xxalignat"
  288. "subequations"
  289. ;; breqn
  290. "dmath" "dseries" "dgroup" "darray"
  291. ;; empheq
  292. "empheq")))
  293. "Regexp of LaTeX math environments.")
  294. ;;; User Configurable Variables
  295. (defgroup org-export-latex nil
  296. "Options for exporting Org mode files to LaTeX."
  297. :tag "Org Export LaTeX"
  298. :group 'org-export)
  299. ;;;; Generic
  300. (defcustom org-latex-caption-above '(table)
  301. "When non-nil, place caption string at the beginning of elements.
  302. Otherwise, place it near the end. When value is a list of
  303. symbols, put caption above selected elements only. Allowed
  304. symbols are: `image', `table', `src-block' and `special-block'."
  305. :group 'org-export-latex
  306. :version "26.1"
  307. :package-version '(Org . "8.3")
  308. :type '(choice
  309. (const :tag "For all elements" t)
  310. (const :tag "For no element" nil)
  311. (set :tag "For the following elements only" :greedy t
  312. (const :tag "Images" image)
  313. (const :tag "Tables" table)
  314. (const :tag "Source code" src-block)
  315. (const :tag "Special blocks" special-block))))
  316. (defcustom org-latex-prefer-user-labels nil
  317. "Use user-provided labels instead of internal ones when non-nil.
  318. When this variable is non-nil, Org will use the value of
  319. CUSTOM_ID property, NAME keyword or Org target as the key for the
  320. \\label commands generated.
  321. By default, Org generates its own internal labels during LaTeX
  322. export. This process ensures that the \\label keys are unique
  323. and valid, but it means the keys are not available in advance of
  324. the export process.
  325. Setting this variable gives you control over how Org generates
  326. labels during LaTeX export, so that you may know their keys in
  327. advance. One reason to do this is that it allows you to refer to
  328. various elements using a single label both in Org's link syntax
  329. and in embedded LaTeX code.
  330. For example, when this variable is non-nil, a headline like this:
  331. ** Some section
  332. :PROPERTIES:
  333. :CUSTOM_ID: sec:foo
  334. :END:
  335. This is section [[#sec:foo]].
  336. #+BEGIN_EXPORT latex
  337. And this is still section \\ref{sec:foo}.
  338. #+END_EXPORT
  339. will be exported to LaTeX as:
  340. \\subsection{Some section}
  341. \\label{sec:foo}
  342. This is section \\ref{sec:foo}.
  343. And this is still section \\ref{sec:foo}.
  344. Note, however, that setting this variable introduces a limitation
  345. on the possible values for CUSTOM_ID and NAME. When this
  346. variable is non-nil, Org passes their value to \\label unchanged.
  347. You are responsible for ensuring that the value is a valid LaTeX
  348. \\label key, and that no other \\label commands with the same key
  349. appear elsewhere in your document. (Keys may contain letters,
  350. numbers, and the following punctuation: '_' '.' '-' ':'.) There
  351. are no such limitations on CUSTOM_ID and NAME when this variable
  352. is nil.
  353. For headlines that do not define the CUSTOM_ID property or
  354. elements without a NAME, Org will continue to use its default
  355. labeling scheme to generate labels and resolve links into proper
  356. references."
  357. :group 'org-export-latex
  358. :type 'boolean
  359. :version "26.1"
  360. :package-version '(Org . "8.3"))
  361. ;;;; Preamble
  362. (defcustom org-latex-default-class "article"
  363. "The default LaTeX class."
  364. :group 'org-export-latex
  365. :type '(string :tag "LaTeX class"))
  366. (defcustom org-latex-classes
  367. '(("article"
  368. "\\documentclass[11pt]{article}"
  369. ("\\section{%s}" . "\\section*{%s}")
  370. ("\\subsection{%s}" . "\\subsection*{%s}")
  371. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
  372. ("\\paragraph{%s}" . "\\paragraph*{%s}")
  373. ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
  374. ("report"
  375. "\\documentclass[11pt]{report}"
  376. ("\\part{%s}" . "\\part*{%s}")
  377. ("\\chapter{%s}" . "\\chapter*{%s}")
  378. ("\\section{%s}" . "\\section*{%s}")
  379. ("\\subsection{%s}" . "\\subsection*{%s}")
  380. ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
  381. ("book"
  382. "\\documentclass[11pt]{book}"
  383. ("\\part{%s}" . "\\part*{%s}")
  384. ("\\chapter{%s}" . "\\chapter*{%s}")
  385. ("\\section{%s}" . "\\section*{%s}")
  386. ("\\subsection{%s}" . "\\subsection*{%s}")
  387. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
  388. "Alist of LaTeX classes and associated header and structure.
  389. If #+LATEX_CLASS is set in the buffer, use its value and the
  390. associated information. Here is the structure of each cell:
  391. (class-name
  392. header-string
  393. (numbered-section . unnumbered-section)
  394. ...)
  395. The header string
  396. -----------------
  397. The HEADER-STRING is the header that will be inserted into the
  398. LaTeX file. It should contain the \\documentclass macro, and
  399. anything else that is needed for this setup. To this header, the
  400. following commands will be added:
  401. - Calls to \\usepackage for all packages mentioned in the
  402. variables `org-latex-default-packages-alist' and
  403. `org-latex-packages-alist'. Thus, your header definitions
  404. should avoid to also request these packages.
  405. - Lines specified via \"#+LATEX_HEADER:\" and
  406. \"#+LATEX_HEADER_EXTRA:\" keywords.
  407. If you need more control about the sequence in which the header
  408. is built up, or if you want to exclude one of these building
  409. blocks for a particular class, you can use the following
  410. macro-like placeholders.
  411. [DEFAULT-PACKAGES] \\usepackage statements for default packages
  412. [NO-DEFAULT-PACKAGES] do not include any of the default packages
  413. [PACKAGES] \\usepackage statements for packages
  414. [NO-PACKAGES] do not include the packages
  415. [EXTRA] the stuff from #+LATEX_HEADER(_EXTRA)
  416. [NO-EXTRA] do not include #+LATEX_HEADER(_EXTRA) stuff
  417. So a header like
  418. \\documentclass{article}
  419. [NO-DEFAULT-PACKAGES]
  420. [EXTRA]
  421. \\providecommand{\\alert}[1]{\\textbf{#1}}
  422. [PACKAGES]
  423. will omit the default packages, and will include the
  424. #+LATEX_HEADER and #+LATEX_HEADER_EXTRA lines, then have a call
  425. to \\providecommand, and then place \\usepackage commands based
  426. on the content of `org-latex-packages-alist'.
  427. If your header, `org-latex-default-packages-alist' or
  428. `org-latex-packages-alist' inserts \"\\usepackage[AUTO]{inputenc}\",
  429. AUTO will automatically be replaced with a coding system derived
  430. from `buffer-file-coding-system'. See also the variable
  431. `org-latex-inputenc-alist' for a way to influence this mechanism.
  432. Likewise, if your header contains \"\\usepackage[AUTO]{babel}\"
  433. or \"\\usepackage[AUTO]{polyglossia}\", AUTO will be replaced
  434. with the language related to the language code specified by
  435. `org-export-default-language'. Note that constructions such as
  436. \"\\usepackage[french,AUTO,english]{babel}\" are permitted. For
  437. Polyglossia the language will be set via the macros
  438. \"\\setmainlanguage\" and \"\\setotherlanguage\". See also
  439. `org-latex-guess-babel-language' and
  440. `org-latex-guess-polyglossia-language'.
  441. The sectioning structure
  442. ------------------------
  443. The sectioning structure of the class is given by the elements
  444. following the header string. For each sectioning level, a number
  445. of strings is specified. A %s formatter is mandatory in each
  446. section string and will be replaced by the title of the section.
  447. Instead of a cons cell (numbered . unnumbered), you can also
  448. provide a list of 2 or 4 elements,
  449. (numbered-open numbered-close)
  450. or
  451. (numbered-open numbered-close unnumbered-open unnumbered-close)
  452. providing opening and closing strings for a LaTeX environment
  453. that should represent the document section. The opening clause
  454. should have a %s to represent the section title.
  455. Instead of a list of sectioning commands, you can also specify
  456. a function name. That function will be called with two
  457. parameters, the (reduced) level of the headline, and a predicate
  458. non-nil when the headline should be numbered. It must return
  459. a format string in which the section title will be added."
  460. :group 'org-export-latex
  461. :type '(repeat
  462. (list (string :tag "LaTeX class")
  463. (string :tag "LaTeX header")
  464. (repeat :tag "Levels" :inline t
  465. (choice
  466. (cons :tag "Heading"
  467. (string :tag " numbered")
  468. (string :tag "unnumbered"))
  469. (list :tag "Environment"
  470. (string :tag "Opening (numbered)")
  471. (string :tag "Closing (numbered)")
  472. (string :tag "Opening (unnumbered)")
  473. (string :tag "Closing (unnumbered)"))
  474. (function :tag "Hook computing sectioning"))))))
  475. (defcustom org-latex-inputenc-alist nil
  476. "Alist of inputenc coding system names, and what should really be used.
  477. For example, adding an entry
  478. (\"utf8\" . \"utf8x\")
  479. will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
  480. are written as utf8 files."
  481. :group 'org-export-latex
  482. :type '(repeat
  483. (cons
  484. (string :tag "Derived from buffer")
  485. (string :tag "Use this instead"))))
  486. (defcustom org-latex-title-command "\\maketitle"
  487. "The command used to insert the title just after \\begin{document}.
  488. This format string may contain these elements:
  489. %a for AUTHOR keyword
  490. %t for TITLE keyword
  491. %s for SUBTITLE keyword
  492. %k for KEYWORDS line
  493. %d for DESCRIPTION line
  494. %c for CREATOR line
  495. %l for Language keyword
  496. %L for capitalized language keyword
  497. %D for DATE keyword
  498. If you need to use a \"%\" character, you need to escape it
  499. like that: \"%%\".
  500. Setting :latex-title-command in publishing projects will take
  501. precedence over this variable."
  502. :group 'org-export-latex
  503. :type '(string :tag "Format string"))
  504. (defcustom org-latex-subtitle-format "\\\\\\medskip\n\\large %s"
  505. "Format string used for transcoded subtitle.
  506. The format string should have at most one \"%s\"-expression,
  507. which is replaced with the subtitle."
  508. :group 'org-export-latex
  509. :version "26.1"
  510. :package-version '(Org . "8.3")
  511. :type '(string :tag "Format string"))
  512. (defcustom org-latex-subtitle-separate nil
  513. "Non-nil means the subtitle is not typeset as part of title."
  514. :group 'org-export-latex
  515. :version "26.1"
  516. :package-version '(Org . "8.3")
  517. :type 'boolean)
  518. (defcustom org-latex-toc-command "\\tableofcontents\n\n"
  519. "LaTeX command to set the table of contents, list of figures, etc.
  520. This command only applies to the table of contents generated with
  521. the toc:nil option, not to those generated with #+TOC keyword."
  522. :group 'org-export-latex
  523. :type 'string)
  524. (defcustom org-latex-hyperref-template
  525. "\\hypersetup{\n pdfauthor={%a},\n pdftitle={%t},\n pdfkeywords={%k},
  526. pdfsubject={%d},\n pdfcreator={%c}, \n pdflang={%L}}\n"
  527. "Template for hyperref package options.
  528. This format string may contain these elements:
  529. %a for AUTHOR keyword
  530. %t for TITLE keyword
  531. %s for SUBTITLE keyword
  532. %k for KEYWORDS line
  533. %d for DESCRIPTION line
  534. %c for CREATOR line
  535. %l for Language keyword
  536. %L for capitalized language keyword
  537. %D for DATE keyword
  538. If you need to use a \"%\" character, you need to escape it
  539. like that: \"%%\".
  540. As a special case, a nil value prevents template from being
  541. inserted.
  542. Setting :latex-hyperref-template in publishing projects will take
  543. precedence over this variable."
  544. :group 'org-export-latex
  545. :version "26.1"
  546. :package-version '(Org . "8.3")
  547. :type '(choice (const :tag "No template" nil)
  548. (string :tag "Format string")))
  549. ;;;; Headline
  550. (defcustom org-latex-format-headline-function
  551. 'org-latex-format-headline-default-function
  552. "Function for formatting the headline's text.
  553. This function will be called with six arguments:
  554. TODO the todo keyword (string or nil)
  555. TODO-TYPE the type of todo (symbol: `todo', `done', nil)
  556. PRIORITY the priority of the headline (integer or nil)
  557. TEXT the main headline text (string)
  558. TAGS the tags (list of strings or nil)
  559. INFO the export options (plist)
  560. The function result will be used in the section format string."
  561. :group 'org-export-latex
  562. :version "24.4"
  563. :package-version '(Org . "8.0")
  564. :type 'function)
  565. ;;;; Footnotes
  566. (defcustom org-latex-footnote-separator "\\textsuperscript{,}\\,"
  567. "Text used to separate footnotes."
  568. :group 'org-export-latex
  569. :type 'string)
  570. (defcustom org-latex-footnote-defined-format "\\textsuperscript{\\ref{%s}}"
  571. "Format string used to format reference to footnote already defined.
  572. %s will be replaced by the label of the referred footnote."
  573. :group 'org-export-latex
  574. :type '(choice
  575. (const :tag "Use plain superscript (default)" "\\textsuperscript{\\ref{%s}}")
  576. (const :tag "Use Memoir/KOMA-Script footref" "\\footref{%s}")
  577. (string :tag "Other format string"))
  578. :version "26.1"
  579. :package-version '(Org . "9.0"))
  580. ;;;; Timestamps
  581. (defcustom org-latex-active-timestamp-format "\\textit{%s}"
  582. "A printf format string to be applied to active timestamps."
  583. :group 'org-export-latex
  584. :type 'string)
  585. (defcustom org-latex-inactive-timestamp-format "\\textit{%s}"
  586. "A printf format string to be applied to inactive timestamps."
  587. :group 'org-export-latex
  588. :type 'string)
  589. (defcustom org-latex-diary-timestamp-format "\\textit{%s}"
  590. "A printf format string to be applied to diary timestamps."
  591. :group 'org-export-latex
  592. :type 'string)
  593. ;;;; Links
  594. (defcustom org-latex-images-centered t
  595. "When non-nil, images are centered."
  596. :group 'org-export-latex
  597. :version "26.1"
  598. :package-version '(Org . "9.0")
  599. :type 'boolean
  600. :safe #'booleanp)
  601. (defcustom org-latex-image-default-option ""
  602. "Default option for images."
  603. :group 'org-export-latex
  604. :version "24.4"
  605. :package-version '(Org . "8.0")
  606. :type 'string)
  607. (defcustom org-latex-image-default-width ".9\\linewidth"
  608. "Default width for images.
  609. This value will not be used if a height is provided."
  610. :group 'org-export-latex
  611. :version "24.4"
  612. :package-version '(Org . "8.0")
  613. :type 'string)
  614. (defcustom org-latex-image-default-height ""
  615. "Default height for images.
  616. This value will not be used if a width is provided, or if the
  617. image is wrapped within a \"figure\" or \"wrapfigure\"
  618. environment."
  619. :group 'org-export-latex
  620. :version "24.4"
  621. :package-version '(Org . "8.0")
  622. :type 'string)
  623. (defcustom org-latex-default-figure-position "htbp"
  624. "Default position for LaTeX figures."
  625. :group 'org-export-latex
  626. :type 'string
  627. :version "26.1"
  628. :package-version '(Org . "9.0")
  629. :safe #'stringp)
  630. (defcustom org-latex-inline-image-rules
  631. '(("file" . "\\.\\(pdf\\|jpeg\\|jpg\\|png\\|ps\\|eps\\|tikz\\|pgf\\|svg\\)\\'"))
  632. "Rules characterizing image files that can be inlined into LaTeX.
  633. A rule consists in an association whose key is the type of link
  634. to consider, and value is a regexp that will be matched against
  635. link's path.
  636. Note that, by default, the image extension *actually* allowed
  637. depend on the way the LaTeX file is processed. When used with
  638. pdflatex, pdf, jpg and png images are OK. When processing
  639. through dvi to Postscript, only ps and eps are allowed. The
  640. default we use here encompasses both."
  641. :group 'org-export-latex
  642. :version "24.4"
  643. :package-version '(Org . "8.0")
  644. :type '(alist :key-type (string :tag "Type")
  645. :value-type (regexp :tag "Path")))
  646. (defcustom org-latex-link-with-unknown-path-format "\\texttt{%s}"
  647. "Format string for links with unknown path type."
  648. :group 'org-export-latex
  649. :type 'string)
  650. ;;;; Tables
  651. (defcustom org-latex-default-table-environment "tabular"
  652. "Default environment used to build tables."
  653. :group 'org-export-latex
  654. :version "24.4"
  655. :package-version '(Org . "8.0")
  656. :type 'string)
  657. (defcustom org-latex-default-table-mode 'table
  658. "Default mode for tables.
  659. Value can be a symbol among:
  660. `table' Regular LaTeX table.
  661. `math' In this mode, every cell is considered as being in math
  662. mode and the complete table will be wrapped within a math
  663. environment. It is particularly useful to write matrices.
  664. `inline-math' This mode is almost the same as `math', but the
  665. math environment will be inlined.
  666. `verbatim' The table is exported as it appears in the Org
  667. buffer, within a verbatim environment.
  668. This value can be overridden locally with, i.e. \":mode math\" in
  669. LaTeX attributes.
  670. When modifying this variable, it may be useful to change
  671. `org-latex-default-table-environment' accordingly."
  672. :group 'org-export-latex
  673. :version "24.4"
  674. :package-version '(Org . "8.0")
  675. :type '(choice (const :tag "Table" table)
  676. (const :tag "Matrix" math)
  677. (const :tag "Inline matrix" inline-math)
  678. (const :tag "Verbatim" verbatim))
  679. :safe (lambda (s) (memq s '(table math inline-math verbatim))))
  680. (defcustom org-latex-tables-centered t
  681. "When non-nil, tables are exported in a center environment."
  682. :group 'org-export-latex
  683. :type 'boolean
  684. :safe #'booleanp)
  685. (defcustom org-latex-tables-booktabs nil
  686. "When non-nil, display tables in a formal \"booktabs\" style.
  687. This option assumes that the \"booktabs\" package is properly
  688. loaded in the header of the document. This value can be ignored
  689. locally with \":booktabs t\" and \":booktabs nil\" LaTeX
  690. attributes."
  691. :group 'org-export-latex
  692. :version "24.4"
  693. :package-version '(Org . "8.0")
  694. :type 'boolean
  695. :safe #'booleanp)
  696. (defcustom org-latex-table-scientific-notation "%s\\,(%s)"
  697. "Format string to display numbers in scientific notation.
  698. The format should have \"%s\" twice, for mantissa and exponent
  699. \(i.e., \"%s\\\\times10^{%s}\").
  700. When nil, no transformation is made."
  701. :group 'org-export-latex
  702. :version "24.4"
  703. :package-version '(Org . "8.0")
  704. :type '(choice
  705. (string :tag "Format string")
  706. (const :tag "No formatting" nil)))
  707. ;;;; Text markup
  708. (defcustom org-latex-text-markup-alist '((bold . "\\textbf{%s}")
  709. (code . protectedtexttt)
  710. (italic . "\\emph{%s}")
  711. (strike-through . "\\sout{%s}")
  712. (underline . "\\uline{%s}")
  713. (verbatim . protectedtexttt))
  714. "Alist of LaTeX expressions to convert text markup.
  715. The key must be a symbol among `bold', `code', `italic',
  716. `strike-through', `underline' and `verbatim'. The value is
  717. a formatting string to wrap fontified text with.
  718. Value can also be set to the following symbols: `verb' and
  719. `protectedtexttt'. For the former, Org will use \"\\verb\" to
  720. create a format string and select a delimiter character that
  721. isn't in the string. For the latter, Org will use \"\\texttt\"
  722. to typeset and try to protect special characters.
  723. If no association can be found for a given markup, text will be
  724. returned as-is."
  725. :group 'org-export-latex
  726. :version "26.1"
  727. :package-version '(Org . "8.3")
  728. :type 'alist
  729. :options '(bold code italic strike-through underline verbatim))
  730. ;;;; Drawers
  731. (defcustom org-latex-format-drawer-function (lambda (_ contents) contents)
  732. "Function called to format a drawer in LaTeX code.
  733. The function must accept two parameters:
  734. NAME the drawer name, like \"LOGBOOK\"
  735. CONTENTS the contents of the drawer.
  736. The function should return the string to be exported.
  737. The default function simply returns the value of CONTENTS."
  738. :group 'org-export-latex
  739. :version "24.4"
  740. :package-version '(Org . "8.3")
  741. :type 'function)
  742. ;;;; Inlinetasks
  743. (defcustom org-latex-format-inlinetask-function
  744. 'org-latex-format-inlinetask-default-function
  745. "Function called to format an inlinetask in LaTeX code.
  746. The function must accept seven parameters:
  747. TODO the todo keyword (string or nil)
  748. TODO-TYPE the todo type (symbol: `todo', `done', nil)
  749. PRIORITY the inlinetask priority (integer or nil)
  750. NAME the inlinetask name (string)
  751. TAGS the inlinetask tags (list of strings or nil)
  752. CONTENTS the contents of the inlinetask (string or nil)
  753. INFO the export options (plist)
  754. The function should return the string to be exported."
  755. :group 'org-export-latex
  756. :type 'function
  757. :version "26.1"
  758. :package-version '(Org . "8.3"))
  759. ;; Src blocks
  760. (defcustom org-latex-listings nil
  761. "Non-nil means export source code using the listings package.
  762. This package will fontify source code, possibly even with color.
  763. If you want to use this, you also need to make LaTeX use the
  764. listings package, and if you want to have color, the color
  765. package. Just add these to `org-latex-packages-alist', for
  766. example using customize, or with something like:
  767. (require \\='ox-latex)
  768. (add-to-list \\='org-latex-packages-alist \\='(\"\" \"listings\"))
  769. (add-to-list \\='org-latex-packages-alist \\='(\"\" \"color\"))
  770. Alternatively,
  771. (setq org-latex-listings \\='minted)
  772. causes source code to be exported using the minted package as
  773. opposed to listings. If you want to use minted, you need to add
  774. the minted package to `org-latex-packages-alist', for example
  775. using customize, or with
  776. (require \\='ox-latex)
  777. (add-to-list \\='org-latex-packages-alist \\='(\"newfloat\" \"minted\"))
  778. In addition, it is necessary to install pygments
  779. \(http://pygments.org), and to configure the variable
  780. `org-latex-pdf-process' so that the -shell-escape option is
  781. passed to pdflatex.
  782. The minted choice has possible repercussions on the preview of
  783. latex fragments (see `org-preview-latex-fragment'). If you run
  784. into previewing problems, please consult
  785. http://orgmode.org/worg/org-tutorials/org-latex-preview.html"
  786. :group 'org-export-latex
  787. :type '(choice
  788. (const :tag "Use listings" t)
  789. (const :tag "Use minted" minted)
  790. (const :tag "Export verbatim" nil))
  791. :safe (lambda (s) (memq s '(t nil minted))))
  792. (defcustom org-latex-listings-langs
  793. '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
  794. (c "C") (cc "C++")
  795. (fortran "fortran")
  796. (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
  797. (html "HTML") (xml "XML")
  798. (tex "TeX") (latex "[LaTeX]TeX")
  799. (shell-script "bash")
  800. (gnuplot "Gnuplot")
  801. (ocaml "Caml") (caml "Caml")
  802. (sql "SQL") (sqlite "sql")
  803. (makefile "make")
  804. (R "r"))
  805. "Alist mapping languages to their listing language counterpart.
  806. The key is a symbol, the major mode symbol without the \"-mode\".
  807. The value is the string that should be inserted as the language
  808. parameter for the listings package. If the mode name and the
  809. listings name are the same, the language does not need an entry
  810. in this list - but it does not hurt if it is present."
  811. :group 'org-export-latex
  812. :version "24.4"
  813. :package-version '(Org . "8.3")
  814. :type '(repeat
  815. (list
  816. (symbol :tag "Major mode ")
  817. (string :tag "Listings language"))))
  818. (defcustom org-latex-listings-options nil
  819. "Association list of options for the latex listings package.
  820. These options are supplied as a comma-separated list to the
  821. \\lstset command. Each element of the association list should be
  822. a list containing two strings: the name of the option, and the
  823. value. For example,
  824. (setq org-latex-listings-options
  825. \\='((\"basicstyle\" \"\\\\small\")
  826. (\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
  827. will typeset the code in a small size font with underlined, bold
  828. black keywords.
  829. Note that the same options will be applied to blocks of all
  830. languages. If you need block-specific options, you may use the
  831. following syntax:
  832. #+ATTR_LATEX: :options key1=value1,key2=value2
  833. #+BEGIN_SRC <LANG>
  834. ...
  835. #+END_SRC"
  836. :group 'org-export-latex
  837. :type '(repeat
  838. (list
  839. (string :tag "Listings option name ")
  840. (string :tag "Listings option value"))))
  841. (defcustom org-latex-minted-langs
  842. '((emacs-lisp "common-lisp")
  843. (cc "c++")
  844. (cperl "perl")
  845. (shell-script "bash")
  846. (caml "ocaml"))
  847. "Alist mapping languages to their minted language counterpart.
  848. The key is a symbol, the major mode symbol without the \"-mode\".
  849. The value is the string that should be inserted as the language
  850. parameter for the minted package. If the mode name and the
  851. listings name are the same, the language does not need an entry
  852. in this list - but it does not hurt if it is present.
  853. Note that minted uses all lower case for language identifiers,
  854. and that the full list of language identifiers can be obtained
  855. with:
  856. pygmentize -L lexers"
  857. :group 'org-export-latex
  858. :type '(repeat
  859. (list
  860. (symbol :tag "Major mode ")
  861. (string :tag "Minted language"))))
  862. (defcustom org-latex-minted-options nil
  863. "Association list of options for the latex minted package.
  864. These options are supplied within square brackets in
  865. \\begin{minted} environments. Each element of the alist should
  866. be a list containing two strings: the name of the option, and the
  867. value. For example,
  868. (setq org-latex-minted-options
  869. \\='((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
  870. will result in src blocks being exported with
  871. \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
  872. as the start of the minted environment. Note that the same
  873. options will be applied to blocks of all languages. If you need
  874. block-specific options, you may use the following syntax:
  875. #+ATTR_LATEX: :options key1=value1,key2=value2
  876. #+BEGIN_SRC <LANG>
  877. ...
  878. #+END_SRC"
  879. :group 'org-export-latex
  880. :type '(repeat
  881. (list
  882. (string :tag "Minted option name ")
  883. (string :tag "Minted option value"))))
  884. (defcustom org-latex-custom-lang-environments nil
  885. "Alist mapping languages to language-specific LaTeX environments.
  886. It is used during export of src blocks by the listings and minted
  887. latex packages. The environment may be a simple string, composed of
  888. only letters and numbers. In this case, the string is directly the
  889. name of the latex environment to use. The environment may also be
  890. a format string. In this case the format string will be directly
  891. exported. This format string may contain these elements:
  892. %s for the formatted source
  893. %c for the caption
  894. %f for the float attribute
  895. %l for an appropriate label
  896. %o for the LaTeX attributes
  897. For example,
  898. (setq org-latex-custom-lang-environments
  899. \\='((python \"pythoncode\")
  900. (ocaml \"\\\\begin{listing}
  901. \\\\begin{minted}[%o]{ocaml}
  902. %s\\\\end{minted}
  903. \\\\caption{%c}
  904. \\\\label{%l}\")))
  905. would have the effect that if Org encounters a Python source block
  906. during LaTeX export it will produce
  907. \\begin{pythoncode}
  908. <src block body>
  909. \\end{pythoncode}
  910. and if Org encounters an Ocaml source block during LaTeX export it
  911. will produce
  912. \\begin{listing}
  913. \\begin{minted}[<attr_latex options>]{ocaml}
  914. <src block body>
  915. \\end{minted}
  916. \\caption{<caption>}
  917. \\label{<label>}
  918. \\end{listing}"
  919. :group 'org-export-latex
  920. :type '(repeat
  921. (list
  922. (symbol :tag "Language name ")
  923. (string :tag "Environment name or format string")))
  924. :version "26.1"
  925. :package-version '(Org . "9.0"))
  926. ;;;; Compilation
  927. (defcustom org-latex-compiler-file-string "%% Intended LaTeX compiler: %s\n"
  928. "LaTeX compiler format-string.
  929. See also `org-latex-compiler'."
  930. :group 'org-export-latex
  931. :type '(choice
  932. (const :tag "Comment" "%% Intended LaTeX compiler: %s\n")
  933. (const :tag "latex-mode file variable" "%% -*- latex-run-command: %s -*-\n")
  934. (const :tag "AUCTeX file variable" "%% -*- LaTeX-command: %s -*-\n")
  935. (string :tag "custom format" "%% %s"))
  936. :version "26.1"
  937. :package-version '(Org . "9.0"))
  938. (defcustom org-latex-compiler "pdflatex"
  939. "LaTeX compiler to use.
  940. Must be an element in `org-latex-compilers' or the empty quote.
  941. Can also be set in buffers via #+LATEX_COMPILER. See also
  942. `org-latex-compiler-file-string'."
  943. :group 'org-export-latex
  944. :type '(choice
  945. (const :tag "pdfLaTeX" "pdflatex")
  946. (const :tag "XeLaTeX" "xelatex")
  947. (const :tag "LuaLaTeX" "lualatex")
  948. (const :tag "Unset" ""))
  949. :version "26.1"
  950. :package-version '(Org . "9.0"))
  951. (defconst org-latex-compilers '("pdflatex" "xelatex" "lualatex")
  952. "Known LaTeX compilers.
  953. See also `org-latex-compiler'.")
  954. (defcustom org-latex-bib-compiler "bibtex"
  955. "Command to process a LaTeX file's bibliography.
  956. The shorthand %bib in `org-latex-pdf-process' is replaced with
  957. this value.
  958. A better approach is to use a compiler suit such as `latexmk'."
  959. :group 'org-export-latex
  960. :type '(choice (const :tag "BibTeX" "bibtex")
  961. (const :tag "Biber" "biber")
  962. (string :tag "Other process"))
  963. :version "26.1"
  964. :package-version '(Org . "9.0"))
  965. (defcustom org-latex-pdf-process
  966. '("%latex -interaction nonstopmode -output-directory %o %f"
  967. "%latex -interaction nonstopmode -output-directory %o %f"
  968. "%latex -interaction nonstopmode -output-directory %o %f")
  969. "Commands to process a LaTeX file to a PDF file.
  970. This is a list of strings, each of them will be given to the
  971. shell as a command. %f in the command will be replaced by the
  972. relative file name, %F by the absolute file name, %b by the file
  973. base name (i.e. without directory and extension parts), %o by the
  974. base directory of the file, %O by the absolute file name of the
  975. output file, %latex is the LaTeX compiler (see
  976. `org-latex-compiler'), and %bib is the BibTeX-like compiler (see
  977. `org-latex-bib-compiler').
  978. The reason why this is a list is that it usually takes several
  979. runs of `pdflatex', maybe mixed with a call to `bibtex'. Org
  980. does not have a clever mechanism to detect which of these
  981. commands have to be run to get to a stable result, and it also
  982. does not do any error checking.
  983. Consider a smart LaTeX compiler such as `texi2dvi' or `latexmk',
  984. which calls the \"correct\" combinations of auxiliary programs.
  985. Alternatively, this may be a Lisp function that does the
  986. processing, so you could use this to apply the machinery of
  987. AUCTeX or the Emacs LaTeX mode. This function should accept the
  988. file name as its single argument."
  989. :group 'org-export-pdf
  990. :type '(choice
  991. (repeat :tag "Shell command sequence"
  992. (string :tag "Shell command"))
  993. (const :tag "2 runs of latex"
  994. ("%latex -interaction nonstopmode -output-directory %o %f"
  995. "%latex -interaction nonstopmode -output-directory %o %f"))
  996. (const :tag "3 runs of latex"
  997. ("%latex -interaction nonstopmode -output-directory %o %f"
  998. "%latex -interaction nonstopmode -output-directory %o %f"
  999. "%latex -interaction nonstopmode -output-directory %o %f"))
  1000. (const :tag "latex,bibtex,latex,latex"
  1001. ("%latex -interaction nonstopmode -output-directory %o %f"
  1002. "%bib %b"
  1003. "%latex -interaction nonstopmode -output-directory %o %f"
  1004. "%latex -interaction nonstopmode -output-directory %o %f"))
  1005. (const :tag "texi2dvi"
  1006. ("cd %o; LATEX=\"%latex\" texi2dvi -p -b -V %b.tex"))
  1007. (const :tag "latexmk"
  1008. ("latexmk -g -pdf -pdflatex=\"%latex\" -outdir=%o %f"))
  1009. (function)))
  1010. (defcustom org-latex-logfiles-extensions
  1011. '("aux" "bcf" "blg" "fdb_latexmk" "fls" "figlist" "idx" "log" "nav" "out"
  1012. "ptc" "run.xml" "snm" "toc" "vrb" "xdv")
  1013. "The list of file extensions to consider as LaTeX logfiles.
  1014. The logfiles will be removed if `org-latex-remove-logfiles' is
  1015. non-nil."
  1016. :group 'org-export-latex
  1017. :version "26.1"
  1018. :package-version '(Org . "8.3")
  1019. :type '(repeat (string :tag "Extension")))
  1020. (defcustom org-latex-remove-logfiles t
  1021. "Non-nil means remove the logfiles produced by PDF production.
  1022. By default, logfiles are files with these extensions: .aux, .idx,
  1023. .log, .out, .toc, .nav, .snm and .vrb. To define the set of
  1024. logfiles to remove, set `org-latex-logfiles-extensions'."
  1025. :group 'org-export-latex
  1026. :type 'boolean)
  1027. (defcustom org-latex-known-warnings
  1028. '(("Reference.*?undefined" . "[undefined reference]")
  1029. ("Runaway argument" . "[runaway argument]")
  1030. ("Underfull \\hbox" . "[underfull hbox]")
  1031. ("Overfull \\hbox" . "[overfull hbox]")
  1032. ("Citation.*?undefined" . "[undefined citation]")
  1033. ("Undefined control sequence" . "[undefined control sequence]"))
  1034. "Alist of regular expressions and associated messages for the user.
  1035. The regular expressions are used to find possible warnings in the
  1036. log of a latex-run. These warnings will be reported after
  1037. calling `org-latex-compile'."
  1038. :group 'org-export-latex
  1039. :version "26.1"
  1040. :package-version '(Org . "8.3")
  1041. :type '(repeat
  1042. (cons
  1043. (string :tag "Regexp")
  1044. (string :tag "Message"))))
  1045. ;;; Internal Functions
  1046. (defun org-latex--caption-above-p (element info)
  1047. "Non nil when caption is expected to be located above ELEMENT.
  1048. INFO is a plist holding contextual information."
  1049. (let ((above (plist-get info :latex-caption-above)))
  1050. (if (symbolp above) above
  1051. (let ((type (org-element-type element)))
  1052. (memq (if (eq type 'link) 'image type) above)))))
  1053. (defun org-latex--label (datum info &optional force full)
  1054. "Return an appropriate label for DATUM.
  1055. DATUM is an element or a `target' type object. INFO is the
  1056. current export state, as a plist.
  1057. Return nil if element DATUM has no NAME or VALUE affiliated
  1058. keyword or no CUSTOM_ID property, unless FORCE is non-nil. In
  1059. this case always return a unique label.
  1060. Eventually, if FULL is non-nil, wrap label within \"\\label{}\"."
  1061. (let* ((type (org-element-type datum))
  1062. (user-label
  1063. (org-element-property
  1064. (cl-case type
  1065. ((headline inlinetask) :CUSTOM_ID)
  1066. (target :value)
  1067. (otherwise :name))
  1068. datum))
  1069. (label
  1070. (and (or user-label force)
  1071. (if (and user-label (plist-get info :latex-prefer-user-labels))
  1072. user-label
  1073. (concat (cl-case type
  1074. (headline "sec:")
  1075. (table "tab:")
  1076. (latex-environment
  1077. (and (string-match-p
  1078. org-latex-math-environments-re
  1079. (org-element-property :value datum))
  1080. "eq:"))
  1081. (paragraph
  1082. (and (org-element-property :caption datum)
  1083. "fig:")))
  1084. (org-export-get-reference datum info))))))
  1085. (cond ((not full) label)
  1086. (label (format "\\label{%s}%s"
  1087. label
  1088. (if (eq type 'target) "" "\n")))
  1089. (t ""))))
  1090. (defun org-latex--caption/label-string (element info)
  1091. "Return caption and label LaTeX string for ELEMENT.
  1092. INFO is a plist holding contextual information. If there's no
  1093. caption nor label, return the empty string.
  1094. For non-floats, see `org-latex--wrap-label'."
  1095. (let* ((label (org-latex--label element info nil t))
  1096. (main (org-export-get-caption element))
  1097. (attr (org-export-read-attribute :attr_latex element))
  1098. (type (org-element-type element))
  1099. (nonfloat (or (and (plist-member attr :float)
  1100. (not (plist-get attr :float))
  1101. main)
  1102. (and (eq type 'src-block)
  1103. (not (plist-get attr :float))
  1104. (null (plist-get info :latex-listings)))))
  1105. (short (org-export-get-caption element t))
  1106. (caption-from-attr-latex (plist-get attr :caption)))
  1107. (cond
  1108. ((org-string-nw-p caption-from-attr-latex)
  1109. (concat caption-from-attr-latex "\n"))
  1110. ((and (not main) (equal label "")) "")
  1111. ((not main) label)
  1112. ;; Option caption format with short name.
  1113. (t
  1114. (format (if nonfloat "\\captionof{%s}%s{%s%s}\n"
  1115. "\\caption%s%s{%s%s}\n")
  1116. (if nonfloat
  1117. (cl-case type
  1118. (paragraph "figure")
  1119. (src-block (if (plist-get info :latex-listings)
  1120. "listing"
  1121. "figure"))
  1122. (t (symbol-name type)))
  1123. "")
  1124. (if short (format "[%s]" (org-export-data short info)) "")
  1125. label
  1126. (org-export-data main info))))))
  1127. (defun org-latex-guess-inputenc (header)
  1128. "Set the coding system in inputenc to what the buffer is.
  1129. HEADER is the LaTeX header string. This function only applies
  1130. when specified inputenc option is \"AUTO\".
  1131. Return the new header, as a string."
  1132. (let* ((cs (or (ignore-errors
  1133. (latexenc-coding-system-to-inputenc
  1134. (or org-export-coding-system buffer-file-coding-system)))
  1135. "utf8")))
  1136. (if (not cs) header
  1137. ;; First translate if that is requested.
  1138. (setq cs (or (cdr (assoc cs org-latex-inputenc-alist)) cs))
  1139. ;; Then find the \usepackage statement and replace the option.
  1140. (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
  1141. cs header t nil 1))))
  1142. (defun org-latex-guess-babel-language (header info)
  1143. "Set Babel's language according to LANGUAGE keyword.
  1144. HEADER is the LaTeX header string. INFO is the plist used as
  1145. a communication channel.
  1146. Insertion of guessed language only happens when Babel package has
  1147. explicitly been loaded. Then it is added to the rest of
  1148. package's options.
  1149. The argument to Babel may be \"AUTO\" which is then replaced with
  1150. the language of the document or `org-export-default-language'
  1151. unless language in question is already loaded.
  1152. Return the new header."
  1153. (let ((language-code (plist-get info :language)))
  1154. ;; If no language is set or Babel package is not loaded, return
  1155. ;; HEADER as-is.
  1156. (if (or (not (stringp language-code))
  1157. (not (string-match "\\\\usepackage\\[\\(.*\\)\\]{babel}" header)))
  1158. header
  1159. (let ((options (save-match-data
  1160. (org-split-string (match-string 1 header) ",[ \t]*")))
  1161. (language (cdr (assoc-string language-code
  1162. org-latex-babel-language-alist t))))
  1163. ;; If LANGUAGE is already loaded, return header without AUTO.
  1164. ;; Otherwise, replace AUTO with language or append language if
  1165. ;; AUTO is not present.
  1166. (replace-match
  1167. (mapconcat (lambda (option) (if (equal "AUTO" option) language option))
  1168. (cond ((member language options) (delete "AUTO" options))
  1169. ((member "AUTO" options) options)
  1170. (t (append options (list language))))
  1171. ", ")
  1172. t nil header 1)))))
  1173. (defun org-latex-guess-polyglossia-language (header info)
  1174. "Set the Polyglossia language according to the LANGUAGE keyword.
  1175. HEADER is the LaTeX header string. INFO is the plist used as
  1176. a communication channel.
  1177. Insertion of guessed language only happens when the Polyglossia
  1178. package has been explicitly loaded.
  1179. The argument to Polyglossia may be \"AUTO\" which is then
  1180. replaced with the language of the document or
  1181. `org-export-default-language'. Note, the language is really set
  1182. using \setdefaultlanguage and not as an option to the package.
  1183. Return the new header."
  1184. (let ((language (plist-get info :language)))
  1185. ;; If no language is set or Polyglossia is not loaded, return
  1186. ;; HEADER as-is.
  1187. (if (or (not (stringp language))
  1188. (not (string-match
  1189. "\\\\usepackage\\(?:\\[\\([^]]+?\\)\\]\\){polyglossia}\n"
  1190. header)))
  1191. header
  1192. (let* ((options (org-string-nw-p (match-string 1 header)))
  1193. (languages (and options
  1194. ;; Reverse as the last loaded language is
  1195. ;; the main language.
  1196. (nreverse
  1197. (delete-dups
  1198. (save-match-data
  1199. (org-split-string
  1200. (replace-regexp-in-string
  1201. "AUTO" language options t)
  1202. ",[ \t]*"))))))
  1203. (main-language-set
  1204. (string-match-p "\\\\setmainlanguage{.*?}" header)))
  1205. (replace-match
  1206. (concat "\\usepackage{polyglossia}\n"
  1207. (mapconcat
  1208. (lambda (l)
  1209. (let ((l (or (assoc l org-latex-polyglossia-language-alist)
  1210. l)))
  1211. (format (if main-language-set "\\setotherlanguage%s{%s}\n"
  1212. (setq main-language-set t)
  1213. "\\setmainlanguage%s{%s}\n")
  1214. (if (and (consp l) (= (length l) 3))
  1215. (format "[variant=%s]" (nth 2 l))
  1216. "")
  1217. (nth 1 l))))
  1218. languages
  1219. ""))
  1220. t t header 0)))))
  1221. (defun org-latex--remove-packages (pkg-alist info)
  1222. "Remove packages based on the current LaTeX compiler.
  1223. If the fourth argument of an element is set in pkg-alist, and it
  1224. is not a member of the LaTeX compiler of the document, the packages
  1225. is removed. See also `org-latex-compiler'.
  1226. Return modified pkg-alist."
  1227. (let ((compiler (or (plist-get info :latex-compiler) "")))
  1228. (if (member-ignore-case compiler org-latex-compilers)
  1229. (delq nil
  1230. (mapcar
  1231. (lambda (pkg)
  1232. (unless (and
  1233. (listp pkg)
  1234. (let ((third (nth 3 pkg)))
  1235. (and third
  1236. (not (member-ignore-case
  1237. compiler
  1238. (if (listp third) third (list third)))))))
  1239. pkg))
  1240. pkg-alist))
  1241. pkg-alist)))
  1242. (defun org-latex--find-verb-separator (s)
  1243. "Return a character not used in string S.
  1244. This is used to choose a separator for constructs like \\verb."
  1245. (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
  1246. (cl-loop for c across ll
  1247. when (not (string-match (regexp-quote (char-to-string c)) s))
  1248. return (char-to-string c))))
  1249. (defun org-latex--make-option-string (options)
  1250. "Return a comma separated string of keywords and values.
  1251. OPTIONS is an alist where the key is the options keyword as
  1252. a string, and the value a list containing the keyword value, or
  1253. nil."
  1254. (mapconcat (lambda (pair)
  1255. (pcase-let ((`(,keyword ,value) pair))
  1256. (concat keyword
  1257. (and (> (length value) 0)
  1258. (concat "=" value)))))
  1259. options
  1260. ","))
  1261. (defun org-latex--wrap-label (element output info)
  1262. "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
  1263. INFO is the current export state, as a plist. This function
  1264. should not be used for floats. See
  1265. `org-latex--caption/label-string'."
  1266. (if (not (and (org-string-nw-p output) (org-element-property :name element)))
  1267. output
  1268. (concat (format "\\phantomsection\n\\label{%s}\n"
  1269. (org-latex--label element info))
  1270. output)))
  1271. (defun org-latex--protect-text (text)
  1272. "Protect special characters in string TEXT and return it."
  1273. (replace-regexp-in-string "[\\{}$%&_#~^]" "\\\\\\&" text))
  1274. (defun org-latex--text-markup (text markup info)
  1275. "Format TEXT depending on MARKUP text markup.
  1276. INFO is a plist used as a communication channel. See
  1277. `org-latex-text-markup-alist' for details."
  1278. (let ((fmt (cdr (assq markup (plist-get info :latex-text-markup-alist)))))
  1279. (cl-case fmt
  1280. ;; No format string: Return raw text.
  1281. ((nil) text)
  1282. ;; Handle the `verb' special case: Find an appropriate separator
  1283. ;; and use "\\verb" command.
  1284. (verb
  1285. (let ((separator (org-latex--find-verb-separator text)))
  1286. (concat "\\verb"
  1287. separator
  1288. (replace-regexp-in-string "\n" " " text)
  1289. separator)))
  1290. ;; Handle the `protectedtexttt' special case: Protect some
  1291. ;; special chars and use "\texttt{%s}" format string.
  1292. (protectedtexttt
  1293. (format "\\texttt{%s}"
  1294. (replace-regexp-in-string
  1295. "--\\|[\\{}$%&_#~^]"
  1296. (lambda (m)
  1297. (cond ((equal m "--") "-{}-")
  1298. ((equal m "\\") "\\textbackslash{}")
  1299. ((equal m "~") "\\textasciitilde{}")
  1300. ((equal m "^") "\\textasciicircum{}")
  1301. (t (org-latex--protect-text m))))
  1302. text nil t)))
  1303. ;; Else use format string.
  1304. (t (format fmt text)))))
  1305. (defun org-latex--delayed-footnotes-definitions (element info)
  1306. "Return footnotes definitions in ELEMENT as a string.
  1307. INFO is a plist used as a communication channel.
  1308. Footnotes definitions are returned within \"\\footnotetext{}\"
  1309. commands.
  1310. This function is used within constructs that don't support
  1311. \"\\footnote{}\" command (e.g., an item tag). In that case,
  1312. \"\\footnotemark\" is used within the construct and the function
  1313. just outside of it."
  1314. (mapconcat
  1315. (lambda (ref)
  1316. (let ((def (org-export-get-footnote-definition ref info)))
  1317. (format "\\footnotetext[%d]{%s%s}"
  1318. (org-export-get-footnote-number ref info)
  1319. (org-trim (org-latex--label def info t t))
  1320. (org-trim (org-export-data def info)))))
  1321. ;; Find every footnote reference in ELEMENT.
  1322. (letrec ((all-refs nil)
  1323. (search-refs
  1324. (lambda (data)
  1325. ;; Return a list of all footnote references never seen
  1326. ;; before in DATA.
  1327. (org-element-map data 'footnote-reference
  1328. (lambda (ref)
  1329. (when (org-export-footnote-first-reference-p ref info)
  1330. (push ref all-refs)
  1331. (when (eq (org-element-property :type ref) 'standard)
  1332. (funcall search-refs
  1333. (org-export-get-footnote-definition ref info)))))
  1334. info)
  1335. (reverse all-refs))))
  1336. (funcall search-refs element))
  1337. ""))
  1338. (defun org-latex--translate (s info)
  1339. "Translate string S according to specified language.
  1340. INFO is a plist used as a communication channel."
  1341. (org-export-translate s :latex info))
  1342. (defun org-latex--format-spec (info)
  1343. "Create a format-spec for document meta-data.
  1344. INFO is a plist used as a communication channel."
  1345. (let ((language (let ((lang (plist-get info :language)))
  1346. (or (cdr (assoc-string lang org-latex-babel-language-alist t))
  1347. (nth 1 (assoc-string lang org-latex-polyglossia-language-alist t))
  1348. lang))))
  1349. `((?a . ,(org-export-data (plist-get info :author) info))
  1350. (?t . ,(org-export-data (plist-get info :title) info))
  1351. (?k . ,(org-export-data (org-latex--wrap-latex-math-block
  1352. (plist-get info :keywords) info)
  1353. info))
  1354. (?d . ,(org-export-data (org-latex--wrap-latex-math-block
  1355. (plist-get info :description) info)
  1356. info))
  1357. (?c . ,(plist-get info :creator))
  1358. (?l . ,language)
  1359. (?L . ,(capitalize language))
  1360. (?D . ,(org-export-get-date info)))))
  1361. (defun org-latex--insert-compiler (info)
  1362. "Insert LaTeX_compiler info into the document.
  1363. INFO is a plist used as a communication channel."
  1364. (let ((compiler (plist-get info :latex-compiler)))
  1365. (and (org-string-nw-p org-latex-compiler-file-string)
  1366. (member (or compiler "") org-latex-compilers)
  1367. (format org-latex-compiler-file-string compiler))))
  1368. ;;; Filters
  1369. (defun org-latex-matrices-tree-filter (tree _backend info)
  1370. (org-latex--wrap-latex-matrices tree info))
  1371. (defun org-latex-math-block-tree-filter (tree _backend info)
  1372. (org-latex--wrap-latex-math-block tree info))
  1373. (defun org-latex-math-block-options-filter (info _backend)
  1374. (dolist (prop '(:author :date :title) info)
  1375. (plist-put info prop
  1376. (org-latex--wrap-latex-math-block (plist-get info prop) info))))
  1377. (defun org-latex-clean-invalid-line-breaks (data _backend _info)
  1378. (replace-regexp-in-string
  1379. "\\(\\end{[A-Za-z0-9*]+}\\|^\\)[ \t]*\\\\\\\\[ \t]*$" "\\1"
  1380. data))
  1381. ;;; Template
  1382. ;;;###autoload
  1383. (defun org-latex-make-preamble (info &optional template)
  1384. "Return a formatted LaTeX preamble.
  1385. INFO is a plist used as a communication channel. Optional
  1386. argument TEMPLATE, when non-nil, is the header template string,
  1387. as expected by `org-splice-latex-header'."
  1388. (let* ((class (plist-get info :latex-class))
  1389. (class-options (plist-get info :latex-class-options))
  1390. (header (nth 1 (assoc class (plist-get info :latex-classes))))
  1391. (class-template
  1392. (or template
  1393. (and (stringp header)
  1394. (if (not class-options) header
  1395. (replace-regexp-in-string
  1396. "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
  1397. class-options header t nil 1)))
  1398. (user-error "Unknown LaTeX class `%s'" class))))
  1399. (org-latex-guess-polyglossia-language
  1400. (org-latex-guess-babel-language
  1401. (org-latex-guess-inputenc
  1402. (org-element-normalize-string
  1403. (org-splice-latex-header
  1404. class-template
  1405. (org-latex--remove-packages org-latex-default-packages-alist info)
  1406. (org-latex--remove-packages org-latex-packages-alist info)
  1407. nil
  1408. (mapconcat #'org-element-normalize-string
  1409. (list (plist-get info :latex-header)
  1410. (plist-get info :latex-header-extra)) ""))))
  1411. info)
  1412. info)))
  1413. (defun org-latex-template (contents info)
  1414. "Return complete document string after LaTeX conversion.
  1415. CONTENTS is the transcoded contents string. INFO is a plist
  1416. holding export options."
  1417. (let ((title (org-export-data (plist-get info :title) info))
  1418. (spec (org-latex--format-spec info)))
  1419. (concat
  1420. ;; Time-stamp.
  1421. (and (plist-get info :time-stamp-file)
  1422. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  1423. ;; LaTeX compiler.
  1424. (org-latex--insert-compiler info)
  1425. ;; Document class and packages.
  1426. (org-latex-make-preamble info)
  1427. ;; Possibly limit depth for headline numbering.
  1428. (let ((sec-num (plist-get info :section-numbers)))
  1429. (when (integerp sec-num)
  1430. (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
  1431. ;; Author.
  1432. (let ((author (and (plist-get info :with-author)
  1433. (let ((auth (plist-get info :author)))
  1434. (and auth (org-export-data auth info)))))
  1435. (email (and (plist-get info :with-email)
  1436. (org-export-data (plist-get info :email) info))))
  1437. (cond ((and author email (not (string= "" email)))
  1438. (format "\\author{%s\\thanks{%s}}\n" author email))
  1439. ((or author email) (format "\\author{%s}\n" (or author email)))))
  1440. ;; Date.
  1441. (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
  1442. (format "\\date{%s}\n" (org-export-data date info)))
  1443. ;; Title and subtitle.
  1444. (let* ((subtitle (plist-get info :subtitle))
  1445. (formatted-subtitle
  1446. (when subtitle
  1447. (format (plist-get info :latex-subtitle-format)
  1448. (org-export-data subtitle info))))
  1449. (separate (plist-get info :latex-subtitle-separate)))
  1450. (concat
  1451. (format "\\title{%s%s}\n" title
  1452. (if separate "" (or formatted-subtitle "")))
  1453. (when (and separate subtitle)
  1454. (concat formatted-subtitle "\n"))))
  1455. ;; Hyperref options.
  1456. (let ((template (plist-get info :latex-hyperref-template)))
  1457. (and (stringp template)
  1458. (format-spec template spec)))
  1459. ;; Document start.
  1460. "\\begin{document}\n\n"
  1461. ;; Title command.
  1462. (let* ((title-command (plist-get info :latex-title-command))
  1463. (command (and (stringp title-command)
  1464. (format-spec title-command spec))))
  1465. (org-element-normalize-string
  1466. (cond ((not (plist-get info :with-title)) nil)
  1467. ((string= "" title) nil)
  1468. ((not (stringp command)) nil)
  1469. ((string-match "\\(?:[^%]\\|^\\)%s" command)
  1470. (format command title))
  1471. (t command))))
  1472. ;; Table of contents.
  1473. (let ((depth (plist-get info :with-toc)))
  1474. (when depth
  1475. (concat (when (wholenump depth)
  1476. (format "\\setcounter{tocdepth}{%d}\n" depth))
  1477. (plist-get info :latex-toc-command))))
  1478. ;; Document's body.
  1479. contents
  1480. ;; Creator.
  1481. (and (plist-get info :with-creator)
  1482. (concat (plist-get info :creator) "\n"))
  1483. ;; Document end.
  1484. "\\end{document}")))
  1485. ;;; Transcode Functions
  1486. ;;;; Bold
  1487. (defun org-latex-bold (_bold contents info)
  1488. "Transcode BOLD from Org to LaTeX.
  1489. CONTENTS is the text with bold markup. INFO is a plist holding
  1490. contextual information."
  1491. (org-latex--text-markup contents 'bold info))
  1492. ;;;; Center Block
  1493. (defun org-latex-center-block (center-block contents info)
  1494. "Transcode a CENTER-BLOCK element from Org to LaTeX.
  1495. CONTENTS holds the contents of the center block. INFO is a plist
  1496. holding contextual information."
  1497. (org-latex--wrap-label
  1498. center-block (format "\\begin{center}\n%s\\end{center}" contents) info))
  1499. ;;;; Clock
  1500. (defun org-latex-clock (clock _contents info)
  1501. "Transcode a CLOCK element from Org to LaTeX.
  1502. CONTENTS is nil. INFO is a plist holding contextual
  1503. information."
  1504. (concat
  1505. "\\noindent"
  1506. (format "\\textbf{%s} " org-clock-string)
  1507. (format (plist-get info :latex-inactive-timestamp-format)
  1508. (concat (org-timestamp-translate (org-element-property :value clock))
  1509. (let ((time (org-element-property :duration clock)))
  1510. (and time (format " (%s)" time)))))
  1511. "\\\\"))
  1512. ;;;; Code
  1513. (defun org-latex-code (code _contents info)
  1514. "Transcode a CODE object from Org to LaTeX.
  1515. CONTENTS is nil. INFO is a plist used as a communication
  1516. channel."
  1517. (org-latex--text-markup (org-element-property :value code) 'code info))
  1518. ;;;; Drawer
  1519. (defun org-latex-drawer (drawer contents info)
  1520. "Transcode a DRAWER element from Org to LaTeX.
  1521. CONTENTS holds the contents of the block. INFO is a plist
  1522. holding contextual information."
  1523. (let* ((name (org-element-property :drawer-name drawer))
  1524. (output (funcall (plist-get info :latex-format-drawer-function)
  1525. name contents)))
  1526. (org-latex--wrap-label drawer output info)))
  1527. ;;;; Dynamic Block
  1528. (defun org-latex-dynamic-block (dynamic-block contents info)
  1529. "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
  1530. CONTENTS holds the contents of the block. INFO is a plist
  1531. holding contextual information. See `org-export-data'."
  1532. (org-latex--wrap-label dynamic-block contents info))
  1533. ;;;; Entity
  1534. (defun org-latex-entity (entity _contents _info)
  1535. "Transcode an ENTITY object from Org to LaTeX.
  1536. CONTENTS are the definition itself. INFO is a plist holding
  1537. contextual information."
  1538. (org-element-property :latex entity))
  1539. ;;;; Example Block
  1540. (defun org-latex-example-block (example-block _contents info)
  1541. "Transcode an EXAMPLE-BLOCK element from Org to LaTeX.
  1542. CONTENTS is nil. INFO is a plist holding contextual
  1543. information."
  1544. (when (org-string-nw-p (org-element-property :value example-block))
  1545. (let ((environment (or (org-export-read-attribute
  1546. :attr_latex example-block :environment)
  1547. "verbatim")))
  1548. (org-latex--wrap-label
  1549. example-block
  1550. (format "\\begin{%s}\n%s\\end{%s}"
  1551. environment
  1552. (org-export-format-code-default example-block info)
  1553. environment)
  1554. info))))
  1555. ;;;; Export Block
  1556. (defun org-latex-export-block (export-block _contents _info)
  1557. "Transcode a EXPORT-BLOCK element from Org to LaTeX.
  1558. CONTENTS is nil. INFO is a plist holding contextual information."
  1559. (when (member (org-element-property :type export-block) '("LATEX" "TEX"))
  1560. (org-remove-indentation (org-element-property :value export-block))))
  1561. ;;;; Export Snippet
  1562. (defun org-latex-export-snippet (export-snippet _contents _info)
  1563. "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
  1564. CONTENTS is nil. INFO is a plist holding contextual information."
  1565. (when (eq (org-export-snippet-backend export-snippet) 'latex)
  1566. (org-element-property :value export-snippet)))
  1567. ;;;; Fixed Width
  1568. (defun org-latex-fixed-width (fixed-width _contents info)
  1569. "Transcode a FIXED-WIDTH element from Org to LaTeX.
  1570. CONTENTS is nil. INFO is a plist holding contextual information."
  1571. (org-latex--wrap-label
  1572. fixed-width
  1573. (format "\\begin{verbatim}\n%s\\end{verbatim}"
  1574. (org-remove-indentation
  1575. (org-element-property :value fixed-width)))
  1576. info))
  1577. ;;;; Footnote Reference
  1578. (defun org-latex-footnote-reference (footnote-reference _contents info)
  1579. "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
  1580. CONTENTS is nil. INFO is a plist holding contextual information."
  1581. (let ((label (org-element-property :label footnote-reference)))
  1582. (concat
  1583. ;; Insert separator between two footnotes in a row.
  1584. (let ((prev (org-export-get-previous-element footnote-reference info)))
  1585. (when (eq (org-element-type prev) 'footnote-reference)
  1586. (plist-get info :latex-footnote-separator)))
  1587. (cond
  1588. ;; Use `:latex-footnote-defined-format' if the footnote has
  1589. ;; already been defined.
  1590. ((not (org-export-footnote-first-reference-p footnote-reference info))
  1591. (format (plist-get info :latex-footnote-defined-format)
  1592. (org-latex--label
  1593. (org-export-get-footnote-definition footnote-reference info)
  1594. info t)))
  1595. ;; Use \footnotemark if reference is within another footnote
  1596. ;; reference, footnote definition or table cell.
  1597. ((org-element-lineage footnote-reference
  1598. '(footnote-reference footnote-definition table-cell))
  1599. "\\footnotemark")
  1600. ;; Otherwise, define it with \footnote command.
  1601. (t
  1602. (let ((def (org-export-get-footnote-definition footnote-reference info)))
  1603. (concat
  1604. (format "\\footnote{%s%s}" (org-trim (org-export-data def info))
  1605. ;; Only insert a \label if there exist another
  1606. ;; reference to def.
  1607. (cond ((not label) "")
  1608. ((org-element-map (plist-get info :parse-tree) 'footnote-reference
  1609. (lambda (f)
  1610. (and (not (eq f footnote-reference))
  1611. (equal (org-element-property :label f) label)
  1612. (org-trim (org-latex--label def info t t))))
  1613. info t))
  1614. (t "")))
  1615. ;; Retrieve all footnote references within the footnote and
  1616. ;; add their definition after it, since LaTeX doesn't support
  1617. ;; them inside.
  1618. (org-latex--delayed-footnotes-definitions def info))))))))
  1619. ;;;; Headline
  1620. (defun org-latex-headline (headline contents info)
  1621. "Transcode a HEADLINE element from Org to LaTeX.
  1622. CONTENTS holds the contents of the headline. INFO is a plist
  1623. holding contextual information."
  1624. (unless (org-element-property :footnote-section-p headline)
  1625. (let* ((class (plist-get info :latex-class))
  1626. (level (org-export-get-relative-level headline info))
  1627. (numberedp (org-export-numbered-headline-p headline info))
  1628. (class-sectioning (assoc class (plist-get info :latex-classes)))
  1629. ;; Section formatting will set two placeholders: one for
  1630. ;; the title and the other for the contents.
  1631. (section-fmt
  1632. (let ((sec (if (functionp (nth 2 class-sectioning))
  1633. (funcall (nth 2 class-sectioning) level numberedp)
  1634. (nth (1+ level) class-sectioning))))
  1635. (cond
  1636. ;; No section available for that LEVEL.
  1637. ((not sec) nil)
  1638. ;; Section format directly returned by a function. Add
  1639. ;; placeholder for contents.
  1640. ((stringp sec) (concat sec "\n%s"))
  1641. ;; (numbered-section . unnumbered-section)
  1642. ((not (consp (cdr sec)))
  1643. (concat (funcall (if numberedp #'car #'cdr) sec) "\n%s"))
  1644. ;; (numbered-open numbered-close)
  1645. ((= (length sec) 2)
  1646. (when numberedp (concat (car sec) "\n%s" (nth 1 sec))))
  1647. ;; (num-in num-out no-num-in no-num-out)
  1648. ((= (length sec) 4)
  1649. (if numberedp (concat (car sec) "\n%s" (nth 1 sec))
  1650. (concat (nth 2 sec) "\n%s" (nth 3 sec)))))))
  1651. ;; Create a temporary export back-end that hard-codes
  1652. ;; "\underline" within "\section" and alike.
  1653. (section-back-end
  1654. (org-export-create-backend
  1655. :parent 'latex
  1656. :transcoders
  1657. '((underline . (lambda (o c i) (format "\\underline{%s}" c))))))
  1658. (text
  1659. (org-export-data-with-backend
  1660. (org-element-property :title headline) section-back-end info))
  1661. (todo
  1662. (and (plist-get info :with-todo-keywords)
  1663. (let ((todo (org-element-property :todo-keyword headline)))
  1664. (and todo (org-export-data todo info)))))
  1665. (todo-type (and todo (org-element-property :todo-type headline)))
  1666. (tags (and (plist-get info :with-tags)
  1667. (org-export-get-tags headline info)))
  1668. (priority (and (plist-get info :with-priority)
  1669. (org-element-property :priority headline)))
  1670. ;; Create the headline text along with a no-tag version.
  1671. ;; The latter is required to remove tags from toc.
  1672. (full-text (funcall (plist-get info :latex-format-headline-function)
  1673. todo todo-type priority text tags info))
  1674. ;; Associate \label to the headline for internal links.
  1675. (headline-label (org-latex--label headline info t t))
  1676. (pre-blanks
  1677. (make-string (org-element-property :pre-blank headline) ?\n)))
  1678. (if (or (not section-fmt) (org-export-low-level-p headline info))
  1679. ;; This is a deep sub-tree: export it as a list item. Also
  1680. ;; export as items headlines for which no section format has
  1681. ;; been found.
  1682. (let ((low-level-body
  1683. (concat
  1684. ;; If headline is the first sibling, start a list.
  1685. (when (org-export-first-sibling-p headline info)
  1686. (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize)))
  1687. ;; Itemize headline
  1688. "\\item"
  1689. (and full-text
  1690. (string-match-p "\\`[ \t]*\\[" full-text)
  1691. "\\relax")
  1692. " " full-text "\n"
  1693. headline-label
  1694. pre-blanks
  1695. contents)))
  1696. ;; If headline is not the last sibling simply return
  1697. ;; LOW-LEVEL-BODY. Otherwise, also close the list, before
  1698. ;; any blank line.
  1699. (if (not (org-export-last-sibling-p headline info)) low-level-body
  1700. (replace-regexp-in-string
  1701. "[ \t\n]*\\'"
  1702. (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize))
  1703. low-level-body)))
  1704. ;; This is a standard headline. Export it as a section. Add
  1705. ;; an alternative heading when possible, and when this is not
  1706. ;; identical to the usual heading.
  1707. (let ((opt-title
  1708. (funcall (plist-get info :latex-format-headline-function)
  1709. todo todo-type priority
  1710. (org-export-data-with-backend
  1711. (org-export-get-alt-title headline info)
  1712. section-back-end info)
  1713. (and (eq (plist-get info :with-tags) t) tags)
  1714. info))
  1715. ;; Maybe end local TOC (see `org-latex-keyword').
  1716. (contents
  1717. (concat
  1718. contents
  1719. (let ((case-fold-search t)
  1720. (section
  1721. (let ((first (car (org-element-contents headline))))
  1722. (and (eq (org-element-type first) 'section) first))))
  1723. (org-element-map section 'keyword
  1724. (lambda (k)
  1725. (and (equal (org-element-property :key k) "TOC")
  1726. (let ((v (org-element-property :value k)))
  1727. (and (string-match-p "\\<headlines\\>" v)
  1728. (string-match-p "\\<local\\>" v)
  1729. (format "\\stopcontents[level-%d]" level)))))
  1730. info t)))))
  1731. (if (and opt-title
  1732. (not (equal opt-title full-text))
  1733. (string-match "\\`\\\\\\(.+?\\){" section-fmt))
  1734. (format (replace-match "\\1[%s]" nil nil section-fmt 1)
  1735. ;; Replace square brackets with parenthesis
  1736. ;; since square brackets are not supported in
  1737. ;; optional arguments.
  1738. (replace-regexp-in-string
  1739. "\\[" "(" (replace-regexp-in-string "\\]" ")" opt-title))
  1740. full-text
  1741. (concat headline-label pre-blanks contents))
  1742. ;; Impossible to add an alternative heading. Fallback to
  1743. ;; regular sectioning format string.
  1744. (format section-fmt full-text
  1745. (concat headline-label pre-blanks contents))))))))
  1746. (defun org-latex-format-headline-default-function
  1747. (todo _todo-type priority text tags _info)
  1748. "Default format function for a headline.
  1749. See `org-latex-format-headline-function' for details."
  1750. (concat
  1751. (and todo (format "{\\bfseries\\sffamily %s} " todo))
  1752. (and priority (format "\\framebox{\\#%c} " priority))
  1753. text
  1754. (and tags
  1755. (format "\\hfill{}\\textsc{%s}"
  1756. (mapconcat #'org-latex--protect-text tags ":")))))
  1757. ;;;; Horizontal Rule
  1758. (defun org-latex-horizontal-rule (horizontal-rule _contents info)
  1759. "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
  1760. CONTENTS is nil. INFO is a plist holding contextual information."
  1761. (let ((attr (org-export-read-attribute :attr_latex horizontal-rule))
  1762. (prev (org-export-get-previous-element horizontal-rule info)))
  1763. (concat
  1764. ;; Make sure the rule doesn't start at the end of the current
  1765. ;; line by separating it with a blank line from previous element.
  1766. (when (and prev
  1767. (let ((prev-blank (org-element-property :post-blank prev)))
  1768. (or (not prev-blank) (zerop prev-blank))))
  1769. "\n")
  1770. (org-latex--wrap-label
  1771. horizontal-rule
  1772. (format "\\rule{%s}{%s}"
  1773. (or (plist-get attr :width) "\\linewidth")
  1774. (or (plist-get attr :thickness) "0.5pt"))
  1775. info))))
  1776. ;;;; Inline Src Block
  1777. (defun org-latex-inline-src-block (inline-src-block _contents info)
  1778. "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
  1779. CONTENTS holds the contents of the item. INFO is a plist holding
  1780. contextual information."
  1781. (let* ((code (org-element-property :value inline-src-block))
  1782. (separator (org-latex--find-verb-separator code)))
  1783. (cl-case (plist-get info :latex-listings)
  1784. ;; Do not use a special package: transcode it verbatim.
  1785. ((nil) (format "\\texttt{%s}" (org-latex--text-markup code 'code info)))
  1786. ;; Use minted package.
  1787. (minted
  1788. (let* ((org-lang (org-element-property :language inline-src-block))
  1789. (mint-lang (or (cadr (assq (intern org-lang)
  1790. (plist-get info :latex-minted-langs)))
  1791. (downcase org-lang)))
  1792. (options (org-latex--make-option-string
  1793. (plist-get info :latex-minted-options))))
  1794. (format "\\mintinline%s{%s}{%s}"
  1795. (if (string= options "") "" (format "[%s]" options))
  1796. mint-lang
  1797. code)))
  1798. ;; Use listings package.
  1799. (otherwise
  1800. ;; Maybe translate language's name.
  1801. (let* ((org-lang (org-element-property :language inline-src-block))
  1802. (lst-lang (or (cadr (assq (intern org-lang)
  1803. (plist-get info :latex-listings-langs)))
  1804. org-lang))
  1805. (options (org-latex--make-option-string
  1806. (append (plist-get info :latex-listings-options)
  1807. `(("language" ,lst-lang))))))
  1808. (concat (format "\\lstinline[%s]" options)
  1809. separator code separator))))))
  1810. ;;;; Inlinetask
  1811. (defun org-latex-inlinetask (inlinetask contents info)
  1812. "Transcode an INLINETASK element from Org to LaTeX.
  1813. CONTENTS holds the contents of the block. INFO is a plist
  1814. holding contextual information."
  1815. (let ((title (org-export-data (org-element-property :title inlinetask) info))
  1816. (todo (and (plist-get info :with-todo-keywords)
  1817. (let ((todo (org-element-property :todo-keyword inlinetask)))
  1818. (and todo (org-export-data todo info)))))
  1819. (todo-type (org-element-property :todo-type inlinetask))
  1820. (tags (and (plist-get info :with-tags)
  1821. (org-export-get-tags inlinetask info)))
  1822. (priority (and (plist-get info :with-priority)
  1823. (org-element-property :priority inlinetask)))
  1824. (contents (concat (org-latex--label inlinetask info) contents)))
  1825. (funcall (plist-get info :latex-format-inlinetask-function)
  1826. todo todo-type priority title tags contents info)))
  1827. (defun org-latex-format-inlinetask-default-function
  1828. (todo _todo-type priority title tags contents _info)
  1829. "Default format function for a inlinetasks.
  1830. See `org-latex-format-inlinetask-function' for details."
  1831. (let ((full-title
  1832. (concat (when todo (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
  1833. (when priority (format "\\framebox{\\#%c} " priority))
  1834. title
  1835. (when tags
  1836. (format "\\hfill{}\\textsc{:%s:}"
  1837. (mapconcat #'org-latex--protect-text tags ":"))))))
  1838. (concat "\\begin{center}\n"
  1839. "\\fbox{\n"
  1840. "\\begin{minipage}[c]{.6\\textwidth}\n"
  1841. full-title "\n\n"
  1842. (and (org-string-nw-p contents)
  1843. (concat "\\rule[.8em]{\\textwidth}{2pt}\n\n" contents))
  1844. "\\end{minipage}\n"
  1845. "}\n"
  1846. "\\end{center}")))
  1847. ;;;; Italic
  1848. (defun org-latex-italic (_italic contents info)
  1849. "Transcode ITALIC from Org to LaTeX.
  1850. CONTENTS is the text with italic markup. INFO is a plist holding
  1851. contextual information."
  1852. (org-latex--text-markup contents 'italic info))
  1853. ;;;; Item
  1854. (defun org-latex-item (item contents info)
  1855. "Transcode an ITEM element from Org to LaTeX.
  1856. CONTENTS holds the contents of the item. INFO is a plist holding
  1857. contextual information."
  1858. (let* ((counter
  1859. (let ((count (org-element-property :counter item))
  1860. (level
  1861. ;; Determine level of current item to determine the
  1862. ;; correct LaTeX counter to use (enumi, enumii...).
  1863. (let ((parent item) (level 0))
  1864. (while (memq (org-element-type
  1865. (setq parent (org-export-get-parent parent)))
  1866. '(plain-list item))
  1867. (when (and (eq (org-element-type parent) 'plain-list)
  1868. (eq (org-element-property :type parent)
  1869. 'ordered))
  1870. (cl-incf level)))
  1871. level)))
  1872. (and count
  1873. (< level 5)
  1874. (format "\\setcounter{enum%s}{%s}\n"
  1875. (nth (1- level) '("i" "ii" "iii" "iv"))
  1876. (1- count)))))
  1877. (checkbox (cl-case (org-element-property :checkbox item)
  1878. (on "$\\boxtimes$ ")
  1879. (off "$\\square$ ")
  1880. (trans "$\\boxminus$ ")))
  1881. (tag (let ((tag (org-element-property :tag item)))
  1882. ;; Check-boxes must belong to the tag.
  1883. (and tag (format "[{%s}] "
  1884. (concat checkbox
  1885. (org-export-data tag info)))))))
  1886. (concat counter
  1887. "\\item"
  1888. (cond
  1889. (tag)
  1890. (checkbox (concat " " checkbox))
  1891. ;; Without a tag or a check-box, if CONTENTS starts with
  1892. ;; an opening square bracket, add "\relax" to "\item",
  1893. ;; unless the brackets comes from an initial export
  1894. ;; snippet (i.e. it is inserted willingly by the user).
  1895. ((and contents
  1896. (string-match-p "\\`[ \t]*\\[" contents)
  1897. (not (let ((e (car (org-element-contents item))))
  1898. (and (eq (org-element-type e) 'paragraph)
  1899. (let ((o (car (org-element-contents e))))
  1900. (and (eq (org-element-type o) 'export-snippet)
  1901. (eq (org-export-snippet-backend o)
  1902. 'latex)))))))
  1903. "\\relax ")
  1904. (t " "))
  1905. (and contents (org-trim contents))
  1906. ;; If there are footnotes references in tag, be sure to
  1907. ;; add their definition at the end of the item. This
  1908. ;; workaround is necessary since "\footnote{}" command is
  1909. ;; not supported in tags.
  1910. (and tag
  1911. (org-latex--delayed-footnotes-definitions
  1912. (org-element-property :tag item) info)))))
  1913. ;;;; Keyword
  1914. (defun org-latex-keyword (keyword _contents info)
  1915. "Transcode a KEYWORD element from Org to LaTeX.
  1916. CONTENTS is nil. INFO is a plist holding contextual information."
  1917. (let ((key (org-element-property :key keyword))
  1918. (value (org-element-property :value keyword)))
  1919. (cond
  1920. ((string= key "LATEX") value)
  1921. ((string= key "INDEX") (format "\\index{%s}" value))
  1922. ((string= key "TOC")
  1923. (let ((case-fold-search t))
  1924. (cond
  1925. ((string-match-p "\\<headlines\\>" value)
  1926. (let* ((localp (string-match-p "\\<local\\>" value))
  1927. (parent (org-element-lineage keyword '(headline)))
  1928. (level (if (not (and localp parent)) 0
  1929. (org-export-get-relative-level parent info)))
  1930. (depth
  1931. (and (string-match "\\<[0-9]+\\>" value)
  1932. (format
  1933. "\\setcounter{tocdepth}{%d}"
  1934. (+ (string-to-number (match-string 0 value)) level)))))
  1935. (if (and localp parent)
  1936. ;; Start local TOC, assuming package "titletoc" is
  1937. ;; required.
  1938. (format "\\startcontents[level-%d]
  1939. \\printcontents[level-%d]{}{0}{%s}"
  1940. level level (or depth ""))
  1941. (concat depth (and depth "\n") "\\tableofcontents"))))
  1942. ((string-match-p "\\<tables\\>" value) "\\listoftables")
  1943. ((string-match-p "\\<listings\\>" value)
  1944. (cl-case (plist-get info :latex-listings)
  1945. ((nil) "\\listoffigures")
  1946. (minted "\\listoflistings")
  1947. (otherwise "\\lstlistoflistings")))))))))
  1948. ;;;; Latex Environment
  1949. (defun org-latex-latex-environment (latex-environment _contents info)
  1950. "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
  1951. CONTENTS is nil. INFO is a plist holding contextual information."
  1952. (when (plist-get info :with-latex)
  1953. (let ((value (org-remove-indentation
  1954. (org-element-property :value latex-environment))))
  1955. (if (not (org-element-property :name latex-environment)) value
  1956. ;; Environment is labeled: label must be within the environment
  1957. ;; (otherwise, a reference pointing to that element will count
  1958. ;; the section instead).
  1959. (with-temp-buffer
  1960. (insert value)
  1961. (goto-char (point-min))
  1962. (forward-line)
  1963. (insert (org-latex--label latex-environment info nil t))
  1964. (buffer-string))))))
  1965. ;;;; Latex Fragment
  1966. (defun org-latex-latex-fragment (latex-fragment _contents _info)
  1967. "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
  1968. CONTENTS is nil. INFO is a plist holding contextual information."
  1969. (let ((value (org-element-property :value latex-fragment)))
  1970. ;; Trim math markers since the fragment is enclosed within
  1971. ;; a latex-math-block object anyway.
  1972. (cond ((string-match-p "\\`\\$[^$]" value) (substring value 1 -1))
  1973. ((string-prefix-p "\\(" value) (substring value 2 -2))
  1974. (t value))))
  1975. ;;;; Line Break
  1976. (defun org-latex-line-break (_line-break _contents _info)
  1977. "Transcode a LINE-BREAK object from Org to LaTeX.
  1978. CONTENTS is nil. INFO is a plist holding contextual information."
  1979. "\\\\\n")
  1980. ;;;; Link
  1981. (defun org-latex--inline-image (link info)
  1982. "Return LaTeX code for an inline image.
  1983. LINK is the link pointing to the inline image. INFO is a plist
  1984. used as a communication channel."
  1985. (let* ((parent (org-export-get-parent-element link))
  1986. (path (let ((raw-path (org-element-property :path link)))
  1987. (if (not (file-name-absolute-p raw-path)) raw-path
  1988. (expand-file-name raw-path))))
  1989. (filetype (file-name-extension path))
  1990. (caption (org-latex--caption/label-string parent info))
  1991. (caption-above-p (org-latex--caption-above-p link info))
  1992. ;; Retrieve latex attributes from the element around.
  1993. (attr (org-export-read-attribute :attr_latex parent))
  1994. (float (let ((float (plist-get attr :float)))
  1995. (cond ((string= float "wrap") 'wrap)
  1996. ((string= float "sideways") 'sideways)
  1997. ((string= float "multicolumn") 'multicolumn)
  1998. ((and (plist-member attr :float) (not float)) 'nonfloat)
  1999. ((or float
  2000. (org-element-property :caption parent)
  2001. (org-string-nw-p (plist-get attr :caption)))
  2002. 'figure)
  2003. (t 'nonfloat))))
  2004. (placement
  2005. (let ((place (plist-get attr :placement)))
  2006. (cond
  2007. (place (format "%s" place))
  2008. ((eq float 'wrap) "{l}{0.5\\textwidth}")
  2009. ((eq float 'figure)
  2010. (format "[%s]" (plist-get info :latex-default-figure-position)))
  2011. (t ""))))
  2012. (center
  2013. (if (plist-member attr :center) (plist-get attr :center)
  2014. (plist-get info :latex-images-centered)))
  2015. (comment-include (if (plist-get attr :comment-include) "%" ""))
  2016. ;; It is possible to specify width and height in the
  2017. ;; ATTR_LATEX line, and also via default variables.
  2018. (width (cond ((plist-get attr :width))
  2019. ((plist-get attr :height) "")
  2020. ((eq float 'wrap) "0.48\\textwidth")
  2021. (t (plist-get info :latex-image-default-width))))
  2022. (height (cond ((plist-get attr :height))
  2023. ((or (plist-get attr :width)
  2024. (memq float '(figure wrap))) "")
  2025. (t (plist-get info :latex-image-default-height))))
  2026. (options (let ((opt (or (plist-get attr :options)
  2027. (plist-get info :latex-image-default-option))))
  2028. (if (not (string-match "\\`\\[\\(.*\\)\\]\\'" opt)) opt
  2029. (match-string 1 opt))))
  2030. image-code)
  2031. (if (member filetype '("tikz" "pgf"))
  2032. ;; For tikz images:
  2033. ;; - use \input to read in image file.
  2034. ;; - if options are present, wrap in a tikzpicture environment.
  2035. ;; - if width or height are present, use \resizebox to change
  2036. ;; the image size.
  2037. (progn
  2038. (setq image-code (format "\\input{%s}" path))
  2039. (when (org-string-nw-p options)
  2040. (setq image-code
  2041. (format "\\begin{tikzpicture}[%s]\n%s\n\\end{tikzpicture}"
  2042. options
  2043. image-code)))
  2044. (when (or (org-string-nw-p width) (org-string-nw-p height))
  2045. (setq image-code (format "\\resizebox{%s}{%s}{%s}"
  2046. (if (org-string-nw-p width) width "!")
  2047. (if (org-string-nw-p height) height "!")
  2048. image-code))))
  2049. ;; For other images:
  2050. ;; - add width and height to options.
  2051. ;; - include the image with \includegraphics.
  2052. (when (org-string-nw-p width)
  2053. (setq options (concat options ",width=" width)))
  2054. (when (org-string-nw-p height)
  2055. (setq options (concat options ",height=" height)))
  2056. (let ((search-option (org-element-property :search-option link)))
  2057. (when (and search-option
  2058. (equal filetype "pdf")
  2059. (string-match-p "\\`[0-9]+\\'" search-option)
  2060. (not (string-match-p "page=" options)))
  2061. (setq options (concat options ",page=" search-option))))
  2062. (setq image-code
  2063. (format "\\includegraphics%s{%s}"
  2064. (cond ((not (org-string-nw-p options)) "")
  2065. ((string-prefix-p "," options)
  2066. (format "[%s]" (substring options 1)))
  2067. (t (format "[%s]" options)))
  2068. path))
  2069. (when (equal filetype "svg")
  2070. (setq image-code (replace-regexp-in-string "^\\\\includegraphics"
  2071. "\\includesvg"
  2072. image-code
  2073. nil t))
  2074. (setq image-code (replace-regexp-in-string "\\.svg}"
  2075. "}"
  2076. image-code
  2077. nil t))))
  2078. ;; Return proper string, depending on FLOAT.
  2079. (pcase float
  2080. (`wrap (format "\\begin{wrapfigure}%s
  2081. %s%s
  2082. %s%s
  2083. %s\\end{wrapfigure}"
  2084. placement
  2085. (if caption-above-p caption "")
  2086. (if center "\\centering" "")
  2087. comment-include image-code
  2088. (if caption-above-p "" caption)))
  2089. (`sideways (format "\\begin{sidewaysfigure}
  2090. %s%s
  2091. %s%s
  2092. %s\\end{sidewaysfigure}"
  2093. (if caption-above-p caption "")
  2094. (if center "\\centering" "")
  2095. comment-include image-code
  2096. (if caption-above-p "" caption)))
  2097. (`multicolumn (format "\\begin{figure*}%s
  2098. %s%s
  2099. %s%s
  2100. %s\\end{figure*}"
  2101. placement
  2102. (if caption-above-p caption "")
  2103. (if center "\\centering" "")
  2104. comment-include image-code
  2105. (if caption-above-p "" caption)))
  2106. (`figure (format "\\begin{figure}%s
  2107. %s%s
  2108. %s%s
  2109. %s\\end{figure}"
  2110. placement
  2111. (if caption-above-p caption "")
  2112. (if center "\\centering" "")
  2113. comment-include image-code
  2114. (if caption-above-p "" caption)))
  2115. ((guard center)
  2116. (format "\\begin{center}
  2117. %s%s
  2118. %s\\end{center}"
  2119. (if caption-above-p caption "")
  2120. image-code
  2121. (if caption-above-p "" caption)))
  2122. (_
  2123. (concat (if caption-above-p caption "")
  2124. image-code
  2125. (if caption-above-p caption ""))))))
  2126. (defun org-latex-link (link desc info)
  2127. "Transcode a LINK object from Org to LaTeX.
  2128. DESC is the description part of the link, or the empty string.
  2129. INFO is a plist holding contextual information. See
  2130. `org-export-data'."
  2131. (let* ((type (org-element-property :type link))
  2132. (raw-path (org-element-property :path link))
  2133. ;; Ensure DESC really exists, or set it to nil.
  2134. (desc (and (not (string= desc "")) desc))
  2135. (imagep (org-export-inline-image-p
  2136. link (plist-get info :latex-inline-image-rules)))
  2137. (path (org-latex--protect-text
  2138. (cond ((member type '("http" "https" "ftp" "mailto" "doi"))
  2139. (concat type ":" raw-path))
  2140. ((string= type "file") (org-export-file-uri raw-path))
  2141. (t raw-path)))))
  2142. (cond
  2143. ;; Link type is handled by a special function.
  2144. ((org-export-custom-protocol-maybe link desc 'latex))
  2145. ;; Image file.
  2146. (imagep (org-latex--inline-image link info))
  2147. ;; Radio link: Transcode target's contents and use them as link's
  2148. ;; description.
  2149. ((string= type "radio")
  2150. (let ((destination (org-export-resolve-radio-link link info)))
  2151. (if (not destination) desc
  2152. (format "\\hyperref[%s]{%s}"
  2153. (org-export-get-reference destination info)
  2154. desc))))
  2155. ;; Links pointing to a headline: Find destination and build
  2156. ;; appropriate referencing command.
  2157. ((member type '("custom-id" "fuzzy" "id"))
  2158. (let ((destination (if (string= type "fuzzy")
  2159. (org-export-resolve-fuzzy-link link info)
  2160. (org-export-resolve-id-link link info))))
  2161. (cl-case (org-element-type destination)
  2162. ;; Id link points to an external file.
  2163. (plain-text
  2164. (if desc (format "\\href{%s}{%s}" destination desc)
  2165. (format "\\url{%s}" destination)))
  2166. ;; Fuzzy link points nowhere.
  2167. ((nil)
  2168. (format (plist-get info :latex-link-with-unknown-path-format)
  2169. (or desc
  2170. (org-export-data
  2171. (org-element-property :raw-link link) info))))
  2172. ;; LINK points to a headline. If headlines are numbered
  2173. ;; and the link has no description, display headline's
  2174. ;; number. Otherwise, display description or headline's
  2175. ;; title.
  2176. (headline
  2177. (let ((label (org-latex--label destination info t)))
  2178. (if (and (not desc)
  2179. (org-export-numbered-headline-p destination info))
  2180. (format "\\ref{%s}" label)
  2181. (format "\\hyperref[%s]{%s}" label
  2182. (or desc
  2183. (org-export-data
  2184. (org-element-property :title destination) info))))))
  2185. ;; Fuzzy link points to a target. Do as above.
  2186. (otherwise
  2187. (let ((ref (org-latex--label destination info t)))
  2188. (if (not desc) (format "\\ref{%s}" ref)
  2189. (format "\\hyperref[%s]{%s}" ref desc)))))))
  2190. ;; Coderef: replace link with the reference name or the
  2191. ;; equivalent line number.
  2192. ((string= type "coderef")
  2193. (format (org-export-get-coderef-format path desc)
  2194. (org-export-resolve-coderef path info)))
  2195. ;; External link with a description part.
  2196. ((and path desc) (format "\\href{%s}{%s}" path desc))
  2197. ;; External link without a description part.
  2198. (path (format "\\url{%s}" path))
  2199. ;; No path, only description. Try to do something useful.
  2200. (t (format (plist-get info :latex-link-with-unknown-path-format) desc)))))
  2201. ;;;; Node Property
  2202. (defun org-latex-node-property (node-property _contents _info)
  2203. "Transcode a NODE-PROPERTY element from Org to LaTeX.
  2204. CONTENTS is nil. INFO is a plist holding contextual
  2205. information."
  2206. (format "%s:%s"
  2207. (org-element-property :key node-property)
  2208. (let ((value (org-element-property :value node-property)))
  2209. (if value (concat " " value) ""))))
  2210. ;;;; Paragraph
  2211. (defun org-latex-paragraph (_paragraph contents _info)
  2212. "Transcode a PARAGRAPH element from Org to LaTeX.
  2213. CONTENTS is the contents of the paragraph, as a string. INFO is
  2214. the plist used as a communication channel."
  2215. contents)
  2216. ;;;; Plain List
  2217. (defun org-latex-plain-list (plain-list contents info)
  2218. "Transcode a PLAIN-LIST element from Org to LaTeX.
  2219. CONTENTS is the contents of the list. INFO is a plist holding
  2220. contextual information."
  2221. (let* ((type (org-element-property :type plain-list))
  2222. (attr (org-export-read-attribute :attr_latex plain-list))
  2223. (latex-type (let ((env (plist-get attr :environment)))
  2224. (cond (env (format "%s" env))
  2225. ((eq type 'ordered) "enumerate")
  2226. ((eq type 'descriptive) "description")
  2227. (t "itemize")))))
  2228. (org-latex--wrap-label
  2229. plain-list
  2230. (format "\\begin{%s}%s\n%s\\end{%s}"
  2231. latex-type
  2232. (or (plist-get attr :options) "")
  2233. contents
  2234. latex-type)
  2235. info)))
  2236. ;;;; Plain Text
  2237. (defun org-latex-plain-text (text info)
  2238. "Transcode a TEXT string from Org to LaTeX.
  2239. TEXT is the string to transcode. INFO is a plist holding
  2240. contextual information."
  2241. (let* ((specialp (plist-get info :with-special-strings))
  2242. (output
  2243. ;; Turn LaTeX into \LaTeX{} and TeX into \TeX{}.
  2244. (let ((case-fold-search nil))
  2245. (replace-regexp-in-string
  2246. "\\<\\(?:La\\)?TeX\\>" "\\\\\\&{}"
  2247. ;; Protect ^, ~, %, #, &, $, _, { and }. Also protect \.
  2248. ;; However, if special strings are used, be careful not
  2249. ;; to protect "\" in "\-" constructs.
  2250. (replace-regexp-in-string
  2251. (concat "[%$#&{}_~^]\\|\\\\" (and specialp "\\([^-]\\|$\\)"))
  2252. (lambda (m)
  2253. (cl-case (string-to-char m)
  2254. (?\\ "$\\\\backslash$\\1")
  2255. (?~ "\\\\textasciitilde{}")
  2256. (?^ "\\\\^{}")
  2257. (t "\\\\\\&")))
  2258. text)))))
  2259. ;; Activate smart quotes. Be sure to provide original TEXT string
  2260. ;; since OUTPUT may have been modified.
  2261. (when (plist-get info :with-smart-quotes)
  2262. (setq output (org-export-activate-smart-quotes output :latex info text)))
  2263. ;; Convert special strings.
  2264. (when specialp
  2265. (setq output (replace-regexp-in-string "\\.\\.\\." "\\\\ldots{}" output)))
  2266. ;; Handle break preservation if required.
  2267. (when (plist-get info :preserve-breaks)
  2268. (setq output (replace-regexp-in-string
  2269. "\\(?:[ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n" output nil t)))
  2270. ;; Return value.
  2271. output))
  2272. ;;;; Planning
  2273. (defun org-latex-planning (planning _contents info)
  2274. "Transcode a PLANNING element from Org to LaTeX.
  2275. CONTENTS is nil. INFO is a plist holding contextual
  2276. information."
  2277. (concat
  2278. "\\noindent"
  2279. (mapconcat
  2280. 'identity
  2281. (delq nil
  2282. (list
  2283. (let ((closed (org-element-property :closed planning)))
  2284. (when closed
  2285. (concat
  2286. (format "\\textbf{%s} " org-closed-string)
  2287. (format (plist-get info :latex-inactive-timestamp-format)
  2288. (org-timestamp-translate closed)))))
  2289. (let ((deadline (org-element-property :deadline planning)))
  2290. (when deadline
  2291. (concat
  2292. (format "\\textbf{%s} " org-deadline-string)
  2293. (format (plist-get info :latex-active-timestamp-format)
  2294. (org-timestamp-translate deadline)))))
  2295. (let ((scheduled (org-element-property :scheduled planning)))
  2296. (when scheduled
  2297. (concat
  2298. (format "\\textbf{%s} " org-scheduled-string)
  2299. (format (plist-get info :latex-active-timestamp-format)
  2300. (org-timestamp-translate scheduled)))))))
  2301. " ")
  2302. "\\\\"))
  2303. ;;;; Property Drawer
  2304. (defun org-latex-property-drawer (_property-drawer contents _info)
  2305. "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
  2306. CONTENTS holds the contents of the drawer. INFO is a plist
  2307. holding contextual information."
  2308. (and (org-string-nw-p contents)
  2309. (format "\\begin{verbatim}\n%s\\end{verbatim}" contents)))
  2310. ;;;; Pseudo Element: LaTeX Matrices
  2311. ;; `latex-matrices' elements have the following properties:
  2312. ;; `:caption', `:post-blank' and `:markup' (`inline', `equation' or
  2313. ;; `math').
  2314. (defun org-latex--wrap-latex-matrices (data info)
  2315. "Merge contiguous tables with the same mode within a pseudo-element.
  2316. DATA is a parse tree or a secondary string. INFO is a plist
  2317. containing export options. Modify DATA by side-effect and return
  2318. it."
  2319. (org-element-map data 'table
  2320. (lambda (table)
  2321. (when (eq (org-element-property :type table) 'org)
  2322. (let ((mode (or (org-export-read-attribute :attr_latex table :mode)
  2323. (plist-get info :latex-default-table-mode))))
  2324. (when (and (member mode '("inline-math" "math"))
  2325. ;; Do not wrap twice the same table.
  2326. (not (eq (org-element-type
  2327. (org-element-property :parent table))
  2328. 'latex-matrices)))
  2329. (let* ((caption (and (not (string= mode "inline-math"))
  2330. (org-element-property :caption table)))
  2331. (matrices
  2332. (list 'latex-matrices
  2333. (list :caption caption
  2334. :markup
  2335. (cond ((string= mode "inline-math") 'inline)
  2336. (caption 'equation)
  2337. (t 'math)))))
  2338. (previous table)
  2339. (next (org-export-get-next-element table info)))
  2340. (org-element-insert-before matrices table)
  2341. ;; Swallow all contiguous tables sharing the same mode.
  2342. (while (and
  2343. (zerop (or (org-element-property :post-blank previous) 0))
  2344. (setq next (org-export-get-next-element previous info))
  2345. (eq (org-element-type next) 'table)
  2346. (eq (org-element-property :type next) 'org)
  2347. (string= (or (org-export-read-attribute
  2348. :attr_latex next :mode)
  2349. (plist-get info :latex-default-table-mode))
  2350. mode))
  2351. (org-element-extract-element previous)
  2352. (org-element-adopt-elements matrices previous)
  2353. (setq previous next))
  2354. ;; Inherit `:post-blank' from the value of the last
  2355. ;; swallowed table. Set the latter's `:post-blank'
  2356. ;; value to 0 so as to not duplicate empty lines.
  2357. (org-element-put-property
  2358. matrices :post-blank (org-element-property :post-blank previous))
  2359. (org-element-put-property previous :post-blank 0)
  2360. (org-element-extract-element previous)
  2361. (org-element-adopt-elements matrices previous))))))
  2362. info)
  2363. data)
  2364. (defun org-latex-matrices (matrices contents _info)
  2365. "Transcode a MATRICES element from Org to LaTeX.
  2366. CONTENTS is a string. INFO is a plist used as a communication
  2367. channel."
  2368. (format (cl-case (org-element-property :markup matrices)
  2369. (inline "\\(%s\\)")
  2370. (equation "\\begin{equation}\n%s\\end{equation}")
  2371. (t "\\[\n%s\\]"))
  2372. contents))
  2373. ;;;; Pseudo Object: LaTeX Math Block
  2374. ;; `latex-math-block' objects have the following property:
  2375. ;; `:post-blank'.
  2376. (defun org-latex--wrap-latex-math-block (data info)
  2377. "Merge contiguous math objects in a pseudo-object container.
  2378. DATA is a parse tree or a secondary string. INFO is a plist
  2379. containing export options. Modify DATA by side-effect and return it."
  2380. (let ((valid-object-p
  2381. ;; Non-nil when OBJ can be added to the latex math block B.
  2382. (lambda (obj b)
  2383. (pcase (org-element-type obj)
  2384. (`entity (org-element-property :latex-math-p obj))
  2385. (`latex-fragment
  2386. (let ((value (org-element-property :value obj)))
  2387. (or (string-prefix-p "\\(" value)
  2388. (string-match-p "\\`\\$[^$]" value))))
  2389. ((and type (or `subscript `superscript))
  2390. (not (memq type (mapcar #'org-element-type
  2391. (org-element-contents b)))))))))
  2392. (org-element-map data '(entity latex-fragment subscript superscript)
  2393. (lambda (object)
  2394. ;; Skip objects already wrapped.
  2395. (when (and (not (eq (org-element-type
  2396. (org-element-property :parent object))
  2397. 'latex-math-block))
  2398. (funcall valid-object-p object nil))
  2399. (let ((math-block (list 'latex-math-block nil))
  2400. (next-elements (org-export-get-next-element object info t))
  2401. (last object))
  2402. ;; Wrap MATH-BLOCK around OBJECT in DATA.
  2403. (org-element-insert-before math-block object)
  2404. (org-element-extract-element object)
  2405. (org-element-adopt-elements math-block object)
  2406. (when (zerop (or (org-element-property :post-blank object) 0))
  2407. ;; MATH-BLOCK swallows consecutive math objects.
  2408. (catch 'exit
  2409. (dolist (next next-elements)
  2410. (unless (funcall valid-object-p next math-block)
  2411. (throw 'exit nil))
  2412. (org-element-extract-element next)
  2413. (org-element-adopt-elements math-block next)
  2414. ;; Eschew the case: \beta$x$ -> \(\betax\).
  2415. (unless (memq (org-element-type next)
  2416. '(subscript superscript))
  2417. (org-element-put-property last :post-blank 1))
  2418. (setq last next)
  2419. (when (> (or (org-element-property :post-blank next) 0) 0)
  2420. (throw 'exit nil)))))
  2421. (org-element-put-property
  2422. math-block :post-blank (org-element-property :post-blank last)))))
  2423. info nil '(subscript superscript latex-math-block) t)
  2424. ;; Return updated DATA.
  2425. data))
  2426. (defun org-latex-math-block (_math-block contents _info)
  2427. "Transcode a MATH-BLOCK object from Org to LaTeX.
  2428. CONTENTS is a string. INFO is a plist used as a communication
  2429. channel."
  2430. (when (org-string-nw-p contents)
  2431. (format "\\(%s\\)" (org-trim contents))))
  2432. ;;;; Quote Block
  2433. (defun org-latex-quote-block (quote-block contents info)
  2434. "Transcode a QUOTE-BLOCK element from Org to LaTeX.
  2435. CONTENTS holds the contents of the block. INFO is a plist
  2436. holding contextual information."
  2437. (org-latex--wrap-label
  2438. quote-block (format "\\begin{quote}\n%s\\end{quote}" contents) info))
  2439. ;;;; Radio Target
  2440. (defun org-latex-radio-target (radio-target text info)
  2441. "Transcode a RADIO-TARGET object from Org to LaTeX.
  2442. TEXT is the text of the target. INFO is a plist holding
  2443. contextual information."
  2444. (format "\\label{%s}%s" (org-export-get-reference radio-target info) text))
  2445. ;;;; Section
  2446. (defun org-latex-section (_section contents _info)
  2447. "Transcode a SECTION element from Org to LaTeX.
  2448. CONTENTS holds the contents of the section. INFO is a plist
  2449. holding contextual information."
  2450. contents)
  2451. ;;;; Special Block
  2452. (defun org-latex-special-block (special-block contents info)
  2453. "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
  2454. CONTENTS holds the contents of the block. INFO is a plist
  2455. holding contextual information."
  2456. (let ((type (org-element-property :type special-block))
  2457. (opt (org-export-read-attribute :attr_latex special-block :options))
  2458. (caption (org-latex--caption/label-string special-block info))
  2459. (caption-above-p (org-latex--caption-above-p special-block info)))
  2460. (concat (format "\\begin{%s}%s\n" type (or opt ""))
  2461. (and caption-above-p caption)
  2462. contents
  2463. (and (not caption-above-p) caption)
  2464. (format "\\end{%s}" type))))
  2465. ;;;; Src Block
  2466. (defun org-latex-src-block (src-block _contents info)
  2467. "Transcode a SRC-BLOCK element from Org to LaTeX.
  2468. CONTENTS holds the contents of the item. INFO is a plist holding
  2469. contextual information."
  2470. (when (org-string-nw-p (org-element-property :value src-block))
  2471. (let* ((lang (org-element-property :language src-block))
  2472. (caption (org-element-property :caption src-block))
  2473. (caption-above-p (org-latex--caption-above-p src-block info))
  2474. (label (org-element-property :name src-block))
  2475. (custom-env (and lang
  2476. (cadr (assq (intern lang)
  2477. org-latex-custom-lang-environments))))
  2478. (num-start (org-export-get-loc src-block info))
  2479. (retain-labels (org-element-property :retain-labels src-block))
  2480. (attributes (org-export-read-attribute :attr_latex src-block))
  2481. (float (plist-get attributes :float))
  2482. (listings (plist-get info :latex-listings)))
  2483. (cond
  2484. ;; Case 1. No source fontification.
  2485. ((not listings)
  2486. (let* ((caption-str (org-latex--caption/label-string src-block info))
  2487. (float-env
  2488. (cond ((string= "multicolumn" float)
  2489. (format "\\begin{figure*}[%s]\n%s%%s\n%s\\end{figure*}"
  2490. (plist-get info :latex-default-figure-position)
  2491. (if caption-above-p caption-str "")
  2492. (if caption-above-p "" caption-str)))
  2493. (caption (concat
  2494. (if caption-above-p caption-str "")
  2495. "%s"
  2496. (if caption-above-p "" (concat "\n" caption-str))))
  2497. (t "%s"))))
  2498. (format
  2499. float-env
  2500. (concat (format "\\begin{verbatim}\n%s\\end{verbatim}"
  2501. (org-export-format-code-default src-block info))))))
  2502. ;; Case 2. Custom environment.
  2503. (custom-env
  2504. (let ((caption-str (org-latex--caption/label-string src-block info))
  2505. (formatted-src (org-export-format-code-default src-block info)))
  2506. (if (string-match-p "\\`[a-zA-Z0-9]+\\'" custom-env)
  2507. (format "\\begin{%s}\n%s\\end{%s}\n"
  2508. custom-env
  2509. (concat (and caption-above-p caption-str)
  2510. formatted-src
  2511. (and (not caption-above-p) caption-str))
  2512. custom-env)
  2513. (format-spec custom-env
  2514. `((?s . ,formatted-src)
  2515. (?c . ,caption)
  2516. (?f . ,float)
  2517. (?l . ,(org-latex--label src-block info))
  2518. (?o . ,(or (plist-get attributes :options) "")))))))
  2519. ;; Case 3. Use minted package.
  2520. ((eq listings 'minted)
  2521. (let* ((caption-str (org-latex--caption/label-string src-block info))
  2522. (float-env
  2523. (cond
  2524. ((string= "multicolumn" float)
  2525. (format "\\begin{listing*}[%s]\n%s%%s\n%s\\end{listing*}"
  2526. (plist-get info :latex-default-figure-position)
  2527. (if caption-above-p caption-str "")
  2528. (if caption-above-p "" caption-str)))
  2529. (caption
  2530. (format "\\begin{listing}[%s]\n%s%%s\n%s\\end{listing}"
  2531. (plist-get info :latex-default-figure-position)
  2532. (if caption-above-p caption-str "")
  2533. (if caption-above-p "" caption-str)))
  2534. ((string= "t" float)
  2535. (concat (format "\\begin{listing}[%s]\n"
  2536. (plist-get info :latex-default-figure-position))
  2537. "%s\n\\end{listing}"))
  2538. (t "%s")))
  2539. (options (plist-get info :latex-minted-options))
  2540. (body
  2541. (format
  2542. "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
  2543. ;; Options.
  2544. (concat
  2545. (org-latex--make-option-string
  2546. (if (or (not num-start) (assoc "linenos" options))
  2547. options
  2548. (append
  2549. `(("linenos")
  2550. ("firstnumber" ,(number-to-string (1+ num-start))))
  2551. options)))
  2552. (let ((local-options (plist-get attributes :options)))
  2553. (and local-options (concat "," local-options))))
  2554. ;; Language.
  2555. (or (cadr (assq (intern lang)
  2556. (plist-get info :latex-minted-langs)))
  2557. (downcase lang))
  2558. ;; Source code.
  2559. (let* ((code-info (org-export-unravel-code src-block))
  2560. (max-width
  2561. (apply 'max
  2562. (mapcar 'length
  2563. (org-split-string (car code-info)
  2564. "\n")))))
  2565. (org-export-format-code
  2566. (car code-info)
  2567. (lambda (loc _num ref)
  2568. (concat
  2569. loc
  2570. (when ref
  2571. ;; Ensure references are flushed to the right,
  2572. ;; separated with 6 spaces from the widest line
  2573. ;; of code.
  2574. (concat (make-string (+ (- max-width (length loc)) 6)
  2575. ?\s)
  2576. (format "(%s)" ref)))))
  2577. nil (and retain-labels (cdr code-info)))))))
  2578. ;; Return value.
  2579. (format float-env body)))
  2580. ;; Case 4. Use listings package.
  2581. (t
  2582. (let ((lst-lang
  2583. (or (cadr (assq (intern lang)
  2584. (plist-get info :latex-listings-langs)))
  2585. lang))
  2586. (caption-str
  2587. (when caption
  2588. (let ((main (org-export-get-caption src-block))
  2589. (secondary (org-export-get-caption src-block t)))
  2590. (if (not secondary)
  2591. (format "{%s}" (org-export-data main info))
  2592. (format "{[%s]%s}"
  2593. (org-export-data secondary info)
  2594. (org-export-data main info))))))
  2595. (lst-opt (plist-get info :latex-listings-options)))
  2596. (concat
  2597. ;; Options.
  2598. (format
  2599. "\\lstset{%s}\n"
  2600. (concat
  2601. (org-latex--make-option-string
  2602. (append
  2603. lst-opt
  2604. (cond
  2605. ((and (not float) (plist-member attributes :float)) nil)
  2606. ((string= "multicolumn" float) '(("float" "*")))
  2607. ((and float (not (assoc "float" lst-opt)))
  2608. `(("float" ,(plist-get info :latex-default-figure-position)))))
  2609. `(("language" ,lst-lang))
  2610. (if label
  2611. `(("label" ,(org-latex--label src-block info)))
  2612. '(("label" " ")))
  2613. (if caption-str `(("caption" ,caption-str)) '(("caption" " ")))
  2614. `(("captionpos" ,(if caption-above-p "t" "b")))
  2615. (cond ((assoc "numbers" lst-opt) nil)
  2616. ((not num-start) '(("numbers" "none")))
  2617. (t `(("firstnumber" ,(number-to-string (1+ num-start)))
  2618. ("numbers" "left"))))))
  2619. (let ((local-options (plist-get attributes :options)))
  2620. (and local-options (concat "," local-options)))))
  2621. ;; Source code.
  2622. (format
  2623. "\\begin{lstlisting}\n%s\\end{lstlisting}"
  2624. (let* ((code-info (org-export-unravel-code src-block))
  2625. (max-width
  2626. (apply 'max
  2627. (mapcar 'length
  2628. (org-split-string (car code-info) "\n")))))
  2629. (org-export-format-code
  2630. (car code-info)
  2631. (lambda (loc _num ref)
  2632. (concat
  2633. loc
  2634. (when ref
  2635. ;; Ensure references are flushed to the right,
  2636. ;; separated with 6 spaces from the widest line of
  2637. ;; code
  2638. (concat (make-string (+ (- max-width (length loc)) 6) ?\s)
  2639. (format "(%s)" ref)))))
  2640. nil (and retain-labels (cdr code-info))))))))))))
  2641. ;;;; Statistics Cookie
  2642. (defun org-latex-statistics-cookie (statistics-cookie _contents _info)
  2643. "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
  2644. CONTENTS is nil. INFO is a plist holding contextual information."
  2645. (replace-regexp-in-string
  2646. "%" "\\%" (org-element-property :value statistics-cookie) nil t))
  2647. ;;;; Strike-Through
  2648. (defun org-latex-strike-through (_strike-through contents info)
  2649. "Transcode STRIKE-THROUGH from Org to LaTeX.
  2650. CONTENTS is the text with strike-through markup. INFO is a plist
  2651. holding contextual information."
  2652. (org-latex--text-markup contents 'strike-through info))
  2653. ;;;; Subscript
  2654. (defun org-latex--script-size (object info)
  2655. "Transcode a subscript or superscript object.
  2656. OBJECT is an Org object. INFO is a plist used as a communication
  2657. channel."
  2658. (let ((output ""))
  2659. (org-element-map (org-element-contents object)
  2660. (cons 'plain-text org-element-all-objects)
  2661. (lambda (obj)
  2662. (cl-case (org-element-type obj)
  2663. ((entity latex-fragment)
  2664. (let ((data (org-trim (org-export-data obj info))))
  2665. (string-match
  2666. "\\`\\(?:\\\\[([]\\|\\$+\\)?\\(.*?\\)\\(?:\\\\[])]\\|\\$+\\)?\\'"
  2667. data)
  2668. (setq output
  2669. (concat output
  2670. (match-string 1 data)
  2671. (let ((blank (org-element-property :post-blank obj)))
  2672. (and blank (> blank 0) "\\ "))))))
  2673. (plain-text
  2674. (setq output
  2675. (format "%s\\text{%s}" output (org-export-data obj info))))
  2676. (otherwise
  2677. (setq output
  2678. (concat output
  2679. (org-export-data obj info)
  2680. (let ((blank (org-element-property :post-blank obj)))
  2681. (and blank (> blank 0) "\\ ")))))))
  2682. info nil org-element-recursive-objects)
  2683. ;; Result. Do not wrap into curly brackets if OUTPUT is a single
  2684. ;; character.
  2685. (concat (if (eq (org-element-type object) 'subscript) "_" "^")
  2686. (and (> (length output) 1) "{")
  2687. output
  2688. (and (> (length output) 1) "}"))))
  2689. (defun org-latex-subscript (subscript _contents info)
  2690. "Transcode a SUBSCRIPT object from Org to LaTeX.
  2691. CONTENTS is the contents of the object. INFO is a plist holding
  2692. contextual information."
  2693. (org-latex--script-size subscript info))
  2694. ;;;; Superscript
  2695. (defun org-latex-superscript (superscript _contents info)
  2696. "Transcode a SUPERSCRIPT object from Org to LaTeX.
  2697. CONTENTS is the contents of the object. INFO is a plist holding
  2698. contextual information."
  2699. (org-latex--script-size superscript info))
  2700. ;;;; Table
  2701. ;;
  2702. ;; `org-latex-table' is the entry point for table transcoding. It
  2703. ;; takes care of tables with a "verbatim" mode. Otherwise, it
  2704. ;; delegates the job to either `org-latex--table.el-table',
  2705. ;; `org-latex--org-table' or `org-latex--math-table' functions,
  2706. ;; depending of the type of the table and the mode requested.
  2707. ;;
  2708. ;; `org-latex--align-string' is a subroutine used to build alignment
  2709. ;; string for Org tables.
  2710. (defun org-latex-table (table contents info)
  2711. "Transcode a TABLE element from Org to LaTeX.
  2712. CONTENTS is the contents of the table. INFO is a plist holding
  2713. contextual information."
  2714. (if (eq (org-element-property :type table) 'table.el)
  2715. ;; "table.el" table. Convert it using appropriate tools.
  2716. (org-latex--table.el-table table info)
  2717. (let ((type (or (org-export-read-attribute :attr_latex table :mode)
  2718. (plist-get info :latex-default-table-mode))))
  2719. (cond
  2720. ;; Case 1: Verbatim table.
  2721. ((string= type "verbatim")
  2722. (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
  2723. ;; Re-create table, without affiliated keywords.
  2724. (org-trim (org-element-interpret-data
  2725. `(table nil ,@(org-element-contents table))))))
  2726. ;; Case 2: Matrix.
  2727. ((or (string= type "math") (string= type "inline-math"))
  2728. (org-latex--math-table table info))
  2729. ;; Case 3: Standard table.
  2730. (t (concat (org-latex--org-table table contents info)
  2731. ;; When there are footnote references within the
  2732. ;; table, insert their definition just after it.
  2733. (org-latex--delayed-footnotes-definitions table info)))))))
  2734. (defun org-latex--align-string (table info)
  2735. "Return an appropriate LaTeX alignment string.
  2736. TABLE is the considered table. INFO is a plist used as
  2737. a communication channel."
  2738. (or (org-export-read-attribute :attr_latex table :align)
  2739. (let (align)
  2740. ;; Extract column groups and alignment from first (non-rule)
  2741. ;; row.
  2742. (org-element-map
  2743. (org-element-map table 'table-row
  2744. (lambda (row)
  2745. (and (eq (org-element-property :type row) 'standard) row))
  2746. info 'first-match)
  2747. 'table-cell
  2748. (lambda (cell)
  2749. (let ((borders (org-export-table-cell-borders cell info)))
  2750. ;; Check left border for the first cell only.
  2751. (when (and (memq 'left borders) (not align))
  2752. (push "|" align))
  2753. (push (cl-case (org-export-table-cell-alignment cell info)
  2754. (left "l")
  2755. (right "r")
  2756. (center "c"))
  2757. align)
  2758. (when (memq 'right borders) (push "|" align))))
  2759. info)
  2760. (apply 'concat (nreverse align)))))
  2761. (defun org-latex--org-table (table contents info)
  2762. "Return appropriate LaTeX code for an Org table.
  2763. TABLE is the table type element to transcode. CONTENTS is its
  2764. contents, as a string. INFO is a plist used as a communication
  2765. channel.
  2766. This function assumes TABLE has `org' as its `:type' property and
  2767. `table' as its `:mode' attribute."
  2768. (let* ((caption (org-latex--caption/label-string table info))
  2769. (attr (org-export-read-attribute :attr_latex table))
  2770. ;; Determine alignment string.
  2771. (alignment (org-latex--align-string table info))
  2772. ;; Determine environment for the table: longtable, tabular...
  2773. (table-env (or (plist-get attr :environment)
  2774. (plist-get info :latex-default-table-environment)))
  2775. ;; If table is a float, determine environment: table, table*
  2776. ;; or sidewaystable.
  2777. (float-env (unless (member table-env '("longtable" "longtabu"))
  2778. (let ((float (plist-get attr :float)))
  2779. (cond
  2780. ((and (not float) (plist-member attr :float)) nil)
  2781. ((or (string= float "sidewaystable")
  2782. (string= float "sideways")) "sidewaystable")
  2783. ((string= float "multicolumn") "table*")
  2784. ((or float
  2785. (org-element-property :caption table)
  2786. (org-string-nw-p (plist-get attr :caption)))
  2787. "table")))))
  2788. ;; Extract others display options.
  2789. (fontsize (let ((font (plist-get attr :font)))
  2790. (and font (concat font "\n"))))
  2791. ;; "tabular" environment doesn't allow to define a width.
  2792. (width (and (not (equal table-env "tabular")) (plist-get attr :width)))
  2793. (spreadp (plist-get attr :spread))
  2794. (placement
  2795. (or (plist-get attr :placement)
  2796. (format "[%s]" (plist-get info :latex-default-figure-position))))
  2797. (centerp (if (plist-member attr :center) (plist-get attr :center)
  2798. (plist-get info :latex-tables-centered)))
  2799. (caption-above-p (org-latex--caption-above-p table info)))
  2800. ;; Prepare the final format string for the table.
  2801. (cond
  2802. ;; Longtable.
  2803. ((equal "longtable" table-env)
  2804. (concat (and fontsize (concat "{" fontsize))
  2805. (format "\\begin{longtable}{%s}\n" alignment)
  2806. (and caption-above-p
  2807. (org-string-nw-p caption)
  2808. (concat caption "\\\\\n"))
  2809. contents
  2810. (and (not caption-above-p)
  2811. (org-string-nw-p caption)
  2812. (concat caption "\\\\\n"))
  2813. "\\end{longtable}\n"
  2814. (and fontsize "}")))
  2815. ;; Longtabu
  2816. ((equal "longtabu" table-env)
  2817. (concat (and fontsize (concat "{" fontsize))
  2818. (format "\\begin{longtabu}%s{%s}\n"
  2819. (if width
  2820. (format " %s %s "
  2821. (if spreadp "spread" "to") width) "")
  2822. alignment)
  2823. (and caption-above-p
  2824. (org-string-nw-p caption)
  2825. (concat caption "\\\\\n"))
  2826. contents
  2827. (and (not caption-above-p)
  2828. (org-string-nw-p caption)
  2829. (concat caption "\\\\\n"))
  2830. "\\end{longtabu}\n"
  2831. (and fontsize "}")))
  2832. ;; Others.
  2833. (t (concat (cond
  2834. (float-env
  2835. (concat (format "\\begin{%s}%s\n" float-env placement)
  2836. (if caption-above-p caption "")
  2837. (when centerp "\\centering\n")
  2838. fontsize))
  2839. ((and (not float-env) caption)
  2840. (concat
  2841. (and centerp "\\begin{center}\n" )
  2842. (if caption-above-p caption "")
  2843. (cond ((and fontsize centerp) fontsize)
  2844. (fontsize (concat "{" fontsize)))))
  2845. (centerp (concat "\\begin{center}\n" fontsize))
  2846. (fontsize (concat "{" fontsize)))
  2847. (cond ((equal "tabu" table-env)
  2848. (format "\\begin{tabu}%s{%s}\n%s\\end{tabu}"
  2849. (if width (format
  2850. (if spreadp " spread %s " " to %s ")
  2851. width) "")
  2852. alignment
  2853. contents))
  2854. (t (format "\\begin{%s}%s{%s}\n%s\\end{%s}"
  2855. table-env
  2856. (if width (format "{%s}" width) "")
  2857. alignment
  2858. contents
  2859. table-env)))
  2860. (cond
  2861. (float-env
  2862. (concat (if caption-above-p "" (concat "\n" caption))
  2863. (format "\n\\end{%s}" float-env)))
  2864. ((and (not float-env) caption)
  2865. (concat
  2866. (if caption-above-p "" (concat "\n" caption))
  2867. (and centerp "\n\\end{center}")
  2868. (and fontsize (not centerp) "}")))
  2869. (centerp "\n\\end{center}")
  2870. (fontsize "}")))))))
  2871. (defun org-latex--table.el-table (table info)
  2872. "Return appropriate LaTeX code for a table.el table.
  2873. TABLE is the table type element to transcode. INFO is a plist
  2874. used as a communication channel.
  2875. This function assumes TABLE has `table.el' as its `:type'
  2876. property."
  2877. (require 'table)
  2878. ;; Ensure "*org-export-table*" buffer is empty.
  2879. (with-current-buffer (get-buffer-create "*org-export-table*")
  2880. (erase-buffer))
  2881. (let ((output (with-temp-buffer
  2882. (insert (org-element-property :value table))
  2883. (goto-char 1)
  2884. (re-search-forward "^[ \t]*|[^|]" nil t)
  2885. (table-generate-source 'latex "*org-export-table*")
  2886. (with-current-buffer "*org-export-table*"
  2887. (org-trim (buffer-string))))))
  2888. (kill-buffer (get-buffer "*org-export-table*"))
  2889. ;; Remove left out comments.
  2890. (while (string-match "^%.*\n" output)
  2891. (setq output (replace-match "" t t output)))
  2892. (let ((attr (org-export-read-attribute :attr_latex table)))
  2893. (when (plist-get attr :rmlines)
  2894. ;; When the "rmlines" attribute is provided, remove all hlines
  2895. ;; but the the one separating heading from the table body.
  2896. (let ((n 0) (pos 0))
  2897. (while (and (< (length output) pos)
  2898. (setq pos (string-match "^\\\\hline\n?" output pos)))
  2899. (cl-incf n)
  2900. (unless (= n 2) (setq output (replace-match "" nil nil output))))))
  2901. (let ((centerp (if (plist-member attr :center) (plist-get attr :center)
  2902. (plist-get info :latex-tables-centered))))
  2903. (if (not centerp) output
  2904. (format "\\begin{center}\n%s\n\\end{center}" output))))))
  2905. (defun org-latex--math-table (table info)
  2906. "Return appropriate LaTeX code for a matrix.
  2907. TABLE is the table type element to transcode. INFO is a plist
  2908. used as a communication channel.
  2909. This function assumes TABLE has `org' as its `:type' property and
  2910. `inline-math' or `math' as its `:mode' attribute."
  2911. (let* ((attr (org-export-read-attribute :attr_latex table))
  2912. (env (or (plist-get attr :environment)
  2913. (plist-get info :latex-default-table-environment)))
  2914. (contents
  2915. (mapconcat
  2916. (lambda (row)
  2917. ;; Ignore horizontal rules.
  2918. (when (eq (org-element-property :type row) 'standard)
  2919. ;; Return each cell unmodified.
  2920. (concat
  2921. (mapconcat
  2922. (lambda (cell)
  2923. (substring (org-element-interpret-data cell) 0 -1))
  2924. (org-element-map row 'table-cell #'identity info) "&")
  2925. (or (cdr (assoc env org-latex-table-matrix-macros)) "\\\\")
  2926. "\n")))
  2927. (org-element-map table 'table-row #'identity info) "")))
  2928. (concat
  2929. ;; Prefix.
  2930. (plist-get attr :math-prefix)
  2931. ;; Environment. Also treat special cases.
  2932. (cond ((member env '("array" "tabular"))
  2933. ;; Make sure cells are always centered while preserving
  2934. ;; vertical separators.
  2935. (let ((align (replace-regexp-in-string
  2936. "[lr]" "c" (org-latex--align-string table info))))
  2937. (format "\\begin{%s}{%s}\n%s\\end{%s}" env align contents env)))
  2938. ((assoc env org-latex-table-matrix-macros)
  2939. (format "\\%s%s{\n%s}"
  2940. env
  2941. (or (plist-get attr :math-arguments) "")
  2942. contents))
  2943. (t (format "\\begin{%s}\n%s\\end{%s}" env contents env)))
  2944. ;; Suffix.
  2945. (plist-get attr :math-suffix))))
  2946. ;;;; Table Cell
  2947. (defun org-latex-table-cell (table-cell contents info)
  2948. "Transcode a TABLE-CELL element from Org to LaTeX.
  2949. CONTENTS is the cell contents. INFO is a plist used as
  2950. a communication channel."
  2951. (concat
  2952. (let ((scientific-format (plist-get info :latex-table-scientific-notation)))
  2953. (if (and contents
  2954. scientific-format
  2955. (string-match orgtbl-exp-regexp contents))
  2956. ;; Use appropriate format string for scientific
  2957. ;; notation.
  2958. (format scientific-format
  2959. (match-string 1 contents)
  2960. (match-string 2 contents))
  2961. contents))
  2962. (when (org-export-get-next-element table-cell info) " & ")))
  2963. ;;;; Table Row
  2964. (defun org-latex-table-row (table-row contents info)
  2965. "Transcode a TABLE-ROW element from Org to LaTeX.
  2966. CONTENTS is the contents of the row. INFO is a plist used as
  2967. a communication channel."
  2968. (let* ((attr (org-export-read-attribute :attr_latex
  2969. (org-export-get-parent table-row)))
  2970. (booktabsp (if (plist-member attr :booktabs) (plist-get attr :booktabs)
  2971. (plist-get info :latex-tables-booktabs)))
  2972. (longtablep
  2973. (member (or (plist-get attr :environment)
  2974. (plist-get info :latex-default-table-environment))
  2975. '("longtable" "longtabu"))))
  2976. (if (eq (org-element-property :type table-row) 'rule)
  2977. (cond
  2978. ((not booktabsp) "\\hline")
  2979. ((not (org-export-get-previous-element table-row info)) "\\toprule")
  2980. ((not (org-export-get-next-element table-row info)) "\\bottomrule")
  2981. ((and longtablep
  2982. (org-export-table-row-ends-header-p
  2983. (org-export-get-previous-element table-row info) info))
  2984. "")
  2985. (t "\\midrule"))
  2986. (concat
  2987. ;; When BOOKTABS are activated enforce top-rule even when no
  2988. ;; hline was specifically marked.
  2989. (and booktabsp (not (org-export-get-previous-element table-row info))
  2990. "\\toprule\n")
  2991. contents "\\\\\n"
  2992. (cond
  2993. ;; Special case for long tables. Define header and footers.
  2994. ((and longtablep (org-export-table-row-ends-header-p table-row info))
  2995. (let ((columns (cdr (org-export-table-dimensions
  2996. (org-export-get-parent-table table-row) info))))
  2997. (format "%s
  2998. \\endfirsthead
  2999. \\multicolumn{%d}{l}{%s} \\\\
  3000. %s
  3001. %s \\\\\n
  3002. %s
  3003. \\endhead
  3004. %s\\multicolumn{%d}{r}{%s} \\\\
  3005. \\endfoot
  3006. \\endlastfoot"
  3007. (if booktabsp "\\midrule" "\\hline")
  3008. columns
  3009. (org-latex--translate "Continued from previous page" info)
  3010. (cond
  3011. ((not (org-export-table-row-starts-header-p table-row info))
  3012. "")
  3013. (booktabsp "\\toprule\n")
  3014. (t "\\hline\n"))
  3015. contents
  3016. (if booktabsp "\\midrule" "\\hline")
  3017. (if booktabsp "\\midrule" "\\hline")
  3018. columns
  3019. (org-latex--translate "Continued on next page" info))))
  3020. ;; When BOOKTABS are activated enforce bottom rule even when
  3021. ;; no hline was specifically marked.
  3022. ((and booktabsp (not (org-export-get-next-element table-row info)))
  3023. "\\bottomrule"))))))
  3024. ;;;; Target
  3025. (defun org-latex-target (target _contents info)
  3026. "Transcode a TARGET object from Org to LaTeX.
  3027. CONTENTS is nil. INFO is a plist holding contextual
  3028. information."
  3029. (format "\\label{%s}" (org-latex--label target info)))
  3030. ;;;; Timestamp
  3031. (defun org-latex-timestamp (timestamp _contents info)
  3032. "Transcode a TIMESTAMP object from Org to LaTeX.
  3033. CONTENTS is nil. INFO is a plist holding contextual
  3034. information."
  3035. (let ((value (org-latex-plain-text (org-timestamp-translate timestamp) info)))
  3036. (format
  3037. (plist-get info
  3038. (cl-case (org-element-property :type timestamp)
  3039. ((active active-range) :latex-active-timestamp-format)
  3040. ((inactive inactive-range) :latex-inactive-timestamp-format)
  3041. (otherwise :latex-diary-timestamp-format)))
  3042. value)))
  3043. ;;;; Underline
  3044. (defun org-latex-underline (_underline contents info)
  3045. "Transcode UNDERLINE from Org to LaTeX.
  3046. CONTENTS is the text with underline markup. INFO is a plist
  3047. holding contextual information."
  3048. (org-latex--text-markup contents 'underline info))
  3049. ;;;; Verbatim
  3050. (defun org-latex-verbatim (verbatim _contents info)
  3051. "Transcode a VERBATIM object from Org to LaTeX.
  3052. CONTENTS is nil. INFO is a plist used as a communication
  3053. channel."
  3054. (org-latex--text-markup
  3055. (org-element-property :value verbatim) 'verbatim info))
  3056. ;;;; Verse Block
  3057. (defun org-latex-verse-block (verse-block contents info)
  3058. "Transcode a VERSE-BLOCK element from Org to LaTeX.
  3059. CONTENTS is verse block contents. INFO is a plist holding
  3060. contextual information."
  3061. (org-latex--wrap-label
  3062. verse-block
  3063. ;; In a verse environment, add a line break to each newline
  3064. ;; character and change each white space at beginning of a line
  3065. ;; into a space of 1 em. Also change each blank line with
  3066. ;; a vertical space of 1 em.
  3067. (format "\\begin{verse}\n%s\\end{verse}"
  3068. (replace-regexp-in-string
  3069. "^[ \t]+" (lambda (m) (format "\\hspace*{%dem}" (length m)))
  3070. (replace-regexp-in-string
  3071. "^[ \t]*\\\\\\\\$" "\\vspace*{1em}"
  3072. (replace-regexp-in-string
  3073. "\\([ \t]*\\\\\\\\\\)?[ \t]*\n" "\\\\\n"
  3074. contents nil t) nil t) nil t))
  3075. info))
  3076. ;;; End-user functions
  3077. ;;;###autoload
  3078. (defun org-latex-export-as-latex
  3079. (&optional async subtreep visible-only body-only ext-plist)
  3080. "Export current buffer as a LaTeX buffer.
  3081. If narrowing is active in the current buffer, only export its
  3082. narrowed part.
  3083. If a region is active, export that region.
  3084. A non-nil optional argument ASYNC means the process should happen
  3085. asynchronously. The resulting buffer should be accessible
  3086. through the `org-export-stack' interface.
  3087. When optional argument SUBTREEP is non-nil, export the sub-tree
  3088. at point, extracting information from the headline properties
  3089. first.
  3090. When optional argument VISIBLE-ONLY is non-nil, don't export
  3091. contents of hidden elements.
  3092. When optional argument BODY-ONLY is non-nil, only write code
  3093. between \"\\begin{document}\" and \"\\end{document}\".
  3094. EXT-PLIST, when provided, is a property list with external
  3095. parameters overriding Org default settings, but still inferior to
  3096. file-local settings.
  3097. Export is done in a buffer named \"*Org LATEX Export*\", which
  3098. will be displayed when `org-export-show-temporary-export-buffer'
  3099. is non-nil."
  3100. (interactive)
  3101. (org-export-to-buffer 'latex "*Org LATEX Export*"
  3102. async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
  3103. ;;;###autoload
  3104. (defun org-latex-convert-region-to-latex ()
  3105. "Assume the current region has Org syntax, and convert it to LaTeX.
  3106. This can be used in any buffer. For example, you can write an
  3107. itemized list in Org syntax in an LaTeX buffer and use this
  3108. command to convert it."
  3109. (interactive)
  3110. (org-export-replace-region-by 'latex))
  3111. ;;;###autoload
  3112. (defun org-latex-export-to-latex
  3113. (&optional async subtreep visible-only body-only ext-plist)
  3114. "Export current buffer to a LaTeX file.
  3115. If narrowing is active in the current buffer, only export its
  3116. narrowed part.
  3117. If a region is active, export that region.
  3118. A non-nil optional argument ASYNC means the process should happen
  3119. asynchronously. The resulting file should be accessible through
  3120. the `org-export-stack' interface.
  3121. When optional argument SUBTREEP is non-nil, export the sub-tree
  3122. at point, extracting information from the headline properties
  3123. first.
  3124. When optional argument VISIBLE-ONLY is non-nil, don't export
  3125. contents of hidden elements.
  3126. When optional argument BODY-ONLY is non-nil, only write code
  3127. between \"\\begin{document}\" and \"\\end{document}\".
  3128. EXT-PLIST, when provided, is a property list with external
  3129. parameters overriding Org default settings, but still inferior to
  3130. file-local settings."
  3131. (interactive)
  3132. (let ((outfile (org-export-output-file-name ".tex" subtreep)))
  3133. (org-export-to-file 'latex outfile
  3134. async subtreep visible-only body-only ext-plist)))
  3135. ;;;###autoload
  3136. (defun org-latex-export-to-pdf
  3137. (&optional async subtreep visible-only body-only ext-plist)
  3138. "Export current buffer to LaTeX then process through to PDF.
  3139. If narrowing is active in the current buffer, only export its
  3140. narrowed part.
  3141. If a region is active, export that region.
  3142. A non-nil optional argument ASYNC means the process should happen
  3143. asynchronously. The resulting file should be accessible through
  3144. the `org-export-stack' interface.
  3145. When optional argument SUBTREEP is non-nil, export the sub-tree
  3146. at point, extracting information from the headline properties
  3147. first.
  3148. When optional argument VISIBLE-ONLY is non-nil, don't export
  3149. contents of hidden elements.
  3150. When optional argument BODY-ONLY is non-nil, only write code
  3151. between \"\\begin{document}\" and \"\\end{document}\".
  3152. EXT-PLIST, when provided, is a property list with external
  3153. parameters overriding Org default settings, but still inferior to
  3154. file-local settings.
  3155. Return PDF file's name."
  3156. (interactive)
  3157. (let ((outfile (org-export-output-file-name ".tex" subtreep)))
  3158. (org-export-to-file 'latex outfile
  3159. async subtreep visible-only body-only ext-plist
  3160. (lambda (file) (org-latex-compile file)))))
  3161. (defun org-latex-compile (texfile &optional snippet)
  3162. "Compile a TeX file.
  3163. TEXFILE is the name of the file being compiled. Processing is
  3164. done through the command specified in `org-latex-pdf-process',
  3165. which see. Output is redirected to \"*Org PDF LaTeX Output*\"
  3166. buffer.
  3167. When optional argument SNIPPET is non-nil, TEXFILE is a temporary
  3168. file used to preview a LaTeX snippet. In this case, do not
  3169. create a log buffer and do not remove log files.
  3170. Return PDF file name or raise an error if it couldn't be
  3171. produced."
  3172. (unless snippet (message "Processing LaTeX file %s..." texfile))
  3173. (let* ((compiler
  3174. (or (with-temp-buffer
  3175. (save-excursion (insert-file-contents texfile))
  3176. (and (search-forward-regexp (regexp-opt org-latex-compilers)
  3177. (line-end-position 2)
  3178. t)
  3179. (progn (beginning-of-line) (looking-at-p "%"))
  3180. (match-string 0)))
  3181. "pdflatex"))
  3182. (process (if (functionp org-latex-pdf-process) org-latex-pdf-process
  3183. ;; Replace "%latex" and "%bibtex" with,
  3184. ;; respectively, "%L" and "%B" so as to adhere to
  3185. ;; `format-spec' specifications.
  3186. (mapcar (lambda (command)
  3187. (replace-regexp-in-string
  3188. "%\\(?:bib\\|la\\)tex\\>"
  3189. (lambda (m) (upcase (substring m 0 2)))
  3190. command))
  3191. org-latex-pdf-process)))
  3192. (spec `((?B . ,(shell-quote-argument org-latex-bib-compiler))
  3193. (?L . ,(shell-quote-argument compiler))))
  3194. (log-buf-name "*Org PDF LaTeX Output*")
  3195. (log-buf (and (not snippet) (get-buffer-create log-buf-name)))
  3196. (outfile (org-compile-file texfile process "pdf"
  3197. (format "See %S for details" log-buf-name)
  3198. log-buf spec)))
  3199. (unless snippet
  3200. (when org-latex-remove-logfiles
  3201. (mapc #'delete-file
  3202. (directory-files
  3203. (file-name-directory outfile)
  3204. t
  3205. (concat (regexp-quote (file-name-base outfile))
  3206. "\\(?:\\.[0-9]+\\)?\\."
  3207. (regexp-opt org-latex-logfiles-extensions))
  3208. t)))
  3209. (let ((warnings (org-latex--collect-warnings log-buf)))
  3210. (message (concat "PDF file produced"
  3211. (cond
  3212. ((eq warnings 'error) " with errors.")
  3213. (warnings (concat " with warnings: " warnings))
  3214. (t "."))))))
  3215. ;; Return output file name.
  3216. outfile))
  3217. (defun org-latex--collect-warnings (buffer)
  3218. "Collect some warnings from \"pdflatex\" command output.
  3219. BUFFER is the buffer containing output. Return collected
  3220. warnings types as a string, `error' if a LaTeX error was
  3221. encountered or nil if there was none."
  3222. (with-current-buffer buffer
  3223. (save-excursion
  3224. (goto-char (point-max))
  3225. (when (re-search-backward "^[ \t]*This is .*?TeX.*?Version" nil t)
  3226. (if (re-search-forward "^!" nil t) 'error
  3227. (let ((case-fold-search t)
  3228. (warnings ""))
  3229. (dolist (warning org-latex-known-warnings)
  3230. (when (save-excursion (re-search-forward (car warning) nil t))
  3231. (setq warnings (concat warnings " " (cdr warning)))))
  3232. (org-string-nw-p (org-trim warnings))))))))
  3233. ;;;###autoload
  3234. (defun org-latex-publish-to-latex (plist filename pub-dir)
  3235. "Publish an Org file to LaTeX.
  3236. FILENAME is the filename of the Org file to be published. PLIST
  3237. is the property list for the given project. PUB-DIR is the
  3238. publishing directory.
  3239. Return output file name."
  3240. (org-publish-org-to 'latex filename ".tex" plist pub-dir))
  3241. ;;;###autoload
  3242. (defun org-latex-publish-to-pdf (plist filename pub-dir)
  3243. "Publish an Org file to PDF (via LaTeX).
  3244. FILENAME is the filename of the Org file to be published. PLIST
  3245. is the property list for the given project. PUB-DIR is the
  3246. publishing directory.
  3247. Return output file name."
  3248. ;; Unlike to `org-latex-publish-to-latex', PDF file is generated
  3249. ;; in working directory and then moved to publishing directory.
  3250. (org-publish-attachment
  3251. plist
  3252. (org-latex-compile
  3253. (org-publish-org-to
  3254. 'latex filename ".tex" plist (file-name-directory filename)))
  3255. pub-dir))
  3256. (provide 'ox-latex)
  3257. ;; Local variables:
  3258. ;; generated-autoload-file: "org-loaddefs.el"
  3259. ;; End:
  3260. ;;; ox-latex.el ends here