ox-beamer.el 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158
  1. ;;; ox-beamer.el --- Beamer Back-End for Org Export Engine -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2007-2019 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.
  365. (cl-remove-if-not #'org-string-nw-p
  366. (append
  367. (org-split-string
  368. (plist-get info :beamer-frame-default-options) ",")
  369. (and beamer-opt
  370. (org-split-string
  371. ;; Remove square brackets if user provided
  372. ;; them.
  373. (and (string-match "^\\[?\\(.*\\)\\]?$" beamer-opt)
  374. (match-string 1 beamer-opt))
  375. ",")))))
  376. (fragile
  377. ;; Add "fragile" option if necessary.
  378. (and fragilep
  379. (not (member "fragile" options))
  380. (list "fragile")))
  381. (label
  382. ;; Provide an automatic label for the frame unless
  383. ;; the user specified one. Also refrain from
  384. ;; labeling `allowframebreaks' frames; this is not
  385. ;; allowed by Beamer.
  386. (and (not (member "allowframebreaks" options))
  387. (not (cl-some (lambda (s) (string-match-p "^label=" s))
  388. options))
  389. (list
  390. (let ((label (org-beamer--get-label headline info)))
  391. ;; Labels containing colons need to be
  392. ;; wrapped within braces.
  393. (format (if (string-match-p ":" label)
  394. "label={%s}"
  395. "label=%s")
  396. label))))))
  397. ;; Change options list into a string.
  398. (org-beamer--normalize-argument
  399. (mapconcat #'identity (append label fragile options) ",")
  400. 'option))
  401. ;; Title.
  402. (let ((env (org-element-property :BEAMER_ENV headline)))
  403. (format "{%s}"
  404. (if (and env (equal (downcase env) "fullframe")) ""
  405. (org-export-data
  406. (org-element-property :title headline) info))))
  407. "\n"
  408. ;; The following workaround is required in fragile frames
  409. ;; as Beamer will append "\par" to the beginning of the
  410. ;; contents. So we need to make sure the command is
  411. ;; separated from the contents by at least one space. If
  412. ;; it isn't, it will create "\parfirst-word" command and
  413. ;; remove the first word from the contents in the PDF
  414. ;; output.
  415. (if (not fragilep) contents
  416. (replace-regexp-in-string "\\`\n*" "\\& " (or contents "")))
  417. "\\end{frame}")))
  418. (defun org-beamer--format-block (headline contents info)
  419. "Format HEADLINE as a block.
  420. CONTENTS holds the contents of the headline. INFO is a plist
  421. used as a communication channel."
  422. (let* ((column-width (org-element-property :BEAMER_COL headline))
  423. ;; ENVIRONMENT defaults to "block" if none is specified and
  424. ;; there is no column specification. If there is a column
  425. ;; specified but still no explicit environment, ENVIRONMENT
  426. ;; is "column".
  427. (environment (let ((env (org-element-property :BEAMER_ENV headline)))
  428. (cond
  429. ;; "block" is the fallback environment.
  430. ((and (not env) (not column-width)) "block")
  431. ;; "column" only.
  432. ((not env) "column")
  433. ;; Use specified environment.
  434. (t env))))
  435. (raw-title (org-element-property :raw-value headline))
  436. (env-format
  437. (cond ((member environment '("column" "columns")) nil)
  438. ((assoc environment
  439. (append (plist-get info :beamer-environments-extra)
  440. org-beamer-environments-default)))
  441. (t (user-error "Wrong block type at a headline named \"%s\""
  442. raw-title))))
  443. (title (org-export-data (org-element-property :title headline) info))
  444. (raw-options (org-element-property :BEAMER_OPT headline))
  445. (options (if raw-options
  446. (org-beamer--normalize-argument raw-options 'option)
  447. ""))
  448. ;; Start a "columns" environment when explicitly requested or
  449. ;; when there is no previous headline or the previous
  450. ;; headline do not have a BEAMER_column property.
  451. (parent-env (org-element-property
  452. :BEAMER_ENV (org-export-get-parent-headline headline)))
  453. (start-columns-p
  454. (or (equal environment "columns")
  455. (and column-width
  456. (not (and parent-env
  457. (equal (downcase parent-env) "columns")))
  458. (or (org-export-first-sibling-p headline info)
  459. (not (org-element-property
  460. :BEAMER_COL
  461. (org-export-get-previous-element
  462. headline info)))))))
  463. ;; End the "columns" environment when explicitly requested or
  464. ;; when there is no next headline or the next headline do not
  465. ;; have a BEAMER_column property.
  466. (end-columns-p
  467. (or (equal environment "columns")
  468. (and column-width
  469. (not (and parent-env
  470. (equal (downcase parent-env) "columns")))
  471. (or (org-export-last-sibling-p headline info)
  472. (not (org-element-property
  473. :BEAMER_COL
  474. (org-export-get-next-element headline info))))))))
  475. (concat
  476. (when start-columns-p
  477. ;; Column can accept options only when the environment is
  478. ;; explicitly defined.
  479. (if (not (equal environment "columns")) "\\begin{columns}\n"
  480. (format "\\begin{columns}%s\n" options)))
  481. (when column-width
  482. (format "\\begin{column}%s{%s}\n"
  483. ;; One can specify placement for column only when
  484. ;; HEADLINE stands for a column on its own.
  485. (if (equal environment "column") options "")
  486. (format "%s\\columnwidth" column-width)))
  487. ;; Block's opening string.
  488. (when (nth 2 env-format)
  489. (concat
  490. (org-fill-template
  491. (nth 2 env-format)
  492. (nconc
  493. ;; If BEAMER_act property has its value enclosed in square
  494. ;; brackets, it is a default overlay specification and
  495. ;; overlay specification is empty. Otherwise, it is an
  496. ;; overlay specification and the default one is nil.
  497. (let ((action (org-element-property :BEAMER_ACT headline)))
  498. (cond
  499. ((not action) (list (cons "a" "") (cons "A" "") (cons "R" "")))
  500. ((and (string-prefix-p "[" action)
  501. (string-suffix-p "]" action))
  502. (list
  503. (cons "A" (org-beamer--normalize-argument action 'defaction))
  504. (cons "a" "")
  505. (cons "R" action)))
  506. (t
  507. (list (cons "a" (org-beamer--normalize-argument action 'action))
  508. (cons "A" "")
  509. (cons "R" action)))))
  510. (list (cons "o" options)
  511. (cons "O" (or raw-options ""))
  512. (cons "h" title)
  513. (cons "r" raw-title)
  514. (cons "H" (if (equal raw-title "") ""
  515. (format "{%s}" raw-title)))
  516. (cons "U" (if (equal raw-title "") ""
  517. (format "[%s]" raw-title))))))
  518. "\n"))
  519. contents
  520. ;; Block's closing string, if any.
  521. (and (nth 3 env-format) (concat (nth 3 env-format) "\n"))
  522. (when column-width "\\end{column}\n")
  523. (when end-columns-p "\\end{columns}"))))
  524. (defun org-beamer-headline (headline contents info)
  525. "Transcode HEADLINE element into Beamer code.
  526. CONTENTS is the contents of the headline. INFO is a plist used
  527. as a communication channel."
  528. (unless (org-element-property :footnote-section-p headline)
  529. (let ((level (org-export-get-relative-level headline info))
  530. (frame-level (org-beamer--frame-level headline info))
  531. (environment (let ((env (org-element-property :BEAMER_ENV headline)))
  532. (or (org-string-nw-p env) "block"))))
  533. (cond
  534. ;; Case 1: Resume frame specified by "BEAMER_ref" property.
  535. ((equal environment "againframe")
  536. (let ((ref (org-element-property :BEAMER_REF headline)))
  537. ;; Reference to frame being resumed is mandatory. Ignore
  538. ;; the whole headline if it isn't provided.
  539. (when (org-string-nw-p ref)
  540. (concat "\\againframe"
  541. ;; Overlay specification.
  542. (let ((overlay (org-element-property :BEAMER_ACT headline)))
  543. (when overlay
  544. (org-beamer--normalize-argument
  545. overlay
  546. (if (string-match "\\`\\[.*\\]\\'" overlay) 'defaction
  547. 'action))))
  548. ;; Options.
  549. (let ((options (org-element-property :BEAMER_OPT headline)))
  550. (when options
  551. (org-beamer--normalize-argument options 'option)))
  552. ;; Resolve reference provided by "BEAMER_ref"
  553. ;; property. This is done by building a minimal
  554. ;; fake link and calling the appropriate resolve
  555. ;; function, depending on the reference syntax.
  556. (let ((target
  557. (if (string-match "\\`\\(id:\\|#\\)" ref)
  558. (org-export-resolve-id-link
  559. `(link (:path ,(substring ref (match-end 0))))
  560. info)
  561. (org-export-resolve-fuzzy-link
  562. `(link (:path
  563. ;; Look for headlines only.
  564. ,(if (eq (string-to-char ref) ?*) ref
  565. (concat "*" ref))))
  566. info))))
  567. ;; Now use user-defined label provided in TARGET
  568. ;; headline, or fallback to standard one.
  569. (format "{%s}" (org-beamer--get-label target info)))))))
  570. ;; Case 2: Creation of an appendix is requested.
  571. ((equal environment "appendix")
  572. (concat "\\appendix"
  573. (org-element-property :BEAMER_ACT headline)
  574. "\n"
  575. (make-string (org-element-property :pre-blank headline) ?\n)
  576. contents))
  577. ;; Case 3: Ignore heading.
  578. ((equal environment "ignoreheading")
  579. (concat (make-string (org-element-property :pre-blank headline) ?\n)
  580. contents))
  581. ;; Case 4: HEADLINE is a note.
  582. ((member environment '("note" "noteNH"))
  583. (concat "\\note"
  584. ;; Overlay specification.
  585. (let ((overlay (org-element-property :BEAMER_ACT headline)))
  586. (when overlay
  587. (org-beamer--normalize-argument
  588. overlay
  589. (if (string-match "\\`\\[.*\\]\\'" overlay)
  590. 'defaction 'action))))
  591. (format "{%s}"
  592. (concat (and (equal environment "note")
  593. (concat
  594. (org-export-data
  595. (org-element-property :title headline)
  596. info)
  597. "\n"))
  598. (org-trim contents)))))
  599. ;; Case 5: HEADLINE is a frame.
  600. ((= level frame-level)
  601. (org-beamer--format-frame headline contents info))
  602. ;; Case 6: Regular section, extracted from
  603. ;; `org-latex-classes'.
  604. ((< level frame-level)
  605. (org-beamer--format-section headline contents info))
  606. ;; Case 7: Otherwise, HEADLINE is a block.
  607. (t (org-beamer--format-block headline contents info))))))
  608. ;;;; Item
  609. (defun org-beamer-item (item contents info)
  610. "Transcode an ITEM element into Beamer code.
  611. CONTENTS holds the contents of the item. INFO is a plist holding
  612. contextual information."
  613. (org-export-with-backend
  614. ;; Delegate item export to `latex'. However, we use `beamer'
  615. ;; transcoders for objects in the description tag.
  616. (org-export-create-backend
  617. :parent 'beamer
  618. :transcoders
  619. (list
  620. (cons
  621. 'item
  622. (lambda (item _c _i)
  623. (let ((action
  624. (let ((first (car (org-element-contents item))))
  625. (and (eq (org-element-type first) 'paragraph)
  626. (org-beamer--element-has-overlay-p first))))
  627. (output (org-latex-item item contents info)))
  628. (if (not (and action (string-match "\\\\item" output))) output
  629. ;; If the item starts with a paragraph and that paragraph
  630. ;; starts with an export snippet specifying an overlay,
  631. ;; append it to the \item command.
  632. (replace-match (concat "\\\\item" action) nil nil output)))))))
  633. item contents info))
  634. ;;;; Keyword
  635. (defun org-beamer-keyword (keyword contents info)
  636. "Transcode a KEYWORD element into Beamer code.
  637. CONTENTS is nil. INFO is a plist used as a communication
  638. channel."
  639. (let ((key (org-element-property :key keyword))
  640. (value (org-element-property :value keyword)))
  641. ;; Handle specifically BEAMER and TOC (headlines only) keywords.
  642. ;; Otherwise, fallback to `latex' back-end.
  643. (cond
  644. ((equal key "BEAMER") value)
  645. ((and (equal key "TOC") (string-match "\\<headlines\\>" value))
  646. (let ((depth (or (and (string-match "[0-9]+" value)
  647. (string-to-number (match-string 0 value)))
  648. (plist-get info :with-toc)))
  649. (options (and (string-match "\\[.*?\\]" value)
  650. (match-string 0 value))))
  651. (concat
  652. (when (wholenump depth) (format "\\setcounter{tocdepth}{%s}\n" depth))
  653. "\\tableofcontents" options)))
  654. (t (org-export-with-backend 'latex keyword contents info)))))
  655. ;;;; Link
  656. (defun org-beamer-link (link contents info)
  657. "Transcode a LINK object into Beamer code.
  658. CONTENTS is the description part of the link. INFO is a plist
  659. used as a communication channel."
  660. (or (org-export-custom-protocol-maybe link contents 'beamer)
  661. ;; Fall-back to LaTeX export. However, prefer "\hyperlink" over
  662. ;; "\hyperref" since the former handles overlay specifications.
  663. (let ((latex-link (org-export-with-backend 'latex link contents info)))
  664. (if (string-match "\\`\\\\hyperref\\[\\(.*?\\)\\]" latex-link)
  665. (replace-match
  666. (format "\\\\hyperlink%s{\\1}"
  667. (or (org-beamer--element-has-overlay-p link) ""))
  668. nil nil latex-link)
  669. latex-link))))
  670. ;;;; Plain List
  671. ;;
  672. ;; Plain lists support `:environment', `:overlay' and `:options'
  673. ;; attributes.
  674. (defun org-beamer-plain-list (plain-list contents info)
  675. "Transcode a PLAIN-LIST element into Beamer code.
  676. CONTENTS is the contents of the list. INFO is a plist holding
  677. contextual information."
  678. (let* ((type (org-element-property :type plain-list))
  679. (attributes (org-combine-plists
  680. (org-export-read-attribute :attr_latex plain-list)
  681. (org-export-read-attribute :attr_beamer plain-list)))
  682. (latex-type (let ((env (plist-get attributes :environment)))
  683. (cond (env)
  684. ((eq type 'ordered) "enumerate")
  685. ((eq type 'descriptive) "description")
  686. (t "itemize")))))
  687. (org-latex--wrap-label
  688. plain-list
  689. (format "\\begin{%s}%s%s\n%s\\end{%s}"
  690. latex-type
  691. ;; Default overlay specification, if any.
  692. (org-beamer--normalize-argument
  693. (or (plist-get attributes :overlay) "")
  694. 'defaction)
  695. ;; Second optional argument depends on the list type.
  696. (org-beamer--normalize-argument
  697. (or (plist-get attributes :options) "")
  698. 'option)
  699. ;; Eventually insert contents and close environment.
  700. contents
  701. latex-type)
  702. info)))
  703. ;;;; Radio Target
  704. (defun org-beamer-radio-target (radio-target text info)
  705. "Transcode a RADIO-TARGET object into Beamer code.
  706. TEXT is the text of the target. INFO is a plist holding
  707. contextual information."
  708. (format "\\hypertarget%s{%s}{%s}"
  709. (or (org-beamer--element-has-overlay-p radio-target) "")
  710. (org-export-get-reference radio-target info)
  711. text))
  712. ;;;; Template
  713. ;;
  714. ;; Template used is similar to the one used in `latex' back-end,
  715. ;; excepted for the table of contents and Beamer themes.
  716. (defun org-beamer-template (contents info)
  717. "Return complete document string after Beamer conversion.
  718. CONTENTS is the transcoded contents string. INFO is a plist
  719. holding export options."
  720. (let ((title (org-export-data (plist-get info :title) info))
  721. (subtitle (org-export-data (plist-get info :subtitle) info)))
  722. (concat
  723. ;; Time-stamp.
  724. (and (plist-get info :time-stamp-file)
  725. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  726. ;; LaTeX compiler
  727. (org-latex--insert-compiler info)
  728. ;; Document class and packages.
  729. (org-latex-make-preamble info)
  730. ;; Insert themes.
  731. (let ((format-theme
  732. (function
  733. (lambda (prop command)
  734. (let ((theme (plist-get info prop)))
  735. (when theme
  736. (concat command
  737. (if (not (string-match "\\[.*\\]" theme))
  738. (format "{%s}\n" theme)
  739. (format "%s{%s}\n"
  740. (match-string 0 theme)
  741. (org-trim
  742. (replace-match "" nil nil theme)))))))))))
  743. (mapconcat (lambda (args) (apply format-theme args))
  744. '((:beamer-theme "\\usetheme")
  745. (:beamer-color-theme "\\usecolortheme")
  746. (:beamer-font-theme "\\usefonttheme")
  747. (:beamer-inner-theme "\\useinnertheme")
  748. (:beamer-outer-theme "\\useoutertheme"))
  749. ""))
  750. ;; Possibly limit depth for headline numbering.
  751. (let ((sec-num (plist-get info :section-numbers)))
  752. (when (integerp sec-num)
  753. (format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
  754. ;; Author.
  755. (let ((author (and (plist-get info :with-author)
  756. (let ((auth (plist-get info :author)))
  757. (and auth (org-export-data auth info)))))
  758. (email (and (plist-get info :with-email)
  759. (org-export-data (plist-get info :email) info))))
  760. (cond ((and author email (not (string= "" email)))
  761. (format "\\author{%s\\thanks{%s}}\n" author email))
  762. ((or author email) (format "\\author{%s}\n" (or author email)))))
  763. ;; Date.
  764. (let ((date (and (plist-get info :with-date) (org-export-get-date info))))
  765. (format "\\date{%s}\n" (org-export-data date info)))
  766. ;; Title
  767. (format "\\title{%s}\n" title)
  768. (when (org-string-nw-p subtitle)
  769. (concat (format (plist-get info :beamer-subtitle-format) subtitle) "\n"))
  770. ;; Beamer-header
  771. (let ((beamer-header (plist-get info :beamer-header)))
  772. (when beamer-header
  773. (format "%s\n" (plist-get info :beamer-header))))
  774. ;; 9. Hyperref options.
  775. (let ((template (plist-get info :latex-hyperref-template)))
  776. (and (stringp template)
  777. (format-spec template (org-latex--format-spec info))))
  778. ;; Document start.
  779. "\\begin{document}\n\n"
  780. ;; Title command.
  781. (org-element-normalize-string
  782. (cond ((not (plist-get info :with-title)) nil)
  783. ((string= "" title) nil)
  784. ((not (stringp org-latex-title-command)) nil)
  785. ((string-match "\\(?:[^%]\\|^\\)%s"
  786. org-latex-title-command)
  787. (format org-latex-title-command title))
  788. (t org-latex-title-command)))
  789. ;; Table of contents.
  790. (let ((depth (plist-get info :with-toc)))
  791. (when depth
  792. (concat
  793. (format "\\begin{frame}%s{%s}\n"
  794. (org-beamer--normalize-argument
  795. (plist-get info :beamer-outline-frame-options) 'option)
  796. (plist-get info :beamer-outline-frame-title))
  797. (when (wholenump depth)
  798. (format "\\setcounter{tocdepth}{%d}\n" depth))
  799. "\\tableofcontents\n"
  800. "\\end{frame}\n\n")))
  801. ;; Document's body.
  802. contents
  803. ;; Creator.
  804. (if (plist-get info :with-creator)
  805. (concat (plist-get info :creator) "\n")
  806. "")
  807. ;; Document end.
  808. "\\end{document}")))
  809. ;;; Minor Mode
  810. (defvar org-beamer-mode-map (make-sparse-keymap)
  811. "The keymap for `org-beamer-mode'.")
  812. (define-key org-beamer-mode-map "\C-c\C-b" 'org-beamer-select-environment)
  813. ;;;###autoload
  814. (define-minor-mode org-beamer-mode
  815. "Support for editing Beamer oriented Org mode files."
  816. nil " Bm" 'org-beamer-mode-map)
  817. (when (fboundp 'font-lock-add-keywords)
  818. (font-lock-add-keywords
  819. 'org-mode
  820. '((":\\(B_[a-z]+\\|BMCOL\\):" 1 'org-beamer-tag prepend))
  821. 'prepend))
  822. (defface org-beamer-tag '((t (:box (:line-width 1 :color grey40))))
  823. "The special face for beamer tags."
  824. :group 'org-export-beamer)
  825. (defun org-beamer-property-changed (property value)
  826. "Track the BEAMER_env property with tags.
  827. PROPERTY is the name of the modified property. VALUE is its new
  828. value."
  829. (cond
  830. ((equal property "BEAMER_env")
  831. (save-excursion
  832. (org-back-to-heading t)
  833. ;; Filter out Beamer-related tags and install environment tag.
  834. (let ((tags (cl-remove-if (lambda (x) (string-match "^B_" x))
  835. (org-get-tags nil t)))
  836. (env-tag (and (org-string-nw-p value) (concat "B_" value))))
  837. (org-set-tags (if env-tag (cons env-tag tags) tags))
  838. (when env-tag (org-toggle-tag env-tag 'on)))))
  839. ((equal property "BEAMER_col")
  840. (org-toggle-tag "BMCOL" (if (org-string-nw-p value) 'on 'off)))))
  841. (add-hook 'org-property-changed-functions 'org-beamer-property-changed)
  842. (defun org-beamer-allowed-property-values (property)
  843. "Supply allowed values for PROPERTY."
  844. (cond
  845. ((and (equal property "BEAMER_env")
  846. (not (org-entry-get nil (concat property "_ALL") 'inherit)))
  847. ;; If no allowed values for BEAMER_env have been defined,
  848. ;; supply all defined environments
  849. (mapcar 'car (append org-beamer-environments-special
  850. org-beamer-environments-extra
  851. org-beamer-environments-default)))
  852. ((and (equal property "BEAMER_col")
  853. (not (org-entry-get nil (concat property "_ALL") 'inherit)))
  854. ;; If no allowed values for BEAMER_col have been defined, supply
  855. ;; some.
  856. (split-string org-beamer-column-widths " "))))
  857. (add-hook 'org-property-allowed-value-functions
  858. 'org-beamer-allowed-property-values)
  859. ;;; Commands
  860. ;;;###autoload
  861. (defun org-beamer-export-as-latex
  862. (&optional async subtreep visible-only body-only ext-plist)
  863. "Export current buffer as a Beamer buffer.
  864. If narrowing is active in the current buffer, only export its
  865. narrowed part.
  866. If a region is active, export that region.
  867. A non-nil optional argument ASYNC means the process should happen
  868. asynchronously. The resulting buffer should be accessible
  869. through the `org-export-stack' interface.
  870. When optional argument SUBTREEP is non-nil, export the sub-tree
  871. at point, extracting information from the headline properties
  872. first.
  873. When optional argument VISIBLE-ONLY is non-nil, don't export
  874. contents of hidden elements.
  875. When optional argument BODY-ONLY is non-nil, only write code
  876. between \"\\begin{document}\" and \"\\end{document}\".
  877. EXT-PLIST, when provided, is a property list with external
  878. parameters overriding Org default settings, but still inferior to
  879. file-local settings.
  880. Export is done in a buffer named \"*Org BEAMER Export*\", which
  881. will be displayed when `org-export-show-temporary-export-buffer'
  882. is non-nil."
  883. (interactive)
  884. (org-export-to-buffer 'beamer "*Org BEAMER Export*"
  885. async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
  886. ;;;###autoload
  887. (defun org-beamer-export-to-latex
  888. (&optional async subtreep visible-only body-only ext-plist)
  889. "Export current buffer as a Beamer presentation (tex).
  890. If narrowing is active in the current buffer, only export its
  891. narrowed part.
  892. If a region is active, export that region.
  893. A non-nil optional argument ASYNC means the process should happen
  894. asynchronously. The resulting file should be accessible through
  895. the `org-export-stack' interface.
  896. When optional argument SUBTREEP is non-nil, export the sub-tree
  897. at point, extracting information from the headline properties
  898. first.
  899. When optional argument VISIBLE-ONLY is non-nil, don't export
  900. contents of hidden elements.
  901. When optional argument BODY-ONLY is non-nil, only write code
  902. between \"\\begin{document}\" and \"\\end{document}\".
  903. EXT-PLIST, when provided, is a property list with external
  904. parameters overriding Org default settings, but still inferior to
  905. file-local settings.
  906. Return output file's name."
  907. (interactive)
  908. (let ((file (org-export-output-file-name ".tex" subtreep)))
  909. (org-export-to-file 'beamer file
  910. async subtreep visible-only body-only ext-plist)))
  911. ;;;###autoload
  912. (defun org-beamer-export-to-pdf
  913. (&optional async subtreep visible-only body-only ext-plist)
  914. "Export current buffer as a Beamer presentation (PDF).
  915. If narrowing is active in the current buffer, only export its
  916. narrowed part.
  917. If a region is active, export that region.
  918. A non-nil optional argument ASYNC means the process should happen
  919. asynchronously. The resulting file should be accessible through
  920. the `org-export-stack' interface.
  921. When optional argument SUBTREEP is non-nil, export the sub-tree
  922. at point, extracting information from the headline properties
  923. first.
  924. When optional argument VISIBLE-ONLY is non-nil, don't export
  925. contents of hidden elements.
  926. When optional argument BODY-ONLY is non-nil, only write code
  927. between \"\\begin{document}\" and \"\\end{document}\".
  928. EXT-PLIST, when provided, is a property list with external
  929. parameters overriding Org default settings, but still inferior to
  930. file-local settings.
  931. Return PDF file's name."
  932. (interactive)
  933. (let ((file (org-export-output-file-name ".tex" subtreep)))
  934. (org-export-to-file 'beamer file
  935. async subtreep visible-only body-only ext-plist
  936. (lambda (file) (org-latex-compile file)))))
  937. ;;;###autoload
  938. (defun org-beamer-select-environment ()
  939. "Select the environment to be used by beamer for this entry.
  940. While this uses (for convenience) a tag selection interface, the
  941. result of this command will be that the BEAMER_env *property* of
  942. the entry is set.
  943. In addition to this, the command will also set a tag as a visual
  944. aid, but the tag does not have any semantic meaning."
  945. (interactive)
  946. ;; Make sure `org-beamer-environments-special' has a higher
  947. ;; priority than `org-beamer-environments-extra'.
  948. (let* ((envs (append org-beamer-environments-special
  949. org-beamer-environments-extra
  950. org-beamer-environments-default))
  951. (org-current-tag-alist
  952. (append '((:startgroup))
  953. (mapcar (lambda (e) (cons (concat "B_" (car e))
  954. (string-to-char (nth 1 e))))
  955. envs)
  956. '((:endgroup))
  957. '(("BMCOL" . ?|))))
  958. (org-tag-persistent-alist nil)
  959. (org-use-fast-tag-selection t)
  960. (org-fast-tag-selection-single-key t))
  961. (org-set-tags-command)
  962. (let ((tags (org-get-tags nil t)))
  963. (cond
  964. ;; For a column, automatically ask for its width.
  965. ((eq org-last-tag-selection-key ?|)
  966. (if (member "BMCOL" tags)
  967. (org-set-property "BEAMER_col" (read-string "Column width: "))
  968. (org-delete-property "BEAMER_col")))
  969. ;; For an "againframe" section, automatically ask for reference
  970. ;; to resumed frame and overlay specifications.
  971. ((eq org-last-tag-selection-key ?A)
  972. (if (equal (org-entry-get nil "BEAMER_env") "againframe")
  973. (progn (org-entry-delete nil "BEAMER_env")
  974. (org-entry-delete nil "BEAMER_ref")
  975. (org-entry-delete nil "BEAMER_act"))
  976. (org-entry-put nil "BEAMER_env" "againframe")
  977. (org-set-property
  978. "BEAMER_ref"
  979. (read-string "Frame reference (*Title, #custom-id, id:...): "))
  980. (org-set-property "BEAMER_act"
  981. (read-string "Overlay specification: "))))
  982. ((let* ((tags-re (concat "B_" (regexp-opt (mapcar #'car envs) t)))
  983. (env (cl-some (lambda (tag)
  984. (and (string-match tags-re tag)
  985. (match-string 1 tag)))
  986. tags)))
  987. (and env (progn (org-entry-put nil "BEAMER_env" env) t))))
  988. (t (org-entry-delete nil "BEAMER_env"))))))
  989. ;;;###autoload
  990. (defun org-beamer-publish-to-latex (plist filename pub-dir)
  991. "Publish an Org file to a Beamer presentation (LaTeX).
  992. FILENAME is the filename of the Org file to be published. PLIST
  993. is the property list for the given project. PUB-DIR is the
  994. publishing directory.
  995. Return output file name."
  996. (org-publish-org-to 'beamer filename ".tex" plist pub-dir))
  997. ;;;###autoload
  998. (defun org-beamer-publish-to-pdf (plist filename pub-dir)
  999. "Publish an Org file to a Beamer presentation (PDF, via LaTeX).
  1000. FILENAME is the filename of the Org file to be published. PLIST
  1001. is the property list for the given project. PUB-DIR is the
  1002. publishing directory.
  1003. Return output file name."
  1004. ;; Unlike to `org-beamer-publish-to-latex', PDF file is generated in
  1005. ;; working directory and then moved to publishing directory.
  1006. (org-publish-attachment
  1007. plist
  1008. ;; Default directory could be anywhere when this function is
  1009. ;; called. We ensure it is set to source file directory during
  1010. ;; compilation so as to not break links to external documents.
  1011. (let ((default-directory (file-name-directory filename)))
  1012. (org-latex-compile
  1013. (org-publish-org-to
  1014. 'beamer filename ".tex" plist (file-name-directory filename))))
  1015. pub-dir))
  1016. (provide 'ox-beamer)
  1017. ;; Local variables:
  1018. ;; generated-autoload-file: "org-loaddefs.el"
  1019. ;; End:
  1020. ;;; ox-beamer.el ends here