ox-beamer.el 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145
  1. ;;; ox-beamer.el --- Beamer Back-End for Org Export Engine -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2007-2018 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten.dominik AT gmail DOT com>
  4. ;; Nicolas Goaziou <n.goaziou AT gmail DOT com>
  5. ;; Keywords: org, wp, tex
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;;
  19. ;; This library implements both a Beamer back-end, derived from the
  20. ;; LaTeX one and a minor mode easing structure edition of the
  21. ;; document. See Org manual for more information.
  22. ;;; Code:
  23. (require 'cl-lib)
  24. (require 'ox-latex)
  25. ;; Install a default set-up for Beamer export.
  26. (unless (assoc "beamer" org-latex-classes)
  27. (add-to-list 'org-latex-classes
  28. '("beamer"
  29. "\\documentclass[presentation]{beamer}"
  30. ("\\section{%s}" . "\\section*{%s}")
  31. ("\\subsection{%s}" . "\\subsection*{%s}")
  32. ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))))
  33. ;;; User-Configurable Variables
  34. (defgroup org-export-beamer nil
  35. "Options specific for using the beamer class in LaTeX export."
  36. :tag "Org Beamer"
  37. :group 'org-export
  38. :version "24.2")
  39. (defcustom org-beamer-frame-level 1
  40. "The level at which headlines become frames.
  41. Headlines at a lower level will be translated into a sectioning
  42. structure. At a higher level, they will be translated into
  43. blocks.
  44. If a headline with a \"BEAMER_env\" property set to \"frame\" is
  45. found within a tree, its level locally overrides this number.
  46. This variable has no effect on headlines with the \"BEAMER_env\"
  47. property set to either \"ignoreheading\", \"appendix\", or
  48. \"note\", which will respectively, be invisible, become an
  49. appendix or a note.
  50. This integer is relative to the minimal level of a headline
  51. within the parse tree, defined as 1."
  52. :group 'org-export-beamer
  53. :type 'integer)
  54. (defcustom org-beamer-frame-default-options ""
  55. "Default options string to use for frames.
  56. For example, it could be set to \"allowframebreaks\"."
  57. :group 'org-export-beamer
  58. :type '(string :tag "[options]"))
  59. (defcustom org-beamer-column-view-format
  60. "%45ITEM %10BEAMER_env(Env) %10BEAMER_act(Act) %4BEAMER_col(Col) %8BEAMER_opt(Opt)"
  61. "Column view format that should be used to fill the template."
  62. :group 'org-export-beamer
  63. :version "24.4"
  64. :package-version '(Org . "8.0")
  65. :type '(choice
  66. (const :tag "Do not insert Beamer column view format" nil)
  67. (string :tag "Beamer column view format")))
  68. (defcustom org-beamer-theme "default"
  69. "Default theme used in Beamer presentations."
  70. :group 'org-export-beamer
  71. :version "24.4"
  72. :package-version '(Org . "8.0")
  73. :type '(choice
  74. (const :tag "Do not insert a Beamer theme" nil)
  75. (string :tag "Beamer theme")))
  76. (defcustom org-beamer-environments-extra nil
  77. "Environments triggered by tags in Beamer export.
  78. Each entry has 4 elements:
  79. name Name of the environment
  80. key Selection key for `org-beamer-select-environment'
  81. open The opening template for the environment, with the following escapes
  82. %a the action/overlay specification
  83. %A the default action/overlay specification
  84. %R the raw BEAMER_act value
  85. %o the options argument, with square brackets
  86. %O the raw BEAMER_opt value
  87. %h the headline text
  88. %r the raw headline text (i.e. without any processing)
  89. %H if there is headline text, that raw text in {} braces
  90. %U if there is headline text, that raw text in [] brackets
  91. close The closing string of the environment."
  92. :group 'org-export-beamer
  93. :version "24.4"
  94. :package-version '(Org . "8.1")
  95. :type '(repeat
  96. (list
  97. (string :tag "Environment")
  98. (string :tag "Selection key")
  99. (string :tag "Begin")
  100. (string :tag "End"))))
  101. (defcustom org-beamer-outline-frame-title "Outline"
  102. "Default title of a frame containing an outline."
  103. :group 'org-export-beamer
  104. :type '(string :tag "Outline frame title"))
  105. (defcustom org-beamer-outline-frame-options ""
  106. "Outline frame options appended after \\begin{frame}.
  107. You might want to put e.g. \"allowframebreaks=0.9\" here."
  108. :group 'org-export-beamer
  109. :type '(string :tag "Outline frame options"))
  110. (defcustom org-beamer-subtitle-format "\\subtitle{%s}"
  111. "Format string used for transcoded subtitle.
  112. The format string should have at most one \"%s\"-expression,
  113. which is replaced with the subtitle."
  114. :group 'org-export-beamer
  115. :version "26.1"
  116. :package-version '(Org . "8.3")
  117. :type '(string :tag "Format string"))
  118. ;;; Internal Variables
  119. (defconst org-beamer-column-widths
  120. "0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 0.0 :ETC"
  121. "The column widths that should be installed as allowed property values.")
  122. (defconst org-beamer-environments-special
  123. '(("againframe" "A")
  124. ("appendix" "x")
  125. ("column" "c")
  126. ("columns" "C")
  127. ("frame" "f")
  128. ("fullframe" "F")
  129. ("ignoreheading" "i")
  130. ("note" "n")
  131. ("noteNH" "N"))
  132. "Alist of environments treated in a special way by the back-end.
  133. Keys are environment names, as strings, values are bindings used
  134. in `org-beamer-select-environment'. Environments listed here,
  135. along with their binding, are hard coded and cannot be modified
  136. through `org-beamer-environments-extra' variable.")
  137. (defconst org-beamer-environments-default
  138. '(("block" "b" "\\begin{block}%a{%h}" "\\end{block}")
  139. ("alertblock" "a" "\\begin{alertblock}%a{%h}" "\\end{alertblock}")
  140. ("verse" "v" "\\begin{verse}%a %% %h" "\\end{verse}")
  141. ("quotation" "q" "\\begin{quotation}%a %% %h" "\\end{quotation}")
  142. ("quote" "Q" "\\begin{quote}%a %% %h" "\\end{quote}")
  143. ("structureenv" "s" "\\begin{structureenv}%a %% %h" "\\end{structureenv}")
  144. ("theorem" "t" "\\begin{theorem}%a[%h]" "\\end{theorem}")
  145. ("definition" "d" "\\begin{definition}%a[%h]" "\\end{definition}")
  146. ("example" "e" "\\begin{example}%a[%h]" "\\end{example}")
  147. ("exampleblock" "E" "\\begin{exampleblock}%a{%h}" "\\end{exampleblock}")
  148. ("proof" "p" "\\begin{proof}%a[%h]" "\\end{proof}")
  149. ("beamercolorbox" "o" "\\begin{beamercolorbox}%o{%h}" "\\end{beamercolorbox}"))
  150. "Environments triggered by properties in Beamer export.
  151. These are the defaults - for user definitions, see
  152. `org-beamer-environments-extra'.")
  153. (defconst org-beamer-verbatim-elements
  154. '(code example-block fixed-width inline-src-block src-block verbatim)
  155. "List of element or object types producing verbatim text.
  156. This is used internally to determine when a frame should have the
  157. \"fragile\" option.")
  158. ;;; Internal functions
  159. (defun org-beamer--normalize-argument (argument type)
  160. "Return ARGUMENT string with proper boundaries.
  161. TYPE is a symbol among the following:
  162. `action' Return ARGUMENT within angular brackets.
  163. `defaction' Return ARGUMENT within both square and angular brackets.
  164. `option' Return ARGUMENT within square brackets."
  165. (if (not (string-match "\\S-" argument)) ""
  166. (cl-case type
  167. (action (format "<%s>" (org-unbracket-string "<" ">" argument)))
  168. (defaction
  169. (format "[<%s>]"
  170. (org-unbracket-string "<" ">" (org-unbracket-string "[" "]" argument))))
  171. (option (format "[%s]" (org-unbracket-string "[" "]" argument)))
  172. (otherwise (error "Invalid `type' argument to `org-beamer--normalize-argument': %s"
  173. type)))))
  174. (defun org-beamer--element-has-overlay-p (element)
  175. "Non-nil when ELEMENT has an overlay specified.
  176. An element has an overlay specification when it starts with an
  177. `beamer' export-snippet whose value is between angular brackets.
  178. Return overlay specification, as a string, or nil."
  179. (let ((first-object (car (org-element-contents element))))
  180. (when (eq (org-element-type first-object) 'export-snippet)
  181. (let ((value (org-element-property :value first-object)))
  182. (and (string-prefix-p "<" value) (string-suffix-p ">" value)
  183. value)))))
  184. ;;; Define Back-End
  185. (org-export-define-derived-backend 'beamer 'latex
  186. :menu-entry
  187. '(?l 1
  188. ((?B "As LaTeX buffer (Beamer)" org-beamer-export-as-latex)
  189. (?b "As LaTeX file (Beamer)" org-beamer-export-to-latex)
  190. (?P "As PDF file (Beamer)" org-beamer-export-to-pdf)
  191. (?O "As PDF file and open (Beamer)"
  192. (lambda (a s v b)
  193. (if a (org-beamer-export-to-pdf t s v b)
  194. (org-open-file (org-beamer-export-to-pdf nil s v b)))))))
  195. :options-alist
  196. '((:headline-levels nil "H" org-beamer-frame-level)
  197. (:latex-class "LATEX_CLASS" nil "beamer" t)
  198. (:beamer-subtitle-format nil nil org-beamer-subtitle-format)
  199. (:beamer-column-view-format "COLUMNS" nil org-beamer-column-view-format)
  200. (:beamer-theme "BEAMER_THEME" nil org-beamer-theme)
  201. (:beamer-color-theme "BEAMER_COLOR_THEME" nil nil t)
  202. (:beamer-font-theme "BEAMER_FONT_THEME" nil nil t)
  203. (:beamer-inner-theme "BEAMER_INNER_THEME" nil nil t)
  204. (:beamer-outer-theme "BEAMER_OUTER_THEME" nil nil t)
  205. (:beamer-header "BEAMER_HEADER" nil nil newline)
  206. (:beamer-environments-extra nil nil org-beamer-environments-extra)
  207. (:beamer-frame-default-options nil nil org-beamer-frame-default-options)
  208. (:beamer-outline-frame-options nil nil org-beamer-outline-frame-options)
  209. (:beamer-outline-frame-title nil nil org-beamer-outline-frame-title))
  210. :translate-alist '((bold . org-beamer-bold)
  211. (export-block . org-beamer-export-block)
  212. (export-snippet . org-beamer-export-snippet)
  213. (headline . org-beamer-headline)
  214. (item . org-beamer-item)
  215. (keyword . org-beamer-keyword)
  216. (link . org-beamer-link)
  217. (plain-list . org-beamer-plain-list)
  218. (radio-target . org-beamer-radio-target)
  219. (template . org-beamer-template)))
  220. ;;; Transcode Functions
  221. ;;;; Bold
  222. (defun org-beamer-bold (bold contents _info)
  223. "Transcode BLOCK object into Beamer code.
  224. CONTENTS is the text being bold. INFO is a plist used as
  225. a communication channel."
  226. (format "\\alert%s{%s}"
  227. (or (org-beamer--element-has-overlay-p bold) "")
  228. contents))
  229. ;;;; Export Block
  230. (defun org-beamer-export-block (export-block _contents _info)
  231. "Transcode an EXPORT-BLOCK element into Beamer code.
  232. CONTENTS is nil. INFO is a plist used as a communication
  233. channel."
  234. (when (member (org-element-property :type export-block) '("BEAMER" "LATEX"))
  235. (org-remove-indentation (org-element-property :value export-block))))
  236. ;;;; Export Snippet
  237. (defun org-beamer-export-snippet (export-snippet _contents info)
  238. "Transcode an EXPORT-SNIPPET object into Beamer code.
  239. CONTENTS is nil. INFO is a plist used as a communication
  240. channel."
  241. (let ((backend (org-export-snippet-backend export-snippet))
  242. (value (org-element-property :value export-snippet)))
  243. ;; Only "latex" and "beamer" snippets are retained.
  244. (cond ((eq backend 'latex) value)
  245. ;; Ignore "beamer" snippets specifying overlays.
  246. ((and (eq backend 'beamer)
  247. (or (org-export-get-previous-element export-snippet info)
  248. (not (string-match "\\`<.*>\\'" value))))
  249. value))))
  250. ;;;; Headline
  251. ;;
  252. ;; The main function to translate a headline is
  253. ;; `org-beamer-headline'.
  254. ;;
  255. ;; Depending on the level at which a headline is considered as
  256. ;; a frame (given by `org-beamer--frame-level'), the headline is
  257. ;; either a section (`org-beamer--format-section'), a frame
  258. ;; (`org-beamer--format-frame') or a block
  259. ;; (`org-beamer--format-block').
  260. ;;
  261. ;; `org-beamer-headline' also takes care of special environments
  262. ;; like "ignoreheading", "note", "noteNH", "appendix" and
  263. ;; "againframe".
  264. (defun org-beamer--get-label (headline info)
  265. "Return label for HEADLINE, as a string.
  266. INFO is a plist used as a communication channel.
  267. The value is either the label specified in \"BEAMER_opt\"
  268. property, the custom ID, if there is one and
  269. `:latex-prefer-user-labels' property has a non nil value, or
  270. a unique internal label. This function assumes HEADLINE will be
  271. treated as a frame."
  272. (cond
  273. ((let ((opt (org-element-property :BEAMER_OPT headline)))
  274. (and (stringp opt)
  275. (string-match "\\(?:^\\|,\\)label=\\(.*?\\)\\(?:$\\|,\\)" opt)
  276. (let ((label (match-string 1 opt)))
  277. (if (string-match-p "\\`{.*}\\'" label)
  278. (substring label 1 -1)
  279. label)))))
  280. ((and (plist-get info :latex-prefer-user-labels)
  281. (org-element-property :CUSTOM_ID headline)))
  282. (t (format "sec:%s" (org-export-get-reference headline info)))))
  283. (defun org-beamer--frame-level (headline info)
  284. "Return frame level in subtree containing HEADLINE.
  285. INFO is a plist used as a communication channel."
  286. (or
  287. ;; 1. Look for "frame" environment in parents, starting from the
  288. ;; farthest.
  289. (catch 'exit
  290. (dolist (parent (nreverse (org-element-lineage headline)))
  291. (let ((env (org-element-property :BEAMER_ENV parent)))
  292. (when (and env (member-ignore-case env '("frame" "fullframe")))
  293. (throw 'exit (org-export-get-relative-level parent info))))))
  294. ;; 2. Look for "frame" environment in HEADLINE.
  295. (let ((env (org-element-property :BEAMER_ENV headline)))
  296. (and env (member-ignore-case env '("frame" "fullframe"))
  297. (org-export-get-relative-level headline info)))
  298. ;; 3. Look for "frame" environment in sub-tree.
  299. (org-element-map headline 'headline
  300. (lambda (hl)
  301. (let ((env (org-element-property :BEAMER_ENV hl)))
  302. (when (and env (member-ignore-case env '("frame" "fullframe")))
  303. (org-export-get-relative-level hl info))))
  304. info 'first-match)
  305. ;; 4. No "frame" environment in tree: use default value.
  306. (plist-get info :headline-levels)))
  307. (defun org-beamer--format-section (headline contents info)
  308. "Format HEADLINE as a sectioning part.
  309. CONTENTS holds the contents of the headline. INFO is a plist
  310. used as a communication channel."
  311. (let ((latex-headline
  312. (org-export-with-backend
  313. ;; We create a temporary export back-end which behaves the
  314. ;; same as current one, but adds "\protect" in front of the
  315. ;; output of some objects.
  316. (org-export-create-backend
  317. :parent 'latex
  318. :transcoders
  319. (let ((protected-output
  320. (function
  321. (lambda (object contents info)
  322. (let ((code (org-export-with-backend
  323. 'beamer object contents info)))
  324. (if (org-string-nw-p code) (concat "\\protect" code)
  325. code))))))
  326. (mapcar #'(lambda (type) (cons type protected-output))
  327. '(bold footnote-reference italic strike-through timestamp
  328. underline))))
  329. headline
  330. contents
  331. info))
  332. (mode-specs (org-element-property :BEAMER_ACT headline)))
  333. (if (and mode-specs
  334. (string-match "\\`\\\\\\(.*?\\)\\(?:\\*\\|\\[.*\\]\\)?{"
  335. latex-headline))
  336. ;; Insert overlay specifications.
  337. (replace-match (concat (match-string 1 latex-headline)
  338. (format "<%s>" mode-specs))
  339. nil nil latex-headline 1)
  340. latex-headline)))
  341. (defun org-beamer--format-frame (headline contents info)
  342. "Format HEADLINE as a frame.
  343. CONTENTS holds the contents of the headline. INFO is a plist
  344. used as a communication channel."
  345. (let ((fragilep
  346. ;; FRAGILEP is non-nil when HEADLINE contains an element
  347. ;; among `org-beamer-verbatim-elements'.
  348. (org-element-map headline org-beamer-verbatim-elements 'identity
  349. info 'first-match)))
  350. (concat "\\begin{frame}"
  351. ;; Overlay specification, if any. When surrounded by
  352. ;; square brackets, consider it as a default
  353. ;; specification.
  354. (let ((action (org-element-property :BEAMER_ACT headline)))
  355. (cond
  356. ((not action) "")
  357. ((string-match "\\`\\[.*\\]\\'" action )
  358. (org-beamer--normalize-argument action 'defaction))
  359. (t (org-beamer--normalize-argument action 'action))))
  360. ;; Options, if any.
  361. (let* ((beamer-opt (org-element-property :BEAMER_OPT headline))
  362. (options
  363. ;; Collect nonempty options from default value and
  364. ;; headline's properties. Also add a label for
  365. ;; links.
  366. (cl-remove-if-not 'org-string-nw-p
  367. (append
  368. (org-split-string
  369. (plist-get info :beamer-frame-default-options) ",")
  370. (and beamer-opt
  371. (org-split-string
  372. ;; Remove square brackets if user provided
  373. ;; them.
  374. (and (string-match "^\\[?\\(.*\\)\\]?$" beamer-opt)
  375. (match-string 1 beamer-opt))
  376. ","))
  377. ;; Provide an automatic label for the frame
  378. ;; unless the user specified one. Also refrain
  379. ;; from labeling `allowframebreaks' frames; this
  380. ;; is not allowed by beamer.
  381. (unless (and beamer-opt
  382. (or (string-match "\\(^\\|,\\)label=" beamer-opt)
  383. (string-match "allowframebreaks" beamer-opt)))
  384. (list
  385. (let ((label (org-beamer--get-label headline info)))
  386. ;; Labels containing colons need to be
  387. ;; wrapped within braces.
  388. (format (if (string-match-p ":" label)
  389. "label={%s}"
  390. "label=%s")
  391. label))))))))
  392. ;; Change options list into a string.
  393. (org-beamer--normalize-argument
  394. (mapconcat
  395. 'identity
  396. (if (or (not fragilep) (member "fragile" options)) options
  397. (cons "fragile" options))
  398. ",")
  399. 'option))
  400. ;; Title.
  401. (let ((env (org-element-property :BEAMER_ENV headline)))
  402. (format "{%s}"
  403. (if (and env (equal (downcase env) "fullframe")) ""
  404. (org-export-data
  405. (org-element-property :title headline) info))))
  406. "\n"
  407. ;; The following workaround is required in fragile frames
  408. ;; as Beamer will append "\par" to the beginning of the
  409. ;; contents. So we need to make sure the command is
  410. ;; separated from the contents by at least one space. If
  411. ;; it isn't, it will create "\parfirst-word" command and
  412. ;; remove the first word from the contents in the PDF
  413. ;; output.
  414. (if (not fragilep) contents
  415. (replace-regexp-in-string "\\`\n*" "\\& " (or contents "")))
  416. "\\end{frame}")))
  417. (defun org-beamer--format-block (headline contents info)
  418. "Format HEADLINE as a block.
  419. CONTENTS holds the contents of the headline. INFO is a plist
  420. used as a communication channel."
  421. (let* ((column-width (org-element-property :BEAMER_COL headline))
  422. ;; ENVIRONMENT defaults to "block" if none is specified and
  423. ;; there is no column specification. If there is a column
  424. ;; specified but still no explicit environment, ENVIRONMENT
  425. ;; is "column".
  426. (environment (let ((env (org-element-property :BEAMER_ENV headline)))
  427. (cond
  428. ;; "block" is the fallback environment.
  429. ((and (not env) (not column-width)) "block")
  430. ;; "column" only.
  431. ((not env) "column")
  432. ;; Use specified environment.
  433. (t env))))
  434. (raw-title (org-element-property :raw-value headline))
  435. (env-format
  436. (cond ((member environment '("column" "columns")) nil)
  437. ((assoc environment
  438. (append (plist-get info :beamer-environments-extra)
  439. org-beamer-environments-default)))
  440. (t (user-error "Wrong block type at a headline named \"%s\""
  441. raw-title))))
  442. (title (org-export-data (org-element-property :title headline) info))
  443. (raw-options (org-element-property :BEAMER_OPT headline))
  444. (options (if raw-options
  445. (org-beamer--normalize-argument raw-options 'option)
  446. ""))
  447. ;; Start a "columns" environment when explicitly requested or
  448. ;; when there is no previous headline or the previous
  449. ;; headline do not have a BEAMER_column property.
  450. (parent-env (org-element-property
  451. :BEAMER_ENV (org-export-get-parent-headline headline)))
  452. (start-columns-p
  453. (or (equal environment "columns")
  454. (and column-width
  455. (not (and parent-env
  456. (equal (downcase parent-env) "columns")))
  457. (or (org-export-first-sibling-p headline info)
  458. (not (org-element-property
  459. :BEAMER_COL
  460. (org-export-get-previous-element
  461. headline info)))))))
  462. ;; End the "columns" environment when explicitly requested or
  463. ;; when there is no next headline or the next headline do not
  464. ;; have a BEAMER_column property.
  465. (end-columns-p
  466. (or (equal environment "columns")
  467. (and column-width
  468. (not (and parent-env
  469. (equal (downcase parent-env) "columns")))
  470. (or (org-export-last-sibling-p headline info)
  471. (not (org-element-property
  472. :BEAMER_COL
  473. (org-export-get-next-element headline info))))))))
  474. (concat
  475. (when start-columns-p
  476. ;; Column can accept options only when the environment is
  477. ;; explicitly defined.
  478. (if (not (equal environment "columns")) "\\begin{columns}\n"
  479. (format "\\begin{columns}%s\n" options)))
  480. (when column-width
  481. (format "\\begin{column}%s{%s}\n"
  482. ;; One can specify placement for column only when
  483. ;; HEADLINE stands for a column on its own.
  484. (if (equal environment "column") options "")
  485. (format "%s\\columnwidth" column-width)))
  486. ;; Block's opening string.
  487. (when (nth 2 env-format)
  488. (concat
  489. (org-fill-template
  490. (nth 2 env-format)
  491. (nconc
  492. ;; If BEAMER_act property has its value enclosed in square
  493. ;; brackets, it is a default overlay specification and
  494. ;; overlay specification is empty. Otherwise, it is an
  495. ;; overlay specification and the default one is nil.
  496. (let ((action (org-element-property :BEAMER_ACT headline)))
  497. (cond
  498. ((not action) (list (cons "a" "") (cons "A" "") (cons "R" "")))
  499. ((and (string-prefix-p "[" action)
  500. (string-suffix-p "]" action))
  501. (list
  502. (cons "A" (org-beamer--normalize-argument action 'defaction))
  503. (cons "a" "")
  504. (cons "R" action)))
  505. (t
  506. (list (cons "a" (org-beamer--normalize-argument action 'action))
  507. (cons "A" "")
  508. (cons "R" action)))))
  509. (list (cons "o" options)
  510. (cons "O" (or raw-options ""))
  511. (cons "h" title)
  512. (cons "r" raw-title)
  513. (cons "H" (if (equal raw-title "") ""
  514. (format "{%s}" raw-title)))
  515. (cons "U" (if (equal raw-title "") ""
  516. (format "[%s]" raw-title))))))
  517. "\n"))
  518. contents
  519. ;; Block's closing string, if any.
  520. (and (nth 3 env-format) (concat (nth 3 env-format) "\n"))
  521. (when column-width "\\end{column}\n")
  522. (when end-columns-p "\\end{columns}"))))
  523. (defun org-beamer-headline (headline contents info)
  524. "Transcode HEADLINE element into Beamer code.
  525. CONTENTS is the contents of the headline. INFO is a plist used
  526. as a communication channel."
  527. (unless (org-element-property :footnote-section-p headline)
  528. (let ((level (org-export-get-relative-level headline info))
  529. (frame-level (org-beamer--frame-level headline info))
  530. (environment (let ((env (org-element-property :BEAMER_ENV headline)))
  531. (or (org-string-nw-p env) "block"))))
  532. (cond
  533. ;; Case 1: Resume frame specified by "BEAMER_ref" property.
  534. ((equal environment "againframe")
  535. (let ((ref (org-element-property :BEAMER_REF headline)))
  536. ;; Reference to frame being resumed is mandatory. Ignore
  537. ;; the whole headline if it isn't provided.
  538. (when (org-string-nw-p ref)
  539. (concat "\\againframe"
  540. ;; Overlay specification.
  541. (let ((overlay (org-element-property :BEAMER_ACT headline)))
  542. (when overlay
  543. (org-beamer--normalize-argument
  544. overlay
  545. (if (string-match "\\`\\[.*\\]\\'" overlay) 'defaction
  546. 'action))))
  547. ;; Options.
  548. (let ((options (org-element-property :BEAMER_OPT headline)))
  549. (when options
  550. (org-beamer--normalize-argument options 'option)))
  551. ;; Resolve reference provided by "BEAMER_ref"
  552. ;; property. This is done by building a minimal
  553. ;; fake link and calling the appropriate resolve
  554. ;; function, depending on the reference syntax.
  555. (let ((target
  556. (if (string-match "\\`\\(id:\\|#\\)" ref)
  557. (org-export-resolve-id-link
  558. `(link (:path ,(substring ref (match-end 0))))
  559. info)
  560. (org-export-resolve-fuzzy-link
  561. `(link (:path
  562. ;; Look for headlines only.
  563. ,(if (eq (string-to-char ref) ?*) ref
  564. (concat "*" ref))))
  565. info))))
  566. ;; Now use user-defined label provided in TARGET
  567. ;; headline, or fallback to standard one.
  568. (format "{%s}" (org-beamer--get-label target info)))))))
  569. ;; Case 2: Creation of an appendix is requested.
  570. ((equal environment "appendix")
  571. (concat "\\appendix"
  572. (org-element-property :BEAMER_ACT headline)
  573. "\n"
  574. (make-string (org-element-property :pre-blank headline) ?\n)
  575. contents))
  576. ;; Case 3: Ignore heading.
  577. ((equal environment "ignoreheading")
  578. (concat (make-string (org-element-property :pre-blank headline) ?\n)
  579. contents))
  580. ;; Case 4: HEADLINE is a note.
  581. ((member environment '("note" "noteNH"))
  582. (format "\\note{%s}"
  583. (concat (and (equal environment "note")
  584. (concat
  585. (org-export-data
  586. (org-element-property :title headline) info)
  587. "\n"))
  588. (org-trim contents))))
  589. ;; Case 5: HEADLINE is a frame.
  590. ((= level frame-level)
  591. (org-beamer--format-frame headline contents info))
  592. ;; Case 6: Regular section, extracted from
  593. ;; `org-latex-classes'.
  594. ((< level frame-level)
  595. (org-beamer--format-section headline contents info))
  596. ;; Case 7: Otherwise, HEADLINE is a block.
  597. (t (org-beamer--format-block headline contents info))))))
  598. ;;;; Item
  599. (defun org-beamer-item (item contents info)
  600. "Transcode an ITEM element into Beamer code.
  601. CONTENTS holds the contents of the item. INFO is a plist holding
  602. contextual information."
  603. (org-export-with-backend
  604. ;; Delegate item export to `latex'. However, we use `beamer'
  605. ;; transcoders for objects in the description tag.
  606. (org-export-create-backend
  607. :parent 'beamer
  608. :transcoders
  609. (list
  610. (cons
  611. 'item
  612. (lambda (item _c _i)
  613. (let ((action
  614. (let ((first (car (org-element-contents item))))
  615. (and (eq (org-element-type first) 'paragraph)
  616. (org-beamer--element-has-overlay-p first))))
  617. (output (org-latex-item item contents info)))
  618. (if (not (and action (string-match "\\\\item" output))) output
  619. ;; If the item starts with a paragraph and that paragraph
  620. ;; starts with an export snippet specifying an overlay,
  621. ;; append it to the \item command.
  622. (replace-match (concat "\\\\item" action) nil nil output)))))))
  623. item contents info))
  624. ;;;; Keyword
  625. (defun org-beamer-keyword (keyword contents info)
  626. "Transcode a KEYWORD element into Beamer code.
  627. CONTENTS is nil. INFO is a plist used as a communication
  628. channel."
  629. (let ((key (org-element-property :key keyword))
  630. (value (org-element-property :value keyword)))
  631. ;; Handle specifically BEAMER and TOC (headlines only) keywords.
  632. ;; Otherwise, fallback to `latex' back-end.
  633. (cond
  634. ((equal key "BEAMER") value)
  635. ((and (equal key "TOC") (string-match "\\<headlines\\>" value))
  636. (let ((depth (or (and (string-match "[0-9]+" value)
  637. (string-to-number (match-string 0 value)))
  638. (plist-get info :with-toc)))
  639. (options (and (string-match "\\[.*?\\]" value)
  640. (match-string 0 value))))
  641. (concat
  642. (when (wholenump depth) (format "\\setcounter{tocdepth}{%s}\n" depth))
  643. "\\tableofcontents" options)))
  644. (t (org-export-with-backend 'latex keyword contents info)))))
  645. ;;;; Link
  646. (defun org-beamer-link (link contents info)
  647. "Transcode a LINK object into Beamer code.
  648. CONTENTS is the description part of the link. INFO is a plist
  649. used as a communication channel."
  650. (or (org-export-custom-protocol-maybe link contents 'beamer)
  651. ;; Fall-back to LaTeX export. However, prefer "\hyperlink" over
  652. ;; "\hyperref" since the former handles overlay specifications.
  653. (let ((latex-link (org-export-with-backend 'latex link contents info)))
  654. (if (string-match "\\`\\\\hyperref\\[\\(.*?\\)\\]" latex-link)
  655. (replace-match
  656. (format "\\\\hyperlink%s{\\1}"
  657. (or (org-beamer--element-has-overlay-p link) ""))
  658. nil nil latex-link)
  659. latex-link))))
  660. ;;;; Plain List
  661. ;;
  662. ;; Plain lists support `:environment', `:overlay' and `:options'
  663. ;; attributes.
  664. (defun org-beamer-plain-list (plain-list contents info)
  665. "Transcode a PLAIN-LIST element into Beamer code.
  666. CONTENTS is the contents of the list. INFO is a plist holding
  667. contextual information."
  668. (let* ((type (org-element-property :type plain-list))
  669. (attributes (org-combine-plists
  670. (org-export-read-attribute :attr_latex plain-list)
  671. (org-export-read-attribute :attr_beamer plain-list)))
  672. (latex-type (let ((env (plist-get attributes :environment)))
  673. (cond (env)
  674. ((eq type 'ordered) "enumerate")
  675. ((eq type 'descriptive) "description")
  676. (t "itemize")))))
  677. (org-latex--wrap-label
  678. plain-list
  679. (format "\\begin{%s}%s%s\n%s\\end{%s}"
  680. latex-type
  681. ;; Default overlay specification, if any.
  682. (org-beamer--normalize-argument
  683. (or (plist-get attributes :overlay) "")
  684. 'defaction)
  685. ;; Second optional argument depends on the list type.
  686. (org-beamer--normalize-argument
  687. (or (plist-get attributes :options) "")
  688. 'option)
  689. ;; Eventually insert contents and close environment.
  690. contents
  691. latex-type)
  692. info)))
  693. ;;;; Radio Target
  694. (defun org-beamer-radio-target (radio-target text info)
  695. "Transcode a RADIO-TARGET object into Beamer code.
  696. TEXT is the text of the target. INFO is a plist holding
  697. contextual information."
  698. (format "\\hypertarget%s{%s}{%s}"
  699. (or (org-beamer--element-has-overlay-p radio-target) "")
  700. (org-export-get-reference radio-target info)
  701. text))
  702. ;;;; Template
  703. ;;
  704. ;; Template used is similar to the one used in `latex' back-end,
  705. ;; excepted for the table of contents and Beamer themes.
  706. (defun org-beamer-template (contents info)
  707. "Return complete document string after Beamer conversion.
  708. CONTENTS is the transcoded contents string. INFO is a plist
  709. holding export options."
  710. (let ((title (org-export-data (plist-get info :title) info))
  711. (subtitle (org-export-data (plist-get info :subtitle) info)))
  712. (concat
  713. ;; Time-stamp.
  714. (and (plist-get info :time-stamp-file)
  715. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  716. ;; LaTeX compiler
  717. (org-latex--insert-compiler info)
  718. ;; Document class and packages.
  719. (org-latex-make-preamble info)
  720. ;; Insert themes.
  721. (let ((format-theme
  722. (function
  723. (lambda (prop command)
  724. (let ((theme (plist-get info prop)))
  725. (when theme
  726. (concat command
  727. (if (not (string-match "\\[.*\\]" theme))
  728. (format "{%s}\n" theme)
  729. (format "%s{%s}\n"
  730. (match-string 0 theme)
  731. (org-trim
  732. (replace-match "" nil nil theme)))))))))))
  733. (mapconcat (lambda (args) (apply format-theme args))
  734. '((:beamer-theme "\\usetheme")
  735. (:beamer-color-theme "\\usecolortheme")
  736. (:beamer-font-theme "\\usefonttheme")
  737. (:beamer-inner-theme "\\useinnertheme")
  738. (:beamer-outer-theme "\\useoutertheme"))
  739. ""))
  740. ;; Possibly limit depth for headline numbering.
  741. (let ((sec-num (plist-get info :section-numbers)))
  742. (when (integerp sec-num)
  743. (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
  744. ;; Author.
  745. (let ((author (and (plist-get info :with-author)
  746. (let ((auth (plist-get info :author)))
  747. (and auth (org-export-data auth info)))))
  748. (email (and (plist-get info :with-email)
  749. (org-export-data (plist-get info :email) info))))
  750. (cond ((and author email (not (string= "" email)))
  751. (format "\\author{%s\\thanks{%s}}\n" author email))
  752. ((or author email) (format "\\author{%s}\n" (or author email)))))
  753. ;; Date.
  754. (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
  755. (format "\\date{%s}\n" (org-export-data date info)))
  756. ;; Title
  757. (format "\\title{%s}\n" title)
  758. (when (org-string-nw-p subtitle)
  759. (concat (format (plist-get info :beamer-subtitle-format) subtitle) "\n"))
  760. ;; Beamer-header
  761. (let ((beamer-header (plist-get info :beamer-header)))
  762. (when beamer-header
  763. (format "%s\n" (plist-get info :beamer-header))))
  764. ;; 9. Hyperref options.
  765. (let ((template (plist-get info :latex-hyperref-template)))
  766. (and (stringp template)
  767. (format-spec template (org-latex--format-spec info))))
  768. ;; Document start.
  769. "\\begin{document}\n\n"
  770. ;; Title command.
  771. (org-element-normalize-string
  772. (cond ((not (plist-get info :with-title)) nil)
  773. ((string= "" title) nil)
  774. ((not (stringp org-latex-title-command)) nil)
  775. ((string-match "\\(?:[^%]\\|^\\)%s"
  776. org-latex-title-command)
  777. (format org-latex-title-command title))
  778. (t org-latex-title-command)))
  779. ;; Table of contents.
  780. (let ((depth (plist-get info :with-toc)))
  781. (when depth
  782. (concat
  783. (format "\\begin{frame}%s{%s}\n"
  784. (org-beamer--normalize-argument
  785. (plist-get info :beamer-outline-frame-options) 'option)
  786. (plist-get info :beamer-outline-frame-title))
  787. (when (wholenump depth)
  788. (format "\\setcounter{tocdepth}{%d}\n" depth))
  789. "\\tableofcontents\n"
  790. "\\end{frame}\n\n")))
  791. ;; Document's body.
  792. contents
  793. ;; Creator.
  794. (if (plist-get info :with-creator)
  795. (concat (plist-get info :creator) "\n")
  796. "")
  797. ;; Document end.
  798. "\\end{document}")))
  799. ;;; Minor Mode
  800. (defvar org-beamer-mode-map (make-sparse-keymap)
  801. "The keymap for `org-beamer-mode'.")
  802. (define-key org-beamer-mode-map "\C-c\C-b" 'org-beamer-select-environment)
  803. ;;;###autoload
  804. (define-minor-mode org-beamer-mode
  805. "Support for editing Beamer oriented Org mode files."
  806. nil " Bm" 'org-beamer-mode-map)
  807. (when (fboundp 'font-lock-add-keywords)
  808. (font-lock-add-keywords
  809. 'org-mode
  810. '((":\\(B_[a-z]+\\|BMCOL\\):" 1 'org-beamer-tag prepend))
  811. 'prepend))
  812. (defface org-beamer-tag '((t (:box (:line-width 1 :color grey40))))
  813. "The special face for beamer tags."
  814. :group 'org-export-beamer)
  815. (defun org-beamer-property-changed (property value)
  816. "Track the BEAMER_env property with tags.
  817. PROPERTY is the name of the modified property. VALUE is its new
  818. value."
  819. (cond
  820. ((equal property "BEAMER_env")
  821. (save-excursion
  822. (org-back-to-heading t)
  823. ;; Filter out Beamer-related tags and install environment tag.
  824. (let ((tags (cl-remove-if (lambda (x) (string-match "^B_" x))
  825. (org-get-tags nil t)))
  826. (env-tag (and (org-string-nw-p value) (concat "B_" value))))
  827. (org-set-tags (if env-tag (cons env-tag tags) tags))
  828. (when env-tag (org-toggle-tag env-tag 'on)))))
  829. ((equal property "BEAMER_col")
  830. (org-toggle-tag "BMCOL" (if (org-string-nw-p value) 'on 'off)))))
  831. (add-hook 'org-property-changed-functions 'org-beamer-property-changed)
  832. (defun org-beamer-allowed-property-values (property)
  833. "Supply allowed values for PROPERTY."
  834. (cond
  835. ((and (equal property "BEAMER_env")
  836. (not (org-entry-get nil (concat property "_ALL") 'inherit)))
  837. ;; If no allowed values for BEAMER_env have been defined,
  838. ;; supply all defined environments
  839. (mapcar 'car (append org-beamer-environments-special
  840. org-beamer-environments-extra
  841. org-beamer-environments-default)))
  842. ((and (equal property "BEAMER_col")
  843. (not (org-entry-get nil (concat property "_ALL") 'inherit)))
  844. ;; If no allowed values for BEAMER_col have been defined, supply
  845. ;; some.
  846. (split-string org-beamer-column-widths " "))))
  847. (add-hook 'org-property-allowed-value-functions
  848. 'org-beamer-allowed-property-values)
  849. ;;; Commands
  850. ;;;###autoload
  851. (defun org-beamer-export-as-latex
  852. (&optional async subtreep visible-only body-only ext-plist)
  853. "Export current buffer as a Beamer buffer.
  854. If narrowing is active in the current buffer, only export its
  855. narrowed part.
  856. If a region is active, export that region.
  857. A non-nil optional argument ASYNC means the process should happen
  858. asynchronously. The resulting buffer should be accessible
  859. through the `org-export-stack' interface.
  860. When optional argument SUBTREEP is non-nil, export the sub-tree
  861. at point, extracting information from the headline properties
  862. first.
  863. When optional argument VISIBLE-ONLY is non-nil, don't export
  864. contents of hidden elements.
  865. When optional argument BODY-ONLY is non-nil, only write code
  866. between \"\\begin{document}\" and \"\\end{document}\".
  867. EXT-PLIST, when provided, is a property list with external
  868. parameters overriding Org default settings, but still inferior to
  869. file-local settings.
  870. Export is done in a buffer named \"*Org BEAMER Export*\", which
  871. will be displayed when `org-export-show-temporary-export-buffer'
  872. is non-nil."
  873. (interactive)
  874. (org-export-to-buffer 'beamer "*Org BEAMER Export*"
  875. async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
  876. ;;;###autoload
  877. (defun org-beamer-export-to-latex
  878. (&optional async subtreep visible-only body-only ext-plist)
  879. "Export current buffer as a Beamer presentation (tex).
  880. If narrowing is active in the current buffer, only export its
  881. narrowed part.
  882. If a region is active, export that region.
  883. A non-nil optional argument ASYNC means the process should happen
  884. asynchronously. The resulting file should be accessible through
  885. the `org-export-stack' interface.
  886. When optional argument SUBTREEP is non-nil, export the sub-tree
  887. at point, extracting information from the headline properties
  888. first.
  889. When optional argument VISIBLE-ONLY is non-nil, don't export
  890. contents of hidden elements.
  891. When optional argument BODY-ONLY is non-nil, only write code
  892. between \"\\begin{document}\" and \"\\end{document}\".
  893. EXT-PLIST, when provided, is a property list with external
  894. parameters overriding Org default settings, but still inferior to
  895. file-local settings.
  896. Return output file's name."
  897. (interactive)
  898. (let ((file (org-export-output-file-name ".tex" subtreep)))
  899. (org-export-to-file 'beamer file
  900. async subtreep visible-only body-only ext-plist)))
  901. ;;;###autoload
  902. (defun org-beamer-export-to-pdf
  903. (&optional async subtreep visible-only body-only ext-plist)
  904. "Export current buffer as a Beamer presentation (PDF).
  905. If narrowing is active in the current buffer, only export its
  906. narrowed part.
  907. If a region is active, export that region.
  908. A non-nil optional argument ASYNC means the process should happen
  909. asynchronously. The resulting file should be accessible through
  910. the `org-export-stack' interface.
  911. When optional argument SUBTREEP is non-nil, export the sub-tree
  912. at point, extracting information from the headline properties
  913. first.
  914. When optional argument VISIBLE-ONLY is non-nil, don't export
  915. contents of hidden elements.
  916. When optional argument BODY-ONLY is non-nil, only write code
  917. between \"\\begin{document}\" and \"\\end{document}\".
  918. EXT-PLIST, when provided, is a property list with external
  919. parameters overriding Org default settings, but still inferior to
  920. file-local settings.
  921. Return PDF file's name."
  922. (interactive)
  923. (let ((file (org-export-output-file-name ".tex" subtreep)))
  924. (org-export-to-file 'beamer file
  925. async subtreep visible-only body-only ext-plist
  926. (lambda (file) (org-latex-compile file)))))
  927. ;;;###autoload
  928. (defun org-beamer-select-environment ()
  929. "Select the environment to be used by beamer for this entry.
  930. While this uses (for convenience) a tag selection interface, the
  931. result of this command will be that the BEAMER_env *property* of
  932. the entry is set.
  933. In addition to this, the command will also set a tag as a visual
  934. aid, but the tag does not have any semantic meaning."
  935. (interactive)
  936. ;; Make sure `org-beamer-environments-special' has a higher
  937. ;; priority than `org-beamer-environments-extra'.
  938. (let* ((envs (append org-beamer-environments-special
  939. org-beamer-environments-extra
  940. org-beamer-environments-default))
  941. (org-current-tag-alist
  942. (append '((:startgroup))
  943. (mapcar (lambda (e) (cons (concat "B_" (car e))
  944. (string-to-char (nth 1 e))))
  945. envs)
  946. '((:endgroup))
  947. '(("BMCOL" . ?|))))
  948. (org-tag-persistent-alist nil)
  949. (org-use-fast-tag-selection t)
  950. (org-fast-tag-selection-single-key t))
  951. (org-set-tags-command)
  952. (let ((tags (org-get-tags nil t)))
  953. (cond
  954. ;; For a column, automatically ask for its width.
  955. ((eq org-last-tag-selection-key ?|)
  956. (if (member "BMCOL" tags)
  957. (org-set-property "BEAMER_col" (read-string "Column width: "))
  958. (org-delete-property "BEAMER_col")))
  959. ;; For an "againframe" section, automatically ask for reference
  960. ;; to resumed frame and overlay specifications.
  961. ((eq org-last-tag-selection-key ?A)
  962. (if (equal (org-entry-get nil "BEAMER_env") "againframe")
  963. (progn (org-entry-delete nil "BEAMER_env")
  964. (org-entry-delete nil "BEAMER_ref")
  965. (org-entry-delete nil "BEAMER_act"))
  966. (org-entry-put nil "BEAMER_env" "againframe")
  967. (org-set-property
  968. "BEAMER_ref"
  969. (read-string "Frame reference (*Title, #custom-id, id:...): "))
  970. (org-set-property "BEAMER_act"
  971. (read-string "Overlay specification: "))))
  972. ((let ((tags-re (concat "B_" (regexp-opt (mapcar #'car envs) t))))
  973. (cl-some (lambda (tag) (string-match tags-re tag)) tags))
  974. (org-entry-put nil "BEAMER_env" (match-string 1 tags)))
  975. (t (org-entry-delete nil "BEAMER_env"))))))
  976. ;;;###autoload
  977. (defun org-beamer-publish-to-latex (plist filename pub-dir)
  978. "Publish an Org file to a Beamer presentation (LaTeX).
  979. FILENAME is the filename of the Org file to be published. PLIST
  980. is the property list for the given project. PUB-DIR is the
  981. publishing directory.
  982. Return output file name."
  983. (org-publish-org-to 'beamer filename ".tex" plist pub-dir))
  984. ;;;###autoload
  985. (defun org-beamer-publish-to-pdf (plist filename pub-dir)
  986. "Publish an Org file to a Beamer presentation (PDF, via LaTeX).
  987. FILENAME is the filename of the Org file to be published. PLIST
  988. is the property list for the given project. PUB-DIR is the
  989. publishing directory.
  990. Return output file name."
  991. ;; Unlike to `org-beamer-publish-to-latex', PDF file is generated in
  992. ;; working directory and then moved to publishing directory.
  993. (org-publish-attachment
  994. plist
  995. ;; Default directory could be anywhere when this function is
  996. ;; called. We ensure it is set to source file directory during
  997. ;; compilation so as to not break links to external documents.
  998. (let ((default-directory (file-name-directory filename)))
  999. (org-latex-compile
  1000. (org-publish-org-to
  1001. 'beamer filename ".tex" plist (file-name-directory filename))))
  1002. pub-dir))
  1003. (provide 'ox-beamer)
  1004. ;; Local variables:
  1005. ;; generated-autoload-file: "org-loaddefs.el"
  1006. ;; End:
  1007. ;;; ox-beamer.el ends here