prawn-core 0.5.0.1 → 0.5.1

data/LICENSE

@@ -1,5 +1,5 @@
 Prawn is copyrighted free software produced by Gregory Brown along with 
-community contributions.
+community contributions.  See git log for authorship information.
 
 Licensing terms follow (License of Ruby 1.8):
 

data/README

@@ -3,9 +3,12 @@
 Prawn is a PDF writing library for Ruby designed to be tiny, fast, and nimble,
 just like the majestic sea creature.
 
-Development on this library is made possible thanks to the many people who
-donated to the Ruby Mendicant project, http://rubymendicant.wikidot.com and
-continues today with the dedicated work of the Prawn pack.
+Development on this library was initially made possible thanks to 
+the many people who donated to the Ruby Mendicant project: 
+http://rubymendicant.wikidot.com 
+
+The project is currently maintained by Gregory Brown, with lots of help from
+the community.
 
 == Quick Start
 
@@ -94,17 +97,29 @@ http://prawn.majesticseacreature.com
 
 === Examples:
 
-http://github.com/sandal/prawn/tree/master/examples
+http://github.com/sandal/prawn/tree/stable/examples
+
+For tables and grid based layout:
+
+http://github.com/sandal/prawn-layout/tree/stable/examples
+
+For inline styling and advanced formatting:
+
+http://github.com/sandal/prawn-format/tree/stable/examples
 
-(or gem unpack prawn, if you want to run them locally)
+(or gem unpack prawn-core, prawn-format, and prawn-layout if you want to run them locally)
 
 === Bug Tracker / Wiki:
 
 http://github.com/sandal/prawn/issues
+http://github.com/sandal/prawn-layout/issues
+http://github.com/sandal/prawn-format/issues
 
-=== GitHub:
+=== Source Code:
 
 http://github.com/sandal/prawn
+http://github.com/sandal/prawn-layout
+http://github.com/sandal/prawn-format
 
 === Mailing List:
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 require "rake/rdoctask"
 require "rake/gempackagetask"  
 
-PRAWN_VERSION = "0.5.0.1" 
+PRAWN_VERSION = "0.5.1" 
 
 task :default => [:test]
        

data/examples/bounding_box/bounding_boxes.rb

@@ -3,8 +3,7 @@
 # This example demonstrates the basic functionality of Prawn's bounding boxes.
 # Note that top level bounding boxes are positioned relative to the margin_box.
 # 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require 'prawn/core'
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("bounding_boxes.pdf") do
 

data/examples/bounding_box/indentation.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+#
+# This example demonstrates the basic functionality of Prawn's bounding boxes.
+# Note that top level bounding boxes are positioned relative to the margin_box.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("indentation.pdf") do
+
+  text "No indentation"
+  indent(20) do
+    text "Some indentation"
+    # Generates a box with a top-left of [100,600] and a top-right of [300,600]
+    # The box automatically expands as the cursor moves down the page.  Notice
+    # that the final coordinates are outlined by a top and bottom line drawn
+    # relatively using calculations from +bounds+.
+    #
+    bounding_box [100,600], :width => 200 do
+      text "A little more indentation"
+      indent(20) do
+        text "And some more indentation"
+        indent(20) do
+          text "And some deeper indentation"
+        end
+      end
+    end
+    text "Some indentation"
+  end
+  indent(10) do
+    text "A bit of indentation"
+  end
+  
+  text "No indentation"
+end

data/examples/bounding_box/russian_boxes.rb

@@ -4,8 +4,7 @@
 # can simplify calculations.  See the other files in examples/bounding_box
 # for more basic uses.
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require 'prawn/core'
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 class Array
   def combine(arr)

data/examples/column_box/column_box_example.rb

@@ -2,8 +2,7 @@
 #
 # Text should flow between columns before wrapping to the next page, like a printed newspaper.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 paragraphs = []
 paragraphs << <<-ONE

data/examples/example_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn/core'
+Prawn.debug = true

data/examples/general/background.rb

