asciidoctor-revealjs 1.0.0

data/asciidoctor-revealjs.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path '../lib/asciidoctor-revealjs/version', __FILE__
+
+Gem::Specification.new do |s|
+  s.name = 'asciidoctor-revealjs'
+  s.version = Asciidoctor::Revealjs::VERSION
+  s.authors = ['Olivier Bilodeau']
+  s.email = ['olivier@bottomlesspit.org']
+  s.homepage = 'https://github.com/asciidoctor/asciidoctor-reveal.js'
+  s.summary = 'Converts AsciiDoc to HTML for a Reveal.js presentation'
+  s.description = 'An Asciidoctor converter that generates the HTML component of a Reveal.js presentation from AsciiDoc.'
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 1.9.3'
+
+  files = begin
+    (result = Open3.popen3('git ls-files -z') {|_, out| out.read }.split %(\0)).empty? ? Dir['**/*'] : result
+  rescue
+    Dir['**/*']
+  end
+  s.files = files.grep %r/^(?:(?:lib|templates)\/.+|Gemfile|Rakefile|(?:CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
+
+
+  s.executables = ['asciidoctor-revealjs']
+  s.extra_rdoc_files = Dir['README.adoc', 'LICENSE.adoc', 'HACKING.adoc']
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'asciidoctor', '~> 1.5.4'
+  s.add_runtime_dependency 'slim', '~> 3.0.6'
+  s.add_runtime_dependency 'thread_safe', '~> 0.3.5'
+
+  s.add_development_dependency 'rake', '~> 10.4.2'
+end

data/bin/asciidoctor-revealjs

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+if File.file?(asciidoctor_revealjs = (File.expand_path '../../lib/asciidoctor-revealjs.rb', __FILE__))
+  require asciidoctor_revealjs
+else
+  require 'asciidoctor-revealjs'
+end
+require 'asciidoctor/cli'
+
+options = Asciidoctor::Cli::Options.new backend: 'revealjs'
+
+# FIXME (from bespoke) This is a really bizarre API. Please make me simpler.
+if Integer === (result = options.parse! ARGV)
+  exit result
+else
+  invoker = Asciidoctor::Cli::Invoker.new options
+  GC.start
+  invoker.invoke!
+  exit invoker.code
+end

data/lib/asciidoctor-revealjs.rb

@@ -0,0 +1,2 @@
+require 'asciidoctor' unless defined? Asciidoctor::Converter
+require_relative 'asciidoctor-revealjs/converter'

data/lib/asciidoctor-revealjs/converter.rb

@@ -0,0 +1,36 @@
+require 'asciidoctor/converter/html5'
+require 'asciidoctor/converter/composite'
+require 'asciidoctor/converter/template'
+
+module Asciidoctor; module Revealjs
+
+  class Converter < ::Asciidoctor::Converter::CompositeConverter
+    ProvidedTemplatesDir = ::File.expand_path '../../../templates', __FILE__
+    register_for 'revealjs'
+
+    def initialize backend, opts = {}
+        # merge user templates with provided templates (user wins)
+        template_dirs = [ProvidedTemplatesDir]
+        if (user_template_dirs = opts[:template_dirs])
+          template_dirs += user_template_dirs.map {|d| ::File.expand_path d }
+        end
+        # Engine Opal means we need to use the Javascript based templates
+        if RUBY_ENGINE == 'opal'
+          template_engine = 'jade'
+        else
+          template_engine = 'slim'
+        end
+        # create the main converter
+        template_converter = ::Asciidoctor::Converter::TemplateConverter.new backend,
+            template_dirs,
+            (opts.merge htmlsyntax: 'html', template_engine: template_engine)
+        # create the delegate / fallback converter
+        html5_converter = ::Asciidoctor::Converter::Html5Converter.new backend, opts
+        # fuse the converters together
+        super backend, template_converter, html5_converter
+        basebackend 'html'
+        htmlsyntax 'html'
+    end
+  end
+
+end; end

data/lib/asciidoctor-revealjs/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+module Revealjs
+  VERSION = '1.0.0'
+end
+end

data/templates/jade/admonition.jade

@@ -0,0 +1,17 @@
+if node['$has_role?']('aside') || node['$has_role?']('speaker')
+  aside.notes !{node.$content()}
+else
+  div.admonitionblock(id=node.$id(),class=[node.$attr('name'), node.$role()])
+    table
+      tr
+        td.icon
+          if node.document.$attr('icons') == 'font'
+            i(class="icon-#{node.$attr('name')}",title=node.$caption())
+          else if node.document.$attr('icons', false)
+            img(src=node.$icon_uri(node.$attr('name')),alt=node.$caption())
+          else
+            div.title
+              | !{node.$caption()}
+          if node.$title() != false
+            div.title !{node.$title()}
+          | !{node.$content()}

data/templates/jade/audio.jade

@@ -0,0 +1,6 @@
+div.audioblock(id=node.$id(),class=[node.$style(), node.$role()])
+  if node.$title() != false
+    div.title !{node.$captioned_title()}
+  div.content
+    audio(src=node.$media_uri(node.$attr('target')),autoplay=node.$option('autoplay', ""),controls=node.$option('nocontrols', ""),loop=node.$option('loop', ""))
+      | "Your browser does not support the audio tag."

data/templates/jade/colist.jade

@@ -0,0 +1,22 @@
+div.colist(id=node.$id(),class=[node.$style(), node.$role()])
+  if node.$title() != false
+    div.title !{node.$title()}
+  if node.document.$attr("icons", false)
+    - font_icons = node.document.$attr("icons") == "font"
+    table
+      each item,i in node.$items()
+        - num = i + 1
+        tr
+          td
+            if font_icons
+              i.conum(data-value=num)
+              b !{num}
+            else
+              img(src=node.$icon_uri("callouts/#{num}"),alt=num)
+          td !{item.$text()}
+  else
+    ol
+      each item in node.$items()
+        li
+          p
+            | !{item.$text()}

data/templates/jade/dlist.jade

@@ -0,0 +1,60 @@
+if node.$style() == 'qanda'
+  div.qlist(id=node.$id(),class=['qanda', node.$role()])
+    if node['$title?']()
+      .title= node.$title()
+    ol
+      each item, i in node.$items()
+        - questions = item[0]
+        - answer = item[1]
+        li
+          each question in [].concat(questions)
+            p
+              em= question.$text()
+            unless answer['$nil?']()
+              if answer['$text?']()
+                p= answer.$text()
+              if answer['$blocks?']()
+                | !{answer.$content()}
+else if node.$style() == 'horizontal'
+  .hdlist(id=node.$id(),class=node.$role())
+    if node['$title?']()
+      .title= node.$title()
+    table
+      if node['$attr?']('labelwidth') || node['$attr?']('itemwidth')
+        colgroup
+          col(width=node.$attr('labelwidth'))
+          col(width=node.$attr('itemwidth'))
+      each item in node.$items()
+        - var terms = item[0]
+        - var dd = item[1]
+        tr
+          td(class=['hdlist1', node['$option?']('strong') ? 'strong' : ''])
+            - terms = [].concat(terms)
+            - last_term = terms.$last()
+            each dt in terms
+              | !{dt.$text()}
+              if dt != last_term
+                br
+          td.hdlist2
+            unless dd['$nil?']()
+              if dd['$text?']()
+                p= dd.$text()
+              if dd['$blocks?']()
+                | !{dd.$content()}
+else
+  .dlist(id=node.$id(),class=[node.$style(), node.$role()])
+    if node['$title?']()
+      .title= node.$title()
+    dl
+      each item in node.$items()
+        - terms = item[0]
+        - dd = item[1]
+        each dt in [].concat(terms)
+          dt(class=node.$style() == false ? 'hdlist1' : '')
+            | !{dt.$text()}
+          unless dd['$nil?']()
+            dd
+              if dd['$text?']()
+                p= dd.$text()
+              if dd['$blocks?']()
+                | !{dd.$content()}

data/templates/jade/document.jade

@@ -0,0 +1,103 @@
+doctype html
+html(lang=node.document.$attr("lang", "en") )
+  head
+    meta(charset="UTF-8")
+    - revealjsdir = node.$attr('revealjsdir', 'reveal.js')
+    each key in ["description","keywords","author","copyright"]
+      if node.$attr(key, false)
+        meta(name=key,content=node.$attr(key))
+    title= node.$doctitle()
+    meta(content="yes",name="apple-mobile-web-app-capable")
+    meta(content="black-translucent",name="apple-mobile-web-app-status-bar-style")
+    meta(content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui",name="viewport")
+    link(href="//maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css",rel="stylesheet")
+    link(href="#{revealjsdir}/css/reveal.css",rel="stylesheet")
+    if node.$attr("revealjs_customtheme", false)
+      link(rel='stylesheet',href="#{node.$attr('revealjs_customtheme')}",id='theme')
+    else
+      link(rel='stylesheet',href='#{revealjsdir}/css/theme/serif.css',id='theme')
+    link(href="#{revealjsdir}/lib/css/zenburn.css",rel="stylesheet")
+    script(src = "http://getfirebug.com/firebug-lite.js#startOpened=false")
+    script(type='text/javascript').
+      document.write('<link rel="stylesheet" href="#{revealjsdir}/css/print/' + ( window.location.search.match(/print-pdf/gi) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">');
+  body
+    .reveal
+      .slides !{node.$content()}
+    script(src = "#{revealjsdir}/lib/js/head.min.js")
+    script(src = "#{revealjsdir}/js/reveal.js")
+    script(type='text/javascript').
+      function initializeReveal() {
+        // See https://github.com/hakimel/reveal.js#configuration for a full list of configuration options
+        Reveal.initialize({
+          // Display controls in the bottom right corner
+          controls: #{node.$attr('revealjs_controls', true)},
+          // Display a presentation progress bar
+          progress: #{node.$attr('revealjs_progress', true) },
+          // Display the page number of the current slide
+          slideNumber: #{node.$attr('revealjs_slidenumber', true) },
+          // Push each slide change to the browser history
+          history: #{node.$attr('revealjs_history', true) },
+          // Enable keyboard shortcuts for navigation
+          keyboard: #{node.$attr('revealjs_keyboard', true) },
+          // Enable the slide overview mode
+          overview: #{node.$attr('revealjs_overview', true) },
+          // Vertical centering of slides
+          center: #{node.$attr('revealjs_center', true) },
+          // Enables touch navigation on devices with touch input
+          touch: #{node.$attr('revealjs_touch', true) },
+          // Loop the presentation
+          loop: #{node.$attr('revealjs_loop', false) },
+          // Change the presentation direction to be RTL
+          rtl: #{node.$attr('revealjs_rtl', false) },
+          // Turns fragments on and off globally
+          fragments: #{node.$attr('revealjs_fragments', true) },
+          // Flags if the presentation is running in an embedded mode,
+          // i.e. contained within a limited portion of the screen
+          embedded: #{node.$attr('revealjs_embedded', false) },
+          // Number of milliseconds between automatically proceeding to the
+          // next slide, disabled when set to 0, this value can be overwritten
+          // by using a data-autoslide attribute on your slides
+          autoSlide: #{node.$attr('revealjs_autoslide', 0) },
+          // Stop auto-sliding after user input
+          autoSlideStoppable: #{node.$attr('revealjs_autoslidestoppable', true) },
+          // Enable slide navigation via mouse wheel
+          mouseWheel: #{node.$attr('revealjs_mousewheel', true) },
+          // Hides the address bar on mobile devices
+          hideAddressBar: #{node.$attr('revealjs_hideaddressbar', true) },
+          // Opens links in an iframe preview overlay
+          previewLinks: #{node.$attr('revealjs_previewlinks', false) },
+          // Theme (e.g., beige, blond, default, moon, night, serif, simple, sky, solarized)
+          theme: Reveal.getQueryHash().theme || '#{node.$attr('revealjs_theme', 'serif') }',
+          // Transition style (e.g., default, cube, page, concave, zoom, linear, fade, none)
+          transition: Reveal.getQueryHash().transition || '#{node.$attr('revealjs_transition', 'default') }',
+          // Transition speed (e.g., default, fast, slow)
+          transitionSpeed: '#{node.$attr('revealjs_transitionspeed', 'default') }',
+          // Transition style for full page slide backgrounds (e.g., default, none, slide, concave, convex, zoom)
+          backgroundTransition: '#{node.$attr('revealjs_backgroundtransition', 'default') }',
+          // Number of slides away from the current that are visible
+          viewDistance: #{node.$attr('revealjs_viewdistance', 3)},
+          // Parallax background image (e.g., "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'")
+          parallaxBackgroundImage: '#{node.$attr('revealjs_parallaxbackgroundimage', '') }',
+          // Parallax background size in CSS syntax (e.g., "2100px 900px")
+          parallaxBackgroundSize: '#{node.$attr('revealjs_parallaxbackgroundsize', '') }',
+          // Optional libraries used to extend on reveal.js
+          dependencies: [
+            {
+              src: '#{revealjsdir}/lib/js/classList.js',
+              condition: function () { return !document.body.classList; }
+            },
+            #{(node.$attr('source-highlighter') == 'highlight.js') ? "{ src: '#{revealjsdir}/plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }," : ""}
+            {
+              src: '#{revealjsdir}/plugin/zoom-js/zoom.js',
+              async: true,
+              condition: function () { return !!document.body.classList; }
+            },
+            {
+              src: '#{revealjsdir}/plugin/notes/notes.js',
+              async: true,
+              condition: function () { return !!document.body.classList; }
+            }
+          ]
+        });
+      }
+      initializeReveal();

data/templates/jade/embedded.jade

@@ -0,0 +1,11 @@
+unless node.$notitle() || !node['$has_header?']()
+  h1(id=node.$id()) !{node.$header().$title()}
+| !{node.$content()}
+unless !node['$footnotes?']() || node['$attr?']('nofootnotes')
+  div(id='footnotes')
+    hr
+    each fn in node.$footnotes()
+      div.footnote(id='_footnote_' + fn.$index())
+        a(href='#_footnoteref_' + fn.$index())
+          | !{fn.$index()}
+        | !{fn.$text()}

data/templates/jade/example.jade

@@ -0,0 +1,4 @@
+div.exampleblock(id=node.$id(),class=node.$role())
+  if node.$title() != false
+    div.title !{node.$captioned_title()}
+  div.content !{node.$content()}

data/templates/jade/floating_title.jade

@@ -0,0 +1,2 @@
+- levelPlusOne = level + 1
+#{"h#{levelPlusOne}"}(id=node.$id(),class=[node.$style(), node.$role()]) !{node.$title()}

data/templates/jade/image.jade

@@ -0,0 +1,12 @@
+div.imageblock(id=node.$id(),class=["#{node.$style()}", "#{node.$role()}"],style={
+  "text-align": node.$attr('align'),
+  float: node.$attr('float') ? "float: #{node.$attr('float')}" : ''
+})
+  .content
+    if node.$attr('link', false)
+      a.image(href=node.$attr('link'))
+        img(src=node.$image_uri(node.$attr('target')),alt=node.$attr('alt'),width=node.$attr('width'),height=node.$attr('height'),style=[node.$attr('background') ? "background: #{node.$attr('background')}" : ""])
+    else
+      img(src=node.$image_uri(node.$attr('target')),alt=node.$attr('alt'),width=node.$attr('width'),height=node.$attr('height'),style=[node.$attr('background') ? "background: #{node.$attr('background')}" : ""])
+    if node.$title() != false
+      .title !{node.$captioned_title()}

data/templates/jade/inline_anchor.jade

@@ -0,0 +1,9 @@
+case node.$type()
+  when "xref"
+    a(href=node.$target()) !{node.$text()}
+  when "ref"
+    a(id=node.$target())
+  when "bibref"
+    a(id=node.$target())
+  default
+    a(href=node.$target(),class=node.$role(),target=node.$attr('window')) !{node.$text()}

data/templates/jade/inline_break.jade

@@ -0,0 +1,2 @@
+| !{node.$text()}
+br

data/templates/jade/inline_button.jade

@@ -0,0 +1 @@
+b.button !{node.$text()}

data/templates/jade/inline_callout.jade

@@ -0,0 +1,9 @@
+if node.document.$attr("icons") == "font"
+  - num = "(" + node.$text() + ")"
+  i.conum(data-value=node.$text())
+  b !{num}
+else if node.document.$attr("icons", false)
+  img(src=node.$icon_uri("callouts/#{node.$text()}"),alt=node.$text())
+else
+  - num = "(" + node.$text() + ")"
+  b !{num}

data/templates/jade/inline_image.jade

@@ -0,0 +1,24 @@
+span(class=[node.$type(), node.$role()],style=node.$attr('float', ''))
+  if node.$type() == 'icon' && node.document.$attr('icons') == 'font'
+    - style_class = ["fa fa-" + node.$target()]
+    - style_class.push(node['$attr?']('size') ? 'fa-' + node.$attr('size'): '');
+    - style_class.push(node['$attr?']('rotate') ? 'fa-rotate-' + node.$attr('rotate'): '');
+    - style_class.push(node['$attr?']('flip') ? 'fa-flip-' + node.$attr('flip'): '');
+    if node['$attr?']('link')
+      a.image(href=node.$attr('link'),target=node.$attr('window'))
+        i(class=[style_class],title=node.$attr('title'))
+    else
+      i(class=[style_class],title=node.$attr('title'))
+  else if node.$type() == 'icon' && !node.document['$attr?']('icons')
+    if node['$attr?']('link')
+      a.image(href=node.$attr('link'),target=node.$attr('window'))
+        | [#{node.$attr('alt')}]
+    else
+      | [#{node.$attr('alt')}]
+  else
+    - src = node.$type() == 'icon' ? node.$icon_uri(node.$target()) : node.$image_uri(node.$target())
+    if node['$attr?']('link')
+      a.image(href=node.$attr('link'),target=node.$attr('window'))
+        img(src=src,alt=node.$attr('link'),width=node.$attr('width'),height=node.$attr('height'),title=node.$attr('title'))
+    else
+      img(src=src,alt=node.$attr('link'),width=node.$attr('width'),height=node.$attr('height'),title=node.$attr('title'))

data/templates/jade/inline_indexterm.jade

@@ -0,0 +1,2 @@
+if node.$type() == "visible"
+  = !{node.$text()}

data/templates/jade/inline_kbd.jade

@@ -0,0 +1,9 @@
+- var keys = node.$attr('keys')
+if keys.length == 1
+  kbd !{keys.$first()}
+else
+  kbd.keyseq
+    each key,idx in keys
+      if !idx['$zero?']()
+        | +
+      kbd !{key}

data/templates/jade/inline_quoted.jade

@@ -0,0 +1,26 @@
+case node.$type()
+  when "emphasis"
+    em(class=node.$role()) !{node.$text()}
+  when "strong"
+    strong(class=node.$role()) !{node.$text()}
+  when "monospaced"
+    code(class=node.$role()) !{node.$text()}
+  when "superscript"
+    sup(class=node.$role()) !{node.$text()}
+  when "subscript"
+    sub(class=node.$role()) !{node.$text()}
+  when "double"
+    if node.$role() != false
+      span(class=node.$role()) “!{node.$text()}”
+    else
+      | “!{node.$text()}”
+  when "single"
+    if node.$role() != false
+      span(class=node.$role()) ‘!{node.$text()}’
+    else
+      | ‘!{node.$text()}’
+  default
+    if node.$role() != false
+      span(class=node.$role()) !{node.$text()}
+    else
+      | !{node.$text()}