slideshow 0.8.5 → 0.9

data/{History.txt → History.rdoc}

@@ -1,3 +1,15 @@
+=== 0.9  / 2010-07-04
+
+* Added support for !SLIDE (and alternative syntax %slide)
+* Added support for comments using %, %begin/%end and %end
+* Added more helpers (step, google_analytics, left/right for two-column layouts)
+* Added support for Django-style expressions and statements as an alternative to <% %>
+* Added support for configuring text filters in slideshow.yml
+* Added support for configuring Markdown engines in slideshow.yml
+* Added fetch shortcuts (configure in slideshow.yml)
+* Added support for template manifests w/o .txt extensions 
+* Removed old options -s5,--fullerscreen (use -t s5blank or -t fullerscreen instead) 
+
 === 0.8.5  / 2010-06-25
 
 * Added workaround for RedCloth 4 (Java-only) multi-byte character bug 

data/Manifest.txt

@@ -1,33 +1,27 @@
-History.txt
+History.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 bin/slideshow
+config/slideshow.builtin.yml
+config/slideshow.yml
 lib/slideshow.rb
+lib/slideshow/config.rb
+lib/slideshow/filters/headers_filter.rb
+lib/slideshow/filters/text_filter.rb
 lib/slideshow/gen.rb
+lib/slideshow/helpers/analytics_helper.rb
 lib/slideshow/helpers/capture_helper.rb
 lib/slideshow/helpers/coderay_helper.rb
+lib/slideshow/helpers/step_helper.rb
+lib/slideshow/helpers/table_helper.rb
 lib/slideshow/helpers/text_helper.rb
 lib/slideshow/helpers/uv_helper.rb
+lib/slideshow/markdown.rb
 lib/slideshow/opts.rb
-templates/fullerscreen.txt
-templates/fullerscreen.txt.gen
-templates/fullerscreen.txt.sample
-templates/fullerscreen/footer.html.erb
-templates/fullerscreen/header.html.erb
-templates/fullerscreen/style.css.erb
+lib/slideshow/slide.rb
+lib/slideshow/textile.rb
 templates/gradient.svg.erb
-templates/s5.txt
-templates/s5.txt.gen
-templates/s5.txt.sample
-templates/s5/footer.html.erb
-templates/s5/header.html.erb
-templates/s5/opera.css
-templates/s5/outline.css
-templates/s5/print.css
-templates/s5/s5-core.css
-templates/s5/slides.js
-templates/s5/style.css.erb
 templates/s6.txt
 templates/s6.txt.gen
 templates/s6.txt.sample

data/{README.txt → README.rdoc}

@@ -1,6 +1,4 @@
-= slideshow
-
-Slide Show (S9) - A Free Web Alternative to PowerPoint and KeyNote in Ruby
+= Slide Show (S9) - A Free Web Alternative to PowerPoint and KeyNote in Ruby
 
 * http://slideshow.rubyforge.org
 
@@ -15,10 +13,8 @@ The Slide Show (S9) project also collects and welcomes themes and ships
 
   Usage: slideshow [options] name
     -o, --output PATH                Output Path
-    -g, --generate                   Generate Slide Show Templates
+    -g, --generate                   Generate Slide Show Templates (Using Built-In S6 Pack)
     -t, --template MANIFEST          Template Manifest
-        --s5                         S5-Compatible Slide Show (same as -t s5.txt)
-        --fullerscreen               FullerScreen-Compatible Slide Show (same as -t fullerscreen.txt)
     -f, --fetch URI                  Fetch Templates
     -c, --config PATH                Configuration Path (default is ~/.slideshow)
     -l, --list                       List Installed Templates
@@ -27,28 +23,27 @@ The Slide Show (S9) project also collects and welcomes themes and ships
 
 Examples:
 
