org-latex.el 103 KB

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