showoff 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Scott Chacon
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -2,12 +2,12 @@ ShowOff Presentation Software
 =============================
 
 ShowOff is a Sinatra web app that reads simple configuration files for a
-presentation.  It is sort of like a Keynote web app engine.  I am using it
-to do all my talks in 2010, because I have a deep hatred in my heart for
-Keynote and yet it is by far the best in the field.
+presentation.  It is sort of like a Keynote web app engine - think S5 + 
+Slidedown.  I am using it to do all my talks in 2010, because I have a deep 
+hatred in my heart for Keynote and yet it is by far the best in the field.
 
-The idea is that you setup your slide files in section subdirectories and
-then startup the showoff server in that directory.  It will read in your
+The idea is that you setup your markdown slide files in section subdirectories
+and then startup the showoff server in that directory.  It will read in your
 showoff.json file for which sections go in which order and then will give 
 you a URL to present from.
 
@@ -29,47 +29,114 @@ It might will can:
  * show audience questions / comments (twitter or direct)
  * let audience members go back / catch up as you talk
  * let audience members vote on sections (?)
- * broadcast itself on Bonjour 
+ * broadcast itself on Bonjour
  * let audience members download slides, code samples or other supplementary material
 
-Some of the nice things are that you can easily version control it, you 
-can easily move sections between presentations, and you can rearrange or 
-remove sections easily. 
+Some of the nice things are that you can easily version control it, you
+can easily move sections between presentations, and you can rearrange or
+remove sections easily.
 
 Usage
 ====================
 
-To try ShowOff, clone this repo and run ./bin/showoff, which will start
-up the Sinatra server and serve the examples/ directory. Eventually this
-will be gemified and you can run it in any ShowOff directory.
+ShowOff is meant to be run in a ShowOff formatted repository - that means that
+it has a showoff.json file and a number of sections (subdirectories) with markdown files for the slides you're presenting.
+
+  $ gem install showoff
+  $ git clone (showoff-repo)
+  $ cd (showoff-repo)
+  $ showoff serve
+
+If you run 'showoff' in the ShowOff directory itself, it will show an example 
+presentation from the 'example' subdirectory, so you can see what it's like.
+
+Slide Format
+====================
+
+You can break your slides up into sections of however many subdirectories deep
+you need.  ShowOff will recursively check all the directories mentioned in
+your showoff.json file for any markdown files (.md).  Each markdown file can
+have any number of slides in it, seperating each slide with the '!SLIDE'
+keyword and optional slide styles.
+
+For example, if you run 'showoff create my_new_pres' it will create a new 
+starter presentation for you with one .md file at one/slide.md which will have
+the following contents:
+
+  !SLIDE
+
+  # My Presentation #
+
+  !SLIDE bullets incremental
+
+  # Bullet Points #
+
+  * first point
+  * second point
+  * third point
+
+That represents two slides, one with just a large title and one with three
+bullets that are incrementally updated when the slide is shown. In order for
+ShowOff to see those slides, your showoff.json file needs to look something 
+like this:
+
+  [ 
+    {"section":"one"} 
+  ]
+
+If you have multiple sections in your talk, you can make this json array 
+include all the sections you want to show in which order you want to show 
+them.
+
+Some useful styles for each slide are:
+
+* center - centers images on a slide
+* bullets - sizes and seperates bullets properly (fits up to 5, generally)
+* smbullets - sizes and seperates more bullets (smaller, closer together)
+* subsection - creates a different background for titles
+* command - monospaces h1 title slides
+* commandline - for pasted commandline sections 
+    (needs leading '$' for commands, then output on subsequent lines)
+* code - monospaces everything on the slide
+* incremental - can be used with 'bullets' and 'commandline' styles,
+    will incrementally update elements on arrow key rather than switch slides
+* small - make all slide text 80%
+* smaller - make all slide text 70%
+
+Check out the example directory included to see examples of most of these.
+
+You can manage the presentation with the following keys:
+
+ * space, cursor right: next slide
+ * cursor left: previous slide
+ * d: debug mode
+ * c: table of contents (vi)
+ * f: toggle footer
+ * z: toggle help 
 
 Real World Usage
 ====================
 
-So far, showoff has been used in the following presentations:
+So far, ShowOff has been used in the following presentations:
 
-* LinuxConf.au 2010 - Wrangling Git - Scott Chacon 
+* LinuxConf.au 2010 - Wrangling Git - Scott Chacon
   http://github.com/schacon/showoff-wrangling-git
 
