org-e-latex.el 75 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124
  1. ;;; org-e-latex.el --- LaTeX Back-End For Org Export Engine
  2. ;; Copyright (C) 2011-2012 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This program is free software; you can redistribute it and/or modify
  6. ;; it under the terms of the GNU General Public License as published by
  7. ;; the Free Software Foundation, either version 3 of the License, or
  8. ;; (at your option) any later version.
  9. ;; This program is distributed in the hope that it will be useful,
  10. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. ;; GNU General Public License for more details.
  13. ;; You should have received a copy of the GNU General Public License
  14. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. ;;; Commentary:
  16. ;; This library implements a LaTeX back-end for Org generic exporter.
  17. ;; To test it, run
  18. ;;
  19. ;; M-: (org-export-to-buffer 'e-latex "*Test e-LaTeX*") RET
  20. ;;
  21. ;; in an org-mode buffer then switch to the buffer to see the LaTeX
  22. ;; export. See contrib/lisp/org-export.el for more details on how
  23. ;; this exporter works.
  24. ;; It introduces three new buffer keywords: "LATEX_CLASS",
  25. ;; "LATEX_CLASS_OPTIONS" and "LATEX_HEADER".
  26. ;;; Code:
  27. (eval-when-compile (require 'cl))
  28. (defvar org-export-latex-default-packages-alist)
  29. (defvar org-export-latex-packages-alist)
  30. (declare-function org-element-get-property "org-element" (property element))
  31. (declare-function org-element-normalize-string "org-element" (s))
  32. (declare-function org-element-parse-secondary-string
  33. "org-element" (string restriction &optional buffer))
  34. (defvar org-element-string-restrictions)
  35. (declare-function org-export-clean-table "org-export" (table specialp))
  36. (declare-function org-export-data "org-export" (data backend info))
  37. (declare-function org-export-directory "org-export" (type plist))
  38. (declare-function org-export-expand-macro "org-export" (macro info))
  39. (declare-function org-export-first-sibling-p "org-export" (headline info))
  40. (declare-function org-export-footnote-first-reference-p "org-export" (footnote-reference info))
  41. (declare-function org-export-get-coderef-format "org-export" (path desc))
  42. (declare-function org-export-get-footnote-definition "org-export" (footnote-reference info))
  43. (declare-function org-export-get-footnote-number "org-export" (footnote info))
  44. (declare-function org-export-get-previous-element "org-export" (blob info))
  45. (declare-function org-export-get-relative-level "org-export" (headline info))
  46. (declare-function org-export-handle-code
  47. "org-export" (element info &optional num-fmt ref-fmt delayed))
  48. (declare-function org-export-included-file "org-export" (keyword backend info))
  49. (declare-function org-export-inline-image-p "org-export" (link &optional extensions))
  50. (declare-function org-export-last-sibling-p "org-export" (headline info))
  51. (declare-function org-export-low-level-p "org-export" (headline info))
  52. (declare-function org-export-output-file-name
  53. "org-export" (extension &optional subtreep pub-dir))
  54. (declare-function org-export-resolve-coderef "org-export" (ref info))
  55. (declare-function org-export-resolve-fuzzy-link "org-export" (link info))
  56. (declare-function org-export-secondary-string "org-export" (secondary backend info))
  57. (declare-function org-export-solidify-link-text "org-export" (s))
  58. (declare-function org-export-table-format-info "org-export" (table))
  59. (declare-function
  60. org-export-to-buffer "org-export"
  61. (backend buffer &optional subtreep visible-only body-only ext-plist))
  62. (declare-function
  63. org-export-to-file "org-export"
  64. (backend file &optional subtreep visible-only body-only ext-plist))
  65. ;;; Internal Variables
  66. (defconst org-e-latex-option-alist
  67. '((:date "DATE" nil org-e-latex-date-format t)
  68. (:latex-class "LATEX_CLASS" nil org-e-latex-default-class t)
  69. (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t)
  70. (:latex-header-extra "LATEX_HEADER" nil nil newline))
  71. "Alist between LaTeX export properties and ways to set them.
  72. See `org-export-option-alist' for more information on the
  73. structure of the value.")
  74. ;;; User Configurable Variables
  75. (defgroup org-export-e-latex nil
  76. "Options for exporting Org mode files to LaTeX."
  77. :tag "Org Export LaTeX"
  78. :group 'org-export)
  79. ;;;; Preamble
  80. (defcustom org-e-latex-default-class "article"
  81. "The default LaTeX class."
  82. :group 'org-export-e-latex
  83. :type '(string :tag "LaTeX class"))
  84. (defcustom org-e-latex-classes
  85. '(("article"
  86. "\\documentclass[11pt]{article}"
  87. ("\\section{%s}" . "\\section*{%s}")
  88. ("\\subsection{%s}" . "\\subsection*{%s}")
  89. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
  90. ("\\paragraph{%s}" . "\\paragraph*{%s}")
  91. ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
  92. ("report"
  93. "\\documentclass[11pt]{report}"
  94. ("\\part{%s}" . "\\part*{%s}")
  95. ("\\chapter{%s}" . "\\chapter*{%s}")
  96. ("\\section{%s}" . "\\section*{%s}")
  97. ("\\subsection{%s}" . "\\subsection*{%s}")
  98. ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
  99. ("book"
  100. "\\documentclass[11pt]{book}"
  101. ("\\part{%s}" . "\\part*{%s}")
  102. ("\\chapter{%s}" . "\\chapter*{%s}")
  103. ("\\section{%s}" . "\\section*{%s}")
  104. ("\\subsection{%s}" . "\\subsection*{%s}")
  105. ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
  106. "Alist of LaTeX classes and associated header and structure.
  107. If #+LaTeX_CLASS is set in the buffer, use its value and the
  108. associated information. Here is the structure of each cell:
  109. \(class-name
  110. header-string
  111. \(numbered-section . unnumbered-section\)
  112. ...\)
  113. The header string
  114. -----------------
  115. The HEADER-STRING is the header that will be inserted into the LaTeX file.
  116. It should contain the \\documentclass macro, and anything else that is needed
  117. for this setup. To this header, the following commands will be added:
  118. - Calls to \\usepackage for all packages mentioned in the variables
  119. `org-e-latex-default-packages-alist' and
  120. `org-e-latex-packages-alist'. Thus, your header definitions should
  121. avoid to also request these packages.
  122. - Lines specified via \"#+LaTeX_HEADER:\"
  123. If you need more control about the sequence in which the header is built
  124. up, or if you want to exclude one of these building blocks for a particular
  125. class, you can use the following macro-like placeholders.
  126. [DEFAULT-PACKAGES] \\usepackage statements for default packages
  127. [NO-DEFAULT-PACKAGES] do not include any of the default packages
  128. [PACKAGES] \\usepackage statements for packages
  129. [NO-PACKAGES] do not include the packages
  130. [EXTRA] the stuff from #+LaTeX_HEADER
  131. [NO-EXTRA] do not include #+LaTeX_HEADER stuff
  132. [BEAMER-HEADER-EXTRA] the beamer extra headers
  133. So a header like
  134. \\documentclass{article}
  135. [NO-DEFAULT-PACKAGES]
  136. [EXTRA]
  137. \\providecommand{\\alert}[1]{\\textbf{#1}}
  138. [PACKAGES]
  139. will omit the default packages, and will include the #+LaTeX_HEADER lines,
  140. then have a call to \\providecommand, and then place \\usepackage commands
  141. based on the content of `org-e-latex-packages-alist'.
  142. If your header or `org-e-latex-default-packages-alist' inserts
  143. \"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be replaced with
  144. a coding system derived from `buffer-file-coding-system'. See also the
  145. variable `org-e-latex-inputenc-alist' for a way to influence this
  146. mechanism.
  147. The sectioning structure
  148. ------------------------
  149. The sectioning structure of the class is given by the elements following
  150. the header string. For each sectioning level, a number of strings is
  151. specified. A %s formatter is mandatory in each section string and will
  152. be replaced by the title of the section.
  153. Instead of a cons cell \(numbered . unnumbered\), you can also
  154. provide a list of 2 or 4 elements,
  155. \(numbered-open numbered-close\)
  156. or
  157. \(numbered-open numbered-close unnumbered-open unnumbered-close\)
  158. providing opening and closing strings for a LaTeX environment that should
  159. represent the document section. The opening clause should have a %s
  160. to represent the section title.
  161. Instead of a list of sectioning commands, you can also specify a
  162. function name. That function will be called with two parameters,
  163. the (reduced) level of the headline, and a predicate non-nil when
  164. the headline should be numbered. It must return a format string in
  165. which the section title will be added."
  166. :group 'org-export-e-latex
  167. :type '(repeat
  168. (list (string :tag "LaTeX class")
  169. (string :tag "LaTeX header")
  170. (repeat :tag "Levels" :inline t
  171. (choice
  172. (cons :tag "Heading"
  173. (string :tag " numbered")
  174. (string :tag "unnumbered"))
  175. (list :tag "Environment"
  176. (string :tag "Opening (numbered)")
  177. (string :tag "Closing (numbered)")
  178. (string :tag "Opening (unnumbered)")
  179. (string :tag "Closing (unnumbered)"))
  180. (function :tag "Hook computing sectioning"))))))
  181. (defcustom org-e-latex-inputenc-alist nil
  182. "Alist of inputenc coding system names, and what should really be used.
  183. For example, adding an entry
  184. (\"utf8\" . \"utf8x\")
  185. will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
  186. are written as utf8 files."
  187. :group 'org-export-e-latex
  188. :type '(repeat
  189. (cons
  190. (string :tag "Derived from buffer")
  191. (string :tag "Use this instead"))))
  192. (defcustom org-e-latex-date-format
  193. "\\today"
  194. "Format string for \\date{...}."
  195. :group 'org-export-e-latex
  196. :type 'boolean)
  197. (defcustom org-e-latex-title-command "\\maketitle"
  198. "The command used to insert the title just after \\begin{document}.
  199. If this string contains the formatting specification \"%s\" then
  200. it will be used as a formatting string, passing the title as an
  201. argument."
  202. :group 'org-export-e-latex
  203. :type 'string)
  204. ;;;; Headline
  205. (defcustom org-e-latex-format-headline-function nil
  206. "Function to format headline text.
  207. This function will be called with 5 arguments:
  208. TODO the todo keyword \(string or nil\).
  209. TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
  210. PRIORITY the priority of the headline \(integer or nil\)
  211. TEXT the main headline text \(string\).
  212. TAGS the tags string, separated with colons \(string or nil\).
  213. The function result will be used in the section format string.
  214. As an example, one could set the variable to the following, in
  215. order to reproduce the default set-up:
  216. \(defun org-e-latex-format-headline \(todo todo-type priority text tags\)
  217. \"Default format function for an headline.\"
  218. \(concat \(when todo
  219. \(format \"\\\\textbf{\\\\textsc{\\\\textsf{%s}}} \" todo\)\)
  220. \(when priority
  221. \(format \"\\\\framebox{\\\\#%c} \" priority\)\)
  222. text
  223. \(when tags \(format \"\\\\hfill{}\\\\textsc{%s}\" tags\)\)\)\)"
  224. :group 'org-export-e-latex
  225. :type 'function)
  226. ;;;; Emphasis
  227. (defcustom org-e-latex-emphasis-alist
  228. '(("*" . "\\textbf{%s}")
  229. ("/" . "\\emph{%s}")
  230. ("_" . "\\underline{%s}")
  231. ("+" . "\\st{%s}")
  232. ("=" . protectedtexttt)
  233. ("~" . verb))
  234. "Alist of LaTeX expressions to convert emphasis fontifiers.
  235. The key is the character used as a marker for fontification. The
  236. value is a formatting string to wrap fontified text with.
  237. Value can also be set to the following symbols: `verb' and
  238. `protectedtexttt'. For the former, Org will use \"\\verb\" to
  239. create a format string and select a delimiter character that
  240. isn't in the string. For the latter, Org will use \"\\texttt\"
  241. to typeset and try to protect special characters."
  242. :group 'org-export-e-latex
  243. :type 'alist)
  244. ;;;; Footnotes
  245. (defcustom org-e-latex-footnote-separator "\\textsuperscript{,}\\,"
  246. "Text used to separate footnotes."
  247. :group 'org-export-e-latex
  248. :type 'string)
  249. ;;;; Time-stamps
  250. (defcustom org-e-latex-active-timestamp-format "\\textit{%s}"
  251. "A printf format string to be applied to active time-stamps."
  252. :group 'org-export-e-latex
  253. :type 'string)
  254. (defcustom org-e-latex-inactive-timestamp-format "\\textit{%s}"
  255. "A printf format string to be applied to inactive time-stamps."
  256. :group 'org-export-e-latex
  257. :type 'string)
  258. (defcustom org-e-latex-diary-timestamp-format "\\textit{%s}"
  259. "A printf format string to be applied to diary time-stamps."
  260. :group 'org-export-e-latex
  261. :type 'string)
  262. ;;;; Links
  263. (defcustom org-e-latex-image-default-option "width=.9\\linewidth"
  264. "Default option for images."
  265. :group 'org-export-e-latex
  266. :type 'string)
  267. (defcustom org-e-latex-default-figure-position "htb"
  268. "Default position for latex figures."
  269. :group 'org-export-e-latex
  270. :type 'string)
  271. (defcustom org-e-latex-inline-image-extensions
  272. '("pdf" "jpeg" "jpg" "png" "ps" "eps")
  273. "Extensions of image files that can be inlined into LaTeX.
  274. Note that the image extension *actually* allowed depend on the
  275. way the LaTeX file is processed. When used with pdflatex, pdf,
  276. jpg and png images are OK. When processing through dvi to
  277. Postscript, only ps and eps are allowed. The default we use here
  278. encompasses both."
  279. :group 'org-export-e-latex
  280. :type '(repeat (string :tag "Extension")))
  281. ;;;; Tables
  282. (defcustom org-e-latex-default-table-environment "tabular"
  283. "Default environment used to build tables."
  284. :group 'org-export-e-latex
  285. :type 'string)
  286. (defcustom org-e-latex-tables-centered t
  287. "When non-nil, tables are exported in a center environment."
  288. :group 'org-export-e-latex
  289. :type 'boolean)
  290. (defcustom org-e-latex-tables-verbatim nil
  291. "When non-nil, tables are exported verbatim."
  292. :group 'org-export-e-latex
  293. :type 'boolean)
  294. (defcustom org-e-latex-table-caption-above t
  295. "When non-nil, place caption string at the beginning of the table.
  296. Otherwise, place it near the end."
  297. :group 'org-export-e-latex
  298. :type 'boolean)
  299. ;;;; Drawers
  300. (defcustom org-e-latex-format-drawer-function nil
  301. "Function called to format a drawer in LaTeX code.
  302. The function must accept two parameters:
  303. NAME the drawer name, like \"LOGBOOK\"
  304. CONTENTS the contents of the drawer.
  305. The function should return the string to be exported.
  306. For example, the variable could be set to the following function
  307. in order to mimic default behaviour:
  308. \(defun org-e-latex-format-drawer-default \(name contents\)
  309. \"Format a drawer element for LaTeX export.\"
  310. contents\)"
  311. :group 'org-export-e-latex
  312. :type 'function)
  313. ;;;; Inlinetasks
  314. (defcustom org-e-latex-format-inlinetask-function nil
  315. "Function called to format an inlinetask in LaTeX code.
  316. The function must accept six parameters:
  317. TODO the todo keyword, as a string
  318. TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
  319. PRIORITY the inlinetask priority, as a string
  320. NAME the inlinetask name, as a string.
  321. TAGS the inlinetask tags, as a string.
  322. CONTENTS the contents of the inlinetask, as a string.
  323. The function should return the string to be exported.
  324. For example, the variable could be set to the following function
  325. in order to mimic default behaviour:
  326. \(defun org-e-latex-format-inlinetask \(todo type priority name tags contents\)
  327. \"Format an inline task element for LaTeX export.\"
  328. \(let \(\(full-title
  329. \(concat
  330. \(when todo
  331. \(format \"\\\\textbf{\\\\textsf{\\\\textsc{%s}}} \" todo\)\)
  332. \(when priority \(format \"\\\\framebox{\\\\#%c} \" priority\)\)
  333. title
  334. \(when tags \(format \"\\\\hfill{}\\\\textsc{%s}\" tags\)\)\)\)\)
  335. \(format \(concat \"\\\\begin{center}\\n\"
  336. \"\\\\fbox{\\n\"
  337. \"\\\\begin{minipage}[c]{.6\\\\textwidth}\\n\"
  338. \"%s\\n\\n\"
  339. \"\\\\rule[.8em]{\\\\textwidth}{2pt}\\n\\n\"
  340. \"%s\"
  341. \"\\\\end{minipage}}\"
  342. \"\\\\end{center}\"\)
  343. full-title contents\)\)"
  344. :group 'org-export-e-latex
  345. :type 'function)
  346. ;; Src blocks
  347. (defcustom org-e-latex-listings nil
  348. "Non-nil means export source code using the listings package.
  349. This package will fontify source code, possibly even with color.
  350. If you want to use this, you also need to make LaTeX use the
  351. listings package, and if you want to have color, the color
  352. package. Just add these to `org-e-latex-packages-alist',
  353. for example using customize, or with something like
  354. (require 'org-e-latex)
  355. (add-to-list 'org-e-latex-packages-alist '(\"\" \"listings\"))
  356. (add-to-list 'org-e-latex-packages-alist '(\"\" \"color\"))
  357. Alternatively,
  358. (setq org-e-latex-listings 'minted)
  359. causes source code to be exported using the minted package as
  360. opposed to listings. If you want to use minted, you need to add
  361. the minted package to `org-e-latex-packages-alist', for
  362. example using customize, or with
  363. (require 'org-e-latex)
  364. (add-to-list 'org-e-latex-packages-alist '(\"\" \"minted\"))
  365. In addition, it is necessary to install
  366. pygments (http://pygments.org), and to configure the variable
  367. `org-e-latex-to-pdf-process' so that the -shell-escape option is
  368. passed to pdflatex."
  369. :group 'org-export-e-latex
  370. :type '(choice
  371. (const :tag "Use listings" t)
  372. (const :tag "Use minted" 'minted)
  373. (const :tag "Export verbatim" nil)))
  374. (defcustom org-e-latex-listings-langs
  375. '((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
  376. (c "C") (cc "C++")
  377. (fortran "fortran")
  378. (perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
  379. (html "HTML") (xml "XML")
  380. (tex "TeX") (latex "TeX")
  381. (shell-script "bash")
  382. (gnuplot "Gnuplot")
  383. (ocaml "Caml") (caml "Caml")
  384. (sql "SQL") (sqlite "sql"))
  385. "Alist mapping languages to their listing language counterpart.
  386. The key is a symbol, the major mode symbol without the \"-mode\".
  387. The value is the string that should be inserted as the language parameter
  388. for the listings package. If the mode name and the listings name are
  389. the same, the language does not need an entry in this list - but it does not
  390. hurt if it is present."
  391. :group 'org-export-e-latex
  392. :type '(repeat
  393. (list
  394. (symbol :tag "Major mode ")
  395. (string :tag "Listings language"))))
  396. (defcustom org-e-latex-listings-options nil
  397. "Association list of options for the latex listings package.
  398. These options are supplied as a comma-separated list to the
  399. \\lstset command. Each element of the association list should be
  400. a list containing two strings: the name of the option, and the
  401. value. For example,
  402. (setq org-e-latex-listings-options
  403. '((\"basicstyle\" \"\\small\")
  404. (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
  405. will typeset the code in a small size font with underlined, bold
  406. black keywords.
  407. Note that the same options will be applied to blocks of all
  408. languages."
  409. :group 'org-export-e-latex
  410. :type '(repeat
  411. (list
  412. (string :tag "Listings option name ")
  413. (string :tag "Listings option value"))))
  414. (defcustom org-e-latex-minted-langs
  415. '((emacs-lisp "common-lisp")
  416. (cc "c++")
  417. (cperl "perl")
  418. (shell-script "bash")
  419. (caml "ocaml"))
  420. "Alist mapping languages to their minted language counterpart.
  421. The key is a symbol, the major mode symbol without the \"-mode\".
  422. The value is the string that should be inserted as the language parameter
  423. for the minted package. If the mode name and the listings name are
  424. the same, the language does not need an entry in this list - but it does not
  425. hurt if it is present.
  426. Note that minted uses all lower case for language identifiers,
  427. and that the full list of language identifiers can be obtained
  428. with:
  429. pygmentize -L lexers"
  430. :group 'org-export-e-latex
  431. :type '(repeat
  432. (list
  433. (symbol :tag "Major mode ")
  434. (string :tag "Minted language"))))
  435. (defcustom org-e-latex-minted-options nil
  436. "Association list of options for the latex minted package.
  437. These options are supplied within square brackets in
  438. \\begin{minted} environments. Each element of the alist should
  439. be a list containing two strings: the name of the option, and the
  440. value. For example,
  441. (setq org-e-latex-minted-options
  442. '((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
  443. will result in src blocks being exported with
  444. \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
  445. as the start of the minted environment. Note that the same
  446. options will be applied to blocks of all languages."
  447. :group 'org-export-e-latex
  448. :type '(repeat
  449. (list
  450. (string :tag "Minted option name ")
  451. (string :tag "Minted option value"))))
  452. (defvar org-e-latex-custom-lang-environments nil
  453. "Alist mapping languages to language-specific LaTeX environments.
  454. It is used during export of src blocks by the listings and minted
  455. latex packages. For example,
  456. \(setq org-e-latex-custom-lang-environments
  457. '\(\(python \"pythoncode\"\)\)\)
  458. would have the effect that if org encounters begin_src python
  459. during latex export it will output
  460. \\begin{pythoncode}
  461. <src block body>
  462. \\end{pythoncode}")
  463. ;;;; Plain text
  464. (defcustom org-e-latex-quotes
  465. '(("fr" ("\\(\\s-\\|[[(]\\)\"" . "«~") ("\\(\\S-\\)\"" . "~»") ("\\(\\s-\\|(\\)'" . "'"))
  466. ("en" ("\\(\\s-\\|[[(]\\)\"" . "``") ("\\(\\S-\\)\"" . "''") ("\\(\\s-\\|(\\)'" . "`")))
  467. "Alist for quotes to use when converting english double-quotes.
  468. The CAR of each item in this alist is the language code.
  469. The CDR of each item in this alist is a list of three CONS:
  470. - the first CONS defines the opening quote;
  471. - the second CONS defines the closing quote;
  472. - the last CONS defines single quotes.
  473. For each item in a CONS, the first string is a regexp
  474. for allowed characters before/after the quote, the second
  475. string defines the replacement string for this quote."
  476. :group 'org-export-e-latex
  477. :type '(list
  478. (cons :tag "Opening quote"
  479. (string :tag "Regexp for char before")
  480. (string :tag "Replacement quote "))
  481. (cons :tag "Closing quote"
  482. (string :tag "Regexp for char after ")
  483. (string :tag "Replacement quote "))
  484. (cons :tag "Single quote"
  485. (string :tag "Regexp for char before")
  486. (string :tag "Replacement quote "))))
  487. ;;;; Compilation
  488. (defcustom org-e-latex-pdf-process
  489. '("pdflatex -interaction nonstopmode -output-directory %o %f"
  490. "pdflatex -interaction nonstopmode -output-directory %o %f"
  491. "pdflatex -interaction nonstopmode -output-directory %o %f")
  492. "Commands to process a LaTeX file to a PDF file.
  493. This is a list of strings, each of them will be given to the shell
  494. as a command. %f in the command will be replaced by the full file name, %b
  495. by the file base name (i.e. without extension) and %o by the base directory
  496. of the file.
  497. The reason why this is a list is that it usually takes several runs of
  498. `pdflatex', maybe mixed with a call to `bibtex'. Org does not have a clever
  499. mechanism to detect which of these commands have to be run to get to a stable
  500. result, and it also does not do any error checking.
  501. By default, Org uses 3 runs of `pdflatex' to do the processing. If you
  502. have texi2dvi on your system and if that does not cause the infamous
  503. egrep/locale bug:
  504. http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
  505. then `texi2dvi' is the superior choice. Org does offer it as one
  506. of the customize options.
  507. Alternatively, this may be a Lisp function that does the processing, so you
  508. could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
  509. This function should accept the file name as its single argument."
  510. :group 'org-export-pdf
  511. :type '(choice
  512. (repeat :tag "Shell command sequence"
  513. (string :tag "Shell command"))
  514. (const :tag "2 runs of pdflatex"
  515. ("pdflatex -interaction nonstopmode -output-directory %o %f"
  516. "pdflatex -interaction nonstopmode -output-directory %o %f"))
  517. (const :tag "3 runs of pdflatex"
  518. ("pdflatex -interaction nonstopmode -output-directory %o %f"
  519. "pdflatex -interaction nonstopmode -output-directory %o %f"
  520. "pdflatex -interaction nonstopmode -output-directory %o %f"))
  521. (const :tag "pdflatex,bibtex,pdflatex,pdflatex"
  522. ("pdflatex -interaction nonstopmode -output-directory %o %f"
  523. "bibtex %b"
  524. "pdflatex -interaction nonstopmode -output-directory %o %f"
  525. "pdflatex -interaction nonstopmode -output-directory %o %f"))
  526. (const :tag "texi2dvi"
  527. ("texi2dvi -p -b -c -V %f"))
  528. (const :tag "rubber"
  529. ("rubber -d --into %o %f"))
  530. (function)))
  531. (defcustom org-e-latex-logfiles-extensions
  532. '("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
  533. "The list of file extensions to consider as LaTeX logfiles."
  534. :group 'org-export-e-latex
  535. :type '(repeat (string :tag "Extension")))
  536. (defcustom org-e-latex-remove-logfiles t
  537. "Non-nil means remove the logfiles produced by PDF production.
  538. These are the .aux, .log, .out, and .toc files."
  539. :group 'org-export-e-latex
  540. :type 'boolean)
  541. ;;; Internal Functions
  542. (defun org-e-latex--caption/label-string (caption label info)
  543. "Return caption and label LaTeX string for floats.
  544. CAPTION is a cons cell of secondary strings, the car being the
  545. standard caption and the cdr its short form. LABEL is a string
  546. representing the label. INFO is a plist holding contextual
  547. information.
  548. If there's no caption nor label, return the empty string.
  549. For non-floats, see `org-e-latex--wrap-label'."
  550. (let ((label-str (if label (format "\\label{%s}" label) "")))
  551. (cond
  552. ((and (not caption) (not label)) "")
  553. ((not caption) (format "\\label{%s}\n" label))
  554. ;; Option caption format with short name.
  555. ((cdr caption)
  556. (format "\\caption[%s]{%s%s}\n"
  557. (org-export-secondary-string (cdr caption) 'e-latex info)
  558. label-str
  559. (org-export-secondary-string (car caption) 'e-latex info)))
  560. ;; Standard caption format.
  561. (t (format "\\caption{%s%s}\n"
  562. label-str
  563. (org-export-secondary-string (car caption) 'e-latex info))))))
  564. (defun org-e-latex--guess-inputenc (header)
  565. "Set the coding system in inputenc to what the buffer is.
  566. HEADER is the LaTeX header string.
  567. Return the new header."
  568. (let* ((cs (or (ignore-errors
  569. (latexenc-coding-system-to-inputenc
  570. buffer-file-coding-system))
  571. "utf8")))
  572. (if (not cs)
  573. header
  574. ;; First translate if that is requested.
  575. (setq cs (or (cdr (assoc cs org-e-latex-inputenc-alist)) cs))
  576. ;; Then find the \usepackage statement and replace the option.
  577. (replace-regexp-in-string "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
  578. cs header t nil 1))))
  579. (defun org-e-latex--find-verb-separator (s)
  580. "Return a character not used in string S.
  581. This is used to choose a separator for constructs like \\verb."
  582. (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
  583. (loop for c across ll
  584. when (not (string-match (regexp-quote (char-to-string c)) s))
  585. return (char-to-string c))))
  586. (defun org-e-latex--make-option-string (options)
  587. "Return a comma separated string of keywords and values.
  588. OPTIONS is an alist where the key is the options keyword as
  589. a string, and the value a list containing the keyword value, or
  590. nil."
  591. (mapconcat (lambda (pair)
  592. (concat (first pair)
  593. (when (> (length (second pair)) 0)
  594. (concat "=" (second pair)))))
  595. options
  596. ","))
  597. (defun org-e-latex--quotation-marks (text info)
  598. "Export quotation marks depending on language conventions.
  599. TEXT is a string containing quotation marks to be replaced. INFO
  600. is a plist used as a communication channel."
  601. (mapc (lambda(l)
  602. (let ((start 0))
  603. (while (setq start (string-match (car l) text start))
  604. (let ((new-quote (concat (match-string 1 text) (cdr l))))
  605. (setq text (replace-match new-quote t t text))))))
  606. (cdr (or (assoc (plist-get info :language) org-e-latex-quotes)
  607. ;; Falls back on English.
  608. (assoc "en" org-e-latex-quotes))))
  609. text)
  610. (defun org-e-latex--wrap-label (element output)
  611. "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
  612. This function shouldn't be used for floats. See
  613. `org-e-latex--caption/label-string'."
  614. (let ((label (org-element-get-property :name element)))
  615. (if (or (not output) (not label) (string= output "") (string= label ""))
  616. output
  617. (concat (format "\\label{%s}\n" label) output))))
  618. ;;; Template
  619. (defun org-e-latex-template (contents info)
  620. "Return complete document string after LaTeX conversion.
  621. CONTENTS is the transcoded contents string. INFO is a plist
  622. holding export options."
  623. (let ((title (org-export-secondary-string
  624. (plist-get info :title) 'e-latex info)))
  625. (concat
  626. ;; 1. Time-stamp.
  627. (and (plist-get info :time-stamp-file)
  628. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  629. ;; 2. Document class and packages.
  630. (let ((class (plist-get info :latex-class))
  631. (class-options (plist-get info :latex-class-options)))
  632. (org-element-normalize-string
  633. (let* ((header (nth 1 (assoc class org-e-latex-classes)))
  634. (document-class-string
  635. (and (stringp header)
  636. (if class-options
  637. (replace-regexp-in-string
  638. "^[ \t]*\\\\documentclass\\(\\[.*?\\]\\)"
  639. class-options header t nil 1)
  640. header))))
  641. (org-e-latex--guess-inputenc
  642. (org-splice-latex-header
  643. document-class-string
  644. org-export-latex-default-packages-alist ; defined in org.el
  645. org-export-latex-packages-alist nil ; defined in org.el
  646. (plist-get info :latex-header-extra))))))
  647. ;; 3. Define alert if not yet defined.
  648. "\\providecommand{\\alert}[1]{\\textbf{#1}}\n"
  649. ;; 4. Author.
  650. (let ((author (and (plist-get info :with-author)
  651. (let ((auth (plist-get info :author)))
  652. (and auth (org-export-secondary-string
  653. auth 'e-latex info)))))
  654. (email (and (plist-get info :with-email)
  655. (org-export-secondary-string
  656. (plist-get info :email) 'e-latex info))))
  657. (cond ((and author email (not (string= "" email)))
  658. (format "\\author{%s\\thanks{%s}}\n" author email))
  659. (author (format "\\author{%s}\n" author))
  660. (t "\\author{}\n")))
  661. ;; 5. Date.
  662. (let ((date (plist-get info :date)))
  663. (and date (format "\\date{%s}\n" date)))
  664. ;; 6. Title
  665. (format "\\title{%s}\n" title)
  666. ;; 7. Hyperref options.
  667. (format "\\hypersetup{\n pdfkeywords={%s},\n pdfsubject={%s},\n pdfcreator={%s}}\n"
  668. (or (plist-get info :keywords) "")
  669. (or (plist-get info :description) "")
  670. (let ((creator-info (plist-get info :with-creator)))
  671. (cond
  672. ((not creator-info) "")
  673. ((eq creator-info 'comment) "")
  674. (t (plist-get info :creator)))))
  675. ;; 7. Document start.
  676. "\\begin{document}\n\n"
  677. ;; 8. Title command.
  678. (org-element-normalize-string
  679. (cond ((string= "" title) nil)
  680. ((not (stringp org-e-latex-title-command)) nil)
  681. ((string-match "\\(?:[^%]\\|^\\)%s"
  682. org-e-latex-title-command)
  683. (format org-e-latex-title-command title))
  684. (t org-e-latex-title-command)))
  685. ;; 9. Table of contents.
  686. (let ((depth (plist-get info :with-toc)))
  687. (when depth
  688. (concat (when (wholenump depth)
  689. (format "\\setcounter{tocdepth}{%d}\n" depth))
  690. "\\tableofcontents\n\\vspace*{1cm}\n\n")))
  691. ;; 10. Document's body.
  692. contents
  693. ;; 11. Creator.
  694. (let ((creator-info (plist-get info :with-creator)))
  695. (cond
  696. ((not creator-info))
  697. ((eq creator-info 'comment)
  698. (format "%% %s\n" (plist-get info :creator)))
  699. (t (concat (plist-get info :creator) "\n"))))
  700. ;; 12. Document end.
  701. "\\end{document}")))
  702. ;;; Transcode Functions
  703. ;;;; Block
  704. (defun org-e-latex-center-block (center-block contents info)
  705. "Transcode a CENTER-BLOCK element from Org to LaTeX.
  706. CONTENTS holds the contents of the block. INFO is a plist
  707. holding contextual information."
  708. (org-e-latex--wrap-label
  709. center-block
  710. (format "\\begin{center}\n%s\\end{center}" contents)))
  711. ;;;; Comment
  712. ;; Comments are ignored.
  713. ;;;; Comment Block
  714. ;; Comment Blocks are ignored.
  715. ;;;; Drawer
  716. (defun org-e-latex-drawer (drawer contents info)
  717. "Transcode a DRAWER element from Org to LaTeX.
  718. CONTENTS holds the contents of the block. INFO is a plist
  719. holding contextual information."
  720. (let* ((name (org-element-get-property :drawer-name drawer))
  721. (output (if (functionp org-e-latex-format-drawer-function)
  722. (funcall org-e-latex-format-drawer-function
  723. name contents)
  724. ;; If there's no user defined function: simply
  725. ;; display contents of the drawer.
  726. contents)))
  727. (org-e-latex--wrap-label drawer output)))
  728. ;;;; Dynamic Block
  729. (defun org-e-latex-dynamic-block (dynamic-block contents info)
  730. "Transcode a DYNAMIC-BLOCK element from Org to LaTeX.
  731. CONTENTS holds the contents of the block. INFO is a plist
  732. holding contextual information. See
  733. `org-export-data'."
  734. (org-e-latex--wrap-label dynamic-block contents))
  735. ;;;; Emphasis
  736. (defun org-e-latex-emphasis (emphasis contents info)
  737. "Transcode EMPHASIS from Org to LaTeX.
  738. CONTENTS is the contents of the emphasized text. INFO is a plist
  739. holding contextual information.."
  740. (format (cdr (assoc (org-element-get-property :marker emphasis)
  741. org-e-latex-emphasis-alist))
  742. contents))
  743. ;;;; Entity
  744. (defun org-e-latex-entity (entity contents info)
  745. "Transcode an ENTITY object from Org to LaTeX.
  746. CONTENTS are the definition itself. INFO is a plist holding
  747. contextual information."
  748. (let ((ent (org-element-get-property :latex entity)))
  749. (if (org-element-get-property :latex-math-p entity)
  750. (format "$%s$" ent)
  751. ent)))
  752. ;;;; Example Block
  753. (defun org-e-latex-example-block (example-block contents info)
  754. "Transcode a EXAMPLE-BLOCK element from Org to LaTeX.
  755. CONTENTS is nil. INFO is a plist holding contextual information."
  756. (let* ((options (or (org-element-get-property :options example-block) ""))
  757. (value (org-export-handle-code example-block info)))
  758. (org-e-latex--wrap-label
  759. example-block (format "\\begin{verbatim}\n%s\\end{verbatim}" value))))
  760. ;;;; Export Snippet
  761. (defun org-e-latex-export-snippet (export-snippet contents info)
  762. "Transcode a EXPORT-SNIPPET object from Org to LaTeX.
  763. CONTENTS is nil. INFO is a plist holding contextual information."
  764. (org-element-get-property :value export-snippet))
  765. ;;;; Export Block
  766. (defun org-e-latex-export-block (export-block contents info)
  767. "Transcode a EXPORT-BLOCK element from Org to LaTeX.
  768. CONTENTS is nil. INFO is a plist holding contextual information."
  769. (when (string= (org-element-get-property :type export-block) "latex")
  770. (org-remove-indentation (org-element-get-property :value export-block))))
  771. ;;;; Fixed Width
  772. (defun org-e-latex-fixed-width (fixed-width contents info)
  773. "Transcode a FIXED-WIDTH element from Org to LaTeX.
  774. CONTENTS is nil. INFO is a plist holding contextual information."
  775. (let* ((value (org-element-normalize-string
  776. (replace-regexp-in-string
  777. "^[ \t]*: ?" ""
  778. (org-element-get-property :value fixed-width)))))
  779. (org-e-latex--wrap-label
  780. fixed-width (format "\\begin{verbatim}\n%s\\end{verbatim}" value))))
  781. ;;;; Footnote Definition
  782. ;; Footnote Definitions are ignored.
  783. ;;;; Footnote Reference
  784. (defun org-e-latex-footnote-reference (footnote-reference contents info)
  785. "Transcode a FOOTNOTE-REFERENCE element from Org to LaTeX.
  786. CONTENTS is nil. INFO is a plist holding contextual information."
  787. (concat
  788. ;; Insert separator between two footnotes in a row.
  789. (let ((prev (org-export-get-previous-element footnote-reference info)))
  790. (when (and (listp prev) (eq (car prev) 'footnote-reference))
  791. org-e-latex-footnote-separator))
  792. ;; Use \footnotemark if the footnote has already been defined.
  793. ;; Otherwise, define it with \footnote command.
  794. (cond
  795. ((not (org-export-footnote-first-reference-p footnote-reference info))
  796. (format "\\footnotemark[%s]"
  797. (org-export-get-footnote-number footnote-reference info)))
  798. ;; Inline definitions are secondary strings.
  799. ((eq (org-element-get-property :type footnote-reference) 'inline)
  800. (format "\\footnote{%s}"
  801. (org-trim
  802. (org-export-secondary-string
  803. (org-export-get-footnote-definition footnote-reference info)
  804. 'e-latex info))))
  805. ;; Non-inline footnotes definitions are full Org data.
  806. (t
  807. (format "\\footnote{%s}"
  808. (org-trim
  809. (org-export-data
  810. (org-export-get-footnote-definition footnote-reference info)
  811. 'e-latex info)))))))
  812. ;;;; Headline
  813. (defun org-e-latex-headline (headline contents info)
  814. "Transcode an HEADLINE element from Org to LaTeX.
  815. CONTENTS holds the contents of the headline. INFO is a plist
  816. holding contextual information."
  817. (let* ((class (plist-get info :latex-class))
  818. (numberedp (plist-get info :section-numbers))
  819. ;; Get level relative to current parsed data.
  820. (level (org-export-get-relative-level headline info))
  821. (class-sectionning (assoc class org-e-latex-classes))
  822. ;; Section formatting will set two placeholders: one for the
  823. ;; title and the other for the contents.
  824. (section-fmt
  825. (let ((sec (if (and (symbolp (nth 2 class-sectionning))
  826. (fboundp (nth 2 class-sectionning)))
  827. (funcall (nth 2 class-sectionning) level numberedp)
  828. (nth (1+ level) class-sectionning))))
  829. (cond
  830. ;; No section available for that LEVEL.
  831. ((not sec) nil)
  832. ;; Section format directly returned by a function.
  833. ((stringp sec) sec)
  834. ;; (numbered-section . unnumbered-section)
  835. ((not (consp (cdr sec)))
  836. (concat (funcall (if numberedp #'car #'cdr) sec) "\n%s"))
  837. ;; (numbered-open numbered-close)
  838. ((= (length sec) 2)
  839. (when numberedp (concat (car sec) "\n%s" (nth 1 sec))))
  840. ;; (num-in num-out no-num-in no-num-out)
  841. ((= (length sec) 4)
  842. (if numberedp
  843. (concat (car sec) "\n%s" (nth 1 sec))
  844. (concat (nth 2 sec) "\n%s" (nth 3 sec)))))))
  845. (text (org-export-secondary-string
  846. (org-element-get-property :title headline) 'e-latex info))
  847. (todo (and (plist-get info :with-todo-keywords)
  848. (let ((todo (org-element-get-property
  849. :todo-keyword headline)))
  850. (and todo
  851. (org-export-secondary-string todo 'e-latex info)))))
  852. (todo-type (and todo (org-element-get-property :todo-type headline)))
  853. (tags (and (plist-get info :with-tags)
  854. (org-element-get-property :tags headline)))
  855. (priority (and (plist-get info :with-priority)
  856. (org-element-get-property :priority headline)))
  857. ;; Create the headline text.
  858. (full-text (if (functionp org-e-latex-format-headline-function)
  859. ;; User-defined formatting function.
  860. (funcall org-e-latex-format-headline-function
  861. todo todo-type priority text tags)
  862. ;; Default formatting.
  863. (concat
  864. (when todo
  865. (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
  866. (when priority (format "\\framebox{\\#%c} " priority))
  867. text
  868. (when tags (format "\\hfill{}\\textsc{%s}" tags)))))
  869. ;; Associate some \label to the headline for internal links.
  870. (headline-labels (mapconcat
  871. (lambda (p)
  872. (let ((val (org-element-get-property p headline)))
  873. (when val (format "\\label{%s}\n"
  874. (if (eq p :begin)
  875. (format "headline-%s" val)
  876. val)))))
  877. '(:custom-id :id :begin) ""))
  878. (pre-blanks (make-string (org-element-get-property :pre-blank headline)
  879. 10)))
  880. (cond
  881. ;; Case 1: This is a footnote section: ignore it.
  882. ((org-element-get-property :footnote-section-p headline) nil)
  883. ;; Case 2. This is a deep sub-tree: export it as a list item.
  884. ;; Also export as items headlines for which no section
  885. ;; format has been found.
  886. ((or (not section-fmt) (org-export-low-level-p headline info))
  887. ;; Build the real contents of the sub-tree.
  888. (let ((low-level-body
  889. (concat
  890. ;; If the headline is the first sibling, start a list.
  891. (when (org-export-first-sibling-p headline info)
  892. (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize)))
  893. ;; Itemize headline
  894. "\\item " full-text "\n" headline-labels pre-blanks contents)))
  895. ;; If headline in the last sibling, close the list, before any
  896. ;; blank line. Otherwise, simply return LOW-LEVEL-BODY.
  897. (if (org-export-last-sibling-p headline info)
  898. (replace-regexp-in-string
  899. "[ \t\n]*\\'"
  900. (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize))
  901. low-level-body)
  902. low-level-body)))
  903. ;; Case 3. Standard headline. Export it as a section.
  904. (t (format section-fmt full-text
  905. (concat headline-labels pre-blanks contents))))))
  906. ;;;; Horizontal Rule
  907. (defun org-e-latex-horizontal-rule (horizontal-rule contents info)
  908. "Transcode an HORIZONTAL-RULE object from Org to LaTeX.
  909. CONTENTS is nil. INFO is a plist holding contextual information."
  910. (let ((attr (mapconcat #'identity
  911. (org-element-get-property :attr_latex horizontal-rule)
  912. " ")))
  913. (org-e-latex--wrap-label horizontal-rule (concat "\\hrule " attr))))
  914. ;;;; Inline Babel Call
  915. ;; Inline Babel Calls are ignored.
  916. ;;;; Inline Src Block
  917. (defun org-e-latex-inline-src-block (inline-src-block contents info)
  918. "Transcode an INLINE-SRC-BLOCK element from Org to LaTeX.
  919. CONTENTS holds the contents of the item. INFO is a plist holding
  920. contextual information."
  921. (let* ((code (org-element-get-property :value inline-src-block))
  922. (separator (org-e-latex--find-verb-separator code)))
  923. (cond
  924. ;; Do not use a special package: transcode it verbatim.
  925. ((not org-e-latex-listings)
  926. (concat "\\verb" separator code separator))
  927. ;; Use minted package.
  928. ((eq org-e-latex-listings 'minted)
  929. (let* ((org-lang (org-element-get-property :language inline-src-block))
  930. (mint-lang (or (cadr (assq (intern org-lang)
  931. org-e-latex-minted-langs))
  932. org-lang))
  933. (options (org-e-latex--make-option-string
  934. org-e-latex-minted-options)))
  935. (concat (format "\\mint%s{%s}"
  936. (if (string= options "") "" (format "[%s]" options))
  937. mint-lang)
  938. separator code separator)))
  939. ;; Use listings package.
  940. (t
  941. ;; Maybe translate language's name.
  942. (let* ((org-lang (org-element-get-property :language inline-src-block))
  943. (lst-lang (or (cadr (assq (intern org-lang)
  944. org-e-latex-listings-langs))
  945. org-lang))
  946. (options (org-e-latex--make-option-string
  947. (append org-e-latex-listings-options
  948. `(("language" ,lst-lang))))))
  949. (concat (format "\\lstinline[%s]" options)
  950. separator code separator))))))
  951. ;;;; Inlinetask
  952. (defun org-e-latex-inlinetask (inlinetask contents info)
  953. "Transcode an INLINETASK element from Org to LaTeX.
  954. CONTENTS holds the contents of the block. INFO is a plist
  955. holding contextual information."
  956. (let ((title (org-export-secondary-string
  957. (org-element-get-property :title inlinetask) 'e-latex info))
  958. (todo (and (plist-get info :with-todo-keywords)
  959. (let ((todo (org-element-get-property
  960. :todo-keyword inlinetask)))
  961. (and todo
  962. (org-export-secondary-string todo 'e-latex info)))))
  963. (todo-type (org-element-get-property :todo-type inlinetask))
  964. (tags (and (plist-get info :with-tags)
  965. (org-element-get-property :tags inlinetask)))
  966. (priority (and (plist-get info :with-priority)
  967. (org-element-get-property :priority inlinetask))))
  968. ;; If `org-e-latex-format-inlinetask-function' is provided, call it
  969. ;; with appropriate arguments.
  970. (if (functionp org-e-latex-format-inlinetask-function)
  971. (funcall org-e-latex-format-inlinetask-function
  972. todo todo-type priority title tags contents)
  973. ;; Otherwise, use a default template.
  974. (org-e-latex--wrap-label
  975. inlinetask
  976. (let ((full-title
  977. (concat
  978. (when todo (format "\\textbf{\\textsf{\\textsc{%s}}} " todo))
  979. (when priority (format "\\framebox{\\#%c} " priority))
  980. title
  981. (when tags (format "\\hfill{}\\textsc{%s}" tags)))))
  982. (format (concat "\\begin{center}\n"
  983. "\\fbox{\n"
  984. "\\begin{minipage}[c]{.6\\textwidth}\n"
  985. "%s\n\n"
  986. "\\rule[.8em]{\\textwidth}{2pt}\n\n"
  987. "%s"
  988. "\\end{minipage}\n"
  989. "}\n"
  990. "\\end{center}")
  991. full-title contents))))))
  992. ;;;; Item
  993. (defun org-e-latex-item (item contents info)
  994. "Transcode an ITEM element from Org to LaTeX.
  995. CONTENTS holds the contents of the item. INFO is a plist holding
  996. contextual information."
  997. ;; Grab `:level' from plain-list properties, which is always the
  998. ;; first element above current item.
  999. (let* ((level (org-element-get-property
  1000. :level (car (plist-get info :genealogy))))
  1001. (counter (let ((count (org-element-get-property :counter item)))
  1002. (and count
  1003. (< level 4)
  1004. (format "\\setcounter{enum%s}{%s}\n"
  1005. (nth level '("i" "ii" "iii" "iv"))
  1006. (1- count)))))
  1007. (checkbox (let ((checkbox (org-element-get-property :checkbox item)))
  1008. (cond ((eq checkbox 'on) "$\\boxtimes$ ")
  1009. ((eq checkbox 'off) "$\\Box$ ")
  1010. ((eq checkbox 'trans) "$\\boxminus$ "))))
  1011. (tag (let ((tag (org-element-get-property :tag item)))
  1012. (and tag
  1013. (format "[%s]" (org-export-secondary-string
  1014. tag 'e-latex info))))))
  1015. (concat counter "\\item" tag " " checkbox contents)))
  1016. ;;;; Keyword
  1017. (defun org-e-latex-keyword (keyword contents info)
  1018. "Transcode a KEYWORD element from Org to LaTeX.
  1019. CONTENTS is nil. INFO is a plist holding contextual information."
  1020. (let ((key (downcase (org-element-get-property :key keyword)))
  1021. (value (org-element-get-property :value keyword)))
  1022. (cond
  1023. ((string= key "latex") value)
  1024. ((string= key "index") (format "\\index{%s}" value))
  1025. ((string= key "target")
  1026. (format "\\label{%s}" (org-export-solidify-link-text value)))
  1027. ((string= key "toc")
  1028. (let ((value (downcase value)))
  1029. (cond
  1030. ((string-match "\\<headlines\\>" value)
  1031. (let ((depth (or (and (string-match "[0-9]+" value)
  1032. (string-to-number (match-string 0 value)))
  1033. (plist-get info :with-toc))))
  1034. (concat
  1035. (when (wholenump depth)
  1036. (format "\\setcounter{tocdepth}{%s}\n" depth))
  1037. "\\tableofcontents")))
  1038. ((string= "tables" value) "\\listoftables")
  1039. ((string= "figures" value) "\\listoffigures")
  1040. ((string= "listings" value) "\\listoflistings"))))
  1041. ((string= key "include")
  1042. (org-export-included-file keyword 'e-latex info)))))
  1043. ;;;; Latex Environment
  1044. (defun org-e-latex-latex-environment (latex-environment contents info)
  1045. "Transcode a LATEX-ENVIRONMENT element from Org to LaTeX.
  1046. CONTENTS is nil. INFO is a plist holding contextual information."
  1047. (org-e-latex--wrap-label
  1048. latex-environment
  1049. (org-remove-indentation (org-element-get-property :value latex-environment))))
  1050. ;;;; Latex Fragment
  1051. (defun org-e-latex-latex-fragment (latex-fragment contents info)
  1052. "Transcode a LATEX-FRAGMENT object from Org to LaTeX.
  1053. CONTENTS is nil. INFO is a plist holding contextual information."
  1054. (org-element-get-property :value latex-fragment))
  1055. ;;;; Line Break
  1056. (defun org-e-latex-line-break (line-break contents info)
  1057. "Transcode a LINE-BREAK object from Org to LaTeX.
  1058. CONTENTS is nil. INFO is a plist holding contextual information."
  1059. "\\\\")
  1060. ;;;; Link
  1061. (defun org-e-latex-link--inline-image (path info)
  1062. "Return LaTeX code for an image at PATH.
  1063. INFO is a plist containing export options."
  1064. (let* ((parent-props (nth 1 (car (plist-get info :genealogy))))
  1065. (caption (org-e-latex--caption/label-string
  1066. (plist-get parent-props :caption)
  1067. (plist-get parent-props :name)
  1068. info))
  1069. ;; Retrieve latex attributes from the element around.
  1070. (attr (let ((raw-attr
  1071. (mapconcat #'identity
  1072. (plist-get parent-props :attr_latex) " ")))
  1073. (unless (string= raw-attr "") raw-attr)))
  1074. (disposition
  1075. (cond
  1076. ((and attr (string-match "\\<wrap\\>" attr)) 'wrap)
  1077. ((and attr (string-match "\\<multicolumn\\>" attr)) 'multicolumn)
  1078. ((or (and attr (string-match "\\<float\\>" attr))
  1079. (not (string= caption "")))
  1080. 'float)))
  1081. (placement
  1082. (cond
  1083. ((and attr (string-match "\\<placement=\\(\\S-+\\)" attr))
  1084. (org-match-string-no-properties 1 attr))
  1085. ((eq disposition 'wrap) "{l}{0.5\\textwidth}")
  1086. ((eq disposition 'float)
  1087. (concat "[" org-e-latex-default-figure-position "]"))
  1088. (t ""))))
  1089. ;; Now clear ATTR from any special keyword and set a default
  1090. ;; value if nothing is left.
  1091. (setq attr
  1092. (if (not attr) ""
  1093. (org-trim
  1094. (replace-regexp-in-string
  1095. "\\(wrap\\|multicolumn\\|float\\|placement=\\S-+\\)" "" attr))))
  1096. (setq attr (cond ((not (string= attr "")) attr)
  1097. ((eq disposition 'float) "width=0.7\\textwidth")
  1098. ((eq disposition 'wrap) "width=0.48\\textwidth")
  1099. (t (or org-e-latex-image-default-option ""))))
  1100. ;; Return proper string, depending on DISPOSITION.
  1101. (case disposition
  1102. ('wrap (format "\\begin{wrapfigure}%s
  1103. \\centering
  1104. \\includegraphics[%s]{%s}
  1105. %s\\end{wrapfigure}" placement attr path caption))
  1106. ('mulicolumn (format "\\begin{figure*}%s
  1107. \\centering
  1108. \\includegraphics[%s]{%s}
  1109. %s\\end{figure*}" placement attr path caption))
  1110. ('float (format "\\begin{figure}%s
  1111. \\centering
  1112. \\includegraphics[%s]{%s}
  1113. %s\\end{figure}" placement attr path caption))
  1114. (t (format "\\includegraphics[%s]{%s}" attr path)))))
  1115. (defun org-e-latex-link (link desc info)
  1116. "Transcode a LINK object from Org to LaTeX.
  1117. DESC is the description part of the link, or the empty string.
  1118. INFO is a plist holding contextual information. See
  1119. `org-export-data'."
  1120. (let* ((type (org-element-get-property :type link))
  1121. (raw-path (org-element-get-property :path link))
  1122. ;; Ensure DESC really exists, or set it to nil.
  1123. (desc (and (not (string= desc "")) desc))
  1124. (imagep (org-export-inline-image-p
  1125. link org-e-latex-inline-image-extensions))
  1126. (path (cond
  1127. ((member type '("http" "https" "ftp" "mailto"))
  1128. (concat type ":" raw-path))
  1129. (imagep (if (not (file-name-absolute-p raw-path)) raw-path
  1130. (expand-file-name raw-path)))
  1131. ((string= type "file")
  1132. (when (string-match "\\(.+\\)::.+" raw-path)
  1133. (setq raw-path (match-string 1 raw-path)))
  1134. (if (file-name-absolute-p raw-path)
  1135. (concat "file://" (expand-file-name raw-path))
  1136. ;; TODO: Not implemented yet. Concat also:
  1137. ;; (org-export-directory :LaTeX info)
  1138. (concat "file://" raw-path)))
  1139. (t raw-path)))
  1140. protocol)
  1141. (cond
  1142. ;; Image file.
  1143. (imagep (org-e-latex-link--inline-image path info))
  1144. ;; Id: for now, assume it's an internal link. TODO: do something
  1145. ;; to check if it isn't in the current file.
  1146. ((string= type "id")
  1147. (format "\\hyperref[%s]{%s}" path (or desc path)))
  1148. ;; Custom-id, target or radioed target: replace link with the
  1149. ;; normalized custom-id/target name.
  1150. ((member type '("custom-id" "target" "radio"))
  1151. (format "\\hyperref[%s]{%s}"
  1152. (org-export-solidify-link-text path)
  1153. (or desc (org-export-secondary-string path 'e-latex info))))
  1154. ;; Fuzzy: With the help of `org-export-resolve-fuzzy-link', find
  1155. ;; the destination of the link.
  1156. ((string= type "fuzzy")
  1157. (let ((destination (org-export-resolve-fuzzy-link link info)))
  1158. (case (car destination)
  1159. (target
  1160. (format "\\hyperref[%s]{%s}"
  1161. (org-export-solidify-link-text
  1162. (org-element-get-property :raw-value destination))
  1163. (or desc
  1164. (org-export-secondary-string
  1165. (org-element-get-property :raw-link link)
  1166. 'e-latex info))))
  1167. (headline
  1168. (format "\\hyperref[headline-%d]{%s}"
  1169. (org-element-get-property :begin destination)
  1170. (or desc
  1171. (org-export-secondary-string
  1172. (org-element-get-property :raw-link link)
  1173. 'e-latex info))))
  1174. (otherwise
  1175. (format "\\texttt{%s}"
  1176. (or desc
  1177. (org-export-secondary-string
  1178. (org-element-get-property :raw-link link)
  1179. 'e-latex info)))))))
  1180. ;; Coderef: replace link with the reference name or the
  1181. ;; equivalent line number.
  1182. ((string= type "coderef")
  1183. (format (org-export-get-coderef-format path (or desc ""))
  1184. (org-export-resolve-coderef path info)))
  1185. ;; Link type is handled by a special function.
  1186. ((functionp (setq protocol (nth 2 (assoc type org-link-protocols))))
  1187. (funcall protocol (org-link-unescape path) desc 'latex))
  1188. ;; External link with a description part.
  1189. ((and path desc) (format "\\href{%s}{%s}" path desc))
  1190. ;; External link without a description part.
  1191. (path (format "\\url{%s}" path))
  1192. ;; No path, only description. Try to do something useful.
  1193. (t (format "\\texttt{%s}" desc)))))
  1194. ;;;; Babel Call
  1195. ;; Babel Calls are ignored.
  1196. ;;;; Macro
  1197. (defun org-e-latex-macro (macro contents info)
  1198. "Transcode a MACRO element from Org to LaTeX.
  1199. CONTENTS is nil. INFO is a plist holding contextual information."
  1200. ;; Use available tools.
  1201. (org-export-expand-macro macro info))
  1202. ;;;; Paragraph
  1203. (defun org-e-latex-paragraph (paragraph contents info)
  1204. "Transcode a PARAGRAPH element from Org to LaTeX.
  1205. CONTENTS is the contents of the paragraph, as a string. INFO is
  1206. the plist used as a communication channel."
  1207. contents)
  1208. ;;;; Plain List
  1209. (defun org-e-latex-plain-list (plain-list contents info)
  1210. "Transcode a PLAIN-LIST element from Org to LaTeX.
  1211. CONTENTS is the contents of the list. INFO is a plist holding
  1212. contextual information."
  1213. (let* ((type (org-element-get-property :type plain-list))
  1214. (paralist-types '("inparaenum" "asparaenum" "inparaitem" "asparaitem"
  1215. "inparadesc" "asparadesc"))
  1216. (paralist-regexp (concat
  1217. "\\("
  1218. (mapconcat 'identity paralist-types "\\|")
  1219. "\\)"))
  1220. (attr (mapconcat #'identity
  1221. (org-element-get-property :attr_latex plain-list)
  1222. " "))
  1223. (latex-type (cond
  1224. ((and attr
  1225. (string-match
  1226. (format "\\<%s\\>" paralist-regexp) attr))
  1227. (match-string 1 attr))
  1228. ((eq type 'ordered) "enumerate")
  1229. ((eq type 'unordered) "itemize")
  1230. ((eq type 'descriptive) "description"))))
  1231. (org-e-latex--wrap-label
  1232. plain-list
  1233. (format "\\begin{%s}%s\n%s\\end{%s}"
  1234. latex-type
  1235. ;; Once special environment, if any, has been removed, the
  1236. ;; rest of the attributes will be optional arguments.
  1237. ;; They will be put inside square brackets if necessary.
  1238. (let ((opt (replace-regexp-in-string
  1239. (format " *%s *" paralist-regexp) "" attr)))
  1240. (cond ((string= opt "") "")
  1241. ((string-match "\\`\\[[^][]+\\]\\'" opt) opt)
  1242. (t (format "[%s]" opt))))
  1243. contents
  1244. latex-type))))
  1245. ;;;; Plain Text
  1246. (defun org-e-latex-plain-text (text info)
  1247. "Transcode a TEXT string from Org to LaTeX.
  1248. TEXT is the string to transcode. INFO is a plist holding
  1249. contextual information."
  1250. ;; Protect %, #, &, $, ~, ^, _, { and }.
  1251. (while (string-match "\\([^\\]\\|^\\)\\([%$#&{}~^_]\\)" text)
  1252. (setq text
  1253. (replace-match (format "\\%s" (match-string 2 text)) nil t text 2)))
  1254. ;; Protect \
  1255. (setq text (replace-regexp-in-string
  1256. "\\(?:[^\\]\\|^\\)\\(\\\\\\)\\(?:[^%$#&{}~^_\\]\\|$\\)"
  1257. "$\\backslash$" text nil t 1))
  1258. ;; LaTeX into \LaTeX{} and TeX into \TeX{}.
  1259. (let ((case-fold-search nil)
  1260. (start 0))
  1261. (while (string-match "\\<\\(\\(?:La\\)?TeX\\)\\>" text start)
  1262. (setq text (replace-match
  1263. (format "\\%s{}" (match-string 1 text)) nil t text)
  1264. start (match-end 0))))
  1265. ;; Handle quotation marks
  1266. (setq text (org-e-latex--quotation-marks text info))
  1267. ;; Convert special strings.
  1268. (when (plist-get info :with-special-strings)
  1269. (while (string-match (regexp-quote "...") text)
  1270. (setq text (replace-match "\\ldots{}" nil t text))))
  1271. ;; Handle break preservation if required.
  1272. (when (plist-get info :preserve-breaks)
  1273. (setq text (replace-regexp-in-string "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n"
  1274. text)))
  1275. ;; Return value.
  1276. text)
  1277. ;;;; Property Drawer
  1278. (defun org-e-latex-property-drawer (property-drawer contents info)
  1279. "Transcode a PROPERTY-DRAWER element from Org to LaTeX.
  1280. CONTENTS is nil. INFO is a plist holding contextual
  1281. information."
  1282. ;; The property drawer isn't exported but we want separating blank
  1283. ;; lines nonetheless.
  1284. "")
  1285. ;;;; Quote Block
  1286. (defun org-e-latex-quote-block (quote-block contents info)
  1287. "Transcode a QUOTE-BLOCK element from Org to LaTeX.
  1288. CONTENTS holds the contents of the block. INFO is a plist
  1289. holding contextual information."
  1290. (org-e-latex--wrap-label
  1291. quote-block
  1292. (format "\\begin{quote}\n%s\\end{quote}" contents)))
  1293. ;;;; Quote Section
  1294. (defun org-e-latex-quote-section (quote-section contents info)
  1295. "Transcode a QUOTE-SECTION element from Org to LaTeX.
  1296. CONTENTS is nil. INFO is a plist holding contextual information."
  1297. (let ((value (org-remove-indentation
  1298. (org-element-get-property :value quote-section))))
  1299. (when value (format "\\begin{verbatim}\n%s\\end{verbatim}" value))))
  1300. ;;;; Section
  1301. (defun org-e-latex-section (section contents info)
  1302. "Transcode a SECTION element from Org to LaTeX.
  1303. CONTENTS holds the contents of the section. INFO is a plist
  1304. holding contextual information."
  1305. contents)
  1306. ;;;; Radio Target
  1307. (defun org-e-latex-radio-target (radio-target text info)
  1308. "Transcode a RADIO-TARGET object from Org to LaTeX.
  1309. TEXT is the text of the target. INFO is a plist holding
  1310. contextual information."
  1311. (format "\\label{%s}%s"
  1312. (org-export-solidify-link-text
  1313. (org-element-get-property :raw-value radio-target))
  1314. text))
  1315. ;;;; Special Block
  1316. (defun org-e-latex-special-block (special-block contents info)
  1317. "Transcode a SPECIAL-BLOCK element from Org to LaTeX.
  1318. CONTENTS holds the contents of the block. INFO is a plist
  1319. holding contextual information."
  1320. (let ((type (downcase (org-element-get-property :type special-block))))
  1321. (org-e-latex--wrap-label
  1322. special-block
  1323. (format "\\begin{%s}\n%s\\end{%s}" type contents type))))
  1324. ;;;; Src Block
  1325. (defun org-e-latex-src-block (src-block contents info)
  1326. "Transcode a SRC-BLOCK element from Org to LaTeX.
  1327. CONTENTS holds the contents of the item. INFO is a plist holding
  1328. contextual information."
  1329. (let* ((lang (org-element-get-property :language src-block))
  1330. (code (org-export-handle-code src-block info))
  1331. (caption (org-element-get-property :caption src-block))
  1332. (label (org-element-get-property :name src-block))
  1333. (custom-env (and lang
  1334. (cadr (assq (intern lang)
  1335. org-e-latex-custom-lang-environments)))))
  1336. (cond
  1337. ;; No source fontification.
  1338. ((not org-e-latex-listings)
  1339. (let ((caption-str (org-e-latex--caption/label-string
  1340. caption label info))
  1341. (float-env (when caption "\\begin{figure}[H]\n%s\n\\end{figure}")))
  1342. (format (or float-env "%s")
  1343. (concat
  1344. caption-str
  1345. (format "\\begin{verbatim}\n%s\\end{verbatim}" code)))))
  1346. ;; Custom environment.
  1347. (custom-env
  1348. (format "\\begin{%s}\n%s\\end{%s}\n" custom-env code custom-env))
  1349. ;; Use minted package.
  1350. ((eq org-e-latex-listings 'minted)
  1351. (let* ((mint-lang (or (cadr (assq (intern lang) org-e-latex-minted-langs))
  1352. lang))
  1353. (float-env (when (or label caption)
  1354. (format "\\begin{listing}[H]\n%%s\n%s\\end{listing}"
  1355. (org-e-latex--caption/label-string
  1356. caption label info))))
  1357. (body (format "\\begin{minted}[%s]{%s}\n%s\\end{minted}"
  1358. (org-e-latex--make-option-string
  1359. org-e-latex-minted-options)
  1360. mint-lang code)))
  1361. (if float-env (format float-env body) body)))
  1362. ;; Use listings package.
  1363. (t
  1364. (let ((lst-lang
  1365. (or (cadr (assq (intern lang) org-e-latex-listings-langs)) lang))
  1366. (caption-str
  1367. (when caption
  1368. (let ((main (org-export-secondary-string
  1369. (car caption) 'e-latex info)))
  1370. (if (not (cdr caption)) (format "{%s}" main)
  1371. (format
  1372. "{[%s]%s}"
  1373. (org-export-secondary-string (cdr caption) 'e-latex info)
  1374. main))))))
  1375. (concat (format "\\lstset{%s}\n"
  1376. (org-e-latex--make-option-string
  1377. (append org-e-latex-listings-options
  1378. `(("language" ,lst-lang))
  1379. (when label `(("label" ,label)))
  1380. (when caption-str
  1381. `(("caption" ,caption-str))))))
  1382. (format "\\begin{lstlisting}\n%s\\end{lstlisting}" code)))))))
  1383. ;;;; Statistics Cookie
  1384. (defun org-e-latex-statistics-cookie (statistics-cookie contents info)
  1385. "Transcode a STATISTICS-COOKIE object from Org to LaTeX.
  1386. CONTENTS is nil. INFO is a plist holding contextual information."
  1387. (org-element-get-property :value statistics-cookie))
  1388. ;;;; Subscript
  1389. (defun org-e-latex-subscript (subscript contents info)
  1390. "Transcode a SUBSCRIPT object from Org to LaTeX.
  1391. CONTENTS is the contents of the object. INFO is a plist holding
  1392. contextual information."
  1393. (format (if (= (length contents) 1) "$_%s$" "$_{\\mathrm{%s}}$") contents))
  1394. ;;;; Superscript
  1395. (defun org-e-latex-superscript (superscript contents info)
  1396. "Transcode a SUPERSCRIPT object from Org to LaTeX.
  1397. CONTENTS is the contents of the object. INFO is a plist holding
  1398. contextual information."
  1399. (format (if (= (length contents) 1) "$^%s$" "$^{\\mathrm{%s}}$") contents))
  1400. ;;;; Table
  1401. (defun org-e-latex-table--format-string (table table-info info)
  1402. "Return an appropriate format string for TABLE.
  1403. TABLE-INFO is the plist containing format info about the table,
  1404. as returned by `org-export-table-format-info'. INFO is a plist
  1405. used as a communication channel.
  1406. The format string one placeholder for the body of the table."
  1407. (let* ((label (org-element-get-property :name table))
  1408. (caption (org-e-latex--caption/label-string
  1409. (org-element-get-property :caption table) label info))
  1410. (attr (mapconcat #'identity
  1411. (org-element-get-property :attr_latex table)
  1412. " "))
  1413. ;; Determine alignment string.
  1414. (alignment (org-e-latex-table--align-string attr table-info))
  1415. ;; Determine environment for the table: longtable, tabular...
  1416. (table-env (cond
  1417. ((not attr) org-e-latex-default-table-environment)
  1418. ((string-match "\\<longtable\\>" attr) "longtable")
  1419. ((string-match "\\(tabular.\\)" attr)
  1420. (org-match-string-no-properties 1 attr))
  1421. (t org-e-latex-default-table-environment)))
  1422. ;; If table is a float, determine environment: table or table*.
  1423. (float-env (cond
  1424. ((string= "longtable" table-env) nil)
  1425. ((and attr
  1426. (or (string-match (regexp-quote "table*") attr)
  1427. (string-match "\\<multicolumn\\>" attr)))
  1428. "table*")
  1429. ((or (not (string= caption "")) label) "table")))
  1430. ;; Extract others display options.
  1431. (width (and attr
  1432. (string-match "\\<width=\\(\\S-+\\)" attr)
  1433. (org-match-string-no-properties 1 attr)))
  1434. (placement (if (and attr
  1435. (string-match "\\<placement=\\(\\S-+\\)" attr))
  1436. (org-match-string-no-properties 1 attr)
  1437. (concat "["
  1438. org-e-latex-default-figure-position
  1439. "]"))))
  1440. ;; Prepare the final format string for the table.
  1441. (cond
  1442. ;; Longtable.
  1443. ((string= "longtable" table-env)
  1444. (format "\\begin{longtable}{%s}\n%s\n%%s\n%s\\end{longtable}"
  1445. alignment
  1446. (if (or (not org-e-latex-table-caption-above)
  1447. (string= "" caption))
  1448. ""
  1449. (concat (org-trim caption) "\\\\"))
  1450. (if (or org-e-latex-table-caption-above
  1451. (string= "" caption))
  1452. ""
  1453. (concat (org-trim caption) "\\\\\n"))))
  1454. ;; Others.
  1455. (t (concat (when float-env
  1456. (concat
  1457. (format "\\begin{%s}%s\n" float-env placement)
  1458. (if org-e-latex-table-caption-above caption "")))
  1459. (when org-e-latex-tables-centered "\\begin{center}\n")
  1460. (format "\\begin{%s}%s{%s}\n%%s\n\\end{%s}"
  1461. table-env
  1462. (if width (format "{%s}" width) "")
  1463. alignment
  1464. table-env)
  1465. (when org-e-latex-tables-centered "\n\\end{center}")
  1466. (when float-env
  1467. (concat (if org-e-latex-table-caption-above "" caption)
  1468. (format "\n\\end{%s}" float-env))))))))
  1469. (defun org-e-latex-table--align-string (attr table-info)
  1470. "Return an appropriate LaTeX alignment string.
  1471. ATTR is a string containing table's LaTeX specific attributes.
  1472. TABLE-INFO is the plist containing format info about the table,
  1473. as returned by `org-export-table-format-info'."
  1474. (or (and attr
  1475. (string-match "\\<align=\\(\\S-+\\)" attr)
  1476. (match-string 1 attr))
  1477. (let* ((align (copy-sequence (plist-get table-info :alignment)))
  1478. (colgroups (copy-sequence (plist-get table-info :column-groups)))
  1479. (cols (length align))
  1480. (separators (make-vector (1+ cols) "")))
  1481. ;; Ignore the first column if it's special.
  1482. (when (plist-get table-info :special-column-p)
  1483. (aset align 0 "") (aset colgroups 0 nil))
  1484. (let ((col 0))
  1485. (mapc (lambda (el)
  1486. (let ((gr (aref colgroups col)))
  1487. (when (memq gr '(start start-end))
  1488. (aset separators col "|"))
  1489. (when (memq gr '(end start-end))
  1490. (aset separators (1+ col) "|")))
  1491. (incf col))
  1492. align))
  1493. ;; Build the LaTeX specific alignment string.
  1494. (loop for al across align
  1495. for sep across separators
  1496. concat (concat sep al) into output
  1497. finally return (concat output (aref separators cols))))))
  1498. (defun org-e-latex-table (table contents info)
  1499. "Transcode a TABLE element from Org to LaTeX.
  1500. CONTENTS is nil. INFO is a plist holding contextual information."
  1501. (let ((attr (mapconcat #'identity
  1502. (org-element-get-property :attr_latex table)
  1503. " "))
  1504. (raw-table (org-element-get-property :raw-table table)))
  1505. (cond
  1506. ;; Case 1: verbatim table.
  1507. ((or org-e-latex-tables-verbatim
  1508. (and attr (string-match "\\<verbatim\\>" attr)))
  1509. (format "\\begin{verbatim}\n%s\n\\end{verbatim}"
  1510. (org-export-clean-table
  1511. raw-table
  1512. (plist-get (org-export-table-format-info raw-table)
  1513. :special-column-p))))
  1514. ;; Case 2: table.el table. Convert it using appropriate tools.
  1515. ((eq (org-element-get-property :type table) 'table.el)
  1516. (require 'table)
  1517. ;; Ensure "*org-export-table*" buffer is empty.
  1518. (and (get-buffer "*org-export-table*")
  1519. (kill-buffer (get-buffer "*org-export-table*")))
  1520. (let ((output (with-temp-buffer
  1521. (insert raw-table)
  1522. (goto-char 1)
  1523. (re-search-forward "^[ \t]*|[^|]" nil t)
  1524. (table-generate-source 'latex "*org-export-table*")
  1525. (with-current-buffer "*org-export-table*"
  1526. (org-trim (buffer-string))))))
  1527. (kill-buffer (get-buffer "*org-export-table*"))
  1528. ;; Remove left out comments.
  1529. (while (string-match "^%.*\n" output)
  1530. (setq output (replace-match "" t t output)))
  1531. ;; When the "rmlines" attribute is provided, remove all hlines
  1532. ;; but the the one separating heading from the table body.
  1533. (when (and attr (string-match "\\<rmlines\\>" attr))
  1534. (let ((n 0) (pos 0))
  1535. (while (and (< (length output) pos)
  1536. (setq pos (string-match "^\\\\hline\n?" output pos)))
  1537. (incf n)
  1538. (unless (= n 2) (setq output (replace-match "" nil nil output))))))
  1539. (if org-e-latex-tables-centered
  1540. (format "\\begin{center}\n%s\n\\end{center}" output)
  1541. output)))
  1542. ;; Case 3: Standard table.
  1543. (t
  1544. (let* ((table-info (org-export-table-format-info raw-table))
  1545. (clean-table (org-export-clean-table
  1546. raw-table (plist-get table-info :special-column-p)))
  1547. (columns-number (length (plist-get table-info :alignment))))
  1548. ;; Convert ROWS to send them to `orgtbl-to-latex'. In
  1549. ;; particular, send each cell to
  1550. ;; `org-element-parse-secondary-string' to expand any Org
  1551. ;; object within. Eventually, flesh the format string out with
  1552. ;; the table.
  1553. (format (org-e-latex-table--format-string table table-info info)
  1554. (orgtbl-to-latex
  1555. (mapcar
  1556. (lambda (row)
  1557. (if (string-match org-table-hline-regexp row)
  1558. 'hline
  1559. (mapcar
  1560. (lambda (cell)
  1561. (org-export-secondary-string
  1562. (org-element-parse-secondary-string
  1563. cell
  1564. (cdr (assq 'table org-element-string-restrictions)))
  1565. 'e-latex info))
  1566. (org-split-string row "[ \t]*|[ \t]*"))))
  1567. (org-split-string clean-table "\n"))
  1568. `(:tstart nil :tend nil
  1569. ;; Longtable environment requires specific
  1570. ;; header line end.
  1571. :hlend ,(and attr
  1572. (string-match "\\<longtable\\>" attr)
  1573. (format "\\\\
  1574. \\hline
  1575. \\endhead
  1576. \\hline\\multicolumn{%d}{r}{Continued on next page}\\\\
  1577. \\endfoot
  1578. \\endlastfoot"
  1579. columns-number))))))))))
  1580. ;;;; Target
  1581. (defun org-e-latex-target (target text info)
  1582. "Transcode a TARGET object from Org to LaTeX.
  1583. TEXT is the text of the target. INFO is a plist holding
  1584. contextual information."
  1585. (format "\\label{%s}%s"
  1586. (org-export-solidify-link-text
  1587. (org-element-get-property :raw-value target))
  1588. text))
  1589. ;;;; Time-stamp
  1590. (defun org-e-latex-time-stamp (time-stamp contents info)
  1591. "Transcode a TIME-STAMP object from Org to LaTeX.
  1592. CONTENTS is nil. INFO is a plist holding contextual
  1593. information."
  1594. (let ((value (org-element-get-property :value time-stamp))
  1595. (type (org-element-get-property :type time-stamp))
  1596. (appt-type (org-element-get-property :appt-type time-stamp)))
  1597. (concat (cond ((eq appt-type 'scheduled)
  1598. (format "\\textbf{\\textsc{%s}} " org-scheduled-string))
  1599. ((eq appt-type 'deadline)
  1600. (format "\\textbf{\\textsc{%s}} " org-deadline-string))
  1601. ((eq appt-type 'closed)
  1602. (format "\\textbf{\\textsc{%s}} " org-closed-string)))
  1603. (cond ((memq type '(active active-range))
  1604. (format org-e-latex-active-timestamp-format value))
  1605. ((memq type '(inactive inactive-range))
  1606. (format org-e-latex-inactive-timestamp-format value))
  1607. (t
  1608. (format org-e-latex-diary-timestamp-format value))))))
  1609. ;;;; Verbatim
  1610. (defun org-e-latex-verbatim (verbatim contents info)
  1611. "Transcode a VERBATIM object from Org to LaTeX.
  1612. CONTENTS is nil. INFO is a plist used as a communication
  1613. channel."
  1614. (let ((fmt (cdr (assoc (org-element-get-property :marker verbatim)
  1615. org-e-latex-emphasis-alist)))
  1616. (value (org-element-get-property :value verbatim)))
  1617. (cond
  1618. ;; Handle the `verb' special case.
  1619. ((eq 'verb fmt)
  1620. (let ((separator (org-e-latex--find-verb-separator value)))
  1621. (concat "\\verb" separator value separator)))
  1622. ;; Handle the `protectedtexttt' special case.
  1623. ((eq 'protectedtexttt fmt)
  1624. (let ((start 0)
  1625. (trans '(("\\" . "\\textbackslash{}")
  1626. ("~" . "\\textasciitilde{}")
  1627. ("^" . "\\textasciicircum{}")))
  1628. (rtn "")
  1629. char)
  1630. (while (string-match "[\\{}$%&_#~^]" value)
  1631. (setq char (match-string 0 value))
  1632. (if (> (match-beginning 0) 0)
  1633. (setq rtn (concat rtn (substring value 0 (match-beginning 0)))))
  1634. (setq value (substring value (1+ (match-beginning 0))))
  1635. (setq char (or (cdr (assoc char trans)) (concat "\\" char))
  1636. rtn (concat rtn char)))
  1637. (setq value (concat rtn value)
  1638. fmt "\\texttt{%s}")
  1639. (while (string-match "--" value)
  1640. (setq value (replace-match "-{}-" t t value)))
  1641. (format fmt value)))
  1642. ;; Else use format string.
  1643. (t (format fmt value)))))
  1644. ;;;; Verse Block
  1645. (defun org-e-latex-verse-block (verse-block contents info)
  1646. "Transcode a VERSE-BLOCK element from Org to LaTeX.
  1647. CONTENTS is nil. INFO is a plist holding contextual information."
  1648. (org-e-latex--wrap-label
  1649. verse-block
  1650. ;; In a verse environment, add a line break to each newline
  1651. ;; character and change each white space at beginning of a line
  1652. ;; into a space of 1 em. Also change each blank line with
  1653. ;; a vertical space of 1 em.
  1654. (progn
  1655. (setq contents (replace-regexp-in-string
  1656. "^ *\\\\\\\\$" "\\\\vspace*{1em}"
  1657. (replace-regexp-in-string
  1658. "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n"
  1659. (org-remove-indentation
  1660. (org-export-secondary-string
  1661. (org-element-get-property :value verse-block)
  1662. 'e-latex info)))))
  1663. (while (string-match "^[ \t]+" contents)
  1664. (let ((new-str (format "\\hspace*{%dem}"
  1665. (length (match-string 0 contents)))))
  1666. (setq contents (replace-match new-str nil t contents))))
  1667. (format "\\begin{verse}\n%s\\end{verse}" contents))))
  1668. ;;; Interactive functions
  1669. (defun org-e-latex-export-to-latex
  1670. (&optional subtreep visible-only body-only ext-plist pub-dir)
  1671. "Export current buffer to a LaTeX file.
  1672. If narrowing is active in the current buffer, only export its
  1673. narrowed part.
  1674. If a region is active, export that region.
  1675. When optional argument SUBTREEP is non-nil, export the sub-tree
  1676. at point, extracting information from the headline properties
  1677. first.
  1678. When optional argument VISIBLE-ONLY is non-nil, don't export
  1679. contents of hidden elements.
  1680. When optional argument BODY-ONLY is non-nil, only write code
  1681. between \"\\begin{document}\" and \"\\end{document}\".
  1682. EXT-PLIST, when provided, is a property list with external
  1683. parameters overriding Org default settings, but still inferior to
  1684. file-local settings.
  1685. When optional argument PUB-DIR is set, use it as the publishing
  1686. directory.
  1687. Return output file's name."
  1688. (interactive)
  1689. (let ((outfile (org-export-output-file-name ".tex" subtreep pub-dir)))
  1690. (org-export-to-file
  1691. 'e-latex outfile subtreep visible-only body-only ext-plist)))
  1692. (defun org-e-latex-export-to-pdf
  1693. (&optional subtreep visible-only body-only ext-plist pub-dir)
  1694. "Export current buffer to LaTeX then process through to PDF.
  1695. If narrowing is active in the current buffer, only export its
  1696. narrowed part.
  1697. If a region is active, export that region.
  1698. When optional argument SUBTREEP is non-nil, export the sub-tree
  1699. at point, extracting information from the headline properties
  1700. first.
  1701. When optional argument VISIBLE-ONLY is non-nil, don't export
  1702. contents of hidden elements.
  1703. When optional argument BODY-ONLY is non-nil, only write code
  1704. between \"\\begin{document}\" and \"\\end{document}\".
  1705. EXT-PLIST, when provided, is a property list with external
  1706. parameters overriding Org default settings, but still inferior to
  1707. file-local settings.
  1708. When optional argument PUB-DIR is set, use it as the publishing
  1709. directory.
  1710. Return PDF file's name."
  1711. (interactive)
  1712. (org-e-latex-compile
  1713. (org-e-latex-export-to-latex
  1714. subtreep visible-only body-only ext-plist pub-dir)))
  1715. (defun org-e-latex-compile (texfile)
  1716. "Compile a TeX file.
  1717. TEXFILE is the name of the file being compiled. Processing is
  1718. done through the command specified in `org-e-latex-pdf-process'.
  1719. Return PDF file name or an error if it couldn't be produced."
  1720. (let* ((wconfig (current-window-configuration))
  1721. (texfile (file-truename texfile))
  1722. (base (file-name-sans-extension texfile))
  1723. errors)
  1724. (message (format "Processing LaTeX file %s ..." texfile))
  1725. (unwind-protect
  1726. (progn
  1727. (cond
  1728. ;; A function is provided: Apply it.
  1729. ((functionp org-latex-to-pdf-process)
  1730. (funcall org-latex-to-pdf-process (shell-quote-argument texfile)))
  1731. ;; A list is provided: Replace %b, %f and %o with appropriate
  1732. ;; values in each command before applying it. Output is
  1733. ;; redirected to "*Org PDF LaTeX Output*" buffer.
  1734. ((consp org-e-latex-pdf-process)
  1735. (let* ((out-dir (or (file-name-directory texfile) "./"))
  1736. (outbuf (get-buffer-create "*Org PDF LaTeX Output*")))
  1737. (mapc
  1738. (lambda (command)
  1739. (shell-command
  1740. (replace-regexp-in-string
  1741. "%b" (shell-quote-argument base)
  1742. (replace-regexp-in-string
  1743. "%f" (shell-quote-argument texfile)
  1744. (replace-regexp-in-string
  1745. "%o" (shell-quote-argument out-dir) command)))
  1746. outbuf))
  1747. org-e-latex-pdf-process)
  1748. ;; Collect standard errors from output buffer.
  1749. (setq errors (org-e-latex-collect-errors outbuf))))
  1750. (t (error "No valid command to process to PDF")))
  1751. (let ((pdffile (concat base ".pdf")))
  1752. ;; Check for process failure. Provide collected errors if
  1753. ;; possible.
  1754. (if (not (file-exists-p pdffile))
  1755. (error (concat (format "PDF file %s wasn't produced" pdffile)
  1756. (when errors (concat ": " errors))))
  1757. ;; Else remove log files, when specified, and signal end of
  1758. ;; process to user, along with any error encountered.
  1759. (when org-e-latex-remove-logfiles
  1760. (dolist (ext org-e-latex-logfiles-extensions)
  1761. (let ((file (concat base "." ext)))
  1762. (when (file-exists-p file) (delete-file file)))))
  1763. (message (concat "Process completed"
  1764. (if (not errors) "."
  1765. (concat " with errors: " errors)))))
  1766. ;; Return output file name.
  1767. pdffile))
  1768. (set-window-configuration wconfig))))
  1769. (defun org-e-latex-collect-errors (buffer)
  1770. "Collect some kind of errors from \"pdflatex\" command output.
  1771. BUFFER is the buffer containing output.
  1772. Return collected error types as a string, or nil if there was
  1773. none."
  1774. (with-current-buffer buffer
  1775. (save-excursion
  1776. (goto-char (point-max))
  1777. ;; Find final "pdflatex" run.
  1778. (when (re-search-backward "^[ \t]*This is pdf.*?TeX.*?Version" nil t)
  1779. (let ((case-fold-search t)
  1780. (errors ""))
  1781. (when (save-excursion
  1782. (re-search-forward "Reference.*?undefined" nil t))
  1783. (setq errors (concat errors " [undefined reference]")))
  1784. (when (save-excursion
  1785. (re-search-forward "Citation.*?undefined" nil t))
  1786. (setq errors (concat errors " [undefined citation]")))
  1787. (when (save-excursion
  1788. (re-search-forward "Undefined control sequence" nil t))
  1789. (setq errors (concat errors " [undefined control sequence]")))
  1790. (when (save-excursion
  1791. (re-search-forward "^! LaTeX.*?Error" nil t))
  1792. (setq errors (concat errors " [LaTeX error]")))
  1793. (when (save-excursion
  1794. (re-search-forward "^! Package.*?Error" nil t))
  1795. (setq errors (concat errors " [package error]")))
  1796. (and (org-string-nw-p errors) (org-trim errors)))))))
  1797. (provide 'org-e-latex)
  1798. ;;; org-e-latex.el ends here