show_off_pdf 0.0.2.pre → 0.0.3.pre

data/README.md

@@ -5,15 +5,55 @@ Using Markdown Prawn, showoff2pdf will try to convert
 a ShowOff presentation into a sensible PDF document
 ready to print.
 
+At the moment it supports the following features:
+
+  * Bulleted Lists
+  * Ordered lists
+  * Images (local and remote)
+  * Multiple levels of headings
+  * Bold,  Italic and Underline text
+
+With partial (and in progress) support for:
+
+  * Code blocks
+  * Commandline argument
+  * Formatting / Alignment
+
+Requirements
+------------
+
+Requires the latest <tt>Prawn</tt> and also requires
+<tt>ShowOff</tt>.
+
+Prawn is used to generate the PDFs and ShowOff itself
+is used to read the configuration information from the
+slideshow and pull in its content from each section.
+
+
 Installation
 ------------
 
-      $  sudo gem install show_off_pdf --pre
+      $  sudo gem install prawn --pre
+      $  sudo gem install show_off_pdf --pre showoff
 
 Usage
 -----
 
-      $  cd ./show_off_presentation
+      $  cd /path/to/show_off_presentation
       $  showoff2pdf > presentation.pdf
 
-That's it
+Known Issues
+------------
+
+The following known issues are being worked on
+
+  * Detecting and dealing with code blocks is sketchy
+    and inconsistant.
+  * Detecting and dealing with commandline blocks is
+    sketchy and inconsistant.
+
+Bugs
+----
+
+Please open an issue here if you encounter a problem with
+using showoff2pdf. 

data/bin/showoff2pdf

@@ -4,10 +4,17 @@ require File.dirname(__FILE__)  + '/../show_off_pdf'
 paths = []
 images = []
 ShowOffUtils.showoff_sections.each do |section|
-  paths << Dir.glob(File.expand_path("./#{section}/*.{md,mdown}"))
+  paths << Dir.glob(File.expand_path("./#{section}/**/*.{md,mdown}"))
   images << Dir.glob(File.expand_path("./#{section}/**/*.{png,jpg,jpeg}"))
 end 
 paths.flatten!
 images.flatten!
 ImageFragment._image_assets = images
+
+# If we set this, then it'll automatically preshrink
+# images to 80% of their size before attempting to
+# scale them.
+#
+ImageFragment._page_image_ratio = 0.8
+
 puts ShowoffSlideStream.new(paths).to_pdf.render

data/lib/markdown_fragments/image_fragment.rb

@@ -2,6 +2,15 @@ require 'net/http'
 require 'tmpdir'
 
 class ImageFragment < MarkdownFragment
+
+  def self._page_image_ratio=(value)
+    @@_page_image_ratio = value
+  end
+
+  def self._page_image_ratio
+    @@_page_image_ratio
+  end
+
   def self._image_assets=(value)
     @@_image_assets = value
   end
@@ -35,7 +44,8 @@ class ImageFragment < MarkdownFragment
       width = JPEG.new(file_path).width 
       height = JPEG.new(file_path).height
     end
-    pdf_object.image file_path, :width => width, :height => height, :scale => 0.8
+    width,height = best_fit(width, height, pdf_object)
+    pdf_object.image file_path , :fit => [ width, height], :position => :center
   end
 
   private
@@ -44,6 +54,64 @@ class ImageFragment < MarkdownFragment
     !/^(http:|https:)/.match(@content.first).nil?
   end
 
+  # Calculate the width and height to best fit the
+  # image on the page.
+  #
+  def best_fit(width, height, pdf)
+    ph = pdf.bounds.height - page_padding
+    pw = pdf.bounds.width - page_padding
+    return [width, height] if height <= ph && width <= pw
+
+    if ImageFragment._page_image_ratio
+      iw = width * ImageFragment._page_image_ratio
+      ih = height * ImageFragment._page_image_ratio
+    else
+      iw = width
+      ih = height
+    end
+    iw = pixels_to_points(iw)
+    ih = pixels_to_points(ih)
+
+    if ih <= ph && iw <= pw
+      return [iw, ih]
+    elsif ih > ph
+      r = height / width
+      ih = (ih - (page_padding * 2))
+      iw = ih * r
+    elsif iw > pw
+      r = width / height
+      iw = (iw - (page_padding * 2))
+      ih = iw * r
+    else
+      puts "SHOULD NEXT GET HERE"
+      exit(-1)
+    end
+    return [iw, ih]
+  end
+
+  # Work out the page padding later, for not assume that
+  # it's 20.
+  # 
+  def page_padding
+    20
+  end
+
+
+  # Very rough way to convert pixels to points, by
+  # assuming the we're at 96 DPI. This isn't the most
+  # ideal method, but it should be good enough for 
+  # sizing images to fit on page correctly.
+  #
+  def pixels_to_points(pixels)
+    pixels * 72 / 96
+  end
+
+  # Very rough reversal ov the above
+  #
+  def points_to_pixels(points)
+    points / 72 * 96
+  end
+
 end
 
 class JPEG

data/lib/show_off_slide.rb

@@ -1,6 +1,22 @@
 class ShowOffSlide
   attr_accessor :components, :content
-  
+
+  SHOWOFF_SLIDE_TYPES = [
+                          'subsection',
+                          'commandline',
+                          'incremental',
+                          'center',
+                          'command',
+                          'small',
+                          'full-page',
+                          'bullets',
+                          'smbullets',
+                          'code',
+                          'smaller',
+                          'execute',
+                          'transition='
+                        ]
+
   def initialize(content = '', options = {})
     @components = []
     @options = { :size => 'A4', :layout => :landscape }.merge(options)
@@ -17,7 +33,17 @@ class ShowOffSlide
   private
   
   def parse    
-      
+    # Get rid of leading \n characters
+    #
+    @content.gsub!(/^(\n)*/,'') 
+
+    # Skip aparently blank slides
+    #
+    return if @content.empty?
+
+    # Pull out presenter notes for displaying at the bottom
+    # of the page
+    # 
     s =/(\s)?.notes\s(.*)(\n)?/.match(@content)
     if !s.nil?
       @slide_notes = $2
@@ -25,10 +51,9 @@ class ShowOffSlide
     else
       @slide_notes = nil
     end
-    
+
     sp = MarkdownPrawn::StringParser.new(@content)
     sp.parse!
-    #@components << ParagraphFragment.new([@content])
     @components = sp.document_structure
     if @slide_notes
       @components << PresenterNotesFragment.new([@slide_notes])

data/show_off_pdf.gemspec

@@ -11,7 +11,7 @@ TXT
 
 Gem::Specification.new do |spec|
   spec.name = "show_off_pdf"
-  spec.version = '0.0.2.pre'
+  spec.version = '0.0.3.pre'
   spec.platform = Gem::Platform::RUBY
   spec.files =  Dir.glob("{bin,lib,.}/**/**/*") +
                       ["show_off_pdf.rb","README.md","COPYING.md",'LICENSE', "show_off_pdf.gemspec"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: show_off_pdf
 version: !ruby/object:Gem::Version 
-  hash: 961915980
+  hash: 961915976
   prerelease: true
   segments: 
   - 0
   - 0
-  - 2
+  - 3
   - pre
-  version: 0.0.2.pre
+  version: 0.0.3.pre
 platform: ruby
 authors: 
 - Ryan Stenhouse
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-09 00:00:00 +00:00
+date: 2010-12-10 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency