showoff 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0547aee458c3417a677758cdf70ea8a063e2d89
-  data.tar.gz: ecb30bc4b56493533a5b70327cedec5b75d2475f
+  metadata.gz: ec76aa0788c47474cae17e4e7fd001f5f59528fb
+  data.tar.gz: 672f97f4f81b725f1f0d68418b5a292f3061d58d
 SHA512:
-  metadata.gz: 58700ccb6dd6d381acb170486ceb0723150a4b6b3e1fd4e8d9be4cb8aa20f10b63c6edc37c4e66a69da546759f5bbbf0e81aaafe949c7c5ba76abd56afea370c
-  data.tar.gz: 1100e728e8f85fdba9966c861d2ada537967cd3f985290774958a2058562b959a72c5f9f682b56fe4ce9184ef6eadf5b3294bc009e5d6076a00fbbb435250a49
+  metadata.gz: 46464828f157e75fd4783ef28628ff404573f57f69d3fa87da500a5cf4be46ce62a9e9639e695cf3f451eca27ec423ab9be48137ffc75fb45317b104c2218204
+  data.tar.gz: 6e3c5444159ce33d30e273de6de19da2357bec6b1aa82da65a7d7b4d5cad118bd472fba0289109c5a70eb0efd2184f080e64ec443aa0823f048445351acca284

data/README.md

@@ -0,0 +1,76 @@
+# Showoff Presenter
+
+Showoff is a slideshow presentation tool with a twist. It runs as a web application,
+with audience interactivity features. This means that your audience can follow along
+in their own browsers, can download supplemental materials, can participate in quizzes
+or polls, post questions for the presenter, etc. By default, their slideshows will
+synchronize with the presenter, but they can switch to self-navigation mode.
+
+![Presenter view](images/presenter.png)
+
+Showoff allows you to author your presentation slides in Markdown, then organize
+them with a `showoff.json` file. This file also contains metadata about
+the presentation, such as the title, any password protection, etc.
+
+Then you just run `showoff serve` in the presentation directory and open
+a browser window.
+
+
+## Functionality
+
+Beyond the standard presentation functionality, Showoff provides:
+
+* Live presenter tools:
+  * presenter view that display notes, tree representation of presentation, and other tools
+  * execute code in many languages (Javascript, Ruby, Python, Puppet, etc) live and display results
+  * show a pre-show slideshow while you wait to start
+  * let audience members download slides, code samples or other supplementary material
+  * show a countdown timer to help keep you on pace.
+  * show synchronized, hidden notes on another browser (like an iphone)
+
+* Live audience tools:
+  * audience can pull up the presentation on their own browsers
+  * presentation is synchronized to track the presenter's
+  * call up a menu of sections/slides at any time to navigate directly to slides
+  * independent navigation so that audience members can go back or catch up as you talk
+  * allow the audience to provide pace feedback and ask questions of the presenter
+  * allow the audience to provide content feedback on the material
+
+* Content creation and distribution functionality:
+  * generate supplemental material based on slide tags
+  * generate printed versions of the presentation including handout notes
+  * password protect any URL path to keep control over different views of content
+  * automatically generate a Table of Contents
+  * provide buttons for one-click issue reporting for presentation materials
+  * open the current slide in a Markdown editor
+  * open the current slide in an online editor such as Github's repository editor
+  * track how much time audience members spend on specific slides
+  * generate a static form of the presentation and upload it to Github Pages
+  * generate a Heroku app to serve your presentation from
+  * automatically generate presentations from an outline
+
+Due to it being plain text, you can easily version control it, you can easily move
+sections between presentations, and you can rearrange or remove sections easily.
+
+
+## Installation
+
+Showoff is distributed as a RubyGem. Simply install it like any other gem. Showoff
+will run out of the box on OS X and most Linux distributions. To install on Windows,
+you'll need to install both Ruby and the Ruby DevKit for compiling native extensions.
+
+    gem install showoff
+
+
+## Documentation
+
+Please see the [documentation](./documentation) section for further information.
+
+You can generate a nice & pretty local copy of the documentation by running
+`rake doc` in your clone of the repository. The generated HTML will be saved in
+the `docs` directory.
+
+
+## Contributing
+
+See the [CONTRIB.md](CONTRIB.md) file for how to contribute to this project