-If you use it for something, please let me know.
+* SF Ruby Meetup - Resque! - Chris Wanstrath
+  http://github.com/defunkt/ruby-meetup-resque
+
+If you use it for something, please let me know so I can add it.
 
 Future Plans
 ====================
 
-Right now it comes with an example presentation (my LinuxConf.au talk)
-that will probably change or go away at some point.  I would like this
-to eventually be a general tool rather than having the presentation in
-the showoff repo.  Eventually.  So you would install showoff as a gem
-and then have just the presentation as your git repo (or whatever) and
-run 'showoff' in the repo to start the presentation.
-
 I really want this to evolve into a dynamic presentation software server,
-that gives the audience a lot of interaction into the presentation - 
+that gives the audience a lot of interaction into the presentation -
 helping them decide dynamically what the content of the presentation is,
 ask questions without interupting the presenter, etc.  I want the audience
 to be able to download a dynamically generated PDF of either the actual
-talk that was given, or all the available slides, plus supplementary 
-material. And I want the presenter (me) to be able to push each 
+talk that was given, or all the available slides, plus supplementary
+material. And I want the presenter (me) to be able to push each
 presentation to Heroku or GitHub pages for archiving super easily.
 
 Why Not S5 or Slidy or Slidedown?

data/bin/showoff

@@ -2,4 +2,17 @@
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'showoff'
-ShowOff.run! :host => 'localhost', :port => 9090
+command = ARGV[0]
+
+case command
+when 'create'
+  ShowOffUtils.create
+when 'add'
+  ShowOffUtils.add_slide
+when 'heroku'
+  ShowOffUtils.heroku
+when 'serve'
+  ShowOff.run! :host => 'localhost', :port => 9090
+else
+  ShowOffUtils.help
+end

data/lib/showoff.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'sinatra/base'
 require 'json'
 require 'nokogiri'
+require 'showoff_utils'
 
 begin 
   require 'rdiscount'
@@ -36,6 +37,14 @@ class ShowOff < Sinatra::Application
       files
     end
 
+    def css_files
+      Dir.glob("#{options.pres_dir}/*.css").map { |path| File.basename(path) }
+    end
+
+    def js_files
+      Dir.glob("#{options.pres_dir}/*.js").map { |path| File.basename(path) }
+    end
+
     def process_markdown(name, content)
       slides = content.split('!SLIDE')
       slides.delete('')
@@ -111,10 +120,10 @@ class ShowOff < Sinatra::Application
     erb :index
   end
 
-  get '/image/*' do
-    img_file = params[:splat].join('/')
-    img = File.join(options.pres_dir, img_file)
-    send_file img
+  get %r{(?:image|file)/(.*)} do
+    path = params[:captures].first
+    full_path = File.join(options.pres_dir, path)
+    send_file full_path
   end
 
   get '/slides' do

data/lib/showoff_utils.rb

@@ -0,0 +1,98 @@
+class ShowOffUtils
+
+  def self.create
+    dirname = ARGV[1]
+    return help('create') if !dirname
+    Dir.mkdir(dirname) if !File.exists?(dirname)
+    Dir.chdir(dirname) do
+      # create section
+      Dir.mkdir('one')
+
+      # create markdown file
+      File.open('one/slide.md', 'w+') do |f|
+        f.puts "!SLIDE"
+        f.puts "# My Presentation #"
+        f.puts
+        f.puts "!SLIDE bullets incremental"
+        f.puts "# Bullet Points #"
+        f.puts
+        f.puts "* first point"
+        f.puts "* second point"
+        f.puts "* third point"
+      end
+
+      # create showoff.json
+      File.open('showoff.json', 'w+') do |f|
+        f.puts '[ {"section":"one"} ]'
+      end
+
+      # print help
+      puts "done. run 'showoff serve' in #{dirname}/ dir to see slideshow"""
+    end
+  end
+
+  def self.heroku
+    name = ARGV[1]
+    return help('heroku') if !name
+    if !File.exists?('showoff.json')
+      puts "fail. not a showoff directory"
+      return false
+    end
+    # create .gems file
+    File.open('.gems', 'w+') do |f|
+      f.puts "bluecloth"
+      f.puts "nokogiri"
+      f.puts "showoff"
+    end if !File.exists?('.gems')
+
+    # create config.ru file
+    File.open('config.ru', 'w+') do |f|
+      f.puts 'require "showoff"'
+      f.puts 'ShowOff.run!'
+    end if !File.exists?('config.ru')
+
+    `heroku create #{name}`
+
+    puts "herokuized. run something like this to launch your heroku presentation:
+
+      $ git add .gems config.ru
+      $ git commit -m 'herokuized'
+      $ git push heroku master
+    "
+  end
+
+  def self.help(verb = nil)
+    verb = ARGV[1] if !verb
+    case verb
+    when 'heroku'
+      puts <<-HELP
+usage: showoff heroku (heroku-name)
+
+creates the .gems file and config.ru file needed to push a showoff pres to
+heroku.  it will then run 'heroku create' for you to register the new project
+on heroku and add the remote for you.  then all you need to do is commit the
+new created files and run 'git push heroku' to deploy.
+
+HELP
+    when 'create'
+      puts <<-HELP
+usage: showoff create (directory)
+
+this command helps start a new showoff presentation by setting up the
+proper directory structure for you.  it takes the directory name you would
+like showoff to create for you.
+
+HELP
+    else
+      puts <<-HELP
+usage: showoff (command)
+
+commands:
+  serve   serves a showoff presentation from the current directory
+  create  generates a new showoff presentation layout
+  heroku  sets up your showoff presentation to push to heroku
+HELP
+    end
+  end
+
+end

