asciidoctor-revealjs 3.1.0 → 4.0.0

data/templates/document.html.slim

@@ -2,6 +2,10 @@ doctype 5
 html lang=(attr :lang, 'en' unless attr? :nolang)
   head
     meta charset="utf-8"
+    meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui"
+
+    title=(doctitle sanitize: true, use_fallback: true)
+
     - if RUBY_ENGINE == 'opal' && JAVASCRIPT_PLATFORM == 'node'
       - revealjsdir = (attr :revealjsdir, 'node_modules/reveal.js')
     - else
@@ -13,17 +17,17 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
       - if attr? key
         meta name=key content=(attr key)
     - linkcss = (attr? 'linkcss')
-    title=(doctitle sanitize: true, use_fallback: true)
-    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="#{revealjsdir}/css/reveal.css" rel="stylesheet"
+    link rel="stylesheet" href="#{revealjsdir}/css/reset.css"
+    link rel="stylesheet" href="#{revealjsdir}/css/reveal.css"
+
     / Default theme required even when using custom theme
     - if attr? :revealjs_customtheme
       link rel='stylesheet' href=(attr :revealjs_customtheme) id='theme'
     - else
       link rel='stylesheet' href='#{revealjsdir}/css/theme/#{attr 'revealjs_theme', 'black'}.css' id='theme'
-    include asciidoctor_revealjs.css.slim
+    /! This CSS is generated by the Asciidoctor reveal.js converter to further integrate AsciiDoc's existing semantic with reveal.js
+    style type="text/css"
+      include asciidoctor-compatibility.css
     - if attr? :icons, 'font'
       / iconfont-remote is implicitly set by Asciidoctor core. See https://github.com/asciidoctor/asciidoctor.org/issues/361
       - if attr? 'iconfont-remote'
@@ -53,55 +57,33 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
     - syntax_hl = self.syntax_highlighter
     - if syntax_hl && (syntax_hl.docinfo? :head)
       =syntax_hl.docinfo :head, self, cdn_base_url: cdn_base, linkcss: linkcss, self_closing_tag_slash: '/'
-    / If the query includes 'print-pdf', use the PDF print sheet
+
+    /! Printing and PDF exports
     javascript:
       var link = document.createElement( 'link' );
       link.rel = 'stylesheet';
       link.type = 'text/css';
       link.href = window.location.search.match( /print-pdf/gi ) ? "#{revealjsdir}/css/print/pdf.css" : "#{revealjsdir}/css/print/paper.css";
       document.getElementsByTagName( 'head' )[0].appendChild( link );
-    /[if lt IE 9]
-      <script src="#{revealjsdir}/lib/js/html5shiv.js"></script>
-    - unless (docinfo_content = docinfo :header, '.html').empty?
-      =docinfo_content
+
     - if attr? :customcss
       link rel='stylesheet' href=((customcss = attr :customcss).empty? ? 'asciidoctor-revealjs.css' : customcss)
+    - unless (_docinfo = docinfo :head, '-revealjs.html').empty?
+      =_docinfo
   body
     .reveal
       / Any section element inside of this container is displayed as a slide
       .slides
