ox-s5.el 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  1. ;;; ox-s5.el --- S5 Presentation Back-End for Org Export Engine
  2. ;; Copyright (C) 2011-2013 Rick Frankel
  3. ;; Author: Rick Frankel <emacs at rickster dot com>
  4. ;; Keywords: outlines, hypermedia, S5, wp
  5. ;; This file is not part of GNU Emacs.
  6. ;; This program is free software; you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation, either version 3 of the License, or
  9. ;; (at your option) any later version.
  10. ;; This program is distributed in the hope that it will be useful,
  11. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. ;; GNU General Public License for more details.
  14. ;; You should have received a copy of the GNU General Public License
  15. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;; This library implements an S5 Presentation back-end for the Org
  18. ;; generic exporter.
  19. ;; Installation
  20. ;; ------------
  21. ;; Get the s5 scripts from
  22. ;; http://meyerweb.com/eric/tools/s5/
  23. ;; (Note that the default s5 version is set for using the alpha, 1.2a2.
  24. ;; Copy the ui dir to somewhere reachable from your published presentation
  25. ;; The default (`org-s5-ui-url') is set to "ui" (e.g., in the
  26. ;; same directory as the html file).
  27. ;; Usage
  28. ;; -----
  29. ;; Follow the general instructions at the above website. To generate
  30. ;; incremental builds, you can set the HTML_CONTAINER_CLASS on an
  31. ;; object to "incremental" to make it build. If you want an outline to
  32. ;; build, set the :INCREMENTAL property on the parent headline.
  33. ;; To test it, run:
  34. ;;
  35. ;; M-x org-s5-export-as-html
  36. ;;
  37. ;; in an Org mode buffer. See ox.el and ox-html.el for more details
  38. ;; on how this exporter works.
  39. (require 'ox-html)
  40. (org-export-define-derived-backend s5 html
  41. :menu-entry
  42. (?s "Export to S5 HTML Presentation"
  43. ((?H "To temporary buffer" org-s5-export-as-html)
  44. (?h "To file" org-s5-export-to-html)
  45. (?o "To file and open"
  46. (lambda (a s v b)
  47. (if a (org-s5-export-to-html t s v b)
  48. (org-open-file (org-s5-export-to-html nil s v b)))))))
  49. :options-alist
  50. ((:html-link-home "HTML_LINK_HOME" nil nil)
  51. (:html-link-up "HTML_LINK_UP" nil nil)
  52. (:html-postamble nil "html-postamble" nil t)
  53. (:html-preamble nil "html-preamble" nil t)
  54. (:html-head-include-default-style "HTML_INCLUDE_DEFAULT_STYLE" nil nil)
  55. (:html-head-include-scripts "HTML_INCLUDE_SCRIPTS" nil nil)
  56. (:s5-version "S5_VERSION" nil org-s5-version)
  57. (:s5-theme-file "S5_THEME_FILE" nil org-s5-theme-file)
  58. (:s5-ui-url "S5_UI_URL" nil org-s5-ui-url)
  59. (:s5-default-view "S5_DEFAULT_VIEW" nil org-s5-default-view)
  60. (:s5-control-visibility "S5_CONTROL_VISIBILITY" nil org-s5-control-visibility))
  61. :translate-alist
  62. ((headline . org-s5-headline)
  63. (plain-list . org-s5-plain-list)
  64. (inner-template . org-s5-inner-template)
  65. (template . org-s5-template)))
  66. (defgroup org-export-s5 nil
  67. "Options for exporting Org mode files to S5 HTML Presentations."
  68. :tag "Org Export S5"
  69. :group 'org-export-html)
  70. (defcustom org-s5-version "1.2a2"
  71. "Version of s5 being used (for version metadata.) Defaults to
  72. s5 v2 alpha 2.
  73. Can be overridden with S5_VERSION."
  74. :group 'org-export-s5
  75. :type 'string)
  76. (defcustom org-s5-theme-file nil
  77. "Url to S5 theme (slides.css) file. Can be overriden with the
  78. S5_THEME_FILE property. If nil, defaults to
  79. `org-s5-ui-url'/default/slides.css. If it starts with anything but
  80. \"http\" or \"/\", it is used as-is. Otherwise the link in generated
  81. relative to `org-s5-ui-url'.
  82. The links for all other required stylesheets and scripts will be
  83. generated relative to `org-s5-ui-url'/default."
  84. :group 'org-export-s5
  85. :type 'string)
  86. (defcustom org-s5-ui-url "ui"
  87. "Base url to directory containing S5 \"default\" subdirectory
  88. and the \"s5-notes.html\" file.
  89. Can be overriden with the S5_UI_URL property."
  90. :group 'org-export-s5
  91. :type 'string)
  92. (defcustom org-s5-default-view 'slideshow
  93. "Setting for \"defaultView\" meta info."
  94. :group 'org-export-s5
  95. :type '(choice (const slideshow) (const outline)))
  96. (defcustom org-s5-control-visibility 'hidden
  97. "Setting for \"controlVis\" meta info."
  98. :group 'org-export-s5
  99. :type '(choice (const hidden) (const visibile)))
  100. (defcustom org-s5-footer-template
  101. "<h1>%author - %title</h1>"
  102. "Format template to specify footer div.
  103. Completed using `org-fill-template', optional keys include
  104. %author, %email, %file, %title and %date.
  105. It will be wrapped in a <div> with the id \"footer\""
  106. :group 'org-export-s5
  107. :type 'string)
  108. (defcustom org-s5-header-template ""
  109. "Format template to specify header div.
  110. Completed using `org-fill-template', optional keys include
  111. %author, %email, %file, %title and %date.
  112. It will be wrapped in a <div> with the id \"header\""
  113. :group 'org-export-s5
  114. :type 'string)
  115. (defcustom org-s5-title-slide-template
  116. "<h1>%title</h1>
  117. <h2>%author</h2>
  118. <h2>%email</h2>
  119. <h2>%date</h2>"
  120. "Format template to specify title page section.
  121. Completed using `org-fill-template', optional keys include
  122. %author, %email, %file, %title and %date.
  123. It will be wrapped in the element defined in the :html-container
  124. property, and defaults to the value of `org-html-container-element',
  125. and have the id \"title-slide\"."
  126. :group 'org-export-s5
  127. :type 'string)
  128. (defun org-s5--format-toc-headline (headline info)
  129. "Return an appropriate table of contents entry for HEADLINE.
  130. Note that (currently) the S5 exporter does not support deep links,
  131. so the table of contents is not \"active\".
  132. INFO is a plist used as a communication channel."
  133. (let* ((headline-number (org-export-get-headline-number headline info))
  134. (section-number
  135. (and (not (org-export-low-level-p headline info))
  136. (org-export-numbered-headline-p headline info)
  137. (concat (mapconcat 'number-to-string headline-number ".") ". ")))
  138. (tags (and (eq (plist-get info :with-tags) t)
  139. (org-export-get-tags headline info))))
  140. (concat section-number
  141. (org-export-data
  142. (org-export-get-alt-title headline info) info)
  143. (and tags "&nbsp;&nbsp;&nbsp;") (org-html--tags tags))))
  144. (defun org-s5-toc (depth info)
  145. (let* ((headlines (org-export-collect-headlines info depth))
  146. (toc-entries
  147. (mapcar (lambda (headline)
  148. (cons (org-s5--format-toc-headline headline info)
  149. (org-export-get-relative-level headline info)))
  150. (org-export-collect-headlines info depth))))
  151. (when toc-entries
  152. (concat
  153. (format "<%s id='table-of-contents' class='slide'>\n"
  154. (plist-get info :html-container))
  155. (format "<h1>%s</h1>\n"
  156. (org-html--translate "Table of Contents" info))
  157. "<div id=\"text-table-of-contents\">"
  158. (org-html--toc-text toc-entries)
  159. "</div>\n"
  160. (format "</%s>\n" (plist-get info :html-container))))))
  161. (defun org-s5--build-head (info)
  162. (let* ((dir (plist-get info :s5-ui-url))
  163. (theme (or (plist-get info :s5-theme-file) "default/slides.css")))
  164. (mapconcat
  165. 'identity
  166. (list
  167. "<!-- style sheet links -->"
  168. (mapconcat
  169. (lambda (list)
  170. (format
  171. (concat
  172. "<link rel='stylesheet' href='%s/default/%s' type='text/css'"
  173. " media='%s' id='%s' />")
  174. dir (nth 0 list) (nth 1 list) (nth 2 list)))
  175. (list
  176. '("outline.css" "screen" "outlineStyle")
  177. '("print.css" "print" "slidePrint")
  178. '("opera.css" "projection" "operaFix")) "\n")
  179. (format (concat
  180. "<link rel='stylesheet' href='%s' type='text/css'"
  181. " media='screen' id='slideProj' />")
  182. (if (string-match-p "^\\(http\\|/\\)" theme) theme
  183. (concat dir "/" theme)))
  184. "<!-- S5 JS -->"
  185. (concat
  186. "<script src='" dir
  187. "/default/slides.js' type='text/javascript'></script>")) "\n")))
  188. (defun org-s5--build-meta-info (info)
  189. (concat
  190. (org-html--build-meta-info info)
  191. (format "<meta name=\"version\" content=\"S5 %s\" />\n"
  192. (plist-get info :s5-version))
  193. (format "<meta name='defaultView' content='%s' />\n"
  194. (plist-get info :s5-default-view))
  195. (format "<meta name='controlVis' content='%s' />"
  196. (plist-get info :s5-control-visibility))))
  197. (defun org-s5-headline (headline contents info)
  198. (let ((org-html-toplevel-hlevel 1)
  199. (class (or (org-element-property :HTML_CONTAINER_CLASS headline) ""))
  200. (level (org-export-get-relative-level headline info)))
  201. (when (and (= 1 level) (not (string-match-p "\\<slide\\>" class)))
  202. (org-element-put-property headline :HTML_CONTAINER_CLASS (concat class " slide")))
  203. (org-html-headline headline contents info)))
  204. (defun org-s5-plain-list (plain-list contents info)
  205. "Transcode a PLAIN-LIST element from Org to HTML.
  206. CONTENTS is the contents of the list. INFO is a plist holding
  207. contextual information.
  208. If a containing headline has the property :INCREMENTAL,
  209. then the \"incremental\" class will be added to the to the list,
  210. which will make the list into a \"build\"."
  211. (let* ((type (org-element-property :type plain-list))
  212. (tag (case type
  213. (ordered "ol")
  214. (unordered "ul")
  215. (descriptive "dl"))))
  216. (format "%s\n%s%s"
  217. (format
  218. "<%s class='org-%s%s'>" tag tag
  219. (if (org-export-get-node-property :INCREMENTAL plain-list t)
  220. " incremental" ""))
  221. contents (org-html-end-plain-list type))))
  222. (defun org-s5-template-alist (info)
  223. `(
  224. ("title" . ,(car (plist-get info :title)))
  225. ("author" . ,(car (plist-get info :author)))
  226. ("email" . ,(plist-get info :email))
  227. ("date" . ,(nth 0 (plist-get info :date)))
  228. ("file" . ,(plist-get info :input-file))))
  229. (defun org-s5-inner-template (contents info)
  230. "Return body of document string after HTML conversion.
  231. CONTENTS is the transcoded contents string. INFO is a plist
  232. holding export options."
  233. (concat contents "\n"))
  234. (defun org-s5-template (contents info)
  235. "Return complete document string after HTML conversion.
  236. CONTENTS is the transcoded contents string. INFO is a plist
  237. holding export options."
  238. (mapconcat
  239. 'identity
  240. (list
  241. (plist-get info :html-doctype)
  242. (format "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"%s\" xml:lang=\"%s\">"
  243. (plist-get info :language) (plist-get info :language))
  244. "<head>"
  245. (org-s5--build-meta-info info)
  246. (org-s5--build-head info)
  247. (org-html--build-head info)
  248. (org-html--build-mathjax-config info)
  249. "</head>"
  250. "<body>"
  251. "<div class=\"layout\">"
  252. "<div id=\"controls\"><!-- no edit --></div>"
  253. "<div id=\"currentSlide\"><!-- no edit --></div>"
  254. "<div id='header'>"
  255. (org-fill-template
  256. org-s5-header-template (org-s5-template-alist info))
  257. "</div>"
  258. "<div id='footer'>"
  259. (org-fill-template
  260. org-s5-footer-template (org-s5-template-alist info))
  261. "</div>"
  262. "</div>"
  263. (format "<%s id=\"%s\" class=\"presentation\">"
  264. (nth 1 (assq 'content org-html-divs))
  265. (nth 2 (assq 'content org-html-divs)))
  266. ;; title page
  267. (format "<%s id='title-slide' class='slide'>"
  268. (plist-get info :html-container))
  269. (org-fill-template
  270. org-s5-title-slide-template (org-s5-template-alist info))
  271. (format "</%s>" (plist-get info :html-container))
  272. ;; table of contents.
  273. (let ((depth (plist-get info :with-toc)))
  274. (when depth (org-s5-toc depth info)))
  275. contents
  276. (format "</%s>" (nth 1 (assq 'content org-html-divs)))
  277. "</body>"
  278. "</html>\n") "\n"))
  279. (defun org-s5-export-as-html
  280. (&optional async subtreep visible-only body-only ext-plist)
  281. "Export current buffer to an HTML buffer.
  282. If narrowing is active in the current buffer, only export its
  283. narrowed part.
  284. If a region is active, export that region.
  285. A non-nil optional argument ASYNC means the process should happen
  286. asynchronously. The resulting buffer should be accessible
  287. through the `org-export-stack' interface.
  288. When optional argument SUBTREEP is non-nil, export the sub-tree
  289. at point, extracting information from the headline properties
  290. first.
  291. When optional argument VISIBLE-ONLY is non-nil, don't export
  292. contents of hidden elements.
  293. When optional argument BODY-ONLY is non-nil, only write code
  294. between \"<body>\" and \"</body>\" tags.
  295. EXT-PLIST, when provided, is a property list with external
  296. parameters overriding Org default settings, but still inferior to
  297. file-local settings.
  298. Export is done in a buffer named \"*Org S5 Export*\", which
  299. will be displayed when `org-export-show-temporary-export-buffer'
  300. is non-nil."
  301. (interactive)
  302. (if async
  303. (org-export-async-start
  304. (lambda (output)
  305. (with-current-buffer (get-buffer-create "*Org S5 Export*")
  306. (erase-buffer)
  307. (insert output)
  308. (goto-char (point-min))
  309. (nxml-mode)
  310. (org-export-add-to-stack (current-buffer) 's5)))
  311. `(org-export-as 's5 ,subtreep ,visible-only ,body-only ',ext-plist))
  312. (let ((outbuf (org-export-to-buffer
  313. 's5 "*Org S5 Export*"
  314. subtreep visible-only body-only ext-plist)))
  315. ;; Set major mode.
  316. (with-current-buffer outbuf (nxml-mode))
  317. (when org-export-show-temporary-export-buffer
  318. (switch-to-buffer-other-window outbuf)))))
  319. (defun org-s5-export-to-html
  320. (&optional async subtreep visible-only body-only ext-plist)
  321. "Export current buffer to a S5 HTML file.
  322. If narrowing is active in the current buffer, only export its
  323. narrowed part.
  324. If a region is active, export that region.
  325. A non-nil optional argument ASYNC means the process should happen
  326. asynchronously. The resulting file should be accessible through
  327. the `org-export-stack' interface.
  328. When optional argument SUBTREEP is non-nil, export the sub-tree
  329. at point, extracting information from the headline properties
  330. first.
  331. When optional argument VISIBLE-ONLY is non-nil, don't export
  332. contents of hidden elements.
  333. When optional argument BODY-ONLY is non-nil, only write code
  334. between \"<body>\" and \"</body>\" tags.
  335. EXT-PLIST, when provided, is a property list with external
  336. parameters overriding Org default settings, but still inferior to
  337. file-local settings.
  338. Return output file's name."
  339. (interactive)
  340. (let* ((extension (concat "." org-html-extension))
  341. (file (org-export-output-file-name extension subtreep))
  342. (org-export-coding-system org-html-coding-system))
  343. (if async
  344. (org-export-async-start
  345. (lambda (f) (org-export-add-to-stack f 's5))
  346. (let ((org-export-coding-system org-html-coding-system))
  347. `(expand-file-name
  348. (org-export-to-file
  349. 's5 ,file ,subtreep ,visible-only ,body-only ',ext-plist))))
  350. (let ((org-export-coding-system org-html-coding-system))
  351. (org-export-to-file
  352. 's5 file subtreep visible-only body-only ext-plist)))))
  353. (defun org-s5-publish-to-html (plist filename pub-dir)
  354. "Publish an org file to S5 HTML Presentation.
  355. FILENAME is the filename of the Org file to be published. PLIST
  356. is the property list for the given project. PUB-DIR is the
  357. publishing directory.
  358. Return output file name."
  359. (org-publish-org-to 's5 filename ".html" plist pub-dir))
  360. (provide 'ox-s5)
  361. ;;; ox-s5.el ends here