data/public/js/showoff.js

@@ -77,7 +77,7 @@ function showFirstSlide() {
   showSlide()
 }
 
-function showSlide() {
+function showSlide(back_step) {
   if(slidenum < 0) {
     slidenum = 0
     return
@@ -96,8 +96,11 @@ function showSlide() {
   var mar_top = (0.5 * parseFloat($("#preso").height())) - (0.5 * parseFloat(slide_height))
   $("#preso > .slide").css('margin-top', mar_top)
 
-  // determine if there are incremental bullets to show
-  determineIncremental()
+  if(!back_step) {
+    // determine if there are incremental bullets to show
+    // unless we are moving backward
+    determineIncremental()
+  }
 }
 
 function determineIncremental()
@@ -169,7 +172,7 @@ function keyDown(event)
     else if (key == 37) // Left arrow
     {
       slidenum--
-      showSlide()
+      showSlide(true) // We show the slide fully loaded
     }
     else if (key == 39) // Right arrow
     {

data/views/index.erb

@@ -21,6 +21,16 @@
   <link type="text/css" href="/css/theme/ui.all.css" media="screen" rel="stylesheet" /> 
   <link type="text/css" href="/css/sh_style.css" rel="stylesheet" >
 
+
+
+  <% css_files.each do |css_file| %>
+	  <link rel="stylesheet" href="file/<%= css_file %>" type="text/css"/>
+  <% end %>
+
+  <% js_files.each do |js_file| %>
+    <script type="text/javascript" src="/file/<%= js_file %>"></script>
+  <% end %>
+
   <script type="text/javascript">
   $(function(){
     setupPreso()
@@ -41,7 +51,7 @@
     <tr><td class="key">d</td><td>debug mode</td></tr>
     <tr><td class="key">c</td><td>table of contents (vi)</td></tr>
     <tr><td class="key">f</td><td>toggle footer</td></tr>
-    <tr><td class="key">x</td><td>toggle help (this)</td></tr>
+    <tr><td class="key">z</td><td>toggle help (this)</td></tr>
   </table>
 </div>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: showoff
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Scott Chacon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-21 00:00:00 +13:00
+date: 2010-01-26 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: "  ShowOff is a Sinatra web app that reads simple configuration files for a\n  presentation.  It is sort of like a Keynote web app engine.  I am using it\n  to do all my talks in 2010, because I have a deep hatred in my heart for\n  Keynote and yet it is by far the best in the field.\n\n  The idea is that you setup your slide files in section subdirectories and\n  then startup the showoff server in that directory.  It will read in your\n  showoff.json file for which sections go in which order and then will give \n  you a URL to present from.\n"
 email: schacon@gmail.com
 executables: 
@@ -53,8 +63,10 @@ extra_rdoc_files: []
 files: 
 - README.txt
 - Rakefile
+- LICENSE
 - bin/showoff
 - lib/showoff.rb
+- lib/showoff_utils.rb
 - views/index.erb
 - public/css/fg.menu.css
 - public/css/sh_style.css