-        - unless notitle || !has_header?
-          - bg_image = (attr? 'title-slide-background-image') ? (image_uri(attr 'title-slide-background-image')) : nil
-          - bg_video = (attr? 'title-slide-background-video') ? (media_uri(attr 'title-slide-background-video')) : nil
-          section.title(class = role
-            data-state='title'
-            data-transition=(attr 'title-slide-transition')
-            data-transition-speed=(attr 'title-slide-transition-speed')
-            data-background=(attr 'title-slide-background')
-            data-background-size=(attr 'title-slide-background-size')
-            data-background-image=bg_image
-            data-background-video=bg_video
-            data-background-video-loop=(attr 'title-slide-background-video-loop')
-            data-background-video-muted=(attr 'title-slide-background-video-muted')
-            data-background-opacity=(attr "background-opacity")
-            data-background-iframe=(attr 'title-slide-background-iframe')
-            data-background-color=(attr 'title-slide-background-color')
-            data-background-repeat=(attr 'title-slide-background-repeat')
-            data-background-position=(attr 'title-slide-background-position')
-            data-background-transition=(attr 'title-slide-background-transition'))
-            - if (_title_obj = doctitle partition: true, use_fallback: true).subtitle?
-              h1=slice_text _title_obj.title, (_slice = header.option? :slice)
-              h2=slice_text _title_obj.subtitle, _slice
-            - else
-              h1=@header.title
-            - preamble = @document.find_by context: :preamble
-            - unless preamble.nil? or preamble.length == 0
-              div.preamble=preamble.pop.content
-            - unless author.nil?
-              p.author: small=author
-        =content
-    script src="#{revealjsdir}/lib/js/head.min.js"
+        - unless noheader
+          - unless (_docinfo = docinfo :header, '-revealjs.html').empty?
+            = _docinfo
+          - if header?
+            include title_slide.html.slim
+        = content
+        - unless (_docinfo = docinfo :footer, '-revealjs.html').empty?
+          = _docinfo
     script src="#{revealjsdir}/js/reveal.js"
+    / Supports easy AsciiDoc syntax for background color
     javascript:
       Array.prototype.slice.call(document.querySelectorAll('.slides section')).forEach(function(slide) {
         if (slide.getAttribute('data-background-color')) return;
@@ -112,9 +94,11 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
           slide.setAttribute('data-background-color', bgColor);
           slide.style.backgroundColor = 'transparent';
         }
-      })
+      });
 