-  slideshow microformats
-  slideshow microformats.textile
+  slideshow microformats                
+  slideshow microformats.textile         # Process slides using Textile
+  slideshow microformats.text            # Process slides using Markdown
+
   slideshow -o slides microformats       # Output slideshow to slides folder
-  slideshow --s5 microformats            # Use S5-compatible slide show templates
-  slideshow --fullerscreen microformats  # Use FullerScreen-compatible slide show templates
 
 More examles:
 
-  slideshow -g                           # Generate slide show templates
-  slideshow -g --s5                      # Generate S5 compatible slide show templates
-  slideshow -g --fullerscreen            # Generate FullerScreen compatible slide show templates
+  slideshow -g                           # Generate slide show templates using built-in S6 pack
 
   slideshow -l                           # List installed slide show templates
   slideshow -f s5blank                   # Fetch (install) S5 blank starter template from internet
-  slideshow -t s5blank.txt microformats  # Use your own slide show templates (e.g. s5blank.txt)
+  slideshow -t s5blank.txt microformats  # Use your own slide show templates (e.g. s5blank)
 
 
 == REQUIREMENTS:
 
 * RedCloth (Textile Markup)
-* BlueCloth (Markdown Markup)
+* Kramdown (Markdown Markup)
 
+* BlueCloth (Markdown Markup) [Optional]
 * RDiscount (Markdown Markup) [Optional]
 * Coderay (Syntax Highlighting) [Optional]
 * Ultraviolet (Syntax Highlighting) [Optional]

data/Rakefile

@@ -13,8 +13,12 @@ Hoe.spec 'slideshow' do
   
   self.extra_deps = [
     ['RedCloth','>= 4.0.0'],
-    ['kramdown','>= 0.8.0']
+    ['kramdown','>= 0.9.0']
   ]
   
-  self.remote_rdoc_dir = 'doc' 
+  self.remote_rdoc_dir = 'doc'
+  
+  # switch extension to .rdoc for gihub formatting
+  self.readme_file  = 'README.rdoc'
+  self.history_file = 'History.rdoc'
 end

data/bin/slideshow

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'slideshow'
+
 Slideshow.main

data/config/slideshow.builtin.yml

@@ -0,0 +1,42 @@
+### builtin configuration for arrays
+#
+#  access or overwrite using nested builtin context e.g.
+#  builtin:
+#    textile:
+#        libs: [ whatever ]
+
+
+# text filters
+
+filters:
+  - comments-percent-style
+  - leading-headers
+  - skip-end-directive
+  - erb-django-style
+  - include-helper-hack
+  - erb
+  - code-block-curly-style
+
+
+# markup (textile, markdown) config
+    
+textile:
+  extnames: [ .textile, .t ]
+  
+markdown:
+  extnames: [ .markdown, .m, .mark, .mkdn, .md, .txt, .text ]
+
+# note: only kramdown is listed as a dependency in gem specs (because it's Ruby only and, thus, easy to install)
+#  if you want to use other markdown libs install the required/desired lib e.g.
+#  use  gem install rdiscount for rdiscount and so on
+#
+# also note for now the first present markdown library gets used
+#  the search order is first come, first serve, that is: rdiscount, rpeg-markdown, maruku, bluecloth, kramdown (fallback, always present)
+
+  libs:
+    - rdiscount
+    - rpeg-markdown
+    - maruku
+    - bluecloth
+    - kramdown
+    

data/config/slideshow.yml

