org-latex.el 105 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885
  1. ;;; org-latex.el --- LaTeX exporter for org-mode
  2. ;;
  3. ;; Copyright (C) 2007-2012 Free Software Foundation, Inc.
  4. ;;
  5. ;; Emacs Lisp Archive Entry
  6. ;; Filename: org-latex.el
  7. ;; Author: Bastien Guerry <bzg AT gnu DOT org>
  8. ;; Maintainer: Carsten Dominik <carsten.dominik AT gmail DOT com>
  9. ;; Keywords: org, wp, tex
  10. ;; Description: Converts an org-mode buffer into LaTeX
  11. ;; This file is part of GNU Emacs.
  12. ;; GNU Emacs is free software: you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation, either version 3 of the License, or
  15. ;; (at your option) any later version.
  16. ;; GNU Emacs is distributed in the hope that it will be useful,
  17. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. ;; GNU General Public License for more details.
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  22. ;;; Commentary:
  23. ;;
  24. ;; This library implements a LaTeX exporter for org-mode.
  25. ;;
  26. ;; It is part of Org and will be autoloaded
  27. ;;
  28. ;; The interactive functions are similar to those of the HTML exporter:
  29. ;;
  30. ;; M-x `org-export-as-latex'
  31. ;; M-x `org-export-as-pdf'
  32. ;; M-x `org-export-as-pdf-and-open'
  33. ;; M-x `org-export-as-latex-batch'
  34. ;; M-x `org-export-as-latex-to-buffer'
  35. ;; M-x `org-export-region-as-latex'
  36. ;; M-x `org-replace-region-by-latex'
  37. ;;
  38. ;;; Code:
  39. (eval-when-compile
  40. (require 'cl))
  41. (require 'footnote)
  42. (require 'org)
  43. (require 'org-exp)
  44. (require 'org-macs)
  45. (require 'org-beamer)
  46. ;;; Variables:
  47. (defvar org-export-latex-class nil)
  48. (defvar org-export-latex-class-options nil)
  49. (defvar org-export-latex-header nil)
  50. (defvar org-export-latex-append-header nil)
  51. (defvar org-export-latex-options-plist nil)
  52. (defvar org-export-latex-todo-keywords-1 nil)
  53. (defvar org-export-latex-complex-heading-re nil)
  54. (defvar org-export-latex-not-done-keywords nil)
  55. (defvar org-export-latex-done-keywords nil)
  56. (defvar org-export-latex-display-custom-times nil)
  57. (defvar org-export-latex-all-targets-re nil)
  58. (defvar org-export-latex-add-level 0)
  59. (defvar org-export-latex-footmark-seen nil
  60. "List of footnotes markers seen so far by exporter.")
  61. (defvar org-export-latex-sectioning "")
  62. (defvar org-export-latex-sectioning-depth 0)
  63. (defvar org-export-latex-special-keyword-regexp
  64. (concat "\\<\\(" org-scheduled-string "\\|"
  65. org-deadline-string "\\|"
  66. org-closed-string"\\)")
  67. "Regexp matching special time planning keywords plus the time after it.")
  68. (defvar org-re-quote) ; dynamically scoped from org.el
  69. (defvar org-commentsp) ; dynamically scoped from org.el
  70. ;;; User variables:
  71. (defgroup org-export-latex nil
  72. "Options for exporting Org-mode files to LaTeX."
  73. :tag "Org Export LaTeX"
  74. :group 'org-export)
  75. (defcustom org-export-latex-default-class "article"
  76. "The default LaTeX class."
  77. :group 'org-export-latex
  78. :type '(string :tag "LaTeX class"))
  79. (defcustom org-export-latex-classes
  80. '(("article"
  81. "\\documentclass[11pt]{article}"
  82. ("\\section{%s}" . "\\section*{%s}")
  83. ("\\subsection{%s}" . "\\subsection*{%s}")
  84. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
  85. ("\\paragraph{%s}" . "\\paragraph*{%s}")
  86. ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
  87. ("report"
  88. "\\documentclass[11pt]{report}"
  89. ("\\part{%s}" . "\\part*{%s}")
  90. ("\\chapter{%s}" . "\\chapter*{%s}")
  91. ("\\section{%s}" . "\\section*{%s}")
  92. ("\\subsection{%s}" . "\\subsection*{%s}")
  93. ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
  94. ("book"
  95. "\\documentclass[11pt]{book}"
  96. ("\\part{%s}" . "\\part*{%s}")
  97. ("\\chapter{%s}" . "\\chapter*{%s}")
  98. ("\\section{%s}" . "\\section*{%s}")
  99. ("\\subsection{%s}" . "\\subsection*{%s}")
  100. ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
  101. ("beamer"
  102. "\\documentclass{beamer}"
  103. org-beamer-sectioning
  104. ))
  105. "Alist of LaTeX classes and associated header and structure.
  106. If #+LaTeX_CLASS is set in the buffer, use its value and the
  107. associated information. Here is the structure of each cell:
  108. \(class-name
  109. header-string
  110. (numbered-section . unnumbered-section\)
  111. ...\)
  112. The header string
  113. -----------------
  114. The HEADER-STRING is the header that will be inserted into the LaTeX file.
  115. It should contain the \\documentclass macro, and anything else that is needed
  116. for this setup. To this header, the following commands will be added:
  117. - Calls to \\usepackage for all packages mentioned in the variables
  118. `org-export-latex-default-packages-alist' and
  119. `org-export-latex-packages-alist'. Thus, your header definitions should
  120. avoid to also request these packages.
  121. - Lines specified via \"#+LaTeX_HEADER:\"
  122. If you need more control about the sequence in which the header is built
  123. up, or if you want to exclude one of these building blocks for a particular
  124. class, you can use the following macro-like placeholders.
  125. [DEFAULT-PACKAGES] \\usepackage statements for default packages
  126. [NO-DEFAULT-PACKAGES] do not include any of the default packages
  127. [PACKAGES] \\usepackage statements for packages
  128. [NO-PACKAGES] do not include the packages
  129. [EXTRA] the stuff from #+LaTeX_HEADER
  130. [NO-EXTRA] do not include #+LaTeX_HEADER stuff
  131. [BEAMER-HEADER-EXTRA] the beamer extra headers
  132. So a header like
  133. \\documentclass{article}
  134. [NO-DEFAULT-PACKAGES]
  135. [EXTRA]
  136. \\providecommand{\\alert}[1]{\\textbf{#1}}
  137. [PACKAGES]
  138. will omit the default packages, and will include the #+LaTeX_HEADER lines,
  139. then have a call to \\providecommand, and then place \\usepackage commands
  140. based on the content of `org-export-latex-packages-alist'.
  141. If your header or `org-export-latex-default-packages-alist' inserts
  142. \"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be replaced with
  143. a coding system derived from `buffer-file-coding-system'. See also the
  144. variable `org-export-latex-inputenc-alist' for a way to influence this
  145. mechanism.
  146. The sectioning structure
  147. ------------------------
  148. The sectioning structure of the class is given by the elements following
  149. the header string. For each sectioning level, a number of strings is
  150. specified. A %s formatter is mandatory in each section string and will
  151. be replaced by the title of the section.
  152. Instead of a cons cell (numbered . unnumbered), you can also provide a list
  153. of 2 or 4 elements,
  154. (numbered-open numbered-close)
  155. or
  156. (numbered-open numbered-close unnumbered-open unnumbered-close)
  157. providing opening and closing strings for a LaTeX environment that should
  158. represent the document section. The opening clause should have a %s
  159. to represent the section title.
  160. Instead of a list of sectioning commands, you can also specify a
  161. function name. That function will be called with two parameters,
  162. the (reduced) level of the headline, and the headline text. The function
  163. must return a cons cell with the (possibly modified) headline text, and the
  164. sectioning list in the cdr."
  165. :group 'org-export-latex
  166. :type '(repeat
  167. (list (string :tag "LaTeX class")
  168. (string :tag "LaTeX header")
  169. (repeat :tag "Levels" :inline t
  170. (choice
  171. (cons :tag "Heading"
  172. (string :tag " numbered")
  173. (string :tag "unnumbered"))
  174. (list :tag "Environment"
  175. (string :tag "Opening (numbered)")
  176. (string :tag "Closing (numbered)")
  177. (string :tag "Opening (unnumbered)")
  178. (string :tag "Closing (unnumbered)"))
  179. (function :tag "Hook computing sectioning"))))))
  180. (defcustom org-export-latex-inputenc-alist nil
  181. "Alist of inputenc coding system names, and what should really be used.
  182. For example, adding an entry
  183. (\"utf8\" . \"utf8x\")
  184. will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
  185. are written as utf8 files."
  186. :group 'org-export-latex
  187. :version "24.1"
  188. :type '(repeat
  189. (cons
  190. (string :tag "Derived from buffer")
  191. (string :tag "Use this instead"))))
  192. (defcustom org-export-latex-emphasis-alist
  193. '(("*" "\\textbf{%s}" nil)
  194. ("/" "\\emph{%s}" nil)
  195. ("_" "\\underline{%s}" nil)
  196. ("+" "\\st{%s}" nil)
  197. ("=" "\\protectedtexttt" t)
  198. ("~" "\\verb" t))
  199. "Alist of LaTeX expressions to convert emphasis fontifiers.
  200. Each element of the list is a list of three elements.
  201. The first element is the character used as a marker for fontification.
  202. The second element is a formatting string to wrap fontified text with.
  203. If it is \"\\verb\", Org will automatically select a delimiter
  204. character that is not in the string. \"\\protectedtexttt\" will use \\texttt
  205. to typeset and try to protect special characters.
  206. The third element decides whether to protect converted text from other
  207. conversions."
  208. :group 'org-export-latex
  209. :type 'alist)
  210. (defcustom org-export-latex-title-command "\\maketitle"
  211. "The command used to insert the title just after \\begin{document}.
  212. If this string contains the formatting specification \"%s\" then
  213. it will be used as a formatting string, passing the title as an
  214. argument."
  215. :group 'org-export-latex
  216. :type 'string)
  217. (defcustom org-export-latex-import-inbuffer-stuff nil
  218. "Non-nil means define TeX macros for Org's inbuffer definitions.
  219. For example \orgTITLE for #+TITLE."
  220. :group 'org-export-latex
  221. :type 'boolean)
  222. (defcustom org-export-latex-date-format
  223. "\\today"
  224. "Format string for \\date{...}."
  225. :group 'org-export-latex
  226. :type 'string)
  227. (defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
  228. "Markup for TODO keywords, as a printf format.
  229. This can be a single format for all keywords, a cons cell with separate
  230. formats for not-done and done states, or an association list with setup
  231. for individual keywords. If a keyword shows up for which there is no
  232. markup defined, the first one in the association list will be used."
  233. :group 'org-export-latex
  234. :type '(choice
  235. (string :tag "Default")
  236. (cons :tag "Distinguish undone and done"
  237. (string :tag "Not-DONE states")
  238. (string :tag "DONE states"))
  239. (repeat :tag "Per keyword markup"
  240. (cons
  241. (string :tag "Keyword")
  242. (string :tag "Markup")))))
  243. (defcustom org-export-latex-tag-markup "\\textbf{%s}"
  244. "Markup for tags, as a printf format."
  245. :group 'org-export-latex
  246. :version "24.1"
  247. :type 'string)
  248. (defcustom org-export-latex-timestamp-markup "\\textit{%s}"
  249. "A printf format string to be applied to time stamps."
  250. :group 'org-export-latex
  251. :type 'string)
  252. (defcustom org-export-latex-timestamp-inactive-markup "\\textit{%s}"
  253. "A printf format string to be applied to inactive time stamps."
  254. :group 'org-export-latex
  255. :version "24.1"
  256. :type 'string)
  257. (defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
  258. "A printf format string to be applied to time stamps."
  259. :group 'org-export-latex
  260. :type 'string)
  261. (defcustom org-export-latex-href-format "\\href{%s}{%s}"
  262. "A printf format string to be applied to href links.
  263. The format must contain either two %s instances or just one.
  264. If it contains two %s instances, the first will be filled with
  265. the link, the second with the link description. If it contains
  266. only one, the %s will be filled with the link."
  267. :group 'org-export-latex
  268. :version "24.1"
  269. :type 'string)
  270. (defcustom org-export-latex-hyperref-format "\\hyperref[%s]{%s}"
  271. "A printf format string to be applied to hyperref links.
  272. The format must contain one or two %s instances. The first one
  273. will be filled with the link, the second with its description."
  274. :group 'org-export-latex
  275. :version "24.1"
  276. :type 'string)
  277. (defcustom org-export-latex-footnote-separator "\\textsuperscript{,}\\,"
  278. "Text used to separate footnotes."
  279. :group 'org-export-latex
  280. :version "24.1"
  281. :type 'string)
  282. (defcustom org-export-latex-quotes
  283. '(("fr" ("\\(\\s-\\|[[(]\\)\"" . "«~") ("\\(\\S-\\)\"" . "~»") ("\\(\\s-\\|(\\)'" . "'"))
  284. ("en" ("\\(\\s-\\|[[(]\\)\"" . "``") ("\\(\\S-\\)\"" . "''") ("\\(\\s-\\|(\\)'" . "`")))
  285. "Alist for quotes to use when converting english double-quotes.
  286. The CAR of each item in this alist is the language code.
  287. The CDR of each item in this alist is a list of three CONS:
  288. - the first CONS defines the opening quote;
  289. - the second CONS defines the closing quote;
  290. - the last CONS defines single quotes.
  291. For each item in a CONS, the first string is a regexp
  292. for allowed characters before/after the quote, the second
  293. string defines the replacement string for this quote."
  294. :group 'org-export-latex
  295. :version "24.1"
  296. :type '(list
  297. (cons :tag "Opening quote"
  298. (string :tag "Regexp for char before")
  299. (string :tag "Replacement quote "))
  300. (cons :tag "Closing quote"
  301. (string :tag "Regexp for char after ")
  302. (string :tag "Replacement quote "))
  303. (cons :tag "Single quote"
  304. (string :tag "Regexp for char before")
  305. (string :tag "Replacement quote "))))
  306. (defcustom org-export-latex-tables-verbatim nil
  307. "When non-nil, tables are exported verbatim."
  308. :group 'org-export-latex
  309. :type 'boolean)
  310. (defcustom org-export-latex-tables-centered t
  311. "When non-nil, tables are exported in a center environment."
  312. :group 'org-export-latex
  313. :type 'boolean)
  314. (defcustom org-export-latex-table-caption-above t
  315. "When non-nil, the caption is set above the table. When nil,
  316. the caption is set below the table."
  317. :group 'org-export-latex
  318. :version "24.1"
  319. :type 'boolean)
  320. (defcustom org-export-latex-tables-column-borders nil
  321. "When non-nil, grouping columns can cause outer vertical lines in tables.
  322. When nil, grouping causes only separation lines between groups."
  323. :group 'org-export-latex
  324. :type 'boolean)
  325. (defcustom org-export-latex-tables-tstart nil
  326. "LaTeX command for top rule for tables."
  327. :group 'org-export-latex
  328. :version "24.1"
  329. :type '(choice
  330. (const :tag "Nothing" nil)
  331. (string :tag "String")
  332. (const :tag "Booktabs default: \\toprule" "\\toprule")))
  333. (defcustom org-export-latex-tables-hline "\\hline"
  334. "LaTeX command to use for a rule somewhere in the middle of a table."
  335. :group 'org-export-latex
  336. :version "24.1"
  337. :type '(choice
  338. (string :tag "String")
  339. (const :tag "Standard: \\hline" "\\hline")
  340. (const :tag "Booktabs default: \\midrule" "\\midrule")))
  341. (defcustom org-export-latex-tables-tend nil
  342. "LaTeX command for bottom rule for tables."
  343. :group 'org-export-latex
  344. :version "24.1"
  345. :type '(choice
  346. (const :tag "Nothing" nil)
  347. (string :tag "String")
  348. (const :tag "Booktabs default: \\bottomrule" "\\bottomrule")))
  349. (defcustom org-export-latex-low-levels 'itemize
  350. "How to convert sections below the current level of sectioning.
  351. This is specified by the `org-export-headline-levels' option or the
  352. value of \"H:\" in Org's #+OPTION line.
  353. This can be either nil (skip the sections), `description', `itemize',
  354. or `enumerate' (convert the sections as the corresponding list type), or
  355. a string to be used instead of \\section{%s}. In this latter case,
  356. the %s stands here for the inserted headline and is mandatory.
  357. It may also be a list of three string to define a user-defined environment
  358. that should be used. The first string should be the like
  359. \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
  360. to two occurrences of %s for the title and a label, respectively. The third
  361. string should be like \"\\end{itemize\"."
  362. :group 'org-export-latex
  363. :type '(choice (const :tag "Ignore" nil)
  364. (const :tag "Convert as descriptive list" description)
  365. (const :tag "Convert as itemized list" itemize)
  366. (const :tag "Convert as enumerated list" enumerate)
  367. (list :tag "User-defined environment"
  368. :value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
  369. (string :tag "Start")
  370. (string :tag "End")
  371. (string :tag "item"))
  372. (string :tag "Use a section string" :value "\\subparagraph{%s}")))
  373. (defcustom org-export-latex-list-parameters
  374. '(:cbon "$\\boxtimes$" :cboff "$\\Box$" :cbtrans "$\\boxminus$")
  375. "Parameters for the LaTeX list exporter.
  376. These parameters will be passed on to `org-list-to-latex', which in turn
  377. will pass them (combined with the LaTeX default list parameters) to
  378. `org-list-to-generic'."
  379. :group 'org-export-latex
  380. :type 'plist)
  381. (defcustom org-export-latex-verbatim-wrap
  382. '("\\begin{verbatim}\n" . "\\end{verbatim}")
  383. "Environment to be wrapped around a fixed-width section in LaTeX export.
  384. This is a cons with two strings, to be added before and after the
  385. fixed-with text.
  386. Defaults to \\begin{verbatim} and \\end{verbatim}."
  387. :group 'org-export-translation
  388. :group 'org-export-latex
  389. :type '(cons (string :tag "Open")
  390. (string :tag "Close")))
  391. (defcustom org-export-latex-listings nil
  392. "Non-nil means export source code using the listings package.
  393. This package will fontify source code, possibly even with color.
  394. If you want to use this, you also need to make LaTeX use the
  395. listings package, and if you want to have color, the color
  396. package. Just add these to `org-export-latex-packages-alist',
  397. for example using customize, or with something like
  398. (require 'org-latex)
  399. (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
  400. (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))
  401. Alternatively,
  402. (setq org-export-latex-listings 'minted)
  403. causes source code to be exported using the minted package as
  404. opposed to listings. If you want to use minted, you need to add
  405. the minted package to `org-export-latex-packages-alist', for
  406. example using customize, or with
  407. (require 'org-latex)
  408. (add-to-list 'org-export-latex-packages-alist '(\"\" \"minted\"))
  409. In addition, it is necessary to install
  410. pygments (http://pygments.org), and to configure the variable
  411. `org-latex-to-pdf-process' so that the -shell-escape option is
  412. passed to pdflatex.
  413. "
  414. :group 'org-export-latex
  415. :type 'boolean)
  416. (defcustom org-export-latex-listings-langs
  417. '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
  418. (c "C") (cc "C++")
  419. (fortran "fortran")
  420. (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
  421. (html "HTML") (xml "XML")
  422. (tex "TeX") (latex "TeX")
  423. (shell-script "bash")
  424. (gnuplot "Gnuplot")
  425. (ocaml "Caml") (caml "Caml")
  426. (sql "SQL") (sqlite "sql"))
  427. "Alist mapping languages to their listing language counterpart.
  428. The key is a symbol, the major mode symbol without the \"-mode\".
  429. The value is the string that should be inserted as the language parameter
  430. for the listings package. If the mode name and the listings name are
  431. the same, the language does not need an entry in this list - but it does not
  432. hurt if it is present."
  433. :group 'org-export-latex
  434. :type '(repeat
  435. (list
  436. (symbol :tag "Major mode ")
  437. (string :tag "Listings language"))))
  438. (defcustom org-export-latex-listings-w-names t
  439. "Non-nil means export names of named code blocks.
  440. Code blocks exported with the listings package (controlled by the
  441. `org-export-latex-listings' variable) can be named in the style
  442. of noweb."
  443. :group 'org-export-latex
  444. :version "24.1"
  445. :type 'boolean)
  446. (defcustom org-export-latex-minted-langs
  447. '((emacs-lisp "common-lisp")
  448. (cc "c++")
  449. (cperl "perl")
  450. (shell-script "bash")
  451. (caml "ocaml"))
  452. "Alist mapping languages to their minted language counterpart.
  453. The key is a symbol, the major mode symbol without the \"-mode\".
  454. The value is the string that should be inserted as the language parameter
  455. for the minted package. If the mode name and the listings name are
  456. the same, the language does not need an entry in this list - but it does not
  457. hurt if it is present.
  458. Note that minted uses all lower case for language identifiers,
  459. and that the full list of language identifiers can be obtained
  460. with:
  461. pygmentize -L lexers
  462. "
  463. :group 'org-export-latex
  464. :version "24.1"
  465. :type '(repeat
  466. (list
  467. (symbol :tag "Major mode ")
  468. (string :tag "Listings language"))))
  469. (defcustom org-export-latex-listings-options nil
  470. "Association list of options for the latex listings package.
  471. These options are supplied as a comma-separated list to the
  472. \\lstset command. Each element of the association list should be
  473. a list containing two strings: the name of the option, and the
  474. value. For example,
  475. (setq org-export-latex-listings-options
  476. '((\"basicstyle\" \"\\small\")
  477. (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
  478. will typeset the code in a small size font with underlined, bold
  479. black keywords.
  480. Note that the same options will be applied to blocks of all
  481. languages."
  482. :group 'org-export-latex
  483. :version "24.1"
  484. :type '(repeat
  485. (list
  486. (string :tag "Listings option name ")
  487. (string :tag "Listings option value"))))
  488. (defcustom org-export-latex-minted-options nil
  489. "Association list of options for the latex minted package.
  490. These options are supplied within square brackets in
  491. \\begin{minted} environments. Each element of the alist should be
  492. a list containing two strings: the name of the option, and the
  493. value. For example,
  494. (setq org-export-latex-minted-options
  495. '((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
  496. will result in src blocks being exported with
  497. \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
  498. as the start of the minted environment. Note that the same
  499. options will be applied to blocks of all languages."
  500. :group 'org-export-latex
  501. :version "24.1"
  502. :type '(repeat
  503. (list
  504. (string :tag "Minted option name ")
  505. (string :tag "Minted option value"))))
  506. (defvar org-export-latex-custom-lang-environments nil
  507. "Association list mapping languages to language-specific latex
  508. environments used during export of src blocks by the listings
  509. and minted latex packages. For example,
  510. (setq org-export-latex-custom-lang-environments
  511. '((python \"pythoncode\")))
  512. would have the effect that if org encounters begin_src python
  513. during latex export it will output
  514. \\begin{pythoncode}
  515. <src block body>
  516. \\end{pythoncode}")
  517. (defcustom org-export-latex-remove-from-headlines
  518. '(:todo nil :priority nil :tags nil)
  519. "A plist of keywords to remove from headlines. OBSOLETE.
  520. Non-nil means remove this keyword type from the headline.
  521. Don't remove the keys, just change their values.
  522. Obsolete, this variable is no longer used. Use the separate
  523. variables `org-export-with-todo-keywords', `org-export-with-priority',
  524. and `org-export-with-tags' instead."
  525. :type 'plist
  526. :group 'org-export-latex)
  527. (defcustom org-export-latex-image-default-option "width=.9\\linewidth"
  528. "Default option for images."
  529. :group 'org-export-latex
  530. :type 'string)
  531. (defcustom org-latex-default-figure-position "htb"
  532. "Default position for latex figures."
  533. :group 'org-export-latex
  534. :version "24.1"
  535. :type 'string)
  536. (defcustom org-export-latex-tabular-environment "tabular"
  537. "Default environment used to build tables."
  538. :group 'org-export-latex
  539. :version "24.1"
  540. :type 'string)
  541. (defcustom org-export-latex-inline-image-extensions
  542. '("pdf" "jpeg" "jpg" "png" "ps" "eps")
  543. "Extensions of image files that can be inlined into LaTeX.
  544. Note that the image extension *actually* allowed depend on the way the
  545. LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
  546. are OK. When processing through dvi to Postscript, only ps and eps are
  547. allowed. The default we use here encompasses both."
  548. :group 'org-export-latex
  549. :type '(repeat (string :tag "Extension")))
  550. (defcustom org-export-latex-coding-system nil
  551. "Coding system for the exported LaTeX file."
  552. :group 'org-export-latex
  553. :type 'coding-system)
  554. (defgroup org-export-pdf nil
  555. "Options for exporting Org-mode files to PDF, via LaTeX."
  556. :tag "Org Export PDF"
  557. :group 'org-export-latex
  558. :group 'org-export)
  559. (defcustom org-latex-to-pdf-process
  560. '("pdflatex -interaction nonstopmode -output-directory %o %f"
  561. "pdflatex -interaction nonstopmode -output-directory %o %f"
  562. "pdflatex -interaction nonstopmode -output-directory %o %f")
  563. "Commands to process a LaTeX file to a PDF file and process latex
  564. fragments to pdf files.By default,this is a list of strings,and each of
  565. strings will be given to the shell as a command. %f in the command will
  566. be replaced by the full file name, %b by the file base name (i.e. without
  567. extension) and %o by the base directory of the file.
  568. If you set `org-create-formula-image-program'
  569. `org-export-with-LaTeX-fragments' to 'imagemagick, you can add a
  570. sublist which contains your own command(s) for LaTeX fragments
  571. previewing, like this:
  572. '(\"xelatex -interaction nonstopmode -output-directory %o %f\"
  573. \"xelatex -interaction nonstopmode -output-directory %o %f\"
  574. ;; use below command(s) to convert latex fragments
  575. (\"xelatex %f\"))
  576. With no such sublist, the default command used to convert LaTeX
  577. fragments will be the first string in the list.
  578. The reason why this is a list is that it usually takes several runs of
  579. `pdflatex', maybe mixed with a call to `bibtex'. Org does not have a clever
  580. mechanism to detect which of these commands have to be run to get to a stable
  581. result, and it also does not do any error checking.
  582. By default, Org uses 3 runs of `pdflatex' to do the processing. If you
  583. have texi2dvi on your system and if that does not cause the infamous
  584. egrep/locale bug:
  585. http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
  586. then `texi2dvi' is the superior choice. Org does offer it as one
  587. of the customize options.
  588. Alternatively, this may be a Lisp function that does the processing, so you
  589. could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
  590. This function should accept the file name as its single argument."
  591. :group 'org-export-pdf
  592. :type '(choice
  593. (repeat :tag "Shell command sequence"
  594. (string :tag "Shell command"))
  595. (const :tag "2 runs of pdflatex"
  596. ("pdflatex -interaction nonstopmode -output-directory %o %f"
  597. "pdflatex -interaction nonstopmode -output-directory %o %f"))
  598. (const :tag "3 runs of pdflatex"
  599. ("pdflatex -interaction nonstopmode -output-directory %o %f"
  600. "pdflatex -interaction nonstopmode -output-directory %o %f"
  601. "pdflatex -interaction nonstopmode -output-directory %o %f"))
  602. (const :tag "pdflatex,bibtex,pdflatex,pdflatex"
  603. ("pdflatex -interaction nonstopmode -output-directory %o %f"
  604. "bibtex %b"
  605. "pdflatex -interaction nonstopmode -output-directory %o %f"
  606. "pdflatex -interaction nonstopmode -output-directory %o %f"))
  607. (const :tag "2 runs of xelatex"
  608. ("xelatex -interaction nonstopmode -output-directory %o %f"
  609. "xelatex -interaction nonstopmode -output-directory %o %f"))
  610. (const :tag "3 runs of xelatex"
  611. ("xelatex -interaction nonstopmode -output-directory %o %f"
  612. "xelatex -interaction nonstopmode -output-directory %o %f"
  613. "xelatex -interaction nonstopmode -output-directory %o %f"))
  614. (const :tag "xelatex,bibtex,xelatex,xelatex"
  615. ("xelatex -interaction nonstopmode -output-directory %o %f"
  616. "bibtex %b"
  617. "xelatex -interaction nonstopmode -output-directory %o %f"
  618. "xelatex -interaction nonstopmode -output-directory %o %f"))
  619. (const :tag "texi2dvi"
  620. ("texi2dvi -p -b -c -V %f"))
  621. (const :tag "rubber"
  622. ("rubber -d --into %o %f"))
  623. (function)))
  624. (defcustom org-export-pdf-logfiles
  625. '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
  626. "The list of file extensions to consider as LaTeX logfiles."
  627. :group 'org-export-pdf
  628. :version "24.1"
  629. :type '(repeat (string :tag "Extension")))
  630. (defcustom org-export-pdf-remove-logfiles t
  631. "Non-nil means remove the logfiles produced by PDF production.
  632. These are the .aux, .log, .out, and .toc files."
  633. :group 'org-export-pdf
  634. :type 'boolean)
  635. ;;; Hooks
  636. (defvar org-export-latex-after-initial-vars-hook nil
  637. "Hook run before LaTeX export.
  638. The exact moment is after the initial variables like org-export-latex-class
  639. have been determined from the environment.")
  640. (defvar org-export-latex-after-blockquotes-hook nil
  641. "Hook run during LaTeX export, after blockquote, verse, center are done.")
  642. (defvar org-export-latex-final-hook nil
  643. "Hook run in the finalized LaTeX buffer.")
  644. (defvar org-export-latex-after-save-hook nil
  645. "Hook run in the finalized LaTeX buffer, after it has been saved.")
  646. ;;; Autoload functions:
  647. ;;;###autoload
  648. (defun org-export-as-latex-batch ()
  649. "Call `org-export-as-latex', may be used in batch processing.
  650. For example:
  651. emacs --batch
  652. --load=$HOME/lib/emacs/org.el
  653. --eval \"(setq org-export-headline-levels 2)\"
  654. --visit=MyFile --funcall org-export-as-latex-batch"
  655. (org-export-as-latex org-export-headline-levels 'hidden))
  656. ;;;###autoload
  657. (defun org-export-as-latex-to-buffer (arg)
  658. "Call `org-export-as-latex` with output to a temporary buffer.
  659. No file is created. The prefix ARG is passed through to `org-export-as-latex'."
  660. (interactive "P")
  661. (org-export-as-latex arg nil nil "*Org LaTeX Export*")
  662. (when org-export-show-temporary-export-buffer
  663. (switch-to-buffer-other-window "*Org LaTeX Export*")))
  664. ;;;###autoload
  665. (defun org-replace-region-by-latex (beg end)
  666. "Replace the region from BEG to END with its LaTeX export.
  667. It assumes the region has `org-mode' syntax, and then convert it to
  668. LaTeX. This can be used in any buffer. For example, you could
  669. write an itemized list in `org-mode' syntax in an LaTeX buffer and
  670. then use this command to convert it."
  671. (interactive "r")
  672. (let (reg latex buf)
  673. (save-window-excursion
  674. (if (derived-mode-p 'org-mode)
  675. (setq latex (org-export-region-as-latex
  676. beg end t 'string))
  677. (setq reg (buffer-substring beg end)
  678. buf (get-buffer-create "*Org tmp*"))
  679. (with-current-buffer buf
  680. (erase-buffer)
  681. (insert reg)
  682. (org-mode)
  683. (setq latex (org-export-region-as-latex
  684. (point-min) (point-max) t 'string)))
  685. (kill-buffer buf)))
  686. (delete-region beg end)
  687. (insert latex)))
  688. ;;;###autoload
  689. (defun org-export-region-as-latex (beg end &optional body-only buffer)
  690. "Convert region from BEG to END in `org-mode' buffer to LaTeX.
  691. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  692. contents, and only produce the region of converted text, useful for
  693. cut-and-paste operations.
  694. If BUFFER is a buffer or a string, use/create that buffer as a target
  695. of the converted LaTeX. If BUFFER is the symbol `string', return the
  696. produced LaTeX as a string and leave no buffer behind. For example,
  697. a Lisp program could call this function in the following way:
  698. (setq latex (org-export-region-as-latex beg end t 'string))
  699. When called interactively, the output buffer is selected, and shown
  700. in a window. A non-interactive call will only return the buffer."
  701. (interactive "r\nP")
  702. (when (org-called-interactively-p 'any)
  703. (setq buffer "*Org LaTeX Export*"))
  704. (let ((transient-mark-mode t) (zmacs-regions t)
  705. ext-plist rtn)
  706. (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
  707. (goto-char end)
  708. (set-mark (point)) ;; to activate the region
  709. (goto-char beg)
  710. (setq rtn (org-export-as-latex
  711. nil nil ext-plist
  712. buffer body-only))
  713. (if (fboundp 'deactivate-mark) (deactivate-mark))
  714. (if (and (org-called-interactively-p 'any) (bufferp rtn))
  715. (switch-to-buffer-other-window rtn)
  716. rtn)))
  717. ;;;###autoload
  718. (defun org-export-as-latex (arg &optional hidden ext-plist
  719. to-buffer body-only pub-dir)
  720. "Export current buffer to a LaTeX file.
  721. If there is an active region, export only the region. The prefix
  722. ARG specifies how many levels of the outline should become
  723. headlines. The default is 3. Lower levels will be exported
  724. depending on `org-export-latex-low-levels'. The default is to
  725. convert them as description lists.
  726. HIDDEN is obsolete and does nothing.
  727. EXT-PLIST is a property list with
  728. external parameters overriding org-mode's default settings, but
  729. still inferior to file-local settings. When TO-BUFFER is
  730. non-nil, create a buffer with that name and export to that
  731. buffer. If TO-BUFFER is the symbol `string', don't leave any
  732. buffer behind but just return the resulting LaTeX as a string.
  733. When BODY-ONLY is set, don't produce the file header and footer,
  734. simply return the content of \\begin{document}...\\end{document},
  735. without even the \\begin{document} and \\end{document} commands.
  736. when PUB-DIR is set, use this as the publishing directory."
  737. (interactive "P")
  738. (when (and (not body-only) arg (listp arg)) (setq body-only t))
  739. (run-hooks 'org-export-first-hook)
  740. ;; Make sure we have a file name when we need it.
  741. (when (and (not (or to-buffer body-only))
  742. (not buffer-file-name))
  743. (if (buffer-base-buffer)
  744. (org-set-local 'buffer-file-name
  745. (with-current-buffer (buffer-base-buffer)
  746. buffer-file-name))
  747. (error "Need a file name to be able to export")))
  748. (message "Exporting to LaTeX...")
  749. (org-unmodified
  750. (let ((inhibit-read-only t))
  751. (remove-text-properties (point-min) (point-max)
  752. '(:org-license-to-kill nil))))
  753. (org-update-radio-target-regexp)
  754. (org-export-latex-set-initial-vars ext-plist arg)
  755. (setq org-export-opt-plist org-export-latex-options-plist
  756. org-export-footnotes-data (org-footnote-all-labels 'with-defs)
  757. org-export-footnotes-seen nil
  758. org-export-latex-footmark-seen nil)
  759. (org-install-letbind)
  760. (run-hooks 'org-export-latex-after-initial-vars-hook)
  761. (let* ((wcf (current-window-configuration))
  762. (opt-plist
  763. (org-export-process-option-filters org-export-latex-options-plist))
  764. (region-p (org-region-active-p))
  765. (rbeg (and region-p (region-beginning)))
  766. (rend (and region-p (region-end)))
  767. (subtree-p
  768. (if (plist-get opt-plist :ignore-subtree-p)
  769. nil
  770. (when region-p
  771. (save-excursion
  772. (goto-char rbeg)
  773. (and (org-at-heading-p)
  774. (>= (org-end-of-subtree t t) rend))))))
  775. (opt-plist (setq org-export-opt-plist
  776. (if subtree-p
  777. (org-export-add-subtree-options opt-plist rbeg)
  778. opt-plist)))
  779. ;; Make sure the variable contains the updated values.
  780. (org-export-latex-options-plist (setq org-export-opt-plist opt-plist))
  781. ;; The following two are dynamically scoped into other
  782. ;; routines below.
  783. (org-current-export-dir
  784. (or pub-dir (org-export-directory :html opt-plist)))
  785. (org-current-export-file buffer-file-name)
  786. (title (or (and subtree-p (org-export-get-title-from-subtree))
  787. (plist-get opt-plist :title)
  788. (and (not
  789. (plist-get opt-plist :skip-before-1st-heading))
  790. (org-export-grab-title-from-buffer))
  791. (and buffer-file-name
  792. (file-name-sans-extension
  793. (file-name-nondirectory buffer-file-name)))
  794. "No Title"))
  795. (filename
  796. (and (not to-buffer)
  797. (concat
  798. (file-name-as-directory
  799. (or pub-dir
  800. (org-export-directory :LaTeX org-export-latex-options-plist)))
  801. (file-name-sans-extension
  802. (or (and subtree-p
  803. (org-entry-get rbeg "EXPORT_FILE_NAME" t))
  804. (file-name-nondirectory ;sans-extension
  805. (or buffer-file-name
  806. (error "Don't know which export file to use")))))
  807. ".tex")))
  808. (filename
  809. (and filename
  810. (if (equal (file-truename filename)
  811. (file-truename (or buffer-file-name "dummy.org")))
  812. (concat filename ".tex")
  813. filename)))
  814. (auto-insert nil); Avoid any auto-insert stuff for the new file
  815. (TeX-master (boundp 'TeX-master))
  816. (buffer (if to-buffer
  817. (cond
  818. ((eq to-buffer 'string) (get-buffer-create
  819. "*Org LaTeX Export*"))
  820. (t (get-buffer-create to-buffer)))
  821. (find-file-noselect filename)))
  822. (odd org-odd-levels-only)
  823. (header (org-export-latex-make-header title opt-plist))
  824. (skip (cond (subtree-p nil)
  825. (region-p nil)
  826. (t (plist-get opt-plist :skip-before-1st-heading))))
  827. (text (plist-get opt-plist :text))
  828. (org-export-preprocess-hook
  829. (cons
  830. `(lambda () (org-set-local 'org-complex-heading-regexp
  831. ,org-export-latex-complex-heading-re))
  832. org-export-preprocess-hook))
  833. (first-lines (if skip "" (org-export-latex-first-lines
  834. opt-plist
  835. (if subtree-p
  836. (save-excursion
  837. (goto-char rbeg)
  838. (point-at-bol 2))
  839. rbeg)
  840. (if region-p rend))))
  841. (coding-system (and (boundp 'buffer-file-coding-system)
  842. buffer-file-coding-system))
  843. (coding-system-for-write (or org-export-latex-coding-system
  844. coding-system))
  845. (save-buffer-coding-system (or org-export-latex-coding-system
  846. coding-system))
  847. (region (buffer-substring
  848. (if region-p (region-beginning) (point-min))
  849. (if region-p (region-end) (point-max))))
  850. (text
  851. (and text (string-match "\\S-" text)
  852. (org-export-preprocess-string
  853. text
  854. :emph-multiline t
  855. :for-backend 'latex
  856. :comments nil
  857. :tags (plist-get opt-plist :tags)
  858. :priority (plist-get opt-plist :priority)
  859. :footnotes (plist-get opt-plist :footnotes)
  860. :drawers (plist-get opt-plist :drawers)
  861. :timestamps (plist-get opt-plist :timestamps)
  862. :todo-keywords (plist-get opt-plist :todo-keywords)
  863. :tasks (plist-get opt-plist :tasks)
  864. :add-text nil
  865. :skip-before-1st-heading skip
  866. :select-tags nil
  867. :exclude-tags nil
  868. :LaTeX-fragments nil)))
  869. (string-for-export
  870. (org-export-preprocess-string
  871. region
  872. :emph-multiline t
  873. :for-backend 'latex
  874. :comments nil
  875. :tags (plist-get opt-plist :tags)
  876. :priority (plist-get opt-plist :priority)
  877. :footnotes (plist-get opt-plist :footnotes)
  878. :drawers (plist-get opt-plist :drawers)
  879. :timestamps (plist-get opt-plist :timestamps)
  880. :todo-keywords (plist-get opt-plist :todo-keywords)
  881. :tasks (plist-get opt-plist :tasks)
  882. :add-text (if (eq to-buffer 'string) nil text)
  883. :skip-before-1st-heading skip
  884. :select-tags (plist-get opt-plist :select-tags)
  885. :exclude-tags (plist-get opt-plist :exclude-tags)
  886. :LaTeX-fragments nil)))
  887. (set-buffer buffer)
  888. (erase-buffer)
  889. (org-install-letbind)
  890. (and (fboundp 'set-buffer-file-coding-system)
  891. (set-buffer-file-coding-system coding-system-for-write))
  892. ;; insert the header and initial document commands
  893. (unless (or (eq to-buffer 'string) body-only)
  894. (insert header))
  895. ;; insert text found in #+TEXT
  896. (when (and text (not (eq to-buffer 'string)))
  897. (insert (org-export-latex-content
  898. text '(lists tables fixed-width keywords))
  899. "\n\n"))
  900. ;; insert lines before the first headline
  901. (unless (or skip (string-match "^\\*" first-lines))
  902. (insert first-lines))
  903. ;; export the content of headlines
  904. (org-export-latex-global
  905. (with-temp-buffer
  906. (insert string-for-export)
  907. (goto-char (point-min))
  908. (when (re-search-forward "^\\(\\*+\\) " nil t)
  909. (let* ((asters (length (match-string 1)))
  910. (level (if odd (- asters 2) (- asters 1))))
  911. (setq org-export-latex-add-level
  912. (if odd (1- (/ (1+ asters) 2)) (1- asters)))
  913. (org-export-latex-parse-global level odd)))))
  914. ;; finalization
  915. (unless body-only (insert "\n\\end{document}"))
  916. ;; Attach description terms to the \item macro
  917. (goto-char (point-min))
  918. (while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t)
  919. (delete-region (match-beginning 1) (match-end 1)))
  920. ;; Relocate the table of contents
  921. (goto-char (point-min))
  922. (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
  923. (goto-char (point-min))
  924. (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
  925. (replace-match ""))
  926. (goto-char (point-min))
  927. (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
  928. (replace-match "\\tableofcontents" t t)))
  929. ;; Cleanup forced line ends in items where they are not needed
  930. (goto-char (point-min))
  931. (while (re-search-forward
  932. "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
  933. nil t)
  934. (delete-region (match-beginning 1) (match-end 1)))
  935. (goto-char (point-min))
  936. (while (re-search-forward
  937. "^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
  938. nil t)
  939. (if (looking-at "[\n \t]+")
  940. (replace-match "\n")))
  941. ;; Ensure we have a final newline
  942. (goto-char (point-max))
  943. (or (eq (char-before) ?\n)
  944. (insert ?\n))
  945. (run-hooks 'org-export-latex-final-hook)
  946. (if to-buffer
  947. (unless (eq major-mode 'latex-mode) (latex-mode))
  948. (save-buffer))
  949. (org-export-latex-fix-inputenc)
  950. (run-hooks 'org-export-latex-after-save-hook)
  951. (goto-char (point-min))
  952. (or (org-export-push-to-kill-ring "LaTeX")
  953. (message "Exporting to LaTeX...done"))
  954. (prog1
  955. (if (eq to-buffer 'string)
  956. (prog1 (buffer-substring (point-min) (point-max))
  957. (kill-buffer (current-buffer)))
  958. (current-buffer))
  959. (set-window-configuration wcf))))
  960. ;;;###autoload
  961. (defun org-export-as-pdf (arg &optional hidden ext-plist
  962. to-buffer body-only pub-dir)
  963. "Export as LaTeX, then process through to PDF."
  964. (interactive "P")
  965. (message "Exporting to PDF...")
  966. (let* ((wconfig (current-window-configuration))
  967. (lbuf (org-export-as-latex arg hidden ext-plist
  968. to-buffer body-only pub-dir))
  969. (file (buffer-file-name lbuf))
  970. (base (file-name-sans-extension (buffer-file-name lbuf)))
  971. (pdffile (concat base ".pdf"))
  972. (cmds (if (eq org-export-latex-listings 'minted)
  973. ;; automatically add -shell-escape when needed
  974. (mapcar (lambda (cmd)
  975. (replace-regexp-in-string
  976. "pdflatex " "pdflatex -shell-escape " cmd))
  977. org-latex-to-pdf-process)
  978. org-latex-to-pdf-process))
  979. (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
  980. (bibtex-p (with-current-buffer lbuf
  981. (save-excursion
  982. (goto-char (point-min))
  983. (re-search-forward "\\\\bibliography{" nil t))))
  984. cmd output-dir errors)
  985. (with-current-buffer outbuf (erase-buffer))
  986. (message (concat "Processing LaTeX file " file "..."))
  987. (setq output-dir (file-name-directory file))
  988. (with-current-buffer lbuf
  989. (save-excursion
  990. (if (and cmds (symbolp cmds))
  991. (funcall cmds (shell-quote-argument file))
  992. (while cmds
  993. (setq cmd (pop cmds))
  994. (cond
  995. ((not (listp cmd))
  996. (while (string-match "%b" cmd)
  997. (setq cmd (replace-match
  998. (save-match-data
  999. (shell-quote-argument base))
  1000. t t cmd)))
  1001. (while (string-match "%f" cmd)
  1002. (setq cmd (replace-match
  1003. (save-match-data
  1004. (shell-quote-argument file))
  1005. t t cmd)))
  1006. (while (string-match "%o" cmd)
  1007. (setq cmd (replace-match
  1008. (save-match-data
  1009. (shell-quote-argument output-dir))
  1010. t t cmd)))
  1011. (shell-command cmd outbuf)))))))
  1012. (message (concat "Processing LaTeX file " file "...done"))
  1013. (setq errors (org-export-latex-get-error outbuf))
  1014. (if (not (file-exists-p pdffile))
  1015. (error (concat "PDF file " pdffile " was not produced"
  1016. (if errors (concat ":" errors "") "")))
  1017. (set-window-configuration wconfig)
  1018. (when org-export-pdf-remove-logfiles
  1019. (dolist (ext org-export-pdf-logfiles)
  1020. (setq file (concat base "." ext))
  1021. (and (file-exists-p file) (delete-file file))))
  1022. (message (concat
  1023. "Exporting to PDF...done"
  1024. (if errors
  1025. (concat ", with some errors:" errors)
  1026. "")))
  1027. pdffile)))
  1028. (defun org-export-latex-get-error (buf)
  1029. "Collect the kinds of errors that remain in pdflatex processing."
  1030. (with-current-buffer buf
  1031. (save-excursion
  1032. (goto-char (point-max))
  1033. (when (re-search-backward "^[ \t]*This is pdf.*?TeX.*?Version" nil t)
  1034. ;; OK, we are at the location of the final run
  1035. (let ((pos (point)) (errors "") (case-fold-search t))
  1036. (if (re-search-forward "Reference.*?undefined" nil t)
  1037. (setq errors (concat errors " [undefined reference]")))
  1038. (goto-char pos)
  1039. (if (re-search-forward "Citation.*?undefined" nil t)
  1040. (setq errors (concat errors " [undefined citation]")))
  1041. (goto-char pos)
  1042. (if (re-search-forward "Undefined control sequence" nil t)
  1043. (setq errors (concat errors " [undefined control sequence]")))
  1044. (and (org-string-nw-p errors) errors))))))
  1045. ;;;###autoload
  1046. (defun org-export-as-pdf-and-open (arg)
  1047. "Export as LaTeX, then process through to PDF, and open."
  1048. (interactive "P")
  1049. (let ((pdffile (org-export-as-pdf arg)))
  1050. (if pdffile
  1051. (progn
  1052. (org-open-file pdffile)
  1053. (when org-export-kill-product-buffer-when-displayed
  1054. (kill-buffer (find-buffer-visiting
  1055. (concat (file-name-sans-extension (buffer-file-name))
  1056. ".tex")))))
  1057. (error "PDF file was not produced"))))
  1058. ;;; Parsing functions:
  1059. (defun org-export-latex-parse-global (level odd)
  1060. "Parse the current buffer recursively, starting at LEVEL.
  1061. If ODD is non-nil, assume the buffer only contains odd sections.
  1062. Return a list reflecting the document structure."
  1063. (save-excursion
  1064. (goto-char (point-min))
  1065. (let* ((cnt 0) output
  1066. (depth org-export-latex-sectioning-depth))
  1067. (while (org-re-search-forward-unprotected
  1068. (concat "^\\(\\(?:\\*\\)\\{"
  1069. (number-to-string (+ (if odd 2 1) level))
  1070. "\\}\\) \\(.*\\)$")
  1071. ;; make sure that there is no upper heading
  1072. (when (> level 0)
  1073. (save-excursion
  1074. (save-match-data
  1075. (org-re-search-forward-unprotected
  1076. (concat "^\\(\\(?:\\*\\)\\{"
  1077. (number-to-string level)
  1078. "\\}\\) \\(.*\\)$") nil t)))) t)
  1079. (setq cnt (1+ cnt))
  1080. (let* ((pos (match-beginning 0))
  1081. (heading (match-string 2))
  1082. (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
  1083. (save-excursion
  1084. (narrow-to-region
  1085. (point)
  1086. (save-match-data
  1087. (if (org-re-search-forward-unprotected
  1088. (concat "^\\(\\(?:\\*\\)\\{"
  1089. (number-to-string (+ (if odd 2 1) level))
  1090. "\\}\\) \\(.*\\)$") nil t)
  1091. (match-beginning 0)
  1092. (point-max))))
  1093. (goto-char (point-min))
  1094. (setq output
  1095. (append output
  1096. (list
  1097. (list
  1098. `(pos . ,pos)
  1099. `(level . ,nlevel)
  1100. `(occur . ,cnt)
  1101. `(heading . ,heading)
  1102. `(content . ,(org-export-latex-parse-content))
  1103. `(subcontent . ,(org-export-latex-parse-subcontent
  1104. level odd)))))))
  1105. (widen)))
  1106. (list output))))
  1107. (defun org-export-latex-parse-content ()
  1108. "Extract the content of a section."
  1109. (let ((beg (point))
  1110. (end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t)
  1111. (progn (beginning-of-line) (point))
  1112. (point-max))))
  1113. (buffer-substring beg end)))
  1114. (defun org-export-latex-parse-subcontent (level odd)
  1115. "Extract the subcontent of a section at LEVEL.
  1116. If ODD Is non-nil, assume subcontent only contains odd sections."
  1117. (if (not (org-re-search-forward-unprotected
  1118. (concat "^\\(\\(?:\\*\\)\\{"
  1119. (number-to-string (+ (if odd 4 2) level))
  1120. "\\}\\) \\(.*\\)$")
  1121. nil t))
  1122. nil ; subcontent is nil
  1123. (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
  1124. ;;; Rendering functions:
  1125. (defun org-export-latex-global (content)
  1126. "Export CONTENT to LaTeX.
  1127. CONTENT is an element of the list produced by
  1128. `org-export-latex-parse-global'."
  1129. (if (eq (car content) 'subcontent)
  1130. (mapc 'org-export-latex-sub (cdr content))
  1131. (org-export-latex-sub (car content))))
  1132. (defun org-export-latex-sub (subcontent)
  1133. "Export the list SUBCONTENT to LaTeX.
  1134. SUBCONTENT is an alist containing information about the headline
  1135. and its content."
  1136. (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
  1137. (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
  1138. (defun org-export-latex-subcontent (subcontent num)
  1139. "Export each cell of SUBCONTENT to LaTeX.
  1140. If NUM is non-nil export numbered sections, otherwise use unnumbered
  1141. sections. If NUM is an integer, export the highest NUM levels as
  1142. numbered sections and lower levels as unnumbered sections."
  1143. (let* ((heading (cdr (assoc 'heading subcontent)))
  1144. (level (- (cdr (assoc 'level subcontent))
  1145. org-export-latex-add-level))
  1146. (occur (number-to-string (cdr (assoc 'occur subcontent))))
  1147. (content (cdr (assoc 'content subcontent)))
  1148. (subcontent (cadr (assoc 'subcontent subcontent)))
  1149. (label (org-get-text-property-any 0 'target heading))
  1150. (label-list (cons label (cdr (assoc label
  1151. org-export-target-aliases))))
  1152. (sectioning org-export-latex-sectioning)
  1153. (depth org-export-latex-sectioning-depth)
  1154. main-heading sub-heading ctnt)
  1155. (when (symbolp (car sectioning))
  1156. (setq sectioning (funcall (car sectioning) level heading))
  1157. (when sectioning
  1158. (setq heading (car sectioning)
  1159. sectioning (cdr sectioning)
  1160. ;; target property migh have changed...
  1161. label (org-get-text-property-any 0 'target heading)
  1162. label-list (cons label (cdr (assoc label
  1163. org-export-target-aliases)))))
  1164. (if sectioning (setq sectioning (make-list 10 sectioning)))
  1165. (setq depth (if sectioning 10000 0)))
  1166. (if (string-match "[ \t]*\\\\\\\\[ \t]*" heading)
  1167. (setq main-heading (substring heading 0 (match-beginning 0))
  1168. sub-heading (substring heading (match-end 0))))
  1169. (setq heading (org-export-latex-fontify-headline heading)
  1170. sub-heading (and sub-heading
  1171. (org-export-latex-fontify-headline sub-heading))
  1172. main-heading (and main-heading
  1173. (org-export-latex-fontify-headline main-heading)))
  1174. (cond
  1175. ;; Normal conversion
  1176. ((<= level depth)
  1177. (let* ((sec (nth (1- level) sectioning))
  1178. (num (if (integerp num)
  1179. (>= num level)
  1180. num))
  1181. start end)
  1182. (if (consp (cdr sec))
  1183. (setq start (nth (if num 0 2) sec)
  1184. end (nth (if num 1 3) sec))
  1185. (setq start (if num (car sec) (cdr sec))))
  1186. (insert (format start (if main-heading main-heading heading)
  1187. (or sub-heading "")))
  1188. (insert "\n")
  1189. (when label
  1190. (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
  1191. label-list "\n") "\n"))
  1192. (insert (org-export-latex-content content))
  1193. (cond ((stringp subcontent) (insert subcontent))
  1194. ((listp subcontent)
  1195. (while (org-looking-back "\n\n") (backward-delete-char 1))
  1196. (org-export-latex-sub subcontent)))
  1197. (when (and end (string-match "[^ \t]" end))
  1198. (let ((hook (org-get-text-property-any 0 'org-insert-hook end)))
  1199. (and (functionp hook) (funcall hook)))
  1200. (insert end "\n"))))
  1201. ;; At a level under the hl option: we can drop this subsection
  1202. ((> level depth)
  1203. (cond ((eq org-export-latex-low-levels 'description)
  1204. (if (string-match "% ends low level$"
  1205. (buffer-substring (point-at-bol 0) (point)))
  1206. (delete-region (point-at-bol 0) (point))
  1207. (insert "\\begin{description}\n"))
  1208. (insert (format "\n\\item[%s]%s~\n"
  1209. heading
  1210. (if label (format "\\label{%s}" label) "")))
  1211. (insert (org-export-latex-content content))
  1212. (cond ((stringp subcontent) (insert subcontent))
  1213. ((listp subcontent) (org-export-latex-sub subcontent)))
  1214. (insert "\\end{description} % ends low level\n"))
  1215. ((memq org-export-latex-low-levels '(itemize enumerate))
  1216. (if (string-match "% ends low level$"
  1217. (buffer-substring (point-at-bol 0) (point)))
  1218. (delete-region (point-at-bol 0) (point))
  1219. (insert (format "\\begin{%s}\n"
  1220. (symbol-name org-export-latex-low-levels))))
  1221. (let ((ctnt (org-export-latex-content content)))
  1222. (insert (format (if (not (equal (replace-regexp-in-string "\n" "" ctnt) ""))
  1223. "\n\\item %s\\\\\n%s%%"
  1224. "\n\\item %s\n%s%%")
  1225. heading
  1226. (if label (format "\\label{%s}" label) "")))
  1227. (insert ctnt))
  1228. (cond ((stringp subcontent) (insert subcontent))
  1229. ((listp subcontent) (org-export-latex-sub subcontent)))
  1230. (insert (format "\\end{%s} %% ends low level\n"
  1231. (symbol-name org-export-latex-low-levels))))
  1232. ((and (listp org-export-latex-low-levels)
  1233. org-export-latex-low-levels)
  1234. (if (string-match "% ends low level$"
  1235. (buffer-substring (point-at-bol 0) (point)))
  1236. (delete-region (point-at-bol 0) (point))
  1237. (insert (car org-export-latex-low-levels) "\n"))
  1238. (insert (format (nth 2 org-export-latex-low-levels)
  1239. heading
  1240. (if label (format "\\label{%s}" label) "")))
  1241. (insert (org-export-latex-content content))
  1242. (cond ((stringp subcontent) (insert subcontent))
  1243. ((listp subcontent) (org-export-latex-sub subcontent)))
  1244. (insert (nth 1 org-export-latex-low-levels)
  1245. " %% ends low level\n"))
  1246. ((stringp org-export-latex-low-levels)
  1247. (insert (format org-export-latex-low-levels heading) "\n")
  1248. (when label (insert (format "\\label{%s}\n" label)))
  1249. (insert (org-export-latex-content content))
  1250. (cond ((stringp subcontent) (insert subcontent))
  1251. ((listp subcontent) (org-export-latex-sub subcontent)))))))))
  1252. ;;; Exporting internals:
  1253. (defun org-export-latex-set-initial-vars (ext-plist level)
  1254. "Store org local variables required for LaTeX export.
  1255. EXT-PLIST is an optional additional plist.
  1256. LEVEL indicates the default depth for export."
  1257. (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
  1258. org-export-latex-done-keywords org-done-keywords
  1259. org-export-latex-not-done-keywords org-not-done-keywords
  1260. org-export-latex-complex-heading-re org-complex-heading-regexp
  1261. org-export-latex-display-custom-times org-display-custom-times
  1262. org-export-latex-all-targets-re
  1263. (org-make-target-link-regexp (org-all-targets))
  1264. org-export-latex-options-plist
  1265. (org-combine-plists (org-default-export-plist) ext-plist
  1266. (org-infile-export-plist))
  1267. org-export-latex-class
  1268. (or (and (org-region-active-p)
  1269. (save-excursion
  1270. (goto-char (region-beginning))
  1271. (and (looking-at org-complex-heading-regexp)
  1272. (org-entry-get nil "LaTeX_CLASS" 'selective))))
  1273. (save-excursion
  1274. (save-restriction
  1275. (widen)
  1276. (goto-char (point-min))
  1277. (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([-/a-zA-Z]+\\)" nil t)
  1278. (match-string 1))))
  1279. (plist-get org-export-latex-options-plist :latex-class)
  1280. org-export-latex-default-class)
  1281. org-export-latex-class-options
  1282. (or (and (org-region-active-p)
  1283. (save-excursion
  1284. (goto-char (region-beginning))
  1285. (and (looking-at org-complex-heading-regexp)
  1286. (org-entry-get nil "LaTeX_CLASS_OPTIONS" 'selective))))
  1287. (save-excursion
  1288. (save-restriction
  1289. (widen)
  1290. (goto-char (point-min))
  1291. (and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t)
  1292. (match-string 1))))
  1293. (plist-get org-export-latex-options-plist :latex-class-options))
  1294. org-export-latex-class
  1295. (or (car (assoc org-export-latex-class org-export-latex-classes))
  1296. (error "No definition for class `%s' in `org-export-latex-classes'"
  1297. org-export-latex-class))
  1298. org-export-latex-header
  1299. (cadr (assoc org-export-latex-class org-export-latex-classes))
  1300. org-export-latex-sectioning
  1301. (cddr (assoc org-export-latex-class org-export-latex-classes))
  1302. org-export-latex-sectioning-depth
  1303. (or level
  1304. (let ((hl-levels
  1305. (plist-get org-export-latex-options-plist :headline-levels))
  1306. (sec-depth (length org-export-latex-sectioning)))
  1307. (if (> hl-levels sec-depth) sec-depth hl-levels))))
  1308. (when (and org-export-latex-class-options
  1309. (string-match "\\S-" org-export-latex-class-options)
  1310. (string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
  1311. org-export-latex-header))
  1312. (setq org-export-latex-header
  1313. (concat (substring org-export-latex-header 0 (match-end 1))
  1314. org-export-latex-class-options
  1315. (substring org-export-latex-header (match-end 0))))))
  1316. (defvar org-export-latex-format-toc-function
  1317. 'org-export-latex-format-toc-default
  1318. "The function formatting returning the string to create the table of contents.
  1319. The function mus take one parameter, the depth of the table of contents.")
  1320. (defun org-export-latex-make-header (title opt-plist)
  1321. "Make the LaTeX header and return it as a string.
  1322. TITLE is the current title from the buffer or region.
  1323. OPT-PLIST is the options plist for current buffer."
  1324. (let ((toc (plist-get opt-plist :table-of-contents))
  1325. (author (org-export-apply-macros-in-string
  1326. (plist-get opt-plist :author)))
  1327. (email (replace-regexp-in-string
  1328. "_" "\\\\_"
  1329. (org-export-apply-macros-in-string
  1330. (plist-get opt-plist :email))))
  1331. (description (org-export-apply-macros-in-string
  1332. (plist-get opt-plist :description)))
  1333. (keywords (org-export-apply-macros-in-string
  1334. (plist-get opt-plist :keywords))))
  1335. (concat
  1336. (if (plist-get opt-plist :time-stamp-file)
  1337. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  1338. ;; insert LaTeX custom header and packages from the list
  1339. (org-splice-latex-header
  1340. (org-export-apply-macros-in-string org-export-latex-header)
  1341. org-export-latex-default-packages-alist
  1342. org-export-latex-packages-alist nil
  1343. (org-export-apply-macros-in-string
  1344. (plist-get opt-plist :latex-header-extra)))
  1345. ;; append another special variable
  1346. (org-export-apply-macros-in-string org-export-latex-append-header)
  1347. ;; define alert if not yet defined
  1348. "\n\\providecommand{\\alert}[1]{\\textbf{#1}}"
  1349. ;; insert the title
  1350. (format
  1351. "\n\n\\title{%s}\n"
  1352. (org-export-latex-fontify-headline title))
  1353. ;; insert author info
  1354. (if (plist-get opt-plist :author-info)
  1355. (format "\\author{%s%s}\n"
  1356. (org-export-latex-fontify-headline (or author user-full-name))
  1357. (if (and (plist-get opt-plist :email-info) email
  1358. (string-match "\\S-" email))
  1359. (format "\\thanks{%s}" email)
  1360. ""))
  1361. (format "%%\\author{%s}\n"
  1362. (org-export-latex-fontify-headline (or author user-full-name))))
  1363. ;; insert the date
  1364. (format "\\date{%s}\n"
  1365. (format-time-string
  1366. (or (plist-get opt-plist :date)
  1367. org-export-latex-date-format)))
  1368. ;; add some hyperref options
  1369. ;; FIXME: let's have a defcustom for this?
  1370. (format "\\hypersetup{\n pdfkeywords={%s},\n pdfsubject={%s},\n pdfcreator={%s}}\n"
  1371. (org-export-latex-fontify-headline keywords)
  1372. (org-export-latex-fontify-headline description)
  1373. (concat "Emacs Org-mode version " (org-version)))
  1374. ;; beginning of the document
  1375. "\n\\begin{document}\n\n"
  1376. ;; insert the title command
  1377. (when (string-match "\\S-" title)
  1378. (if (string-match "%s" org-export-latex-title-command)
  1379. (format org-export-latex-title-command title)
  1380. org-export-latex-title-command))
  1381. "\n\n"
  1382. ;; table of contents
  1383. (when (and org-export-with-toc
  1384. (plist-get opt-plist :section-numbers))
  1385. (funcall org-export-latex-format-toc-function
  1386. (cond ((numberp toc)
  1387. (min toc (plist-get opt-plist :headline-levels)))
  1388. (toc (plist-get opt-plist :headline-levels))))))))
  1389. (defun org-export-latex-format-toc-default (depth)
  1390. (when depth
  1391. (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
  1392. depth)))
  1393. (defun org-export-latex-first-lines (opt-plist &optional beg end)
  1394. "Export the first lines before first headline.
  1395. If BEG is non-nil, it is the beginning of the region.
  1396. If END is non-nil, it is the end of the region."
  1397. (save-excursion
  1398. (goto-char (or beg (point-min)))
  1399. (let* ((pt (point))
  1400. (end (if (re-search-forward
  1401. (concat "^" (org-get-limited-outline-regexp)) end t)
  1402. (goto-char (match-beginning 0))
  1403. (goto-char (or end (point-max))))))
  1404. (prog1
  1405. (org-export-latex-content
  1406. (org-export-preprocess-string
  1407. (buffer-substring pt end)
  1408. :for-backend 'latex
  1409. :emph-multiline t
  1410. :add-text nil
  1411. :comments nil
  1412. :skip-before-1st-heading nil
  1413. :LaTeX-fragments nil
  1414. :timestamps (plist-get opt-plist :timestamps)
  1415. :footnotes (plist-get opt-plist :footnotes)))
  1416. (org-unmodified
  1417. (let ((inhibit-read-only t)
  1418. (limit (max pt (1- end))))
  1419. (add-text-properties pt limit
  1420. '(:org-license-to-kill t))
  1421. (save-excursion
  1422. (goto-char pt)
  1423. (while (re-search-forward "^[ \t]*#\\+.*\n?" limit t)
  1424. (let ((case-fold-search t))
  1425. (unless (org-string-match-p
  1426. "^[ \t]*#\\+\\(attr_\\|caption\\>\\|label\\>\\)"
  1427. (match-string 0))
  1428. (remove-text-properties (match-beginning 0) (match-end 0)
  1429. '(:org-license-to-kill t))))))))))))
  1430. (defvar org-export-latex-header-defs nil
  1431. "The header definitions that might be used in the LaTeX body.")
  1432. (defun org-export-latex-content (content &optional exclude-list)
  1433. "Convert CONTENT string to LaTeX.
  1434. Don't perform conversions that are in EXCLUDE-LIST. Recognized
  1435. conversion types are: quotation-marks, emphasis, sub-superscript,
  1436. links, keywords, lists, tables, fixed-width"
  1437. (with-temp-buffer
  1438. (org-install-letbind)
  1439. (insert content)
  1440. (unless (memq 'timestamps exclude-list)
  1441. (org-export-latex-time-stamps))
  1442. (unless (memq 'quotation-marks exclude-list)
  1443. (org-export-latex-quotation-marks))
  1444. (unless (memq 'emphasis exclude-list)
  1445. (when (plist-get org-export-latex-options-plist :emphasize)
  1446. (org-export-latex-fontify)))
  1447. (unless (memq 'sub-superscript exclude-list)
  1448. (org-export-latex-special-chars
  1449. (plist-get org-export-latex-options-plist :sub-superscript)))
  1450. (unless (memq 'links exclude-list)
  1451. (org-export-latex-links))
  1452. (unless (memq 'keywords exclude-list)
  1453. (org-export-latex-keywords))
  1454. (unless (memq 'lists exclude-list)
  1455. (org-export-latex-lists))
  1456. (unless (memq 'tables exclude-list)
  1457. (org-export-latex-tables
  1458. (plist-get org-export-latex-options-plist :tables)))
  1459. (unless (memq 'fixed-width exclude-list)
  1460. (org-export-latex-fixed-width
  1461. (plist-get org-export-latex-options-plist :fixed-width)))
  1462. ;; return string
  1463. (buffer-substring (point-min) (point-max))))
  1464. (defun org-export-latex-protect-string (s)
  1465. "Add the org-protected property to string S."
  1466. (add-text-properties 0 (length s) '(org-protected t) s) s)
  1467. (defun org-export-latex-protect-char-in-string (char-list string)
  1468. "Add org-protected text-property to char from CHAR-LIST in STRING."
  1469. (with-temp-buffer
  1470. (save-match-data
  1471. (insert string)
  1472. (goto-char (point-min))
  1473. (while (re-search-forward (regexp-opt char-list) nil t)
  1474. (add-text-properties (match-beginning 0)
  1475. (match-end 0) '(org-protected t)))
  1476. (buffer-string))))
  1477. (defun org-export-latex-keywords-maybe (&optional remove-list)
  1478. "Maybe remove keywords depending on rules in REMOVE-LIST."
  1479. (goto-char (point-min))
  1480. (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
  1481. (case-fold-search nil)
  1482. (todo-markup org-export-latex-todo-keyword-markup)
  1483. fmt)
  1484. ;; convert TODO keywords
  1485. (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
  1486. (if (plist-get remove-list :todo)
  1487. (replace-match "")
  1488. (setq fmt (cond
  1489. ((stringp todo-markup) todo-markup)
  1490. ((and (consp todo-markup) (stringp (car todo-markup)))
  1491. (if (member (match-string 1) org-export-latex-done-keywords)
  1492. (cdr todo-markup) (car todo-markup)))
  1493. (t (cdr (or (assoc (match-string 1) todo-markup)
  1494. (car todo-markup))))))
  1495. (replace-match (org-export-latex-protect-string
  1496. (format fmt (match-string 1))) t t)))
  1497. ;; convert priority string
  1498. (when (re-search-forward "\\[\\\\#.\\]" nil t)
  1499. (if (plist-get remove-list :priority)
  1500. (replace-match "")
  1501. (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
  1502. ;; convert tags
  1503. (when (re-search-forward "\\(:[a-zA-Z0-9_@#%]+\\)+:" nil t)
  1504. (if (or (not org-export-with-tags)
  1505. (plist-get remove-list :tags))
  1506. (replace-match "")
  1507. (replace-match
  1508. (org-export-latex-protect-string
  1509. (format org-export-latex-tag-markup
  1510. (save-match-data
  1511. (replace-regexp-in-string
  1512. "\\([_#]\\)" "\\\\\\1" (match-string 0)))))
  1513. t t)))))
  1514. (defun org-export-latex-fontify-headline (string)
  1515. "Fontify special words in STRING."
  1516. (with-temp-buffer
  1517. ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
  1518. ;; the beginning of the buffer - inserting "\n" is safe here though.
  1519. (insert "\n" string)
  1520. ;; Preserve math snippets
  1521. (let* ((matchers (plist-get org-format-latex-options :matchers))
  1522. (re-list org-latex-regexps)
  1523. beg end re e m n block off)
  1524. ;; Check the different regular expressions
  1525. (while (setq e (pop re-list))
  1526. (setq m (car e) re (nth 1 e) n (nth 2 e)
  1527. block (if (nth 3 e) "\n\n" ""))
  1528. (setq off (if (member m '("$" "$1")) 1 0))
  1529. (when (and (member m matchers) (not (equal m "begin")))
  1530. (goto-char (point-min))
  1531. (while (re-search-forward re nil t)
  1532. (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
  1533. (add-text-properties beg end
  1534. '(org-protected t org-latex-math t))))))
  1535. ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
  1536. (goto-char (point-min))
  1537. (let ((case-fold-search nil))
  1538. (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
  1539. (unless (eq (char-before (match-beginning 1)) ?\\)
  1540. (org-if-unprotected-1
  1541. (replace-match (org-export-latex-protect-string
  1542. (concat "\\" (match-string 1)
  1543. "{}")) t t)))))
  1544. (goto-char (point-min))
  1545. (let ((re (concat "\\\\\\([a-zA-Z]+\\)"
  1546. "\\(?:<[^<>\n]*>\\)*"
  1547. "\\(?:\\[[^][\n]*?\\]\\)*"
  1548. "\\(?:<[^<>\n]*>\\)*"
  1549. "\\("
  1550. (org-create-multibrace-regexp "{" "}" 3)
  1551. "\\)\\{1,3\\}")))
  1552. (while (re-search-forward re nil t)
  1553. (unless (or
  1554. ;; check for comment line
  1555. (save-excursion (goto-char (match-beginning 0))
  1556. (org-in-indented-comment-line))
  1557. ;; Check if this is a defined entity, so that is may need conversion
  1558. (org-entity-get (match-string 1)))
  1559. (add-text-properties (match-beginning 0) (match-end 0)
  1560. '(org-protected t)))))
  1561. (when (plist-get org-export-latex-options-plist :emphasize)
  1562. (org-export-latex-fontify))
  1563. (org-export-latex-time-stamps)
  1564. (org-export-latex-quotation-marks)
  1565. (org-export-latex-keywords-maybe)
  1566. (org-export-latex-special-chars
  1567. (plist-get org-export-latex-options-plist :sub-superscript))
  1568. (org-export-latex-links)
  1569. (org-trim (buffer-string))))
  1570. (defun org-export-latex-time-stamps ()
  1571. "Format time stamps."
  1572. (goto-char (point-min))
  1573. (let ((org-display-custom-times org-export-latex-display-custom-times))
  1574. (while (re-search-forward org-ts-regexp-both nil t)
  1575. (org-if-unprotected-at (1- (point))
  1576. (replace-match
  1577. (org-export-latex-protect-string
  1578. (format (if (string= "<" (substring (match-string 0) 0 1))
  1579. org-export-latex-timestamp-markup
  1580. org-export-latex-timestamp-inactive-markup)
  1581. (substring (org-translate-time (match-string 0)) 1 -1)))
  1582. t t)))))
  1583. (defun org-export-latex-quotation-marks ()
  1584. "Export quotation marks depending on language conventions."
  1585. (mapc (lambda(l)
  1586. (goto-char (point-min))
  1587. (while (re-search-forward (car l) nil t)
  1588. (let ((rpl (concat (match-string 1)
  1589. (org-export-latex-protect-string
  1590. (copy-sequence (cdr l))))))
  1591. (org-if-unprotected-1
  1592. (replace-match rpl t t)))))
  1593. (cdr (or (assoc (plist-get org-export-latex-options-plist :language)
  1594. org-export-latex-quotes)
  1595. ;; falls back on english
  1596. (assoc "en" org-export-latex-quotes)))))
  1597. (defun org-export-latex-special-chars (sub-superscript)
  1598. "Export special characters to LaTeX.
  1599. If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
  1600. See the `org-export-latex.el' code for a complete conversion table."
  1601. (goto-char (point-min))
  1602. (mapc (lambda(c)
  1603. (goto-char (point-min))
  1604. (while (re-search-forward c nil t)
  1605. ;; Put the point where to check for org-protected
  1606. (unless (get-text-property (match-beginning 2) 'org-protected)
  1607. (cond ((member (match-string 2) '("\\$" "$"))
  1608. (if (equal (match-string 2) "\\$")
  1609. nil
  1610. (replace-match "\\$" t t)))
  1611. ((member (match-string 2) '("&" "%" "#"))
  1612. (if (equal (match-string 1) "\\")
  1613. (replace-match (match-string 2) t t)
  1614. (replace-match (concat (match-string 1) "\\"
  1615. (match-string 2)) t t)
  1616. (backward-char 1)))
  1617. ((equal (match-string 2) "...")
  1618. (replace-match
  1619. (concat (match-string 1)
  1620. (org-export-latex-protect-string "\\ldots{}")) t t))
  1621. ((equal (match-string 2) "~")
  1622. (cond ((equal (match-string 1) "\\") nil)
  1623. ((eq 'org-link (get-text-property 0 'face (match-string 2)))
  1624. (replace-match (concat (match-string 1) "\\~") t t))
  1625. (t (replace-match
  1626. (org-export-latex-protect-string
  1627. (concat (match-string 1) "\\~{}")) t t))))
  1628. ((member (match-string 2) '("{" "}"))
  1629. (unless (save-match-data (org-inside-latex-math-p))
  1630. (if (equal (match-string 1) "\\")
  1631. (replace-match (match-string 2) t t)
  1632. (replace-match (concat (match-string 1) "\\"
  1633. (match-string 2)) t t)))))
  1634. (unless (save-match-data (or (org-inside-latex-math-p) (org-at-table-p)))
  1635. (cond ((equal (match-string 2) "\\")
  1636. (replace-match (or (save-match-data
  1637. (org-export-latex-treat-backslash-char
  1638. (match-string 1)
  1639. (or (match-string 3) "")))
  1640. "") t t)
  1641. (when (and (get-text-property (1- (point)) 'org-entity)
  1642. (looking-at "{}"))
  1643. ;; OK, this was an entity replacement, and the user
  1644. ;; had terminated the entity with {}. Make sure
  1645. ;; {} is protected as well, and remove the extra {}
  1646. ;; inserted by the conversion.
  1647. (put-text-property (point) (+ 2 (point)) 'org-protected t)
  1648. (if (save-excursion (goto-char (max (- (point) 2) (point-min)))
  1649. (looking-at "{}"))
  1650. (replace-match ""))
  1651. (forward-char 2))
  1652. (backward-char 1))
  1653. ((member (match-string 2) '("_" "^"))
  1654. (replace-match (or (save-match-data
  1655. (org-export-latex-treat-sub-super-char
  1656. sub-superscript
  1657. (match-string 2)
  1658. (match-string 1)
  1659. (match-string 3))) "") t t)
  1660. (backward-char 1)))))))
  1661. '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
  1662. "\\(\\(\\\\?\\$\\)\\)"
  1663. "\\([a-zA-Z0-9()]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-zA-Z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-zA-Z0-9]+}\\|([a-zA-Z0-9]+)\\)"
  1664. "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|\\([&#%{}\"]\\|[a-zA-Z][a-zA-Z0-9]*\\)\\)"
  1665. "\\(^\\|.\\)\\([&#%{}~]\\|\\.\\.\\.\\)"
  1666. ;; (?\< . "\\textless{}")
  1667. ;; (?\> . "\\textgreater{}")
  1668. )))
  1669. (defun org-inside-latex-math-p ()
  1670. (get-text-property (point) 'org-latex-math))
  1671. (defun org-export-latex-treat-sub-super-char
  1672. (subsup char string-before string-after)
  1673. "Convert the \"_\" and \"^\" characters to LaTeX.
  1674. SUBSUP corresponds to the ^: option in the #+OPTIONS line.
  1675. Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
  1676. (cond ((equal string-before "\\")
  1677. (concat string-before char string-after))
  1678. ((and (string-match "\\S-+" string-after))
  1679. ;; this is part of a math formula
  1680. (cond ((eq 'org-link (get-text-property 0 'face char))
  1681. (concat string-before "\\" char string-after))
  1682. ((save-match-data (org-inside-latex-math-p))
  1683. (if subsup
  1684. (cond ((eq 1 (length string-after))
  1685. (concat string-before char string-after))
  1686. ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
  1687. (format "%s%s{%s}" string-before char
  1688. (match-string 1 string-after))))))
  1689. ((and (> (length string-after) 1)
  1690. (or (eq subsup t)
  1691. (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
  1692. (or (string-match "[{]?\\([^}]+\\)[}]?" string-after)
  1693. (string-match "[(]?\\([^)]+\\)[)]?" string-after)))
  1694. (org-export-latex-protect-string
  1695. (format "%s$%s{%s}$" string-before char
  1696. (if (and (> (match-end 1) (1+ (match-beginning 1)))
  1697. (not (equal (substring string-after 0 2) "{\\")))
  1698. (concat "\\mathrm{" (match-string 1 string-after) "}")
  1699. (match-string 1 string-after)))))
  1700. ((eq subsup t) (concat string-before "$" char string-after "$"))
  1701. (t (org-export-latex-protect-string
  1702. (concat string-before "\\" char "{}" string-after)))))
  1703. (t (org-export-latex-protect-string
  1704. (concat string-before "\\" char "{}" string-after)))))
  1705. (defun org-export-latex-treat-backslash-char (string-before string-after)
  1706. "Convert the \"$\" special character to LaTeX.
  1707. The conversion is made depending of STRING-BEFORE and STRING-AFTER."
  1708. (let ((ass (org-entity-get string-after)))
  1709. (cond
  1710. (ass (org-add-props
  1711. (if (nth 2 ass)
  1712. (concat string-before
  1713. (org-export-latex-protect-string
  1714. (concat "$" (nth 1 ass) "$")))
  1715. (concat string-before (org-export-latex-protect-string
  1716. (nth 1 ass))))
  1717. nil 'org-entity t))
  1718. ((and (not (string-match "^[ \n\t]" string-after))
  1719. (not (string-match "[ \t]\\'\\|^" string-before)))
  1720. ;; backslash is inside a word
  1721. (concat string-before
  1722. (org-export-latex-protect-string
  1723. (concat "\\textbackslash{}" string-after))))
  1724. ((not (or (equal string-after "")
  1725. (string-match "^[ \t\n]" string-after)))
  1726. ;; backslash might escape a character (like \#) or a user TeX
  1727. ;; macro (like \setcounter)
  1728. (concat string-before
  1729. (org-export-latex-protect-string (concat "\\" string-after))))
  1730. ((and (string-match "^[ \t\n]" string-after)
  1731. (string-match "[ \t\n]\\'" string-before))
  1732. ;; backslash is alone, convert it to $\backslash$
  1733. (org-export-latex-protect-string
  1734. (concat string-before "\\textbackslash{}" string-after)))
  1735. (t (org-export-latex-protect-string
  1736. (concat string-before "\\textbackslash{}" string-after))))))
  1737. (defun org-export-latex-keywords ()
  1738. "Convert special keywords to LaTeX."
  1739. (goto-char (point-min))
  1740. (while (re-search-forward org-export-latex-special-keyword-regexp nil t)
  1741. (replace-match (format org-export-latex-timestamp-keyword-markup
  1742. (match-string 0)) t t)
  1743. (save-excursion
  1744. (beginning-of-line 1)
  1745. (unless (looking-at ".*\n[ \t]*\n")
  1746. (end-of-line 1)
  1747. (insert "\n")))))
  1748. (defun org-export-latex-fixed-width (opt)
  1749. "When OPT is non-nil convert fixed-width sections to LaTeX."
  1750. (goto-char (point-min))
  1751. (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
  1752. (unless (get-text-property (point) 'org-example)
  1753. (if opt
  1754. (progn (goto-char (match-beginning 0))
  1755. (insert "\\begin{verbatim}\n")
  1756. (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
  1757. (replace-match (concat (match-string 1)
  1758. (match-string 2)) t t)
  1759. (forward-line))
  1760. (insert "\\end{verbatim}\n"))
  1761. (progn (goto-char (match-beginning 0))
  1762. (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
  1763. (replace-match (concat "%" (match-string 1)
  1764. (match-string 2)) t t)
  1765. (forward-line)))))))
  1766. (defvar org-table-last-alignment) ; defined in org-table.el
  1767. (defvar org-table-last-column-widths) ; defined in org-table.el
  1768. (declare-function orgtbl-to-latex "org-table" (table params) t)
  1769. (defun org-export-latex-tables (insert)
  1770. "Convert tables to LaTeX and INSERT it."
  1771. ;; First, get the table.el tables
  1772. (goto-char (point-min))
  1773. (while (re-search-forward "^[ \t]*\\(\\+-[-+]*\\+\\)[ \t]*\n[ \t]*|" nil t)
  1774. (org-if-unprotected
  1775. (require 'table)
  1776. (org-export-latex-convert-table.el-table)))
  1777. ;; And now the Org-mode tables
  1778. (goto-char (point-min))
  1779. (while (re-search-forward "^\\([ \t]*\\)|" nil t)
  1780. (org-if-unprotected-at (1- (point))
  1781. (org-table-align)
  1782. (let* ((beg (org-table-begin))
  1783. (end (org-table-end))
  1784. (raw-table (buffer-substring beg end))
  1785. (org-table-last-alignment (copy-sequence org-table-last-alignment))
  1786. (org-table-last-column-widths (copy-sequence
  1787. org-table-last-column-widths))
  1788. fnum fields line lines olines gr colgropen line-fmt align
  1789. caption width shortn label attr hfmt floatp placement
  1790. longtblp tblenv tabular-env)
  1791. (if org-export-latex-tables-verbatim
  1792. (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
  1793. "\\end{verbatim}\n")))
  1794. (apply 'delete-region (list beg end))
  1795. (insert (org-export-latex-protect-string tbl)))
  1796. (progn
  1797. (setq caption (org-find-text-property-in-string
  1798. 'org-caption raw-table)
  1799. shortn (org-find-text-property-in-string
  1800. 'org-caption-shortn raw-table)
  1801. attr (org-find-text-property-in-string
  1802. 'org-attributes raw-table)
  1803. label (org-find-text-property-in-string
  1804. 'org-label raw-table)
  1805. longtblp (and attr (stringp attr)
  1806. (string-match "\\<longtable\\>" attr))
  1807. tblenv (if (and attr (stringp attr))
  1808. (cond ((string-match "\\<sidewaystable\\>" attr)
  1809. "sidewaystable")
  1810. ((or (string-match (regexp-quote "table*") attr)
  1811. (string-match "\\<multicolumn\\>" attr))
  1812. "table*")
  1813. (t "table"))
  1814. "table")
  1815. tabular-env
  1816. (if (and attr (stringp attr)
  1817. (string-match "\\(tabular.\\)" attr))
  1818. (match-string 1 attr)
  1819. org-export-latex-tabular-environment)
  1820. width (and attr (stringp attr)
  1821. (string-match "\\<width=\\([^ \t\n\r]+\\)" attr)
  1822. (match-string 1 attr))
  1823. align (and attr (stringp attr)
  1824. (string-match "\\<align=\\([^ \t\n\r]+\\)" attr)
  1825. (match-string 1 attr))
  1826. hfmt (and attr (stringp attr)
  1827. (string-match "\\<hfmt=\\(\\S-+\\)" attr)
  1828. (match-string 1 attr))
  1829. floatp (or caption label (string= "table*" tblenv))
  1830. placement (if (and attr
  1831. (stringp attr)
  1832. (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
  1833. (match-string 1 attr)
  1834. (concat
  1835. "[" org-latex-default-figure-position "]")))
  1836. (setq caption (and caption (org-export-latex-fontify-headline caption)))
  1837. (setq lines (org-split-string raw-table "\n"))
  1838. (apply 'delete-region (list beg end))
  1839. (when org-export-table-remove-special-lines
  1840. (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
  1841. (when org-table-clean-did-remove-column
  1842. (pop org-table-last-alignment)
  1843. (pop org-table-last-column-widths))
  1844. ;; make a formatting string to reflect alignment
  1845. (setq olines lines)
  1846. (while (and (not line-fmt) (setq line (pop olines)))
  1847. (unless (string-match "^[ \t]*|-" line)
  1848. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1849. (setq fnum (make-vector (length fields) 0))
  1850. (setq line-fmt
  1851. (mapconcat
  1852. (lambda (x)
  1853. (setq gr (pop org-table-colgroup-info))
  1854. (format "%s%%s%s"
  1855. (cond ((eq gr :start)
  1856. (prog1 (if colgropen "|" "|")
  1857. (setq colgropen t)))
  1858. ((eq gr :startend)
  1859. (prog1 (if colgropen "|" "|")
  1860. (setq colgropen nil)))
  1861. (t ""))
  1862. (if (memq gr '(:end :startend))
  1863. (progn (setq colgropen nil) "|")
  1864. "")))
  1865. fnum ""))))
  1866. ;; fix double || in line-fmt
  1867. (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
  1868. ;; maybe remove the first and last "|"
  1869. (when (and (not org-export-latex-tables-column-borders)
  1870. (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
  1871. (setq line-fmt (match-string 2 line-fmt)))
  1872. ;; format alignment
  1873. (unless align
  1874. (setq align (apply 'format
  1875. (cons line-fmt
  1876. (mapcar (lambda (x) (if x "r" "l"))
  1877. org-table-last-alignment)))))
  1878. ;; prepare the table to send to orgtbl-to-latex
  1879. (setq lines
  1880. (mapcar
  1881. (lambda(elem)
  1882. (or (and (string-match "[ \t]*|-+" elem) 'hline)
  1883. (org-split-string
  1884. (progn (set-text-properties 0 (length elem) nil elem)
  1885. (org-trim elem)) "|")))
  1886. lines))
  1887. (when insert
  1888. (insert (org-export-latex-protect-string
  1889. (concat
  1890. (if longtblp
  1891. (concat "\\begin{longtable}{" align "}\n")
  1892. (if floatp
  1893. (format "\\begin{%s}%s\n" tblenv placement)))
  1894. (if (and floatp org-export-latex-table-caption-above)
  1895. (format
  1896. "\\caption%s{%s} %s"
  1897. (if shortn (concat "[" shortn "]") "")
  1898. (or caption "")
  1899. (if label (format "\\label{%s}" label) "")))
  1900. (if (and longtblp caption org-export-latex-table-caption-above)
  1901. "\\\\\n" "\n")
  1902. (if (and org-export-latex-tables-centered (not longtblp))
  1903. "\\begin{center}\n")
  1904. (if (not longtblp)
  1905. (format "\\begin{%s}%s{%s}\n"
  1906. tabular-env
  1907. (if width (format "{%s}" width) "")
  1908. align))
  1909. (orgtbl-to-latex
  1910. lines
  1911. `(:tstart ,org-export-latex-tables-tstart
  1912. :tend ,org-export-latex-tables-tend
  1913. :hline ,org-export-latex-tables-hline
  1914. :skipheadrule ,longtblp
  1915. :hfmt ,hfmt
  1916. :hlend ,(if longtblp
  1917. (format "\\\\
  1918. %s
  1919. \\endhead
  1920. %s\\multicolumn{%d}{r}{Continued on next page}\\
  1921. \\endfoot
  1922. \\endlastfoot"
  1923. org-export-latex-tables-hline
  1924. org-export-latex-tables-hline
  1925. (length org-table-last-alignment))
  1926. nil)))
  1927. (if (not longtblp) (format "\n\\end{%s}" tabular-env))
  1928. (if longtblp "\n" (if org-export-latex-tables-centered
  1929. "\n\\end{center}\n" "\n"))
  1930. (if (and floatp (not org-export-latex-table-caption-above))
  1931. (format
  1932. "\\caption%s{%s} %s"
  1933. (if shortn (concat "[" shortn "]") "")
  1934. (or caption "")
  1935. (if label (format "\\label{%s}" label) "")))
  1936. (if longtblp
  1937. "\\end{longtable}"
  1938. (if floatp (format "\\end{%s}" tblenv)))))
  1939. "\n\n"))))))))
  1940. (defun org-export-latex-convert-table.el-table ()
  1941. "Replace table.el table at point with LaTeX code."
  1942. (let (tbl caption shortn label line floatp attr align rmlines)
  1943. (setq line (buffer-substring (point-at-bol) (point-at-eol))
  1944. label (org-get-text-property-any 0 'org-label line)
  1945. caption (org-get-text-property-any 0 'org-caption line)
  1946. shortn (org-get-text-property-any 0 'org-caption-shortn line)
  1947. attr (org-get-text-property-any 0 'org-attributes line)
  1948. align (and attr (stringp attr)
  1949. (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
  1950. (match-string 1 attr))
  1951. rmlines (and attr (stringp attr)
  1952. (string-match "\\<rmlines\\>" attr))
  1953. floatp (or label caption))
  1954. (and (get-buffer "*org-export-table*")
  1955. (kill-buffer (get-buffer "*org-export-table*")))
  1956. (table-generate-source 'latex "*org-export-table*" "caption")
  1957. (setq tbl (with-current-buffer "*org-export-table*"
  1958. (buffer-string)))
  1959. (while (string-match "^%.*\n" tbl)
  1960. (setq tbl (replace-match "" t t tbl)))
  1961. ;; fix the hlines
  1962. (when rmlines
  1963. (let ((n 0) lines)
  1964. (setq lines (mapcar (lambda (x)
  1965. (if (string-match "^\\\\hline$" x)
  1966. (progn
  1967. (setq n (1+ n))
  1968. (if (= n 2) x nil))
  1969. x))
  1970. (org-split-string tbl "\n")))
  1971. (setq tbl (mapconcat 'identity (delq nil lines) "\n"))))
  1972. (when (and align (string-match "\\\\begin{tabular}{.*}" tbl))
  1973. (setq tbl (replace-match (concat "\\begin{tabular}{" align "}")
  1974. t t tbl)))
  1975. (and (get-buffer "*org-export-table*")
  1976. (kill-buffer (get-buffer "*org-export-table*")))
  1977. (beginning-of-line 0)
  1978. (while (looking-at "[ \t]*\\(|\\|\\+-\\)")
  1979. (delete-region (point) (1+ (point-at-eol))))
  1980. (when org-export-latex-tables-centered
  1981. (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
  1982. (when floatp
  1983. (setq tbl (concat "\\begin{table}\n"
  1984. (if (not org-export-latex-table-caption-above) tbl)
  1985. (format "\\caption%s{%s%s}\n"
  1986. (if shortn (format "[%s]" shortn) "")
  1987. (if label (format "\\label{%s}" label) "")
  1988. (or caption ""))
  1989. (if org-export-latex-table-caption-above tbl)
  1990. "\n\\end{table}\n")))
  1991. (insert (org-export-latex-protect-string tbl))))
  1992. (defun org-export-latex-fontify ()
  1993. "Convert fontification to LaTeX."
  1994. (goto-char (point-min))
  1995. (while (re-search-forward org-emph-re nil t)
  1996. ;; The match goes one char after the *string*, except at the end of a line
  1997. (let ((emph (assoc (match-string 3)
  1998. org-export-latex-emphasis-alist))
  1999. (beg (match-beginning 0))
  2000. (end (match-end 0))
  2001. rpl s)
  2002. (unless emph
  2003. (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
  2004. (match-string 3)))
  2005. (unless (or (and (get-text-property (- (point) 2) 'org-protected)
  2006. (not (get-text-property
  2007. (- (point) 2) 'org-verbatim-emph)))
  2008. (equal (char-after (match-beginning 3))
  2009. (char-after (1+ (match-beginning 3))))
  2010. (save-excursion
  2011. (goto-char (match-beginning 1))
  2012. (save-match-data
  2013. (and (org-at-table-p)
  2014. (string-match
  2015. "[|\n]" (buffer-substring beg end)))))
  2016. (and (equal (match-string 3) "+")
  2017. (save-match-data
  2018. (string-match "\\`-+\\'" (match-string 4)))))
  2019. (setq s (match-string 4))
  2020. (setq rpl (concat (match-string 1)
  2021. (org-export-latex-emph-format (cadr emph)
  2022. (match-string 4))
  2023. (match-string 5)))
  2024. (if (caddr emph)
  2025. (setq rpl (org-export-latex-protect-string rpl))
  2026. (save-match-data
  2027. (if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl)
  2028. (progn
  2029. (add-text-properties (match-beginning 1) (match-end 1)
  2030. '(org-protected t) rpl)
  2031. (add-text-properties (match-beginning 3) (match-end 3)
  2032. '(org-protected t) rpl)))))
  2033. (replace-match rpl t t)))
  2034. (backward-char)))
  2035. (defun org-export-latex-emph-format (format string)
  2036. "Format an emphasis string and handle the \\verb special case."
  2037. (when (member format '("\\verb" "\\protectedtexttt"))
  2038. (save-match-data
  2039. (if (equal format "\\verb")
  2040. (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
  2041. (catch 'exit
  2042. (loop for i from 0 to (1- (length ll)) do
  2043. (if (not (string-match (regexp-quote (substring ll i (1+ i)))
  2044. string))
  2045. (progn
  2046. (setq format (concat "\\verb" (substring ll i (1+ i))
  2047. "%s" (substring ll i (1+ i))))
  2048. (throw 'exit nil))))))
  2049. (let ((start 0)
  2050. (trans '(("\\" . "\\textbackslash{}")
  2051. ("~" . "\\textasciitilde{}")
  2052. ("^" . "\\textasciicircum{}")))
  2053. (rtn "") char)
  2054. (while (string-match "[\\{}$%&_#~^]" string)
  2055. (setq char (match-string 0 string))
  2056. (if (> (match-beginning 0) 0)
  2057. (setq rtn (concat rtn (substring string
  2058. 0 (match-beginning 0)))))
  2059. (setq string (substring string (1+ (match-beginning 0))))
  2060. (setq char (or (cdr (assoc char trans)) (concat "\\" char))
  2061. rtn (concat rtn char)))
  2062. (setq string (concat rtn string) format "\\texttt{%s}")
  2063. (while (string-match "--" string)
  2064. (setq string (replace-match "-{}-" t t string)))))))
  2065. (format format string))
  2066. (defun org-export-latex-links ()
  2067. ;; Make sure to use the LaTeX hyperref and graphicx package
  2068. ;; or send some warnings.
  2069. "Convert links to LaTeX."
  2070. (goto-char (point-min))
  2071. (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
  2072. (org-if-unprotected-1
  2073. (goto-char (match-beginning 0))
  2074. (let* ((re-radio org-export-latex-all-targets-re)
  2075. (remove (list (match-beginning 0) (match-end 0)))
  2076. (raw-path (org-extract-attributes (match-string 3)))
  2077. (full-raw-path (concat (match-string 1) raw-path))
  2078. (desc (match-string 5))
  2079. (type (or (match-string 2)
  2080. (if (or (file-name-absolute-p raw-path)
  2081. (string-match "^\\.\\.?/" raw-path))
  2082. "file")))
  2083. (coderefp (equal type "coderef"))
  2084. (caption (org-find-text-property-in-string 'org-caption raw-path))
  2085. (shortn (org-find-text-property-in-string 'org-caption-shortn raw-path))
  2086. (attr (or (org-find-text-property-in-string 'org-attributes raw-path)
  2087. (plist-get org-export-latex-options-plist :latex-image-options)))
  2088. (label (org-find-text-property-in-string 'org-label raw-path))
  2089. imgp radiop fnc
  2090. ;; define the path of the link
  2091. (path (cond
  2092. ((member type '("coderef"))
  2093. raw-path)
  2094. ((member type '("http" "https" "ftp"))
  2095. (concat type ":" raw-path))
  2096. ((and re-radio (string-match re-radio raw-path))
  2097. (setq radiop t))
  2098. ((equal type "mailto")
  2099. (concat type ":" raw-path))
  2100. ((equal type "file")
  2101. (if (and (org-file-image-p
  2102. (expand-file-name
  2103. raw-path)
  2104. org-export-latex-inline-image-extensions)
  2105. (or (get-text-property 0 'org-no-description
  2106. raw-path)
  2107. (equal desc full-raw-path)))
  2108. (setq imgp t)
  2109. (progn (when (string-match "\\(.+\\)::.+" raw-path)
  2110. (setq raw-path (match-string 1 raw-path)))
  2111. (if (file-exists-p raw-path)
  2112. (concat type "://" (expand-file-name raw-path))
  2113. (concat type "://" (org-export-directory
  2114. :LaTeX org-export-latex-options-plist)
  2115. raw-path))))))))
  2116. ;; process with link inserting
  2117. (apply 'delete-region remove)
  2118. (setq caption (and caption (org-export-latex-fontify-headline caption)))
  2119. (cond ((and imgp
  2120. (plist-get org-export-latex-options-plist :inline-images))
  2121. ;; OK, we need to inline an image
  2122. (insert
  2123. (org-export-latex-format-image raw-path caption label attr shortn)))
  2124. (coderefp
  2125. (insert (format
  2126. (org-export-get-coderef-format path desc)
  2127. (cdr (assoc path org-export-code-refs)))))
  2128. (radiop (insert (format org-export-latex-hyperref-format
  2129. (org-solidify-link-text raw-path) desc)))
  2130. ((not type)
  2131. (insert (format org-export-latex-hyperref-format
  2132. (org-remove-initial-hash
  2133. (org-solidify-link-text raw-path))
  2134. desc)))
  2135. (path
  2136. (when (org-at-table-p)
  2137. ;; There is a strange problem when we have a link in a table,
  2138. ;; ampersands then cause a problem. I think this must be
  2139. ;; a LaTeX issue, but we here implement a work-around anyway.
  2140. (setq path (org-export-latex-protect-amp path)
  2141. desc (org-export-latex-protect-amp desc)))
  2142. (insert
  2143. (if (string-match "%s.*%s" org-export-latex-href-format)
  2144. (format org-export-latex-href-format path desc)
  2145. (format org-export-latex-href-format path))))
  2146. ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
  2147. ;; The link protocol has a function for formatting the link
  2148. (insert
  2149. (save-match-data
  2150. (funcall fnc (org-link-unescape raw-path) desc 'latex))))
  2151. (t (insert "\\texttt{" desc "}")))))))
  2152. (defun org-export-latex-format-image (path caption label attr &optional shortn)
  2153. "Format the image element, depending on user settings."
  2154. (let (ind floatp wrapp multicolumnp placement figenv)
  2155. (setq floatp (or caption label))
  2156. (setq ind (org-get-text-property-any 0 'original-indentation path))
  2157. (when (and attr (stringp attr))
  2158. (if (string-match "[ \t]*\\<wrap\\>" attr)
  2159. (setq wrapp t floatp nil attr (replace-match "" t t attr)))
  2160. (if (string-match "[ \t]*\\<float\\>" attr)
  2161. (setq wrapp nil floatp t attr (replace-match "" t t attr)))
  2162. (if (string-match "[ \t]*\\<multicolumn\\>" attr)
  2163. (setq multicolumnp t attr (replace-match "" t t attr))))
  2164. (setq placement
  2165. (cond
  2166. (wrapp "{l}{0.5\\textwidth}")
  2167. (floatp (concat "[" org-latex-default-figure-position "]"))
  2168. (t "")))
  2169. (when (and attr (stringp attr)
  2170. (string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
  2171. (setq placement (match-string 1 attr)
  2172. attr (replace-match "" t t attr)))
  2173. (setq attr (and attr (org-trim attr)))
  2174. (when (or (not attr) (= (length attr) 0))
  2175. (setq attr (cond (floatp "width=0.7\\textwidth")
  2176. (wrapp "width=0.48\\textwidth")
  2177. (t attr))))
  2178. (setq figenv
  2179. (cond
  2180. (wrapp "\\begin{wrapfigure}%placement
  2181. \\centering
  2182. \\includegraphics[%attr]{%path}
  2183. \\caption%shortn{%labelcmd%caption}
  2184. \\end{wrapfigure}")
  2185. (multicolumnp "\\begin{figure*}%placement
  2186. \\centering
  2187. \\includegraphics[%attr]{%path}
  2188. \\caption%shortn{%labelcmd%caption}
  2189. \\end{figure*}")
  2190. (floatp "\\begin{figure}%placement
  2191. \\centering
  2192. \\includegraphics[%attr]{%path}
  2193. \\caption%shortn{%labelcmd%caption}
  2194. \\end{figure}")
  2195. (t "\\includegraphics[%attr]{%path}")))
  2196. (setq figenv (mapconcat 'identity (split-string figenv "\n")
  2197. (save-excursion (beginning-of-line 1)
  2198. (looking-at "[ \t]*")
  2199. (concat "\n" (match-string 0)))))
  2200. (if (and (not label) (not caption)
  2201. (string-match "^\\\\caption{.*\n" figenv))
  2202. (setq figenv (replace-match "" t t figenv)))
  2203. (org-add-props
  2204. (org-fill-template
  2205. figenv
  2206. (list (cons "path"
  2207. (if (file-name-absolute-p path)
  2208. (expand-file-name path)
  2209. path))
  2210. (cons "attr" attr)
  2211. (cons "shortn" (if shortn (format "[%s]" shortn) ""))
  2212. (cons "labelcmd" (if label (format "\\label{%s}"
  2213. label)""))
  2214. (cons "caption" (or caption ""))
  2215. (cons "placement" (or placement ""))))
  2216. nil 'original-indentation ind)))
  2217. (defun org-export-latex-protect-amp (s)
  2218. (while (string-match "\\([^\\\\]\\)\\(&\\)" s)
  2219. (setq s (replace-match (concat (match-string 1 s) "\\" (match-string 2 s))
  2220. t t s)))
  2221. s)
  2222. (defun org-remove-initial-hash (s)
  2223. (if (string-match "\\`#" s)
  2224. (substring s 1)
  2225. s))
  2226. (defvar org-latex-entities) ; defined below
  2227. (defvar org-latex-entities-regexp) ; defined below
  2228. (defun org-export-latex-preprocess (parameters)
  2229. "Clean stuff in the LaTeX export."
  2230. ;; Replace footnotes.
  2231. (when (plist-get parameters :footnotes)
  2232. (goto-char (point-min))
  2233. (let (ref)
  2234. (while (setq ref (org-footnote-get-next-reference))
  2235. (let* ((beg (nth 1 ref))
  2236. (lbl (car ref))
  2237. (def (nth 1 (assoc (string-to-number lbl)
  2238. (mapcar (lambda (e) (cdr e))
  2239. org-export-footnotes-seen)))))
  2240. ;; Fix body for footnotes ending on a link or a list and
  2241. ;; remove definition from buffer.
  2242. (setq def
  2243. (concat def
  2244. (if (string-match "ORG-LIST-END-MARKER\\'" def)
  2245. "\n" " ")))
  2246. (org-footnote-delete-definitions lbl)
  2247. ;; Compute string to insert (FNOTE), and protect the outside
  2248. ;; macro from further transformation. When footnote at
  2249. ;; point is referring to a previously defined footnote, use
  2250. ;; \footnotemark. Otherwise, use \footnote.
  2251. (let ((fnote (if (member lbl org-export-latex-footmark-seen)
  2252. (org-export-latex-protect-string
  2253. (format "\\footnotemark[%s]" lbl))
  2254. (push lbl org-export-latex-footmark-seen)
  2255. (concat (org-export-latex-protect-string "\\footnote{")
  2256. def
  2257. (org-export-latex-protect-string "}"))))
  2258. ;; Check if another footnote is immediately following.
  2259. ;; If so, add a separator in-between.
  2260. (sep (org-export-latex-protect-string
  2261. (if (save-excursion (goto-char (1- (nth 2 ref)))
  2262. (let ((next (org-footnote-get-next-reference)))
  2263. (and next (= (nth 1 next) (nth 2 ref)))))
  2264. org-export-latex-footnote-separator ""))))
  2265. (when (org-at-heading-p)
  2266. (setq fnote (concat (org-export-latex-protect-string "\\protect")
  2267. fnote)))
  2268. ;; Ensure a footnote at column 0 cannot end a list
  2269. ;; containing it.
  2270. (put-text-property 0 (length fnote) 'original-indentation 1000 fnote)
  2271. ;; Replace footnote reference with FNOTE and, maybe, SEP.
  2272. ;; `save-excursion' is required if there are two footnotes
  2273. ;; in a row. In that case, point would be left at the
  2274. ;; beginning of the second one, and
  2275. ;; `org-footnote-get-next-reference' would then skip it.
  2276. (goto-char beg)
  2277. (delete-region beg (nth 2 ref))
  2278. (save-excursion (insert fnote sep)))))))
  2279. ;; Remove footnote section tag for LaTeX
  2280. (goto-char (point-min))
  2281. (while (re-search-forward
  2282. (concat "^" footnote-section-tag-regexp) nil t)
  2283. (org-if-unprotected
  2284. (replace-match "")))
  2285. ;; Remove any left-over footnote definition.
  2286. (mapc (lambda (fn) (org-footnote-delete-definitions (car fn)))
  2287. org-export-footnotes-data)
  2288. (mapc (lambda (fn) (org-footnote-delete-definitions fn))
  2289. org-export-latex-footmark-seen)
  2290. ;; Preserve line breaks
  2291. (goto-char (point-min))
  2292. (while (re-search-forward "\\\\\\\\" nil t)
  2293. (add-text-properties (match-beginning 0) (match-end 0)
  2294. '(org-protected t)))
  2295. ;; Preserve latex environments
  2296. (goto-char (point-min))
  2297. (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
  2298. (org-if-unprotected
  2299. (let* ((start (progn (beginning-of-line) (point)))
  2300. (end (and (re-search-forward
  2301. (concat "^[ \t]*\\\\end{"
  2302. (regexp-quote (match-string 1))
  2303. "}") nil t)
  2304. (point-at-eol))))
  2305. (if end
  2306. (add-text-properties start end '(org-protected t))
  2307. (goto-char (point-at-eol))))))
  2308. ;; Preserve math snippets
  2309. (let* ((matchers (plist-get org-format-latex-options :matchers))
  2310. (re-list org-latex-regexps)
  2311. beg end re e m n block off)
  2312. ;; Check the different regular expressions
  2313. (while (setq e (pop re-list))
  2314. (setq m (car e) re (nth 1 e) n (nth 2 e)
  2315. block (if (nth 3 e) "\n\n" ""))
  2316. (setq off (if (member m '("$" "$1")) 1 0))
  2317. (when (and (member m matchers) (not (equal m "begin")))
  2318. (goto-char (point-min))
  2319. (while (re-search-forward re nil t)
  2320. (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
  2321. (add-text-properties beg end '(org-protected t org-latex-math t))))))
  2322. ;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
  2323. (goto-char (point-min))
  2324. (let ((case-fold-search nil))
  2325. (while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
  2326. (unless (eq (char-before (match-beginning 1)) ?\\)
  2327. (org-if-unprotected-1
  2328. (replace-match (org-export-latex-protect-string
  2329. (concat "\\" (match-string 1)
  2330. "{}")) t t)))))
  2331. ;; Convert blockquotes
  2332. (goto-char (point-min))
  2333. (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
  2334. (org-replace-match-keep-properties "\\begin{quote}" t t))
  2335. (goto-char (point-min))
  2336. (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
  2337. (org-replace-match-keep-properties "\\end{quote}" t t))
  2338. ;; Convert verse
  2339. (goto-char (point-min))
  2340. (while (search-forward "ORG-VERSE-START" nil t)
  2341. (org-replace-match-keep-properties "\\begin{verse}" t t)
  2342. (beginning-of-line 2)
  2343. (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
  2344. (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
  2345. (goto-char (match-end 1))
  2346. (org-replace-match-keep-properties
  2347. (org-export-latex-protect-string
  2348. (concat "\\hspace*{1cm}" (match-string 2))) t t)
  2349. (beginning-of-line 1))
  2350. (if (looking-at "[ \t]*$")
  2351. (insert (org-export-latex-protect-string "\\vspace*{1em}"))
  2352. (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
  2353. (end-of-line 1)
  2354. (insert "\\\\")))
  2355. (beginning-of-line 2))
  2356. (and (looking-at "[ \t]*ORG-VERSE-END.*")
  2357. (org-replace-match-keep-properties "\\end{verse}" t t)))
  2358. ;; Convert #+INDEX to LaTeX \\index.
  2359. (goto-char (point-min))
  2360. (let ((case-fold-search t) entry)
  2361. (while (re-search-forward
  2362. "^[ \t]*#\\+index:[ \t]*\\([^ \t\r\n].*?\\)[ \t]*$"
  2363. nil t)
  2364. (setq entry
  2365. (save-match-data
  2366. (org-export-latex-protect-string
  2367. (org-export-latex-fontify-headline (match-string 1)))))
  2368. (replace-match (format "\\index{%s}" entry) t t)))
  2369. ;; Convert center
  2370. (goto-char (point-min))
  2371. (while (search-forward "ORG-CENTER-START" nil t)
  2372. (org-replace-match-keep-properties "\\begin{center}" t t))
  2373. (goto-char (point-min))
  2374. (while (search-forward "ORG-CENTER-END" nil t)
  2375. (org-replace-match-keep-properties "\\end{center}" t t))
  2376. (run-hooks 'org-export-latex-after-blockquotes-hook)
  2377. ;; Convert horizontal rules
  2378. (goto-char (point-min))
  2379. (while (re-search-forward "^[ \t]*-\\{5,\\}[ \t]*$" nil t)
  2380. (org-if-unprotected
  2381. (replace-match (org-export-latex-protect-string "\\hrule") t t)))
  2382. ;; Protect LaTeX commands like \command[...]{...} or \command{...}
  2383. (goto-char (point-min))
  2384. (let ((re (concat
  2385. "\\\\\\([a-zA-Z]+\\*?\\)"
  2386. "\\(?:<[^<>\n]*>\\)*"
  2387. "\\(?:\\[[^][\n]*?\\]\\)*"
  2388. "\\(?:<[^<>\n]*>\\)*"
  2389. "\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
  2390. (while (re-search-forward re nil t)
  2391. (unless (or
  2392. ;; Check for comment line.
  2393. (save-excursion (goto-char (match-beginning 0))
  2394. (org-in-indented-comment-line))
  2395. ;; Check if this is a defined entity, so that is may
  2396. ;; need conversion.
  2397. (org-entity-get (match-string 1))
  2398. ;; Do not protect interior of footnotes. Those have
  2399. ;; already been taken care of earlier in the function.
  2400. ;; Yet, keep looking inside them for more commands.
  2401. (and (equal (match-string 1) "footnote")
  2402. (goto-char (match-end 1))))
  2403. (add-text-properties (match-beginning 0) (match-end 0)
  2404. '(org-protected t)))))
  2405. ;; Special case for \nbsp
  2406. (goto-char (point-min))
  2407. (while (re-search-forward "\\\\nbsp\\({}\\|\\>\\)" nil t)
  2408. (org-if-unprotected
  2409. (replace-match (org-export-latex-protect-string "~"))))
  2410. ;; Protect LaTeX entities
  2411. (goto-char (point-min))
  2412. (while (re-search-forward org-latex-entities-regexp nil t)
  2413. (org-if-unprotected
  2414. (add-text-properties (match-beginning 0) (match-end 0)
  2415. '(org-protected t))))
  2416. ;; Replace radio links
  2417. (goto-char (point-min))
  2418. (while (re-search-forward
  2419. (concat "<<<?" org-export-latex-all-targets-re
  2420. ">>>?\\((INVISIBLE)\\)?") nil t)
  2421. (org-if-unprotected-at (+ (match-beginning 0) 2)
  2422. (replace-match
  2423. (concat
  2424. (org-export-latex-protect-string
  2425. (format "\\label{%s}" (save-match-data (org-solidify-link-text
  2426. (match-string 1)))))
  2427. (if (match-string 2) "" (match-string 1)))
  2428. t t)))
  2429. ;; Delete @<...> constructs
  2430. ;; Thanks to Daniel Clemente for this regexp
  2431. (goto-char (point-min))
  2432. (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
  2433. (org-if-unprotected
  2434. (replace-match ""))))
  2435. (defun org-export-latex-fix-inputenc ()
  2436. "Set the coding system in inputenc to what the buffer is."
  2437. (let* ((cs buffer-file-coding-system)
  2438. (opt (or (ignore-errors (latexenc-coding-system-to-inputenc cs))
  2439. "utf8")))
  2440. (when opt
  2441. ;; Translate if that is requested
  2442. (setq opt (or (cdr (assoc opt org-export-latex-inputenc-alist)) opt))
  2443. ;; find the \usepackage statement and replace the option
  2444. (goto-char (point-min))
  2445. (while (re-search-forward "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
  2446. nil t)
  2447. (goto-char (match-beginning 1))
  2448. (delete-region (match-beginning 1) (match-end 1))
  2449. (insert opt))
  2450. (and buffer-file-name
  2451. (save-buffer)))))
  2452. ;;; List handling:
  2453. (defun org-export-latex-lists ()
  2454. "Convert plain text lists in current buffer into LaTeX lists."
  2455. ;; `org-list-end-re' output has changed since preprocess from
  2456. ;; org-exp.el. Make sure it is taken into account.
  2457. (let ((org-list-end-re "^ORG-LIST-END-MARKER\n"))
  2458. (mapc
  2459. (lambda (e)
  2460. ;; For each type of context allowed for list export (E), find
  2461. ;; every list, parse it, delete it and insert resulting
  2462. ;; conversion to latex (RES), while keeping the same
  2463. ;; `original-indentation' property.
  2464. (let (res)
  2465. (goto-char (point-min))
  2466. (while (re-search-forward (org-item-beginning-re) nil t)
  2467. (when (and (eq (get-text-property (point) 'list-context) e)
  2468. (not (get-text-property (point) 'org-example)))
  2469. (beginning-of-line)
  2470. (setq res
  2471. (org-list-to-latex
  2472. ;; Narrowing is needed because we're converting
  2473. ;; from inner functions to outer ones.
  2474. (save-restriction
  2475. (narrow-to-region (point) (point-max))
  2476. (org-list-parse-list t))
  2477. org-export-latex-list-parameters))
  2478. ;; Extend previous value of original-indentation to the
  2479. ;; whole string
  2480. (insert (org-add-props res nil 'original-indentation
  2481. (org-find-text-property-in-string
  2482. 'original-indentation res)))))))
  2483. ;; List of allowed contexts for export, and the default one.
  2484. (append org-list-export-context '(nil)))))
  2485. (defconst org-latex-entities
  2486. '("\\!"
  2487. "\\'"
  2488. "\\+"
  2489. "\\,"
  2490. "\\-"
  2491. "\\:"
  2492. "\\;"
  2493. "\\<"
  2494. "\\="
  2495. "\\>"
  2496. "\\Huge"
  2497. "\\LARGE"
  2498. "\\Large"
  2499. "\\Styles"
  2500. "\\\\"
  2501. "\\`"
  2502. "\\\""
  2503. "\\addcontentsline"
  2504. "\\address"
  2505. "\\addtocontents"
  2506. "\\addtocounter"
  2507. "\\addtolength"
  2508. "\\addvspace"
  2509. "\\alph"
  2510. "\\appendix"
  2511. "\\arabic"
  2512. "\\author"
  2513. "\\begin{array}"
  2514. "\\begin{center}"
  2515. "\\begin{description}"
  2516. "\\begin{enumerate}"
  2517. "\\begin{eqnarray}"
  2518. "\\begin{equation}"
  2519. "\\begin{figure}"
  2520. "\\begin{flushleft}"
  2521. "\\begin{flushright}"
  2522. "\\begin{itemize}"
  2523. "\\begin{list}"
  2524. "\\begin{minipage}"
  2525. "\\begin{picture}"
  2526. "\\begin{quotation}"
  2527. "\\begin{quote}"
  2528. "\\begin{tabbing}"
  2529. "\\begin{table}"
  2530. "\\begin{tabular}"
  2531. "\\begin{thebibliography}"
  2532. "\\begin{theorem}"
  2533. "\\begin{titlepage}"
  2534. "\\begin{verbatim}"
  2535. "\\begin{verse}"
  2536. "\\bf"
  2537. "\\bf"
  2538. "\\bibitem"
  2539. "\\bigskip"
  2540. "\\cdots"
  2541. "\\centering"
  2542. "\\circle"
  2543. "\\cite"
  2544. "\\cleardoublepage"
  2545. "\\clearpage"
  2546. "\\cline"
  2547. "\\closing"
  2548. "\\dashbox"
  2549. "\\date"
  2550. "\\ddots"
  2551. "\\dotfill"
  2552. "\\em"
  2553. "\\fbox"
  2554. "\\flushbottom"
  2555. "\\fnsymbol"
  2556. "\\footnote"
  2557. "\\footnotemark"
  2558. "\\footnotesize"
  2559. "\\footnotetext"
  2560. "\\frac"
  2561. "\\frame"
  2562. "\\framebox"
  2563. "\\hfill"
  2564. "\\hline"
  2565. "\\hrulespace"
  2566. "\\hspace"
  2567. "\\huge"
  2568. "\\hyphenation"
  2569. "\\include"
  2570. "\\includeonly"
  2571. "\\indent"
  2572. "\\input"
  2573. "\\it"
  2574. "\\kill"
  2575. "\\label"
  2576. "\\large"
  2577. "\\ldots"
  2578. "\\line"
  2579. "\\linebreak"
  2580. "\\linethickness"
  2581. "\\listoffigures"
  2582. "\\listoftables"
  2583. "\\location"
  2584. "\\makebox"
  2585. "\\maketitle"
  2586. "\\mark"
  2587. "\\mbox"
  2588. "\\medskip"
  2589. "\\multicolumn"
  2590. "\\multiput"
  2591. "\\newcommand"
  2592. "\\newcounter"
  2593. "\\newenvironment"
  2594. "\\newfont"
  2595. "\\newlength"
  2596. "\\newline"
  2597. "\\newpage"
  2598. "\\newsavebox"
  2599. "\\newtheorem"
  2600. "\\nocite"
  2601. "\\nofiles"
  2602. "\\noindent"
  2603. "\\nolinebreak"
  2604. "\\nopagebreak"
  2605. "\\normalsize"
  2606. "\\onecolumn"
  2607. "\\opening"
  2608. "\\oval"
  2609. "\\overbrace"
  2610. "\\overline"
  2611. "\\pagebreak"
  2612. "\\pagenumbering"
  2613. "\\pageref"
  2614. "\\pagestyle"
  2615. "\\par"
  2616. "\\parbox"
  2617. "\\put"
  2618. "\\raggedbottom"
  2619. "\\raggedleft"
  2620. "\\raggedright"
  2621. "\\raisebox"
  2622. "\\ref"
  2623. "\\rm"
  2624. "\\roman"
  2625. "\\rule"
  2626. "\\savebox"
  2627. "\\sc"
  2628. "\\scriptsize"
  2629. "\\setcounter"
  2630. "\\setlength"
  2631. "\\settowidth"
  2632. "\\sf"
  2633. "\\shortstack"
  2634. "\\signature"
  2635. "\\sl"
  2636. "\\small"
  2637. "\\smallskip"
  2638. "\\sqrt"
  2639. "\\tableofcontents"
  2640. "\\telephone"
  2641. "\\thanks"
  2642. "\\thispagestyle"
  2643. "\\tiny"
  2644. "\\title"
  2645. "\\tt"
  2646. "\\twocolumn"
  2647. "\\typein"
  2648. "\\typeout"
  2649. "\\underbrace"
  2650. "\\underline"
  2651. "\\usebox"
  2652. "\\usecounter"
  2653. "\\value"
  2654. "\\vdots"
  2655. "\\vector"
  2656. "\\verb"
  2657. "\\vfill"
  2658. "\\vline"
  2659. "\\vspace")
  2660. "A list of LaTeX commands to be protected when performing conversion.")
  2661. (defconst org-latex-entities-regexp
  2662. (let (names rest)
  2663. (dolist (x org-latex-entities)
  2664. (if (string-match "[a-zA-Z]$" x)
  2665. (push x names)
  2666. (push x rest)))
  2667. (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
  2668. "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
  2669. (provide 'org-export-latex)
  2670. (provide 'org-latex)
  2671. ;;; org-latex.el ends here