prawn-core 0.5.0.1

data/examples/m17n/sjis.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+#
+# FIXME: Introducing TTFunk into Prawn broke this example and a cooresponding
+# test.  Ticket: #139
+#
+# Tests passing non utf-8 data into Prawns text function. Should
+# be transparently converted to utf-8 and rendered as usual.
+# 
+# NOTE: only works on ruby1.9 compatible VMs, and requires the current
+#       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"
+
+begin
+  ruby_19 do  
+    datafile = File.join(File.dirname(__FILE__), "..", "..", "data", 
+      "shift_jis_text.txt")
+    sjis_str = File.open(datafile, "r:shift_jis") { |f| f.gets }
+
+    Prawn::Document.generate("sjis.pdf") do
+      font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+      text sjis_str
+    end       
+  end
+rescue
+  puts "\n FIXME: SJIS Broken due to TTFunk integration."
+end

data/examples/m17n/utf8.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+#
+# 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"
+
+Prawn::Document.generate("utf8.pdf") do
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  text "ὕαλον ϕαγεῖν δύναμαι· τοῦτο οὔ με βλάπτει." * 20
+end
+
+      

data/examples/m17n/win_ansi_charset.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+#
+# Prints a list of all of the glyphs that can be rendered by Adobe's built
+# 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'
+
+FONT_SIZE = 9.5
+
+Prawn::Document.generate("win-ansi.pdf") do
+  @skip_encoding = true
+
+  x = 0
+  y = bounds.top
+
+  fields = [[20, :right], [8, :left], [12, :center], [30, :right], [8, :left], [0, :left]]
+
+  font "Helvetica", :size => FONT_SIZE
+
+  Prawn::Encoding::WinAnsi::CHARACTERS.each_with_index do |name, index|
+    next if name == ".notdef"
+    y -= FONT_SIZE
+
+    if y < FONT_SIZE
+      y = bounds.top - FONT_SIZE
+      x += 170
+    end
+
+    code = "%d." % index
+    char = index.chr
+
+    width = 1000 * width_of(char, :size => FONT_SIZE) / FONT_SIZE
+    size = "%d" % width
+
+    data = [code, nil, char, size, nil, name]
+    dx = x
+    fields.zip(data).each do |(total_width, align), field|
+      if field
+        width = width_of(field, :size => FONT_SIZE)
+
+        case align
+        when :left then offset = 0
+        when :right then offset = total_width - width
+        when :center then offset = (total_width - width)/2
+        end
+
+        text(field, :at => [dx + offset, y])
+      end
+
+      dx += total_width
+    end
+  end
+end

data/examples/text/alignment.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+# 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"
+
+Prawn::Document.generate("alignment.pdf") do
+  text "This text should be left aligned"
+  text "This text should be centered", :align => :center    
+  text "This text should be right aligned", :align => :right
+  
+  pad(20) { text "This is Flowing from the left. " * 20 }
+  
+  pad(20) { text "This is Flowing from the center. " * 20, :align => :center }
+  
+  pad(20) { text "This is Flowing from the right. " * 20, :align => :right }
+end

data/examples/text/dfont.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+DFONT_FILE = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+puts "There are #{Prawn::Font::DFont.font_count(DFONT_FILE)} fonts in #{DFONT_FILE}:"
+Prawn::Font::DFont.named_fonts(DFONT_FILE).each do |name|
+  puts "* #{name}"
+end
+
+puts
+puts "generating sample document in 'dfont.pdf'..."
+
+Prawn::Document.generate "dfont.pdf" do       
+  fill_color "0000ff"
+
+  font DFONT_FILE, :font => "ActionMan-Bold", :size => 24
+  text "Introducing Action Man!"
+
+  move_text_position 24
+
+  font_families["Action Man"] = {
+    :normal      => { :file => DFONT_FILE, :font => "ActionMan" },
+    :bold        => { :file => DFONT_FILE, :font => "ActionMan-Bold" },
+    :italic      => { :file => DFONT_FILE, :font => "ActionMan-Italic" },
+    :bold_italic => { :file => DFONT_FILE, :font => "ActionMan-BoldItalic" }
+  }
+
+  font "Action Man", :size => 16
+  text "Action Man is feeling normal here."
+
+  move_text_position 16
+
+  font "Action Man", :style => :bold, :size => 16
+  text "Action Man is feeling bold here!"
+
+  move_text_position 16
+
+  font "Action Man", :style => :italic, :size => 16
+  text "Here, we see Action Man feeling italicized. Slick!"
+
+  move_text_position 16
+
+  font "Action Man", :style => :bold_italic, :size => 16
+  text "Lastly, we observe Mr. Action Man being bold AND italicized. Excellent!"
+end
+
+puts "done"

