deckrb 0.4.2 → 0.5.0

data/README.md

@@ -54,7 +54,8 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
   * links to image files are resolved relative to the source file -- no more broken images in markdown previews, and no need to put all your images in a separate directory!
   * add CSS classes to slides inside the slide directive - - e.g. `<!SLIDE center>` gives `<section class="slide center">`
   * generated HTML is pretty-printed for easier "view source"
-* uses deck.js' "swiss" theme and several extensions, including `goto`, `menu`, `navigation`, `status`, `hash`,  and `scale`
+* uses deck.js' "swiss" and "horizontal-slide" themes (configurable)
+* uses several deck.js extensions, including `goto`, `menu`, `navigation`, `status`, `hash`,  and `scale`
 * uses RedCarpet markdown extensions, including
   * tables <http://michelf.com/projects/php-markdown/extra/#table>
   * fenced code blocks <http://michelf.com/projects/php-markdown/extra/#fenced-code-blocks>
@@ -63,8 +64,9 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 * code syntax highlighting using Coderay
   * specify language at the top of the block using either ::: or @@@
   * e.g. `@@@ ruby`
-* there's a simple table of contents (click the [toc] link on lower left to toggle)
+* there's a simple table of contents (click the [contents] link on lower left to toggle)
   * this is currently very primitive and should be redone and/or integrated into deck.js
+* lines beginning with `.notes ` are skipped
 
 ## Command-Line API
 
@@ -77,10 +79,30 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 
 ### Options
 
-    --port, -p <i>:   Specify alternate port (default: 4333)
-       --build, -b:   Build an HTML file instead of launching a server (WARNING: not very useful yet)
-     --version, -v:   Print version and exit
-        --help, -h:   Show this message
+            --port, -p <i>:   Specify alternate port (default: 4333)
+               --build, -b:   Build an HTML file instead of launching a server (WARNING: not very useful yet)
+           --style, -s <s>:   Specify the style theme from deck.js/themes/style/ (default: swiss)
+      --transition, -t <s>:   Specify the transition theme from deck.js/themes/transition/ (default: horizontal-slide)
+             --version, -v:   Print version and exit
+                --help, -h:   Show this message
+
+## Themes
+
+`deck.js` has several themes for styling and animating your presentation.
+You can select these from the command line or from a `showoff.json` file with the `style` and `transition` options.
+Currently the following themes are available:
+
+### Style Themes
+
+* neon
+* swiss
+* web-2.0
+
+### Transition Themes
+
+* fade
+* horizontal-slide
+* vertical-slide
 
 ## Deploying to Heroku
 
@@ -101,20 +123,24 @@ and a `Gemfile` like this:
 
 Then deploy to Heroku as usual (e.g. `heroku apps:create`).
 
-(Note that Deck::RackApp can accept either a filename or an array of filenames.)
+Note that `Deck::RackApp.build` can accept either a filename or an array of filenames.
+It also accepts options, e.g.
+
+    run Deck::RackApp.build('slides.md', transition: 'fade')
+
 
 ## Known Issues (Bugs and Limitations)
 
 * If you're running Webrick, you may not be able to kill the server with Ctrl-C. This is apparently due to a bug in recent versions of Webrick.
   * Workaround: `gem install thin` -- if thin is installed, deck will use it instead of webrick
-* auxiliary files (e.g. images) are interleaved in URL path space, so overlapping file names might not resolve to the right file
+* Auxiliary files (e.g. images) are interleaved in URL path space, so overlapping file names might not resolve to the right file.
   * todo: rewrite internal links to files and serve them relative to current dir, not slide dir
 * H1s (which split slides) are converted to H2s for compatibility with deck.js's CSS themes
   * unless they're the only item on the slide, in which case they remain H1s
-* we use RedCarpet to process markdown, which doesn't work exactly the same as RDiscount... for example:
+* We use RedCarpet to process markdown, which doesn't work exactly the same as RDiscount... for example:
   * indented code blocks under a bullet point may need to be indented more
   * code blocks must be separated from the previous text by a newline