-      // See https://github.com/hakimel/reveal.js#configuration for a full list of configuration options
+      // More info about config & dependencies:
+      // - https://github.com/hakimel/reveal.js#configuration
+      // - https://github.com/hakimel/reveal.js#dependencies
       Reveal.initialize({
         // Display presentation control arrows
         controls: #{to_boolean(attr 'revealjs_controls', true)},
@@ -132,7 +116,10 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
         slideNumber: #{to_valid_slidenumber(attr 'revealjs_slidenumber', false)},
         // Control which views the slide number displays on
         showSlideNumber: '#{attr 'revealjs_showslidenumber', 'all'}',
-        // Push each slide change to the browser history
+        // Add the current slide number to the URL hash so that reloading the
+        // page/copying the URL will return you to the same slide
+        hash: #{to_boolean(attr 'revealjs_hash', false)},
+        // Push each slide change to the browser history. Implies `hash: true`
         history: #{to_boolean(attr 'revealjs_history', false)},
         // Enable keyboard shortcuts for navigation
         keyboard: #{to_boolean(attr 'revealjs_keyboard', true)},
@@ -146,6 +133,8 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
         loop: #{to_boolean(attr 'revealjs_loop', false)},
         // Change the presentation direction to be RTL
         rtl: #{to_boolean(attr 'revealjs_rtl', false)},
+        // See https://github.com/hakimel/reveal.js/#navigation-mode
+        navigationMode: '#{attr 'revealjs_navigationmode', 'default'}',
         // Randomizes the order of slides each time the presentation loads
         shuffle: #{to_boolean(attr 'revealjs_shuffle', false)},
         // Turns fragments on and off globally
@@ -166,6 +155,12 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
         // - true: All media will autoplay, regardless of individual setting
         // - false: No media will autoplay, regardless of individual setting
         autoPlayMedia: #{attr 'revealjs_autoplaymedia', 'null'},
+        // Global override for preloading lazy-loaded iframes
+        // - null: Iframes with data-src AND data-preload will be loaded when within
+        //   the viewDistance, iframes with only data-src will be loaded when visible
+        // - true: All iframes with data-src will be loaded when within the viewDistance
+        // - false: All iframes with data-src will be loaded only when visible
+        preloadIframes: #{attr 'revealjs_preloadiframes', 'null'},
         // 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
@@ -178,8 +173,23 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
         // presenting each slide. This is used to show a pacing timer in the
         // speaker view
         defaultTiming: #{attr 'revealjs_defaulttiming', 120},
+        // Specify the total time in seconds that is available to
+        // present.  If this is set to a nonzero value, the pacing
+        // timer will work out the time available for each slide,
+        // instead of using the defaultTiming value
+        totalTime: #{attr 'revealjs_totaltime', 0},
+        // Specify the minimum amount of time you want to allot to
+        // each slide, if using the totalTime calculation method.  If
+        // the automated time allocation causes slide pacing to fall
+        // below this threshold, then you will see an alert in the
+        // speaker notes window
+        minimumTimePerSlide: #{attr 'revealjs_minimumtimeperslide', 0},
         // Enable slide navigation via mouse wheel
         mouseWheel: #{to_boolean(attr 'revealjs_mousewheel', false)},
+        // Hide cursor if inactive
+        hideInactiveCursor: #{to_boolean(attr 'revealjs_hideinactivecursor', true)},
+        // Time before the cursor is hidden (in ms)
+        hideCursorTime: #{attr 'revealjs_hidecursortime', 5000},
         // Hides the address bar on mobile devices
         hideAddressBar: #{to_boolean(attr 'revealjs_hideaddressbar', true)},
         // Opens links in an iframe preview overlay
@@ -194,6 +204,10 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
         backgroundTransition: '#{attr 'revealjs_backgroundtransition', 'fade'}',
         // Number of slides away from the current that are visible
         viewDistance: #{attr 'revealjs_viewdistance', 3},
+        // Number of slides away from the current that are visible on mobile
+        // devices. It is advisable to set this to a lower number than
+        // viewDistance in order to save resources.
+        mobileViewDistance: #{attr 'revealjs_mobileviewdistance', 3},
         // Parallax background image (e.g., "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'")
         parallaxBackgroundImage: '#{attr 'revealjs_parallaxbackgroundimage', ''}',
         // Parallax background size in CSS syntax (e.g., "2100px 900px")
@@ -227,19 +241,16 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
 
         // Optional libraries used to extend on reveal.js
         dependencies: [
-            { src: '#{revealjsdir}/lib/js/classList.js', condition: function() { return !document.body.classList; } },
-            #{(document.attr? 'source-highlighter', 'highlightjs') ? "{ src: '#{revealjsdir}/plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }," : nil}
-            #{(attr? 'revealjs_plugin_zoom', 'disabled') ? "" :  "{ src: '#{revealjsdir}/plugin/zoom-js/zoom.js', async: true }," }
-            #{(attr? 'revealjs_plugin_notes', 'disabled') ? "" :  "{ src: '#{revealjsdir}/plugin/notes/notes.js', async: true }," }
-            #{(attr? 'revealjs_plugin_marked', 'enabled') ? "{ src: '#{revealjsdir}/plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }," : "" }
-            #{(attr? 'revealjs_plugin_markdown', 'enabled') ? "{ src: '#{revealjsdir}/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }," : "" }
-            #{(attr? 'revealjs_plugin_pdf', 'enabled') ? "{ src: '#{revealjsdir}/plugin/print-pdf/print-pdf.js', async: true }," :  "" }
-            #{(attr? 'revealjs_plugins') ? File.read(attr('revealjs_plugins', '')) : ""}
+            #{revealjs_dependencies(document, self, revealjsdir)}
         ],
 
         #{(attr? 'revealjs_plugins_configuration') ? File.read(attr('revealjs_plugins_configuration', '')) : ""}
 
       });
+    / Workaround the "Only direct descendants of a slide section can be stretched" limitation in reveal.js
+    / https://github.com/hakimel/reveal.js/issues/2584
+    include stretch_nested_elements.js.slim
+
     - if syntax_hl && (syntax_hl.docinfo? :footer)
       =syntax_hl.docinfo :footer, self, cdn_base_url: cdn_base, linkcss: linkcss, self_closing_tag_slash: '/'
 