data/examples/text/family_based_styling.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# This example demonstrates using the :style option for Document#text.
+# 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"
+
+Prawn::Document.generate("family_style.pdf") do
+  ["Courier","Helvetica","Times-Roman"].each do |f|
+    [:bold,:bold_italic,:italic,:normal].each do |s|
+      font f, :style => s
+      text "I'm writing in #{f} (#{s})"
+    end
+  end
+  
+  font "Helvetica"
+  
+  text "Normal"
+  text "Bold",        :style => :bold
+  text "Bold Italic", :style => :bold_italic
+  text "Italic",      :style => :italic
+  text "Normal"
+end

data/examples/text/font_calculations.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+# 
+# This example is a demonstration of how Prawn does its text positioning,
+# 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'
+
+Prawn::Document.generate('font_calculations.pdf') do
+  
+  def demonstration
+    font_size 12
+    move_down 10
+
+    stroke_horizontal_rule
+
+    text "When using flowing text, Prawn will position text\n" +
+         "starting font.ascender below the baseline, and leave\n" +
+         "the y-cursor at the baseline of the next line of text"
+
+    stroke_horizontal_rule
+
+    move_down 20
+
+    bl = y - bounds.absolute_bottom
+
+    stroke_horizontal_rule
+    text "When using text positioned with :at, the baseline is used", :at => [0, bl]
+
+    text "(and the Y-cursor is not moved)", :at => [350, bl]
+
+    colors = { :ascender    => "ff0000", 
+               :descender   => "00ff00",
+               :line_gap    => "0000ff",
+               :font_height => "005500" }
+
+
+    pad(20) do                    
+      text "Calculations Demo", :size => 16
+    end
+
+    fill_color colors[:ascender]
+    text "ASCENDER"
+
+    fill_color colors[:descender]
+    text "DESCENDER"
+
+    fill_color colors[:line_gap]
+    text "LINEGAP" 
+
+    fill_color colors[:font_height]
+    text "FONT_HEIGHT"
+
+    fill_color "000000"
+    font_size 16
+
+    move_down 40
+
+    bl = y - bounds.absolute_bottom
+    text "The quick brown fox jumps over the lazy dog.", :at => [0, bl]
+
+    stroke_color colors[:ascender]
+    stroke_line [0, bl], [0, bl + font.ascender]
+    stroke_line [0, bl + font.ascender], [bounds.width, bl + font.ascender]
+
+    stroke_color colors[:descender]
+    stroke_line [0,bl], [0, bl + font.descender]
+    stroke_line [0, bl + font.descender], [bounds.width, bl + font.descender]
+
+    stroke_color colors[:line_gap]
+    stroke_line [0, bl + font.descender], [0,bl + font.descender - font.line_gap]
+    stroke_line [0, bl + font.descender - font.line_gap], 
+                [bounds.width,bl + font.descender - font.line_gap]
+
+    stroke_color colors[:font_height]
+    stroke_line [bounds.width, bl + font.ascender],
+                [bounds.width, bl + font.descender - font.line_gap]
+                
+    stroke_color "000000"
+    fill_color "000000"
+  end
+  
+  text "Using AFM", :size => 20
+  demonstration
+  
+  move_down 75
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  text "Using TTF", :size => 20
+  demonstration
+  
+end

