deckrb 0.3.0 → 0.3.1

data/README.md

@@ -62,6 +62,8 @@ 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)
+  * this is currently very primitive and should be redone and/or integrated into deck.js
 
 ## Command-Line API
 
@@ -79,6 +81,13 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
      --version, -v:   Print version and exit
         --help, -h:   Show this message
 
+## Known Issues
+
+* If you're running Webrick, you may not be able to kill the server with Ctrl-C. This is a bug in recent versions of Webrick.
+  * Workaround: `gem install thin` -- if thin is installed, deck will use it instead of webrick
+
+Report bugs on <http://github.com/alexch/deck.rb/issues>
+
 ## Credits
 
 * deck.js by Caleb at <http://imakewebthings.com>
@@ -140,6 +149,10 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 * rewrite internal links to files and serve them relative to current dir, not slide dir
 * custom `.css`, `.scss`, and `.js` files, which will get imported into all slides
 * support some more extensions https://github.com/imakewebthings/deck.js/wiki
+* improve table of contents
+  * nested sections
+  * disappear when clicked outside of, esc pressed, etc.
+  * close box
 
 ## TODO (community)
 
@@ -147,6 +160,7 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 * mix with keydown https://github.com/infews/keydown
 * gh-pages documentation site
 * integrate with slideshow https://github.com/geraldb/slideshow-deck.js
+* make it a proper Rack middleware thingy and add to https://github.com/rack/rack/wiki/List-of-Middleware
 
 # License
 

data/bin/deck

@@ -27,11 +27,11 @@ if options[:build]
     # output_dir ||= File.dirname(arg)
     basename ||= File.basename(arg, ".md")
     output_path ||= "#{output_dir}/#{basename}.html"
-    slides += Slide.from_file arg
+    slides += Deck::Slide.from_file arg
   end
 
   File.open(output_path, "w") do |file|
-    deck = SlideDeck.new :slides => slides
+    deck = Deck::SlideDeck.new :slides => slides
     # deck.to_pretty(:output => file)  # todo: figure out why this doesn't work
     file.write deck.to_pretty
   end

data/lib/deck/slide.rb

@@ -101,6 +101,12 @@ module Deck
     @markdown_text.strip == ""
   end
 
+  def title
+    lines = @markdown_text.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")

data/lib/deck/slide_deck.rb

@@ -55,8 +55,6 @@ module Deck
     meta :name => "description", :content=> @description if @description
     meta :name => "author", :content=> @author if @author
 
-    stylesheet public_asset("coderay.css")
-
     #  <!-- Core and extension CSS files -->
     stylesheet public_asset("deck.js/core/deck.core.css")
     extensions.each do |extension|
@@ -65,6 +63,10 @@ module Deck
 
     # <!-- Theme CSS files (menu swaps these out) -->
     stylesheet public_asset("deck.js/themes/style/swiss.css"), :id=>"style-theme-link"
+
+    stylesheet public_asset("coderay.css")
+    stylesheet public_asset("tables.css")
+    stylesheet public_asset("toc.css")
   end
 
   def scripts
@@ -74,6 +76,12 @@ module Deck
     # script :src => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.min.js'
     script :src => public_asset('deck.js/jquery-1.7.min.js')
 
+    jquery <<-JAVASCRIPT
+    $('.slide_toc .toggle').click(function(){
+      $('.slide_toc ul').toggle();
+    });
+    JAVASCRIPT
+
     comment 'Deck Core and extensions'
     script :type => "text/javascript", :src => public_asset('deck.js/core/deck.core.js')
 
@@ -93,6 +101,7 @@ module Deck
   def body_content
     slides
     slide_navigation
+    toc
     deck_status
     goto_slide
     permalink
@@ -138,6 +147,21 @@ module Deck
     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}"
+            end
+          end
+        end
+      end
+    end
+  end
+
   def deck_status
     p :class => 'deck-status' do
       span :class => 'deck-status-current' do

data/lib/deck/version.rb

@@ -1,3 +1,3 @@
 module Deck
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/public/tables.css

@@ -0,0 +1,29 @@
+.slide table {
+	display: table;
+	border-collapse: collapse;
+	border-spacing: 2px;
+	border-color: gray;
+	margin: 15px 0;
+}
+
+.slide table tr {
+	border-top: 1px solid #CCC;
+	background-color: white;
+	margin: 0;
+	padding: 0;
+}
+
+.slide table tr th, .slide table tr td {
+	border: 1px solid #CCC;
+	text-align: left;
+	margin: 0;
+	padding: 6px 13px;
+}
+
+.slide table thead tr {
+	background-color: #F2F2F8;
+}
+
+.slide table tr:nth-child(2n) {
+	background-color: #F8F8F8;
+}

data/public/toc.css

@@ -0,0 +1,37 @@
+.deck-container .slide_toc {
+		position:fixed;
+		bottom:4px;
+		left:4px;
+		height: 80%;
+		color:#888;
+		z-index:3;
+		margin:0;
+	}
+
+.deck-container .slide_toc .toggle {
+	position: absolute;
+	bottom: 0px;
+	cursor: pointer;
+}
+
+.deck-container .slide_toc ul {
+		display: none;
+		position: absolute;
+		width: 20em;
+		bottom: 1em;
+
+		border: 1px solid black;
+		padding: 4px;
+		margin: 4px 0 2em;
+		background: white;
+		overflow-y: auto;
+		color: black;
+
+		height: 100%;
+	}
+
+@media print {
+	.slide_toc {
+		display:none;
+	}
+}

data/spec/slide_deck_spec.rb

@@ -41,5 +41,19 @@ module Deck
     }
   end
 
+  it "includes a table of contents" do
+    deck_widget :slides => Slide.split("# Foo\n\n# Bar\n")
+    toc = doc.css('.slide_toc')
+    assert { toc.size == 1 }
+    assert { noko_html(toc.first) == "<div class=\"slide_toc\">" +
+      "<div class=\"toggle\">[toc]</div>" +
+      "<ul>" +
+      "<li><a href=\"#foo\">Foo</a></li>" +
+      "<li><a href=\"#bar\">Bar</a></li>" +
+      "</ul>" +
+      "</div>"
+    }
+  end
+
  end
 end

data/spec/slide_spec.rb

@@ -180,7 +180,7 @@ Two
     Slide.split(markdown_text).first
   end
 
-  describe "sets the slide's id" do
+  describe "has an id" do
     it "based on the first header" do
       assert { slide_from("# foo").slide_id == "foo" }
     end
@@ -195,6 +195,20 @@ Two
     end
   end
 
+  describe "has a title" do
+    it "based on the first header" do
+      assert { slide_from("# Foo").title == "Foo" }
+    end
+
+    it "preserves punctuation" do
+      assert { slide_from("# Don't tread on me!").title == "Don't tread on me!" }
+    end
+
+    it "strips whitespace" do
+      assert { slide_from("#    hi there    ").title == "hi there" }
+    end
+  end
+
   describe "renders deck.js-compatible HTML" do
     it "leaves a solo H1 as an H1" do
       html = slide_from(<<-MARKDOWN).to_pretty

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deckrb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000 Z
+date: 2012-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erector
@@ -224,6 +224,8 @@ files:
 - public/deck.js/themes/transition/vertical-slide.css
 - public/deck.js/themes/transition/vertical-slide.scss
 - public/favicon.ico
+- public/tables.css
+- public/toc.css
 - README.md
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
@@ -247,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1200341781470137723
+      hash: 1497059126395334120
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -256,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1200341781470137723
+      hash: 1497059126395334120
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21