data/templates/helpers.rb

@@ -24,6 +24,23 @@ module Slim::Helpers
     val && val != 'false' && val.to_s != '0' || false
   end
 
+  # bool_data_attr
+  # If the AsciiDoc attribute doesn't exist, no HTML attribute is added
+  # If the AsciiDoc attribute exist and is a true value, HTML attribute is enabled (bool)
+  # If the AsciiDoc attribute exist and is a false value, HTML attribute is a false string
+  # Ex: a feature is enabled globally but can be disabled using a data- attribute on individual items
+  # :revealjs_previewlinks: True
+  # then link::example.com[Link text, preview=false]
+  # Here the template must have data-preview-link="false" not just no data-preview-link attribute
+  def bool_data_attr val
+    return false if !attr?(val)
+    if attr(val).downcase == 'false' || attr(val) == '0'
+      return 'false'
+    else
+      return true
+    end
+  end
+
   # false needs to be verbatim everything else is a string.
   # Calling side isn't responsible for quoting so we are doing it here
   def to_valid_slidenumber val
@@ -101,6 +118,20 @@ module Slim::Helpers
     end
   end
 
+  def revealjs_dependencies(document, node, revealjsdir)
+    dependencies = []
+    dependencies << "{ src: '#{revealjsdir}/plugin/zoom-js/zoom.js', async: true }" unless (node.attr? 'revealjs_plugin_zoom', 'disabled')
+    dependencies << "{ src: '#{revealjsdir}/plugin/notes/notes.js', async: true }" unless (node.attr? 'revealjs_plugin_notes', 'disabled')
+    dependencies << "{ src: '#{revealjsdir}/plugin/markdown/marked.js', async: true }" if (node.attr? 'revealjs_plugin_marked', 'enabled')
+    dependencies << "{ src: '#{revealjsdir}/plugin/markdown/markdown.js', async: true }" if (node.attr? 'revealjs_plugin_markdown', 'enabled')
+    if (node.attr? 'revealjs_plugins') &&
+        !(revealjs_plugins_file = (node.attr 'revealjs_plugins', '').strip).empty? &&
+        !(revealjs_plugins_content = (File.read revealjs_plugins_file).strip).empty?
+      dependencies << revealjs_plugins_content
+    end
+    dependencies.join(",\n      ")
+  end
+
 
   # Between delimiters (--) is code taken from asciidoctor-bespoke 1.0.0.alpha.1
   # Licensed under MIT, Copyright (C) 2015-2016 Dan Allen and the Asciidoctor Project