-* slide scaling isn't perfect; sometimes either resizing or reloading will improve the layout
+* Slide scaling isn't perfect; sometimes either resizing or reloading will improve the layout.
 
 Report bugs on <http://github.com/alexch/deck.rb/issues>
 
@@ -123,6 +149,8 @@ Report bugs on <http://github.com/alexch/deck.rb/issues>
 * deck.js by Caleb at <http://imakewebthings.com>
 * deck.rb by Alex Chaffee <http://alexchaffee.com>, with help from
   * Steven! Ragnarök <http://nuclearsandwich.com>
+  * David Doolin <http://dool.in>
+  * and other awesome patchers
 
 ### See Also
 

data/bin/deck

@@ -8,6 +8,7 @@ require "rack"
 require "deck"
 require "deck/rack_app"
 require "deck/version"
+require "thin" # i hate webrick
 
 options = Trollop.options do
   version "deck v#{Deck::VERSION}"
@@ -16,9 +17,11 @@ options = Trollop.options do
   banner "(see http://github.com/alexch/deck.rb README for more help)"
   opt :port, "Specify alternate port", :default => 4333
   opt :build, "Build an HTML file instead of launching a server (WARNING: not very useful yet)"
+  opt :style, "Specify the style theme from deck.js/themes/style/", default: "swiss"
+  opt :transition, "Specify the transition theme from deck.js/themes/transition/", default: "horizontal-slide"
 end
 
-if options[:build]
+if options.delete(:build)
   slides = []
   output_path = nil
   output_dir = "."  # for now, since deck.js is relative to the project root
@@ -31,14 +34,18 @@ if options[:build]
   end
 
   File.open(output_path, "w") do |file|
-    deck = Deck::SlideDeck.new :slides => slides
+    deck = Deck::SlideDeck.new :slides => slides  #todo: pass theme options
     # deck.to_pretty(:output => file)  # todo: figure out why this doesn't work
     file.write deck.to_pretty
   end
 
 else
 
-  port = options[:port]
+  port = options.delete(:port)
   slide_files = ARGV
-  Rack::Handler.default.run Deck::RackApp.build(slide_files), :Port => port
+  options = {
+      style: options[:style],
+      transition: options[:transition],
+  }
+  Rack::Handler.default.run Deck::RackApp.build(slide_files, options), :Port => port
 end

data/lib/deck/rack_app.rb

@@ -1,5 +1,3 @@
-here = File.expand_path File.dirname(__FILE__)
-
 require 'json'
 require 'coderay'
 require 'rack/codehighlighter'
@@ -16,12 +14,8 @@ module Deck
       Rack::File.new("#{app_root}/public")
     end
 
-    def self.build slide_files
-      if const_defined?(:Thin)
-        if require "thin/logging"
-          Thin::Logging.debug = true
-        end
-      end
+    def self.build slide_files, options = {}
+      enable_thin_logging()
 
       Rack::Builder.app do
         use Rack::ShowExceptions
@@ -30,25 +24,24 @@ module Deck
           :element => "pre>code",
           :markdown => true,
           :pattern => /\A[:@]{3}\s?(\w+)\s*(\n|
)/i
-        run ::Deck::RackApp.new(slide_files)
+        run ::Deck::RackApp.new(slide_files, options)
+      end
+    end
+
+    def self.enable_thin_logging
+      if const_defined?(:Thin)
+        if require "thin/logging"
+          Thin::Logging.debug = true
+        end
       end
     end
 
-    def initialize slide_files
+    def initialize slide_files, options = {}
+      @options = options
       @slide_files = [slide_files].flatten.map do |slide_file|
         case slide_file
         when /\/?showoff(.*)\.json$/
-          json_file_dir = File.expand_path(File.dirname(slide_file))
-          json_file = slide_file
-          config = JSON.parse(File.read(json_file))
-          config['sections'].map do |markdown_file|
-            if markdown_file =~ /^# /   # you can use literal markdown instead of a file name
-              s = Slide.split(markdown_file)
-              s
-            else
-              File.new(json_file_dir + '/' + markdown_file)
-            end
-          end
+          parse_showoff_json(slide_file)
         else
           File.new(slide_file)
         end