@@ -4,17 +4,20 @@
 # generating a new Document.  Image is assumed to be pre-fit for your page
 # size, and will not be rescaled.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 img = "#{Prawn::BASEDIR}/data/images/letterhead.jpg"
 
 Prawn::Document.generate("background.pdf", :background => img) do
-  text_options.update(:size => 18, :align => :right)
-  text "My report caption"
-  text_options.update(:size => 12, :align => :left, :spacing => 2)
+  text "My report caption", :size => 18, :align => :right
+
   move_down font.height * 2
-  text "Here is my text explaning this report. " * 20
+
+  text "Here is my text explaning this report. " * 20, 
+    :size => 12, :align => :left, :leading => 2
+
   move_down font.height
-  text "I'm using a soft background. " * 40
-end
+
+  text "I'm using a soft background. " * 40,
+    :size => 12, :align => :left, :leading => 2
+end

data/examples/general/canvas.rb

@@ -3,8 +3,7 @@
 # Demonstrates how to enable absolute positioning in Prawn by temporarily
 # removing the margin_box via Document#canvas()
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("canvas.pdf") do
   canvas do

data/examples/general/measurement_units.rb

@@ -5,8 +5,7 @@
 # its particular implementation, though some might find that interesting as
 # well.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 require "prawn/measurement_extensions"
 

data/examples/general/metadata-info.rb