@@ -0,0 +1,67 @@
+# built-in slideshow configuration
+#
+# override settings in:
+#  ~/.slideshow/slideshow.yml
+# or
+#  ./slideshow.yml or ./.slideshow.yml
+
+#lets you define default/fallback headers
+
+headers:
+  generator: <%= Slideshow.generator %> 
+  author:  Your Name Here
+  email:   Your Email Here
+  company: Your Company Here
+  title:   Your Title Here
+  subtitle: Your Subtitle Here
+  footer: Your Footer Here
+  subfooter: Your Subfooter Here 
+  date:  <%= Date.today %>
+
+  # todo: use nested config?? eg.
+  # gradient:
+  #   theme: dark
+  #   color1:
+  gradient-theme:  dark
+  gradient-color1:  red
+  gradient-color2:  black
+
+  # todo: use nested config??
+  #
+  # ultraviolet (uv) | coderay (cr) 
+  code-engine:  uv
+  # Text Mate Hyperlink for Source?
+  code-txmt:  false
+  # todo: add code-linenumbers??
+
+
+
+# shortcuts for fetching template packs
+#   map shortcut to URI
+    
+fetch:
+    s6blank: http://github.com/geraldb/slideshow-s6-blank/raw/master/s6blank.txt
+    s5blank: http://github.com/geraldb/slideshow-s5-blank/raw/master/s5blank.txt
+    s5themes: http://github.com/geraldb/slideshow-s5-themes/raw/master/s5themes.txt
+    fullerscreen: http://github.com/geraldb/slideshow-fullerscreen/raw/master/fullerscreen.txt
+    slidy: http://github.com/geraldb/slideshow-slidy/raw/master/slidy.txt
+    g5: http://github.com/geraldb/slideshow-google-html5-slides/raw/master/g5.txt
+    slippy: http://github.com/geraldb/slideshow-slippy/raw/master/slippy.txt
+  
+# your google analytics code  
+analytics:
+    google: UA-XXX
+    
+
+### markup (textile, markdown) config
+
+# filters to run before markup processing
+filters: []
+    
+textile:
+  extnames: []  
+  
+markdown:
+  extnames: []
+  libs:     []
+  

data/lib/slideshow.rb

@@ -1,7 +1,7 @@
 $KCODE = 'utf'
 
 LIB_PATH = File.expand_path( File.dirname(__FILE__) )
-$:.unshift(LIB_PATH) 
+$LOAD_PATH.unshift(LIB_PATH) 
 
 # core and stlibs
 require 'optparse'
@@ -12,19 +12,42 @@ require 'pp'
 require 'uri'
 require 'net/http'
 require 'ostruct'
+require 'date'
+require 'yaml'
 
 # required gems
 require 'redcloth'  # default textile library
 require 'kramdown'  # default markdown library
 
 
-# own code
+# our own code
 require 'slideshow/opts'
+require 'slideshow/config'
 require 'slideshow/gen'
+require 'slideshow/slide'
+require 'slideshow/textile'
+require 'slideshow/markdown'
+
+# load built-in (required) helpers/plugins
+require 'slideshow/helpers/text_helper'
+require 'slideshow/helpers/capture_helper'
+require 'slideshow/helpers/analytics_helper'
+require 'slideshow/helpers/table_helper'
+require 'slideshow/helpers/step_helper'
+
+# load built-in filters
+require 'slideshow/filters/headers_filter'
+require 'slideshow/filters/text_filter'
+
 
 module Slideshow
 
-  VERSION = '0.8.5'
+  VERSION = '0.9'
+
+  # version string for generator meta tag (includes ruby version)
+  def Slideshow.generator
+    "Slide Show (S9) #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
 
   def Slideshow.main
     
@@ -41,10 +64,6 @@ module Slideshow
 
 end # module Slideshow
 
-# load built-in (required) helpers/plugins
-require 'slideshow/helpers/text_helper.rb'
-require 'slideshow/helpers/capture_helper.rb'
-
 # load built-in (optional) helpers/plugins
 #   If a helper fails to load, simply ingnore it
 #   If you want to use it install missing required gems e.g.:

data/lib/slideshow/config.rb