data/examples/text/font_size.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+#
+# This example shows the many ways of setting font sizes in Prawn
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
+
+  # Explicit global changes
+  font 'Helvetica'
+  self.font_size = 16
+
+  text 'Font at 16 point'
+
+  # Transactional changes rolled back after block exit
+  font_size 9 do
+    text 'Font at 9 point'
+    # single line changes, not persisted.
+    text 'Font at manual override 20 point', :size => 20
+    text 'Font at 9 point'
+  end
+
+  # Transactional changes rolled back after block exit on full fonts.
+  font("Times-Roman", :style => :italic, :size => 12) do
+    text "Font in times at 12"
+    font_size(16) { text "Font in Times at 16" }
+  end
+
+  text 'Font at 16 point'
+
+  font "Courier", :size => 40
+  text "40 pt!"
+end

data/examples/text/kerning.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# Demonstration of enabling and disabling kerning support
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+Prawn::Document.generate "kerning.pdf" do
+  text "To kern?", :at => [200,720], :size => 24, :kerning => true
+  text "To not kern?", :at => [200,690], :size => 24, :kerning => false 
+  
+  move_down 100
+                                                                     
+  pad(30) do
+    text "To kern and wrap. " * 5, :size => 24, :kerning => true   
+  end
+  
+  text "To not kern and wrap. " * 5, :size => 24, :kerning => false
+
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  
+  text "To kern?", :at => [200,660], :size => 24, :kerning => true
+  text "To not kern?", :at => [200,630], :size => 24, :kerning => false     
+  
+  pad(30) do
+    text "To kern and wrap. " * 5, :size => 24, :kerning => true   
+  end
+  
+  text "To not kern and wrap. " * 5, :size => 24, :kerning => false
+  
+end

data/examples/text/simple_text.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# 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"
+
+Prawn::Document.generate "simple_text.pdf" do       
+  fill_color "0000ff"
+  text "Hello World", :at => [200,420], :size => 32, :rotate => 45
+  font "Times-Roman"     
+  fill_color "ff0000"
+  text "Using Another Font", :at => [5,5]    
+  start_new_page        
+  font "Courier"       
+  text "Goodbye World", :at => [288,50]     
+end

data/examples/text/simple_text_ttf.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# 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"
+
+Prawn::Document.generate "simple_text_ttf.pdf" do       
+  fill_color "0000ff"
+  font "#{Prawn::BASEDIR}/data/fonts/comicsans.ttf" 
+  text "Hello World", :at => [200,720], :size => 32         
+
+  font "#{Prawn::BASEDIR}/data/fonts/Chalkboard.ttf"
+
+  pad(20) do
+    text "This is chalkboard wrapping " * 20
+  end
+end

data/examples/text/span.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# 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"
+
+Prawn::Document.generate("span.pdf") do
+  
+  # Spans will typically be used outside of bounding boxes as a way to build
+  # single columns of flowing text that span across pages.
+  #
+  span(350, :position => :center) do
+    text "Here's some centered text in a 350 point column. " * 100
+  end
+  
+  # Spans are not really compatible with bounding boxes because they break
+  # the nesting chain and also may position text outside of the bounding box
+  # boundaries, but sometimes you may wish to use them anyway for convenience
+  # Here's an example of how to do that dynamically.
+  # 
+  bounding_box([50,300], :width => 400) do
+    text "Here's some default bounding box text. " * 10 
+    span(bounds.width, 
+      :position => bounds.absolute_left - margin_box.absolute_left) do
+      text "The rain in spain falls mainly on the plains. " * 300
+    end
+  end
+end

data/examples/text/text_box.rb

@@ -0,0 +1,26 @@
+# 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
+# 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'
+
+Prawn::Document.generate("text_box.pdf") do
+
+  text_box "Oh hai text box. " * 200, 
+    :width    => 300, :height => font.height * 5,
+    :overflow => :ellipses, 
+    :at       => [100,bounds.top]
+
+  text_box "Oh hai text box. " * 200,
+    :width    => 250, :height => font.height * 10,
+    :overflow => :truncate,
+    :at       => [50, 300]
+
+  move_down 20
+
+  text_box "Oh hai text box. " * 100, :overflow => :expand
+end