public
Last active

HTML5 Presentation export for Org-mode

  • Download Gist
.gitignore
1
README.html
README.org
Org

org-html5presentation.el

org-html5presentation.el

This library implements a HTML5 Presentation back-end for Org generic exporter based on ox-html.el.

http://kinjo.github.io/org-html5presentation.el/ is a demo page. Please use the latest version of Google Chrome.

This requires Org-mode version 8.2.5h and GNU Emacs 24 or higher.

INSTALLATION

  1. First of all, check your Org-mode version.
  2. Note: This library has been tested on Org-mode 8.2.5h.
    M-x org-version
        
  3. Get org-html5presentation.el. For example,
    git clone https://github.com/kinjo/org-html5presentation.el.git \
    ~/org-html5presentation.el
        
  4. Add following to ~/.emacs.d/init.el and reboot emacs.
    (add-to-list 'load-path "~/org-html5presentation.el")
    (require 'ox-html5presentation)
        

USAGE

  1. Open this README.org in your emacs.
  2. Type C-c C-e to convert Org file to an HTML5 Presentation file.
  3. `*Org Export Dispatcher*ā€™ buffer will open, so follow the menu.
  4. For example, if you type `pā€™ and then `pā€™, README.html will be generated.
  5. Finally, Open the generated file in your Google Chrome.

PROPERTIES for CSS

Following PROPERTIES are available for CSSs.

  • PRETTIFY_CSS : resources/styles/prettify.css is default. org-html5presentation-prettify-css defines.
  • FONTS_CSS : resources/styles/fonts.css is default. org-html5presentation-fonts-css defines.
  • PRESENTATION_CSS : resources/styles/presentation.css is default. org-html5presentation-presentation-css defines.
  • COMMON_CSS : resources/styles/common.css is default. org-html5presentation-common-css defines.
  • DEFAULT_CSS : resources/styles/default.css is default. org-html5presentation-default-css defines.
  • MOON_CSS : resources/styles/moon.css is default. org-html5presentation-moon-css defines.
  • SAND_CSS : resources/styles/sand.css is default. org-html5presentation-sand-css defines.
  • SEA_WAVE_CSS : css resources/styles/sea_wave.css is default. org-html5presentation-sea-wave-css defines.

PROPERTIES for JS

LICENSE

Licensed under the GPLv3 license.

ox-html5presentation.el
Emacs Lisp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
;;; ox-html5presentation.el --- HTML5 Presentation Back-End for Org Export Engine
 
;; Copyright (C) 2014 Takumi Kinjo.
 
;; Author: Takumi KINJO <takumi dot kinjo at gmail dot org>
;; URL: https://github.com/kinjo/org-html5presentation.el
;; Version: 0.1
;; Keywords: outlines, hypermedia, calendar, wp
 
;; This file is not part of GNU Emacs.
 
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
 
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
 
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
 
;;; Commentary:
 
;; This library implements a HTML5 Presentation back-end for Org
;; generic exporter based on ox-html.el.
 
;; About HTML5 presentation, see http://slides.html5rocks.com.
 
;; Original author: Carsten Dominik <carsten at orgmode dot org>
;; Jambunathan K <kjambunathan at gmail dot com>
 
;;; Code:
 
;;; Dependencies
 
(require 'ox)
(require 'ox-publish)
(require 'format-spec)
(eval-when-compile (require 'cl) (require 'table nil 'noerror))
 
;;; Function Declarations
 
(declare-function org-id-find-id-file "org-id" (id))
(declare-function htmlize-region "ext:htmlize" (beg end))
(declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label))
(declare-function mm-url-decode-entities "mm-url" ())
 
;;; Define Back-End
 
(org-export-define-backend 'html5presentation
'((bold . org-html-bold)
(center-block . org-html-center-block)
(clock . org-html-clock)
(code . org-html-code)
(drawer . org-html-drawer)
(dynamic-block . org-html-dynamic-block)
(entity . org-html-entity)
(example-block . org-html-example-block)
(export-block . org-html-export-block)
(export-snippet . org-html-export-snippet)
(fixed-width . org-html-fixed-width)
(footnote-definition . org-html-footnote-definition)
(footnote-reference . org-html-footnote-reference)
(headline . org-html5presentation-headline)
(horizontal-rule . org-html-horizontal-rule)
(inline-src-block . org-html-inline-src-block)
(inlinetask . org-html-inlinetask)
(inner-template . org-html5presentation-inner-template)
(italic . org-html-italic)
(item . org-html-item)
(keyword . org-html-keyword)
(latex-environment . org-html-latex-environment)
(latex-fragment . org-html-latex-fragment)
(line-break . org-html-line-break)
(link . org-html-link)
(node-property . org-html-node-property)
(paragraph . org-html-paragraph)
(plain-list . org-html-plain-list)
(plain-text . org-html-plain-text)
(planning . org-html-planning)
(property-drawer . org-html-property-drawer)
(quote-block . org-html-quote-block)
(radio-target . org-html-radio-target)
(section . org-html5presentation-section)
(special-block . org-html-special-block)
(src-block . org-html-src-block)
(statistics-cookie . org-html-statistics-cookie)
(strike-through . org-html-strike-through)
(subscript . org-html-subscript)
(superscript . org-html-superscript)
(table . org-html-table)
(table-cell . org-html-table-cell)
(table-row . org-html-table-row)
(target . org-html-target)
(template . org-html5presentation-template)
(timestamp . org-html-timestamp)
(underline . org-html-underline)
(verbatim . org-html-verbatim)
(verse-block . org-html-verse-block))
:export-block "HTML"
:filters-alist '((:filter-options . org-html-infojs-install-script)
(:filter-final-output . org-html-final-function))
:menu-entry
'(?p "Export to HTML5 Presentation"
((?P "As HTML buffer" org-html5presentation-export-as-html)
(?p "As HTML file" org-html5presentation-export-to-html)
(?o "As HTML file and open"
(lambda (a s v b)
(if a (org-html5presentation-export-to-html t s v b)
(org-open-file (org-html5presentation-export-to-html nil s v b)))))))
:options-alist
'((:creator "CREATOR" nil org-html-creator-string)
(:html-doctype "HTML_DOCTYPE" nil org-html5presentation-doctype)
(:html-link-home "HTML_LINK_HOME" nil org-html-link-home)
(:html-link-up "HTML_LINK_UP" nil org-html-link-up)
(:html-head "HTML_HEAD" nil org-html-head newline)
(:html-head-extra "HTML_HEAD_EXTRA" nil org-html-head-extra newline)
(:html-container "HTML_CONTAINER" nil org-html-container-element)
(:html-mathjax "HTML_MATHJAX" nil "" space)
(:infojs-opt "INFOJS_OPT" nil nil)
;; Retrieve LaTeX header for fragments.
(:latex-header "LATEX_HEADER" nil nil newline)
(:html-extension nil nil org-html-extension)
(:html-link-org-as-html nil nil org-html-link-org-files-as-html)
(:html-html5-fancy nil "html5-fancy" org-html-html5-fancy)
(:html-link-use-abs-url nil "html-link-use-abs-url" org-html-link-use-abs-url)
(:html-postamble nil "html-postamble" org-html-postamble)
(:html-preamble nil "html-preamble" org-html-preamble)
(:html-head-include-default-style nil "html-style" org-html-head-include-default-style)
(:html-table-attributes nil nil org-html-table-default-attributes)
(:html-table-row-tags nil nil org-html-table-row-tags)
(:html-xml-declaration nil nil org-html-xml-declaration)
(:html-inline-images nil nil org-html-inline-images)
(:with-latex nil "tex" org-html-with-latex)
(:prettify-css "PRETTIFY_CSS" nil org-html5presentation-prettify-css)
(:fonts-css "FONTS_CSS" nil org-html5presentation-fonts-css)
(:presentation-css "PRESENTATION_CSS" nil org-html5presentation-presentation-css)
(:common-css "COMMON_CSS" nil org-html5presentation-common-css)
(:default-css "DEFAULT_CSS" nil org-html5presentation-default-css)
(:moon-css "MOON_CSS" nil org-html5presentation-moon-css)
(:sand-css "SAND_CSS" nil org-html5presentation-sand-css)
(:sea-wave-css "SEA_WAVE_CSS" nil org-html5presentation-sea-wave-css)
(:ie-lt-9-js "IE_LT_9_JS" nil org-html5presentation-ie-lt-9-js)
(:prettify-js "PRETTIFY_JS" nil org-html5presentation-prettify-js)
(:utils-js "UTILS_JS" nil org-html5presentation-utils-js)))
 
;;; Internal Variables
 
(defconst org-html5presentation-style-default
"<link id=\"prettify-link\" href=\"resources/styles/prettify.css\" rel=\"stylesheet\" disabled />
<link href=\"resources/styles/fonts.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link href=\"resources/styles/presentation.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link href=\"resources/styles/common.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link class=\"theme\" href=\"resources/styles/default.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link class=\"theme\" href=\"resources/styles/moon.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link class=\"theme\" href=\"resources/styles/sand.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\"/>
<link class=\"theme\" href=\"resources/styles/sea_wave.css\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\"/>
"
"The default style specification for exported HTML files.
You can use `org-html-head' and `org-html-head-extra' to add to
this style. If you don't want to include this default style,
customize `org-html-head-include-default-style'.")
 
;;; User Configuration Variables
 
;;;; Template :: Generic
 
(defcustom org-html5presentation-doctype "html5"
"Document type definition to use for exported HTML files.
Can be set with the in-buffer HTML_DOCTYPE property or for
publishing, with :html-doctype."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type (append
'(choice)
(mapcar (lambda (x) `(const ,(car x))) org-html-doctype-alist)
'((string :tag "Custom doctype" ))))
 