data/bin/showoff

@@ -50,11 +50,10 @@ command [:create,:init] do |c|
   c.action do |global_options,options,args|
     raise "dir_name is required" if args.empty?
     ShowOffUtils.create(args[0],!options[:n],options[:d])
-    if !options[:n]
-      puts "done. run 'showoff serve' in #{options[:d]}/ dir to see slideshow"
-    else
-      puts "done. add slides, modify #{ShowOffUtils.presentation_config_file} and then run 'showoff serve' in #{dirname}/ dir to see slideshow"
+    if options[:n]
+      puts "Add slides and update #{args[0]}/#{ShowOffUtils.presentation_config_file}"
     end
+    puts "Run 'showoff serve' in the #{args[0]} directory to see your new slideshow"
   end
 end
 

data/lib/showoff/version.rb

@@ -1,3 +1,3 @@
 # No namespace here since ShowOff is a class and I'd have to inherit from
 # Sinatra::Application (which we don't want to load here)
-SHOWOFF_VERSION = '0.12.1'
+SHOWOFF_VERSION = '0.12.2'

data/lib/showoff_utils.rb

@@ -32,22 +32,28 @@ class ShowOffUtils
   end
 
   def self.create(dirname,create_samples,dir='one')
-    Dir.mkdir(dirname) if !File.exist?(dirname)
+    FileUtils.mkdir_p(dirname)
     Dir.chdir(dirname) do
       if create_samples
         # create section
-        Dir.mkdir(dir)
+        FileUtils.mkdir_p(dir)
 
         # create markdown file
         File.open("#{dir}/01_slide.md", 'w+') do |f|
           f.puts make_slide("My Presentation")
+        end
+        File.open("#{dir}/02_slide.md", 'w+') do |f|
           f.puts make_slide("Bullet Points","bullets incremental",["first point","second point","third point"])
         end
       end
 
+      # Create asset directories
+      FileUtils.mkdir_p('_files/share')
+      FileUtils.mkdir_p('_images')
+
       # create showoff.json
       File.open(ShowOffUtils.presentation_config_file, 'w+') do |f|
-        f.puts "{ \"name\": \"My Preso\", \"sections\": [ {\"section\":\"#{dir}\"} ]}"
+        f.puts JSON.pretty_generate({ "name" => "My Preso", "sections" => [ { "section" => dir } ]})
       end
     end
   end
@@ -58,6 +64,10 @@ class ShowOffUtils
       ShowOffUtils.presentation_config_file = File.basename(config)
     end
 
+    # Create asset directories
+    FileUtils.mkdir_p('_files/share')
+    FileUtils.mkdir_p('_images')
+
     self.showoff_sections('.').each do |filename|
       next if File.exist? filename
 
@@ -138,8 +148,8 @@ class ShowOffUtils
   # [content] slide content.  Currently, if this is an array, it will make a bullet list.  Otherwise
   #           the string value of this will be put in the slide as-is
   def self.make_slide(title,classes="",content=nil)
-    slide = "!SLIDE #{classes}\n"
-    slide << "# #{title} #\n"
+    slide = "<!SLIDE #{classes}>\n"
+    slide << "# #{title}\n"
     slide << "\n"
     if content
       if content.kind_of? Array
