slideshow 0.9.2 → 0.9.3

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 0.9.3 / 2010-07-13
+
+* Added support for pandoc-ruby (for Markdown processing); skip %-filters; break slides using div/h1 rule [Thanks David Sanson]
+
 === 0.9.2 / 2010-07-11
 
 * Change default template pack from s6gradients to s6blank

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/slideshow.rb
 lib/slideshow/config.rb
 lib/slideshow/filters/debug_filter.rb
 lib/slideshow/filters/headers_filter.rb
+lib/slideshow/filters/slide_filter.rb
 lib/slideshow/filters/text_filter.rb
 lib/slideshow/gen.rb
 lib/slideshow/helpers/analytics_helper.rb

data/config/slideshow.builtin.yml

@@ -16,7 +16,7 @@ filters:
   - skip-end-directive
   - directives_bang_style_to_percent_style
   - directives_percent_style
-  - comments-percent-style
+  - comments-percent-style 
   - leading-headers
   - erb-django-style
   - erb-rename-helper-hack
@@ -42,6 +42,7 @@ markdown:
 #  the search order is first come, first serve, that is: rdiscount, rpeg-markdown, maruku, bluecloth, kramdown (fallback, always present)
 
   libs:
+    - pandoc-ruby
     - rdiscount
     - rpeg-markdown
     - maruku

data/lib/slideshow/config.rb

@@ -48,7 +48,7 @@ class Config
   
   def known_markdown_libs
     # returns an array of known markdown engines e.g.
-    # [ rdiscount, rpeg-markdown, maruku, bluecloth, kramdown ]
+    # [ pandoc-ruby, rdiscount, rpeg-markdown, maruku, bluecloth, kramdown ]
     
     (@hash[ 'markdown' ][ 'libs' ] || []) + @hash[ 'builtin' ][ 'markdown' ][ 'libs' ]
   end

data/lib/slideshow/filters/debug_filter.rb

@@ -18,6 +18,23 @@ def dump_content_to_file_debug_text_erb( content )
   content
 end
 
+# use it to dump content before html post processing
+
+def dump_content_to_file_debug_html( content )
+
+  return content   unless logger.level == Logger::DEBUG
+
+  outname = "#{@name}.debug.html"
+
+  puts "  Dumping content before html post processing to #{outname}..."
+
+  File.open( outname, 'w' ) do |f|
+    f.write( content )	
+  end
+
+  content
+end
+
 # use it to dump content before text-to-html conversion
 
 def dump_content_to_file_debug_text( content )

data/lib/slideshow/filters/slide_filter.rb

@@ -0,0 +1,60 @@
+module Slideshow
+  module SlideFilter
+
+# add slide directive before h1 (tells slideshow gem where to break slides)
+#
+# e.g. changes:
+# <h1 id='optional' class='optional'>
+#  to
+# <!-- _S9SLIDE_ -->
+# <h1 id='optional' class='optional'>
+
+def add_slide_directive_before_h1( content )
+
+  # mark h1 for getting wrapped into slide divs
+  # note: use just <h1 since some processors add ids e.g. <h1 id='x'>
+
+  slide_count = 0
+
+  content.gsub!( /<h1/ ) do |match|
+    slide_count += 1
+    "\n<!-- _S9SLIDE_ -->\n#{Regexp.last_match(0)}"
+  end
+  
+  puts "  Adding #{slide_count} slide breaks (using h1 rule)..."
+  
+  content
+end
+
+# add slide directive before div h1 (for pandoc-generated html)
+#
+# e.g. changes:
+# <div id='header'>
+# <h1 id='optional' class='optional'>
+#  to
+# <!-- _S9SLIDE_ -->
+# <div id='header'>
+# <h1 id='optional' class='optional'>
+
+
+def add_slide_directive_before_div_h1( content )
+
+  slide_count = 0
+
+  content.gsub!( /<div[^>]*>\s*<h1/ ) do |match|
+    slide_count += 1
+    "\n<!-- _S9SLIDE_ -->\n#{Regexp.last_match(0)}" 
+  end
+
+  puts "  Adding #{slide_count} slide breaks (using div_h1 rule)..."
+
+  content
+end
+
+  
+end  # module SlideFilter
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::SlideFilter
+end