@@ -63,6 +56,33 @@ module Deck
         end
     end
 
+    def parse_showoff_json(slide_file)
+      json_file_dir = File.expand_path(File.dirname(slide_file))
+      json_file = slide_file
+      config = JSON.parse(File.read(json_file))
+      extract_options(config)
+      extract_slides(config, json_file_dir)
+    end
+
+    def extract_slides(config, json_file_dir)
+      config['sections'].map do |markdown_file|
+        if markdown_file =~ /^# / # you can use literal markdown instead of a file name
+          s = Slide.split(markdown_file)
+          s
+        else
+          File.new(json_file_dir + '/' + markdown_file)
+        end
+      end
+    end
+
+    def extract_options(config)
+      ["style", "transition"].each do |key|
+        if config[key] and !@options[key.to_sym]
+          @options[key.to_sym] = config[key]
+        end
+      end
+    end
+
     def call env
       request = Rack::Request.new(env)
       if request.path == "/"
@@ -78,7 +98,7 @@ module Deck
     end
 
     def deck
-      SlideDeck.new :slides => slides
+      SlideDeck.new({:slides => slides}.merge(@options))
     end
 
     def slides

data/lib/deck/slide.rb

@@ -35,6 +35,9 @@ module Deck
         slides << (slide = Slide.new)
         slide << line
 
+      elsif line =~ /^\.notes/
+        # don't include notes
+
       else
         slide << line
       end
@@ -107,16 +110,14 @@ module Deck
   end
 
   def title