@@ -152,13 +162,13 @@ class ShowOffUtils
   end
 
   TYPES = {
-    :default => lambda { |t,size,source,type| make_slide(t,"#{size} #{type}",source) },
-    'title' => lambda { |t,size,dontcare| make_slide(t,size) },
-    'bullets' => lambda { |t,size,dontcare| make_slide(t,"#{size} bullets incremental",["bullets","go","here"])},
-    'smbullets' => lambda { |t,size,dontcare| make_slide(t,"#{size} smbullets incremental",["bullets","go","here","and","here"])},
-    'code' => lambda { |t,size,src| make_slide(t,size,blank?(src) ? "    @@@ Ruby\n    code_here()" : src) },
-    'commandline' => lambda { |t,size,dontcare| make_slide(t,"#{size} commandline","    $ command here\n    output here")},
-    'full-page' => lambda { |t,size,dontcare| make_slide(t,"#{size} full-page","![Image Description](image/ref.png)")},
+    :default      => lambda { |t,size,source,type| make_slide(t,"#{size} #{type}",source) },
+    'title'       => lambda { |t,size,dontcare|    make_slide(t,size) },
+    'bullets'     => lambda { |t,size,dontcare|    make_slide(t,"#{size} bullets incremental",["bullets","go","here"])},
+    'smbullets'   => lambda { |t,size,dontcare|    make_slide(t,"#{size} smbullets incremental",["bullets","go","here","and","here"])},
+    'code'        => lambda { |t,size,src|         make_slide(t,size,blank?(src) ? "    @@@ Ruby\n    code_here()" : src) },
+    'commandline' => lambda { |t,size,dontcare|    make_slide(t,"#{size} commandline","    $ command here\n    output here")},
+    'full-page'   => lambda { |t,size,dontcare|    make_slide(t,"#{size} full-page","![Image Description](image/ref.png)")},
   }
 
 
@@ -187,7 +197,7 @@ class ShowOffUtils
     type = options[:type] || :default
     slide = TYPES[type].call(title,size,source)
 
-    if options[:dir]
+    if options[:name]
       filename = determine_filename(options[:dir],options[:name],options[:number])
       write_file(filename,slide)
     else
@@ -233,27 +243,29 @@ class ShowOffUtils
   end
 
   def self.determine_filename(slide_dir,slide_name,number)
-    filename = "#{slide_dir}/#{slide_name}.md"
+    raise "Slide name is required" unless slide_name
+
     if number
-      max = find_next_number(slide_dir)
-      filename = "#{slide_dir}/#{max}_#{slide_name}.md"
+      next_num   = find_next_number(slide_dir)
+      slide_name = "#{next_num}_#{slide_name}"
     end
+
+    if slide_dir
+      filename = "#{slide_dir}/#{slide_name}.md"
+    else
+      filename = "#{slide_name}.md"
+    end
+
     filename
   end
 
   # Finds the next number in the given dir to
   # name a slide as the last slide in the dir.
   def self.find_next_number(slide_dir)
-    max = 0
-    Dir.open(slide_dir).each do |file|
-      if file =~ /(\d+).*\.md/
-        num = $1.to_i
-        max = num if num > max
-      end
-    end
-    max += 1
-    max = "0#{max}" if max < 10
-    max
+    slide_dir ||= '.'
+    next_num    = Dir.glob("#{slide_dir}/*.md").size + 1
+
+    sprintf("%02d", next_num)
   end
 
   def self.determine_title(title,slide_name,code)
@@ -274,8 +286,8 @@ class ShowOffUtils
     size = "small" if lines > 15
     size = "smaller" if width > 57
     size = "smaller" if lines > 19
-    puts "warning, some lines are too long and the code may be cut off" if width > 65
-    puts "warning, your code is too long and the code may be cut off" if lines > 23
+    puts "WARNING: some lines are too long and might be truncated" if width > 65
+    puts "WARNING: your code is too long and may not fit on a slide" if lines > 23
     size
   end
 

data/public/css/presenter.css

@@ -330,10 +330,7 @@
     height: 100%;
     padding: 0 1em;
     display: block;
-  }
-
-  #notes > :first-child:before {
-    display: none;
+    position: relative;
   }
 
   #notes ul.section-selector {

data/public/css/showoff.css

