org-e-latex.el 77 KB

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