org-latex.el 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976
  1. ;;; org-latex.el --- LaTeX exporter for org-mode
  2. ;;
  3. ;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
  4. ;;
  5. ;; Emacs Lisp Archive Entry
  6. ;; Filename: org-latex.el
  7. ;; Version: 6.30trans
  8. ;; Author: Bastien Guerry <bzg AT altern DOT org>
  9. ;; Maintainer: Carsten Dominik <carsten.dominik AT gmail DOT com>
  10. ;; Keywords: org, wp, tex
  11. ;; Description: Converts an org-mode buffer into LaTeX
  12. ;; This file is part of GNU Emacs.
  13. ;; GNU Emacs is free software: you can redistribute it and/or modify
  14. ;; it under the terms of the GNU General Public License as published by
  15. ;; the Free Software Foundation, either version 3 of the License, or
  16. ;; (at your option) any later version.
  17. ;; GNU Emacs is distributed in the hope that it will be useful,
  18. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. ;; GNU General Public License for more details.
  21. ;; You should have received a copy of the GNU General Public License
  22. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  23. ;;; Commentary:
  24. ;;
  25. ;; This library implements a LaTeX exporter for org-mode.
  26. ;;
  27. ;; It is part of Org and will be autoloaded
  28. ;;
  29. ;; The interactive functions are similar to those of the HTML exporter:
  30. ;;
  31. ;; M-x `org-export-as-latex'
  32. ;; M-x `org-export-as-pdf'
  33. ;; M-x `org-export-as-pdf-and-open'
  34. ;; M-x `org-export-as-latex-batch'
  35. ;; M-x `org-export-as-latex-to-buffer'
  36. ;; M-x `org-export-region-as-latex'
  37. ;; M-x `org-replace-region-by-latex'
  38. ;;
  39. ;;; Code:
  40. (eval-when-compile
  41. (require 'cl))
  42. (require 'footnote)
  43. (require 'org)
  44. (require 'org-exp)
  45. ;;; Variables:
  46. (defvar org-export-latex-class nil)
  47. (defvar org-export-latex-header nil)
  48. (defvar org-export-latex-append-header nil)
  49. (defvar org-export-latex-options-plist nil)
  50. (defvar org-export-latex-todo-keywords-1 nil)
  51. (defvar org-export-latex-complex-heading-re nil)
  52. (defvar org-export-latex-not-done-keywords nil)
  53. (defvar org-export-latex-done-keywords nil)
  54. (defvar org-export-latex-display-custom-times nil)
  55. (defvar org-export-latex-all-targets-re nil)
  56. (defvar org-export-latex-add-level 0)
  57. (defvar org-export-latex-sectioning "")
  58. (defvar org-export-latex-sectioning-depth 0)
  59. (defvar org-export-latex-special-keyword-regexp
  60. (concat "\\<\\(" org-scheduled-string "\\|"
  61. org-deadline-string "\\|"
  62. org-closed-string"\\)")
  63. "Regexp matching special time planning keywords plus the time after it.")
  64. (defvar latexp) ; dynamically scoped from org.el
  65. (defvar re-quote) ; dynamically scoped from org.el
  66. (defvar commentsp) ; dynamically scoped from org.el
  67. ;;; User variables:
  68. (defgroup org-export-latex nil
  69. "Options for exporting Org-mode files to LaTeX."
  70. :tag "Org Export LaTeX"
  71. :group 'org-export)
  72. (defcustom org-export-latex-default-class "article"
  73. "The default LaTeX class."
  74. :group 'org-export-latex
  75. :type '(string :tag "LaTeX class"))
  76. (defcustom org-export-latex-classes
  77. '(("article"
  78. "\\documentclass[11pt]{article}
  79. \\usepackage[utf8]{inputenc}
  80. \\usepackage[T1]{fontenc}
  81. \\usepackage{graphicx}
  82. \\usepackage{longtable}
  83. \\usepackage{soul}
  84. \\usepackage{hyperref}"
  85. ("\\section{%s}" . "\\section*{%s}")
  86. ("\\subsection{%s}" . "\\subsection*{%s}")
  87. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
  88. ("\\paragraph{%s}" . "\\paragraph*{%s}")
  89. ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
  90. ("report"
  91. "\\documentclass[11pt]{report}
  92. \\usepackage[utf8]{inputenc}
  93. \\usepackage[T1]{fontenc}
  94. \\usepackage{graphicx}
  95. \\usepackage{longtable}
  96. \\usepackage{soul}
  97. \\usepackage{hyperref}"
  98. ("\\part{%s}" . "\\part*{%s}")
  99. ("\\chapter{%s}" . "\\chapter*{%s}")
  100. ("\\section{%s}" . "\\section*{%s}")
  101. ("\\subsection{%s}" . "\\subsection*{%s}")
  102. ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
  103. ("book"
  104. "\\documentclass[11pt]{book}
  105. \\usepackage[utf8]{inputenc}
  106. \\usepackage[T1]{fontenc}
  107. \\usepackage{graphicx}
  108. \\usepackage{longtable}
  109. \\usepackage{soul}
  110. \\usepackage{hyperref}"
  111. ("\\part{%s}" . "\\part*{%s}")
  112. ("\\chapter{%s}" . "\\chapter*{%s}")
  113. ("\\section{%s}" . "\\section*{%s}")
  114. ("\\subsection{%s}" . "\\subsection*{%s}")
  115. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
  116. "Alist of LaTeX classes and associated header and structure.
  117. If #+LaTeX_CLASS is set in the buffer, use its value and the
  118. associated information. Here is the structure of each cell:
  119. \(class-name
  120. header-string
  121. (numbered-section . unnumbered-section\)
  122. ...\)
  123. A %s formatter is mandatory in each section string and will be
  124. replaced by the title of the section.
  125. Instead of a cons cell (numbered . unnumbered), you can also provide a list
  126. of 2-4 elements,
  127. (numbered-open numbered-close)
  128. or
  129. (numbered-open numbered-close unnumbered-open unnumbered-close)
  130. providing opening and closing strings for an environment that should
  131. represent the document section. The opening clause should have a %s
  132. to represent the section title."
  133. :group 'org-export-latex
  134. :type '(repeat
  135. (list (string :tag "LaTeX class")
  136. (string :tag "LaTeX header")
  137. (repeat :tag "Levels" :inline t
  138. (choice
  139. (cons :tag "Heading"
  140. (string :tag "numbered")
  141. (string :tag "unnumbered)"))
  142. (list :tag "Environment"
  143. (string :tag "Opening (numbered) ")
  144. (string :tag "Closing (numbered) ")
  145. (string :tag "Opening (unnumbered)")
  146. (string :tag "Closing (unnumbered)")))))))
  147. (defcustom org-export-latex-emphasis-alist
  148. '(("*" "\\textbf{%s}" nil)
  149. ("/" "\\emph{%s}" nil)
  150. ("_" "\\underline{%s}" nil)
  151. ("+" "\\st{%s}" nil)
  152. ("=" "\\verb" t)
  153. ("~" "\\verb" t))
  154. "Alist of LaTeX expressions to convert emphasis fontifiers.
  155. Each element of the list is a list of three elements.
  156. The first element is the character used as a marker for fontification.
  157. The second element is a formatting string to wrap fontified text with.
  158. If it is \"\\verb\", Org will automatically select a deimiter
  159. character that is not in the string.
  160. The third element decides whether to protect converted text from other
  161. conversions."
  162. :group 'org-export-latex
  163. :type 'alist)
  164. (defcustom org-export-latex-title-command "\\maketitle"
  165. "The command used to insert the title just after \\begin{document}.
  166. If this string contains the formatting specification \"%s\" then
  167. it will be used as a formatting string, passing the title as an
  168. argument."
  169. :group 'org-export-latex
  170. :type 'string)
  171. (defcustom org-export-latex-import-inbuffer-stuff nil
  172. "Non-nil means define TeX macros for Org's inbuffer definitions.
  173. For example \orgTITLE for #+TITLE."
  174. :group 'org-export-latex
  175. :type 'boolean)
  176. (defcustom org-export-latex-date-format
  177. "%d %B %Y"
  178. "Format string for \\date{...}."
  179. :group 'org-export-latex
  180. :type 'string)
  181. (defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
  182. "Markup for TODO keywords, as a printf format.
  183. This can be a single format for all keywords, a cons cell with separate
  184. formats for not-done and done states, or an association list with setup
  185. for individual keywords. If a keyword shows up for which there is no
  186. markup defined, the first one in the association list will be used."
  187. :group 'org-export-latex
  188. :type '(choice
  189. (string :tag "Default")
  190. (cons :tag "Distinguish undone and done"
  191. (string :tag "Not-DONE states")
  192. (string :tag "DONE states"))
  193. (repeat :tag "Per keyword markup"
  194. (cons
  195. (string :tag "Keyword")
  196. (string :tag "Markup")))))
  197. (defcustom org-export-latex-timestamp-markup "\\textit{%s}"
  198. "A printf format string to be applied to time stamps."
  199. :group 'org-export-latex
  200. :type 'string)
  201. (defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
  202. "A printf format string to be applied to time stamps."
  203. :group 'org-export-latex
  204. :type 'string)
  205. (defcustom org-export-latex-tables-verbatim nil
  206. "When non-nil, tables are exported verbatim."
  207. :group 'org-export-latex
  208. :type 'boolean)
  209. (defcustom org-export-latex-tables-centered t
  210. "When non-nil, tables are exported in a center environment."
  211. :group 'org-export-latex
  212. :type 'boolean)
  213. (defcustom org-export-latex-tables-column-borders nil
  214. "When non-nil, grouping columns can cause outer vertical lines in tables.
  215. When nil, grouping causes only separation lines between groups."
  216. :group 'org-export-latex
  217. :type 'boolean)
  218. (defcustom org-export-latex-packages-alist nil
  219. "Alist of packages to be inserted in the header.
  220. Each cell is of the format \( \"option\" . \"package\" \)."
  221. :group 'org-export-latex
  222. :type '(repeat
  223. (list
  224. (string :tag "option")
  225. (string :tag "package"))))
  226. (defcustom org-export-latex-low-levels 'itemize
  227. "How to convert sections below the current level of sectioning.
  228. This is specified by the `org-export-headline-levels' option or the
  229. value of \"H:\" in Org's #+OPTION line.
  230. This can be either nil (skip the sections), `description', `itemize',
  231. or `enumerate' (convert the sections as the corresponding list type), or
  232. a string to be used instead of \\section{%s}. In this latter case,
  233. the %s stands here for the inserted headline and is mandatory.
  234. It may also be a list of three string to define a user-defined environment
  235. that should be used. The first string should be the like
  236. \"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
  237. to two occurrences of %s for the title and a lable, respectively. The third
  238. string should be like \"\\end{itemize\"."
  239. :group 'org-export-latex
  240. :type '(choice (const :tag "Ignore" nil)
  241. (const :tag "Convert as descriptive list" description)
  242. (const :tag "Convert as itemized list" itemize)
  243. (const :tag "Convert as enumerated list" enumerate)
  244. (list :tag "User-defined environment"
  245. :value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
  246. (string :tag "Start")
  247. (string :tag "End")
  248. (string :tag "item"))
  249. (string :tag "Use a section string" :value "\\subparagraph{%s}")))
  250. (defcustom org-export-latex-list-parameters
  251. '(:cbon "\\texttt{[X]}" :cboff "\\texttt{[ ]}")
  252. "Parameters for the LaTeX list exporter.
  253. These parameters will be passed on to `org-list-to-latex', which in turn
  254. will pass them (combined with the LaTeX default list parameters) to
  255. `org-list-to-generic'."
  256. :group 'org-export-latex
  257. :type 'plist)
  258. (defcustom org-export-latex-verbatim-wrap
  259. '("\\begin{verbatim}\n" . "\\end{verbatim}\n")
  260. "Environment to be wrapped around a fixed-width section in LaTeX export.
  261. This is a cons with two strings, to be added before and after the
  262. fixed-with text.
  263. Defaults to \\begin{verbatim} and \\end{verbatim}."
  264. :group 'org-export-translation
  265. :group 'org-export-latex
  266. :type '(cons (string :tag "Open")
  267. (string :tag "Close")))
  268. (defcustom org-export-latex-listings nil
  269. "Non-nil means, export source code using the listings package.
  270. This package will fontify source code, possibly even with color.
  271. If you want to use this, you also need to make LaTeX use the
  272. listings package, and if you want to have color, the color
  273. package. Just add these to `org-export-latex-packages-alist',
  274. for example using customize, or with something like
  275. (require 'org-latex)
  276. (add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
  277. (add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))"
  278. :group 'org-export-latex
  279. :type 'boolean)
  280. (defcustom org-export-latex-listings-langs
  281. '((emacs-lisp "Lisp") (lisp "Lisp")
  282. (c "C") (cc "C++")
  283. (fortran "fortran")
  284. (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
  285. (html "HTML") (xml "XML")
  286. (tex "TeX") (latex "TeX")
  287. (shell-script "bash")
  288. (gnuplot "Gnuplot")
  289. (ocaml "Caml") (caml "Caml")
  290. (sql "SQL"))
  291. "Alist mapping languages to their listing language counterpart.
  292. The key is a symbol, the major mode symbol without the \"-mode\".
  293. The value is the string that should be inserted as the language parameter
  294. for the listings package. If the mode name and the listings name are
  295. the same, the language does not need an entry in this list - but it does not
  296. hurt if it is present."
  297. :group 'org-export-latex
  298. :type '(repeat
  299. (list
  300. (symbol :tag "Major mode ")
  301. (string :tag "Listings language"))))
  302. (defcustom org-export-latex-remove-from-headlines
  303. '(:todo nil :priority nil :tags nil)
  304. "A plist of keywords to remove from headlines. OBSOLETE.
  305. Non-nil means remove this keyword type from the headline.
  306. Don't remove the keys, just change their values.
  307. Obsolete, this variable is no longer used. Use the separate
  308. variables `org-export-with-todo-keywords', `org-export-with-priority',
  309. and `org-export-with-tags' instead."
  310. :type 'plist
  311. :group 'org-export-latex)
  312. (defcustom org-export-latex-image-default-option "width=10em"
  313. "Default option for images."
  314. :group 'org-export-latex
  315. :type 'string)
  316. (defcustom org-export-latex-inline-image-extensions
  317. '("pdf" "jpeg" "jpg" "png" "ps" "eps")
  318. "Extensions of image files that can be inlined into LaTeX.
  319. Note that the image extension *actually* allowed depend on the way the
  320. LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
  321. are OK. When processing through dvi to Postscript, only ps and eps are
  322. allowed. The default we use here encompasses both."
  323. :group 'org-export-latex
  324. :type '(repeat (string :tag "Extension")))
  325. (defcustom org-export-latex-coding-system nil
  326. "Coding system for the exported LaTex file."
  327. :group 'org-export-latex
  328. :type 'coding-system)
  329. (defgroup org-export-pdf nil
  330. "Options for exporting Org-mode files to PDF, via LaTeX."
  331. :tag "Org Export LaTeX"
  332. :group 'org-export-latex
  333. :group 'org-export)
  334. (defcustom org-latex-to-pdf-process
  335. '("pdflatex -interaction nonstopmode %s"
  336. "pdflatex -interaction nonstopmode %s")
  337. "Commands to process a LaTeX file to a PDF file.
  338. This is a list of strings, each of them will be given to the shell
  339. as a command. %s in the command will be replaced by the full file name, %b
  340. by the file base name (i.e. without extension).
  341. The reason why this is a list is that it usually takes several runs of
  342. pdflatex, maybe mixed with a call to bibtex. Org does not have a clever
  343. mechanism to detect whihc of these commands have to be run to get to a stable
  344. result, and it also does not do any error checking.
  345. Alternatively, this may be a Lisp function that does the processing, so you
  346. could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
  347. THis function should accept the file name as its single argument."
  348. :group 'org-export-latex
  349. :type '(choice (repeat :tag "Shell command sequence"
  350. (string :tag "Shell command"))
  351. (function)))
  352. (defcustom org-export-pdf-remove-logfiles t
  353. "Non-nil means, remove the logfiles produced by PDF production.
  354. These are the .aux, .log, .out, and .toc files."
  355. :group 'org-export-pdf
  356. :type 'boolean)
  357. ;;; Hooks
  358. (defvar org-export-latex-after-blockquotes-hook nil
  359. "Hook run during LaTeX export, after blockquote, verse, center are done.")
  360. ;;; Autoload functions:
  361. ;;;###autoload
  362. (defun org-export-as-latex-batch ()
  363. "Call `org-export-as-latex', may be used in batch processing.
  364. For example:
  365. emacs --batch
  366. --load=$HOME/lib/emacs/org.el
  367. --eval \"(setq org-export-headline-levels 2)\"
  368. --visit=MyFile --funcall org-export-as-latex-batch"
  369. (org-export-as-latex org-export-headline-levels 'hidden))
  370. ;;;###autoload
  371. (defun org-export-as-latex-to-buffer (arg)
  372. "Call `org-export-as-latex` with output to a temporary buffer.
  373. No file is created. The prefix ARG is passed through to `org-export-as-latex'."
  374. (interactive "P")
  375. (org-export-as-latex arg nil nil "*Org LaTeX Export*")
  376. (when org-export-show-temporary-export-buffer
  377. (switch-to-buffer-other-window "*Org LaTeX Export*")))
  378. ;;;###autoload
  379. (defun org-replace-region-by-latex (beg end)
  380. "Replace the region from BEG to END with its LaTeX export.
  381. It assumes the region has `org-mode' syntax, and then convert it to
  382. LaTeX. This can be used in any buffer. For example, you could
  383. write an itemized list in `org-mode' syntax in an LaTeX buffer and
  384. then use this command to convert it."
  385. (interactive "r")
  386. (let (reg latex buf)
  387. (save-window-excursion
  388. (if (org-mode-p)
  389. (setq latex (org-export-region-as-latex
  390. beg end t 'string))
  391. (setq reg (buffer-substring beg end)
  392. buf (get-buffer-create "*Org tmp*"))
  393. (save-excursion
  394. (set-buffer buf)
  395. (erase-buffer)
  396. (insert reg)
  397. (org-mode)
  398. (setq latex (org-export-region-as-latex
  399. (point-min) (point-max) t 'string)))
  400. (kill-buffer buf)))
  401. (delete-region beg end)
  402. (insert latex)))
  403. ;;;###autoload
  404. (defun org-export-region-as-latex (beg end &optional body-only buffer)
  405. "Convert region from BEG to END in `org-mode' buffer to LaTeX.
  406. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  407. contents, and only produce the region of converted text, useful for
  408. cut-and-paste operations.
  409. If BUFFER is a buffer or a string, use/create that buffer as a target
  410. of the converted LaTeX. If BUFFER is the symbol `string', return the
  411. produced LaTeX as a string and leave no buffer behind. For example,
  412. a Lisp program could call this function in the following way:
  413. (setq latex (org-export-region-as-latex beg end t 'string))
  414. When called interactively, the output buffer is selected, and shown
  415. in a window. A non-interactive call will only return the buffer."
  416. (interactive "r\nP")
  417. (when (interactive-p)
  418. (setq buffer "*Org LaTeX Export*"))
  419. (let ((transient-mark-mode t) (zmacs-regions t)
  420. ext-plist rtn)
  421. (setq ext-plist (plist-put ext-plist :ignore-subree-p t))
  422. (goto-char end)
  423. (set-mark (point)) ;; to activate the region
  424. (goto-char beg)
  425. (setq rtn (org-export-as-latex
  426. nil nil ext-plist
  427. buffer body-only))
  428. (if (fboundp 'deactivate-mark) (deactivate-mark))
  429. (if (and (interactive-p) (bufferp rtn))
  430. (switch-to-buffer-other-window rtn)
  431. rtn)))
  432. ;;;###autoload
  433. (defun org-export-as-latex (arg &optional hidden ext-plist
  434. to-buffer body-only pub-dir)
  435. "Export current buffer to a LaTeX file.
  436. If there is an active region, export only the region. The prefix
  437. ARG specifies how many levels of the outline should become
  438. headlines. The default is 3. Lower levels will be exported
  439. depending on `org-export-latex-low-levels'. The default is to
  440. convert them as description lists.
  441. HIDDEN is obsolete and does nothing.
  442. EXT-PLIST is a property list with
  443. external parameters overriding org-mode's default settings, but
  444. still inferior to file-local settings. When TO-BUFFER is
  445. non-nil, create a buffer with that name and export to that
  446. buffer. If TO-BUFFER is the symbol `string', don't leave any
  447. buffer behind but just return the resulting LaTeX as a string.
  448. When BODY-ONLY is set, don't produce the file header and footer,
  449. simply return the content of \begin{document}...\end{document},
  450. without even the \begin{document} and \end{document} commands.
  451. when PUB-DIR is set, use this as the publishing directory."
  452. (interactive "P")
  453. ;; Make sure we have a file name when we need it.
  454. (when (and (not (or to-buffer body-only))
  455. (not buffer-file-name))
  456. (if (buffer-base-buffer)
  457. (org-set-local 'buffer-file-name
  458. (with-current-buffer (buffer-base-buffer)
  459. buffer-file-name))
  460. (error "Need a file name to be able to export")))
  461. (message "Exporting to LaTeX...")
  462. (org-unmodified
  463. (remove-text-properties (point-min) (point-max)
  464. '(:org-license-to-kill nil)))
  465. (org-update-radio-target-regexp)
  466. (org-export-latex-set-initial-vars ext-plist arg)
  467. (let* ((wcf (current-window-configuration))
  468. (opt-plist org-export-latex-options-plist)
  469. (region-p (org-region-active-p))
  470. (rbeg (and region-p (region-beginning)))
  471. (rend (and region-p (region-end)))
  472. (subtree-p
  473. (if (plist-get opt-plist :ignore-subree-p)
  474. nil
  475. (when region-p
  476. (save-excursion
  477. (goto-char rbeg)
  478. (and (org-at-heading-p)
  479. (>= (org-end-of-subtree t t) rend))))))
  480. (opt-plist (setq org-export-opt-plist
  481. (if subtree-p
  482. (org-export-add-subtree-options opt-plist rbeg)
  483. opt-plist)))
  484. ;; Make sure the variable contains the updated values.
  485. (org-export-latex-options-plist opt-plist)
  486. (title (or (and subtree-p (org-export-get-title-from-subtree))
  487. (plist-get opt-plist :title)
  488. (and (not
  489. (plist-get opt-plist :skip-before-1st-heading))
  490. (org-export-grab-title-from-buffer))
  491. (file-name-sans-extension
  492. (file-name-nondirectory buffer-file-name))))
  493. (filename (concat (file-name-as-directory
  494. (or pub-dir
  495. (org-export-directory :LaTeX ext-plist)))
  496. (file-name-sans-extension
  497. (or (and subtree-p
  498. (org-entry-get rbeg "EXPORT_FILE_NAME" t))
  499. (file-name-nondirectory ;sans-extension
  500. buffer-file-name)))
  501. ".tex"))
  502. (filename (if (equal (file-truename filename)
  503. (file-truename buffer-file-name))
  504. (concat filename ".tex")
  505. filename))
  506. (buffer (if to-buffer
  507. (cond
  508. ((eq to-buffer 'string) (get-buffer-create
  509. "*Org LaTeX Export*"))
  510. (t (get-buffer-create to-buffer)))
  511. (find-file-noselect filename)))
  512. (odd org-odd-levels-only)
  513. (header (org-export-latex-make-header title opt-plist))
  514. (skip (cond (subtree-p nil)
  515. (region-p nil)
  516. (t (plist-get opt-plist :skip-before-1st-heading))))
  517. (text (plist-get opt-plist :text))
  518. (org-export-preprocess-hook
  519. (cons
  520. `(lambda () (org-set-local 'org-complex-heading-regexp
  521. ,org-export-latex-complex-heading-re))
  522. org-export-preprocess-hook))
  523. (first-lines (if skip "" (org-export-latex-first-lines
  524. opt-plist
  525. (if subtree-p
  526. (save-excursion
  527. (goto-char rbeg)
  528. (point-at-bol 2))
  529. rbeg)
  530. (if region-p rend))))
  531. (coding-system (and (boundp 'buffer-file-coding-system)
  532. buffer-file-coding-system))
  533. (coding-system-for-write (or org-export-latex-coding-system
  534. coding-system))
  535. (save-buffer-coding-system (or org-export-latex-coding-system
  536. coding-system))
  537. (region (buffer-substring
  538. (if region-p (region-beginning) (point-min))
  539. (if region-p (region-end) (point-max))))
  540. (string-for-export
  541. (org-export-preprocess-string
  542. region
  543. :emph-multiline t
  544. :for-LaTeX t
  545. :comments nil
  546. :tags (plist-get opt-plist :tags)
  547. :priority (plist-get opt-plist :priority)
  548. :footnotes (plist-get opt-plist :footnotes)
  549. :timestamps (plist-get opt-plist :timestamps)
  550. :todo-keywords (plist-get opt-plist :todo-keywords)
  551. :add-text (if (eq to-buffer 'string) nil text)
  552. :skip-before-1st-heading skip
  553. :select-tags (plist-get opt-plist :select-tags)
  554. :exclude-tags (plist-get opt-plist :exclude-tags)
  555. :LaTeX-fragments nil)))
  556. (set-buffer buffer)
  557. (erase-buffer)
  558. (org-install-letbind)
  559. (and (fboundp 'set-buffer-file-coding-system)
  560. (set-buffer-file-coding-system coding-system-for-write))
  561. ;; insert the header and initial document commands
  562. (unless (or (eq to-buffer 'string) body-only)
  563. (insert header))
  564. ;; insert text found in #+TEXT
  565. (when (and text (not (eq to-buffer 'string)))
  566. (insert (org-export-latex-content
  567. text '(lists tables fixed-width keywords))
  568. "\n\n"))
  569. ;; insert lines before the first headline
  570. (unless skip
  571. (insert first-lines))
  572. ;; export the content of headlines
  573. (org-export-latex-global
  574. (with-temp-buffer
  575. (insert string-for-export)
  576. (goto-char (point-min))
  577. (when (re-search-forward "^\\(\\*+\\) " nil t)
  578. (let* ((asters (length (match-string 1)))
  579. (level (if odd (- asters 2) (- asters 1))))
  580. (setq org-export-latex-add-level
  581. (if odd (1- (/ (1+ asters) 2)) (1- asters)))
  582. (org-export-latex-parse-global level odd)))))
  583. ;; finalization
  584. (unless body-only (insert "\n\\end{document}"))
  585. ;; Relocate the table of contents
  586. (goto-char (point-min))
  587. (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
  588. (goto-char (point-min))
  589. (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
  590. (replace-match ""))
  591. (goto-char (point-min))
  592. (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
  593. (replace-match "\\tableofcontents" t t)))
  594. (or to-buffer (save-buffer))
  595. (goto-char (point-min))
  596. (or (org-export-push-to-kill-ring "LaTeX")
  597. (message "Exporting to LaTeX...done"))
  598. (prog1
  599. (if (eq to-buffer 'string)
  600. (prog1 (buffer-substring (point-min) (point-max))
  601. (kill-buffer (current-buffer)))
  602. (current-buffer))
  603. (set-window-configuration wcf))))
  604. ;;;###autoload
  605. (defun org-export-as-pdf (arg &optional hidden ext-plist
  606. to-buffer body-only pub-dir)
  607. "Export as LaTeX, then process through to PDF."
  608. (interactive "P")
  609. (message "Exporting to PDF...")
  610. (let* ((wconfig (current-window-configuration))
  611. (lbuf (org-export-as-latex arg hidden ext-plist
  612. to-buffer body-only pub-dir))
  613. (file (buffer-file-name lbuf))
  614. (base (file-name-sans-extension (buffer-file-name lbuf)))
  615. (pdffile (concat base ".pdf"))
  616. (cmds org-latex-to-pdf-process)
  617. (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
  618. (bibtex-p (with-current-buffer lbuf
  619. (save-excursion
  620. (goto-char (point-min))
  621. (re-search-forward "\\\\bibliography{" nil t))))
  622. cmd)
  623. (with-current-buffer outbuf (erase-buffer))
  624. (and (file-exists-p pdffile) (delete-file pdffile))
  625. (message "Processing LaTeX file...")
  626. (if (and cmds (symbolp cmds))
  627. (funcall cmds file)
  628. (while cmds
  629. (setq cmd (pop cmds))
  630. (while (string-match "%b" cmd)
  631. (setq cmd (replace-match
  632. (save-match-data
  633. (shell-quote-argument base))
  634. t t cmd)))
  635. (while (string-match "%s" cmd)
  636. (setq cmd (replace-match
  637. (save-match-data
  638. (shell-quote-argument file))
  639. t t cmd)))
  640. (shell-command cmd outbuf outbuf)))
  641. (message "Processing LaTeX file...done")
  642. (if (not (file-exists-p pdffile))
  643. (error "PDF file was not produced")
  644. (set-window-configuration wconfig)
  645. (when org-export-pdf-remove-logfiles
  646. (dolist (ext '("aux" "log" "out" "toc"))
  647. (setq file (concat base "." ext))
  648. (and (file-exists-p file) (delete-file file))))
  649. (message "Exporting to PDF...done")
  650. pdffile)))
  651. ;;;###autoload
  652. (defun org-export-as-pdf-and-open (arg)
  653. "Export as LaTeX, then process through to PDF, and open."
  654. (interactive "P")
  655. (let ((pdffile (org-export-as-pdf arg)))
  656. (if pdffile
  657. (org-open-file pdffile)
  658. (error "PDF file was not produced"))))
  659. ;;; Parsing functions:
  660. (defun org-export-latex-parse-global (level odd)
  661. "Parse the current buffer recursively, starting at LEVEL.
  662. If ODD is non-nil, assume the buffer only contains odd sections.
  663. Return a list reflecting the document structure."
  664. (save-excursion
  665. (goto-char (point-min))
  666. (let* ((cnt 0) output
  667. (depth org-export-latex-sectioning-depth))
  668. (while (re-search-forward
  669. (concat "^\\(\\(?:\\*\\)\\{"
  670. (number-to-string (+ (if odd 2 1) level))
  671. "\\}\\) \\(.*\\)$")
  672. ;; make sure that there is no upper heading
  673. (when (> level 0)
  674. (save-excursion
  675. (save-match-data
  676. (re-search-forward
  677. (concat "^\\(\\(?:\\*\\)\\{"
  678. (number-to-string level)
  679. "\\}\\) \\(.*\\)$") nil t)))) t)
  680. (setq cnt (1+ cnt))
  681. (let* ((pos (match-beginning 0))
  682. (heading (match-string 2))
  683. (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
  684. (save-excursion
  685. (narrow-to-region
  686. (point)
  687. (save-match-data
  688. (if (re-search-forward
  689. (concat "^\\(\\(?:\\*\\)\\{"
  690. (number-to-string (+ (if odd 2 1) level))
  691. "\\}\\) \\(.*\\)$") nil t)
  692. (match-beginning 0)
  693. (point-max))))
  694. (goto-char (point-min))
  695. (setq output
  696. (append output
  697. (list
  698. (list
  699. `(pos . ,pos)
  700. `(level . ,nlevel)
  701. `(occur . ,cnt)
  702. `(heading . ,heading)
  703. `(content . ,(org-export-latex-parse-content))
  704. `(subcontent . ,(org-export-latex-parse-subcontent
  705. level odd)))))))
  706. (widen)))
  707. (list output))))
  708. (defun org-export-latex-parse-content ()
  709. "Extract the content of a section."
  710. (let ((beg (point))
  711. (end (if (re-search-forward "^\\(\\*\\)+ .*$" nil t)
  712. (progn (beginning-of-line) (point))
  713. (point-max))))
  714. (buffer-substring beg end)))
  715. (defun org-export-latex-parse-subcontent (level odd)
  716. "Extract the subcontent of a section at LEVEL.
  717. If ODD Is non-nil, assume subcontent only contains odd sections."
  718. (if (not (re-search-forward
  719. (concat "^\\(\\(?:\\*\\)\\{"
  720. (number-to-string (+ (if odd 4 2) level))
  721. "\\}\\) \\(.*\\)$")
  722. nil t))
  723. nil ; subcontent is nil
  724. (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
  725. ;;; Rendering functions:
  726. (defun org-export-latex-global (content)
  727. "Export CONTENT to LaTeX.
  728. CONTENT is an element of the list produced by
  729. `org-export-latex-parse-global'."
  730. (if (eq (car content) 'subcontent)
  731. (mapc 'org-export-latex-sub (cdr content))
  732. (org-export-latex-sub (car content))))
  733. (defun org-export-latex-sub (subcontent)
  734. "Export the list SUBCONTENT to LaTeX.
  735. SUBCONTENT is an alist containing information about the headline
  736. and its content."
  737. (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
  738. (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
  739. (defun org-export-latex-subcontent (subcontent num)
  740. "Export each cell of SUBCONTENT to LaTeX.
  741. If NUM, export sections as numerical sections."
  742. (let* ((heading (org-export-latex-fontify-headline
  743. (cdr (assoc 'heading subcontent))))
  744. (level (- (cdr (assoc 'level subcontent))
  745. org-export-latex-add-level))
  746. (occur (number-to-string (cdr (assoc 'occur subcontent))))
  747. (content (cdr (assoc 'content subcontent)))
  748. (subcontent (cadr (assoc 'subcontent subcontent)))
  749. (label (org-get-text-property-any 0 'target heading))
  750. (label-list (cons label (cdr (assoc label
  751. org-export-target-aliases)))))
  752. (cond
  753. ;; Normal conversion
  754. ((<= level org-export-latex-sectioning-depth)
  755. (let* ((sec (nth (1- level) org-export-latex-sectioning))
  756. start end)
  757. (if (consp (cdr sec))
  758. (setq start (nth (if num 0 2) sec)
  759. end (nth (if num 1 3) sec))
  760. (setq start (if num (car sec) (cdr sec))))
  761. (insert (format start heading) "\n")
  762. (when label
  763. (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
  764. label-list "\n") "\n"))
  765. (insert (org-export-latex-content content))
  766. (cond ((stringp subcontent) (insert subcontent))
  767. ((listp subcontent) (org-export-latex-sub subcontent)))
  768. (if end (insert end "\n"))))
  769. ;; At a level under the hl option: we can drop this subsection
  770. ((> level org-export-latex-sectioning-depth)
  771. (cond ((eq org-export-latex-low-levels 'description)
  772. (if (string-match "% ends low level$"
  773. (buffer-substring (point-at-bol 0) (point)))
  774. (delete-region (point-at-bol 0) (point))
  775. (insert "\\begin{description}\n"))
  776. (insert (format "\n\\item[%s]%s~\n\n"
  777. heading
  778. (if label (format "\\label{%s}" label) "")))
  779. (insert (org-export-latex-content content))
  780. (cond ((stringp subcontent) (insert subcontent))
  781. ((listp subcontent) (org-export-latex-sub subcontent)))
  782. (insert "\\end{description} % ends low level\n"))
  783. ((memq org-export-latex-low-levels '(itemize enumerate))
  784. (if (string-match "% ends low level$"
  785. (buffer-substring (point-at-bol 0) (point)))
  786. (delete-region (point-at-bol 0) (point))
  787. (insert (format "\\begin{%s}\n"
  788. (symbol-name org-export-latex-low-levels))))
  789. (insert (format "\n\\item %s\\\\\n%s\n"
  790. heading
  791. (if label (format "\\label{%s}" label) "")))
  792. (insert (org-export-latex-content content))
  793. (cond ((stringp subcontent) (insert subcontent))
  794. ((listp subcontent) (org-export-latex-sub subcontent)))
  795. (insert (format "\\end{%s} %% ends low level\n"
  796. (symbol-name org-export-latex-low-levels))))
  797. ((listp org-export-latex-low-levels)
  798. (if (string-match "% ends low level$"
  799. (buffer-substring (point-at-bol 0) (point)))
  800. (delete-region (point-at-bol 0) (point))
  801. (insert (car org-export-latex-low-levels) "\n"))
  802. (insert (format (nth 2 org-export-latex-low-levels)
  803. heading
  804. (if label (format "\\label{%s}" label) "")))
  805. (insert (org-export-latex-content content))
  806. (cond ((stringp subcontent) (insert subcontent))
  807. ((listp subcontent) (org-export-latex-sub subcontent)))
  808. (insert (nth 1 org-export-latex-low-levels)
  809. " %% ends low level\n"))
  810. ((stringp org-export-latex-low-levels)
  811. (insert (format org-export-latex-low-levels heading) "\n")
  812. (when label (insert (format "\\label{%s}\n" label)))
  813. (insert (org-export-latex-content content))
  814. (cond ((stringp subcontent) (insert subcontent))
  815. ((listp subcontent) (org-export-latex-sub subcontent)))))))))
  816. ;;; Exporting internals:
  817. (defun org-export-latex-set-initial-vars (ext-plist level)
  818. "Store org local variables required for LaTeX export.
  819. EXT-PLIST is an optional additional plist.
  820. LEVEL indicates the default depth for export."
  821. (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
  822. org-export-latex-done-keywords org-done-keywords
  823. org-export-latex-not-done-keywords org-not-done-keywords
  824. org-export-latex-complex-heading-re org-complex-heading-regexp
  825. org-export-latex-display-custom-times org-display-custom-times
  826. org-export-latex-all-targets-re
  827. (org-make-target-link-regexp (org-all-targets))
  828. org-export-latex-options-plist
  829. (org-combine-plists (org-default-export-plist) ext-plist
  830. (org-infile-export-plist))
  831. org-export-latex-class
  832. (or (and (org-region-active-p)
  833. (save-excursion
  834. (goto-char (region-beginning))
  835. (and (looking-at org-complex-heading-regexp)
  836. (org-entry-get nil "LaTeX_CLASS" 'selective))))
  837. (save-excursion
  838. (save-restriction
  839. (widen)
  840. (goto-char (point-min))
  841. (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([a-zA-Z]+\\)" nil t)
  842. (match-string 1))))
  843. org-export-latex-default-class)
  844. org-export-latex-class
  845. (or (car (assoc org-export-latex-class org-export-latex-classes))
  846. (error "No definition for class `%s' in `org-export-latex-classes'"
  847. org-export-latex-class))
  848. org-export-latex-header
  849. (cadr (assoc org-export-latex-class org-export-latex-classes))
  850. org-export-latex-sectioning
  851. (cddr (assoc org-export-latex-class org-export-latex-classes))
  852. org-export-latex-sectioning-depth
  853. (or level
  854. (let ((hl-levels
  855. (plist-get org-export-latex-options-plist :headline-levels))
  856. (sec-depth (length org-export-latex-sectioning)))
  857. (if (> hl-levels sec-depth) sec-depth hl-levels)))))
  858. (defun org-export-latex-make-header (title opt-plist)
  859. "Make the LaTeX header and return it as a string.
  860. TITLE is the current title from the buffer or region.
  861. OPT-PLIST is the options plist for current buffer."
  862. (let ((toc (plist-get opt-plist :table-of-contents))
  863. (author (plist-get opt-plist :author)))
  864. (concat
  865. (if (plist-get opt-plist :time-stamp-file)
  866. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  867. ;; insert LaTeX custom header
  868. (org-export-apply-macros-in-string org-export-latex-header)
  869. "\n"
  870. ;; insert information on LaTeX packages
  871. (when org-export-latex-packages-alist
  872. (mapconcat (lambda(p)
  873. (if (equal "" (car p))
  874. (format "\\usepackage{%s}" (cadr p))
  875. (format "\\usepackage[%s]{%s}"
  876. (car p) (cadr p))))
  877. org-export-latex-packages-alist "\n"))
  878. ;; insert additional commands in the header
  879. (org-export-apply-macros-in-string
  880. (plist-get opt-plist :latex-header-extra))
  881. (org-export-apply-macros-in-string org-export-latex-append-header)
  882. ;; insert the title
  883. (format
  884. "\n\n\\title{%s}\n"
  885. ;; convert the title
  886. (org-export-latex-content
  887. title '(lists tables fixed-width keywords)))
  888. ;; insert author info
  889. (if (plist-get opt-plist :author-info)
  890. (format "\\author{%s}\n"
  891. (org-export-latex-fontify-headline (or author user-full-name)));????????????????????
  892. (format "%%\\author{%s}\n"
  893. (or author user-full-name)))
  894. ;; insert the date
  895. (format "\\date{%s}\n"
  896. (format-time-string
  897. (or (plist-get opt-plist :date)
  898. org-export-latex-date-format)))
  899. ;; beginning of the document
  900. "\n\\begin{document}\n\n"
  901. ;; insert the title command
  902. (when (string-match "\\S-" title)
  903. (if (string-match "%s" org-export-latex-title-command)
  904. (format org-export-latex-title-command title)
  905. org-export-latex-title-command))
  906. "\n\n"
  907. ;; table of contents
  908. (when (and org-export-with-toc
  909. (plist-get opt-plist :section-numbers))
  910. (cond ((numberp toc)
  911. (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
  912. (min toc (plist-get opt-plist :headline-levels))))
  913. (toc (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
  914. (plist-get opt-plist :headline-levels))))))))
  915. (defun org-export-latex-first-lines (opt-plist &optional beg end)
  916. "Export the first lines before first headline.
  917. If BEG is non-nil, it is the beginning of the region.
  918. If END is non-nil, it is the end of the region."
  919. (save-excursion
  920. (goto-char (or beg (point-min)))
  921. (let* ((pt (point)))
  922. (or end
  923. (and (re-search-forward "^\\*+ " end t)
  924. (setq end (match-beginning 0)))
  925. (setq end (point-max)))
  926. (prog1
  927. (org-export-latex-content
  928. (org-export-preprocess-string
  929. (buffer-substring pt end)
  930. :for-LaTeX t
  931. :emph-multiline t
  932. :add-text nil
  933. :comments nil
  934. :skip-before-1st-heading nil
  935. :LaTeX-fragments nil
  936. :timestamps (plist-get opt-plist :timestamps)
  937. :footnotes (plist-get opt-plist :footnotes)))
  938. (org-unmodified
  939. (add-text-properties pt (max pt (1- end))
  940. '(:org-license-to-kill t)))))))
  941. (defvar org-export-latex-header-defs nil
  942. "The header definitions that might be used in the LaTeX body.")
  943. (defvar org-export-latex-header-defs-re nil
  944. "The header definitions that might be used in the LaTeX body.")
  945. (defun org-export-latex-content (content &optional exclude-list)
  946. "Convert CONTENT string to LaTeX.
  947. Don't perform conversions that are in EXCLUDE-LIST. Recognized
  948. conversion types are: quotation-marks, emphasis, sub-superscript,
  949. links, keywords, lists, tables, fixed-width"
  950. (with-temp-buffer
  951. (insert content)
  952. (unless (memq 'timestamps exclude-list)
  953. (org-export-latex-time-stamps))
  954. (unless (memq 'quotation-marks exclude-list)
  955. (org-export-latex-quotation-marks))
  956. (unless (memq 'emphasis exclude-list)
  957. (when (plist-get org-export-latex-options-plist :emphasize)
  958. (org-export-latex-fontify)))
  959. (unless (memq 'sub-superscript exclude-list)
  960. (org-export-latex-special-chars
  961. (plist-get org-export-latex-options-plist :sub-superscript)))
  962. (unless (memq 'links exclude-list)
  963. (org-export-latex-links))
  964. (unless (memq 'keywords exclude-list)
  965. (org-export-latex-keywords))
  966. (unless (memq 'lists exclude-list)
  967. (org-export-latex-lists))
  968. (unless (memq 'tables exclude-list)
  969. (org-export-latex-tables
  970. (plist-get org-export-latex-options-plist :tables)))
  971. (unless (memq 'fixed-width exclude-list)
  972. (org-export-latex-fixed-width
  973. (plist-get org-export-latex-options-plist :fixed-width)))
  974. ;; return string
  975. (buffer-substring (point-min) (point-max))))
  976. (defun org-export-latex-protect-string (s)
  977. "Add the org-protected property to string S."
  978. (add-text-properties 0 (length s) '(org-protected t) s) s)
  979. (defun org-export-latex-protect-char-in-string (char-list string)
  980. "Add org-protected text-property to char from CHAR-LIST in STRING."
  981. (with-temp-buffer
  982. (save-match-data
  983. (insert string)
  984. (goto-char (point-min))
  985. (while (re-search-forward (regexp-opt char-list) nil t)
  986. (add-text-properties (match-beginning 0)
  987. (match-end 0) '(org-protected t)))
  988. (buffer-string))))
  989. (defun org-export-latex-keywords-maybe (&optional remove-list)
  990. "Maybe remove keywords depending on rules in REMOVE-LIST."
  991. (goto-char (point-min))
  992. (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
  993. (case-fold-search nil)
  994. (todo-markup org-export-latex-todo-keyword-markup)
  995. fmt)
  996. ;; convert TODO keywords
  997. (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
  998. (if (plist-get remove-list :todo)
  999. (replace-match "")
  1000. (setq fmt (cond
  1001. ((stringp todo-markup) todo-markup)
  1002. ((and (consp todo-markup) (stringp (car todo-markup)))
  1003. (if (member (match-string 1) org-export-latex-done-keywords)
  1004. (cdr todo-markup) (car todo-markup)))
  1005. (t (cdr (or (assoc (match-string 1) todo-markup)
  1006. (car todo-markup))))))
  1007. (replace-match (format fmt (match-string 1)) t t)))
  1008. ;; convert priority string
  1009. (when (re-search-forward "\\[\\\\#.\\]" nil t)
  1010. (if (plist-get remove-list :priority)
  1011. (replace-match "")
  1012. (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
  1013. ;; convert tags
  1014. (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t)
  1015. (if (or (not org-export-with-tags)
  1016. (plist-get remove-list :tags))
  1017. (replace-match "")
  1018. (replace-match
  1019. (org-export-latex-protect-string
  1020. (format "\\textbf{%s}"
  1021. (save-match-data
  1022. (replace-regexp-in-string
  1023. "_" "\\\\_" (match-string 0)))))
  1024. t t)))))
  1025. (defun org-export-latex-fontify-headline (string)
  1026. "Fontify special words in STRING."
  1027. (with-temp-buffer
  1028. ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
  1029. ;; the beginning of the buffer - inserting "\n" is safe here though.
  1030. (insert "\n" string)
  1031. (goto-char (point-min))
  1032. (when (plist-get org-export-latex-options-plist :emphasize)
  1033. (org-export-latex-fontify))
  1034. (org-export-latex-keywords-maybe)
  1035. (org-export-latex-special-chars
  1036. (plist-get org-export-latex-options-plist :sub-superscript))
  1037. (org-export-latex-links)
  1038. (org-trim (buffer-string))))
  1039. (defun org-export-latex-time-stamps ()
  1040. "Format time stamps."
  1041. (goto-char (point-min))
  1042. (let ((org-display-custom-times org-export-latex-display-custom-times))
  1043. (while (re-search-forward org-ts-regexp-both nil t)
  1044. (org-if-unprotected-at (1- (point))
  1045. (replace-match
  1046. (org-export-latex-protect-string
  1047. (format org-export-latex-timestamp-markup
  1048. (substring (org-translate-time (match-string 0)) 1 -1)))
  1049. t t)))))
  1050. (defun org-export-latex-quotation-marks ()
  1051. "Export quotation marks depending on language conventions."
  1052. (let* ((lang (plist-get org-export-latex-options-plist :language))
  1053. (quote-rpl (if (equal lang "fr")
  1054. '(("\\(\\s-\\)\"" "«~")
  1055. ("\\(\\S-\\)\"" "~»")
  1056. ("\\(\\s-\\)'" "`"))
  1057. '(("\\(\\s-\\|(\\)\"" "``")
  1058. ("\\(\\S-\\)\"" "''")
  1059. ("\\(\\s-\\|(\\)'" "`")))))
  1060. (mapc (lambda(l) (goto-char (point-min))
  1061. (while (re-search-forward (car l) nil t)
  1062. (let ((rpl (concat (match-string 1) (cadr l))))
  1063. (org-export-latex-protect-string rpl)
  1064. (org-if-unprotected-1
  1065. (replace-match rpl t t))))) quote-rpl)))
  1066. (defun org-export-latex-special-chars (sub-superscript)
  1067. "Export special characters to LaTeX.
  1068. If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
  1069. See the `org-export-latex.el' code for a complete conversion table."
  1070. (goto-char (point-min))
  1071. (mapc (lambda(c)
  1072. (goto-char (point-min))
  1073. (while (re-search-forward c nil t)
  1074. ;; Put the point where to check for org-protected
  1075. (unless (get-text-property (match-beginning 2) 'org-protected)
  1076. (cond ((member (match-string 2) '("\\$" "$"))
  1077. (if (equal (match-string 2) "\\$")
  1078. nil
  1079. (replace-match "\\$" t t)))
  1080. ((member (match-string 2) '("&" "%" "#"))
  1081. (if (equal (match-string 1) "\\")
  1082. (replace-match (match-string 2) t t)
  1083. (replace-match (concat (match-string 1) "\\"
  1084. (match-string 2)) t t)))
  1085. ((equal (match-string 2) "...")
  1086. (replace-match
  1087. (concat (match-string 1)
  1088. (org-export-latex-protect-string "\\ldots{}")) t t))
  1089. ((equal (match-string 2) "~")
  1090. (cond ((equal (match-string 1) "\\") nil)
  1091. ((eq 'org-link (get-text-property 0 'face (match-string 2)))
  1092. (replace-match (concat (match-string 1) "\\~") t t))
  1093. (t (replace-match
  1094. (org-export-latex-protect-string
  1095. (concat (match-string 1) "\\~{}")) t t))))
  1096. ((member (match-string 2) '("{" "}"))
  1097. (unless (save-match-data (org-inside-latex-math-p))
  1098. (if (equal (match-string 1) "\\")
  1099. (replace-match (match-string 2) t t)
  1100. (replace-match (concat (match-string 1) "\\"
  1101. (match-string 2)) t t)))))
  1102. (unless (save-match-data (org-inside-latex-math-p))
  1103. (cond ((equal (match-string 2) "\\")
  1104. (replace-match (or (save-match-data
  1105. (org-export-latex-treat-backslash-char
  1106. (match-string 1)
  1107. (or (match-string 3) "")))
  1108. "") t t))
  1109. ((member (match-string 2) '("_" "^"))
  1110. (replace-match (or (save-match-data
  1111. (org-export-latex-treat-sub-super-char
  1112. sub-superscript
  1113. (match-string 2)
  1114. (match-string 1)
  1115. (match-string 3))) "") t t)
  1116. (backward-char 1)))))))
  1117. '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
  1118. "\\(\\(\\\\?\\$\\)\\)"
  1119. "\\([a-za-z0-9]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-za-z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-za-z0-9]+}\\|([a-za-z0-9]+)\\)"
  1120. "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|[a-zA-Z&#%{}\"]+\\)"
  1121. "\\(.\\|^\\)\\(&\\)"
  1122. "\\(.\\|^\\)\\(#\\)"
  1123. "\\(.\\|^\\)\\(%\\)"
  1124. "\\(.\\|^\\)\\({\\)"
  1125. "\\(.\\|^\\)\\(}\\)"
  1126. "\\(.\\|^\\)\\(~\\)"
  1127. "\\(.\\|^\\)\\(\\.\\.\\.\\)"
  1128. ;; (?\< . "\\textless{}")
  1129. ;; (?\> . "\\textgreater{}")
  1130. )))
  1131. (defun org-inside-latex-math-p ()
  1132. (get-text-property (point) 'org-latex-math))
  1133. (defun org-export-latex-treat-sub-super-char
  1134. (subsup char string-before string-after)
  1135. "Convert the \"_\" and \"^\" characters to LaTeX.
  1136. SUBSUP corresponds to the ^: option in the #+OPTIONS line.
  1137. Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
  1138. (cond ((equal string-before "\\")
  1139. (concat string-before char string-after))
  1140. ;; this is part of a math formula
  1141. ((and (string-match "\\S-+" string-before)
  1142. (string-match "\\S-+" string-after))
  1143. (cond ((eq 'org-link (get-text-property 0 'face char))
  1144. (concat string-before "\\" char string-after))
  1145. ((save-match-data (org-inside-latex-math-p))
  1146. (if subsup
  1147. (cond ((eq 1 (length string-after))
  1148. (concat string-before char string-after))
  1149. ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
  1150. (format "%s%s{%s}" string-before char
  1151. (match-string 1 string-after))))))
  1152. ((and (> (length string-after) 1)
  1153. (or (eq subsup t)
  1154. (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
  1155. (string-match "[({]?\\([^)}]+\\)[)}]?" string-after))
  1156. (org-export-latex-protect-string
  1157. (format "%s$%s{%s}$" string-before char
  1158. (if (and (> (match-end 1) (1+ (match-beginning 1)))
  1159. (not (equal (substring string-after 0 2) "{\\")))
  1160. (concat "\\mathrm{" (match-string 1 string-after) "}")
  1161. (match-string 1 string-after)))))
  1162. ((eq subsup t) (concat string-before "$" char string-after "$"))
  1163. (t (org-export-latex-protect-string
  1164. (concat string-before "\\" char "{}" string-after)))))
  1165. (t (org-export-latex-protect-string
  1166. (concat string-before "\\" char "{}" string-after)))))
  1167. (defun org-export-latex-treat-backslash-char (string-before string-after)
  1168. "Convert the \"$\" special character to LaTeX.
  1169. The conversion is made depending of STRING-BEFORE and STRING-AFTER."
  1170. (cond ((member (list string-after) org-html-entities)
  1171. ;; backslash is part of a special entity (like "\alpha")
  1172. (concat string-before "$\\"
  1173. (or (cdar (member (list string-after) org-html-entities))
  1174. string-after) "$"))
  1175. ((and (not (string-match "^[ \n\t]" string-after))
  1176. (not (string-match "[ \t]\\'\\|^" string-before)))
  1177. ;; backslash is inside a word
  1178. (org-export-latex-protect-string
  1179. (concat string-before "\\textbackslash{}" string-after)))
  1180. ((not (or (equal string-after "")
  1181. (string-match "^[ \t\n]" string-after)))
  1182. ;; backslash might escape a character (like \#) or a user TeX
  1183. ;; macro (like \setcounter)
  1184. (org-export-latex-protect-string
  1185. (concat string-before "\\" string-after)))
  1186. ((and (string-match "^[ \t\n]" string-after)
  1187. (string-match "[ \t\n]\\'" string-before))
  1188. ;; backslash is alone, convert it to $\backslash$
  1189. (org-export-latex-protect-string
  1190. (concat string-before "\\textbackslash{}" string-after)))
  1191. (t (org-export-latex-protect-string
  1192. (concat string-before "\\textbackslash{}" string-after)))))
  1193. (defun org-export-latex-keywords ()
  1194. "Convert special keywords to LaTeX."
  1195. (goto-char (point-min))
  1196. (while (re-search-forward org-export-latex-special-keyword-regexp nil t)
  1197. (replace-match (format org-export-latex-timestamp-keyword-markup
  1198. (match-string 0)) t t)
  1199. (save-excursion
  1200. (beginning-of-line 1)
  1201. (unless (looking-at ".*\\\\newline[ \t]*$")
  1202. (end-of-line 1)
  1203. (insert "\\newline")))))
  1204. (defun org-export-latex-fixed-width (opt)
  1205. "When OPT is non-nil convert fixed-width sections to LaTeX."
  1206. (goto-char (point-min))
  1207. (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
  1208. (if opt
  1209. (progn (goto-char (match-beginning 0))
  1210. (insert "\\begin{verbatim}\n")
  1211. (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
  1212. (replace-match (concat (match-string 1)
  1213. (match-string 2)) t t)
  1214. (forward-line))
  1215. (insert "\\end{verbatim}\n\n"))
  1216. (progn (goto-char (match-beginning 0))
  1217. (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
  1218. (replace-match (concat "%" (match-string 1)
  1219. (match-string 2)) t t)
  1220. (forward-line))))))
  1221. (defvar org-table-last-alignment) ; defined in org-table.el
  1222. (defvar org-table-last-column-widths) ; defined in org-table.el
  1223. (declare-function orgtbl-to-latex "org-table" (table params) t)
  1224. (defun org-export-latex-tables (insert)
  1225. "Convert tables to LaTeX and INSERT it."
  1226. (goto-char (point-min))
  1227. (while (re-search-forward "^\\([ \t]*\\)|" nil t)
  1228. (org-table-align)
  1229. (let* ((beg (org-table-begin))
  1230. (end (org-table-end))
  1231. (raw-table (buffer-substring beg end))
  1232. (org-table-last-alignment (copy-sequence org-table-last-alignment))
  1233. (org-table-last-column-widths (copy-sequence
  1234. org-table-last-column-widths))
  1235. fnum fields line lines olines gr colgropen line-fmt align
  1236. caption label attr floatp longtblp)
  1237. (if org-export-latex-tables-verbatim
  1238. (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
  1239. "\\end{verbatim}\n")))
  1240. (apply 'delete-region (list beg end))
  1241. (insert (org-export-latex-protect-string tbl)))
  1242. (progn
  1243. (setq caption (org-find-text-property-in-string
  1244. 'org-caption raw-table)
  1245. attr (org-find-text-property-in-string
  1246. 'org-attributes raw-table)
  1247. label (org-find-text-property-in-string
  1248. 'org-label raw-table)
  1249. longtblp (and attr (stringp attr)
  1250. (string-match "\\<longtable\\>" attr))
  1251. align (and attr (stringp attr)
  1252. (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
  1253. (match-string 1 attr))
  1254. floatp (or caption label))
  1255. (setq lines (org-split-string raw-table "\n"))
  1256. (apply 'delete-region (list beg end))
  1257. (when org-export-table-remove-special-lines
  1258. (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
  1259. (when org-table-clean-did-remove-column
  1260. (pop org-table-last-alignment)
  1261. (pop org-table-last-column-widths))
  1262. ;; make a formatting string to reflect aligment
  1263. (setq olines lines)
  1264. (while (and (not line-fmt) (setq line (pop olines)))
  1265. (unless (string-match "^[ \t]*|-" line)
  1266. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1267. (setq fnum (make-vector (length fields) 0))
  1268. (setq line-fmt
  1269. (mapconcat
  1270. (lambda (x)
  1271. (setq gr (pop org-table-colgroup-info))
  1272. (format "%s%%s%s"
  1273. (cond ((eq gr :start)
  1274. (prog1 (if colgropen "|" "|")
  1275. (setq colgropen t)))
  1276. ((eq gr :startend)
  1277. (prog1 (if colgropen "|" "|")
  1278. (setq colgropen nil)))
  1279. (t ""))
  1280. (if (memq gr '(:end :startend))
  1281. (progn (setq colgropen nil) "|")
  1282. "")))
  1283. fnum ""))))
  1284. ;; fix double || in line-fmt
  1285. (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
  1286. ;; maybe remove the first and last "|"
  1287. (when (and (not org-export-latex-tables-column-borders)
  1288. (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
  1289. (setq line-fmt (match-string 2 line-fmt)))
  1290. ;; format alignment
  1291. (unless align
  1292. (setq align (apply 'format
  1293. (cons line-fmt
  1294. (mapcar (lambda (x) (if x "r" "l"))
  1295. org-table-last-alignment)))))
  1296. ;; prepare the table to send to orgtbl-to-latex
  1297. (setq lines
  1298. (mapcar
  1299. (lambda(elem)
  1300. (or (and (string-match "[ \t]*|-+" elem) 'hline)
  1301. (org-split-string (org-trim elem) "|")))
  1302. lines))
  1303. (when insert
  1304. (insert (org-export-latex-protect-string
  1305. (concat
  1306. (if longtblp
  1307. (concat "\\begin{longtable}{" align "}\n")
  1308. (if floatp "\\begin{table}[htb]\n"))
  1309. (if (or floatp longtblp)
  1310. (format
  1311. "\\caption{%s%s}"
  1312. (if label (concat "\\\label{" label "}") "")
  1313. (or caption "")))
  1314. (if longtblp "\\\\\n" "\n")
  1315. (if (and org-export-latex-tables-centered (not longtblp))
  1316. "\\begin{center}\n")
  1317. (if (not longtblp) (concat "\\begin{tabular}{" align "}\n"))
  1318. (orgtbl-to-latex
  1319. lines
  1320. `(:tstart nil :tend nil
  1321. :hlend ,(if longtblp
  1322. (format "\\\\
  1323. \\hline
  1324. \\endhead
  1325. \\hline\\multicolumn{%d}{r}{Continued on next page}\\
  1326. \\endfoot
  1327. \\endlastfoot" (length org-table-last-alignment))
  1328. nil)))
  1329. (if (not longtblp) (concat "\n\\end{tabular}"))
  1330. (if longtblp "\n" (if org-export-latex-tables-centered
  1331. "\n\\end{center}\n" "\n"))
  1332. (if longtblp
  1333. "\\end{longtable}"
  1334. (if floatp "\\end{table}"))))
  1335. "\n\n")))))))
  1336. (defun org-export-latex-fontify ()
  1337. "Convert fontification to LaTeX."
  1338. (goto-char (point-min))
  1339. (while (re-search-forward org-emph-re nil t)
  1340. ;; The match goes one char after the *string*
  1341. (let ((emph (assoc (match-string 3)
  1342. org-export-latex-emphasis-alist))
  1343. (beg (match-beginning 0))
  1344. (end (match-end 0))
  1345. rpl)
  1346. (unless emph
  1347. (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
  1348. (match-string 3)))
  1349. (unless (or (get-text-property (1- (point)) 'org-protected)
  1350. (save-excursion
  1351. (goto-char (match-beginning 1))
  1352. (save-match-data
  1353. (and (org-at-table-p)
  1354. (string-match
  1355. "[|\n]" (buffer-substring beg end))))))
  1356. (setq rpl (concat (match-string 1)
  1357. (org-export-latex-emph-format (cadr emph)
  1358. (match-string 4))
  1359. (match-string 5)))
  1360. (if (caddr emph)
  1361. (setq rpl (org-export-latex-protect-string rpl)))
  1362. (replace-match rpl t t)))
  1363. (backward-char)))
  1364. (defvar org-export-latex-use-verb nil)
  1365. (defun org-export-latex-emph-format (format string)
  1366. "Format an emphasis string and handle the \\verb special case."
  1367. (when (equal format "\\verb")
  1368. (save-match-data
  1369. (if org-export-latex-use-verb
  1370. (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
  1371. (catch 'exit
  1372. (loop for i from 0 to (1- (length ll)) do
  1373. (if (not (string-match (regexp-quote (substring ll i (1+ i)))
  1374. string))
  1375. (progn
  1376. (setq format (concat "\\verb" (substring ll i (1+ i))
  1377. "%s" (substring ll i (1+ i))))
  1378. (throw 'exit nil))))))
  1379. (let ((start 0)
  1380. (trans '(("\\" . "\\backslash")
  1381. ("~" . "\\ensuremath{\\sim}")
  1382. ("^" . "\\ensuremath{\\wedge}")))
  1383. (rtn "") char)
  1384. (while (string-match "[\\{}$%&_#~^]" string)
  1385. (setq char (match-string 0 string))
  1386. (if (> (match-beginning 0) 0)
  1387. (setq rtn (concat rtn (substring string
  1388. 0 (match-beginning 0)))))
  1389. (setq string (substring string (1+ (match-beginning 0))))
  1390. (setq char (or (cdr (assoc char trans)) (concat "\\" char))
  1391. rtn (concat rtn char)))
  1392. (setq string (concat rtn string) format "\\texttt{%s}")))))
  1393. (setq string (org-export-latex-protect-string
  1394. (format format string))))
  1395. (defun org-export-latex-links ()
  1396. ;; Make sure to use the LaTeX hyperref and graphicx package
  1397. ;; or send some warnings.
  1398. "Convert links to LaTeX."
  1399. (goto-char (point-min))
  1400. (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
  1401. (org-if-unprotected
  1402. (goto-char (match-beginning 0))
  1403. (let* ((re-radio org-export-latex-all-targets-re)
  1404. (remove (list (match-beginning 0) (match-end 0)))
  1405. (raw-path (org-extract-attributes (match-string 3)))
  1406. (full-raw-path (concat (match-string 1) raw-path))
  1407. (desc (match-string 5))
  1408. (type (or (match-string 2)
  1409. (if (or (file-name-absolute-p raw-path)
  1410. (string-match "^\\.\\.?/" raw-path))
  1411. "file")))
  1412. (coderefp (equal type "coderef"))
  1413. (caption (org-find-text-property-in-string 'org-caption raw-path))
  1414. (attr (or (org-find-text-property-in-string 'org-attributes raw-path)
  1415. (plist-get org-export-latex-options-plist :latex-image-options)))
  1416. (label (org-find-text-property-in-string 'org-label raw-path))
  1417. (floatp (or label caption))
  1418. imgp radiop
  1419. ;; define the path of the link
  1420. (path (cond
  1421. ((member type '("coderef"))
  1422. raw-path)
  1423. ((member type '("http" "https" "ftp"))
  1424. (concat type ":" raw-path))
  1425. ((and re-radio (string-match re-radio raw-path))
  1426. (setq radiop t))
  1427. ((equal type "mailto")
  1428. (concat type ":" raw-path))
  1429. ((equal type "file")
  1430. (if (and (org-file-image-p
  1431. (expand-file-name
  1432. raw-path)
  1433. org-export-latex-inline-image-extensions)
  1434. (or (get-text-property 0 'org-no-description
  1435. raw-path)
  1436. (equal desc full-raw-path)))
  1437. (setq imgp t)
  1438. (progn (when (string-match "\\(.+\\)::.+" raw-path)
  1439. (setq raw-path (match-string 1 raw-path)))
  1440. (if (file-exists-p raw-path)
  1441. (concat type "://" (expand-file-name raw-path))
  1442. (concat type "://" (org-export-directory
  1443. :LaTeX org-export-latex-options-plist)
  1444. raw-path))))))))
  1445. ;; process with link inserting
  1446. (apply 'delete-region remove)
  1447. (cond ((and imgp (plist-get org-export-latex-options-plist :inline-images))
  1448. (insert
  1449. (concat
  1450. (if floatp "\\begin{figure}[htb]\n")
  1451. (format "\\centerline{\\includegraphics[%s]{%s}}\n"
  1452. attr
  1453. (if (file-name-absolute-p raw-path)
  1454. (expand-file-name raw-path)
  1455. raw-path))
  1456. (if floatp
  1457. (format "\\caption{%s%s}\n"
  1458. (if label (concat "\\label{" label "}") "")
  1459. (or caption "")))
  1460. (if floatp "\\end{figure}\n"))))
  1461. (coderefp
  1462. (insert (format
  1463. (org-export-get-coderef-format path desc)
  1464. (cdr (assoc path org-export-code-refs)))))
  1465. (radiop (insert (format "\\hyperref[%s]{%s}"
  1466. (org-solidify-link-text raw-path) desc)))
  1467. ((not type)
  1468. (insert (format "\\hyperref[%s]{%s}"
  1469. (org-remove-initial-hash
  1470. (org-solidify-link-text raw-path))
  1471. desc)))
  1472. (path
  1473. (when (org-at-table-p)
  1474. ;; There is a strange problem when we have a link in a table,
  1475. ;; ampersands then cause a problem. I think this must be
  1476. ;; a LaTeX issue, but we here implement a work-around anyway.
  1477. (setq path (org-export-latex-protect-amp path)
  1478. desc (org-export-latex-protect-amp desc)))
  1479. (insert (format "\\href{%s}{%s}" path desc)))
  1480. (t (insert "\\texttt{" desc "}")))))))
  1481. (defun org-export-latex-protect-amp (s)
  1482. (while (string-match "\\([^\\\\]\\)\\(&\\)" s)
  1483. (setq s (replace-match (concat (match-string 1 s) "\\" (match-string 2 s))
  1484. t t s)))
  1485. s)
  1486. (defun org-remove-initial-hash (s)
  1487. (if (string-match "\\`#" s)
  1488. (substring s 1)
  1489. s))
  1490. (defvar org-latex-entities) ; defined below
  1491. (defvar org-latex-entities-regexp) ; defined below
  1492. (defvar org-latex-entities-exceptions) ; defined below
  1493. (defun org-export-latex-preprocess (parameters)
  1494. "Clean stuff in the LaTeX export."
  1495. ;; Preserve line breaks
  1496. (goto-char (point-min))
  1497. (while (re-search-forward "\\\\\\\\" nil t)
  1498. (add-text-properties (match-beginning 0) (match-end 0)
  1499. '(org-protected t)))
  1500. ;; Preserve latex environments
  1501. (goto-char (point-min))
  1502. (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
  1503. (let* ((start (progn (beginning-of-line) (point)))
  1504. (end (and (re-search-forward
  1505. (concat "^[ \t]*\\\\end{"
  1506. (regexp-quote (match-string 1))
  1507. "}") nil t)
  1508. (point-at-eol))))
  1509. (if end
  1510. (add-text-properties start end '(org-protected t))
  1511. (goto-char (point-at-eol)))))
  1512. ;; Preserve math snippets
  1513. (let* ((matchers (plist-get org-format-latex-options :matchers))
  1514. (re-list org-latex-regexps)
  1515. beg end re e m n block off)
  1516. ;; Check the different regular expressions
  1517. (while (setq e (pop re-list))
  1518. (setq m (car e) re (nth 1 e) n (nth 2 e)
  1519. block (if (nth 3 e) "\n\n" ""))
  1520. (setq off (if (member m '("$" "$1")) 1 0))
  1521. (when (and (member m matchers) (not (equal m "begin")))
  1522. (goto-char (point-min))
  1523. (while (re-search-forward re nil t)
  1524. (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
  1525. (add-text-properties beg end '(org-protected t org-latex-math t))))))
  1526. ;; Convert LaTeX to \LaTeX{}
  1527. (goto-char (point-min))
  1528. (let ((case-fold-search nil))
  1529. (while (re-search-forward "\\([^+_]\\)LaTeX" nil t)
  1530. (org-if-unprotected
  1531. (replace-match (org-export-latex-protect-string
  1532. (concat (match-string 1) "\\LaTeX{}")) t t))))
  1533. ;; Convert blockquotes
  1534. (goto-char (point-min))
  1535. (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
  1536. (org-replace-match-keep-properties "\\begin{quote}" t t))
  1537. (goto-char (point-min))
  1538. (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
  1539. (org-replace-match-keep-properties "\\end{quote}" t t))
  1540. ;; Convert verse
  1541. (goto-char (point-min))
  1542. (while (search-forward "ORG-VERSE-START" nil t)
  1543. (org-replace-match-keep-properties "\\begin{verse}" t t)
  1544. (beginning-of-line 2)
  1545. (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
  1546. (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
  1547. (goto-char (match-end 1))
  1548. (org-replace-match-keep-properties
  1549. (org-export-latex-protect-string
  1550. (concat "\\hspace*{1cm}" (match-string 2))) t t)
  1551. (beginning-of-line 1))
  1552. (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
  1553. (end-of-line 1)
  1554. (insert "\\\\"))
  1555. (beginning-of-line 2))
  1556. (and (looking-at "[ \t]*ORG-VERSE-END.*")
  1557. (org-replace-match-keep-properties "\\end{verse}" t t)))
  1558. ;; Convert center
  1559. (goto-char (point-min))
  1560. (while (search-forward "ORG-CENTER-START" nil t)
  1561. (org-replace-match-keep-properties "\\begin{center}" t t))
  1562. (goto-char (point-min))
  1563. (while (search-forward "ORG-CENTER-END" nil t)
  1564. (org-replace-match-keep-properties "\\end{center}" t t))
  1565. (run-hooks 'org-export-latex-after-blockquotes-hook)
  1566. ;; Convert horizontal rules
  1567. (goto-char (point-min))
  1568. (while (re-search-forward "^----+.$" nil t)
  1569. (org-if-unprotected
  1570. (replace-match (org-export-latex-protect-string "\\hrule") t t)))
  1571. ;; Protect LaTeX commands like \command[...]{...} or \command{...}
  1572. (let ((re (concat "\\\\[a-zA-Z]+\\(?:"
  1573. "\\[.*\\]"
  1574. "\\)?"
  1575. (org-create-multibrace-regexp "{" "}" 3))))
  1576. (while (re-search-forward re nil t)
  1577. (add-text-properties (match-beginning 0) (match-end 0)
  1578. '(org-protected t))))
  1579. ;; Protect LaTeX entities
  1580. (goto-char (point-min))
  1581. (let (a)
  1582. (while (re-search-forward org-latex-entities-regexp nil t)
  1583. (if (setq a (assoc (match-string 0) org-latex-entities-exceptions))
  1584. (replace-match (org-add-props (nth 1 a) nil 'org-protected t)
  1585. t t)
  1586. (add-text-properties (match-beginning 0) (match-end 0)
  1587. '(org-protected t)))))
  1588. ;; Replace radio links
  1589. (goto-char (point-min))
  1590. (while (re-search-forward
  1591. (concat "<<<?" org-export-latex-all-targets-re
  1592. ">>>?\\((INVISIBLE)\\)?") nil t)
  1593. (org-if-unprotected
  1594. (replace-match
  1595. (org-export-latex-protect-string
  1596. (format "\\label{%s}%s" (save-match-data (org-solidify-link-text
  1597. (match-string 1)))
  1598. (if (match-string 2) "" (match-string 1)))) t t)))
  1599. ;; Delete @<...> constructs
  1600. ;; Thanks to Daniel Clemente for this regexp
  1601. (goto-char (point-min))
  1602. (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
  1603. (org-if-unprotected
  1604. (replace-match "")))
  1605. ;; When converting to LaTeX, replace footnotes
  1606. ;; FIXME: don't protect footnotes from conversion
  1607. (when (plist-get org-export-latex-options-plist :footnotes)
  1608. (goto-char (point-min))
  1609. (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t)
  1610. (org-if-unprotected
  1611. (when (save-match-data
  1612. (save-excursion (beginning-of-line)
  1613. (looking-at "[^:|#]")))
  1614. (let ((foot-beg (match-beginning 0))
  1615. (foot-end (match-end 0))
  1616. (foot-prefix (match-string 0))
  1617. footnote footnote-rpl)
  1618. (save-excursion
  1619. (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix))
  1620. nil t))
  1621. (replace-match "$^{\\1}$")
  1622. (replace-match "")
  1623. (let ((end (save-excursion
  1624. (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t)
  1625. (match-beginning 0) (point-max)))))
  1626. (setq footnote (concat (org-trim (buffer-substring (point) end))
  1627. " ")) ; prevent last } being part of a link
  1628. (delete-region (point) end))
  1629. (goto-char foot-beg)
  1630. (delete-region foot-beg foot-end)
  1631. (unless (null footnote)
  1632. (setq footnote-rpl (format "\\footnote{%s}" footnote))
  1633. (add-text-properties 0 10 '(org-protected t) footnote-rpl)
  1634. (add-text-properties (1- (length footnote-rpl))
  1635. (length footnote-rpl)
  1636. '(org-protected t) footnote-rpl)
  1637. (insert footnote-rpl)))
  1638. )))))
  1639. ;; Remove footnote section tag for LaTeX
  1640. (goto-char (point-min))
  1641. (while (re-search-forward
  1642. (concat "^" footnote-section-tag-regexp) nil t)
  1643. (org-if-unprotected
  1644. (replace-match "")))))
  1645. ;;; List handling:
  1646. (defun org-export-latex-lists ()
  1647. "Convert plain text lists in current buffer into LaTeX lists."
  1648. (goto-char (point-min))
  1649. (while (re-search-forward org-list-beginning-re nil t)
  1650. (org-if-unprotected
  1651. (beginning-of-line)
  1652. (insert (org-list-to-latex (org-list-parse-list t)
  1653. org-export-latex-list-parameters))
  1654. "\n")))
  1655. (defconst org-latex-entities
  1656. '("\\!"
  1657. "\\'"
  1658. "\\+"
  1659. "\\,"
  1660. "\\-"
  1661. "\\:"
  1662. "\\;"
  1663. "\\<"
  1664. "\\="
  1665. "\\>"
  1666. "\\Huge"
  1667. "\\LARGE"
  1668. "\\Large"
  1669. "\\Styles"
  1670. "\\\\"
  1671. "\\`"
  1672. "\\addcontentsline"
  1673. "\\address"
  1674. "\\addtocontents"
  1675. "\\addtocounter"
  1676. "\\addtolength"
  1677. "\\addvspace"
  1678. "\\alph"
  1679. "\\appendix"
  1680. "\\arabic"
  1681. "\\author"
  1682. "\\begin{array}"
  1683. "\\begin{center}"
  1684. "\\begin{description}"
  1685. "\\begin{enumerate}"
  1686. "\\begin{eqnarray}"
  1687. "\\begin{equation}"
  1688. "\\begin{figure}"
  1689. "\\begin{flushleft}"
  1690. "\\begin{flushright}"
  1691. "\\begin{itemize}"
  1692. "\\begin{list}"
  1693. "\\begin{minipage}"
  1694. "\\begin{picture}"
  1695. "\\begin{quotation}"
  1696. "\\begin{quote}"
  1697. "\\begin{tabbing}"
  1698. "\\begin{table}"
  1699. "\\begin{tabular}"
  1700. "\\begin{thebibliography}"
  1701. "\\begin{theorem}"
  1702. "\\begin{titlepage}"
  1703. "\\begin{verbatim}"
  1704. "\\begin{verse}"
  1705. "\\bf"
  1706. "\\bf"
  1707. "\\bibitem"
  1708. "\\bigskip"
  1709. "\\cdots"
  1710. "\\centering"
  1711. "\\circle"
  1712. "\\cite"
  1713. "\\cleardoublepage"
  1714. "\\clearpage"
  1715. "\\cline"
  1716. "\\closing"
  1717. "\\dashbox"
  1718. "\\date"
  1719. "\\ddots"
  1720. "\\dotfill"
  1721. "\\em"
  1722. "\\fbox"
  1723. "\\flushbottom"
  1724. "\\fnsymbol"
  1725. "\\footnote"
  1726. "\\footnotemark"
  1727. "\\footnotesize"
  1728. "\\footnotetext"
  1729. "\\frac"
  1730. "\\frame"
  1731. "\\framebox"
  1732. "\\hfill"
  1733. "\\hline"
  1734. "\\hrulespace"
  1735. "\\hspace"
  1736. "\\huge"
  1737. "\\hyphenation"
  1738. "\\include"
  1739. "\\includeonly"
  1740. "\\indent"
  1741. "\\input"
  1742. "\\it"
  1743. "\\kill"
  1744. "\\label"
  1745. "\\large"
  1746. "\\ldots"
  1747. "\\line"
  1748. "\\linebreak"
  1749. "\\linethickness"
  1750. "\\listoffigures"
  1751. "\\listoftables"
  1752. "\\location"
  1753. "\\makebox"
  1754. "\\maketitle"
  1755. "\\mark"
  1756. "\\mbox"
  1757. "\\medskip"
  1758. "\\multicolumn"
  1759. "\\multiput"
  1760. ("\\nbsp" "~")
  1761. "\\newcommand"
  1762. "\\newcounter"
  1763. "\\newenvironment"
  1764. "\\newfont"
  1765. "\\newlength"
  1766. "\\newline"
  1767. "\\newpage"
  1768. "\\newsavebox"
  1769. "\\newtheorem"
  1770. "\\nocite"
  1771. "\\nofiles"
  1772. "\\noindent"
  1773. "\\nolinebreak"
  1774. "\\nopagebreak"
  1775. "\\normalsize"
  1776. "\\onecolumn"
  1777. "\\opening"
  1778. "\\oval"
  1779. "\\overbrace"
  1780. "\\overline"
  1781. "\\pagebreak"
  1782. "\\pagenumbering"
  1783. "\\pageref"
  1784. "\\pagestyle"
  1785. "\\par"
  1786. "\\parbox"
  1787. "\\put"
  1788. "\\raggedbottom"
  1789. "\\raggedleft"
  1790. "\\raggedright"
  1791. "\\raisebox"
  1792. "\\ref"
  1793. "\\rm"
  1794. "\\roman"
  1795. "\\rule"
  1796. "\\savebox"
  1797. "\\sc"
  1798. "\\scriptsize"
  1799. "\\setcounter"
  1800. "\\setlength"
  1801. "\\settowidth"
  1802. "\\sf"
  1803. "\\shortstack"
  1804. "\\signature"
  1805. "\\sl"
  1806. "\\small"
  1807. "\\smallskip"
  1808. "\\sqrt"
  1809. "\\tableofcontents"
  1810. "\\telephone"
  1811. "\\thanks"
  1812. "\\thispagestyle"
  1813. "\\tiny"
  1814. "\\title"
  1815. "\\tt"
  1816. "\\twocolumn"
  1817. "\\typein"
  1818. "\\typeout"
  1819. "\\underbrace"
  1820. "\\underline"
  1821. "\\usebox"
  1822. "\\usecounter"
  1823. "\\value"
  1824. "\\vdots"
  1825. "\\vector"
  1826. "\\verb"
  1827. "\\vfill"
  1828. "\\vline"
  1829. "\\vspace")
  1830. "A list of LaTeX commands to be protected when performing conversion.")
  1831. (defvar org-latex-entities-exceptions nil)
  1832. (defconst org-latex-entities-regexp
  1833. (let (names rest)
  1834. (dolist (x org-latex-entities)
  1835. (when (consp x)
  1836. (add-to-list 'org-latex-entities-exceptions x)
  1837. (setq x (car x)))
  1838. (if (string-match "[a-z][A-Z]$" x)
  1839. (push x names)
  1840. (push x rest)))
  1841. (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
  1842. "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
  1843. (provide 'org-export-latex)
  1844. (provide 'org-latex)
  1845. ;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
  1846. ;;; org-latex.el ends here