@@ -0,0 +1,88 @@
+module Slideshow
+
+class Config
+  
+  def initialize
+    @hash = {}
+  end
+
+  def []( key )
+    value = @hash[ normalize_key( key ) ]
+    if value.nil?
+      puts "** Warning: config key '#{key}' undefined (returning nil)"
+    end
+    
+    value
+  end
+
+  def load   
+    # load builtin config file @  <gem>/config/slideshow.yml
+    config_file         = "#{File.dirname( LIB_PATH )}/config/slideshow.yml"
+    config_builtin_file = "#{File.dirname( LIB_PATH )}/config/slideshow.builtin.yml"
+
+    # run through erb        
+    config_txt = File.read( config_file )
+    config_txt = ERB.new( config_txt ).result( binding() )
+    
+    @hash = YAML.load( config_txt )
+    
+    # for now builtin has no erb processing; add builtin hash to main hash 
+    @hash[ 'builtin' ] = YAML.load_file( config_builtin_file )
+  end
+
+  
+  def known_textile_extnames
+    # returns an array of known file extensions e.g.
+    # [ '.textile', '.t' ]
+    #
+    # using nested key
+    # textile:
+    #   extnames:  [ .textile, .t ]
+    
+    @hash[ 'textile' ][ 'extnames' ] + @hash[ 'builtin' ][ 'textile' ][ 'extnames' ] 
+  end
+
+  def known_markdown_extnames
+    @hash[ 'markdown' ][ 'extnames' ] + @hash[ 'builtin' ][ 'markdown' ][ 'extnames' ]   
+  end
+  
+  def known_markdown_libs
+    # returns an array of known markdown engines e.g.
+    # [ rdiscount, rpeg-markdown, maruku, bluecloth, kramdown ]
+    
+    @hash[ 'markdown' ][ 'libs' ] + @hash[ 'builtin' ][ 'markdown' ][ 'libs' ]
+  end
+
+  def known_extnames
+    # ruby check: is it better self. ?? or more confusing
+    #  possible conflict only with write access (e.g. prop=) 
+    
+    known_textile_extnames + known_markdown_extnames
+  end
+  
+  def text_filters
+    @hash[ 'builtin' ][ 'filters' ] + @hash[ 'filters' ] 
+  end
+
+  def google_analytics_code
+    @hash[ 'analytics' ][ 'google' ]
+  end
+  
+  def map_fetch_shortcut( key )
+    @hash[ 'fetch' ][ key ]
+  end
+  
+private
+
+  def normalize_key( key )
+    #  make key all lower case/downcase (e.g. Content-Type  => content-type)
+    #  replace _ with -                 (e.g. gradient_color => gradient-color)
+    #  todo: replace space(s) with -  ??
+    #  todo: strip leading and trailing spaces - possible use case ??
+    
+    key.to_s.downcase.tr( '_', '-' )
+  end
+
+end # class Config
+
+end # module Slideshow

data/lib/slideshow/filters/headers_filter.rb

@@ -0,0 +1,45 @@
+module HeadersFilter
+
+def leading_headers( content_with_headers )
+  
+  # todo: read headers before command line options (lets you override options using commandline switch)?
+  
+  # read source document; split off optional header from source
+  # strip leading optional headers (key/value pairs) including optional empty lines
+
+  read_headers = true
+  content = ""
+
+  headers = [] # track header keys for stats
+  
+  content_with_headers.each_line do |line|
+    if read_headers && line =~ /^\s*(\w[\w-]*)[ \t]*:[ \t]*(.*)/
+      key = $1.downcase
+      value = $2.strip
+      
+      headers << key
+    
+      logger.debug "  adding option: key=>#{key}< value=>#{value}<"
+      opts.put( key, value )
+    elsif line =~ /^\s*$/
+      content << line  unless read_headers
+    else
+      read_headers = false
+      content << line
+    end
+  end
+
+  # fix: do a merge w/ config instead, possible??
+  opts.set_defaults  
+
+  puts "  Reading #{headers.length} headers: #{headers.join(', ')}..."
+
+  content  
+end
+  
+end  # module HeadersFilter
+
+
+class Slideshow::Gen
+  include HeadersFilter
+end