@@ -113,8 +144,69 @@ module Slim::Helpers
   def resolve_content
     @content_model == :simple ? %(<p>#{content}</p>) : content
   end
-  #--
 
+  # Capture nested template content and register it with the specified key, to
+  # be executed at a later time.
+  #
+  # This method must be invoked using the control code directive (i.e., -). By
+  # using a control code directive, the block is set up to append the result
+  # directly to the output buffer. (Integrations often hide the distinction
+  # between a control code directive and an output directive in this context).
+  #
+  # key   - The Symbol under which to save the template block.
+  # opts  - A Hash of options to control processing (default: {}):
+  #         * :append  - A Boolean that indicates whether to append this block
+  #                      to others registered with this key (default: false).
+  #         * :content - String content to be used if template content is not
+  #                      provided (optional).
+  # block - The template content (in Slim template syntax).
+  #
+  # Examples
+  #
+  #   - content_for :body
+  #     p content
+  #   - content_for :body, append: true
+  #     p more content
+  #
+  # Returns nothing.
+  def content_for key, opts = {}, &block
+    @content = {} unless defined? @content
+    (opts[:append] ? (@content[key] ||= []) : (@content[key] = [])) << (block_given? ? block : lambda { opts[:content] })
+    nil
+  end
+
+  # Checks whether deferred template content has been registered for the specified key.
+  #
+  # key - The Symbol under which to look for saved template blocks.
+  #
+  # Returns a Boolean indicating whether content has been registered for this key.
+  def content_for? key
+    (defined? @content) && (@content.key? key)
+  end
+
+  # Evaluates the deferred template content registered with the specified key.
+  #
+  # When the corresponding content_for method is invoked using a control code
+  # directive, the block is set up to append the result to the output buffer
+  # directly.
+  #
+  # key  - The Symbol under which to look for template blocks to yield.
+  # opts - A Hash of options to control processing (default: {}):
+  #        * :drain - A Boolean indicating whether to drain the key of blocks
+  #                   after calling them (default: true).
+  #
+  # Examples
+  #
+  #   - yield_content :body
+  #
+  # Returns nothing (assuming the content has been captured in the context of control code).
+  def yield_content key, opts = {}
+    if (defined? @content) && (blks = (opts.fetch :drain, true) ? (@content.delete key) : @content[key])
+      blks.map {|b| b.call }.join
+    end
+    nil
+  end
+  #--
 end
 
 # More custom functions can be added in another namespace if required

data/templates/image.html.slim

@@ -13,7 +13,7 @@
   .imageblock(id=@id class=roles
       style=[("text-align: #{attr :align}" if attr? :align),("float: #{attr :float}" if attr? :float)].compact.join('; '))
     - if attr? :link
-      a.image href=(attr :link)
+      a.image href=(attr :link) target=(attr :window) data-preview-link=(bool_data_attr :link_preview)
         img src=image_uri(attr :target) alt=(attr :alt) width=(width) height=(height) style=((attr? :background) ? "background: #{attr :background}" : nil)
     - else
       img src=image_uri(attr :target) alt=(attr :alt) width=(width) height=(height) style=((attr? :background) ? "background: #{attr :background}" : nil)

data/templates/inline_anchor.html.slim

@@ -8,4 +8,5 @@
   a id=@target
   |[#{@target}]
 - else
-  a href=@target class=role target=(attr :window) =@text
+  a href=@target class=role target=(attr :window) data-preview-link=(bool_data_attr :preview)
+    =@text

data/templates/inline_image.html.slim

@@ -5,20 +5,20 @@ span class=[@type,role] style=("float: #{attr :float}" if attr? :float)
     - style_class << "fa-rotate-#{attr :rotate}" if attr? :rotate
     - style_class << "fa-flip-#{attr :flip}" if attr? :flip
     - if attr? :link
-      a.image href=(attr :link) target=(attr :window)
+      a.image href=(attr :link) target=(attr :window) data-preview-link=(bool_data_attr :link_preview)
         i class=style_class title=(attr :title)
     - else
       i class=style_class title=(attr :title)
   - elsif @type == 'icon' && !(@document.attr? :icons)
     - if attr? :link
-      a.image href=(attr :link) target=(attr :window)
+      a.image href=(attr :link) target=(attr :window) data-preview-link=(bool_data_attr :link_preview)
         |[#{attr :alt}]
     - else
       |[#{attr :alt}]
   - else
     - src = (@type == 'icon' ? (icon_uri @target) : (image_uri @target))
     - if attr? :link
-      a.image href=(attr :link) target=(attr :window)
+      a.image href=(attr :link) target=(attr :window) data-preview-link=(bool_data_attr :link_preview)
         img src=src alt=(attr :alt) width=(attr :width) height=(attr :height) title=(attr :title)
     - else
       img src=src alt=(attr :alt) width=(attr :width) height=(attr :height) title=(attr :title)

data/templates/listing.html.slim

@@ -1,6 +1,6 @@
 - nowrap = (option? 'nowrap') || !(document.attr? 'prewrap')
-- syntax_hl = document.syntax_highlighter
 - if @style == 'source'
+  - syntax_hl = document.syntax_highlighter
   - lang = attr :language
   - if syntax_hl
     - doc_attrs = document.attributes

data/templates/section.html.slim

@@ -33,32 +33,42 @@
 - if attr? 'background-color'
   - data_background_color = attr 'background-color'
 
+- parent_section_with_vertical_slides = @level == 1 && !vertical_slides.empty?
+
+- content_for :section
+  section(id=(titleless ? nil : id)
+    class=roles
+    data-transition=(attr 'transition')
+    data-transition-speed=(attr 'transition-speed')
+    data-background-color=data_background_color
+    data-background-image=data_background_image
+    data-background-size=(data_background_size || attr('background-size'))
+    data-background-repeat=(data_background_repeat || attr('background-repeat'))
+    data-background-transition=(data_background_transition || attr('background-transition'))
+    data-background-position=(data_background_position || attr('background-position'))
+    data-background-iframe=(attr "background-iframe")
+    data-background-video=(attr "background-video")
+    data-background-video-loop=((attr? 'background-video-loop') || (option? 'loop'))
+    data-background-video-muted=((attr? 'background-video-muted') || (option? 'muted'))
+    data-background-opacity=(attr "background-opacity")
+    data-state=(attr 'state'))
+    - unless hide_title
+      h2=section_title
+    - if parent_section_with_vertical_slides
+      - unless (_blocks = blocks - vertical_slides).empty?
+        div.slide-content
+          - _blocks.each do |block|
+            =block.convert
+    - else
+      - unless (_content = content.chomp).empty?
+        div.slide-content
+          =_content
+
 / RENDERING
 / render parent section of vertical slides set
-- if @level == 1 && !vertical_slides.empty?
+- if parent_section_with_vertical_slides
   section
-    / TODO: try to get rid of duplication w/ standalone slide section
-    section(id=(titleless ? nil : id)
-      class=roles
-      data-transition=(attr 'transition')
-      data-transition-speed=(attr 'transition-speed')
-      data-background-color=data_background_color
-      data-background-image=data_background_image
-      data-background-size=(data_background_size || attr('background-size'))
-      data-background-repeat=(data_background_repeat || attr('background-repeat'))
-      data-background-transition=(data_background_transition || attr('background-transition'))
-      data-background-position=(data_background_position || attr('background-position'))
-      data-background-iframe=(attr "background-iframe")
-      data-background-video=(attr "background-video")
-      data-background-video-loop=((attr? 'background-video-loop') || (option? 'loop'))
-      data-background-video-muted=((attr? 'background-video-muted') || (option? 'muted'))
-      data-background-opacity=(attr "background-opacity")
-      data-state=(attr 'state'))
-
-      - unless hide_title
-        h2=title
-      - (blocks - vertical_slides).each do |block|
-        =block.convert
+    - yield_content :section
     - vertical_slides.each do |subsection|
       =subsection.convert
 
@@ -69,23 +79,4 @@
     h level=(@level) =title
     =content.chomp
   - else
-    section(id=(titleless ? nil : id)
-      class=roles
-      data-transition=(attr 'transition')
-      data-transition-speed=(attr 'transition-speed')
-      data-background-color=data_background_color
-      data-background-image=data_background_image
-      data-background-size=(data_background_size || attr('background-size'))
-      data-background-repeat=(data_background_repeat || attr('background-repeat'))
-      data-background-transition=(data_background_transition || attr('background-transition'))
-      data-background-position=(data_background_position || attr('background-position'))
-      data-background-iframe=(attr "background-iframe")
-      data-background-video=(attr "background-video")
-      data-background-video-loop=((attr? 'background-video-loop') || (option? 'loop'))
-      data-background-video-muted=((attr? 'background-video-muted') || (option? 'muted'))
-      data-background-opacity=(attr "background-opacity")
-      data-state=(attr 'state'))
-
-      - unless hide_title
-        h2=title
-      =content.chomp
+    - yield_content :section