data/lib/slideshow/filters/text_filter.rb

@@ -15,9 +15,9 @@ def directives_bang_style_to_percent_style( content )
   # get unparsed helpers e.g. SLIDE|STYLE  
   unparsed = config.helper_unparsed.map { |item| item.upcase }.join( '|' )                                                                   
   
-  content.gsub!(/^!(#{unparsed})/) do |match|
+  content.gsub!(/^!(#{unparsed})(.*)$/) do |match|
     bang_count += 1
-    "%#{$1.downcase}"
+    "<%= #{$1.downcase} '#{$2}' %>"
   end
 
   puts "  Patching !-directives (#{bang_count} #{config.helper_unparsed.join('/')}-directives)..."
@@ -27,6 +27,13 @@ end
 
 def directives_percent_style( content )
 
+  # skip filter for pandoc
+  # - pandoc uses % for its own markdown extension
+  # - don't process % pass it along/through to pandoc
+
+  return content  if @markup_type == :markdown && @markdown_libs.first == 'pandoc-ruby'
+    
+    
   directive_unparsed  = 0
   directive_expr      = 0
   directive_block_beg = 0
@@ -88,6 +95,11 @@ end
 
 
 def comments_percent_style( content )    
+
+  # skip filter for pandoc
+  # - pandoc uses % for its own markdown extension
+
+  return content  if @markup_type == :markdown && @markdown_libs.first == 'pandoc-ruby'
     
     # remove comments
     # % comments

data/lib/slideshow/gen.rb

@@ -519,78 +519,93 @@ class Gen
   end
 
   # convert light-weight markup to hypertext
- 
+
   content = text_to_html( content )
- 
+
   # post-processing
 
-  slide_counter = 0
+  # 1) add slide break  
+  
+  if @markup_type == :markdown && @markdown_libs.first == 'pandoc-ruby'
+    content = add_slide_directive_before_div_h1( content )
+  else
+    content = add_slide_directive_before_h1( content )
+  end
+
+  dump_content_to_file_debug_html( content )
+
+  # 2) use generic slide break processing instruction to
+  #   split content into slides
 
-  slides       = []
-  slide_source = ""
+    slide_counter = 0
+
+    slides       = []
+    slide_source = ""
      
-  # wrap h1's in slide divs; note: use just <h1 since some processors add ids e.g. <h1 id='x'>
-  content.each_line do |line|
-     if line.include?( '<h1' ) || line.include?( '<!-- _S9SLIDE_' )  then
-        if slide_counter > 0 then   # found start of new slide (and, thus, end of last slide)
-          slides   << slide_source  # add slide to slide stack
-          slide_source = ""         # reset slide source buffer
-        end
-        slide_counter += 1
-     end
-     slide_source  << line
-  end
+    content.each_line do |line|
+       if line.include?( '<!-- _S9SLIDE_' )  then
+          if slide_counter > 0 then   # found start of new slide (and, thus, end of last slide)
+            slides   << slide_source  # add slide to slide stack
+            slide_source = ""         # reset slide source buffer
+          end
+          slide_counter += 1
+       end
+       slide_source  << line
+    end
   
-  if slide_counter > 0 then
-    slides   << slide_source     # add slide to slide stack
-    slide_source = ""            # reset slide source buffer 
-  end
+    if slide_counter > 0 then
+      slides   << slide_source     # add slide to slide stack
+      slide_source = ""            # reset slide source buffer 
+    end
 
-  ## split slide source into header (optional) and content/body
-  ## plus check for (css style) classes
+    ## split slide source into header (optional) and content/body
+    ## plus check for (css style) classes
 
-  slides2 = []
-  slides.each do |slide_source|
-    slide = Slide.new
+    slides2 = []
+    slides.each do |slide_source|
+      slide = Slide.new
 
-    ## check for css style classes    
-    from = 0
-    while (pos = slide_source.index( /<!-- _S9(SLIDE|STYLE)_(.*?)-->/m, from ))
-      logger.debug "  adding css classes from pi #{$1.downcase}: #{$2.strip}"
+      ## check for css style classes    
+      from = 0
+      while (pos = slide_source.index( /<!-- _S9(SLIDE|STYLE)_(.*?)-->/m, from ))
+        logger.debug "  adding css classes from pi #{$1.downcase}: #{$2.strip}"
 
-      if slide.classes.nil?
-        slide.classes = $2.strip
-      else
-        slide.classes << " #{$2.strip}"
-      end
+        if slide.classes.nil?
+          slide.classes = $2.strip
+        else
+          slide.classes << " #{$2.strip}"
+        end
       
-      from = Regexp.last_match.end(0)
-    end
+        from = Regexp.last_match.end(0)
+      end
        
-    if slide_source =~ /^\s*(<h1.*?>.*?<\/h\d>)\s*(.*)/m  # try to cut off header using non-greedy .+? pattern; tip test regex online at rubular.com
-      slide.header  = $1
-      slide.content = ($2 ? $2 : "")
-      logger.debug "  adding slide with header:\n#{slide.header}"
-    else
-      slide.content = slide_source
-      logger.debug "  adding slide with *no* header:\n#{slide.content}"
+       # try to cut off header using non-greedy .+? pattern; tip test regex online at rubular.com
+       #  note/fix: needs to get improved to also handle case for h1 wrapped into div
+       #    (e.g. extract h1 - do not assume it starts slide source)
+      if slide_source =~ /^\s*(<h1.*?>.*?<\/h\d>)\s*(.*)/m 
+        slide.header  = $1
+        slide.content = ($2 ? $2 : "")
+        logger.debug "  adding slide with header:\n#{slide.header}"
+      else
+        slide.content = slide_source
+        logger.debug "  adding slide with *no* header:\n#{slide.content}"
+      end
+      slides2 << slide
     end
-    slides2 << slide
-  end
 
-   # for convenience create a string w/ all in-one-html
-   #  no need to wrap slides in divs etc.
+     # for convenience create a string w/ all in-one-html
+     #  no need to wrap slides in divs etc.
    
-   content2 = ""
-   slides2.each do |slide|         
-      content2 << slide.to_classic_html
-   end
+     content2 = ""
+     slides2.each do |slide|         
+        content2 << slide.to_classic_html
+     end
    
-  # make content2 and slide2 available to erb template
-  # -- todo: cleanup variable names and use attr_readers for content and slide
+    # make content2 and slide2 available to erb template
+    # -- todo: cleanup variable names and use attr_readers for content and slide
   
-  @slides   = slides2     # strutured content 
-  @content  = content2   # content all-in-one
+    @slides   = slides2     # strutured content 
+    @content  = content2   # content all-in-one
 
 
   manifest.each do |entry|

data/lib/slideshow/markdown.rb

@@ -1,6 +1,11 @@
 module Slideshow
   module MarkdownEngines
 
+  def pandoc_ruby_to_html( content )
+    content = PandocRuby.new( content, :from => :markdown, :to => :html ).convert
+    content.gsub( /class="incremental"/, 'class="step"' )
+  end
+
   def rdiscount_to_html( content )
     RDiscount.new( content ).to_html
   end

data/lib/slideshow.rb

@@ -46,11 +46,12 @@ require 'slideshow/helpers/syntax/sh_helper'
 require 'slideshow/filters/headers_filter'
 require 'slideshow/filters/text_filter'
 require 'slideshow/filters/debug_filter'
+require 'slideshow/filters/slide_filter'
 
 
 module Slideshow
 
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 
   # version string for generator meta tag (includes ruby version)
   def Slideshow.generator

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slideshow
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: false
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-11 00:00:00 +02:00
+date: 2010-07-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,7 @@ files:
 - lib/slideshow/config.rb
 - lib/slideshow/filters/debug_filter.rb
 - lib/slideshow/filters/headers_filter.rb
+- lib/slideshow/filters/slide_filter.rb
 - lib/slideshow/filters/text_filter.rb
 - lib/slideshow/gen.rb
 - lib/slideshow/helpers/analytics_helper.rb