ox-latex.el 125 KB

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