@@ -3,8 +3,7 @@
 # Demonstrates how to set metadata properties via the info option
 # It allows one to specify no standard properties
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "metadata-info.pdf",
   :info => {

data/examples/general/multi_page_layout.rb

@@ -3,8 +3,7 @@
 # This demonstrates that Prawn can modify page size, margins and layout for 
 # each individual page, via Document#start_new_page()
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("multi-layout.pdf", :page_layout => :landscape) do |pdf|
    pdf.text "This is on a landscaped page" 

data/examples/general/page_geometry.rb

@@ -4,8 +4,7 @@
 # documents.  The style used here is a bit out of date, see 
 # multi_page_layout.rb for a more modern example.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 def pdf(*options)  
   Prawn::Document.new(*options)

data/examples/graphics/basic_images.rb

@@ -4,8 +4,7 @@
 # For positioning images alongside flowing text, see the image_flow.rb
 # example.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
    
 Prawn::Document.generate("basic_images.pdf", :page_layout => :landscape) do     
   stef = "#{Prawn::BASEDIR}/data/images/stef.jpg"

data/examples/graphics/cmyk.rb

@@ -2,8 +2,7 @@
 #
 # Demonstrates Prawn's support for CMYK images and colors.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("cmyk.pdf", :page_layout => :landscape) do
   fill_color 50, 100, 0, 0

data/examples/graphics/curves.rb

@@ -2,8 +2,7 @@
 #
 # Demonstrates simple curve and circle usage
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 pdf = Prawn::Document.new
 pdf.move_to [100,100]

data/examples/graphics/hexagon.rb

@@ -2,8 +2,7 @@
 #
 # Draws and fills a Hexagon using Document#polygon
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 pdf = Prawn::Document.new
                         

data/examples/graphics/image_fit.rb

@@ -4,8 +4,7 @@
 # The image will be scaled down to fit within the box, while preserving
 # the aspect ratio.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
    
 Prawn::Document.generate("image_fit.pdf", :page_layout => :landscape) do
 

data/examples/graphics/image_flow.rb

@@ -5,8 +5,7 @@
 # useful when used in combination with flowing text, where the exact final
 # position of the image is not known ahead of time.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
    
 Prawn::Document.generate("image-flow.pdf", :page_layout => :landscape) do  
   self.font_size = 8                           

data/examples/graphics/image_position.rb

@@ -2,8 +2,7 @@
 #
 # Demonstrates vertical and horizontal positioning of images.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
    
 Prawn::Document.generate("image_position.pdf", :page_layout => :landscape) do
 

data/examples/graphics/line.rb

@@ -2,8 +2,7 @@
 #
 # The very first Prawn example.  Here for nostalgia's sake.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
  
 pdf = Prawn::Document.new   
 pdf.line_width = 10    

data/examples/graphics/png_types.rb

@@ -3,8 +3,7 @@
 # PNG files come in different flavours - 5 of them. This example embeds
 # one of each type as proof that they all work.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 images = [
           ["Type 0", "#{Prawn::BASEDIR}/data/images/web-links.png"],

data/examples/graphics/polygons.rb

@@ -2,8 +2,7 @@
 # 
 # Basic polygon drawing example.  See also: hexagon.rb
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 pdf = Prawn::Document.new
 

data/examples/graphics/remote_images.rb

@@ -3,8 +3,8 @@
 # Demonstrates how to use open-uri and Document#image to embed remote image
 # files.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
 require "open-uri"
 
 Prawn::Document.generate("remote_images.pdf") do 

data/examples/graphics/ruport_style_helpers.rb

@@ -3,8 +3,7 @@
 # These helpers will be familiar to Ruport users, and now are supported
 # directly in Prawn.   Run the example to see how they work.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 # Demonstrates some features stolen from Ruport::Formatter::PDF
 Prawn::Document.generate("ruport.pdf") do

data/examples/graphics/stroke_bounds.rb

@@ -8,8 +8,7 @@
 # Feature borrowed from Josh Knowle's pt at:
 # http://github.com/joshknowles/pt/tree/master
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require 'prawn/core'
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("stroke_bounds.pdf") do 
   stroke_bounds

data/examples/m17n/chinese_text_wrapping.rb

@@ -3,18 +3,17 @@
 # Some text is not usefully wrapped by our naive_wrap which depends on 
 # spaces.  This example shows how to wrap by character instead.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 start = Time.now
 Prawn::Document.generate("chinese_flow.pdf") do  
   font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"   
-  text_options.update(:wrap => :character, :size => 16)
+  font_size 16
+
   long_text = "更可怕的是，同质化竞争对手可以按照URL中后面这个ID来遍历您的DB中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，这样的话，你就非常被动了。写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事"                                                       
-  text long_text
+  text long_text, :wrap => :character
   
   # be sure to restore space based wrapping when dealing with latin scripts
-  text_options.update(:wrap => :spaces)
   long_text = "Text with some spaces " * 25
   text long_text
-end
+end

data/examples/m17n/euro.rb

@@ -8,8 +8,7 @@
 # If you need precision spacing, use a TTF file instead and the issue will
 # go away.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "euro.pdf" do
   text "A Euro! € ©", :size => 32

data/examples/m17n/sjis.rb

@@ -10,8 +10,7 @@
 #       font to include japanese glyphs. On 1.8.x comaptible VMs, an exception
 #       will be raised.
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 begin
   ruby_19 do  

data/examples/m17n/utf8.rb

@@ -3,8 +3,7 @@
 # Shows that Prawn works out of the box with UTF-8 text, so long as you use
 # a TTF file with the necessary glyphs for your content.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("utf8.pdf") do
   font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"

data/examples/m17n/win_ansi_charset.rb

@@ -4,8 +4,7 @@
 # in fonts, along with their character widths and WinAnsi codes.  Be sure
 # to pass these glyphs as UTF-8, and Prawn will transcode them for you.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require 'prawn/core'
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 FONT_SIZE = 9.5
 

data/examples/text/alignment.rb

@@ -3,8 +3,7 @@
 # This example demonstrates usage of Document#text with the :align option.
 # Available options are :left, :right, and :center, with :left as default.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("alignment.pdf") do
   text "This text should be left aligned"

data/examples/text/dfont.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 DFONT_FILE = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
 puts "There are #{Prawn::Font::DFont.font_count(DFONT_FILE)} fonts in #{DFONT_FILE}:"

data/examples/text/family_based_styling.rb

@@ -4,8 +4,7 @@
 # If you are working with TTF fonts, you'll want to check out the 
 # documentation for Document#font_families and register your fonts with it.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("family_style.pdf") do
   ["Courier","Helvetica","Times-Roman"].each do |f|

data/examples/text/font_calculations.rb

@@ -4,8 +4,7 @@
 # meant to assist those that need to do advanced positioning calculations.
 # Run the example for a clearer picture of how things work
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require 'prawn/core'
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate('font_calculations.pdf') do
   

data/examples/text/font_size.rb

@@ -2,8 +2,7 @@
 #
 # This example shows the many ways of setting font sizes in Prawn
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
 

data/examples/text/kerning.rb

@@ -2,8 +2,7 @@
 #
 # Demonstration of enabling and disabling kerning support
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "kerning.pdf" do
   text "To kern?", :at => [200,720], :size => 24, :kerning => true

data/examples/text/simple_text.rb

@@ -3,8 +3,7 @@
 # An early example of basic text generation at absolute positions.
 # Mostly kept for nostalgia.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "simple_text.pdf" do       
   fill_color "0000ff"

data/examples/text/simple_text_ttf.rb

@@ -2,8 +2,7 @@
 #
 # An early example of TTF font embedding.  Mostly kept for nostalgia's sake.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "simple_text_ttf.pdf" do       
   fill_color "0000ff"

data/examples/text/span.rb

@@ -3,8 +3,7 @@
 # Demonstration of Document#span, which is used for generating flowing
 # columns of text.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("span.pdf") do
   

data/examples/text/text_box.rb

@@ -1,12 +1,11 @@
 # encoding: utf-8
 #
 # A text box is positioned by a top-left corner, width, and height and is
-# essentially an invisible rectangle that the text wil lflow within.  If the
+# essentially an invisible rectangle that the text will flow within.  If the
 # text exceeds the boundaries, it is either truncated, replaced with some
 # ellipses, or set to expand beyond the bottom boundary.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require 'prawn/core'
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate("text_box.pdf") do
 
@@ -23,4 +22,4 @@ Prawn::Document.generate("text_box.pdf") do
   move_down 20
 
   text_box "Oh hai text box. " * 100, :overflow => :expand
-end
+end

data/examples/text/text_flow.rb

@@ -3,8 +3,7 @@
 # Basic text flowing example including the use of bounding boxes.  A somewhat
 # old example, mostly retained for nostalgia.
 #
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-require "prawn/core"
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 content = <<-EOS
 How does
@@ -60,7 +59,7 @@ Prawn::Document.generate("flow.pdf") do |pdf|
   pdf.bounding_box([100,450], :width => 300) do
     pdf.stroke_line [pdf.bounds.left,  pdf.bounds.top],
                     [pdf.bounds.right, pdf.bounds.top]
-    pdf.text poem, :size => 10, :spacing => 5
+    pdf.text poem, :size => 10, :leading => 5
   end
   
   pdf.text "And this text automatically goes below the poem", :size => 18

data/lib/prawn/core.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
- 
-# prawn.rb : A library for PDF generation in Ruby
+# 
+# Prawn : A library for PDF generation in Ruby
 #
 # Copyright April 2008, Gregory Brown. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
-           
+        
 %w[ttfunk/lib].each do |dep|
   $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../../vendor/#{dep}")
 end
@@ -27,13 +27,20 @@ module Prawn
   # The base source directory for Prawn as installed on the system
   BASEDIR = File.expand_path(File.join(dir, '..', '..'))
   
-  VERSION = "0.5.0.1"
+  VERSION = "0.5.1"
   
   extend self
 
   # Whe set to true, Prawn will verify hash options to ensure only valid keys
   # are used.  Off by default.
-  # 
+  #
+  # Example:
+  #
+  #   >> Prawn::Document.new(:tomato => "Juicy")  
+  #   Prawn::Errors::UnknownOption:   
+  #   Detected unknown option(s): [:tomato] 
+  #   Accepted options are: [:page_size, :page_layout, :left_margin, ...]  
+  #
   attr_accessor :debug
   
   def verify_options(accepted,actual) #:nodoc: