asciidoctor-revealjs 4.0.1 → 4.1.0.rc2

data/templates/example.html.slim

@@ -1,4 +1,4 @@
-.exampleblock id=@id class=role
+= html_tag('div', { :id => @id, :class => ['exampleblock', role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
   - if title?
     .title=captioned_title
   .content=content

data/templates/helpers.rb

@@ -33,11 +33,11 @@ module Slim::Helpers
   # 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)
+    return false unless attr?(val)
     if attr(val).downcase == 'false' || attr(val) == '0'
-      return 'false'
+      'false'
     else
-      return true
+      true
     end
   end
 
@@ -72,25 +72,52 @@ module Slim::Helpers
   # @yield The block of Slim/HTML code within the tag (optional).
   # @return [String] a rendered HTML element.
   #
-
   def html_tag(name, attributes = {}, content = nil)
     attrs = attributes.inject([]) do |attrs, (k, v)|
-      next attrs if !v || v.nil_or_empty?
+      next attrs unless v && (v == true || !v.nil_or_empty?)
       v = v.compact.join(' ') if v.is_a? Array
       attrs << (v == true ? k : %(#{k}="#{v}"))
     end
     attrs_str = attrs.empty? ? '' : ' ' + attrs.join(' ')
 
-
     if VOID_ELEMENTS.include? name.to_s
       %(<#{name}#{attrs_str}>)
     else
-      content ||= yield if block_given?
+      content ||= (yield if block_given?)
       %(<#{name}#{attrs_str}>#{content}</#{name}>)
     end
   end
 
 
+  #
+  # Extracts data- attributes from the attributes.
+  # @param attributes [Hash] (default: {})
+  # @return [Hash] a Hash that contains only data- attributes
+  #
+  def data_attrs(attributes)
+    # key can be an Integer (for positional attributes)
+    attributes.map { |key, value| (key == 'step') ? ['data-fragment-index', value] : [key, value] }
+              .to_h
+              .select { |key, _| key.to_s.start_with?('data-') }
+  end
+
+
+  #
+  # Wrap an inline text in a <span> element if the node contains a role, an id or data- attributes.
+  # @param content [#to_s] the content; +nil+ to call the block. (default: nil).
+  # @return [String] the content or the content wrapped in a <span> element as string
+  #
+  def inline_text_container(content = nil)
+    data_attrs = data_attrs(@attributes)
+    classes = [role, ('fragment' if (option? :step) || (attr? 'step') || (roles.include? 'step'))].compact
+    if !roles.empty? || !data_attrs.empty? || !@id.nil?
+      html_tag('span', { :id => @id, :class => classes }.merge(data_attrs), (content || (yield if block_given?)))
+    else
+      content || (yield if block_given?)
+    end
+  end
+
+
   ##
   # Returns corrected section level.
   #
@@ -101,6 +128,52 @@ module Slim::Helpers
     @_section_level ||= (sec.level == 0 && sec.special) ? 1 : sec.level
   end
 
+  ##
+  # Display footnotes per slide
+  #
+  @@slide_footnotes = {}
+  @@section_footnotes = {}
+
+  def slide_footnote(footnote)
+    footnote_parent = footnote.parent
+    # footnotes declared on the section title are processed during the parsing/substitution.
+    # as a result, we need to store them to display them on the right slide/section
+    if footnote_parent.instance_of?(::Asciidoctor::Section)
+      footnote_parent_object_id = footnote_parent.object_id
+      section_footnotes = (@@section_footnotes[footnote_parent_object_id] || [])
+      footnote_index = section_footnotes.length + 1
+      attributes = footnote.attributes.merge({ 'index' => footnote_index })
+      inline_footnote = Asciidoctor::Inline.new(footnote_parent, footnote.context, footnote.text, :attributes => attributes)
+      section_footnotes << Asciidoctor::Document::Footnote.new(inline_footnote.attr(:index), inline_footnote.id, inline_footnote.text)
+      @@section_footnotes[footnote_parent_object_id] = section_footnotes
+      inline_footnote
+    else
+      parent = footnote.parent
+      until parent == nil || parent.instance_of?(::Asciidoctor::Section)
+        parent = parent.parent
+      end
+      # check if there is any footnote attached on the section title
+      section_footnotes = parent != nil ? @@section_footnotes[parent.object_id] || [] : []
+      initial_index = footnote.attr(:index)
+      # reset the footnote numbering to 1 on each slide
+      # make sure that if a footnote is used more than once it will use the same index/number
+      slide_index = (existing_footnote = @@slide_footnotes[initial_index]) ? existing_footnote.index : @@slide_footnotes.length + section_footnotes.length + 1
+      attributes = footnote.attributes.merge({ 'index' => slide_index })
+      inline_footnote = Asciidoctor::Inline.new(footnote_parent, footnote.context, footnote.text, :attributes => attributes)
+      @@slide_footnotes[initial_index] = Asciidoctor::Document::Footnote.new(inline_footnote.attr(:index), inline_footnote.id, inline_footnote.text)
+      inline_footnote
+    end
+  end
+
+  def clear_slide_footnotes
+    @@slide_footnotes = {}
+  end
+
+  def slide_footnotes(section)
+    section_object_id = section.object_id
+    section_footnotes = @@section_footnotes[section_object_id] || []
+    section_footnotes + @@slide_footnotes.values
+  end
 
   ##
   # Returns the captioned section's title, optionally numbered.

data/templates/image.html.slim

@@ -10,8 +10,8 @@
   - height = "100%"
 
 - unless attributes[1] == 'background' || attributes[1] == 'canvas'
-  .imageblock(id=@id class=roles
-      style=[("text-align: #{attr :align}" if attr? :align),("float: #{attr :float}" if attr? :float)].compact.join('; '))
+  - inline_style = [("text-align: #{attr :align}" if attr? :align),("float: #{attr :float}" if attr? :float)].compact.join('; ')
+  = html_tag('div', { :id => @id, :class => ['imageblock', role, ('fragment' if (option? :step) || (attr? 'step'))], :style => inline_style }.merge(data_attrs(@attributes)))
     - if 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)

data/templates/inline_anchor.html.slim

@@ -1,12 +1,13 @@
 - case @type
 - when :xref
   - refid = (attr :refid) || @target
-  a href=@target =(@text || @document.references[:ids].fetch(refid, "[#{refid}]")).tr_s("\n", ' ')
+  = html_tag('a', { :href => @target, :class => [role, ('fragment' if (option? :step) || (attr? 'step'))].compact }.merge(data_attrs(@attributes)))
+    =(@text || @document.references[:ids].fetch(refid, "[#{refid}]")).tr_s("\n", ' ')
 - when :ref
-  a id=@target
+  = html_tag('a', { :id => @target }.merge(data_attrs(@attributes)))
 - when :bibref
-  a id=@target
+  = html_tag('a', { :id => @target }.merge(data_attrs(@attributes)))
   |[#{@target}]
 - else
-  a href=@target class=role target=(attr :window) data-preview-link=(bool_data_attr :preview)
+  = html_tag('a', { :href => @target, :class => [role, ('fragment' if (option? :step) || (attr? 'step'))].compact, :target => (attr :window), 'data-preview-link' => (bool_data_attr :preview) }.merge(data_attrs(@attributes)))
     =@text

data/templates/inline_button.html.slim

@@ -1 +1,2 @@
-b.button=@text
+= html_tag('b', { :class => ['button'] }.merge(data_attrs(@attributes)))
+  = @text

data/templates/inline_footnote.html.slim

@@ -1,6 +1,13 @@
+- footnote = slide_footnote(self)
+- index = footnote.attr(:index)
+- id = footnote.id
 - if @type == :xref
-  span.footnoteref
-    | [<a class="footnote" href="#_footnote_#{attr :index}" title="View footnote.">#{attr :index}</a>]
+  = html_tag('sup', { :class => ['footnoteref'] }.merge(data_attrs(footnote.attributes)))
+    | [
+    span(class="footnote" title="View footnote.") = index
+    | ]
 - else
-  span.footnote id=("_footnote_#{@id}" if @id)
-    | [<a id="_footnoteref_#{attr :index}" class="footnote" href="#_footnote_#{attr :index}" title="View footnote.">#{attr :index}</a>]
+  = html_tag('sup', { :id => ("_footnote_#{id}" if id), :class => ['footnote'] }.merge(data_attrs(footnote.attributes)))
+    | [
+    span(class="footnote" title="View footnote.") = index
+    | ]

data/templates/inline_image.html.slim

@@ -1,9 +1,6 @@
-span class=[@type,role] style=("float: #{attr :float}" if attr? :float)
+= html_tag('span', { :class => [@type, role, ('fragment' if (option? :step) || (attr? 'step'))], :style => ("float: #{attr :float}" if attr? :float) }.merge(data_attrs(@attributes)))
   - if @type == 'icon' && (@document.attr? :icons, 'font')
-    - style_class = ["fa fa-#{@target}"]
-    - style_class << "fa-#{attr :size}" if attr? :size
-    - style_class << "fa-rotate-#{attr :rotate}" if attr? :rotate
-    - style_class << "fa-flip-#{attr :flip}" if attr? :flip
+    - style_class = [(attr :set, 'fa'), "fa-#{@target}", ("fa-#{attr :size}" if attr? :size), ("fa-rotate-#{attr :rotate}" if attr? :rotate), ("fa-flip-#{attr :flip}" if attr? :flip)]
     - if attr? :link
       a.image href=(attr :link) target=(attr :window) data-preview-link=(bool_data_attr :link_preview)
         i class=style_class title=(attr :title)

data/templates/inline_kbd.html.slim

@@ -1,7 +1,8 @@
 - if (keys = attr 'keys').size == 1
-  kbd=keys.first
+  = html_tag('kbd', data_attrs(@attributes))
+    = keys.first
 - else
-  span.keyseq
+  = html_tag('span', { :class => ['keyseq'] }.merge(data_attrs(@attributes)))
     - keys.each_with_index do |key, idx|
       - unless idx.zero?
         |+

data/templates/inline_menu.html.slim

@@ -1,15 +1,16 @@
 - menu = attr 'menu'
 - menuitem = attr 'menuitem'
 - if !(submenus = attr 'submenus').empty?
-  span.menuseq
+  = html_tag('span', { :class => ['menuseq'] }.merge(data_attrs(@attributes)))
     span.menu=menu
     | ▸ 
     =submenus.map {|submenu| %(<span class="submenu">#{submenu}</span>&#160;&#9656;&#32;) }.join
     span.menuitem=menuitem
 - elsif !menuitem.nil?
-  span.menuseq
+  = html_tag('span', { :class => ['menuseq'] }.merge(data_attrs(@attributes)))
     span.menu=menu
     |&#160;&#9656;&#32;
     span.menuitem=menuitem
 - else
-  span.menu=menu
+  = html_tag('span', { :class => ['menu'] }.merge(data_attrs(@attributes)))
+    = menu

data/templates/inline_quoted.html.slim

@@ -1,22 +1,14 @@
-- unless @id.nil?
-  a id=@id
-- case @type
-- when :emphasis
-  em class=role =@text
-- when :strong
-  strong class=role =@text
-- when :monospaced
-  code class=role =@text
-- when :superscript
-  sup class=role =@text
-- when :subscript
-  sub class=role =@text
-- when :double
-  =role? ? %(<span class="#{role}">&#8220;#{@text}&#8221;</span>) : %(&#8220;#{@text}&#8221;)
-- when :single
-  =role? ? %(<span class="#{role}">&#8216;#{@text}&#8217;</span>) : %(&#8216;#{@text}&#8217;)
-- when :asciimath, :latexmath
-  - open, close = Asciidoctor::INLINE_MATH_DELIMITERS[@type]
-  |#{open}#{@text}#{close}
+- quote_tags = { emphasis: 'em', strong: 'strong', monospaced: 'code', superscript: 'sup', subscript: 'sup' }
+- if (quote_tag = quote_tags[@type])
+  = html_tag(quote_tag, { :id => @id, :class => [role, ('fragment' if (option? :step) || (attr? 'step'))].compact }.merge(data_attrs(@attributes)), @text)
 - else
-  =role? ? %(<span class="#{role}">#{@text}</span>) : @text
+  - case @type
+  - when :double
+    - inline_text_container("&#8220;#{@text}&#8221;")
+  - when :single
+    = inline_text_container("&#8216;#{@text}&#8217;")
+  - when :asciimath, :latexmath
+    - open, close = Asciidoctor::INLINE_MATH_DELIMITERS[@type]
+    = inline_text_container("#{open}#{@text}#{close}")
+  - else
+    = inline_text_container(@text)

data/templates/listing.html.slim

@@ -8,12 +8,17 @@
     - style = doc_attrs[%(#{syntax_hl.name}-style)]
     - opts = syntax_hl.highlight? ? { css_mode: css_mode, style: style } : {}
     - opts[:nowrap] = nowrap
-  - else
-    - pre_open = %(<pre class="highlight#{nowrap ? ' nowrap' : ''}"><code#{lang ? %[ class="language-#{lang}" data-lang="#{lang}"] : ''}>)
-    - pre_close = '</code></pre>'
-- else
-  - pre_open = %(<pre#{nowrap ? ' class="nowrap"' : ''}>)
-  - pre_close = '</pre>'
-- id_attribute = id ? %( id="#{id}") : ''
-- title_element = title? ? %(<div class="title">#{captioned_title}</div>\n) : ''
-=%(<div#{id_attribute} class="listingblock#{(role = self.role) ? " #{role}" : ''}">#{title_element}<div class="content">#{syntax_hl ? (syntax_hl.format self, lang, opts) : pre_open + (content || '') + pre_close}</div></div>)
+= html_tag('div', { :id => id, :class => ['listingblock', role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
+  - if title?
+    div.title= captioned_title
+  div.content
+    - if syntax_hl
+      = (syntax_hl.format self, lang, opts)
+    - else
+      - if @style == 'source'
+        pre class = ['highlight', ('nowrap' if nowrap)]
+          code class = [("language-#{lang}" if lang)] data-lang = ("#{lang}" if lang)
+            = content || ''
+      - else
+        pre class = [('nowrap' if nowrap)]
+          = content || ''

data/templates/literal.html.slim

@@ -1,4 +1,4 @@
-.literalblock id=@id class=role
+= html_tag('div', { :id => id, :class => ['literalblock', role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
   - if title?
     .title=title
   .content: pre class=(!(@document.attr? :prewrap) || (option? 'nowrap') ? 'nowrap' : nil) =content

data/templates/olist.html.slim

@@ -1,9 +1,9 @@
-.olist id=@id class=[@style,role]
+= html_tag('div', { :id => @id, :class => ['olist', @style, role] }.merge(data_attrs(@attributes)))
   - if title?
     .title=title
   ol class=@style start=(attr :start) type=list_marker_keyword
     - items.each do |item|
-      li class=('fragment' if (option? :step) or (has_role? 'step'))
+      li class=('fragment' if (option? :step) || (has_role? 'step') || (attr? 'step'))
         p=item.text
         - if item.blocks?
           =item.content

data/templates/open.html.slim

@@ -2,17 +2,17 @@
   - if @parent == @document && @document.doctype == 'book'
     - puts 'asciidoctor: WARNING: abstract block cannot be used in a document without a title when doctype is book. Excluding block content.'
   - else
-    .quoteblock.abstract id=@id class=role
+    = html_tag('div', { :id => @id, :class => ['quoteblock', 'abstract', role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
       - if title?
         .title=title
       blockquote=content
 - elsif @style == 'partintro' && (@level != 0 || @parent.context != :section || @document.doctype != 'book')
-  - puts 'asciidoctor: ERROR: partintro block can only be used when doctype is book and it\'s a child of a book part. Excluding block content.' 
+  - puts 'asciidoctor: ERROR: partintro block can only be used when doctype is book and it\'s a child of a book part. Excluding block content.'
 - else
   - if (has_role? 'aside') or (has_role? 'speaker') or (has_role? 'notes')
     include notes.html.slim
   - else
-    .openblock id=@id class=[(@style != 'open' ? @style : nil),role]
+    = html_tag('div', { :id => @id, :class => ['openblock', (@style != 'open' ? @style : nil), role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
       - if title?
         .title=title
       .content=content

data/templates/paragraph.html.slim

@@ -1,4 +1,4 @@
-.paragraph id=@id class=role
+= html_tag('div', { :id => @id, :class => ['paragraph', role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
   - if title?
     .title=title
   - if has_role? 'small'

data/templates/quote.html.slim

@@ -1,4 +1,4 @@
-.quoteblock id=@id class=role
+= html_tag('div', { :id => @id, :class => ['quoteblock', role, ('fragment' if (option? :step) || (attr? 'step'))] }.merge(data_attrs(@attributes)))
   - if title?
     .title=title
   blockquote=content

data/templates/section.html.slim

@@ -30,11 +30,22 @@
 - if attr? 'background-image'
   - data_background_image = image_uri(attr 'background-image')
 
+- if attr? 'background-video'
+  - data_background_video = media_uri(attr 'background-video')
+
 - if attr? 'background-color'
   - data_background_color = attr 'background-color'
 
 - parent_section_with_vertical_slides = @level == 1 && !vertical_slides.empty?
 
+- content_for :footnotes
+  - slide_footnotes = slide_footnotes(self)
+  - if document.footnotes? && !(parent.attr? 'nofootnotes') && !slide_footnotes.empty?
+    .footnotes
+      - slide_footnotes.each do |footnote|
+        .footnote
+          = "#{footnote.index}. #{footnote.text}"
+
 - content_for :section
   section(id=(titleless ? nil : id)
     class=roles
@@ -47,10 +58,11 @@
     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=data_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-autoslide=(attr "autoslide")
     data-state=(attr 'state'))
     - unless hide_title
       h2=section_title
@@ -59,10 +71,15 @@
         div.slide-content
           - _blocks.each do |block|
             =block.convert
+      - yield_content :footnotes
+
     - else
       - unless (_content = content.chomp).empty?
         div.slide-content
           =_content
+      - yield_content :footnotes
+
+    - clear_slide_footnotes
 
 / RENDERING
 / render parent section of vertical slides set

data/templates/sidebar.html.slim

@@ -1,7 +1,7 @@
 - if (has_role? 'aside') or (has_role? 'speaker') or (has_role? 'notes')
   include notes.html.slim
 - else
-  .sidebarblock id=@id class=role
+  = html_tag('div', { :id => @id, :class => ['sidebarblock', role, ('fragment' if (option? :step) || (has_role? 'step') || (attr? 'step'))] }.merge(data_attrs(@attributes)))
     .content
       - if title?
         .title=title

data/templates/stem.html.slim

@@ -4,7 +4,7 @@
   - equation = sub_specialcharacters equation
 - unless (equation.start_with? open) && (equation.end_with? close)
   - equation = %(#{open}#{equation}#{close})
-.stemblock id=@id class=role
+= html_tag('div', { :id => @id, :class => ['stemblock', role, ('fragment' if (option? :step) || (has_role? 'step') || (attr? 'step'))] }.merge(data_attrs(@attributes)))
   - if title?
     .title=title
   .content=equation

data/templates/table.html.slim

@@ -1,5 +1,6 @@
-table(id=@id class=['tableblock',"frame-#{attr :frame, 'all'}","grid-#{attr :grid, 'all'}",role]
-    style=[("width:#{attr :tablepcwidth}%" unless option? 'autowidth'),("float:#{attr :float}" if attr? :float)].compact.join('; '))
+- classes = ['tableblock', "frame-#{attr :frame, 'all'}", "grid-#{attr :grid, 'all'}", role, ('fragment' if (option? :step) || (attr? 'step'))]
+- styles = [("width:#{attr :tablepcwidth}%" unless option? 'autowidth'), ("float:#{attr :float}" if attr? :float)].compact.join('; ')
+= html_tag('table', { :id => @id, :class => classes, :style => styles }.merge(data_attrs(@attributes)))
   - if title?
     caption.title=captioned_title
   - unless (attr :rowcount).zero?

data/templates/ulist.html.slim

@@ -6,16 +6,16 @@
     - if @document.attr? :icons, 'font'
       - marker_checked = '<i class="icon-check"></i>'
       - marker_unchecked = '<i class="icon-check-empty"></i>'
-    - else 
+    - else
       / could use &#9745 (checked ballot) and &#9744 (ballot) w/o font instead
       - marker_checked = '<input type="checkbox" data-item-complete="1" checked disabled>'
       - marker_unchecked = '<input type="checkbox" data-item-complete="0" disabled>'
-.ulist id=@id class=[checklist,@style,role]
+= html_tag('div', { :id => @id, :class => ['ulist', checklist, @style, role] }.merge(data_attrs(@attributes)))
   - if title?
     .title=title
   ul class=(checklist || @style)
     - items.each do |item|
-      li class=('fragment' if (option? :step) || (has_role? 'step'))
+      li class=('fragment' if (option? :step) || (has_role? 'step') || (attr? 'step'))
         p
           - if checklist && (item.attr? :checkbox)
             =%(#{(item.attr? :checked) ? marker_checked : marker_unchecked}#{item.text})