-    lines = @markdown_text.split("\n")
+    lines = @markdown_text.strip.split("\n")
     raise "an empty slide has no id" if lines.empty?
     lines.first.gsub(/^[#=]*/, '').strip
   end
 
   def slide_id
     @slide_id ||= begin
-      lines = @markdown_text.split("\n")
-      raise "an empty slide has no id" if lines.empty?
-      lines.first.downcase.gsub(/[^\w\s]/, '').strip.gsub(/\s/, '_')
+      title.downcase.gsub(/[^\w\s]/, '').strip.gsub(/\s/, '_')
     end
   end
 

data/lib/deck/slide_deck.rb

@@ -4,31 +4,34 @@ require 'redcarpet'
 require "deck/slide"
 
 module Deck
- class SlideDeck < Erector::Widgets::Page
-  needs :title => "deck.rb presentation",
-    :description => nil,
-    :author => nil
-  needs :extensions => [
-      'goto',
-      'menu',
-      'navigation',
-      'status',
-      'hash',
-      'scale',
-      # 'theme-picker',
+  class SlideDeck < Erector::Widgets::Page
+    needs :title => "deck.rb presentation",
+          :description => nil,
+          :author => nil
+    needs :extensions => [
+        'goto',
+        'menu',
+        'navigation',
+        'status',
+        'hash',
+        'scale',
     ]
-  needs :slides => nil
-  attr_reader :extensions
+    needs :slides => nil
 
-  def page_title
-    @title
-  end
+    needs :style => "swiss"
+    needs :transition => "horizontal-slide"
 
-  # todo: promote into Text
-  # todo: support numbers a la '&#1234;'
-  def entity entity_id
-    raw("&#{entity_id};")
-  end
+    attr_reader :extensions
+
+    def page_title
+      @title
+    end
+
+    # todo: promote into Text
+    # todo: support numbers a la '&#1234;'
+    def entity entity_id
+      raw("&#{entity_id};")
+    end
 
 # left over from deck.js' introduction/index.html
 
@@ -38,155 +41,159 @@ module Deck
 # <!--[if IE 8]>    <html class="no-js ie8" lang="en"> <![endif]-->
 # <!--[if gt IE 8]><!-->  <html class="no-js" lang="en"> <!--<![endif]-->
 
-  # todo: promote into Page
-  def stylesheet src, attributes = {}
-    link({:rel => "stylesheet", :href => src}.merge(attributes))
-  end
-
-  def public_asset path
-    "/#{path}"
-  end
-
-  def head_content
-    super
-    meta 'charset' => 'utf-8'
-    meta 'http-equiv'=>"X-UA-Compatible", 'content'=>"IE=edge,chrome=1"
-    meta :name => "viewport", :content=> "width=1024, user-scalable=no"
-    meta :name => "description", :content=> @description if @description
-    meta :name => "author", :content=> @author if @author
+# todo: promote into Page
+    def stylesheet src, attributes = {}
+      link({:rel => "stylesheet", :href => src}.merge(attributes))
+    end
 
-    #  <!-- Core and extension CSS files -->
-    stylesheet public_asset("deck.js/core/deck.core.css")
-    extensions.each do |extension|
-      stylesheet public_asset("deck.js/extensions/#{extension}/deck.#{extension}.css")
+    def public_asset path
+      "/#{path}"
     end
 
-    # <!-- Theme CSS files (menu swaps these out) -->
-    stylesheet public_asset("deck.js/themes/style/swiss.css"), :id=>"style-theme-link"
+    def head_content
+      super
+      meta 'charset' => 'utf-8'
+      meta 'http-equiv' => "X-UA-Compatible", 'content' => "IE=edge,chrome=1"
+      meta :name => "viewport", :content => "width=1024, user-scalable=no"
+      meta :name => "description", :content => @description if @description
+      meta :name => "author", :content => @author if @author
+
+      #  <!-- Core and extension CSS files -->
+      stylesheet public_asset("deck.js/core/deck.core.css")
+      extensions.each do |extension|
+        stylesheet public_asset("deck.js/extensions/#{extension}/deck.#{extension}.css")
+      end
 
-    stylesheet public_asset("coderay.css")
-    stylesheet public_asset("tables.css")
-    stylesheet public_asset("toc.css")
-  end
+      # <!-- Theme CSS files -->
+      stylesheet public_asset("deck.js/themes/style/#{@style}.css"), :id => "style-theme-link"
+      stylesheet public_asset("deck.js/themes/transition/#{@transition}.css"), :id => "transition-theme-link"
+
+      stylesheet public_asset("coderay.css")
+      stylesheet public_asset("tables.css")
+      stylesheet public_asset("toc.css")
+    end
 
-  def scripts
-    script :src => public_asset("deck.js/modernizr.custom.js")
+    def scripts
+      script :src => public_asset("deck.js/modernizr.custom.js")
 
-    # comment 'Grab CDN jQuery, with a protocol relative URL; fall back to local if offline'
-    # script :src => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.min.js'
-    script :src => public_asset('deck.js/jquery-1.7.min.js')
+      # comment 'Grab CDN jQuery, with a protocol relative URL; fall back to local if offline'
+      # script :src => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.2.min.js'
+      script :src => public_asset('deck.js/jquery-1.7.2.min.js')
 
-    jquery <<-JAVASCRIPT
+      jquery <<-JAVASCRIPT
     $('.slide_toc .toggle').click(function(){
-      $('.slide_toc ul').toggle();
+      $('.slide_toc .table').toggle();
     });
-    JAVASCRIPT
+      JAVASCRIPT
 
-    comment 'Deck Core and extensions'
-    script :type => "text/javascript", :src => public_asset('deck.js/core/deck.core.js')
+      comment 'Deck Core and extensions'
+      script :type => "text/javascript", :src => public_asset('deck.js/core/deck.core.js')
 
-    extensions.each do |extension|
-      script :type => "text/javascript", :src => public_asset("deck.js/extensions/#{extension}/deck.#{extension}.js")
-    end
+      extensions.each do |extension|
+        script :type => "text/javascript", :src => public_asset("deck.js/extensions/#{extension}/deck.#{extension}.js")
+      end
 
-    # fire up deck.js
-    script "$(function(){$.deck('.slide');});"
+      # fire up deck.js
+      script "$(function(){$.deck('.slide');});"
 
-  end
-
-  def body_attributes
-    {:class=>"deck-container"}
-  end
+    end
 
-  def body_content
-    slides
-    slide_navigation
-    toc
-    deck_status
-    goto_slide
-    permalink
-    scripts
-  end
+    def body_attributes
+      {:class => "deck-container"}
+    end
 
-  def slide slide_id
-    # todo: use Slide object, but without markdown
-    # slide = Slide.new(:slide_id => slide_id)
-    section.slide :id => slide_id do
-      yield
+    def body_content
+      slides
+      slide_navigation
+      toc
+      deck_status
+      goto_slide
+      permalink
+      scripts
     end
-  end
 
-  def slides
-    if @slides
-      @slides.each do |slide|
-        widget slide
+    def slide slide_id
+      # todo: use Slide object, but without markdown
+      # slide = Slide.new(:slide_id => slide_id)
+      section.slide :id => slide_id do
+        yield
       end
-    else
-      default_slide
     end
-  end
 
-  def default_slide
-    slide 'readme' do
-      h2 "deck.rb"
-      ul {
-        li "based on deck.js"
-        li "create a subclass of Deck (see introduction.rb)"
-        li "run erector to build it"
-      }
-      pre "erector --to-html ./deck.rb  # generates deck.html"
+    def slides
+      if @slides
+        @slides.each do |slide|
+          widget slide
+        end
+      else
+        default_slide
+      end
     end
-  end
 
-  def slide_navigation
-    a :href => '#', :class => 'deck-prev-link', :title => 'Previous' do
-      character 8592
+    def default_slide
+      slide 'readme' do
+        h2 "deck.rb"
+        ul {
+          li "based on deck.js"
+          li "create a subclass of Deck (see introduction.rb)"
+          li "run erector to build it"
+        }
+        pre "erector --to-html ./deck.rb  # generates deck.html"
+      end
     end
-    a :href => '#', :class => 'deck-next-link', :title => 'Next' do
-      character 8594
+
+    def slide_navigation
+      a :href => '#', :class => 'deck-prev-link', :title => 'Previous' do
+        character 8592
+      end
+      a :href => '#', :class => 'deck-next-link', :title => 'Next' do
+        character 8594
+      end
     end
-  end
 
-  def toc
-    div.slide_toc do
-      div.toggle "[toc]"
-      ul do
-        if @slides
-          @slides.each do |slide|
-            li do
-              a slide.title, :href => "##{slide.slide_id}"
+    def toc
+      div.slide_toc do
+        div.toggle "[contents]"
+        div.table do
+          h2 @title
+          ul do
+            if @slides
+              @slides.each do |slide|
+                li do
+                  a slide.title, :href => "##{slide.slide_id}"
+                end
+              end
             end
           end
         end
       end
     end
-  end
 
-  def deck_status
-    p :class => 'deck-status' do
-      span :class => 'deck-status-current' do
-      end
-      text '/'
-      span :class => 'deck-status-total' do
+    def deck_status
+      p :class => 'deck-status' do
+        span :class => 'deck-status-current' do
+        end
+        text '/'
+        span :class => 'deck-status-total' do
+        end
       end
     end
-  end
 
-  def goto_slide
-    form :action => '.', :method => 'get', :class => 'goto-form' do
-      label :for => 'goto-slide' do
-        text 'Go to slide:'
-      end
-      input :type => 'text', :name => 'slidenum', :id => 'goto-slide', :list => 'goto-datalist'
-      datalist :id => 'goto-datalist' do
+    def goto_slide
+      form :action => '.', :method => 'get', :class => 'goto-form' do
+        label :for => 'goto-slide' do
+          text 'Go to slide:'
+        end
+        input :type => 'text', :name => 'slidenum', :id => 'goto-slide', :list => 'goto-datalist'
+        datalist :id => 'goto-datalist' do
         end
-      input :type => 'submit', :value => 'Go'
+        input :type => 'submit', :value => 'Go'
+      end
     end
-  end
 
-  def permalink
-    a "#", :href => '.', :title => 'Permalink to this slide', :class => 'deck-permalink'
-  end
+    def permalink
+      a "#", :href => '.', :title => 'Permalink to this slide', :class => 'deck-permalink'
+    end
 
- end
+  end
 end