(defcustom org-html5presentation-divs
'((container "div" "flex-container")
(slides "div" "slides"))
"Alist of the section elements for HTML export."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type '(list :greedy t
(list :tag "Content"
(const :format "" content)
(string :tag "element") (string :tag " id"))))
 
(defcustom org-html5presentation-prettify-css "resources/styles/prettify.css"
"Default URL of prettify.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-fonts-css "resources/styles/fonts.css"
"Default URL of fonts.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-presentation-css "resources/styles/presentation.css"
"Default URL of presentation.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-common-css "resources/styles/common.css"
"Default URL of common.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-default-css "resources/styles/default.css"
"Default URL of default.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-moon-css "resources/styles/moon.css"
"Default URL of moon.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-sand-css "resources/styles/sand.css"
"Default URL of sand.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-sea-wave-css "css resources/styles/sea_wave.css"
"Default URL of sea_wave.css."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-ie-lt-9-js "http://ajax.googleapis.com/ajax/libs/chrome-frame/1/CFInstall.min.js"
"Default URL of CFInstall.min.js."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-prettify-js "resources/js/prettify.js"
"Default URL of prettify.js."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
(defcustom org-html5presentation-utils-js "resources/js/utils.js"
"Default URL of utils.js."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
 
;;;; template :: Navi
(defcustom org-html5presentation-navi "<nav id=\"helpers\">
<button title=\"Previous slide\" id=\"nav-prev\" class=\"nav-prev\">&#8701;</button>
<button title=\"Jump to a random slide\" id=\"slide-no\">5</button>
<button title=\"Next slide\" id=\"nav-next\" class=\"nav-next\">&#8702;</button>
<menu>
<!-- <button type=\"checkbox\" data-command=\"toc\" title=\"Table of Contents\" class=\"toc\">TOC</button> -->
<!-- <button type=\"checkbox\" data-command=\"resources\" title=\"View Related Resources\">&#9734;</button> -->
<!-- <button type=\"checkbox\" data-command=\"notes\" title=\"View Slide Notes\">&#9999;</button> -->
<!-- <button type=\"checkbox\" data-command=\"source\" title=\"View slide source\">&#8635;</button> -->
<button type=\"checkbox\" data-command=\"help\" title=\"View Help\">?</button>
</menu>
</nav>
"
"Help section describes usage of the HTML5 Presentation slides."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
;;;###autoload
(put 'org-html5presentation-navi 'safe-local-variable 'stringp)
 
;;;; template :: Loading
(defcustom org-html5presentation-loading "<div id=\"presentation-counter\">Loading...</div>
"
"Loading message will be shown when contents are loading."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
;;;###autoload
(put 'org-html5presentation-loading 'safe-local-variable 'stringp)
 
;;;; template :: Help
(defcustom org-html5presentation-help "<aside id=\"help\" class=\"sidebar invisible\" style=\"display: none;\">
<table>
<caption>Help</caption>
<tbody>
<tr>
<th>Move Around</th>
<td>&larr;&nbsp;&rarr;</td>
</tr>
<tr>
<th>Change Theme</th>
<td>t</td>
</tr>
<tr>
<th>Syntax Highlight</th>
<td>h</td>
</tr>
<tr>
<th>Toggle 3D</th>
<td>3</td>
</tr>
<tr>
<th>Help</th>
<td>0</td>
</tr>
</tbody>
</table>
</aside>
"
"Help template."
:group 'org-export-html5presentation
:version "24.4"
:package-version '(Org . "8.0")
:type 'string)
;;;###autoload
(put 'org-html5presentation-help 'safe-local-variable 'stringp)
 
;;; Template
 
(defun org-html5presentation--build-meta-info (info)
"Return meta tags for exported document.
INFO is a plist used as a communication channel."
(let ((protect-string
(lambda (str)
(replace-regexp-in-string
"\"" "&quot;" (org-html-encode-plain-text str))))
(title (org-export-data (plist-get info :title) info))
(author (and (plist-get info :with-author)
(let ((auth (plist-get info :author)))
(and auth
;; Return raw Org syntax, skipping non
;; exportable objects.
(org-element-interpret-data
(org-element-map auth
(cons 'plain-text org-element-all-objects)
'identity info))))))
(description (plist-get info :description))
(keywords (plist-get info :keywords))
(charset (or (and org-html-coding-system
(fboundp 'coding-system-get)
(coding-system-get org-html-coding-system
'mime-charset))
"iso-8859-1")))
(concat
(format "<title>%s</title>\n" title)
(when (plist-get info :time-stamp-file)
(format-time-string
(concat "<!-- " org-html-metadata-timestamp-format " -->\n")))
(org-html-close-tag
"meta" " http-equiv=\"X-UA-Compatible\" content=\"IE=Edge;chrome=1\"" info) "\n"
(format
(if (org-html-html5-p info)
(org-html-close-tag "meta" " charset=\"%s\"" info)
(org-html-close-tag
"meta" " http-equiv=\"Content-Type\" content=\"text/html;charset=%s\""
info))
charset) "\n"
(org-html-close-tag "meta" " name=\"generator\" content=\"Org-mode\"" info)
"\n"
(and (org-string-nw-p author)
(concat
(org-html-close-tag "meta"
(format " name=\"author\" content=\"%s\""
(funcall protect-string author))
info)
"\n"))
(and (org-string-nw-p description)
(concat
(org-html-close-tag "meta"
(format " name=\"description\" content=\"%s\"\n"
(funcall protect-string description))
info)
"\n"))
(and (org-string-nw-p keywords)
(concat
(org-html-close-tag "meta"
(format " name=\"keywords\" content=\"%s\""
(funcall protect-string keywords))
info)
"\n")))))
 
(defun org-html5presentation-style-template (info)
"Return string of styles. INFO is a plist holding export options."
(format "<link id=\"prettify-link\" href=\"%s\" rel=\"stylesheet\" disabled />
<link href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link class=\"theme\" href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link class=\"theme\" href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />
<link class=\"theme\" href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\"/>
<link class=\"theme\" href=\"%s\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\"/>
"
(plist-get info :prettify-css)
(plist-get info :fonts-css)
(plist-get info :presentation-css)
(plist-get info :common-css)
(plist-get info :default-css)
(plist-get info :moon-css)
(plist-get info :sand-css)
(plist-get info :sea-wave-css)))
 
(defun org-html5presentation-ie-lt-9-js (info)
"Return JavaScript string for IE version less than 9."
(format "<!--[if lt IE 9]>
<script src=\"%s\">
</script>
<script>CFInstall.check({ mode: \"overlay\" });</script>
<![endif]-->\n"
(plist-get info :ie-lt-9-js)))
 
(defun org-html5presentation-prettify-js (info)
"Return string of prettify.js. INFO is a plist used as a communication channel."
(format "<script src=\"%s\" onload=\"prettyPrint();\" defer></script>\n"
(plist-get info :prettify-js)))
 
(defun org-html5presentation-utils-js (info)
"Return string of utils.js. INFO is a plist used as a communication channel."
(format "<script src=\"%s\"></script>\n"
(plist-get info :utils-js)))
 
(defun org-html5presentation--build-head (info)
"Return information for the <head>..</head> of the HTML output.
INFO is a plist used as a communication channel."
(org-element-normalize-string
(concat
(when (plist-get info :html-head-include-default-style)
(org-element-normalize-string (org-html5presentation-style-template info)))
(org-element-normalize-string (plist-get info :html-head))
(org-element-normalize-string (plist-get info :html-head-extra))
(when (and (plist-get info :html-htmlized-css-url)
(eq org-html-htmlize-output-type 'css))
(org-html-close-tag "link"
(format " rel=\"stylesheet\" href=\"%s\" type=\"text/css\""
(plist-get info :html-htmlized-css-url))
info))
)))
 
(defun org-html5presentation-title-slide-template (info)
"Return document string of the title slide. INFO is a plist
holding export options."
(let ((title (org-export-data (plist-get info :title) info))
(subtitle ""))
(format "<div class=\"slide title-slide\" id=\"landing-slide\">
<section class=\"middle\">
<hgroup>
<h1>%s</h1>
<h2>%s</h2>
</hgroup>
<p>Press <span id=\"left-init-key\" class=\"key\">&rarr;</span> key to advance.</p>
%s
</section>
</div>
"
title
subtitle
(let ((spec (org-html-format-spec info)))
(let ((date (cdr (assq ?d spec)))
(author (cdr (assq ?a spec)))
(email (cdr (assq ?e spec)))
(creator (cdr (assq ?c spec)))
(timestamp (cdr (assq ?T spec)))
(validation-link (cdr (assq ?v spec))))
(concat
(when (and (plist-get info :with-date)
(org-string-nw-p date))
(format "<p class=\"date\">%s: %s</p>\n"
(org-html--translate "Date" info)
date))
(when (and (plist-get info :with-author)
(org-string-nw-p author))
(format "<p class=\"author\">%s: %s</p>\n"
(org-html--translate "Author" info)
author))
(when (and (plist-get info :with-email)
(org-string-nw-p email))
(format "<p class=\"email\">%s: %s</p>\n"
(org-html--translate "Email" info)
email))
(when (plist-get info :time-stamp-file)
(format
"<p class=\"date\">%s: %s</p>\n"
(org-html--translate "Created" info)
(format-time-string org-html-metadata-timestamp-format)))
(when (plist-get info :with-creator)
(format "<p class=\"creator\">%s</p>\n" creator))
(format "<p class=\"validation\">%s</p>\n"
validation-link)))))))
 
(defun org-html5presentation-inner-template (contents info)
"Return body of document string after HTML conversion.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options."
(concat
;; Title slide.
(org-html5presentation-title-slide-template info)
;; Document contents.
(save-match-data
;; Remove first `</div>' tag contained in contents string.
;; To prevent nested sections, couple of div tags are being reversed.
;; Thus, `</div>' tag will be at the head of document string.
(if (string-match "^<\/div>" contents)
(substring contents (match-end 0))))
"</div>"))
 
(defun org-html5presentation-template (contents info)
"Return complete document string after HTML conversion.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options."
(concat
(when (and (not (org-html-html5-p info)) (org-html-xhtml-p info))
(let ((decl (or (and (stringp org-html-xml-declaration)
org-html-xml-declaration)
(cdr (assoc (plist-get info :html-extension)
org-html-xml-declaration))
(cdr (assoc "html" org-html-xml-declaration))
 
"")))
(when (not (or (eq nil decl) (string= "" decl)))
(format "%s\n"
(format decl
(or (and org-html-coding-system
(fboundp 'coding-system-get)
(coding-system-get org-html-coding-system 'mime-charset))
"iso-8859-1"))))))
(org-html-doctype info)
"\n"
(concat "<html"
(when (org-html-xhtml-p info)
(format
" xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"%s\" xml:lang=\"%s\""
(plist-get info :language) (plist-get info :language)))
">\n")
"<head>\n"
(org-html5presentation--build-meta-info info)
(org-html5presentation--build-head info)
(org-html--build-mathjax-config info)
"</head>\n"
"<body>\n"
(let ((link-up (org-trim (plist-get info :html-link-up)))
(link-home (org-trim (plist-get info :html-link-home))))
(unless (and (string= link-up "") (string= link-home ""))
(format org-html-home/up-format
(or link-up link-home)
(or link-home link-up))))
;; Document contents.
(format "<%s id=\"%s\">\n"
(nth 1 (assq 'container org-html5presentation-divs))
(nth 2 (assq 'container org-html5presentation-divs)))
;; Navi.
org-html5presentation-navi
(format "<%s class=\"%s\">\n"
(nth 1 (assq 'slides org-html5presentation-divs))
(nth 2 (assq 'slides org-html5presentation-divs)))
;; Loading message.
org-html5presentation-loading
;; Contents.
contents
;; Help.
org-html5presentation-help
(format "</%s>\n"
(nth 1 (assq 'slides org-html5presentation-divs)))
(format "</%s>\n"
(nth 1 (assq 'container org-html5presentation-divs)))
;; JavaScript for IE less than version 9.
(org-html5presentation-ie-lt-9-js info)
;; JavaScript for prettify.js.
(org-html5presentation-prettify-js info)
;; JavaScript for util.js.
(org-html5presentation-utils-js info)
;; Closing document.
"</body>\n</html>"))
 
;;; Transcode Functions
 
;;;; Headline
 
(defun org-html5presentation-headline (headline contents info)
"Transcode a HEADLINE element from Org to HTML.
CONTENTS holds the contents of the headline. INFO is a plist
holding contextual information."
;; Empty contents?
(setq contents (or contents ""))
(let* ((numberedp (org-export-numbered-headline-p headline info))
(level (org-export-get-relative-level headline info))
(text (org-export-data (org-element-property :title headline) info))
(todo (and (plist-get info :with-todo-keywords)
(let ((todo (org-element-property :todo-keyword headline)))
(and todo (org-export-data todo info)))))
(todo-type (and todo (org-element-property :todo-type headline)))
(tags (and (plist-get info :with-tags)
(org-export-get-tags headline info)))
(priority (and (plist-get info :with-priority)
(org-element-property :priority headline)))
(section-number (and (org-export-numbered-headline-p headline info)
(mapconcat 'number-to-string
(org-export-get-headline-number
headline info) ".")))
;; Create the headline text.
(full-text (org-html-format-headline--wrap headline info)))
(cond
;; Case 1: This is a footnote section: ignore it.
((org-element-property :footnote-section-p headline) nil)
;; Case 2. This is a deep sub-tree: export it as a list item.
;; Also export as items headlines for which no section
;; format has been found.
((org-export-low-level-p headline info)
;; Build the real contents of the sub-tree.
(let* ((type (if numberedp 'ordered 'unordered))
(itemized-body (org-html-format-list-item
contents type nil info nil full-text)))
(concat
(and (org-export-first-sibling-p headline info)
(org-html-begin-plain-list type))
itemized-body
(and (org-export-last-sibling-p headline info)
(org-html-end-plain-list type)))))
;; Case 3. Standard headline. Export it as a section.
(t
(let* ((section-number (mapconcat 'number-to-string
(org-export-get-headline-number
headline info) "-"))
(ids (remove 'nil
(list (org-element-property :CUSTOM_ID headline)
(concat "sec-" section-number)
(org-element-property :ID headline))))
(preferred-id (car ids))
(extra-ids (cdr ids))
(extra-class (org-element-property :HTML_CONTAINER_CLASS headline))
(level1 (+ level (1- org-html-toplevel-hlevel)))
(first-content (car (org-element-contents headline))))
(format "</%s>\n<%s id=\"%s\" class=\"%s\">%s%s"
(org-html--container headline info)
(org-html--container headline info)
(format "outline-container-%s"
(or (org-element-property :CUSTOM_ID headline)
(concat "sec-" section-number)))
"slide"
(format "\n<header id=\"%s\">%s%s</header>\n"
preferred-id
(mapconcat
(lambda (x)
(let ((id (org-export-solidify-link-text
(if (org-uuidgen-p x) (concat "ID-" x)
x))))
(org-html--anchor id)))
extra-ids "")
full-text)
;; When there is no section, pretend there is an empty
;; one to get the correct <div class="outline- ...>
;; which is needed by `org-info.js'.
(if (not (eq (org-element-type first-content) 'section))
(concat (org-html5presentation-section first-content "" info)
contents)
contents)))))))
 
;;;; Section
 
(defun org-html5presentation-section (section contents info)
"Transcode a SECTION element from Org to HTML.
CONTENTS holds the contents of the section. INFO is a plist
holding contextual information."
(let ((parent (org-export-get-parent-headline section)))
;; Before first headline: no container, just return CONTENTS.
(if (not parent) contents
;; Build return value.
(format "<section>\n%s</section>"
contents))))
 
;;; End-user functions
 
;;;###autoload
(defun org-html5presentation-export-as-html
(&optional async subtreep visible-only body-only ext-plist)
"Export current buffer to an HTML buffer.
 
If narrowing is active in the current buffer, only export its
narrowed part.
 
If a region is active, export that region.
 
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer should be accessible
through the `org-export-stack' interface.
 
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
 
When optional argument VISIBLE-ONLY is non-nil, don't export
contents of hidden elements.
 
When optional argument BODY-ONLY is non-nil, only write code
between \"<body>\" and \"</body>\" tags.
 
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
 
Export is done in a buffer named \"*Org HTML Export*\", which
will be displayed when `org-export-show-temporary-export-buffer'
is non-nil."
(interactive)
(org-export-to-buffer 'html5presentation "*Org HTML Export*"
async subtreep visible-only body-only ext-plist
(lambda () (set-auto-mode t))))
 
;;;###autoload
(defun org-html5presentation-convert-region-to-html ()
"Assume the current region has org-mode syntax, and convert it to HTML.
This can be used in any buffer. For example, you can write an
itemized list in org-mode syntax in an HTML buffer and use this
command to convert it."
(interactive)
(org-export-replace-region-by 'html5presentation))
 
;;;###autoload
(defun org-html5presentation-export-to-html
(&optional async subtreep visible-only body-only ext-plist)
"Export current buffer to a HTML file.
 
If narrowing is active in the current buffer, only export its
narrowed part.
 
If a region is active, export that region.
 
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the `org-export-stack' interface.
 
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
 
When optional argument VISIBLE-ONLY is non-nil, don't export
contents of hidden elements.
 
When optional argument BODY-ONLY is non-nil, only write code
between \"<body>\" and \"</body>\" tags.
 
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
 
Return output file's name."
(interactive)
(let* ((extension (concat "." org-html-extension))
(file (org-export-output-file-name extension subtreep))
(org-export-coding-system org-html-coding-system))
(org-export-to-file 'html5presentation file
async subtreep visible-only body-only ext-plist)))
 
;;;###autoload
(defun org-html5presentation-publish-to-html (plist filename pub-dir)
"Publish an org file to HTML.
 
FILENAME is the filename of the Org file to be published. PLIST
is the property list for the given project. PUB-DIR is the
publishing directory.
 
Return output file name."
(org-publish-org-to 'html5presentation filename
(concat "." (or (plist-get plist :html-extension)
org-html-extension "html"))
plist pub-dir))
 
 
(provide 'ox-html5presentation)
;;; ox-html5presentation.el ends here

Hi Kinjo,

This is broken in the latest version of org-mode. From my emacs Messages buffer...

Org-mode version 8.0.3 (release_8.0.3 @ /Users/regcl/Darwin/share/emacs/site-lisp/org/)

GNU Emacs 24.3.1 (x86_64-apple-darwin12.2.0, NS apple-appkit-1187.34) of 2013-05-30 on hobo.local

Load org-html5presentation.el? (y or n) y
Loading /Users/regcl/org/present/ideas/org-html5presentation/gist509761-91c1e7727ed45ec24eec855cb86b6b80f4f020d1/org-html5presentation.el (source)...
Load error for /Users/regcl/org/present/ideas/org-html5presentation/gist509761-91c1e7727ed45ec24eec855cb86b6b80f4f020d1/org-html5presentation.el:
(file-error Cannot open load file org-exp)

... so I comment out ...

;;(require 'org-exp)

... now it loads without error, but when I try

M-x org-export-as-html5presentation-and-open

... I get

Exporting...
let*: Symbol's function definition is void: org-export-process-option-filters

...

Also, it would be really helpful to those of us trying to use this if
you could clean up all the org-html5presentation clutter on GitHub.

best,
regcl

I got this error trying to export:

org-export-html5presentation-convert-special-strings: Symbol's value as variable is void: org-export-html-special-string-regexps

I'm using org-mode 8.0.7 and I couldn't find org-export-html-special-string-regexps anywhere in source code. Should I add any line to .emacs?

same problem as sineau...

Same for me, did you solve the error?

Sorry to have kept everyone waiting so long.

I updated this library to support Org-mode 8.2.5h.

Note: Main repository has moved to Github https://github.com/kinjo/org-html5presentation.el.
This repository will be deleted some day in the future.

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.