@@ -820,33 +820,41 @@ form .element {
  ***    Callouts    ***
  **********************/
 
- .callout {
-   padding: 12px;
-   line-height: 1.6em;
-   border: 1px solid #222;
-   border-radius: 4px;
-   background-color: transparent; /* because there's a warning class with a red background */
- }
-
- .callout:before {
-   font-family: FontAwesome;
-   font-style: normal;
-   font-weight: normal;
-   font-size: 2em;
-   text-decoration: inherit;
-   padding: 0 8px 100% 8px;
-   float: left;
- }
-
- .callout.info:before     { content: "\f05a"; } /* fa-info-circle */
- .callout.warning:before  { content: "\f071"; } /* fa-exclamation-triangle */
- .callout.question:before { content: "\f059"; } /* fa-question-circle */
- .callout.exercise:before { content: "\f41b"; } /* fa-pencil-square */
- .callout.stop:before     { content: "\f05e"; } /* fa-ban */
+.callout {
+  padding: 1em;
+  line-height: 1.2em;
+  border: 1px solid #222;
+  border-radius: 4px;
+  background-color: transparent; /* because there's a warning class with a red background */
+}
 
- /**********************
- ***  end callouts   ***
- **********************/
+  .callout:before {
+    font-family: FontAwesome;
+    font-style: normal;
+    font-weight: normal;
+    font-size: 2em;
+    text-decoration: inherit;
+    position: absolute;
+    left: 1em;
+  }
+
+  .callout.info,
+  .callout.warning,
+  .callout.question,
+  .callout.exercise,
+  .callout.stop {
+    padding-left: 3em;
+  }
+
+  .callout.info:before     { content: "\f05a"; } /* fa-info-circle */
+  .callout.warning:before  { content: "\f071"; } /* fa-exclamation-triangle */
+  .callout.question:before { content: "\f059"; } /* fa-question-circle */
+  .callout.exercise:before { content: "\f41b"; } /* fa-pencil-square */
+  .callout.stop:before     { content: "\f05e"; } /* fa-ban */
+
+/**********************
+***  end callouts   ***
+**********************/
 
 
 /* Tiny mobile devices. Larger devices scale automatically. */

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: showoff
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Scott Chacon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -180,7 +180,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rdoc
+- README.md
 - Rakefile
 - LICENSE
 - bin/showoff

data/README.rdoc

@@ -1,128 +0,0 @@
-= 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 - 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.
-
-Showoff allows you to author your presentation slides in Markdown, then organize
-them with a <tt>showoff.json</tt> file. This file also contains metadata about
-the presentation, such as the title, any password protection, etc.
-
-Then you just run <tt>showoff serve</tt> in the presentation directory and open
-a browser window.
-
-Showoff's capabilities include:
-
-* Display content on slides including:
-  * formatted text and images
-  * syntax highlighted code
-  * bullets with incremental advancing
-  * simple slide transitions (instant, fade, slide in)
-  * replayed command line interactions
-
-* Live presenter tools:
-  * presenter view that display notes, tree representation of presentation, and other tools
-  * execute Javascript, Coffeescript or Ruby live and display results
-  * show a pre-show slideshow while you wait to start
-  * let audience members download slides, code samples or other supplementary material
-  * show a timer - elapsed / remaining
-  * show synchronized, hidden notes on another browser (like an iphone)
-
-* Live audience tools:
-  * audience can pull up the presentation on their own browsers
-  * call up a menu of sections/slides at any time to jump around
-  * independent navigation so that audience members can go back / catch up as you talk
-  * allow viewers to set their view of the presentation to track the presenter's
-  * allow the audience to provide pace feedback and ask questions of the presenter
-  * allow the audience to provide contend feedback on the material
-
-* Content creation and distribution functionality:
-  * generate supplemental material based on slide tags
-  * generate printed versions of the presentation including handout notes
-  * password protect any URL path to keep control over different views of content
-  * Automatically generate a Table of Contents
-
-Due to it being plain text, you can easily version control it, you can easily move
-sections between presentations, and you can rearrange or remove sections easily.
-
-Please see the documentation in <tt>./documentation</tt> for further information.
-
-= Real World Usage
-
-So far, Showoff has been used in the following presentations (and many others):
-
-* LinuxConf.au 2010 - Wrangling Git - Scott Chacon
-  http://github.com/schacon/showoff-wrangling-git
-* SF Ruby Meetup - Resque! - Chris Wanstrath
-  http://github.com/defunkt/sfruby-meetup-resque
-* RORO Sydney Talk, Feb 2010 - Beyond Actions - Dave Bolton
-  http://github.com/lightningdb/roro-syd-beyond-actions
-* LRUG's February meeting - Showing Off with Ruby - Joel Chippindale
-  http://github.com/mocoso/showing-off-with-ruby
-* PyCon 2010 - Hg and Git; Can't we all just get along? - Scott Chacon
-  http://github.com/schacon/pycon-hg-git
-* PdxJs Tech Talk - Asynchronous Coding For My Tiny Ruby Brain - Rick Olson
-  http://github.com/technoweenie/pdxjs-twitter-node
-* RORO Perth Talk - Rails 3; A Brief Introduction Darcy Laycock
-  http://github.com/Sutto/roro-perth-rails-3
-* PDXRB Tech Talk - Here's Sinatra - Jesse Cooke
-  http://github.com/jc00ke/pdxrb_sinatra
-* Red Dirt Ruby Conference May 2010 - Plain Old Tokyo Storage - Jeremy Hinegardner
-  http://github.com/copiousfreetime/plain-old-tokyo-storage-presentation
-  http://plain-old-tokyo-storage.heroku.com/
-* Lambda Lounge and StrangeLoop 2010 - JavaScript Functions : The Good Parts - Idioms for Encapsulation and Inheritance - Scott Bale
-  http://github.com/scottbale/JavaScript-Function-Idioms
-* Open Source Bridge 2010 - Creating a low-cost clustered virtualization environment w/ Ganeti - Lance Albertson
-  http://github.com/ramereth/presentation-ganeti
-* RailsConf 2010 - Domain-driven Test-assisted Production Rails Crisis Interventions - Rick Bradley
-  http://railsconf2010.rickbradley.com/ http://github.com/rick/presentation_railsconf_2010
-* WebWorkersCamp - 25 promising projects in 50 minutes - Bruno Michel
-  http://github.com/nono/Presentations/tree/master/20100703_25_promising_projects_in_50_minutes/
-* 11th Libre Software Meeting 2010 - Ruby 1.9, The future of Ruby? - Bruno Michel
-  http://github.com/nono/Presentations/tree/master/20100708_RMLL_Ruby_1.9/
-* Lone Star PHP 2011 - Drupal - Chris Christensen
-  https://github.com/christianchristensen/Presentations/tree/master/20110611-lonestarphp-drupal
-* Railsbridge Open Workshops - Sarah Allen, Sarah Mei, and Alex Chaffee
-  http://github.com/alexch/workshop
-* SDRuby Lightning Talk - Readable Regexps - Ian Young
-  https://github.com/iangreenleaf/sdruby-lightningtalk-tregexp
-* Disney HTML5 Summit 2011 - Polyfills: Shims and Shivs - Josh Dzielak
-  https://github.com/dzello/shims_and_shivs
-* All PuppetLabs training from Summer 2012 on and many internal & external presentations
-
-
-If you use it for something, please let me know so I can add it.
-
-= Future Plans
-
-I really want this to evolve into a dynamic presentation software server,
-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
-presentation to Heroku or GitHub pages for archiving super easily.
-
-Potential future capabilities might include:
-
-* perform simple animations of images moving between keyframes
-* let audience members vote on sections (?)
-* broadcast itself on Bonjour
-* let you write on the slide with your mouse, madden-style via canvas
-* automatically resize text to fit screen [see Alex's shrink.js]
-
-= Why Not S5 or Slidy or Slidedown?
-
-S5 and Slidy are really cool, and I was going to use them, but mainly I wanted
-something more dynamic.  I wanted Slidy + Slidedown, where I could write my
-slideshows in a structured format in sections, where the sections could easily
-be moved around and between presentations and could be written in Markdown. I
-also like the idea of having interactive presentation system and didn't need
-half the features of S5/Slidy (style based print view, auto-scaling, themes,
-etc).
-
-= Contributing
-
-See the CONTRIB.txt file for how to contribute to this project